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