MDL-44330 Assign: Assignment grading may not display expected student
[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 // Name of file area for intro attachments.
65 define('ASSIGN_INTROATTACHMENT_FILEAREA', 'introattachment');
67 require_once($CFG->libdir . '/accesslib.php');
68 require_once($CFG->libdir . '/formslib.php');
69 require_once($CFG->dirroot . '/repository/lib.php');
70 require_once($CFG->dirroot . '/mod/assign/mod_form.php');
71 require_once($CFG->libdir . '/gradelib.php');
72 require_once($CFG->dirroot . '/grade/grading/lib.php');
73 require_once($CFG->dirroot . '/mod/assign/feedbackplugin.php');
74 require_once($CFG->dirroot . '/mod/assign/submissionplugin.php');
75 require_once($CFG->dirroot . '/mod/assign/renderable.php');
76 require_once($CFG->dirroot . '/mod/assign/gradingtable.php');
77 require_once($CFG->libdir . '/eventslib.php');
78 require_once($CFG->libdir . '/portfolio/caller.php');
80 /**
81  * Standard base class for mod_assign (assignment types).
82  *
83  * @package   mod_assign
84  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
85  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
86  */
87 class assign {
89     /** @var stdClass the assignment record that contains the global settings for this assign instance */
90     private $instance;
92     /** @var stdClass the grade_item record for this assign instance's primary grade item. */
93     private $gradeitem;
95     /** @var context the context of the course module for this assign instance
96      *               (or just the course if we are creating a new one)
97      */
98     private $context;
100     /** @var stdClass the course this assign instance belongs to */
101     private $course;
103     /** @var stdClass the admin config for all assign instances  */
104     private $adminconfig;
106     /** @var assign_renderer the custom renderer for this module */
107     private $output;
109     /** @var cm_info the course module for this assign instance */
110     private $coursemodule;
112     /** @var array cache for things like the coursemodule name or the scale menu -
113      *             only lives for a single request.
114      */
115     private $cache;
117     /** @var array list of the installed submission plugins */
118     private $submissionplugins;
120     /** @var array list of the installed feedback plugins */
121     private $feedbackplugins;
123     /** @var string action to be used to return to this page
124      *              (without repeating any form submissions etc).
125      */
126     private $returnaction = 'view';
128     /** @var array params to be used to return to this page */
129     private $returnparams = array();
131     /** @var string modulename prevents excessive calls to get_string */
132     private static $modulename = null;
134     /** @var string modulenameplural prevents excessive calls to get_string */
135     private static $modulenameplural = null;
137     /** @var array of marking workflow states for the current user */
138     private $markingworkflowstates = null;
140     /** @var bool whether to exclude users with inactive enrolment */
141     private $showonlyactiveenrol = null;
143     /** @var string A key used to identify cached userlists created by this object. */
144     private $useridlistid = null;
146     /** @var array cached list of participants for this assignment. The cache key will be group, showactive and the context id */
147     private $participants = array();
149     /** @var array cached list of user groups when team submissions are enabled. The cache key will be the user. */
150     private $usersubmissiongroups = array();
152     /** @var array cached list of user groups. The cache key will be the user. */
153     private $usergroups = array();
155     /** @var array cached list of IDs of users who share group membership with the user. The cache key will be the user. */
156     private $sharedgroupmembers = array();
158     /**
159      * Constructor for the base assign class.
160      *
161      * Note: For $coursemodule you can supply a stdclass if you like, but it
162      * will be more efficient to supply a cm_info object.
163      *
164      * @param mixed $coursemodulecontext context|null the course module context
165      *                                   (or the course context if the coursemodule has not been
166      *                                   created yet).
167      * @param mixed $coursemodule the current course module if it was already loaded,
168      *                            otherwise this class will load one from the context as required.
169      * @param mixed $course the current course  if it was already loaded,
170      *                      otherwise this class will load one from the context as required.
171      */
172     public function __construct($coursemodulecontext, $coursemodule, $course) {
173         $this->context = $coursemodulecontext;
174         $this->course = $course;
176         // Ensure that $this->coursemodule is a cm_info object (or null).
177         $this->coursemodule = cm_info::create($coursemodule);
179         // Temporary cache only lives for a single request - used to reduce db lookups.
180         $this->cache = array();
182         $this->submissionplugins = $this->load_plugins('assignsubmission');
183         $this->feedbackplugins = $this->load_plugins('assignfeedback');
185         // Extra entropy is required for uniqid() to work on cygwin.
186         $this->useridlistid = clean_param(uniqid('', true), PARAM_ALPHANUM);
187     }
189     /**
190      * Set the action and parameters that can be used to return to the current page.
191      *
192      * @param string $action The action for the current page
193      * @param array $params An array of name value pairs which form the parameters
194      *                      to return to the current page.
195      * @return void
196      */
197     public function register_return_link($action, $params) {
198         global $PAGE;
199         $params['action'] = $action;
200         $currenturl = $PAGE->url;
202         $currenturl->params($params);
203         $PAGE->set_url($currenturl);
204     }
206     /**
207      * Return an action that can be used to get back to the current page.
208      *
209      * @return string action
210      */
211     public function get_return_action() {
212         global $PAGE;
214         $params = $PAGE->url->params();
216         if (!empty($params['action'])) {
217             return $params['action'];
218         }
219         return '';
220     }
222     /**
223      * Based on the current assignment settings should we display the intro.
224      *
225      * @return bool showintro
226      */
227     public function show_intro() {
228         if ($this->get_instance()->alwaysshowdescription ||
229                 time() > $this->get_instance()->allowsubmissionsfromdate) {
230             return true;
231         }
232         return false;
233     }
235     /**
236      * Return a list of parameters that can be used to get back to the current page.
237      *
238      * @return array params
239      */
240     public function get_return_params() {
241         global $PAGE;
243         $params = $PAGE->url->params();
244         unset($params['id']);
245         unset($params['action']);
246         return $params;
247     }
249     /**
250      * Set the submitted form data.
251      *
252      * @param stdClass $data The form data (instance)
253      */
254     public function set_instance(stdClass $data) {
255         $this->instance = $data;
256     }
258     /**
259      * Set the context.
260      *
261      * @param context $context The new context
262      */
263     public function set_context(context $context) {
264         $this->context = $context;
265     }
267     /**
268      * Set the course data.
269      *
270      * @param stdClass $course The course data
271      */
272     public function set_course(stdClass $course) {
273         $this->course = $course;
274     }
276     /**
277      * Get list of feedback plugins installed.
278      *
279      * @return array
280      */
281     public function get_feedback_plugins() {
282         return $this->feedbackplugins;
283     }
285     /**
286      * Get list of submission plugins installed.
287      *
288      * @return array
289      */
290     public function get_submission_plugins() {
291         return $this->submissionplugins;
292     }
294     /**
295      * Is blind marking enabled and reveal identities not set yet?
296      *
297      * @return bool
298      */
299     public function is_blind_marking() {
300         return $this->get_instance()->blindmarking && !$this->get_instance()->revealidentities;
301     }
303     /**
304      * Does an assignment have submission(s) or grade(s) already?
305      *
306      * @return bool
307      */
308     public function has_submissions_or_grades() {
309         $allgrades = $this->count_grades();
310         $allsubmissions = $this->count_submissions();
311         if (($allgrades == 0) && ($allsubmissions == 0)) {
312             return false;
313         }
314         return true;
315     }
317     /**
318      * Get a specific submission plugin by its type.
319      *
320      * @param string $subtype assignsubmission | assignfeedback
321      * @param string $type
322      * @return mixed assign_plugin|null
323      */
324     public function get_plugin_by_type($subtype, $type) {
325         $shortsubtype = substr($subtype, strlen('assign'));
326         $name = $shortsubtype . 'plugins';
327         if ($name != 'feedbackplugins' && $name != 'submissionplugins') {
328             return null;
329         }
330         $pluginlist = $this->$name;
331         foreach ($pluginlist as $plugin) {
332             if ($plugin->get_type() == $type) {
333                 return $plugin;
334             }
335         }
336         return null;
337     }
339     /**
340      * Get a feedback plugin by type.
341      *
342      * @param string $type - The type of plugin e.g comments
343      * @return mixed assign_feedback_plugin|null
344      */
345     public function get_feedback_plugin_by_type($type) {
346         return $this->get_plugin_by_type('assignfeedback', $type);
347     }
349     /**
350      * Get a submission plugin by type.
351      *
352      * @param string $type - The type of plugin e.g comments
353      * @return mixed assign_submission_plugin|null
354      */
355     public function get_submission_plugin_by_type($type) {
356         return $this->get_plugin_by_type('assignsubmission', $type);
357     }
359     /**
360      * Load the plugins from the sub folders under subtype.
361      *
362      * @param string $subtype - either submission or feedback
363      * @return array - The sorted list of plugins
364      */
365     protected function load_plugins($subtype) {
366         global $CFG;
367         $result = array();
369         $names = core_component::get_plugin_list($subtype);
371         foreach ($names as $name => $path) {
372             if (file_exists($path . '/locallib.php')) {
373                 require_once($path . '/locallib.php');
375                 $shortsubtype = substr($subtype, strlen('assign'));
376                 $pluginclass = 'assign_' . $shortsubtype . '_' . $name;
378                 $plugin = new $pluginclass($this, $name);
380                 if ($plugin instanceof assign_plugin) {
381                     $idx = $plugin->get_sort_order();
382                     while (array_key_exists($idx, $result)) {
383                         $idx +=1;
384                     }
385                     $result[$idx] = $plugin;
386                 }
387             }
388         }
389         ksort($result);
390         return $result;
391     }
393     /**
394      * Display the assignment, used by view.php
395      *
396      * The assignment is displayed differently depending on your role,
397      * the settings for the assignment and the status of the assignment.
398      *
399      * @param string $action The current action if any.
400      * @return string - The page output.
401      */
402     public function view($action='') {
404         $o = '';
405         $mform = null;
406         $notices = array();
407         $nextpageparams = array();
409         if (!empty($this->get_course_module()->id)) {
410             $nextpageparams['id'] = $this->get_course_module()->id;
411         }
413         // Handle form submissions first.
414         if ($action == 'savesubmission') {
415             $action = 'editsubmission';
416             if ($this->process_save_submission($mform, $notices)) {
417                 $action = 'redirect';
418                 $nextpageparams['action'] = 'view';
419             }
420         } else if ($action == 'editprevioussubmission') {
421             $action = 'editsubmission';
422             if ($this->process_copy_previous_attempt($notices)) {
423                 $action = 'redirect';
424                 $nextpageparams['action'] = 'editsubmission';
425             }
426         } else if ($action == 'lock') {
427             $this->process_lock_submission();
428             $action = 'redirect';
429             $nextpageparams['action'] = 'grading';
430         } else if ($action == 'addattempt') {
431             $this->process_add_attempt(required_param('userid', PARAM_INT));
432             $action = 'redirect';
433             $nextpageparams['action'] = 'grading';
434         } else if ($action == 'reverttodraft') {
435             $this->process_revert_to_draft();
436             $action = 'redirect';
437             $nextpageparams['action'] = 'grading';
438         } else if ($action == 'unlock') {
439             $this->process_unlock_submission();
440             $action = 'redirect';
441             $nextpageparams['action'] = 'grading';
442         } else if ($action == 'setbatchmarkingworkflowstate') {
443             $this->process_set_batch_marking_workflow_state();
444             $action = 'redirect';
445             $nextpageparams['action'] = 'grading';
446         } else if ($action == 'setbatchmarkingallocation') {
447             $this->process_set_batch_marking_allocation();
448             $action = 'redirect';
449             $nextpageparams['action'] = 'grading';
450         } else if ($action == 'confirmsubmit') {
451             $action = 'submit';
452             if ($this->process_submit_for_grading($mform, $notices)) {
453                 $action = 'redirect';
454                 $nextpageparams['action'] = 'view';
455             } else if ($notices) {
456                 $action = 'viewsubmitforgradingerror';
457             }
458         } else if ($action == 'submitotherforgrading') {
459             if ($this->process_submit_other_for_grading($mform, $notices)) {
460                 $action = 'redirect';
461                 $nextpageparams['action'] = 'grading';
462             } else {
463                 $action = 'viewsubmitforgradingerror';
464             }
465         } else if ($action == 'gradingbatchoperation') {
466             $action = $this->process_grading_batch_operation($mform);
467             if ($action == 'grading') {
468                 $action = 'redirect';
469                 $nextpageparams['action'] = 'grading';
470             }
471         } else if ($action == 'submitgrade') {
472             if (optional_param('saveandshownext', null, PARAM_RAW)) {
473                 // Save and show next.
474                 $action = 'grade';
475                 if ($this->process_save_grade($mform)) {
476                     $action = 'redirect';
477                     $nextpageparams['action'] = 'grade';
478                     $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
479                     $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
480                 }
481             } else if (optional_param('nosaveandprevious', null, PARAM_RAW)) {
482                 $action = 'redirect';
483                 $nextpageparams['action'] = 'grade';
484                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) - 1;
485                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
486             } else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
487                 $action = 'redirect';
488                 $nextpageparams['action'] = 'grade';
489                 $nextpageparams['rownum'] = optional_param('rownum', 0, PARAM_INT) + 1;
490                 $nextpageparams['useridlistid'] = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
491             } else if (optional_param('savegrade', null, PARAM_RAW)) {
492                 // Save changes button.
493                 $action = 'grade';
494                 if ($this->process_save_grade($mform)) {
495                     $action = 'redirect';
496                     $nextpageparams['action'] = 'savegradingresult';
497                 }
498             } else {
499                 // Cancel button.
500                 $action = 'redirect';
501                 $nextpageparams['action'] = 'grading';
502             }
503         } else if ($action == 'quickgrade') {
504             $message = $this->process_save_quick_grades();
505             $action = 'quickgradingresult';
506         } else if ($action == 'saveoptions') {
507             $this->process_save_grading_options();
508             $action = 'redirect';
509             $nextpageparams['action'] = 'grading';
510         } else if ($action == 'saveextension') {
511             $action = 'grantextension';
512             if ($this->process_save_extension($mform)) {
513                 $action = 'redirect';
514                 $nextpageparams['action'] = 'grading';
515             }
516         } else if ($action == 'revealidentitiesconfirm') {
517             $this->process_reveal_identities();
518             $action = 'redirect';
519             $nextpageparams['action'] = 'grading';
520         }
522         $returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT),
523                               'useridlistid' => optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM));
524         $this->register_return_link($action, $returnparams);
526         // Now show the right view page.
527         if ($action == 'redirect') {
528             $nextpageurl = new moodle_url('/mod/assign/view.php', $nextpageparams);
529             redirect($nextpageurl);
530             return;
531         } else if ($action == 'savegradingresult') {
532             $message = get_string('gradingchangessaved', 'assign');
533             $o .= $this->view_savegrading_result($message);
534         } else if ($action == 'quickgradingresult') {
535             $mform = null;
536             $o .= $this->view_quickgrading_result($message);
537         } else if ($action == 'grade') {
538             $o .= $this->view_single_grade_page($mform);
539         } else if ($action == 'viewpluginassignfeedback') {
540             $o .= $this->view_plugin_content('assignfeedback');
541         } else if ($action == 'viewpluginassignsubmission') {
542             $o .= $this->view_plugin_content('assignsubmission');
543         } else if ($action == 'editsubmission') {
544             $o .= $this->view_edit_submission_page($mform, $notices);
545         } else if ($action == 'grading') {
546             $o .= $this->view_grading_page();
547         } else if ($action == 'downloadall') {
548             $o .= $this->download_submissions();
549         } else if ($action == 'submit') {
550             $o .= $this->check_submit_for_grading($mform);
551         } else if ($action == 'grantextension') {
552             $o .= $this->view_grant_extension($mform);
553         } else if ($action == 'revealidentities') {
554             $o .= $this->view_reveal_identities_confirm($mform);
555         } else if ($action == 'plugingradingbatchoperation') {
556             $o .= $this->view_plugin_grading_batch_operation($mform);
557         } else if ($action == 'viewpluginpage') {
558              $o .= $this->view_plugin_page();
559         } else if ($action == 'viewcourseindex') {
560              $o .= $this->view_course_index();
561         } else if ($action == 'viewbatchsetmarkingworkflowstate') {
562              $o .= $this->view_batch_set_workflow_state($mform);
563         } else if ($action == 'viewbatchmarkingallocation') {
564             $o .= $this->view_batch_markingallocation($mform);
565         } else if ($action == 'viewsubmitforgradingerror') {
566             $o .= $this->view_error_page(get_string('submitforgrading', 'assign'), $notices);
567         } else {
568             $o .= $this->view_submission_page();
569         }
571         return $o;
572     }
574     /**
575      * Add this instance to the database.
576      *
577      * @param stdClass $formdata The data submitted from the form
578      * @param bool $callplugins This is used to skip the plugin code
579      *             when upgrading an old assignment to a new one (the plugins get called manually)
580      * @return mixed false if an error occurs or the int id of the new instance
581      */
582     public function add_instance(stdClass $formdata, $callplugins) {
583         global $DB;
584         $adminconfig = $this->get_admin_config();
586         $err = '';
588         // Add the database record.
589         $update = new stdClass();
590         $update->name = $formdata->name;
591         $update->timemodified = time();
592         $update->timecreated = time();
593         $update->course = $formdata->course;
594         $update->courseid = $formdata->course;
595         $update->intro = $formdata->intro;
596         $update->introformat = $formdata->introformat;
597         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
598         $update->submissiondrafts = $formdata->submissiondrafts;
599         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
600         $update->sendnotifications = $formdata->sendnotifications;
601         $update->sendlatenotifications = $formdata->sendlatenotifications;
602         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
603         if (isset($formdata->sendstudentnotifications)) {
604             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
605         }
606         $update->duedate = $formdata->duedate;
607         $update->cutoffdate = $formdata->cutoffdate;
608         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
609         $update->grade = $formdata->grade;
610         $update->completionsubmit = !empty($formdata->completionsubmit);
611         $update->teamsubmission = $formdata->teamsubmission;
612         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
613         if (isset($formdata->teamsubmissiongroupingid)) {
614             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
615         }
616         $update->blindmarking = $formdata->blindmarking;
617         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
618         if (!empty($formdata->attemptreopenmethod)) {
619             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
620         }
621         if (!empty($formdata->maxattempts)) {
622             $update->maxattempts = $formdata->maxattempts;
623         }
624         if (isset($formdata->preventsubmissionnotingroup)) {
625             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
626         }
627         $update->markingworkflow = $formdata->markingworkflow;
628         $update->markingallocation = $formdata->markingallocation;
629         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
630             $update->markingallocation = 0;
631         }
633         $returnid = $DB->insert_record('assign', $update);
634         $this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
635         // Cache the course record.
636         $this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
638         $this->save_intro_draft_files($formdata);
640         if ($callplugins) {
641             // Call save_settings hook for submission plugins.
642             foreach ($this->submissionplugins as $plugin) {
643                 if (!$this->update_plugin_instance($plugin, $formdata)) {
644                     print_error($plugin->get_error());
645                     return false;
646                 }
647             }
648             foreach ($this->feedbackplugins as $plugin) {
649                 if (!$this->update_plugin_instance($plugin, $formdata)) {
650                     print_error($plugin->get_error());
651                     return false;
652                 }
653             }
655             // In the case of upgrades the coursemodule has not been set,
656             // so we need to wait before calling these two.
657             $this->update_calendar($formdata->coursemodule);
658             $this->update_gradebook(false, $formdata->coursemodule);
660         }
662         $update = new stdClass();
663         $update->id = $this->get_instance()->id;
664         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
665         $DB->update_record('assign', $update);
667         return $returnid;
668     }
670     /**
671      * Delete all grades from the gradebook for this assignment.
672      *
673      * @return bool
674      */
675     protected function delete_grades() {
676         global $CFG;
678         $result = grade_update('mod/assign',
679                                $this->get_course()->id,
680                                'mod',
681                                'assign',
682                                $this->get_instance()->id,
683                                0,
684                                null,
685                                array('deleted'=>1));
686         return $result == GRADE_UPDATE_OK;
687     }
689     /**
690      * Delete this instance from the database.
691      *
692      * @return bool false if an error occurs
693      */
694     public function delete_instance() {
695         global $DB;
696         $result = true;
698         foreach ($this->submissionplugins as $plugin) {
699             if (!$plugin->delete_instance()) {
700                 print_error($plugin->get_error());
701                 $result = false;
702             }
703         }
704         foreach ($this->feedbackplugins as $plugin) {
705             if (!$plugin->delete_instance()) {
706                 print_error($plugin->get_error());
707                 $result = false;
708             }
709         }
711         // Delete files associated with this assignment.
712         $fs = get_file_storage();
713         if (! $fs->delete_area_files($this->context->id) ) {
714             $result = false;
715         }
717         // Delete_records will throw an exception if it fails - so no need for error checking here.
718         $DB->delete_records('assign_submission', array('assignment' => $this->get_instance()->id));
719         $DB->delete_records('assign_grades', array('assignment' => $this->get_instance()->id));
720         $DB->delete_records('assign_plugin_config', array('assignment' => $this->get_instance()->id));
721         $DB->delete_records('assign_user_flags', array('assignment' => $this->get_instance()->id));
722         $DB->delete_records('assign_user_mapping', array('assignment' => $this->get_instance()->id));
724         // Delete items from the gradebook.
725         if (! $this->delete_grades()) {
726             $result = false;
727         }
729         // Delete the instance.
730         $DB->delete_records('assign', array('id'=>$this->get_instance()->id));
732         return $result;
733     }
735     /**
736      * Actual implementation of the reset course functionality, delete all the
737      * assignment submissions for course $data->courseid.
738      *
739      * @param stdClass $data the data submitted from the reset course.
740      * @return array status array
741      */
742     public function reset_userdata($data) {
743         global $CFG, $DB;
745         $componentstr = get_string('modulenameplural', 'assign');
746         $status = array();
748         $fs = get_file_storage();
749         if (!empty($data->reset_assign_submissions)) {
750             // Delete files associated with this assignment.
751             foreach ($this->submissionplugins as $plugin) {
752                 $fileareas = array();
753                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
754                 $fileareas = $plugin->get_file_areas();
755                 foreach ($fileareas as $filearea => $notused) {
756                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
757                 }
759                 if (!$plugin->delete_instance()) {
760                     $status[] = array('component'=>$componentstr,
761                                       'item'=>get_string('deleteallsubmissions', 'assign'),
762                                       'error'=>$plugin->get_error());
763                 }
764             }
766             foreach ($this->feedbackplugins as $plugin) {
767                 $fileareas = array();
768                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
769                 $fileareas = $plugin->get_file_areas();
770                 foreach ($fileareas as $filearea => $notused) {
771                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
772                 }
774                 if (!$plugin->delete_instance()) {
775                     $status[] = array('component'=>$componentstr,
776                                       'item'=>get_string('deleteallsubmissions', 'assign'),
777                                       'error'=>$plugin->get_error());
778                 }
779             }
781             $assignids = $DB->get_records('assign', array('course' => $data->courseid), '', 'id');
782             list($sql, $params) = $DB->get_in_or_equal(array_keys($assignids));
784             $DB->delete_records_select('assign_submission', "assignment $sql", $params);
785             $DB->delete_records_select('assign_user_flags', "assignment $sql", $params);
787             $status[] = array('component'=>$componentstr,
788                               'item'=>get_string('deleteallsubmissions', 'assign'),
789                               'error'=>false);
791             if (!empty($data->reset_gradebook_grades)) {
792                 $DB->delete_records_select('assign_grades', "assignment $sql", $params);
793                 // Remove all grades from gradebook.
794                 require_once($CFG->dirroot.'/mod/assign/lib.php');
795                 assign_reset_gradebook($data->courseid);
797                 // Reset revealidentities if both submissions and grades have been reset.
798                 if ($this->get_instance()->blindmarking && $this->get_instance()->revealidentities) {
799                     $DB->set_field('assign', 'revealidentities', 0, array('id' => $this->get_instance()->id));
800                 }
801             }
802         }
803         // Updating dates - shift may be negative too.
804         if ($data->timeshift) {
805             shift_course_mod_dates('assign',
806                                     array('duedate', 'allowsubmissionsfromdate', 'cutoffdate'),
807                                     $data->timeshift,
808                                     $data->courseid, $this->get_instance()->id);
809             $status[] = array('component'=>$componentstr,
810                               'item'=>get_string('datechanged'),
811                               'error'=>false);
812         }
814         return $status;
815     }
817     /**
818      * Update the settings for a single plugin.
819      *
820      * @param assign_plugin $plugin The plugin to update
821      * @param stdClass $formdata The form data
822      * @return bool false if an error occurs
823      */
824     protected function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
825         if ($plugin->is_visible()) {
826             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
827             if (!empty($formdata->$enabledname)) {
828                 $plugin->enable();
829                 if (!$plugin->save_settings($formdata)) {
830                     print_error($plugin->get_error());
831                     return false;
832                 }
833             } else {
834                 $plugin->disable();
835             }
836         }
837         return true;
838     }
840     /**
841      * Update the gradebook information for this assignment.
842      *
843      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
844      * @param int $coursemoduleid This is required because it might not exist in the database yet
845      * @return bool
846      */
847     public function update_gradebook($reset, $coursemoduleid) {
848         global $CFG;
850         require_once($CFG->dirroot.'/mod/assign/lib.php');
851         $assign = clone $this->get_instance();
852         $assign->cmidnumber = $coursemoduleid;
854         // Set assign gradebook feedback plugin status (enabled and visible).
855         $assign->gradefeedbackenabled = $this->is_gradebook_feedback_enabled();
857         $param = null;
858         if ($reset) {
859             $param = 'reset';
860         }
862         return assign_grade_item_update($assign, $param);
863     }
865     /**
866      * Load and cache the admin config for this module.
867      *
868      * @return stdClass the plugin config
869      */
870     public function get_admin_config() {
871         if ($this->adminconfig) {
872             return $this->adminconfig;
873         }
874         $this->adminconfig = get_config('assign');
875         return $this->adminconfig;
876     }
878     /**
879      * Update the calendar entries for this assignment.
880      *
881      * @param int $coursemoduleid - Required to pass this in because it might
882      *                              not exist in the database yet.
883      * @return bool
884      */
885     public function update_calendar($coursemoduleid) {
886         global $DB, $CFG;
887         require_once($CFG->dirroot.'/calendar/lib.php');
889         // Special case for add_instance as the coursemodule has not been set yet.
890         $instance = $this->get_instance();
892         if ($instance->duedate) {
893             $event = new stdClass();
895             $params = array('modulename'=>'assign', 'instance'=>$instance->id);
896             $event->id = $DB->get_field('event', 'id', $params);
897             $event->name = $instance->name;
898             $event->timestart = $instance->duedate;
900             // Convert the links to pluginfile. It is a bit hacky but at this stage the files
901             // might not have been saved in the module area yet.
902             $intro = $instance->intro;
903             if ($draftid = file_get_submitted_draft_itemid('introeditor')) {
904                 $intro = file_rewrite_urls_to_pluginfile($intro, $draftid);
905             }
907             // We need to remove the links to files as the calendar is not ready
908             // to support module events with file areas.
909             $intro = strip_pluginfile_content($intro);
910             if ($this->show_intro()) {
911                 $event->description = array(
912                     'text' => $intro,
913                     'format' => $instance->introformat
914                 );
915             } else {
916                 $event->description = array(
917                     'text' => '',
918                     'format' => $instance->introformat
919                 );
920             }
922             if ($event->id) {
923                 $calendarevent = calendar_event::load($event->id);
924                 $calendarevent->update($event);
925             } else {
926                 unset($event->id);
927                 $event->courseid    = $instance->course;
928                 $event->groupid     = 0;
929                 $event->userid      = 0;
930                 $event->modulename  = 'assign';
931                 $event->instance    = $instance->id;
932                 $event->eventtype   = 'due';
933                 $event->timeduration = 0;
934                 calendar_event::create($event);
935             }
936         } else {
937             $DB->delete_records('event', array('modulename'=>'assign', 'instance'=>$instance->id));
938         }
939     }
942     /**
943      * Update this instance in the database.
944      *
945      * @param stdClass $formdata - the data submitted from the form
946      * @return bool false if an error occurs
947      */
948     public function update_instance($formdata) {
949         global $DB;
950         $adminconfig = $this->get_admin_config();
952         $update = new stdClass();
953         $update->id = $formdata->instance;
954         $update->name = $formdata->name;
955         $update->timemodified = time();
956         $update->course = $formdata->course;
957         $update->intro = $formdata->intro;
958         $update->introformat = $formdata->introformat;
959         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
960         $update->submissiondrafts = $formdata->submissiondrafts;
961         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
962         $update->sendnotifications = $formdata->sendnotifications;
963         $update->sendlatenotifications = $formdata->sendlatenotifications;
964         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
965         if (isset($formdata->sendstudentnotifications)) {
966             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
967         }
968         $update->duedate = $formdata->duedate;
969         $update->cutoffdate = $formdata->cutoffdate;
970         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
971         $update->grade = $formdata->grade;
972         if (!empty($formdata->completionunlocked)) {
973             $update->completionsubmit = !empty($formdata->completionsubmit);
974         }
975         $update->teamsubmission = $formdata->teamsubmission;
976         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
977         if (isset($formdata->teamsubmissiongroupingid)) {
978             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
979         }
980         $update->blindmarking = $formdata->blindmarking;
981         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
982         if (!empty($formdata->attemptreopenmethod)) {
983             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
984         }
985         if (!empty($formdata->maxattempts)) {
986             $update->maxattempts = $formdata->maxattempts;
987         }
988         if (isset($formdata->preventsubmissionnotingroup)) {
989             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
990         }
991         $update->markingworkflow = $formdata->markingworkflow;
992         $update->markingallocation = $formdata->markingallocation;
993         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
994             $update->markingallocation = 0;
995         }
997         $result = $DB->update_record('assign', $update);
998         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
1000         $this->save_intro_draft_files($formdata);
1002         // Load the assignment so the plugins have access to it.
1004         // Call save_settings hook for submission plugins.
1005         foreach ($this->submissionplugins as $plugin) {
1006             if (!$this->update_plugin_instance($plugin, $formdata)) {
1007                 print_error($plugin->get_error());
1008                 return false;
1009             }
1010         }
1011         foreach ($this->feedbackplugins as $plugin) {
1012             if (!$this->update_plugin_instance($plugin, $formdata)) {
1013                 print_error($plugin->get_error());
1014                 return false;
1015             }
1016         }
1018         $this->update_calendar($this->get_course_module()->id);
1019         $this->update_gradebook(false, $this->get_course_module()->id);
1021         $update = new stdClass();
1022         $update->id = $this->get_instance()->id;
1023         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
1024         $DB->update_record('assign', $update);
1026         return $result;
1027     }
1029     /**
1030      * Save the attachments in the draft areas.
1031      *
1032      * @param stdClass $formdata
1033      */
1034     protected function save_intro_draft_files($formdata) {
1035         if (isset($formdata->introattachments)) {
1036             file_save_draft_area_files($formdata->introattachments, $this->get_context()->id,
1037                                        'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA, 0);
1038         }
1039     }
1041     /**
1042      * Add elements in grading plugin form.
1043      *
1044      * @param mixed $grade stdClass|null
1045      * @param MoodleQuickForm $mform
1046      * @param stdClass $data
1047      * @param int $userid - The userid we are grading
1048      * @return void
1049      */
1050     protected function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
1051         foreach ($this->feedbackplugins as $plugin) {
1052             if ($plugin->is_enabled() && $plugin->is_visible()) {
1053                 $plugin->get_form_elements_for_user($grade, $mform, $data, $userid);
1054             }
1055         }
1056     }
1060     /**
1061      * Add one plugins settings to edit plugin form.
1062      *
1063      * @param assign_plugin $plugin The plugin to add the settings from
1064      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1065      *                               This form is modified directly (not returned).
1066      * @param array $pluginsenabled A list of form elements to be added to a group.
1067      *                              The new element is added to this array by this function.
1068      * @return void
1069      */
1070     protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) {
1071         global $CFG;
1072         if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) {
1073             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1074             $pluginsenabled[] = $mform->createElement('hidden', $name, 1);
1075             $mform->setType($name, PARAM_BOOL);
1076             $plugin->get_settings($mform);
1077         } else if ($plugin->is_visible() && $plugin->is_configurable()) {
1078             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1079             $label = $plugin->get_name();
1080             $label .= ' ' . $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
1081             $pluginsenabled[] = $mform->createElement('checkbox', $name, '', $label);
1083             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
1084             if ($plugin->get_config('enabled') !== false) {
1085                 $default = $plugin->is_enabled();
1086             }
1087             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
1089             $plugin->get_settings($mform);
1091         }
1092     }
1094     /**
1095      * Add settings to edit plugin form.
1096      *
1097      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1098      *                               This form is modified directly (not returned).
1099      * @return void
1100      */
1101     public function add_all_plugin_settings(MoodleQuickForm $mform) {
1102         $mform->addElement('header', 'submissiontypes', get_string('submissiontypes', 'assign'));
1104         $submissionpluginsenabled = array();
1105         $group = $mform->addGroup(array(), 'submissionplugins', get_string('submissiontypes', 'assign'), array(' '), false);
1106         foreach ($this->submissionplugins as $plugin) {
1107             $this->add_plugin_settings($plugin, $mform, $submissionpluginsenabled);
1108         }
1109         $group->setElements($submissionpluginsenabled);
1111         $mform->addElement('header', 'feedbacktypes', get_string('feedbacktypes', 'assign'));
1112         $feedbackpluginsenabled = array();
1113         $group = $mform->addGroup(array(), 'feedbackplugins', get_string('feedbacktypes', 'assign'), array(' '), false);
1114         foreach ($this->feedbackplugins as $plugin) {
1115             $this->add_plugin_settings($plugin, $mform, $feedbackpluginsenabled);
1116         }
1117         $group->setElements($feedbackpluginsenabled);
1118         $mform->setExpanded('submissiontypes');
1119     }
1121     /**
1122      * Allow each plugin an opportunity to update the defaultvalues
1123      * passed in to the settings form (needed to set up draft areas for
1124      * editor and filemanager elements)
1125      *
1126      * @param array $defaultvalues
1127      */
1128     public function plugin_data_preprocessing(&$defaultvalues) {
1129         foreach ($this->submissionplugins as $plugin) {
1130             if ($plugin->is_visible()) {
1131                 $plugin->data_preprocessing($defaultvalues);
1132             }
1133         }
1134         foreach ($this->feedbackplugins as $plugin) {
1135             if ($plugin->is_visible()) {
1136                 $plugin->data_preprocessing($defaultvalues);
1137             }
1138         }
1139     }
1141     /**
1142      * Get the name of the current module.
1143      *
1144      * @return string the module name (Assignment)
1145      */
1146     protected function get_module_name() {
1147         if (isset(self::$modulename)) {
1148             return self::$modulename;
1149         }
1150         self::$modulename = get_string('modulename', 'assign');
1151         return self::$modulename;
1152     }
1154     /**
1155      * Get the plural name of the current module.
1156      *
1157      * @return string the module name plural (Assignments)
1158      */
1159     protected function get_module_name_plural() {
1160         if (isset(self::$modulenameplural)) {
1161             return self::$modulenameplural;
1162         }
1163         self::$modulenameplural = get_string('modulenameplural', 'assign');
1164         return self::$modulenameplural;
1165     }
1167     /**
1168      * Has this assignment been constructed from an instance?
1169      *
1170      * @return bool
1171      */
1172     public function has_instance() {
1173         return $this->instance || $this->get_course_module();
1174     }
1176     /**
1177      * Get the settings for the current instance of this assignment
1178      *
1179      * @return stdClass The settings
1180      */
1181     public function get_instance() {
1182         global $DB;
1183         if ($this->instance) {
1184             return $this->instance;
1185         }
1186         if ($this->get_course_module()) {
1187             $params = array('id' => $this->get_course_module()->instance);
1188             $this->instance = $DB->get_record('assign', $params, '*', MUST_EXIST);
1189         }
1190         if (!$this->instance) {
1191             throw new coding_exception('Improper use of the assignment class. ' .
1192                                        'Cannot load the assignment record.');
1193         }
1194         return $this->instance;
1195     }
1197     /**
1198      * Get the primary grade item for this assign instance.
1199      *
1200      * @return stdClass The grade_item record
1201      */
1202     public function get_grade_item() {
1203         if ($this->gradeitem) {
1204             return $this->gradeitem;
1205         }
1206         $instance = $this->get_instance();
1207         $params = array('itemtype' => 'mod',
1208                         'itemmodule' => 'assign',
1209                         'iteminstance' => $instance->id,
1210                         'courseid' => $instance->course,
1211                         'itemnumber' => 0);
1212         $this->gradeitem = grade_item::fetch($params);
1213         if (!$this->gradeitem) {
1214             throw new coding_exception('Improper use of the assignment class. ' .
1215                                        'Cannot load the grade item.');
1216         }
1217         return $this->gradeitem;
1218     }
1220     /**
1221      * Get the context of the current course.
1222      *
1223      * @return mixed context|null The course context
1224      */
1225     public function get_course_context() {
1226         if (!$this->context && !$this->course) {
1227             throw new coding_exception('Improper use of the assignment class. ' .
1228                                        'Cannot load the course context.');
1229         }
1230         if ($this->context) {
1231             return $this->context->get_course_context();
1232         } else {
1233             return context_course::instance($this->course->id);
1234         }
1235     }
1238     /**
1239      * Get the current course module.
1240      *
1241      * @return cm_info|null The course module or null if not known
1242      */
1243     public function get_course_module() {
1244         if ($this->coursemodule) {
1245             return $this->coursemodule;
1246         }
1247         if (!$this->context) {
1248             return null;
1249         }
1251         if ($this->context->contextlevel == CONTEXT_MODULE) {
1252             $modinfo = get_fast_modinfo($this->get_course());
1253             $this->coursemodule = $modinfo->get_cm($this->context->instanceid);
1254             return $this->coursemodule;
1255         }
1256         return null;
1257     }
1259     /**
1260      * Get context module.
1261      *
1262      * @return context
1263      */
1264     public function get_context() {
1265         return $this->context;
1266     }
1268     /**
1269      * Get the current course.
1270      *
1271      * @return mixed stdClass|null The course
1272      */
1273     public function get_course() {
1274         global $DB;
1276         if ($this->course) {
1277             return $this->course;
1278         }
1280         if (!$this->context) {
1281             return null;
1282         }
1283         $params = array('id' => $this->get_course_context()->instanceid);
1284         $this->course = $DB->get_record('course', $params, '*', MUST_EXIST);
1286         return $this->course;
1287     }
1289     /**
1290      * Count the number of intro attachments.
1291      *
1292      * @return int
1293      */
1294     protected function count_attachments() {
1296         $fs = get_file_storage();
1297         $files = $fs->get_area_files($this->get_context()->id, 'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA,
1298                         0, 'id', false);
1300         return count($files);
1301     }
1303     /**
1304      * Are there any intro attachments to display?
1305      *
1306      * @return boolean
1307      */
1308     protected function has_visible_attachments() {
1309         return ($this->count_attachments() > 0);
1310     }
1312     /**
1313      * Return a grade in user-friendly form, whether it's a scale or not.
1314      *
1315      * @param mixed $grade int|null
1316      * @param boolean $editing Are we allowing changes to this grade?
1317      * @param int $userid The user id the grade belongs to
1318      * @param int $modified Timestamp from when the grade was last modified
1319      * @return string User-friendly representation of grade
1320      */
1321     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1322         global $DB;
1324         static $scalegrades = array();
1326         $o = '';
1328         if ($this->get_instance()->grade >= 0) {
1329             // Normal number.
1330             if ($editing && $this->get_instance()->grade > 0) {
1331                 if ($grade < 0) {
1332                     $displaygrade = '';
1333                 } else {
1334                     $displaygrade = format_float($grade, 2);
1335                 }
1336                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' .
1337                        get_string('usergrade', 'assign') .
1338                        '</label>';
1339                 $o .= '<input type="text"
1340                               id="quickgrade_' . $userid . '"
1341                               name="quickgrade_' . $userid . '"
1342                               value="' .  $displaygrade . '"
1343                               size="6"
1344                               maxlength="10"
1345                               class="quickgrade"/>';
1346                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, 2);
1347                 return $o;
1348             } else {
1349                 if ($grade == -1 || $grade === null) {
1350                     $o .= '-';
1351                 } else {
1352                     $item = $this->get_grade_item();
1353                     $o .= grade_format_gradevalue($grade, $item);
1354                     if ($item->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) {
1355                         // If displaying the raw grade, also display the total value.
1356                         $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, 2);
1357                     }
1358                 }
1359                 return $o;
1360             }
1362         } else {
1363             // Scale.
1364             if (empty($this->cache['scale'])) {
1365                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1366                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1367                 } else {
1368                     $o .= '-';
1369                     return $o;
1370                 }
1371             }
1372             if ($editing) {
1373                 $o .= '<label class="accesshide"
1374                               for="quickgrade_' . $userid . '">' .
1375                       get_string('usergrade', 'assign') .
1376                       '</label>';
1377                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1378                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1379                 foreach ($this->cache['scale'] as $optionid => $option) {
1380                     $selected = '';
1381                     if ($grade == $optionid) {
1382                         $selected = 'selected="selected"';
1383                     }
1384                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1385                 }
1386                 $o .= '</select>';
1387                 return $o;
1388             } else {
1389                 $scaleid = (int)$grade;
1390                 if (isset($this->cache['scale'][$scaleid])) {
1391                     $o .= $this->cache['scale'][$scaleid];
1392                     return $o;
1393                 }
1394                 $o .= '-';
1395                 return $o;
1396             }
1397         }
1398     }
1400     /**
1401      * Load a list of users enrolled in the current course with the specified permission and group.
1402      * 0 for no group.
1403      *
1404      * @param int $currentgroup
1405      * @param bool $idsonly
1406      * @return array List of user records
1407      */
1408     public function list_participants($currentgroup, $idsonly) {
1410         if (empty($currentgroup)) {
1411             $currentgroup = 0;
1412         }
1414         $key = $this->context->id . '-' . $currentgroup . '-' . $this->show_only_active_users();
1415         if (!isset($this->participants[$key])) {
1416             $users = get_enrolled_users($this->context, 'mod/assign:submit', $currentgroup, 'u.*', null, null, null,
1417                     $this->show_only_active_users());
1419             $cm = $this->get_course_module();
1420             $info = new \core_availability\info_module($cm);
1421             $users = $info->filter_user_list($users);
1423             $this->participants[$key] = $users;
1424         }
1426         if ($idsonly) {
1427             $idslist = array();
1428             foreach ($this->participants[$key] as $id => $user) {
1429                 $idslist[$id] = new stdClass();
1430                 $idslist[$id]->id = $id;
1431             }
1432             return $idslist;
1433         }
1434         return $this->participants[$key];
1435     }
1437     /**
1438      * Load a count of valid teams for this assignment.
1439      *
1440      * @param int $activitygroup Activity active group
1441      * @return int number of valid teams
1442      */
1443     public function count_teams($activitygroup = 0) {
1445         $count = 0;
1447         $participants = $this->list_participants($activitygroup, true);
1449         // If a team submission grouping id is provided all good as all returned groups
1450         // are the submission teams, but if no team submission grouping was specified
1451         // $groups will contain all participants groups.
1452         if ($this->get_instance()->teamsubmissiongroupingid) {
1454             // We restrict the users to the selected group ones.
1455             $groups = groups_get_all_groups($this->get_course()->id,
1456                                             array_keys($participants),
1457                                             $this->get_instance()->teamsubmissiongroupingid,
1458                                             'DISTINCT g.id, g.name');
1460             $count = count($groups);
1462             // When a specific group is selected we don't count the default group users.
1463             if ($activitygroup == 0) {
1464                 if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1465                     // See if there are any users in the default group.
1466                     $defaultusers = $this->get_submission_group_members(0, true);
1467                     if (count($defaultusers) > 0) {
1468                         $count += 1;
1469                     }
1470                 }
1471             }
1472         } else {
1473             // It is faster to loop around participants if no grouping was specified.
1474             $groups = array();
1475             foreach ($participants as $participant) {
1476                 if ($group = $this->get_submission_group($participant->id)) {
1477                     $groups[$group->id] = true;
1478                 } else if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1479                     $groups[0] = true;
1480                 }
1481             }
1483             $count = count($groups);
1484         }
1486         return $count;
1487     }
1489     /**
1490      * Load a count of active users enrolled in the current course with the specified permission and group.
1491      * 0 for no group.
1492      *
1493      * @param int $currentgroup
1494      * @return int number of matching users
1495      */
1496     public function count_participants($currentgroup) {
1497         return count($this->list_participants($currentgroup, true));
1498     }
1500     /**
1501      * Load a count of active users submissions in the current module that require grading
1502      * This means the submission modification time is more recent than the
1503      * grading modification time and the status is SUBMITTED.
1504      *
1505      * @return int number of matching submissions
1506      */
1507     public function count_submissions_need_grading() {
1508         global $DB;
1510         if ($this->get_instance()->teamsubmission) {
1511             // This does not make sense for group assignment because the submission is shared.
1512             return 0;
1513         }
1515         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1516         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1518         $params['assignid'] = $this->get_instance()->id;
1519         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1521         $sql = 'SELECT COUNT(s.userid)
1522                    FROM {assign_submission} s
1523                    LEFT JOIN {assign_grades} g ON
1524                         s.assignment = g.assignment AND
1525                         s.userid = g.userid AND
1526                         g.attemptnumber = s.attemptnumber
1527                    JOIN(' . $esql . ') e ON e.id = s.userid
1528                    WHERE
1529                         s.latest = 1 AND
1530                         s.assignment = :assignid AND
1531                         s.timemodified IS NOT NULL AND
1532                         s.status = :submitted AND
1533                         (s.timemodified >= g.timemodified OR g.timemodified IS NULL OR g.grade IS NULL)';
1535         return $DB->count_records_sql($sql, $params);
1536     }
1538     /**
1539      * Load a count of grades.
1540      *
1541      * @return int number of grades
1542      */
1543     public function count_grades() {
1544         global $DB;
1546         if (!$this->has_instance()) {
1547             return 0;
1548         }
1550         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1551         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1553         $params['assignid'] = $this->get_instance()->id;
1555         $sql = 'SELECT COUNT(g.userid)
1556                    FROM {assign_grades} g
1557                    JOIN(' . $esql . ') e ON e.id = g.userid
1558                    WHERE g.assignment = :assignid';
1560         return $DB->count_records_sql($sql, $params);
1561     }
1563     /**
1564      * Load a count of submissions.
1565      *
1566      * @param bool $includenew When true, also counts the submissions with status 'new'.
1567      * @return int number of submissions
1568      */
1569     public function count_submissions($includenew = false) {
1570         global $DB;
1572         if (!$this->has_instance()) {
1573             return 0;
1574         }
1576         $params = array();
1577         $sqlnew = '';
1579         if (!$includenew) {
1580             $sqlnew = ' AND s.status <> :status ';
1581             $params['status'] = ASSIGN_SUBMISSION_STATUS_NEW;
1582         }
1584         if ($this->get_instance()->teamsubmission) {
1585             // We cannot join on the enrolment tables for group submissions (no userid).
1586             $sql = 'SELECT COUNT(DISTINCT s.groupid)
1587                         FROM {assign_submission} s
1588                         WHERE
1589                             s.assignment = :assignid AND
1590                             s.timemodified IS NOT NULL AND
1591                             s.userid = :groupuserid' .
1592                             $sqlnew;
1594             $params['assignid'] = $this->get_instance()->id;
1595             $params['groupuserid'] = 0;
1596         } else {
1597             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1598             list($esql, $enrolparams) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1600             $params = array_merge($params, $enrolparams);
1601             $params['assignid'] = $this->get_instance()->id;
1603             $sql = 'SELECT COUNT(DISTINCT s.userid)
1604                        FROM {assign_submission} s
1605                        JOIN(' . $esql . ') e ON e.id = s.userid
1606                        WHERE
1607                             s.assignment = :assignid AND
1608                             s.timemodified IS NOT NULL ' .
1609                             $sqlnew;
1611         }
1613         return $DB->count_records_sql($sql, $params);
1614     }
1616     /**
1617      * Load a count of submissions with a specified status.
1618      *
1619      * @param string $status The submission status - should match one of the constants
1620      * @return int number of matching submissions
1621      */
1622     public function count_submissions_with_status($status) {
1623         global $DB;
1625         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1626         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1628         $params['assignid'] = $this->get_instance()->id;
1629         $params['assignid2'] = $this->get_instance()->id;
1630         $params['submissionstatus'] = $status;
1632         if ($this->get_instance()->teamsubmission) {
1634             $groupsstr = '';
1635             if ($currentgroup != 0) {
1636                 // If there is an active group we should only display the current group users groups.
1637                 $participants = $this->list_participants($currentgroup, true);
1638                 $groups = groups_get_all_groups($this->get_course()->id,
1639                                                 array_keys($participants),
1640                                                 $this->get_instance()->teamsubmissiongroupingid,
1641                                                 'DISTINCT g.id, g.name');
1642                 list($groupssql, $groupsparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
1643                 $groupsstr = 's.groupid ' . $groupssql . ' AND';
1644                 $params = $params + $groupsparams;
1645             }
1646             $sql = 'SELECT COUNT(s.groupid)
1647                         FROM {assign_submission} s
1648                         WHERE
1649                             s.latest = 1 AND
1650                             s.assignment = :assignid AND
1651                             s.timemodified IS NOT NULL AND
1652                             s.userid = :groupuserid AND '
1653                             . $groupsstr . '
1654                             s.status = :submissionstatus';
1655             $params['groupuserid'] = 0;
1656         } else {
1657             $sql = 'SELECT COUNT(s.userid)
1658                         FROM {assign_submission} s
1659                         JOIN(' . $esql . ') e ON e.id = s.userid
1660                         WHERE
1661                             s.latest = 1 AND
1662                             s.assignment = :assignid AND
1663                             s.timemodified IS NOT NULL AND
1664                             s.status = :submissionstatus';
1666         }
1668         return $DB->count_records_sql($sql, $params);
1669     }
1671     /**
1672      * Utility function to get the userid for every row in the grading table
1673      * so the order can be frozen while we iterate it.
1674      *
1675      * @return array An array of userids
1676      */
1677     protected function get_grading_userid_list() {
1678         $filter = get_user_preferences('assign_filter', '');
1679         $table = new assign_grading_table($this, 0, $filter, 0, false);
1681         $useridlist = $table->get_column_data('userid');
1683         return $useridlist;
1684     }
1686     /**
1687      * Generate zip file from array of given files.
1688      *
1689      * @param array $filesforzipping - array of files to pass into archive_to_pathname.
1690      *                                 This array is indexed by the final file name and each
1691      *                                 element in the array is an instance of a stored_file object.
1692      * @return path of temp file - note this returned file does
1693      *         not have a .zip extension - it is a temp file.
1694      */
1695     protected function pack_files($filesforzipping) {
1696         global $CFG;
1697         // Create path for new zip file.
1698         $tempzip = tempnam($CFG->tempdir . '/', 'assignment_');
1699         // Zip files.
1700         $zipper = new zip_packer();
1701         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
1702             return $tempzip;
1703         }
1704         return false;
1705     }
1707     /**
1708      * Finds all assignment notifications that have yet to be mailed out, and mails them.
1709      *
1710      * Cron function to be run periodically according to the moodle cron.
1711      *
1712      * @return bool
1713      */
1714     public static function cron() {
1715         global $DB;
1717         // Only ever send a max of one days worth of updates.
1718         $yesterday = time() - (24 * 3600);
1719         $timenow   = time();
1720         $lastcron = $DB->get_field('modules', 'lastcron', array('name' => 'assign'));
1722         // Collect all submissions that require mailing.
1723         // Submissions are included if all are true:
1724         //   - The assignment is visible in the gradebook.
1725         //   - No previous notification has been sent.
1726         //   - If marking workflow is not enabled, the grade was updated in the past 24 hours, or
1727         //     if marking workflow is enabled, the workflow state is at 'released'.
1728         $sql = "SELECT g.id as gradeid, a.course, a.name, a.blindmarking, a.revealidentities,
1729                        g.*, g.timemodified as lastmodified, cm.id as cmid
1730                  FROM {assign} a
1731                  JOIN {assign_grades} g ON g.assignment = a.id
1732             LEFT JOIN {assign_user_flags} uf ON uf.assignment = a.id AND uf.userid = g.userid
1733                  JOIN {course_modules} cm ON cm.course = a.course AND cm.instance = a.id
1734                  JOIN {modules} md ON md.id = cm.module AND md.name = 'assign'
1735                  JOIN {grade_items} gri ON gri.iteminstance = a.id AND gri.courseid = a.course AND gri.itemmodule = md.name
1736                  WHERE ((a.markingworkflow = 0 AND g.timemodified >= :yesterday AND g.timemodified <= :today) OR
1737                         (a.markingworkflow = 1 AND uf.workflowstate = :wfreleased)) AND
1738                        uf.mailed = 0 AND gri.hidden = 0
1739               ORDER BY a.course, cm.id";
1741         $params = array(
1742             'yesterday' => $yesterday,
1743             'today' => $timenow,
1744             'wfreleased' => ASSIGN_MARKING_WORKFLOW_STATE_RELEASED,
1745         );
1746         $submissions = $DB->get_records_sql($sql, $params);
1748         if (!empty($submissions)) {
1750             mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
1752             // Preload courses we are going to need those.
1753             $courseids = array();
1754             foreach ($submissions as $submission) {
1755                 $courseids[] = $submission->course;
1756             }
1758             // Filter out duplicates.
1759             $courseids = array_unique($courseids);
1760             $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
1761             list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
1762             $sql = 'SELECT c.*, ' . $ctxselect .
1763                       ' FROM {course} c
1764                  LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
1765                      WHERE c.id ' . $courseidsql;
1767             $params['contextlevel'] = CONTEXT_COURSE;
1768             $courses = $DB->get_records_sql($sql, $params);
1770             // Clean up... this could go on for a while.
1771             unset($courseids);
1772             unset($ctxselect);
1773             unset($courseidsql);
1774             unset($params);
1776             // Message students about new feedback.
1777             foreach ($submissions as $submission) {
1779                 mtrace("Processing assignment submission $submission->id ...");
1781                 // Do not cache user lookups - could be too many.
1782                 if (!$user = $DB->get_record('user', array('id'=>$submission->userid))) {
1783                     mtrace('Could not find user ' . $submission->userid);
1784                     continue;
1785                 }
1787                 // Use a cache to prevent the same DB queries happening over and over.
1788                 if (!array_key_exists($submission->course, $courses)) {
1789                     mtrace('Could not find course ' . $submission->course);
1790                     continue;
1791                 }
1792                 $course = $courses[$submission->course];
1793                 if (isset($course->ctxid)) {
1794                     // Context has not yet been preloaded. Do so now.
1795                     context_helper::preload_from_record($course);
1796                 }
1798                 // Override the language and timezone of the "current" user, so that
1799                 // mail is customised for the receiver.
1800                 cron_setup_user($user, $course);
1802                 // Context lookups are already cached.
1803                 $coursecontext = context_course::instance($course->id);
1804                 if (!is_enrolled($coursecontext, $user->id)) {
1805                     $courseshortname = format_string($course->shortname,
1806                                                      true,
1807                                                      array('context' => $coursecontext));
1808                     mtrace(fullname($user) . ' not an active participant in ' . $courseshortname);
1809                     continue;
1810                 }
1812                 if (!$grader = $DB->get_record('user', array('id'=>$submission->grader))) {
1813                     mtrace('Could not find grader ' . $submission->grader);
1814                     continue;
1815                 }
1817                 $modinfo = get_fast_modinfo($course, $user->id);
1818                 $cm = $modinfo->get_cm($submission->cmid);
1819                 // Context lookups are already cached.
1820                 $contextmodule = context_module::instance($cm->id);
1822                 if (!$cm->uservisible) {
1823                     // Hold mail notification for assignments the user cannot access until later.
1824                     continue;
1825                 }
1827                 // Need to send this to the student.
1828                 $messagetype = 'feedbackavailable';
1829                 $eventtype = 'assign_notification';
1830                 $updatetime = $submission->lastmodified;
1831                 $modulename = get_string('modulename', 'assign');
1833                 $uniqueid = 0;
1834                 if ($submission->blindmarking && !$submission->revealidentities) {
1835                     $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $user->id);
1836                 }
1837                 $showusers = $submission->blindmarking && !$submission->revealidentities;
1838                 self::send_assignment_notification($grader,
1839                                                    $user,
1840                                                    $messagetype,
1841                                                    $eventtype,
1842                                                    $updatetime,
1843                                                    $cm,
1844                                                    $contextmodule,
1845                                                    $course,
1846                                                    $modulename,
1847                                                    $submission->name,
1848                                                    $showusers,
1849                                                    $uniqueid);
1851                 $flags = $DB->get_record('assign_user_flags', array('userid'=>$user->id, 'assignment'=>$submission->assignment));
1852                 if ($flags) {
1853                     $flags->mailed = 1;
1854                     $DB->update_record('assign_user_flags', $flags);
1855                 } else {
1856                     $flags = new stdClass();
1857                     $flags->userid = $user->id;
1858                     $flags->assignment = $submission->assignment;
1859                     $flags->mailed = 1;
1860                     $DB->insert_record('assign_user_flags', $flags);
1861                 }
1863                 mtrace('Done');
1864             }
1865             mtrace('Done processing ' . count($submissions) . ' assignment submissions');
1867             cron_setup_user();
1869             // Free up memory just to be sure.
1870             unset($courses);
1871         }
1873         // Update calendar events to provide a description.
1874         $sql = 'SELECT id
1875                     FROM {assign}
1876                     WHERE
1877                         allowsubmissionsfromdate >= :lastcron AND
1878                         allowsubmissionsfromdate <= :timenow AND
1879                         alwaysshowdescription = 0';
1880         $params = array('lastcron' => $lastcron, 'timenow' => $timenow);
1881         $newlyavailable = $DB->get_records_sql($sql, $params);
1882         foreach ($newlyavailable as $record) {
1883             $cm = get_coursemodule_from_instance('assign', $record->id, 0, false, MUST_EXIST);
1884             $context = context_module::instance($cm->id);
1886             $assignment = new assign($context, null, null);
1887             $assignment->update_calendar($cm->id);
1888         }
1890         return true;
1891     }
1893     /**
1894      * Mark in the database that this grade record should have an update notification sent by cron.
1895      *
1896      * @param stdClass $grade a grade record keyed on id
1897      * @param bool $mailedoverride when true, flag notification to be sent again.
1898      * @return bool true for success
1899      */
1900     public function notify_grade_modified($grade, $mailedoverride = false) {
1901         global $DB;
1903         $flags = $this->get_user_flags($grade->userid, true);
1904         if ($flags->mailed != 1 || $mailedoverride) {
1905             $flags->mailed = 0;
1906         }
1908         return $this->update_user_flags($flags);
1909     }
1911     /**
1912      * Update user flags for this user in this assignment.
1913      *
1914      * @param stdClass $flags a flags record keyed on id
1915      * @return bool true for success
1916      */
1917     public function update_user_flags($flags) {
1918         global $DB;
1919         if ($flags->userid <= 0 || $flags->assignment <= 0 || $flags->id <= 0) {
1920             return false;
1921         }
1923         $result = $DB->update_record('assign_user_flags', $flags);
1924         return $result;
1925     }
1927     /**
1928      * Update a grade in the grade table for the assignment and in the gradebook.
1929      *
1930      * @param stdClass $grade a grade record keyed on id
1931      * @param bool $reopenattempt If the attempt reopen method is manual, allow another attempt at this assignment.
1932      * @return bool true for success
1933      */
1934     public function update_grade($grade, $reopenattempt = false) {
1935         global $DB;
1937         $grade->timemodified = time();
1939         if (!empty($grade->workflowstate)) {
1940             $validstates = $this->get_marking_workflow_states_for_current_user();
1941             if (!array_key_exists($grade->workflowstate, $validstates)) {
1942                 return false;
1943             }
1944         }
1946         if ($grade->grade && $grade->grade != -1) {
1947             if ($this->get_instance()->grade > 0) {
1948                 if (!is_numeric($grade->grade)) {
1949                     return false;
1950                 } else if ($grade->grade > $this->get_instance()->grade) {
1951                     return false;
1952                 } else if ($grade->grade < 0) {
1953                     return false;
1954                 }
1955             } else {
1956                 // This is a scale.
1957                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
1958                     $scaleoptions = make_menu_from_list($scale->scale);
1959                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
1960                         return false;
1961                     }
1962                 }
1963             }
1964         }
1966         if (empty($grade->attemptnumber)) {
1967             // Set it to the default.
1968             $grade->attemptnumber = 0;
1969         }
1970         $DB->update_record('assign_grades', $grade);
1972         $submission = null;
1973         if ($this->get_instance()->teamsubmission) {
1974             $submission = $this->get_group_submission($grade->userid, 0, false);
1975         } else {
1976             $submission = $this->get_user_submission($grade->userid, false);
1977         }
1979         // Only push to gradebook if the update is for the latest attempt.
1980         // Not the latest attempt.
1981         if ($submission && $submission->attemptnumber != $grade->attemptnumber) {
1982             return true;
1983         }
1985         if ($this->gradebook_item_update(null, $grade)) {
1986             \mod_assign\event\submission_graded::create_from_grade($this, $grade)->trigger();
1987         }
1989         // If the conditions are met, allow another attempt.
1990         if ($submission) {
1991             $this->reopen_submission_if_required($grade->userid,
1992                     $submission,
1993                     $reopenattempt);
1994         }
1996         return true;
1997     }
1999     /**
2000      * View the grant extension date page.
2001      *
2002      * Uses url parameters 'userid'
2003      * or from parameter 'selectedusers'
2004      *
2005      * @param moodleform $mform - Used for validation of the submitted data
2006      * @return string
2007      */
2008     protected function view_grant_extension($mform) {
2009         global $DB, $CFG;
2010         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
2012         $o = '';
2013         $batchusers = optional_param('selectedusers', '', PARAM_SEQUENCE);
2014         $data = new stdClass();
2015         $data->extensionduedate = null;
2016         $userid = 0;
2017         if (!$batchusers) {
2018             $userid = required_param('userid', PARAM_INT);
2020             $flags = $this->get_user_flags($userid, false);
2022             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
2024             if ($flags) {
2025                 $data->extensionduedate = $flags->extensionduedate;
2026             }
2027             $data->userid = $userid;
2028         } else {
2029             $data->batchusers = $batchusers;
2030         }
2031         $header = new assign_header($this->get_instance(),
2032                                     $this->get_context(),
2033                                     $this->show_intro(),
2034                                     $this->get_course_module()->id,
2035                                     get_string('grantextension', 'assign'));
2036         $o .= $this->get_renderer()->render($header);
2038         if (!$mform) {
2039             $formparams = array($this->get_course_module()->id,
2040                                 $userid,
2041                                 $batchusers,
2042                                 $this->get_instance(),
2043                                 $data);
2044             $mform = new mod_assign_extension_form(null, $formparams);
2045         }
2046         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
2047         $o .= $this->view_footer();
2048         return $o;
2049     }
2051     /**
2052      * Get a list of the users in the same group as this user.
2053      *
2054      * @param int $groupid The id of the group whose members we want or 0 for the default group
2055      * @param bool $onlyids Whether to retrieve only the user id's
2056      * @param bool $excludesuspended Whether to exclude suspended users
2057      * @return array The users (possibly id's only)
2058      */
2059     public function get_submission_group_members($groupid, $onlyids, $excludesuspended = false) {
2060         $members = array();
2061         if ($groupid != 0) {
2062             if ($onlyids) {
2063                 $allusers = groups_get_members($groupid, 'u.id');
2064             } else {
2065                 $allusers = groups_get_members($groupid);
2066             }
2067             foreach ($allusers as $user) {
2068                 if ($this->get_submission_group($user->id)) {
2069                     $members[] = $user;
2070                 }
2071             }
2072         } else {
2073             $allusers = $this->list_participants(null, $onlyids);
2074             foreach ($allusers as $user) {
2075                 if ($this->get_submission_group($user->id) == null) {
2076                     $members[] = $user;
2077                 }
2078             }
2079         }
2080         // Exclude suspended users, if user can't see them.
2081         if ($excludesuspended || !has_capability('moodle/course:viewsuspendedusers', $this->context)) {
2082             foreach ($members as $key => $member) {
2083                 if (!$this->is_active_user($member->id)) {
2084                     unset($members[$key]);
2085                 }
2086             }
2087         }
2089         return $members;
2090     }
2092     /**
2093      * Get a list of the users in the same group as this user that have not submitted the assignment.
2094      *
2095      * @param int $groupid The id of the group whose members we want or 0 for the default group
2096      * @param bool $onlyids Whether to retrieve only the user id's
2097      * @return array The users (possibly id's only)
2098      */
2099     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
2100         $instance = $this->get_instance();
2101         if (!$instance->teamsubmission || !$instance->requireallteammemberssubmit) {
2102             return array();
2103         }
2104         $members = $this->get_submission_group_members($groupid, $onlyids);
2106         foreach ($members as $id => $member) {
2107             $submission = $this->get_user_submission($member->id, false);
2108             if ($submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2109                 unset($members[$id]);
2110             } else {
2111                 if ($this->is_blind_marking()) {
2112                     $members[$id]->alias = get_string('hiddenuser', 'assign') .
2113                                            $this->get_uniqueid_for_user($id);
2114                 }
2115             }
2116         }
2117         return $members;
2118     }
2120     /**
2121      * Load the group submission object for a particular user, optionally creating it if required.
2122      *
2123      * @param int $userid The id of the user whose submission we want
2124      * @param int $groupid The id of the group for this user - may be 0 in which
2125      *                     case it is determined from the userid.
2126      * @param bool $create If set to true a new submission object will be created in the database
2127      *                     with the status set to "new".
2128      * @param int $attemptnumber - -1 means the latest attempt
2129      * @return stdClass The submission
2130      */
2131     public function get_group_submission($userid, $groupid, $create, $attemptnumber=-1) {
2132         global $DB;
2134         if ($groupid == 0) {
2135             $group = $this->get_submission_group($userid);
2136             if ($group) {
2137                 $groupid = $group->id;
2138             }
2139         }
2141         // Now get the group submission.
2142         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2143         if ($attemptnumber >= 0) {
2144             $params['attemptnumber'] = $attemptnumber;
2145         }
2147         // Only return the row with the highest attemptnumber.
2148         $submission = null;
2149         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2150         if ($submissions) {
2151             $submission = reset($submissions);
2152         }
2154         if ($submission) {
2155             return $submission;
2156         }
2157         if ($create) {
2158             $submission = new stdClass();
2159             $submission->assignment = $this->get_instance()->id;
2160             $submission->userid = 0;
2161             $submission->groupid = $groupid;
2162             $submission->timecreated = time();
2163             $submission->timemodified = $submission->timecreated;
2164             if ($attemptnumber >= 0) {
2165                 $submission->attemptnumber = $attemptnumber;
2166             } else {
2167                 $submission->attemptnumber = 0;
2168             }
2169             // Work out if this is the latest submission.
2170             $submission->latest = 0;
2171             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2172             if ($attemptnumber == -1) {
2173                 // This is a new submission so it must be the latest.
2174                 $submission->latest = 1;
2175             } else {
2176                 // We need to work this out.
2177                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2178                 if ($result) {
2179                     $latestsubmission = reset($result);
2180                 }
2181                 if (!$latestsubmission || ($attemptnumber == $latestsubmission->attemptnumber)) {
2182                     $submission->latest = 1;
2183                 }
2184             }
2185             if ($submission->latest) {
2186                 // This is the case when we need to set latest to 0 for all the other attempts.
2187                 $DB->set_field('assign_submission', 'latest', 0, $params);
2188             }
2189             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2190             $sid = $DB->insert_record('assign_submission', $submission);
2191             return $DB->get_record('assign_submission', array('id' => $sid));
2192         }
2193         return false;
2194     }
2196     /**
2197      * View a summary listing of all assignments in the current course.
2198      *
2199      * @return string
2200      */
2201     private function view_course_index() {
2202         global $USER;
2204         $o = '';
2206         $course = $this->get_course();
2207         $strplural = get_string('modulenameplural', 'assign');
2209         if (!$cms = get_coursemodules_in_course('assign', $course->id, 'm.duedate')) {
2210             $o .= $this->get_renderer()->notification(get_string('thereareno', 'moodle', $strplural));
2211             $o .= $this->get_renderer()->continue_button(new moodle_url('/course/view.php', array('id' => $course->id)));
2212             return $o;
2213         }
2215         $strsectionname = '';
2216         $usesections = course_format_uses_sections($course->format);
2217         $modinfo = get_fast_modinfo($course);
2219         if ($usesections) {
2220             $strsectionname = get_string('sectionname', 'format_'.$course->format);
2221             $sections = $modinfo->get_section_info_all();
2222         }
2223         $courseindexsummary = new assign_course_index_summary($usesections, $strsectionname);
2225         $timenow = time();
2227         $currentsection = '';
2228         foreach ($modinfo->instances['assign'] as $cm) {
2229             if (!$cm->uservisible) {
2230                 continue;
2231             }
2233             $timedue = $cms[$cm->id]->duedate;
2235             $sectionname = '';
2236             if ($usesections && $cm->sectionnum) {
2237                 $sectionname = get_section_name($course, $sections[$cm->sectionnum]);
2238             }
2240             $submitted = '';
2241             $context = context_module::instance($cm->id);
2243             $assignment = new assign($context, $cm, $course);
2245             if (has_capability('mod/assign:grade', $context)) {
2246                 $submitted = $assignment->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED);
2248             } else if (has_capability('mod/assign:submit', $context)) {
2249                 $usersubmission = $assignment->get_user_submission($USER->id, false);
2251                 if (!empty($usersubmission->status)) {
2252                     $submitted = get_string('submissionstatus_' . $usersubmission->status, 'assign');
2253                 } else {
2254                     $submitted = get_string('submissionstatus_', 'assign');
2255                 }
2256             }
2257             $gradinginfo = grade_get_grades($course->id, 'mod', 'assign', $cm->instance, $USER->id);
2258             if (isset($gradinginfo->items[0]->grades[$USER->id]) &&
2259                     !$gradinginfo->items[0]->grades[$USER->id]->hidden ) {
2260                 $grade = $gradinginfo->items[0]->grades[$USER->id]->str_grade;
2261             } else {
2262                 $grade = '-';
2263             }
2265             $courseindexsummary->add_assign_info($cm->id, $cm->name, $sectionname, $timedue, $submitted, $grade);
2267         }
2269         $o .= $this->get_renderer()->render($courseindexsummary);
2270         $o .= $this->view_footer();
2272         return $o;
2273     }
2275     /**
2276      * View a page rendered by a plugin.
2277      *
2278      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.
2279      *
2280      * @return string
2281      */
2282     protected function view_plugin_page() {
2283         global $USER;
2285         $o = '';
2287         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
2288         $plugintype = required_param('plugin', PARAM_TEXT);
2289         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
2291         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
2292         if (!$plugin) {
2293             print_error('invalidformdata', '');
2294             return;
2295         }
2297         $o .= $plugin->view_page($pluginaction);
2299         return $o;
2300     }
2303     /**
2304      * This is used for team assignments to get the group for the specified user.
2305      * If the user is a member of multiple or no groups this will return false
2306      *
2307      * @param int $userid The id of the user whose submission we want
2308      * @return mixed The group or false
2309      */
2310     public function get_submission_group($userid) {
2312         if (isset($this->usersubmissiongroups[$userid])) {
2313             return $this->usersubmissiongroups[$userid];
2314         }
2316         $groups = $this->get_all_groups($userid);
2317         if (count($groups) != 1) {
2318             $return = false;
2319         } else {
2320             $return = array_pop($groups);
2321         }
2323         // Cache the user submission group.
2324         $this->usersubmissiongroups[$userid] = $return;
2326         return $return;
2327     }
2329     /**
2330      * Gets all groups the user is a member of.
2331      *
2332      * @param int $userid Teh id of the user who's groups we are checking
2333      * @return array The group objects
2334      */
2335     public function get_all_groups($userid) {
2336         if (isset($this->usergroups[$userid])) {
2337             return $this->usergroups[$userid];
2338         }
2340         $grouping = $this->get_instance()->teamsubmissiongroupingid;
2341         $return = groups_get_all_groups($this->get_course()->id, $userid, $grouping);
2343         $this->usergroups[$userid] = $return;
2345         return $return;
2346     }
2349     /**
2350      * Display the submission that is used by a plugin.
2351      *
2352      * Uses url parameters 'sid', 'gid' and 'plugin'.
2353      *
2354      * @param string $pluginsubtype
2355      * @return string
2356      */
2357     protected function view_plugin_content($pluginsubtype) {
2358         $o = '';
2360         $submissionid = optional_param('sid', 0, PARAM_INT);
2361         $gradeid = optional_param('gid', 0, PARAM_INT);
2362         $plugintype = required_param('plugin', PARAM_TEXT);
2363         $item = null;
2364         if ($pluginsubtype == 'assignsubmission') {
2365             $plugin = $this->get_submission_plugin_by_type($plugintype);
2366             if ($submissionid <= 0) {
2367                 throw new coding_exception('Submission id should not be 0');
2368             }
2369             $item = $this->get_submission($submissionid);
2371             // Check permissions.
2372             $this->require_view_submission($item->userid);
2373             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2374                                                               $this->get_context(),
2375                                                               $this->show_intro(),
2376                                                               $this->get_course_module()->id,
2377                                                               $plugin->get_name()));
2378             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
2379                                                               $item,
2380                                                               assign_submission_plugin_submission::FULL,
2381                                                               $this->get_course_module()->id,
2382                                                               $this->get_return_action(),
2383                                                               $this->get_return_params()));
2385             // Trigger event for viewing a submission.
2386             \mod_assign\event\submission_viewed::create_from_submission($this, $item)->trigger();
2388         } else {
2389             $plugin = $this->get_feedback_plugin_by_type($plugintype);
2390             if ($gradeid <= 0) {
2391                 throw new coding_exception('Grade id should not be 0');
2392             }
2393             $item = $this->get_grade($gradeid);
2394             // Check permissions.
2395             $this->require_view_submission($item->userid);
2396             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2397                                                               $this->get_context(),
2398                                                               $this->show_intro(),
2399                                                               $this->get_course_module()->id,
2400                                                               $plugin->get_name()));
2401             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
2402                                                               $item,
2403                                                               assign_feedback_plugin_feedback::FULL,
2404                                                               $this->get_course_module()->id,
2405                                                               $this->get_return_action(),
2406                                                               $this->get_return_params()));
2408             // Trigger event for viewing feedback.
2409             \mod_assign\event\feedback_viewed::create_from_grade($this, $item)->trigger();
2410         }
2412         $o .= $this->view_return_links();
2414         $o .= $this->view_footer();
2416         return $o;
2417     }
2419     /**
2420      * Rewrite plugin file urls so they resolve correctly in an exported zip.
2421      *
2422      * @param string $text - The replacement text
2423      * @param stdClass $user - The user record
2424      * @param assign_plugin $plugin - The assignment plugin
2425      */
2426     public function download_rewrite_pluginfile_urls($text, $user, $plugin) {
2427         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2428         $groupname = '';
2429         if ($groupmode) {
2430             $groupid = groups_get_activity_group($this->get_course_module(), true);
2431             $groupname = groups_get_group_name($groupid).'-';
2432         }
2434         if ($this->is_blind_marking()) {
2435             $prefix = $groupname . get_string('participant', 'assign');
2436             $prefix = str_replace('_', ' ', $prefix);
2437             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2438         } else {
2439             $prefix = $groupname . fullname($user);
2440             $prefix = str_replace('_', ' ', $prefix);
2441             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2442         }
2444         $subtype = $plugin->get_subtype();
2445         $type = $plugin->get_type();
2446         $prefix = $prefix . $subtype . '_' . $type . '_';
2448         $result = str_replace('@@PLUGINFILE@@/', $prefix, $text);
2450         return $result;
2451     }
2453     /**
2454      * Render the content in editor that is often used by plugin.
2455      *
2456      * @param string $filearea
2457      * @param int  $submissionid
2458      * @param string $plugintype
2459      * @param string $editor
2460      * @param string $component
2461      * @return string
2462      */
2463     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
2464         global $CFG;
2466         $result = '';
2468         $plugin = $this->get_submission_plugin_by_type($plugintype);
2470         $text = $plugin->get_editor_text($editor, $submissionid);
2471         $format = $plugin->get_editor_format($editor, $submissionid);
2473         $finaltext = file_rewrite_pluginfile_urls($text,
2474                                                   'pluginfile.php',
2475                                                   $this->get_context()->id,
2476                                                   $component,
2477                                                   $filearea,
2478                                                   $submissionid);
2479         $params = array('overflowdiv' => true, 'context' => $this->get_context());
2480         $result .= format_text($finaltext, $format, $params);
2482         if ($CFG->enableportfolios && has_capability('mod/assign:exportownsubmission', $this->context)) {
2483             require_once($CFG->libdir . '/portfoliolib.php');
2485             $button = new portfolio_add_button();
2486             $portfolioparams = array('cmid' => $this->get_course_module()->id,
2487                                      'sid' => $submissionid,
2488                                      'plugin' => $plugintype,
2489                                      'editor' => $editor,
2490                                      'area'=>$filearea);
2491             $button->set_callback_options('assign_portfolio_caller', $portfolioparams, 'mod_assign');
2492             $fs = get_file_storage();
2494             if ($files = $fs->get_area_files($this->context->id,
2495                                              $component,
2496                                              $filearea,
2497                                              $submissionid,
2498                                              'timemodified',
2499                                              false)) {
2500                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
2501             } else {
2502                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
2503             }
2504             $result .= $button->to_html();
2505         }
2506         return $result;
2507     }
2509     /**
2510      * Display a continue page after grading.
2511      *
2512      * @param string $message - The message to display.
2513      * @return string
2514      */
2515     protected function view_savegrading_result($message) {
2516         $o = '';
2517         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2518                                                       $this->get_context(),
2519                                                       $this->show_intro(),
2520                                                       $this->get_course_module()->id,
2521                                                       get_string('savegradingresult', 'assign')));
2522         $gradingresult = new assign_gradingmessage(get_string('savegradingresult', 'assign'),
2523                                                    $message,
2524                                                    $this->get_course_module()->id);
2525         $o .= $this->get_renderer()->render($gradingresult);
2526         $o .= $this->view_footer();
2527         return $o;
2528     }
2529     /**
2530      * Display a continue page after quickgrading.
2531      *
2532      * @param string $message - The message to display.
2533      * @return string
2534      */
2535     protected function view_quickgrading_result($message) {
2536         $o = '';
2537         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2538                                                       $this->get_context(),
2539                                                       $this->show_intro(),
2540                                                       $this->get_course_module()->id,
2541                                                       get_string('quickgradingresult', 'assign')));
2542         $lastpage = optional_param('lastpage', null, PARAM_INT);
2543         $gradingresult = new assign_gradingmessage(get_string('quickgradingresult', 'assign'),
2544                                                    $message,
2545                                                    $this->get_course_module()->id,
2546                                                    false,
2547                                                    $lastpage);
2548         $o .= $this->get_renderer()->render($gradingresult);
2549         $o .= $this->view_footer();
2550         return $o;
2551     }
2553     /**
2554      * Display the page footer.
2555      *
2556      * @return string
2557      */
2558     protected function view_footer() {
2559         // When viewing the footer during PHPUNIT tests a set_state error is thrown.
2560         if (!PHPUNIT_TEST) {
2561             return $this->get_renderer()->render_footer();
2562         }
2564         return '';
2565     }
2567     /**
2568      * Throw an error if the permissions to view this users submission are missing.
2569      *
2570      * @throws required_capability_exception
2571      * @return none
2572      */
2573     public function require_view_submission($userid) {
2574         if (!$this->can_view_submission($userid)) {
2575             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
2576         }
2577     }
2579     /**
2580      * Throw an error if the permissions to view grades in this assignment are missing.
2581      *
2582      * @throws required_capability_exception
2583      * @return none
2584      */
2585     public function require_view_grades() {
2586         if (!$this->can_view_grades()) {
2587             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
2588         }
2589     }
2591     /**
2592      * Does this user have view grade or grade permission for this assignment?
2593      *
2594      * @return bool
2595      */
2596     public function can_view_grades() {
2597         // Permissions check.
2598         if (!has_any_capability(array('mod/assign:viewgrades', 'mod/assign:grade'), $this->context)) {
2599             return false;
2600         }
2602         return true;
2603     }
2605     /**
2606      * Does this user have grade permission for this assignment?
2607      *
2608      * @return bool
2609      */
2610     public function can_grade() {
2611         // Permissions check.
2612         if (!has_capability('mod/assign:grade', $this->context)) {
2613             return false;
2614         }
2616         return true;
2617     }
2619     /**
2620      * Download a zip file of all assignment submissions.
2621      *
2622      * @return string - If an error occurs, this will contain the error page.
2623      */
2624     protected function download_submissions() {
2625         global $CFG, $DB;
2627         // More efficient to load this here.
2628         require_once($CFG->libdir.'/filelib.php');
2630         // Increase the server timeout to handle the creation and sending of large zip files.
2631         core_php_time_limit::raise();
2633         $this->require_view_grades();
2635         // Load all users with submit.
2636         $students = get_enrolled_users($this->context, "mod/assign:submit", null, 'u.*', null, null, null,
2637                         $this->show_only_active_users());
2639         // Build a list of files to zip.
2640         $filesforzipping = array();
2641         $fs = get_file_storage();
2643         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2644         // All users.
2645         $groupid = 0;
2646         $groupname = '';
2647         if ($groupmode) {
2648             $groupid = groups_get_activity_group($this->get_course_module(), true);
2649             $groupname = groups_get_group_name($groupid).'-';
2650         }
2652         // Construct the zip file name.
2653         $filename = clean_filename($this->get_course()->shortname . '-' .
2654                                    $this->get_instance()->name . '-' .
2655                                    $groupname.$this->get_course_module()->id . '.zip');
2657         // Get all the files for each student.
2658         foreach ($students as $student) {
2659             $userid = $student->id;
2661             if ((groups_is_member($groupid, $userid) or !$groupmode or !$groupid)) {
2662                 // Get the plugins to add their own files to the zip.
2664                 $submissiongroup = false;
2665                 $groupname = '';
2666                 if ($this->get_instance()->teamsubmission) {
2667                     $submission = $this->get_group_submission($userid, 0, false);
2668                     $submissiongroup = $this->get_submission_group($userid);
2669                     if ($submissiongroup) {
2670                         $groupname = $submissiongroup->name . '-';
2671                     } else {
2672                         $groupname = get_string('defaultteam', 'assign') . '-';
2673                     }
2674                 } else {
2675                     $submission = $this->get_user_submission($userid, false);
2676                 }
2678                 if ($this->is_blind_marking()) {
2679                     $prefix = str_replace('_', ' ', $groupname . get_string('participant', 'assign'));
2680                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid) . '_');
2681                 } else {
2682                     $prefix = str_replace('_', ' ', $groupname . fullname($student));
2683                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid) . '_');
2684                 }
2686                 if ($submission) {
2687                     foreach ($this->submissionplugins as $plugin) {
2688                         if ($plugin->is_enabled() && $plugin->is_visible()) {
2689                             $pluginfiles = $plugin->get_files($submission, $student);
2690                             foreach ($pluginfiles as $zipfilename => $file) {
2691                                 $subtype = $plugin->get_subtype();
2692                                 $type = $plugin->get_type();
2693                                 $prefixedfilename = clean_filename($prefix .
2694                                                                    $subtype .
2695                                                                    '_' .
2696                                                                    $type .
2697                                                                    '_' .
2698                                                                    $zipfilename);
2699                                 $filesforzipping[$prefixedfilename] = $file;
2700                             }
2701                         }
2702                     }
2703                 }
2704             }
2705         }
2706         $result = '';
2707         if (count($filesforzipping) == 0) {
2708             $header = new assign_header($this->get_instance(),
2709                                         $this->get_context(),
2710                                         '',
2711                                         $this->get_course_module()->id,
2712                                         get_string('downloadall', 'assign'));
2713             $result .= $this->get_renderer()->render($header);
2714             $result .= $this->get_renderer()->notification(get_string('nosubmission', 'assign'));
2715             $url = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
2716                                                                     'action'=>'grading'));
2717             $result .= $this->get_renderer()->continue_button($url);
2718             $result .= $this->view_footer();
2719         } else if ($zipfile = $this->pack_files($filesforzipping)) {
2720             \mod_assign\event\all_submissions_downloaded::create_from_assign($this)->trigger();
2721             // Send file and delete after sending.
2722             send_temp_file($zipfile, $filename);
2723             // We will not get here - send_temp_file calls exit.
2724         }
2725         return $result;
2726     }
2728     /**
2729      * Util function to add a message to the log.
2730      *
2731      * @deprecated since 2.7 - Use new events system instead.
2732      *             (see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins).
2733      *
2734      * @param string $action The current action
2735      * @param string $info A detailed description of the change. But no more than 255 characters.
2736      * @param string $url The url to the assign module instance.
2737      * @param bool $return If true, returns the arguments, else adds to log. The purpose of this is to
2738      *                     retrieve the arguments to use them with the new event system (Event 2).
2739      * @return void|array
2740      */
2741     public function add_to_log($action = '', $info = '', $url='', $return = false) {
2742         global $USER;
2744         $fullurl = 'view.php?id=' . $this->get_course_module()->id;
2745         if ($url != '') {
2746             $fullurl .= '&' . $url;
2747         }
2749         $args = array(
2750             $this->get_course()->id,
2751             'assign',
2752             $action,
2753             $fullurl,
2754             $info,
2755             $this->get_course_module()->id
2756         );
2758         if ($return) {
2759             // We only need to call debugging when returning a value. This is because the call to
2760             // call_user_func_array('add_to_log', $args) will trigger a debugging message of it's own.
2761             debugging('The mod_assign add_to_log() function is now deprecated.', DEBUG_DEVELOPER);
2762             return $args;
2763         }
2764         call_user_func_array('add_to_log', $args);
2765     }
2767     /**
2768      * Lazy load the page renderer and expose the renderer to plugins.
2769      *
2770      * @return assign_renderer
2771      */
2772     public function get_renderer() {
2773         global $PAGE;
2774         if ($this->output) {
2775             return $this->output;
2776         }
2777         $this->output = $PAGE->get_renderer('mod_assign');
2778         return $this->output;
2779     }
2781     /**
2782      * Load the submission object for a particular user, optionally creating it if required.
2783      *
2784      * For team assignments there are 2 submissions - the student submission and the team submission
2785      * All files are associated with the team submission but the status of the students contribution is
2786      * recorded separately.
2787      *
2788      * @param int $userid The id of the user whose submission we want or 0 in which case USER->id is used
2789      * @param bool $create optional - defaults to false. If set to true a new submission object
2790      *                     will be created in the database with the status set to "new".
2791      * @param int $attemptnumber - -1 means the latest attempt
2792      * @return stdClass The submission
2793      */
2794     public function get_user_submission($userid, $create, $attemptnumber=-1) {
2795         global $DB, $USER;
2797         if (!$userid) {
2798             $userid = $USER->id;
2799         }
2800         // If the userid is not null then use userid.
2801         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
2802         if ($attemptnumber >= 0) {
2803             $params['attemptnumber'] = $attemptnumber;
2804         }
2806         // Only return the row with the highest attemptnumber.
2807         $submission = null;
2808         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2809         if ($submissions) {
2810             $submission = reset($submissions);
2811         }
2813         if ($submission) {
2814             return $submission;
2815         }
2816         if ($create) {
2817             $submission = new stdClass();
2818             $submission->assignment   = $this->get_instance()->id;
2819             $submission->userid       = $userid;
2820             $submission->timecreated = time();
2821             $submission->timemodified = $submission->timecreated;
2822             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2823             if ($attemptnumber >= 0) {
2824                 $submission->attemptnumber = $attemptnumber;
2825             } else {
2826                 $submission->attemptnumber = 0;
2827             }
2828             // Work out if this is the latest submission.
2829             $submission->latest = 0;
2830             $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
2831             if ($attemptnumber == -1) {
2832                 // This is a new submission so it must be the latest.
2833                 $submission->latest = 1;
2834             } else {
2835                 // We need to work this out.
2836                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2837                 $latestsubmission = null;
2838                 if ($result) {
2839                     $latestsubmission = reset($result);
2840                 }
2841                 if (empty($latestsubmission) || ($attemptnumber > $latestsubmission->attemptnumber)) {
2842                     $submission->latest = 1;
2843                 }
2844             }
2845             if ($submission->latest) {
2846                 // This is the case when we need to set latest to 0 for all the other attempts.
2847                 $DB->set_field('assign_submission', 'latest', 0, $params);
2848             }
2849             $sid = $DB->insert_record('assign_submission', $submission);
2850             return $DB->get_record('assign_submission', array('id' => $sid));
2851         }
2852         return false;
2853     }
2855     /**
2856      * Load the submission object from it's id.
2857      *
2858      * @param int $submissionid The id of the submission we want
2859      * @return stdClass The submission
2860      */
2861     protected function get_submission($submissionid) {
2862         global $DB;
2864         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$submissionid);
2865         return $DB->get_record('assign_submission', $params, '*', MUST_EXIST);
2866     }
2868     /**
2869      * This will retrieve a user flags object from the db optionally creating it if required.
2870      * The user flags was split from the user_grades table in 2.5.
2871      *
2872      * @param int $userid The user we are getting the flags for.
2873      * @param bool $create If true the flags record will be created if it does not exist
2874      * @return stdClass The flags record
2875      */
2876     public function get_user_flags($userid, $create) {
2877         global $DB, $USER;
2879         // If the userid is not null then use userid.
2880         if (!$userid) {
2881             $userid = $USER->id;
2882         }
2884         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
2886         $flags = $DB->get_record('assign_user_flags', $params);
2888         if ($flags) {
2889             return $flags;
2890         }
2891         if ($create) {
2892             $flags = new stdClass();
2893             $flags->assignment = $this->get_instance()->id;
2894             $flags->userid = $userid;
2895             $flags->locked = 0;
2896             $flags->extensionduedate = 0;
2897             $flags->workflowstate = '';
2898             $flags->allocatedmarker = 0;
2900             // The mailed flag can be one of 3 values: 0 is unsent, 1 is sent and 2 is do not send yet.
2901             // This is because students only want to be notified about certain types of update (grades and feedback).
2902             $flags->mailed = 2;
2904             $fid = $DB->insert_record('assign_user_flags', $flags);
2905             $flags->id = $fid;
2906             return $flags;
2907         }
2908         return false;
2909     }
2911     /**
2912      * This will retrieve a grade object from the db, optionally creating it if required.
2913      *
2914      * @param int $userid The user we are grading
2915      * @param bool $create If true the grade will be created if it does not exist
2916      * @param int $attemptnumber The attempt number to retrieve the grade for. -1 means the latest submission.
2917      * @return stdClass The grade record
2918      */
2919     public function get_user_grade($userid, $create, $attemptnumber=-1) {
2920         global $DB, $USER;
2922         // If the userid is not null then use userid.
2923         if (!$userid) {
2924             $userid = $USER->id;
2925         }
2926         $submission = null;
2928         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
2929         if ($attemptnumber < 0 || $create) {
2930             // Make sure this grade matches the latest submission attempt.
2931             if ($this->get_instance()->teamsubmission) {
2932                 $submission = $this->get_group_submission($userid, 0, true);
2933             } else {
2934                 $submission = $this->get_user_submission($userid, true);
2935             }
2936             if ($submission) {
2937                 $attemptnumber = $submission->attemptnumber;
2938             }
2939         }
2941         if ($attemptnumber >= 0) {
2942             $params['attemptnumber'] = $attemptnumber;
2943         }
2945         $grades = $DB->get_records('assign_grades', $params, 'attemptnumber DESC', '*', 0, 1);
2947         if ($grades) {
2948             return reset($grades);
2949         }
2950         if ($create) {
2951             $grade = new stdClass();
2952             $grade->assignment   = $this->get_instance()->id;
2953             $grade->userid       = $userid;
2954             $grade->timecreated = time();
2955             // If we are "auto-creating" a grade - and there is a submission
2956             // the new grade should not have a more recent timemodified value
2957             // than the submission.
2958             if ($submission) {
2959                 $grade->timemodified = $submission->timemodified;
2960             } else {
2961                 $grade->timemodified = $grade->timecreated;
2962             }
2963             $grade->grade = -1;
2964             $grade->grader = $USER->id;
2965             if ($attemptnumber >= 0) {
2966                 $grade->attemptnumber = $attemptnumber;
2967             }
2969             $gid = $DB->insert_record('assign_grades', $grade);
2970             $grade->id = $gid;
2971             return $grade;
2972         }
2973         return false;
2974     }
2976     /**
2977      * This will retrieve a grade object from the db.
2978      *
2979      * @param int $gradeid The id of the grade
2980      * @return stdClass The grade record
2981      */
2982     protected function get_grade($gradeid) {
2983         global $DB;
2985         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$gradeid);
2986         return $DB->get_record('assign_grades', $params, '*', MUST_EXIST);
2987     }
2989     /**
2990      * Print the grading page for a single user submission.
2991      *
2992      * @param moodleform $mform
2993      * @return string
2994      */
2995     protected function view_single_grade_page($mform) {
2996         global $DB, $CFG;
2998         $o = '';
2999         $instance = $this->get_instance();
3001         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
3003         // Need submit permission to submit an assignment.
3004         require_capability('mod/assign:grade', $this->context);
3006         $header = new assign_header($instance,
3007                                     $this->get_context(),
3008                                     false,
3009                                     $this->get_course_module()->id,
3010                                     get_string('grading', 'assign'));
3011         $o .= $this->get_renderer()->render($header);
3013         // If userid is passed - we are only grading a single student.
3014         $rownum = required_param('rownum', PARAM_INT);
3015         $useridlistid = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
3016         $userid = optional_param('userid', 0, PARAM_INT);
3017         $attemptnumber = optional_param('attemptnumber', -1, PARAM_INT);
3019         $cache = cache::make_from_params(cache_store::MODE_SESSION, 'mod_assign', 'useridlist');
3020         if (!$userid) {
3021             if (!$useridlist = $cache->get($this->get_useridlist_key($useridlistid))) {
3022                 $useridlist = $this->get_grading_userid_list();
3023             }
3024             $cache->set($this->get_useridlist_key($useridlistid), $useridlist);
3025         } else {
3026             $rownum = 0;
3027             $useridlist = array($userid);
3028         }
3030         if ($rownum < 0 || $rownum > count($useridlist)) {
3031             throw new coding_exception('Row is out of bounds for the current grading table: ' . $rownum);
3032         }
3034         $last = false;
3035         $userid = $useridlist[$rownum];
3036         if ($rownum == count($useridlist) - 1) {
3037             $last = true;
3038         }
3039         // This variation on the url will link direct to this student, with no next/previous links.
3040         // The benefit is the url will be the same every time for this student, so Atto autosave drafts can match up.
3041         $returnparams = array('userid' => $userid, 'rownum' => 0, 'useridlistid' => 0);
3042         $this->register_return_link('grade', $returnparams);
3044         $user = $DB->get_record('user', array('id' => $userid));
3045         if ($user) {
3046             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
3047             $usersummary = new assign_user_summary($user,
3048                                                    $this->get_course()->id,
3049                                                    $viewfullnames,
3050                                                    $this->is_blind_marking(),
3051                                                    $this->get_uniqueid_for_user($user->id),
3052                                                    get_extra_user_fields($this->get_context()),
3053                                                    !$this->is_active_user($userid));
3054             $o .= $this->get_renderer()->render($usersummary);
3055         }
3056         $submission = $this->get_user_submission($userid, false, $attemptnumber);
3057         $submissiongroup = null;
3058         $teamsubmission = null;
3059         $notsubmitted = array();
3060         if ($instance->teamsubmission) {
3061             $teamsubmission = $this->get_group_submission($userid, 0, false, $attemptnumber);
3062             $submissiongroup = $this->get_submission_group($userid);
3063             $groupid = 0;
3064             if ($submissiongroup) {
3065                 $groupid = $submissiongroup->id;
3066             }
3067             $notsubmitted = $this->get_submission_group_members_who_have_not_submitted($groupid, false);
3069         }
3071         // Get the requested grade.
3072         $grade = $this->get_user_grade($userid, false, $attemptnumber);
3073         $flags = $this->get_user_flags($userid, false);
3074         if ($this->can_view_submission($userid)) {
3075             $gradelocked = ($flags && $flags->locked) || $this->grading_disabled($userid);
3076             $extensionduedate = null;
3077             if ($flags) {
3078                 $extensionduedate = $flags->extensionduedate;
3079             }
3080             $showedit = $this->submissions_open($userid) && ($this->is_any_submission_plugin_enabled());
3081             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
3082             $usergroups = $this->get_all_groups($user->id);
3084             $submissionstatus = new assign_submission_status($instance->allowsubmissionsfromdate,
3085                                                              $instance->alwaysshowdescription,
3086                                                              $submission,
3087                                                              $instance->teamsubmission,
3088                                                              $teamsubmission,
3089                                                              $submissiongroup,
3090                                                              $notsubmitted,
3091                                                              $this->is_any_submission_plugin_enabled(),
3092                                                              $gradelocked,
3093                                                              $this->is_graded($userid),
3094                                                              $instance->duedate,
3095                                                              $instance->cutoffdate,
3096                                                              $this->get_submission_plugins(),
3097                                                              $this->get_return_action(),
3098                                                              $this->get_return_params(),
3099                                                              $this->get_course_module()->id,
3100                                                              $this->get_course()->id,
3101                                                              assign_submission_status::GRADER_VIEW,
3102                                                              $showedit,
3103                                                              false,
3104                                                              $viewfullnames,
3105                                                              $extensionduedate,
3106                                                              $this->get_context(),
3107                                                              $this->is_blind_marking(),
3108                                                              '',
3109                                                              $instance->attemptreopenmethod,
3110                                                              $instance->maxattempts,
3111                                                              $this->get_grading_status($userid),
3112                                                              $instance->preventsubmissionnotingroup,
3113                                                              $usergroups);
3114             $o .= $this->get_renderer()->render($submissionstatus);
3115         }
3117         if ($grade) {
3118             $data = new stdClass();
3119             if ($grade->grade !== null && $grade->grade >= 0) {
3120                 $data->grade = format_float($grade->grade, 2);
3121             }
3122         } else {
3123             $data = new stdClass();
3124             $data->grade = '';
3125         }
3127         if (!empty($flags->workflowstate)) {
3128             $data->workflowstate = $flags->workflowstate;
3129         }
3130         if (!empty($flags->allocatedmarker)) {
3131             $data->allocatedmarker = $flags->allocatedmarker;
3132         }
3134         // Warning if required.
3135         $allsubmissions = $this->get_all_submissions($userid);
3137         if ($attemptnumber != -1) {
3138             $params = array('attemptnumber'=>$attemptnumber + 1,
3139                             'totalattempts'=>count($allsubmissions));
3140             $message = get_string('editingpreviousfeedbackwarning', 'assign', $params);
3141             $o .= $this->get_renderer()->notification($message);
3142         }
3144         // Now show the grading form.
3145         if (!$mform) {
3146             $pagination = array('rownum'=>$rownum,
3147                                 'useridlistid'=>$useridlistid,
3148                                 'last'=>$last,
3149                                 'userid'=>optional_param('userid', 0, PARAM_INT),
3150                                 'attemptnumber'=>$attemptnumber);
3151             $formparams = array($this, $data, $pagination);
3152             $mform = new mod_assign_grade_form(null,
3153                                                $formparams,
3154                                                'post',
3155                                                '',
3156                                                array('class'=>'gradeform'));
3157         }
3158         $o .= $this->get_renderer()->heading(get_string('grade'), 3);
3159         $o .= $this->get_renderer()->render(new assign_form('gradingform', $mform));
3161         if (count($allsubmissions) > 1 && $attemptnumber == -1) {
3162             $allgrades = $this->get_all_grades($userid);
3163             $history = new assign_attempt_history($allsubmissions,
3164                                                   $allgrades,
3165                                                   $this->get_submission_plugins(),
3166                                                   $this->get_feedback_plugins(),
3167                                                   $this->get_course_module()->id,
3168                                                   $this->get_return_action(),
3169                                                   $this->get_return_params(),
3170                                                   true,
3171                                                   $useridlistid,
3172                                                   $rownum);
3174             $o .= $this->get_renderer()->render($history);
3175         }
3177         \mod_assign\event\grading_form_viewed::create_from_user($this, $user)->trigger();
3179         $o .= $this->view_footer();
3180         return $o;
3181     }
3183     /**
3184      * Show a confirmation page to make sure they want to release student identities.
3185      *
3186      * @return string
3187      */
3188     protected function view_reveal_identities_confirm() {
3189         require_capability('mod/assign:revealidentities', $this->get_context());
3191         $o = '';
3192         $header = new assign_header($this->get_instance(),
3193                                     $this->get_context(),
3194                                     false,
3195                                     $this->get_course_module()->id);
3196         $o .= $this->get_renderer()->render($header);
3198         $urlparams = array('id'=>$this->get_course_module()->id,
3199                            'action'=>'revealidentitiesconfirm',
3200                            'sesskey'=>sesskey());
3201         $confirmurl = new moodle_url('/mod/assign/view.php', $urlparams);
3203         $urlparams = array('id'=>$this->get_course_module()->id,
3204                            'action'=>'grading');
3205         $cancelurl = new moodle_url('/mod/assign/view.php', $urlparams);
3207         $o .= $this->get_renderer()->confirm(get_string('revealidentitiesconfirm', 'assign'),
3208                                              $confirmurl,
3209                                              $cancelurl);
3210         $o .= $this->view_footer();
3212         \mod_assign\event\reveal_identities_confirmation_page_viewed::create_from_assign($this)->trigger();
3214         return $o;
3215     }
3217     /**
3218      * View a link to go back to the previous page. Uses url parameters returnaction and returnparams.
3219      *
3220      * @return string
3221      */
3222     protected function view_return_links() {
3223         $returnaction = optional_param('returnaction', '', PARAM_ALPHA);
3224         $returnparams = optional_param('returnparams', '', PARAM_TEXT);
3226         $params = array();
3227         $returnparams = str_replace('&amp;', '&', $returnparams);
3228         parse_str($returnparams, $params);
3229         $newparams = array('id' => $this->get_course_module()->id, 'action' => $returnaction);
3230         $params = array_merge($newparams, $params);
3232         $url = new moodle_url('/mod/assign/view.php', $params);
3233         return $this->get_renderer()->single_button($url, get_string('back'), 'get');
3234     }
3236     /**
3237      * View the grading table of all submissions for this assignment.
3238      *
3239      * @return string
3240      */
3241     protected function view_grading_table() {
3242         global $USER, $CFG;
3244         // Include grading options form.
3245         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
3246         require_once($CFG->dirroot . '/mod/assign/quickgradingform.php');
3247         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
3248         $o = '';
3249         $cmid = $this->get_course_module()->id;
3251         $links = array();
3252         if (has_capability('gradereport/grader:view', $this->get_course_context()) &&
3253                 has_capability('moodle/grade:viewall', $this->get_course_context())) {
3254             $gradebookurl = '/grade/report/grader/index.php?id=' . $this->get_course()->id;
3255             $links[$gradebookurl] = get_string('viewgradebook', 'assign');
3256         }
3257         if ($this->is_any_submission_plugin_enabled() && $this->count_submissions()) {
3258             $downloadurl = '/mod/assign/view.php?id=' . $cmid . '&action=downloadall';
3259             $links[$downloadurl] = get_string('downloadall', 'assign');
3260         }
3261         if ($this->is_blind_marking() &&
3262                 has_capability('mod/assign:revealidentities', $this->get_context())) {
3263             $revealidentitiesurl = '/mod/assign/view.php?id=' . $cmid . '&action=revealidentities';
3264             $links[$revealidentitiesurl] = get_string('revealidentities', 'assign');
3265         }
3266         foreach ($this->get_feedback_plugins() as $plugin) {
3267             if ($plugin->is_enabled() && $plugin->is_visible()) {
3268                 foreach ($plugin->get_grading_actions() as $action => $description) {