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/>.

namespace tool_usertours\local\filter;

use tool_usertours\tour;

use context;

/**

 * Theme filter.

 *

 * @package    tool_usertours

 * @copyright  2016 Andrew Nicols <andrew@nicols.co.uk>

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

 */

class role extends base {

    /**

     * The Site Admin pseudo-role.

     *

     * @var ROLE_SITEADMIN int

     */

    const ROLE_SITEADMIN = -1;

    /**

     * The name of the filter.

     *

     * @return  string

     */

    public static function get_filter_name() {

        return 'role';

    }

    /**

     * Retrieve the list of available filter options.

     *

     * @return  array                   An array whose keys are the valid options

     *                                  And whose values are the values to display

     */

    public static function get_filter_options() {

        $allroles = role_get_names(null, ROLENAME_ALIAS);

        $roles = [];

        foreach ($allroles as $role) {

            if ($role->archetype === 'guest') {

                // No point in including the 'guest' role as it isn't possible to show tours to a guest.

                continue;

            }

            $roles[$role->shortname] = $role->localname;

        }

        // Add the Site Administrator pseudo-role.

        $roles[self::ROLE_SITEADMIN] = get_string('administrator', 'core');

        // Sort alphabetically too.

        \core_collator::asort($roles);

        return $roles;

    }

    /**

     * Check whether the filter matches the specified tour and/or context.

     *

     * @param   tour        $tour       The tour to check

     * @param   context     $context    The context to check

     * @return  boolean

     */

    public static function filter_matches(tour $tour, context $context) {

        global $USER;

        $values = $tour->get_filter_values(self::get_filter_name());

        if (empty($values)) {

            // There are no values configured.

            // No values means all.

            return true;

        }

        // Presence within the array is sufficient. Ignore any value.

        $values = array_flip($values);

        if (isset($values[self::ROLE_SITEADMIN]) && is_siteadmin()) {

            // This tour has been restricted to a role including site admin, and this user is a site admin.

            return true;

        }

        // Use a request cache to save on DB queries.

        // We may be checking multiple tours and they'll all be for the same userid, and contextid.

        $cache = \cache::make_from_params(\cache_store::MODE_REQUEST, 'tool_usertours', 'filter_role');

        // Get all of the roles used in this context, including special roles such as user, and frontpageuser.

        $cachekey = "{$USER->id}_{$context->id}";

        $userroles = $cache->get($cachekey);

        if ($userroles === false) {

            $userroles = get_user_roles_with_special($context);

            $cache->set($cachekey, $userroles);

        }

        // Some special roles do not include the shortname.

        // Therefore we must fetch all roles too. Thankfully these don't actually change based on context.

        // They do require a DB call, so let's cache it.

        $cachekey = "allroles";

        $allroles = $cache->get($cachekey);

        if ($allroles === false) {

            $allroles = get_all_roles();

            $cache->set($cachekey, $allroles);

        }

        // Now we can check whether any of the user roles are in the list of allowed roles for this filter.

        foreach ($userroles as $role) {

            $shortname = $allroles[$role->roleid]->shortname;

            if (isset($values[$shortname])) {

                return true;

            }

        }

        return false;

    }

}