MDL-22388 Added some checks to kill these scripts dead with an unequivocal notice...
[moodle.git] / mod / quiz / override_form.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * Settings form for overrides in the quiz module.
21  *
22  * @package mod_quiz
23  * @copyright 2010 Matt Petro
24  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 if (!defined('MOODLE_INTERNAL')) {
28     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
29 }
31 require_once $CFG->libdir.'/formslib.php';
33 class quiz_override_form extends moodleform {
35     protected $cm;          // course module object
36     protected $quiz;        // quiz object
37     protected $context;     // context object
38     protected $groupmode;   // editing group override (true) or user override (false)
39     protected $groupid;     // groupid, if provided
40     protected $userid;      // userid, if provided
42     public function quiz_override_form($submiturl, $cm, $quiz, $context, $groupmode, $override) {
44         $this->cm = $cm;
45         $this->quiz = $quiz;
46         $this->context = $context;
47         $this->groupmode = $groupmode;
48         $this->groupid = empty($override->groupid) ? 0 : $override->groupid;
49         $this->userid = empty($override->userid) ? 0 : $override->userid;
51         parent::moodleform($submiturl, null, 'post');
53     }
55     public function definition() {
56         global $CFG, $USER, $DB;
58         $cm = $this->cm;
59         $mform = $this->_form;
61         $mform->addElement('header', 'override', get_string('override', 'quiz'));
63         if ($this->groupmode) {
64             // group override
65             if ($this->groupid) {
66                 // There is already a groupid, so freeze the selector
67                 $groupchoices = array();
68                 $groupchoices[$this->groupid] = groups_get_group_name($this->groupid);
69                 $mform->addElement('select', 'groupid', get_string('overridegroup', 'quiz'), $groupchoices);
70                 $mform->freeze('groupid');
71             } else {
72                 // Prepare the list of groups
73                 $groups = groups_get_all_groups($cm->course);
74                 if (empty($groups)) {
75                     // generate an error
76                     $link = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$cm->id));
77                     print_error('groupsnone', 'quiz', $link);
78                 }
80                 $groupchoices = array();
81                 foreach ($groups as $group) {
82                     $groupchoices[$group->id] = $group->name;
83                 }
84                 unset($groups);
86                 if (count($groupchoices) == 0) {
87                     $groupchoices[0] = get_string('none');
88                 }
90                 $mform->addElement('select', 'groupid', get_string('overridegroup', 'quiz'), $groupchoices);
91                 $mform->addRule('groupid', get_string('required'), 'required', null, 'client');
92             }
93         } else {
94             //user override
95             if ($this->userid) {
96                 // There is already a userid, so freeze the selector
97                 $user = $DB->get_record('user', array('id'=>$this->userid));
98                 $userchoices = array();
99                 $userchoices[$this->userid] = fullname($user);
100                 $mform->addElement('select', 'userid', get_string('overrideuser', 'quiz'), $userchoices);
101                 $mform->freeze('userid');
102             } else {
103                 // Prepare the list of users
104                 $users = array();
105                 if (!empty($CFG->enablegroupmembersonly) && $cm->groupmembersonly) {
106                     // only users from the grouping
107                     $groups = groups_get_all_groups($cm->course, 0, $cm->groupingid);
108                     if (empty($groups)) {
109                         // empty grouping
110                     } else {
111                         $users = get_users_by_capability($this->context, 'mod/quiz:attempt', 'u.id,u.firstname,u.lastname,u.email' ,
112                                     'firstname ASC, lastname ASC', '', '', array_keys($groups), '', false, true);
113                     }
114                 } else {
115                     $users = get_users_by_capability($this->context, 'mod/quiz:attempt', 'u.id,u.firstname,u.lastname,u.email' ,
116                                     'firstname ASC, lastname ASC', '', '', '', '', false, true);
117                 }
118                 if (empty($users)) {
119                     // generate an error
120                     $link = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$cm->id));
121                     print_error('usersnone', 'quiz', $link);
122                 }
124                 $userchoices = array();
125                 foreach ($users as $id=>$user) {
126                     if (empty($invalidusers[$id]) || (!empty($override) && $id == $override->userid)) {
127                         $userchoices[$id] = fullname($user) . ', ' . $user->email;
128                     }
129                 }
130                 unset($users);
132                 if (count($userchoices) == 0) {
133                     $userchoices[0] = get_string('none');
134                 }
135                 $mform->addElement('searchableselector', 'userid', get_string('overrideuser', 'quiz'), $userchoices);
136                 $mform->addRule('userid', get_string('required'), 'required', null, 'client');
137             }
138         }
140         // Password
141         // This field has to be above the date and timelimit fields,
142         // otherwise browsers will clear it when those fields are changed
143         $mform->addElement('passwordunmask', 'password', get_string('requirepassword', 'quiz'));
144         $mform->setType('password', PARAM_TEXT);
145         $mform->setHelpButton('password', array('requirepassword', get_string('requirepassword', 'quiz'), 'quiz'));
146         $mform->setDefault('password', $this->quiz->password);
148         // Open and close dates.
149         $mform->addElement('date_time_selector', 'timeopen', get_string('quizopen', 'quiz'), array('optional' => true));
150         $mform->setHelpButton('timeopen', array('timeopen', get_string('quizopen', 'quiz'), 'quiz'));
151         $mform->setDefault('timeopen', $this->quiz->timeopen);
153         $mform->addElement('date_time_selector', 'timeclose', get_string('quizclose', 'quiz'), array('optional' => true));
154         $mform->setHelpButton('timeclose', array('timeopen', get_string('quizclose', 'quiz'), 'quiz'));
155         $mform->setDefault('timeclose', $this->quiz->timeclose);
157         // Time limit.
158         $mform->addElement('duration', 'timelimit', get_string('quiztimer', 'quiz'), array('optional' => true));
159         $mform->setHelpButton('timelimit', array('timelimit', get_string('quiztimer','quiz'), 'quiz'));
160         $mform->setDefault('timelimit', $this->quiz->timelimit);
162         // Number of attempts.
163         $attemptoptions = array('0' => get_string('unlimited'));
164         for ($i = 1; $i <= QUIZ_MAX_ATTEMPT_OPTION; $i++) {
165             $attemptoptions[$i] = $i;
166         }
167         $mform->addElement('select', 'attempts', get_string('attemptsallowed', 'quiz'), $attemptoptions);
168         $mform->setHelpButton('attempts', array('attempts', get_string('attemptsallowed','quiz'), 'quiz'));
169         $mform->setDefault('attempts', $this->quiz->attempts);
171         // Submit buttons
172         $mform->addElement('submit', 'resetbutton', get_string('reverttodefaults','quiz'));
174         $buttonarray = array();
175         $buttonarray[] = $mform->createElement('submit', 'submitbutton', get_string('save', 'quiz'));
176         $buttonarray[] = $mform->createElement('submit', 'againbutton', get_string('saveoverrideandstay', 'quiz'));
177         $buttonarray[] = $mform->createElement('cancel');
179         $mform->addGroup($buttonarray, 'buttonbar', '', array(' '), false);
180         $mform->closeHeaderBefore('buttonbar');
182     }
184     // form verification
185     public function validation($data, $files) {
186         global $COURSE, $DB;
187         $errors = parent::validation($data, $files);
189         $mform =& $this->_form;
190         $quiz = $this->quiz;
192         if ($mform->elementExists('userid')) {
193             if (empty($data['userid'])) {
194                 $errors['userid'] = get_string('required');
195             }
196         }
198         if ($mform->elementExists('groupid')) {
199             if (empty($data['groupid'])) {
200                 $errors['groupid'] = get_string('required');
201             }
202         }
204         // Ensure that the dates make sense
205         if (!empty($data['timeopen']) && !empty($data['timeclose'])) {
206             if ($data['timeclose'] < $data['timeopen'] ) {
207                 $errors['timeclose'] = get_string('closebeforeopen', 'quiz');
208             }
209         }
211         // Ensure that at least one quiz setting was changed
212         $changed = false;
213         $keys = array('timeopen','timeclose', 'timelimit', 'attempts', 'password');
214         foreach ($keys as $key) {
215             if ($data[$key] != $quiz->{$key}) {
216                 $changed = true;
217                 break;
218             }
219         }
220         if (!$changed) {
221             $errors['timeopen'] = get_string('nooverridedata', 'quiz');
222         }
224         return $errors;
225     }