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

/**

 * Output the grading actionbar for this activity.

 *

 * @package   mod_assign

 * @copyright 2021 Adrian Greeve <adrian@moodle.com>

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

 */

namespace mod_assign\output;

use assign;

use context_module;

use core_course\output\actionbar\group_selector;

use core_course\output\actionbar\user_selector;

use templatable;

use renderable;

use moodle_url;

use core\output\local\dropdown\dialog;

/**

 * Output the grading actionbar for this activity.

 *

 * @package   mod_assign

 * @copyright 2021 Adrian Greeve <adrian@moodle.com>

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

 */

class grading_actionmenu implements templatable, renderable {

    /** @var int Course module ID. */

    protected int $cmid;

    /** @var bool If any submission plugins are enabled. */

    protected bool $submissionpluginenabled;

    /** @var int The number of submissions made. */

    protected int $submissioncount;

    /** @var assign The assign instance. */

    protected assign $assign;

    /** @var bool If there are submissions to download. */

    protected bool $showdownload;

    /** @var array Applied user initials filters, containing 'firstname' and 'lastname'. **/

    protected array $userinitials;

    /** @var bool true if the user has this capability. Otherwise false. */

    private bool $hasviewblind;

    /**

     * Constructor for this object.

     *

     * @param int $cmid Course module ID.

     * @param null|bool $submissionpluginenabled This parameter has been deprecated since 4.5 and should not be used anymore.

     * @param null|int $submissioncount This parameter has been deprecated since 4.5 and should not be used anymore.

     * @param assign|null $assign The assign instance. If not provided, it will be loaded based on the cmid.

     * @param array $userinitials The user initials to filter the table by.

     */

    public function __construct(

        int $cmid,

        ?bool $submissionpluginenabled = null,

        ?int $submissioncount = null,

        ?assign $assign = null,

        array $userinitials = []

    ) {

        $this->cmid = $cmid;

        if (!$assign) {

            $context = context_module::instance($cmid);

            $assign = new assign($context, null, null);

        }

        $this->assign = $assign;

        $this->showdownload = $this->assign->is_any_submission_plugin_enabled() && $this->assign->count_submissions();

        $this->userinitials = $userinitials;

        // Check if we have the elevated view capablities to see the blind details.

        $this->hasviewblind = has_capability('mod/assign:viewblinddetails', $this->assign->get_context());

    }

    /**

     * Data to render in a template.

     *

     * @param \renderer_base $output renderer base output.

     * @return array Data to render.

     */

