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 core;

use context_course;

use stdClass;

/**

 * A helper class with static methods to help report plugins

 *

 * @package core

 * @subpackage report

 * @copyright 2021 Sujith Haridasan

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

 */

class report_helper {

    /**

     * Print the selector dropdown

     *

     * @param string $pluginname The report plugin where the header is modified

     * @param string $additional Additional content to display aligned with the selector

     */

    public static function print_report_selector(string $pluginname, string $additional = ''): void {

        global $OUTPUT, $PAGE;

        if ($reportnode = $PAGE->settingsnav->find('coursereports', \navigation_node::TYPE_CONTAINER)) {

            $menuarray = \core\navigation\views\secondary::create_menu_element([$reportnode]);

            if (empty($menuarray)) {

                return;

            }

            $coursereports = get_string('reports');

            $activeurl = '';

            if (isset($menuarray[0])) {

                // Remove the reports entry.

                $result = array_search($coursereports, $menuarray[0][$coursereports]);

                unset($menuarray[0][$coursereports][$result]);

                // Find the active node.

                foreach ($menuarray[0] as $key => $value) {

                    $check = array_search($pluginname, $value);

                    if ($check !== false) {

                        $activeurl = $check;

                    }

                }

            } else {

                $result = array_search($coursereports, $menuarray);

                unset($menuarray[$result]);

                $check = array_search($pluginname, $menuarray);

                if ($check !== false) {

                    $activeurl = $check;

                }

            }

            $selectmenu = new \core\output\select_menu('reporttype', $menuarray, $activeurl);

            $selectmenu->set_label(get_string('reporttype'), ['class' => 'visually-hidden']);

            $options = \html_writer::tag(

                'div',

                $OUTPUT->render_from_template('core/tertiary_navigation_selector', $selectmenu->export_for_template($OUTPUT)),

                ['class' => 'navitem']

            );

            if ($additional) {

                $options .= \html_writer::div('', 'navitem-divider') .

                    \html_writer::div($additional, 'navitem');

            }

            echo \html_writer::tag(

                'div',

                $options,

                ['class' => 'tertiary-navigation full-width-bottom-border ms-0 d-flex', 'id' => 'tertiary-navigation']);

        } else {

            echo $OUTPUT->heading($pluginname, 2, 'mb-3');

        }

    }

    /**

     * @deprecated since Moodle 4.0

     */

    #[\core\attribute\deprecated(null, reason: 'It is no longer used', since: '4.0', final: true)]

    public static function save_selected_report() {

        \core\deprecation::emit_deprecation([self::class, __FUNCTION__]);

    }

    /**

     * Retrieve the right SQL / params for the group filter depending on the filterparams, course and group settings.

     *

     * Addionnaly, it will return the list of users visible by the current user so

     * it can be used to filter out records that are not visible. This is mainly

     * because we cannot use joins as the log tables can be in two different databases.

     *

     * @param stdClass $filterparams

     * @return array

     */

    public static function get_group_filter(stdClass $filterparams): array {

        global $DB, $USER;

        $useridfilter = null;

        // First and just in case we are in separate group, just set the $useridfilter to the list

        // of users visible by this user.

        $courseid = $filterparams->courseid ?? SITEID;

        $courseid = $courseid ?: SITEID; // Make sure that if courseid is set to 0 we use SITEID.

        $course = get_course($courseid);

        $groupmode = groups_get_course_groupmode($course);

        $groupid = $filterparams->groupid ?? 0;

        $context = context_course::instance($courseid);

        if ($groupid || ($groupmode == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $context))) {

            if ($groupid) {

                $cgroups = [(int) $groupid];

            } else {

                $cgroups = groups_get_all_groups($courseid, $USER->id);

                $cgroups = array_keys($cgroups);

                // If you are not in any groups you can still view users without group. This may

                // perform poorly because it will list all users in the entire system who do not

                // belong to a group on this course.

                if (empty($cgroups)) {

                    $cgroups[] = USERSWITHOUTGROUP;

                }

            }

            // If that's the case, limit the users to be in the groups only, defined by the filter.

            [$groupmembersql, $groupmemberparams] = groups_get_members_ids_sql($cgroups, $context);

            $groupusers = $DB->get_fieldset_sql($groupmembersql, $groupmemberparams);

            $useridfilter = array_fill_keys($groupusers, true);

        }

        $joins = [];

        $params = [];

        if (empty($filterparams->userid)) {

            if ($groupid) {

                if ($thisgroupusers = groups_get_members($groupid)) {

                    [$sql, $sqlfilterparams] = $DB->get_in_or_equal(

                        array_keys($thisgroupusers),

                        SQL_PARAMS_NAMED,

                    );

                    $joins[] = "userid {$sql}";

                    $params = $sqlfilterparams;

                } else {

                    $joins[] = 'userid = 0'; // No users in groups, so we want something that will always be false.

                }

            }

        } else {

            $joins[] = "userid = :userid";

            $params['userid'] = $filterparams->userid;

            $useridfilter[$filterparams->userid] = true;

        }

        return [

            'joins' => $joins,

            'params' => $params,

            'useridfilter' => $useridfilter,

        ];

    }

    /**

     * Check if the user is in a valid group for the course (i.e. if the user is in a group in SEPARATEGROUPS mode)

     *

     * @param context $context context for the course or module: if context is a course context, the course group mode is used,

     * if it is a module context, the module effective group mode is used (combined with the current user).

     * @param int|null $userid user id to check, if null the current user is used

     * @return bool true if the user is in a valid group (i.e. belongs to a group in SEPARATEGROUPS MODE), false otherwise

     */

    public static function has_valid_group(\context $context, ?int $userid = null): bool {

        global $USER;

        $userid = $userid ?? $USER->id;

        if ($context instanceof context_course) {

            $courseid = $context->instanceid;

            $course = get_course($courseid);

            $groupmode = $course->groupmode;

        } else if ($context instanceof \context_module) {

            $courseid = $context->get_course_context()->instanceid;

            $modinfo = get_fast_modinfo($courseid);

            $cm = $modinfo->get_cm($context->instanceid);

            $groupmode = $cm->effectivegroupmode;

        } else {

            return true; // No groups in system context.

        }

        if ($groupmode != SEPARATEGROUPS) {

            return true; // No groups or visible all groups.

        }

        if (!has_capability('moodle/site:accessallgroups', $context, $userid)) {

            $usergroups = groups_get_all_groups($courseid, $userid);

            if (empty($usergroups)) {

                return false;

            }

        }

        return true;

    }

}