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