    public function export_for_template(\renderer_base $output): array {

        global $PAGE;

        $course = $this->assign->get_course();

        $cm = get_coursemodule_from_id('assign', $this->cmid);

        $data = [];

        $userid = optional_param('userid', null, PARAM_INT);

        // If the user ID is set, it indicates that a user has been selected. In this case, override the user search

        // string with the full name of the selected user.

        $usersearch = $userid ? fullname(\core_user::get_user($userid)) : optional_param('search', '', PARAM_NOTAGS);

        $isblind = $this->assign->is_blind_marking() && !$this->hasviewblind;

        if ($isblind) {

            $usersearch = $userid ? get_string('hiddenuser', 'assign') . $this->assign->get_uniqueid_for_user($userid) : $usersearch;

        }

        $resetlink = new moodle_url('/mod/assign/view.php', ['id' => $this->cmid, 'action' => 'grading']);

        $groupid = groups_get_course_group($course, true);

        $userselector = new user_selector(

            course: $course,

            resetlink: $resetlink,

            userid: !$isblind ? $userid : null,

            groupid: $groupid,

            usersearch: $usersearch,

            instanceid: $this->assign->get_instance()->id

        );

        $data['userselector'] = $userselector->export_for_template($output);

        $hasinitials = !empty($this->userinitials['firstname']) || !empty($this->userinitials['lastname']);

        $additionalparams = ['action' => 'grading', 'id' => $this->cmid];

        if (!empty($userid)) {

            $additionalparams['userid'] = $userid;

        } else if (!empty($usersearch)) {

            $additionalparams['search'] = $usersearch;

        }

        $initialselector = new \core_course\output\actionbar\initials_selector(

            course: $course,

            targeturl: 'mod/assign/view.php',

            firstinitial: $this->userinitials['firstname'] ?? '',

            lastinitial: $this->userinitials['lastname'] ?? '',

            firstinitialparam: 'tifirst',

            lastinitialparam: 'tilast',

            additionalparams: $additionalparams

        );

        $data['initialselector'] = $initialselector->export_for_template($output);

        if (groups_get_activity_groupmode($cm, $course)) {

            $gs = new group_selector($PAGE->context);

            $data['groupselector'] = $gs->export_for_template($output);

        }

        if ($extrafiltersdropdown = $this->get_extra_filters_dropdown()) {

            $PAGE->requires->js_call_amd('mod_assign/actionbar/grading/extra_filters_dropdown', 'init', []);

            $data['extrafiltersdropdown'] = $extrafiltersdropdown->export_for_template($output);

        }

        $activitygroup = groups_get_activity_group($cm);

        $hasuserfilter = get_user_preferences('assign_filter');

        $hasextrafilters = $this->get_applied_extra_filters_count() > 0;

        if ($activitygroup || $hasuserfilter || $hasextrafilters || $hasinitials) {

            $url = new moodle_url('/mod/assign/view.php', [

                'id' => $this->cmid,

                'action' => 'grading',

                'group' => 0,

                'status' => '',

                'workflowfilter' => '',

                'markingallocationfilter' => '',

                'suspendedparticipantsfilter' => 0,

                'tifirst' => '',

                'tilast' => '',

            ]);

            $data['pagereset'] = $url->out(false);

        }

        if ($this->assign->is_any_submission_plugin_enabled()) {

            ['statusmenu' => $statusmenu, 'currentvalue' => $currentvalue] = $this->get_status_menu();

            $statusselect = new \core\output\select_menu('status', $statusmenu, $currentvalue);

            $statusselect->set_label(get_string('status', 'mod_assign'), [], true);

            $data['statusselector'] = $statusselect->export_for_template($output);

        }

        if ($this->assign->can_grade()) {

            $url = new moodle_url('/mod/assign/view.php', [

                'id' => $this->assign->get_course_module()->id,

                'action' => 'grader',

            ]);

            $data['graderurl'] = $url->out(false);

        }

        $gradingmanager = get_grading_manager($this->assign->get_context(), 'mod_assign', 'submissions');

        $controller = $gradingmanager->get_active_controller();

        $showquickgrading = empty($controller) && $this->assign->can_grade();

        if ($showquickgrading) {

            $quickgradingbaseurl = new moodle_url('/mod/assign/view.php', [

                'id' => $this->assign->get_course_module()->id,

                'action' => 'grading',

            ]);

            if ($userid) {

                $quickgradingbaseurl->param('userid', $userid);

            } else if ($usersearch) {

                $quickgradingbaseurl->param('search', $usersearch);

            }

            $data['quickgrading'] = [

                'baseurl' => $quickgradingbaseurl->out(false),

                'enabled' => get_user_preferences('assign_quickgrading', false),

            ];

        }

        if ($this->showdownload) {

            $downloadasfoldersbaseurl = new moodle_url('/mod/assign/view.php', [

                'id' => $this->assign->get_course_module()->id,

                'action' => 'grading',

            ]);

            if ($userid) {

                $downloadasfoldersbaseurl->param('userid', $userid);

            } else if ($usersearch) {

                $downloadasfoldersbaseurl->param('search', $usersearch);

            }

            $downloadasfolders = get_user_preferences('assign_downloadasfolders', 1);

            $data['downloadasfolders'] = [

                'baseurl' => $downloadasfoldersbaseurl->out(false),

                'enabled' => $downloadasfolders,

            ];

        }

        $actions = $this->get_actions();

        if ($actions) {

            $menu = new \action_menu();

            $menu->set_menu_trigger(get_string('actions'), 'btn btn-outline-primary');

            foreach ($actions as $groupkey => $actiongroup) {

                foreach ($actiongroup as $label => $url) {

                    $menu->add(new \action_menu_link_secondary(new \moodle_url($url), null, $label));

                }

                if ($groupkey !== array_key_last($actions)) {

                    $divider = new \action_menu_filler();

                    $divider->primary = false;

                    $menu->add($divider);

                }

            }

            $renderer = $PAGE->get_renderer('core');

            $data['actions'] = $renderer->render($menu);

        }

        return $data;

    }

    /**

     * Get the actions for the grading action menu.

     *

     * @return array A 2D array of actions grouped by a key in the form of key => label => URL.

     */

    private function get_actions() {

        $actions = [];

        if (

            has_capability('gradereport/grader:view', $this->assign->get_course_context())

            && has_capability('moodle/grade:viewall', $this->assign->get_course_context())

        ) {

            $url = new moodle_url('/grade/report/grader/index.php', ['id' => $this->assign->get_course()->id]);

            $actions['gradebook'][get_string('viewgradebook', 'assign')] = $url->out(false);

        }

        if ($this->assign->is_blind_marking() && has_capability('mod/assign:revealidentities', $this->assign->get_context())) {

            $url = new moodle_url('/mod/assign/view.php', [

                'id' => $this->assign->get_course_module()->id,

                'action' => 'revealidentities',

            ]);

            $actions['blindmarking'][get_string('revealidentities', 'assign')] = $url->out(false);

        }

        foreach ($this->assign->get_feedback_plugins() as $plugin) {

            if ($plugin->is_enabled() && $plugin->is_visible()) {

                foreach ($plugin->get_grading_actions() as $action => $description) {

                    $url = new moodle_url('/mod/assign/view.php', [

                        'id' => $this->assign->get_course_module()->id,

                        'plugin' => $plugin->get_type(),

                        'pluginsubtype' => 'assignfeedback',

                        'action' => 'viewpluginpage',

                        'pluginaction' => $action,

                    ]);

                    $actions['assignfeedback_' . $plugin->get_type()][$description] = $url->out(false);

                }

            }

        }

        if ($this->showdownload) {

            $url = new moodle_url('/mod/assign/view.php', [

                'id' => $this->assign->get_course_module()->id,

                'action' => 'downloadall',

            ]);

            $actions['downloadall'][get_string('downloadall', 'mod_assign')] = $url->out(false);

        }

        return $actions;

    }

