MDL-43628 mod_assign: fixed formatting of statement
[moodle.git] / mod / assign / locallib.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/>.
17 /**
18  * This file contains the definition for the class assignment
19  *
20  * This class provides all the functionality for the new assign module.
21  *
22  * @package   mod_assign
23  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 // Assignment submission statuses.
30 define('ASSIGN_SUBMISSION_STATUS_NEW', 'new');
31 define('ASSIGN_SUBMISSION_STATUS_REOPENED', 'reopened');
32 define('ASSIGN_SUBMISSION_STATUS_DRAFT', 'draft');
33 define('ASSIGN_SUBMISSION_STATUS_SUBMITTED', 'submitted');
35 // Search filters for grading page.
36 define('ASSIGN_FILTER_SUBMITTED', 'submitted');
37 define('ASSIGN_FILTER_NOT_SUBMITTED', 'notsubmitted');
38 define('ASSIGN_FILTER_SINGLE_USER', 'singleuser');
39 define('ASSIGN_FILTER_REQUIRE_GRADING', 'require_grading');
41 // Marker filter for grading page.
42 define('ASSIGN_MARKER_FILTER_NO_MARKER', -1);
44 // Reopen attempt methods.
45 define('ASSIGN_ATTEMPT_REOPEN_METHOD_NONE', 'none');
46 define('ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL', 'manual');
47 define('ASSIGN_ATTEMPT_REOPEN_METHOD_UNTILPASS', 'untilpass');
49 // Special value means allow unlimited attempts.
50 define('ASSIGN_UNLIMITED_ATTEMPTS', -1);
52 // Marking workflow states.
53 define('ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED', 'notmarked');
54 define('ASSIGN_MARKING_WORKFLOW_STATE_INMARKING', 'inmarking');
55 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORREVIEW', 'readyforreview');
56 define('ASSIGN_MARKING_WORKFLOW_STATE_INREVIEW', 'inreview');
57 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORRELEASE', 'readyforrelease');
58 define('ASSIGN_MARKING_WORKFLOW_STATE_RELEASED', 'released');
60 // Name of file area for intro attachments.
61 define('ASSIGN_INTROATTACHMENT_FILEAREA', 'introattachment');
63 require_once($CFG->libdir . '/accesslib.php');
64 require_once($CFG->libdir . '/formslib.php');
65 require_once($CFG->dirroot . '/repository/lib.php');
66 require_once($CFG->dirroot . '/mod/assign/mod_form.php');
67 require_once($CFG->libdir . '/gradelib.php');
68 require_once($CFG->dirroot . '/grade/grading/lib.php');
69 require_once($CFG->dirroot . '/mod/assign/feedbackplugin.php');
70 require_once($CFG->dirroot . '/mod/assign/submissionplugin.php');
71 require_once($CFG->dirroot . '/mod/assign/renderable.php');
72 require_once($CFG->dirroot . '/mod/assign/gradingtable.php');
73 require_once($CFG->libdir . '/eventslib.php');
74 require_once($CFG->libdir . '/portfolio/caller.php');
76 /**
77  * Standard base class for mod_assign (assignment types).
78  *
79  * @package   mod_assign
80  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
81  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
82  */
83 class assign {
85     /** @var stdClass the assignment record that contains the global settings for this assign instance */
86     private $instance;
88     /** @var stdClass the grade_item record for this assign instance's primary grade item. */
89     private $gradeitem;
91     /** @var context the context of the course module for this assign instance
92      *               (or just the course if we are creating a new one)
93      */
94     private $context;
96     /** @var stdClass the course this assign instance belongs to */
97     private $course;
99     /** @var stdClass the admin config for all assign instances  */
100     private $adminconfig;
102     /** @var assign_renderer the custom renderer for this module */
103     private $output;
105     /** @var cm_info the course module for this assign instance */
106     private $coursemodule;
108     /** @var array cache for things like the coursemodule name or the scale menu -
109      *             only lives for a single request.
110      */
111     private $cache;
113     /** @var array list of the installed submission plugins */
114     private $submissionplugins;
116     /** @var array list of the installed feedback plugins */
117     private $feedbackplugins;
119     /** @var string action to be used to return to this page
120      *              (without repeating any form submissions etc).
121      */
122     private $returnaction = 'view';
124     /** @var array params to be used to return to this page */
125     private $returnparams = array();
127     /** @var string modulename prevents excessive calls to get_string */
128     private static $modulename = null;
130     /** @var string modulenameplural prevents excessive calls to get_string */
131     private static $modulenameplural = null;
133     /** @var array of marking workflow states for the current user */
134     private $markingworkflowstates = null;
136     /** @var bool whether to exclude users with inactive enrolment */
137     private $showonlyactiveenrol = null;
139     /** @var array cached list of participants for this assignment. The cache key will be group, showactive and the context id */
140     private $participants = array();
142     /**
143      * Constructor for the base assign class.
144      *
145      * Note: For $coursemodule you can supply a stdclass if you like, but it
146      * will be more efficient to supply a cm_info object.
147      *
148      * @param mixed $coursemodulecontext context|null the course module context
149      *                                   (or the course context if the coursemodule has not been
150      *                                   created yet).
151      * @param mixed $coursemodule the current course module if it was already loaded,
152      *                            otherwise this class will load one from the context as required.
153      * @param mixed $course the current course  if it was already loaded,
154      *                      otherwise this class will load one from the context as required.
155      */
156     public function __construct($coursemodulecontext, $coursemodule, $course) {
157         $this->context = $coursemodulecontext;
158         $this->course = $course;
160         // Ensure that $this->coursemodule is a cm_info object (or null).
161         $this->coursemodule = cm_info::create($coursemodule);
163         // Temporary cache only lives for a single request - used to reduce db lookups.
164         $this->cache = array();
166         $this->submissionplugins = $this->load_plugins('assignsubmission');
167         $this->feedbackplugins = $this->load_plugins('assignfeedback');
168     }
170     /**
171      * Set the action and parameters that can be used to return to the current page.
172      *
173      * @param string $action The action for the current page
174      * @param array $params An array of name value pairs which form the parameters
175      *                      to return to the current page.
176      * @return void
177      */
178     public function register_return_link($action, $params) {
179         global $PAGE;
180         $params['action'] = $action;
181         $currenturl = $PAGE->url;
183         $currenturl->params($params);
184         $PAGE->set_url($currenturl);
185     }
187     /**
188      * Return an action that can be used to get back to the current page.
189      *
190      * @return string action
191      */
192     public function get_return_action() {
193         global $PAGE;
195         $params = $PAGE->url->params();
197         if (!empty($params['action'])) {
198             return $params['action'];
199         }
200         return '';
201     }
203     /**
204      * Based on the current assignment settings should we display the intro.
205      *
206      * @return bool showintro
207      */
208     public function show_intro() {
209         if ($this->get_instance()->alwaysshowdescription ||
210                 time() > $this->get_instance()->allowsubmissionsfromdate) {
211             return true;
212         }
213         return false;
214     }
216     /**
217      * Return a list of parameters that can be used to get back to the current page.
218      *
219      * @return array params
220      */
221     public function get_return_params() {
222         global $PAGE;
224         $params = $PAGE->url->params();
225         unset($params['id']);
226         unset($params['action']);
227         return $params;
228     }
230     /**
231      * Set the submitted form data.
232      *
233      * @param stdClass $data The form data (instance)
234      */
235     public function set_instance(stdClass $data) {
236         $this->instance = $data;
237     }
239     /**
240      * Set the context.
241      *
242      * @param context $context The new context
243      */
244     public function set_context(context $context) {
245         $this->context = $context;
246     }
248     /**
249      * Set the course data.
250      *
251      * @param stdClass $course The course data
252      */
253     public function set_course(stdClass $course) {
254         $this->course = $course;
255     }
257     /**
258      * Get list of feedback plugins installed.
259      *
260      * @return array
261      */
262     public function get_feedback_plugins() {
263         return $this->feedbackplugins;
264     }
266     /**
267      * Get list of submission plugins installed.
268      *
269      * @return array
270      */
271     public function get_submission_plugins() {
272         return $this->submissionplugins;
273     }
275     /**
276      * Is blind marking enabled and reveal identities not set yet?
277      *
278      * @return bool
279      */
280     public function is_blind_marking() {
281         return $this->get_instance()->blindmarking && !$this->get_instance()->revealidentities;
282     }
284     /**
285      * Does an assignment have submission(s) or grade(s) already?
286      *
287      * @return bool
288      */
289     public function has_submissions_or_grades() {
290         $allgrades = $this->count_grades();
291         $allsubmissions = $this->count_submissions();
292         if (($allgrades == 0) && ($allsubmissions == 0)) {
293             return false;
294         }
295         return true;
296     }
298     /**
299      * Get a specific submission plugin by its type.
300      *
301      * @param string $subtype assignsubmission | assignfeedback
302      * @param string $type
303      * @return mixed assign_plugin|null
304      */
305     public function get_plugin_by_type($subtype, $type) {
306         $shortsubtype = substr($subtype, strlen('assign'));
307         $name = $shortsubtype . 'plugins';
308         if ($name != 'feedbackplugins' && $name != 'submissionplugins') {
309             return null;
310         }
311         $pluginlist = $this->$name;
312         foreach ($pluginlist as $plugin) {
313             if ($plugin->get_type() == $type) {
314                 return $plugin;
315             }
316         }
317         return null;
318     }
320     /**
321      * Get a feedback plugin by type.
322      *
323      * @param string $type - The type of plugin e.g comments
324      * @return mixed assign_feedback_plugin|null
325      */
326     public function get_feedback_plugin_by_type($type) {
327         return $this->get_plugin_by_type('assignfeedback', $type);
328     }
330     /**
331      * Get a submission plugin by type.
332      *
333      * @param string $type - The type of plugin e.g comments
334      * @return mixed assign_submission_plugin|null
335      */
336     public function get_submission_plugin_by_type($type) {
337         return $this->get_plugin_by_type('assignsubmission', $type);
338     }
340     /**
341      * Load the plugins from the sub folders under subtype.
342      *
343      * @param string $subtype - either submission or feedback
344      * @return array - The sorted list of plugins
345      */
346     protected function load_plugins($subtype) {
347         global $CFG;
348         $result = array();
350         $names = core_component::get_plugin_list($subtype);
352         foreach ($names as $name => $path) {
353             if (file_exists($path . '/locallib.php')) {
354                 require_once($path . '/locallib.php');
356                 $shortsubtype = substr($subtype, strlen('assign'));
357                 $pluginclass = 'assign_' . $shortsubtype . '_' . $name;
359                 $plugin = new $pluginclass($this, $name);
361                 if ($plugin instanceof assign_plugin) {
362                     $idx = $plugin->get_sort_order();
363                     while (array_key_exists($idx, $result)) {
364                         $idx +=1;
365                     }
366                     $result[$idx] = $plugin;
367                 }
368             }
369         }
370         ksort($result);
371         return $result;
372     }
374     /**
375      * Display the assignment, used by view.php
376      *
377      * The assignment is displayed differently depending on your role,
378      * the settings for the assignment and the status of the assignment.
379      *
380      * @param string $action The current action if any.
381      * @return string - The page output.
382      */
383     public function view($action='') {
385         $o = '';
386         $mform = null;
387         $notices = array();
388         $nextpageparams = array();
390         if (!empty($this->get_course_module()->id)) {
391             $nextpageparams['id'] = $this->get_course_module()->id;
392         }
394         // Handle form submissions first.
395         if ($action == 'savesubmission') {
396             $action = 'editsubmission';
397             if ($this->process_save_submission($mform, $notices)) {
398                 $action = 'redirect';
399                 $nextpageparams['action'] = 'view';
400             }
401         } else if ($action == 'editprevioussubmission') {
402             $action = 'editsubmission';
403             if ($this->process_copy_previous_attempt($notices)) {
404                 $action = 'redirect';
405                 $nextpageparams['action'] = 'editsubmission';
406             }
407         } else if ($action == 'lock') {
408             $this->process_lock_submission();
409             $action = 'redirect';
410             $nextpageparams['action'] = 'grading';
411         } else if ($action == 'addattempt') {
412             $this->process_add_attempt(required_param('userid', PARAM_INT));
413             $action = 'redirect';
414             $nextpageparams['action'] = 'grading';
415         } else if ($action == 'reverttodraft') {
416             $this->process_revert_to_draft();
417             $action = 'redirect';
418             $nextpageparams['action'] = 'grading';
419         } else if ($action == 'unlock') {
420             $this->process_unlock_submission();
421             $action = 'redirect';
422             $nextpageparams['action'] = 'grading';
423         } else if ($action == 'setbatchmarkingworkflowstate') {
424             $this->process_set_batch_marking_workflow_state();
425             $action = 'redirect';
426             $nextpageparams['action'] = 'grading';
427         } else if ($action == 'setbatchmarkingallocation') {
428             $this->process_set_batch_marking_allocation();
429             $action = 'redirect';
430             $nextpageparams['action'] = 'grading';
431         } else if ($action == 'confirmsubmit') {
432             $action = 'submit';
433             if ($this->process_submit_for_grading($mform, $notices)) {
434                 $action = 'redirect';
435                 $nextpageparams['action'] = 'view';
436             } else if ($notices) {
437                 $action = 'viewsubmitforgradingerror';
438             }
439         } else if ($action == 'submitotherforgrading') {
440             if ($this->process_submit_other_for_grading($mform, $notices)) {
441                 $action = 'redirect';
442                 $nextpageparams['action'] = 'grading';
443             } else {
444                 $action = 'viewsubmitforgradingerror';
445             }
446         } else if ($action == 'gradingbatchoperation') {
447             $action = $this->process_grading_batch_operation($mform);
448             if ($action == 'grading') {
449                 $action = 'redirect';
450                 $nextpageparams['action'] = 'grading';
451             }
452         } else if ($action == 'submitgrade') {
453             if (optional_param('saveandshownext', null, PARAM_RAW)) {
454                 // Save and show next.
455                 $action = 'grade';
456                 if ($this->process_save_grade($mform)) {
457                     $action = 'redirect';
458                     $nextpageparams['action'] = 'grade';
459                     $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
460                     $nextpageparams['useridlistid'] = optional_param('useridlistid', time(), PARAM_INT);
461                 }
462             } else if (optional_param('nosaveandprevious', null, PARAM_RAW)) {
463                 $action = 'redirect';
464                 $nextpageparams['action'] = 'grade';
465                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) - 1;
466                 $nextpageparams['useridlistid'] = optional_param('useridlistid', time(), PARAM_INT);
467             } else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
468                 $action = 'redirect';
469                 $nextpageparams['action'] = 'grade';
470                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
471                 $nextpageparams['useridlistid'] = optional_param('useridlistid', time(), PARAM_INT);
472             } else if (optional_param('savegrade', null, PARAM_RAW)) {
473                 // Save changes button.
474                 $action = 'grade';
475                 if ($this->process_save_grade($mform)) {
476                     $action = 'redirect';
477                     $nextpageparams['action'] = 'savegradingresult';
478                 }
479             } else {
480                 // Cancel button.
481                 $action = 'redirect';
482                 $nextpageparams['action'] = 'grading';
483             }
484         } else if ($action == 'quickgrade') {
485             $message = $this->process_save_quick_grades();
486             $action = 'quickgradingresult';
487         } else if ($action == 'saveoptions') {
488             $this->process_save_grading_options();
489             $action = 'redirect';
490             $nextpageparams['action'] = 'grading';
491         } else if ($action == 'saveextension') {
492             $action = 'grantextension';
493             if ($this->process_save_extension($mform)) {
494                 $action = 'redirect';
495                 $nextpageparams['action'] = 'grading';
496             }
497         } else if ($action == 'revealidentitiesconfirm') {
498             $this->process_reveal_identities();
499             $action = 'redirect';
500             $nextpageparams['action'] = 'grading';
501         }
503         $returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT),
504                               'useridlistid'=>optional_param('useridlistid', 0, PARAM_INT));
505         $this->register_return_link($action, $returnparams);
507         // Now show the right view page.
508         if ($action == 'redirect') {
509             $nextpageurl = new moodle_url('/mod/assign/view.php', $nextpageparams);
510             redirect($nextpageurl);
511             return;
512         } else if ($action == 'savegradingresult') {
513             $message = get_string('gradingchangessaved', 'assign');
514             $o .= $this->view_savegrading_result($message);
515         } else if ($action == 'quickgradingresult') {
516             $mform = null;
517             $o .= $this->view_quickgrading_result($message);
518         } else if ($action == 'grade') {
519             $o .= $this->view_single_grade_page($mform);
520         } else if ($action == 'viewpluginassignfeedback') {
521             $o .= $this->view_plugin_content('assignfeedback');
522         } else if ($action == 'viewpluginassignsubmission') {
523             $o .= $this->view_plugin_content('assignsubmission');
524         } else if ($action == 'editsubmission') {
525             $o .= $this->view_edit_submission_page($mform, $notices);
526         } else if ($action == 'grading') {
527             $o .= $this->view_grading_page();
528         } else if ($action == 'downloadall') {
529             $o .= $this->download_submissions();
530         } else if ($action == 'submit') {
531             $o .= $this->check_submit_for_grading($mform);
532         } else if ($action == 'grantextension') {
533             $o .= $this->view_grant_extension($mform);
534         } else if ($action == 'revealidentities') {
535             $o .= $this->view_reveal_identities_confirm($mform);
536         } else if ($action == 'plugingradingbatchoperation') {
537             $o .= $this->view_plugin_grading_batch_operation($mform);
538         } else if ($action == 'viewpluginpage') {
539              $o .= $this->view_plugin_page();
540         } else if ($action == 'viewcourseindex') {
541              $o .= $this->view_course_index();
542         } else if ($action == 'viewbatchsetmarkingworkflowstate') {
543              $o .= $this->view_batch_set_workflow_state($mform);
544         } else if ($action == 'viewbatchmarkingallocation') {
545             $o .= $this->view_batch_markingallocation($mform);
546         } else if ($action == 'viewsubmitforgradingerror') {
547             $o .= $this->view_error_page(get_string('submitforgrading', 'assign'), $notices);
548         } else {
549             $o .= $this->view_submission_page();
550         }
552         return $o;
553     }
555     /**
556      * Add this instance to the database.
557      *
558      * @param stdClass $formdata The data submitted from the form
559      * @param bool $callplugins This is used to skip the plugin code
560      *             when upgrading an old assignment to a new one (the plugins get called manually)
561      * @return mixed false if an error occurs or the int id of the new instance
562      */
563     public function add_instance(stdClass $formdata, $callplugins) {
564         global $DB;
565         $adminconfig = $this->get_admin_config();
567         $err = '';
569         // Add the database record.
570         $update = new stdClass();
571         $update->name = $formdata->name;
572         $update->timemodified = time();
573         $update->timecreated = time();
574         $update->course = $formdata->course;
575         $update->courseid = $formdata->course;
576         $update->intro = $formdata->intro;
577         $update->introformat = $formdata->introformat;
578         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
579         $update->submissiondrafts = $formdata->submissiondrafts;
580         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
581         $update->sendnotifications = $formdata->sendnotifications;
582         $update->sendlatenotifications = $formdata->sendlatenotifications;
583         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
584         if (isset($formdata->sendstudentnotifications)) {
585             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
586         }
587         $update->duedate = $formdata->duedate;
588         $update->cutoffdate = $formdata->cutoffdate;
589         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
590         $update->grade = $formdata->grade;
591         $update->completionsubmit = !empty($formdata->completionsubmit);
592         $update->teamsubmission = $formdata->teamsubmission;
593         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
594         if (isset($formdata->teamsubmissiongroupingid)) {
595             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
596         }
597         $update->blindmarking = $formdata->blindmarking;
598         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
599         if (!empty($formdata->attemptreopenmethod)) {
600             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
601         }
602         if (!empty($formdata->maxattempts)) {
603             $update->maxattempts = $formdata->maxattempts;
604         }
605         $update->markingworkflow = $formdata->markingworkflow;
606         $update->markingallocation = $formdata->markingallocation;
607         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
608             $update->markingallocation = 0;
609         }
611         $returnid = $DB->insert_record('assign', $update);
612         $this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
613         // Cache the course record.
614         $this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
616         $this->save_intro_draft_files($formdata);
618         if ($callplugins) {
619             // Call save_settings hook for submission plugins.
620             foreach ($this->submissionplugins as $plugin) {
621                 if (!$this->update_plugin_instance($plugin, $formdata)) {
622                     print_error($plugin->get_error());
623                     return false;
624                 }
625             }
626             foreach ($this->feedbackplugins as $plugin) {
627                 if (!$this->update_plugin_instance($plugin, $formdata)) {
628                     print_error($plugin->get_error());
629                     return false;
630                 }
631             }
633             // In the case of upgrades the coursemodule has not been set,
634             // so we need to wait before calling these two.
635             $this->update_calendar($formdata->coursemodule);
636             $this->update_gradebook(false, $formdata->coursemodule);
638         }
640         $update = new stdClass();
641         $update->id = $this->get_instance()->id;
642         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
643         $DB->update_record('assign', $update);
645         return $returnid;
646     }
648     /**
649      * Delete all grades from the gradebook for this assignment.
650      *
651      * @return bool
652      */
653     protected function delete_grades() {
654         global $CFG;
656         $result = grade_update('mod/assign',
657                                $this->get_course()->id,
658                                'mod',
659                                'assign',
660                                $this->get_instance()->id,
661                                0,
662                                null,
663                                array('deleted'=>1));
664         return $result == GRADE_UPDATE_OK;
665     }
667     /**
668      * Delete this instance from the database.
669      *
670      * @return bool false if an error occurs
671      */
672     public function delete_instance() {
673         global $DB;
674         $result = true;
676         foreach ($this->submissionplugins as $plugin) {
677             if (!$plugin->delete_instance()) {
678                 print_error($plugin->get_error());
679                 $result = false;
680             }
681         }
682         foreach ($this->feedbackplugins as $plugin) {
683             if (!$plugin->delete_instance()) {
684                 print_error($plugin->get_error());
685                 $result = false;
686             }
687         }
689         // Delete files associated with this assignment.
690         $fs = get_file_storage();
691         if (! $fs->delete_area_files($this->context->id) ) {
692             $result = false;
693         }
695         // Delete_records will throw an exception if it fails - so no need for error checking here.
696         $DB->delete_records('assign_submission', array('assignment'=>$this->get_instance()->id));
697         $DB->delete_records('assign_grades', array('assignment'=>$this->get_instance()->id));
698         $DB->delete_records('assign_plugin_config', array('assignment'=>$this->get_instance()->id));
700         // Delete items from the gradebook.
701         if (! $this->delete_grades()) {
702             $result = false;
703         }
705         // Delete the instance.
706         $DB->delete_records('assign', array('id'=>$this->get_instance()->id));
708         return $result;
709     }
711     /**
712      * Actual implementation of the reset course functionality, delete all the
713      * assignment submissions for course $data->courseid.
714      *
715      * @param stdClass $data the data submitted from the reset course.
716      * @return array status array
717      */
718     public function reset_userdata($data) {
719         global $CFG, $DB;
721         $componentstr = get_string('modulenameplural', 'assign');
722         $status = array();
724         $fs = get_file_storage();
725         if (!empty($data->reset_assign_submissions)) {
726             // Delete files associated with this assignment.
727             foreach ($this->submissionplugins as $plugin) {
728                 $fileareas = array();
729                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
730                 $fileareas = $plugin->get_file_areas();
731                 foreach ($fileareas as $filearea => $notused) {
732                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
733                 }
735                 if (!$plugin->delete_instance()) {
736                     $status[] = array('component'=>$componentstr,
737                                       'item'=>get_string('deleteallsubmissions', 'assign'),
738                                       'error'=>$plugin->get_error());
739                 }
740             }
742             foreach ($this->feedbackplugins as $plugin) {
743                 $fileareas = array();
744                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
745                 $fileareas = $plugin->get_file_areas();
746                 foreach ($fileareas as $filearea => $notused) {
747                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
748                 }
750                 if (!$plugin->delete_instance()) {
751                     $status[] = array('component'=>$componentstr,
752                                       'item'=>get_string('deleteallsubmissions', 'assign'),
753                                       'error'=>$plugin->get_error());
754                 }
755             }
757             $assignssql = 'SELECT a.id
758                              FROM {assign} a
759                            WHERE a.course=:course';
760             $params = array('course'=>$data->courseid);
762             $DB->delete_records_select('assign_submission', "assignment IN ($assignssql)", $params);
764             $status[] = array('component'=>$componentstr,
765                               'item'=>get_string('deleteallsubmissions', 'assign'),
766                               'error'=>false);
768             if (!empty($data->reset_gradebook_grades)) {
769                 $DB->delete_records_select('assign_grades', "assignment IN ($assignssql)", $params);
770                 // Remove all grades from gradebook.
771                 require_once($CFG->dirroot.'/mod/assign/lib.php');
772                 assign_reset_gradebook($data->courseid);
774                 // Reset revealidentities if both submissions and grades have been reset.
775                 if ($this->get_instance()->blindmarking && $this->get_instance()->revealidentities) {
776                     $DB->set_field('assign', 'revealidentities', 0, array('id' => $this->get_instance()->id));
777                 }
778             }
779         }
780         // Updating dates - shift may be negative too.
781         if ($data->timeshift) {
782             shift_course_mod_dates('assign',
783                                     array('duedate', 'allowsubmissionsfromdate', 'cutoffdate'),
784                                     $data->timeshift,
785                                     $data->courseid, $this->get_instance()->id);
786             $status[] = array('component'=>$componentstr,
787                               'item'=>get_string('datechanged'),
788                               'error'=>false);
789         }
791         return $status;
792     }
794     /**
795      * Update the settings for a single plugin.
796      *
797      * @param assign_plugin $plugin The plugin to update
798      * @param stdClass $formdata The form data
799      * @return bool false if an error occurs
800      */
801     protected function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
802         if ($plugin->is_visible()) {
803             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
804             if (!empty($formdata->$enabledname)) {
805                 $plugin->enable();
806                 if (!$plugin->save_settings($formdata)) {
807                     print_error($plugin->get_error());
808                     return false;
809                 }
810             } else {
811                 $plugin->disable();
812             }
813         }
814         return true;
815     }
817     /**
818      * Update the gradebook information for this assignment.
819      *
820      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
821      * @param int $coursemoduleid This is required because it might not exist in the database yet
822      * @return bool
823      */
824     public function update_gradebook($reset, $coursemoduleid) {
825         global $CFG;
827         require_once($CFG->dirroot.'/mod/assign/lib.php');
828         $assign = clone $this->get_instance();
829         $assign->cmidnumber = $coursemoduleid;
831         // Set assign gradebook feedback plugin status (enabled and visible).
832         $assign->gradefeedbackenabled = $this->is_gradebook_feedback_enabled();
834         $param = null;
835         if ($reset) {
836             $param = 'reset';
837         }
839         return assign_grade_item_update($assign, $param);
840     }
842     /**
843      * Load and cache the admin config for this module.
844      *
845      * @return stdClass the plugin config
846      */
847     public function get_admin_config() {
848         if ($this->adminconfig) {
849             return $this->adminconfig;
850         }
851         $this->adminconfig = get_config('assign');
852         return $this->adminconfig;
853     }
855     /**
856      * Update the calendar entries for this assignment.
857      *
858      * @param int $coursemoduleid - Required to pass this in because it might
859      *                              not exist in the database yet.
860      * @return bool
861      */
862     public function update_calendar($coursemoduleid) {
863         global $DB, $CFG;
864         require_once($CFG->dirroot.'/calendar/lib.php');
866         // Special case for add_instance as the coursemodule has not been set yet.
867         $instance = $this->get_instance();
869         if ($instance->duedate) {
870             $event = new stdClass();
872             $params = array('modulename'=>'assign', 'instance'=>$instance->id);
873             $event->id = $DB->get_field('event', 'id', $params);
874             $event->name = $instance->name;
875             $event->timestart = $instance->duedate;
877             // Convert the links to pluginfile. It is a bit hacky but at this stage the files
878             // might not have been saved in the module area yet.
879             $intro = $instance->intro;
880             if ($draftid = file_get_submitted_draft_itemid('introeditor')) {
881                 $intro = file_rewrite_urls_to_pluginfile($intro, $draftid);
882             }
884             // We need to remove the links to files as the calendar is not ready
885             // to support module events with file areas.
886             $intro = strip_pluginfile_content($intro);
887             if ($this->show_intro()) {
888                 $event->description = array(
889                     'text' => $intro,
890                     'format' => $instance->introformat
891                 );
892             } else {
893                 $event->description = array(
894                     'text' => '',
895                     'format' => $instance->introformat
896                 );
897             }
899             if ($event->id) {
900                 $calendarevent = calendar_event::load($event->id);
901                 $calendarevent->update($event);
902             } else {
903                 unset($event->id);
904                 $event->courseid    = $instance->course;
905                 $event->groupid     = 0;
906                 $event->userid      = 0;
907                 $event->modulename  = 'assign';
908                 $event->instance    = $instance->id;
909                 $event->eventtype   = 'due';
910                 $event->timeduration = 0;
911                 calendar_event::create($event);
912             }
913         } else {
914             $DB->delete_records('event', array('modulename'=>'assign', 'instance'=>$instance->id));
915         }
916     }
919     /**
920      * Update this instance in the database.
921      *
922      * @param stdClass $formdata - the data submitted from the form
923      * @return bool false if an error occurs
924      */
925     public function update_instance($formdata) {
926         global $DB;
927         $adminconfig = $this->get_admin_config();
929         $update = new stdClass();
930         $update->id = $formdata->instance;
931         $update->name = $formdata->name;
932         $update->timemodified = time();
933         $update->course = $formdata->course;
934         $update->intro = $formdata->intro;
935         $update->introformat = $formdata->introformat;
936         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
937         $update->submissiondrafts = $formdata->submissiondrafts;
938         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
939         $update->sendnotifications = $formdata->sendnotifications;
940         $update->sendlatenotifications = $formdata->sendlatenotifications;
941         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
942         if (isset($formdata->sendstudentnotifications)) {
943             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
944         }
945         $update->duedate = $formdata->duedate;
946         $update->cutoffdate = $formdata->cutoffdate;
947         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
948         $update->grade = $formdata->grade;
949         if (!empty($formdata->completionunlocked)) {
950             $update->completionsubmit = !empty($formdata->completionsubmit);
951         }
952         $update->teamsubmission = $formdata->teamsubmission;
953         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
954         if (isset($formdata->teamsubmissiongroupingid)) {
955             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
956         }
957         $update->blindmarking = $formdata->blindmarking;
958         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
959         if (!empty($formdata->attemptreopenmethod)) {
960             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
961         }
962         if (!empty($formdata->maxattempts)) {
963             $update->maxattempts = $formdata->maxattempts;
964         }
965         $update->markingworkflow = $formdata->markingworkflow;
966         $update->markingallocation = $formdata->markingallocation;
967         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
968             $update->markingallocation = 0;
969         }
971         $result = $DB->update_record('assign', $update);
972         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
974         $this->save_intro_draft_files($formdata);
976         // Load the assignment so the plugins have access to it.
978         // Call save_settings hook for submission plugins.
979         foreach ($this->submissionplugins as $plugin) {
980             if (!$this->update_plugin_instance($plugin, $formdata)) {
981                 print_error($plugin->get_error());
982                 return false;
983             }
984         }
985         foreach ($this->feedbackplugins as $plugin) {
986             if (!$this->update_plugin_instance($plugin, $formdata)) {
987                 print_error($plugin->get_error());
988                 return false;
989             }
990         }
992         $this->update_calendar($this->get_course_module()->id);
993         $this->update_gradebook(false, $this->get_course_module()->id);
995         $update = new stdClass();
996         $update->id = $this->get_instance()->id;
997         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
998         $DB->update_record('assign', $update);
1000         return $result;
1001     }
1003     /**
1004      * Save the attachments in the draft areas.
1005      *
1006      * @param stdClass $formdata
1007      */
1008     protected function save_intro_draft_files($formdata) {
1009         if (isset($formdata->introattachments)) {
1010             file_save_draft_area_files($formdata->introattachments, $this->get_context()->id,
1011                                        'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA, 0);
1012         }
1013     }
1015     /**
1016      * Add elements in grading plugin form.
1017      *
1018      * @param mixed $grade stdClass|null
1019      * @param MoodleQuickForm $mform
1020      * @param stdClass $data
1021      * @param int $userid - The userid we are grading
1022      * @return void
1023      */
1024     protected function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
1025         foreach ($this->feedbackplugins as $plugin) {
1026             if ($plugin->is_enabled() && $plugin->is_visible()) {
1027                 $plugin->get_form_elements_for_user($grade, $mform, $data, $userid);
1028             }
1029         }
1030     }
1034     /**
1035      * Add one plugins settings to edit plugin form.
1036      *
1037      * @param assign_plugin $plugin The plugin to add the settings from
1038      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1039      *                               This form is modified directly (not returned).
1040      * @param array $pluginsenabled A list of form elements to be added to a group.
1041      *                              The new element is added to this array by this function.
1042      * @return void
1043      */
1044     protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) {
1045         global $CFG;
1046         if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) {
1047             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1048             $pluginsenabled[] = $mform->createElement('hidden', $name, 1);
1049             $mform->setType($name, PARAM_BOOL);
1050             $plugin->get_settings($mform);
1051         } else if ($plugin->is_visible() && $plugin->is_configurable()) {
1052             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1053             $label = $plugin->get_name();
1054             $label .= ' ' . $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
1055             $pluginsenabled[] = $mform->createElement('checkbox', $name, '', $label);
1057             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
1058             if ($plugin->get_config('enabled') !== false) {
1059                 $default = $plugin->is_enabled();
1060             }
1061             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
1063             $plugin->get_settings($mform);
1065         }
1066     }
1068     /**
1069      * Add settings to edit plugin form.
1070      *
1071      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1072      *                               This form is modified directly (not returned).
1073      * @return void
1074      */
1075     public function add_all_plugin_settings(MoodleQuickForm $mform) {
1076         $mform->addElement('header', 'submissiontypes', get_string('submissiontypes', 'assign'));
1078         $submissionpluginsenabled = array();
1079         $group = $mform->addGroup(array(), 'submissionplugins', get_string('submissiontypes', 'assign'), array(' '), false);
1080         foreach ($this->submissionplugins as $plugin) {
1081             $this->add_plugin_settings($plugin, $mform, $submissionpluginsenabled);
1082         }
1083         $group->setElements($submissionpluginsenabled);
1085         $mform->addElement('header', 'feedbacktypes', get_string('feedbacktypes', 'assign'));
1086         $feedbackpluginsenabled = array();
1087         $group = $mform->addGroup(array(), 'feedbackplugins', get_string('feedbacktypes', 'assign'), array(' '), false);
1088         foreach ($this->feedbackplugins as $plugin) {
1089             $this->add_plugin_settings($plugin, $mform, $feedbackpluginsenabled);
1090         }
1091         $group->setElements($feedbackpluginsenabled);
1092         $mform->setExpanded('submissiontypes');
1093     }
1095     /**
1096      * Allow each plugin an opportunity to update the defaultvalues
1097      * passed in to the settings form (needed to set up draft areas for
1098      * editor and filemanager elements)
1099      *
1100      * @param array $defaultvalues
1101      */
1102     public function plugin_data_preprocessing(&$defaultvalues) {
1103         foreach ($this->submissionplugins as $plugin) {
1104             if ($plugin->is_visible()) {
1105                 $plugin->data_preprocessing($defaultvalues);
1106             }
1107         }
1108         foreach ($this->feedbackplugins as $plugin) {
1109             if ($plugin->is_visible()) {
1110                 $plugin->data_preprocessing($defaultvalues);
1111             }
1112         }
1113     }
1115     /**
1116      * Get the name of the current module.
1117      *
1118      * @return string the module name (Assignment)
1119      */
1120     protected function get_module_name() {
1121         if (isset(self::$modulename)) {
1122             return self::$modulename;
1123         }
1124         self::$modulename = get_string('modulename', 'assign');
1125         return self::$modulename;
1126     }
1128     /**
1129      * Get the plural name of the current module.
1130      *
1131      * @return string the module name plural (Assignments)
1132      */
1133     protected function get_module_name_plural() {
1134         if (isset(self::$modulenameplural)) {
1135             return self::$modulenameplural;
1136         }
1137         self::$modulenameplural = get_string('modulenameplural', 'assign');
1138         return self::$modulenameplural;
1139     }
1141     /**
1142      * Has this assignment been constructed from an instance?
1143      *
1144      * @return bool
1145      */
1146     public function has_instance() {
1147         return $this->instance || $this->get_course_module();
1148     }
1150     /**
1151      * Get the settings for the current instance of this assignment
1152      *
1153      * @return stdClass The settings
1154      */
1155     public function get_instance() {
1156         global $DB;
1157         if ($this->instance) {
1158             return $this->instance;
1159         }
1160         if ($this->get_course_module()) {
1161             $params = array('id' => $this->get_course_module()->instance);
1162             $this->instance = $DB->get_record('assign', $params, '*', MUST_EXIST);
1163         }
1164         if (!$this->instance) {
1165             throw new coding_exception('Improper use of the assignment class. ' .
1166                                        'Cannot load the assignment record.');
1167         }
1168         return $this->instance;
1169     }
1171     /**
1172      * Get the primary grade item for this assign instance.
1173      *
1174      * @return stdClass The grade_item record
1175      */
1176     public function get_grade_item() {
1177         if ($this->gradeitem) {
1178             return $this->gradeitem;
1179         }
1180         $instance = $this->get_instance();
1181         $params = array('itemtype' => 'mod',
1182                         'itemmodule' => 'assign',
1183                         'iteminstance' => $instance->id,
1184                         'courseid' => $instance->course,
1185                         'itemnumber' => 0);
1186         $this->gradeitem = grade_item::fetch($params);
1187         if (!$this->gradeitem) {
1188             throw new coding_exception('Improper use of the assignment class. ' .
1189                                        'Cannot load the grade item.');
1190         }
1191         return $this->gradeitem;
1192     }
1194     /**
1195      * Get the context of the current course.
1196      *
1197      * @return mixed context|null The course context
1198      */
1199     public function get_course_context() {
1200         if (!$this->context && !$this->course) {
1201             throw new coding_exception('Improper use of the assignment class. ' .
1202                                        'Cannot load the course context.');
1203         }
1204         if ($this->context) {
1205             return $this->context->get_course_context();
1206         } else {
1207             return context_course::instance($this->course->id);
1208         }
1209     }
1212     /**
1213      * Get the current course module.
1214      *
1215      * @return cm_info|null The course module or null if not known
1216      */
1217     public function get_course_module() {
1218         if ($this->coursemodule) {
1219             return $this->coursemodule;
1220         }
1221         if (!$this->context) {
1222             return null;
1223         }
1225         if ($this->context->contextlevel == CONTEXT_MODULE) {
1226             $modinfo = get_fast_modinfo($this->get_course());
1227             $this->coursemodule = $modinfo->get_cm($this->context->instanceid);
1228             return $this->coursemodule;
1229         }
1230         return null;
1231     }
1233     /**
1234      * Get context module.
1235      *
1236      * @return context
1237      */
1238     public function get_context() {
1239         return $this->context;
1240     }
1242     /**
1243      * Get the current course.
1244      *
1245      * @return mixed stdClass|null The course
1246      */
1247     public function get_course() {
1248         global $DB;
1250         if ($this->course) {
1251             return $this->course;
1252         }
1254         if (!$this->context) {
1255             return null;
1256         }
1257         $params = array('id' => $this->get_course_context()->instanceid);
1258         $this->course = $DB->get_record('course', $params, '*', MUST_EXIST);
1260         return $this->course;
1261     }
1263     /**
1264      * Count the number of intro attachments.
1265      *
1266      * @return int
1267      */
1268     protected function count_attachments() {
1270         $fs = get_file_storage();
1271         $files = $fs->get_area_files($this->get_context()->id, 'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA,
1272                         0, 'id', false);
1274         return count($files);
1275     }
1277     /**
1278      * Are there any intro attachments to display?
1279      *
1280      * @return boolean
1281      */
1282     protected function has_visible_attachments() {
1283         return ($this->count_attachments() > 0);
1284     }
1286     /**
1287      * Return a grade in user-friendly form, whether it's a scale or not.
1288      *
1289      * @param mixed $grade int|null
1290      * @param boolean $editing Are we allowing changes to this grade?
1291      * @param int $userid The user id the grade belongs to
1292      * @param int $modified Timestamp from when the grade was last modified
1293      * @return string User-friendly representation of grade
1294      */
1295     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1296         global $DB;
1298         static $scalegrades = array();
1300         $o = '';
1302         if ($this->get_instance()->grade >= 0) {
1303             // Normal number.
1304             if ($editing && $this->get_instance()->grade > 0) {
1305                 if ($grade < 0) {
1306                     $displaygrade = '';
1307                 } else {
1308                     $displaygrade = format_float($grade, 2);
1309                 }
1310                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' .
1311                        get_string('usergrade', 'assign') .
1312                        '</label>';
1313                 $o .= '<input type="text"
1314                               id="quickgrade_' . $userid . '"
1315                               name="quickgrade_' . $userid . '"
1316                               value="' .  $displaygrade . '"
1317                               size="6"
1318                               maxlength="10"
1319                               class="quickgrade"/>';
1320                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, 2);
1321                 return $o;
1322             } else {
1323                 if ($grade == -1 || $grade === null) {
1324                     $o .= '-';
1325                 } else {
1326                     $item = $this->get_grade_item();
1327                     $o .= grade_format_gradevalue($grade, $item);
1328                     if ($item->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) {
1329                         // If displaying the raw grade, also display the total value.
1330                         $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, 2);
1331                     }
1332                 }
1333                 return $o;
1334             }
1336         } else {
1337             // Scale.
1338             if (empty($this->cache['scale'])) {
1339                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1340                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1341                 } else {
1342                     $o .= '-';
1343                     return $o;
1344                 }
1345             }
1346             if ($editing) {
1347                 $o .= '<label class="accesshide"
1348                               for="quickgrade_' . $userid . '">' .
1349                       get_string('usergrade', 'assign') .
1350                       '</label>';
1351                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1352                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1353                 foreach ($this->cache['scale'] as $optionid => $option) {
1354                     $selected = '';
1355                     if ($grade == $optionid) {
1356                         $selected = 'selected="selected"';
1357                     }
1358                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1359                 }
1360                 $o .= '</select>';
1361                 return $o;
1362             } else {
1363                 $scaleid = (int)$grade;
1364                 if (isset($this->cache['scale'][$scaleid])) {
1365                     $o .= $this->cache['scale'][$scaleid];
1366                     return $o;
1367                 }
1368                 $o .= '-';
1369                 return $o;
1370             }
1371         }
1372     }
1374     /**
1375      * Load a list of users enrolled in the current course with the specified permission and group.
1376      * 0 for no group.
1377      *
1378      * @param int $currentgroup
1379      * @param bool $idsonly
1380      * @return array List of user records
1381      */
1382     public function list_participants($currentgroup, $idsonly) {
1383         $key = $this->context->id . '-' . $currentgroup . '-' . $this->show_only_active_users();
1384         if (!isset($this->participants[$key])) {
1385             $users = get_enrolled_users($this->context, 'mod/assign:submit', $currentgroup, 'u.*', null, null, null,
1386                     $this->show_only_active_users());
1388             $cm = $this->get_course_module();
1389             $info = new \core_availability\info_module($cm);
1390             $users = $info->filter_user_list($users);
1392             $this->participants[$key] = $users;
1393         }
1395         if ($idsonly) {
1396             $idslist = array();
1397             foreach ($this->participants[$key] as $id => $user) {
1398                 $idslist[$id] = new stdClass();
1399                 $idslist[$id]->id = $id;
1400             }
1401             return $idslist;
1402         }
1403         return $this->participants[$key];
1404     }
1406     /**
1407      * Load a count of valid teams for this assignment.
1408      *
1409      * @return int number of valid teams
1410      */
1411     public function count_teams() {
1413         $groups = groups_get_all_groups($this->get_course()->id,
1414                                         0,
1415                                         $this->get_instance()->teamsubmissiongroupingid,
1416                                         'g.id');
1417         $count = count($groups);
1419         // See if there are any users in the default group.
1420         $defaultusers = $this->get_submission_group_members(0, true);
1421         if (count($defaultusers) > 0) {
1422             $count += 1;
1423         }
1424         return $count;
1425     }
1427     /**
1428      * Load a count of active users enrolled in the current course with the specified permission and group.
1429      * 0 for no group.
1430      *
1431      * @param int $currentgroup
1432      * @return int number of matching users
1433      */
1434     public function count_participants($currentgroup) {
1435         return count($this->list_participants($currentgroup, true));
1436     }
1438     /**
1439      * Load a count of active users submissions in the current module that require grading
1440      * This means the submission modification time is more recent than the
1441      * grading modification time and the status is SUBMITTED.
1442      *
1443      * @return int number of matching submissions
1444      */
1445     public function count_submissions_need_grading() {
1446         global $DB;
1448         if ($this->get_instance()->teamsubmission) {
1449             // This does not make sense for group assignment because the submission is shared.
1450             return 0;
1451         }
1453         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1454         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1456         $params['assignid'] = $this->get_instance()->id;
1457         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1459         $sql = 'SELECT COUNT(s.userid)
1460                    FROM {assign_submission} s
1461                    LEFT JOIN {assign_grades} g ON
1462                         s.assignment = g.assignment AND
1463                         s.userid = g.userid AND
1464                         g.attemptnumber = s.attemptnumber
1465                    JOIN(' . $esql . ') e ON e.id = s.userid
1466                    WHERE
1467                         s.latest = 1 AND
1468                         s.assignment = :assignid AND
1469                         s.timemodified IS NOT NULL AND
1470                         s.status = :submitted AND
1471                         (s.timemodified > g.timemodified OR g.timemodified IS NULL)';
1473         return $DB->count_records_sql($sql, $params);
1474     }
1476     /**
1477      * Load a count of grades.
1478      *
1479      * @return int number of grades
1480      */
1481     public function count_grades() {
1482         global $DB;
1484         if (!$this->has_instance()) {
1485             return 0;
1486         }
1488         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1489         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1491         $params['assignid'] = $this->get_instance()->id;
1493         $sql = 'SELECT COUNT(g.userid)
1494                    FROM {assign_grades} g
1495                    JOIN(' . $esql . ') e ON e.id = g.userid
1496                    WHERE g.assignment = :assignid';
1498         return $DB->count_records_sql($sql, $params);
1499     }
1501     /**
1502      * Load a count of submissions.
1503      *
1504      * @return int number of submissions
1505      */
1506     public function count_submissions() {
1507         global $DB;
1509         if (!$this->has_instance()) {
1510             return 0;
1511         }
1513         $params = array();
1515         if ($this->get_instance()->teamsubmission) {
1516             // We cannot join on the enrolment tables for group submissions (no userid).
1517             $sql = 'SELECT COUNT(DISTINCT s.groupid)
1518                         FROM {assign_submission} s
1519                         WHERE
1520                             s.assignment = :assignid AND
1521                             s.timemodified IS NOT NULL AND
1522                             s.userid = :groupuserid';
1524             $params['assignid'] = $this->get_instance()->id;
1525             $params['groupuserid'] = 0;
1526         } else {
1527             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1528             list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1530             $params['assignid'] = $this->get_instance()->id;
1532             $sql = 'SELECT COUNT(DISTINCT s.userid)
1533                        FROM {assign_submission} s
1534                        JOIN(' . $esql . ') e ON e.id = s.userid
1535                        WHERE
1536                             s.assignment = :assignid AND
1537                             s.timemodified IS NOT NULL';
1539         }
1541         return $DB->count_records_sql($sql, $params);
1542     }
1544     /**
1545      * Load a count of submissions with a specified status.
1546      *
1547      * @param string $status The submission status - should match one of the constants
1548      * @return int number of matching submissions
1549      */
1550     public function count_submissions_with_status($status) {
1551         global $DB;
1553         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1554         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1556         $params['assignid'] = $this->get_instance()->id;
1557         $params['assignid2'] = $this->get_instance()->id;
1558         $params['submissionstatus'] = $status;
1560         if ($this->get_instance()->teamsubmission) {
1561             $sql = 'SELECT COUNT(s.groupid)
1562                         FROM {assign_submission} s
1563                         WHERE
1564                             s.latest = 1 AND
1565                             s.assignment = :assignid AND
1566                             s.timemodified IS NOT NULL AND
1567                             s.userid = :groupuserid AND
1568                             s.status = :submissionstatus';
1569             $params['groupuserid'] = 0;
1570         } else {
1571             $sql = 'SELECT COUNT(s.userid)
1572                         FROM {assign_submission} s
1573                         JOIN(' . $esql . ') e ON e.id = s.userid
1574                         WHERE
1575                             s.latest = 1 AND
1576                             s.assignment = :assignid AND
1577                             s.timemodified IS NOT NULL AND
1578                             s.status = :submissionstatus';
1580         }
1582         return $DB->count_records_sql($sql, $params);
1583     }
1585     /**
1586      * Utility function to get the userid for every row in the grading table
1587      * so the order can be frozen while we iterate it.
1588      *
1589      * @return array An array of userids
1590      */
1591     protected function get_grading_userid_list() {
1592         $filter = get_user_preferences('assign_filter', '');
1593         $table = new assign_grading_table($this, 0, $filter, 0, false);
1595         $useridlist = $table->get_column_data('userid');
1597         return $useridlist;
1598     }
1600     /**
1601      * Generate zip file from array of given files.
1602      *
1603      * @param array $filesforzipping - array of files to pass into archive_to_pathname.
1604      *                                 This array is indexed by the final file name and each
1605      *                                 element in the array is an instance of a stored_file object.
1606      * @return path of temp file - note this returned file does
1607      *         not have a .zip extension - it is a temp file.
1608      */
1609     protected function pack_files($filesforzipping) {
1610         global $CFG;
1611         // Create path for new zip file.
1612         $tempzip = tempnam($CFG->tempdir . '/', 'assignment_');
1613         // Zip files.
1614         $zipper = new zip_packer();
1615         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
1616             return $tempzip;
1617         }
1618         return false;
1619     }
1621     /**
1622      * Finds all assignment notifications that have yet to be mailed out, and mails them.
1623      *
1624      * Cron function to be run periodically according to the moodle cron.
1625      *
1626      * @return bool
1627      */
1628     public static function cron() {
1629         global $DB;
1631         // Only ever send a max of one days worth of updates.
1632         $yesterday = time() - (24 * 3600);
1633         $timenow   = time();
1634         $lastcron = $DB->get_field('modules', 'lastcron', array('name' => 'assign'));
1636         // Collect all submissions from the past 24 hours that require mailing.
1637         // Submissions are excluded if the assignment is hidden in the gradebook.
1638         $sql = "SELECT g.id as gradeid, a.course, a.name, a.blindmarking, a.revealidentities,
1639                        g.*, g.timemodified as lastmodified, cm.id as cmid
1640                  FROM {assign} a
1641                  JOIN {assign_grades} g ON g.assignment = a.id
1642             LEFT JOIN {assign_user_flags} uf ON uf.assignment = a.id AND uf.userid = g.userid
1643                  JOIN {course_modules} cm ON cm.course = a.course AND cm.instance = a.id
1644                  JOIN {modules} md ON md.id = cm.module AND md.name = 'assign'
1645                  JOIN {grade_items} gri ON gri.iteminstance = a.id AND gri.courseid = a.course AND gri.itemmodule = md.name
1646                  WHERE g.timemodified >= :yesterday AND
1647                        g.timemodified <= :today AND
1648                        uf.mailed = 0 AND gri.hidden = 0
1649               ORDER BY a.course, cm.id";
1651         $params = array('yesterday' => $yesterday, 'today' => $timenow);
1652         $submissions = $DB->get_records_sql($sql, $params);
1654         if (!empty($submissions)) {
1656             mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
1658             // Preload courses we are going to need those.
1659             $courseids = array();
1660             foreach ($submissions as $submission) {
1661                 $courseids[] = $submission->course;
1662             }
1664             // Filter out duplicates.
1665             $courseids = array_unique($courseids);
1666             $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
1667             list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
1668             $sql = 'SELECT c.*, ' . $ctxselect .
1669                       ' FROM {course} c
1670                  LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
1671                      WHERE c.id ' . $courseidsql;
1673             $params['contextlevel'] = CONTEXT_COURSE;
1674             $courses = $DB->get_records_sql($sql, $params);
1676             // Clean up... this could go on for a while.
1677             unset($courseids);
1678             unset($ctxselect);
1679             unset($courseidsql);
1680             unset($params);
1682             // Message students about new feedback.
1683             foreach ($submissions as $submission) {
1685                 mtrace("Processing assignment submission $submission->id ...");
1687                 // Do not cache user lookups - could be too many.
1688                 if (!$user = $DB->get_record('user', array('id'=>$submission->userid))) {
1689                     mtrace('Could not find user ' . $submission->userid);
1690                     continue;
1691                 }
1693                 // Use a cache to prevent the same DB queries happening over and over.
1694                 if (!array_key_exists($submission->course, $courses)) {
1695                     mtrace('Could not find course ' . $submission->course);
1696                     continue;
1697                 }
1698                 $course = $courses[$submission->course];
1699                 if (isset($course->ctxid)) {
1700                     // Context has not yet been preloaded. Do so now.
1701                     context_helper::preload_from_record($course);
1702                 }
1704                 // Override the language and timezone of the "current" user, so that
1705                 // mail is customised for the receiver.
1706                 cron_setup_user($user, $course);
1708                 // Context lookups are already cached.
1709                 $coursecontext = context_course::instance($course->id);
1710                 if (!is_enrolled($coursecontext, $user->id)) {
1711                     $courseshortname = format_string($course->shortname,
1712                                                      true,
1713                                                      array('context' => $coursecontext));
1714                     mtrace(fullname($user) . ' not an active participant in ' . $courseshortname);
1715                     continue;
1716                 }
1718                 if (!$grader = $DB->get_record('user', array('id'=>$submission->grader))) {
1719                     mtrace('Could not find grader ' . $submission->grader);
1720                     continue;
1721                 }
1723                 $modinfo = get_fast_modinfo($course, $user->id);
1724                 $cm = $modinfo->get_cm($submission->cmid);
1725                 // Context lookups are already cached.
1726                 $contextmodule = context_module::instance($cm->id);
1728                 if (!$cm->uservisible) {
1729                     // Hold mail notification for assignments the user cannot access until later.
1730                     continue;
1731                 }
1733                 // Need to send this to the student.
1734                 $messagetype = 'feedbackavailable';
1735                 $eventtype = 'assign_notification';
1736                 $updatetime = $submission->lastmodified;
1737                 $modulename = get_string('modulename', 'assign');
1739                 $uniqueid = 0;
1740                 if ($submission->blindmarking && !$submission->revealidentities) {
1741                     $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $user->id);
1742                 }
1743                 $showusers = $submission->blindmarking && !$submission->revealidentities;
1744                 self::send_assignment_notification($grader,
1745                                                    $user,
1746                                                    $messagetype,
1747                                                    $eventtype,
1748                                                    $updatetime,
1749                                                    $cm,
1750                                                    $contextmodule,
1751                                                    $course,
1752                                                    $modulename,
1753                                                    $submission->name,
1754                                                    $showusers,
1755                                                    $uniqueid);
1757                 $flags = $DB->get_record('assign_user_flags', array('userid'=>$user->id, 'assignment'=>$submission->assignment));
1758                 if ($flags) {
1759                     $flags->mailed = 1;
1760                     $DB->update_record('assign_user_flags', $flags);
1761                 } else {
1762                     $flags = new stdClass();
1763                     $flags->userid = $user->id;
1764                     $flags->assignment = $submission->assignment;
1765                     $flags->mailed = 1;
1766                     $DB->insert_record('assign_user_flags', $flags);
1767                 }
1769                 mtrace('Done');
1770             }
1771             mtrace('Done processing ' . count($submissions) . ' assignment submissions');
1773             cron_setup_user();
1775             // Free up memory just to be sure.
1776             unset($courses);
1777         }
1779         // Update calendar events to provide a description.
1780         $sql = 'SELECT id
1781                     FROM {assign}
1782                     WHERE
1783                         allowsubmissionsfromdate >= :lastcron AND
1784                         allowsubmissionsfromdate <= :timenow AND
1785                         alwaysshowdescription = 0';
1786         $params = array('lastcron' => $lastcron, 'timenow' => $timenow);
1787         $newlyavailable = $DB->get_records_sql($sql, $params);
1788         foreach ($newlyavailable as $record) {
1789             $cm = get_coursemodule_from_instance('assign', $record->id, 0, false, MUST_EXIST);
1790             $context = context_module::instance($cm->id);
1792             $assignment = new assign($context, null, null);
1793             $assignment->update_calendar($cm->id);
1794         }
1796         return true;
1797     }
1799     /**
1800      * Mark in the database that this grade record should have an update notification sent by cron.
1801      *
1802      * @param stdClass $grade a grade record keyed on id
1803      * @return bool true for success
1804      */
1805     public function notify_grade_modified($grade) {
1806         global $DB;
1808         $flags = $this->get_user_flags($grade->userid, true);
1809         if ($flags->mailed != 1) {
1810             $flags->mailed = 0;
1811         }
1813         return $this->update_user_flags($flags);
1814     }
1816     /**
1817      * Update user flags for this user in this assignment.
1818      *
1819      * @param stdClass $flags a flags record keyed on id
1820      * @return bool true for success
1821      */
1822     public function update_user_flags($flags) {
1823         global $DB;
1824         if ($flags->userid <= 0 || $flags->assignment <= 0 || $flags->id <= 0) {
1825             return false;
1826         }
1828         $result = $DB->update_record('assign_user_flags', $flags);
1829         return $result;
1830     }
1832     /**
1833      * Update a grade in the grade table for the assignment and in the gradebook.
1834      *
1835      * @param stdClass $grade a grade record keyed on id
1836      * @param bool $reopenattempt If the attempt reopen method is manual, allow another attempt at this assignment.
1837      * @return bool true for success
1838      */
1839     public function update_grade($grade, $reopenattempt = false) {
1840         global $DB;
1842         $grade->timemodified = time();
1844         if (!empty($grade->workflowstate)) {
1845             $validstates = $this->get_marking_workflow_states_for_current_user();
1846             if (!array_key_exists($grade->workflowstate, $validstates)) {
1847                 return false;
1848             }
1849         }
1851         if ($grade->grade && $grade->grade != -1) {
1852             if ($this->get_instance()->grade > 0) {
1853                 if (!is_numeric($grade->grade)) {
1854                     return false;
1855                 } else if ($grade->grade > $this->get_instance()->grade) {
1856                     return false;
1857                 } else if ($grade->grade < 0) {
1858                     return false;
1859                 }
1860             } else {
1861                 // This is a scale.
1862                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
1863                     $scaleoptions = make_menu_from_list($scale->scale);
1864                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
1865                         return false;
1866                     }
1867                 }
1868             }
1869         }
1871         if (empty($grade->attemptnumber)) {
1872             // Set it to the default.
1873             $grade->attemptnumber = 0;
1874         }
1875         $result = $DB->update_record('assign_grades', $grade);
1877         // If the conditions are met, allow another attempt.
1878         $submission = null;
1879         if ($this->get_instance()->teamsubmission) {
1880             $submission = $this->get_group_submission($grade->userid, 0, false);
1881         } else {
1882             $submission = $this->get_user_submission($grade->userid, false);
1883         }
1884         if ($submission && $submission->attemptnumber == $grade->attemptnumber) {
1885             $this->reopen_submission_if_required($grade->userid,
1886                                                  $submission,
1887                                                  $reopenattempt);
1888         }
1890         // Only push to gradebook if the update is for the latest attempt.
1891         // Not the latest attempt.
1892         if ($submission && $submission->attemptnumber != $grade->attemptnumber) {
1893             return true;
1894         }
1896         if ($result) {
1897             $this->gradebook_item_update(null, $grade);
1898             \mod_assign\event\submission_graded::create_from_grade($this, $grade)->trigger();
1899         }
1900         return $result;
1901     }
1903     /**
1904      * View the grant extension date page.
1905      *
1906      * Uses url parameters 'userid'
1907      * or from parameter 'selectedusers'
1908      *
1909      * @param moodleform $mform - Used for validation of the submitted data
1910      * @return string
1911      */
1912     protected function view_grant_extension($mform) {
1913         global $DB, $CFG;
1914         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
1916         $o = '';
1917         $batchusers = optional_param('selectedusers', '', PARAM_SEQUENCE);
1918         $data = new stdClass();
1919         $data->extensionduedate = null;
1920         $userid = 0;
1921         if (!$batchusers) {
1922             $userid = required_param('userid', PARAM_INT);
1924             $flags = $this->get_user_flags($userid, false);
1926             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
1928             if ($flags) {
1929                 $data->extensionduedate = $flags->extensionduedate;
1930             }
1931             $data->userid = $userid;
1932         } else {
1933             $data->batchusers = $batchusers;
1934         }
1935         $header = new assign_header($this->get_instance(),
1936                                     $this->get_context(),
1937                                     $this->show_intro(),
1938                                     $this->get_course_module()->id,
1939                                     get_string('grantextension', 'assign'));
1940         $o .= $this->get_renderer()->render($header);
1942         if (!$mform) {
1943             $formparams = array($this->get_course_module()->id,
1944                                 $userid,
1945                                 $batchusers,
1946                                 $this->get_instance(),
1947                                 $data);
1948             $mform = new mod_assign_extension_form(null, $formparams);
1949         }
1950         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
1951         $o .= $this->view_footer();
1952         return $o;
1953     }
1955     /**
1956      * Get a list of the users in the same group as this user.
1957      *
1958      * @param int $groupid The id of the group whose members we want or 0 for the default group
1959      * @param bool $onlyids Whether to retrieve only the user id's
1960      * @return array The users (possibly id's only)
1961      */
1962     public function get_submission_group_members($groupid, $onlyids) {
1963         $members = array();
1964         if ($groupid != 0) {
1965             if ($onlyids) {
1966                 $allusers = groups_get_members($groupid, 'u.id');
1967             } else {
1968                 $allusers = groups_get_members($groupid);
1969             }
1970             foreach ($allusers as $user) {
1971                 if ($this->get_submission_group($user->id)) {
1972                     $members[] = $user;
1973                 }
1974             }
1975         } else {
1976             $allusers = $this->list_participants(null, $onlyids);
1977             foreach ($allusers as $user) {
1978                 if ($this->get_submission_group($user->id) == null) {
1979                     $members[] = $user;
1980                 }
1981             }
1982         }
1983         // Exclude suspended users, if user can't see them.
1984         if (!has_capability('moodle/course:viewsuspendedusers', $this->context)) {
1985             foreach ($members as $key => $member) {
1986                 if (!$this->is_active_user($member->id)) {
1987                     unset($members[$key]);
1988                 }
1989             }
1990         }
1991         return $members;
1992     }
1994     /**
1995      * Get a list of the users in the same group as this user that have not submitted the assignment.
1996      *
1997      * @param int $groupid The id of the group whose members we want or 0 for the default group
1998      * @param bool $onlyids Whether to retrieve only the user id's
1999      * @return array The users (possibly id's only)
2000      */
2001     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
2002         $instance = $this->get_instance();
2003         if (!$instance->teamsubmission || !$instance->requireallteammemberssubmit) {
2004             return array();
2005         }
2006         $members = $this->get_submission_group_members($groupid, $onlyids);
2008         foreach ($members as $id => $member) {
2009             $submission = $this->get_user_submission($member->id, false);
2010             if ($submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2011                 unset($members[$id]);
2012             } else {
2013                 if ($this->is_blind_marking()) {
2014                     $members[$id]->alias = get_string('hiddenuser', 'assign') .
2015                                            $this->get_uniqueid_for_user($id);
2016                 }
2017             }
2018         }
2019         return $members;
2020     }
2022     /**
2023      * Load the group submission object for a particular user, optionally creating it if required.
2024      *
2025      * @param int $userid The id of the user whose submission we want
2026      * @param int $groupid The id of the group for this user - may be 0 in which
2027      *                     case it is determined from the userid.
2028      * @param bool $create If set to true a new submission object will be created in the database
2029      *                     with the status set to "new".
2030      * @param int $attemptnumber - -1 means the latest attempt
2031      * @return stdClass The submission
2032      */
2033     public function get_group_submission($userid, $groupid, $create, $attemptnumber=-1) {
2034         global $DB;
2036         if ($groupid == 0) {
2037             $group = $this->get_submission_group($userid);
2038             if ($group) {
2039                 $groupid = $group->id;
2040             }
2041         }
2043         // Now get the group submission.
2044         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2045         if ($attemptnumber >= 0) {
2046             $params['attemptnumber'] = $attemptnumber;
2047         }
2049         // Only return the row with the highest attemptnumber.
2050         $submission = null;
2051         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2052         if ($submissions) {
2053             $submission = reset($submissions);
2054         }
2056         if ($submission) {
2057             return $submission;
2058         }
2059         if ($create) {
2060             $submission = new stdClass();
2061             $submission->assignment = $this->get_instance()->id;
2062             $submission->userid = 0;
2063             $submission->groupid = $groupid;
2064             $submission->timecreated = time();
2065             $submission->timemodified = $submission->timecreated;
2066             if ($attemptnumber >= 0) {
2067                 $submission->attemptnumber = $attemptnumber;
2068             } else {
2069                 $submission->attemptnumber = 0;
2070             }
2071             // Work out if this is the latest submission.
2072             $submission->latest = 0;
2073             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2074             if ($attemptnumber == -1) {
2075                 // This is a new submission so it must be the latest.
2076                 $submission->latest = 1;
2077             } else {
2078                 // We need to work this out.
2079                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2080                 if ($result) {
2081                     $latestsubmission = reset($result);
2082                 }
2083                 if (!$latestsubmission || ($attemptnumber == $latestsubmission->attemptnumber)) {
2084                     $submission->latest = 1;
2085                 }
2086             }
2087             if ($submission->latest) {
2088                 // This is the case when we need to set latest to 0 for all the other attempts.
2089                 $DB->set_field('assign_submission', 'latest', 0, $params);
2090             }
2091             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2092             $sid = $DB->insert_record('assign_submission', $submission);
2093             return $DB->get_record('assign_submission', array('id' => $sid));
2094         }
2095         return false;
2096     }
2098     /**
2099      * View a summary listing of all assignments in the current course.
2100      *
2101      * @return string
2102      */
2103     private function view_course_index() {
2104         global $USER;
2106         $o = '';
2108         $course = $this->get_course();
2109         $strplural = get_string('modulenameplural', 'assign');
2111         if (!$cms = get_coursemodules_in_course('assign', $course->id, 'm.duedate')) {
2112             $o .= $this->get_renderer()->notification(get_string('thereareno', 'moodle', $strplural));
2113             $o .= $this->get_renderer()->continue_button(new moodle_url('/course/view.php', array('id' => $course->id)));
2114             return $o;
2115         }
2117         $strsectionname = '';
2118         $usesections = course_format_uses_sections($course->format);
2119         $modinfo = get_fast_modinfo($course);
2121         if ($usesections) {
2122             $strsectionname = get_string('sectionname', 'format_'.$course->format);
2123             $sections = $modinfo->get_section_info_all();
2124         }
2125         $courseindexsummary = new assign_course_index_summary($usesections, $strsectionname);
2127         $timenow = time();
2129         $currentsection = '';
2130         foreach ($modinfo->instances['assign'] as $cm) {
2131             if (!$cm->uservisible) {
2132                 continue;
2133             }
2135             $timedue = $cms[$cm->id]->duedate;
2137             $sectionname = '';
2138             if ($usesections && $cm->sectionnum) {
2139                 $sectionname = get_section_name($course, $sections[$cm->sectionnum]);
2140             }
2142             $submitted = '';
2143             $context = context_module::instance($cm->id);
2145             $assignment = new assign($context, $cm, $course);
2147             if (has_capability('mod/assign:grade', $context)) {
2148                 $submitted = $assignment->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED);
2150             } else if (has_capability('mod/assign:submit', $context)) {
2151                 $usersubmission = $assignment->get_user_submission($USER->id, false);
2153                 if (!empty($usersubmission->status)) {
2154                     $submitted = get_string('submissionstatus_' . $usersubmission->status, 'assign');
2155                 } else {
2156                     $submitted = get_string('submissionstatus_', 'assign');
2157                 }
2158             }
2159             $gradinginfo = grade_get_grades($course->id, 'mod', 'assign', $cm->instance, $USER->id);
2160             if (isset($gradinginfo->items[0]->grades[$USER->id]) &&
2161                     !$gradinginfo->items[0]->grades[$USER->id]->hidden ) {
2162                 $grade = $gradinginfo->items[0]->grades[$USER->id]->str_grade;
2163             } else {
2164                 $grade = '-';
2165             }
2167             $courseindexsummary->add_assign_info($cm->id, $cm->name, $sectionname, $timedue, $submitted, $grade);
2169         }
2171         $o .= $this->get_renderer()->render($courseindexsummary);
2172         $o .= $this->view_footer();
2174         return $o;
2175     }
2177     /**
2178      * View a page rendered by a plugin.
2179      *
2180      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.
2181      *
2182      * @return string
2183      */
2184     protected function view_plugin_page() {
2185         global $USER;
2187         $o = '';
2189         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
2190         $plugintype = required_param('plugin', PARAM_TEXT);
2191         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
2193         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
2194         if (!$plugin) {
2195             print_error('invalidformdata', '');
2196             return;
2197         }
2199         $o .= $plugin->view_page($pluginaction);
2201         return $o;
2202     }
2205     /**
2206      * This is used for team assignments to get the group for the specified user.
2207      * If the user is a member of multiple or no groups this will return false
2208      *
2209      * @param int $userid The id of the user whose submission we want
2210      * @return mixed The group or false
2211      */
2212     public function get_submission_group($userid) {
2213         $grouping = $this->get_instance()->teamsubmissiongroupingid;
2214         $groups = groups_get_all_groups($this->get_course()->id, $userid, $grouping);
2215         if (count($groups) != 1) {
2216             return false;
2217         }
2218         return array_pop($groups);
2219     }
2222     /**
2223      * Display the submission that is used by a plugin.
2224      *
2225      * Uses url parameters 'sid', 'gid' and 'plugin'.
2226      *
2227      * @param string $pluginsubtype
2228      * @return string
2229      */
2230     protected function view_plugin_content($pluginsubtype) {
2231         $o = '';
2233         $submissionid = optional_param('sid', 0, PARAM_INT);
2234         $gradeid = optional_param('gid', 0, PARAM_INT);
2235         $plugintype = required_param('plugin', PARAM_TEXT);
2236         $item = null;
2237         if ($pluginsubtype == 'assignsubmission') {
2238             $plugin = $this->get_submission_plugin_by_type($plugintype);
2239             if ($submissionid <= 0) {
2240                 throw new coding_exception('Submission id should not be 0');
2241             }
2242             $item = $this->get_submission($submissionid);
2244             // Check permissions.
2245             $this->require_view_submission($item->userid);
2246             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2247                                                               $this->get_context(),
2248                                                               $this->show_intro(),
2249                                                               $this->get_course_module()->id,
2250                                                               $plugin->get_name()));
2251             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
2252                                                               $item,
2253                                                               assign_submission_plugin_submission::FULL,
2254                                                               $this->get_course_module()->id,
2255                                                               $this->get_return_action(),
2256                                                               $this->get_return_params()));
2258             // Trigger event for viewing a submission.
2259             \mod_assign\event\submission_viewed::create_from_submission($this, $item)->trigger();
2261         } else {
2262             $plugin = $this->get_feedback_plugin_by_type($plugintype);
2263             if ($gradeid <= 0) {
2264                 throw new coding_exception('Grade id should not be 0');
2265             }
2266             $item = $this->get_grade($gradeid);
2267             // Check permissions.
2268             $this->require_view_submission($item->userid);
2269             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2270                                                               $this->get_context(),
2271                                                               $this->show_intro(),
2272                                                               $this->get_course_module()->id,
2273                                                               $plugin->get_name()));
2274             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
2275                                                               $item,
2276                                                               assign_feedback_plugin_feedback::FULL,
2277                                                               $this->get_course_module()->id,
2278                                                               $this->get_return_action(),
2279                                                               $this->get_return_params()));
2281             // Trigger event for viewing feedback.
2282             \mod_assign\event\feedback_viewed::create_from_grade($this, $item)->trigger();
2283         }
2285         $o .= $this->view_return_links();
2287         $o .= $this->view_footer();
2289         return $o;
2290     }
2292     /**
2293      * Rewrite plugin file urls so they resolve correctly in an exported zip.
2294      *
2295      * @param string $text - The replacement text
2296      * @param stdClass $user - The user record
2297      * @param assign_plugin $plugin - The assignment plugin
2298      */
2299     public function download_rewrite_pluginfile_urls($text, $user, $plugin) {
2300         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2301         $groupname = '';
2302         if ($groupmode) {
2303             $groupid = groups_get_activity_group($this->get_course_module(), true);
2304             $groupname = groups_get_group_name($groupid).'-';
2305         }
2307         if ($this->is_blind_marking()) {
2308             $prefix = $groupname . get_string('participant', 'assign');
2309             $prefix = str_replace('_', ' ', $prefix);
2310             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2311         } else {
2312             $prefix = $groupname . fullname($user);
2313             $prefix = str_replace('_', ' ', $prefix);
2314             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2315         }
2317         $subtype = $plugin->get_subtype();
2318         $type = $plugin->get_type();
2319         $prefix = $prefix . $subtype . '_' . $type . '_';
2321         $result = str_replace('@@PLUGINFILE@@/', $prefix, $text);
2323         return $result;
2324     }
2326     /**
2327      * Render the content in editor that is often used by plugin.
2328      *
2329      * @param string $filearea
2330      * @param int  $submissionid
2331      * @param string $plugintype
2332      * @param string $editor
2333      * @param string $component
2334      * @return string
2335      */
2336     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
2337         global $CFG;
2339         $result = '';
2341         $plugin = $this->get_submission_plugin_by_type($plugintype);
2343         $text = $plugin->get_editor_text($editor, $submissionid);
2344         $format = $plugin->get_editor_format($editor, $submissionid);
2346         $finaltext = file_rewrite_pluginfile_urls($text,
2347                                                   'pluginfile.php',
2348                                                   $this->get_context()->id,
2349                                                   $component,
2350                                                   $filearea,
2351                                                   $submissionid);
2352         $params = array('overflowdiv' => true, 'context' => $this->get_context());
2353         $result .= format_text($finaltext, $format, $params);
2355         if ($CFG->enableportfolios) {
2356             require_once($CFG->libdir . '/portfoliolib.php');
2358             $button = new portfolio_add_button();
2359             $portfolioparams = array('cmid' => $this->get_course_module()->id,
2360                                      'sid' => $submissionid,
2361                                      'plugin' => $plugintype,
2362                                      'editor' => $editor,
2363                                      'area'=>$filearea);
2364             $button->set_callback_options('assign_portfolio_caller', $portfolioparams, 'mod_assign');
2365             $fs = get_file_storage();
2367             if ($files = $fs->get_area_files($this->context->id,
2368                                              $component,
2369                                              $filearea,
2370                                              $submissionid,
2371                                              'timemodified',
2372                                              false)) {
2373                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
2374             } else {
2375                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
2376             }
2377             $result .= $button->to_html();
2378         }
2379         return $result;
2380     }
2382     /**
2383      * Display a continue page after grading.
2384      *
2385      * @param string $message - The message to display.
2386      * @return string
2387      */
2388     protected function view_savegrading_result($message) {
2389         $o = '';
2390         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2391                                                       $this->get_context(),
2392                                                       $this->show_intro(),
2393                                                       $this->get_course_module()->id,
2394                                                       get_string('savegradingresult', 'assign')));
2395         $gradingresult = new assign_gradingmessage(get_string('savegradingresult', 'assign'),
2396                                                    $message,
2397                                                    $this->get_course_module()->id);
2398         $o .= $this->get_renderer()->render($gradingresult);
2399         $o .= $this->view_footer();
2400         return $o;
2401     }
2402     /**
2403      * Display a continue page after quickgrading.
2404      *
2405      * @param string $message - The message to display.
2406      * @return string
2407      */
2408     protected function view_quickgrading_result($message) {
2409         $o = '';
2410         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2411                                                       $this->get_context(),
2412                                                       $this->show_intro(),
2413                                                       $this->get_course_module()->id,
2414                                                       get_string('quickgradingresult', 'assign')));
2415         $lastpage = optional_param('lastpage', null, PARAM_INT);
2416         $gradingresult = new assign_gradingmessage(get_string('quickgradingresult', 'assign'),
2417                                                    $message,
2418                                                    $this->get_course_module()->id,
2419                                                    false,
2420                                                    $lastpage);
2421         $o .= $this->get_renderer()->render($gradingresult);
2422         $o .= $this->view_footer();
2423         return $o;
2424     }
2426     /**
2427      * Display the page footer.
2428      *
2429      * @return string
2430      */
2431     protected function view_footer() {
2432         // When viewing the footer during PHPUNIT tests a set_state error is thrown.
2433         if (!PHPUNIT_TEST) {
2434             return $this->get_renderer()->render_footer();
2435         }
2437         return '';
2438     }
2440     /**
2441      * Throw an error if the permissions to view this users submission are missing.
2442      *
2443      * @throws required_capability_exception
2444      * @return none
2445      */
2446     public function require_view_submission($userid) {
2447         if (!$this->can_view_submission($userid)) {
2448             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
2449         }
2450     }
2452     /**
2453      * Throw an error if the permissions to view grades in this assignment are missing.
2454      *
2455      * @throws required_capability_exception
2456      * @return none
2457      */
2458     public function require_view_grades() {
2459         if (!$this->can_view_grades()) {
2460             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
2461         }
2462     }
2464     /**
2465      * Does this user have view grade or grade permission for this assignment?
2466      *
2467      * @return bool
2468      */
2469     public function can_view_grades() {
2470         // Permissions check.
2471         if (!has_any_capability(array('mod/assign:viewgrades', 'mod/assign:grade'), $this->context)) {
2472             return false;
2473         }
2475         return true;
2476     }
2478     /**
2479      * Does this user have grade permission for this assignment?
2480      *
2481      * @return bool
2482      */
2483     public function can_grade() {
2484         // Permissions check.
2485         if (!has_capability('mod/assign:grade', $this->context)) {
2486             return false;
2487         }
2489         return true;
2490     }
2492     /**
2493      * Download a zip file of all assignment submissions.
2494      *
2495      * @return string - If an error occurs, this will contain the error page.
2496      */
2497     protected function download_submissions() {
2498         global $CFG, $DB;
2500         // More efficient to load this here.
2501         require_once($CFG->libdir.'/filelib.php');
2503         $this->require_view_grades();
2505         // Load all users with submit.
2506         $students = get_enrolled_users($this->context, "mod/assign:submit", null, 'u.*', null, null, null,
2507                         $this->show_only_active_users());
2509         // Build a list of files to zip.
2510         $filesforzipping = array();
2511         $fs = get_file_storage();
2513         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2514         // All users.
2515         $groupid = 0;
2516         $groupname = '';
2517         if ($groupmode) {
2518             $groupid = groups_get_activity_group($this->get_course_module(), true);
2519             $groupname = groups_get_group_name($groupid).'-';
2520         }
2522         // Construct the zip file name.
2523         $filename = clean_filename($this->get_course()->shortname . '-' .
2524                                    $this->get_instance()->name . '-' .
2525                                    $groupname.$this->get_course_module()->id . '.zip');
2527         // Get all the files for each student.
2528         foreach ($students as $student) {
2529             $userid = $student->id;
2531             if ((groups_is_member($groupid, $userid) or !$groupmode or !$groupid)) {
2532                 // Get the plugins to add their own files to the zip.
2534                 $submissiongroup = false;
2535                 $groupname = '';
2536                 if ($this->get_instance()->teamsubmission) {
2537                     $submission = $this->get_group_submission($userid, 0, false);
2538                     $submissiongroup = $this->get_submission_group($userid);
2539                     if ($submissiongroup) {
2540                         $groupname = $submissiongroup->name . '-';
2541                     } else {
2542                         $groupname = get_string('defaultteam', 'assign') . '-';
2543                     }
2544                 } else {
2545                     $submission = $this->get_user_submission($userid, false);
2546                 }
2548                 if ($this->is_blind_marking()) {
2549                     $prefix = str_replace('_', ' ', $groupname . get_string('participant', 'assign'));
2550                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid) . '_');
2551                 } else {
2552                     $prefix = str_replace('_', ' ', $groupname . fullname($student));
2553                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid) . '_');
2554                 }
2556                 if ($submission) {
2557                     foreach ($this->submissionplugins as $plugin) {
2558                         if ($plugin->is_enabled() && $plugin->is_visible()) {
2559                             $pluginfiles = $plugin->get_files($submission, $student);
2560                             foreach ($pluginfiles as $zipfilename => $file) {
2561                                 $subtype = $plugin->get_subtype();
2562                                 $type = $plugin->get_type();
2563                                 $prefixedfilename = clean_filename($prefix .
2564                                                                    $subtype .
2565                                                                    '_' .
2566                                                                    $type .
2567                                                                    '_' .
2568                                                                    $zipfilename);
2569                                 $filesforzipping[$prefixedfilename] = $file;
2570                             }
2571                         }
2572                     }
2573                 }
2574             }
2575         }
2576         $result = '';
2577         if (count($filesforzipping) == 0) {
2578             $header = new assign_header($this->get_instance(),
2579                                         $this->get_context(),
2580                                         '',
2581                                         $this->get_course_module()->id,
2582                                         get_string('downloadall', 'assign'));
2583             $result .= $this->get_renderer()->render($header);
2584             $result .= $this->get_renderer()->notification(get_string('nosubmission', 'assign'));
2585             $url = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
2586                                                                     'action'=>'grading'));
2587             $result .= $this->get_renderer()->continue_button($url);
2588             $result .= $this->view_footer();
2589         } else if ($zipfile = $this->pack_files($filesforzipping)) {
2590             \mod_assign\event\all_submissions_downloaded::create_from_assign($this)->trigger();
2591             // Send file and delete after sending.
2592             send_temp_file($zipfile, $filename);
2593             // We will not get here - send_temp_file calls exit.
2594         }
2595         return $result;
2596     }
2598     /**
2599      * Util function to add a message to the log.
2600      *
2601      * @deprecated since 2.7 - Use new events system instead.
2602      *             (see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins).
2603      *
2604      * @param string $action The current action
2605      * @param string $info A detailed description of the change. But no more than 255 characters.
2606      * @param string $url The url to the assign module instance.
2607      * @param bool $return If true, returns the arguments, else adds to log. The purpose of this is to
2608      *                     retrieve the arguments to use them with the new event system (Event 2).
2609      * @return void|array
2610      */
2611     public function add_to_log($action = '', $info = '', $url='', $return = false) {
2612         global $USER;
2614         $fullurl = 'view.php?id=' . $this->get_course_module()->id;
2615         if ($url != '') {
2616             $fullurl .= '&' . $url;
2617         }
2619         $args = array(
2620             $this->get_course()->id,
2621             'assign',
2622             $action,
2623             $fullurl,
2624             $info,
2625             $this->get_course_module()->id
2626         );
2628         if ($return) {
2629             // We only need to call debugging when returning a value. This is because the call to
2630             // call_user_func_array('add_to_log', $args) will trigger a debugging message of it's own.
2631             debugging('The mod_assign add_to_log() function is now deprecated.', DEBUG_DEVELOPER);
2632             return $args;
2633         }
2634         call_user_func_array('add_to_log', $args);
2635     }
2637     /**
2638      * Lazy load the page renderer and expose the renderer to plugins.
2639      *
2640      * @return assign_renderer
2641      */
2642     public function get_renderer() {
2643         global $PAGE;
2644         if ($this->output) {
2645             return $this->output;
2646         }
2647         $this->output = $PAGE->get_renderer('mod_assign');
2648         return $this->output;
2649     }
2651     /**
2652      * Load the submission object for a particular user, optionally creating it if required.
2653      *
2654      * For team assignments there are 2 submissions - the student submission and the team submission
2655      * All files are associated with the team submission but the status of the students contribution is
2656      * recorded separately.
2657      *
2658      * @param int $userid The id of the user whose submission we want or 0 in which case USER->id is used
2659      * @param bool $create optional - defaults to false. If set to true a new submission object
2660      *                     will be created in the database with the status set to "new".
2661      * @param int $attemptnumber - -1 means the latest attempt
2662      * @return stdClass The submission
2663      */
2664     public function get_user_submission($userid, $create, $attemptnumber=-1) {
2665         global $DB, $USER;
2667         if (!$userid) {
2668             $userid = $USER->id;
2669         }
2670         // If the userid is not null then use userid.
2671         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
2672         if ($attemptnumber >= 0) {
2673             $params['attemptnumber'] = $attemptnumber;
2674         }
2676         // Only return the row with the highest attemptnumber.
2677         $submission = null;
2678         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2679         if ($submissions) {
2680             $submission = reset($submissions);
2681         }
2683         if ($submission) {
2684             return $submission;
2685         }
2686         if ($create) {
2687             $submission = new stdClass();
2688             $submission->assignment   = $this->get_instance()->id;
2689             $submission->userid       = $userid;
2690             $submission->timecreated = time();
2691             $submission->timemodified = $submission->timecreated;
2692             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2693             if ($attemptnumber >= 0) {
2694                 $submission->attemptnumber = $attemptnumber;
2695             } else {
2696                 $submission->attemptnumber = 0;
2697             }
2698             // Work out if this is the latest submission.
2699             $submission->latest = 0;
2700             $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
2701             if ($attemptnumber == -1) {
2702                 // This is a new submission so it must be the latest.
2703                 $submission->latest = 1;
2704             } else {
2705                 // We need to work this out.
2706                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2707                 $latestsubmission = null;
2708                 if ($result) {
2709                     $latestsubmission = reset($result);
2710                 }
2711                 if (empty($latestsubmission) || ($attemptnumber > $latestsubmission->attemptnumber)) {
2712                     $submission->latest = 1;
2713                 }
2714             }
2715             if ($submission->latest) {
2716                 // This is the case when we need to set latest to 0 for all the other attempts.
2717                 $DB->set_field('assign_submission', 'latest', 0, $params);
2718             }
2719             $sid = $DB->insert_record('assign_submission', $submission);
2720             return $DB->get_record('assign_submission', array('id' => $sid));
2721         }
2722         return false;
2723     }
2725     /**
2726      * Load the submission object from it's id.
2727      *
2728      * @param int $submissionid The id of the submission we want
2729      * @return stdClass The submission
2730      */
2731     protected function get_submission($submissionid) {
2732         global $DB;
2734         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$submissionid);
2735         return $DB->get_record('assign_submission', $params, '*', MUST_EXIST);
2736     }
2738     /**
2739      * This will retrieve a user flags object from the db optionally creating it if required.
2740      * The user flags was split from the user_grades table in 2.5.
2741      *
2742      * @param int $userid The user we are getting the flags for.
2743      * @param bool $create If true the flags record will be created if it does not exist
2744      * @return stdClass The flags record
2745      */
2746     public function get_user_flags($userid, $create) {
2747         global $DB, $USER;
2749         // If the userid is not null then use userid.
2750         if (!$userid) {
2751             $userid = $USER->id;
2752         }
2754         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
2756         $flags = $DB->get_record('assign_user_flags', $params);
2758         if ($flags) {
2759             return $flags;
2760         }
2761         if ($create) {
2762             $flags = new stdClass();
2763             $flags->assignment = $this->get_instance()->id;
2764             $flags->userid = $userid;
2765             $flags->locked = 0;
2766             $flags->extensionduedate = 0;
2767             $flags->workflowstate = '';
2768             $flags->allocatedmarker = 0;
2770             // The mailed flag can be one of 3 values: 0 is unsent, 1 is sent and 2 is do not send yet.
2771             // This is because students only want to be notified about certain types of update (grades and feedback).
2772             $flags->mailed = 2;
2774             $fid = $DB->insert_record('assign_user_flags', $flags);
2775             $flags->id = $fid;
2776             return $flags;
2777         }
2778         return false;
2779     }
2781     /**
2782      * This will retrieve a grade object from the db, optionally creating it if required.
2783      *
2784      * @param int $userid The user we are grading
2785      * @param bool $create If true the grade will be created if it does not exist
2786      * @param int $attemptnumber The attempt number to retrieve the grade for. -1 means the latest submission.
2787      * @return stdClass The grade record
2788      */
2789     public function get_user_grade($userid, $create, $attemptnumber=-1) {
2790         global $DB, $USER;
2792         // If the userid is not null then use userid.
2793         if (!$userid) {
2794             $userid = $USER->id;
2795         }
2797         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
2798         if ($attemptnumber < 0) {
2799             // Make sure this grade matches the latest submission attempt.
2800             if ($this->get_instance()->teamsubmission) {
2801                 $submission = $this->get_group_submission($userid, 0, true);
2802             } else {
2803                 $submission = $this->get_user_submission($userid, true);
2804             }
2805             if ($submission) {
2806                 $attemptnumber = $submission->attemptnumber;
2807             }
2808         }
2810         if ($attemptnumber >= 0) {
2811             $params['attemptnumber'] = $attemptnumber;
2812         }
2814         $grades = $DB->get_records('assign_grades', $params, 'attemptnumber DESC', '*', 0, 1);
2816         if ($grades) {
2817             return reset($grades);
2818         }
2819         if ($create) {
2820             $grade = new stdClass();
2821             $grade->assignment   = $this->get_instance()->id;
2822             $grade->userid       = $userid;
2823             $grade->timecreated = time();
2824             $grade->timemodified = $grade->timecreated;
2825             $grade->grade = -1;
2826             $grade->grader = $USER->id;
2827             if ($attemptnumber >= 0) {
2828                 $grade->attemptnumber = $attemptnumber;
2829             }
2831             $gid = $DB->insert_record('assign_grades', $grade);
2832             $grade->id = $gid;
2833             return $grade;
2834         }
2835         return false;
2836     }
2838     /**
2839      * This will retrieve a grade object from the db.
2840      *
2841      * @param int $gradeid The id of the grade
2842      * @return stdClass The grade record
2843      */
2844     protected function get_grade($gradeid) {
2845         global $DB;
2847         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$gradeid);
2848         return $DB->get_record('assign_grades', $params, '*', MUST_EXIST);
2849     }
2851     /**
2852      * Print the grading page for a single user submission.
2853      *
2854      * @param moodleform $mform
2855      * @return string
2856      */
2857     protected function view_single_grade_page($mform) {
2858         global $DB, $CFG;
2860         $o = '';
2861         $instance = $this->get_instance();
2863         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
2865         // Need submit permission to submit an assignment.
2866         require_capability('mod/assign:grade', $this->context);
2868         $header = new assign_header($instance,
2869                                     $this->get_context(),
2870                                     false,
2871                                     $this->get_course_module()->id,
2872                                     get_string('grading', 'assign'));
2873         $o .= $this->get_renderer()->render($header);
2875         // If userid is passed - we are only grading a single student.
2876         $rownum = required_param('rownum', PARAM_INT);
2877         $useridlistid = optional_param('useridlistid', time(), PARAM_INT);
2878         $userid = optional_param('userid', 0, PARAM_INT);
2879         $attemptnumber = optional_param('attemptnumber', -1, PARAM_INT);
2881         $cache = cache::make_from_params(cache_store::MODE_SESSION, 'mod_assign', 'useridlist');
2882         if (!$userid) {
2883             if (!$useridlist = $cache->get($this->get_course_module()->id . '_' . $useridlistid)) {
2884                 $useridlist = $this->get_grading_userid_list();
2885             }
2886             $cache->set($this->get_course_module()->id . '_' . $useridlistid, $useridlist);
2887         } else {
2888             $rownum = 0;
2889             $useridlist = array($userid);
2890         }
2892         if ($rownum < 0 || $rownum > count($useridlist)) {
2893             throw new coding_exception('Row is out of bounds for the current grading table: ' . $rownum);
2894         }
2896         $last = false;
2897         $userid = $useridlist[$rownum];
2898         if ($rownum == count($useridlist) - 1) {
2899             $last = true;
2900         }
2901         $user = $DB->get_record('user', array('id' => $userid));
2902         if ($user) {
2903             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
2904             $usersummary = new assign_user_summary($user,
2905                                                    $this->get_course()->id,
2906                                                    $viewfullnames,
2907                                                    $this->is_blind_marking(),
2908                                                    $this->get_uniqueid_for_user($user->id),
2909                                                    get_extra_user_fields($this->get_context()),
2910                                                    !$this->is_active_user($userid));
2911             $o .= $this->get_renderer()->render($usersummary);
2912         }
2913         $submission = $this->get_user_submission($userid, false, $attemptnumber);
2914         $submissiongroup = null;
2915         $teamsubmission = null;
2916         $notsubmitted = array();
2917         if ($instance->teamsubmission) {
2918             $teamsubmission = $this->get_group_submission($userid, 0, false, $attemptnumber);
2919             $submissiongroup = $this->get_submission_group($userid);
2920             $groupid = 0;
2921             if ($submissiongroup) {
2922                 $groupid = $submissiongroup->id;
2923             }
2924             $notsubmitted = $this->get_submission_group_members_who_have_not_submitted($groupid, false);
2926         }
2928         // Get the requested grade.
2929         $grade = $this->get_user_grade($userid, false, $attemptnumber);
2930         $flags = $this->get_user_flags($userid, false);
2931         if ($this->can_view_submission($userid)) {
2932             $gradelocked = ($flags && $flags->locked) || $this->grading_disabled($userid);
2933             $extensionduedate = null;
2934             if ($flags) {
2935                 $extensionduedate = $flags->extensionduedate;
2936             }
2937             $showedit = $this->submissions_open($userid) && ($this->is_any_submission_plugin_enabled());
2938             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
2940             $submissionstatus = new assign_submission_status($instance->allowsubmissionsfromdate,
2941                                                              $instance->alwaysshowdescription,
2942                                                              $submission,
2943                                                              $instance->teamsubmission,
2944                                                              $teamsubmission,
2945                                                              $submissiongroup,
2946                                                              $notsubmitted,
2947                                                              $this->is_any_submission_plugin_enabled(),
2948                                                              $gradelocked,
2949                                                              $this->is_graded($userid),
2950                                                              $instance->duedate,
2951                                                              $instance->cutoffdate,
2952                                                              $this->get_submission_plugins(),
2953                                                              $this->get_return_action(),
2954                                                              $this->get_return_params(),
2955                                                              $this->get_course_module()->id,
2956                                                              $this->get_course()->id,
2957                                                              assign_submission_status::GRADER_VIEW,
2958                                                              $showedit,
2959                                                              false,
2960                                                              $viewfullnames,
2961                                                              $extensionduedate,
2962                                                              $this->get_context(),
2963                                                              $this->is_blind_marking(),
2964                                                              '',
2965                                                              $instance->attemptreopenmethod,
2966                                                              $instance->maxattempts);
2967             $o .= $this->get_renderer()->render($submissionstatus);
2968         }
2970         if ($grade) {
2971             $data = new stdClass();
2972             if ($grade->grade !== null && $grade->grade >= 0) {
2973                 $data->grade = format_float($grade->grade, 2);
2974             }
2975             if (!empty($flags->workflowstate)) {
2976                 $data->workflowstate = $flags->workflowstate;
2977             }
2978             if (!empty($flags->allocatedmarker)) {
2979                 $data->allocatedmarker = $flags->allocatedmarker;
2980             }
2981         } else {
2982             $data = new stdClass();
2983             $data->grade = '';
2984         }
2985         // Warning if required.
2986         $allsubmissions = $this->get_all_submissions($userid);
2988         if ($attemptnumber != -1) {
2989             $params = array('attemptnumber'=>$attemptnumber + 1,
2990                             'totalattempts'=>count($allsubmissions));
2991             $message = get_string('editingpreviousfeedbackwarning', 'assign', $params);
2992             $o .= $this->get_renderer()->notification($message);
2993         }
2995         // Now show the grading form.
2996         if (!$mform) {
2997             $pagination = array('rownum'=>$rownum,
2998                                 'useridlistid'=>$useridlistid,
2999                                 'last'=>$last,
3000                                 'userid'=>optional_param('userid', 0, PARAM_INT),
3001                                 'attemptnumber'=>$attemptnumber);
3002             $formparams = array($this, $data, $pagination);
3003             $mform = new mod_assign_grade_form(null,
3004                                                $formparams,
3005                                                'post',
3006                                                '',
3007                                                array('class'=>'gradeform'));
3008         }
3009         $o .= $this->get_renderer()->heading(get_string('grade'), 3);
3010         $o .= $this->get_renderer()->render(new assign_form('gradingform', $mform));
3012         if (count($allsubmissions) > 1 && $attemptnumber == -1) {
3013             $allgrades = $this->get_all_grades($userid);
3014             $history = new assign_attempt_history($allsubmissions,
3015                                                   $allgrades,
3016                                                   $this->get_submission_plugins(),
3017                                                   $this->get_feedback_plugins(),
3018                                                   $this->get_course_module()->id,
3019                                                   $this->get_return_action(),
3020                                                   $this->get_return_params(),
3021                                                   true,
3022                                                   $useridlistid,
3023                                                   $rownum);
3025             $o .= $this->get_renderer()->render($history);
3026         }
3028         \mod_assign\event\grading_form_viewed::create_from_user($this, $user)->trigger();
3030         $o .= $this->view_footer();
3031         return $o;
3032     }
3034     /**
3035      * Show a confirmation page to make sure they want to release student identities.
3036      *
3037      * @return string
3038      */
3039     protected function view_reveal_identities_confirm() {
3040         require_capability('mod/assign:revealidentities', $this->get_context());
3042         $o = '';
3043         $header = new assign_header($this->get_instance(),
3044                                     $this->get_context(),
3045                                     false,
3046                                     $this->get_course_module()->id);
3047         $o .= $this->get_renderer()->render($header);
3049         $urlparams = array('id'=>$this->get_course_module()->id,
3050                            'action'=>'revealidentitiesconfirm',
3051                            'sesskey'=>sesskey());
3052         $confirmurl = new moodle_url('/mod/assign/view.php', $urlparams);
3054         $urlparams = array('id'=>$this->get_course_module()->id,
3055                            'action'=>'grading');
3056         $cancelurl = new moodle_url('/mod/assign/view.php', $urlparams);
3058         $o .= $this->get_renderer()->confirm(get_string('revealidentitiesconfirm', 'assign'),
3059                                              $confirmurl,
3060                                              $cancelurl);
3061         $o .= $this->view_footer();
3063         \mod_assign\event\reveal_identities_confirmation_page_viewed::create_from_assign($this)->trigger();
3065         return $o;
3066     }
3068     /**
3069      * View a link to go back to the previous page. Uses url parameters returnaction and returnparams.
3070      *
3071      * @return string
3072      */
3073     protected function view_return_links() {
3074         $returnaction = optional_param('returnaction', '', PARAM_ALPHA);
3075         $returnparams = optional_param('returnparams', '', PARAM_TEXT);
3077         $params = array();
3078         $returnparams = str_replace('&amp;', '&', $returnparams);
3079         parse_str($returnparams, $params);
3080         $newparams = array('id' => $this->get_course_module()->id, 'action' => $returnaction);
3081         $params = array_merge($newparams, $params);
3083         $url = new moodle_url('/mod/assign/view.php', $params);
3084         return $this->get_renderer()->single_button($url, get_string('back'), 'get');
3085     }
3087     /**
3088      * View the grading table of all submissions for this assignment.
3089      *
3090      * @return string
3091      */
3092     protected function view_grading_table() {
3093         global $USER, $CFG;
3095         // Include grading options form.
3096         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
3097         require_once($CFG->dirroot . '/mod/assign/quickgradingform.php');
3098         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
3099         $o = '';
3100         $cmid = $this->get_course_module()->id;
3102         $links = array();
3103         if (has_capability('gradereport/grader:view', $this->get_course_context()) &&
3104                 has_capability('moodle/grade:viewall', $this->get_course_context())) {
3105             $gradebookurl = '/grade/report/grader/index.php?id=' . $this->get_course()->id;
3106             $links[$gradebookurl] = get_string('viewgradebook', 'assign');
3107         }
3108         if ($this->is_any_submission_plugin_enabled() && $this->count_submissions()) {
3109             $downloadurl = '/mod/assign/view.php?id=' . $cmid . '&action=downloadall';
3110             $links[$downloadurl] = get_string('downloadall', 'assign');
3111         }
3112         if ($this->is_blind_marking() &&
3113                 has_capability('mod/assign:revealidentities', $this->get_context())) {
3114             $revealidentitiesurl = '/mod/assign/view.php?id=' . $cmid . '&action=revealidentities';
3115             $links[$revealidentitiesurl] = get_string('revealidentities', 'assign');
3116         }
3117         foreach ($this->get_feedback_plugins() as $plugin) {
3118             if ($plugin->is_enabled() && $plugin->is_visible()) {
3119                 foreach ($plugin->get_grading_actions() as $action => $description) {
3120                     $url = '/mod/assign/view.php' .
3121                            '?id=' .  $cmid .
3122                            '&plugin=' . $plugin->get_type() .
3123                            '&pluginsubtype=assignfeedback' .
3124                            '&action=viewpluginpage&pluginaction=' . $action;
3125                     $links[$url] = $description;
3126                 }
3127             }
3128         }
3130         // Sort links alphabetically based on the link description.
3131         core_collator::asort($links);
3133         $gradingactions = new url_select($links);
3134         $gradingactions->set_label(get_string('choosegradingaction', 'assign'));
3136         $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
3138         $perpage = (int) get_user_preferences('assign_perpage', 10);
3139         $filter = get_user_preferences('assign_filter', '');
3140         $markerfilter = get_user_preferences('assign_markerfilter', '');
3141         $workflowfilter = get_user_preferences('assign_workflowfilter', '');
3142         $controller = $gradingmanager->get_active_controller();
3143         $showquickgrading = empty($controller) && $this->can_grade();
3144         $quickgrading = get_user_preferences('assign_quickgrading', false);
3145         $showonlyactiveenrolopt = has_capability('moodle/course:viewsuspendedusers', $this->context);
3147         $markingallocation = $this->get_instance()->markingworkflow &&
3148             $this->get_instance()->markingallocation &&
3149             has_capability('mod/assign:manageallocations', $this->context);
3150         // Get markers to use in drop lists.
3151         $markingallocationoptions = array();
3152         if ($markingallocation) {
3153             $markers = get_users_by_capability($this->context, 'mod/assign:grade');
3154             $markingallocationoptions[''] = get_string('filternone', 'assign');
3155             $markingallocationoptions[ASSIGN_MARKER_FILTER_NO_MARKER] = get_string('markerfilternomarker', 'assign');
3156             foreach ($markers as $marker) {
3157                 $markingallocationoptions[$marker->id] = fullname($marker);
3158             }
3159         }
3161         $markingworkflow = $this->get_instance()->markingworkflow;
3162         // Get marking states to show in form.
3163         $markingworkflowoptions = array();
3164         if ($markingworkflow) {
3165             $notmarked = get_string('markingworkflowstatenotmarked', 'assign');
3166             $markingworkflowoptions[''] = get_string('filternone', 'assign');
3167             $markingworkflowoptions[ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED] = $notmarked;
3168             $markingworkflowoptions = array_merge($markingworkflowoptions, $this->get_marking_workflow_states_for_current_user());
3169         }
3171         // Print options for changing the filter and changing the number of results per page.
3172         $gradingoptionsformparams = array('cm'=>$cmid,
3173                                           'contextid'=>$this->context->id,
3174                                           'userid'=>$USER->id,
3175                                           'submissionsenabled'=>$this->is_any_submission_plugin_enabled(),
3176                                           'showquickgrading'=>$showquickgrading,
3177                                           'quickgrading'=>$quickgrading,
3178                                           'markingworkflowopt'=>$markingworkflowoptions,
3179                                           'markingallocationopt'=>$markingallocationoptions,
3180                                           'showonlyactiveenrolopt'=>$showonlyactiveenrolopt,
3181                                           'showonlyactiveenrol'=>$this->show_only_active_users());
3183         $classoptions = array('class'=>'gradingoptionsform');
3184         $gradingoptionsform = new mod_assign_grading_options_form(null,
3185                                                                   $gradingoptionsformparams,
3186                                                                   'post',
3187                                                                   '',
3188                                                                   $classoptions);
3190         $batchformparams = array('cm'=>$cmid,
3191                                  'submissiondrafts'=>$this->get_instance()->submissiondrafts,
3192                                  'duedate'=>$this->get_instance()->duedate,
3193                                  'attemptreopenmethod'=>$this->get_instance()->attemptreopenmethod,
3194                                  'feedbackplugins'=>$this->get_feedback_plugins(),
3195                                  'context'=>$this->get_context(),
3196                                  'markingworkflow'=>$markingworkflow,
3197                                  'markingallocation'=>$markingallocation);
3198         $classoptions = array('class'=>'gradingbatchoperationsform');
3200         $gradingbatchoperationsform = new mod_assign_grading_batch_operations_form(null,
3201                                                                                    $batchformparams,
3202                                                                                    'post',
3203                                                                                    '',
3204                                                                                    $classoptions);
3206         $gradingoptionsdata = new stdClass();
3207         $gradingoptionsdata->perpage = $perpage;
3208         $gradingoptionsdata->filter = $filter;
3209         $gradingoptionsdata->markerfilter = $markerfilter;
3210         $gradingoptionsdata->workflowfilter = $workflowfilter;
3211         $gradingoptionsform->set_data($gradingoptionsdata);
3213         $actionformtext = $this->get_renderer()->render($gradingactions);
3214         $header = new assign_header($this->get_instance(),
3215                                     $this->get_context(),
3216                                     false,
3217                                     $this->get_course_module()->id,
3218                                     get_string('grading', 'assign'),
3219                                     $actionformtext);
3220         $o .= $this->get_renderer()->render($header);
3222         $currenturl = $CFG->wwwroot .
3223                       '/mod/assign/view.php?id=' .
3224                       $this->get_course_module()->id .
3225                       '&action=grading';
3227         $o .= groups_print_activity_menu($this->get_course_module(), $currenturl, true);
3229         // Plagiarism update status apearring in the grading book.
3230         if (!empty($CFG->enableplagiarism)) {
3231             require_once($CFG->libdir . '/plagiarismlib.php');
3232             $o .= plagiarism_update_status($this->get_course(), $this->get_course_module());
3233         }
3235         // Load and print the table of submissions.
3236         if ($showquickgrading && $quickgrading) {
3237             $gradingtable = new assign_grading_table($this, $perpage, $filter, 0, true);
3238             $table = $this->get_renderer()->render($gradingtable);
3239             $page = optional_param('page', null, PARAM_INT);
3240             $quickformparams = array('cm'=>$this->get_course_module()->id,
3241                                      'gradingtable'=>$table,
3242                                      'sendstudentnotifications' => $this->get_instance()->sendstudentnotifications,
3243                                      'page' => $page);
3244             $quickgradingform = new mod_assign_quick_grading_form(null, $quickformparams);
3246             $o .= $this->get_renderer()->render(new assign_form('quickgradingform', $quickgradingform));
3247         } else {
3248             $gradingtable = new assign_grading_table($this, $perpage, $filter, 0, false);