Merge branch 'MDL-57411-master' of git://github.com/jleyva/moodle
[moodle.git] / mod / assign / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the definition for the class assignment
19  *
20  * This class provides all the functionality for the new assign module.
21  *
22  * @package   mod_assign
23  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 // Assignment submission statuses.
30 define('ASSIGN_SUBMISSION_STATUS_NEW', 'new');
31 define('ASSIGN_SUBMISSION_STATUS_REOPENED', 'reopened');
32 define('ASSIGN_SUBMISSION_STATUS_DRAFT', 'draft');
33 define('ASSIGN_SUBMISSION_STATUS_SUBMITTED', 'submitted');
35 // Search filters for grading page.
36 define('ASSIGN_FILTER_SUBMITTED', 'submitted');
37 define('ASSIGN_FILTER_NOT_SUBMITTED', 'notsubmitted');
38 define('ASSIGN_FILTER_SINGLE_USER', 'singleuser');
39 define('ASSIGN_FILTER_REQUIRE_GRADING', 'require_grading');
40 define('ASSIGN_FILTER_GRANTED_EXTENSION', 'granted_extension');
42 // Marker filter for grading page.
43 define('ASSIGN_MARKER_FILTER_NO_MARKER', -1);
45 // Reopen attempt methods.
46 define('ASSIGN_ATTEMPT_REOPEN_METHOD_NONE', 'none');
47 define('ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL', 'manual');
48 define('ASSIGN_ATTEMPT_REOPEN_METHOD_UNTILPASS', 'untilpass');
50 // Special value means allow unlimited attempts.
51 define('ASSIGN_UNLIMITED_ATTEMPTS', -1);
53 // 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 = $this->get_course_module();
779         if (empty($cm)) {
780             $instance = $this->get_instance();
781             $cm = get_coursemodule_from_instance('assign', $instance->id, $instance->course);
782         }
784         $override = $DB->get_record('assign_overrides', array('id' => $overrideid), '*', MUST_EXIST);
786         // Delete the events.
787         $conds = array('modulename' => 'assign', 'instance' => $this->get_instance()->id);
788         if (isset($override->userid)) {
789             $conds['userid'] = $override->userid;
790         } else {
791             $conds['groupid'] = $override->groupid;
792         }
793         $events = $DB->get_records('event', $conds);
794         foreach ($events as $event) {
795             $eventold = calendar_event::load($event);
796             $eventold->delete();
797         }
799         $DB->delete_records('assign_overrides', array('id' => $overrideid));
801         // Set the common parameters for one of the events we will be triggering.
802         $params = array(
803             'objectid' => $override->id,
804             'context' => context_module::instance($cm->id),
805             'other' => array(
806                 'assignid' => $override->assignid
807             )
808         );
809         // Determine which override deleted event to fire.
810         if (!empty($override->userid)) {
811             $params['relateduserid'] = $override->userid;
812             $event = \mod_assign\event\user_override_deleted::create($params);
813         } else {
814             $params['other']['groupid'] = $override->groupid;
815             $event = \mod_assign\event\group_override_deleted::create($params);
816         }
818         // Trigger the override deleted event.
819         $event->add_record_snapshot('assign_overrides', $override);
820         $event->trigger();
822         return true;
823     }
825     /**
826      * Deletes all assign overrides from the database and clears any corresponding calendar events
827      */
828     public function delete_all_overrides() {
829         global $DB;
831         $overrides = $DB->get_records('assign_overrides', array('assignid' => $this->get_instance()->id), 'id');
832         foreach ($overrides as $override) {
833             $this->delete_override($override->id);
834         }
835     }
837     /**
838      * Updates the assign properties with override information for a user.
839      *
840      * Algorithm:  For each assign setting, if there is a matching user-specific override,
841      *   then use that otherwise, if there are group-specific overrides, return the most
842      *   lenient combination of them.  If neither applies, leave the assign setting unchanged.
843      *
844      * @param int $userid The userid.
845      */
846     public function update_effective_access($userid) {
848         $override = $this->override_exists($userid);
850         // Merge with assign defaults.
851         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
852         foreach ($keys as $key) {
853             if (isset($override->{$key})) {
854                 $this->get_instance()->{$key} = $override->{$key};
855             }
856         }
858     }
860     /**
861      * Returns whether an assign has any overrides.
862      *
863      * @return true if any, false if not
864      */
865     public function has_overrides() {
866         global $DB;
868         $override = $DB->record_exists('assign_overrides', array('assignid' => $this->get_instance()->id));
870         if ($override) {
871             return true;
872         }
874         return false;
875     }
877     /**
878      * Returns user override
879      *
880      * Algorithm:  For each assign setting, if there is a matching user-specific override,
881      *   then use that otherwise, if there are group-specific overrides, return the most
882      *   lenient combination of them.  If neither applies, leave the assign setting unchanged.
883      *
884      * @param int $userid The userid.
885      * @return override  if exist
886      */
887     public function override_exists($userid) {
888         global $DB;
890         // Check for user override.
891         $override = $DB->get_record('assign_overrides', array('assignid' => $this->get_instance()->id, 'userid' => $userid));
893         if (!$override) {
894             $override = new stdClass();
895             $override->duedate = null;
896             $override->cutoffdate = null;
897             $override->allowsubmissionsfromdate = null;
898         }
900         // Check for group overrides.
901         $groupings = groups_get_user_groups($this->get_instance()->course, $userid);
903         if (!empty($groupings[0])) {
904             // Select all overrides that apply to the User's groups.
905             list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
906             $sql = "SELECT * FROM {assign_overrides}
907                     WHERE groupid $extra AND assignid = ?";
908             $params[] = $this->get_instance()->id;
909             $records = $DB->get_records_sql($sql, $params);
911             // Combine the overrides.
912             $duedates = array();
913             $cutoffdates = array();
914             $allowsubmissionsfromdates = array();
916             foreach ($records as $gpoverride) {
917                 if (isset($gpoverride->duedate)) {
918                     $duedates[] = $gpoverride->duedate;
919                 }
920                 if (isset($gpoverride->cutoffdate)) {
921                     $cutoffdates[] = $gpoverride->cutoffdate;
922                 }
923                 if (isset($gpoverride->allowsubmissionsfromdate)) {
924                     $allowsubmissionsfromdates[] = $gpoverride->allowsubmissionsfromdate;
925                 }
926             }
927             // If there is a user override for a setting, ignore the group override.
928             if (is_null($override->allowsubmissionsfromdate) && count($allowsubmissionsfromdates)) {
929                 $override->allowsubmissionsfromdate = min($allowsubmissionsfromdates);
930             }
931             if (is_null($override->cutoffdate) && count($cutoffdates)) {
932                 if (in_array(0, $cutoffdates)) {
933                     $override->cutoffdate = 0;
934                 } else {
935                     $override->cutoffdate = max($cutoffdates);
936                 }
937             }
938             if (is_null($override->duedate) && count($duedates)) {
939                 if (in_array(0, $duedates)) {
940                     $override->duedate = 0;
941                 } else {
942                     $override->duedate = max($duedates);
943                 }
944             }
946         }
948         return $override;
949     }
951     /**
952      * Actual implementation of the reset course functionality, delete all the
953      * assignment submissions for course $data->courseid.
954      *
955      * @param stdClass $data the data submitted from the reset course.
956      * @return array status array
957      */
958     public function reset_userdata($data) {
959         global $CFG, $DB;
961         $componentstr = get_string('modulenameplural', 'assign');
962         $status = array();
964         $fs = get_file_storage();
965         if (!empty($data->reset_assign_submissions)) {
966             // Delete files associated with this assignment.
967             foreach ($this->submissionplugins as $plugin) {
968                 $fileareas = array();
969                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
970                 $fileareas = $plugin->get_file_areas();
971                 foreach ($fileareas as $filearea => $notused) {
972                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
973                 }
975                 if (!$plugin->delete_instance()) {
976                     $status[] = array('component'=>$componentstr,
977                                       'item'=>get_string('deleteallsubmissions', 'assign'),
978                                       'error'=>$plugin->get_error());
979                 }
980             }
982             foreach ($this->feedbackplugins as $plugin) {
983                 $fileareas = array();
984                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
985                 $fileareas = $plugin->get_file_areas();
986                 foreach ($fileareas as $filearea => $notused) {
987                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
988                 }
990                 if (!$plugin->delete_instance()) {
991                     $status[] = array('component'=>$componentstr,
992                                       'item'=>get_string('deleteallsubmissions', 'assign'),
993                                       'error'=>$plugin->get_error());
994                 }
995             }
997             $assignids = $DB->get_records('assign', array('course' => $data->courseid), '', 'id');
998             list($sql, $params) = $DB->get_in_or_equal(array_keys($assignids));
1000             $DB->delete_records_select('assign_submission', "assignment $sql", $params);
1001             $DB->delete_records_select('assign_user_flags', "assignment $sql", $params);
1003             $status[] = array('component'=>$componentstr,
1004                               'item'=>get_string('deleteallsubmissions', 'assign'),
1005                               'error'=>false);
1007             if (!empty($data->reset_gradebook_grades)) {
1008                 $DB->delete_records_select('assign_grades', "assignment $sql", $params);
1009                 // Remove all grades from gradebook.
1010                 require_once($CFG->dirroot.'/mod/assign/lib.php');
1011                 assign_reset_gradebook($data->courseid);
1013                 // Reset revealidentities if both submissions and grades have been reset.
1014                 if ($this->get_instance()->blindmarking && $this->get_instance()->revealidentities) {
1015                     $DB->set_field('assign', 'revealidentities', 0, array('id' => $this->get_instance()->id));
1016                 }
1017             }
1018         }
1020         // Remove user overrides.
1021         if (!empty($data->reset_assign_user_overrides)) {
1022             $DB->delete_records_select('assign_overrides',
1023                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
1024             $status[] = array(
1025                 'component' => $componentstr,
1026                 'item' => get_string('useroverridesdeleted', 'assign'),
1027                 'error' => false);
1028         }
1029         // Remove group overrides.
1030         if (!empty($data->reset_assign_group_overrides)) {
1031             $DB->delete_records_select('assign_overrides',
1032                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
1033             $status[] = array(
1034                 'component' => $componentstr,
1035                 'item' => get_string('groupoverridesdeleted', 'assign'),
1036                 'error' => false);
1037         }
1039         // Updating dates - shift may be negative too.
1040         if ($data->timeshift) {
1041             $DB->execute("UPDATE {assign_overrides}
1042                          SET allowsubmissionsfromdate = allowsubmissionsfromdate + ?
1043                        WHERE assignid = ? AND allowsubmissionsfromdate <> 0",
1044                 array($data->timeshift, $this->get_instance()->id));
1045             $DB->execute("UPDATE {assign_overrides}
1046                          SET duedate = duedate + ?
1047                        WHERE assignid = ? AND duedate <> 0",
1048                 array($data->timeshift, $this->get_instance()->id));
1049             $DB->execute("UPDATE {assign_overrides}
1050                          SET cutoffdate = cutoffdate + ?
1051                        WHERE assignid =? AND cutoffdate <> 0",
1052                 array($data->timeshift, $this->get_instance()->id));
1054             shift_course_mod_dates('assign',
1055                                     array('duedate', 'allowsubmissionsfromdate', 'cutoffdate'),
1056                                     $data->timeshift,
1057                                     $data->courseid, $this->get_instance()->id);
1058             $status[] = array('component'=>$componentstr,
1059                               'item'=>get_string('datechanged'),
1060                               'error'=>false);
1061         }
1063         return $status;
1064     }
1066     /**
1067      * Update the settings for a single plugin.
1068      *
1069      * @param assign_plugin $plugin The plugin to update
1070      * @param stdClass $formdata The form data
1071      * @return bool false if an error occurs
1072      */
1073     protected function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
1074         if ($plugin->is_visible()) {
1075             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1076             if (!empty($formdata->$enabledname)) {
1077                 $plugin->enable();
1078                 if (!$plugin->save_settings($formdata)) {
1079                     print_error($plugin->get_error());
1080                     return false;
1081                 }
1082             } else {
1083                 $plugin->disable();
1084             }
1085         }
1086         return true;
1087     }
1089     /**
1090      * Update the gradebook information for this assignment.
1091      *
1092      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
1093      * @param int $coursemoduleid This is required because it might not exist in the database yet
1094      * @return bool
1095      */
1096     public function update_gradebook($reset, $coursemoduleid) {
1097         global $CFG;
1099         require_once($CFG->dirroot.'/mod/assign/lib.php');
1100         $assign = clone $this->get_instance();
1101         $assign->cmidnumber = $coursemoduleid;
1103         // Set assign gradebook feedback plugin status (enabled and visible).
1104         $assign->gradefeedbackenabled = $this->is_gradebook_feedback_enabled();
1106         $param = null;
1107         if ($reset) {
1108             $param = 'reset';
1109         }
1111         return assign_grade_item_update($assign, $param);
1112     }
1114     /**
1115      * Get the marking table page size
1116      *
1117      * @return integer
1118      */
1119     public function get_assign_perpage() {
1120         $perpage = (int) get_user_preferences('assign_perpage', 10);
1121         $adminconfig = $this->get_admin_config();
1122         $maxperpage = -1;
1123         if (isset($adminconfig->maxperpage)) {
1124             $maxperpage = $adminconfig->maxperpage;
1125         }
1126         if (isset($maxperpage) &&
1127             $maxperpage != -1 &&
1128             ($perpage == -1 || $perpage > $maxperpage)) {
1129             $perpage = $maxperpage;
1130         }
1131         return $perpage;
1132     }
1134     /**
1135      * Load and cache the admin config for this module.
1136      *
1137      * @return stdClass the plugin config
1138      */
1139     public function get_admin_config() {
1140         if ($this->adminconfig) {
1141             return $this->adminconfig;
1142         }
1143         $this->adminconfig = get_config('assign');
1144         return $this->adminconfig;
1145     }
1147     /**
1148      * Update the calendar entries for this assignment.
1149      *
1150      * @param int $coursemoduleid - Required to pass this in because it might
1151      *                              not exist in the database yet.
1152      * @return bool
1153      */
1154     public function update_calendar($coursemoduleid) {
1155         global $DB, $CFG;
1156         require_once($CFG->dirroot.'/calendar/lib.php');
1158         // Special case for add_instance as the coursemodule has not been set yet.
1159         $instance = $this->get_instance();
1161         $eventtype = 'due';
1163         if ($instance->duedate) {
1164             $event = new stdClass();
1166             // Fetch the original due date event. It will have a non-zero course ID and a zero group ID.
1167             $select = "modulename = :modulename
1168                        AND instance = :instance
1169                        AND eventtype = :eventtype
1170                        AND groupid = 0
1171                        AND courseid <> 0";
1172             $params = array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype);
1173             $event->id = $DB->get_field_select('event', 'id', $select, $params);
1174             $event->name = $instance->name;
1175             $event->timestart = $instance->duedate;
1177             // Convert the links to pluginfile. It is a bit hacky but at this stage the files
1178             // might not have been saved in the module area yet.
1179             $intro = $instance->intro;
1180             if ($draftid = file_get_submitted_draft_itemid('introeditor')) {
1181                 $intro = file_rewrite_urls_to_pluginfile($intro, $draftid);
1182             }
1184             // We need to remove the links to files as the calendar is not ready
1185             // to support module events with file areas.
1186             $intro = strip_pluginfile_content($intro);
1187             if ($this->show_intro()) {
1188                 $event->description = array(
1189                     'text' => $intro,
1190                     'format' => $instance->introformat
1191                 );
1192             } else {
1193                 $event->description = array(
1194                     'text' => '',
1195                     'format' => $instance->introformat
1196                 );
1197             }
1199             if ($event->id) {
1200                 $calendarevent = calendar_event::load($event->id);
1201                 $calendarevent->update($event);
1202             } else {
1203                 unset($event->id);
1204                 $event->courseid    = $instance->course;
1205                 $event->groupid     = 0;
1206                 $event->userid      = 0;
1207                 $event->modulename  = 'assign';
1208                 $event->instance    = $instance->id;
1209                 $event->eventtype   = $eventtype;
1210                 $event->timeduration = 0;
1211                 calendar_event::create($event);
1212             }
1213         } else {
1214             $DB->delete_records('event', array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype));
1215         }
1216     }
1219     /**
1220      * Update this instance in the database.
1221      *
1222      * @param stdClass $formdata - the data submitted from the form
1223      * @return bool false if an error occurs
1224      */
1225     public function update_instance($formdata) {
1226         global $DB;
1227         $adminconfig = $this->get_admin_config();
1229         $update = new stdClass();
1230         $update->id = $formdata->instance;
1231         $update->name = $formdata->name;
1232         $update->timemodified = time();
1233         $update->course = $formdata->course;
1234         $update->intro = $formdata->intro;
1235         $update->introformat = $formdata->introformat;
1236         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
1237         $update->submissiondrafts = $formdata->submissiondrafts;
1238         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
1239         $update->sendnotifications = $formdata->sendnotifications;
1240         $update->sendlatenotifications = $formdata->sendlatenotifications;
1241         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
1242         if (isset($formdata->sendstudentnotifications)) {
1243             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
1244         }
1245         $update->duedate = $formdata->duedate;
1246         $update->cutoffdate = $formdata->cutoffdate;
1247         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
1248         $update->grade = $formdata->grade;
1249         if (!empty($formdata->completionunlocked)) {
1250             $update->completionsubmit = !empty($formdata->completionsubmit);
1251         }
1252         $update->teamsubmission = $formdata->teamsubmission;
1253         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
1254         if (isset($formdata->teamsubmissiongroupingid)) {
1255             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
1256         }
1257         $update->blindmarking = $formdata->blindmarking;
1258         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
1259         if (!empty($formdata->attemptreopenmethod)) {
1260             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
1261         }
1262         if (!empty($formdata->maxattempts)) {
1263             $update->maxattempts = $formdata->maxattempts;
1264         }
1265         if (isset($formdata->preventsubmissionnotingroup)) {
1266             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
1267         }
1268         $update->markingworkflow = $formdata->markingworkflow;
1269         $update->markingallocation = $formdata->markingallocation;
1270         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
1271             $update->markingallocation = 0;
1272         }
1274         $result = $DB->update_record('assign', $update);
1275         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
1277         $this->save_intro_draft_files($formdata);
1279         // Load the assignment so the plugins have access to it.
1281         // Call save_settings hook for submission plugins.
1282         foreach ($this->submissionplugins as $plugin) {
1283             if (!$this->update_plugin_instance($plugin, $formdata)) {
1284                 print_error($plugin->get_error());
1285                 return false;
1286             }
1287         }
1288         foreach ($this->feedbackplugins as $plugin) {
1289             if (!$this->update_plugin_instance($plugin, $formdata)) {
1290                 print_error($plugin->get_error());
1291                 return false;
1292             }
1293         }
1295         $this->update_calendar($this->get_course_module()->id);
1296         $this->update_gradebook(false, $this->get_course_module()->id);
1298         $update = new stdClass();
1299         $update->id = $this->get_instance()->id;
1300         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
1301         $DB->update_record('assign', $update);
1303         return $result;
1304     }
1306     /**
1307      * Save the attachments in the draft areas.
1308      *
1309      * @param stdClass $formdata
1310      */
1311     protected function save_intro_draft_files($formdata) {
1312         if (isset($formdata->introattachments)) {
1313             file_save_draft_area_files($formdata->introattachments, $this->get_context()->id,
1314                                        'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA, 0);
1315         }
1316     }
1318     /**
1319      * Add elements in grading plugin form.
1320      *
1321      * @param mixed $grade stdClass|null
1322      * @param MoodleQuickForm $mform
1323      * @param stdClass $data
1324      * @param int $userid - The userid we are grading
1325      * @return void
1326      */
1327     protected function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
1328         foreach ($this->feedbackplugins as $plugin) {
1329             if ($plugin->is_enabled() && $plugin->is_visible()) {
1330                 $plugin->get_form_elements_for_user($grade, $mform, $data, $userid);
1331             }
1332         }
1333     }
1337     /**
1338      * Add one plugins settings to edit plugin form.
1339      *
1340      * @param assign_plugin $plugin The plugin to add the settings from
1341      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1342      *                               This form is modified directly (not returned).
1343      * @param array $pluginsenabled A list of form elements to be added to a group.
1344      *                              The new element is added to this array by this function.
1345      * @return void
1346      */
1347     protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) {
1348         global $CFG;
1349         if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) {
1350             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1351             $pluginsenabled[] = $mform->createElement('hidden', $name, 1);
1352             $mform->setType($name, PARAM_BOOL);
1353             $plugin->get_settings($mform);
1354         } else if ($plugin->is_visible() && $plugin->is_configurable()) {
1355             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1356             $label = $plugin->get_name();
1357             $label .= ' ' . $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
1358             $pluginsenabled[] = $mform->createElement('checkbox', $name, '', $label);
1360             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
1361             if ($plugin->get_config('enabled') !== false) {
1362                 $default = $plugin->is_enabled();
1363             }
1364             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
1366             $plugin->get_settings($mform);
1368         }
1369     }
1371     /**
1372      * Add settings to edit plugin form.
1373      *
1374      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1375      *                               This form is modified directly (not returned).
1376      * @return void
1377      */
1378     public function add_all_plugin_settings(MoodleQuickForm $mform) {
1379         $mform->addElement('header', 'submissiontypes', get_string('submissiontypes', 'assign'));
1381         $submissionpluginsenabled = array();
1382         $group = $mform->addGroup(array(), 'submissionplugins', get_string('submissiontypes', 'assign'), array(' '), false);
1383         foreach ($this->submissionplugins as $plugin) {
1384             $this->add_plugin_settings($plugin, $mform, $submissionpluginsenabled);
1385         }
1386         $group->setElements($submissionpluginsenabled);
1388         $mform->addElement('header', 'feedbacktypes', get_string('feedbacktypes', 'assign'));
1389         $feedbackpluginsenabled = array();
1390         $group = $mform->addGroup(array(), 'feedbackplugins', get_string('feedbacktypes', 'assign'), array(' '), false);
1391         foreach ($this->feedbackplugins as $plugin) {
1392             $this->add_plugin_settings($plugin, $mform, $feedbackpluginsenabled);
1393         }
1394         $group->setElements($feedbackpluginsenabled);
1395         $mform->setExpanded('submissiontypes');
1396     }
1398     /**
1399      * Allow each plugin an opportunity to update the defaultvalues
1400      * passed in to the settings form (needed to set up draft areas for
1401      * editor and filemanager elements)
1402      *
1403      * @param array $defaultvalues
1404      */
1405     public function plugin_data_preprocessing(&$defaultvalues) {
1406         foreach ($this->submissionplugins as $plugin) {
1407             if ($plugin->is_visible()) {
1408                 $plugin->data_preprocessing($defaultvalues);
1409             }
1410         }
1411         foreach ($this->feedbackplugins as $plugin) {
1412             if ($plugin->is_visible()) {
1413                 $plugin->data_preprocessing($defaultvalues);
1414             }
1415         }
1416     }
1418     /**
1419      * Get the name of the current module.
1420      *
1421      * @return string the module name (Assignment)
1422      */
1423     protected function get_module_name() {
1424         if (isset(self::$modulename)) {
1425             return self::$modulename;
1426         }
1427         self::$modulename = get_string('modulename', 'assign');
1428         return self::$modulename;
1429     }
1431     /**
1432      * Get the plural name of the current module.
1433      *
1434      * @return string the module name plural (Assignments)
1435      */
1436     protected function get_module_name_plural() {
1437         if (isset(self::$modulenameplural)) {
1438             return self::$modulenameplural;
1439         }
1440         self::$modulenameplural = get_string('modulenameplural', 'assign');
1441         return self::$modulenameplural;
1442     }
1444     /**
1445      * Has this assignment been constructed from an instance?
1446      *
1447      * @return bool
1448      */
1449     public function has_instance() {
1450         return $this->instance || $this->get_course_module();
1451     }
1453     /**
1454      * Get the settings for the current instance of this assignment
1455      *
1456      * @return stdClass The settings
1457      */
1458     public function get_instance() {
1459         global $DB;
1460         if ($this->instance) {
1461             return $this->instance;
1462         }
1463         if ($this->get_course_module()) {
1464             $params = array('id' => $this->get_course_module()->instance);
1465             $this->instance = $DB->get_record('assign', $params, '*', MUST_EXIST);
1466         }
1467         if (!$this->instance) {
1468             throw new coding_exception('Improper use of the assignment class. ' .
1469                                        'Cannot load the assignment record.');
1470         }
1471         return $this->instance;
1472     }
1474     /**
1475      * Get the primary grade item for this assign instance.
1476      *
1477      * @return grade_item The grade_item record
1478      */
1479     public function get_grade_item() {
1480         if ($this->gradeitem) {
1481             return $this->gradeitem;
1482         }
1483         $instance = $this->get_instance();
1484         $params = array('itemtype' => 'mod',
1485                         'itemmodule' => 'assign',
1486                         'iteminstance' => $instance->id,
1487                         'courseid' => $instance->course,
1488                         'itemnumber' => 0);
1489         $this->gradeitem = grade_item::fetch($params);
1490         if (!$this->gradeitem) {
1491             throw new coding_exception('Improper use of the assignment class. ' .
1492                                        'Cannot load the grade item.');
1493         }
1494         return $this->gradeitem;
1495     }
1497     /**
1498      * Get the context of the current course.
1499      *
1500      * @return mixed context|null The course context
1501      */
1502     public function get_course_context() {
1503         if (!$this->context && !$this->course) {
1504             throw new coding_exception('Improper use of the assignment class. ' .
1505                                        'Cannot load the course context.');
1506         }
1507         if ($this->context) {
1508             return $this->context->get_course_context();
1509         } else {
1510             return context_course::instance($this->course->id);
1511         }
1512     }
1515     /**
1516      * Get the current course module.
1517      *
1518      * @return cm_info|null The course module or null if not known
1519      */
1520     public function get_course_module() {
1521         if ($this->coursemodule) {
1522             return $this->coursemodule;
1523         }
1524         if (!$this->context) {
1525             return null;
1526         }
1528         if ($this->context->contextlevel == CONTEXT_MODULE) {
1529             $modinfo = get_fast_modinfo($this->get_course());
1530             $this->coursemodule = $modinfo->get_cm($this->context->instanceid);
1531             return $this->coursemodule;
1532         }
1533         return null;
1534     }
1536     /**
1537      * Get context module.
1538      *
1539      * @return context
1540      */
1541     public function get_context() {
1542         return $this->context;
1543     }
1545     /**
1546      * Get the current course.
1547      *
1548      * @return mixed stdClass|null The course
1549      */
1550     public function get_course() {
1551         global $DB;
1553         if ($this->course) {
1554             return $this->course;
1555         }
1557         if (!$this->context) {
1558             return null;
1559         }
1560         $params = array('id' => $this->get_course_context()->instanceid);
1561         $this->course = $DB->get_record('course', $params, '*', MUST_EXIST);
1563         return $this->course;
1564     }
1566     /**
1567      * Count the number of intro attachments.
1568      *
1569      * @return int
1570      */
1571     protected function count_attachments() {
1573         $fs = get_file_storage();
1574         $files = $fs->get_area_files($this->get_context()->id, 'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA,
1575                         0, 'id', false);
1577         return count($files);
1578     }
1580     /**
1581      * Are there any intro attachments to display?
1582      *
1583      * @return boolean
1584      */
1585     protected function has_visible_attachments() {
1586         return ($this->count_attachments() > 0);
1587     }
1589     /**
1590      * Return a grade in user-friendly form, whether it's a scale or not.
1591      *
1592      * @param mixed $grade int|null
1593      * @param boolean $editing Are we allowing changes to this grade?
1594      * @param int $userid The user id the grade belongs to
1595      * @param int $modified Timestamp from when the grade was last modified
1596      * @return string User-friendly representation of grade
1597      */
1598     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1599         global $DB;
1601         static $scalegrades = array();
1603         $o = '';
1605         if ($this->get_instance()->grade >= 0) {
1606             // Normal number.
1607             if ($editing && $this->get_instance()->grade > 0) {
1608                 if ($grade < 0) {
1609                     $displaygrade = '';
1610                 } else {
1611                     $displaygrade = format_float($grade, $this->get_grade_item()->get_decimals());
1612                 }
1613                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' .
1614                        get_string('usergrade', 'assign') .
1615                        '</label>';
1616                 $o .= '<input type="text"
1617                               id="quickgrade_' . $userid . '"
1618                               name="quickgrade_' . $userid . '"
1619                               value="' .  $displaygrade . '"
1620                               size="6"
1621                               maxlength="10"
1622                               class="quickgrade"/>';
1623                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $this->get_grade_item()->get_decimals());
1624                 return $o;
1625             } else {
1626                 if ($grade == -1 || $grade === null) {
1627                     $o .= '-';
1628                 } else {
1629                     $item = $this->get_grade_item();
1630                     $o .= grade_format_gradevalue($grade, $item);
1631                     if ($item->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) {
1632                         // If displaying the raw grade, also display the total value.
1633                         $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $item->get_decimals());
1634                     }
1635                 }
1636                 return $o;
1637             }
1639         } else {
1640             // Scale.
1641             if (empty($this->cache['scale'])) {
1642                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1643                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1644                 } else {
1645                     $o .= '-';
1646                     return $o;
1647                 }
1648             }
1649             if ($editing) {
1650                 $o .= '<label class="accesshide"
1651                               for="quickgrade_' . $userid . '">' .
1652                       get_string('usergrade', 'assign') .
1653                       '</label>';
1654                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1655                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1656                 foreach ($this->cache['scale'] as $optionid => $option) {
1657                     $selected = '';
1658                     if ($grade == $optionid) {
1659                         $selected = 'selected="selected"';
1660                     }
1661                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1662                 }
1663                 $o .= '</select>';
1664                 return $o;
1665             } else {
1666                 $scaleid = (int)$grade;
1667                 if (isset($this->cache['scale'][$scaleid])) {
1668                     $o .= $this->cache['scale'][$scaleid];
1669                     return $o;
1670                 }
1671                 $o .= '-';
1672                 return $o;
1673             }
1674         }
1675     }
1677     /**
1678      * Get the submission status/grading status for all submissions in this assignment for the
1679      * given paticipants.
1680      *
1681      * These statuses match the available filters (requiregrading, submitted, notsubmitted, grantedextension).
1682      * If this is a group assignment, group info is also returned.
1683      *
1684      * @param array $participants an associative array where the key is the participant id and
1685      *                            the value is the participant record.
1686      * @return array an associative array where the key is the participant id and the value is
1687      *               the participant record.
1688      */
1689     private function get_submission_info_for_participants($participants) {
1690         global $DB;
1692         if (empty($participants)) {
1693             return $participants;
1694         }
1696         list($insql, $params) = $DB->get_in_or_equal(array_keys($participants), SQL_PARAMS_NAMED);
1698         $assignid = $this->get_instance()->id;
1699         $params['assignmentid1'] = $assignid;
1700         $params['assignmentid2'] = $assignid;
1701         $params['assignmentid3'] = $assignid;
1703         $fields = 'SELECT u.id, s.status, s.timemodified AS stime, g.timemodified AS gtime, g.grade, uf.extensionduedate';
1704         $from = ' FROM {user} u
1705                          LEFT JOIN {assign_submission} s
1706                                 ON u.id = s.userid
1707                                AND s.assignment = :assignmentid1
1708                                AND s.latest = 1
1709                          LEFT JOIN {assign_grades} g
1710                                 ON u.id = g.userid
1711                                AND g.assignment = :assignmentid2
1712                                AND g.attemptnumber = s.attemptnumber
1713                          LEFT JOIN {assign_user_flags} uf
1714                                 ON u.id = uf.userid
1715                                AND uf.assignment = :assignmentid3
1716             ';
1717         $where = ' WHERE u.id ' . $insql;
1719         if (!empty($this->get_instance()->blindmarking)) {
1720             $from .= 'LEFT JOIN {assign_user_mapping} um
1721                              ON u.id = um.userid
1722                             AND um.assignment = :assignmentid4 ';
1723             $params['assignmentid4'] = $assignid;
1724             $fields .= ', um.id as recordid ';
1725         }
1727         $sql = "$fields $from $where";
1729         $records = $DB->get_records_sql($sql, $params);
1731         if ($this->get_instance()->teamsubmission) {
1732             // Get all groups.
1733             $allgroups = groups_get_all_groups($this->get_course()->id,
1734                                                array_keys($participants),
1735                                                $this->get_instance()->teamsubmissiongroupingid,
1736                                                'DISTINCT g.id, g.name');
1738         }
1739         foreach ($participants as $userid => $participant) {
1740             $participants[$userid]->fullname = $this->fullname($participant);
1741             $participants[$userid]->submitted = false;
1742             $participants[$userid]->requiregrading = false;
1743             $participants[$userid]->grantedextension = false;
1744         }
1746         foreach ($records as $userid => $submissioninfo) {
1747             // These filters are 100% the same as the ones in the grading table SQL.
1748             $submitted = false;
1749             $requiregrading = false;
1750             $grantedextension = false;
1752             if (!empty($submissioninfo->stime) && $submissioninfo->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
1753                 $submitted = true;
1754             }
1756             if ($submitted && ($submissioninfo->stime >= $submissioninfo->gtime ||
1757                     empty($submissioninfo->gtime) ||
1758                     $submissioninfo->grade === null)) {
1759                 $requiregrading = true;
1760             }
1762             if (!empty($submissioninfo->extensionduedate)) {
1763                 $grantedextension = true;
1764             }
1766             $participants[$userid]->submitted = $submitted;
1767             $participants[$userid]->requiregrading = $requiregrading;
1768             $participants[$userid]->grantedextension = $grantedextension;
1769             if ($this->get_instance()->teamsubmission) {
1770                 $group = $this->get_submission_group($userid);
1771                 if ($group) {
1772                     $participants[$userid]->groupid = $group->id;
1773                     $participants[$userid]->groupname = $group->name;
1774                 }
1775             }
1776         }
1777         return $participants;
1778     }
1780     /**
1781      * Get the submission status/grading status for all submissions in this assignment.
1782      * These statuses match the available filters (requiregrading, submitted, notsubmitted, grantedextension).
1783      * If this is a group assignment, group info is also returned.
1784      *
1785      * @param int $currentgroup
1786      * @return array List of user records with extra fields 'submitted', 'notsubmitted', 'requiregrading', 'grantedextension',
1787      *               'groupid', 'groupname'
1788      */
1789     public function list_participants_with_filter_status_and_group($currentgroup) {
1790         $participants = $this->list_participants($currentgroup, false);
1792         if (empty($participants)) {
1793             return $participants;
1794         } else {
1795             return $this->get_submission_info_for_participants($participants);
1796         }
1797     }
1799     /**
1800      * Load a list of users enrolled in the current course with the specified permission and group.
1801      * 0 for no group.
1802      *
1803      * @param int $currentgroup
1804      * @param bool $idsonly
1805      * @return array List of user records
1806      */
1807     public function list_participants($currentgroup, $idsonly) {
1808         global $DB, $USER;
1810         if (empty($currentgroup)) {
1811             $currentgroup = 0;
1812         }
1814         $key = $this->context->id . '-' . $currentgroup . '-' . $this->show_only_active_users();
1815         if (!isset($this->participants[$key])) {
1816             list($esql, $params) = get_enrolled_sql($this->context, 'mod/assign:submit', $currentgroup,
1817                     $this->show_only_active_users());
1819             $fields = 'u.*';
1820             $orderby = 'u.lastname, u.firstname, u.id';
1821             $additionaljoins = '';
1822             $additionalfilters = '';
1823             $instance = $this->get_instance();
1824             if (!empty($instance->blindmarking)) {
1825                 $additionaljoins .= " LEFT JOIN {assign_user_mapping} um
1826                                   ON u.id = um.userid
1827                                  AND um.assignment = :assignmentid1
1828                            LEFT JOIN {assign_submission} s
1829                                   ON u.id = s.userid
1830                                  AND s.assignment = :assignmentid2
1831                                  AND s.latest = 1
1832                         ";
1833                 $params['assignmentid1'] = (int) $instance->id;
1834                 $params['assignmentid2'] = (int) $instance->id;
1835                 $fields .= ', um.id as recordid ';
1837                 // Sort by submission time first, then by um.id to sort reliably by the blind marking id.
1838                 // Note, different DBs have different ordering of NULL values.
1839                 // Therefore we coalesce the current time into the timecreated field, and the max possible integer into
1840                 // the ID field.
1841                 $orderby = "COALESCE(s.timecreated, " . time() . ") ASC, COALESCE(s.id, " . PHP_INT_MAX . ") ASC, um.id ASC";
1842             }
1844             if ($instance->markingworkflow &&
1845                     $instance->markingallocation &&
1846                     !has_capability('mod/assign:manageallocations', $this->get_context()) &&
1847                     has_capability('mod/assign:grade', $this->get_context())) {
1849                 $additionaljoins .= ' LEFT JOIN {assign_user_flags} uf
1850                                      ON u.id = uf.userid
1851                                      AND uf.assignment = :assignmentid3';
1853                 $params['assignmentid3'] = (int) $instance->id;
1855                 $additionalfilters .= ' AND uf.allocatedmarker = :markerid';
1856                 $params['markerid'] = $USER->id;
1857             }
1859             $sql = "SELECT $fields
1860                       FROM {user} u
1861                       JOIN ($esql) je ON je.id = u.id
1862                            $additionaljoins
1863                      WHERE u.deleted = 0
1864                            $additionalfilters
1865                   ORDER BY $orderby";
1867             $users = $DB->get_records_sql($sql, $params);
1869             $cm = $this->get_course_module();
1870             $info = new \core_availability\info_module($cm);
1871             $users = $info->filter_user_list($users);
1873             $this->participants[$key] = $users;
1874         }
1876         if ($idsonly) {
1877             $idslist = array();
1878             foreach ($this->participants[$key] as $id => $user) {
1879                 $idslist[$id] = new stdClass();
1880                 $idslist[$id]->id = $id;
1881             }
1882             return $idslist;
1883         }
1884         return $this->participants[$key];
1885     }
1887     /**
1888      * Load a user if they are enrolled in the current course. Populated with submission
1889      * status for this assignment.
1890      *
1891      * @param int $userid
1892      * @return null|stdClass user record
1893      */
1894     public function get_participant($userid) {
1895         global $DB;
1897         $participant = $DB->get_record('user', array('id' => $userid));
1898         if (!$participant) {
1899             return null;
1900         }
1902         if (!is_enrolled($this->context, $participant, 'mod/assign:submit', $this->show_only_active_users())) {
1903             return null;
1904         }
1906         $result = $this->get_submission_info_for_participants(array($participant->id => $participant));
1907         return $result[$participant->id];
1908     }
1910     /**
1911      * Load a count of valid teams for this assignment.
1912      *
1913      * @param int $activitygroup Activity active group
1914      * @return int number of valid teams
1915      */
1916     public function count_teams($activitygroup = 0) {
1918         $count = 0;
1920         $participants = $this->list_participants($activitygroup, true);
1922         // If a team submission grouping id is provided all good as all returned groups
1923         // are the submission teams, but if no team submission grouping was specified
1924         // $groups will contain all participants groups.
1925         if ($this->get_instance()->teamsubmissiongroupingid) {
1927             // We restrict the users to the selected group ones.
1928             $groups = groups_get_all_groups($this->get_course()->id,
1929                                             array_keys($participants),
1930                                             $this->get_instance()->teamsubmissiongroupingid,
1931                                             'DISTINCT g.id, g.name');
1933             $count = count($groups);
1935             // When a specific group is selected we don't count the default group users.
1936             if ($activitygroup == 0) {
1937                 if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1938                     // See if there are any users in the default group.
1939                     $defaultusers = $this->get_submission_group_members(0, true);
1940                     if (count($defaultusers) > 0) {
1941                         $count += 1;
1942                     }
1943                 }
1944             } else if ($activitygroup != 0 && empty($groups)) {
1945                 // Set count to 1 if $groups returns empty.
1946                 // It means the group is not part of $this->get_instance()->teamsubmissiongroupingid.
1947                 $count = 1;
1948             }
1949         } else {
1950             // It is faster to loop around participants if no grouping was specified.
1951             $groups = array();
1952             foreach ($participants as $participant) {
1953                 if ($group = $this->get_submission_group($participant->id)) {
1954                     $groups[$group->id] = true;
1955                 } else if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1956                     $groups[0] = true;
1957                 }
1958             }
1960             $count = count($groups);
1961         }
1963         return $count;
1964     }
1966     /**
1967      * Load a count of active users enrolled in the current course with the specified permission and group.
1968      * 0 for no group.
1969      *
1970      * @param int $currentgroup
1971      * @return int number of matching users
1972      */
1973     public function count_participants($currentgroup) {
1974         return count($this->list_participants($currentgroup, true));
1975     }
1977     /**
1978      * Load a count of active users submissions in the current module that require grading
1979      * This means the submission modification time is more recent than the
1980      * grading modification time and the status is SUBMITTED.
1981      *
1982      * @return int number of matching submissions
1983      */
1984     public function count_submissions_need_grading() {
1985         global $DB;
1987         if ($this->get_instance()->teamsubmission) {
1988             // This does not make sense for group assignment because the submission is shared.
1989             return 0;
1990         }
1992         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1993         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1995         $params['assignid'] = $this->get_instance()->id;
1996         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1998         $sql = 'SELECT COUNT(s.userid)
1999                    FROM {assign_submission} s
2000                    LEFT JOIN {assign_grades} g ON
2001                         s.assignment = g.assignment AND
2002                         s.userid = g.userid AND
2003                         g.attemptnumber = s.attemptnumber
2004                    JOIN(' . $esql . ') e ON e.id = s.userid
2005                    WHERE
2006                         s.latest = 1 AND
2007                         s.assignment = :assignid AND
2008                         s.timemodified IS NOT NULL AND
2009                         s.status = :submitted AND
2010                         (s.timemodified >= g.timemodified OR g.timemodified IS NULL OR g.grade IS NULL)';
2012         return $DB->count_records_sql($sql, $params);
2013     }
2015     /**
2016      * Load a count of grades.
2017      *
2018      * @return int number of grades
2019      */
2020     public function count_grades() {
2021         global $DB;
2023         if (!$this->has_instance()) {
2024             return 0;
2025         }
2027         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2028         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2030         $params['assignid'] = $this->get_instance()->id;
2032         $sql = 'SELECT COUNT(g.userid)
2033                    FROM {assign_grades} g
2034                    JOIN(' . $esql . ') e ON e.id = g.userid
2035                    WHERE g.assignment = :assignid';
2037         return $DB->count_records_sql($sql, $params);
2038     }
2040     /**
2041      * Load a count of submissions.
2042      *
2043      * @param bool $includenew When true, also counts the submissions with status 'new'.
2044      * @return int number of submissions
2045      */
2046     public function count_submissions($includenew = false) {
2047         global $DB;
2049         if (!$this->has_instance()) {
2050             return 0;
2051         }
2053         $params = array();
2054         $sqlnew = '';
2056         if (!$includenew) {
2057             $sqlnew = ' AND s.status <> :status ';
2058             $params['status'] = ASSIGN_SUBMISSION_STATUS_NEW;
2059         }
2061         if ($this->get_instance()->teamsubmission) {
2062             // We cannot join on the enrolment tables for group submissions (no userid).
2063             $sql = 'SELECT COUNT(DISTINCT s.groupid)
2064                         FROM {assign_submission} s
2065                         WHERE
2066                             s.assignment = :assignid AND
2067                             s.timemodified IS NOT NULL AND
2068                             s.userid = :groupuserid' .
2069                             $sqlnew;
2071             $params['assignid'] = $this->get_instance()->id;
2072             $params['groupuserid'] = 0;
2073         } else {
2074             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2075             list($esql, $enrolparams) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2077             $params = array_merge($params, $enrolparams);
2078             $params['assignid'] = $this->get_instance()->id;
2080             $sql = 'SELECT COUNT(DISTINCT s.userid)
2081                        FROM {assign_submission} s
2082                        JOIN(' . $esql . ') e ON e.id = s.userid
2083                        WHERE
2084                             s.assignment = :assignid AND
2085                             s.timemodified IS NOT NULL ' .
2086                             $sqlnew;
2088         }
2090         return $DB->count_records_sql($sql, $params);
2091     }
2093     /**
2094      * Load a count of submissions with a specified status.
2095      *
2096      * @param string $status The submission status - should match one of the constants
2097      * @return int number of matching submissions
2098      */
2099     public function count_submissions_with_status($status) {
2100         global $DB;
2102         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2103         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2105         $params['assignid'] = $this->get_instance()->id;
2106         $params['assignid2'] = $this->get_instance()->id;
2107         $params['submissionstatus'] = $status;
2109         if ($this->get_instance()->teamsubmission) {
2111             $groupsstr = '';
2112             if ($currentgroup != 0) {
2113                 // If there is an active group we should only display the current group users groups.
2114                 $participants = $this->list_participants($currentgroup, true);
2115                 $groups = groups_get_all_groups($this->get_course()->id,
2116                                                 array_keys($participants),
2117                                                 $this->get_instance()->teamsubmissiongroupingid,
2118                                                 'DISTINCT g.id, g.name');
2119                 if (empty($groups)) {
2120                     // If $groups is empty it means it is not part of $this->get_instance()->teamsubmissiongroupingid.
2121                     // All submissions from students that do not belong to any of teamsubmissiongroupingid groups
2122                     // count towards groupid = 0. Setting to true as only '0' key matters.
2123                     $groups = [true];
2124                 }
2125                 list($groupssql, $groupsparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
2126                 $groupsstr = 's.groupid ' . $groupssql . ' AND';
2127                 $params = $params + $groupsparams;
2128             }
2129             $sql = 'SELECT COUNT(s.groupid)
2130                         FROM {assign_submission} s
2131                         WHERE
2132                             s.latest = 1 AND
2133                             s.assignment = :assignid AND
2134                             s.timemodified IS NOT NULL AND
2135                             s.userid = :groupuserid AND '
2136                             . $groupsstr . '
2137                             s.status = :submissionstatus';
2138             $params['groupuserid'] = 0;
2139         } else {
2140             $sql = 'SELECT COUNT(s.userid)
2141                         FROM {assign_submission} s
2142                         JOIN(' . $esql . ') e ON e.id = s.userid
2143                         WHERE
2144                             s.latest = 1 AND
2145                             s.assignment = :assignid AND
2146                             s.timemodified IS NOT NULL AND
2147                             s.status = :submissionstatus';
2149         }
2151         return $DB->count_records_sql($sql, $params);
2152     }
2154     /**
2155      * Utility function to get the userid for every row in the grading table
2156      * so the order can be frozen while we iterate it.
2157      *
2158      * @return array An array of userids
2159      */
2160     protected function get_grading_userid_list() {
2161         $filter = get_user_preferences('assign_filter', '');
2162         $table = new assign_grading_table($this, 0, $filter, 0, false);
2164         $useridlist = $table->get_column_data('userid');
2166         return $useridlist;
2167     }
2169     /**
2170      * Generate zip file from array of given files.
2171      *
2172      * @param array $filesforzipping - array of files to pass into archive_to_pathname.
2173      *                                 This array is indexed by the final file name and each
2174      *                                 element in the array is an instance of a stored_file object.
2175      * @return path of temp file - note this returned file does
2176      *         not have a .zip extension - it is a temp file.
2177      */
2178     protected function pack_files($filesforzipping) {
2179         global $CFG;
2180         // Create path for new zip file.
2181         $tempzip = tempnam($CFG->tempdir . '/', 'assignment_');
2182         // Zip files.
2183         $zipper = new zip_packer();
2184         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
2185             return $tempzip;
2186         }
2187         return false;
2188     }
2190     /**
2191      * Finds all assignment notifications that have yet to be mailed out, and mails them.
2192      *
2193      * Cron function to be run periodically according to the moodle cron.
2194      *
2195      * @return bool
2196      */
2197     public static function cron() {
2198         global $DB;
2200         // Only ever send a max of one days worth of updates.
2201         $yesterday = time() - (24 * 3600);
2202         $timenow   = time();
2203         $lastcron = $DB->get_field('modules', 'lastcron', array('name' => 'assign'));
2205         // Collect all submissions that require mailing.
2206         // Submissions are included if all are true:
2207         //   - The assignment is visible in the gradebook.
2208         //   - No previous notification has been sent.
2209         //   - If marking workflow is not enabled, the grade was updated in the past 24 hours, or
2210         //     if marking workflow is enabled, the workflow state is at 'released'.
2211         $sql = "SELECT g.id as gradeid, a.course, a.name, a.blindmarking, a.revealidentities,
2212                        g.*, g.timemodified as lastmodified, cm.id as cmid, um.id as recordid
2213                  FROM {assign} a
2214                  JOIN {assign_grades} g ON g.assignment = a.id
2215             LEFT JOIN {assign_user_flags} uf ON uf.assignment = a.id AND uf.userid = g.userid
2216                  JOIN {course_modules} cm ON cm.course = a.course AND cm.instance = a.id
2217                  JOIN {modules} md ON md.id = cm.module AND md.name = 'assign'
2218                  JOIN {grade_items} gri ON gri.iteminstance = a.id AND gri.courseid = a.course AND gri.itemmodule = md.name
2219             LEFT JOIN {assign_user_mapping} um ON g.id = um.userid AND um.assignment = a.id
2220                  WHERE ((a.markingworkflow = 0 AND g.timemodified >= :yesterday AND g.timemodified <= :today) OR
2221                         (a.markingworkflow = 1 AND uf.workflowstate = :wfreleased)) AND
2222                        uf.mailed = 0 AND gri.hidden = 0
2223               ORDER BY a.course, cm.id";
2225         $params = array(
2226             'yesterday' => $yesterday,
2227             'today' => $timenow,
2228             'wfreleased' => ASSIGN_MARKING_WORKFLOW_STATE_RELEASED,
2229         );
2230         $submissions = $DB->get_records_sql($sql, $params);
2232         if (!empty($submissions)) {
2234             mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
2236             // Preload courses we are going to need those.
2237             $courseids = array();
2238             foreach ($submissions as $submission) {
2239                 $courseids[] = $submission->course;
2240             }
2242             // Filter out duplicates.
2243             $courseids = array_unique($courseids);
2244             $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2245             list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
2246             $sql = 'SELECT c.*, ' . $ctxselect .
2247                       ' FROM {course} c
2248                  LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
2249                      WHERE c.id ' . $courseidsql;
2251             $params['contextlevel'] = CONTEXT_COURSE;
2252             $courses = $DB->get_records_sql($sql, $params);
2254             // Clean up... this could go on for a while.
2255             unset($courseids);
2256             unset($ctxselect);
2257             unset($courseidsql);
2258             unset($params);
2260             // Message students about new feedback.
2261             foreach ($submissions as $submission) {
2263                 mtrace("Processing assignment submission $submission->id ...");
2265                 // Do not cache user lookups - could be too many.
2266                 if (!$user = $DB->get_record('user', array('id'=>$submission->userid))) {
2267                     mtrace('Could not find user ' . $submission->userid);
2268                     continue;
2269                 }
2271                 // Use a cache to prevent the same DB queries happening over and over.
2272                 if (!array_key_exists($submission->course, $courses)) {
2273                     mtrace('Could not find course ' . $submission->course);
2274                     continue;
2275                 }
2276                 $course = $courses[$submission->course];
2277                 if (isset($course->ctxid)) {
2278                     // Context has not yet been preloaded. Do so now.
2279                     context_helper::preload_from_record($course);
2280                 }
2282                 // Override the language and timezone of the "current" user, so that
2283                 // mail is customised for the receiver.
2284                 cron_setup_user($user, $course);
2286                 // Context lookups are already cached.
2287                 $coursecontext = context_course::instance($course->id);
2288                 if (!is_enrolled($coursecontext, $user->id)) {
2289                     $courseshortname = format_string($course->shortname,
2290                                                      true,
2291                                                      array('context' => $coursecontext));
2292                     mtrace(fullname($user) . ' not an active participant in ' . $courseshortname);
2293                     continue;
2294                 }
2296                 if (!$grader = $DB->get_record('user', array('id'=>$submission->grader))) {
2297                     mtrace('Could not find grader ' . $submission->grader);
2298                     continue;
2299                 }
2301                 $modinfo = get_fast_modinfo($course, $user->id);
2302                 $cm = $modinfo->get_cm($submission->cmid);
2303                 // Context lookups are already cached.
2304                 $contextmodule = context_module::instance($cm->id);
2306                 if (!$cm->uservisible) {
2307                     // Hold mail notification for assignments the user cannot access until later.
2308                     continue;
2309                 }
2311                 // Need to send this to the student.
2312                 $messagetype = 'feedbackavailable';
2313                 $eventtype = 'assign_notification';
2314                 $updatetime = $submission->lastmodified;
2315                 $modulename = get_string('modulename', 'assign');
2317                 $uniqueid = 0;
2318                 if ($submission->blindmarking && !$submission->revealidentities) {
2319                     if (empty($submission->recordid)) {
2320                         $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $user->id);
2321                     } else {
2322                         $uniqueid = $submission->recordid;
2323                     }
2324                 }
2325                 $showusers = $submission->blindmarking && !$submission->revealidentities;
2326                 self::send_assignment_notification($grader,
2327                                                    $user,
2328                                                    $messagetype,
2329                                                    $eventtype,
2330                                                    $updatetime,
2331                                                    $cm,
2332                                                    $contextmodule,
2333                                                    $course,
2334                                                    $modulename,
2335                                                    $submission->name,
2336                                                    $showusers,
2337                                                    $uniqueid);
2339                 $flags = $DB->get_record('assign_user_flags', array('userid'=>$user->id, 'assignment'=>$submission->assignment));
2340                 if ($flags) {
2341                     $flags->mailed = 1;
2342                     $DB->update_record('assign_user_flags', $flags);
2343                 } else {
2344                     $flags = new stdClass();
2345                     $flags->userid = $user->id;
2346                     $flags->assignment = $submission->assignment;
2347                     $flags->mailed = 1;
2348                     $DB->insert_record('assign_user_flags', $flags);
2349                 }
2351                 mtrace('Done');
2352             }
2353             mtrace('Done processing ' . count($submissions) . ' assignment submissions');
2355             cron_setup_user();
2357             // Free up memory just to be sure.
2358             unset($courses);
2359         }
2361         // Update calendar events to provide a description.
2362         $sql = 'SELECT id
2363                     FROM {assign}
2364                     WHERE
2365                         allowsubmissionsfromdate >= :lastcron AND
2366                         allowsubmissionsfromdate <= :timenow AND
2367                         alwaysshowdescription = 0';
2368         $params = array('lastcron' => $lastcron, 'timenow' => $timenow);
2369         $newlyavailable = $DB->get_records_sql($sql, $params);
2370         foreach ($newlyavailable as $record) {
2371             $cm = get_coursemodule_from_instance('assign', $record->id, 0, false, MUST_EXIST);
2372             $context = context_module::instance($cm->id);
2374             $assignment = new assign($context, null, null);
2375             $assignment->update_calendar($cm->id);
2376         }
2378         return true;
2379     }
2381     /**
2382      * Mark in the database that this grade record should have an update notification sent by cron.
2383      *
2384      * @param stdClass $grade a grade record keyed on id
2385      * @param bool $mailedoverride when true, flag notification to be sent again.
2386      * @return bool true for success
2387      */
2388     public function notify_grade_modified($grade, $mailedoverride = false) {
2389         global $DB;
2391         $flags = $this->get_user_flags($grade->userid, true);
2392         if ($flags->mailed != 1 || $mailedoverride) {
2393             $flags->mailed = 0;
2394         }
2396         return $this->update_user_flags($flags);
2397     }
2399     /**
2400      * Update user flags for this user in this assignment.
2401      *
2402      * @param stdClass $flags a flags record keyed on id
2403      * @return bool true for success
2404      */
2405     public function update_user_flags($flags) {
2406         global $DB;
2407         if ($flags->userid <= 0 || $flags->assignment <= 0 || $flags->id <= 0) {
2408             return false;
2409         }
2411         $result = $DB->update_record('assign_user_flags', $flags);
2412         return $result;
2413     }
2415     /**
2416      * Update a grade in the grade table for the assignment and in the gradebook.
2417      *
2418      * @param stdClass $grade a grade record keyed on id
2419      * @param bool $reopenattempt If the attempt reopen method is manual, allow another attempt at this assignment.
2420      * @return bool true for success
2421      */
2422     public function update_grade($grade, $reopenattempt = false) {
2423         global $DB;
2425         $grade->timemodified = time();
2427         if (!empty($grade->workflowstate)) {
2428             $validstates = $this->get_marking_workflow_states_for_current_user();
2429             if (!array_key_exists($grade->workflowstate, $validstates)) {
2430                 return false;
2431             }
2432         }
2434         if ($grade->grade && $grade->grade != -1) {
2435             if ($this->get_instance()->grade > 0) {
2436                 if (!is_numeric($grade->grade)) {
2437                     return false;
2438                 } else if ($grade->grade > $this->get_instance()->grade) {
2439                     return false;
2440                 } else if ($grade->grade < 0) {
2441                     return false;
2442                 }
2443             } else {
2444                 // This is a scale.
2445                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
2446                     $scaleoptions = make_menu_from_list($scale->scale);
2447                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
2448                         return false;
2449                     }
2450                 }
2451             }
2452         }
2454         if (empty($grade->attemptnumber)) {
2455             // Set it to the default.
2456             $grade->attemptnumber = 0;
2457         }
2458         $DB->update_record('assign_grades', $grade);
2460         $submission = null;
2461         if ($this->get_instance()->teamsubmission) {
2462             $submission = $this->get_group_submission($grade->userid, 0, false);
2463         } else {
2464             $submission = $this->get_user_submission($grade->userid, false);
2465         }
2467         // Only push to gradebook if the update is for the latest attempt.
2468         // Not the latest attempt.
2469         if ($submission && $submission->attemptnumber != $grade->attemptnumber) {
2470             return true;
2471         }
2473         if ($this->gradebook_item_update(null, $grade)) {
2474             \mod_assign\event\submission_graded::create_from_grade($this, $grade)->trigger();
2475         }
2477         // If the conditions are met, allow another attempt.
2478         if ($submission) {
2479             $this->reopen_submission_if_required($grade->userid,
2480                     $submission,
2481                     $reopenattempt);
2482         }
2484         return true;
2485     }
2487     /**
2488      * View the grant extension date page.
2489      *
2490      * Uses url parameters 'userid'
2491      * or from parameter 'selectedusers'
2492      *
2493      * @param moodleform $mform - Used for validation of the submitted data
2494      * @return string
2495      */
2496     protected function view_grant_extension($mform) {
2497         global $CFG;
2498         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
2500         $o = '';
2502         $data = new stdClass();
2503         $data->id = $this->get_course_module()->id;
2505         $formparams = array(
2506             'instance' => $this->get_instance(),
2507             'assign' => $this
2508         );
2510         $users = optional_param('userid', 0, PARAM_INT);
2511         if (!$users) {
2512             $users = required_param('selectedusers', PARAM_SEQUENCE);
2513         }
2514         $userlist = explode(',', $users);
2516         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
2517         $maxoverride = array('allowsubmissionsfromdate' => 0, 'duedate' => 0, 'cutoffdate' => 0);
2518         foreach ($userlist as $userid) {
2519             // To validate extension date with users overrides.
2520             $override = $this->override_exists($userid);
2521             foreach ($keys as $key) {
2522                 if ($override->{$key}) {
2523                     if ($maxoverride[$key] < $override->{$key}) {
2524                         $maxoverride[$key] = $override->{$key};
2525                     }
2526                 } else if ($maxoverride[$key] < $this->get_instance()->{$key}) {
2527                     $maxoverride[$key] = $this->get_instance()->{$key};
2528                 }
2529             }
2530         }
2531         foreach ($keys as $key) {
2532             if ($maxoverride[$key]) {
2533                 $this->get_instance()->{$key} = $maxoverride[$key];
2534             }
2535         }
2537         $formparams['userlist'] = $userlist;
2539         $data->selectedusers = $users;
2540         $data->userid = 0;
2542         if (empty($mform)) {
2543             $mform = new mod_assign_extension_form(null, $formparams);
2544         }
2545         $mform->set_data($data);
2546         $header = new assign_header($this->get_instance(),
2547                                     $this->get_context(),
2548                                     $this->show_intro(),
2549                                     $this->get_course_module()->id,
2550                                     get_string('grantextension', 'assign'));
2551         $o .= $this->get_renderer()->render($header);
2552         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
2553         $o .= $this->view_footer();
2554         return $o;
2555     }
2557     /**
2558      * Get a list of the users in the same group as this user.
2559      *
2560      * @param int $groupid The id of the group whose members we want or 0 for the default group
2561      * @param bool $onlyids Whether to retrieve only the user id's
2562      * @param bool $excludesuspended Whether to exclude suspended users
2563      * @return array The users (possibly id's only)
2564      */
2565     public function get_submission_group_members($groupid, $onlyids, $excludesuspended = false) {
2566         $members = array();
2567         if ($groupid != 0) {
2568             $allusers = $this->list_participants($groupid, $onlyids);
2569             foreach ($allusers as $user) {
2570                 if ($this->get_submission_group($user->id)) {
2571                     $members[] = $user;
2572                 }
2573             }
2574         } else {
2575             $allusers = $this->list_participants(null, $onlyids);
2576             foreach ($allusers as $user) {
2577                 if ($this->get_submission_group($user->id) == null) {
2578                     $members[] = $user;
2579                 }
2580             }
2581         }
2582         // Exclude suspended users, if user can't see them.
2583         if ($excludesuspended || !has_capability('moodle/course:viewsuspendedusers', $this->context)) {
2584             foreach ($members as $key => $member) {
2585                 if (!$this->is_active_user($member->id)) {
2586                     unset($members[$key]);
2587                 }
2588             }
2589         }
2591         return $members;
2592     }
2594     /**
2595      * Get a list of the users in the same group as this user that have not submitted the assignment.
2596      *
2597      * @param int $groupid The id of the group whose members we want or 0 for the default group
2598      * @param bool $onlyids Whether to retrieve only the user id's
2599      * @return array The users (possibly id's only)
2600      */
2601     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
2602         $instance = $this->get_instance();
2603         if (!$instance->teamsubmission || !$instance->requireallteammemberssubmit) {
2604             return array();
2605         }
2606         $members = $this->get_submission_group_members($groupid, $onlyids);
2608         foreach ($members as $id => $member) {
2609             $submission = $this->get_user_submission($member->id, false);
2610             if ($submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2611                 unset($members[$id]);
2612             } else {
2613                 if ($this->is_blind_marking()) {
2614                     $members[$id]->alias = get_string('hiddenuser', 'assign') .
2615                                            $this->get_uniqueid_for_user($id);
2616                 }
2617             }
2618         }
2619         return $members;
2620     }
2622     /**
2623      * Load the group submission object for a particular user, optionally creating it if required.
2624      *
2625      * @param int $userid The id of the user whose submission we want
2626      * @param int $groupid The id of the group for this user - may be 0 in which
2627      *                     case it is determined from the userid.
2628      * @param bool $create If set to true a new submission object will be created in the database
2629      *                     with the status set to "new".
2630      * @param int $attemptnumber - -1 means the latest attempt
2631      * @return stdClass The submission
2632      */
2633     public function get_group_submission($userid, $groupid, $create, $attemptnumber=-1) {
2634         global $DB;
2636         if ($groupid == 0) {
2637             $group = $this->get_submission_group($userid);
2638             if ($group) {
2639                 $groupid = $group->id;
2640             }
2641         }
2643         // Now get the group submission.
2644         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2645         if ($attemptnumber >= 0) {
2646             $params['attemptnumber'] = $attemptnumber;
2647         }
2649         // Only return the row with the highest attemptnumber.
2650         $submission = null;
2651         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2652         if ($submissions) {
2653             $submission = reset($submissions);
2654         }
2656         if ($submission) {
2657             return $submission;
2658         }
2659         if ($create) {
2660             $submission = new stdClass();
2661             $submission->assignment = $this->get_instance()->id;
2662             $submission->userid = 0;
2663             $submission->groupid = $groupid;
2664             $submission->timecreated = time();
2665             $submission->timemodified = $submission->timecreated;
2666             if ($attemptnumber >= 0) {
2667                 $submission->attemptnumber = $attemptnumber;
2668             } else {
2669                 $submission->attemptnumber = 0;
2670             }
2671             // Work out if this is the latest submission.
2672             $submission->latest = 0;
2673             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2674             if ($attemptnumber == -1) {
2675                 // This is a new submission so it must be the latest.
2676                 $submission->latest = 1;
2677             } else {
2678                 // We need to work this out.
2679                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2680                 if ($result) {
2681                     $latestsubmission = reset($result);
2682                 }
2683                 if (!$latestsubmission || ($attemptnumber == $latestsubmission->attemptnumber)) {
2684                     $submission->latest = 1;
2685                 }
2686             }
2687             if ($submission->latest) {
2688                 // This is the case when we need to set latest to 0 for all the other attempts.
2689                 $DB->set_field('assign_submission', 'latest', 0, $params);
2690             }
2691             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2692             $sid = $DB->insert_record('assign_submission', $submission);
2693             return $DB->get_record('assign_submission', array('id' => $sid));
2694         }
2695         return false;
2696     }
2698     /**
2699      * View a summary listing of all assignments in the current course.
2700      *
2701      * @return string
2702      */
2703     private function view_course_index() {
2704         global $USER;
2706         $o = '';
2708         $course = $this->get_course();
2709         $strplural = get_string('modulenameplural', 'assign');
2711         if (!$cms = get_coursemodules_in_course('assign', $course->id, 'm.duedate')) {
2712             $o .= $this->get_renderer()->notification(get_string('thereareno', 'moodle', $strplural));
2713             $o .= $this->get_renderer()->continue_button(new moodle_url('/course/view.php', array('id' => $course->id)));
2714             return $o;
2715         }
2717         $strsectionname = '';
2718         $usesections = course_format_uses_sections($course->format);
2719         $modinfo = get_fast_modinfo($course);
2721         if ($usesections) {
2722             $strsectionname = get_string('sectionname', 'format_'.$course->format);
2723             $sections = $modinfo->get_section_info_all();
2724         }
2725         $courseindexsummary = new assign_course_index_summary($usesections, $strsectionname);
2727         $timenow = time();
2729         $currentsection = '';
2730         foreach ($modinfo->instances['assign'] as $cm) {
2731             if (!$cm->uservisible) {
2732                 continue;
2733             }
2735             $timedue = $cms[$cm->id]->duedate;
2737             $sectionname = '';
2738             if ($usesections && $cm->sectionnum) {
2739                 $sectionname = get_section_name($course, $sections[$cm->sectionnum]);
2740             }
2742             $submitted = '';
2743             $context = context_module::instance($cm->id);
2745             $assignment = new assign($context, $cm, $course);
2747             // Apply overrides.
2748             $assignment->update_effective_access($USER->id);
2749             $timedue = $assignment->get_instance()->duedate;
2751             if (has_capability('mod/assign:grade', $context)) {
2752                 $submitted = $assignment->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED);
2754             } else if (has_capability('mod/assign:submit', $context)) {
2755                 $usersubmission = $assignment->get_user_submission($USER->id, false);
2757                 if (!empty($usersubmission->status)) {
2758                     $submitted = get_string('submissionstatus_' . $usersubmission->status, 'assign');
2759                 } else {
2760                     $submitted = get_string('submissionstatus_', 'assign');
2761                 }
2762             }
2763             $gradinginfo = grade_get_grades($course->id, 'mod', 'assign', $cm->instance, $USER->id);
2764             if (isset($gradinginfo->items[0]->grades[$USER->id]) &&
2765                     !$gradinginfo->items[0]->grades[$USER->id]->hidden ) {
2766                 $grade = $gradinginfo->items[0]->grades[$USER->id]->str_grade;
2767             } else {
2768                 $grade = '-';
2769             }
2771             $courseindexsummary->add_assign_info($cm->id, $cm->get_formatted_name(), $sectionname, $timedue, $submitted, $grade);
2773         }
2775         $o .= $this->get_renderer()->render($courseindexsummary);
2776         $o .= $this->view_footer();
2778         return $o;
2779     }
2781     /**
2782      * View a page rendered by a plugin.
2783      *
2784      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.
2785      *
2786      * @return string
2787      */
2788     protected function view_plugin_page() {
2789         global $USER;
2791         $o = '';
2793         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
2794         $plugintype = required_param('plugin', PARAM_PLUGIN);
2795         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
2797         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
2798         if (!$plugin) {
2799             print_error('invalidformdata', '');
2800             return;
2801         }
2803         $o .= $plugin->view_page($pluginaction);
2805         return $o;
2806     }
2809     /**
2810      * This is used for team assignments to get the group for the specified user.
2811      * If the user is a member of multiple or no groups this will return false
2812      *
2813      * @param int $userid The id of the user whose submission we want
2814      * @return mixed The group or false
2815      */
2816     public function get_submission_group($userid) {
2818         if (isset($this->usersubmissiongroups[$userid])) {
2819             return $this->usersubmissiongroups[$userid];
2820         }
2822         $groups = $this->get_all_groups($userid);
2823         if (count($groups) != 1) {
2824             $return = false;
2825         } else {
2826             $return = array_pop($groups);
2827         }
2829         // Cache the user submission group.
2830         $this->usersubmissiongroups[$userid] = $return;
2832         return $return;
2833     }
2835     /**
2836      * Gets all groups the user is a member of.
2837      *
2838      * @param int $userid Teh id of the user who's groups we are checking
2839      * @return array The group objects
2840      */
2841     public function get_all_groups($userid) {
2842         if (isset($this->usergroups[$userid])) {
2843             return $this->usergroups[$userid];
2844         }
2846         $grouping = $this->get_instance()->teamsubmissiongroupingid;
2847         $return = groups_get_all_groups($this->get_course()->id, $userid, $grouping);
2849         $this->usergroups[$userid] = $return;
2851         return $return;
2852     }
2855     /**
2856      * Display the submission that is used by a plugin.
2857      *
2858      * Uses url parameters 'sid', 'gid' and 'plugin'.
2859      *
2860      * @param string $pluginsubtype
2861      * @return string
2862      */
2863     protected function view_plugin_content($pluginsubtype) {
2864         $o = '';
2866         $submissionid = optional_param('sid', 0, PARAM_INT);
2867         $gradeid = optional_param('gid', 0, PARAM_INT);
2868         $plugintype = required_param('plugin', PARAM_PLUGIN);
2869         $item = null;
2870         if ($pluginsubtype == 'assignsubmission') {
2871             $plugin = $this->get_submission_plugin_by_type($plugintype);
2872             if ($submissionid <= 0) {
2873                 throw new coding_exception('Submission id should not be 0');
2874             }
2875             $item = $this->get_submission($submissionid);
2877             // Check permissions.
2878             $this->require_view_submission($item->userid);
2879             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2880                                                               $this->get_context(),
2881                                                               $this->show_intro(),
2882                                                               $this->get_course_module()->id,
2883                                                               $plugin->get_name()));
2884             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
2885                                                               $item,
2886                                                               assign_submission_plugin_submission::FULL,
2887                                                               $this->get_course_module()->id,
2888                                                               $this->get_return_action(),
2889                                                               $this->get_return_params()));
2891             // Trigger event for viewing a submission.
2892             \mod_assign\event\submission_viewed::create_from_submission($this, $item)->trigger();
2894         } else {
2895             $plugin = $this->get_feedback_plugin_by_type($plugintype);
2896             if ($gradeid <= 0) {
2897                 throw new coding_exception('Grade id should not be 0');
2898             }
2899             $item = $this->get_grade($gradeid);
2900             // Check permissions.
2901             $this->require_view_submission($item->userid);
2902             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2903                                                               $this->get_context(),
2904                                                               $this->show_intro(),
2905                                                               $this->get_course_module()->id,
2906                                                               $plugin->get_name()));
2907             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
2908                                                               $item,
2909                                                               assign_feedback_plugin_feedback::FULL,
2910                                                               $this->get_course_module()->id,
2911                                                               $this->get_return_action(),
2912                                                               $this->get_return_params()));
2914             // Trigger event for viewing feedback.
2915             \mod_assign\event\feedback_viewed::create_from_grade($this, $item)->trigger();
2916         }
2918         $o .= $this->view_return_links();
2920         $o .= $this->view_footer();
2922         return $o;
2923     }
2925     /**
2926      * Rewrite plugin file urls so they resolve correctly in an exported zip.
2927      *
2928      * @param string $text - The replacement text
2929      * @param stdClass $user - The user record
2930      * @param assign_plugin $plugin - The assignment plugin
2931      */
2932     public function download_rewrite_pluginfile_urls($text, $user, $plugin) {
2933         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2934         $groupname = '';
2935         if ($groupmode) {
2936             $groupid = groups_get_activity_group($this->get_course_module(), true);
2937             $groupname = groups_get_group_name($groupid).'-';
2938         }
2940         if ($this->is_blind_marking()) {
2941             $prefix = $groupname . get_string('participant', 'assign');
2942             $prefix = str_replace('_', ' ', $prefix);
2943             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2944         } else {
2945             $prefix = $groupname . fullname($user);
2946             $prefix = str_replace('_', ' ', $prefix);
2947             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2948         }
2950         $subtype = $plugin->get_subtype();
2951         $type = $plugin->get_type();
2952         $prefix = $prefix . $subtype . '_' . $type . '_';
2954         $result = str_replace('@@PLUGINFILE@@/', $prefix, $text);
2956         return $result;
2957     }
2959     /**
2960      * Render the content in editor that is often used by plugin.
2961      *
2962      * @param string $filearea
2963      * @param int  $submissionid
2964      * @param string $plugintype
2965      * @param string $editor
2966      * @param string $component
2967      * @return string
2968      */
2969     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
2970         global $CFG;
2972         $result = '';
2974         $plugin = $this->get_submission_plugin_by_type($plugintype);
2976         $text = $plugin->get_editor_text($editor, $submissionid);
2977         $format = $plugin->get_editor_format($editor, $submissionid);
2979         $finaltext = file_rewrite_pluginfile_urls($text,
2980                                                   'pluginfile.php',
2981                                                   $this->get_context()->id,
2982                                                   $component,
2983                                                   $filearea,
2984                                                   $submissionid);
2985         $params = array('overflowdiv' => true, 'context' => $this->get_context());
2986         $result .= format_text($finaltext, $format, $params);
2988         if ($CFG->enableportfolios && has_capability('mod/assign:exportownsubmission', $this->context)) {
2989             require_once($CFG->libdir . '/portfoliolib.php');
2991             $button = new portfolio_add_button();
2992             $portfolioparams = array('cmid' => $this->get_course_module()->id,
2993                                      'sid' => $submissionid,
2994                                      'plugin' => $plugintype,
2995                                      'editor' => $editor,
2996                                      'area'=>$filearea);
2997             $button->set_callback_options('assign_portfolio_caller', $portfolioparams, 'mod_assign');
2998             $fs = get_file_storage();
3000             if ($files = $fs->get_area_files($this->context->id,
3001                                              $component,
3002                                              $filearea,
3003                                              $submissionid,
3004                                              'timemodified',
3005                                              false)) {
3006                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3007             } else {
3008                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3009             }
3010             $result .= $button->to_html();
3011         }
3012         return $result;
3013     }
3015     /**
3016      * Display a continue page after grading.
3017      *
3018      * @param string $message - The message to display.
3019      * @return string
3020      */
3021     protected function view_savegrading_result($message) {
3022         $o = '';
3023         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
3024                                                       $this->get_context(),
3025                                                       $this->show_intro(),
3026                                                       $this->get_course_module()->id,
3027                                                       get_string('savegradingresult', 'assign')));
3028         $gradingresult = new assign_gradingmessage(get_string('savegradingresult', 'assign'),
3029                                                    $message,
3030                                                    $this->get_course_module()->id);
3031         $o .= $this->get_renderer()->render($gradingresult);
3032         $o .= $this->view_footer();
3033         return $o;
3034     }
3035     /**
3036      * Display a continue page after quickgrading.
3037      *
3038      * @param string $message - The message to display.
3039      * @return string
3040      */
3041     protected function view_quickgrading_result($message) {
3042         $o = '';
3043         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
3044                                                       $this->get_context(),
3045                                                       $this->show_intro(),
3046                                                       $this->get_course_module()->id,
3047                                                       get_string('quickgradingresult', 'assign')));
3048         $lastpage = optional_param('lastpage', null, PARAM_INT);
3049         $gradingresult = new assign_gradingmessage(get_string('quickgradingresult', 'assign'),
3050                                                    $message,
3051                                                    $this->get_course_module()->id,
3052                                                    false,
3053                                                    $lastpage);
3054         $o .= $this->get_renderer()->render($gradingresult);
3055         $o .= $this->view_footer();
3056         return $o;
3057     }
3059     /**
3060      * Display the page footer.
3061      *
3062      * @return string
3063      */
3064     protected function view_footer() {
3065         // When viewing the footer during PHPUNIT tests a set_state error is thrown.
3066         if (!PHPUNIT_TEST) {
3067             return $this->get_renderer()->render_footer();
3068         }
3070         return '';
3071     }
3073     /**
3074      * Throw an error if the permissions to view this users submission are missing.
3075      *
3076      * @throws required_capability_exception
3077      * @return void
3078      */
3079     public function require_view_submission($userid) {
3080         if (!$this->can_view_submission($userid)) {
3081             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
3082         }
3083     }
3085     /**
3086      * Throw an error if the permissions to view grades in this assignment are missing.
3087      *
3088      * @throws required_capability_exception
3089      * @return void
3090      */
3091     public function require_view_grades() {
3092         if (!$this->can_view_grades()) {
3093             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
3094         }
3095     }
3097     /**
3098      * Does this user have view grade or grade permission for this assignment?
3099      *
3100      * @return bool
3101      */
3102     public function can_view_grades() {
3103         // Permissions check.
3104         if (!has_any_capability(array('mod/assign:viewgrades', 'mod/assign:grade'), $this->context)) {
3105             return false;
3106         }
3107         // Checks for the edge case when user belongs to no groups and groupmode is sep.
3108         if ($this->get_course_module()->effectivegroupmode == SEPARATEGROUPS) {
3109             $groupflag = has_capability('moodle/site:accessallgroups', $this->get_context());
3110             $groupflag = $groupflag || !empty(groups_get_activity_allowed_groups($this->get_course_module()));
3111             return (bool)$groupflag;
3112         }
3113         return true;
3114     }
3116     /**
3117      * Does this user have grade permission for this assignment?
3118      *
3119      * @return bool
3120      */
3121     public function can_grade() {
3122         // Permissions check.
3123         if (!has_capability('mod/assign:grade', $this->context)) {
3124             return false;
3125         }
3127         return true;
3128     }
3130     /**
3131      * Download a zip file of all assignment submissions.
3132      *
3133      * @param array $userids Array of user ids to download assignment submissions in a zip file
3134      * @return string - If an error occurs, this will contain the error page.
3135      */
3136     protected function download_submissions($userids = false) {
3137         global $CFG, $DB;
3139         // More efficient to load this here.
3140         require_once($CFG->libdir.'/filelib.php');
3142         // Increase the server timeout to handle the creation and sending of large zip files.
3143         core_php_time_limit::raise();
3145         $this->require_view_grades();
3147         // Load all users with submit.
3148         $students = get_enrolled_users($this->context, "mod/assign:submit", null, 'u.*', null, null, null,
3149                         $this->show_only_active_users());
3151         // Build a list of files to zip.
3152         $filesforzipping = array();
3153         $fs = get_file_storage();
3155         $groupmode = groups_get_activity_groupmode($this->get_course_module());
3156         // All users.
3157         $groupid = 0;
3158         $groupname = '';
3159         if ($groupmode) {
3160             $groupid = groups_get_activity_group($this->get_course_module(), true);
3161             $groupname = groups_get_group_name($groupid).'-';
3162         }
3164         // Construct the zip file name.
3165         $filename = clean_filename($this->get_course()->shortname . '-' .
3166                                    $this->get_instance()->name . '-' .
3167                                    $groupname.$this->get_course_module()->id . '.zip');
3169         // Get all the files for each student.
3170         foreach ($students as $student) {
3171             $userid = $student->id;
3172             // Download all assigments submission or only selected users.
3173             if ($userids and !in_array($userid, $userids)) {
3174                 continue;
3175             }
3177             if ((groups_is_member($groupid, $userid) or !$groupmode or !$groupid)) {
3178                 // Get the plugins to add their own files to the zip.
3180                 $submissiongroup = false;
3181                 $groupname = '';
3182                 if ($this->get_instance()->teamsubmission) {
3183                     $submission = $this->get_group_submission($userid, 0, false);
3184                     $submissiongroup = $this->get_submission_group($userid);
3185                     if ($submissiongroup) {
3186                         $groupname = $submissiongroup->name . '-';
3187                     } else {
3188                         $groupname = get_string('defaultteam', 'assign') . '-';
3189                     }
3190                 } else {
3191                     $submission = $this->get_user_submission($userid, false);
3192                 }
3194                 if ($this->is_blind_marking()) {
3195                     $prefix = str_replace('_', ' ', $groupname . get_string('participant', 'assign'));
3196                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid));
3197                 } else {
3198                     $prefix = str_replace('_', ' ', $groupname . fullname($student));
3199                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid));
3200                 }
3202                 if ($submission) {
3203                     $downloadasfolders = get_user_preferences('assign_downloadasfolders', 1);
3204                     foreach ($this->submissionplugins as $plugin) {
3205                         if ($plugin->is_enabled() && $plugin->is_visible()) {
3206                             if ($downloadasfolders) {
3207                                 // Create a folder for each user for each assignment plugin.
3208                                 // This is the default behavior for version of Moodle >= 3.1.
3209                                 $submission->exportfullpath = true;
3210                                 $pluginfiles = $plugin->get_files($submission, $student);
3211                                 foreach ($pluginfiles as $zipfilepath => $file) {
3212                                     $subtype = $plugin->get_subtype();
3213                                     $type = $plugin->get_type();
3214                                     $zipfilename = basename($zipfilepath);
3215                                     $prefixedfilename = clean_filename($prefix .
3216                                                                        '_' .
3217                                                                        $subtype .
3218                                                                        '_' .
3219                                                                        $type .
3220                                                                        '_');
3221                                     if ($type == 'file') {
3222                                         $pathfilename = $prefixedfilename . $file->get_filepath() . $zipfilename;
3223                                     } else if ($type == 'onlinetext') {
3224                                         $pathfilename = $prefixedfilename . '/' . $zipfilename;
3225                                     } else {
3226                                         $pathfilename = $prefixedfilename . '/' . $zipfilename;
3227                                     }
3228                                     $pathfilename = clean_param($pathfilename, PARAM_PATH);
3229                                     $filesforzipping[$pathfilename] = $file;
3230                                 }
3231                             } else {
3232                                 // Create a single folder for all users of all assignment plugins.
3233                                 // This was the default behavior for version of Moodle < 3.1.
3234                                 $submission->exportfullpath = false;
3235                                 $pluginfiles = $plugin->get_files($submission, $student);
3236                                 foreach ($pluginfiles as $zipfilename => $file) {
3237                                     $subtype = $plugin->get_subtype();
3238                                     $type = $plugin->get_type();
3239                                     $prefixedfilename = clean_filename($prefix .
3240                                                                        '_' .
3241                                                                        $subtype .
3242                                                                        '_' .
3243                                                                        $type .
3244                                                                        '_' .
3245                                                                        $zipfilename);
3246                                     $filesforzipping[$prefixedfilename] = $file;
3247                                 }
3248                             }
3249                         }
3250                     }
3251                 }
3252             }
3253         }
3254         $result = '';
3255         if (count($filesforzipping) == 0) {
3256             $header = new assign_header($this->get_instance(),
3257                                         $this->get_context(),
3258                                         '',
3259                                         $this->get_course_module()->id,
3260                                         get_string('downloadall', 'assign'));
3261             $result .= $this->get_renderer()->render($header);
3262             $result .= $this->get_renderer()->notification(get_string('nosubmission', 'assign'));
3263             $url = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
3264                                                                     'action'=>'grading'));
3265             $result .= $this->get_renderer()->continue_button($url);
3266             $result .= $this->view_footer();
3267         } else if ($zipfile = $this->pack_files($filesforzipping)) {
3268             \mod_assign\event\all_submissions_downloaded::create_from_assign($this)->trigger();
3269             // Send file and delete after sending.
3270             send_temp_file($zipfile, $filename);
3271             // We will not get here - send_temp_file calls exit.
3272         }
3273         return $result;
3274     }