8c4aacebcac5d22f5056cced1241cdbd2c735fd3
[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');
41 // Marker filter for grading page.
42 define('ASSIGN_MARKER_FILTER_NO_MARKER', -1);
44 // Reopen attempt methods.
45 define('ASSIGN_ATTEMPT_REOPEN_METHOD_NONE', 'none');
46 define('ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL', 'manual');
47 define('ASSIGN_ATTEMPT_REOPEN_METHOD_UNTILPASS', 'untilpass');
49 // Special value means allow unlimited attempts.
50 define('ASSIGN_UNLIMITED_ATTEMPTS', -1);
52 // Grading states.
53 define('ASSIGN_GRADING_STATUS_GRADED', 'graded');
54 define('ASSIGN_GRADING_STATUS_NOT_GRADED', 'notgraded');
56 // Marking workflow states.
57 define('ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED', 'notmarked');
58 define('ASSIGN_MARKING_WORKFLOW_STATE_INMARKING', 'inmarking');
59 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORREVIEW', 'readyforreview');
60 define('ASSIGN_MARKING_WORKFLOW_STATE_INREVIEW', 'inreview');
61 define('ASSIGN_MARKING_WORKFLOW_STATE_READYFORRELEASE', 'readyforrelease');
62 define('ASSIGN_MARKING_WORKFLOW_STATE_RELEASED', 'released');
64 /** ASSIGN_MAX_EVENT_LENGTH = 432000 ; 5 days maximum */
65 define("ASSIGN_MAX_EVENT_LENGTH", "432000");
67 // Name of file area for intro attachments.
68 define('ASSIGN_INTROATTACHMENT_FILEAREA', 'introattachment');
70 require_once($CFG->libdir . '/accesslib.php');
71 require_once($CFG->libdir . '/formslib.php');
72 require_once($CFG->dirroot . '/repository/lib.php');
73 require_once($CFG->dirroot . '/mod/assign/mod_form.php');
74 require_once($CFG->libdir . '/gradelib.php');
75 require_once($CFG->dirroot . '/grade/grading/lib.php');
76 require_once($CFG->dirroot . '/mod/assign/feedbackplugin.php');
77 require_once($CFG->dirroot . '/mod/assign/submissionplugin.php');
78 require_once($CFG->dirroot . '/mod/assign/renderable.php');
79 require_once($CFG->dirroot . '/mod/assign/gradingtable.php');
80 require_once($CFG->libdir . '/eventslib.php');
81 require_once($CFG->libdir . '/portfolio/caller.php');
83 use \mod_assign\output\grading_app;
85 /**
86  * Standard base class for mod_assign (assignment types).
87  *
88  * @package   mod_assign
89  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
90  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
91  */
92 class assign {
94     /** @var stdClass the assignment record that contains the global settings for this assign instance */
95     private $instance;
97     /** @var grade_item the grade_item record for this assign instance's primary grade item. */
98     private $gradeitem;
100     /** @var context the context of the course module for this assign instance
101      *               (or just the course if we are creating a new one)
102      */
103     private $context;
105     /** @var stdClass the course this assign instance belongs to */
106     private $course;
108     /** @var stdClass the admin config for all assign instances  */
109     private $adminconfig;
111     /** @var assign_renderer the custom renderer for this module */
112     private $output;
114     /** @var cm_info the course module for this assign instance */
115     private $coursemodule;
117     /** @var array cache for things like the coursemodule name or the scale menu -
118      *             only lives for a single request.
119      */
120     private $cache;
122     /** @var array list of the installed submission plugins */
123     private $submissionplugins;
125     /** @var array list of the installed feedback plugins */
126     private $feedbackplugins;
128     /** @var string action to be used to return to this page
129      *              (without repeating any form submissions etc).
130      */
131     private $returnaction = 'view';
133     /** @var array params to be used to return to this page */
134     private $returnparams = array();
136     /** @var string modulename prevents excessive calls to get_string */
137     private static $modulename = null;
139     /** @var string modulenameplural prevents excessive calls to get_string */
140     private static $modulenameplural = null;
142     /** @var array of marking workflow states for the current user */
143     private $markingworkflowstates = null;
145     /** @var bool whether to exclude users with inactive enrolment */
146     private $showonlyactiveenrol = null;
148     /** @var string A key used to identify userlists created by this object. */
149     private $useridlistid = null;
151     /** @var array cached list of participants for this assignment. The cache key will be group, showactive and the context id */
152     private $participants = array();
154     /** @var array cached list of user groups when team submissions are enabled. The cache key will be the user. */
155     private $usersubmissiongroups = array();
157     /** @var array cached list of user groups. The cache key will be the user. */
158     private $usergroups = array();
160     /** @var array cached list of IDs of users who share group membership with the user. The cache key will be the user. */
161     private $sharedgroupmembers = array();
163     /**
164      * Constructor for the base assign class.
165      *
166      * Note: For $coursemodule you can supply a stdclass if you like, but it
167      * will be more efficient to supply a cm_info object.
168      *
169      * @param mixed $coursemodulecontext context|null the course module context
170      *                                   (or the course context if the coursemodule has not been
171      *                                   created yet).
172      * @param mixed $coursemodule the current course module if it was already loaded,
173      *                            otherwise this class will load one from the context as required.
174      * @param mixed $course the current course  if it was already loaded,
175      *                      otherwise this class will load one from the context as required.
176      */
177     public function __construct($coursemodulecontext, $coursemodule, $course) {
178         global $SESSION;
180         $this->context = $coursemodulecontext;
181         $this->course = $course;
183         // Ensure that $this->coursemodule is a cm_info object (or null).
184         $this->coursemodule = cm_info::create($coursemodule);
186         // Temporary cache only lives for a single request - used to reduce db lookups.
187         $this->cache = array();
189         $this->submissionplugins = $this->load_plugins('assignsubmission');
190         $this->feedbackplugins = $this->load_plugins('assignfeedback');
192         // Extra entropy is required for uniqid() to work on cygwin.
193         $this->useridlistid = clean_param(uniqid('', true), PARAM_ALPHANUM);
195         if (!isset($SESSION->mod_assign_useridlist)) {
196             $SESSION->mod_assign_useridlist = [];
197         }
198     }
200     /**
201      * Set the action and parameters that can be used to return to the current page.
202      *
203      * @param string $action The action for the current page
204      * @param array $params An array of name value pairs which form the parameters
205      *                      to return to the current page.
206      * @return void
207      */
208     public function register_return_link($action, $params) {
209         global $PAGE;
210         $params['action'] = $action;
211         $cm = $this->get_course_module();
212         if ($cm) {
213             $currenturl = new moodle_url('/mod/assign/view.php', array('id' => $cm->id));
214         } else {
215             $currenturl = new moodle_url('/mod/assign/index.php', array('id' => $this->get_course()->id));
216         }
218         $currenturl->params($params);
219         $PAGE->set_url($currenturl);
220     }
222     /**
223      * Return an action that can be used to get back to the current page.
224      *
225      * @return string action
226      */
227     public function get_return_action() {
228         global $PAGE;
230         // Web services don't set a URL, we should avoid debugging when ussing the url object.
231         if (!WS_SERVER) {
232             $params = $PAGE->url->params();
233         }
235         if (!empty($params['action'])) {
236             return $params['action'];
237         }
238         return '';
239     }
241     /**
242      * Based on the current assignment settings should we display the intro.
243      *
244      * @return bool showintro
245      */
246     public function show_intro() {
247         if ($this->get_instance()->alwaysshowdescription ||
248                 time() > $this->get_instance()->allowsubmissionsfromdate) {
249             return true;
250         }
251         return false;
252     }
254     /**
255      * Return a list of parameters that can be used to get back to the current page.
256      *
257      * @return array params
258      */
259     public function get_return_params() {
260         global $PAGE;
262         $params = $PAGE->url->params();
263         unset($params['id']);
264         unset($params['action']);
265         return $params;
266     }
268     /**
269      * Set the submitted form data.
270      *
271      * @param stdClass $data The form data (instance)
272      */
273     public function set_instance(stdClass $data) {
274         $this->instance = $data;
275     }
277     /**
278      * Set the context.
279      *
280      * @param context $context The new context
281      */
282     public function set_context(context $context) {
283         $this->context = $context;
284     }
286     /**
287      * Set the course data.
288      *
289      * @param stdClass $course The course data
290      */
291     public function set_course(stdClass $course) {
292         $this->course = $course;
293     }
295     /**
296      * Get list of feedback plugins installed.
297      *
298      * @return array
299      */
300     public function get_feedback_plugins() {
301         return $this->feedbackplugins;
302     }
304     /**
305      * Get list of submission plugins installed.
306      *
307      * @return array
308      */
309     public function get_submission_plugins() {
310         return $this->submissionplugins;
311     }
313     /**
314      * Is blind marking enabled and reveal identities not set yet?
315      *
316      * @return bool
317      */
318     public function is_blind_marking() {
319         return $this->get_instance()->blindmarking && !$this->get_instance()->revealidentities;
320     }
322     /**
323      * Does an assignment have submission(s) or grade(s) already?
324      *
325      * @return bool
326      */
327     public function has_submissions_or_grades() {
328         $allgrades = $this->count_grades();
329         $allsubmissions = $this->count_submissions();
330         if (($allgrades == 0) && ($allsubmissions == 0)) {
331             return false;
332         }
333         return true;
334     }
336     /**
337      * Get a specific submission plugin by its type.
338      *
339      * @param string $subtype assignsubmission | assignfeedback
340      * @param string $type
341      * @return mixed assign_plugin|null
342      */
343     public function get_plugin_by_type($subtype, $type) {
344         $shortsubtype = substr($subtype, strlen('assign'));
345         $name = $shortsubtype . 'plugins';
346         if ($name != 'feedbackplugins' && $name != 'submissionplugins') {
347             return null;
348         }
349         $pluginlist = $this->$name;
350         foreach ($pluginlist as $plugin) {
351             if ($plugin->get_type() == $type) {
352                 return $plugin;
353             }
354         }
355         return null;
356     }
358     /**
359      * Get a feedback plugin by type.
360      *
361      * @param string $type - The type of plugin e.g comments
362      * @return mixed assign_feedback_plugin|null
363      */
364     public function get_feedback_plugin_by_type($type) {
365         return $this->get_plugin_by_type('assignfeedback', $type);
366     }
368     /**
369      * Get a submission plugin by type.
370      *
371      * @param string $type - The type of plugin e.g comments
372      * @return mixed assign_submission_plugin|null
373      */
374     public function get_submission_plugin_by_type($type) {
375         return $this->get_plugin_by_type('assignsubmission', $type);
376     }
378     /**
379      * Load the plugins from the sub folders under subtype.
380      *
381      * @param string $subtype - either submission or feedback
382      * @return array - The sorted list of plugins
383      */
384     public function load_plugins($subtype) {
385         global $CFG;
386         $result = array();
388         $names = core_component::get_plugin_list($subtype);
390         foreach ($names as $name => $path) {
391             if (file_exists($path . '/locallib.php')) {
392                 require_once($path . '/locallib.php');
394                 $shortsubtype = substr($subtype, strlen('assign'));
395                 $pluginclass = 'assign_' . $shortsubtype . '_' . $name;
397                 $plugin = new $pluginclass($this, $name);
399                 if ($plugin instanceof assign_plugin) {
400                     $idx = $plugin->get_sort_order();
401                     while (array_key_exists($idx, $result)) {
402                         $idx +=1;
403                     }
404                     $result[$idx] = $plugin;
405                 }
406             }
407         }
408         ksort($result);
409         return $result;
410     }
412     /**
413      * Display the assignment, used by view.php
414      *
415      * The assignment is displayed differently depending on your role,
416      * the settings for the assignment and the status of the assignment.
417      *
418      * @param string $action The current action if any.
419      * @param array $args Optional arguments to pass to the view (instead of getting them from GET and POST).
420      * @return string - The page output.
421      */
422     public function view($action='', $args = array()) {
423         global $PAGE;
425         $o = '';
426         $mform = null;
427         $notices = array();
428         $nextpageparams = array();
430         if (!empty($this->get_course_module()->id)) {
431             $nextpageparams['id'] = $this->get_course_module()->id;
432         }
434         // Handle form submissions first.
435         if ($action == 'savesubmission') {
436             $action = 'editsubmission';
437             if ($this->process_save_submission($mform, $notices)) {
438                 $action = 'redirect';
439                 $nextpageparams['action'] = 'view';
440             }
441         } else if ($action == 'editprevioussubmission') {
442             $action = 'editsubmission';
443             if ($this->process_copy_previous_attempt($notices)) {
444                 $action = 'redirect';
445                 $nextpageparams['action'] = 'editsubmission';
446             }
447         } else if ($action == 'lock') {
448             $this->process_lock_submission();
449             $action = 'redirect';
450             $nextpageparams['action'] = 'grading';
451         } else if ($action == 'addattempt') {
452             $this->process_add_attempt(required_param('userid', PARAM_INT));
453             $action = 'redirect';
454             $nextpageparams['action'] = 'grading';
455         } else if ($action == 'reverttodraft') {
456             $this->process_revert_to_draft();
457             $action = 'redirect';
458             $nextpageparams['action'] = 'grading';
459         } else if ($action == 'unlock') {
460             $this->process_unlock_submission();
461             $action = 'redirect';
462             $nextpageparams['action'] = 'grading';
463         } else if ($action == 'setbatchmarkingworkflowstate') {
464             $this->process_set_batch_marking_workflow_state();
465             $action = 'redirect';
466             $nextpageparams['action'] = 'grading';
467         } else if ($action == 'setbatchmarkingallocation') {
468             $this->process_set_batch_marking_allocation();
469             $action = 'redirect';
470             $nextpageparams['action'] = 'grading';
471         } else if ($action == 'confirmsubmit') {
472             $action = 'submit';
473             if ($this->process_submit_for_grading($mform, $notices)) {
474                 $action = 'redirect';
475                 $nextpageparams['action'] = 'view';
476             } else if ($notices) {
477                 $action = 'viewsubmitforgradingerror';
478             }
479         } else if ($action == 'submitotherforgrading') {
480             if ($this->process_submit_other_for_grading($mform, $notices)) {
481                 $action = 'redirect';
482                 $nextpageparams['action'] = 'grading';
483             } else {
484                 $action = 'viewsubmitforgradingerror';
485             }
486         } else if ($action == 'gradingbatchoperation') {
487             $action = $this->process_grading_batch_operation($mform);
488             if ($action == 'grading') {
489                 $action = 'redirect';
490                 $nextpageparams['action'] = 'grading';
491             }
492         } else if ($action == 'submitgrade') {
493             if (optional_param('saveandshownext', null, PARAM_RAW)) {
494                 // Save and show next.
495                 $action = 'grade';
496                 if ($this->process_save_grade($mform)) {
497                     $action = 'redirect';
498                     $nextpageparams['action'] = 'grade';
499                     $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
500                     $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
501                 }
502             } else if (optional_param('nosaveandprevious', null, PARAM_RAW)) {
503                 $action = 'redirect';
504                 $nextpageparams['action'] = 'grade';
505                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) - 1;
506                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
507             } else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
508                 $action = 'redirect';
509                 $nextpageparams['action'] = 'grade';
510                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
511                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
512             } else if (optional_param('savegrade', null, PARAM_RAW)) {
513                 // Save changes button.
514                 $action = 'grade';
515                 if ($this->process_save_grade($mform)) {
516                     $action = 'redirect';
517                     $nextpageparams['action'] = 'savegradingresult';
518                 }
519             } else {
520                 // Cancel button.
521                 $action = 'redirect';
522                 $nextpageparams['action'] = 'grading';
523             }
524         } else if ($action == 'quickgrade') {
525             $message = $this->process_save_quick_grades();
526             $action = 'quickgradingresult';
527         } else if ($action == 'saveoptions') {
528             $this->process_save_grading_options();
529             $action = 'redirect';
530             $nextpageparams['action'] = 'grading';
531         } else if ($action == 'saveextension') {
532             $action = 'grantextension';
533             if ($this->process_save_extension($mform)) {
534                 $action = 'redirect';
535                 $nextpageparams['action'] = 'grading';
536             }
537         } else if ($action == 'revealidentitiesconfirm') {
538             $this->process_reveal_identities();
539             $action = 'redirect';
540             $nextpageparams['action'] = 'grading';
541         }
543         $returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT),
544                               'useridlistid' => optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM));
545         $this->register_return_link($action, $returnparams);
547         // Include any page action as part of the body tag CSS id.
548         if (!empty($action)) {
549             $PAGE->set_pagetype('mod-assign-' . $action);
550         }
551         // Now show the right view page.
552         if ($action == 'redirect') {
553             $nextpageurl = new moodle_url('/mod/assign/view.php', $nextpageparams);
554             redirect($nextpageurl);
555             return;
556         } else if ($action == 'savegradingresult') {
557             $message = get_string('gradingchangessaved', 'assign');
558             $o .= $this->view_savegrading_result($message);
559         } else if ($action == 'quickgradingresult') {
560             $mform = null;
561             $o .= $this->view_quickgrading_result($message);
562         } else if ($action == 'gradingpanel') {
563             $o .= $this->view_single_grading_panel($args);
564         } else if ($action == 'grade') {
565             $o .= $this->view_single_grade_page($mform);
566         } else if ($action == 'viewpluginassignfeedback') {
567             $o .= $this->view_plugin_content('assignfeedback');
568         } else if ($action == 'viewpluginassignsubmission') {
569             $o .= $this->view_plugin_content('assignsubmission');
570         } else if ($action == 'editsubmission') {
571             $o .= $this->view_edit_submission_page($mform, $notices);
572         } else if ($action == 'grader') {
573             $o .= $this->view_grader();
574         } else if ($action == 'grading') {
575             $o .= $this->view_grading_page();
576         } else if ($action == 'downloadall') {
577             $o .= $this->download_submissions();
578         } else if ($action == 'submit') {
579             $o .= $this->check_submit_for_grading($mform);
580         } else if ($action == 'grantextension') {
581             $o .= $this->view_grant_extension($mform);
582         } else if ($action == 'revealidentities') {
583             $o .= $this->view_reveal_identities_confirm($mform);
584         } else if ($action == 'plugingradingbatchoperation') {
585             $o .= $this->view_plugin_grading_batch_operation($mform);
586         } else if ($action == 'viewpluginpage') {
587              $o .= $this->view_plugin_page();
588         } else if ($action == 'viewcourseindex') {
589              $o .= $this->view_course_index();
590         } else if ($action == 'viewbatchsetmarkingworkflowstate') {
591              $o .= $this->view_batch_set_workflow_state($mform);
592         } else if ($action == 'viewbatchmarkingallocation') {
593             $o .= $this->view_batch_markingallocation($mform);
594         } else if ($action == 'viewsubmitforgradingerror') {
595             $o .= $this->view_error_page(get_string('submitforgrading', 'assign'), $notices);
596         } else {
597             $o .= $this->view_submission_page();
598         }
600         return $o;
601     }
603     /**
604      * Add this instance to the database.
605      *
606      * @param stdClass $formdata The data submitted from the form
607      * @param bool $callplugins This is used to skip the plugin code
608      *             when upgrading an old assignment to a new one (the plugins get called manually)
609      * @return mixed false if an error occurs or the int id of the new instance
610      */
611     public function add_instance(stdClass $formdata, $callplugins) {
612         global $DB;
613         $adminconfig = $this->get_admin_config();
615         $err = '';
617         // Add the database record.
618         $update = new stdClass();
619         $update->name = $formdata->name;
620         $update->timemodified = time();
621         $update->timecreated = time();
622         $update->course = $formdata->course;
623         $update->courseid = $formdata->course;
624         $update->intro = $formdata->intro;
625         $update->introformat = $formdata->introformat;
626         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
627         $update->submissiondrafts = $formdata->submissiondrafts;
628         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
629         $update->sendnotifications = $formdata->sendnotifications;
630         $update->sendlatenotifications = $formdata->sendlatenotifications;
631         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
632         if (isset($formdata->sendstudentnotifications)) {
633             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
634         }
635         $update->duedate = $formdata->duedate;
636         $update->cutoffdate = $formdata->cutoffdate;
637         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
638         $update->grade = $formdata->grade;
639         $update->completionsubmit = !empty($formdata->completionsubmit);
640         $update->teamsubmission = $formdata->teamsubmission;
641         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
642         if (isset($formdata->teamsubmissiongroupingid)) {
643             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
644         }
645         $update->blindmarking = $formdata->blindmarking;
646         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
647         if (!empty($formdata->attemptreopenmethod)) {
648             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
649         }
650         if (!empty($formdata->maxattempts)) {
651             $update->maxattempts = $formdata->maxattempts;
652         }
653         if (isset($formdata->preventsubmissionnotingroup)) {
654             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
655         }
656         $update->markingworkflow = $formdata->markingworkflow;
657         $update->markingallocation = $formdata->markingallocation;
658         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
659             $update->markingallocation = 0;
660         }
662         $returnid = $DB->insert_record('assign', $update);
663         $this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
664         // Cache the course record.
665         $this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
667         $this->save_intro_draft_files($formdata);
669         if ($callplugins) {
670             // Call save_settings hook for submission plugins.
671             foreach ($this->submissionplugins as $plugin) {
672                 if (!$this->update_plugin_instance($plugin, $formdata)) {
673                     print_error($plugin->get_error());
674                     return false;
675                 }
676             }
677             foreach ($this->feedbackplugins as $plugin) {
678                 if (!$this->update_plugin_instance($plugin, $formdata)) {
679                     print_error($plugin->get_error());
680                     return false;
681                 }
682             }
684             // In the case of upgrades the coursemodule has not been set,
685             // so we need to wait before calling these two.
686             $this->update_calendar($formdata->coursemodule);
687             $this->update_gradebook(false, $formdata->coursemodule);
689         }
691         $update = new stdClass();
692         $update->id = $this->get_instance()->id;
693         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
694         $DB->update_record('assign', $update);
696         return $returnid;
697     }
699     /**
700      * Delete all grades from the gradebook for this assignment.
701      *
702      * @return bool
703      */
704     protected function delete_grades() {
705         global $CFG;
707         $result = grade_update('mod/assign',
708                                $this->get_course()->id,
709                                'mod',
710                                'assign',
711                                $this->get_instance()->id,
712                                0,
713                                null,
714                                array('deleted'=>1));
715         return $result == GRADE_UPDATE_OK;
716     }
718     /**
719      * Delete this instance from the database.
720      *
721      * @return bool false if an error occurs
722      */
723     public function delete_instance() {
724         global $DB;
725         $result = true;
727         foreach ($this->submissionplugins as $plugin) {
728             if (!$plugin->delete_instance()) {
729                 print_error($plugin->get_error());
730                 $result = false;
731             }
732         }
733         foreach ($this->feedbackplugins as $plugin) {
734             if (!$plugin->delete_instance()) {
735                 print_error($plugin->get_error());
736                 $result = false;
737             }
738         }
740         // Delete files associated with this assignment.
741         $fs = get_file_storage();
742         if (! $fs->delete_area_files($this->context->id) ) {
743             $result = false;
744         }
746         $this->delete_all_overrides();
748         // Delete_records will throw an exception if it fails - so no need for error checking here.
749         $DB->delete_records('assign_submission', array('assignment' => $this->get_instance()->id));
750         $DB->delete_records('assign_grades', array('assignment' => $this->get_instance()->id));
751         $DB->delete_records('assign_plugin_config', array('assignment' => $this->get_instance()->id));
752         $DB->delete_records('assign_user_flags', array('assignment' => $this->get_instance()->id));
753         $DB->delete_records('assign_user_mapping', array('assignment' => $this->get_instance()->id));
755         // Delete items from the gradebook.
756         if (! $this->delete_grades()) {
757             $result = false;
758         }
760         // Delete the instance.
761         $DB->delete_records('assign', array('id'=>$this->get_instance()->id));
763         return $result;
764     }
766     /**
767      * Deletes a assign override from the database and clears any corresponding calendar events
768      *
769      * @param int $overrideid The id of the override being deleted
770      * @return bool true on success
771      */
772     public function delete_override($overrideid) {
773         global $CFG, $DB;
775         require_once($CFG->dirroot . '/calendar/lib.php');
777         $cm = get_coursemodule_from_instance('assign', $this->get_context()->id, $this->get_context()->course);
779         $override = $DB->get_record('assign_overrides', array('id' => $overrideid), '*', MUST_EXIST);
781         // Delete the events.
782         $conds = array('modulename' => 'assign',
783             'instance' => $this->get_context()->id);
784         if (isset($override->userid)) {
785             $conds['userid'] = $override->userid;
786         } else {
787             $conds['groupid'] = $override->groupid;
788         }
789         $events = $DB->get_records('event', $conds);
790         foreach ($events as $event) {
791             $eventold = calendar_event::load($event);
792             $eventold->delete();
793         }
795         $DB->delete_records('assign_overrides', array('id' => $overrideid));
797         // Set the common parameters for one of the events we will be triggering.
798         $params = array(
799             'objectid' => $override->id,
800             'context' => context_module::instance($cm->id),
801             'other' => array(
802                 'assignid' => $override->assignid
803             )
804         );
805         // Determine which override deleted event to fire.
806         if (!empty($override->userid)) {
807             $params['relateduserid'] = $override->userid;
808             $event = \mod_assign\event\user_override_deleted::create($params);
809         } else {
810             $params['other']['groupid'] = $override->groupid;
811             $event = \mod_assign\event\group_override_deleted::create($params);
812         }
814         // Trigger the override deleted event.
815         $event->add_record_snapshot('assign_overrides', $override);
816         $event->trigger();
818         return true;
819     }
821     /**
822      * Deletes all assign overrides from the database and clears any corresponding calendar events
823      */
824     public function delete_all_overrides() {
825         global $DB;
827         $overrides = $DB->get_records('assign_overrides', array('assignid' => $this->get_context()->id), 'id');
828         foreach ($overrides as $override) {
829             $this->delete_override($override->id);
830         }
831     }
833     /**
834      * Updates the assign properties with override information for a user.
835      *
836      * Algorithm:  For each assign setting, if there is a matching user-specific override,
837      *   then use that otherwise, if there are group-specific overrides, return the most
838      *   lenient combination of them.  If neither applies, leave the assign setting unchanged.
839      *
840      * @param int $userid The userid.
841      */
842     public function update_effective_access($userid) {
844         $override = $this->override_exists($userid);
846         // Merge with assign defaults.
847         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
848         foreach ($keys as $key) {
849             if (isset($override->{$key})) {
850                 $this->get_instance()->{$key} = $override->{$key};
851             }
852         }
854     }
856     /**
857      * Returns whether an assign has any overrides.
858      *
859      * @return true if any, false if not
860      */
861     public function has_overrides() {
862         global $DB;
864         $override = $DB->record_exists('assign_overrides', array('assignid' => $this->get_instance()->id));
866         if ($override) {
867             return true;
868         }
870         return false;
871     }
873     /**
874      * Returns user override
875      *
876      * Algorithm:  For each assign setting, if there is a matching user-specific override,
877      *   then use that otherwise, if there are group-specific overrides, return the most
878      *   lenient combination of them.  If neither applies, leave the assign setting unchanged.
879      *
880      * @param int $userid The userid.
881      * @return override  if exist
882      */
883     public function override_exists($userid) {
884         global $DB;
886         // Check for user override.
887         $override = $DB->get_record('assign_overrides', array('assignid' => $this->get_instance()->id, 'userid' => $userid));
889         if (!$override) {
890             $override = new stdClass();
891             $override->duedate = null;
892             $override->cutoffdate = null;
893             $override->allowsubmissionsfromdate = null;
894         }
896         // Check for group overrides.
897         $groupings = groups_get_user_groups($this->get_instance()->course, $userid);
899         if (!empty($groupings[0])) {
900             // Select all overrides that apply to the User's groups.
901             list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
902             $sql = "SELECT * FROM {assign_overrides}
903                     WHERE groupid $extra AND assignid = ?";
904             $params[] = $this->get_instance()->id;
905             $records = $DB->get_records_sql($sql, $params);
907             // Combine the overrides.
908             $duedates = array();
909             $cutoffdates = array();
910             $allowsubmissionsfromdates = array();
912             foreach ($records as $gpoverride) {
913                 if (isset($gpoverride->duedate)) {
914                     $duedates[] = $gpoverride->duedate;
915                 }
916                 if (isset($gpoverride->cutoffdate)) {
917                     $cutoffdates[] = $gpoverride->cutoffdate;
918                 }
919                 if (isset($gpoverride->allowsubmissionsfromdate)) {
920                     $allowsubmissionsfromdates[] = $gpoverride->allowsubmissionsfromdate;
921                 }
922             }
923             // If there is a user override for a setting, ignore the group override.
924             if (is_null($override->allowsubmissionsfromdate) && count($allowsubmissionsfromdates)) {
925                 $override->allowsubmissionsfromdate = min($allowsubmissionsfromdates);
926             }
927             if (is_null($override->cutoffdate) && count($cutoffdates)) {
928                 if (in_array(0, $cutoffdates)) {
929                     $override->cutoffdate = 0;
930                 } else {
931                     $override->cutoffdate = max($cutoffdates);
932                 }
933             }
934             if (is_null($override->duedate) && count($duedates)) {
935                 if (in_array(0, $duedates)) {
936                     $override->duedate = 0;
937                 } else {
938                     $override->duedate = max($duedates);
939                 }
940             }
942         }
944         return $override;
945     }
947     /**
948      * Actual implementation of the reset course functionality, delete all the
949      * assignment submissions for course $data->courseid.
950      *
951      * @param stdClass $data the data submitted from the reset course.
952      * @return array status array
953      */
954     public function reset_userdata($data) {
955         global $CFG, $DB;
957         $componentstr = get_string('modulenameplural', 'assign');
958         $status = array();
960         $fs = get_file_storage();
961         if (!empty($data->reset_assign_submissions)) {
962             // Delete files associated with this assignment.
963             foreach ($this->submissionplugins as $plugin) {
964                 $fileareas = array();
965                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
966                 $fileareas = $plugin->get_file_areas();
967                 foreach ($fileareas as $filearea => $notused) {
968                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
969                 }
971                 if (!$plugin->delete_instance()) {
972                     $status[] = array('component'=>$componentstr,
973                                       'item'=>get_string('deleteallsubmissions', 'assign'),
974                                       'error'=>$plugin->get_error());
975                 }
976             }
978             foreach ($this->feedbackplugins as $plugin) {
979                 $fileareas = array();
980                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
981                 $fileareas = $plugin->get_file_areas();
982                 foreach ($fileareas as $filearea => $notused) {
983                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
984                 }
986                 if (!$plugin->delete_instance()) {
987                     $status[] = array('component'=>$componentstr,
988                                       'item'=>get_string('deleteallsubmissions', 'assign'),
989                                       'error'=>$plugin->get_error());
990                 }
991             }
993             $assignids = $DB->get_records('assign', array('course' => $data->courseid), '', 'id');
994             list($sql, $params) = $DB->get_in_or_equal(array_keys($assignids));
996             $DB->delete_records_select('assign_submission', "assignment $sql", $params);
997             $DB->delete_records_select('assign_user_flags', "assignment $sql", $params);
999             $status[] = array('component'=>$componentstr,
1000                               'item'=>get_string('deleteallsubmissions', 'assign'),
1001                               'error'=>false);
1003             if (!empty($data->reset_gradebook_grades)) {
1004                 $DB->delete_records_select('assign_grades', "assignment $sql", $params);
1005                 // Remove all grades from gradebook.
1006                 require_once($CFG->dirroot.'/mod/assign/lib.php');
1007                 assign_reset_gradebook($data->courseid);
1009                 // Reset revealidentities if both submissions and grades have been reset.
1010                 if ($this->get_instance()->blindmarking && $this->get_instance()->revealidentities) {
1011                     $DB->set_field('assign', 'revealidentities', 0, array('id' => $this->get_instance()->id));
1012                 }
1013             }
1014         }
1016         // Remove user overrides.
1017         if (!empty($data->reset_assign_user_overrides)) {
1018             $DB->delete_records_select('assign_overrides',
1019                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
1020             $status[] = array(
1021                 'component' => $componentstr,
1022                 'item' => get_string('useroverridesdeleted', 'assign'),
1023                 'error' => false);
1024         }
1025         // Remove group overrides.
1026         if (!empty($data->reset_assign_group_overrides)) {
1027             $DB->delete_records_select('assign_overrides',
1028                 'assignid IN (SELECT id FROM {assign} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
1029             $status[] = array(
1030                 'component' => $componentstr,
1031                 'item' => get_string('groupoverridesdeleted', 'assign'),
1032                 'error' => false);
1033         }
1035         // Updating dates - shift may be negative too.
1036         if ($data->timeshift) {
1037             $DB->execute("UPDATE {assign_overrides}
1038                          SET allowsubmissionsfromdate = allowsubmissionsfromdate + ?
1039                        WHERE assignid = ? AND allowsubmissionsfromdate <> 0",
1040                 array($data->timeshift, $this->get_instance()->id));
1041             $DB->execute("UPDATE {assign_overrides}
1042                          SET duedate = duedate + ?
1043                        WHERE assignid = ? AND duedate <> 0",
1044                 array($data->timeshift, $this->get_instance()->id));
1045             $DB->execute("UPDATE {assign_overrides}
1046                          SET cutoffdate = cutoffdate + ?
1047                        WHERE assignid =? AND cutoffdate <> 0",
1048                 array($data->timeshift, $this->get_instance()->id));
1050             shift_course_mod_dates('assign',
1051                                     array('duedate', 'allowsubmissionsfromdate', 'cutoffdate'),
1052                                     $data->timeshift,
1053                                     $data->courseid, $this->get_instance()->id);
1054             $status[] = array('component'=>$componentstr,
1055                               'item'=>get_string('datechanged'),
1056                               'error'=>false);
1057         }
1059         return $status;
1060     }
1062     /**
1063      * Update the settings for a single plugin.
1064      *
1065      * @param assign_plugin $plugin The plugin to update
1066      * @param stdClass $formdata The form data
1067      * @return bool false if an error occurs
1068      */
1069     protected function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
1070         if ($plugin->is_visible()) {
1071             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1072             if (!empty($formdata->$enabledname)) {
1073                 $plugin->enable();
1074                 if (!$plugin->save_settings($formdata)) {
1075                     print_error($plugin->get_error());
1076                     return false;
1077                 }
1078             } else {
1079                 $plugin->disable();
1080             }
1081         }
1082         return true;
1083     }
1085     /**
1086      * Update the gradebook information for this assignment.
1087      *
1088      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
1089      * @param int $coursemoduleid This is required because it might not exist in the database yet
1090      * @return bool
1091      */
1092     public function update_gradebook($reset, $coursemoduleid) {
1093         global $CFG;
1095         require_once($CFG->dirroot.'/mod/assign/lib.php');
1096         $assign = clone $this->get_instance();
1097         $assign->cmidnumber = $coursemoduleid;
1099         // Set assign gradebook feedback plugin status (enabled and visible).
1100         $assign->gradefeedbackenabled = $this->is_gradebook_feedback_enabled();
1102         $param = null;
1103         if ($reset) {
1104             $param = 'reset';
1105         }
1107         return assign_grade_item_update($assign, $param);
1108     }
1110     /**
1111      * Get the marking table page size
1112      *
1113      * @return integer
1114      */
1115     public function get_assign_perpage() {
1116         $perpage = (int) get_user_preferences('assign_perpage', 10);
1117         $adminconfig = $this->get_admin_config();
1118         $maxperpage = -1;
1119         if (isset($adminconfig->maxperpage)) {
1120             $maxperpage = $adminconfig->maxperpage;
1121         }
1122         if (isset($maxperpage) &&
1123             $maxperpage != -1 &&
1124             ($perpage == -1 || $perpage > $maxperpage)) {
1125             $perpage = $maxperpage;
1126         }
1127         return $perpage;
1128     }
1130     /**
1131      * Load and cache the admin config for this module.
1132      *
1133      * @return stdClass the plugin config
1134      */
1135     public function get_admin_config() {
1136         if ($this->adminconfig) {
1137             return $this->adminconfig;
1138         }
1139         $this->adminconfig = get_config('assign');
1140         return $this->adminconfig;
1141     }
1143     /**
1144      * Update the calendar entries for this assignment.
1145      *
1146      * @param int $coursemoduleid - Required to pass this in because it might
1147      *                              not exist in the database yet.
1148      * @return bool
1149      */
1150     public function update_calendar($coursemoduleid) {
1151         global $DB, $CFG;
1152         require_once($CFG->dirroot.'/calendar/lib.php');
1154         // Special case for add_instance as the coursemodule has not been set yet.
1155         $instance = $this->get_instance();
1157         $eventtype = 'due';
1159         if ($instance->duedate) {
1160             $event = new stdClass();
1162             $params = array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype);
1163             $event->id = $DB->get_field('event', 'id', $params);
1164             $event->name = $instance->name;
1165             $event->timestart = $instance->duedate;
1167             // Convert the links to pluginfile. It is a bit hacky but at this stage the files
1168             // might not have been saved in the module area yet.
1169             $intro = $instance->intro;
1170             if ($draftid = file_get_submitted_draft_itemid('introeditor')) {
1171                 $intro = file_rewrite_urls_to_pluginfile($intro, $draftid);
1172             }
1174             // We need to remove the links to files as the calendar is not ready
1175             // to support module events with file areas.
1176             $intro = strip_pluginfile_content($intro);
1177             if ($this->show_intro()) {
1178                 $event->description = array(
1179                     'text' => $intro,
1180                     'format' => $instance->introformat
1181                 );
1182             } else {
1183                 $event->description = array(
1184                     'text' => '',
1185                     'format' => $instance->introformat
1186                 );
1187             }
1189             if ($event->id) {
1190                 $calendarevent = calendar_event::load($event->id);
1191                 $calendarevent->update($event);
1192             } else {
1193                 unset($event->id);
1194                 $event->courseid    = $instance->course;
1195                 $event->groupid     = 0;
1196                 $event->userid      = 0;
1197                 $event->modulename  = 'assign';
1198                 $event->instance    = $instance->id;
1199                 $event->eventtype   = $eventtype;
1200                 $event->timeduration = 0;
1201                 calendar_event::create($event);
1202             }
1203         } else {
1204             $DB->delete_records('event', array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype));
1205         }
1206     }
1209     /**
1210      * Update this instance in the database.
1211      *
1212      * @param stdClass $formdata - the data submitted from the form
1213      * @return bool false if an error occurs
1214      */
1215     public function update_instance($formdata) {
1216         global $DB;
1217         $adminconfig = $this->get_admin_config();
1219         $update = new stdClass();
1220         $update->id = $formdata->instance;
1221         $update->name = $formdata->name;
1222         $update->timemodified = time();
1223         $update->course = $formdata->course;
1224         $update->intro = $formdata->intro;
1225         $update->introformat = $formdata->introformat;
1226         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
1227         $update->submissiondrafts = $formdata->submissiondrafts;
1228         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
1229         $update->sendnotifications = $formdata->sendnotifications;
1230         $update->sendlatenotifications = $formdata->sendlatenotifications;
1231         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
1232         if (isset($formdata->sendstudentnotifications)) {
1233             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
1234         }
1235         $update->duedate = $formdata->duedate;
1236         $update->cutoffdate = $formdata->cutoffdate;
1237         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
1238         $update->grade = $formdata->grade;
1239         if (!empty($formdata->completionunlocked)) {
1240             $update->completionsubmit = !empty($formdata->completionsubmit);
1241         }
1242         $update->teamsubmission = $formdata->teamsubmission;
1243         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
1244         if (isset($formdata->teamsubmissiongroupingid)) {
1245             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
1246         }
1247         $update->blindmarking = $formdata->blindmarking;
1248         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
1249         if (!empty($formdata->attemptreopenmethod)) {
1250             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
1251         }
1252         if (!empty($formdata->maxattempts)) {
1253             $update->maxattempts = $formdata->maxattempts;
1254         }
1255         if (isset($formdata->preventsubmissionnotingroup)) {
1256             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
1257         }
1258         $update->markingworkflow = $formdata->markingworkflow;
1259         $update->markingallocation = $formdata->markingallocation;
1260         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
1261             $update->markingallocation = 0;
1262         }
1264         $result = $DB->update_record('assign', $update);
1265         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
1267         $this->save_intro_draft_files($formdata);
1269         // Load the assignment so the plugins have access to it.
1271         // Call save_settings hook for submission plugins.
1272         foreach ($this->submissionplugins as $plugin) {
1273             if (!$this->update_plugin_instance($plugin, $formdata)) {
1274                 print_error($plugin->get_error());
1275                 return false;
1276             }
1277         }
1278         foreach ($this->feedbackplugins as $plugin) {
1279             if (!$this->update_plugin_instance($plugin, $formdata)) {
1280                 print_error($plugin->get_error());
1281                 return false;
1282             }
1283         }
1285         $this->update_calendar($this->get_course_module()->id);
1286         $this->update_gradebook(false, $this->get_course_module()->id);
1288         $update = new stdClass();
1289         $update->id = $this->get_instance()->id;
1290         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
1291         $DB->update_record('assign', $update);
1293         return $result;
1294     }
1296     /**
1297      * Save the attachments in the draft areas.
1298      *
1299      * @param stdClass $formdata
1300      */
1301     protected function save_intro_draft_files($formdata) {
1302         if (isset($formdata->introattachments)) {
1303             file_save_draft_area_files($formdata->introattachments, $this->get_context()->id,
1304                                        'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA, 0);
1305         }
1306     }
1308     /**
1309      * Add elements in grading plugin form.
1310      *
1311      * @param mixed $grade stdClass|null
1312      * @param MoodleQuickForm $mform
1313      * @param stdClass $data
1314      * @param int $userid - The userid we are grading
1315      * @return void
1316      */
1317     protected function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
1318         foreach ($this->feedbackplugins as $plugin) {
1319             if ($plugin->is_enabled() && $plugin->is_visible()) {
1320                 $plugin->get_form_elements_for_user($grade, $mform, $data, $userid);
1321             }
1322         }
1323     }
1327     /**
1328      * Add one plugins settings to edit plugin form.
1329      *
1330      * @param assign_plugin $plugin The plugin to add the settings from
1331      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1332      *                               This form is modified directly (not returned).
1333      * @param array $pluginsenabled A list of form elements to be added to a group.
1334      *                              The new element is added to this array by this function.
1335      * @return void
1336      */
1337     protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) {
1338         global $CFG;
1339         if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) {
1340             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1341             $pluginsenabled[] = $mform->createElement('hidden', $name, 1);
1342             $mform->setType($name, PARAM_BOOL);
1343             $plugin->get_settings($mform);
1344         } else if ($plugin->is_visible() && $plugin->is_configurable()) {
1345             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1346             $label = $plugin->get_name();
1347             $label .= ' ' . $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
1348             $pluginsenabled[] = $mform->createElement('checkbox', $name, '', $label);
1350             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
1351             if ($plugin->get_config('enabled') !== false) {
1352                 $default = $plugin->is_enabled();
1353             }
1354             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
1356             $plugin->get_settings($mform);
1358         }
1359     }
1361     /**
1362      * Add settings to edit plugin form.
1363      *
1364      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1365      *                               This form is modified directly (not returned).
1366      * @return void
1367      */
1368     public function add_all_plugin_settings(MoodleQuickForm $mform) {
1369         $mform->addElement('header', 'submissiontypes', get_string('submissiontypes', 'assign'));
1371         $submissionpluginsenabled = array();
1372         $group = $mform->addGroup(array(), 'submissionplugins', get_string('submissiontypes', 'assign'), array(' '), false);
1373         foreach ($this->submissionplugins as $plugin) {
1374             $this->add_plugin_settings($plugin, $mform, $submissionpluginsenabled);
1375         }
1376         $group->setElements($submissionpluginsenabled);
1378         $mform->addElement('header', 'feedbacktypes', get_string('feedbacktypes', 'assign'));
1379         $feedbackpluginsenabled = array();
1380         $group = $mform->addGroup(array(), 'feedbackplugins', get_string('feedbacktypes', 'assign'), array(' '), false);
1381         foreach ($this->feedbackplugins as $plugin) {
1382             $this->add_plugin_settings($plugin, $mform, $feedbackpluginsenabled);
1383         }
1384         $group->setElements($feedbackpluginsenabled);
1385         $mform->setExpanded('submissiontypes');
1386     }
1388     /**
1389      * Allow each plugin an opportunity to update the defaultvalues
1390      * passed in to the settings form (needed to set up draft areas for
1391      * editor and filemanager elements)
1392      *
1393      * @param array $defaultvalues
1394      */
1395     public function plugin_data_preprocessing(&$defaultvalues) {
1396         foreach ($this->submissionplugins as $plugin) {
1397             if ($plugin->is_visible()) {
1398                 $plugin->data_preprocessing($defaultvalues);
1399             }
1400         }
1401         foreach ($this->feedbackplugins as $plugin) {
1402             if ($plugin->is_visible()) {
1403                 $plugin->data_preprocessing($defaultvalues);
1404             }
1405         }
1406     }
1408     /**
1409      * Get the name of the current module.
1410      *
1411      * @return string the module name (Assignment)
1412      */
1413     protected function get_module_name() {
1414         if (isset(self::$modulename)) {
1415             return self::$modulename;
1416         }
1417         self::$modulename = get_string('modulename', 'assign');
1418         return self::$modulename;
1419     }
1421     /**
1422      * Get the plural name of the current module.
1423      *
1424      * @return string the module name plural (Assignments)
1425      */
1426     protected function get_module_name_plural() {
1427         if (isset(self::$modulenameplural)) {
1428             return self::$modulenameplural;
1429         }
1430         self::$modulenameplural = get_string('modulenameplural', 'assign');
1431         return self::$modulenameplural;
1432     }
1434     /**
1435      * Has this assignment been constructed from an instance?
1436      *
1437      * @return bool
1438      */
1439     public function has_instance() {
1440         return $this->instance || $this->get_course_module();
1441     }
1443     /**
1444      * Get the settings for the current instance of this assignment
1445      *
1446      * @return stdClass The settings
1447      */
1448     public function get_instance() {
1449         global $DB;
1450         if ($this->instance) {
1451             return $this->instance;
1452         }
1453         if ($this->get_course_module()) {
1454             $params = array('id' => $this->get_course_module()->instance);
1455             $this->instance = $DB->get_record('assign', $params, '*', MUST_EXIST);
1456         }
1457         if (!$this->instance) {
1458             throw new coding_exception('Improper use of the assignment class. ' .
1459                                        'Cannot load the assignment record.');
1460         }
1461         return $this->instance;
1462     }
1464     /**
1465      * Get the primary grade item for this assign instance.
1466      *
1467      * @return grade_item The grade_item record
1468      */
1469     public function get_grade_item() {
1470         if ($this->gradeitem) {
1471             return $this->gradeitem;
1472         }
1473         $instance = $this->get_instance();
1474         $params = array('itemtype' => 'mod',
1475                         'itemmodule' => 'assign',
1476                         'iteminstance' => $instance->id,
1477                         'courseid' => $instance->course,
1478                         'itemnumber' => 0);
1479         $this->gradeitem = grade_item::fetch($params);
1480         if (!$this->gradeitem) {
1481             throw new coding_exception('Improper use of the assignment class. ' .
1482                                        'Cannot load the grade item.');
1483         }
1484         return $this->gradeitem;
1485     }
1487     /**
1488      * Get the context of the current course.
1489      *
1490      * @return mixed context|null The course context
1491      */
1492     public function get_course_context() {
1493         if (!$this->context && !$this->course) {
1494             throw new coding_exception('Improper use of the assignment class. ' .
1495                                        'Cannot load the course context.');
1496         }
1497         if ($this->context) {
1498             return $this->context->get_course_context();
1499         } else {
1500             return context_course::instance($this->course->id);
1501         }
1502     }
1505     /**
1506      * Get the current course module.
1507      *
1508      * @return cm_info|null The course module or null if not known
1509      */
1510     public function get_course_module() {
1511         if ($this->coursemodule) {
1512             return $this->coursemodule;
1513         }
1514         if (!$this->context) {
1515             return null;
1516         }
1518         if ($this->context->contextlevel == CONTEXT_MODULE) {
1519             $modinfo = get_fast_modinfo($this->get_course());
1520             $this->coursemodule = $modinfo->get_cm($this->context->instanceid);
1521             return $this->coursemodule;
1522         }
1523         return null;
1524     }
1526     /**
1527      * Get context module.
1528      *
1529      * @return context
1530      */
1531     public function get_context() {
1532         return $this->context;
1533     }
1535     /**
1536      * Get the current course.
1537      *
1538      * @return mixed stdClass|null The course
1539      */
1540     public function get_course() {
1541         global $DB;
1543         if ($this->course) {
1544             return $this->course;
1545         }
1547         if (!$this->context) {
1548             return null;
1549         }
1550         $params = array('id' => $this->get_course_context()->instanceid);
1551         $this->course = $DB->get_record('course', $params, '*', MUST_EXIST);
1553         return $this->course;
1554     }
1556     /**
1557      * Count the number of intro attachments.
1558      *
1559      * @return int
1560      */
1561     protected function count_attachments() {
1563         $fs = get_file_storage();
1564         $files = $fs->get_area_files($this->get_context()->id, 'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA,
1565                         0, 'id', false);
1567         return count($files);
1568     }
1570     /**
1571      * Are there any intro attachments to display?
1572      *
1573      * @return boolean
1574      */
1575     protected function has_visible_attachments() {
1576         return ($this->count_attachments() > 0);
1577     }
1579     /**
1580      * Return a grade in user-friendly form, whether it's a scale or not.
1581      *
1582      * @param mixed $grade int|null
1583      * @param boolean $editing Are we allowing changes to this grade?
1584      * @param int $userid The user id the grade belongs to
1585      * @param int $modified Timestamp from when the grade was last modified
1586      * @return string User-friendly representation of grade
1587      */
1588     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1589         global $DB;
1591         static $scalegrades = array();
1593         $decimals = $this->get_grade_item()->get_decimals();
1594         $o = '';
1596         if ($this->get_instance()->grade >= 0) {
1597             // Normal number.
1598             if ($editing && $this->get_instance()->grade > 0) {
1599                 if ($grade < 0) {
1600                     $displaygrade = '';
1601                 } else {
1602                     $displaygrade = format_float($grade, $decimals);
1603                 }
1604                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' .
1605                        get_string('usergrade', 'assign') .
1606                        '</label>';
1607                 $o .= '<input type="text"
1608                               id="quickgrade_' . $userid . '"
1609                               name="quickgrade_' . $userid . '"
1610                               value="' .  $displaygrade . '"
1611                               size="6"
1612                               maxlength="10"
1613                               class="quickgrade"/>';
1614                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $decimals);
1615                 return $o;
1616             } else {
1617                 if ($grade == -1 || $grade === null) {
1618                     $o .= '-';
1619                 } else {
1620                     $item = $this->get_grade_item();
1621                     $o .= grade_format_gradevalue($grade, $item);
1622                     if ($item->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) {
1623                         // If displaying the raw grade, also display the total value.
1624                         $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, $decimals);
1625                     }
1626                 }
1627                 return $o;
1628             }
1630         } else {
1631             // Scale.
1632             if (empty($this->cache['scale'])) {
1633                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1634                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1635                 } else {
1636                     $o .= '-';
1637                     return $o;
1638                 }
1639             }
1640             if ($editing) {
1641                 $o .= '<label class="accesshide"
1642                               for="quickgrade_' . $userid . '">' .
1643                       get_string('usergrade', 'assign') .
1644                       '</label>';
1645                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1646                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1647                 foreach ($this->cache['scale'] as $optionid => $option) {
1648                     $selected = '';
1649                     if ($grade == $optionid) {
1650                         $selected = 'selected="selected"';
1651                     }
1652                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1653                 }
1654                 $o .= '</select>';
1655                 return $o;
1656             } else {
1657                 $scaleid = (int)$grade;
1658                 if (isset($this->cache['scale'][$scaleid])) {
1659                     $o .= $this->cache['scale'][$scaleid];
1660                     return $o;
1661                 }
1662                 $o .= '-';
1663                 return $o;
1664             }
1665         }
1666     }
1668     /**
1669      * Get the submission status/grading status for all submissions in this assignment for the
1670      * given paticipants.
1671      *
1672      * These statuses match the available filters (requiregrading, submitted, notsubmitted).
1673      * If this is a group assignment, group info is also returned.
1674      *
1675      * @param array $participants an associative array where the key is the participant id and
1676      *                            the value is the participant record.
1677      * @return array an associative array where the key is the participant id and the value is
1678      *               the participant record.
1679      */
1680     private function get_submission_info_for_participants($participants) {
1681         global $DB;
1683         if (empty($participants)) {
1684             return $participants;
1685         }
1687         list($insql, $params) = $DB->get_in_or_equal(array_keys($participants), SQL_PARAMS_NAMED);
1689         $assignid = $this->get_instance()->id;
1690         $params['assignmentid1'] = $assignid;
1691         $params['assignmentid2'] = $assignid;
1693         $fields = 'SELECT u.id, s.status, s.timemodified AS stime, g.timemodified AS gtime, g.grade';
1694         $from = ' FROM {user} u
1695                          LEFT JOIN {assign_submission} s
1696                                 ON u.id = s.userid
1697                                AND s.assignment = :assignmentid1
1698                                AND s.latest = 1
1699                          LEFT JOIN {assign_grades} g
1700                                 ON u.id = g.userid
1701                                AND g.assignment = :assignmentid2
1702                                AND g.attemptnumber = s.attemptnumber
1703             ';
1704         $where = ' WHERE u.id ' . $insql;
1706         if (!empty($this->get_instance()->blindmarking)) {
1707             $from .= 'LEFT JOIN {assign_user_mapping} um
1708                              ON u.id = um.userid
1709                             AND um.assignment = :assignmentid3 ';
1710             $params['assignmentid3'] = $assignid;
1711             $fields .= ', um.id as recordid ';
1712         }
1714         $sql = "$fields $from $where";
1716         $records = $DB->get_records_sql($sql, $params);
1718         if ($this->get_instance()->teamsubmission) {
1719             // Get all groups.
1720             $allgroups = groups_get_all_groups($this->get_course()->id,
1721                                                array_keys($participants),
1722                                                $this->get_instance()->teamsubmissiongroupingid,
1723                                                'DISTINCT g.id, g.name');
1725         }
1726         foreach ($participants as $userid => $participant) {
1727             $participants[$userid]->fullname = $this->fullname($participant);
1728             $participants[$userid]->submitted = false;
1729             $participants[$userid]->requiregrading = false;
1730         }
1732         foreach ($records as $userid => $submissioninfo) {
1733             // These filters are 100% the same as the ones in the grading table SQL.
1734             $submitted = false;
1735             $requiregrading = false;
1737             if (!empty($submissioninfo->stime) && $submissioninfo->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
1738                 $submitted = true;
1739             }
1741             if ($submitted && ($submissioninfo->stime >= $submissioninfo->gtime ||
1742                     empty($submissioninfo->gtime) ||
1743                     $submissioninfo->grade === null)) {
1744                 $requiregrading = true;
1745             }
1747             $participants[$userid]->submitted = $submitted;
1748             $participants[$userid]->requiregrading = $requiregrading;
1749             if ($this->get_instance()->teamsubmission) {
1750                 $group = $this->get_submission_group($userid);
1751                 if ($group) {
1752                     $participants[$userid]->groupid = $group->id;
1753                     $participants[$userid]->groupname = $group->name;
1754                 }
1755             }
1756         }
1757         return $participants;
1758     }
1760     /**
1761      * Get the submission status/grading status for all submissions in this assignment.
1762      * These statuses match the available filters (requiregrading, submitted, notsubmitted).
1763      * If this is a group assignment, group info is also returned.
1764      *
1765      * @param int $currentgroup
1766      * @return array List of user records with extra fields 'submitted', 'notsubmitted', 'requiregrading', 'groupid', 'groupname'
1767      */
1768     public function list_participants_with_filter_status_and_group($currentgroup) {
1769         $participants = $this->list_participants($currentgroup, false);
1771         if (empty($participants)) {
1772             return $participants;
1773         } else {
1774             return $this->get_submission_info_for_participants($participants);
1775         }
1776     }
1778     /**
1779      * Load a list of users enrolled in the current course with the specified permission and group.
1780      * 0 for no group.
1781      *
1782      * @param int $currentgroup
1783      * @param bool $idsonly
1784      * @return array List of user records
1785      */
1786     public function list_participants($currentgroup, $idsonly) {
1787         global $DB;
1789         if (empty($currentgroup)) {
1790             $currentgroup = 0;
1791         }
1793         $key = $this->context->id . '-' . $currentgroup . '-' . $this->show_only_active_users();
1794         if (!isset($this->participants[$key])) {
1795             list($esql, $params) = get_enrolled_sql($this->context, 'mod/assign:submit', $currentgroup,
1796                     $this->show_only_active_users());
1798             $fields = 'u.*';
1799             $orderby = 'u.lastname, u.firstname, u.id';
1800             $additionaljoins = '';
1801             $instance = $this->get_instance();
1802             if (!empty($instance->blindmarking)) {
1803                 $additionaljoins .= " LEFT JOIN {assign_user_mapping} um
1804                                   ON u.id = um.userid
1805                                  AND um.assignment = :assignmentid1
1806                            LEFT JOIN {assign_submission} s
1807                                   ON u.id = s.userid
1808                                  AND s.assignment = :assignmentid2
1809                                  AND s.latest = 1
1810                         ";
1811                 $params['assignmentid1'] = (int) $instance->id;
1812                 $params['assignmentid2'] = (int) $instance->id;
1813                 $fields .= ', um.id as recordid ';
1815                 // Sort by submission time first, then by um.id to sort reliably by the blind marking id.
1816                 // Note, different DBs have different ordering of NULL values.
1817                 // Therefore we coalesce the current time into the timecreated field, and the max possible integer into
1818                 // the ID field.
1819                 $orderby = "COALESCE(s.timecreated, " . time() . ") ASC, COALESCE(s.id, " . PHP_INT_MAX . ") ASC, um.id ASC";
1820             }
1822             $sql = "SELECT $fields
1823                       FROM {user} u
1824                       JOIN ($esql) je ON je.id = u.id
1825                            $additionaljoins
1826                      WHERE u.deleted = 0
1827                   ORDER BY $orderby";
1829             $users = $DB->get_records_sql($sql, $params);
1831             $cm = $this->get_course_module();
1832             $info = new \core_availability\info_module($cm);
1833             $users = $info->filter_user_list($users);
1835             $this->participants[$key] = $users;
1836         }
1838         if ($idsonly) {
1839             $idslist = array();
1840             foreach ($this->participants[$key] as $id => $user) {
1841                 $idslist[$id] = new stdClass();
1842                 $idslist[$id]->id = $id;
1843             }
1844             return $idslist;
1845         }
1846         return $this->participants[$key];
1847     }
1849     /**
1850      * Load a user if they are enrolled in the current course. Populated with submission
1851      * status for this assignment.
1852      *
1853      * @param int $userid
1854      * @return null|stdClass user record
1855      */
1856     public function get_participant($userid) {
1857         global $DB;
1859         $participant = $DB->get_record('user', array('id' => $userid));
1860         if (!$participant) {
1861             return null;
1862         }
1864         if (!is_enrolled($this->context, $participant, 'mod/assign:submit', $this->show_only_active_users())) {
1865             return null;
1866         }
1868         $result = $this->get_submission_info_for_participants(array($participant->id => $participant));
1869         return $result[$participant->id];
1870     }
1872     /**
1873      * Load a count of valid teams for this assignment.
1874      *
1875      * @param int $activitygroup Activity active group
1876      * @return int number of valid teams
1877      */
1878     public function count_teams($activitygroup = 0) {
1880         $count = 0;
1882         $participants = $this->list_participants($activitygroup, true);
1884         // If a team submission grouping id is provided all good as all returned groups
1885         // are the submission teams, but if no team submission grouping was specified
1886         // $groups will contain all participants groups.
1887         if ($this->get_instance()->teamsubmissiongroupingid) {
1889             // We restrict the users to the selected group ones.
1890             $groups = groups_get_all_groups($this->get_course()->id,
1891                                             array_keys($participants),
1892                                             $this->get_instance()->teamsubmissiongroupingid,
1893                                             'DISTINCT g.id, g.name');
1895             $count = count($groups);
1897             // When a specific group is selected we don't count the default group users.
1898             if ($activitygroup == 0) {
1899                 if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1900                     // See if there are any users in the default group.
1901                     $defaultusers = $this->get_submission_group_members(0, true);
1902                     if (count($defaultusers) > 0) {
1903                         $count += 1;
1904                     }
1905                 }
1906             }
1907         } else {
1908             // It is faster to loop around participants if no grouping was specified.
1909             $groups = array();
1910             foreach ($participants as $participant) {
1911                 if ($group = $this->get_submission_group($participant->id)) {
1912                     $groups[$group->id] = true;
1913                 } else if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1914                     $groups[0] = true;
1915                 }
1916             }
1918             $count = count($groups);
1919         }
1921         return $count;
1922     }
1924     /**
1925      * Load a count of active users enrolled in the current course with the specified permission and group.
1926      * 0 for no group.
1927      *
1928      * @param int $currentgroup
1929      * @return int number of matching users
1930      */
1931     public function count_participants($currentgroup) {
1932         return count($this->list_participants($currentgroup, true));
1933     }
1935     /**
1936      * Load a count of active users submissions in the current module that require grading
1937      * This means the submission modification time is more recent than the
1938      * grading modification time and the status is SUBMITTED.
1939      *
1940      * @return int number of matching submissions
1941      */
1942     public function count_submissions_need_grading() {
1943         global $DB;
1945         if ($this->get_instance()->teamsubmission) {
1946             // This does not make sense for group assignment because the submission is shared.
1947             return 0;
1948         }
1950         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1951         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1953         $params['assignid'] = $this->get_instance()->id;
1954         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1956         $sql = 'SELECT COUNT(s.userid)
1957                    FROM {assign_submission} s
1958                    LEFT JOIN {assign_grades} g ON
1959                         s.assignment = g.assignment AND
1960                         s.userid = g.userid AND
1961                         g.attemptnumber = s.attemptnumber
1962                    JOIN(' . $esql . ') e ON e.id = s.userid
1963                    WHERE
1964                         s.latest = 1 AND
1965                         s.assignment = :assignid AND
1966                         s.timemodified IS NOT NULL AND
1967                         s.status = :submitted AND
1968                         (s.timemodified >= g.timemodified OR g.timemodified IS NULL OR g.grade IS NULL)';
1970         return $DB->count_records_sql($sql, $params);
1971     }
1973     /**
1974      * Load a count of grades.
1975      *
1976      * @return int number of grades
1977      */
1978     public function count_grades() {
1979         global $DB;
1981         if (!$this->has_instance()) {
1982             return 0;
1983         }
1985         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1986         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1988         $params['assignid'] = $this->get_instance()->id;
1990         $sql = 'SELECT COUNT(g.userid)
1991                    FROM {assign_grades} g
1992                    JOIN(' . $esql . ') e ON e.id = g.userid
1993                    WHERE g.assignment = :assignid';
1995         return $DB->count_records_sql($sql, $params);
1996     }
1998     /**
1999      * Load a count of submissions.
2000      *
2001      * @param bool $includenew When true, also counts the submissions with status 'new'.
2002      * @return int number of submissions
2003      */
2004     public function count_submissions($includenew = false) {
2005         global $DB;
2007         if (!$this->has_instance()) {
2008             return 0;
2009         }
2011         $params = array();
2012         $sqlnew = '';
2014         if (!$includenew) {
2015             $sqlnew = ' AND s.status <> :status ';
2016             $params['status'] = ASSIGN_SUBMISSION_STATUS_NEW;
2017         }
2019         if ($this->get_instance()->teamsubmission) {
2020             // We cannot join on the enrolment tables for group submissions (no userid).
2021             $sql = 'SELECT COUNT(DISTINCT s.groupid)
2022                         FROM {assign_submission} s
2023                         WHERE
2024                             s.assignment = :assignid AND
2025                             s.timemodified IS NOT NULL AND
2026                             s.userid = :groupuserid' .
2027                             $sqlnew;
2029             $params['assignid'] = $this->get_instance()->id;
2030             $params['groupuserid'] = 0;
2031         } else {
2032             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2033             list($esql, $enrolparams) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2035             $params = array_merge($params, $enrolparams);
2036             $params['assignid'] = $this->get_instance()->id;
2038             $sql = 'SELECT COUNT(DISTINCT s.userid)
2039                        FROM {assign_submission} s
2040                        JOIN(' . $esql . ') e ON e.id = s.userid
2041                        WHERE
2042                             s.assignment = :assignid AND
2043                             s.timemodified IS NOT NULL ' .
2044                             $sqlnew;
2046         }
2048         return $DB->count_records_sql($sql, $params);
2049     }
2051     /**
2052      * Load a count of submissions with a specified status.
2053      *
2054      * @param string $status The submission status - should match one of the constants
2055      * @return int number of matching submissions
2056      */
2057     public function count_submissions_with_status($status) {
2058         global $DB;
2060         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2061         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
2063         $params['assignid'] = $this->get_instance()->id;
2064         $params['assignid2'] = $this->get_instance()->id;
2065         $params['submissionstatus'] = $status;
2067         if ($this->get_instance()->teamsubmission) {
2069             $groupsstr = '';
2070             if ($currentgroup != 0) {
2071                 // If there is an active group we should only display the current group users groups.
2072                 $participants = $this->list_participants($currentgroup, true);
2073                 $groups = groups_get_all_groups($this->get_course()->id,
2074                                                 array_keys($participants),
2075                                                 $this->get_instance()->teamsubmissiongroupingid,
2076                                                 'DISTINCT g.id, g.name');
2077                 list($groupssql, $groupsparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
2078                 $groupsstr = 's.groupid ' . $groupssql . ' AND';
2079                 $params = $params + $groupsparams;
2080             }
2081             $sql = 'SELECT COUNT(s.groupid)
2082                         FROM {assign_submission} s
2083                         WHERE
2084                             s.latest = 1 AND
2085                             s.assignment = :assignid AND
2086                             s.timemodified IS NOT NULL AND
2087                             s.userid = :groupuserid AND '
2088                             . $groupsstr . '
2089                             s.status = :submissionstatus';
2090             $params['groupuserid'] = 0;
2091         } else {
2092             $sql = 'SELECT COUNT(s.userid)
2093                         FROM {assign_submission} s
2094                         JOIN(' . $esql . ') e ON e.id = s.userid
2095                         WHERE
2096                             s.latest = 1 AND
2097                             s.assignment = :assignid AND
2098                             s.timemodified IS NOT NULL AND
2099                             s.status = :submissionstatus';
2101         }
2103         return $DB->count_records_sql($sql, $params);
2104     }
2106     /**
2107      * Utility function to get the userid for every row in the grading table
2108      * so the order can be frozen while we iterate it.
2109      *
2110      * @return array An array of userids
2111      */
2112     protected function get_grading_userid_list() {
2113         $filter = get_user_preferences('assign_filter', '');
2114         $table = new assign_grading_table($this, 0, $filter, 0, false);
2116         $useridlist = $table->get_column_data('userid');
2118         return $useridlist;
2119     }
2121     /**
2122      * Generate zip file from array of given files.
2123      *
2124      * @param array $filesforzipping - array of files to pass into archive_to_pathname.
2125      *                                 This array is indexed by the final file name and each
2126      *                                 element in the array is an instance of a stored_file object.
2127      * @return path of temp file - note this returned file does
2128      *         not have a .zip extension - it is a temp file.
2129      */
2130     protected function pack_files($filesforzipping) {
2131         global $CFG;
2132         // Create path for new zip file.
2133         $tempzip = tempnam($CFG->tempdir . '/', 'assignment_');
2134         // Zip files.
2135         $zipper = new zip_packer();
2136         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
2137             return $tempzip;
2138         }
2139         return false;
2140     }
2142     /**
2143      * Finds all assignment notifications that have yet to be mailed out, and mails them.
2144      *
2145      * Cron function to be run periodically according to the moodle cron.
2146      *
2147      * @return bool
2148      */
2149     public static function cron() {
2150         global $DB;
2152         // Only ever send a max of one days worth of updates.
2153         $yesterday = time() - (24 * 3600);
2154         $timenow   = time();
2155         $lastcron = $DB->get_field('modules', 'lastcron', array('name' => 'assign'));
2157         // Collect all submissions that require mailing.
2158         // Submissions are included if all are true:
2159         //   - The assignment is visible in the gradebook.
2160         //   - No previous notification has been sent.
2161         //   - If marking workflow is not enabled, the grade was updated in the past 24 hours, or
2162         //     if marking workflow is enabled, the workflow state is at 'released'.
2163         $sql = "SELECT g.id as gradeid, a.course, a.name, a.blindmarking, a.revealidentities,
2164                        g.*, g.timemodified as lastmodified, cm.id as cmid, um.id as recordid
2165                  FROM {assign} a
2166                  JOIN {assign_grades} g ON g.assignment = a.id
2167             LEFT JOIN {assign_user_flags} uf ON uf.assignment = a.id AND uf.userid = g.userid
2168                  JOIN {course_modules} cm ON cm.course = a.course AND cm.instance = a.id
2169                  JOIN {modules} md ON md.id = cm.module AND md.name = 'assign'
2170                  JOIN {grade_items} gri ON gri.iteminstance = a.id AND gri.courseid = a.course AND gri.itemmodule = md.name
2171             LEFT JOIN {assign_user_mapping} um ON g.id = um.userid AND um.assignment = a.id
2172                  WHERE ((a.markingworkflow = 0 AND g.timemodified >= :yesterday AND g.timemodified <= :today) OR
2173                         (a.markingworkflow = 1 AND uf.workflowstate = :wfreleased)) AND
2174                        uf.mailed = 0 AND gri.hidden = 0
2175               ORDER BY a.course, cm.id";
2177         $params = array(
2178             'yesterday' => $yesterday,
2179             'today' => $timenow,
2180             'wfreleased' => ASSIGN_MARKING_WORKFLOW_STATE_RELEASED,
2181         );
2182         $submissions = $DB->get_records_sql($sql, $params);
2184         if (!empty($submissions)) {
2186             mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
2188             // Preload courses we are going to need those.
2189             $courseids = array();
2190             foreach ($submissions as $submission) {
2191                 $courseids[] = $submission->course;
2192             }
2194             // Filter out duplicates.
2195             $courseids = array_unique($courseids);
2196             $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2197             list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
2198             $sql = 'SELECT c.*, ' . $ctxselect .
2199                       ' FROM {course} c
2200                  LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
2201                      WHERE c.id ' . $courseidsql;
2203             $params['contextlevel'] = CONTEXT_COURSE;
2204             $courses = $DB->get_records_sql($sql, $params);
2206             // Clean up... this could go on for a while.
2207             unset($courseids);
2208             unset($ctxselect);
2209             unset($courseidsql);
2210             unset($params);
2212             // Message students about new feedback.
2213             foreach ($submissions as $submission) {
2215                 mtrace("Processing assignment submission $submission->id ...");
2217                 // Do not cache user lookups - could be too many.
2218                 if (!$user = $DB->get_record('user', array('id'=>$submission->userid))) {
2219                     mtrace('Could not find user ' . $submission->userid);
2220                     continue;
2221                 }
2223                 // Use a cache to prevent the same DB queries happening over and over.
2224                 if (!array_key_exists($submission->course, $courses)) {
2225                     mtrace('Could not find course ' . $submission->course);
2226                     continue;
2227                 }
2228                 $course = $courses[$submission->course];
2229                 if (isset($course->ctxid)) {
2230                     // Context has not yet been preloaded. Do so now.
2231                     context_helper::preload_from_record($course);
2232                 }
2234                 // Override the language and timezone of the "current" user, so that
2235                 // mail is customised for the receiver.
2236                 cron_setup_user($user, $course);
2238                 // Context lookups are already cached.
2239                 $coursecontext = context_course::instance($course->id);
2240                 if (!is_enrolled($coursecontext, $user->id)) {
2241                     $courseshortname = format_string($course->shortname,
2242                                                      true,
2243                                                      array('context' => $coursecontext));
2244                     mtrace(fullname($user) . ' not an active participant in ' . $courseshortname);
2245                     continue;
2246                 }
2248                 if (!$grader = $DB->get_record('user', array('id'=>$submission->grader))) {
2249                     mtrace('Could not find grader ' . $submission->grader);
2250                     continue;
2251                 }
2253                 $modinfo = get_fast_modinfo($course, $user->id);
2254                 $cm = $modinfo->get_cm($submission->cmid);
2255                 // Context lookups are already cached.
2256                 $contextmodule = context_module::instance($cm->id);
2258                 if (!$cm->uservisible) {
2259                     // Hold mail notification for assignments the user cannot access until later.
2260                     continue;
2261                 }
2263                 // Need to send this to the student.
2264                 $messagetype = 'feedbackavailable';
2265                 $eventtype = 'assign_notification';
2266                 $updatetime = $submission->lastmodified;
2267                 $modulename = get_string('modulename', 'assign');
2269                 $uniqueid = 0;
2270                 if ($submission->blindmarking && !$submission->revealidentities) {
2271                     if (empty($submission->recordid)) {
2272                         $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $user->id);
2273                     } else {
2274                         $uniqueid = $submission->recordid;
2275                     }
2276                 }
2277                 $showusers = $submission->blindmarking && !$submission->revealidentities;
2278                 self::send_assignment_notification($grader,
2279                                                    $user,
2280                                                    $messagetype,
2281                                                    $eventtype,
2282                                                    $updatetime,
2283                                                    $cm,
2284                                                    $contextmodule,
2285                                                    $course,
2286                                                    $modulename,
2287                                                    $submission->name,
2288                                                    $showusers,
2289                                                    $uniqueid);
2291                 $flags = $DB->get_record('assign_user_flags', array('userid'=>$user->id, 'assignment'=>$submission->assignment));
2292                 if ($flags) {
2293                     $flags->mailed = 1;
2294                     $DB->update_record('assign_user_flags', $flags);
2295                 } else {
2296                     $flags = new stdClass();
2297                     $flags->userid = $user->id;
2298                     $flags->assignment = $submission->assignment;
2299                     $flags->mailed = 1;
2300                     $DB->insert_record('assign_user_flags', $flags);
2301                 }
2303                 mtrace('Done');
2304             }
2305             mtrace('Done processing ' . count($submissions) . ' assignment submissions');
2307             cron_setup_user();
2309             // Free up memory just to be sure.
2310             unset($courses);
2311         }
2313         // Update calendar events to provide a description.
2314         $sql = 'SELECT id
2315                     FROM {assign}
2316                     WHERE
2317                         allowsubmissionsfromdate >= :lastcron AND
2318                         allowsubmissionsfromdate <= :timenow AND
2319                         alwaysshowdescription = 0';
2320         $params = array('lastcron' => $lastcron, 'timenow' => $timenow);
2321         $newlyavailable = $DB->get_records_sql($sql, $params);
2322         foreach ($newlyavailable as $record) {
2323             $cm = get_coursemodule_from_instance('assign', $record->id, 0, false, MUST_EXIST);
2324             $context = context_module::instance($cm->id);
2326             $assignment = new assign($context, null, null);
2327             $assignment->update_calendar($cm->id);
2328         }
2330         return true;
2331     }
2333     /**
2334      * Mark in the database that this grade record should have an update notification sent by cron.
2335      *
2336      * @param stdClass $grade a grade record keyed on id
2337      * @param bool $mailedoverride when true, flag notification to be sent again.
2338      * @return bool true for success
2339      */
2340     public function notify_grade_modified($grade, $mailedoverride = false) {
2341         global $DB;
2343         $flags = $this->get_user_flags($grade->userid, true);
2344         if ($flags->mailed != 1 || $mailedoverride) {
2345             $flags->mailed = 0;
2346         }
2348         return $this->update_user_flags($flags);
2349     }
2351     /**
2352      * Update user flags for this user in this assignment.
2353      *
2354      * @param stdClass $flags a flags record keyed on id
2355      * @return bool true for success
2356      */
2357     public function update_user_flags($flags) {
2358         global $DB;
2359         if ($flags->userid <= 0 || $flags->assignment <= 0 || $flags->id <= 0) {
2360             return false;
2361         }
2363         $result = $DB->update_record('assign_user_flags', $flags);
2364         return $result;
2365     }
2367     /**
2368      * Update a grade in the grade table for the assignment and in the gradebook.
2369      *
2370      * @param stdClass $grade a grade record keyed on id
2371      * @param bool $reopenattempt If the attempt reopen method is manual, allow another attempt at this assignment.
2372      * @return bool true for success
2373      */
2374     public function update_grade($grade, $reopenattempt = false) {
2375         global $DB;
2377         $grade->timemodified = time();
2379         if (!empty($grade->workflowstate)) {
2380             $validstates = $this->get_marking_workflow_states_for_current_user();
2381             if (!array_key_exists($grade->workflowstate, $validstates)) {
2382                 return false;
2383             }
2384         }
2386         if ($grade->grade && $grade->grade != -1) {
2387             if ($this->get_instance()->grade > 0) {
2388                 if (!is_numeric($grade->grade)) {
2389                     return false;
2390                 } else if ($grade->grade > $this->get_instance()->grade) {
2391                     return false;
2392                 } else if ($grade->grade < 0) {
2393                     return false;
2394                 }
2395             } else {
2396                 // This is a scale.
2397                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
2398                     $scaleoptions = make_menu_from_list($scale->scale);
2399                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
2400                         return false;
2401                     }
2402                 }
2403             }
2404         }
2406         if (empty($grade->attemptnumber)) {
2407             // Set it to the default.
2408             $grade->attemptnumber = 0;
2409         }
2410         $DB->update_record('assign_grades', $grade);
2412         $submission = null;
2413         if ($this->get_instance()->teamsubmission) {
2414             $submission = $this->get_group_submission($grade->userid, 0, false);
2415         } else {
2416             $submission = $this->get_user_submission($grade->userid, false);
2417         }
2419         // Only push to gradebook if the update is for the latest attempt.
2420         // Not the latest attempt.
2421         if ($submission && $submission->attemptnumber != $grade->attemptnumber) {
2422             return true;
2423         }
2425         if ($this->gradebook_item_update(null, $grade)) {
2426             \mod_assign\event\submission_graded::create_from_grade($this, $grade)->trigger();
2427         }
2429         // If the conditions are met, allow another attempt.
2430         if ($submission) {
2431             $this->reopen_submission_if_required($grade->userid,
2432                     $submission,
2433                     $reopenattempt);
2434         }
2436         return true;
2437     }
2439     /**
2440      * View the grant extension date page.
2441      *
2442      * Uses url parameters 'userid'
2443      * or from parameter 'selectedusers'
2444      *
2445      * @param moodleform $mform - Used for validation of the submitted data
2446      * @return string
2447      */
2448     protected function view_grant_extension($mform) {
2449         global $CFG;
2450         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
2452         $o = '';
2454         $data = new stdClass();
2455         $data->id = $this->get_course_module()->id;
2457         $formparams = array(
2458             'instance' => $this->get_instance(),
2459             'assign' => $this
2460         );
2462         $users = optional_param('userid', 0, PARAM_INT);
2463         if (!$users) {
2464             $users = required_param('selectedusers', PARAM_SEQUENCE);
2465         }
2466         $userlist = explode(',', $users);
2468         $keys = array('duedate', 'cutoffdate', 'allowsubmissionsfromdate');
2469         $maxoverride = array('allowsubmissionsfromdate' => 0, 'duedate' => 0, 'cutoffdate' => 0);
2470         foreach ($userlist as $userid) {
2471             // To validate extension date with users overrides.
2472             $override = $this->override_exists($userid);
2473             foreach ($keys as $key) {
2474                 if ($override->{$key}) {
2475                     if ($maxoverride[$key] < $override->{$key}) {
2476                         $maxoverride[$key] = $override->{$key};
2477                     }
2478                 } else if ($maxoverride[$key] < $this->get_instance()->{$key}) {
2479                     $maxoverride[$key] = $this->get_instance()->{$key};
2480                 }
2481             }
2482         }
2483         foreach ($keys as $key) {
2484             if ($maxoverride[$key]) {
2485                 $this->get_instance()->{$key} = $maxoverride[$key];
2486             }
2487         }
2489         $formparams['userlist'] = $userlist;
2491         $data->selectedusers = $users;
2492         $data->userid = 0;
2494         if (empty($mform)) {
2495             $mform = new mod_assign_extension_form(null, $formparams);
2496         }
2497         $mform->set_data($data);
2498         $header = new assign_header($this->get_instance(),
2499                                     $this->get_context(),
2500                                     $this->show_intro(),
2501                                     $this->get_course_module()->id,
2502                                     get_string('grantextension', 'assign'));
2503         $o .= $this->get_renderer()->render($header);
2504         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
2505         $o .= $this->view_footer();
2506         return $o;
2507     }
2509     /**
2510      * Get a list of the users in the same group as this user.
2511      *
2512      * @param int $groupid The id of the group whose members we want or 0 for the default group
2513      * @param bool $onlyids Whether to retrieve only the user id's
2514      * @param bool $excludesuspended Whether to exclude suspended users
2515      * @return array The users (possibly id's only)
2516      */
2517     public function get_submission_group_members($groupid, $onlyids, $excludesuspended = false) {
2518         $members = array();
2519         if ($groupid != 0) {
2520             $allusers = $this->list_participants($groupid, $onlyids);
2521             foreach ($allusers as $user) {
2522                 if ($this->get_submission_group($user->id)) {
2523                     $members[] = $user;
2524                 }
2525             }
2526         } else {
2527             $allusers = $this->list_participants(null, $onlyids);
2528             foreach ($allusers as $user) {
2529                 if ($this->get_submission_group($user->id) == null) {
2530                     $members[] = $user;
2531                 }
2532             }
2533         }
2534         // Exclude suspended users, if user can't see them.
2535         if ($excludesuspended || !has_capability('moodle/course:viewsuspendedusers', $this->context)) {
2536             foreach ($members as $key => $member) {
2537                 if (!$this->is_active_user($member->id)) {
2538                     unset($members[$key]);
2539                 }
2540             }
2541         }
2543         return $members;
2544     }
2546     /**
2547      * Get a list of the users in the same group as this user that have not submitted the assignment.
2548      *
2549      * @param int $groupid The id of the group whose members we want or 0 for the default group
2550      * @param bool $onlyids Whether to retrieve only the user id's
2551      * @return array The users (possibly id's only)
2552      */
2553     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
2554         $instance = $this->get_instance();
2555         if (!$instance->teamsubmission || !$instance->requireallteammemberssubmit) {
2556             return array();
2557         }
2558         $members = $this->get_submission_group_members($groupid, $onlyids);
2560         foreach ($members as $id => $member) {
2561             $submission = $this->get_user_submission($member->id, false);
2562             if ($submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2563                 unset($members[$id]);
2564             } else {
2565                 if ($this->is_blind_marking()) {
2566                     $members[$id]->alias = get_string('hiddenuser', 'assign') .
2567                                            $this->get_uniqueid_for_user($id);
2568                 }
2569             }
2570         }
2571         return $members;
2572     }
2574     /**
2575      * Load the group submission object for a particular user, optionally creating it if required.
2576      *
2577      * @param int $userid The id of the user whose submission we want
2578      * @param int $groupid The id of the group for this user - may be 0 in which
2579      *                     case it is determined from the userid.
2580      * @param bool $create If set to true a new submission object will be created in the database
2581      *                     with the status set to "new".
2582      * @param int $attemptnumber - -1 means the latest attempt
2583      * @return stdClass The submission
2584      */
2585     public function get_group_submission($userid, $groupid, $create, $attemptnumber=-1) {
2586         global $DB;
2588         if ($groupid == 0) {
2589             $group = $this->get_submission_group($userid);
2590             if ($group) {
2591                 $groupid = $group->id;
2592             }
2593         }
2595         // Now get the group submission.
2596         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2597         if ($attemptnumber >= 0) {
2598             $params['attemptnumber'] = $attemptnumber;
2599         }
2601         // Only return the row with the highest attemptnumber.
2602         $submission = null;
2603         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2604         if ($submissions) {
2605             $submission = reset($submissions);
2606         }
2608         if ($submission) {
2609             return $submission;
2610         }
2611         if ($create) {
2612             $submission = new stdClass();
2613             $submission->assignment = $this->get_instance()->id;
2614             $submission->userid = 0;
2615             $submission->groupid = $groupid;
2616             $submission->timecreated = time();
2617             $submission->timemodified = $submission->timecreated;
2618             if ($attemptnumber >= 0) {
2619                 $submission->attemptnumber = $attemptnumber;
2620             } else {
2621                 $submission->attemptnumber = 0;
2622             }
2623             // Work out if this is the latest submission.
2624             $submission->latest = 0;
2625             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2626             if ($attemptnumber == -1) {
2627                 // This is a new submission so it must be the latest.
2628                 $submission->latest = 1;
2629             } else {
2630                 // We need to work this out.
2631                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2632                 if ($result) {
2633                     $latestsubmission = reset($result);
2634                 }
2635                 if (!$latestsubmission || ($attemptnumber == $latestsubmission->attemptnumber)) {
2636                     $submission->latest = 1;
2637                 }
2638             }
2639             if ($submission->latest) {
2640                 // This is the case when we need to set latest to 0 for all the other attempts.
2641                 $DB->set_field('assign_submission', 'latest', 0, $params);
2642             }
2643             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2644             $sid = $DB->insert_record('assign_submission', $submission);
2645             return $DB->get_record('assign_submission', array('id' => $sid));
2646         }
2647         return false;
2648     }
2650     /**
2651      * View a summary listing of all assignments in the current course.
2652      *
2653      * @return string
2654      */
2655     private function view_course_index() {
2656         global $USER;
2658         $o = '';
2660         $course = $this->get_course();
2661         $strplural = get_string('modulenameplural', 'assign');
2663         if (!$cms = get_coursemodules_in_course('assign', $course->id, 'm.duedate')) {
2664             $o .= $this->get_renderer()->notification(get_string('thereareno', 'moodle', $strplural));
2665             $o .= $this->get_renderer()->continue_button(new moodle_url('/course/view.php', array('id' => $course->id)));
2666             return $o;
2667         }
2669         $strsectionname = '';
2670         $usesections = course_format_uses_sections($course->format);
2671         $modinfo = get_fast_modinfo($course);
2673         if ($usesections) {
2674             $strsectionname = get_string('sectionname', 'format_'.$course->format);
2675             $sections = $modinfo->get_section_info_all();
2676         }
2677         $courseindexsummary = new assign_course_index_summary($usesections, $strsectionname);
2679         $timenow = time();
2681         $currentsection = '';
2682         foreach ($modinfo->instances['assign'] as $cm) {
2683             if (!$cm->uservisible) {
2684                 continue;
2685             }
2687             $timedue = $cms[$cm->id]->duedate;
2689             $sectionname = '';
2690             if ($usesections && $cm->sectionnum) {
2691                 $sectionname = get_section_name($course, $sections[$cm->sectionnum]);
2692             }
2694             $submitted = '';
2695             $context = context_module::instance($cm->id);
2697             $assignment = new assign($context, $cm, $course);
2699             // Apply overrides.
2700             $assignment->update_effective_access($USER->id);
2701             $timedue = $assignment->get_instance()->duedate;
2703             if (has_capability('mod/assign:grade', $context)) {
2704                 $submitted = $assignment->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED);
2706             } else if (has_capability('mod/assign:submit', $context)) {
2707                 $usersubmission = $assignment->get_user_submission($USER->id, false);
2709                 if (!empty($usersubmission->status)) {
2710                     $submitted = get_string('submissionstatus_' . $usersubmission->status, 'assign');
2711                 } else {
2712                     $submitted = get_string('submissionstatus_', 'assign');
2713                 }
2714             }
2715             $gradinginfo = grade_get_grades($course->id, 'mod', 'assign', $cm->instance, $USER->id);
2716             if (isset($gradinginfo->items[0]->grades[$USER->id]) &&
2717                     !$gradinginfo->items[0]->grades[$USER->id]->hidden ) {
2718                 $grade = $gradinginfo->items[0]->grades[$USER->id]->str_grade;
2719             } else {
2720                 $grade = '-';
2721             }
2723             $courseindexsummary->add_assign_info($cm->id, $cm->get_formatted_name(), $sectionname, $timedue, $submitted, $grade);
2725         }
2727         $o .= $this->get_renderer()->render($courseindexsummary);
2728         $o .= $this->view_footer();
2730         return $o;
2731     }
2733     /**
2734      * View a page rendered by a plugin.
2735      *
2736      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.
2737      *
2738      * @return string
2739      */
2740     protected function view_plugin_page() {
2741         global $USER;
2743         $o = '';
2745         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
2746         $plugintype = required_param('plugin', PARAM_TEXT);
2747         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
2749         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
2750         if (!$plugin) {
2751             print_error('invalidformdata', '');
2752             return;
2753         }
2755         $o .= $plugin->view_page($pluginaction);
2757         return $o;
2758     }
2761     /**
2762      * This is used for team assignments to get the group for the specified user.
2763      * If the user is a member of multiple or no groups this will return false
2764      *
2765      * @param int $userid The id of the user whose submission we want
2766      * @return mixed The group or false
2767      */
2768     public function get_submission_group($userid) {
2770         if (isset($this->usersubmissiongroups[$userid])) {
2771             return $this->usersubmissiongroups[$userid];
2772         }
2774         $groups = $this->get_all_groups($userid);
2775         if (count($groups) != 1) {
2776             $return = false;
2777         } else {
2778             $return = array_pop($groups);
2779         }
2781         // Cache the user submission group.
2782         $this->usersubmissiongroups[$userid] = $return;
2784         return $return;
2785     }
2787     /**
2788      * Gets all groups the user is a member of.
2789      *
2790      * @param int $userid Teh id of the user who's groups we are checking
2791      * @return array The group objects
2792      */
2793     public function get_all_groups($userid) {
2794         if (isset($this->usergroups[$userid])) {
2795             return $this->usergroups[$userid];
2796         }
2798         $grouping = $this->get_instance()->teamsubmissiongroupingid;
2799         $return = groups_get_all_groups($this->get_course()->id, $userid, $grouping);
2801         $this->usergroups[$userid] = $return;
2803         return $return;
2804     }
2807     /**
2808      * Display the submission that is used by a plugin.
2809      *
2810      * Uses url parameters 'sid', 'gid' and 'plugin'.
2811      *
2812      * @param string $pluginsubtype
2813      * @return string
2814      */
2815     protected function view_plugin_content($pluginsubtype) {
2816         $o = '';
2818         $submissionid = optional_param('sid', 0, PARAM_INT);
2819         $gradeid = optional_param('gid', 0, PARAM_INT);
2820         $plugintype = required_param('plugin', PARAM_TEXT);
2821         $item = null;
2822         if ($pluginsubtype == 'assignsubmission') {
2823             $plugin = $this->get_submission_plugin_by_type($plugintype);
2824             if ($submissionid <= 0) {
2825                 throw new coding_exception('Submission id should not be 0');
2826             }
2827             $item = $this->get_submission($submissionid);
2829             // Check permissions.
2830             $this->require_view_submission($item->userid);
2831             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2832                                                               $this->get_context(),
2833                                                               $this->show_intro(),
2834                                                               $this->get_course_module()->id,
2835                                                               $plugin->get_name()));
2836             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
2837                                                               $item,
2838                                                               assign_submission_plugin_submission::FULL,
2839                                                               $this->get_course_module()->id,
2840                                                               $this->get_return_action(),
2841                                                               $this->get_return_params()));
2843             // Trigger event for viewing a submission.
2844             \mod_assign\event\submission_viewed::create_from_submission($this, $item)->trigger();
2846         } else {
2847             $plugin = $this->get_feedback_plugin_by_type($plugintype);
2848             if ($gradeid <= 0) {
2849                 throw new coding_exception('Grade id should not be 0');
2850             }
2851             $item = $this->get_grade($gradeid);
2852             // Check permissions.
2853             $this->require_view_submission($item->userid);
2854             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2855                                                               $this->get_context(),
2856                                                               $this->show_intro(),
2857                                                               $this->get_course_module()->id,
2858                                                               $plugin->get_name()));
2859             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
2860                                                               $item,
2861                                                               assign_feedback_plugin_feedback::FULL,
2862                                                               $this->get_course_module()->id,
2863                                                               $this->get_return_action(),
2864                                                               $this->get_return_params()));
2866             // Trigger event for viewing feedback.
2867             \mod_assign\event\feedback_viewed::create_from_grade($this, $item)->trigger();
2868         }
2870         $o .= $this->view_return_links();
2872         $o .= $this->view_footer();
2874         return $o;
2875     }
2877     /**
2878      * Rewrite plugin file urls so they resolve correctly in an exported zip.
2879      *
2880      * @param string $text - The replacement text
2881      * @param stdClass $user - The user record
2882      * @param assign_plugin $plugin - The assignment plugin
2883      */
2884     public function download_rewrite_pluginfile_urls($text, $user, $plugin) {
2885         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2886         $groupname = '';
2887         if ($groupmode) {
2888             $groupid = groups_get_activity_group($this->get_course_module(), true);
2889             $groupname = groups_get_group_name($groupid).'-';
2890         }
2892         if ($this->is_blind_marking()) {
2893             $prefix = $groupname . get_string('participant', 'assign');
2894             $prefix = str_replace('_', ' ', $prefix);
2895             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2896         } else {
2897             $prefix = $groupname . fullname($user);
2898             $prefix = str_replace('_', ' ', $prefix);
2899             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2900         }
2902         $subtype = $plugin->get_subtype();
2903         $type = $plugin->get_type();
2904         $prefix = $prefix . $subtype . '_' . $type . '_';
2906         $result = str_replace('@@PLUGINFILE@@/', $prefix, $text);
2908         return $result;
2909     }
2911     /**
2912      * Render the content in editor that is often used by plugin.
2913      *
2914      * @param string $filearea
2915      * @param int  $submissionid
2916      * @param string $plugintype
2917      * @param string $editor
2918      * @param string $component
2919      * @return string
2920      */
2921     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
2922         global $CFG;
2924         $result = '';
2926         $plugin = $this->get_submission_plugin_by_type($plugintype);
2928         $text = $plugin->get_editor_text($editor, $submissionid);
2929         $format = $plugin->get_editor_format($editor, $submissionid);
2931         $finaltext = file_rewrite_pluginfile_urls($text,
2932                                                   'pluginfile.php',
2933                                                   $this->get_context()->id,
2934                                                   $component,
2935                                                   $filearea,
2936                                                   $submissionid);
2937         $params = array('overflowdiv' => true, 'context' => $this->get_context());
2938         $result .= format_text($finaltext, $format, $params);
2940         if ($CFG->enableportfolios && has_capability('mod/assign:exportownsubmission', $this->context)) {
2941             require_once($CFG->libdir . '/portfoliolib.php');
2943             $button = new portfolio_add_button();
2944             $portfolioparams = array('cmid' => $this->get_course_module()->id,
2945                                      'sid' => $submissionid,
2946                                      'plugin' => $plugintype,
2947                                      'editor' => $editor,
2948                                      'area'=>$filearea);
2949             $button->set_callback_options('assign_portfolio_caller', $portfolioparams, 'mod_assign');
2950             $fs = get_file_storage();
2952             if ($files = $fs->get_area_files($this->context->id,
2953                                              $component,
2954                                              $filearea,
2955                                              $submissionid,
2956                                              'timemodified',
2957                                              false)) {
2958                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
2959             } else {
2960                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
2961             }
2962             $result .= $button->to_html();
2963         }
2964         return $result;
2965     }
2967     /**
2968      * Display a continue page after grading.
2969      *
2970      * @param string $message - The message to display.
2971      * @return string
2972      */
2973     protected function view_savegrading_result($message) {
2974         $o = '';
2975         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2976                                                       $this->get_context(),
2977                                                       $this->show_intro(),
2978                                                       $this->get_course_module()->id,
2979                                                       get_string('savegradingresult', 'assign')));
2980         $gradingresult = new assign_gradingmessage(get_string('savegradingresult', 'assign'),
2981                                                    $message,
2982                                                    $this->get_course_module()->id);
2983         $o .= $this->get_renderer()->render($gradingresult);
2984         $o .= $this->view_footer();
2985         return $o;
2986     }
2987     /**
2988      * Display a continue page after quickgrading.
2989      *
2990      * @param string $message - The message to display.
2991      * @return string
2992      */
2993     protected function view_quickgrading_result($message) {
2994         $o = '';
2995         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2996                                                       $this->get_context(),
2997                                                       $this->show_intro(),
2998                                                       $this->get_course_module()->id,
2999                                                       get_string('quickgradingresult', 'assign')));
3000         $lastpage = optional_param('lastpage', null, PARAM_INT);
3001         $gradingresult = new assign_gradingmessage(get_string('quickgradingresult', 'assign'),
3002                                                    $message,
3003                                                    $this->get_course_module()->id,
3004                                                    false,
3005                                                    $lastpage);
3006         $o .= $this->get_renderer()->render($gradingresult);
3007         $o .= $this->view_footer();
3008         return $o;
3009     }
3011     /**
3012      * Display the page footer.
3013      *
3014      * @return string
3015      */
3016     protected function view_footer() {
3017         // When viewing the footer during PHPUNIT tests a set_state error is thrown.
3018         if (!PHPUNIT_TEST) {
3019             return $this->get_renderer()->render_footer();
3020         }
3022         return '';
3023     }
3025     /**
3026      * Throw an error if the permissions to view this users submission are missing.
3027      *
3028      * @throws required_capability_exception
3029      * @return none
3030      */
3031     public function require_view_submission($userid) {
3032         if (!$this->can_view_submission($userid)) {
3033             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
3034         }
3035     }
3037     /**
3038      * Throw an error if the permissions to view grades in this assignment are missing.
3039      *
3040      * @throws required_capability_exception
3041      * @return none
3042      */
3043     public function require_view_grades() {
3044         if (!$this->can_view_grades()) {
3045             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
3046         }
3047     }
3049     /**
3050      * Does this user have view grade or grade permission for this assignment?
3051      *
3052      * @return bool
3053      */
3054     public function can_view_grades() {
3055         // Permissions check.
3056         if (!has_any_capability(array('mod/assign:viewgrades', 'mod/assign:grade'), $this->context)) {
3057             return false;
3058         }
3060         return true;
3061     }
3063     /**
3064      * Does this user have grade permission for this assignment?
3065      *
3066      * @return bool
3067      */
3068     public function can_grade() {
3069         // Permissions check.
3070         if (!has_capability('mod/assign:grade', $this->context)) {
3071             return false;
3072         }
3074         return true;
3075     }
3077     /**
3078      * Download a zip file of all assignment submissions.
3079      *
3080      * @param array $userids Array of user ids to download assignment submissions in a zip file
3081      * @return string - If an error occurs, this will contain the error page.
3082      */
3083     protected function download_submissions($userids = false) {
3084         global $CFG, $DB;
3086         // More efficient to load this here.
3087         require_once($CFG->libdir.'/filelib.php');
3089         // Increase the server timeout to handle the creation and sending of large zip files.
3090         core_php_time_limit::raise();
3092         $this->require_view_grades();
3094         // Load all users with submit.
3095         $students = get_enrolled_users($this->context, "mod/assign:submit", null, 'u.*', null, null, null,
3096                         $this->show_only_active_users());
3098         // Build a list of files to zip.
3099         $filesforzipping = array();
3100         $fs = get_file_storage();
3102         $groupmode = groups_get_activity_groupmode($this->get_course_module());
3103         // All users.
3104         $groupid = 0;
3105         $groupname = '';
3106         if ($groupmode) {
3107             $groupid = groups_get_activity_group($this->get_course_module(), true);
3108             $groupname = groups_get_group_name($groupid).'-';
3109         }
3111         // Construct the zip file name.
3112         $filename = clean_filename($this->get_course()->shortname . '-' .
3113                                    $this->get_instance()->name . '-' .
3114                                    $groupname.$this->get_course_module()->id . '.zip');
3116         // Get all the files for each student.
3117         foreach ($students as $student) {
3118             $userid = $student->id;
3119             // Download all assigments submission or only selected users.
3120             if ($userids and !in_array($userid, $userids)) {
3121                 continue;
3122             }
3124             if ((groups_is_member($groupid, $userid) or !$groupmode or !$groupid)) {
3125                 // Get the plugins to add their own files to the zip.
3127                 $submissiongroup = false;
3128                 $groupname = '';
3129                 if ($this->get_instance()->teamsubmission) {
3130                     $submission = $this->get_group_submission($userid, 0, false);
3131                     $submissiongroup = $this->get_submission_group($userid);
3132                     if ($submissiongroup) {
3133                         $groupname = $submissiongroup->name . '-';
3134                     } else {
3135                         $groupname = get_string('defaultteam', 'assign') . '-';
3136                     }
3137                 } else {
3138                     $submission = $this->get_user_submission($userid, false);
3139                 }
3141                 if ($this->is_blind_marking()) {
3142                     $prefix = str_replace('_', ' ', $groupname . get_string('participant', 'assign'));
3143                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid));
3144                 } else {
3145                     $prefix = str_replace('_', ' ', $groupname . fullname($student));
3146                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid));
3147                 }
3149                 if ($submission) {
3150                     $downloadasfolders = get_user_preferences('assign_downloadasfolders', 1);
3151                     foreach ($this->submissionplugins as $plugin) {
3152                         if ($plugin->is_enabled() && $plugin->is_visible()) {
3153                             if ($downloadasfolders) {
3154                                 // Create a folder for each user for each assignment plugin.
3155                                 // This is the default behavior for version of Moodle >= 3.1.
3156                                 $submission->exportfullpath = true;
3157                                 $pluginfiles = $plugin->get_files($submission, $student);
3158                                 foreach ($pluginfiles as $zipfilepath => $file) {
3159                                     $subtype = $plugin->get_subtype();
3160                                     $type = $plugin->get_type();
3161                                     $zipfilename = basename($zipfilepath);
3162                                     $prefixedfilename = clean_filename($prefix .
3163                                                                        '_' .
3164                                                                        $subtype .
3165                                                                        '_' .
3166                                                                        $type .
3167                                                                        '_');
3168                                     if ($type == 'file') {
3169                                         $pathfilename = $prefixedfilename . $file->get_filepath() . $zipfilename;
3170                                     } else if ($type == 'onlinetext') {
3171                                         $pathfilename = $prefixedfilename . '/' . $zipfilename;
3172                                     } else {
3173                                         $pathfilename = $prefixedfilename . '/' . $zipfilename;
3174                                     }
3175                                     $pathfilename = clean_param($pathfilename, PARAM_PATH);
3176                                     $filesforzipping[$pathfilename] = $file;
3177                                 }
3178                             } else {
3179                                 // Create a single folder for all users of all assignment plugins.
3180                                 // This was the default behavior for version of Moodle < 3.1.
3181                                 $submission->exportfullpath = false;
3182                                 $pluginfiles = $plugin->get_files($submission, $student);
3183                                 foreach ($pluginfiles as $zipfilename => $file) {
3184                                     $subtype = $plugin->get_subtype();
3185                                     $type = $plugin->get_type();
3186                                     $prefixedfilename = clean_filename($prefix .
3187                                                                        '_' .
3188                                                                        $subtype .
3189                                                                        '_' .
3190                                                                        $type .
3191                                                                        '_' .
3192                                                                        $zipfilename);
3193                                     $filesforzipping[$prefixedfilename] = $file;
3194                                 }
3195                             }
3196                         }
3197                     }
3198                 }
3199             }
3200         }
3201         $result = '';
3202         if (count($filesforzipping) == 0) {
3203             $header = new assign_header($this->get_instance(),
3204                                         $this->get_context(),
3205                                         '',
3206                                         $this->get_course_module()->id,
3207                                         get_string('downloadall', 'assign'));
3208             $result .= $this->get_renderer()->render($header);
3209             $result .= $this->get_renderer()->notification(get_string('nosubmission', 'assign'));
3210             $url = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
3211                                                                     'action'=>'grading'));
3212             $result .= $this->get_renderer()->continue_button($url);
3213             $result .= $this->view_footer();
3214         } else if ($zipfile = $this->pack_files($filesforzipping)) {
3215             \mod_assign\event\all_submissions_downloaded::create_from_assign($this)->trigger();
3216             // Send file and delete after sending.
3217             send_temp_file($zipfile, $filename);
3218             // We will not get here - send_temp_file calls exit.
3219         }
3220         return $result;
3221     }
3223     /**
3224      * Util function to add a message to the log.
3225      *
3226      * @deprecated since 2.7 - Use new events system instead.
3227      *             (see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins).
3228      *
3229      * @param string $action The current action
3230      * @param string $info A detailed description of the change. But no more than 255 characters.
3231      * @param string $url The url to the assign module instance.
3232      * @param bool $return If true, returns the arguments, else adds to log. The purpose of this is to
3233      *                     retrieve the arguments to use them with the new event system (Event 2).
3234      * @return void|array
3235      */
3236     public function add_to_log($action = '', $info = '', $url='', $return = false) {
3237         global $USER;
3239         $fullurl = 'view.php?id=' . $this->get_course_module()->id;
3240         if ($url != '') {
3241             $fullurl .= '&' . $url;
3242         }
3244         $args = array(
3245             $this->get_course()->id,
3246             'assign',
3247             $action,
3248             $fullurl,
3249             $info,
3250             $this->get_course_module()->id
3251         );
3253         if ($return) {
3254             // We only need to call debugging when returning a value. This is because the call to
3255             // call_user_func_array('add_to_log', $args) will trigger a debugging message of it's own.
3256             debugging('The mod_assign add_to_log() function is now deprecated.', DEBUG_DEVELOPER);
3257             return $args;
3258         }
3259         call_user_func_array('add_to_log', $args);
3260     }
3262     /**
3263      * Lazy load the page renderer and expose the renderer to plugins.
3264      *
3265      * @return assign_renderer
3266      */
3267     public function get_renderer() {
3268         global $PAGE;
3269         if ($this->output) {
3270             return $this->output;
3271         }
3272         $this->output = $PAGE->get_renderer('mod_assign', null, RENDERER_TARGET_GENERAL);
3273         return $this->output;
3274     }
3276     /**
3277      * Load the submission object for a particular user, optionally creating it if required.
3278      *
3279      * For team assignments there are 2 submissions - the student submission and the team submission
3280      * All files are associated with the team submission but the status of the students contribution is
3281      * recorded separately.
3282      *
3283      * @param int $userid The id of the user whose submission we want or 0 in which case USER->id is used
3284      * @param bool $create If set to true a new submission object will be created in the database with the status set to "new".
3285      * @param int $attemptnumber - -1 means the latest attempt
3286      * @return stdClass The submission
3287      */
3288     public function get_user_submission($userid, $create, $attemptnumber=-1) {
3289         global $DB, $USER;
3291         if (!$userid) {
3292             $userid = $USER->id;
3293         }
3294         // If the userid is not null then use userid.
3295         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
3296         if ($attemptnumber >= 0) {
3297             $params['attemptnumber'] = $attemptnumber;
3298         }
3300         // Only return the row with the highest attemptnumber.
3301         $submission = null;
3302         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
3303         if ($submissions) {
3304             $submission = reset($submissions);
3305         }
3307         if ($submission) {
3308             return $submission;
3309         }
3310         if ($create) {
3311             $submission = new stdClass();
3312             $submission->assignment   = $this->get_instance()->id;
3313             $submission->userid       = $userid;
3314             $submission->timecreated = time();
3315             $submission->timemodified = $submission->timecreated;
3316             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
3317             if ($attemptnumber >= 0) {
3318                 $submission->attemptnumber = $attemptnumber;
3319             } else {
3320                 $submission->attemptnumber = 0;
3321             }
3322             // Work out if this is the latest submission.
3323             $submission->latest = 0;
3324             $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
3325             if ($attemptnumber == -1) {
3326                 // This is a new submission so it must be the latest.
3327                 $submission->latest = 1;
3328             } else {
3329                 // We need to work this out.
3330                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
3331                 $latestsubmission = null;
3332                 if ($result) {
3333                     $latestsubmission = reset($result);
3334                 }
3335                 if (empty($latestsubmission) || ($attemptnumber > $latestsubmission->attemptnumber)) {
3336                     $submission->latest = 1;
3337                 }
3338             }
3339             if ($submission->latest) {
3340                 // This is the case when we need to set latest to 0 for all the other attempts.
3341                 $DB->set_field('assign_submission', 'latest', 0, $params);
3342             }
3343             $sid = $DB->insert_record('assign_submission', $submission);
3344             return $DB->get_record('assign_submission', array('id' => $sid));
3345         }
3346         return false;
3347     }
3349     /**
3350      * Load the submission object from it's id.
3351      *
3352      * @param int $submissionid The id of the submission we want
3353      * @return stdClass The submission
3354      */
3355     protected function get_submission($submissionid) {
3356         global $DB;
3358         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$submissionid);
3359         return $DB->get_record('assign_submission', $params, '*', MUST_EXIST);
3360     }
3362     /**
3363      * This will retrieve a user flags object from the db optionally creating it if required.
3364      * The user flags was split from the user_grades table in 2.5.
3365      *
3366      * @param int $userid The user we are getting the flags for.
3367      * @param bool $create If true the flags record will be created if it does not exist
3368      * @return stdClass The flags record
3369      */
3370     public function get_user_flags($userid, $create) {
3371         global $DB, $USER;
3373         // If the userid is not null then use userid.
3374         if (!$userid) {
3375             $userid = $USER->id;
3376         }
3378         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
3380         $flags = $DB->get_record('assign_user_flags', $params);
3382         if ($flags) {
3383             return $flags;
3384         }
3385         if ($create) {
3386             $flags = new stdClass();
3387             $flags->assignment = $this->get_instance()->id;
3388             $flags->userid = $userid;
3389             $flags->locked = 0;
3390             $flags->extensionduedate = 0;
3391             $flags->workflowstate = '';
3392             $flags->allocatedmarker = 0;
3394             // The mailed flag can be one of 3 values: 0 is unsent, 1 is sent and 2 is do not send yet.
3395             // This is because students only want to be notified about certain types of update (grades and feedback).
3396             $flags->mailed = 2;
3398             $fid = $DB->insert_record('assign_user_flags', $flags);
3399             $flags->id = $fid;
3400             return $flags;
3401         }
3402         return false;
3403     }
3405     /**
3406      * This will retrieve a grade object from the db, optionally creating it if required.
3407      *
3408      * @param int $userid The user we are grading
3409      * @param bool $create If true the grade will be created if it does not exist
3410      * @param int $attemptnumber The attempt number to retrieve the grade for. -1 means the latest submission.
3411      * @return stdClass The grade record
3412      */
3413     public function get_user_grade($userid, $create, $attemptnumber=-1) {
3414         global $DB, $USER;
3416         // If the userid is not null then use userid.
3417         if (!$userid) {
3418             $userid = $USER->id;
3419         }
3420         $submission = null;
3422         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
3423         if ($attemptnumber < 0 || $create) {
3424             // Make sure this grade matches the latest submission attempt.
3425             if ($this->get_instance()->teamsubmission) {
3426                 $submission = $this->get_group_submission($userid, 0, true, $attemptnumber);
3427             } else {
3428                 $submission = $this->get_user_submission($userid, true, $attemptnumber);
3429             }
3430             if ($submission) {
3431                 $attemptnumber = $submission->attemptnumber;
3432             }
3433         }
3435         if ($attemptnumber >= 0) {
3436             $params['attemptnumber'] = $attemptnumber;
3437         }
3439         $grades = $DB->get_records('assign_grades', $params, 'attemptnumber DESC', '*', 0, 1);
3441         if ($grades) {
3442             return reset($grades);
3443         }
3444         if ($create) {
3445             $grade = new stdClass();
3446             $grade->assignment   = $this->get_instance()->id;
3447             $grade->userid       = $userid;
3448             $grade->timecreated = time();
3449             // If we are "auto-creating" a grade - and there is a submission
3450             // the new grade should not have a more recent timemodified value
3451             // than the submission.
3452             if ($submission) {
3453                 $grade->timemodified = $submission->timemodified;
3454             } else {
3455                 $grade->timemodified = $grade->timecreated;
3456             }
3457             $grade->grade = -1;
3458             $grade->grader = $USER->id;
3459             if ($attemptnumber >= 0) {
3460                 $grade->attemptnumber = $attemptnumber;
3461             }
3463             $gid = $DB->insert_record('assign_grades', $grade);
3464             $grade->id = $gid;
3465             return $grade;
3466         }
3467         return false;
3468     }
3470     /**
3471      * This will retrieve a grade object from the db.
3472      *
3473      * @param int $gradeid The id of the grade
3474      * @return stdClass The grade record
3475      */
3476     protected function get_grade($gradeid) {
3477         global $DB;
3479         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$gradeid);
3480         return $DB->get_record('assign_grades', $params, '*', MUST_EXIST);
3481     }
3483     /**
3484      * Print the grading page for a single user submission.
3485      *
3486      * @param array $args Optional args array (better than pulling args from _GET and _POST)
3487      * @return string
3488      */
3489     protected function view_single_grading_panel($args) {
3490         global $DB, $CFG, $SESSION, $PAGE;
3492         $o = '';
3493         $instance = $this->get_instance();
3495         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
3497         // Need submit permission to submit an assignment.
3498         require_capability('mod/assign:grade', $this->context);
3500         // If userid is passed - we are only grading a single student.
3501         $userid = $args['userid'];
3502         $attemptnumber = $args['attemptnumber'];
3504         // Apply overrides.
3505         $this->update_effective_access($userid);
3507         $rownum = 0;
3508         $useridlist = array($userid);
3510         $last = true;
3511         // This variation on the url will link direct to this student, with no next/previous links.
3512         // The benefit is the url will be the same every time for this student, so Atto autosave drafts can match up.
3513         $returnparams = array('userid' => $userid, 'rownum' => 0, 'useridlistid' => 0);
3514         $this->register_return_link('grade', $returnparams);
3516         $user = $DB->get_record('user', array('id' => $userid));
3517         $submission = $this->get_user_submission($userid, false, $attemptnumber);
3518         $submissiongroup = null;
3519         $teamsubmission = null;
3520         $notsubmitted = array();
3521         if ($instance->teamsubmission) {
3522             $teamsubmission = $this->get_group_submission($userid, 0, false, $attemptnumber);
3523             $submissiongroup = $this->get_submission_group($userid);
3524             $groupid = 0;
3525             if ($submissiongroup) {
3526                 $groupid = $submissiongroup->id;
3527             }
3528             $notsubmitted = $this->get_submission_group_members_who_have_not_submitted($groupid, false);
3530         }
3532         // Get the requested grade.
3533         $grade = $this->get_user_grade($userid, false, $attemptnumber);
3534         $flags = $this->get_user_flags($userid, false);
3535         if ($this->can_view_submission($userid)) {
3536             $gradelocked = ($flags && $flags->locked) || $this->grading_disabled($userid);
3537             $extensionduedate = null;
3538             if ($flags) {
3539                 $extensionduedate = $flags->extensionduedate;
3540             }
3541             $showedit = $this->submissions_open($userid) && ($this->is_any_submission_plugin_enabled());
3542             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
3543             $usergroups = $this->get_all_groups($user->id);
3545             $submissionstatus = new assign_submission_status_compact($instance->allowsubmissionsfromdate,
3546                                                                      $instance->alwaysshowdescription,
3547                                                                      $submission,
3548                                                                      $instance->teamsubmission,
3549                                                                      $teamsubmission,
3550                                                                      $submissiongroup,
3551                                                                      $notsubmitted,
3552                                                                      $this->is_any_submission_plugin_enabled(),
3553                                                                      $gradelocked,
3554                                                                      $this->is_graded($userid),
3555                                                                      $instance->duedate,
3556                                                                      $instance->cutoffdate,
3557                                                                      $this->get_submission_plugins(),
3558                                                                      $this->get_return_action(),
3559                                                                      $this->get_return_params(),
3560                                                                      $this->get_course_module()->id,
3561                                                                      $this->get_course()->id,
3562                                                                      assign_submission_status::GRADER_VIEW,
3563                                                                      $showedit,
3564                                                                      false,
3565                                                                      $viewfullnames,
3566                                                                      $extensionduedate,
3567                                                                      $this->get_context(),
3568                                                                      $this->is_blind_marking(),
3569                                                                      '',
3570                                                                      $instance->attemptreopenmethod,
3571                                                                      $instance->maxattempts,
3572                                                                      $this->get_grading_status($userid),
3573                                                                      $instance->preventsubmissionnotingroup,
3574                                                                      $usergroups);
3575             $o .= $this->get_renderer()->render($submissionstatus);
3576         }
3578         if ($grade) {
3579             $data = new stdClass();
3580             if ($grade->grade !== null && $grade->grade >= 0) {
3581                 $data->grade = format_float($grade->grade, $this->get_grade_item()->get_decimals());
3582             }
3583         } else {
3584             $data = new stdClass();
3585             $data->grade = '';
3586         }
3588         if (!empty($flags->workflowstate)) {
3589             $data->workflowstate = $flags->workflowstate;
3590         }
3591         if (!empty($flags->allocatedmarker)) {
3592             $data->allocatedmarker = $flags->allocatedmarker;
3593         }
3595         // Warning if required.
3596         $allsubmissions = $this->get_all_submissions($userid);
3598         if ($attemptnumber != -1 && ($attemptnumber + 1) != count($allsubmissions)) {
3599             $params = array('attemptnumber' => $attemptnumber + 1,
3600                             'totalattempts' => count($allsubmissions));
3601             $message = get_string('editingpreviousfeedbackwarning', 'assign', $params);
3602             $o .= $this->get_renderer()->notification($message);
3603         }
3605         $pagination = array('rownum' => $rownum,
3606                             'useridlistid' => 0,
3607                             'last' => $last,
3608                             'userid' => $userid,
3609                             'attemptnumber' => $attemptnumber,
3610                             'gradingpanel' => true);
3612         if (!empty($args['formdata'])) {
3613             $data = (array) $data;
3614             $data = (object) array_merge($data, $args['formdata']);
3615         }
3616         $formparams = array($this, $data, $pagination);
3617         $mform = new mod_assign_grade_form(null,
3618                                            $formparams,
3619                                            'post',
3620                                            '',
3621                                            array('class' => 'gradeform'));
3623         if (!empty($args['formdata'])) {
3624             // If we were passed form data - we want the form to check the data
3625             // and show errors.
3626             $mform->is_validated();
3627         }
3628         $o .= $this->get_renderer()->heading(get_string('grade'), 3);
3629         $o .= $this->get_renderer()->render(new assign_form('gradingform', $mform));
3631         if (count($allsubmissions) > 1) {
3632             $allgrades = $this->get_all_grades($userid);
3633             $history = new assign_attempt_history_chooser($allsubmissions,
3634                                                           $allgrades,
3635                                                           $this->get_course_module()->id,
3636                                                           $userid);
3638             $o .= $this->get_renderer()->render($history);
3639         }
3641         \mod_assign\event\grading_form_viewed::create_from_user($this, $user)->trigger();
3643         return $o;
3644     }
3646     /**
3647      * Print the grading page for a single user submission.
3648      *
3649      * @param moodleform $mform
3650      * @return string
3651      */
3652     protected function view_single_grade_page($mform) {
3653         global $DB, $CFG, $SESSION;
3655         $o = '';
3656         $instance = $this->get_instance();
3658         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
3660         // Need submit permission to submit an assignment.
3661         require_capability('mod/assign:grade', $this->context);
3663         $header = new assign_header($instance,
3664                                     $this->get_context(),
3665                                     false,
3666                                     $this->get_course_module()->id,
3667                                     get_string('grading', 'assign'));
3668         $o .= $this->get_renderer()->render($header);
3670         // If userid is passed - we are only grading a single student.
3671         $rownum = optional_param('rownum', 0, PARAM_INT);
3672         $useridlistid = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
3673         $userid = optional_param('userid', 0, PARAM_INT);
3674         $attemptnumber = optional_param('attemptnumber', -1, PARAM_INT);
3676         if (!$userid) {
3677             $useridlistkey = $this->get_useridlist_key($useridlistid);
3678             if (empty($SESSION->mod_assign_useridlist[$useridlistkey])) {
3679                 $SESSION->mod_assign_useridlist[$useridlistkey] = $this->get_grading_userid_list();
3680             }
3681             $useridlist = $SESSION->mod_assign_useridlist[$useridlistkey];
3682         } else {
3683             $rownum = 0;
3684             $useridlistid = 0;
3685             $useridlist = array($userid);
3686         }
3688         if ($rownum < 0 || $rownum > count($useridlist)) {
3689             throw new coding_exception('Row is out of bounds for the current grading table: ' . $rownum);
3690         }
3692         $last = false;
3693         $userid = $useridlist[$rownum];
3694         if ($rownum == count($useridlist) - 1) {
3695             $last = true;
3696         }
3697         // This variation on the url will link direct to this student, with no next/previous links.
3698         // The benefit is the url will be the same every time for this student, so Atto autosave drafts can match up.
3699         $returnparams = array('userid' => $userid, 'rownum' => 0, 'useridlistid' => 0);
3700         $this->register_return_link('grade', $returnparams);
3702         $user = $DB->get_record('user', array('id' => $userid));
3703         if ($user) {
3704             $this->update_effective_access($userid);
3705             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
3706             $usersummary = new assign_user_summary($user,
3707                                                    $this->get_course()->id,
3708                                                    $viewfullnames,
3709                                                    $this->is_blind_marking(),
3710                                                    $this->get_uniqueid_for_user($user->id),
3711                                                    get_extra_user_fields($this->get_context()),
3712                                                    !$this->is_active_user($userid));
3713             $o .= $this->get_renderer()->render($usersummary);
3714         }
3715         $submission = $this->get_user_submission($userid, false, $attemptnumber);
3716         $submissiongroup = null;
3717         $teamsubmission = null;
3718         $notsubmitted = array();
3719         if ($instance->teamsubmission) {
3720             $teamsubmission = $this->get_group_submission($userid, 0, false, $attemptnumber);
3721             $submissiongroup = $this->get_submission_group($userid);
3722             $groupid = 0;
3723             if ($submissiongroup) {
3724                 $groupid = $submissiongroup->id;
3725             }
3726             $notsubmitted = $this->get_submission_group_members_who_have_not_submitted($groupid, false);
3728         }
3730         // Get the requested grade.
3731         $grade = $this->get_user_grade($userid, false, $attemptnumber);
3732         $flags = $this->get_user_flags($userid, false);
3733         if ($this->can_view_submission($userid)) {
3734             $gradelocked = ($flags && $flags->locked) || $this->grading_disabled($userid);
3735             $extensionduedate = null;
3736             if ($flags) {
3737                 $extensionduedate = $flags->extensionduedate;
3738             }
3739             $showedit = $this->submissions_open($userid) && ($this->is_any_submission_plugin_enabled());
3740             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
3741             $usergroups = $this->get_all_groups($user->id);
3743             $submissionstatus = new assign_submission_status($instance->allowsubmissionsfromdate,
3744                                                              $instance->alwaysshowdescription,
3745                                                              $submission,
3746                                                              $instance->teamsubmission,
3747                                                              $teamsubmission,
3748                                                              $submissiongroup,
3749                                                              $notsubmitted,
3750                                                              $this->is_any_submission_plugin_enabled(),
3751                                                              $gradelocked,
3752                                                              $this->is_graded($userid),
3753                                                              $instance->duedate,
3754                                                              $instance->cutoffdate,
3755                                                              $this->get_submission_plugins(),
3756                                                              $this->get_return_action(),
3757                                                              $this->get_return_params(),
3758                                                              $this->get_course_module()->id,
3759                                                              $this->get_course()->id,
3760                                                              assign_submission_status::GRADER_VIEW,
3761                                                              $showedit,