Merge branch 'MDL-52013-m' of https://github.com/micaherne/moodle
[moodle.git] / mod / assign / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the definition for the class assignment
19  *
20  * This class provides all the functionality for the new assign module.
21  *
22  * @package   mod_assign
23  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 // Assignment submission statuses.
30 define('ASSIGN_SUBMISSION_STATUS_NEW', 'new');
31 define('ASSIGN_SUBMISSION_STATUS_REOPENED', 'reopened');
32 define('ASSIGN_SUBMISSION_STATUS_DRAFT', 'draft');
33 define('ASSIGN_SUBMISSION_STATUS_SUBMITTED', 'submitted');
35 // Search filters for grading page.
36 define('ASSIGN_FILTER_SUBMITTED', 'submitted');
37 define('ASSIGN_FILTER_NOT_SUBMITTED', 'notsubmitted');
38 define('ASSIGN_FILTER_SINGLE_USER', 'singleuser');
39 define('ASSIGN_FILTER_REQUIRE_GRADING', 'require_grading');
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         $eventtype = 'due';
894         if ($instance->duedate) {
895             $event = new stdClass();
897             $params = array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype);
898             $event->id = $DB->get_field('event', 'id', $params);
899             $event->name = $instance->name;
900             $event->timestart = $instance->duedate;
902             // Convert the links to pluginfile. It is a bit hacky but at this stage the files
903             // might not have been saved in the module area yet.
904             $intro = $instance->intro;
905             if ($draftid = file_get_submitted_draft_itemid('introeditor')) {
906                 $intro = file_rewrite_urls_to_pluginfile($intro, $draftid);
907             }
909             // We need to remove the links to files as the calendar is not ready
910             // to support module events with file areas.
911             $intro = strip_pluginfile_content($intro);
912             if ($this->show_intro()) {
913                 $event->description = array(
914                     'text' => $intro,
915                     'format' => $instance->introformat
916                 );
917             } else {
918                 $event->description = array(
919                     'text' => '',
920                     'format' => $instance->introformat
921                 );
922             }
924             if ($event->id) {
925                 $calendarevent = calendar_event::load($event->id);
926                 $calendarevent->update($event);
927             } else {
928                 unset($event->id);
929                 $event->courseid    = $instance->course;
930                 $event->groupid     = 0;
931                 $event->userid      = 0;
932                 $event->modulename  = 'assign';
933                 $event->instance    = $instance->id;
934                 $event->eventtype   = $eventtype;
935                 $event->timeduration = 0;
936                 calendar_event::create($event);
937             }
938         } else {
939             $DB->delete_records('event', array('modulename' => 'assign', 'instance' => $instance->id, 'eventtype' => $eventtype));
940         }
941     }
944     /**
945      * Update this instance in the database.
946      *
947      * @param stdClass $formdata - the data submitted from the form
948      * @return bool false if an error occurs
949      */
950     public function update_instance($formdata) {
951         global $DB;
952         $adminconfig = $this->get_admin_config();
954         $update = new stdClass();
955         $update->id = $formdata->instance;
956         $update->name = $formdata->name;
957         $update->timemodified = time();
958         $update->course = $formdata->course;
959         $update->intro = $formdata->intro;
960         $update->introformat = $formdata->introformat;
961         $update->alwaysshowdescription = !empty($formdata->alwaysshowdescription);
962         $update->submissiondrafts = $formdata->submissiondrafts;
963         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
964         $update->sendnotifications = $formdata->sendnotifications;
965         $update->sendlatenotifications = $formdata->sendlatenotifications;
966         $update->sendstudentnotifications = $adminconfig->sendstudentnotifications;
967         if (isset($formdata->sendstudentnotifications)) {
968             $update->sendstudentnotifications = $formdata->sendstudentnotifications;
969         }
970         $update->duedate = $formdata->duedate;
971         $update->cutoffdate = $formdata->cutoffdate;
972         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
973         $update->grade = $formdata->grade;
974         if (!empty($formdata->completionunlocked)) {
975             $update->completionsubmit = !empty($formdata->completionsubmit);
976         }
977         $update->teamsubmission = $formdata->teamsubmission;
978         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
979         if (isset($formdata->teamsubmissiongroupingid)) {
980             $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
981         }
982         $update->blindmarking = $formdata->blindmarking;
983         $update->attemptreopenmethod = ASSIGN_ATTEMPT_REOPEN_METHOD_NONE;
984         if (!empty($formdata->attemptreopenmethod)) {
985             $update->attemptreopenmethod = $formdata->attemptreopenmethod;
986         }
987         if (!empty($formdata->maxattempts)) {
988             $update->maxattempts = $formdata->maxattempts;
989         }
990         if (isset($formdata->preventsubmissionnotingroup)) {
991             $update->preventsubmissionnotingroup = $formdata->preventsubmissionnotingroup;
992         }
993         $update->markingworkflow = $formdata->markingworkflow;
994         $update->markingallocation = $formdata->markingallocation;
995         if (empty($update->markingworkflow)) { // If marking workflow is disabled, make sure allocation is disabled.
996             $update->markingallocation = 0;
997         }
999         $result = $DB->update_record('assign', $update);
1000         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
1002         $this->save_intro_draft_files($formdata);
1004         // Load the assignment so the plugins have access to it.
1006         // Call save_settings hook for submission plugins.
1007         foreach ($this->submissionplugins as $plugin) {
1008             if (!$this->update_plugin_instance($plugin, $formdata)) {
1009                 print_error($plugin->get_error());
1010                 return false;
1011             }
1012         }
1013         foreach ($this->feedbackplugins as $plugin) {
1014             if (!$this->update_plugin_instance($plugin, $formdata)) {
1015                 print_error($plugin->get_error());
1016                 return false;
1017             }
1018         }
1020         $this->update_calendar($this->get_course_module()->id);
1021         $this->update_gradebook(false, $this->get_course_module()->id);
1023         $update = new stdClass();
1024         $update->id = $this->get_instance()->id;
1025         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
1026         $DB->update_record('assign', $update);
1028         return $result;
1029     }
1031     /**
1032      * Save the attachments in the draft areas.
1033      *
1034      * @param stdClass $formdata
1035      */
1036     protected function save_intro_draft_files($formdata) {
1037         if (isset($formdata->introattachments)) {
1038             file_save_draft_area_files($formdata->introattachments, $this->get_context()->id,
1039                                        'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA, 0);
1040         }
1041     }
1043     /**
1044      * Add elements in grading plugin form.
1045      *
1046      * @param mixed $grade stdClass|null
1047      * @param MoodleQuickForm $mform
1048      * @param stdClass $data
1049      * @param int $userid - The userid we are grading
1050      * @return void
1051      */
1052     protected function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
1053         foreach ($this->feedbackplugins as $plugin) {
1054             if ($plugin->is_enabled() && $plugin->is_visible()) {
1055                 $plugin->get_form_elements_for_user($grade, $mform, $data, $userid);
1056             }
1057         }
1058     }
1062     /**
1063      * Add one plugins settings to edit plugin form.
1064      *
1065      * @param assign_plugin $plugin The plugin to add the settings from
1066      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1067      *                               This form is modified directly (not returned).
1068      * @param array $pluginsenabled A list of form elements to be added to a group.
1069      *                              The new element is added to this array by this function.
1070      * @return void
1071      */
1072     protected function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled) {
1073         global $CFG;
1074         if ($plugin->is_visible() && !$plugin->is_configurable() && $plugin->is_enabled()) {
1075             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1076             $pluginsenabled[] = $mform->createElement('hidden', $name, 1);
1077             $mform->setType($name, PARAM_BOOL);
1078             $plugin->get_settings($mform);
1079         } else if ($plugin->is_visible() && $plugin->is_configurable()) {
1080             $name = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
1081             $label = $plugin->get_name();
1082             $label .= ' ' . $this->get_renderer()->help_icon('enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
1083             $pluginsenabled[] = $mform->createElement('checkbox', $name, '', $label);
1085             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
1086             if ($plugin->get_config('enabled') !== false) {
1087                 $default = $plugin->is_enabled();
1088             }
1089             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
1091             $plugin->get_settings($mform);
1093         }
1094     }
1096     /**
1097      * Add settings to edit plugin form.
1098      *
1099      * @param MoodleQuickForm $mform The form to add the configuration settings to.
1100      *                               This form is modified directly (not returned).
1101      * @return void
1102      */
1103     public function add_all_plugin_settings(MoodleQuickForm $mform) {
1104         $mform->addElement('header', 'submissiontypes', get_string('submissiontypes', 'assign'));
1106         $submissionpluginsenabled = array();
1107         $group = $mform->addGroup(array(), 'submissionplugins', get_string('submissiontypes', 'assign'), array(' '), false);
1108         foreach ($this->submissionplugins as $plugin) {
1109             $this->add_plugin_settings($plugin, $mform, $submissionpluginsenabled);
1110         }
1111         $group->setElements($submissionpluginsenabled);
1113         $mform->addElement('header', 'feedbacktypes', get_string('feedbacktypes', 'assign'));
1114         $feedbackpluginsenabled = array();
1115         $group = $mform->addGroup(array(), 'feedbackplugins', get_string('feedbacktypes', 'assign'), array(' '), false);
1116         foreach ($this->feedbackplugins as $plugin) {
1117             $this->add_plugin_settings($plugin, $mform, $feedbackpluginsenabled);
1118         }
1119         $group->setElements($feedbackpluginsenabled);
1120         $mform->setExpanded('submissiontypes');
1121     }
1123     /**
1124      * Allow each plugin an opportunity to update the defaultvalues
1125      * passed in to the settings form (needed to set up draft areas for
1126      * editor and filemanager elements)
1127      *
1128      * @param array $defaultvalues
1129      */
1130     public function plugin_data_preprocessing(&$defaultvalues) {
1131         foreach ($this->submissionplugins as $plugin) {
1132             if ($plugin->is_visible()) {
1133                 $plugin->data_preprocessing($defaultvalues);
1134             }
1135         }
1136         foreach ($this->feedbackplugins as $plugin) {
1137             if ($plugin->is_visible()) {
1138                 $plugin->data_preprocessing($defaultvalues);
1139             }
1140         }
1141     }
1143     /**
1144      * Get the name of the current module.
1145      *
1146      * @return string the module name (Assignment)
1147      */
1148     protected function get_module_name() {
1149         if (isset(self::$modulename)) {
1150             return self::$modulename;
1151         }
1152         self::$modulename = get_string('modulename', 'assign');
1153         return self::$modulename;
1154     }
1156     /**
1157      * Get the plural name of the current module.
1158      *
1159      * @return string the module name plural (Assignments)
1160      */
1161     protected function get_module_name_plural() {
1162         if (isset(self::$modulenameplural)) {
1163             return self::$modulenameplural;
1164         }
1165         self::$modulenameplural = get_string('modulenameplural', 'assign');
1166         return self::$modulenameplural;
1167     }
1169     /**
1170      * Has this assignment been constructed from an instance?
1171      *
1172      * @return bool
1173      */
1174     public function has_instance() {
1175         return $this->instance || $this->get_course_module();
1176     }
1178     /**
1179      * Get the settings for the current instance of this assignment
1180      *
1181      * @return stdClass The settings
1182      */
1183     public function get_instance() {
1184         global $DB;
1185         if ($this->instance) {
1186             return $this->instance;
1187         }
1188         if ($this->get_course_module()) {
1189             $params = array('id' => $this->get_course_module()->instance);
1190             $this->instance = $DB->get_record('assign', $params, '*', MUST_EXIST);
1191         }
1192         if (!$this->instance) {
1193             throw new coding_exception('Improper use of the assignment class. ' .
1194                                        'Cannot load the assignment record.');
1195         }
1196         return $this->instance;
1197     }
1199     /**
1200      * Get the primary grade item for this assign instance.
1201      *
1202      * @return stdClass The grade_item record
1203      */
1204     public function get_grade_item() {
1205         if ($this->gradeitem) {
1206             return $this->gradeitem;
1207         }
1208         $instance = $this->get_instance();
1209         $params = array('itemtype' => 'mod',
1210                         'itemmodule' => 'assign',
1211                         'iteminstance' => $instance->id,
1212                         'courseid' => $instance->course,
1213                         'itemnumber' => 0);
1214         $this->gradeitem = grade_item::fetch($params);
1215         if (!$this->gradeitem) {
1216             throw new coding_exception('Improper use of the assignment class. ' .
1217                                        'Cannot load the grade item.');
1218         }
1219         return $this->gradeitem;
1220     }
1222     /**
1223      * Get the context of the current course.
1224      *
1225      * @return mixed context|null The course context
1226      */
1227     public function get_course_context() {
1228         if (!$this->context && !$this->course) {
1229             throw new coding_exception('Improper use of the assignment class. ' .
1230                                        'Cannot load the course context.');
1231         }
1232         if ($this->context) {
1233             return $this->context->get_course_context();
1234         } else {
1235             return context_course::instance($this->course->id);
1236         }
1237     }
1240     /**
1241      * Get the current course module.
1242      *
1243      * @return cm_info|null The course module or null if not known
1244      */
1245     public function get_course_module() {
1246         if ($this->coursemodule) {
1247             return $this->coursemodule;
1248         }
1249         if (!$this->context) {
1250             return null;
1251         }
1253         if ($this->context->contextlevel == CONTEXT_MODULE) {
1254             $modinfo = get_fast_modinfo($this->get_course());
1255             $this->coursemodule = $modinfo->get_cm($this->context->instanceid);
1256             return $this->coursemodule;
1257         }
1258         return null;
1259     }
1261     /**
1262      * Get context module.
1263      *
1264      * @return context
1265      */
1266     public function get_context() {
1267         return $this->context;
1268     }
1270     /**
1271      * Get the current course.
1272      *
1273      * @return mixed stdClass|null The course
1274      */
1275     public function get_course() {
1276         global $DB;
1278         if ($this->course) {
1279             return $this->course;
1280         }
1282         if (!$this->context) {
1283             return null;
1284         }
1285         $params = array('id' => $this->get_course_context()->instanceid);
1286         $this->course = $DB->get_record('course', $params, '*', MUST_EXIST);
1288         return $this->course;
1289     }
1291     /**
1292      * Count the number of intro attachments.
1293      *
1294      * @return int
1295      */
1296     protected function count_attachments() {
1298         $fs = get_file_storage();
1299         $files = $fs->get_area_files($this->get_context()->id, 'mod_assign', ASSIGN_INTROATTACHMENT_FILEAREA,
1300                         0, 'id', false);
1302         return count($files);
1303     }
1305     /**
1306      * Are there any intro attachments to display?
1307      *
1308      * @return boolean
1309      */
1310     protected function has_visible_attachments() {
1311         return ($this->count_attachments() > 0);
1312     }
1314     /**
1315      * Return a grade in user-friendly form, whether it's a scale or not.
1316      *
1317      * @param mixed $grade int|null
1318      * @param boolean $editing Are we allowing changes to this grade?
1319      * @param int $userid The user id the grade belongs to
1320      * @param int $modified Timestamp from when the grade was last modified
1321      * @return string User-friendly representation of grade
1322      */
1323     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1324         global $DB;
1326         static $scalegrades = array();
1328         $o = '';
1330         if ($this->get_instance()->grade >= 0) {
1331             // Normal number.
1332             if ($editing && $this->get_instance()->grade > 0) {
1333                 if ($grade < 0) {
1334                     $displaygrade = '';
1335                 } else {
1336                     $displaygrade = format_float($grade, 2);
1337                 }
1338                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' .
1339                        get_string('usergrade', 'assign') .
1340                        '</label>';
1341                 $o .= '<input type="text"
1342                               id="quickgrade_' . $userid . '"
1343                               name="quickgrade_' . $userid . '"
1344                               value="' .  $displaygrade . '"
1345                               size="6"
1346                               maxlength="10"
1347                               class="quickgrade"/>';
1348                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, 2);
1349                 return $o;
1350             } else {
1351                 if ($grade == -1 || $grade === null) {
1352                     $o .= '-';
1353                 } else {
1354                     $item = $this->get_grade_item();
1355                     $o .= grade_format_gradevalue($grade, $item);
1356                     if ($item->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) {
1357                         // If displaying the raw grade, also display the total value.
1358                         $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade, 2);
1359                     }
1360                 }
1361                 return $o;
1362             }
1364         } else {
1365             // Scale.
1366             if (empty($this->cache['scale'])) {
1367                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1368                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1369                 } else {
1370                     $o .= '-';
1371                     return $o;
1372                 }
1373             }
1374             if ($editing) {
1375                 $o .= '<label class="accesshide"
1376                               for="quickgrade_' . $userid . '">' .
1377                       get_string('usergrade', 'assign') .
1378                       '</label>';
1379                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1380                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1381                 foreach ($this->cache['scale'] as $optionid => $option) {
1382                     $selected = '';
1383                     if ($grade == $optionid) {
1384                         $selected = 'selected="selected"';
1385                     }
1386                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1387                 }
1388                 $o .= '</select>';
1389                 return $o;
1390             } else {
1391                 $scaleid = (int)$grade;
1392                 if (isset($this->cache['scale'][$scaleid])) {
1393                     $o .= $this->cache['scale'][$scaleid];
1394                     return $o;
1395                 }
1396                 $o .= '-';
1397                 return $o;
1398             }
1399         }
1400     }
1402     /**
1403      * Load a list of users enrolled in the current course with the specified permission and group.
1404      * 0 for no group.
1405      *
1406      * @param int $currentgroup
1407      * @param bool $idsonly
1408      * @return array List of user records
1409      */
1410     public function list_participants($currentgroup, $idsonly) {
1412         if (empty($currentgroup)) {
1413             $currentgroup = 0;
1414         }
1416         $key = $this->context->id . '-' . $currentgroup . '-' . $this->show_only_active_users();
1417         if (!isset($this->participants[$key])) {
1418             $users = get_enrolled_users($this->context, 'mod/assign:submit', $currentgroup, 'u.*', null, null, null,
1419                     $this->show_only_active_users());
1421             $cm = $this->get_course_module();
1422             $info = new \core_availability\info_module($cm);
1423             $users = $info->filter_user_list($users);
1425             $this->participants[$key] = $users;
1426         }
1428         if ($idsonly) {
1429             $idslist = array();
1430             foreach ($this->participants[$key] as $id => $user) {
1431                 $idslist[$id] = new stdClass();
1432                 $idslist[$id]->id = $id;
1433             }
1434             return $idslist;
1435         }
1436         return $this->participants[$key];
1437     }
1439     /**
1440      * Load a count of valid teams for this assignment.
1441      *
1442      * @param int $activitygroup Activity active group
1443      * @return int number of valid teams
1444      */
1445     public function count_teams($activitygroup = 0) {
1447         $count = 0;
1449         $participants = $this->list_participants($activitygroup, true);
1451         // If a team submission grouping id is provided all good as all returned groups
1452         // are the submission teams, but if no team submission grouping was specified
1453         // $groups will contain all participants groups.
1454         if ($this->get_instance()->teamsubmissiongroupingid) {
1456             // We restrict the users to the selected group ones.
1457             $groups = groups_get_all_groups($this->get_course()->id,
1458                                             array_keys($participants),
1459                                             $this->get_instance()->teamsubmissiongroupingid,
1460                                             'DISTINCT g.id, g.name');
1462             $count = count($groups);
1464             // When a specific group is selected we don't count the default group users.
1465             if ($activitygroup == 0) {
1466                 if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1467                     // See if there are any users in the default group.
1468                     $defaultusers = $this->get_submission_group_members(0, true);
1469                     if (count($defaultusers) > 0) {
1470                         $count += 1;
1471                     }
1472                 }
1473             }
1474         } else {
1475             // It is faster to loop around participants if no grouping was specified.
1476             $groups = array();
1477             foreach ($participants as $participant) {
1478                 if ($group = $this->get_submission_group($participant->id)) {
1479                     $groups[$group->id] = true;
1480                 } else if (empty($this->get_instance()->preventsubmissionnotingroup)) {
1481                     $groups[0] = true;
1482                 }
1483             }
1485             $count = count($groups);
1486         }
1488         return $count;
1489     }
1491     /**
1492      * Load a count of active users enrolled in the current course with the specified permission and group.
1493      * 0 for no group.
1494      *
1495      * @param int $currentgroup
1496      * @return int number of matching users
1497      */
1498     public function count_participants($currentgroup) {
1499         return count($this->list_participants($currentgroup, true));
1500     }
1502     /**
1503      * Load a count of active users submissions in the current module that require grading
1504      * This means the submission modification time is more recent than the
1505      * grading modification time and the status is SUBMITTED.
1506      *
1507      * @return int number of matching submissions
1508      */
1509     public function count_submissions_need_grading() {
1510         global $DB;
1512         if ($this->get_instance()->teamsubmission) {
1513             // This does not make sense for group assignment because the submission is shared.
1514             return 0;
1515         }
1517         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1518         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1520         $params['assignid'] = $this->get_instance()->id;
1521         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1523         $sql = 'SELECT COUNT(s.userid)
1524                    FROM {assign_submission} s
1525                    LEFT JOIN {assign_grades} g ON
1526                         s.assignment = g.assignment AND
1527                         s.userid = g.userid AND
1528                         g.attemptnumber = s.attemptnumber
1529                    JOIN(' . $esql . ') e ON e.id = s.userid
1530                    WHERE
1531                         s.latest = 1 AND
1532                         s.assignment = :assignid AND
1533                         s.timemodified IS NOT NULL AND
1534                         s.status = :submitted AND
1535                         (s.timemodified >= g.timemodified OR g.timemodified IS NULL OR g.grade IS NULL)';
1537         return $DB->count_records_sql($sql, $params);
1538     }
1540     /**
1541      * Load a count of grades.
1542      *
1543      * @return int number of grades
1544      */
1545     public function count_grades() {
1546         global $DB;
1548         if (!$this->has_instance()) {
1549             return 0;
1550         }
1552         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1553         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1555         $params['assignid'] = $this->get_instance()->id;
1557         $sql = 'SELECT COUNT(g.userid)
1558                    FROM {assign_grades} g
1559                    JOIN(' . $esql . ') e ON e.id = g.userid
1560                    WHERE g.assignment = :assignid';
1562         return $DB->count_records_sql($sql, $params);
1563     }
1565     /**
1566      * Load a count of submissions.
1567      *
1568      * @param bool $includenew When true, also counts the submissions with status 'new'.
1569      * @return int number of submissions
1570      */
1571     public function count_submissions($includenew = false) {
1572         global $DB;
1574         if (!$this->has_instance()) {
1575             return 0;
1576         }
1578         $params = array();
1579         $sqlnew = '';
1581         if (!$includenew) {
1582             $sqlnew = ' AND s.status <> :status ';
1583             $params['status'] = ASSIGN_SUBMISSION_STATUS_NEW;
1584         }
1586         if ($this->get_instance()->teamsubmission) {
1587             // We cannot join on the enrolment tables for group submissions (no userid).
1588             $sql = 'SELECT COUNT(DISTINCT s.groupid)
1589                         FROM {assign_submission} s
1590                         WHERE
1591                             s.assignment = :assignid AND
1592                             s.timemodified IS NOT NULL AND
1593                             s.userid = :groupuserid' .
1594                             $sqlnew;
1596             $params['assignid'] = $this->get_instance()->id;
1597             $params['groupuserid'] = 0;
1598         } else {
1599             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1600             list($esql, $enrolparams) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1602             $params = array_merge($params, $enrolparams);
1603             $params['assignid'] = $this->get_instance()->id;
1605             $sql = 'SELECT COUNT(DISTINCT s.userid)
1606                        FROM {assign_submission} s
1607                        JOIN(' . $esql . ') e ON e.id = s.userid
1608                        WHERE
1609                             s.assignment = :assignid AND
1610                             s.timemodified IS NOT NULL ' .
1611                             $sqlnew;
1613         }
1615         return $DB->count_records_sql($sql, $params);
1616     }
1618     /**
1619      * Load a count of submissions with a specified status.
1620      *
1621      * @param string $status The submission status - should match one of the constants
1622      * @return int number of matching submissions
1623      */
1624     public function count_submissions_with_status($status) {
1625         global $DB;
1627         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1628         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, true);
1630         $params['assignid'] = $this->get_instance()->id;
1631         $params['assignid2'] = $this->get_instance()->id;
1632         $params['submissionstatus'] = $status;
1634         if ($this->get_instance()->teamsubmission) {
1636             $groupsstr = '';
1637             if ($currentgroup != 0) {
1638                 // If there is an active group we should only display the current group users groups.
1639                 $participants = $this->list_participants($currentgroup, true);
1640                 $groups = groups_get_all_groups($this->get_course()->id,
1641                                                 array_keys($participants),
1642                                                 $this->get_instance()->teamsubmissiongroupingid,
1643                                                 'DISTINCT g.id, g.name');
1644                 list($groupssql, $groupsparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED);
1645                 $groupsstr = 's.groupid ' . $groupssql . ' AND';
1646                 $params = $params + $groupsparams;
1647             }
1648             $sql = 'SELECT COUNT(s.groupid)
1649                         FROM {assign_submission} s
1650                         WHERE
1651                             s.latest = 1 AND
1652                             s.assignment = :assignid AND
1653                             s.timemodified IS NOT NULL AND
1654                             s.userid = :groupuserid AND '
1655                             . $groupsstr . '
1656                             s.status = :submissionstatus';
1657             $params['groupuserid'] = 0;
1658         } else {
1659             $sql = 'SELECT COUNT(s.userid)
1660                         FROM {assign_submission} s
1661                         JOIN(' . $esql . ') e ON e.id = s.userid
1662                         WHERE
1663                             s.latest = 1 AND
1664                             s.assignment = :assignid AND
1665                             s.timemodified IS NOT NULL AND
1666                             s.status = :submissionstatus';
1668         }
1670         return $DB->count_records_sql($sql, $params);
1671     }
1673     /**
1674      * Utility function to get the userid for every row in the grading table
1675      * so the order can be frozen while we iterate it.
1676      *
1677      * @return array An array of userids
1678      */
1679     protected function get_grading_userid_list() {
1680         $filter = get_user_preferences('assign_filter', '');
1681         $table = new assign_grading_table($this, 0, $filter, 0, false);
1683         $useridlist = $table->get_column_data('userid');
1685         return $useridlist;
1686     }
1688     /**
1689      * Generate zip file from array of given files.
1690      *
1691      * @param array $filesforzipping - array of files to pass into archive_to_pathname.
1692      *                                 This array is indexed by the final file name and each
1693      *                                 element in the array is an instance of a stored_file object.
1694      * @return path of temp file - note this returned file does
1695      *         not have a .zip extension - it is a temp file.
1696      */
1697     protected function pack_files($filesforzipping) {
1698         global $CFG;
1699         // Create path for new zip file.
1700         $tempzip = tempnam($CFG->tempdir . '/', 'assignment_');
1701         // Zip files.
1702         $zipper = new zip_packer();
1703         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
1704             return $tempzip;
1705         }
1706         return false;
1707     }
1709     /**
1710      * Finds all assignment notifications that have yet to be mailed out, and mails them.
1711      *
1712      * Cron function to be run periodically according to the moodle cron.
1713      *
1714      * @return bool
1715      */
1716     public static function cron() {
1717         global $DB;
1719         // Only ever send a max of one days worth of updates.
1720         $yesterday = time() - (24 * 3600);
1721         $timenow   = time();
1722         $lastcron = $DB->get_field('modules', 'lastcron', array('name' => 'assign'));
1724         // Collect all submissions that require mailing.
1725         // Submissions are included if all are true:
1726         //   - The assignment is visible in the gradebook.
1727         //   - No previous notification has been sent.
1728         //   - If marking workflow is not enabled, the grade was updated in the past 24 hours, or
1729         //     if marking workflow is enabled, the workflow state is at 'released'.
1730         $sql = "SELECT g.id as gradeid, a.course, a.name, a.blindmarking, a.revealidentities,
1731                        g.*, g.timemodified as lastmodified, cm.id as cmid
1732                  FROM {assign} a
1733                  JOIN {assign_grades} g ON g.assignment = a.id
1734             LEFT JOIN {assign_user_flags} uf ON uf.assignment = a.id AND uf.userid = g.userid
1735                  JOIN {course_modules} cm ON cm.course = a.course AND cm.instance = a.id
1736                  JOIN {modules} md ON md.id = cm.module AND md.name = 'assign'
1737                  JOIN {grade_items} gri ON gri.iteminstance = a.id AND gri.courseid = a.course AND gri.itemmodule = md.name
1738                  WHERE ((a.markingworkflow = 0 AND g.timemodified >= :yesterday AND g.timemodified <= :today) OR
1739                         (a.markingworkflow = 1 AND uf.workflowstate = :wfreleased)) AND
1740                        uf.mailed = 0 AND gri.hidden = 0
1741               ORDER BY a.course, cm.id";
1743         $params = array(
1744             'yesterday' => $yesterday,
1745             'today' => $timenow,
1746             'wfreleased' => ASSIGN_MARKING_WORKFLOW_STATE_RELEASED,
1747         );
1748         $submissions = $DB->get_records_sql($sql, $params);
1750         if (!empty($submissions)) {
1752             mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
1754             // Preload courses we are going to need those.
1755             $courseids = array();
1756             foreach ($submissions as $submission) {
1757                 $courseids[] = $submission->course;
1758             }
1760             // Filter out duplicates.
1761             $courseids = array_unique($courseids);
1762             $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
1763             list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
1764             $sql = 'SELECT c.*, ' . $ctxselect .
1765                       ' FROM {course} c
1766                  LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
1767                      WHERE c.id ' . $courseidsql;
1769             $params['contextlevel'] = CONTEXT_COURSE;
1770             $courses = $DB->get_records_sql($sql, $params);
1772             // Clean up... this could go on for a while.
1773             unset($courseids);
1774             unset($ctxselect);
1775             unset($courseidsql);
1776             unset($params);
1778             // Message students about new feedback.
1779             foreach ($submissions as $submission) {
1781                 mtrace("Processing assignment submission $submission->id ...");
1783                 // Do not cache user lookups - could be too many.
1784                 if (!$user = $DB->get_record('user', array('id'=>$submission->userid))) {
1785                     mtrace('Could not find user ' . $submission->userid);
1786                     continue;
1787                 }
1789                 // Use a cache to prevent the same DB queries happening over and over.
1790                 if (!array_key_exists($submission->course, $courses)) {
1791                     mtrace('Could not find course ' . $submission->course);
1792                     continue;
1793                 }
1794                 $course = $courses[$submission->course];
1795                 if (isset($course->ctxid)) {
1796                     // Context has not yet been preloaded. Do so now.
1797                     context_helper::preload_from_record($course);
1798                 }
1800                 // Override the language and timezone of the "current" user, so that
1801                 // mail is customised for the receiver.
1802                 cron_setup_user($user, $course);
1804                 // Context lookups are already cached.
1805                 $coursecontext = context_course::instance($course->id);
1806                 if (!is_enrolled($coursecontext, $user->id)) {
1807                     $courseshortname = format_string($course->shortname,
1808                                                      true,
1809                                                      array('context' => $coursecontext));
1810                     mtrace(fullname($user) . ' not an active participant in ' . $courseshortname);
1811                     continue;
1812                 }
1814                 if (!$grader = $DB->get_record('user', array('id'=>$submission->grader))) {
1815                     mtrace('Could not find grader ' . $submission->grader);
1816                     continue;
1817                 }
1819                 $modinfo = get_fast_modinfo($course, $user->id);
1820                 $cm = $modinfo->get_cm($submission->cmid);
1821                 // Context lookups are already cached.
1822                 $contextmodule = context_module::instance($cm->id);
1824                 if (!$cm->uservisible) {
1825                     // Hold mail notification for assignments the user cannot access until later.
1826                     continue;
1827                 }
1829                 // Need to send this to the student.
1830                 $messagetype = 'feedbackavailable';
1831                 $eventtype = 'assign_notification';
1832                 $updatetime = $submission->lastmodified;
1833                 $modulename = get_string('modulename', 'assign');
1835                 $uniqueid = 0;
1836                 if ($submission->blindmarking && !$submission->revealidentities) {
1837                     $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $user->id);
1838                 }
1839                 $showusers = $submission->blindmarking && !$submission->revealidentities;
1840                 self::send_assignment_notification($grader,
1841                                                    $user,
1842                                                    $messagetype,
1843                                                    $eventtype,
1844                                                    $updatetime,
1845                                                    $cm,
1846                                                    $contextmodule,
1847                                                    $course,
1848                                                    $modulename,
1849                                                    $submission->name,
1850                                                    $showusers,
1851                                                    $uniqueid);
1853                 $flags = $DB->get_record('assign_user_flags', array('userid'=>$user->id, 'assignment'=>$submission->assignment));
1854                 if ($flags) {
1855                     $flags->mailed = 1;
1856                     $DB->update_record('assign_user_flags', $flags);
1857                 } else {
1858                     $flags = new stdClass();
1859                     $flags->userid = $user->id;
1860                     $flags->assignment = $submission->assignment;
1861                     $flags->mailed = 1;
1862                     $DB->insert_record('assign_user_flags', $flags);
1863                 }
1865                 mtrace('Done');
1866             }
1867             mtrace('Done processing ' . count($submissions) . ' assignment submissions');
1869             cron_setup_user();
1871             // Free up memory just to be sure.
1872             unset($courses);
1873         }
1875         // Update calendar events to provide a description.
1876         $sql = 'SELECT id
1877                     FROM {assign}
1878                     WHERE
1879                         allowsubmissionsfromdate >= :lastcron AND
1880                         allowsubmissionsfromdate <= :timenow AND
1881                         alwaysshowdescription = 0';
1882         $params = array('lastcron' => $lastcron, 'timenow' => $timenow);
1883         $newlyavailable = $DB->get_records_sql($sql, $params);
1884         foreach ($newlyavailable as $record) {
1885             $cm = get_coursemodule_from_instance('assign', $record->id, 0, false, MUST_EXIST);
1886             $context = context_module::instance($cm->id);
1888             $assignment = new assign($context, null, null);
1889             $assignment->update_calendar($cm->id);
1890         }
1892         return true;
1893     }
1895     /**
1896      * Mark in the database that this grade record should have an update notification sent by cron.
1897      *
1898      * @param stdClass $grade a grade record keyed on id
1899      * @param bool $mailedoverride when true, flag notification to be sent again.
1900      * @return bool true for success
1901      */
1902     public function notify_grade_modified($grade, $mailedoverride = false) {
1903         global $DB;
1905         $flags = $this->get_user_flags($grade->userid, true);
1906         if ($flags->mailed != 1 || $mailedoverride) {
1907             $flags->mailed = 0;
1908         }
1910         return $this->update_user_flags($flags);
1911     }
1913     /**
1914      * Update user flags for this user in this assignment.
1915      *
1916      * @param stdClass $flags a flags record keyed on id
1917      * @return bool true for success
1918      */
1919     public function update_user_flags($flags) {
1920         global $DB;
1921         if ($flags->userid <= 0 || $flags->assignment <= 0 || $flags->id <= 0) {
1922             return false;
1923         }
1925         $result = $DB->update_record('assign_user_flags', $flags);
1926         return $result;
1927     }
1929     /**
1930      * Update a grade in the grade table for the assignment and in the gradebook.
1931      *
1932      * @param stdClass $grade a grade record keyed on id
1933      * @param bool $reopenattempt If the attempt reopen method is manual, allow another attempt at this assignment.
1934      * @return bool true for success
1935      */
1936     public function update_grade($grade, $reopenattempt = false) {
1937         global $DB;
1939         $grade->timemodified = time();
1941         if (!empty($grade->workflowstate)) {
1942             $validstates = $this->get_marking_workflow_states_for_current_user();
1943             if (!array_key_exists($grade->workflowstate, $validstates)) {
1944                 return false;
1945             }
1946         }
1948         if ($grade->grade && $grade->grade != -1) {
1949             if ($this->get_instance()->grade > 0) {
1950                 if (!is_numeric($grade->grade)) {
1951                     return false;
1952                 } else if ($grade->grade > $this->get_instance()->grade) {
1953                     return false;
1954                 } else if ($grade->grade < 0) {
1955                     return false;
1956                 }
1957             } else {
1958                 // This is a scale.
1959                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
1960                     $scaleoptions = make_menu_from_list($scale->scale);
1961                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
1962                         return false;
1963                     }
1964                 }
1965             }
1966         }
1968         if (empty($grade->attemptnumber)) {
1969             // Set it to the default.
1970             $grade->attemptnumber = 0;
1971         }
1972         $DB->update_record('assign_grades', $grade);
1974         $submission = null;
1975         if ($this->get_instance()->teamsubmission) {
1976             $submission = $this->get_group_submission($grade->userid, 0, false);
1977         } else {
1978             $submission = $this->get_user_submission($grade->userid, false);
1979         }
1981         // Only push to gradebook if the update is for the latest attempt.
1982         // Not the latest attempt.
1983         if ($submission && $submission->attemptnumber != $grade->attemptnumber) {
1984             return true;
1985         }
1987         if ($this->gradebook_item_update(null, $grade)) {
1988             \mod_assign\event\submission_graded::create_from_grade($this, $grade)->trigger();
1989         }
1991         // If the conditions are met, allow another attempt.
1992         if ($submission) {
1993             $this->reopen_submission_if_required($grade->userid,
1994                     $submission,
1995                     $reopenattempt);
1996         }
1998         return true;
1999     }
2001     /**
2002      * View the grant extension date page.
2003      *
2004      * Uses url parameters 'userid'
2005      * or from parameter 'selectedusers'
2006      *
2007      * @param moodleform $mform - Used for validation of the submitted data
2008      * @return string
2009      */
2010     protected function view_grant_extension($mform) {
2011         global $DB, $CFG;
2012         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
2014         $o = '';
2015         $batchusers = optional_param('selectedusers', '', PARAM_SEQUENCE);
2016         $data = new stdClass();
2017         $data->extensionduedate = null;
2018         $userid = 0;
2019         if (!$batchusers) {
2020             $userid = required_param('userid', PARAM_INT);
2022             $flags = $this->get_user_flags($userid, false);
2024             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
2026             if ($flags) {
2027                 $data->extensionduedate = $flags->extensionduedate;
2028             }
2029             $data->userid = $userid;
2030         } else {
2031             $data->batchusers = $batchusers;
2032         }
2033         $header = new assign_header($this->get_instance(),
2034                                     $this->get_context(),
2035                                     $this->show_intro(),
2036                                     $this->get_course_module()->id,
2037                                     get_string('grantextension', 'assign'));
2038         $o .= $this->get_renderer()->render($header);
2040         if (!$mform) {
2041             $formparams = array($this->get_course_module()->id,
2042                                 $userid,
2043                                 $batchusers,
2044                                 $this->get_instance(),
2045                                 $data);
2046             $mform = new mod_assign_extension_form(null, $formparams);
2047         }
2048         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
2049         $o .= $this->view_footer();
2050         return $o;
2051     }
2053     /**
2054      * Get a list of the users in the same group as this user.
2055      *
2056      * @param int $groupid The id of the group whose members we want or 0 for the default group
2057      * @param bool $onlyids Whether to retrieve only the user id's
2058      * @param bool $excludesuspended Whether to exclude suspended users
2059      * @return array The users (possibly id's only)
2060      */
2061     public function get_submission_group_members($groupid, $onlyids, $excludesuspended = false) {
2062         $members = array();
2063         if ($groupid != 0) {
2064             if ($onlyids) {
2065                 $allusers = groups_get_members($groupid, 'u.id');
2066             } else {
2067                 $allusers = groups_get_members($groupid);
2068             }
2069             foreach ($allusers as $user) {
2070                 if ($this->get_submission_group($user->id)) {
2071                     $members[] = $user;
2072                 }
2073             }
2074         } else {
2075             $allusers = $this->list_participants(null, $onlyids);
2076             foreach ($allusers as $user) {
2077                 if ($this->get_submission_group($user->id) == null) {
2078                     $members[] = $user;
2079                 }
2080             }
2081         }
2082         // Exclude suspended users, if user can't see them.
2083         if ($excludesuspended || !has_capability('moodle/course:viewsuspendedusers', $this->context)) {
2084             foreach ($members as $key => $member) {
2085                 if (!$this->is_active_user($member->id)) {
2086                     unset($members[$key]);
2087                 }
2088             }
2089         }
2091         return $members;
2092     }
2094     /**
2095      * Get a list of the users in the same group as this user that have not submitted the assignment.
2096      *
2097      * @param int $groupid The id of the group whose members we want or 0 for the default group
2098      * @param bool $onlyids Whether to retrieve only the user id's
2099      * @return array The users (possibly id's only)
2100      */
2101     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
2102         $instance = $this->get_instance();
2103         if (!$instance->teamsubmission || !$instance->requireallteammemberssubmit) {
2104             return array();
2105         }
2106         $members = $this->get_submission_group_members($groupid, $onlyids);
2108         foreach ($members as $id => $member) {
2109             $submission = $this->get_user_submission($member->id, false);
2110             if ($submission && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2111                 unset($members[$id]);
2112             } else {
2113                 if ($this->is_blind_marking()) {
2114                     $members[$id]->alias = get_string('hiddenuser', 'assign') .
2115                                            $this->get_uniqueid_for_user($id);
2116                 }
2117             }
2118         }
2119         return $members;
2120     }
2122     /**
2123      * Load the group submission object for a particular user, optionally creating it if required.
2124      *
2125      * @param int $userid The id of the user whose submission we want
2126      * @param int $groupid The id of the group for this user - may be 0 in which
2127      *                     case it is determined from the userid.
2128      * @param bool $create If set to true a new submission object will be created in the database
2129      *                     with the status set to "new".
2130      * @param int $attemptnumber - -1 means the latest attempt
2131      * @return stdClass The submission
2132      */
2133     public function get_group_submission($userid, $groupid, $create, $attemptnumber=-1) {
2134         global $DB;
2136         if ($groupid == 0) {
2137             $group = $this->get_submission_group($userid);
2138             if ($group) {
2139                 $groupid = $group->id;
2140             }
2141         }
2143         // Now get the group submission.
2144         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2145         if ($attemptnumber >= 0) {
2146             $params['attemptnumber'] = $attemptnumber;
2147         }
2149         // Only return the row with the highest attemptnumber.
2150         $submission = null;
2151         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2152         if ($submissions) {
2153             $submission = reset($submissions);
2154         }
2156         if ($submission) {
2157             return $submission;
2158         }
2159         if ($create) {
2160             $submission = new stdClass();
2161             $submission->assignment = $this->get_instance()->id;
2162             $submission->userid = 0;
2163             $submission->groupid = $groupid;
2164             $submission->timecreated = time();
2165             $submission->timemodified = $submission->timecreated;
2166             if ($attemptnumber >= 0) {
2167                 $submission->attemptnumber = $attemptnumber;
2168             } else {
2169                 $submission->attemptnumber = 0;
2170             }
2171             // Work out if this is the latest submission.
2172             $submission->latest = 0;
2173             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
2174             if ($attemptnumber == -1) {
2175                 // This is a new submission so it must be the latest.
2176                 $submission->latest = 1;
2177             } else {
2178                 // We need to work this out.
2179                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2180                 if ($result) {
2181                     $latestsubmission = reset($result);
2182                 }
2183                 if (!$latestsubmission || ($attemptnumber == $latestsubmission->attemptnumber)) {
2184                     $submission->latest = 1;
2185                 }
2186             }
2187             if ($submission->latest) {
2188                 // This is the case when we need to set latest to 0 for all the other attempts.
2189                 $DB->set_field('assign_submission', 'latest', 0, $params);
2190             }
2191             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2192             $sid = $DB->insert_record('assign_submission', $submission);
2193             return $DB->get_record('assign_submission', array('id' => $sid));
2194         }
2195         return false;
2196     }
2198     /**
2199      * View a summary listing of all assignments in the current course.
2200      *
2201      * @return string
2202      */
2203     private function view_course_index() {
2204         global $USER;
2206         $o = '';
2208         $course = $this->get_course();
2209         $strplural = get_string('modulenameplural', 'assign');
2211         if (!$cms = get_coursemodules_in_course('assign', $course->id, 'm.duedate')) {
2212             $o .= $this->get_renderer()->notification(get_string('thereareno', 'moodle', $strplural));
2213             $o .= $this->get_renderer()->continue_button(new moodle_url('/course/view.php', array('id' => $course->id)));
2214             return $o;
2215         }
2217         $strsectionname = '';
2218         $usesections = course_format_uses_sections($course->format);
2219         $modinfo = get_fast_modinfo($course);
2221         if ($usesections) {
2222             $strsectionname = get_string('sectionname', 'format_'.$course->format);
2223             $sections = $modinfo->get_section_info_all();
2224         }
2225         $courseindexsummary = new assign_course_index_summary($usesections, $strsectionname);
2227         $timenow = time();
2229         $currentsection = '';
2230         foreach ($modinfo->instances['assign'] as $cm) {
2231             if (!$cm->uservisible) {
2232                 continue;
2233             }
2235             $timedue = $cms[$cm->id]->duedate;
2237             $sectionname = '';
2238             if ($usesections && $cm->sectionnum) {
2239                 $sectionname = get_section_name($course, $sections[$cm->sectionnum]);
2240             }
2242             $submitted = '';
2243             $context = context_module::instance($cm->id);
2245             $assignment = new assign($context, $cm, $course);
2247             if (has_capability('mod/assign:grade', $context)) {
2248                 $submitted = $assignment->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED);
2250             } else if (has_capability('mod/assign:submit', $context)) {
2251                 $usersubmission = $assignment->get_user_submission($USER->id, false);
2253                 if (!empty($usersubmission->status)) {
2254                     $submitted = get_string('submissionstatus_' . $usersubmission->status, 'assign');
2255                 } else {
2256                     $submitted = get_string('submissionstatus_', 'assign');
2257                 }
2258             }
2259             $gradinginfo = grade_get_grades($course->id, 'mod', 'assign', $cm->instance, $USER->id);
2260             if (isset($gradinginfo->items[0]->grades[$USER->id]) &&
2261                     !$gradinginfo->items[0]->grades[$USER->id]->hidden ) {
2262                 $grade = $gradinginfo->items[0]->grades[$USER->id]->str_grade;
2263             } else {
2264                 $grade = '-';
2265             }
2267             $courseindexsummary->add_assign_info($cm->id, $cm->name, $sectionname, $timedue, $submitted, $grade);
2269         }
2271         $o .= $this->get_renderer()->render($courseindexsummary);
2272         $o .= $this->view_footer();
2274         return $o;
2275     }
2277     /**
2278      * View a page rendered by a plugin.
2279      *
2280      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.
2281      *
2282      * @return string
2283      */
2284     protected function view_plugin_page() {
2285         global $USER;
2287         $o = '';
2289         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
2290         $plugintype = required_param('plugin', PARAM_TEXT);
2291         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
2293         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
2294         if (!$plugin) {
2295             print_error('invalidformdata', '');
2296             return;
2297         }
2299         $o .= $plugin->view_page($pluginaction);
2301         return $o;
2302     }
2305     /**
2306      * This is used for team assignments to get the group for the specified user.
2307      * If the user is a member of multiple or no groups this will return false
2308      *
2309      * @param int $userid The id of the user whose submission we want
2310      * @return mixed The group or false
2311      */
2312     public function get_submission_group($userid) {
2314         if (isset($this->usersubmissiongroups[$userid])) {
2315             return $this->usersubmissiongroups[$userid];
2316         }
2318         $groups = $this->get_all_groups($userid);
2319         if (count($groups) != 1) {
2320             $return = false;
2321         } else {
2322             $return = array_pop($groups);
2323         }
2325         // Cache the user submission group.
2326         $this->usersubmissiongroups[$userid] = $return;
2328         return $return;
2329     }
2331     /**
2332      * Gets all groups the user is a member of.
2333      *
2334      * @param int $userid Teh id of the user who's groups we are checking
2335      * @return array The group objects
2336      */
2337     public function get_all_groups($userid) {
2338         if (isset($this->usergroups[$userid])) {
2339             return $this->usergroups[$userid];
2340         }
2342         $grouping = $this->get_instance()->teamsubmissiongroupingid;
2343         $return = groups_get_all_groups($this->get_course()->id, $userid, $grouping);
2345         $this->usergroups[$userid] = $return;
2347         return $return;
2348     }
2351     /**
2352      * Display the submission that is used by a plugin.
2353      *
2354      * Uses url parameters 'sid', 'gid' and 'plugin'.
2355      *
2356      * @param string $pluginsubtype
2357      * @return string
2358      */
2359     protected function view_plugin_content($pluginsubtype) {
2360         $o = '';
2362         $submissionid = optional_param('sid', 0, PARAM_INT);
2363         $gradeid = optional_param('gid', 0, PARAM_INT);
2364         $plugintype = required_param('plugin', PARAM_TEXT);
2365         $item = null;
2366         if ($pluginsubtype == 'assignsubmission') {
2367             $plugin = $this->get_submission_plugin_by_type($plugintype);
2368             if ($submissionid <= 0) {
2369                 throw new coding_exception('Submission id should not be 0');
2370             }
2371             $item = $this->get_submission($submissionid);
2373             // Check permissions.
2374             $this->require_view_submission($item->userid);
2375             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2376                                                               $this->get_context(),
2377                                                               $this->show_intro(),
2378                                                               $this->get_course_module()->id,
2379                                                               $plugin->get_name()));
2380             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
2381                                                               $item,
2382                                                               assign_submission_plugin_submission::FULL,
2383                                                               $this->get_course_module()->id,
2384                                                               $this->get_return_action(),
2385                                                               $this->get_return_params()));
2387             // Trigger event for viewing a submission.
2388             \mod_assign\event\submission_viewed::create_from_submission($this, $item)->trigger();
2390         } else {
2391             $plugin = $this->get_feedback_plugin_by_type($plugintype);
2392             if ($gradeid <= 0) {
2393                 throw new coding_exception('Grade id should not be 0');
2394             }
2395             $item = $this->get_grade($gradeid);
2396             // Check permissions.
2397             $this->require_view_submission($item->userid);
2398             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2399                                                               $this->get_context(),
2400                                                               $this->show_intro(),
2401                                                               $this->get_course_module()->id,
2402                                                               $plugin->get_name()));
2403             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
2404                                                               $item,
2405                                                               assign_feedback_plugin_feedback::FULL,
2406                                                               $this->get_course_module()->id,
2407                                                               $this->get_return_action(),
2408                                                               $this->get_return_params()));
2410             // Trigger event for viewing feedback.
2411             \mod_assign\event\feedback_viewed::create_from_grade($this, $item)->trigger();
2412         }
2414         $o .= $this->view_return_links();
2416         $o .= $this->view_footer();
2418         return $o;
2419     }
2421     /**
2422      * Rewrite plugin file urls so they resolve correctly in an exported zip.
2423      *
2424      * @param string $text - The replacement text
2425      * @param stdClass $user - The user record
2426      * @param assign_plugin $plugin - The assignment plugin
2427      */
2428     public function download_rewrite_pluginfile_urls($text, $user, $plugin) {
2429         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2430         $groupname = '';
2431         if ($groupmode) {
2432             $groupid = groups_get_activity_group($this->get_course_module(), true);
2433             $groupname = groups_get_group_name($groupid).'-';
2434         }
2436         if ($this->is_blind_marking()) {
2437             $prefix = $groupname . get_string('participant', 'assign');
2438             $prefix = str_replace('_', ' ', $prefix);
2439             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2440         } else {
2441             $prefix = $groupname . fullname($user);
2442             $prefix = str_replace('_', ' ', $prefix);
2443             $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($user->id) . '_');
2444         }
2446         $subtype = $plugin->get_subtype();
2447         $type = $plugin->get_type();
2448         $prefix = $prefix . $subtype . '_' . $type . '_';
2450         $result = str_replace('@@PLUGINFILE@@/', $prefix, $text);
2452         return $result;
2453     }
2455     /**
2456      * Render the content in editor that is often used by plugin.
2457      *
2458      * @param string $filearea
2459      * @param int  $submissionid
2460      * @param string $plugintype
2461      * @param string $editor
2462      * @param string $component
2463      * @return string
2464      */
2465     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
2466         global $CFG;
2468         $result = '';
2470         $plugin = $this->get_submission_plugin_by_type($plugintype);
2472         $text = $plugin->get_editor_text($editor, $submissionid);
2473         $format = $plugin->get_editor_format($editor, $submissionid);
2475         $finaltext = file_rewrite_pluginfile_urls($text,
2476                                                   'pluginfile.php',
2477                                                   $this->get_context()->id,
2478                                                   $component,
2479                                                   $filearea,
2480                                                   $submissionid);
2481         $params = array('overflowdiv' => true, 'context' => $this->get_context());
2482         $result .= format_text($finaltext, $format, $params);
2484         if ($CFG->enableportfolios && has_capability('mod/assign:exportownsubmission', $this->context)) {
2485             require_once($CFG->libdir . '/portfoliolib.php');
2487             $button = new portfolio_add_button();
2488             $portfolioparams = array('cmid' => $this->get_course_module()->id,
2489                                      'sid' => $submissionid,
2490                                      'plugin' => $plugintype,
2491                                      'editor' => $editor,
2492                                      'area'=>$filearea);
2493             $button->set_callback_options('assign_portfolio_caller', $portfolioparams, 'mod_assign');
2494             $fs = get_file_storage();
2496             if ($files = $fs->get_area_files($this->context->id,
2497                                              $component,
2498                                              $filearea,
2499                                              $submissionid,
2500                                              'timemodified',
2501                                              false)) {
2502                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
2503             } else {
2504                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
2505             }
2506             $result .= $button->to_html();
2507         }
2508         return $result;
2509     }
2511     /**
2512      * Display a continue page after grading.
2513      *
2514      * @param string $message - The message to display.
2515      * @return string
2516      */
2517     protected function view_savegrading_result($message) {
2518         $o = '';
2519         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2520                                                       $this->get_context(),
2521                                                       $this->show_intro(),
2522                                                       $this->get_course_module()->id,
2523                                                       get_string('savegradingresult', 'assign')));
2524         $gradingresult = new assign_gradingmessage(get_string('savegradingresult', 'assign'),
2525                                                    $message,
2526                                                    $this->get_course_module()->id);
2527         $o .= $this->get_renderer()->render($gradingresult);
2528         $o .= $this->view_footer();
2529         return $o;
2530     }
2531     /**
2532      * Display a continue page after quickgrading.
2533      *
2534      * @param string $message - The message to display.
2535      * @return string
2536      */
2537     protected function view_quickgrading_result($message) {
2538         $o = '';
2539         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2540                                                       $this->get_context(),
2541                                                       $this->show_intro(),
2542                                                       $this->get_course_module()->id,
2543                                                       get_string('quickgradingresult', 'assign')));
2544         $lastpage = optional_param('lastpage', null, PARAM_INT);
2545         $gradingresult = new assign_gradingmessage(get_string('quickgradingresult', 'assign'),
2546                                                    $message,
2547                                                    $this->get_course_module()->id,
2548                                                    false,
2549                                                    $lastpage);
2550         $o .= $this->get_renderer()->render($gradingresult);
2551         $o .= $this->view_footer();
2552         return $o;
2553     }
2555     /**
2556      * Display the page footer.
2557      *
2558      * @return string
2559      */
2560     protected function view_footer() {
2561         // When viewing the footer during PHPUNIT tests a set_state error is thrown.
2562         if (!PHPUNIT_TEST) {
2563             return $this->get_renderer()->render_footer();
2564         }
2566         return '';
2567     }
2569     /**
2570      * Throw an error if the permissions to view this users submission are missing.
2571      *
2572      * @throws required_capability_exception
2573      * @return none
2574      */
2575     public function require_view_submission($userid) {
2576         if (!$this->can_view_submission($userid)) {
2577             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
2578         }
2579     }
2581     /**
2582      * Throw an error if the permissions to view grades in this assignment are missing.
2583      *
2584      * @throws required_capability_exception
2585      * @return none
2586      */
2587     public function require_view_grades() {
2588         if (!$this->can_view_grades()) {
2589             throw new required_capability_exception($this->context, 'mod/assign:viewgrades', 'nopermission', '');
2590         }
2591     }
2593     /**
2594      * Does this user have view grade or grade permission for this assignment?
2595      *
2596      * @return bool
2597      */
2598     public function can_view_grades() {
2599         // Permissions check.
2600         if (!has_any_capability(array('mod/assign:viewgrades', 'mod/assign:grade'), $this->context)) {
2601             return false;
2602         }
2604         return true;
2605     }
2607     /**
2608      * Does this user have grade permission for this assignment?
2609      *
2610      * @return bool
2611      */
2612     public function can_grade() {
2613         // Permissions check.
2614         if (!has_capability('mod/assign:grade', $this->context)) {
2615             return false;
2616         }
2618         return true;
2619     }
2621     /**
2622      * Download a zip file of all assignment submissions.
2623      *
2624      * @return string - If an error occurs, this will contain the error page.
2625      */
2626     protected function download_submissions() {
2627         global $CFG, $DB;
2629         // More efficient to load this here.
2630         require_once($CFG->libdir.'/filelib.php');
2632         // Increase the server timeout to handle the creation and sending of large zip files.
2633         core_php_time_limit::raise();
2635         $this->require_view_grades();
2637         // Load all users with submit.
2638         $students = get_enrolled_users($this->context, "mod/assign:submit", null, 'u.*', null, null, null,
2639                         $this->show_only_active_users());
2641         // Build a list of files to zip.
2642         $filesforzipping = array();
2643         $fs = get_file_storage();
2645         $groupmode = groups_get_activity_groupmode($this->get_course_module());
2646         // All users.
2647         $groupid = 0;
2648         $groupname = '';
2649         if ($groupmode) {
2650             $groupid = groups_get_activity_group($this->get_course_module(), true);
2651             $groupname = groups_get_group_name($groupid).'-';
2652         }
2654         // Construct the zip file name.
2655         $filename = clean_filename($this->get_course()->shortname . '-' .
2656                                    $this->get_instance()->name . '-' .
2657                                    $groupname.$this->get_course_module()->id . '.zip');
2659         // Get all the files for each student.
2660         foreach ($students as $student) {
2661             $userid = $student->id;
2663             if ((groups_is_member($groupid, $userid) or !$groupmode or !$groupid)) {
2664                 // Get the plugins to add their own files to the zip.
2666                 $submissiongroup = false;
2667                 $groupname = '';
2668                 if ($this->get_instance()->teamsubmission) {
2669                     $submission = $this->get_group_submission($userid, 0, false);
2670                     $submissiongroup = $this->get_submission_group($userid);
2671                     if ($submissiongroup) {
2672                         $groupname = $submissiongroup->name . '-';
2673                     } else {
2674                         $groupname = get_string('defaultteam', 'assign') . '-';
2675                     }
2676                 } else {
2677                     $submission = $this->get_user_submission($userid, false);
2678                 }
2680                 if ($this->is_blind_marking()) {
2681                     $prefix = str_replace('_', ' ', $groupname . get_string('participant', 'assign'));
2682                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid) . '_');
2683                 } else {
2684                     $prefix = str_replace('_', ' ', $groupname . fullname($student));
2685                     $prefix = clean_filename($prefix . '_' . $this->get_uniqueid_for_user($userid) . '_');
2686                 }
2688                 if ($submission) {
2689                     foreach ($this->submissionplugins as $plugin) {
2690                         if ($plugin->is_enabled() && $plugin->is_visible()) {
2691                             $pluginfiles = $plugin->get_files($submission, $student);
2692                             foreach ($pluginfiles as $zipfilename => $file) {
2693                                 $subtype = $plugin->get_subtype();
2694                                 $type = $plugin->get_type();
2695                                 $prefixedfilename = clean_filename($prefix .
2696                                                                    $subtype .
2697                                                                    '_' .
2698                                                                    $type .
2699                                                                    '_' .
2700                                                                    $zipfilename);
2701                                 $filesforzipping[$prefixedfilename] = $file;
2702                             }
2703                         }
2704                     }
2705                 }
2706             }
2707         }
2708         $result = '';
2709         if (count($filesforzipping) == 0) {
2710             $header = new assign_header($this->get_instance(),
2711                                         $this->get_context(),
2712                                         '',
2713                                         $this->get_course_module()->id,
2714                                         get_string('downloadall', 'assign'));
2715             $result .= $this->get_renderer()->render($header);
2716             $result .= $this->get_renderer()->notification(get_string('nosubmission', 'assign'));
2717             $url = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
2718                                                                     'action'=>'grading'));
2719             $result .= $this->get_renderer()->continue_button($url);
2720             $result .= $this->view_footer();
2721         } else if ($zipfile = $this->pack_files($filesforzipping)) {
2722             \mod_assign\event\all_submissions_downloaded::create_from_assign($this)->trigger();
2723             // Send file and delete after sending.
2724             send_temp_file($zipfile, $filename);
2725             // We will not get here - send_temp_file calls exit.
2726         }
2727         return $result;
2728     }
2730     /**
2731      * Util function to add a message to the log.
2732      *
2733      * @deprecated since 2.7 - Use new events system instead.
2734      *             (see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins).
2735      *
2736      * @param string $action The current action
2737      * @param string $info A detailed description of the change. But no more than 255 characters.
2738      * @param string $url The url to the assign module instance.
2739      * @param bool $return If true, returns the arguments, else adds to log. The purpose of this is to
2740      *                     retrieve the arguments to use them with the new event system (Event 2).
2741      * @return void|array
2742      */
2743     public function add_to_log($action = '', $info = '', $url='', $return = false) {
2744         global $USER;
2746         $fullurl = 'view.php?id=' . $this->get_course_module()->id;
2747         if ($url != '') {
2748             $fullurl .= '&' . $url;
2749         }
2751         $args = array(
2752             $this->get_course()->id,
2753             'assign',
2754             $action,
2755             $fullurl,
2756             $info,
2757             $this->get_course_module()->id
2758         );
2760         if ($return) {
2761             // We only need to call debugging when returning a value. This is because the call to
2762             // call_user_func_array('add_to_log', $args) will trigger a debugging message of it's own.
2763             debugging('The mod_assign add_to_log() function is now deprecated.', DEBUG_DEVELOPER);
2764             return $args;
2765         }
2766         call_user_func_array('add_to_log', $args);
2767     }
2769     /**
2770      * Lazy load the page renderer and expose the renderer to plugins.
2771      *
2772      * @return assign_renderer
2773      */
2774     public function get_renderer() {
2775         global $PAGE;
2776         if ($this->output) {
2777             return $this->output;
2778         }
2779         $this->output = $PAGE->get_renderer('mod_assign');
2780         return $this->output;
2781     }
2783     /**
2784      * Load the submission object for a particular user, optionally creating it if required.
2785      *
2786      * For team assignments there are 2 submissions - the student submission and the team submission
2787      * All files are associated with the team submission but the status of the students contribution is
2788      * recorded separately.
2789      *
2790      * @param int $userid The id of the user whose submission we want or 0 in which case USER->id is used
2791      * @param bool $create optional - defaults to false. If set to true a new submission object
2792      *                     will be created in the database with the status set to "new".
2793      * @param int $attemptnumber - -1 means the latest attempt
2794      * @return stdClass The submission
2795      */
2796     public function get_user_submission($userid, $create, $attemptnumber=-1) {
2797         global $DB, $USER;
2799         if (!$userid) {
2800             $userid = $USER->id;
2801         }
2802         // If the userid is not null then use userid.
2803         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
2804         if ($attemptnumber >= 0) {
2805             $params['attemptnumber'] = $attemptnumber;
2806         }
2808         // Only return the row with the highest attemptnumber.
2809         $submission = null;
2810         $submissions = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', '*', 0, 1);
2811         if ($submissions) {
2812             $submission = reset($submissions);
2813         }
2815         if ($submission) {
2816             return $submission;
2817         }
2818         if ($create) {
2819             $submission = new stdClass();
2820             $submission->assignment   = $this->get_instance()->id;
2821             $submission->userid       = $userid;
2822             $submission->timecreated = time();
2823             $submission->timemodified = $submission->timecreated;
2824             $submission->status = ASSIGN_SUBMISSION_STATUS_NEW;
2825             if ($attemptnumber >= 0) {
2826                 $submission->attemptnumber = $attemptnumber;
2827             } else {
2828                 $submission->attemptnumber = 0;
2829             }
2830             // Work out if this is the latest submission.
2831             $submission->latest = 0;
2832             $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
2833             if ($attemptnumber == -1) {
2834                 // This is a new submission so it must be the latest.
2835                 $submission->latest = 1;
2836             } else {
2837                 // We need to work this out.
2838                 $result = $DB->get_records('assign_submission', $params, 'attemptnumber DESC', 'attemptnumber', 0, 1);
2839                 $latestsubmission = null;
2840                 if ($result) {
2841                     $latestsubmission = reset($result);
2842                 }
2843                 if (empty($latestsubmission) || ($attemptnumber > $latestsubmission->attemptnumber)) {
2844                     $submission->latest = 1;
2845                 }
2846             }
2847             if ($submission->latest) {
2848                 // This is the case when we need to set latest to 0 for all the other attempts.
2849                 $DB->set_field('assign_submission', 'latest', 0, $params);
2850             }
2851             $sid = $DB->insert_record('assign_submission', $submission);
2852             return $DB->get_record('assign_submission', array('id' => $sid));
2853         }
2854         return false;
2855     }
2857     /**
2858      * Load the submission object from it's id.
2859      *
2860      * @param int $submissionid The id of the submission we want
2861      * @return stdClass The submission
2862      */
2863     protected function get_submission($submissionid) {
2864         global $DB;
2866         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$submissionid);
2867         return $DB->get_record('assign_submission', $params, '*', MUST_EXIST);
2868     }
2870     /**
2871      * This will retrieve a user flags object from the db optionally creating it if required.
2872      * The user flags was split from the user_grades table in 2.5.
2873      *
2874      * @param int $userid The user we are getting the flags for.
2875      * @param bool $create If true the flags record will be created if it does not exist
2876      * @return stdClass The flags record
2877      */
2878     public function get_user_flags($userid, $create) {
2879         global $DB, $USER;
2881         // If the userid is not null then use userid.
2882         if (!$userid) {
2883             $userid = $USER->id;
2884         }
2886         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
2888         $flags = $DB->get_record('assign_user_flags', $params);
2890         if ($flags) {
2891             return $flags;
2892         }
2893         if ($create) {
2894             $flags = new stdClass();
2895             $flags->assignment = $this->get_instance()->id;
2896             $flags->userid = $userid;
2897             $flags->locked = 0;
2898             $flags->extensionduedate = 0;
2899             $flags->workflowstate = '';
2900             $flags->allocatedmarker = 0;
2902             // The mailed flag can be one of 3 values: 0 is unsent, 1 is sent and 2 is do not send yet.
2903             // This is because students only want to be notified about certain types of update (grades and feedback).
2904             $flags->mailed = 2;
2906             $fid = $DB->insert_record('assign_user_flags', $flags);
2907             $flags->id = $fid;
2908             return $flags;
2909         }
2910         return false;
2911     }
2913     /**
2914      * This will retrieve a grade object from the db, optionally creating it if required.
2915      *
2916      * @param int $userid The user we are grading
2917      * @param bool $create If true the grade will be created if it does not exist
2918      * @param int $attemptnumber The attempt number to retrieve the grade for. -1 means the latest submission.
2919      * @return stdClass The grade record
2920      */
2921     public function get_user_grade($userid, $create, $attemptnumber=-1) {
2922         global $DB, $USER;
2924         // If the userid is not null then use userid.
2925         if (!$userid) {
2926             $userid = $USER->id;
2927         }
2928         $submission = null;
2930         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid);
2931         if ($attemptnumber < 0 || $create) {
2932             // Make sure this grade matches the latest submission attempt.
2933             if ($this->get_instance()->teamsubmission) {
2934                 $submission = $this->get_group_submission($userid, 0, true);
2935             } else {
2936                 $submission = $this->get_user_submission($userid, true);
2937             }
2938             if ($submission) {
2939                 $attemptnumber = $submission->attemptnumber;
2940             }
2941         }
2943         if ($attemptnumber >= 0) {
2944             $params['attemptnumber'] = $attemptnumber;
2945         }
2947         $grades = $DB->get_records('assign_grades', $params, 'attemptnumber DESC', '*', 0, 1);
2949         if ($grades) {
2950             return reset($grades);
2951         }
2952         if ($create) {
2953             $grade = new stdClass();
2954             $grade->assignment   = $this->get_instance()->id;
2955             $grade->userid       = $userid;
2956             $grade->timecreated = time();
2957             // If we are "auto-creating" a grade - and there is a submission
2958             // the new grade should not have a more recent timemodified value
2959             // than the submission.
2960             if ($submission) {
2961                 $grade->timemodified = $submission->timemodified;
2962             } else {
2963                 $grade->timemodified = $grade->timecreated;
2964             }
2965             $grade->grade = -1;
2966             $grade->grader = $USER->id;
2967             if ($attemptnumber >= 0) {
2968                 $grade->attemptnumber = $attemptnumber;
2969             }
2971             $gid = $DB->insert_record('assign_grades', $grade);
2972             $grade->id = $gid;
2973             return $grade;
2974         }
2975         return false;
2976     }
2978     /**
2979      * This will retrieve a grade object from the db.
2980      *
2981      * @param int $gradeid The id of the grade
2982      * @return stdClass The grade record
2983      */
2984     protected function get_grade($gradeid) {
2985         global $DB;
2987         $params = array('assignment'=>$this->get_instance()->id, 'id'=>$gradeid);
2988         return $DB->get_record('assign_grades', $params, '*', MUST_EXIST);
2989     }
2991     /**
2992      * Print the grading page for a single user submission.
2993      *
2994      * @param moodleform $mform
2995      * @return string
2996      */
2997     protected function view_single_grade_page($mform) {
2998         global $DB, $CFG;
3000         $o = '';
3001         $instance = $this->get_instance();
3003         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
3005         // Need submit permission to submit an assignment.
3006         require_capability('mod/assign:grade', $this->context);
3008         $header = new assign_header($instance,
3009                                     $this->get_context(),
3010                                     false,
3011                                     $this->get_course_module()->id,
3012                                     get_string('grading', 'assign'));
3013         $o .= $this->get_renderer()->render($header);
3015         // If userid is passed - we are only grading a single student.
3016         $rownum = required_param('rownum', PARAM_INT);
3017         $useridlistid = optional_param('useridlistid', $this->get_useridlist_key_id(), PARAM_ALPHANUM);
3018         $userid = optional_param('userid', 0, PARAM_INT);
3019         $attemptnumber = optional_param('attemptnumber', -1, PARAM_INT);
3021         $cache = cache::make_from_params(cache_store::MODE_SESSION, 'mod_assign', 'useridlist');
3022         if (!$userid) {
3023             if (!$useridlist = $cache->get($this->get_useridlist_key($useridlistid))) {
3024                 $useridlist = $this->get_grading_userid_list();
3025             }
3026             $cache->set($this->get_useridlist_key($useridlistid), $useridlist);
3027         } else {
3028             $rownum = 0;
3029             $useridlist = array($userid);
3030         }
3032         if ($rownum < 0 || $rownum > count($useridlist)) {
3033             throw new coding_exception('Row is out of bounds for the current grading table: ' . $rownum);
3034         }
3036         $last = false;
3037         $userid = $useridlist[$rownum];
3038         if ($rownum == count($useridlist) - 1) {
3039             $last = true;
3040         }
3041         // This variation on the url will link direct to this student, with no next/previous links.
3042         // The benefit is the url will be the same every time for this student, so Atto autosave drafts can match up.
3043         $returnparams = array('userid' => $userid, 'rownum' => 0, 'useridlistid' => 0);
3044         $this->register_return_link('grade', $returnparams);
3046         $user = $DB->get_record('user', array('id' => $userid));
3047         if ($user) {
3048             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
3049             $usersummary = new assign_user_summary($user,
3050                                                    $this->get_course()->id,
3051                                                    $viewfullnames,
3052                                                    $this->is_blind_marking(),
3053                                                    $this->get_uniqueid_for_user($user->id),
3054                                                    get_extra_user_fields($this->get_context()),
3055                                                    !$this->is_active_user($userid));
3056             $o .= $this->get_renderer()->render($usersummary);
3057         }
3058         $submission = $this->get_user_submission($userid, false, $attemptnumber);
3059         $submissiongroup = null;
3060         $teamsubmission = null;
3061         $notsubmitted = array();
3062         if ($instance->teamsubmission) {
3063             $teamsubmission = $this->get_group_submission($userid, 0, false, $attemptnumber);
3064             $submissiongroup = $this->get_submission_group($userid);
3065             $groupid = 0;
3066             if ($submissiongroup) {
3067                 $groupid = $submissiongroup->id;
3068             }
3069             $notsubmitted = $this->get_submission_group_members_who_have_not_submitted($groupid, false);
3071         }
3073         // Get the requested grade.
3074         $grade = $this->get_user_grade($userid, false, $attemptnumber);
3075         $flags = $this->get_user_flags($userid, false);
3076         if ($this->can_view_submission($userid)) {
3077             $gradelocked = ($flags && $flags->locked) || $this->grading_disabled($userid);
3078             $extensionduedate = null;
3079             if ($flags) {
3080                 $extensionduedate = $flags->extensionduedate;
3081             }
3082             $showedit = $this->submissions_open($userid) && ($this->is_any_submission_plugin_enabled());
3083             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
3084             $usergroups = $this->get_all_groups($user->id);
3086             $submissionstatus = new assign_submission_status($instance->allowsubmissionsfromdate,
3087                                                              $instance->alwaysshowdescription,
3088                                                              $submission,
3089                                                              $instance->teamsubmission,
3090                                                              $teamsubmission,
3091                                                              $submissiongroup,
3092                                                              $notsubmitted,
3093                                                              $this->is_any_submission_plugin_enabled(),
3094                                                              $gradelocked,
3095                                                              $this->is_graded($userid),
3096                                                              $instance->duedate,
3097                                                              $instance->cutoffdate,
3098                                                              $this->get_submission_plugins(),
3099                                                              $this->get_return_action(),
3100                                                              $this->get_return_params(),
3101                                                              $this->get_course_module()->id,
3102                                                              $this->get_course()->id,
3103                                                              assign_submission_status::GRADER_VIEW,
3104                                                              $showedit,
3105                                                              false,
3106                                                              $viewfullnames,
3107                                                              $extensionduedate,
3108                                                              $this->get_context(),
3109                                                              $this->is_blind_marking(),
3110                                                              '',
3111                                                              $instance->attemptreopenmethod,
3112                                                              $instance->maxattempts,
3113                                                              $this->get_grading_status($userid),
3114                                                              $instance->preventsubmissionnotingroup,
3115                                                              $usergroups);
3116             $o .= $this->get_renderer()->render($submissionstatus);
3117         }
3119         if ($grade) {
3120             $data = new stdClass();
3121             if ($grade->grade !== null && $grade->grade >= 0) {
3122                 $data->grade = format_float($grade->grade, 2);
3123             }
3124         } else {
3125             $data = new stdClass();
3126             $data->grade = '';
3127         }
3129         if (!empty($flags->workflowstate)) {
3130             $data->workflowstate = $flags->workflowstate;
3131         }
3132         if (!empty($flags->allocatedmarker)) {
3133             $data->allocatedmarker = $flags->allocatedmarker;
3134         }
3136         // Warning if required.
3137         $allsubmissions = $this->get_all_submissions($userid);
3139         if ($attemptnumber != -1) {
3140             $params = array('attemptnumber'=>$attemptnumber + 1,
3141                             'totalattempts'=>count($allsubmissions));
3142             $message = get_string('editingpreviousfeedbackwarning', 'assign', $params);
3143             $o .= $this->get_renderer()->notification($message);
3144         }
3146         // Now show the grading form.
3147         if (!$mform) {
3148             $pagination = array('rownum'=>$rownum,
3149                                 'useridlistid'=>$useridlistid,
3150                                 'last'=>$last,
3151                                 'userid'=>optional_param('userid', 0, PARAM_INT),
3152                                 'attemptnumber'=>$attemptnumber);
3153             $formparams = array($this, $data, $pagination);
3154             $mform = new mod_assign_grade_form(null,
3155                                                $formparams,
3156                                                'post',
3157                                                '',
3158                                                array('class'=>'gradeform'));
3159         }
3160         $o .= $this->get_renderer()->heading(get_string('grade'), 3);
3161         $o .= $this->get_renderer()->render(new assign_form('gradingform', $mform));
3163         if (count($allsubmissions) > 1 && $attemptnumber == -1) {
3164             $allgrades = $this->get_all_grades($userid);
3165             $history = new assign_attempt_history($allsubmissions,
3166                                                   $allgrades,
3167                                                   $this->get_submission_plugins(),
3168                                                   $this->get_feedback_plugins(),
3169                                                   $this->get_course_module()->id,
3170                                                   $this->get_return_action(),
3171                                                   $this->get_return_params(),
3172                                                   true,
3173                                                   $useridlistid,
3174                                                   $rownum);
3176             $o .= $this->get_renderer()->render($history);
3177         }
3179         \mod_assign\event\grading_form_viewed::create_from_user($this, $user)->trigger();
3181         $o .= $this->view_footer();
3182         return $o;
3183     }
3185     /**
3186      * Show a confirmation page to make sure they want to release student identities.
3187      *
3188      * @return string
3189      */
3190     protected function view_reveal_identities_confirm() {
3191         require_capability('mod/assign:revealidentities', $this->get_context());
3193         $o = '';
3194         $header = new assign_header($this->get_instance(),
3195                                     $this->get_context(),
3196                                     false,
3197                                     $this->get_course_module()->id);
3198         $o .= $this->get_renderer()->render($header);
3200         $urlparams = array('id'=>$this->get_course_module()->id,
3201                            'action'=>'revealidentitiesconfirm',
3202                            'sesskey'=>sesskey());
3203         $confirmurl = new moodle_url('/mod/assign/view.php', $urlparams);
3205         $urlparams = array('id'=>$this->get_course_module()->id,
3206                            'action'=>'grading');
3207         $cancelurl = new moodle_url('/mod/assign/view.php', $urlparams);
3209         $o .= $this->get_renderer()->confirm(get_string('revealidentitiesconfirm', 'assign'),
3210                                              $confirmurl,
3211                                              $cancelurl);
3212         $o .= $this->view_footer();
3214         \mod_assign\event\reveal_identities_confirmation_page_viewed::create_from_assign($this)->trigger();
3216         return $o;
3217     }
3219     /**
3220      * View a link to go back to the previous page. Uses url parameters returnaction and returnparams.
3221      *
3222      * @return string
3223      */
3224     protected function view_return_links() {
3225         $returnaction = optional_param('returnaction', '', PARAM_ALPHA);
3226         $returnparams = optional_param('returnparams', '', PARAM_TEXT);
3228         $params = array();
3229         $returnparams = str_replace('&amp;', '&', $returnparams);
3230         parse_str($returnparams, $params);
3231         $newparams = array('id' => $this->get_course_module()->id, 'action' => $returnaction);
3232         $params = array_merge($newparams, $params);
3234         $url = new moodle_url('/mod/assign/view.php', $params);
3235         return $this->get_renderer()->single_button($url, get_string('back'), 'get');
3236     }
3238     /**
3239      * View the grading table of all submissions for this assignment.
3240      *
3241      * @return string
3242      */
3243     protected function view_grading_table() {
3244         global $USER, $CFG;
3246         // Include grading options form.
3247         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
3248         require_once($CFG->dirroot . '/mod/assign/quickgradingform.php');
3249         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
3250         $o = '';
3251         $cmid = $this->get_course_module()->id;
3253         $links = array();
3254         if (has_capability('gradereport/grader:view', $this->get_course_context()) &&
3255                 has_capability('moodle/grade:viewall', $this->get_course_context())) {
3256             $gradebookurl = '/grade/report/grader/index.php?id=' . $this->get_course()->id;
3257             $links[$gradebookurl] = get_string('viewgradebook', 'assign');
3258         }
3259         if ($this->is_any_submission_plugin_enabled() && $this->count_submissions()) {
3260             $downloadurl = '/mod/assign/view.php?id=' . $cmid . '&action=downloadall';
3261             $links[$downloadurl] = get_string('downloadall', 'assign');
3262         }
3263         if ($this->is_blind_marking() &&
3264                 has_capability('mod/assign:revealidentities', $this->get_context())) {
3265             $revealidentitiesurl = '/mod/assign/view.php?id=' . $cmid . '&action=revealidentities';
3266             $links[$revealidentitiesurl] = get_string('revealidentities', 'assign');
3267         }
3268         foreach ($this->get_feedback_plugins() as $plugin) {
3269        &n