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