MDL-64761 assign: Return grader -1 when hidden in get_submission_status
[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_NONE', 'none');
37 define('ASSIGN_FILTER_SUBMITTED', 'submitted');
38 define('ASSIGN_FILTER_NOT_SUBMITTED', 'notsubmitted');
39 define('ASSIGN_FILTER_SINGLE_USER', 'singleuser');
40 define('ASSIGN_FILTER_REQUIRE_GRADING', 'requiregrading');
41 define('ASSIGN_FILTER_GRANTED_EXTENSION', 'grantedextension');
43 // Marker filter for grading page.
44 define('ASSIGN_MARKER_FILTER_NO_MARKER', -1);
46 // Reopen attempt methods.
47 define('ASSIGN_ATTEMPT_REOPEN_METHOD_NONE', 'none');
48 define('ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL', 'manual');
49 define('ASSIGN_ATTEMPT_REOPEN_METHOD_UNTILPASS', 'untilpass');
51 // Special value means allow unlimited attempts.
52 define('ASSIGN_UNLIMITED_ATTEMPTS', -1);
54 // Special value means no grade has been set.
55 define('ASSIGN_GRADE_NOT_SET', -1);
57 // Grading states.
58 define('ASSIGN_GRADING_STATUS_GRADED', 'graded');
59 define('ASSIGN_GRADING_STATUS_NOT_GRADED', 'notgraded');
61 // Marking workflow states.
62 define('ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED', 'notmarked');
63 define('ASSIGN_MARKING_WORKFLOW_STATE_INMARKING', 'inmarking');
64 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORREVIEW', 'readyforreview');
65 define('ASSIGN_MARKING_WORKFLOW_STATE_INREVIEW', 'inreview');
66 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORRELEASE', 'readyforrelease');
67 define('ASSIGN_MARKING_WORKFLOW_STATE_RELEASED', 'released');
69 /** ASSIGN_MAX_EVENT_LENGTH = 432000 ; 5 days maximum */
70 define("ASSIGN_MAX_EVENT_LENGTH", "432000");
72 // Name of file area for intro attachments.
73 define('ASSIGN_INTROATTACHMENT_FILEAREA', 'introattachment');
75 // Event types.
76 define('ASSIGN_EVENT_TYPE_DUE', 'due');
77 define('ASSIGN_EVENT_TYPE_GRADINGDUE', 'gradingdue');
78 define('ASSIGN_EVENT_TYPE_OPEN', 'open');
79 define('ASSIGN_EVENT_TYPE_CLOSE', 'close');
81 require_once($CFG->libdir . '/accesslib.php');
82 require_once($CFG->libdir . '/formslib.php');
83 require_once($CFG->dirroot . '/repository/lib.php');
84 require_once($CFG->dirroot . '/mod/assign/mod_form.php');
85 require_once($CFG->libdir . '/gradelib.php');
86 require_once($CFG->dirroot . '/grade/grading/lib.php');
87 require_once($CFG->dirroot . '/mod/assign/feedbackplugin.php');
88 require_once($CFG->dirroot . '/mod/assign/submissionplugin.php');
89 require_once($CFG->dirroot . '/mod/assign/renderable.php');
90 require_once($CFG->dirroot . '/mod/assign/gradingtable.php');
91 require_once($CFG->libdir . '/portfolio/caller.php');
93 use \mod_assign\output\grading_app;
95 /**
96  * Standard base class for mod_assign (assignment types).
97  *
98  * @package   mod_assign
99  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
100  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
101  */
102 class assign {
104     /** @var stdClass the assignment record that contains the global settings for this assign instance */
105     private $instance;
107     /** @var grade_item the grade_item record for this assign instance's primary grade item. */
108     private $gradeitem;
110     /** @var context the context of the course module for this assign instance
111      *               (or just the course if we are creating a new one)
112      */
113     private $context;
115     /** @var stdClass the course this assign instance belongs to */
116     private $course;
118     /** @var stdClass the admin config for all assign instances  */
119     private $adminconfig;
121     /** @var assign_renderer the custom renderer for this module */
122     private $output;
124     /** @var cm_info the course module for this assign instance */
125     private $coursemodule;
127     /** @var array cache for things like the coursemodule name or the scale menu -
128      *             only lives for a single request.
129      */
130     private $cache;
132     /** @var array list of the installed submission plugins */
133     private $submissionplugins;
135     /** @var array list of the installed feedback plugins */
136     private $feedbackplugins;
138     /** @var string action to be used to return to this page
139      *              (without repeating any form submissions etc).
140      */
141     private $returnaction = 'view';
143     /** @var array params to be used to return to this page */
144     private $returnparams = array();
146     /** @var string modulename prevents excessive calls to get_string */
147     private static $modulename = null;
149     /** @var string modulenameplural prevents excessive calls to get_string */
150     private static $modulenameplural = null;
152     /** @var array of marking workflow states for the current user */
153     private $markingworkflowstates = null;
155     /** @var bool whether to exclude users with inactive enrolment */
156     private $showonlyactiveenrol = null;
158     /** @var string A key used to identify userlists created by this object. */
159     private $useridlistid = null;
161     /** @var array cached list of participants for this assignment. The cache key will be group, showactive and the context id */
162     private $participants = array();
164     /** @var array cached list of user groups when team submissions are enabled. The cache key will be the user. */
165     private $usersubmissiongroups = array();
167     /** @var array cached list of user groups. The cache key will be the user. */
168     private $usergroups = array();
170     /** @var array cached list of IDs of users who share group membership with the user. The cache key will be the user. */
171     private $sharedgroupmembers = array();
173     /**
174      * @var stdClass The most recent team submission. Used to determine additional attempt numbers and whether
175      * to update the gradebook.
176      */
177     private $mostrecentteamsubmission = null;
179     /**
180      * Constructor for the base assign class.
181      *
182      * Note: For $coursemodule you can supply a stdclass if you like, but it
183      * will be more efficient to supply a cm_info object.
184      *
185      * @param mixed $coursemodulecontext context|null the course module context
186      *                                   (or the course context if the coursemodule has not been
187      *                                   created yet).
188      * @param mixed $coursemodule the current course module if it was already loaded,
189      *                            otherwise this class will load one from the context as required.
190      * @param mixed $course the current course  if it was already loaded,
191      *                      otherwise this class will load one from the context as required.
192      */
193     public function __construct($coursemodulecontext, $coursemodule, $course) {
194         global $SESSION;
196         $this->context = $coursemodulecontext;
197         $this->course = $course;
199         // Ensure that $this->coursemodule is a cm_info object (or null).
200         $this->coursemodule = cm_info::create($coursemodule);
202         // Temporary cache only lives for a single request - used to reduce db lookups.
203         $this->cache = array();
205         $this->submissionplugins = $this->load_plugins('assignsubmission');
206         $this->feedbackplugins = $this->load_plugins('assignfeedback');
208         // Extra entropy is required for uniqid() to work on cygwin.
209         $this->useridlistid = clean_param(uniqid('', true), PARAM_ALPHANUM);
211         if (!isset($SESSION->mod_assign_useridlist)) {
212             $SESSION->mod_assign_useridlist = [];
213         }
214     }
216     /**
217      * Set the action and parameters that can be used to return to the current page.
218      *
219      * @param string $action The action for the current page
220      * @param array $params An array of name value pairs which form the parameters
221      *                      to return to the current page.
222      * @return void
223      */
224     public function register_return_link($action, $params) {
225         global $PAGE;
226         $params['action'] = $action;
227         $cm = $this->get_course_module();
228         if ($cm) {
229             $currenturl = new moodle_url('/mod/assign/view.php', array('id' => $cm->id));
230         } else {
231             $currenturl = new moodle_url('/mod/assign/index.php', array('id' => $this->get_course()->id));
232         }
234         $currenturl->params($params);
235         $PAGE->set_url($currenturl);
236     }
238     /**
239      * Return an action that can be used to get back to the current page.
240      *
241      * @return string action
242      */
243     public function get_return_action() {
244         global $PAGE;
246         // Web services don't set a URL, we should avoid debugging when ussing the url object.
247         if (!WS_SERVER) {
248             $params = $PAGE->url->params();
249         }
251         if (!empty($params['action'])) {
252             return $params['action'];
253         }
254         return '';
255     }
257     /**
258      * Based on the current assignment settings should we display the intro.
259      *
260      * @return bool showintro
261      */
262     public function show_intro() {
263         if ($this->get_instance()->alwaysshowdescription ||
264                 time() > $this->get_instance()->allowsubmissionsfromdate) {
265             return true;
266         }
267         return false;
268     }
270     /**
271      * Return a list of parameters that can be used to get back to the current page.
272      *
273      * @return array params
274      */
275     public function get_return_params() {
276         global $PAGE;
278         $params = array();
279         if (!WS_SERVER) {
280             $params = $PAGE->url->params();
281         }
282         unset($params['id']);
283         unset($params['action']);
284         return $params;
285     }
287     /**
288      * Set the submitted form data.
289      *
290      * @param stdClass $data The form data (instance)
291      */
292     public function set_instance(stdClass $data) {
293         $this->instance = $data;
294     }
296     /**
297      * Set the context.
298      *
299      * @param context $context The new context
300      */
301     public function set_context(context $context) {
302         $this->context = $context;
303     }
305     /**
306      * Set the course data.
307      *
308      * @param stdClass $course The course data
309      */
310     public function set_course(stdClass $course) {
311         $this->course = $course;
312     }
314     /**
315      * Get list of feedback plugins installed.
316      *
317      * @return array
318      */
319     public function get_feedback_plugins() {
320         return $this->feedbackplugins;
321     }
323     /**
324      * Get list of submission plugins installed.
325      *
326      * @return array
327      */
328     public function get_submission_plugins() {
329         return $this->submissionplugins;
330     }
332     /**
333      * Is blind marking enabled and reveal identities not set yet?
334      *
335      * @return bool
336      */
337     public function is_blind_marking() {
338         return $this->get_instance()->blindmarking && !$this->get_instance()->revealidentities;
339     }
341     /**
342      * Is hidden grading enabled?
343      *
344      * This just checks the assignment settings. Remember to check
345      * the user has the 'showhiddengrader' capability too
346      *
347      * @return bool
348      */
349     public function is_hidden_grader() {
350         return $this->get_instance()->hidegrader;
351     }
353     /**
354      * Does an assignment have submission(s) or grade(s) already?
355      *
356      * @return bool
357      */
358     public function has_submissions_or_grades() {
359         $allgrades = $this->count_grades();
360         $allsubmissions = $this->count_submissions();
361         if (($allgrades == 0) && ($allsubmissions == 0)) {
362             return false;
363         }
364         return true;
365     }
367     /**
368      * Get a specific submission plugin by its type.
369      *
370      * @param string $subtype assignsubmission | assignfeedback
371      * @param string $type
372      * @return mixed assign_plugin|null
373      */
374     public function get_plugin_by_type($subtype, $type) {
375         $shortsubtype = substr($subtype, strlen('assign'));
376         $name = $shortsubtype . 'plugins';
377         if ($name != 'feedbackplugins' && $name != 'submissionplugins') {
378             return null;
379         }
380         $pluginlist = $this->$name;
381         foreach ($pluginlist as $plugin) {
382             if ($plugin->get_type() == $type) {
383                 return $plugin;
384             }
385         }
386         return null;
387     }
389     /**
390      * Get a feedback plugin by type.
391      *
392      * @param string $type - The type of plugin e.g comments
393      * @return mixed assign_feedback_plugin|null
394      */
395     public function get_feedback_plugin_by_type($type) {
396         return $this->get_plugin_by_type('assignfeedback', $type);
397     }
399     /**
400      * Get a submission plugin by type.
401      *
402      * @param string $type - The type of plugin e.g comments
403      * @return mixed assign_submission_plugin|null
404      */
405     public function get_submission_plugin_by_type($type) {
406         return $this->get_plugin_by_type('assignsubmission', $type);
407     }
409     /**
410      * Load the plugins from the sub folders under subtype.
411      *
412      * @param string $subtype - either submission or feedback
413      * @return array - The sorted list of plugins
414      */
415     public function load_plugins($subtype) {
416         global $CFG;
417         $result = array();
419         $names = core_component::get_plugin_list($subtype);
421         foreach ($names as $name => $path) {
422             if (file_exists($path . '/locallib.php')) {
423                 require_once($path . '/locallib.php');
425                 $shortsubtype = substr($subtype, strlen('assign'));
426                 $pluginclass = 'assign_' . $shortsubtype . '_' . $name;
428                 $plugin = new $pluginclass($this, $name);
430                 if ($plugin instanceof assign_plugin) {
431                     $idx = $plugin->get_sort_order();
432                     while (array_key_exists($idx, $result)) {
433                         $idx +=1;
434                     }
435                     $result[$idx] = $plugin;
436                 }
437             }
438         }
439         ksort($result);
440         return $result;
441     }
443     /**
444      * Display the assignment, used by view.php
445      *
446      * The assignment is displayed differently depending on your role,
447      * the settings for the assignment and the status of the assignment.
448      *
449      * @param string $action The current action if any.
450      * @param array $args Optional arguments to pass to the view (instead of getting them from GET and POST).
451      * @return string - The page output.
452      */
453     public function view($action='', $args = array()) {
454         global $PAGE;
456         $o = '';
457         $mform = null;
458         $notices = array();
459         $nextpageparams = array();
461         if (!empty($this->get_course_module()->id)) {
462             $nextpageparams['id'] = $this->get_course_module()->id;
463         }
465         // Handle form submissions first.
466         if ($action == 'savesubmission') {
467             $action = 'editsubmission';
468             if ($this->process_save_submission($mform, $notices)) {
469                 $action = 'redirect';
470                 $nextpageparams['action'] = 'view';
471             }
472         } else if ($action == 'editprevioussubmission') {
473             $action = 'editsubmission';
474             if ($this->process_copy_previous_attempt($notices)) {
475                 $action = 'redirect';
476                 $nextpageparams['action'] = 'editsubmission';
477             }
478         } else if ($action == 'lock') {
479             $this->process_lock_submission();
480             $action = 'redirect';
481             $nextpageparams['action'] = 'grading';
482         } else if ($action == 'addattempt') {
483             $this->process_add_attempt(required_param('userid', PARAM_INT));
484             $action = 'redirect';
485             $nextpageparams['action'] = 'grading';
486         } else if ($action == 'reverttodraft') {
487             $this->process_revert_to_draft();
488             $action = 'redirect';
489             $nextpageparams['action'] = 'grading';
490         } else if ($action == 'unlock') {
491             $this->process_unlock_submission();
492             $action = 'redirect';
493             $nextpageparams['action'] = 'grading';
494         } else if ($action == 'setbatchmarkingworkflowstate') {
495             $this->process_set_batch_marking_workflow_state();
496             $action = 'redirect';
497             $nextpageparams['action'] = 'grading';
498         } else if ($action == 'setbatchmarkingallocation') {
499             $this->process_set_batch_marking_allocation();
500             $action = 'redirect';
501             $nextpageparams['action'] = 'grading';
502         } else if ($action == 'confirmsubmit') {
503             $action = 'submit';
504             if ($this->process_submit_for_grading($mform, $notices)) {
505                 $action = 'redirect';
506                 $nextpageparams['action'] = 'view';
507             } else if ($notices) {
508                 $action = 'viewsubmitforgradingerror';
509             }
510         } else if ($action == 'submitotherforgrading') {
511             if ($this->process_submit_other_for_grading($mform, $notices)) {
512                 $action = 'redirect';
513                 $nextpageparams['action'] = 'grading';
514             } else {
515                 $action = 'viewsubmitforgradingerror';
516             }
517         } else if ($action == 'gradingbatchoperation') {
518             $action = $this->process_grading_batch_operation($mform);
519             if ($action == 'grading') {
520                 $action = 'redirect';
521                 $nextpageparams['action'] = 'grading';
522             }
523         } else if ($action == 'submitgrade') {
524             if (optional_param('saveandshownext', null, PARAM_RAW)) {
525                 // Save and show next.
526                 $action = 'grade';
527                 if ($this->process_save_grade($mform)) {
528                     $action = 'redirect';
529                     $nextpageparams['action'] = 'grade';
530                     $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
531                     $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
532                 }
533             } else if (optional_param('nosaveandprevious', null, PARAM_RAW)) {
534                 $action = 'redirect';
535                 $nextpageparams['action'] = 'grade';
536                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) - 1;
537                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
538             } else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
539                 $action = 'redirect';
540                 $nextpageparams['action'] = 'grade';
541                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
542                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
543             } else if (optional_param('savegrade', null, PARAM_RAW)) {
544                 // Save changes button.
545                 $action = 'grade';
546                 if ($this->process_save_grade($mform)) {
547                     $action = 'redirect';
548                     $nextpageparams['action'] = 'savegradingresult';
549                 }
550             } else {
551                 // Cancel button.
552                 $action = 'redirect';
553                 $nextpageparams['action'] = 'grading';
554             }
555         } else if ($action == 'quickgrade') {
556             $message = $this->process_save_quick_grades();
557             $action = 'quickgradingresult';
558         } else if ($action == 'saveoptions') {
559             $this->process_save_grading_options();
560             $action = 'redirect';
561             $nextpageparams['action'] = 'grading';
562         } else if ($action == 'saveextension') {
563             $action = 'grantextension';
564             if ($this->process_save_extension($mform)) {
565                 $action = 'redirect';
566                 $nextpageparams['action'] = 'grading';
567             }
568         } else if ($action == 'revealidentitiesconfirm') {
569             $this->process_reveal_identities();
570             $action = 'redirect';
571             $nextpageparams['action'] = 'grading';
572         }
574         $returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT),
575                               'useridlistid' => optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM));
576         $this->register_return_link($action, $returnparams);
578         // Include any page action as part of the body tag CSS id.
579         if (!empty($action)) {
580             $PAGE->set_pagetype('mod-assign-' . $action);
581         }
582         // Now show the right view page.
583         if ($action == 'redirect') {
584             $nextpageurl = new moodle_url('/mod/assign/view.php', $nextpageparams);
585             redirect($nextpageurl);
586             return;
587         } else if ($action == 'savegradingresult') {
588             $message = get_string('gradingchangessaved', 'assign');
589             $o .= $this->view_savegrading_result($message);
590         } else if ($action == 'quickgradingresult') {
591             $mform = null;
592             $o .= $this->view_quickgrading_result($message);
593         } else if ($action == 'gradingpanel') {
594             $o .= $this->view_single_grading_panel($args);
595         } else if ($action == 'grade') {
596             $o .= $this->view_single_grade_page($mform);
597         } else if ($action == 'viewpluginassignfeedback') {
598             $o .= $this->view_plugin_content('assignfeedback');
599         } else if ($action == 'viewpluginassignsubmission') {
600             $o .= $this->view_plugin_content('assignsubmission');
601         } else if ($action == 'editsubmission') {
602             $o .= $this->view_edit_submission_page($mform, $notices);
603         } else if ($action == 'grader') {
604             $o .= $this->view_grader();
605         } else if ($action == 'grading') {
606             $o .= $this->view_grading_page();
607         } else if ($action == 'downloadall') {
608             $o .= $this->download_submissions();
609         } else if ($action == 'submit') {
610             $o .= $this->check_submit_for_grading($mform);
611         } else if ($action == 'grantextension') {
612             $o .= $this->view_grant_extension($mform);
613         } else if ($action == 'revealidentities') {
614             $o .= $this->view_reveal_identities_confirm($mform);
615         } else if ($action == 'plugingradingbatchoperation') {
616             $o .= $this->view_plugin_grading_batch_operation($mform);
617         } else if ($action == 'viewpluginpage') {
618              $o .= $this->view_plugin_page();
619         } else if ($action == 'viewcourseindex') {
620              $o .= $this->view_course_index();
621         } else if ($action == 'viewbatchsetmarkingworkflowstate') {
622              $o .= $this->view_batch_set_workflow_state($mform);
623         } else if ($action == 'viewbatchmarkingallocation') {
624             $o .= $this->view_batch_markingallocation($mform);
625         } else if ($action == 'viewsubmitforgradingerror') {
626             $o .= $this->view_error_page(get_string('submitforgrading', 'assign'), $notices);
627         } else if ($action == 'fixrescalednullgrades') {
628             $o .= $this->view_fix_rescaled_null_grades();
629         } else {
630             $o .= $this->view_submission_page();
631         }
633         return $o;
634     }
636     /**
637      * Add this instance to the database.
638      *
639      * @param stdClass $formdata The data submitted from the form
640      * @param bool $callplugins This is used to skip the plugin code
641      *             when upgrading an old assignment to a new one (the plugins get called manually)
642      * @return mixed false if an error occurs or the int id of the new instance
643      */
644     public function add_instance(stdClass $formdata, $callplugins) {
645         global $DB;
646         $adminconfig = $this->get_admin_config();
648         $err = '';
650         // Add the database record.
651         $update = new stdClass();
652         $update->name = $formdata->name;
653         $update->timemodified = time();
654         $update->timecreated = time();
655         $update->course = $formdata->course;
656         $update->courseid = $formdata->course;
657         $update->intro = $formdata->intro;
658         $update->introformat = $formdata->introformat;
659         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
660         $update->submissiondrafts = $formdata->submissiondrafts;
661         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
662         $update->sendnotifications = $formdata->sendnotifications;
663         $update->sendlatenotifications = $formdata->sendlatenotifications;
664         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
665         if (isset($formdata->sendstudentnotifications)) {
666             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
667         }
668         $update->duedate = $formdata->duedate;
669         $update->cutoffdate = $formdata->cutoffdate;
670         $update->gradingduedate = $formdata->gradingduedate;
671         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
672         $update->grade = $formdata->grade;
673         $update->completionsubmit = !empty($formdata->completionsubmit);
674         $update->teamsubmission = $formdata->teamsubmission;
675         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
676         if (isset($formdata->teamsubmissiongroupingid)) {
677             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
678         }
679         $update->blindmarking = $formdata->blindmarking;
680         if (isset($formdata->hidegrader)) {
681             $update->hidegrader = $formdata->hidegrader;
682         }
683         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
684         if (!empty($formdata->attemptreopenmethod)) {
685             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
686         }
687         if (!empty($formdata->maxattempts)) {
688             $update->maxattempts = $formdata->maxattempts;
689         }
690         if (isset($formdata->preventsubmissionnotingroup)) {
691             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
692         }
693         $update->markingworkflow = $formdata->markingworkflow;
694         $update->markingallocation = $formdata->markingallocation;
695         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
696             $update->markingallocation = 0;
697         }
699         $returnid = $DB->insert_record('assign', $update);
700         $this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
701         // Cache the course record.
702         $this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
704         $this->save_intro_draft_files($formdata);
706         if ($callplugins) {
707             // Call save_settings hook for submission plugins.
708             foreach ($this->submissionplugins as $plugin) {
709                 if (!$this->update_plugin_instance($plugin, $formdata)) {
710                     print_error($plugin->get_error());
711                     return false;
712                 }
713             }
714             foreach ($this->feedbackplugins as $plugin) {
715                 if (!$this->update_plugin_instance($plugin, $formdata)) {
716                     print_error($plugin->get_error());
717                     return false;
718                 }
719             }
721             // In the case of upgrades the coursemodule has not been set,
722             // so we need to wait before calling these two.
723             $this->update_calendar($formdata->coursemodule);
724             if (!empty($formdata->completionexpected)) {
725                 \core_completion\api::update_completion_date_event($formdata->coursemodule, 'assign', $this->instance,
726                         $formdata->completionexpected);
727             }
728             $this->update_gradebook(false, $formdata->coursemodule);
730         }
732         $update = new stdClass();
733         $update->id = $this->get_instance()->id;
734         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
735         $DB->update_record('assign', $update);
737         return $returnid;
738     }
740     /**
741      * Delete all grades from the gradebook for this assignment.
742      *
743      * @return bool
744      */
745     protected function delete_grades() {
746         global $CFG;
748         $result = grade_update('mod/assign',
749                                $this->get_course()->id,
750                                'mod',
751                                'assign',
752                                $this->get_instance()->id,
753                                0,
754                                null,
755                                array('deleted'=>1));
756         return $result == GRADE_UPDATE_OK;
757     }
759     /**
760      * Delete this instance from the database.
761      *
762      * @return bool false if an error occurs
763      */
764     public function delete_instance() {
765         global $DB;
766         $result = true;
768         foreach ($this->submissionplugins as $plugin) {
769             if (!$plugin->delete_instance()) {
770                 print_error($plugin->get_error());
771                 $result = false;
772             }
773         }
774         foreach ($this->feedbackplugins as $plugin) {
775             if (!$plugin->delete_instance()) {
776                 print_error($plugin->get_error());
777                 $result = false;
778             }
779         }
781         // Delete files associated with this assignment.
782         $fs = get_file_storage();
783         if (! $fs->delete_area_files($this->context->id) ) {
784             $result = false;
785         }
787         $this->delete_all_overrides();
789         // Delete_records will throw an exception if it fails - so no need for error checking here.
790         $DB->delete_records('assign_submission', array('assignment' => $this->get_instance()->id));
791         $DB->delete_records('assign_grades', array('assignment' => $this->get_instance()->id));
792         $DB->delete_records('assign_plugin_config', array('assignment' => $this->get_instance()->id));
793         $DB->delete_records('assign_user_flags', array('assignment' => $this->get_instance()->id));
794         $DB->delete_records('assign_user_mapping', array('assignment' => $this->get_instance()->id));
796         // Delete items from the gradebook.
797         if (! $this->delete_grades()) {
798             $result = false;
799         }
801         // Delete the instance.
802         $DB->delete_records('assign', array('id'=>$this->get_instance()->id));
804         return $result;
805     }
807     /**
808      * Deletes a assign override from the database and clears any corresponding calendar events
809      *
810      * @param int $overrideid The id of the override being deleted
811      * @return bool true on success
812      */
813     public function delete_override($overrideid) {
814         global $CFG, $DB;
816         require_once($CFG->dirroot . '/calendar/lib.php');
818         $cm = $this->get_course_module();
819         if (empty($cm)) {
820             $instance = $this->get_instance();
821             $cm = get_coursemodule_from_instance('assign', $instance->id, $instance->course);
822         }
824         $override = $DB->get_record('assign_overrides', array('id' => $overrideid), '*', MUST_EXIST);
826         // Delete the events.
827         $conds = array('modulename' => 'assign', 'instance' => $this->get_instance()->id);
828         if (isset($override->userid)) {
829             $conds['userid'] = $override->userid;
830         } else {
831             $conds['groupid'] = $override->groupid;
832         }
833         $events = $DB->get_records('event', $conds);
834         foreach ($events as $event) {
835             $eventold = calendar_event::load($event);
836             $eventold->delete();
837         }
839         $DB->delete_records('assign_overrides', array('id' => $overrideid));
841         // Set the common parameters for one of the events we will be triggering.
842         $params = array(
843             'objectid' => $override->id,
844             'context' => context_module::instance($cm->id),
845             'other' => array(
846                 'assignid' => $override->assignid
847             )
848         );
849         // Determine which override deleted event to fire.
850         if (!empty($override->userid)) {
851             $params['relateduserid'] = $override->userid;
852             $event = \mod_assign\event\user_override_deleted::create($params);
853         } else {
854             $params['other']['groupid'] = $override->groupid;
855             $event = \mod_assign\event\group_override_deleted::create($params);
856         }
858         // Trigger the override deleted event.
859         $event->add_record_snapshot('assign_overrides', $override);
860         $event->trigger();
862         return true;
863     }
865     /**
866      * Deletes all assign overrides from the database and clears any corresponding calendar events
867      */
868     public function delete_all_overrides() {
869         global $DB;
871         $overrides = $DB->get_records('assign_overrides', array('assignid' => $this->get_instance()->id), 'id');
872         foreach ($overrides as $override) {
873             $this->delete_override($override->id);
874         }
875     }
877     /**
878      * Updates the assign properties with override information for a user.
879      *
880      * Algorithm:  For each assign setting, if there is a matching user-specific override,
881      *   then use that otherwise, if there are group-specific overrides, return the most
882      *   lenient combination of them.  If neither applies, leave the assign setting unchanged.
883      *
884      * @param int $userid The userid.
885      */
886     public function update_effective_access($userid) {
888         $override = $this->override_exists($userid);
890         // Merge with assign defaults.
891         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
892         foreach ($keys as $key) {
893             if (isset($override->{$key})) {
894                 $this->get_instance()->{$key} = $override->{$key};
895             }
896         }
898     }
900     /**
901      * Returns whether an assign has any overrides.
902      *
903      * @return true if any, false if not
904      */
905     public function has_overrides() {
906         global $DB;
908         $override = $DB->record_exists('assign_overrides', array('assignid' => $this->get_instance()->id));
910         if ($override) {
911             return true;
912         }
914         return false;
915     }
917     /**
918      * Returns user override
919      *
920      * Algorithm:  For each assign setting, if there is a matching user-specific override,
921      *   then use that otherwise, if there are group-specific overrides, use the one with the
922      *   lowest sort order. If neither applies, leave the assign setting unchanged.
923      *
924      * @param int $userid The userid.
925      * @return stdClass The override
926      */
927     public function override_exists($userid) {
928         global $DB;
930         // Gets an assoc array containing the keys for defined user overrides only.
931         $getuseroverride = function($userid) use ($DB) {
932             $useroverride = $DB->get_record('assign_overrides', ['assignid' => $this->get_instance()->id, 'userid' => $userid]);
933             return $useroverride ? get_object_vars($useroverride) : [];
934         };
936         // Gets an assoc array containing the keys for defined group overrides only.
937         $getgroupoverride = function($userid) use ($DB) {
938             $groupings = groups_get_user_groups($this->get_instance()->course, $userid);
940             if (empty($groupings[0])) {
941                 return [];
942             }
944             // Select all overrides that apply to the User's groups.
945             list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
946             $sql = "SELECT * FROM {assign_overrides}
947                     WHERE groupid $extra AND assignid = ? ORDER BY sortorder ASC";
948             $params[] = $this->get_instance()->id;
949             $groupoverride = $DB->get_record_sql($sql, $params, IGNORE_MULTIPLE);
951             return $groupoverride ? get_object_vars($groupoverride) : [];
952         };
954         // Later arguments clobber earlier ones with array_merge. The two helper functions
955         // return arrays containing keys for only the defined overrides. So we get the
956         // desired behaviour as per the algorithm.
957         return (object)array_merge(
958             ['duedate' => null, 'cutoffdate' => null, 'allowsubmissionsfromdate' => null],
959             $getgroupoverride($userid),
960             $getuseroverride($userid)
961         );
962     }
964     /**
965      * Check if the given calendar_event is either a user or group override
966      * event.
967      *
968      * @return bool
969      */
970     public function is_override_calendar_event(\calendar_event $event) {
971         global $DB;
973         if (!isset($event->modulename)) {
974             return false;
975         }
977         if ($event->modulename != 'assign') {
978             return false;
979         }
981         if (!isset($event->instance)) {
982             return false;
983         }
985         if (!isset($event->userid) && !isset($event->groupid)) {
986             return false;
987         }
989         $overrideparams = [
990             'assignid' => $event->instance
991         ];
993         if (isset($event->groupid)) {
994             $overrideparams['groupid'] = $event->groupid;
995         } else if (isset($event->userid)) {
996             $overrideparams['userid'] = $event->userid;
997         }
999         if ($DB->get_record('assign_overrides', $overrideparams)) {
1000             return true;
1001         } else {
1002             return false;
1003         }
1004     }
1006     /**
1007      * This function calculates the minimum and maximum cutoff values for the timestart of
1008      * the given event.
1009      *
1010      * It will return an array with two values, the first being the minimum cutoff value and
1011      * the second being the maximum cutoff value. Either or both values can be null, which
1012      * indicates there is no minimum or maximum, respectively.
1013      *
1014      * If a cutoff is required then the function must return an array containing the cutoff
1015      * timestamp and error string to display to the user if the cutoff value is violated.
1016      *
1017      * A minimum and maximum cutoff return value will look like:
1018      * [
1019      *     [1505704373, 'The due date must be after the sbumission start date'],
1020      *     [1506741172, 'The due date must be before the cutoff date']
1021      * ]
1022      *
1023      * If the event does not have a valid timestart range then [false, false] will
1024      * be returned.
1025      *
1026      * @param calendar_event $event The calendar event to get the time range for
1027      * @return array
1028      */
1029     function get_valid_calendar_event_timestart_range(\calendar_event $event) {
1030         $instance = $this->get_instance();
1031         $submissionsfromdate = $instance->allowsubmissionsfromdate;
1032         $cutoffdate = $instance->cutoffdate;
1033         $duedate = $instance->duedate;
1034         $gradingduedate = $instance->gradingduedate;
1035         $mindate = null;
1036         $maxdate = null;
1038         if ($event->eventtype == ASSIGN_EVENT_TYPE_DUE) {
1039             // This check is in here because due date events are currently
1040             // the only events that can be overridden, so we can save a DB
1041             // query if we don't bother checking other events.
1042             if ($this->is_override_calendar_event($event)) {
1043                 // This is an override event so there is no valid timestart
1044                 // range to set it to.
1045                 return [false, false];
1046             }
1048             if ($submissionsfromdate) {
1049                 $mindate = [
1050                     $submissionsfromdate,
1051                     get_string('duedatevalidation', 'assign'),
1052                 ];
1053             }
1055             if ($cutoffdate) {
1056                 $maxdate = [
1057                     $cutoffdate,
1058                     get_string('cutoffdatevalidation', 'assign'),
1059                 ];
1060             }
1062             if ($gradingduedate) {
1063                 // If we don't have a cutoff date or we've got a grading due date
1064                 // that is earlier than the cutoff then we should use that as the
1065                 // upper limit for the due date.
1066                 if (!$cutoffdate || $gradingduedate < $cutoffdate) {
1067                     $maxdate = [
1068                         $gradingduedate,
1069                         get_string('gradingdueduedatevalidation', 'assign'),
1070                     ];
1071                 }
1072             }
1073         } else if ($event->eventtype == ASSIGN_EVENT_TYPE_GRADINGDUE) {
1074             if ($duedate) {
1075                 $mindate = [
1076                     $duedate,
1077                     get_string('gradingdueduedatevalidation', 'assign'),
1078                 ];
1079             } else if ($submissionsfromdate) {
1080                 $mindate = [
1081                     $submissionsfromdate,
1082                     get_string('gradingduefromdatevalidation', 'assign'),
1083                 ];
1084             }
1085         }
1087         return [$mindate, $maxdate];
1088     }
1090     /**
1091      * Actual implementation of the reset course functionality, delete all the
1092      * assignment submissions for course $data->courseid.
1093      *
1094      * @param stdClass $data the data submitted from the reset course.
1095      * @return array status array
1096      */
1097     public function reset_userdata($data) {
1098         global $CFG, $DB;
1100         $componentstr = get_string('modulenameplural', 'assign');
1101         $status = array();
1103         $fs = get_file_storage();
1104         if (!empty($data->reset_assign_submissions)) {
1105             // Delete files associated with this assignment.
1106             foreach ($this->submissionplugins as $plugin) {
1107                 $fileareas = array();
1108                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
1109                 $fileareas = $plugin->get_file_areas();
1110                 foreach ($fileareas as $filearea => $notused) {
1111                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
1112                 }
1114                 if (!$plugin->delete_instance()) {
1115                     $status[] = array('component'=>$componentstr,
1116                                       'item'=>get_string('deleteallsubmissions', 'assign'),
1117                                       'error'=>$plugin->get_error());
1118                 }
1119             }
1121             foreach ($this->feedbackplugins as $plugin) {
1122                 $fileareas = array();
1123                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
1124                 $fileareas = $plugin->get_file_areas();
1125                 foreach ($fileareas as $filearea => $notused) {
1126                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
1127                 }
1129                 if (!$plugin->delete_instance()) {
1130                     $status[] = array('component'=>$componentstr,
1131                                       'item'=>get_string('deleteallsubmissions', 'assign'),
1132                                       'error'=>$plugin->get_error());
1133                 }
1134             }
1136             $assignids = $DB->get_records('assign', array('course' => $data->courseid), '', 'id');
1137             list($sql, $params) = $DB->get_in_or_equal(array_keys($assignids));
1139             $DB->delete_records_select('assign_submission', "assignment $sql", $params);
1140             $DB->delete_records_select('assign_user_flags', "assignment $sql", $params);
1142             $status[] = array('component'=>$componentstr,
1143                               'item'=>get_string('deleteallsubmissions', 'assign'),
1144                               'error'=>false);
1146             if (!empty($data->reset_gradebook_grades)) {
1147                 $DB->delete_records_select('assign_grades', "assignment $sql", $params);
1148                 // Remove all grades from gradebook.
1149                 require_once($CFG->dirroot.'/mod/assign/lib.php');
1150                 assign_reset_gradebook($data->courseid);
1151             }
1153             // Reset revealidentities for assign if blindmarking is enabled.
1154             if ($this->get_instance()->blindmarking) {
1155                 $DB->set_field('assign', 'revealidentities', 0, array('id' => $this->get_instance()->id));
1156             }
1157         }
1159         // Remove user overrides.
1160         if (!empty($data->reset_assign_user_overrides)) {
1161             $DB->delete_records_select('assign_overrides',
1162                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
1163             $status[] = array(
1164                 'component' => $componentstr,
1165                 'item' => get_string('useroverridesdeleted', 'assign'),
1166                 'error' => false);
1167         }
1168         // Remove group overrides.
1169         if (!empty($data->reset_assign_group_overrides)) {
1170             $DB->delete_records_select('assign_overrides',
1171                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
1172             $status[] = array(
1173                 'component' => $componentstr,
1174                 'item' => get_string('groupoverridesdeleted', 'assign'),
1175                 'error' => false);
1176         }
1178         // Updating dates - shift may be negative too.
1179         if ($data->timeshift) {
1180             $DB->execute("UPDATE {assign_overrides}
1181                          SET allowsubmissionsfromdate = allowsubmissionsfromdate + ?
1182                        WHERE assignid = ? AND allowsubmissionsfromdate <> 0",
1183                 array($data->timeshift, $this->get_instance()->id));
1184             $DB->execute("UPDATE {assign_overrides}
1185                          SET duedate = duedate + ?
1186                        WHERE assignid = ? AND duedate <> 0",
1187                 array($data->timeshift, $this->get_instance()->id));
1188             $DB->execute("UPDATE {assign_overrides}
1189                          SET cutoffdate = cutoffdate + ?
1190                        WHERE assignid =? AND cutoffdate <> 0",
1191                 array($data->timeshift, $this->get_instance()->id));
1193             // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
1194             // See MDL-9367.
1195             shift_course_mod_dates('assign',
1196                                     array('duedate', 'allowsubmissionsfromdate', 'cutoffdate'),
1197                                     $data->timeshift,
1198                                     $data->courseid, $this->get_instance()->id);
1199             $status[] = array('component'=>$componentstr,
1200                               'item'=>get_string('datechanged'),
1201                               'error'=>false);
1202         }
1204         return $status;
1205     }
1207     /**
1208      * Update the settings for a single plugin.
1209      *
1210      * @param assign_plugin $plugin The plugin to update
1211      * @param stdClass $formdata The form data
1212      * @return bool false if an error occurs
1213      */
1214     protected function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
1215         if ($plugin->is_visible()) {
1216             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1217             if (!empty($formdata->$enabledname)) {
1218                 $plugin->enable();
1219                 if (!$plugin->save_settings($formdata)) {
1220                     print_error($plugin->get_error());
1221                     return false;
1222                 }
1223             } else {
1224                 $plugin->disable();
1225             }
1226         }
1227         return true;
1228     }
1230     /**
1231      * Update the gradebook information for this assignment.
1232      *
1233      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
1234      * @param int $coursemoduleid This is required because it might not exist in the database yet
1235      * @return bool
1236      */
1237     public function update_gradebook($reset, $coursemoduleid) {
1238         global $CFG;
1240         require_once($CFG->dirroot.'/mod/assign/lib.php');
1241         $assign = clone $this->get_instance();
1242         $assign->cmidnumber = $coursemoduleid;
1244         // Set assign gradebook feedback plugin status (enabled and visible).
1245         $assign->gradefeedbackenabled = $this->is_gradebook_feedback_enabled();
1247         $param = null;
1248         if ($reset) {
1249             $param = 'reset';
1250         }
1252         return assign_grade_item_update($assign, $param);
1253     }
1255     /**
1256      * Get the marking table page size
1257      *
1258      * @return integer
1259      */
1260     public function get_assign_perpage() {
1261         $perpage = (int) get_user_preferences('assign_perpage', 10);
1262         $adminconfig = $this->get_admin_config();
1263         $maxperpage = -1;
1264         if (isset($adminconfig->maxperpage)) {
1265             $maxperpage = $adminconfig->maxperpage;
1266         }
1267         if (isset($maxperpage) &&
1268             $maxperpage != -1 &&
1269             ($perpage == -1 || $perpage > $maxperpage)) {
1270             $perpage = $maxperpage;
1271         }
1272         return $perpage;
1273     }
1275     /**
1276      * Load and cache the admin config for this module.
1277      *
1278      * @return stdClass the plugin config
1279      */
1280     public function get_admin_config() {
1281         if ($this->adminconfig) {
1282             return $this->adminconfig;
1283         }
1284         $this->adminconfig = get_config('assign');
1285         return $this->adminconfig;
1286     }
1288     /**
1289      * Update the calendar entries for this assignment.
1290      *
1291      * @param int $coursemoduleid - Required to pass this in because it might
1292      *                              not exist in the database yet.
1293      * @return bool
1294      */
1295     public function update_calendar($coursemoduleid) {
1296         global $DB, $CFG;
1297         require_once($CFG->dirroot.'/calendar/lib.php');
1299         // Special case for add_instance as the coursemodule has not been set yet.
1300         $instance = $this->get_instance();
1302         // Start with creating the event.
1303         $event = new stdClass();
1304         $event->modulename  = 'assign';
1305         $event->courseid = $instance->course;
1306         $event->groupid = 0;
1307         $event->userid  = 0;
1308         $event->instance  = $instance->id;
1309         $event->type = CALENDAR_EVENT_TYPE_ACTION;
1311         // Convert the links to pluginfile. It is a bit hacky but at this stage the files
1312         // might not have been saved in the module area yet.
1313         $intro = $instance->intro;
1314         if ($draftid = file_get_submitted_draft_itemid('introeditor')) {
1315             $intro = file_rewrite_urls_to_pluginfile($intro, $draftid);
1316         }
1318         // We need to remove the links to files as the calendar is not ready
1319         // to support module events with file areas.
1320         $intro = strip_pluginfile_content($intro);
1321         if ($this->show_intro()) {
1322             $event->description = array(
1323                 'text' => $intro,
1324                 'format' => $instance->introformat
1325             );
1326         } else {
1327             $event->description = array(
1328                 'text' => '',
1329                 'format' => $instance->introformat
1330             );
1331         }
1333         $eventtype = ASSIGN_EVENT_TYPE_DUE;
1334         if ($instance->duedate) {
1335             $event->name = get_string('calendardue', 'assign', $instance->name);
1336             $event->eventtype = $eventtype;
1337             $event->timestart = $instance->duedate;
1338             $event->timesort = $instance->duedate;
1339             $select = "modulename = :modulename
1340                        AND instance = :instance
1341                        AND eventtype = :eventtype
1342                        AND groupid = 0
1343                        AND courseid <> 0";
1344             $params = array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype);
1345             $event->id = $DB->get_field_select('event', 'id', $select, $params);
1347             // Now process the event.
1348             if ($event->id) {
1349                 $calendarevent = calendar_event::load($event->id);
1350                 $calendarevent->update($event, false);
1351             } else {
1352                 calendar_event::create($event, false);
1353             }
1354         } else {
1355             $DB->delete_records('event', array('modulename' => 'assign', 'instance' => $instance->id,
1356                 'eventtype' => $eventtype));
1357         }
1359         $eventtype = ASSIGN_EVENT_TYPE_GRADINGDUE;
1360         if ($instance->gradingduedate) {
1361             $event->name = get_string('calendargradingdue', 'assign', $instance->name);
1362             $event->eventtype = $eventtype;
1363             $event->timestart = $instance->gradingduedate;
1364             $event->timesort = $instance->gradingduedate;
1365             $event->id = $DB->get_field('event', 'id', array('modulename' => 'assign',
1366                 'instance' => $instance->id, 'eventtype' => $event->eventtype));
1368             // Now process the event.
1369             if ($event->id) {
1370                 $calendarevent = calendar_event::load($event->id);
1371                 $calendarevent->update($event, false);
1372             } else {
1373                 calendar_event::create($event, false);
1374             }
1375         } else {
1376             $DB->delete_records('event', array('modulename' => 'assign', 'instance' => $instance->id,
1377                 'eventtype' => $eventtype));
1378         }
1380         return true;
1381     }
1383     /**
1384      * Update this instance in the database.
1385      *
1386      * @param stdClass $formdata - the data submitted from the form
1387      * @return bool false if an error occurs
1388      */
1389     public function update_instance($formdata) {
1390         global $DB;
1391         $adminconfig = $this->get_admin_config();
1393         $update = new stdClass();
1394         $update->id = $formdata->instance;
1395         $update->name = $formdata->name;
1396         $update->timemodified = time();
1397         $update->course = $formdata->course;
1398         $update->intro = $formdata->intro;
1399         $update->introformat = $formdata->introformat;
1400         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
1401         $update->submissiondrafts = $formdata->submissiondrafts;
1402         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
1403         $update->sendnotifications = $formdata->sendnotifications;
1404         $update->sendlatenotifications = $formdata->sendlatenotifications;
1405         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
1406         if (isset($formdata->sendstudentnotifications)) {
1407             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
1408         }
1409         $update->duedate = $formdata->duedate;
1410         $update->cutoffdate = $formdata->cutoffdate;
1411         $update->gradingduedate = $formdata->gradingduedate;
1412         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
1413         $update->grade = $formdata->grade;
1414         if (!empty($formdata->completionunlocked)) {
1415             $update->completionsubmit = !empty($formdata->completionsubmit);
1416         }
1417         $update->teamsubmission = $formdata->teamsubmission;
1418         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
1419         if (isset($formdata->teamsubmissiongroupingid)) {
1420             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
1421         }
1422         if (isset($formdata->hidegrader)) {
1423             $update->hidegrader = $formdata->hidegrader;
1424         }
1425         $update->blindmarking = $formdata->blindmarking;
1426         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
1427         if (!empty($formdata->attemptreopenmethod)) {
1428             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
1429         }
1430         if (!empty($formdata->maxattempts)) {
1431             $update->maxattempts = $formdata->maxattempts;
1432         }
1433         if (isset($formdata->preventsubmissionnotingroup)) {
1434             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
1435         }
1436         $update->markingworkflow = $formdata->markingworkflow;
1437         $update->markingallocation = $formdata->markingallocation;
1438         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
1439             $update->markingallocation = 0;
1440         }
1442         $result = $DB->update_record('assign', $update);
1443         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
1445         $this->save_intro_draft_files($formdata);
1447         // Load the assignment so the plugins have access to it.
1449         // Call save_settings hook for submission plugins.
1450         foreach ($this->submissionplugins as $plugin) {
1451             if (!$this->update_plugin_instance($plugin, $formdata)) {
1452                 print_error($plugin->get_error());
1453                 return false;
1454             }
1455         }
1456         foreach ($this->feedbackplugins as $plugin) {
1457             if (!$this->update_plugin_instance($plugin, $formdata)) {
1458                 print_error($plugin->get_error());
1459                 return false;
1460             }
1461         }
1463         $this->update_calendar($this->get_course_module()->id);
1464         $completionexpected = (!empty($formdata->completionexpected)) ? $formdata->completionexpected : null;
1465         \core_completion\api::update_completion_date_event($this->get_course_module()->id, 'assign', $this->instance,
1466                 $completionexpected);
1467         $this->update_gradebook(false, $this->get_course_module()->id);
1469         $update = new stdClass();
1470         $update->id = $this->get_instance()->id;
1471         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
1472         $DB->update_record('assign', $update);
1474         return $result;
1475     }
1477     /**
1478      * Save the attachments in the draft areas.
1479      *
1480      * @param stdClass $formdata
1481      */
1482     protected function save_intro_draft_files($formdata) {
1483         if (isset($formdata->introattachments)) {
1484             file_save_draft_area_files($formdata->introattachments, $this->get_context()->id,
1485                                        'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA, 0);
1486         }
1487     }
1489     /**
1490      * Add elements in grading plugin form.
1491      *
1492      * @param mixed $grade stdClass|null
1493      * @param MoodleQuickForm $mform
1494      * @param stdClass $data
1495      * @param int $userid - The userid we are grading
1496      * @return void
1497      */
1498     protected function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
1499         foreach ($this->feedbackplugins as $plugin) {
1500             if ($plugin->is_enabled() && $plugin->is_visible()) {
1501                 $plugin->get_form_elements_for_user($grade, $mform, $data, $userid);
1502             }
1503         }
1504     }
1508     /**
1509      * Add one plugins settings to edit plugin form.
1510      *
1511      * @param assign_plugin $plugin The plugin to add the settings from
1512      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1513      *                               This form is modified directly (not returned).
1514      * @param array $pluginsenabled A list of form elements to be added to a group.
1515      *                              The new element is added to this array by this function.
1516      * @return void
1517      */
1518     protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) {
1519         global $CFG;
1520         if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) {
1521             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1522             $pluginsenabled[] = $mform->createElement('hidden', $name, 1);
1523             $mform->setType($name, PARAM_BOOL);
1524             $plugin->get_settings($mform);
1525         } else if ($plugin->is_visible() && $plugin->is_configurable()) {
1526             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1527             $label = $plugin->get_name();
1528             $pluginsenabled[] = $mform->createElement('checkbox', $name, '', $label);
1529             $helpicon = $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
1530             $pluginsenabled[] = $mform->createElement('static', '', '', $helpicon);
1532             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
1533             if ($plugin->get_config('enabled') !== false) {
1534                 $default = $plugin->is_enabled();
1535             }
1536             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
1538             $plugin->get_settings($mform);
1540         }
1541     }
1543     /**
1544      * Add settings to edit plugin form.
1545      *
1546      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1547      *                               This form is modified directly (not returned).
1548      * @return void
1549      */
1550     public function add_all_plugin_settings(MoodleQuickForm $mform) {
1551         $mform->addElement('header', 'submissiontypes', get_string('submissiontypes', 'assign'));
1553         $submissionpluginsenabled = array();
1554         $group = $mform->addGroup(array(), 'submissionplugins', get_string('submissiontypes', 'assign'), array(' '), false);
1555         foreach ($this->submissionplugins as $plugin) {
1556             $this->add_plugin_settings($plugin, $mform, $submissionpluginsenabled);
1557         }
1558         $group->setElements($submissionpluginsenabled);
1560         $mform->addElement('header', 'feedbacktypes', get_string('feedbacktypes', 'assign'));
1561         $feedbackpluginsenabled = array();
1562         $group = $mform->addGroup(array(), 'feedbackplugins', get_string('feedbacktypes', 'assign'), array(' '), false);
1563         foreach ($this->feedbackplugins as $plugin) {
1564             $this->add_plugin_settings($plugin, $mform, $feedbackpluginsenabled);
1565         }
1566         $group->setElements($feedbackpluginsenabled);
1567         $mform->setExpanded('submissiontypes');
1568     }
1570     /**
1571      * Allow each plugin an opportunity to update the defaultvalues
1572      * passed in to the settings form (needed to set up draft areas for
1573      * editor and filemanager elements)
1574      *
1575      * @param array $defaultvalues
1576      */
1577     public function plugin_data_preprocessing(&$defaultvalues) {
1578         foreach ($this->submissionplugins as $plugin) {
1579             if ($plugin->is_visible()) {
1580                 $plugin->data_preprocessing($defaultvalues);
1581             }
1582         }
1583         foreach ($this->feedbackplugins as $plugin) {
1584             if ($plugin->is_visible()) {
1585                 $plugin->data_preprocessing($defaultvalues);
1586             }
1587         }
1588     }
1590     /**
1591      * Get the name of the current module.
1592      *
1593      * @return string the module name (Assignment)
1594      */
1595     protected function get_module_name() {
1596         if (isset(self::$modulename)) {
1597             return self::$modulename;
1598         }
1599         self::$modulename = get_string('modulename', 'assign');
1600         return self::$modulename;
1601     }
1603     /**
1604      * Get the plural name of the current module.
1605      *
1606      * @return string the module name plural (Assignments)
1607      */
1608     protected function get_module_name_plural() {
1609         if (isset(self::$modulenameplural)) {
1610             return self::$modulenameplural;
1611         }
1612         self::$modulenameplural = get_string('modulenameplural', 'assign');
1613         return self::$modulenameplural;
1614     }
1616     /**
1617      * Has this assignment been constructed from an instance?
1618      *
1619      * @return bool
1620      */
1621     public function has_instance() {
1622         return $this->instance || $this->get_course_module();
1623     }
1625     /**
1626      * Get the settings for the current instance of this assignment
1627      *
1628      * @return stdClass The settings
1629      */
1630     public function get_instance() {
1631         global $DB;
1632         if ($this->instance) {
1633             return $this->instance;
1634         }
1635         if ($this->get_course_module()) {
1636             $params = array('id' => $this->get_course_module()->instance);
1637             $this->instance = $DB->get_record('assign', $params, '*', MUST_EXIST);
1638         }
1639         if (!$this->instance) {
1640             throw new coding_exception('Improper use of the assignment class. ' .
1641                                        'Cannot load the assignment record.');
1642         }
1643         return $this->instance;
1644     }
1646     /**
1647      * Get the primary grade item for this assign instance.
1648      *
1649      * @return grade_item The grade_item record
1650      */
1651     public function get_grade_item() {
1652         if ($this->gradeitem) {
1653             return $this->gradeitem;
1654         }
1655         $instance = $this->get_instance();
1656         $params = array('itemtype' => 'mod',
1657                         'itemmodule' => 'assign',
1658                         'iteminstance' => $instance->id,
1659                         'courseid' => $instance->course,
1660                         'itemnumber' => 0);
1661         $this->gradeitem = grade_item::fetch($params);
1662         if (!$this->gradeitem) {
1663             throw new coding_exception('Improper use of the assignment class. ' .
1664                                        'Cannot load the grade item.');
1665         }
1666         return $this->gradeitem;
1667     }
1669     /**
1670      * Get the context of the current course.
1671      *
1672      * @return mixed context|null The course context
1673      */
1674     public function get_course_context() {
1675         if (!$this->context && !$this->course) {
1676             throw new coding_exception('Improper use of the assignment class. ' .
1677                                        'Cannot load the course context.');
1678         }
1679         if ($this->context) {
1680             return $this->context->get_course_context();
1681         } else {
1682             return context_course::instance($this->course->id);
1683         }
1684     }
1687     /**
1688      * Get the current course module.
1689      *
1690      * @return cm_info|null The course module or null if not known
1691      */
1692     public function get_course_module() {
1693         if ($this->coursemodule) {
1694             return $this->coursemodule;
1695         }
1696         if (!$this->context) {
1697             return null;
1698         }
1700         if ($this->context->contextlevel == CONTEXT_MODULE) {
1701             $modinfo = get_fast_modinfo($this->get_course());
1702             $this->coursemodule = $modinfo->get_cm($this->context->instanceid);
1703             return $this->coursemodule;
1704         }
1705         return null;
1706     }
1708     /**
1709      * Get context module.
1710      *
1711      * @return context
1712      */
1713     public function get_context() {
1714         return $this->context;
1715     }
1717     /**
1718      * Get the current course.
1719      *
1720      * @return mixed stdClass|null The course
1721      */
1722     public function get_course() {
1723         global $DB;
1725         if ($this->course) {
1726             return $this->course;
1727         }
1729         if (!$this->context) {
1730             return null;
1731         }
1732         $params = array('id' => $this->get_course_context()->instanceid);
1733         $this->course = $DB->get_record('course', $params, '*', MUST_EXIST);
1735         return $this->course;
1736     }
1738     /**
1739      * Count the number of intro attachments.
1740      *
1741      * @return int
1742      */
1743     protected function count_attachments() {
1745         $fs = get_file_storage();
1746         $files = $fs->get_area_files($this->get_context()->id, 'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA,
1747                         0, 'id', false);
1749         return count($files);
1750     }
1752     /**
1753      * Are there any intro attachments to display?
1754      *
1755      * @return boolean
1756      */
1757     protected function has_visible_attachments() {
1758         return ($this->count_attachments() > 0);
1759     }
1761     /**
1762      * Return a grade in user-friendly form, whether it's a scale or not.
1763      *
1764      * @param mixed $grade int|null
1765      * @param boolean $editing Are we allowing changes to this grade?
1766      * @param int $userid The user id the grade belongs to
1767      * @param int $modified Timestamp from when the grade was last modified
1768      * @return string User-friendly representation of grade
1769      */
1770     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1771         global $DB;
1773         static $scalegrades = array();
1775         $o = '';
1777         if ($this->get_instance()->grade >= 0) {
1778             // Normal number.
1779             if ($editing && $this->get_instance()->grade > 0) {
1780                 if ($grade < 0) {
1781                     $displaygrade = '';
1782                 } else {
1783                     $displaygrade = format_float($grade, $this->get_grade_item()->get_decimals());
1784                 }
1785                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' .
1786                        get_string('usergrade', 'assign') .
1787                        '</label>';
1788                 $o .= '<input type="text"
1789                               id="quickgrade_' . $userid . '"
1790                               name="quickgrade_' . $userid . '"
1791                               value="' .  $displaygrade . '"
1792                               size="6"
1793                               maxlength="10"
1794                               class="quickgrade"/>';
1795                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $this->get_grade_item()->get_decimals());
1796                 return $o;
1797             } else {
1798                 if ($grade == -1 || $grade === null) {
1799                     $o .= '-';
1800                 } else {
1801                     $item = $this->get_grade_item();
1802                     $o .= grade_format_gradevalue($grade, $item);
1803                     if ($item->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) {
1804                         // If displaying the raw grade, also display the total value.
1805                         $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $item->get_decimals());
1806                     }
1807                 }
1808                 return $o;
1809             }
1811         } else {
1812             // Scale.
1813             if (empty($this->cache['scale'])) {
1814                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1815                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1816                 } else {
1817                     $o .= '-';
1818                     return $o;
1819                 }
1820             }
1821             if ($editing) {
1822                 $o .= '<label class="accesshide"
1823                               for="quickgrade_' . $userid . '">' .
1824                       get_string('usergrade', 'assign') .
1825                       '</label>';
1826                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1827                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1828                 foreach ($this->cache['scale'] as $optionid => $option) {
1829                     $selected = '';
1830                     if ($grade == $optionid) {
1831                         $selected = 'selected="selected"';
1832                     }
1833                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1834                 }
1835                 $o .= '</select>';
1836                 return $o;
1837             } else {
1838                 $scaleid = (int)$grade;
1839                 if (isset($this->cache['scale'][$scaleid])) {
1840                     $o .= $this->cache['scale'][$scaleid];
1841                     return $o;
1842                 }
1843                 $o .= '-';
1844                 return $o;
1845             }
1846         }
1847     }
1849     /**
1850      * Get the submission status/grading status for all submissions in this assignment for the
1851      * given paticipants.
1852      *
1853      * These statuses match the available filters (requiregrading, submitted, notsubmitted, grantedextension).
1854      * If this is a group assignment, group info is also returned.
1855      *
1856      * @param array $participants an associative array where the key is the participant id and
1857      *                            the value is the participant record.
1858      * @return array an associative array where the key is the participant id and the value is
1859      *               the participant record.
1860      */
1861     private function get_submission_info_for_participants($participants) {
1862         global $DB;
1864         if (empty($participants)) {
1865             return $participants;
1866         }
1868         list($insql, $params) = $DB->get_in_or_equal(array_keys($participants), SQL_PARAMS_NAMED);
1870         $assignid = $this->get_instance()->id;
1871         $params['assignmentid1'] = $assignid;
1872         $params['assignmentid2'] = $assignid;
1873         $params['assignmentid3'] = $assignid;
1875         $fields = 'SELECT u.id, s.status, s.timemodified AS stime, g.timemodified AS gtime, g.grade, uf.extensionduedate';
1876         $from = ' FROM {user} u
1877                          LEFT JOIN {assign_submission} s
1878                                 ON u.id = s.userid
1879                                AND s.assignment = :assignmentid1
1880                                AND s.latest = 1
1881                          LEFT JOIN {assign_grades} g
1882                                 ON u.id = g.userid
1883                                AND g.assignment = :assignmentid2
1884                                AND g.attemptnumber = s.attemptnumber
1885                          LEFT JOIN {assign_user_flags} uf
1886                                 ON u.id = uf.userid
1887                                AND uf.assignment = :assignmentid3
1888             ';
1889         $where = ' WHERE u.id ' . $insql;
1891         if (!empty($this->get_instance()->blindmarking)) {
1892             $from .= 'LEFT JOIN {assign_user_mapping} um
1893                              ON u.id = um.userid
1894                             AND um.assignment = :assignmentid4 ';
1895             $params['assignmentid4'] = $assignid;
1896             $fields .= ', um.id as recordid ';
1897         }
1899         $sql = "$fields $from $where";
1901         $records = $DB->get_records_sql($sql, $params);
1903         if ($this->get_instance()->teamsubmission) {
1904             // Get all groups.
1905             $allgroups = groups_get_all_groups($this->get_course()->id,
1906                                                array_keys($participants),
1907                                                $this->get_instance()->teamsubmissiongroupingid,
1908                                                'DISTINCT g.id, g.name');
1910         }
1911         foreach ($participants as $userid => $participant) {
1912             $participants[$userid]->fullname = $this->fullname($participant);
1913             $participants[$userid]->submitted = false;
1914             $participants[$userid]->requiregrading = false;
1915             $participants[$userid]->grantedextension = false;
1916         }
1918         foreach ($records as $userid => $submissioninfo) {
1919             // These filters are 100% the same as the ones in the grading table SQL.
1920             $submitted = false;
1921             $requiregrading = false;
1922             $grantedextension = false;
1924             if (!empty($submissioninfo->stime) && $submissioninfo->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
1925                 $submitted = true;
1926             }
1928             if ($submitted && ($submissioninfo->stime >= $submissioninfo->gtime ||
1929                     empty($submissioninfo->gtime) ||
1930                     $submissioninfo->grade === null)) {
1931                 $requiregrading = true;
1932             }
1934             if (!empty($submissioninfo->extensionduedate)) {
1935                 $grantedextension = true;
1936             }
1938             $participants[$userid]->submitted = $submitted;
1939             $participants[$userid]->requiregrading = $requiregrading;
1940             $participants[$userid]->grantedextension = $grantedextension;
1941             if ($this->get_instance()->teamsubmission) {
1942                 $group = $this->get_submission_group($userid);
1943                 if ($group) {
1944                     $participants[$userid]->groupid = $group->id;
1945                     $participants[$userid]->groupname = $group->name;
1946                 }
1947             }
1948         }
1949         return $participants;
1950     }
1952     /**
1953      * Get the submission status/grading status for all submissions in this assignment.
1954      * These statuses match the available filters (requiregrading, submitted, notsubmitted, grantedextension).
1955      * If this is a group assignment, group info is also returned.
1956      *
1957      * @param int $currentgroup
1958      * @param boolean $tablesort Apply current user table sorting preferences.
1959      * @return array List of user records with extra fields 'submitted', 'notsubmitted', 'requiregrading', 'grantedextension',
1960      *               'groupid', 'groupname'
1961      */
1962     public function list_participants_with_filter_status_and_group($currentgroup, $tablesort = false) {
1963         $participants = $this->list_participants($currentgroup, false, $tablesort);
1965         if (empty($participants)) {
1966             return $participants;
1967         } else {
1968             return $this->get_submission_info_for_participants($participants);
1969         }
1970     }
1972     /**
1973      * Return a valid order by segment for list_participants that matches
1974      * the sorting of the current grading table. Not every field is supported,
1975      * we are only concerned with a list of users so we can't search on anything
1976      * that is not part of the user information (like grading statud or last modified stuff).
1977      *
1978      * @return string Order by clause for list_participants
1979      */
1980     private function get_grading_sort_sql() {
1981         $usersort = flexible_table::get_sort_for_table('mod_assign_grading');
1982         $extrauserfields = get_extra_user_fields($this->get_context());
1984         $userfields = explode(',', user_picture::fields('', $extrauserfields));
1985         $orderfields = explode(',', $usersort);
1986         $validlist = [];
1988         foreach ($orderfields as $orderfield) {
1989             $orderfield = trim($orderfield);
1990             foreach ($userfields as $field) {
1991                 $parts = explode(' ', $orderfield);
1992                 if ($parts[0] == $field) {
1993                     // Prepend the user table prefix and count this as a valid order field.
1994                     array_push($validlist, 'u.' . $orderfield);
1995                 }
1996             }
1997         }
1998         // Produce a final list.
1999         $result = implode(',', $validlist);
2000         if (empty($result)) {
2001             // Fall back ordering when none has been set.
2002             $result = 'u.lastname, u.firstname, u.id';
2003         }
2005         return $result;
2006     }
2008     /**
2009      * Load a list of users enrolled in the current course with the specified permission and group.
2010      * 0 for no group.
2011      * Apply any current sort filters from the grading table.
2012      *
2013      * @param int $currentgroup
2014      * @param bool $idsonly
2015      * @return array List of user records
2016      */
2017     public function list_participants($currentgroup, $idsonly, $tablesort = false) {
2018         global $DB, $USER;
2020         // Get the last known sort order for the grading table.
2022         if (empty($currentgroup)) {
2023             $currentgroup = 0;
2024         }
2026         $key = $this->context->id . '-' . $currentgroup . '-' . $this->show_only_active_users();
2027         if (!isset($this->participants[$key])) {
2028             list($esql, $params) = get_enrolled_sql($this->context, 'mod/assign:submit', $currentgroup,
2029                     $this->show_only_active_users());
2031             $fields = 'u.*';
2032             $orderby = 'u.lastname, u.firstname, u.id';
2034             $additionaljoins = '';
2035             $additionalfilters = '';
2036             $instance = $this->get_instance();
2037             if (!empty($instance->blindmarking)) {
2038                 $additionaljoins .= " LEFT JOIN {assign_user_mapping} um
2039                                   ON u.id = um.userid
2040                                  AND um.assignment = :assignmentid1
2041                            LEFT JOIN {assign_submission} s
2042                                   ON u.id = s.userid
2043                                  AND s.assignment = :assignmentid2
2044                                  AND s.latest = 1
2045                         ";
2046                 $params['assignmentid1'] = (int) $instance->id;
2047                 $params['assignmentid2'] = (int) $instance->id;
2048                 $fields .= ', um.id as recordid ';
2050                 // Sort by submission time first, then by um.id to sort reliably by the blind marking id.
2051                 // Note, different DBs have different ordering of NULL values.
2052                 // Therefore we coalesce the current time into the timecreated field, and the max possible integer into
2053                 // the ID field.
2054                 if (empty($tablesort)) {
2055                     $orderby = "COALESCE(s.timecreated, " . time() . ") ASC, COALESCE(s.id, " . PHP_INT_MAX . ") ASC, um.id ASC";
2056                 }
2057             }
2059             if ($instance->markingworkflow &&
2060                     $instance->markingallocation &&
2061                     !has_capability('mod/assign:manageallocations', $this->get_context()) &&
2062                     has_capability('mod/assign:grade', $this->get_context())) {
2064                 $additionaljoins .= ' LEFT JOIN {assign_user_flags} uf
2065                                      ON u.id = uf.userid
2066                                      AND uf.assignment = :assignmentid3';
2068                 $params['assignmentid3'] = (int) $instance->id;
2070                 $additionalfilters .= ' AND uf.allocatedmarker = :markerid';
2071                 $params['markerid'] = $USER->id;
2072             }
2074             $sql = "SELECT $fields
2075                       FROM {user} u
2076                       JOIN ($esql) je ON je.id = u.id
2077                            $additionaljoins
2078                      WHERE u.deleted = 0
2079                            $additionalfilters
2080                   ORDER BY $orderby";
2082             $users = $DB->get_records_sql($sql, $params);
2084             $cm = $this->get_course_module();
2085             $info = new \core_availability\info_module($cm);
2086             $users = $info->filter_user_list($users);
2088             $this->participants[$key] = $users;
2089         }
2091         if ($tablesort) {
2092             // Resort the user list according to the grading table sort and filter settings.
2093             $sortedfiltereduserids = $this->get_grading_userid_list(true, '');
2094             $sortedfilteredusers = [];
2095             foreach ($sortedfiltereduserids as $nextid) {
2096                 $nextid = intval($nextid);
2097                 if (isset($this->participants[$key][$nextid])) {
2098                     $sortedfilteredusers[$nextid] = $this->participants[$key][$nextid];
2099                 }
2100             }
2101             $this->participants[$key] = $sortedfilteredusers;
2102         }
2104         if ($idsonly) {
2105             $idslist = array();
2106             foreach ($this->participants[$key] as $id => $user) {
2107                 $idslist[$id] = new stdClass();
2108                 $idslist[$id]->id = $id;
2109             }
2110             return $idslist;
2111         }
2112         return $this->participants[$key];
2113     }
2115     /**
2116      * Load a user if they are enrolled in the current course. Populated with submission
2117      * status for this assignment.
2118      *
2119      * @param int $userid
2120      * @return null|stdClass user record
2121      */
2122     public function get_participant($userid) {
2123         global $DB, $USER;
2125         if ($userid == $USER->id) {
2126             $participant = clone ($USER);
2127         } else {
2128             $participant = $DB->get_record('user', array('id' => $userid));
2129         }
2130         if (!$participant) {
2131             return null;
2132         }
2134         if (!is_enrolled($this->context, $participant, 'mod/assign:submit', $this->show_only_active_users())) {
2135             return null;
2136         }
2138         $result = $this->get_submission_info_for_participants(array($participant->id => $participant));
2139         return $result[$participant->id];
2140     }
2142     /**
2143      * Load a count of valid teams for this assignment.
2144      *
2145      * @param int $activitygroup Activity active group
2146      * @return int number of valid teams
2147      */
2148     public function count_teams($activitygroup = 0) {
2150         $count = 0;
2152         $participants = $this->list_participants($activitygroup, true);
2154         // If a team submission grouping id is provided all good as all returned groups
2155         // are the submission teams, but if no team submission grouping was specified
2156         // $groups will contain all participants groups.
2157         if ($this->get_instance()->teamsubmissiongroupingid) {
2159             // We restrict the users to the selected group ones.
2160             $groups = groups_get_all_groups($this->get_course()->id,
2161                                             array_keys($participants),
2162                                             $this->get_instance()->teamsubmissiongroupingid,
2163                                             'DISTINCT g.id, g.name');
2165             $count = count($groups);
2167             // When a specific group is selected we don't count the default group users.
2168             if ($activitygroup == 0) {
2169                 if (empty($this->get_instance()->preventsubmissionnotingroup)) {
2170                     // See if there are any users in the default group.
2171                     $defaultusers = $this->get_submission_group_members(0, true);
2172                     if (count($defaultusers) > 0) {
2173                         $count += 1;
2174                     }
2175                 }
2176             } else if ($activitygroup != 0 && empty($groups)) {
2177                 // Set count to 1 if $groups returns empty.
2178                 // It means the group is not part of $this->get_instance()->teamsubmissiongroupingid.
2179                 $count = 1;
2180             }
2181         } else {
2182             // It is faster to loop around participants if no grouping was specified.
2183             $groups = array();
2184             foreach ($participants as $participant) {
2185                 if ($group = $this->get_submission_group($participant->id)) {
2186                     $groups[$group->id] = true;
2187                 } else if (empty($this->get_instance()->preventsubmissionnotingroup)) {
2188                     $groups[0] = true;
2189                 }
2190             }
2192             $count = count($groups);
2193         }
2195         return $count;
2196     }
2198     /**
2199      * Load a count of active users enrolled in the current course with the specified permission and group.
2200      * 0 for no group.
2201      *
2202      * @param int $currentgroup
2203      * @return int number of matching users
2204      */
2205     public function count_participants($currentgroup) {
2206         return count($this->list_participants($currentgroup, true));
2207     }
2209     /**
2210      * Load a count of active users submissions in the current module that require grading
2211      * This means the submission modification time is more recent than the
2212      * grading modification time and the status is SUBMITTED.
2213      *
2214      * @param mixed $currentgroup int|null the group for counting (if null the function will determine it)
2215      * @return int number of matching submissions
2216      */
2217     public function count_submissions_need_grading($currentgroup = null) {
2218         global $DB;
2220         if ($this->get_instance()->teamsubmission) {
2221             // This does not make sense for group assignment because the submission is shared.
2222             return 0;
2223         }
2225         if ($currentgroup === null) {
2226             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2227         }
2228         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2230         $params['assignid'] = $this->get_instance()->id;
2231         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
2232         $sqlscalegrade = $this->get_instance()->grade < 0 ? ' OR g.grade = -1' : '';
2234         $sql = 'SELECT COUNT(s.userid)
2235                    FROM {assign_submission} s
2236                    LEFT JOIN {assign_grades} g ON
2237                         s.assignment = g.assignment AND
2238                         s.userid = g.userid AND
2239                         g.attemptnumber = s.attemptnumber
2240                    JOIN(' . $esql . ') e ON e.id = s.userid
2241                    WHERE
2242                         s.latest = 1 AND
2243                         s.assignment = :assignid AND
2244                         s.timemodified IS NOT NULL AND
2245                         s.status = :submitted AND
2246                         (s.timemodified >= g.timemodified OR g.timemodified IS NULL OR g.grade IS NULL '
2247                             . $sqlscalegrade . ')';
2249         return $DB->count_records_sql($sql, $params);
2250     }
2252     /**
2253      * Load a count of grades.
2254      *
2255      * @return int number of grades
2256      */
2257     public function count_grades() {
2258         global $DB;
2260         if (!$this->has_instance()) {
2261             return 0;
2262         }
2264         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2265         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2267         $params['assignid'] = $this->get_instance()->id;
2269         $sql = 'SELECT COUNT(g.userid)
2270                    FROM {assign_grades} g
2271                    JOIN(' . $esql . ') e ON e.id = g.userid
2272                    WHERE g.assignment = :assignid';
2274         return $DB->count_records_sql($sql, $params);
2275     }
2277     /**
2278      * Load a count of submissions.
2279      *
2280      * @param bool $includenew When true, also counts the submissions with status 'new'.
2281      * @return int number of submissions
2282      */
2283     public function count_submissions($includenew = false) {
2284         global $DB;
2286         if (!$this->has_instance()) {
2287             return 0;
2288         }
2290         $params = array();
2291         $sqlnew = '';
2293         if (!$includenew) {
2294             $sqlnew = ' AND s.status <> :status ';
2295             $params['status'] = ASSIGN_SUBMISSION_STATUS_NEW;
2296         }
2298         if ($this->get_instance()->teamsubmission) {
2299             // We cannot join on the enrolment tables for group submissions (no userid).
2300             $sql = 'SELECT COUNT(DISTINCT s.groupid)
2301                         FROM {assign_submission} s
2302                         WHERE
2303                             s.assignment = :assignid AND
2304                             s.timemodified IS NOT NULL AND
2305                             s.userid = :groupuserid' .
2306                             $sqlnew;
2308             $params['assignid'] = $this->get_instance()->id;
2309             $params['groupuserid'] = 0;
2310         } else {
2311             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2312             list($esql, $enrolparams) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2314             $params = array_merge($params, $enrolparams);
2315             $params['assignid'] = $this->get_instance()->id;
2317             $sql = 'SELECT COUNT(DISTINCT s.userid)
2318                        FROM {assign_submission} s
2319                        JOIN(' . $esql . ') e ON e.id = s.userid
2320                        WHERE
2321                             s.assignment = :assignid AND
2322                             s.timemodified IS NOT NULL ' .
2323                             $sqlnew;
2325         }
2327         return $DB->count_records_sql($sql, $params);
2328     }
2330     /**
2331      * Load a count of submissions with a specified status.
2332      *
2333      * @param string $status The submission status - should match one of the constants
2334      * @param mixed $currentgroup int|null the group for counting (if null the function will determine it)
2335      * @return int number of matching submissions
2336      */
2337     public function count_submissions_with_status($status, $currentgroup = null) {
2338         global $DB;
2340         if ($currentgroup === null) {
2341             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2342         }
2343         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2345         $params['assignid'] = $this->get_instance()->id;
2346         $params['assignid2'] = $this->get_instance()->id;
2347         $params['submissionstatus'] = $status;
2349         if ($this->get_instance()->teamsubmission) {
2351             $groupsstr = '';
2352             if ($currentgroup != 0) {
2353                 // If there is an active group we should only display the current group users groups.
2354                 $participants = $this->list_participants($currentgroup, true);
2355                 $groups = groups_get_all_groups($this->get_course()->id,
2356                                                 array_keys($participants),
2357                                                 $this->get_instance()->teamsubmissiongroupingid,
2358                                                 'DISTINCT g.id, g.name');
2359                 if (empty($groups)) {
2360                     // If $groups is empty it means it is not part of $this->get_instance()->teamsubmissiongroupingid.
2361                     // All submissions from students that do not belong to any of teamsubmissiongroupingid groups
2362                     // count towards groupid = 0. Setting to true as only '0' key matters.
2363                     $groups = [true];
2364                 }
2365                 list($groupssql, $groupsparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
2366                 $groupsstr = 's.groupid ' . $groupssql . ' AND';
2367                 $params = $params + $groupsparams;
2368             }
2369             $sql = 'SELECT COUNT(s.groupid)
2370                         FROM {assign_submission} s
2371                         WHERE
2372                             s.latest = 1 AND
2373                             s.assignment = :assignid AND
2374                             s.timemodified IS NOT NULL AND
2375                             s.userid = :groupuserid AND '
2376                             . $groupsstr . '
2377                             s.status = :submissionstatus';
2378             $params['groupuserid'] = 0;
2379         } else {
2380             $sql = 'SELECT COUNT(s.userid)
2381                         FROM {assign_submission} s
2382                         JOIN(' . $esql . ') e ON e.id = s.userid
2383                         WHERE
2384                             s.latest = 1 AND
2385                             s.assignment = :assignid AND
2386                             s.timemodified IS NOT NULL AND
2387                             s.status = :submissionstatus';
2389         }
2391         return $DB->count_records_sql($sql, $params);
2392     }
2394     /**
2395      * Utility function to get the userid for every row in the grading table
2396      * so the order can be frozen while we iterate it.
2397      *
2398      * @param boolean $cached If true, the cached list from the session could be returned.
2399      * @param string $useridlistid String value used for caching the participant list.
2400      * @return array An array of userids
2401      */
2402     protected function get_grading_userid_list($cached = false, $useridlistid = '') {
2403         if ($cached) {
2404             if (empty($useridlistid)) {
2405                 $useridlistid = $this->get_useridlist_key_id();
2406             }
2407             $useridlistkey = $this->get_useridlist_key($useridlistid);
2408             if (empty($SESSION->mod_assign_useridlist[$useridlistkey])) {
2409                 $SESSION->mod_assign_useridlist[$useridlistkey] = $this->get_grading_userid_list(false, '');
2410             }
2411             return $SESSION->mod_assign_useridlist[$useridlistkey];
2412         }
2413         $filter = get_user_preferences('assign_filter', '');
2414         $table = new assign_grading_table($this, 0, $filter, 0, false);
2416         $useridlist = $table->get_column_data('userid');
2418         return $useridlist;
2419     }
2421     /**
2422      * Generate zip file from array of given files.
2423      *
2424      * @param array $filesforzipping - array of files to pass into archive_to_pathname.
2425      *                                 This array is indexed by the final file name and each
2426      *                                 element in the array is an instance of a stored_file object.
2427      * @return path of temp file - note this returned file does
2428      *         not have a .zip extension - it is a temp file.
2429      */
2430     protected function pack_files($filesforzipping) {
2431         global $CFG;
2432         // Create path for new zip file.
2433         $tempzip = tempnam($CFG->tempdir . '/', 'assignment_');
2434         // Zip files.
2435         $zipper = new zip_packer();
2436         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
2437             return $tempzip;
2438         }
2439         return false;
2440     }
2442     /**
2443      * Finds all assignment notifications that have yet to be mailed out, and mails them.
2444      *
2445      * Cron function to be run periodically according to the moodle cron.
2446      *
2447      * @return bool
2448      */
2449     public static function cron() {
2450         global $DB;
2452         // Only ever send a max of one days worth of updates.
2453         $yesterday = time() - (24 * 3600);
2454         $timenow   = time();
2455         $lastcron = $DB->get_field('modules', 'lastcron', array('name' => 'assign'));
2457         // Collect all submissions that require mailing.
2458         // Submissions are included if all are true:
2459         //   - The assignment is visible in the gradebook.
2460         //   - No previous notification has been sent.
2461         //   - The grader was a real user, not an automated process.
2462         //   - If marking workflow is not enabled, the grade was updated in the past 24 hours, or
2463         //     if marking workflow is enabled, the workflow state is at 'released'.
2464         $sql = "SELECT g.id as gradeid, a.course, a.name, a.blindmarking, a.revealidentities, a.hidegrader,
2465                        g.*, g.timemodified as lastmodified, cm.id as cmid, um.id as recordid
2466                  FROM {assign} a
2467                  JOIN {assign_grades} g ON g.assignment = a.id
2468             LEFT JOIN {assign_user_flags} uf ON uf.assignment = a.id AND uf.userid = g.userid
2469                  JOIN {course_modules} cm ON cm.course = a.course AND cm.instance = a.id
2470                  JOIN {modules} md ON md.id = cm.module AND md.name = 'assign'
2471                  JOIN {grade_items} gri ON gri.iteminstance = a.id AND gri.courseid = a.course AND gri.itemmodule = md.name
2472             LEFT JOIN {assign_user_mapping} um ON g.id = um.userid AND um.assignment = a.id
2473                  WHERE ((a.markingworkflow = 0 AND g.timemodified >= :yesterday AND g.timemodified <= :today) OR
2474                         (a.markingworkflow = 1 AND uf.workflowstate = :wfreleased)) AND
2475                        g.grader > 0 AND uf.mailed = 0 AND gri.hidden = 0
2476               ORDER BY a.course, cm.id";
2478         $params = array(
2479             'yesterday' => $yesterday,
2480             'today' => $timenow,
2481             'wfreleased' => ASSIGN_MARKING_WORKFLOW_STATE_RELEASED,
2482         );
2483         $submissions = $DB->get_records_sql($sql, $params);
2485         if (!empty($submissions)) {
2487             mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
2489             // Preload courses we are going to need those.
2490             $courseids = array();
2491             foreach ($submissions as $submission) {
2492                 $courseids[] = $submission->course;
2493             }
2495             // Filter out duplicates.
2496             $courseids = array_unique($courseids);
2497             $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2498             list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
2499             $sql = 'SELECT c.*, ' . $ctxselect .
2500                       ' FROM {course} c
2501                  LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
2502                      WHERE c.id ' . $courseidsql;
2504             $params['contextlevel'] = CONTEXT_COURSE;
2505             $courses = $DB->get_records_sql($sql, $params);
2507             // Clean up... this could go on for a while.
2508             unset($courseids);
2509             unset($ctxselect);
2510             unset($courseidsql);
2511             unset($params);
2513             // Message students about new feedback.
2514             foreach ($submissions as $submission) {
2516                 mtrace("Processing assignment submission $submission->id ...");
2518                 // Do not cache user lookups - could be too many.
2519                 if (!$user = $DB->get_record('user', array('id'=>$submission->userid))) {
2520                     mtrace('Could not find user ' . $submission->userid);
2521                     continue;
2522                 }
2524                 // Use a cache to prevent the same DB queries happening over and over.
2525                 if (!array_key_exists($submission->course, $courses)) {
2526                     mtrace('Could not find course ' . $submission->course);
2527                     continue;
2528                 }
2529                 $course = $courses[$submission->course];
2530                 if (isset($course->ctxid)) {
2531                     // Context has not yet been preloaded. Do so now.
2532                     context_helper::preload_from_record($course);
2533                 }
2535                 // Override the language and timezone of the "current" user, so that
2536                 // mail is customised for the receiver.
2537                 cron_setup_user($user, $course);
2539                 // Context lookups are already cached.
2540                 $coursecontext = context_course::instance($course->id);
2541                 if (!is_enrolled($coursecontext, $user->id)) {
2542                     $courseshortname = format_string($course->shortname,
2543                                                      true,
2544                                                      array('context' => $coursecontext));
2545                     mtrace(fullname($user) . ' not an active participant in ' . $courseshortname);
2546                     continue;
2547                 }
2549                 if (!$grader = $DB->get_record('user', array('id'=>$submission->grader))) {
2550                     mtrace('Could not find grader ' . $submission->grader);
2551                     continue;
2552                 }
2554                 $modinfo = get_fast_modinfo($course, $user->id);
2555                 $cm = $modinfo->get_cm($submission->cmid);
2556                 // Context lookups are already cached.
2557                 $contextmodule = context_module::instance($cm->id);
2559                 if (!$cm->uservisible) {
2560                     // Hold mail notification for assignments the user cannot access until later.
2561                     continue;
2562                 }
2564                 // Notify the student. Default to the non-anon version.
2565                 $messagetype = 'feedbackavailable';
2566                 // Message type needs 'anon' if "hidden grading" is enabled and the student
2567                 // doesn't have permission to see the grader.
2568                 if ($submission->hidegrader && !has_capability('mod/assign:showhiddengrader', $contextmodule, $user)) {
2569                     $messagetype = 'feedbackavailableanon';
2570                     // There's no point in having an "anonymous grader" if the notification email
2571                     // comes from them. Send the email from the noreply user instead.
2572                     $grader = core_user::get_noreply_user();
2573                 }
2575                 $eventtype = 'assign_notification';
2576                 $updatetime = $submission->lastmodified;
2577                 $modulename = get_string('modulename', 'assign');
2579                 $uniqueid = 0;
2580                 if ($submission->blindmarking && !$submission->revealidentities) {
2581                     if (empty($submission->recordid)) {
2582                         $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $grader->id);
2583                     } else {
2584                         $uniqueid = $submission->recordid;
2585                     }
2586                 }
2587                 $showusers = $submission->blindmarking && !$submission->revealidentities;
2588                 self::send_assignment_notification($grader,
2589                                                    $user,
2590                                                    $messagetype,
2591                                                    $eventtype,
2592                                                    $updatetime,
2593                                                    $cm,
2594                                                    $contextmodule,
2595                                                    $course,
2596                                                    $modulename,
2597                                                    $submission->name,
2598                                                    $showusers,
2599                                                    $uniqueid);
2601                 $flags = $DB->get_record('assign_user_flags', array('userid'=>$user->id, 'assignment'=>$submission->assignment));
2602                 if ($flags) {
2603                     $flags->mailed = 1;
2604                     $DB->update_record('assign_user_flags', $flags);
2605                 } else {
2606                     $flags = new stdClass();
2607                     $flags->userid = $user->id;
2608                     $flags->assignment = $submission->assignment;
2609                     $flags->mailed = 1;
2610                     $DB->insert_record('assign_user_flags', $flags);
2611                 }
2613                 mtrace('Done');
2614             }
2615             mtrace('Done processing ' . count($submissions) . ' assignment submissions');
2617             cron_setup_user();
2619             // Free up memory just to be sure.
2620             unset($courses);
2621         }
2623         // Update calendar events to provide a description.
2624         $sql = 'SELECT id
2625                     FROM {assign}
2626                     WHERE
2627                         allowsubmissionsfromdate >= :lastcron AND
2628                         allowsubmissionsfromdate <= :timenow AND
2629                         alwaysshowdescription = 0';
2630         $params = array('lastcron' => $lastcron, 'timenow' => $timenow);
2631         $newlyavailable = $DB->get_records_sql($sql, $params);
2632         foreach ($newlyavailable as $record) {
2633             $cm = get_coursemodule_from_instance('assign', $record->id, 0, false, MUST_EXIST);
2634             $context = context_module::instance($cm->id);
2636             $assignment = new assign($context, null, null);
2637             $assignment->update_calendar($cm->id);
2638         }
2640         return true;
2641     }
2643     /**
2644      * Mark in the database that this grade record should have an update notification sent by cron.
2645      *
2646      * @param stdClass $grade a grade record keyed on id
2647      * @param bool $mailedoverride when true, flag notification to be sent again.
2648      * @return bool true for success
2649      */
2650     public function notify_grade_modified($grade, $mailedoverride = false) {
2651         global $DB;
2653         $flags = $this->get_user_flags($grade->userid, true);
2654         if ($flags->mailed != 1 || $mailedoverride) {
2655             $flags->mailed = 0;
2656         }
2658         return $this->update_user_flags($flags);
2659     }
2661     /**
2662      * Update user flags for this user in this assignment.
2663      *
2664      * @param stdClass $flags a flags record keyed on id
2665      * @return bool true for success
2666      */
2667     public function update_user_flags($flags) {
2668         global $DB;
2669         if ($flags->userid <= 0 || $flags->assignment <= 0 || $flags->id <= 0) {
2670             return false;
2671         }
2673         $result = $DB->update_record('assign_user_flags', $flags);
2674         return $result;
2675     }
2677     /**
2678      * Update a grade in the grade table for the assignment and in the gradebook.
2679      *
2680      * @param stdClass $grade a grade record keyed on id
2681      * @param bool $reopenattempt If the attempt reopen method is manual, allow another attempt at this assignment.
2682      * @return bool true for success
2683      */
2684     public function update_grade($grade, $reopenattempt = false) {
2685         global $DB;
2687         $grade->timemodified = time();
2689         if (!empty($grade->workflowstate)) {
2690             $validstates = $this->get_marking_workflow_states_for_current_user();
2691             if (!array_key_exists($grade->workflowstate, $validstates)) {
2692                 return false;
2693             }
2694         }
2696         if ($grade->grade && $grade->grade != -1) {
2697             if ($this->get_instance()->grade > 0) {
2698                 if (!is_numeric($grade->grade)) {
2699                     return false;
2700                 } else if ($grade->grade > $this->get_instance()->grade) {
2701                     return false;
2702                 } else if ($grade->grade < 0) {
2703                     return false;
2704                 }
2705             } else {
2706                 // This is a scale.
2707                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
2708                     $scaleoptions = make_menu_from_list($scale->scale);
2709                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
2710                         return false;
2711                     }
2712                 }
2713             }
2714         }
2716         if (empty($grade->attemptnumber)) {
2717             // Set it to the default.
2718             $grade->attemptnumber = 0;
2719         }
2720         $DB->update_record('assign_grades', $grade);
2722         $submission = null;
2723         if ($this->get_instance()->teamsubmission) {
2724             if (isset($this->mostrecentteamsubmission)) {
2725                 $submission = $this->mostrecentteamsubmission;
2726             } else {
2727                 $submission = $this->get_group_submission($grade->userid, 0, false);
2728             }
2729         } else {
2730             $submission = $this->get_user_submission($grade->userid, false);
2731         }
2733         // Only push to gradebook if the update is for the most recent attempt.
2734         if ($submission && $submission->attemptnumber != $grade->attemptnumber) {
2735             return true;
2736         }
2738         if ($this->gradebook_item_update(null, $grade)) {
2739             \mod_assign\event\submission_graded::create_from_grade($this, $grade)->trigger();
2740         }
2742         // If the conditions are met, allow another attempt.
2743         if ($submission) {
2744             $this->reopen_submission_if_required($grade->userid,
2745                     $submission,
2746                     $reopenattempt);
2747         }
2749         return true;
2750     }
2752     /**
2753      * View the grant extension date page.
2754      *
2755      * Uses url parameters 'userid'
2756      * or from parameter 'selectedusers'
2757      *
2758      * @param moodleform $mform - Used for validation of the submitted data
2759      * @return string
2760      */
2761     protected function view_grant_extension($mform) {
2762         global $CFG;
2763         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
2765         $o = '';
2767         $data = new stdClass();
2768         $data->id = $this->get_course_module()->id;
2770         $formparams = array(
2771             'instance' => $this->get_instance(),
2772             'assign' => $this
2773         );
2775         $users = optional_param('userid', 0, PARAM_INT);
2776         if (!$users) {
2777             $users = required_param('selectedusers', PARAM_SEQUENCE);
2778         }
2779         $userlist = explode(',', $users);
2781         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
2782         $maxoverride = array('allowsubmissionsfromdate' => 0, 'duedate' => 0, 'cutoffdate' => 0);
2783         foreach ($userlist as $userid) {
2784             // To validate extension date with users overrides.
2785             $override = $this->override_exists($userid);
2786             foreach ($keys as $key) {
2787                 if ($override->{$key}) {
2788                     if ($maxoverride[$key] < $override->{$key}) {
2789                         $maxoverride[$key] = $override->{$key};
2790                     }
2791                 } else if ($maxoverride[$key] < $this->get_instance()->{$key}) {
2792                     $maxoverride[$key] = $this->get_instance()->{$key};
2793                 }
2794             }
2795         }
2796         foreach ($keys as $key) {
2797             if ($maxoverride[$key]) {
2798                 $this->get_instance()->{$key} = $maxoverride[$key];
2799             }
2800         }
2802         $formparams['userlist'] = $userlist;
2804         $data->selectedusers = $users;
2805         $data->userid = 0;
2807         if (empty($mform)) {
2808             $mform = new mod_assign_extension_form(null, $formparams);
2809         }
2810         $mform->set_data($data);
2811         $header = new assign_header($this->get_instance(),
2812                                     $this->get_context(),
2813                                     $this->show_intro(),
2814                                     $this->get_course_module()->id,
2815                                     get_string('grantextension', 'assign'));
2816         $o .= $this->get_renderer()->render($header);
2817         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
2818         $o .= $this->view_footer();
2819         return $o;
2820     }
2822     /**
2823      * Get a list of the users in the same group as this user.
2824      *
2825      * @param int $groupid The id of the group whose members we want or 0 for the default group
2826      * @param bool $onlyids Whether to retrieve only the user id's
2827      * @param bool $excludesuspended Whether to exclude suspended users
2828      * @return array The users (possibly id's only)
2829      */
2830     public function get_submission_group_members($groupid, $onlyids, $excludesuspended = false) {
2831         $members = array();
2832         if ($groupid != 0) {
2833             $allusers = $this->list_participants($groupid, $onlyids);
2834             foreach ($allusers as $user) {
2835                 if ($this->get_submission_group($user->id)) {
2836                     $members[] = $user;
2837                 }
2838             }
2839         } else {
2840             $allusers = $this->list_participants(null, $onlyids);
2841             foreach ($allusers as $user) {
2842                 if ($this->get_submission_group($user->id) == null) {
2843                     $members[] = $user;
2844                 }
2845             }
2846         }
2847         // Exclude suspended users, if user can't see them.
2848         if ($excludesuspended || !has_capability('moodle/course:viewsuspendedusers', $this->context)) {
2849             foreach ($members as $key => $member) {
2850                 if (!$this->is_active_user($member->id)) {
2851                     unset($members[$key]);
2852                 }
2853             }
2854         }
2856         return $members;
2857     }
2859     /**
2860      * Get a list of the users in the same group as this user that have not submitted the assignment.
2861      *
2862      * @param int $groupid The id of the group whose members we want or 0 for the default group
2863      * @param bool $onlyids Whether to retrieve only the user id's
2864      * @return array The users (possibly id's only)
2865      */
2866     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
2867         $instance = $this->get_instance();
2868         if (!$instance->teamsubmission || !$instance->requireallteammemberssubmit) {
2869             return array();
2870         }
2871         $members = $this->get_submission_group_members($groupid, $onlyids);
2873         foreach ($members as $id => $member) {
2874             $submission = $this->get_user_submission($member->id, false);
2875             if ($submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2876                 unset($members[$id]);
2877             } else {
2878                 if ($this->is_blind_marking()) {
2879                     $members[$id]->alias = get_string('hiddenuser', 'assign') .
2880                                            $this->get_uniqueid_for_user($id);
2881                 }
2882             }
2883         }
2884         return $members;
2885     }
2887     /**
2888      * Load the group submission object for a particular user, optionally creating it if required.
2889      *
2890      * @param int $userid The id of the user whose submission we want
2891      * @param int $groupid The id of the group for this user - may be 0 in which
2892      *                     case it is determined from the userid.
2893      * @param bool $create If set to true a new submission object will be created in the database
2894      *                     with the status set to "new".
2895      * @param int $attemptnumber - -1 means the latest attempt
2896      * @return stdClass The submission
2897      */
2898     public function get_group_submission($userid, $groupid, $create, $attemptnumber=-1) {
2899         global $DB;
2901         if ($groupid == 0) {
2902             $group = $this->get_submission_group($userid);
2903             if ($group) {
2904                 $groupid = $group->id;
2905             }
2906         }
2908         // Now get the group submission.
2909         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2910         if ($attemptnumber >= 0) {
2911             $params['attemptnumber'] = $attemptnumber;
2912         }
2914         // Only return the row with the highest attemptnumber.
2915         $submission = null;
2916         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2917         if ($submissions) {
2918             $submission = reset($submissions);
2919         }
2921         if ($submission) {
2922             return $submission;
2923         }
2924         if ($create) {
2925             $submission = new stdClass();
2926             $submission->assignment = $this->get_instance()->id;
2927             $submission->userid = 0;
2928             $submission->groupid = $groupid;
2929             $submission->timecreated = time();
2930             $submission->timemodified = $submission->timecreated;
2931             if ($attemptnumber >= 0) {
2932                 $submission->attemptnumber = $attemptnumber;
2933             } else {
2934                 $submission->attemptnumber = 0;
2935             }
2936             // Work out if this is the latest submission.
2937             $submission->latest = 0;
2938             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2939             if ($attemptnumber == -1) {
2940                 // This is a new submission so it must be the latest.
2941                 $submission->latest = 1;
2942             } else {
2943                 // We need to work this out.
2944                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2945                 if ($result) {
2946                     $latestsubmission = reset($result);
2947                 }
2948                 if (!$latestsubmission || ($attemptnumber == $latestsubmission->attemptnumber)) {
2949                     $submission->latest = 1;
2950                 }
2951             }
2952             if ($submission->latest) {
2953                 // This is the case when we need to set latest to 0 for all the other attempts.
2954                 $DB->set_field('assign_submission', 'latest', 0, $params);
2955             }
2956             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2957             $sid = $DB->insert_record('assign_submission', $submission);
2958             return $DB->get_record('assign_submission', array('id' => $sid));
2959         }
2960         return false;
2961     }
2963     /**
2964      * View a summary listing of all assignments in the current course.
2965      *
2966      * @return string
2967      */
2968     private function view_course_index() {
2969         global $USER;
2971         $o = '';
2973         $course = $this->get_course();
2974         $strplural = get_string('modulenameplural', 'assign');
2976         if (!$cms = get_coursemodules_in_course('assign', $course->id, 'm.duedate')) {
2977             $o .= $this->get_renderer()->notification(get_string('thereareno', 'moodle', $strplural));
2978             $o .= $this->get_renderer()->continue_button(new moodle_url('/course/view.php', array('id' => $course->id)));
2979             return $o;
2980         }
2982         $strsectionname = '';
2983         $usesections = course_format_uses_sections($course->format);
2984         $modinfo = get_fast_modinfo($course);
2986         if ($usesections) {
2987             $strsectionname = get_string('sectionname', 'format_'.$course->format);
2988             $sections = $modinfo->get_section_info_all();
2989         }
2990         $courseindexsummary = new assign_course_index_summary($usesections, $strsectionname);
2992         $timenow = time();
2994         $currentsection = '';
2995         foreach ($modinfo->instances['assign'] as $cm) {
2996             if (!$cm->uservisible) {
2997                 continue;
2998             }
3000             $timedue = $cms[$cm->id]->duedate;
3002             $sectionname = '';
3003             if ($usesections && $cm->sectionnum) {
3004                 $sectionname = get_section_name($course, $sections[$cm->sectionnum]);
3005             }
3007             $submitted = '';
3008             $context = context_module::instance($cm->id);
3010             $assignment = new assign($context, $cm, $course);
3012             // Apply overrides.
3013             $assignment->update_effective_access($USER->id);
3014             $timedue = $assignment->get_instance()->duedate;
3016             if (has_capability('mod/assign:grade', $context)) {
3017                 $submitted = $assignment->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED);
3019             } else if (has_capability('mod/assign:submit', $context)) {
3020                 if ($assignment->get_instance()->teamsubmission) {
3021                     $usersubmission = $assignment->get_group_submission($USER->id, 0, false);
3022                 } else {
3023                     $usersubmission = $assignment->get_user_submission($USER->id, false);
3024                 }
3026                 if (!empty($usersubmission->status)) {
3027                     $submitted = get_string('submissionstatus_' . $usersubmission->status, 'assign');
3028                 } else {
3029                     $submitted = get_string('submissionstatus_', 'assign');
3030                 }
3031             }
3032             $gradinginfo = grade_get_grades($course->id, 'mod', 'assign', $cm->instance, $USER->id);
3033             if (isset($gradinginfo->items[0]->grades[$USER->id]) &&
3034                     !$gradinginfo->items[0]->grades[$USER->id]->hidden ) {
3035                 $grade = $gradinginfo->items[0]->grades[$USER->id]->str_grade;
3036             } else {
3037                 $grade = '-';
3038             }
3040             $courseindexsummary->add_assign_info($cm->id, $cm->get_formatted_name(), $sectionname, $timedue, $submitted, $grade);
3042         }
3044         $o .= $this->get_renderer()->render($courseindexsummary);
3045         $o .= $this->view_footer();
3047         return $o;
3048     }
3050     /**
3051      * View a page rendered by a plugin.
3052      *
3053      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.
3054      *
3055      * @return string
3056      */
3057     protected function view_plugin_page() {
3058         global $USER;
3060         $o = '';
3062         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
3063         $plugintype = required_param('plugin', PARAM_PLUGIN);
3064         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
3066         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
3067         if (!$plugin) {
3068             print_error('invalidformdata', '');
3069             return;
3070         }
3072         $o .= $plugin->view_page($pluginaction);
3074         return $o;
3075     }
3078     /**
3079      * This is used for team assignments to get the group for the specified user.
3080      * If the user is a member of multiple or no groups this will return false
3081      *
3082      * @param int $userid The id of the user whose submission we want
3083      * @return mixed The group or false
3084      */
3085     public function get_submission_group($userid) {
3087         if (isset($this->usersubmissiongroups[$userid])) {
3088             return $this->usersubmissiongroups[$userid];
3089         }
3091         $groups = $this->get_all_groups($userid);
3092         if (count($groups) != 1) {
3093             $return = false;
3094         } else {
3095             $return = array_pop($groups);
3096         }
3098         // Cache the user submission group.
3099         $this->usersubmissiongroups[$userid] = $return;
3101         return $return;
3102     }
3104     /**
3105      * Gets all groups the user is a member of.
3106      *
3107      * @param int $userid Teh id of the user who's groups we are checking
3108      * @return array The group objects
3109      */
3110     public function get_all_groups($userid) {
3111         if (isset($this->usergroups[$userid])) {
3112             return $this->usergroups[$userid];
3113         }
3115         $grouping = $this->get_instance()->teamsubmissiongroupingid;
3116         $return = groups_get_all_groups($this->get_course()->id, $userid, $grouping);
3118         $this->usergroups[$userid] = $return;
3120         return $return;
3121     }
3124     /**
3125      * Display the submission that is used by a plugin.
3126      *
3127      * Uses url parameters 'sid', 'gid' and 'plugin'.
3128      *
3129      * @param string $pluginsubtype
3130      * @return string
3131      */
3132     protected function view_plugin_content($pluginsubtype) {
3133         $o = '';
3135         $submissionid = optional_param('sid', 0, PARAM_INT);
3136         $gradeid = optional_param('gid', 0, PARAM_INT);
3137         $plugintype = required_param('plugin', PARAM_PLUGIN);
3138         $item = null;
3139         if ($pluginsubtype == 'assignsubmission') {
3140             $plugin = $this->get_submission_plugin_by_type($plugintype);
3141             if ($submissionid <= 0) {
3142                 throw new coding_exception('Submission id should not be 0');
3143             }
3144             $item = $this->get_submission($submissionid);
3146             // Check permissions.
3147             if (empty($item->userid)) {
3148                 // Group submission.
3149                 $this->require_view_group_submission($item->groupid);
3150             } else {
3151                 $this->require_view_submission($item->userid);
3152             }
3153             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
3154                                                               $this->get_context(),
3155                                                               $this->show_intro(),
3156                                                               $this->get_course_module()->id,
3157                                                               $plugin->get_name()));
3158             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
3159                                                               $item,
3160                                                               assign_submission_plugin_submission::FULL,
3161                                                               $this->get_course_module()->id,
3162                                                               $this->get_return_action(),
3163                                                               $this->get_return_params()));
3165             // Trigger event for viewing a submission.
3166             \mod_assign\event\submission_viewed::create_from_submission($this, $item)->trigger();
3168         } else {
3169             $plugin = $this->get_feedback_plugin_by_type($plugintype);
3170             if ($gradeid <= 0) {
3171                 throw new coding_exception('Grade id should not be 0');
3172             }
3173             $item = $this->get_grade($gradeid);
3174             // Check permissions.
3175             $this->require_view_submission($item->userid);
3176             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
3177                                                               $this->get_context(),
3178                                                               $this->show_intro(),
3179                                                               $this->get_course_module()->id,
3180                                                               $plugin->get_name()));
3181             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
3182                                                               $item,
3183                                                               assign_feedback_plugin_feedback::FULL,
3184                                                               $this->get_course_module()->id,
3185                                                               $this->get_return_action(),
3186                                                               $this->get_return_params()));
3188             // Trigger event for viewing feedback.
3189             \mod_assign\event\feedback_viewed::create_from_grade($this, $item)->trigger();
3190         }
3192         $o .= $this->view_return_links();
3194         $o .= $this->view_footer();
3196         return $o;
3197     }
3199     /**
3200      * Rewrite plugin file urls so they resolve correctly in an exported zip.
3201      *
3202      * @param string $text - The replacement text
3203      * @param stdClass $user - The user record
3204      * @param assign_plugin $plugin - The assignment plugin
3205      */
3206     public function download_rewrite_pluginfile_urls($text, $user, $plugin) {
3207         // The groupname prefix for the urls doesn't depend on the group mode of the assignment instance.
3208         // Rather, it should be determined by checking the group submission settings of the instance,
3209         // which is what download_submission() does when generating the file name prefixes.
3210         $groupname = '';
3211         if ($this->get_instance()->teamsubmission) {
3212             $submissiongroup = $this->get_submission_group($user->id);
3213             if ($submissiongroup) {
3214                 $groupname = $submissiongroup->name . '-';
3215             } else {
3216                 $groupname = get_string('defaultteam', 'assign') . '-';
3217             }
3218         }
3220         if ($this->is_blind_marking()) {
3221             $prefix = $groupname . get_string('participant', 'assign');
3222             $prefix = str_replace('_', ' ', $prefix);
3223             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
3224         } else {
3225             $prefix = $groupname . fullname($user);
3226             $prefix = str_replace('_', ' ', $prefix);
3227             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
3228         }
3230         // Only prefix files if downloadasfolders user preference is NOT set.
3231         if (!get_user_preferences('assign_downloadasfolders', 1)) {
3232             $subtype = $plugin->get_subtype();
3233             $type = $plugin->get_type();
3234             $prefix = $prefix . $subtype . '_' . $type . '_';
3235         } else {
3236             $prefix = "";
3237         }
3238         $result = str_replace('@@PLUGINFILE@@/', $prefix, $text);
3240         return $result;
3241     }
3243     /**
3244      * Render the content in editor that is often used by plugin.
3245      *
3246      * @param string $filearea
3247      * @param int $submissionid
3248      * @param string $plugintype
3249      * @param string $editor
3250      * @param string $component
3251      * @param bool $shortentext Whether to shorten the text content.
3252      * @return string
3253      */
3254     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component, $shortentext = false) {
3255         global $CFG;
3257         $result = '';
3259         $plugin = $this->get_submission_plugin_by_type($plugintype);
3261         $text = $plugin->get_editor_text($editor, $submissionid);
3262         if ($shortentext) {
3263             $text = shorten_text($text, 140);
3264         }
3265         $format = $plugin->get_editor_format($editor, $submissionid);
3267         $finaltext = file_rewrite_pluginfile_urls($text,
3268                                                   'pluginfile.php',
3269                                                   $this->get_context()->id,
3270                                                   $component,
3271                                                   $filearea,
3272                                                   $submissionid);
3273         $params = array('overflowdiv' => true, 'context' => $this->get_context());
3274         $result .= format_text($finaltext, $format, $params);
3276         if ($CFG->enableportfolios && has_capability('mod/assign:exportownsubmission', $this->context)) {
3277             require_once($CFG->libdir . '/portfoliolib.php');
3279             $button = new portfolio_add_button();
3280             $portfolioparams = array('cmid' => $this->get_course_module()->id,
3281                                      'sid' => $submissionid,
3282                                      'plugin' => $plugintype,
3283                                      'editor' => $editor,
3284                                      'area'=>$filearea);
3285             $button->set_callback_options('assign_portfolio_caller', $portfolioparams, 'mod_assign');
3286             $fs = get_file_storage();
3288             if ($files = $fs->get_area_files($this->context->id,
3289                                              $component,
3290                                              $filearea,
3291                                              $submissionid,
3292                                              'timemodified',
3293                                              false)) {
3294                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3295             } else {
3296                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3297             }
3298             $result .= $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3299         }
3300         return $result;
3301     }
3303     /**
3304      * Display a continue page after grading.
3305      *
3306      * @param string $message - The message to display.
3307      * @return string
3308      */
3309     protected function view_savegrading_result($message) {
3310         $o = '';
3311         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
3312                                                       $this->get_context(),