MDL-57362 assign: Fix permission checks
[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 // Grading states.
54 define('ASSIGN_GRADING_STATUS_GRADED', 'graded');
55 define('ASSIGN_GRADING_STATUS_NOT_GRADED', 'notgraded');
57 // Marking workflow states.
58 define('ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED', 'notmarked');
59 define('ASSIGN_MARKING_WORKFLOW_STATE_INMARKING', 'inmarking');
60 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORREVIEW', 'readyforreview');
61 define('ASSIGN_MARKING_WORKFLOW_STATE_INREVIEW', 'inreview');
62 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORRELEASE', 'readyforrelease');
63 define('ASSIGN_MARKING_WORKFLOW_STATE_RELEASED', 'released');
65 /** ASSIGN_MAX_EVENT_LENGTH = 432000 ; 5 days maximum */
66 define("ASSIGN_MAX_EVENT_LENGTH", "432000");
68 // Name of file area for intro attachments.
69 define('ASSIGN_INTROATTACHMENT_FILEAREA', 'introattachment');
71 require_once($CFG->libdir . '/accesslib.php');
72 require_once($CFG->libdir . '/formslib.php');
73 require_once($CFG->dirroot . '/repository/lib.php');
74 require_once($CFG->dirroot . '/mod/assign/mod_form.php');
75 require_once($CFG->libdir . '/gradelib.php');
76 require_once($CFG->dirroot . '/grade/grading/lib.php');
77 require_once($CFG->dirroot . '/mod/assign/feedbackplugin.php');
78 require_once($CFG->dirroot . '/mod/assign/submissionplugin.php');
79 require_once($CFG->dirroot . '/mod/assign/renderable.php');
80 require_once($CFG->dirroot . '/mod/assign/gradingtable.php');
81 require_once($CFG->libdir . '/eventslib.php');
82 require_once($CFG->libdir . '/portfolio/caller.php');
84 use \mod_assign\output\grading_app;
86 /**
87  * Standard base class for mod_assign (assignment types).
88  *
89  * @package   mod_assign
90  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
91  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
92  */
93 class assign {
95     /** @var stdClass the assignment record that contains the global settings for this assign instance */
96     private $instance;
98     /** @var grade_item the grade_item record for this assign instance's primary grade item. */
99     private $gradeitem;
101     /** @var context the context of the course module for this assign instance
102      *               (or just the course if we are creating a new one)
103      */
104     private $context;
106     /** @var stdClass the course this assign instance belongs to */
107     private $course;
109     /** @var stdClass the admin config for all assign instances  */
110     private $adminconfig;
112     /** @var assign_renderer the custom renderer for this module */
113     private $output;
115     /** @var cm_info the course module for this assign instance */
116     private $coursemodule;
118     /** @var array cache for things like the coursemodule name or the scale menu -
119      *             only lives for a single request.
120      */
121     private $cache;
123     /** @var array list of the installed submission plugins */
124     private $submissionplugins;
126     /** @var array list of the installed feedback plugins */
127     private $feedbackplugins;
129     /** @var string action to be used to return to this page
130      *              (without repeating any form submissions etc).
131      */
132     private $returnaction = 'view';
134     /** @var array params to be used to return to this page */
135     private $returnparams = array();
137     /** @var string modulename prevents excessive calls to get_string */
138     private static $modulename = null;
140     /** @var string modulenameplural prevents excessive calls to get_string */
141     private static $modulenameplural = null;
143     /** @var array of marking workflow states for the current user */
144     private $markingworkflowstates = null;
146     /** @var bool whether to exclude users with inactive enrolment */
147     private $showonlyactiveenrol = null;
149     /** @var string A key used to identify userlists created by this object. */
150     private $useridlistid = null;
152     /** @var array cached list of participants for this assignment. The cache key will be group, showactive and the context id */
153     private $participants = array();
155     /** @var array cached list of user groups when team submissions are enabled. The cache key will be the user. */
156     private $usersubmissiongroups = array();
158     /** @var array cached list of user groups. The cache key will be the user. */
159     private $usergroups = array();
161     /** @var array cached list of IDs of users who share group membership with the user. The cache key will be the user. */
162     private $sharedgroupmembers = array();
164     /**
165      * Constructor for the base assign class.
166      *
167      * Note: For $coursemodule you can supply a stdclass if you like, but it
168      * will be more efficient to supply a cm_info object.
169      *
170      * @param mixed $coursemodulecontext context|null the course module context
171      *                                   (or the course context if the coursemodule has not been
172      *                                   created yet).
173      * @param mixed $coursemodule the current course module if it was already loaded,
174      *                            otherwise this class will load one from the context as required.
175      * @param mixed $course the current course  if it was already loaded,
176      *                      otherwise this class will load one from the context as required.
177      */
178     public function __construct($coursemodulecontext, $coursemodule, $course) {
179         global $SESSION;
181         $this->context = $coursemodulecontext;
182         $this->course = $course;
184         // Ensure that $this->coursemodule is a cm_info object (or null).
185         $this->coursemodule = cm_info::create($coursemodule);
187         // Temporary cache only lives for a single request - used to reduce db lookups.
188         $this->cache = array();
190         $this->submissionplugins = $this->load_plugins('assignsubmission');
191         $this->feedbackplugins = $this->load_plugins('assignfeedback');
193         // Extra entropy is required for uniqid() to work on cygwin.
194         $this->useridlistid = clean_param(uniqid('', true), PARAM_ALPHANUM);
196         if (!isset($SESSION->mod_assign_useridlist)) {
197             $SESSION->mod_assign_useridlist = [];
198         }
199     }
201     /**
202      * Set the action and parameters that can be used to return to the current page.
203      *
204      * @param string $action The action for the current page
205      * @param array $params An array of name value pairs which form the parameters
206      *                      to return to the current page.
207      * @return void
208      */
209     public function register_return_link($action, $params) {
210         global $PAGE;
211         $params['action'] = $action;
212         $cm = $this->get_course_module();
213         if ($cm) {
214             $currenturl = new moodle_url('/mod/assign/view.php', array('id' => $cm->id));
215         } else {
216             $currenturl = new moodle_url('/mod/assign/index.php', array('id' => $this->get_course()->id));
217         }
219         $currenturl->params($params);
220         $PAGE->set_url($currenturl);
221     }
223     /**
224      * Return an action that can be used to get back to the current page.
225      *
226      * @return string action
227      */
228     public function get_return_action() {
229         global $PAGE;
231         // Web services don't set a URL, we should avoid debugging when ussing the url object.
232         if (!WS_SERVER) {
233             $params = $PAGE->url->params();
234         }
236         if (!empty($params['action'])) {
237             return $params['action'];
238         }
239         return '';
240     }
242     /**
243      * Based on the current assignment settings should we display the intro.
244      *
245      * @return bool showintro
246      */
247     public function show_intro() {
248         if ($this->get_instance()->alwaysshowdescription ||
249                 time() > $this->get_instance()->allowsubmissionsfromdate) {
250             return true;
251         }
252         return false;
253     }
255     /**
256      * Return a list of parameters that can be used to get back to the current page.
257      *
258      * @return array params
259      */
260     public function get_return_params() {
261         global $PAGE;
263         $params = $PAGE->url->params();
264         unset($params['id']);
265         unset($params['action']);
266         return $params;
267     }
269     /**
270      * Set the submitted form data.
271      *
272      * @param stdClass $data The form data (instance)
273      */
274     public function set_instance(stdClass $data) {
275         $this->instance = $data;
276     }
278     /**
279      * Set the context.
280      *
281      * @param context $context The new context
282      */
283     public function set_context(context $context) {
284         $this->context = $context;
285     }
287     /**
288      * Set the course data.
289      *
290      * @param stdClass $course The course data
291      */
292     public function set_course(stdClass $course) {
293         $this->course = $course;
294     }
296     /**
297      * Get list of feedback plugins installed.
298      *
299      * @return array
300      */
301     public function get_feedback_plugins() {
302         return $this->feedbackplugins;
303     }
305     /**
306      * Get list of submission plugins installed.
307      *
308      * @return array
309      */
310     public function get_submission_plugins() {
311         return $this->submissionplugins;
312     }
314     /**
315      * Is blind marking enabled and reveal identities not set yet?
316      *
317      * @return bool
318      */
319     public function is_blind_marking() {
320         return $this->get_instance()->blindmarking && !$this->get_instance()->revealidentities;
321     }
323     /**
324      * Does an assignment have submission(s) or grade(s) already?
325      *
326      * @return bool
327      */
328     public function has_submissions_or_grades() {
329         $allgrades = $this->count_grades();
330         $allsubmissions = $this->count_submissions();
331         if (($allgrades == 0) && ($allsubmissions == 0)) {
332             return false;
333         }
334         return true;
335     }
337     /**
338      * Get a specific submission plugin by its type.
339      *
340      * @param string $subtype assignsubmission | assignfeedback
341      * @param string $type
342      * @return mixed assign_plugin|null
343      */
344     public function get_plugin_by_type($subtype, $type) {
345         $shortsubtype = substr($subtype, strlen('assign'));
346         $name = $shortsubtype . 'plugins';
347         if ($name != 'feedbackplugins' && $name != 'submissionplugins') {
348             return null;
349         }
350         $pluginlist = $this->$name;
351         foreach ($pluginlist as $plugin) {
352             if ($plugin->get_type() == $type) {
353                 return $plugin;
354             }
355         }
356         return null;
357     }
359     /**
360      * Get a feedback plugin by type.
361      *
362      * @param string $type - The type of plugin e.g comments
363      * @return mixed assign_feedback_plugin|null
364      */
365     public function get_feedback_plugin_by_type($type) {
366         return $this->get_plugin_by_type('assignfeedback', $type);
367     }
369     /**
370      * Get a submission plugin by type.
371      *
372      * @param string $type - The type of plugin e.g comments
373      * @return mixed assign_submission_plugin|null
374      */
375     public function get_submission_plugin_by_type($type) {
376         return $this->get_plugin_by_type('assignsubmission', $type);
377     }
379     /**
380      * Load the plugins from the sub folders under subtype.
381      *
382      * @param string $subtype - either submission or feedback
383      * @return array - The sorted list of plugins
384      */
385     public function load_plugins($subtype) {
386         global $CFG;
387         $result = array();
389         $names = core_component::get_plugin_list($subtype);
391         foreach ($names as $name => $path) {
392             if (file_exists($path . '/locallib.php')) {
393                 require_once($path . '/locallib.php');
395                 $shortsubtype = substr($subtype, strlen('assign'));
396                 $pluginclass = 'assign_' . $shortsubtype . '_' . $name;
398                 $plugin = new $pluginclass($this, $name);
400                 if ($plugin instanceof assign_plugin) {
401                     $idx = $plugin->get_sort_order();
402                     while (array_key_exists($idx, $result)) {
403                         $idx +=1;
404                     }
405                     $result[$idx] = $plugin;
406                 }
407             }
408         }
409         ksort($result);
410         return $result;
411     }
413     /**
414      * Display the assignment, used by view.php
415      *
416      * The assignment is displayed differently depending on your role,
417      * the settings for the assignment and the status of the assignment.
418      *
419      * @param string $action The current action if any.
420      * @param array $args Optional arguments to pass to the view (instead of getting them from GET and POST).
421      * @return string - The page output.
422      */
423     public function view($action='', $args = array()) {
424         global $PAGE;
426         $o = '';
427         $mform = null;
428         $notices = array();
429         $nextpageparams = array();
431         if (!empty($this->get_course_module()->id)) {
432             $nextpageparams['id'] = $this->get_course_module()->id;
433         }
435         // Handle form submissions first.
436         if ($action == 'savesubmission') {
437             $action = 'editsubmission';
438             if ($this->process_save_submission($mform, $notices)) {
439                 $action = 'redirect';
440                 $nextpageparams['action'] = 'view';
441             }
442         } else if ($action == 'editprevioussubmission') {
443             $action = 'editsubmission';
444             if ($this->process_copy_previous_attempt($notices)) {
445                 $action = 'redirect';
446                 $nextpageparams['action'] = 'editsubmission';
447             }
448         } else if ($action == 'lock') {
449             $this->process_lock_submission();
450             $action = 'redirect';
451             $nextpageparams['action'] = 'grading';
452         } else if ($action == 'addattempt') {
453             $this->process_add_attempt(required_param('userid', PARAM_INT));
454             $action = 'redirect';
455             $nextpageparams['action'] = 'grading';
456         } else if ($action == 'reverttodraft') {
457             $this->process_revert_to_draft();
458             $action = 'redirect';
459             $nextpageparams['action'] = 'grading';
460         } else if ($action == 'unlock') {
461             $this->process_unlock_submission();
462             $action = 'redirect';
463             $nextpageparams['action'] = 'grading';
464         } else if ($action == 'setbatchmarkingworkflowstate') {
465             $this->process_set_batch_marking_workflow_state();
466             $action = 'redirect';
467             $nextpageparams['action'] = 'grading';
468         } else if ($action == 'setbatchmarkingallocation') {
469             $this->process_set_batch_marking_allocation();
470             $action = 'redirect';
471             $nextpageparams['action'] = 'grading';
472         } else if ($action == 'confirmsubmit') {
473             $action = 'submit';
474             if ($this->process_submit_for_grading($mform, $notices)) {
475                 $action = 'redirect';
476                 $nextpageparams['action'] = 'view';
477             } else if ($notices) {
478                 $action = 'viewsubmitforgradingerror';
479             }
480         } else if ($action == 'submitotherforgrading') {
481             if ($this->process_submit_other_for_grading($mform, $notices)) {
482                 $action = 'redirect';
483                 $nextpageparams['action'] = 'grading';
484             } else {
485                 $action = 'viewsubmitforgradingerror';
486             }
487         } else if ($action == 'gradingbatchoperation') {
488             $action = $this->process_grading_batch_operation($mform);
489             if ($action == 'grading') {
490                 $action = 'redirect';
491                 $nextpageparams['action'] = 'grading';
492             }
493         } else if ($action == 'submitgrade') {
494             if (optional_param('saveandshownext', null, PARAM_RAW)) {
495                 // Save and show next.
496                 $action = 'grade';
497                 if ($this->process_save_grade($mform)) {
498                     $action = 'redirect';
499                     $nextpageparams['action'] = 'grade';
500                     $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
501                     $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
502                 }
503             } else if (optional_param('nosaveandprevious', null, PARAM_RAW)) {
504                 $action = 'redirect';
505                 $nextpageparams['action'] = 'grade';
506                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) - 1;
507                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
508             } else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
509                 $action = 'redirect';
510                 $nextpageparams['action'] = 'grade';
511                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
512                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
513             } else if (optional_param('savegrade', null, PARAM_RAW)) {
514                 // Save changes button.
515                 $action = 'grade';
516                 if ($this->process_save_grade($mform)) {
517                     $action = 'redirect';
518                     $nextpageparams['action'] = 'savegradingresult';
519                 }
520             } else {
521                 // Cancel button.
522                 $action = 'redirect';
523                 $nextpageparams['action'] = 'grading';
524             }
525         } else if ($action == 'quickgrade') {
526             $message = $this->process_save_quick_grades();
527             $action = 'quickgradingresult';
528         } else if ($action == 'saveoptions') {
529             $this->process_save_grading_options();
530             $action = 'redirect';
531             $nextpageparams['action'] = 'grading';
532         } else if ($action == 'saveextension') {
533             $action = 'grantextension';
534             if ($this->process_save_extension($mform)) {
535                 $action = 'redirect';
536                 $nextpageparams['action'] = 'grading';
537             }
538         } else if ($action == 'revealidentitiesconfirm') {
539             $this->process_reveal_identities();
540             $action = 'redirect';
541             $nextpageparams['action'] = 'grading';
542         }
544         $returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT),
545                               'useridlistid' => optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM));
546         $this->register_return_link($action, $returnparams);
548         // Include any page action as part of the body tag CSS id.
549         if (!empty($action)) {
550             $PAGE->set_pagetype('mod-assign-' . $action);
551         }
552         // Now show the right view page.
553         if ($action == 'redirect') {
554             $nextpageurl = new moodle_url('/mod/assign/view.php', $nextpageparams);
555             redirect($nextpageurl);
556             return;
557         } else if ($action == 'savegradingresult') {
558             $message = get_string('gradingchangessaved', 'assign');
559             $o .= $this->view_savegrading_result($message);
560         } else if ($action == 'quickgradingresult') {
561             $mform = null;
562             $o .= $this->view_quickgrading_result($message);
563         } else if ($action == 'gradingpanel') {
564             $o .= $this->view_single_grading_panel($args);
565         } else if ($action == 'grade') {
566             $o .= $this->view_single_grade_page($mform);
567         } else if ($action == 'viewpluginassignfeedback') {
568             $o .= $this->view_plugin_content('assignfeedback');
569         } else if ($action == 'viewpluginassignsubmission') {
570             $o .= $this->view_plugin_content('assignsubmission');
571         } else if ($action == 'editsubmission') {
572             $o .= $this->view_edit_submission_page($mform, $notices);
573         } else if ($action == 'grader') {
574             $o .= $this->view_grader();
575         } else if ($action == 'grading') {
576             $o .= $this->view_grading_page();
577         } else if ($action == 'downloadall') {
578             $o .= $this->download_submissions();
579         } else if ($action == 'submit') {
580             $o .= $this->check_submit_for_grading($mform);
581         } else if ($action == 'grantextension') {
582             $o .= $this->view_grant_extension($mform);
583         } else if ($action == 'revealidentities') {
584             $o .= $this->view_reveal_identities_confirm($mform);
585         } else if ($action == 'plugingradingbatchoperation') {
586             $o .= $this->view_plugin_grading_batch_operation($mform);
587         } else if ($action == 'viewpluginpage') {
588              $o .= $this->view_plugin_page();
589         } else if ($action == 'viewcourseindex') {
590              $o .= $this->view_course_index();
591         } else if ($action == 'viewbatchsetmarkingworkflowstate') {
592              $o .= $this->view_batch_set_workflow_state($mform);
593         } else if ($action == 'viewbatchmarkingallocation') {
594             $o .= $this->view_batch_markingallocation($mform);
595         } else if ($action == 'viewsubmitforgradingerror') {
596             $o .= $this->view_error_page(get_string('submitforgrading', 'assign'), $notices);
597         } else {
598             $o .= $this->view_submission_page();
599         }
601         return $o;
602     }
604     /**
605      * Add this instance to the database.
606      *
607      * @param stdClass $formdata The data submitted from the form
608      * @param bool $callplugins This is used to skip the plugin code
609      *             when upgrading an old assignment to a new one (the plugins get called manually)
610      * @return mixed false if an error occurs or the int id of the new instance
611      */
612     public function add_instance(stdClass $formdata, $callplugins) {
613         global $DB;
614         $adminconfig = $this->get_admin_config();
616         $err = '';
618         // Add the database record.
619         $update = new stdClass();
620         $update->name = $formdata->name;
621         $update->timemodified = time();
622         $update->timecreated = time();
623         $update->course = $formdata->course;
624         $update->courseid = $formdata->course;
625         $update->intro = $formdata->intro;
626         $update->introformat = $formdata->introformat;
627         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
628         $update->submissiondrafts = $formdata->submissiondrafts;
629         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
630         $update->sendnotifications = $formdata->sendnotifications;
631         $update->sendlatenotifications = $formdata->sendlatenotifications;
632         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
633         if (isset($formdata->sendstudentnotifications)) {
634             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
635         }
636         $update->duedate = $formdata->duedate;
637         $update->cutoffdate = $formdata->cutoffdate;
638         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
639         $update->grade = $formdata->grade;
640         $update->completionsubmit = !empty($formdata->completionsubmit);
641         $update->teamsubmission = $formdata->teamsubmission;
642         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
643         if (isset($formdata->teamsubmissiongroupingid)) {
644             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
645         }
646         $update->blindmarking = $formdata->blindmarking;
647         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
648         if (!empty($formdata->attemptreopenmethod)) {
649             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
650         }
651         if (!empty($formdata->maxattempts)) {
652             $update->maxattempts = $formdata->maxattempts;
653         }
654         if (isset($formdata->preventsubmissionnotingroup)) {
655             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
656         }
657         $update->markingworkflow = $formdata->markingworkflow;
658         $update->markingallocation = $formdata->markingallocation;
659         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
660             $update->markingallocation = 0;
661         }
663         $returnid = $DB->insert_record('assign', $update);
664         $this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
665         // Cache the course record.
666         $this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
668         $this->save_intro_draft_files($formdata);
670         if ($callplugins) {
671             // Call save_settings hook for submission plugins.
672             foreach ($this->submissionplugins as $plugin) {
673                 if (!$this->update_plugin_instance($plugin, $formdata)) {
674                     print_error($plugin->get_error());
675                     return false;
676                 }
677             }
678             foreach ($this->feedbackplugins as $plugin) {
679                 if (!$this->update_plugin_instance($plugin, $formdata)) {
680                     print_error($plugin->get_error());
681                     return false;
682                 }
683             }
685             // In the case of upgrades the coursemodule has not been set,
686             // so we need to wait before calling these two.
687             $this->update_calendar($formdata->coursemodule);
688             $this->update_gradebook(false, $formdata->coursemodule);
690         }
692         $update = new stdClass();
693         $update->id = $this->get_instance()->id;
694         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
695         $DB->update_record('assign', $update);
697         return $returnid;
698     }
700     /**
701      * Delete all grades from the gradebook for this assignment.
702      *
703      * @return bool
704      */
705     protected function delete_grades() {
706         global $CFG;
708         $result = grade_update('mod/assign',
709                                $this->get_course()->id,
710                                'mod',
711                                'assign',
712                                $this->get_instance()->id,
713                                0,
714                                null,
715                                array('deleted'=>1));
716         return $result == GRADE_UPDATE_OK;
717     }
719     /**
720      * Delete this instance from the database.
721      *
722      * @return bool false if an error occurs
723      */
724     public function delete_instance() {
725         global $DB;
726         $result = true;
728         foreach ($this->submissionplugins as $plugin) {
729             if (!$plugin->delete_instance()) {
730                 print_error($plugin->get_error());
731                 $result = false;
732             }
733         }
734         foreach ($this->feedbackplugins as $plugin) {
735             if (!$plugin->delete_instance()) {
736                 print_error($plugin->get_error());
737                 $result = false;
738             }
739         }
741         // Delete files associated with this assignment.
742         $fs = get_file_storage();
743         if (! $fs->delete_area_files($this->context->id) ) {
744             $result = false;
745         }
747         $this->delete_all_overrides();
749         // Delete_records will throw an exception if it fails - so no need for error checking here.
750         $DB->delete_records('assign_submission', array('assignment' => $this->get_instance()->id));
751         $DB->delete_records('assign_grades', array('assignment' => $this->get_instance()->id));
752         $DB->delete_records('assign_plugin_config', array('assignment' => $this->get_instance()->id));
753         $DB->delete_records('assign_user_flags', array('assignment' => $this->get_instance()->id));
754         $DB->delete_records('assign_user_mapping', array('assignment' => $this->get_instance()->id));
756         // Delete items from the gradebook.
757         if (! $this->delete_grades()) {
758             $result = false;
759         }
761         // Delete the instance.
762         $DB->delete_records('assign', array('id'=>$this->get_instance()->id));
764         return $result;
765     }
767     /**
768      * Deletes a assign override from the database and clears any corresponding calendar events
769      *
770      * @param int $overrideid The id of the override being deleted
771      * @return bool true on success
772      */
773     public function delete_override($overrideid) {
774         global $CFG, $DB;
776         require_once($CFG->dirroot . '/calendar/lib.php');
778         $cm = get_coursemodule_from_instance('assign', $this->get_context()->id, $this->get_context()->course);
780         $override = $DB->get_record('assign_overrides', array('id' => $overrideid), '*', MUST_EXIST);
782         // Delete the events.
783         $conds = array('modulename' => 'assign',
784             'instance' => $this->get_context()->id);
785         if (isset($override->userid)) {
786             $conds['userid'] = $override->userid;
787         } else {
788             $conds['groupid'] = $override->groupid;
789         }
790         $events = $DB->get_records('event', $conds);
791         foreach ($events as $event) {
792             $eventold = calendar_event::load($event);
793             $eventold->delete();
794         }
796         $DB->delete_records('assign_overrides', array('id' => $overrideid));
798         // Set the common parameters for one of the events we will be triggering.
799         $params = array(
800             'objectid' => $override->id,
801             'context' => context_module::instance($cm->id),
802             'other' => array(
803                 'assignid' => $override->assignid
804             )
805         );
806         // Determine which override deleted event to fire.
807         if (!empty($override->userid)) {
808             $params['relateduserid'] = $override->userid;
809             $event = \mod_assign\event\user_override_deleted::create($params);
810         } else {
811             $params['other']['groupid'] = $override->groupid;
812             $event = \mod_assign\event\group_override_deleted::create($params);
813         }
815         // Trigger the override deleted event.
816         $event->add_record_snapshot('assign_overrides', $override);
817         $event->trigger();
819         return true;
820     }
822     /**
823      * Deletes all assign overrides from the database and clears any corresponding calendar events
824      */
825     public function delete_all_overrides() {
826         global $DB;
828         $overrides = $DB->get_records('assign_overrides', array('assignid' => $this->get_context()->id), 'id');
829         foreach ($overrides as $override) {
830             $this->delete_override($override->id);
831         }
832     }
834     /**
835      * Updates the assign properties with override information for a user.
836      *
837      * Algorithm:  For each assign setting, if there is a matching user-specific override,
838      *   then use that otherwise, if there are group-specific overrides, return the most
839      *   lenient combination of them.  If neither applies, leave the assign setting unchanged.
840      *
841      * @param int $userid The userid.
842      */
843     public function update_effective_access($userid) {
845         $override = $this->override_exists($userid);
847         // Merge with assign defaults.
848         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
849         foreach ($keys as $key) {
850             if (isset($override->{$key})) {
851                 $this->get_instance()->{$key} = $override->{$key};
852             }
853         }
855     }
857     /**
858      * Returns whether an assign has any overrides.
859      *
860      * @return true if any, false if not
861      */
862     public function has_overrides() {
863         global $DB;
865         $override = $DB->record_exists('assign_overrides', array('assignid' => $this->get_instance()->id));
867         if ($override) {
868             return true;
869         }
871         return false;
872     }
874     /**
875      * Returns user override
876      *
877      * Algorithm:  For each assign setting, if there is a matching user-specific override,
878      *   then use that otherwise, if there are group-specific overrides, return the most
879      *   lenient combination of them.  If neither applies, leave the assign setting unchanged.
880      *
881      * @param int $userid The userid.
882      * @return override  if exist
883      */
884     public function override_exists($userid) {
885         global $DB;
887         // Check for user override.
888         $override = $DB->get_record('assign_overrides', array('assignid' => $this->get_instance()->id, 'userid' => $userid));
890         if (!$override) {
891             $override = new stdClass();
892             $override->duedate = null;
893             $override->cutoffdate = null;
894             $override->allowsubmissionsfromdate = null;
895         }
897         // Check for group overrides.
898         $groupings = groups_get_user_groups($this->get_instance()->course, $userid);
900         if (!empty($groupings[0])) {
901             // Select all overrides that apply to the User's groups.
902             list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
903             $sql = "SELECT * FROM {assign_overrides}
904                     WHERE groupid $extra AND assignid = ?";
905             $params[] = $this->get_instance()->id;
906             $records = $DB->get_records_sql($sql, $params);
908             // Combine the overrides.
909             $duedates = array();
910             $cutoffdates = array();
911             $allowsubmissionsfromdates = array();
913             foreach ($records as $gpoverride) {
914                 if (isset($gpoverride->duedate)) {
915                     $duedates[] = $gpoverride->duedate;
916                 }
917                 if (isset($gpoverride->cutoffdate)) {
918                     $cutoffdates[] = $gpoverride->cutoffdate;
919                 }
920                 if (isset($gpoverride->allowsubmissionsfromdate)) {
921                     $allowsubmissionsfromdates[] = $gpoverride->allowsubmissionsfromdate;
922                 }
923             }
924             // If there is a user override for a setting, ignore the group override.
925             if (is_null($override->allowsubmissionsfromdate) && count($allowsubmissionsfromdates)) {
926                 $override->allowsubmissionsfromdate = min($allowsubmissionsfromdates);
927             }
928             if (is_null($override->cutoffdate) && count($cutoffdates)) {
929                 if (in_array(0, $cutoffdates)) {
930                     $override->cutoffdate = 0;
931                 } else {
932                     $override->cutoffdate = max($cutoffdates);
933                 }
934             }
935             if (is_null($override->duedate) && count($duedates)) {
936                 if (in_array(0, $duedates)) {
937                     $override->duedate = 0;
938                 } else {
939                     $override->duedate = max($duedates);
940                 }
941             }
943         }
945         return $override;
946     }
948     /**
949      * Actual implementation of the reset course functionality, delete all the
950      * assignment submissions for course $data->courseid.
951      *
952      * @param stdClass $data the data submitted from the reset course.
953      * @return array status array
954      */
955     public function reset_userdata($data) {
956         global $CFG, $DB;
958         $componentstr = get_string('modulenameplural', 'assign');
959         $status = array();
961         $fs = get_file_storage();
962         if (!empty($data->reset_assign_submissions)) {
963             // Delete files associated with this assignment.
964             foreach ($this->submissionplugins as $plugin) {
965                 $fileareas = array();
966                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
967                 $fileareas = $plugin->get_file_areas();
968                 foreach ($fileareas as $filearea => $notused) {
969                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
970                 }
972                 if (!$plugin->delete_instance()) {
973                     $status[] = array('component'=>$componentstr,
974                                       'item'=>get_string('deleteallsubmissions', 'assign'),
975                                       'error'=>$plugin->get_error());
976                 }
977             }
979             foreach ($this->feedbackplugins as $plugin) {
980                 $fileareas = array();
981                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
982                 $fileareas = $plugin->get_file_areas();
983                 foreach ($fileareas as $filearea => $notused) {
984                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
985                 }
987                 if (!$plugin->delete_instance()) {
988                     $status[] = array('component'=>$componentstr,
989                                       'item'=>get_string('deleteallsubmissions', 'assign'),
990                                       'error'=>$plugin->get_error());
991                 }
992             }
994             $assignids = $DB->get_records('assign', array('course' => $data->courseid), '', 'id');
995             list($sql, $params) = $DB->get_in_or_equal(array_keys($assignids));
997             $DB->delete_records_select('assign_submission', "assignment $sql", $params);
998             $DB->delete_records_select('assign_user_flags', "assignment $sql", $params);
1000             $status[] = array('component'=>$componentstr,
1001                               'item'=>get_string('deleteallsubmissions', 'assign'),
1002                               'error'=>false);
1004             if (!empty($data->reset_gradebook_grades)) {
1005                 $DB->delete_records_select('assign_grades', "assignment $sql", $params);
1006                 // Remove all grades from gradebook.
1007                 require_once($CFG->dirroot.'/mod/assign/lib.php');
1008                 assign_reset_gradebook($data->courseid);
1010                 // Reset revealidentities if both submissions and grades have been reset.
1011                 if ($this->get_instance()->blindmarking && $this->get_instance()->revealidentities) {
1012                     $DB->set_field('assign', 'revealidentities', 0, array('id' => $this->get_instance()->id));
1013                 }
1014             }
1015         }
1017         // Remove user overrides.
1018         if (!empty($data->reset_assign_user_overrides)) {
1019             $DB->delete_records_select('assign_overrides',
1020                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
1021             $status[] = array(
1022                 'component' => $componentstr,
1023                 'item' => get_string('useroverridesdeleted', 'assign'),
1024                 'error' => false);
1025         }
1026         // Remove group overrides.
1027         if (!empty($data->reset_assign_group_overrides)) {
1028             $DB->delete_records_select('assign_overrides',
1029                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
1030             $status[] = array(
1031                 'component' => $componentstr,
1032                 'item' => get_string('groupoverridesdeleted', 'assign'),
1033                 'error' => false);
1034         }
1036         // Updating dates - shift may be negative too.
1037         if ($data->timeshift) {
1038             $DB->execute("UPDATE {assign_overrides}
1039                          SET allowsubmissionsfromdate = allowsubmissionsfromdate + ?
1040                        WHERE assignid = ? AND allowsubmissionsfromdate <> 0",
1041                 array($data->timeshift, $this->get_instance()->id));
1042             $DB->execute("UPDATE {assign_overrides}
1043                          SET duedate = duedate + ?
1044                        WHERE assignid = ? AND duedate <> 0",
1045                 array($data->timeshift, $this->get_instance()->id));
1046             $DB->execute("UPDATE {assign_overrides}
1047                          SET cutoffdate = cutoffdate + ?
1048                        WHERE assignid =? AND cutoffdate <> 0",
1049                 array($data->timeshift, $this->get_instance()->id));
1051             shift_course_mod_dates('assign',
1052                                     array('duedate', 'allowsubmissionsfromdate', 'cutoffdate'),
1053                                     $data->timeshift,
1054                                     $data->courseid, $this->get_instance()->id);
1055             $status[] = array('component'=>$componentstr,
1056                               'item'=>get_string('datechanged'),
1057                               'error'=>false);
1058         }
1060         return $status;
1061     }
1063     /**
1064      * Update the settings for a single plugin.
1065      *
1066      * @param assign_plugin $plugin The plugin to update
1067      * @param stdClass $formdata The form data
1068      * @return bool false if an error occurs
1069      */
1070     protected function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
1071         if ($plugin->is_visible()) {
1072             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1073             if (!empty($formdata->$enabledname)) {
1074                 $plugin->enable();
1075                 if (!$plugin->save_settings($formdata)) {
1076                     print_error($plugin->get_error());
1077                     return false;
1078                 }
1079             } else {
1080                 $plugin->disable();
1081             }
1082         }
1083         return true;
1084     }
1086     /**
1087      * Update the gradebook information for this assignment.
1088      *
1089      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
1090      * @param int $coursemoduleid This is required because it might not exist in the database yet
1091      * @return bool
1092      */
1093     public function update_gradebook($reset, $coursemoduleid) {
1094         global $CFG;
1096         require_once($CFG->dirroot.'/mod/assign/lib.php');
1097         $assign = clone $this->get_instance();
1098         $assign->cmidnumber = $coursemoduleid;
1100         // Set assign gradebook feedback plugin status (enabled and visible).
1101         $assign->gradefeedbackenabled = $this->is_gradebook_feedback_enabled();
1103         $param = null;
1104         if ($reset) {
1105             $param = 'reset';
1106         }
1108         return assign_grade_item_update($assign, $param);
1109     }
1111     /**
1112      * Get the marking table page size
1113      *
1114      * @return integer
1115      */
1116     public function get_assign_perpage() {
1117         $perpage = (int) get_user_preferences('assign_perpage', 10);
1118         $adminconfig = $this->get_admin_config();
1119         $maxperpage = -1;
1120         if (isset($adminconfig->maxperpage)) {
1121             $maxperpage = $adminconfig->maxperpage;
1122         }
1123         if (isset($maxperpage) &&
1124             $maxperpage != -1 &&
1125             ($perpage == -1 || $perpage > $maxperpage)) {
1126             $perpage = $maxperpage;
1127         }
1128         return $perpage;
1129     }
1131     /**
1132      * Load and cache the admin config for this module.
1133      *
1134      * @return stdClass the plugin config
1135      */
1136     public function get_admin_config() {
1137         if ($this->adminconfig) {
1138             return $this->adminconfig;
1139         }
1140         $this->adminconfig = get_config('assign');
1141         return $this->adminconfig;
1142     }
1144     /**
1145      * Update the calendar entries for this assignment.
1146      *
1147      * @param int $coursemoduleid - Required to pass this in because it might
1148      *                              not exist in the database yet.
1149      * @return bool
1150      */
1151     public function update_calendar($coursemoduleid) {
1152         global $DB, $CFG;
1153         require_once($CFG->dirroot.'/calendar/lib.php');
1155         // Special case for add_instance as the coursemodule has not been set yet.
1156         $instance = $this->get_instance();
1158         $eventtype = 'due';
1160         if ($instance->duedate) {
1161             $event = new stdClass();
1163             $params = array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype);
1164             $event->id = $DB->get_field('event', 'id', $params);
1165             $event->name = $instance->name;
1166             $event->timestart = $instance->duedate;
1168             // Convert the links to pluginfile. It is a bit hacky but at this stage the files
1169             // might not have been saved in the module area yet.
1170             $intro = $instance->intro;
1171             if ($draftid = file_get_submitted_draft_itemid('introeditor')) {
1172                 $intro = file_rewrite_urls_to_pluginfile($intro, $draftid);
1173             }
1175             // We need to remove the links to files as the calendar is not ready
1176             // to support module events with file areas.
1177             $intro = strip_pluginfile_content($intro);
1178             if ($this->show_intro()) {
1179                 $event->description = array(
1180                     'text' => $intro,
1181                     'format' => $instance->introformat
1182                 );
1183             } else {
1184                 $event->description = array(
1185                     'text' => '',
1186                     'format' => $instance->introformat
1187                 );
1188             }
1190             if ($event->id) {
1191                 $calendarevent = calendar_event::load($event->id);
1192                 $calendarevent->update($event);
1193             } else {
1194                 unset($event->id);
1195                 $event->courseid    = $instance->course;
1196                 $event->groupid     = 0;
1197                 $event->userid      = 0;
1198                 $event->modulename  = 'assign';
1199                 $event->instance    = $instance->id;
1200                 $event->eventtype   = $eventtype;
1201                 $event->timeduration = 0;
1202                 calendar_event::create($event);
1203             }
1204         } else {
1205             $DB->delete_records('event', array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype));
1206         }
1207     }
1210     /**
1211      * Update this instance in the database.
1212      *
1213      * @param stdClass $formdata - the data submitted from the form
1214      * @return bool false if an error occurs
1215      */
1216     public function update_instance($formdata) {
1217         global $DB;
1218         $adminconfig = $this->get_admin_config();
1220         $update = new stdClass();
1221         $update->id = $formdata->instance;
1222         $update->name = $formdata->name;
1223         $update->timemodified = time();
1224         $update->course = $formdata->course;
1225         $update->intro = $formdata->intro;
1226         $update->introformat = $formdata->introformat;
1227         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
1228         $update->submissiondrafts = $formdata->submissiondrafts;
1229         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
1230         $update->sendnotifications = $formdata->sendnotifications;
1231         $update->sendlatenotifications = $formdata->sendlatenotifications;
1232         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
1233         if (isset($formdata->sendstudentnotifications)) {
1234             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
1235         }
1236         $update->duedate = $formdata->duedate;
1237         $update->cutoffdate = $formdata->cutoffdate;
1238         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
1239         $update->grade = $formdata->grade;
1240         if (!empty($formdata->completionunlocked)) {
1241             $update->completionsubmit = !empty($formdata->completionsubmit);
1242         }
1243         $update->teamsubmission = $formdata->teamsubmission;
1244         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
1245         if (isset($formdata->teamsubmissiongroupingid)) {
1246             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
1247         }
1248         $update->blindmarking = $formdata->blindmarking;
1249         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
1250         if (!empty($formdata->attemptreopenmethod)) {
1251             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
1252         }
1253         if (!empty($formdata->maxattempts)) {
1254             $update->maxattempts = $formdata->maxattempts;
1255         }
1256         if (isset($formdata->preventsubmissionnotingroup)) {
1257             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
1258         }
1259         $update->markingworkflow = $formdata->markingworkflow;
1260         $update->markingallocation = $formdata->markingallocation;
1261         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
1262             $update->markingallocation = 0;
1263         }
1265         $result = $DB->update_record('assign', $update);
1266         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
1268         $this->save_intro_draft_files($formdata);
1270         // Load the assignment so the plugins have access to it.
1272         // Call save_settings hook for submission plugins.
1273         foreach ($this->submissionplugins as $plugin) {
1274             if (!$this->update_plugin_instance($plugin, $formdata)) {
1275                 print_error($plugin->get_error());
1276                 return false;
1277             }
1278         }
1279         foreach ($this->feedbackplugins as $plugin) {
1280             if (!$this->update_plugin_instance($plugin, $formdata)) {
1281                 print_error($plugin->get_error());
1282                 return false;
1283             }
1284         }
1286         $this->update_calendar($this->get_course_module()->id);
1287         $this->update_gradebook(false, $this->get_course_module()->id);
1289         $update = new stdClass();
1290         $update->id = $this->get_instance()->id;
1291         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
1292         $DB->update_record('assign', $update);
1294         return $result;
1295     }
1297     /**
1298      * Save the attachments in the draft areas.
1299      *
1300      * @param stdClass $formdata
1301      */
1302     protected function save_intro_draft_files($formdata) {
1303         if (isset($formdata->introattachments)) {
1304             file_save_draft_area_files($formdata->introattachments, $this->get_context()->id,
1305                                        'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA, 0);
1306         }
1307     }
1309     /**
1310      * Add elements in grading plugin form.
1311      *
1312      * @param mixed $grade stdClass|null
1313      * @param MoodleQuickForm $mform
1314      * @param stdClass $data
1315      * @param int $userid - The userid we are grading
1316      * @return void
1317      */
1318     protected function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
1319         foreach ($this->feedbackplugins as $plugin) {
1320             if ($plugin->is_enabled() && $plugin->is_visible()) {
1321                 $plugin->get_form_elements_for_user($grade, $mform, $data, $userid);
1322             }
1323         }
1324     }
1328     /**
1329      * Add one plugins settings to edit plugin form.
1330      *
1331      * @param assign_plugin $plugin The plugin to add the settings from
1332      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1333      *                               This form is modified directly (not returned).
1334      * @param array $pluginsenabled A list of form elements to be added to a group.
1335      *                              The new element is added to this array by this function.
1336      * @return void
1337      */
1338     protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) {
1339         global $CFG;
1340         if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) {
1341             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1342             $pluginsenabled[] = $mform->createElement('hidden', $name, 1);
1343             $mform->setType($name, PARAM_BOOL);
1344             $plugin->get_settings($mform);
1345         } else if ($plugin->is_visible() && $plugin->is_configurable()) {
1346             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1347             $label = $plugin->get_name();
1348             $label .= ' ' . $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
1349             $pluginsenabled[] = $mform->createElement('checkbox', $name, '', $label);
1351             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
1352             if ($plugin->get_config('enabled') !== false) {
1353                 $default = $plugin->is_enabled();
1354             }
1355             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
1357             $plugin->get_settings($mform);
1359         }
1360     }
1362     /**
1363      * Add settings to edit plugin form.
1364      *
1365      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1366      *                               This form is modified directly (not returned).
1367      * @return void
1368      */
1369     public function add_all_plugin_settings(MoodleQuickForm $mform) {
1370         $mform->addElement('header', 'submissiontypes', get_string('submissiontypes', 'assign'));
1372         $submissionpluginsenabled = array();
1373         $group = $mform->addGroup(array(), 'submissionplugins', get_string('submissiontypes', 'assign'), array(' '), false);
1374         foreach ($this->submissionplugins as $plugin) {
1375             $this->add_plugin_settings($plugin, $mform, $submissionpluginsenabled);
1376         }
1377         $group->setElements($submissionpluginsenabled);
1379         $mform->addElement('header', 'feedbacktypes', get_string('feedbacktypes', 'assign'));
1380         $feedbackpluginsenabled = array();
1381         $group = $mform->addGroup(array(), 'feedbackplugins', get_string('feedbacktypes', 'assign'), array(' '), false);
1382         foreach ($this->feedbackplugins as $plugin) {
1383             $this->add_plugin_settings($plugin, $mform, $feedbackpluginsenabled);
1384         }
1385         $group->setElements($feedbackpluginsenabled);
1386         $mform->setExpanded('submissiontypes');
1387     }
1389     /**
1390      * Allow each plugin an opportunity to update the defaultvalues
1391      * passed in to the settings form (needed to set up draft areas for
1392      * editor and filemanager elements)
1393      *
1394      * @param array $defaultvalues
1395      */
1396     public function plugin_data_preprocessing(&$defaultvalues) {
1397         foreach ($this->submissionplugins as $plugin) {
1398             if ($plugin->is_visible()) {
1399                 $plugin->data_preprocessing($defaultvalues);
1400             }
1401         }
1402         foreach ($this->feedbackplugins as $plugin) {
1403             if ($plugin->is_visible()) {
1404                 $plugin->data_preprocessing($defaultvalues);
1405             }
1406         }
1407     }
1409     /**
1410      * Get the name of the current module.
1411      *
1412      * @return string the module name (Assignment)
1413      */
1414     protected function get_module_name() {
1415         if (isset(self::$modulename)) {
1416             return self::$modulename;
1417         }
1418         self::$modulename = get_string('modulename', 'assign');
1419         return self::$modulename;
1420     }
1422     /**
1423      * Get the plural name of the current module.
1424      *
1425      * @return string the module name plural (Assignments)
1426      */
1427     protected function get_module_name_plural() {
1428         if (isset(self::$modulenameplural)) {
1429             return self::$modulenameplural;
1430         }
1431         self::$modulenameplural = get_string('modulenameplural', 'assign');
1432         return self::$modulenameplural;
1433     }
1435     /**
1436      * Has this assignment been constructed from an instance?
1437      *
1438      * @return bool
1439      */
1440     public function has_instance() {
1441         return $this->instance || $this->get_course_module();
1442     }
1444     /**
1445      * Get the settings for the current instance of this assignment
1446      *
1447      * @return stdClass The settings
1448      */
1449     public function get_instance() {
1450         global $DB;
1451         if ($this->instance) {
1452             return $this->instance;
1453         }
1454         if ($this->get_course_module()) {
1455             $params = array('id' => $this->get_course_module()->instance);
1456             $this->instance = $DB->get_record('assign', $params, '*', MUST_EXIST);
1457         }
1458         if (!$this->instance) {
1459             throw new coding_exception('Improper use of the assignment class. ' .
1460                                        'Cannot load the assignment record.');
1461         }
1462         return $this->instance;
1463     }
1465     /**
1466      * Get the primary grade item for this assign instance.
1467      *
1468      * @return grade_item The grade_item record
1469      */
1470     public function get_grade_item() {
1471         if ($this->gradeitem) {
1472             return $this->gradeitem;
1473         }
1474         $instance = $this->get_instance();
1475         $params = array('itemtype' => 'mod',
1476                         'itemmodule' => 'assign',
1477                         'iteminstance' => $instance->id,
1478                         'courseid' => $instance->course,
1479                         'itemnumber' => 0);
1480         $this->gradeitem = grade_item::fetch($params);
1481         if (!$this->gradeitem) {
1482             throw new coding_exception('Improper use of the assignment class. ' .
1483                                        'Cannot load the grade item.');
1484         }
1485         return $this->gradeitem;
1486     }
1488     /**
1489      * Get the context of the current course.
1490      *
1491      * @return mixed context|null The course context
1492      */
1493     public function get_course_context() {
1494         if (!$this->context && !$this->course) {
1495             throw new coding_exception('Improper use of the assignment class. ' .
1496                                        'Cannot load the course context.');
1497         }
1498         if ($this->context) {
1499             return $this->context->get_course_context();
1500         } else {
1501             return context_course::instance($this->course->id);
1502         }
1503     }
1506     /**
1507      * Get the current course module.
1508      *
1509      * @return cm_info|null The course module or null if not known
1510      */
1511     public function get_course_module() {
1512         if ($this->coursemodule) {
1513             return $this->coursemodule;
1514         }
1515         if (!$this->context) {
1516             return null;
1517         }
1519         if ($this->context->contextlevel == CONTEXT_MODULE) {
1520             $modinfo = get_fast_modinfo($this->get_course());
1521             $this->coursemodule = $modinfo->get_cm($this->context->instanceid);
1522             return $this->coursemodule;
1523         }
1524         return null;
1525     }
1527     /**
1528      * Get context module.
1529      *
1530      * @return context
1531      */
1532     public function get_context() {
1533         return $this->context;
1534     }
1536     /**
1537      * Get the current course.
1538      *
1539      * @return mixed stdClass|null The course
1540      */
1541     public function get_course() {
1542         global $DB;
1544         if ($this->course) {
1545             return $this->course;
1546         }
1548         if (!$this->context) {
1549             return null;
1550         }
1551         $params = array('id' => $this->get_course_context()->instanceid);
1552         $this->course = $DB->get_record('course', $params, '*', MUST_EXIST);
1554         return $this->course;
1555     }
1557     /**
1558      * Count the number of intro attachments.
1559      *
1560      * @return int
1561      */
1562     protected function count_attachments() {
1564         $fs = get_file_storage();
1565         $files = $fs->get_area_files($this->get_context()->id, 'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA,
1566                         0, 'id', false);
1568         return count($files);
1569     }
1571     /**
1572      * Are there any intro attachments to display?
1573      *
1574      * @return boolean
1575      */
1576     protected function has_visible_attachments() {
1577         return ($this->count_attachments() > 0);
1578     }
1580     /**
1581      * Return a grade in user-friendly form, whether it's a scale or not.
1582      *
1583      * @param mixed $grade int|null
1584      * @param boolean $editing Are we allowing changes to this grade?
1585      * @param int $userid The user id the grade belongs to
1586      * @param int $modified Timestamp from when the grade was last modified
1587      * @return string User-friendly representation of grade
1588      */
1589     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1590         global $DB;
1592         static $scalegrades = array();
1594         $o = '';
1596         if ($this->get_instance()->grade >= 0) {
1597             // Normal number.
1598             if ($editing && $this->get_instance()->grade > 0) {
1599                 if ($grade < 0) {
1600                     $displaygrade = '';
1601                 } else {
1602                     $displaygrade = format_float($grade, $this->get_grade_item()->get_decimals());
1603                 }
1604                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' .
1605                        get_string('usergrade', 'assign') .
1606                        '</label>';
1607                 $o .= '<input type="text"
1608                               id="quickgrade_' . $userid . '"
1609                               name="quickgrade_' . $userid . '"
1610                               value="' .  $displaygrade . '"
1611                               size="6"
1612                               maxlength="10"
1613                               class="quickgrade"/>';
1614                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $this->get_grade_item()->get_decimals());
1615                 return $o;
1616             } else {
1617                 if ($grade == -1 || $grade === null) {
1618                     $o .= '-';
1619                 } else {
1620                     $item = $this->get_grade_item();
1621                     $o .= grade_format_gradevalue($grade, $item);
1622                     if ($item->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) {
1623                         // If displaying the raw grade, also display the total value.
1624                         $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $item->get_decimals());
1625                     }
1626                 }
1627                 return $o;
1628             }
1630         } else {
1631             // Scale.
1632             if (empty($this->cache['scale'])) {
1633                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1634                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1635                 } else {
1636                     $o .= '-';
1637                     return $o;
1638                 }
1639             }
1640             if ($editing) {
1641                 $o .= '<label class="accesshide"
1642                               for="quickgrade_' . $userid . '">' .
1643                       get_string('usergrade', 'assign') .
1644                       '</label>';
1645                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1646                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1647                 foreach ($this->cache['scale'] as $optionid => $option) {
1648                     $selected = '';
1649                     if ($grade == $optionid) {
1650                         $selected = 'selected="selected"';
1651                     }
1652                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1653                 }
1654                 $o .= '</select>';
1655                 return $o;
1656             } else {
1657                 $scaleid = (int)$grade;
1658                 if (isset($this->cache['scale'][$scaleid])) {
1659                     $o .= $this->cache['scale'][$scaleid];
1660                     return $o;
1661                 }
1662                 $o .= '-';
1663                 return $o;
1664             }
1665         }
1666     }
1668     /**
1669      * Get the submission status/grading status for all submissions in this assignment for the
1670      * given paticipants.
1671      *
1672      * These statuses match the available filters (requiregrading, submitted, notsubmitted, grantedextension).
1673      * If this is a group assignment, group info is also returned.
1674      *
1675      * @param array $participants an associative array where the key is the participant id and
1676      *                            the value is the participant record.
1677      * @return array an associative array where the key is the participant id and the value is
1678      *               the participant record.
1679      */
1680     private function get_submission_info_for_participants($participants) {
1681         global $DB;
1683         if (empty($participants)) {
1684             return $participants;
1685         }
1687         list($insql, $params) = $DB->get_in_or_equal(array_keys($participants), SQL_PARAMS_NAMED);
1689         $assignid = $this->get_instance()->id;
1690         $params['assignmentid1'] = $assignid;
1691         $params['assignmentid2'] = $assignid;
1692         $params['assignmentid3'] = $assignid;
1694         $fields = 'SELECT u.id, s.status, s.timemodified AS stime, g.timemodified AS gtime, g.grade, uf.extensionduedate';
1695         $from = ' FROM {user} u
1696                          LEFT JOIN {assign_submission} s
1697                                 ON u.id = s.userid
1698                                AND s.assignment = :assignmentid1
1699                                AND s.latest = 1
1700                          LEFT JOIN {assign_grades} g
1701                                 ON u.id = g.userid
1702                                AND g.assignment = :assignmentid2
1703                                AND g.attemptnumber = s.attemptnumber
1704                          LEFT JOIN {assign_user_flags} uf
1705                                 ON u.id = uf.userid
1706                                AND uf.assignment = :assignmentid3
1707             ';
1708         $where = ' WHERE u.id ' . $insql;
1710         if (!empty($this->get_instance()->blindmarking)) {
1711             $from .= 'LEFT JOIN {assign_user_mapping} um
1712                              ON u.id = um.userid
1713                             AND um.assignment = :assignmentid4 ';
1714             $params['assignmentid4'] = $assignid;
1715             $fields .= ', um.id as recordid ';
1716         }
1718         $sql = "$fields $from $where";
1720         $records = $DB->get_records_sql($sql, $params);
1722         if ($this->get_instance()->teamsubmission) {
1723             // Get all groups.
1724             $allgroups = groups_get_all_groups($this->get_course()->id,
1725                                                array_keys($participants),
1726                                                $this->get_instance()->teamsubmissiongroupingid,
1727                                                'DISTINCT g.id, g.name');
1729         }
1730         foreach ($participants as $userid => $participant) {
1731             $participants[$userid]->fullname = $this->fullname($participant);
1732             $participants[$userid]->submitted = false;
1733             $participants[$userid]->requiregrading = false;
1734             $participants[$userid]->grantedextension = false;
1735         }
1737         foreach ($records as $userid => $submissioninfo) {
1738             // These filters are 100% the same as the ones in the grading table SQL.
1739             $submitted = false;
1740             $requiregrading = false;
1741             $grantedextension = false;
1743             if (!empty($submissioninfo->stime) && $submissioninfo->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
1744                 $submitted = true;
1745             }
1747             if ($submitted && ($submissioninfo->stime >= $submissioninfo->gtime ||
1748                     empty($submissioninfo->gtime) ||
1749                     $submissioninfo->grade === null)) {
1750                 $requiregrading = true;
1751             }
1753             if (!empty($submissioninfo->extensionduedate)) {
1754                 $grantedextension = true;
1755             }
1757             $participants[$userid]->submitted = $submitted;
1758             $participants[$userid]->requiregrading = $requiregrading;
1759             $participants[$userid]->grantedextension = $grantedextension;
1760             if ($this->get_instance()->teamsubmission) {
1761                 $group = $this->get_submission_group($userid);
1762                 if ($group) {
1763                     $participants[$userid]->groupid = $group->id;
1764                     $participants[$userid]->groupname = $group->name;
1765                 }
1766             }
1767         }
1768         return $participants;
1769     }
1771     /**
1772      * Get the submission status/grading status for all submissions in this assignment.
1773      * These statuses match the available filters (requiregrading, submitted, notsubmitted, grantedextension).
1774      * If this is a group assignment, group info is also returned.
1775      *
1776      * @param int $currentgroup
1777      * @return array List of user records with extra fields 'submitted', 'notsubmitted', 'requiregrading', 'grantedextension',
1778      *               'groupid', 'groupname'
1779      */
1780     public function list_participants_with_filter_status_and_group($currentgroup) {
1781         $participants = $this->list_participants($currentgroup, false);
1783         if (empty($participants)) {
1784             return $participants;
1785         } else {
1786             return $this->get_submission_info_for_participants($participants);
1787         }
1788     }
1790     /**
1791      * Load a list of users enrolled in the current course with the specified permission and group.
1792      * 0 for no group.
1793      *
1794      * @param int $currentgroup
1795      * @param bool $idsonly
1796      * @return array List of user records
1797      */
1798     public function list_participants($currentgroup, $idsonly) {
1799         global $DB, $USER;
1801         if (empty($currentgroup)) {
1802             $currentgroup = 0;
1803         }
1805         $key = $this->context->id . '-' . $currentgroup . '-' . $this->show_only_active_users();
1806         if (!isset($this->participants[$key])) {
1807             list($esql, $params) = get_enrolled_sql($this->context, 'mod/assign:submit', $currentgroup,
1808                     $this->show_only_active_users());
1810             $fields = 'u.*';
1811             $orderby = 'u.lastname, u.firstname, u.id';
1812             $additionaljoins = '';
1813             $additionalfilters = '';
1814             $instance = $this->get_instance();
1815             if (!empty($instance->blindmarking)) {
1816                 $additionaljoins .= " LEFT JOIN {assign_user_mapping} um
1817                                   ON u.id = um.userid
1818                                  AND um.assignment = :assignmentid1
1819                            LEFT JOIN {assign_submission} s
1820                                   ON u.id = s.userid
1821                                  AND s.assignment = :assignmentid2
1822                                  AND s.latest = 1
1823                         ";
1824                 $params['assignmentid1'] = (int) $instance->id;
1825                 $params['assignmentid2'] = (int) $instance->id;
1826                 $fields .= ', um.id as recordid ';
1828                 // Sort by submission time first, then by um.id to sort reliably by the blind marking id.
1829                 // Note, different DBs have different ordering of NULL values.
1830                 // Therefore we coalesce the current time into the timecreated field, and the max possible integer into
1831                 // the ID field.
1832                 $orderby = "COALESCE(s.timecreated, " . time() . ") ASC, COALESCE(s.id, " . PHP_INT_MAX . ") ASC, um.id ASC";
1833             }
1835             if ($instance->markingworkflow &&
1836                     $instance->markingallocation &&
1837                     !has_capability('mod/assign:manageallocations', $this->get_context())) {
1839                 $additionaljoins .= ' LEFT JOIN {assign_user_flags} uf
1840                                      ON u.id = uf.userid
1841                                      AND uf.assignment = :assignmentid3';
1843                 $params['assignmentid3'] = (int) $instance->id;
1845                 $additionalfilters .= ' AND uf.allocatedmarker = :markerid';
1846                 $params['markerid'] = $USER->id;
1847             }
1849             $sql = "SELECT $fields
1850                       FROM {user} u
1851                       JOIN ($esql) je ON je.id = u.id
1852                            $additionaljoins
1853                      WHERE u.deleted = 0
1854                            $additionalfilters
1855                   ORDER BY $orderby";
1857             $users = $DB->get_records_sql($sql, $params);
1859             $cm = $this->get_course_module();
1860             $info = new \core_availability\info_module($cm);
1861             $users = $info->filter_user_list($users);
1863             $this->participants[$key] = $users;
1864         }
1866         if ($idsonly) {
1867             $idslist = array();
1868             foreach ($this->participants[$key] as $id => $user) {
1869                 $idslist[$id] = new stdClass();
1870                 $idslist[$id]->id = $id;
1871             }
1872             return $idslist;
1873         }
1874         return $this->participants[$key];
1875     }
1877     /**
1878      * Load a user if they are enrolled in the current course. Populated with submission
1879      * status for this assignment.
1880      *
1881      * @param int $userid
1882      * @return null|stdClass user record
1883      */
1884     public function get_participant($userid) {
1885         global $DB;
1887         $participant = $DB->get_record('user', array('id' => $userid));
1888         if (!$participant) {
1889             return null;
1890         }
1892         if (!is_enrolled($this->context, $participant, 'mod/assign:submit', $this->show_only_active_users())) {
1893             return null;
1894         }
1896         $result = $this->get_submission_info_for_participants(array($participant->id => $participant));
1897         return $result[$participant->id];
1898     }
1900     /**
1901      * Load a count of valid teams for this assignment.
1902      *
1903      * @param int $activitygroup Activity active group
1904      * @return int number of valid teams
1905      */
1906     public function count_teams($activitygroup = 0) {
1908         $count = 0;
1910         $participants = $this->list_participants($activitygroup, true);
1912         // If a team submission grouping id is provided all good as all returned groups
1913         // are the submission teams, but if no team submission grouping was specified
1914         // $groups will contain all participants groups.
1915         if ($this->get_instance()->teamsubmissiongroupingid) {
1917             // We restrict the users to the selected group ones.
1918             $groups = groups_get_all_groups($this->get_course()->id,
1919                                             array_keys($participants),
1920                                             $this->get_instance()->teamsubmissiongroupingid,
1921                                             'DISTINCT g.id, g.name');
1923             $count = count($groups);
1925             // When a specific group is selected we don't count the default group users.
1926             if ($activitygroup == 0) {
1927                 if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1928                     // See if there are any users in the default group.
1929                     $defaultusers = $this->get_submission_group_members(0, true);
1930                     if (count($defaultusers) > 0) {
1931                         $count += 1;
1932                     }
1933                 }
1934             } else if ($activitygroup != 0 && empty($groups)) {
1935                 // Set count to 1 if $groups returns empty.
1936                 // It means the group is not part of $this->get_instance()->teamsubmissiongroupingid.
1937                 $count = 1;
1938             }
1939         } else {
1940             // It is faster to loop around participants if no grouping was specified.
1941             $groups = array();
1942             foreach ($participants as $participant) {
1943                 if ($group = $this->get_submission_group($participant->id)) {
1944                     $groups[$group->id] = true;
1945                 } else if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1946                     $groups[0] = true;
1947                 }
1948             }
1950             $count = count($groups);
1951         }
1953         return $count;
1954     }
1956     /**
1957      * Load a count of active users enrolled in the current course with the specified permission and group.
1958      * 0 for no group.
1959      *
1960      * @param int $currentgroup
1961      * @return int number of matching users
1962      */
1963     public function count_participants($currentgroup) {
1964         return count($this->list_participants($currentgroup, true));
1965     }
1967     /**
1968      * Load a count of active users submissions in the current module that require grading
1969      * This means the submission modification time is more recent than the
1970      * grading modification time and the status is SUBMITTED.
1971      *
1972      * @return int number of matching submissions
1973      */
1974     public function count_submissions_need_grading() {
1975         global $DB;
1977         if ($this->get_instance()->teamsubmission) {
1978             // This does not make sense for group assignment because the submission is shared.
1979             return 0;
1980         }
1982         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1983         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1985         $params['assignid'] = $this->get_instance()->id;
1986         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1988         $sql = 'SELECT COUNT(s.userid)
1989                    FROM {assign_submission} s
1990                    LEFT JOIN {assign_grades} g ON
1991                         s.assignment = g.assignment AND
1992                         s.userid = g.userid AND
1993                         g.attemptnumber = s.attemptnumber
1994                    JOIN(' . $esql . ') e ON e.id = s.userid
1995                    WHERE
1996                         s.latest = 1 AND
1997                         s.assignment = :assignid AND
1998                         s.timemodified IS NOT NULL AND
1999                         s.status = :submitted AND
2000                         (s.timemodified >= g.timemodified OR g.timemodified IS NULL OR g.grade IS NULL)';
2002         return $DB->count_records_sql($sql, $params);
2003     }
2005     /**
2006      * Load a count of grades.
2007      *
2008      * @return int number of grades
2009      */
2010     public function count_grades() {
2011         global $DB;
2013         if (!$this->has_instance()) {
2014             return 0;
2015         }
2017         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2018         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2020         $params['assignid'] = $this->get_instance()->id;
2022         $sql = 'SELECT COUNT(g.userid)
2023                    FROM {assign_grades} g
2024                    JOIN(' . $esql . ') e ON e.id = g.userid
2025                    WHERE g.assignment = :assignid';
2027         return $DB->count_records_sql($sql, $params);
2028     }
2030     /**
2031      * Load a count of submissions.
2032      *
2033      * @param bool $includenew When true, also counts the submissions with status 'new'.
2034      * @return int number of submissions
2035      */
2036     public function count_submissions($includenew = false) {
2037         global $DB;
2039         if (!$this->has_instance()) {
2040             return 0;
2041         }
2043         $params = array();
2044         $sqlnew = '';
2046         if (!$includenew) {
2047             $sqlnew = ' AND s.status <> :status ';
2048             $params['status'] = ASSIGN_SUBMISSION_STATUS_NEW;
2049         }
2051         if ($this->get_instance()->teamsubmission) {
2052             // We cannot join on the enrolment tables for group submissions (no userid).
2053             $sql = 'SELECT COUNT(DISTINCT s.groupid)
2054                         FROM {assign_submission} s
2055                         WHERE
2056                             s.assignment = :assignid AND
2057                             s.timemodified IS NOT NULL AND
2058                             s.userid = :groupuserid' .
2059                             $sqlnew;
2061             $params['assignid'] = $this->get_instance()->id;
2062             $params['groupuserid'] = 0;
2063         } else {
2064             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2065             list($esql, $enrolparams) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2067             $params = array_merge($params, $enrolparams);
2068             $params['assignid'] = $this->get_instance()->id;
2070             $sql = 'SELECT COUNT(DISTINCT s.userid)
2071                        FROM {assign_submission} s
2072                        JOIN(' . $esql . ') e ON e.id = s.userid
2073                        WHERE
2074                             s.assignment = :assignid AND
2075                             s.timemodified IS NOT NULL ' .
2076                             $sqlnew;
2078         }
2080         return $DB->count_records_sql($sql, $params);
2081     }
2083     /**
2084      * Load a count of submissions with a specified status.
2085      *
2086      * @param string $status The submission status - should match one of the constants
2087      * @return int number of matching submissions
2088      */
2089     public function count_submissions_with_status($status) {
2090         global $DB;
2092         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2093         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2095         $params['assignid'] = $this->get_instance()->id;
2096         $params['assignid2'] = $this->get_instance()->id;
2097         $params['submissionstatus'] = $status;
2099         if ($this->get_instance()->teamsubmission) {
2101             $groupsstr = '';
2102             if ($currentgroup != 0) {
2103                 // If there is an active group we should only display the current group users groups.
2104                 $participants = $this->list_participants($currentgroup, true);
2105                 $groups = groups_get_all_groups($this->get_course()->id,
2106                                                 array_keys($participants),
2107                                                 $this->get_instance()->teamsubmissiongroupingid,
2108                                                 'DISTINCT g.id, g.name');
2109                 if (empty($groups)) {
2110                     // If $groups is empty it means it is not part of $this->get_instance()->teamsubmissiongroupingid.
2111                     // All submissions from students that do not belong to any of teamsubmissiongroupingid groups
2112                     // count towards groupid = 0. Setting to true as only '0' key matters.
2113                     $groups = [true];
2114                 }
2115                 list($groupssql, $groupsparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
2116                 $groupsstr = 's.groupid ' . $groupssql . ' AND';
2117                 $params = $params + $groupsparams;
2118             }
2119             $sql = 'SELECT COUNT(s.groupid)
2120                         FROM {assign_submission} s
2121                         WHERE
2122                             s.latest = 1 AND
2123                             s.assignment = :assignid AND
2124                             s.timemodified IS NOT NULL AND
2125                             s.userid = :groupuserid AND '
2126                             . $groupsstr . '
2127                             s.status = :submissionstatus';
2128             $params['groupuserid'] = 0;
2129         } else {
2130             $sql = 'SELECT COUNT(s.userid)
2131                         FROM {assign_submission} s
2132                         JOIN(' . $esql . ') e ON e.id = s.userid
2133                         WHERE
2134                             s.latest = 1 AND
2135                             s.assignment = :assignid AND
2136                             s.timemodified IS NOT NULL AND
2137                             s.status = :submissionstatus';
2139         }
2141         return $DB->count_records_sql($sql, $params);
2142     }
2144     /**
2145      * Utility function to get the userid for every row in the grading table
2146      * so the order can be frozen while we iterate it.
2147      *
2148      * @return array An array of userids
2149      */
2150     protected function get_grading_userid_list() {
2151         $filter = get_user_preferences('assign_filter', '');
2152         $table = new assign_grading_table($this, 0, $filter, 0, false);
2154         $useridlist = $table->get_column_data('userid');
2156         return $useridlist;
2157     }
2159     /**
2160      * Generate zip file from array of given files.
2161      *
2162      * @param array $filesforzipping - array of files to pass into archive_to_pathname.
2163      *                                 This array is indexed by the final file name and each
2164      *                                 element in the array is an instance of a stored_file object.
2165      * @return path of temp file - note this returned file does
2166      *         not have a .zip extension - it is a temp file.
2167      */
2168     protected function pack_files($filesforzipping) {
2169         global $CFG;
2170         // Create path for new zip file.
2171         $tempzip = tempnam($CFG->tempdir . '/', 'assignment_');
2172         // Zip files.
2173         $zipper = new zip_packer();
2174         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
2175             return $tempzip;
2176         }
2177         return false;
2178     }
2180     /**
2181      * Finds all assignment notifications that have yet to be mailed out, and mails them.
2182      *
2183      * Cron function to be run periodically according to the moodle cron.
2184      *
2185      * @return bool
2186      */
2187     public static function cron() {
2188         global $DB;
2190         // Only ever send a max of one days worth of updates.
2191         $yesterday = time() - (24 * 3600);
2192         $timenow   = time();
2193         $lastcron = $DB->get_field('modules', 'lastcron', array('name' => 'assign'));
2195         // Collect all submissions that require mailing.
2196         // Submissions are included if all are true:
2197         //   - The assignment is visible in the gradebook.
2198         //   - No previous notification has been sent.
2199         //   - If marking workflow is not enabled, the grade was updated in the past 24 hours, or
2200         //     if marking workflow is enabled, the workflow state is at 'released'.
2201         $sql = "SELECT g.id as gradeid, a.course, a.name, a.blindmarking, a.revealidentities,
2202                        g.*, g.timemodified as lastmodified, cm.id as cmid, um.id as recordid
2203                  FROM {assign} a
2204                  JOIN {assign_grades} g ON g.assignment = a.id
2205             LEFT JOIN {assign_user_flags} uf ON uf.assignment = a.id AND uf.userid = g.userid
2206                  JOIN {course_modules} cm ON cm.course = a.course AND cm.instance = a.id
2207                  JOIN {modules} md ON md.id = cm.module AND md.name = 'assign'
2208                  JOIN {grade_items} gri ON gri.iteminstance = a.id AND gri.courseid = a.course AND gri.itemmodule = md.name
2209             LEFT JOIN {assign_user_mapping} um ON g.id = um.userid AND um.assignment = a.id
2210                  WHERE ((a.markingworkflow = 0 AND g.timemodified >= :yesterday AND g.timemodified <= :today) OR
2211                         (a.markingworkflow = 1 AND uf.workflowstate = :wfreleased)) AND
2212                        uf.mailed = 0 AND gri.hidden = 0
2213               ORDER BY a.course, cm.id";
2215         $params = array(
2216             'yesterday' => $yesterday,
2217             'today' => $timenow,
2218             'wfreleased' => ASSIGN_MARKING_WORKFLOW_STATE_RELEASED,
2219         );
2220         $submissions = $DB->get_records_sql($sql, $params);
2222         if (!empty($submissions)) {
2224             mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
2226             // Preload courses we are going to need those.
2227             $courseids = array();
2228             foreach ($submissions as $submission) {
2229                 $courseids[] = $submission->course;
2230             }
2232             // Filter out duplicates.
2233             $courseids = array_unique($courseids);
2234             $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2235             list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
2236             $sql = 'SELECT c.*, ' . $ctxselect .
2237                       ' FROM {course} c
2238                  LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
2239                      WHERE c.id ' . $courseidsql;
2241             $params['contextlevel'] = CONTEXT_COURSE;
2242             $courses = $DB->get_records_sql($sql, $params);
2244             // Clean up... this could go on for a while.
2245             unset($courseids);
2246             unset($ctxselect);
2247             unset($courseidsql);
2248             unset($params);
2250             // Message students about new feedback.
2251             foreach ($submissions as $submission) {
2253                 mtrace("Processing assignment submission $submission->id ...");
2255                 // Do not cache user lookups - could be too many.
2256                 if (!$user = $DB->get_record('user', array('id'=>$submission->userid))) {
2257                     mtrace('Could not find user ' . $submission->userid);
2258                     continue;
2259                 }
2261                 // Use a cache to prevent the same DB queries happening over and over.
2262                 if (!array_key_exists($submission->course, $courses)) {
2263                     mtrace('Could not find course ' . $submission->course);
2264                     continue;
2265                 }
2266                 $course = $courses[$submission->course];
2267                 if (isset($course->ctxid)) {
2268                     // Context has not yet been preloaded. Do so now.
2269                     context_helper::preload_from_record($course);
2270                 }
2272                 // Override the language and timezone of the "current" user, so that
2273                 // mail is customised for the receiver.
2274                 cron_setup_user($user, $course);
2276                 // Context lookups are already cached.
2277                 $coursecontext = context_course::instance($course->id);
2278                 if (!is_enrolled($coursecontext, $user->id)) {
2279                     $courseshortname = format_string($course->shortname,
2280                                                      true,
2281                                                      array('context' => $coursecontext));
2282                     mtrace(fullname($user) . ' not an active participant in ' . $courseshortname);
2283                     continue;
2284                 }
2286                 if (!$grader = $DB->get_record('user', array('id'=>$submission->grader))) {
2287                     mtrace('Could not find grader ' . $submission->grader);
2288                     continue;
2289                 }
2291                 $modinfo = get_fast_modinfo($course, $user->id);
2292                 $cm = $modinfo->get_cm($submission->cmid);
2293                 // Context lookups are already cached.
2294                 $contextmodule = context_module::instance($cm->id);
2296                 if (!$cm->uservisible) {
2297                     // Hold mail notification for assignments the user cannot access until later.
2298                     continue;
2299                 }
2301                 // Need to send this to the student.
2302                 $messagetype = 'feedbackavailable';
2303                 $eventtype = 'assign_notification';
2304                 $updatetime = $submission->lastmodified;
2305                 $modulename = get_string('modulename', 'assign');
2307                 $uniqueid = 0;
2308                 if ($submission->blindmarking && !$submission->revealidentities) {
2309                     if (empty($submission->recordid)) {
2310                         $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $user->id);
2311                     } else {
2312                         $uniqueid = $submission->recordid;
2313                     }
2314                 }
2315                 $showusers = $submission->blindmarking && !$submission->revealidentities;
2316                 self::send_assignment_notification($grader,
2317                                                    $user,
2318                                                    $messagetype,
2319                                                    $eventtype,
2320                                                    $updatetime,
2321                                                    $cm,
2322                                                    $contextmodule,
2323                                                    $course,
2324                                                    $modulename,
2325                                                    $submission->name,
2326                                                    $showusers,
2327                                                    $uniqueid);
2329                 $flags = $DB->get_record('assign_user_flags', array('userid'=>$user->id, 'assignment'=>$submission->assignment));
2330                 if ($flags) {
2331                     $flags->mailed = 1;
2332                     $DB->update_record('assign_user_flags', $flags);
2333                 } else {
2334                     $flags = new stdClass();
2335                     $flags->userid = $user->id;
2336                     $flags->assignment = $submission->assignment;
2337                     $flags->mailed = 1;
2338                     $DB->insert_record('assign_user_flags', $flags);
2339                 }
2341                 mtrace('Done');
2342             }
2343             mtrace('Done processing ' . count($submissions) . ' assignment submissions');
2345             cron_setup_user();
2347             // Free up memory just to be sure.
2348             unset($courses);
2349         }
2351         // Update calendar events to provide a description.
2352         $sql = 'SELECT id
2353                     FROM {assign}
2354                     WHERE
2355                         allowsubmissionsfromdate >= :lastcron AND
2356                         allowsubmissionsfromdate <= :timenow AND
2357                         alwaysshowdescription = 0';
2358         $params = array('lastcron' => $lastcron, 'timenow' => $timenow);
2359         $newlyavailable = $DB->get_records_sql($sql, $params);
2360         foreach ($newlyavailable as $record) {
2361             $cm = get_coursemodule_from_instance('assign', $record->id, 0, false, MUST_EXIST);
2362             $context = context_module::instance($cm->id);
2364             $assignment = new assign($context, null, null);
2365             $assignment->update_calendar($cm->id);
2366         }
2368         return true;
2369     }
2371     /**
2372      * Mark in the database that this grade record should have an update notification sent by cron.
2373      *
2374      * @param stdClass $grade a grade record keyed on id
2375      * @param bool $mailedoverride when true, flag notification to be sent again.
2376      * @return bool true for success
2377      */
2378     public function notify_grade_modified($grade, $mailedoverride = false) {
2379         global $DB;
2381         $flags = $this->get_user_flags($grade->userid, true);
2382         if ($flags->mailed != 1 || $mailedoverride) {
2383             $flags->mailed = 0;
2384         }
2386         return $this->update_user_flags($flags);
2387     }
2389     /**
2390      * Update user flags for this user in this assignment.
2391      *
2392      * @param stdClass $flags a flags record keyed on id
2393      * @return bool true for success
2394      */
2395     public function update_user_flags($flags) {
2396         global $DB;
2397         if ($flags->userid <= 0 || $flags->assignment <= 0 || $flags->id <= 0) {
2398             return false;
2399         }
2401         $result = $DB->update_record('assign_user_flags', $flags);
2402         return $result;
2403     }
2405     /**
2406      * Update a grade in the grade table for the assignment and in the gradebook.
2407      *
2408      * @param stdClass $grade a grade record keyed on id
2409      * @param bool $reopenattempt If the attempt reopen method is manual, allow another attempt at this assignment.
2410      * @return bool true for success
2411      */
2412     public function update_grade($grade, $reopenattempt = false) {
2413         global $DB;
2415         $grade->timemodified = time();
2417         if (!empty($grade->workflowstate)) {
2418             $validstates = $this->get_marking_workflow_states_for_current_user();
2419             if (!array_key_exists($grade->workflowstate, $validstates)) {
2420                 return false;
2421             }
2422         }
2424         if ($grade->grade && $grade->grade != -1) {
2425             if ($this->get_instance()->grade > 0) {
2426                 if (!is_numeric($grade->grade)) {
2427                     return false;
2428                 } else if ($grade->grade > $this->get_instance()->grade) {
2429                     return false;
2430                 } else if ($grade->grade < 0) {
2431                     return false;
2432                 }
2433             } else {
2434                 // This is a scale.
2435                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
2436                     $scaleoptions = make_menu_from_list($scale->scale);
2437                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
2438                         return false;
2439                     }
2440                 }
2441             }
2442         }
2444         if (empty($grade->attemptnumber)) {
2445             // Set it to the default.
2446             $grade->attemptnumber = 0;
2447         }
2448         $DB->update_record('assign_grades', $grade);
2450         $submission = null;
2451         if ($this->get_instance()->teamsubmission) {
2452             $submission = $this->get_group_submission($grade->userid, 0, false);
2453         } else {
2454             $submission = $this->get_user_submission($grade->userid, false);
2455         }
2457         // Only push to gradebook if the update is for the latest attempt.
2458         // Not the latest attempt.
2459         if ($submission && $submission->attemptnumber != $grade->attemptnumber) {
2460             return true;
2461         }
2463         if ($this->gradebook_item_update(null, $grade)) {
2464             \mod_assign\event\submission_graded::create_from_grade($this, $grade)->trigger();
2465         }
2467         // If the conditions are met, allow another attempt.
2468         if ($submission) {
2469             $this->reopen_submission_if_required($grade->userid,
2470                     $submission,
2471                     $reopenattempt);
2472         }
2474         return true;
2475     }
2477     /**
2478      * View the grant extension date page.
2479      *
2480      * Uses url parameters 'userid'
2481      * or from parameter 'selectedusers'
2482      *
2483      * @param moodleform $mform - Used for validation of the submitted data
2484      * @return string
2485      */
2486     protected function view_grant_extension($mform) {
2487         global $CFG;
2488         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
2490         $o = '';
2492         $data = new stdClass();
2493         $data->id = $this->get_course_module()->id;
2495         $formparams = array(
2496             'instance' => $this->get_instance(),
2497             'assign' => $this
2498         );
2500         $users = optional_param('userid', 0, PARAM_INT);
2501         if (!$users) {
2502             $users = required_param('selectedusers', PARAM_SEQUENCE);
2503         }
2504         $userlist = explode(',', $users);
2506         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
2507         $maxoverride = array('allowsubmissionsfromdate' => 0, 'duedate' => 0, 'cutoffdate' => 0);
2508         foreach ($userlist as $userid) {
2509             // To validate extension date with users overrides.
2510             $override = $this->override_exists($userid);
2511             foreach ($keys as $key) {
2512                 if ($override->{$key}) {
2513                     if ($maxoverride[$key] < $override->{$key}) {
2514                         $maxoverride[$key] = $override->{$key};
2515                     }
2516                 } else if ($maxoverride[$key] < $this->get_instance()->{$key}) {
2517                     $maxoverride[$key] = $this->get_instance()->{$key};
2518                 }
2519             }
2520         }
2521         foreach ($keys as $key) {
2522             if ($maxoverride[$key]) {
2523                 $this->get_instance()->{$key} = $maxoverride[$key];
2524             }
2525         }
2527         $formparams['userlist'] = $userlist;
2529         $data->selectedusers = $users;
2530         $data->userid = 0;
2532         if (empty($mform)) {
2533             $mform = new mod_assign_extension_form(null, $formparams);
2534         }
2535         $mform->set_data($data);
2536         $header = new assign_header($this->get_instance(),
2537                                     $this->get_context(),
2538                                     $this->show_intro(),
2539                                     $this->get_course_module()->id,
2540                                     get_string('grantextension', 'assign'));
2541         $o .= $this->get_renderer()->render($header);
2542         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
2543         $o .= $this->view_footer();
2544         return $o;
2545     }
2547     /**
2548      * Get a list of the users in the same group as this user.
2549      *
2550      * @param int $groupid The id of the group whose members we want or 0 for the default group
2551      * @param bool $onlyids Whether to retrieve only the user id's
2552      * @param bool $excludesuspended Whether to exclude suspended users
2553      * @return array The users (possibly id's only)
2554      */
2555     public function get_submission_group_members($groupid, $onlyids, $excludesuspended = false) {
2556         $members = array();
2557         if ($groupid != 0) {
2558             $allusers = $this->list_participants($groupid, $onlyids);
2559             foreach ($allusers as $user) {
2560                 if ($this->get_submission_group($user->id)) {
2561                     $members[] = $user;
2562                 }
2563             }
2564         } else {
2565             $allusers = $this->list_participants(null, $onlyids);
2566             foreach ($allusers as $user) {
2567                 if ($this->get_submission_group($user->id) == null) {
2568                     $members[] = $user;
2569                 }
2570             }
2571         }
2572         // Exclude suspended users, if user can't see them.
2573         if ($excludesuspended || !has_capability('moodle/course:viewsuspendedusers', $this->context)) {
2574             foreach ($members as $key => $member) {
2575                 if (!$this->is_active_user($member->id)) {
2576                     unset($members[$key]);
2577                 }
2578             }
2579         }
2581         return $members;
2582     }
2584     /**
2585      * Get a list of the users in the same group as this user that have not submitted the assignment.
2586      *
2587      * @param int $groupid The id of the group whose members we want or 0 for the default group
2588      * @param bool $onlyids Whether to retrieve only the user id's
2589      * @return array The users (possibly id's only)
2590      */
2591     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
2592         $instance = $this->get_instance();
2593         if (!$instance->teamsubmission || !$instance->requireallteammemberssubmit) {
2594             return array();
2595         }
2596         $members = $this->get_submission_group_members($groupid, $onlyids);
2598         foreach ($members as $id => $member) {
2599             $submission = $this->get_user_submission($member->id, false);
2600             if ($submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2601                 unset($members[$id]);
2602             } else {
2603                 if ($this->is_blind_marking()) {
2604                     $members[$id]->alias = get_string('hiddenuser', 'assign') .
2605                                            $this->get_uniqueid_for_user($id);
2606                 }
2607             }
2608         }
2609         return $members;
2610     }
2612     /**
2613      * Load the group submission object for a particular user, optionally creating it if required.
2614      *
2615      * @param int $userid The id of the user whose submission we want
2616      * @param int $groupid The id of the group for this user - may be 0 in which
2617      *                     case it is determined from the userid.
2618      * @param bool $create If set to true a new submission object will be created in the database
2619      *                     with the status set to "new".
2620      * @param int $attemptnumber - -1 means the latest attempt
2621      * @return stdClass The submission
2622      */
2623     public function get_group_submission($userid, $groupid, $create, $attemptnumber=-1) {
2624         global $DB;
2626         if ($groupid == 0) {
2627             $group = $this->get_submission_group($userid);
2628             if ($group) {
2629                 $groupid = $group->id;
2630             }
2631         }
2633         // Now get the group submission.
2634         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2635         if ($attemptnumber >= 0) {
2636             $params['attemptnumber'] = $attemptnumber;
2637         }
2639         // Only return the row with the highest attemptnumber.
2640         $submission = null;
2641         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2642         if ($submissions) {
2643             $submission = reset($submissions);
2644         }
2646         if ($submission) {
2647             return $submission;
2648         }
2649         if ($create) {
2650             $submission = new stdClass();
2651             $submission->assignment = $this->get_instance()->id;
2652             $submission->userid = 0;
2653             $submission->groupid = $groupid;
2654             $submission->timecreated = time();
2655             $submission->timemodified = $submission->timecreated;
2656             if ($attemptnumber >= 0) {
2657                 $submission->attemptnumber = $attemptnumber;
2658             } else {
2659                 $submission->attemptnumber = 0;
2660             }
2661             // Work out if this is the latest submission.
2662             $submission->latest = 0;
2663             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2664             if ($attemptnumber == -1) {
2665                 // This is a new submission so it must be the latest.
2666                 $submission->latest = 1;
2667             } else {
2668                 // We need to work this out.
2669                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2670                 if ($result) {
2671                     $latestsubmission = reset($result);
2672                 }
2673                 if (!$latestsubmission || ($attemptnumber == $latestsubmission->attemptnumber)) {
2674                     $submission->latest = 1;
2675                 }
2676             }
2677             if ($submission->latest) {
2678                 // This is the case when we need to set latest to 0 for all the other attempts.
2679                 $DB->set_field('assign_submission', 'latest', 0, $params);
2680             }
2681             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2682             $sid = $DB->insert_record('assign_submission', $submission);
2683             return $DB->get_record('assign_submission', array('id' => $sid));
2684         }
2685         return false;
2686     }
2688     /**
2689      * View a summary listing of all assignments in the current course.
2690      *
2691      * @return string
2692      */
2693     private function view_course_index() {
2694         global $USER;
2696         $o = '';
2698         $course = $this->get_course();
2699         $strplural = get_string('modulenameplural', 'assign');
2701         if (!$cms = get_coursemodules_in_course('assign', $course->id, 'm.duedate')) {
2702             $o .= $this->get_renderer()->notification(get_string('thereareno', 'moodle', $strplural));
2703             $o .= $this->get_renderer()->continue_button(new moodle_url('/course/view.php', array('id' => $course->id)));
2704             return $o;
2705         }
2707         $strsectionname = '';
2708         $usesections = course_format_uses_sections($course->format);
2709         $modinfo = get_fast_modinfo($course);
2711         if ($usesections) {
2712             $strsectionname = get_string('sectionname', 'format_'.$course->format);
2713             $sections = $modinfo->get_section_info_all();
2714         }
2715         $courseindexsummary = new assign_course_index_summary($usesections, $strsectionname);
2717         $timenow = time();
2719         $currentsection = '';
2720         foreach ($modinfo->instances['assign'] as $cm) {
2721             if (!$cm->uservisible) {
2722                 continue;
2723             }
2725             $timedue = $cms[$cm->id]->duedate;
2727             $sectionname = '';
2728             if ($usesections && $cm->sectionnum) {
2729                 $sectionname = get_section_name($course, $sections[$cm->sectionnum]);
2730             }
2732             $submitted = '';
2733             $context = context_module::instance($cm->id);
2735             $assignment = new assign($context, $cm, $course);
2737             // Apply overrides.
2738             $assignment->update_effective_access($USER->id);
2739             $timedue = $assignment->get_instance()->duedate;
2741             if (has_capability('mod/assign:grade', $context)) {
2742                 $submitted = $assignment->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED);
2744             } else if (has_capability('mod/assign:submit', $context)) {
2745                 $usersubmission = $assignment->get_user_submission($USER->id, false);
2747                 if (!empty($usersubmission->status)) {
2748                     $submitted = get_string('submissionstatus_' . $usersubmission->status, 'assign');
2749                 } else {
2750                     $submitted = get_string('submissionstatus_', 'assign');
2751                 }
2752             }
2753             $gradinginfo = grade_get_grades($course->id, 'mod', 'assign', $cm->instance, $USER->id);
2754             if (isset($gradinginfo->items[0]->grades[$USER->id]) &&
2755                     !$gradinginfo->items[0]->grades[$USER->id]->hidden ) {
2756                 $grade = $gradinginfo->items[0]->grades[$USER->id]->str_grade;
2757             } else {
2758                 $grade = '-';
2759             }
2761             $courseindexsummary->add_assign_info($cm->id, $cm->get_formatted_name(), $sectionname, $timedue, $submitted, $grade);
2763         }
2765         $o .= $this->get_renderer()->render($courseindexsummary);
2766         $o .= $this->view_footer();
2768         return $o;
2769     }
2771     /**
2772      * View a page rendered by a plugin.
2773      *
2774      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.
2775      *
2776      * @return string
2777      */
2778     protected function view_plugin_page() {
2779         global $USER;
2781         $o = '';
2783         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
2784         $plugintype = required_param('plugin', PARAM_PLUGIN);
2785         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
2787         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
2788         if (!$plugin) {
2789             print_error('invalidformdata', '');
2790             return;
2791         }
2793         $o .= $plugin->view_page($pluginaction);
2795         return $o;
2796     }
2799     /**
2800      * This is used for team assignments to get the group for the specified user.
2801      * If the user is a member of multiple or no groups this will return false
2802      *
2803      * @param int $userid The id of the user whose submission we want
2804      * @return mixed The group or false
2805      */
2806     public function get_submission_group($userid) {
2808         if (isset($this->usersubmissiongroups[$userid])) {
2809             return $this->usersubmissiongroups[$userid];
2810         }
2812         $groups = $this->get_all_groups($userid);
2813         if (count($groups) != 1) {
2814             $return = false;
2815         } else {
2816             $return = array_pop($groups);
2817         }
2819         // Cache the user submission group.
2820         $this->usersubmissiongroups[$userid] = $return;
2822         return $return;
2823     }
2825     /**
2826      * Gets all groups the user is a member of.
2827      *
2828      * @param int $userid Teh id of the user who's groups we are checking
2829      * @return array The group objects
2830      */
2831     public function get_all_groups($userid) {
2832         if (isset($this->usergroups[$userid])) {
2833             return $this->usergroups[$userid];
2834         }
2836         $grouping = $this->get_instance()->teamsubmissiongroupingid;
2837         $return = groups_get_all_groups($this->get_course()->id, $userid, $grouping);
2839         $this->usergroups[$userid] = $return;
2841         return $return;
2842     }
2845     /**
2846      * Display the submission that is used by a plugin.
2847      *
2848      * Uses url parameters 'sid', 'gid' and 'plugin'.
2849      *
2850      * @param string $pluginsubtype
2851      * @return string
2852      */
2853     protected function view_plugin_content($pluginsubtype) {
2854         $o = '';
2856         $submissionid = optional_param('sid', 0, PARAM_INT);
2857         $gradeid = optional_param('gid', 0, PARAM_INT);
2858         $plugintype = required_param('plugin', PARAM_PLUGIN);
2859         $item = null;
2860         if ($pluginsubtype == 'assignsubmission') {
2861             $plugin = $this->get_submission_plugin_by_type($plugintype);
2862             if ($submissionid <= 0) {
2863                 throw new coding_exception('Submission id should not be 0');
2864             }
2865             $item = $this->get_submission($submissionid);
2867             // Check permissions.
2868             $this->require_view_submission($item->userid);
2869             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2870                                                               $this->get_context(),
2871                                                               $this->show_intro(),
2872                                                               $this->get_course_module()->id,
2873                                                               $plugin->get_name()));
2874             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
2875                                                               $item,
2876                                                               assign_submission_plugin_submission::FULL,
2877                                                               $this->get_course_module()->id,
2878                                                               $this->get_return_action(),
2879                                                               $this->get_return_params()));
2881             // Trigger event for viewing a submission.
2882             \mod_assign\event\submission_viewed::create_from_submission($this, $item)->trigger();
2884         } else {
2885             $plugin = $this->get_feedback_plugin_by_type($plugintype);
2886             if ($gradeid <= 0) {
2887                 throw new coding_exception('Grade id should not be 0');
2888             }
2889             $item = $this->get_grade($gradeid);
2890             // Check permissions.
2891             $this->require_view_submission($item->userid);
2892             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2893                                                               $this->get_context(),
2894                                                               $this->show_intro(),
2895                                                               $this->get_course_module()->id,
2896                                                               $plugin->get_name()));
2897             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
2898                                                               $item,
2899                                                               assign_feedback_plugin_feedback::FULL,
2900                                                               $this->get_course_module()->id,
2901                                                               $this->get_return_action(),
2902                                                               $this->get_return_params()));
2904             // Trigger event for viewing feedback.
2905             \mod_assign\event\feedback_viewed::create_from_grade($this, $item)->trigger();
2906         }
2908         $o .= $this->view_return_links();
2910         $o .= $this->view_footer();
2912         return $o;
2913     }
2915     /**
2916      * Rewrite plugin file urls so they resolve correctly in an exported zip.
2917      *
2918      * @param string $text - The replacement text
2919      * @param stdClass $user - The user record
2920      * @param assign_plugin $plugin - The assignment plugin
2921      */
2922     public function download_rewrite_pluginfile_urls($text, $user, $plugin) {
2923         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2924         $groupname = '';
2925         if ($groupmode) {
2926             $groupid = groups_get_activity_group($this->get_course_module(), true);
2927             $groupname = groups_get_group_name($groupid).'-';
2928         }
2930         if ($this->is_blind_marking()) {
2931             $prefix = $groupname . get_string('participant', 'assign');
2932             $prefix = str_replace('_', ' ', $prefix);
2933             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2934         } else {
2935             $prefix = $groupname . fullname($user);
2936             $prefix = str_replace('_', ' ', $prefix);
2937             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2938         }
2940         $subtype = $plugin->get_subtype();
2941         $type = $plugin->get_type();
2942         $prefix = $prefix . $subtype . '_' . $type . '_';
2944         $result = str_replace('@@PLUGINFILE@@/', $prefix, $text);
2946         return $result;
2947     }
2949     /**
2950      * Render the content in editor that is often used by plugin.
2951      *
2952      * @param string $filearea
2953      * @param int  $submissionid
2954      * @param string $plugintype
2955      * @param string $editor
2956      * @param string $component
2957      * @return string
2958      */
2959     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
2960         global $CFG;
2962         $result = '';
2964         $plugin = $this->get_submission_plugin_by_type($plugintype);
2966         $text = $plugin->get_editor_text($editor, $submissionid);
2967         $format = $plugin->get_editor_format($editor, $submissionid);
2969         $finaltext = file_rewrite_pluginfile_urls($text,
2970                                                   'pluginfile.php',
2971                                                   $this->get_context()->id,
2972                                                   $component,
2973                                                   $filearea,
2974                                                   $submissionid);
2975         $params = array('overflowdiv' => true, 'context' => $this->get_context());
2976         $result .= format_text($finaltext, $format, $params);
2978         if ($CFG->enableportfolios && has_capability('mod/assign:exportownsubmission', $this->context)) {
2979             require_once($CFG->libdir . '/portfoliolib.php');
2981             $button = new portfolio_add_button();
2982             $portfolioparams = array('cmid' => $this->get_course_module()->id,
2983                                      'sid' => $submissionid,
2984                                      'plugin' => $plugintype,
2985                                      'editor' => $editor,
2986                                      'area'=>$filearea);
2987             $button->set_callback_options('assign_portfolio_caller', $portfolioparams, 'mod_assign');
2988             $fs = get_file_storage();
2990             if ($files = $fs->get_area_files($this->context->id,
2991                                              $component,
2992                                              $filearea,
2993                                              $submissionid,
2994                                              'timemodified',
2995                                              false)) {
2996                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
2997             } else {
2998                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
2999             }
3000             $result .= $button->to_html();
3001         }
3002         return $result;
3003     }
3005     /**
3006      * Display a continue page after grading.
3007      *
3008      * @param string $message - The message to display.
3009      * @return string
3010      */
3011     protected function view_savegrading_result($message) {
3012         $o = '';
3013         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
3014                                                       $this->get_context(),
3015                                                       $this->show_intro(),
3016                                                       $this->get_course_module()->id,
3017                                                       get_string('savegradingresult', 'assign')));
3018         $gradingresult = new assign_gradingmessage(get_string('savegradingresult', 'assign'),
3019                                                    $message,
3020                                                    $this->get_course_module()->id);
3021         $o .= $this->get_renderer()->render($gradingresult);
3022         $o .= $this->view_footer();
3023         return $o;
3024     }
3025     /**
3026      * Display a continue page after quickgrading.
3027      *
3028      * @param string $message - The message to display.
3029      * @return string
3030      */
3031     protected function view_quickgrading_result($message) {
3032         $o = '';
3033         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
3034                                                       $this->get_context(),
3035                                                       $this->show_intro(),
3036                                                       $this->get_course_module()->id,
3037                                                       get_string('quickgradingresult', 'assign')));
3038         $lastpage = optional_param('lastpage', null, PARAM_INT);
3039         $gradingresult = new assign_gradingmessage(get_string('quickgradingresult', 'assign'),
3040                                                    $message,
3041                                                    $this->get_course_module()->id,
3042                                                    false,
3043                                                    $lastpage);
3044         $o .= $this->get_renderer()->render($gradingresult);
3045         $o .= $this->view_footer();
3046         return $o;
3047     }
3049     /**
3050      * Display the page footer.
3051      *
3052      * @return string
3053      */
3054     protected function view_footer() {
3055         // When viewing the footer during PHPUNIT tests a set_state error is thrown.
3056         if (!PHPUNIT_TEST) {
3057             return $this->get_renderer()->render_footer();
3058         }
3060         return '';
3061     }
3063     /**
3064      * Throw an error if the permissions to view this users submission are missing.
3065      *
3066      * @throws required_capability_exception
3067      * @return void
3068      */
3069     public function require_view_submission($userid) {
3070         if (!$this->can_view_submission($userid)) {
3071             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
3072         }
3073     }
3075     /**
3076      * Throw an error if the permissions to view grades in this assignment are missing.
3077      *
3078      * @throws required_capability_exception
3079      * @return void
3080      */
3081     public function require_view_grades() {
3082         if (!$this->can_view_grades()) {
3083             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
3084         }
3085     }
3087     /**
3088      * Does this user have view grade or grade permission for this assignment?
3089      *
3090      * @return bool
3091      */
3092     public function can_view_grades() {
3093         // Permissions check.
3094         if (!has_any_capability(array('mod/assign:viewgrades', 'mod/assign:grade'), $this->context)) {
3095             return false;
3096         }
3097         // Checks for the edge case when user belongs to no groups and groupmode is sep.
3098         if ($this->get_course_module()->effectivegroupmode == SEPARATEGROUPS) {
3099             $groupflag = has_capability('moodle/site:accessallgroups', $this->get_context());
3100             $groupflag = $groupflag || !empty(groups_get_activity_allowed_groups($this->get_course_module()));
3101             return (bool)$groupflag;
3102         }
3103         return true;
3104     }
3106     /**
3107      * Does this user have grade permission for this assignment?
3108      *
3109      * @return bool
3110      */
3111     public function can_grade() {
3112         // Permissions check.
3113         if (!has_capability('mod/assign:grade', $this->context)) {
3114             return false;
3115         }
3117         return true;
3118     }
3120     /**
3121      * Download a zip file of all assignment submissions.
3122      *
3123      * @param array $userids Array of user ids to download assignment submissions in a zip file
3124      * @return string - If an error occurs, this will contain the error page.
3125      */
3126     protected function download_submissions($userids = false) {
3127         global $CFG, $DB;
3129         // More efficient to load this here.
3130         require_once($CFG->libdir.'/filelib.php');
3132         // Increase the server timeout to handle the creation and sending of large zip files.
3133         core_php_time_limit::raise();
3135         $this->require_view_grades();
3137         // Load all users with submit.
3138         $students = get_enrolled_users($this->context, "mod/assign:submit", null, 'u.*', null, null, null,
3139                         $this->show_only_active_users());
3141         // Build a list of files to zip.
3142         $filesforzipping = array();
3143         $fs = get_file_storage();
3145         $groupmode = groups_get_activity_groupmode($this->get_course_module());
3146         // All users.
3147         $groupid = 0;
3148         $groupname = '';
3149         if ($groupmode) {
3150             $groupid = groups_get_activity_group($this->get_course_module(), true);
3151             $groupname = groups_get_group_name($groupid).'-';
3152         }
3154         // Construct the zip file name.
3155         $filename = clean_filename($this->get_course()->shortname . '-' .
3156                                    $this->get_instance()->name . '-' .
3157                                    $groupname.$this->get_course_module()->id . '.zip');
3159         // Get all the files for each student.
3160         foreach ($students as $student) {
3161             $userid = $student->id;
3162             // Download all assigments submission or only selected users.
3163             if ($userids and !in_array($userid, $userids)) {
3164                 continue;
3165             }
3167             if ((groups_is_member($groupid, $userid) or !$groupmode or !$groupid)) {
3168                 // Get the plugins to add their own files to the zip.
3170                 $submissiongroup = false;
3171                 $groupname = '';
3172                 if ($this->get_instance()->teamsubmission) {
3173                     $submission = $this->get_group_submission($userid, 0, false);
3174                     $submissiongroup = $this->get_submission_group($userid);
3175                     if ($submissiongroup) {
3176                         $groupname = $submissiongroup->name . '-';
3177                     } else {
3178                         $groupname = get_string('defaultteam', 'assign') . '-';
3179                     }
3180                 } else {
3181                     $submission = $this->get_user_submission($userid, false);
3182                 }
3184                 if ($this->is_blind_marking()) {
3185                     $prefix = str_replace('_', ' ', $groupname . get_string('participant', 'assign'));
3186                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid));
3187                 } else {
3188                     $prefix = str_replace('_', ' ', $groupname . fullname($student));
3189                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid));
3190                 }
3192                 if ($submission) {
3193                     $downloadasfolders = get_user_preferences('assign_downloadasfolders', 1);
3194                     foreach ($this->submissionplugins as $plugin) {
3195                         if ($plugin->is_enabled() && $plugin->is_visible()) {
3196                             if ($downloadasfolders) {
3197                                 // Create a folder for each user for each assignment plugin.
3198                                 // This is the default behavior for version of Moodle >= 3.1.
3199                                 $submission->exportfullpath = true;
3200                                 $pluginfiles = $plugin->get_files($submission, $student);
3201                                 foreach ($pluginfiles as $zipfilepath => $file) {
3202                                     $subtype = $plugin->get_subtype();
3203                                     $type = $plugin->get_type();
3204                                     $zipfilename = basename($zipfilepath);
3205                                     $prefixedfilename = clean_filename($prefix .
3206                                                                        '_' .
3207                                                                        $subtype .
3208                                                                        '_' .
3209                                                                        $type .
3210                                                                        '_');
3211                                     if ($type == 'file') {
3212                                         $pathfilename = $prefixedfilename . $file->get_filepath() . $zipfilename;
3213                                     } else if ($type == 'onlinetext') {
3214                                         $pathfilename = $prefixedfilename . '/' . $zipfilename;
3215                                     } else {
3216                                         $pathfilename = $prefixedfilename . '/' . $zipfilename;
3217                                     }
3218                                     $pathfilename = clean_param($pathfilename, PARAM_PATH);
3219                                     $filesforzipping[$pathfilename] = $file;
3220                                 }
3221                             } else {
3222                                 // Create a single folder for all users of all assignment plugins.
3223                                 // This was the default behavior for version of Moodle < 3.1.
3224                                 $submission->exportfullpath = false;
3225                                 $pluginfiles = $plugin->get_files($submission, $student);
3226                                 foreach ($pluginfiles as $zipfilename => $file) {
3227                                     $subtype = $plugin->get_subtype();
3228                                     $type = $plugin->get_type();
3229                                     $prefixedfilename = clean_filename($prefix .
3230                                                                        '_' .
3231                                                                        $subtype .
3232                                                                        '_' .
3233                                                                        $type .
3234                                                                        '_' .
3235                                                                        $zipfilename);
3236                                     $filesforzipping[$prefixedfilename] = $file;
3237                                 }
3238                             }
3239                         }
3240                     }
3241                 }
3242             }
3243         }
3244         $result = '';
3245         if (count($filesforzipping) == 0) {
3246             $header = new assign_header($this->get_instance(),
3247                                         $this->get_context(),
3248                                         '',
3249                                         $this->get_course_module()->id,
3250                                         get_string('downloadall', 'assign'));
3251             $result .= $this->get_renderer()->render($header);
3252             $result .= $this->get_renderer()->notification(get_string('nosubmission', 'assign'));
3253             $url = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
3254                                                                     'action'=>'grading'));
3255             $result .= $this->get_renderer()->continue_button($url);
3256             $result .= $this->view_footer();
3257         } else if ($zipfile = $this->pack_files($filesforzipping)) {
3258             \mod_assign\event\all_submissions_downloaded::create_from_assign($this)->trigger();
3259             // Send file and delete after sending.
3260             send_temp_file($zipfile, $filename);
3261             // We will not get here - send_temp_file calls exit.
3262         }
3263         return $result;
3264     }
3266     /**
3267      * Util function to add a message to the log.
3268      *
3269      * @deprecated since 2.7 - Use new events system instead.
3270      *             (see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins).
3271      *
3272      * @param string $action The current action
3273      * @param string $info A detailed description of the change. But no more than 255 characters.
3274      * @param string $url The url to the assign module instance.
3275      * @param bool $return If true, returns the arguments, else adds to log. The purpose of this is to
3276      *                     retrieve the arguments to use them with the new event system (Event 2).