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