    /**

     * Get the status menu for the grading action menu.

     *

     * @return array An array containing the status menu and the current value.

     */

    private function get_status_menu(): array {

        $statusmenu = [];

        $currentvalue = '';

        $groupedfilters = $this->assign->get_filters(true);

        foreach ($groupedfilters as $group => $filters) {

            foreach ($filters as $filter) {

                if ($filter['key'] === ASSIGN_FILTER_NONE) {

                    // The 'none' filter is not a real filter.

                    $filter['key'] = '';

                }

                $url = new moodle_url('/mod/assign/view.php', [

                    'id' => $this->assign->get_course_module()->id,

                    'action' => 'grading',

                    'status' => $filter['key'],

                ]);

                $statusmenu[$url->out(false)] = $filter['name'];

                if ($filter['active']) {

                    $currentvalue = $url->out(false);

                }

            }

            if ($group !== array_key_last($groupedfilters)) {

                $statusmenu[] = '';

            }

        }

        return [

            'statusmenu' => $statusmenu,

            'currentvalue' => $currentvalue,

        ];

    }

    /**

     * The renderable for the extra filters dropdown, if available.

     *

     * @return dialog|null The renderable for the extra filters dropdown, if available.

     */

    private function get_extra_filters_dropdown(): ?dialog {

        global $OUTPUT;

        $dropdowncontentdata = [

            'actionurl' => (new moodle_url('/mod/assign/view.php'))->out(false),

            'id' => $this->assign->get_course_module()->id,

            'action' => 'grading',

            'filters' => [],

        ];

        // If marking workflow is enabled.

        if ($this->assign->get_instance()->markingworkflow) {

            $dropdowncontentdata['filters']['markingworkflow'] = [

                'workflowfilteroptions' => $this->assign->get_marking_workflow_filters(true),

            ];

            // If marking allocation is enabled and the user has the capability to manage marker allocations.

            if ($this->assign->get_instance()->markingallocation &&

                    has_capability('mod/assign:manageallocations', $this->assign->get_context())) {

                $dropdowncontentdata['filters']['markingallocation'] = [

                    'markingallocationoptions' => $this->assign->get_marking_allocation_filters(true),

                ];

            }

        }

        if (has_capability('moodle/course:viewsuspendedusers', $this->assign->get_context())) {

            $dropdowncontentdata['filters']['suspendedparticipants'] = [

                'active' => !$this->assign->show_only_active_users(),

            ];

        }

        // If there are no available filters, return null.

        if (empty($dropdowncontentdata['filters'])) {

            return null;

        }

        // Define the content output for the extra filters dropdown menu.

        $dropdowncontent = $OUTPUT->render_from_template(

            'mod_assign/actionbar/grading/extra_filters_dropdown_body',

            $dropdowncontentdata

        );

        // Define the output for the extra filters dropdown trigger.

        $buttoncontent = $OUTPUT->render_from_template(

            'mod_assign/actionbar/grading/extra_filters_dropdown_trigger',

            ['appliedfilterscount' => $this->get_applied_extra_filters_count()]

        );

        return new dialog(

            $buttoncontent,

            $dropdowncontent,

            [

                'classes' => 'extrafilters d-flex',

                'buttonclasses' => 'btn d-flex border-none align-items-center dropdown-toggle p-0',

                'autoclose' => 'outside',

            ]

        );

    }

    /**

     * Returns the number of applied extra filters.

     *

     * @return int The number of applied extra filters.

     */

    private function get_applied_extra_filters_count(): int {

        $appliedextrafilterscount = 0;

        // If marking workflow is enabled.

        if ($this->assign->get_instance()->markingworkflow) {

            if (get_user_preferences('assign_workflowfilter')) {

                $appliedextrafilterscount++;

            }

            $canallocatemarker = $this->assign->get_instance()->markingallocation &&

                has_capability('mod/assign:manageallocations', $this->assign->get_context());

            if ($canallocatemarker && get_user_preferences('assign_markerfilter')) {

                $appliedextrafilterscount++;

            }

        }

        // If suspended participants are included.

        if (!$this->assign->show_only_active_users()) {

            $appliedextrafilterscount++;

        }

        return $appliedextrafilterscount;

    }

}