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