Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * Provides {@link tool_policy\output\renderer} class.

 *

 * @package     tool_policy

 * @category    output

 * @copyright   2018 Sara Arjona <sara@moodle.com>

 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

namespace tool_policy\output;

use moodle_exception;

defined('MOODLE_INTERNAL') || die();

use context_system;

use moodle_url;

use renderable;

use renderer_base;

use single_button;

use templatable;

use tool_policy\api;

use tool_policy\policy_version;

/**

 * Represents a page for showing the given policy document version.

 *

 * @copyright 2018 Sara Arjona <sara@moodle.com>

 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class page_viewdoc implements renderable, templatable {

    /** @var stdClass Exported {@link \tool_policy\policy_version_exporter} to display on this page. */

    protected $policy;

    /** @var string Return URL. */

    protected $returnurl = null;

    /** @var int User id who wants to view this page. */

    protected $behalfid = null;

    /** @var bool View the policy as a part of the management UI. */

    protected $manage;

    /** @var int Position of the current policy with respect to the total of policy docs to display. */

    protected $numpolicy = 0;

    /** @var int Total number of policy documents which the user has to agree to. */

    protected $totalpolicies = 0;

    /**

     * Prepare the page for rendering.

     *

     * @param int $policyid The policy id for this page.

     * @param int $versionid The version id to show. Empty tries to load the current one.

     * @param string $returnurl URL of a page to continue after reading the policy text.

     * @param int $behalfid The userid to view this policy version as (such as child's id).

     * @param bool $manage View the policy as a part of the management UI.

     * @param int $numpolicy Position of the current policy with respect to the total of policy docs to display.

     * @param int $totalpolicies Total number of policy documents which the user has to agree to.

     */

    public function __construct($policyid, $versionid, $returnurl, $behalfid, $manage, $numpolicy = 0, $totalpolicies = 0) {

        $this->returnurl = $returnurl;

        $this->behalfid = $behalfid;

        $this->manage = $manage;

        $this->numpolicy = $numpolicy;

        $this->totalpolicies = $totalpolicies;

        $this->prepare_policy($policyid, $versionid);

        $this->prepare_global_page_access();

    }

    /**

     * Loads the policy version to display on the page.

     *

     * @param int $policyid The policy id for this page.

     * @param int $versionid The version id to show. Empty tries to load the current one.

     */

    protected function prepare_policy($policyid, $versionid) {

        if ($versionid) {

            $this->policy = api::get_policy_version($versionid);

        } else {

            $this->policy = array_reduce(api::list_current_versions(), function ($carry, $current) use ($policyid) {

                if ($current->policyid == $policyid) {

                    return $current;

                }

                return $carry;

            });

        }

        if (empty($this->policy)) {

            throw new \moodle_exception('errorpolicyversionnotfound', 'tool_policy');

        }

    }

    /**

     * Sets up the global $PAGE and performs the access checks.

     */

    protected function prepare_global_page_access() {

        global $CFG, $PAGE, $SITE, $USER;

        $myurl = new moodle_url('/admin/tool/policy/view.php', [

            'policyid' => $this->policy->policyid,

            'versionid' => $this->policy->id,

            'returnurl' => $this->returnurl,

            'behalfid' => $this->behalfid,

            'manage' => $this->manage,

            'numpolicy' => $this->numpolicy,

            'totalpolicies' => $this->totalpolicies,

        ]);

        if ($this->manage) {

            require_once($CFG->libdir.'/adminlib.php');

            admin_externalpage_setup('tool_policy_managedocs', '', null, $myurl);

            require_capability('tool/policy:managedocs', context_system::instance());

            $PAGE->navbar->add(format_string($this->policy->name),

                new moodle_url('/admin/tool/policy/managedocs.php', ['id' => $this->policy->policyid]));

        } else {

            if ($this->policy->status != policy_version::STATUS_ACTIVE) {

                require_login();

            } else if (isguestuser() || empty($USER->id) || !$USER->policyagreed) {

                // Disable notifications for new users, guests or users who haven't agreed to the policies.

                $PAGE->set_popup_notification_allowed(false);

            }

            $PAGE->set_url($myurl);

            $PAGE->set_heading($SITE->fullname);

            $PAGE->set_title(get_string('policiesagreements', 'tool_policy'));

            $PAGE->navbar->add(get_string('policiesagreements', 'tool_policy'), new moodle_url('/admin/tool/policy/index.php'));

            $PAGE->navbar->add(format_string($this->policy->name));

        }

        if (!api::can_user_view_policy_version($this->policy, $this->behalfid)) {

            throw new moodle_exception('accessdenied', 'tool_policy');

        }

    }

    /**

     * Export the page data for the mustache template.

     *

     * @param renderer_base $output renderer to be used to render the page elements.

     * @return stdClass

     */

    public function export_for_template(renderer_base $output) {

        global $USER;

        $data = (object) [

            'pluginbaseurl' => (new moodle_url('/admin/tool/policy'))->out(false),

            'returnurl' => $this->returnurl ? (new moodle_url($this->returnurl))->out(false) : null,

            'numpolicy' => $this->numpolicy ? : null,

            'totalpolicies' => $this->totalpolicies ? : null,

        ];

        if ($this->manage && $this->policy->status != policy_version::STATUS_ARCHIVED) {

            $paramsurl = ['policyid' => $this->policy->policyid, 'versionid' => $this->policy->id];

            $data->editurl = (new moodle_url('/admin/tool/policy/editpolicydoc.php', $paramsurl))->out(false);

        }

        if ($this->policy->agreementstyle == policy_version::AGREEMENTSTYLE_OWNPAGE) {

            if (!api::is_user_version_accepted($USER->id, $this->policy->id)) {

                unset($data->returnurl);

                $data->accepturl = (new moodle_url('/admin/tool/policy/index.php', [

                    'listdoc[]' => $this->policy->id,

                    'status'.$this->policy->id => 1,

                    'submit' => 'accept',

                    'sesskey' => sesskey(),

                ]))->out(false);

                if ($this->policy->optional == policy_version::AGREEMENT_OPTIONAL) {

                    $data->declineurl = (new moodle_url('/admin/tool/policy/index.php', [

                        'listdoc[]' => $this->policy->id,

                        'status'.$this->policy->id => 0,

                        'submit' => 'decline',

                        'sesskey' => sesskey(),

                    ]))->out(false);

                }

            }

        }

        $data->policy = clone($this->policy);

        return $data;

    }

}