mod/quiz/override_form.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Settings form for overrides in the quiz module.
  19  *
  20  * @package    mod_quiz
  21  * @copyright  2010 Matt Petro
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 require_once($CFG->libdir . '/formslib.php');
  29 require_once($CFG->dirroot . '/mod/quiz/mod_form.php');
  30
  31
  32 /**
  33  * Form for editing settings overrides.
  34  *
  35  * @copyright  2010 Matt Petro
  36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37  */
  38 class quiz_override_form extends moodleform {
  39
  40     /** @var cm_info course module object. */
  41     protected $cm;
  42
  43     /** @var stdClass the quiz settings object. */
  44     protected $quiz;
  45
  46     /** @var context the quiz context. */
  47     protected $context;
  48
  49     /** @var bool editing group override (true) or user override (false). */
  50     protected $groupmode;
  51
  52     /** @var int groupid, if provided. */
  53     protected $groupid;
  54
  55     /** @var int userid, if provided. */
  56     protected $userid;
  57
  58     /**
  59      * Constructor.
  60      * @param moodle_url $submiturl the form action URL.
  61      * @param object course module object.
  62      * @param object the quiz settings object.
  63      * @param context the quiz context.
  64      * @param bool editing group override (true) or user override (false).
  65      * @param object $override the override being edited, if it already exists.
  66      */
  67     public function __construct($submiturl, $cm, $quiz, $context, $groupmode, $override) {
  68
  69         $this->cm = $cm;
  70         $this->quiz = $quiz;
  71         $this->context = $context;
  72         $this->groupmode = $groupmode;
  73         $this->groupid = empty($override->groupid) ? 0 : $override->groupid;
  74         $this->userid = empty($override->userid) ? 0 : $override->userid;
  75
  76         parent::__construct($submiturl);
  77     }
  78
  79     protected function definition() {
  80         global $DB;
  81
  82         $cm = $this->cm;
  83         $mform = $this->_form;
  84
  85         $mform->addElement('header', 'override', get_string('override', 'quiz'));
  86
  87         $quizgroupmode = groups_get_activity_groupmode($cm);
  88         $accessallgroups = ($quizgroupmode == NOGROUPS) || has_capability('moodle/site:accessallgroups', $this->context);
  89
  90         if ($this->groupmode) {
  91             // Group override.
  92             if ($this->groupid) {
  93                 // There is already a groupid, so freeze the selector.
  94                 $groupchoices = array();
  95                 $groupchoices[$this->groupid] = groups_get_group_name($this->groupid);
  96                 $mform->addElement('select', 'groupid',
  97                         get_string('overridegroup', 'quiz'), $groupchoices);
  98                 $mform->freeze('groupid');
  99             } else {
 100                 // Prepare the list of groups.
 101                 // Only include the groups the current can access.
 102                 $groups = $accessallgroups ? groups_get_all_groups($cm->course) : groups_get_activity_allowed_groups($cm);
 103                 if (empty($groups)) {
 104                     // Generate an error.
 105                     $link = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$cm->id));
 106                     print_error('groupsnone', 'quiz', $link);
 107                 }
 108
 109                 $groupchoices = array();
 110                 foreach ($groups as $group) {
 111                     $groupchoices[$group->id] = $group->name;
 112                 }
 113                 unset($groups);
 114
 115                 if (count($groupchoices) == 0) {
 116                     $groupchoices[0] = get_string('none');
 117                 }
 118
 119                 $mform->addElement('select', 'groupid',
 120                         get_string('overridegroup', 'quiz'), $groupchoices);
 121                 $mform->addRule('groupid', get_string('required'), 'required', null, 'client');
 122             }
 123         } else {
 124             // User override.
 125             $userfieldsapi = \core_user\fields::for_identity($this->context)->with_userpic()->with_name();
 126             $extrauserfields = $userfieldsapi->get_required_fields([\core_user\fields::PURPOSE_IDENTITY]);
 127             if ($this->userid) {
 128                 // There is already a userid, so freeze the selector.
 129                 $user = $DB->get_record('user', ['id' => $this->userid]);
 130                 profile_load_custom_fields($user);
 131                 $userchoices = array();
 132                 $userchoices[$this->userid] = self::display_user_name($user, $extrauserfields);
 133                 $mform->addElement('select', 'userid',
 134                         get_string('overrideuser', 'quiz'), $userchoices);
 135                 $mform->freeze('userid');
 136             } else {
 137                 // Prepare the list of users.
 138
 139                 // Get the list of appropriate users, depending on whether and how groups are used.
 140                 $userfieldsql = $userfieldsapi->get_sql('u', true, '', '', false);
 141                 $capabilityjoin = get_with_capability_join($this->context, 'mod/quiz:attempt', 'u.id');
 142                 list($sort, $sortparams) = users_order_by_sql('u', null,
 143                         $this->context, $userfieldsql->mappings);
 144
 145                 $groupjoin = '';
 146                 $groupparams = [];
 147                 if (!$accessallgroups) {
 148                     $groups = groups_get_activity_allowed_groups($cm);
 149                     list($grouptest, $groupparams) = $DB->get_in_or_equal(
 150                             array_keys($groups), SQL_PARAMS_NAMED, 'grp');
 151                     $groupjoin = "JOIN (SELECT DISTINCT userid
 152                                   FROM {groups_members}
 153                                  WHERE groupid $grouptest
 154                                        ) gm ON gm.userid = u.id";
 155                 }
 156
 157                 $capabilitywhere = '';
 158                 if ($capabilityjoin->wheres) {
 159                     $capabilitywhere = 'AND ' . $capabilityjoin->wheres;
 160                 }
 161
 162                 $users = $DB->get_records_sql("
 163                         SELECT $userfieldsql->selects
 164                           FROM {user} u
 165                           LEFT JOIN {quiz_overrides} existingoverride ON
 166                                       existingoverride.userid = u.id AND existingoverride.quiz = :quizid
 167                           $capabilityjoin->joins
 168                           $groupjoin
 169                           $userfieldsql->joins
 170                          WHERE existingoverride.id IS NULL
 171                            $capabilitywhere
 172                       ORDER BY $sort
 173                         ", array_merge(['quizid' => $this->quiz->id], $capabilityjoin->params,
 174                         $groupparams, $userfieldsql->params, $sortparams));
 175
 176                 // Filter users based on any fixed restrictions (groups, profile).
 177                 $info = new \core_availability\info_module($cm);
 178                 $users = $info->filter_user_list($users);
 179
 180                 if (empty($users)) {
 181                     // Generate an error.
 182                     $link = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$cm->id));
 183                     print_error('usersnone', 'quiz', $link);
 184                 }
 185
 186                 $userchoices = [];
 187                 foreach ($users as $id => $user) {
 188                     $userchoices[$id] = self::display_user_name($user, $extrauserfields);
 189                 }
 190                 unset($users);
 191
 192                 $mform->addElement('searchableselector', 'userid',
 193                         get_string('overrideuser', 'quiz'), $userchoices);
 194                 $mform->addRule('userid', get_string('required'), 'required', null, 'client');
 195             }
 196         }
 197
 198         // Password.
 199         // This field has to be above the date and timelimit fields,
 200         // otherwise browsers will clear it when those fields are changed.
 201         $mform->addElement('passwordunmask', 'password', get_string('requirepassword', 'quiz'));
 202         $mform->setType('password', PARAM_TEXT);
 203         $mform->addHelpButton('password', 'requirepassword', 'quiz');
 204         $mform->setDefault('password', $this->quiz->password);
 205
 206         // Open and close dates.
 207         $mform->addElement('date_time_selector', 'timeopen',
 208                 get_string('quizopen', 'quiz'), mod_quiz_mod_form::$datefieldoptions);
 209         $mform->setDefault('timeopen', $this->quiz->timeopen);
 210
 211         $mform->addElement('date_time_selector', 'timeclose',
 212                 get_string('quizclose', 'quiz'), mod_quiz_mod_form::$datefieldoptions);
 213         $mform->setDefault('timeclose', $this->quiz->timeclose);
 214
 215         // Time limit.
 216         $mform->addElement('duration', 'timelimit',
 217                 get_string('timelimit', 'quiz'), array('optional' => true));
 218         $mform->addHelpButton('timelimit', 'timelimit', 'quiz');
 219         $mform->setDefault('timelimit', $this->quiz->timelimit);
 220
 221         // Number of attempts.
 222         $attemptoptions = array('0' => get_string('unlimited'));
 223         for ($i = 1; $i <= QUIZ_MAX_ATTEMPT_OPTION; $i++) {
 224             $attemptoptions[$i] = $i;
 225         }
 226         $mform->addElement('select', 'attempts',
 227                 get_string('attemptsallowed', 'quiz'), $attemptoptions);
 228         $mform->addHelpButton('attempts', 'attempts', 'quiz');
 229         $mform->setDefault('attempts', $this->quiz->attempts);
 230
 231         // Submit buttons.
 232         $mform->addElement('submit', 'resetbutton',
 233                 get_string('reverttodefaults', 'quiz'));
 234
 235         $buttonarray = array();
 236         $buttonarray[] = $mform->createElement('submit', 'submitbutton',
 237                 get_string('save', 'quiz'));
 238         $buttonarray[] = $mform->createElement('submit', 'againbutton',
 239                 get_string('saveoverrideandstay', 'quiz'));
 240         $buttonarray[] = $mform->createElement('cancel');
 241
 242         $mform->addGroup($buttonarray, 'buttonbar', '', array(' '), false);
 243         $mform->closeHeaderBefore('buttonbar');
 244     }
 245
 246     /**
 247      * Get a user's name and identity ready to display.
 248      *
 249      * @param stdClass $user a user object.
 250      * @param array $extrauserfields (identity fields in user table only from the user_fields API)
 251      * @return string User's name, with extra info, for display.
 252      */
 253     public static function display_user_name(stdClass $user, array $extrauserfields): string {
 254         $username = fullname($user);
 255         $namefields = [];
 256         foreach ($extrauserfields as $field) {
 257             if (isset($user->$field) && $user->$field !== '') {
 258                 $namefields[] = s($user->$field);
 259             } else if (strpos($field, 'profile_field_') === 0) {
 260                 $field = substr($field, 14);
 261                 if (isset($user->profile[$field]) && $user->profile[$field] !== '') {
 262                     $namefields[] = s($user->profile[$field]);
 263                 }
 264             }
 265         }
 266         if ($namefields) {
 267             $username .= ' (' . implode(', ', $namefields) . ')';
 268         }
 269         return $username;
 270     }
 271
 272     public function validation($data, $files): array {
 273         $errors = parent::validation($data, $files);
 274
 275         $mform =& $this->_form;
 276         $quiz = $this->quiz;
 277
 278         if ($mform->elementExists('userid')) {
 279             if (empty($data['userid'])) {
 280                 $errors['userid'] = get_string('required');
 281             }
 282         }
 283
 284         if ($mform->elementExists('groupid')) {
 285             if (empty($data['groupid'])) {
 286                 $errors['groupid'] = get_string('required');
 287             }
 288         }
 289
 290         // Ensure that the dates make sense.
 291         if (!empty($data['timeopen']) && !empty($data['timeclose'])) {
 292             if ($data['timeclose'] < $data['timeopen'] ) {
 293                 $errors['timeclose'] = get_string('closebeforeopen', 'quiz');
 294             }
 295         }
 296
 297         // Ensure that at least one quiz setting was changed.
 298         $changed = false;
 299         $keys = array('timeopen', 'timeclose', 'timelimit', 'attempts', 'password');
 300         foreach ($keys as $key) {
 301             if ($data[$key] != $quiz->{$key}) {
 302                 $changed = true;
 303                 break;
 304             }
 305         }
 306         if (!$changed) {
 307             $errors['timeopen'] = get_string('nooverridedata', 'quiz');
 308         }
 309
 310         return $errors;
 311     }
 312 }