Merge branch 'w49_MDL-36983_m25_ordertext' of git://github.com/skodak/moodle
[moodle.git] / mod / assign / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the definition for the class assignment
19  *
20  * This class provides all the functionality for the new assign module.
21  *
22  * @package   mod_assign
23  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Assignment submission statuses
31  */
32 define('ASSIGN_SUBMISSION_STATUS_DRAFT', 'draft'); // student thinks it is a draft
33 define('ASSIGN_SUBMISSION_STATUS_SUBMITTED', 'submitted'); // student thinks it is finished
35 /**
36  * Search filters for grading page
37  */
38 define('ASSIGN_FILTER_SUBMITTED', 'submitted');
39 define('ASSIGN_FILTER_SINGLE_USER', 'singleuser');
40 define('ASSIGN_FILTER_REQUIRE_GRADING', 'require_grading');
42 /** Include accesslib.php */
43 require_once($CFG->libdir.'/accesslib.php');
44 /** Include formslib.php */
45 require_once($CFG->libdir.'/formslib.php');
46 /** Include repository/lib.php */
47 require_once($CFG->dirroot . '/repository/lib.php');
48 /** Include local mod_form.php */
49 require_once($CFG->dirroot.'/mod/assign/mod_form.php');
50 /** gradelib.php */
51 require_once($CFG->libdir.'/gradelib.php');
52 /** grading lib.php */
53 require_once($CFG->dirroot.'/grade/grading/lib.php');
54 /** Include feedbackplugin.php */
55 require_once($CFG->dirroot.'/mod/assign/feedbackplugin.php');
56 /** Include submissionplugin.php */
57 require_once($CFG->dirroot.'/mod/assign/submissionplugin.php');
58 /** Include renderable.php */
59 require_once($CFG->dirroot.'/mod/assign/renderable.php');
60 /** Include gradingtable.php */
61 require_once($CFG->dirroot.'/mod/assign/gradingtable.php');
62 /** Include eventslib.php */
63 require_once($CFG->libdir.'/eventslib.php');
64 /** Include portfolio caller.php */
65 require_once($CFG->libdir . '/portfolio/caller.php');
67 /**
68  * Standard base class for mod_assign (assignment types).
69  *
70  * @package   mod_assign
71  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
72  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
73  */
74 class assign {
77     /** @var stdClass the assignment record that contains the global settings for this assign instance */
78     private $instance;
80     /** @var context the context of the course module for this assign instance (or just the course if we are
81         creating a new one) */
82     private $context;
84     /** @var stdClass the course this assign instance belongs to */
85     private $course;
87     /** @var stdClass the admin config for all assign instances  */
88     private $adminconfig;
91     /** @var assign_renderer the custom renderer for this module */
92     private $output;
94     /** @var stdClass the course module for this assign instance */
95     private $coursemodule;
97     /** @var array cache for things like the coursemodule name or the scale menu - only lives for a single
98         request */
99     private $cache;
101     /** @var array list of the installed submission plugins */
102     private $submissionplugins;
104     /** @var array list of the installed feedback plugins */
105     private $feedbackplugins;
107     /** @var string action to be used to return to this page (without repeating any form submissions etc.) */
108     private $returnaction = 'view';
110     /** @var array params to be used to return to this page */
111     private $returnparams = array();
113     /** @var string modulename prevents excessive calls to get_string */
114     private static $modulename = null;
116     /** @var string modulenameplural prevents excessive calls to get_string */
117     private static $modulenameplural = null;
119     /**
120      * Constructor for the base assign class
121      *
122      * @param mixed $coursemodulecontext context|null the course module context (or the course context if the coursemodule has not been created yet)
123      * @param mixed $coursemodule the current course module if it was already loaded - otherwise this class will load one from the context as required
124      * @param mixed $course the current course  if it was already loaded - otherwise this class will load one from the context as required
125      */
126     public function __construct($coursemodulecontext, $coursemodule, $course) {
127         global $PAGE;
129         $this->context = $coursemodulecontext;
130         $this->coursemodule = $coursemodule;
131         $this->course = $course;
132         $this->cache = array(); // temporary cache only lives for a single request - used to reduce db lookups
134         $this->submissionplugins = $this->load_plugins('assignsubmission');
135         $this->feedbackplugins = $this->load_plugins('assignfeedback');
136     }
138     /**
139      * Set the action and parameters that can be used to return to the current page
140      *
141      * @param string $action The action for the current page
142      * @param array $params An array of name value pairs which form the parameters to return to the current page
143      * @return void
144      */
145     public function register_return_link($action, $params) {
146         $this->returnaction = $action;
147         $this->returnparams = $params;
148     }
150     /**
151      * Return an action that can be used to get back to the current page
152      * @return string action
153      */
154     public function get_return_action() {
155         return $this->returnaction;
156     }
158     /**
159      * Based on the current assignment settings should we display the intro
160      * @return bool showintro
161      */
162     private function show_intro() {
163         if ($this->get_instance()->alwaysshowdescription ||
164                 time() > $this->get_instance()->allowsubmissionsfromdate) {
165             return true;
166         }
167         return false;
168     }
170     /**
171      * Return a list of parameters that can be used to get back to the current page
172      * @return array params
173      */
174     public function get_return_params() {
175         return $this->returnparams;
176     }
178     /**
179      * Set the submitted form data
180      * @param stdClass $data The form data (instance)
181      */
182     public function set_instance(stdClass $data) {
183         $this->instance = $data;
184     }
186     /**
187      * Set the context
188      * @param context $context The new context
189      */
190     public function set_context(context $context) {
191         $this->context = $context;
192     }
194     /**
195      * Set the course data
196      * @param stdClass $course The course data
197      */
198     public function set_course(stdClass $course) {
199         $this->course = $course;
200     }
202     /**
203      * get list of feedback plugins installed
204      * @return array
205      */
206     public function get_feedback_plugins() {
207         return $this->feedbackplugins;
208     }
210     /**
211      * get list of submission plugins installed
212      * @return array
213      */
214     public function get_submission_plugins() {
215         return $this->submissionplugins;
216     }
218     /**
219      * Is blind marking enabled and reveal identities not set yet?
220      *
221      * @return bool
222      */
223     public function is_blind_marking() {
224         return $this->get_instance()->blindmarking && !$this->get_instance()->revealidentities;
225     }
227     /**
228      * Does an assignment have submission(s) or grade(s) already?
229      *
230      * @return bool
231      */
232     public function has_submissions_or_grades() {
233         $allgrades = $this->count_grades();
234         $allsubmissions = $this->count_submissions();
235         if (($allgrades == 0) && ($allsubmissions == 0)) {
236             return false;
237         }
238         return true;
239     }
241     /**
242      * get a specific submission plugin by its type
243      * @param string $subtype assignsubmission | assignfeedback
244      * @param string $type
245      * @return mixed assign_plugin|null
246      */
247     public function get_plugin_by_type($subtype, $type) {
248         $shortsubtype = substr($subtype, strlen('assign'));
249         $name = $shortsubtype . 'plugins';
250         if ($name != 'feedbackplugins' && $name != 'submissionplugins') {
251             return null;
252         }
253         $pluginlist = $this->$name;
254         foreach ($pluginlist as $plugin) {
255             if ($plugin->get_type() == $type) {
256                 return $plugin;
257             }
258         }
259         return null;
260     }
262     /**
263      * Get a feedback plugin by type
264      * @param string $type - The type of plugin e.g comments
265      * @return mixed assign_feedback_plugin|null
266      */
267     public function get_feedback_plugin_by_type($type) {
268         return $this->get_plugin_by_type('assignfeedback', $type);
269     }
271     /**
272      * Get a submission plugin by type
273      * @param string $type - The type of plugin e.g comments
274      * @return mixed assign_submission_plugin|null
275      */
276     public function get_submission_plugin_by_type($type) {
277         return $this->get_plugin_by_type('assignsubmission', $type);
278     }
280     /**
281      * Load the plugins from the sub folders under subtype
282      * @param string $subtype - either submission or feedback
283      * @return array - The sorted list of plugins
284      */
285     private function load_plugins($subtype) {
286         global $CFG;
287         $result = array();
289         $names = get_plugin_list($subtype);
291         foreach ($names as $name => $path) {
292             if (file_exists($path . '/locallib.php')) {
293                 require_once($path . '/locallib.php');
295                 $shortsubtype = substr($subtype, strlen('assign'));
296                 $pluginclass = 'assign_' . $shortsubtype . '_' . $name;
298                 $plugin = new $pluginclass($this, $name);
300                 if ($plugin instanceof assign_plugin) {
301                     $idx = $plugin->get_sort_order();
302                     while (array_key_exists($idx, $result)) $idx +=1;
303                     $result[$idx] = $plugin;
304                 }
305             }
306         }
307         ksort($result);
308         return $result;
309     }
311     /**
312      * Display the assignment, used by view.php
313      *
314      * The assignment is displayed differently depending on your role,
315      * the settings for the assignment and the status of the assignment.
316      * @param string $action The current action if any.
317      * @return void
318      */
319     public function view($action='') {
321         $o = '';
322         $mform = null;
323         $notices = array();
325         // Handle form submissions first.
326         if ($action == 'savesubmission') {
327             $action = 'editsubmission';
328             if ($this->process_save_submission($mform, $notices)) {
329                 $action = 'view';
330             }
331         } else if ($action == 'lock') {
332             $this->process_lock();
333             $action = 'grading';
334         } else if ($action == 'reverttodraft') {
335             $this->process_revert_to_draft();
336             $action = 'grading';
337         } else if ($action == 'unlock') {
338             $this->process_unlock();
339             $action = 'grading';
340         } else if ($action == 'confirmsubmit') {
341             $action = 'submit';
342             if ($this->process_submit_for_grading($mform)) {
343                 $action = 'view';
344             }
345         } else if ($action == 'gradingbatchoperation') {
346             $action = $this->process_grading_batch_operation($mform);
347         } else if ($action == 'submitgrade') {
348             if (optional_param('saveandshownext', null, PARAM_RAW)) {
349                 //save and show next
350                 $action = 'grade';
351                 if ($this->process_save_grade($mform)) {
352                     $action = 'nextgrade';
353                 }
354             } else if (optional_param('nosaveandprevious', null, PARAM_RAW)) {
355                 $action = 'previousgrade';
356             } else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
357                 //show next button
358                 $action = 'nextgrade';
359             } else if (optional_param('savegrade', null, PARAM_RAW)) {
360                 //save changes button
361                 $action = 'grade';
362                 if ($this->process_save_grade($mform)) {
363                     $action = 'grading';
364                 }
365             } else {
366                 //cancel button
367                 $action = 'grading';
368             }
369         } else if ($action == 'quickgrade') {
370             $message = $this->process_save_quick_grades();
371             $action = 'quickgradingresult';
372         } else if ($action == 'saveoptions') {
373             $this->process_save_grading_options();
374             $action = 'grading';
375         } else if ($action == 'saveextension') {
376             $action = 'grantextension';
377             if ($this->process_save_extension($mform)) {
378                 $action = 'grading';
379             }
380         } else if ($action == 'revealidentitiesconfirm') {
381             $this->process_reveal_identities();
382             $action = 'grading';
383         }
385         $returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT));
386         $this->register_return_link($action, $returnparams);
388         // Now show the right view page.
389         if ($action == 'previousgrade') {
390             $mform = null;
391             $o .= $this->view_single_grade_page($mform, -1);
392         } else if ($action == 'quickgradingresult') {
393             $mform = null;
394             $o .= $this->view_quickgrading_result($message);
395         } else if ($action == 'nextgrade') {
396             $mform = null;
397             $o .= $this->view_single_grade_page($mform, 1);
398         } else if ($action == 'grade') {
399             $o .= $this->view_single_grade_page($mform);
400         } else if ($action == 'viewpluginassignfeedback') {
401             $o .= $this->view_plugin_content('assignfeedback');
402         } else if ($action == 'viewpluginassignsubmission') {
403             $o .= $this->view_plugin_content('assignsubmission');
404         } else if ($action == 'editsubmission') {
405             $o .= $this->view_edit_submission_page($mform, $notices);
406         } else if ($action == 'grading') {
407             $o .= $this->view_grading_page();
408         } else if ($action == 'downloadall') {
409             $o .= $this->download_submissions();
410         } else if ($action == 'submit') {
411             $o .= $this->check_submit_for_grading($mform);
412         } else if ($action == 'grantextension') {
413             $o .= $this->view_grant_extension($mform);
414         } else if ($action == 'revealidentities') {
415             $o .= $this->view_reveal_identities_confirm($mform);
416         } else if ($action == 'plugingradingbatchoperation') {
417             $o .= $this->view_plugin_grading_batch_operation($mform);
418         } else if ($action == 'viewpluginpage') {
419              $o .= $this->view_plugin_page();
420         } else {
421             $o .= $this->view_submission_page();
422         }
424         return $o;
425     }
428     /**
429      * Add this instance to the database
430      *
431      * @param stdClass $formdata The data submitted from the form
432      * @param bool $callplugins This is used to skip the plugin code
433      *             when upgrading an old assignment to a new one (the plugins get called manually)
434      * @return mixed false if an error occurs or the int id of the new instance
435      */
436     public function add_instance(stdClass $formdata, $callplugins) {
437         global $DB;
439         $err = '';
441         // add the database record
442         $update = new stdClass();
443         $update->name = $formdata->name;
444         $update->timemodified = time();
445         $update->timecreated = time();
446         $update->course = $formdata->course;
447         $update->courseid = $formdata->course;
448         $update->intro = $formdata->intro;
449         $update->introformat = $formdata->introformat;
450         $update->alwaysshowdescription = $formdata->alwaysshowdescription;
451         $update->submissiondrafts = $formdata->submissiondrafts;
452         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
453         $update->sendnotifications = $formdata->sendnotifications;
454         $update->sendlatenotifications = $formdata->sendlatenotifications;
455         $update->duedate = $formdata->duedate;
456         $update->cutoffdate = $formdata->cutoffdate;
457         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
458         $update->grade = $formdata->grade;
459         $update->completionsubmit = !empty($formdata->completionsubmit);
460         $update->teamsubmission = $formdata->teamsubmission;
461         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
462         $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
463         $update->blindmarking = $formdata->blindmarking;
465         $returnid = $DB->insert_record('assign', $update);
466         $this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
467         // cache the course record
468         $this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
470         if ($callplugins) {
471             // call save_settings hook for submission plugins
472             foreach ($this->submissionplugins as $plugin) {
473                 if (!$this->update_plugin_instance($plugin, $formdata)) {
474                     print_error($plugin->get_error());
475                     return false;
476                 }
477             }
478             foreach ($this->feedbackplugins as $plugin) {
479                 if (!$this->update_plugin_instance($plugin, $formdata)) {
480                     print_error($plugin->get_error());
481                     return false;
482                 }
483             }
485             // in the case of upgrades the coursemodule has not been set so we need to wait before calling these two
486             // TODO: add event to the calendar
487             $this->update_calendar($formdata->coursemodule);
488             // TODO: add the item in the gradebook
489             $this->update_gradebook(false, $formdata->coursemodule);
491         }
493         $update = new stdClass();
494         $update->id = $this->get_instance()->id;
495         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
496         $DB->update_record('assign', $update);
498         return $returnid;
499     }
501     /**
502      * Delete all grades from the gradebook for this assignment
503      *
504      * @return bool
505      */
506     private function delete_grades() {
507         global $CFG;
509         return grade_update('mod/assign', $this->get_course()->id, 'mod', 'assign', $this->get_instance()->id, 0, NULL, array('deleted'=>1)) == GRADE_UPDATE_OK;
510     }
512     /**
513      * Delete this instance from the database
514      *
515      * @return bool false if an error occurs
516      */
517     public function delete_instance() {
518         global $DB;
519         $result = true;
521         foreach ($this->submissionplugins as $plugin) {
522             if (!$plugin->delete_instance()) {
523                 print_error($plugin->get_error());
524                 $result = false;
525             }
526         }
527         foreach ($this->feedbackplugins as $plugin) {
528             if (!$plugin->delete_instance()) {
529                 print_error($plugin->get_error());
530                 $result = false;
531             }
532         }
534         // delete files associated with this assignment
535         $fs = get_file_storage();
536         if (! $fs->delete_area_files($this->context->id) ) {
537             $result = false;
538         }
540         // delete_records will throw an exception if it fails - so no need for error checking here
542         $DB->delete_records('assign_submission', array('assignment'=>$this->get_instance()->id));
543         $DB->delete_records('assign_grades', array('assignment'=>$this->get_instance()->id));
544         $DB->delete_records('assign_plugin_config', array('assignment'=>$this->get_instance()->id));
546         // delete items from the gradebook
547         if (! $this->delete_grades()) {
548             $result = false;
549         }
551         // delete the instance
552         $DB->delete_records('assign', array('id'=>$this->get_instance()->id));
554         return $result;
555     }
557     /**
558     * Actual implementation of the reset course functionality, delete all the
559     * assignment submissions for course $data->courseid.
560     *
561     * @param $data the data submitted from the reset course.
562     * @return array status array
563     */
564     public function reset_userdata($data) {
565         global $CFG,$DB;
567         $componentstr = get_string('modulenameplural', 'assign');
568         $status = array();
570         $fs = get_file_storage();
571         if (!empty($data->reset_assign_submissions)) {
572             // Delete files associated with this assignment.
573             foreach ($this->submissionplugins as $plugin) {
574                 $fileareas = array();
575                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
576                 $fileareas = $plugin->get_file_areas();
577                 foreach ($fileareas as $filearea) {
578                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
579                 }
581                 if (!$plugin->delete_instance()) {
582                     $status[] = array('component'=>$componentstr,
583                                       'item'=>get_string('deleteallsubmissions','assign'),
584                                       'error'=>$plugin->get_error());
585                 }
586             }
588             foreach ($this->feedbackplugins as $plugin) {
589                 $fileareas = array();
590                 $plugincomponent = $plugin->get_subtype() . '_' . $plugin->get_type();
591                 $fileareas = $plugin->get_file_areas();
592                 foreach ($fileareas as $filearea) {
593                     $fs->delete_area_files($this->context->id, $plugincomponent, $filearea);
594                 }
596                 if (!$plugin->delete_instance()) {
597                     $status[] = array('component'=>$componentstr,
598                                       'item'=>get_string('deleteallsubmissions','assign'),
599                                       'error'=>$plugin->get_error());
600                 }
601             }
603             $assignssql = "SELECT a.id
604                              FROM {assign} a
605                            WHERE a.course=:course";
606             $params = array ("course" => $data->courseid);
608             $DB->delete_records_select('assign_submission', "assignment IN ($assignssql)", $params);
609             $status[] = array('component'=>$componentstr,
610                               'item'=>get_string('deleteallsubmissions','assign'),
611                               'error'=>false);
613             if (empty($data->reset_gradebook_grades)) {
614                 // Remove all grades from gradebook.
615                 require_once($CFG->dirroot.'/mod/assign/lib.php');
616                 assign_reset_gradebook($data->courseid);
617             }
618         }
619         // Updating dates - shift may be negative too.
620         if ($data->timeshift) {
621             shift_course_mod_dates('assign',
622                                     array('duedate', 'allowsubmissionsfromdate','cutoffdate'),
623                                     $data->timeshift,
624                                     $data->courseid);
625             $status[] = array('component'=>$componentstr,
626                               'item'=>get_string('datechanged'),
627                               'error'=>false);
628         }
630         return $status;
631     }
633     /**
634      * Update the settings for a single plugin
635      *
636      * @param assign_plugin $plugin The plugin to update
637      * @param stdClass $formdata The form data
638      * @return bool false if an error occurs
639      */
640     private function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
641         if ($plugin->is_visible()) {
642             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
643             if ($formdata->$enabledname) {
644                 $plugin->enable();
645                 if (!$plugin->save_settings($formdata)) {
646                     print_error($plugin->get_error());
647                     return false;
648                 }
649             } else {
650                 $plugin->disable();
651             }
652         }
653         return true;
654     }
656     /**
657      * Update the gradebook information for this assignment
658      *
659      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
660      * @param int $coursemoduleid This is required because it might not exist in the database yet
661      * @return bool
662      */
663     public function update_gradebook($reset, $coursemoduleid) {
664          global $CFG;
665         /** Include lib.php */
666         require_once($CFG->dirroot.'/mod/assign/lib.php');
667         $assign = clone $this->get_instance();
668         $assign->cmidnumber = $coursemoduleid;
669         $param = null;
670         if ($reset) {
671             $param = 'reset';
672         }
674         return assign_grade_item_update($assign, $param);
675     }
677     /** Load and cache the admin config for this module
678      *
679      * @return stdClass the plugin config
680      */
681     public function get_admin_config() {
682         if ($this->adminconfig) {
683             return $this->adminconfig;
684         }
685         $this->adminconfig = get_config('assign');
686         return $this->adminconfig;
687     }
690     /**
691      * Update the calendar entries for this assignment
692      *
693      * @param int $coursemoduleid - Required to pass this in because it might not exist in the database yet
694      * @return bool
695      */
696     public function update_calendar($coursemoduleid) {
697         global $DB, $CFG;
698         require_once($CFG->dirroot.'/calendar/lib.php');
700         // special case for add_instance as the coursemodule has not been set yet.
702         if ($this->get_instance()->duedate) {
703             $event = new stdClass();
705             if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assign', 'instance'=>$this->get_instance()->id))) {
707                 $event->name        = $this->get_instance()->name;
709                 $event->description = format_module_intro('assign', $this->get_instance(), $coursemoduleid);
710                 $event->timestart   = $this->get_instance()->duedate;
712                 $calendarevent = calendar_event::load($event->id);
713                 $calendarevent->update($event);
714             } else {
715                 $event = new stdClass();
716                 $event->name        = $this->get_instance()->name;
717                 $event->description = format_module_intro('assign', $this->get_instance(), $coursemoduleid);
718                 $event->courseid    = $this->get_instance()->course;
719                 $event->groupid     = 0;
720                 $event->userid      = 0;
721                 $event->modulename  = 'assign';
722                 $event->instance    = $this->get_instance()->id;
723                 $event->eventtype   = 'due';
724                 $event->timestart   = $this->get_instance()->duedate;
725                 $event->timeduration = 0;
727                 calendar_event::create($event);
728             }
729         } else {
730             $DB->delete_records('event', array('modulename'=>'assign', 'instance'=>$this->get_instance()->id));
731         }
732     }
735     /**
736      * Update this instance in the database
737      *
738      * @param stdClass $formdata - the data submitted from the form
739      * @return bool false if an error occurs
740      */
741     public function update_instance($formdata) {
742         global $DB;
744         $update = new stdClass();
745         $update->id = $formdata->instance;
746         $update->name = $formdata->name;
747         $update->timemodified = time();
748         $update->course = $formdata->course;
749         $update->intro = $formdata->intro;
750         $update->introformat = $formdata->introformat;
751         $update->alwaysshowdescription = $formdata->alwaysshowdescription;
752         $update->submissiondrafts = $formdata->submissiondrafts;
753         $update->requiresubmissionstatement = $formdata->requiresubmissionstatement;
754         $update->sendnotifications = $formdata->sendnotifications;
755         $update->sendlatenotifications = $formdata->sendlatenotifications;
756         $update->duedate = $formdata->duedate;
757         $update->cutoffdate = $formdata->cutoffdate;
758         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
759         $update->grade = $formdata->grade;
760         $update->completionsubmit = !empty($formdata->completionsubmit);
761         $update->teamsubmission = $formdata->teamsubmission;
762         $update->requireallteammemberssubmit = $formdata->requireallteammemberssubmit;
763         $update->teamsubmissiongroupingid = $formdata->teamsubmissiongroupingid;
764         $update->blindmarking = $formdata->blindmarking;
766         $result = $DB->update_record('assign', $update);
767         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
769         // load the assignment so the plugins have access to it
771         // call save_settings hook for submission plugins
772         foreach ($this->submissionplugins as $plugin) {
773             if (!$this->update_plugin_instance($plugin, $formdata)) {
774                 print_error($plugin->get_error());
775                 return false;
776             }
777         }
778         foreach ($this->feedbackplugins as $plugin) {
779             if (!$this->update_plugin_instance($plugin, $formdata)) {
780                 print_error($plugin->get_error());
781                 return false;
782             }
783         }
786         // update the database record
789         // update all the calendar events
790         $this->update_calendar($this->get_course_module()->id);
792         $this->update_gradebook(false, $this->get_course_module()->id);
794         $update = new stdClass();
795         $update->id = $this->get_instance()->id;
796         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
797         $DB->update_record('assign', $update);
803         return $result;
804     }
806     /**
807      * add elements in grading plugin form
808      *
809      * @param mixed $grade stdClass|null
810      * @param MoodleQuickForm $mform
811      * @param stdClass $data
812      * @param int $userid - The userid we are grading
813      * @return void
814      */
815     private function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
816         foreach ($this->feedbackplugins as $plugin) {
817             if ($plugin->is_enabled() && $plugin->is_visible()) {
818                 $mform->addElement('header', 'header_' . $plugin->get_type(), $plugin->get_name());
819                 if (!$plugin->get_form_elements_for_user($grade, $mform, $data, $userid)) {
820                     $mform->removeElement('header_' . $plugin->get_type());
821                 }
822             }
823         }
824     }
828     /**
829      * Add one plugins settings to edit plugin form
830      *
831      * @param assign_plugin $plugin The plugin to add the settings from
832      * @param MoodleQuickForm $mform The form to add the configuration settings to. This form is modified directly (not returned)
833      * @return void
834      */
835     private function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform) {
836         global $CFG;
837         if ($plugin->is_visible()) {
838             // enabled
839             //tied disableIf rule to this select element
840             $mform->addElement('selectyesno', $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $plugin->get_name());
841             $mform->addHelpButton($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', 'enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
844             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
845             if ($plugin->get_config('enabled') !== false) {
846                 $default = $plugin->is_enabled();
847             }
848             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
850             $plugin->get_settings($mform);
852         }
854     }
857     /**
858      * Add settings to edit plugin form
859      *
860      * @param MoodleQuickForm $mform The form to add the configuration settings to. This form is modified directly (not returned)
861      * @return void
862      */
863     public function add_all_plugin_settings(MoodleQuickForm $mform) {
864         $mform->addElement('header', 'general', get_string('submissionsettings', 'assign'));
866         foreach ($this->submissionplugins as $plugin) {
867             $this->add_plugin_settings($plugin, $mform);
869         }
870         $mform->addElement('header', 'general', get_string('feedbacksettings', 'assign'));
871         foreach ($this->feedbackplugins as $plugin) {
872             $this->add_plugin_settings($plugin, $mform);
873         }
874     }
876     /**
877      * Allow each plugin an opportunity to update the defaultvalues
878      * passed in to the settings form (needed to set up draft areas for
879      * editor and filemanager elements)
880      * @param array $defaultvalues
881      */
882     public function plugin_data_preprocessing(&$defaultvalues) {
883         foreach ($this->submissionplugins as $plugin) {
884             if ($plugin->is_visible()) {
885                 $plugin->data_preprocessing($defaultvalues);
886             }
887         }
888         foreach ($this->feedbackplugins as $plugin) {
889             if ($plugin->is_visible()) {
890                 $plugin->data_preprocessing($defaultvalues);
891             }
892         }
893     }
895     /**
896      * Get the name of the current module.
897      *
898      * @return string the module name (Assignment)
899      */
900     protected function get_module_name() {
901         if (isset(self::$modulename)) {
902             return self::$modulename;
903         }
904         self::$modulename = get_string('modulename', 'assign');
905         return self::$modulename;
906     }
908     /**
909      * Get the plural name of the current module.
910      *
911      * @return string the module name plural (Assignments)
912      */
913     protected function get_module_name_plural() {
914         if (isset(self::$modulenameplural)) {
915             return self::$modulenameplural;
916         }
917         self::$modulenameplural = get_string('modulenameplural', 'assign');
918         return self::$modulenameplural;
919     }
921     /**
922      * Has this assignment been constructed from an instance?
923      *
924      * @return bool
925      */
926     public function has_instance() {
927         return $this->instance || $this->get_course_module();
928     }
930     /**
931      * Get the settings for the current instance of this assignment
932      *
933      * @return stdClass The settings
934      */
935     public function get_instance() {
936         global $DB;
937         if ($this->instance) {
938             return $this->instance;
939         }
940         if ($this->get_course_module()) {
941             $this->instance = $DB->get_record('assign', array('id' => $this->get_course_module()->instance), '*', MUST_EXIST);
942         }
943         if (!$this->instance) {
944             throw new coding_exception('Improper use of the assignment class. Cannot load the assignment record.');
945         }
946         return $this->instance;
947     }
949     /**
950      * Get the context of the current course
951      * @return mixed context|null The course context
952      */
953     public function get_course_context() {
954         if (!$this->context && !$this->course) {
955             throw new coding_exception('Improper use of the assignment class. Cannot load the course context.');
956         }
957         if ($this->context) {
958             return $this->context->get_course_context();
959         } else {
960             return context_course::instance($this->course->id);
961         }
962     }
965     /**
966      * Get the current course module
967      *
968      * @return mixed stdClass|null The course module
969      */
970     public function get_course_module() {
971         if ($this->coursemodule) {
972             return $this->coursemodule;
973         }
974         if (!$this->context) {
975             return null;
976         }
978         if ($this->context->contextlevel == CONTEXT_MODULE) {
979             $this->coursemodule = get_coursemodule_from_id('assign', $this->context->instanceid, 0, false, MUST_EXIST);
980             return $this->coursemodule;
981         }
982         return null;
983     }
985     /**
986      * Get context module
987      *
988      * @return context
989      */
990     public function get_context() {
991         return $this->context;
992     }
994     /**
995      * Get the current course
996      * @return mixed stdClass|null The course
997      */
998     public function get_course() {
999         global $DB;
1000         if ($this->course) {
1001             return $this->course;
1002         }
1004         if (!$this->context) {
1005             return null;
1006         }
1007         $this->course = $DB->get_record('course', array('id' => $this->get_course_context()->instanceid), '*', MUST_EXIST);
1008         return $this->course;
1009     }
1011     /**
1012      * Return a grade in user-friendly form, whether it's a scale or not
1013      *
1014      * @param mixed $grade int|null
1015      * @param boolean $editing Are we allowing changes to this grade?
1016      * @param int $userid The user id the grade belongs to
1017      * @param int $modified Timestamp from when the grade was last modified
1018      * @return string User-friendly representation of grade
1019      */
1020     public function display_grade($grade, $editing, $userid=0, $modified=0) {
1021         global $DB;
1023         static $scalegrades = array();
1025         $o = '';
1027         if ($this->get_instance()->grade >= 0) {
1028             // Normal number
1029             if ($editing && $this->get_instance()->grade > 0) {
1030                 if ($grade < 0) {
1031                     $displaygrade = '';
1032                 } else {
1033                     $displaygrade = format_float($grade);
1034                 }
1035                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' . get_string('usergrade', 'assign') . '</label>';
1036                 $o .= '<input type="text" id="quickgrade_' . $userid . '" name="quickgrade_' . $userid . '" value="' .
1037                       $displaygrade . '" size="6" maxlength="10" class="quickgrade"/>';
1038                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade,2);
1039                 $o .= '<input type="hidden" name="grademodified_' . $userid . '" value="' . $modified . '"/>';
1040                 return $o;
1041             } else {
1042                 $o .= '<input type="hidden" name="grademodified_' . $userid . '" value="' . $modified . '"/>';
1043                 if ($grade == -1 || $grade === null) {
1044                     $o .= '-';
1045                     return $o;
1046                 } else {
1047                     $o .= format_float(($grade),2) .'&nbsp;/&nbsp;'. format_float($this->get_instance()->grade,2);
1048                     return $o;
1049                 }
1050             }
1052         } else {
1053             // Scale
1054             if (empty($this->cache['scale'])) {
1055                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
1056                     $this->cache['scale'] = make_menu_from_list($scale->scale);
1057                 } else {
1058                     $o .= '-';
1059                     return $o;
1060                 }
1061             }
1062             if ($editing) {
1063                 $o .= '<label class="accesshide" for="quickgrade_' . $userid . '">' . get_string('usergrade', 'assign') . '</label>';
1064                 $o .= '<select name="quickgrade_' . $userid . '" class="quickgrade">';
1065                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
1066                 foreach ($this->cache['scale'] as $optionid => $option) {
1067                     $selected = '';
1068                     if ($grade == $optionid) {
1069                         $selected = 'selected="selected"';
1070                     }
1071                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
1072                 }
1073                 $o .= '</select>';
1074                 $o .= '<input type="hidden" name="grademodified_' . $userid . '" value="' . $modified . '"/>';
1075                 return $o;
1076             } else {
1077                 $scaleid = (int)$grade;
1078                 if (isset($this->cache['scale'][$scaleid])) {
1079                     $o .= $this->cache['scale'][$scaleid];
1080                     return $o;
1081                 }
1082                 $o .= '-';
1083                 return $o;
1084             }
1085         }
1086     }
1088     /**
1089      * Load a list of users enrolled in the current course with the specified permission and group (0 for no group)
1090      *
1091      * @param int $currentgroup
1092      * @param bool $idsonly
1093      * @return array List of user records
1094      */
1095     public function list_participants($currentgroup, $idsonly) {
1096         if ($idsonly) {
1097             return get_enrolled_users($this->context, "mod/assign:submit", $currentgroup, 'u.id');
1098         } else {
1099             return get_enrolled_users($this->context, "mod/assign:submit", $currentgroup);
1100         }
1101     }
1103     /**
1104      * Load a count of valid teams for this assignment
1105      *
1106      * @return int number of valid teams
1107      */
1108     public function count_teams() {
1110         $groups = groups_get_all_groups($this->get_course()->id, 0, $this->get_instance()->teamsubmissiongroupingid, 'g.id');
1111         $count = count($groups);
1113         // See if there are any users in the default group.
1114         $defaultusers = $this->get_submission_group_members(0, true);
1115         if (count($defaultusers) > 0) {
1116             $count += 1;
1117         }
1118         return $count;
1119     }
1121     /**
1122      * Load a count of users enrolled in the current course with the specified permission and group (0 for no group)
1123      *
1124      * @param int $currentgroup
1125      * @return int number of matching users
1126      */
1127     public function count_participants($currentgroup) {
1128         return count_enrolled_users($this->context, "mod/assign:submit", $currentgroup);
1129     }
1131     /**
1132      * Load a count of users submissions in the current module that require grading
1133      * This means the submission modification time is more recent than the
1134      * grading modification time and the status is SUBMITTED.
1135      *
1136      * @return int number of matching submissions
1137      */
1138     public function count_submissions_need_grading() {
1139         global $DB;
1141         if ($this->get_instance()->teamsubmission) {
1142             // This does not make sense for group assignment because the submission is shared.
1143             return 0;
1144         }
1146         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1147         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, false);
1149         $params['assignid'] = $this->get_instance()->id;
1150         $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1152         $sql = 'SELECT COUNT(s.userid)
1153                    FROM {assign_submission} s
1154                    LEFT JOIN {assign_grades} g ON
1155                         s.assignment = g.assignment AND
1156                         s.userid = g.userid
1157                    JOIN(' . $esql . ') AS e ON e.id = s.userid
1158                    WHERE
1159                         s.assignment = :assignid AND
1160                         s.timemodified IS NOT NULL AND
1161                         s.status = :submitted AND
1162                         (s.timemodified > g.timemodified OR g.timemodified IS NULL)';
1164         return $DB->count_records_sql($sql, $params);
1165     }
1167     /**
1168      * Load a count of grades
1169      *
1170      * @return int number of grades
1171      */
1172     public function count_grades() {
1173         global $DB;
1175         if (!$this->has_instance()) {
1176             return 0;
1177         }
1179         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1180         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, false);
1182         $params['assignid'] = $this->get_instance()->id;
1184         $sql = 'SELECT COUNT(g.userid)
1185                    FROM {assign_grades} g
1186                    JOIN(' . $esql . ') AS e ON e.id = g.userid
1187                    WHERE g.assignment = :assignid';
1189         return $DB->count_records_sql($sql, $params);
1190     }
1192     /**
1193      * Load a count of submissions
1194      *
1195      * @return int number of submissions
1196      */
1197     public function count_submissions() {
1198         global $DB;
1200         if (!$this->has_instance()) {
1201             return 0;
1202         }
1204         $params = array();
1206         if ($this->get_instance()->teamsubmission) {
1207             // We cannot join on the enrolment tables for group submissions (no userid).
1208             $sql = 'SELECT COUNT(s.groupid)
1209                         FROM {assign_submission} s
1210                         WHERE
1211                             s.assignment = :assignid AND
1212                             s.timemodified IS NOT NULL AND
1213                             s.userid = :groupuserid';
1215             $params['assignid'] = $this->get_instance()->id;
1216             $params['groupuserid'] = 0;
1217         } else {
1218             $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1219             list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, false);
1221             $params['assignid'] = $this->get_instance()->id;
1223             $sql = 'SELECT COUNT(s.userid)
1224                        FROM {assign_submission} s
1225                        JOIN(' . $esql . ') AS e ON e.id = s.userid
1226                        WHERE
1227                             s.assignment = :assignid AND
1228                             s.timemodified IS NOT NULL';
1229         }
1231         return $DB->count_records_sql($sql, $params);
1232     }
1234     /**
1235      * Load a count of submissions with a specified status
1236      *
1237      * @param string $status The submission status - should match one of the constants
1238      * @return int number of matching submissions
1239      */
1240     public function count_submissions_with_status($status) {
1241         global $DB;
1243         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1244         list($esql, $params) = get_enrolled_sql($this->get_context(), 'mod/assign:submit', $currentgroup, false);
1246         $params['assignid'] = $this->get_instance()->id;
1247         $params['submissionstatus'] = $status;
1249         if ($this->get_instance()->teamsubmission) {
1250             $sql = 'SELECT COUNT(s.groupid)
1251                         FROM {assign_submission} s
1252                         WHERE
1253                             s.assignment = :assignid AND
1254                             s.timemodified IS NOT NULL AND
1255                             s.userid = :groupuserid AND
1256                             s.status = :submissionstatus';
1257             $params['groupuserid'] = 0;
1258         } else {
1259             $sql = 'SELECT COUNT(s.userid)
1260                         FROM {assign_submission} s
1261                         JOIN(' . $esql . ') AS e ON e.id = s.userid
1262                         WHERE
1263                             s.assignment = :assignid AND
1264                             s.timemodified IS NOT NULL AND
1265                             s.status = :submissionstatus';
1266         }
1268         return $DB->count_records_sql($sql, $params);
1269     }
1271     /**
1272      * Utility function to get the userid for every row in the grading table
1273      * so the order can be frozen while we iterate it
1274      *
1275      * @return array An array of userids
1276      */
1277     private function get_grading_userid_list() {
1278         $filter = get_user_preferences('assign_filter', '');
1279         $table = new assign_grading_table($this, 0, $filter, 0, false);
1281         $useridlist = $table->get_column_data('userid');
1283         return $useridlist;
1284     }
1287     /**
1288      * Utility function get the userid based on the row number of the grading table.
1289      * This takes into account any active filters on the table.
1290      *
1291      * @param int $num The row number of the user
1292      * @param bool $last This is set to true if this is the last user in the table
1293      * @return mixed The user id of the matching user or false if there was an error
1294      */
1295     private function get_userid_for_row($num, $last) {
1296         if (!array_key_exists('userid_for_row', $this->cache)) {
1297             $this->cache['userid_for_row'] = array();
1298         }
1299         if (array_key_exists($num, $this->cache['userid_for_row'])) {
1300             list($userid, $last) = $this->cache['userid_for_row'][$num];
1301             return $userid;
1302         }
1304         $filter = get_user_preferences('assign_filter', '');
1305         $table = new assign_grading_table($this, 0, $filter, 0, false);
1307         $userid = $table->get_cell_data($num, 'userid', $last);
1309         $this->cache['userid_for_row'][$num] = array($userid, $last);
1310         return $userid;
1311     }
1313     /**
1314      * Generate zip file from array of given files
1315      *
1316      * @param array $filesforzipping - array of files to pass into archive_to_pathname - this array is indexed by the final file name and each element in the array is an instance of a stored_file object
1317      * @return path of temp file - note this returned file does not have a .zip extension - it is a temp file.
1318      */
1319      private function pack_files($filesforzipping) {
1320          global $CFG;
1321          //create path for new zip file.
1322          $tempzip = tempnam($CFG->tempdir.'/', 'assignment_');
1323          //zip files
1324          $zipper = new zip_packer();
1325          if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
1326              return $tempzip;
1327          }
1328          return false;
1329     }
1331     /**
1332      * Finds all assignment notifications that have yet to be mailed out, and mails them.
1333      *
1334      * Cron function to be run periodically according to the moodle cron
1335      *
1336      * @return bool
1337      */
1338     static function cron() {
1339         global $DB;
1341         // only ever send a max of one days worth of updates
1342         $yesterday = time() - (24 * 3600);
1343         $timenow   = time();
1345         // Collect all submissions from the past 24 hours that require mailing.
1346         $sql = "SELECT s.*, a.course, a.name, a.blindmarking, a.revealidentities,
1347                        g.*, g.id as gradeid, g.timemodified as lastmodified
1348                  FROM {assign} a
1349                  JOIN {assign_grades} g ON g.assignment = a.id
1350             LEFT JOIN {assign_submission} s ON s.assignment = a.id AND s.userid = g.userid
1351                 WHERE g.timemodified >= :yesterday AND
1352                       g.timemodified <= :today AND
1353                       g.mailed = 0";
1354         $params = array('yesterday' => $yesterday, 'today' => $timenow);
1355         $submissions = $DB->get_records_sql($sql, $params);
1357         if (empty($submissions)) {
1358             mtrace('done.');
1359             return true;
1360         }
1362         mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
1364         // Preload courses we are going to need those.
1365         $courseids = array();
1366         foreach ($submissions as $submission) {
1367             $courseids[] = $submission->course;
1368         }
1369         // Filter out duplicates
1370         $courseids = array_unique($courseids);
1371         $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
1372         list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
1373         $sql = "SELECT c.*, {$ctxselect}
1374                   FROM {course} c
1375              LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
1376                  WHERE c.id {$courseidsql}";
1377         $params['contextlevel'] = CONTEXT_COURSE;
1378         $courses = $DB->get_records_sql($sql, $params);
1379         // Clean up... this could go on for a while.
1380         unset($courseids);
1381         unset($ctxselect);
1382         unset($courseidsql);
1383         unset($params);
1385         // Simple array we'll use for caching modules.
1386         $modcache = array();
1388         // Message students about new feedback
1389         foreach ($submissions as $submission) {
1391             mtrace("Processing assignment submission $submission->id ...");
1393             // do not cache user lookups - could be too many
1394             if (!$user = $DB->get_record("user", array("id"=>$submission->userid))) {
1395                 mtrace("Could not find user $submission->userid");
1396                 continue;
1397             }
1399             // use a cache to prevent the same DB queries happening over and over
1400             if (!array_key_exists($submission->course, $courses)) {
1401                 mtrace("Could not find course $submission->course");
1402                 continue;
1403             }
1404             $course = $courses[$submission->course];
1405             if (isset($course->ctxid)) {
1406                 // Context has not yet been preloaded. Do so now.
1407                 context_helper::preload_from_record($course);
1408             }
1410             // Override the language and timezone of the "current" user, so that
1411             // mail is customised for the receiver.
1412             cron_setup_user($user, $course);
1414             // context lookups are already cached
1415             $coursecontext = context_course::instance($course->id);
1416             if (!is_enrolled($coursecontext, $user->id)) {
1417                 $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
1418                 mtrace(fullname($user)." not an active participant in " . $courseshortname);
1419                 continue;
1420             }
1422             if (!$grader = $DB->get_record("user", array("id"=>$submission->grader))) {
1423                 mtrace("Could not find grader $submission->grader");
1424                 continue;
1425             }
1427             if (!array_key_exists($submission->assignment, $modcache)) {
1428                 if (! $mod = get_coursemodule_from_instance("assign", $submission->assignment, $course->id)) {
1429                     mtrace("Could not find course module for assignment id $submission->assignment");
1430                     continue;
1431                 }
1432                 $modcache[$submission->assignment] = $mod;
1433             } else {
1434                 $mod = $modcache[$submission->assignment];
1435             }
1436             // context lookups are already cached
1437             $contextmodule = context_module::instance($mod->id);
1439             if (!$mod->visible) {
1440                 // Hold mail notification for hidden assignments until later
1441                 continue;
1442             }
1444             // need to send this to the student
1445             $messagetype = 'feedbackavailable';
1446             $eventtype = 'assign_notification';
1447             $updatetime = $submission->lastmodified;
1448             $modulename = get_string('modulename', 'assign');
1450             $uniqueid = 0;
1451             if ($submission->blindmarking && !$submission->revealidentities) {
1452                 $uniqueid = self::get_uniqueid_for_user_static($submission->assignment, $user->id);
1453             }
1454             self::send_assignment_notification($grader, $user, $messagetype, $eventtype, $updatetime,
1455                                                $mod, $contextmodule, $course, $modulename, $submission->name,
1456                                                $submission->blindmarking && !$submission->revealidentities,
1457                                                $uniqueid);
1459             $grade = new stdClass();
1460             $grade->id = $submission->gradeid;
1461             $grade->mailed = 1;
1462             $DB->update_record('assign_grades', $grade);
1464             mtrace('Done');
1465         }
1466         mtrace('Done processing ' . count($submissions) . ' assignment submissions');
1468         cron_setup_user();
1470         // Free up memory just to be sure
1471         unset($courses);
1472         unset($modcache);
1474         return true;
1475     }
1477     /**
1478      * Update a grade in the grade table for the assignment and in the gradebook
1479      *
1480      * @param stdClass $grade a grade record keyed on id
1481      * @return bool true for success
1482      */
1483     public function update_grade($grade) {
1484         global $DB;
1486         $grade->timemodified = time();
1488         if ($grade->grade && $grade->grade != -1) {
1489             if ($this->get_instance()->grade > 0) {
1490                 if (!is_numeric($grade->grade)) {
1491                     return false;
1492                 } else if ($grade->grade > $this->get_instance()->grade) {
1493                     return false;
1494                 } else if ($grade->grade < 0) {
1495                     return false;
1496                 }
1497             } else {
1498                 // this is a scale
1499                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
1500                     $scaleoptions = make_menu_from_list($scale->scale);
1501                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
1502                         return false;
1503                     }
1504                 }
1505             }
1506         }
1508         $result = $DB->update_record('assign_grades', $grade);
1509         if ($result) {
1510             $this->gradebook_item_update(null, $grade);
1511         }
1512         return $result;
1513     }
1515     /**
1516      * View the grant extension date page
1517      *
1518      * Uses url parameters 'userid'
1519      * or from parameter 'selectedusers'
1520      * @param moodleform $mform - Used for validation of the submitted data
1521      * @return string
1522      */
1523     private function view_grant_extension($mform) {
1524         global $DB, $CFG;
1525         require_once($CFG->dirroot . '/mod/assign/extensionform.php');
1527         $o = '';
1528         $batchusers = optional_param('selectedusers', '', PARAM_TEXT);
1529         $data = new stdClass();
1530         $data->extensionduedate = null;
1531         $userid = 0;
1532         if (!$batchusers) {
1533             $userid = required_param('userid', PARAM_INT);
1535             $grade = $this->get_user_grade($userid, false);
1537             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
1539             if ($grade) {
1540                 $data->extensionduedate = $grade->extensionduedate;
1541             }
1542             $data->userid = $userid;
1543         } else {
1544             $data->batchusers = $batchusers;
1545         }
1546         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
1547                                                       $this->get_context(),
1548                                                       $this->show_intro(),
1549                                                       $this->get_course_module()->id,
1550                                                       get_string('grantextension', 'assign')));
1552         if (!$mform) {
1553             $mform = new mod_assign_extension_form(null, array($this->get_course_module()->id,
1554                                                                $userid,
1555                                                                $batchusers,
1556                                                                $this->get_instance(),
1557                                                                $data));
1558         }
1559         $o .= $this->get_renderer()->render(new assign_form('extensionform', $mform));
1560         $o .= $this->view_footer();
1561         return $o;
1562     }
1564     /**
1565      * Get a list of the users in the same group as this user
1566      *
1567      * @param int $groupid The id of the group whose members we want or 0 for the default group
1568      * @param bool $onlyids Whether to retrieve only the user id's
1569      * @return array The users (possibly id's only)
1570      */
1571     public function get_submission_group_members($groupid, $onlyids) {
1572         $members = array();
1573         if ($groupid != 0) {
1574             if ($onlyids) {
1575                 $allusers = groups_get_members($groupid, 'u.id');
1576             } else {
1577                 $allusers = groups_get_members($groupid);
1578             }
1579             foreach ($allusers as $user) {
1580                 if ($this->get_submission_group($user->id)) {
1581                     $members[] = $user;
1582                 }
1583             }
1584         } else {
1585             $allusers = $this->list_participants(null, $onlyids);
1586             foreach ($allusers as $user) {
1587                 if ($this->get_submission_group($user->id) == null) {
1588                     $members[] = $user;
1589                 }
1590             }
1591         }
1592         return $members;
1593     }
1595     /**
1596      * Get a list of the users in the same group as this user that have not submitted the assignment
1597      *
1598      * @param int $groupid The id of the group whose members we want or 0 for the default group
1599      * @param bool $onlyids Whether to retrieve only the user id's
1600      * @return array The users (possibly id's only)
1601      */
1602     public function get_submission_group_members_who_have_not_submitted($groupid, $onlyids) {
1603         if (!$this->get_instance()->teamsubmission || !$this->get_instance()->requireallteammemberssubmit) {
1604             return array();
1605         }
1606         $members = $this->get_submission_group_members($groupid, $onlyids);
1608         foreach ($members as $id => $member) {
1609             $submission = $this->get_user_submission($member->id, false);
1610             if ($submission && $submission->status != ASSIGN_SUBMISSION_STATUS_DRAFT) {
1611                 unset($members[$id]);
1612             } else {
1613                 if ($this->is_blind_marking()) {
1614                     $members[$id]->alias = get_string('hiddenuser', 'assign') . $this->get_uniqueid_for_user($id);
1615                 }
1616             }
1617         }
1618         return $members;
1619     }
1621     /**
1622      * Load the group submission object for a particular user, optionally creating it if required
1623      *
1624      * This will create the user submission and the group submission if required
1625      *
1626      * @param int $userid The id of the user whose submission we want
1627      * @param int $groupid The id of the group for this user - may be 0 in which case it is determined from the userid
1628      * @param bool $create If set to true a new submission object will be created in the database
1629      * @return stdClass The submission
1630      */
1631     public function get_group_submission($userid, $groupid, $create) {
1632         global $DB;
1634         if ($groupid == 0) {
1635             $group = $this->get_submission_group($userid);
1636             if ($group) {
1637                 $groupid = $group->id;
1638             }
1639         }
1641         if ($create) {
1642             // Make sure there is a submission for this user.
1643             $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>0, 'userid'=>$userid);
1644             $submission = $DB->get_record('assign_submission', $params);
1646             if (!$submission) {
1647                 $submission = new stdClass();
1648                 $submission->assignment   = $this->get_instance()->id;
1649                 $submission->userid       = $userid;
1650                 $submission->groupid      = 0;
1651                 $submission->timecreated  = time();
1652                 $submission->timemodified = $submission->timecreated;
1654                 if ($this->get_instance()->submissiondrafts) {
1655                     $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
1656                 } else {
1657                     $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1658                 }
1659                 $DB->insert_record('assign_submission', $submission);
1660             }
1661         }
1662         // Now get the group submission.
1663         $params = array('assignment'=>$this->get_instance()->id, 'groupid'=>$groupid, 'userid'=>0);
1664         $submission = $DB->get_record('assign_submission', $params);
1666         if ($submission) {
1667             return $submission;
1668         }
1669         if ($create) {
1670             $submission = new stdClass();
1671             $submission->assignment   = $this->get_instance()->id;
1672             $submission->userid       = 0;
1673             $submission->groupid       = $groupid;
1674             $submission->timecreated = time();
1675             $submission->timemodified = $submission->timecreated;
1677             if ($this->get_instance()->submissiondrafts) {
1678                 $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
1679             } else {
1680                 $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1681             }
1682             $sid = $DB->insert_record('assign_submission', $submission);
1683             $submission->id = $sid;
1684             return $submission;
1685         }
1686         return false;
1687     }
1689     /**
1690      * View a page rendered by a plugin
1691      *
1692      * Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'
1693      *
1694      * @return string
1695      */
1696     private function view_plugin_page() {
1697         global $USER;
1699         $o = '';
1701         $pluginsubtype = required_param('pluginsubtype', PARAM_ALPHA);
1702         $plugintype = required_param('plugin', PARAM_TEXT);
1703         $pluginaction = required_param('pluginaction', PARAM_ALPHA);
1705         $plugin = $this->get_plugin_by_type($pluginsubtype, $plugintype);
1706         if (!$plugin) {
1707             print_error('invalidformdata', '');
1708             return;
1709         }
1711         $o .= $plugin->view_page($pluginaction);
1713         return $o;
1714     }
1717     /**
1718      * This is used for team assignments to get the group for the specified user.
1719      * If the user is a member of multiple or no groups this will return false
1720      *
1721      * @param int $userid The id of the user whose submission we want
1722      * @return mixed The group or false
1723      */
1724     public function get_submission_group($userid) {
1725         $groups = groups_get_all_groups($this->get_course()->id, $userid, $this->get_instance()->teamsubmissiongroupingid);
1726         if (count($groups) != 1) {
1727             return false;
1728         }
1729         return array_pop($groups);
1730     }
1733     /**
1734      * display the submission that is used by a plugin
1735      * Uses url parameters 'sid', 'gid' and 'plugin'
1736      * @param string $pluginsubtype
1737      * @return string
1738      */
1739     private function view_plugin_content($pluginsubtype) {
1740         global $USER;
1742         $o = '';
1744         $submissionid = optional_param('sid', 0, PARAM_INT);
1745         $gradeid = optional_param('gid', 0, PARAM_INT);
1746         $plugintype = required_param('plugin', PARAM_TEXT);
1747         $item = null;
1748         if ($pluginsubtype == 'assignsubmission') {
1749             $plugin = $this->get_submission_plugin_by_type($plugintype);
1750             if ($submissionid <= 0) {
1751                 throw new coding_exception('Submission id should not be 0');
1752             }
1753             $item = $this->get_submission($submissionid);
1755             // permissions
1756             if ($item->userid != $USER->id) {
1757                 require_capability('mod/assign:grade', $this->context);
1758             }
1759             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
1760                                                               $this->get_context(),
1761                                                               $this->show_intro(),
1762                                                               $this->get_course_module()->id,
1763                                                               $plugin->get_name()));
1764             $o .= $this->get_renderer()->render(new assign_submission_plugin_submission($plugin,
1765                                                               $item,
1766                                                               assign_submission_plugin_submission::FULL,
1767                                                               $this->get_course_module()->id,
1768                                                               $this->get_return_action(),
1769                                                               $this->get_return_params()));
1771             $this->add_to_log('view submission', get_string('viewsubmissionforuser', 'assign', $item->userid));
1772         } else {
1773             $plugin = $this->get_feedback_plugin_by_type($plugintype);
1774             if ($gradeid <= 0) {
1775                 throw new coding_exception('Grade id should not be 0');
1776             }
1777             $item = $this->get_grade($gradeid);
1778             // permissions
1779             if ($item->userid != $USER->id) {
1780                 require_capability('mod/assign:grade', $this->context);
1781             }
1782             $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
1783                                                               $this->get_context(),
1784                                                               $this->show_intro(),
1785                                                               $this->get_course_module()->id,
1786                                                               $plugin->get_name()));
1787             $o .= $this->get_renderer()->render(new assign_feedback_plugin_feedback($plugin,
1788                                                               $item,
1789                                                               assign_feedback_plugin_feedback::FULL,
1790                                                               $this->get_course_module()->id,
1791                                                               $this->get_return_action(),
1792                                                               $this->get_return_params()));
1793             $this->add_to_log('view feedback', get_string('viewfeedbackforuser', 'assign', $item->userid));
1794         }
1797         $o .= $this->view_return_links();
1799         $o .= $this->view_footer();
1800         return $o;
1801     }
1803     /**
1804      * render the content in editor that is often used by plugin
1805      *
1806      * @param string $filearea
1807      * @param int  $submissionid
1808      * @param string $plugintype
1809      * @param string $editor
1810      * @param string $component
1811      * @return string
1812      */
1813     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
1814         global $CFG;
1816         $result = '';
1818         $plugin = $this->get_submission_plugin_by_type($plugintype);
1820         $text = $plugin->get_editor_text($editor, $submissionid);
1821         $format = $plugin->get_editor_format($editor, $submissionid);
1823         $finaltext = file_rewrite_pluginfile_urls($text, 'pluginfile.php', $this->get_context()->id, $component, $filearea, $submissionid);
1824         $result .= format_text($finaltext, $format, array('overflowdiv' => true, 'context' => $this->get_context()));
1828         if ($CFG->enableportfolios) {
1829             require_once($CFG->libdir . '/portfoliolib.php');
1831             $button = new portfolio_add_button();
1832             $button->set_callback_options('assign_portfolio_caller', array('cmid' => $this->get_course_module()->id,
1833                                           'sid' => $submissionid, 'plugin' => $plugintype, 'editor' => $editor, 'area'=>$filearea),
1834                                           'mod_assign');
1835             $fs = get_file_storage();
1837             if ($files = $fs->get_area_files($this->context->id, $component,$filearea, $submissionid, "timemodified", false)) {
1838                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1839             } else {
1840                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1841             }
1842             $result .= $button->to_html();
1843         }
1844         return $result;
1845     }
1847     /**
1848      * Display a grading error
1849      *
1850      * @param string $message - The description of the result
1851      * @return string
1852      */
1853     private function view_quickgrading_result($message) {
1854         $o = '';
1855         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
1856                                                       $this->get_context(),
1857                                                       $this->show_intro(),
1858                                                       $this->get_course_module()->id,
1859                                                       get_string('quickgradingresult', 'assign')));
1860         $o .= $this->get_renderer()->render(new assign_quickgrading_result($message, $this->get_course_module()->id));
1861         $o .= $this->view_footer();
1862         return $o;
1863     }
1865     /**
1866      * Display the page footer
1867      *
1868      * @return string
1869      */
1870     private function view_footer() {
1871         return $this->get_renderer()->render_footer();
1872     }
1874     /**
1875      * Does this user have grade permission for this assignment
1876      *
1877      * @return bool
1878      */
1879     private function can_grade() {
1880         // Permissions check
1881         if (!has_capability('mod/assign:grade', $this->context)) {
1882             return false;
1883         }
1885         return true;
1886     }
1888     /**
1889      * Download a zip file of all assignment submissions
1890      *
1891      * @return void
1892      */
1893     private function download_submissions() {
1894         global $CFG,$DB;
1896         // More efficient to load this here.
1897         require_once($CFG->libdir.'/filelib.php');
1899         // Load all users with submit.
1900         $students = get_enrolled_users($this->context, "mod/assign:submit");
1902         // Build a list of files to zip.
1903         $filesforzipping = array();
1904         $fs = get_file_storage();
1906         $groupmode = groups_get_activity_groupmode($this->get_course_module());
1907         // All users.
1908         $groupid = 0;
1909         $groupname = '';
1910         if ($groupmode) {
1911             $groupid = groups_get_activity_group($this->get_course_module(), true);
1912             $groupname = groups_get_group_name($groupid).'-';
1913         }
1915         // Construct the zip file name.
1916         $filename = clean_filename($this->get_course()->shortname.'-'.
1917                                    $this->get_instance()->name.'-'.
1918                                    $groupname.$this->get_course_module()->id.".zip");
1920         // Get all the files for each student.
1921         foreach ($students as $student) {
1922             $userid = $student->id;
1924             if ((groups_is_member($groupid, $userid) or !$groupmode or !$groupid)) {
1925                 // Get the plugins to add their own files to the zip.
1927                 $submissiongroup = false;
1928                 $groupname = '';
1929                 if ($this->get_instance()->teamsubmission) {
1930                     $submission = $this->get_group_submission($userid, 0, false);
1931                     $submissiongroup = $this->get_submission_group($userid);
1932                     if ($submissiongroup) {
1933                         $groupname = $submissiongroup->name . '-';
1934                     } else {
1935                         $groupname = get_string('defaultteam', 'assign') . '-';
1936                     }
1937                 } else {
1938                     $submission = $this->get_user_submission($userid, false);
1939                 }
1941                 if ($this->is_blind_marking()) {
1942                     $prefix = clean_filename(str_replace('_', ' ', $groupname . get_string('participant', 'assign')) .
1943                                              "_" . $this->get_uniqueid_for_user($userid) . "_");
1944                 } else {
1945                     $prefix = clean_filename(str_replace('_', ' ', $groupname . fullname($student)) .
1946                                              "_" . $this->get_uniqueid_for_user($userid) . "_");
1947                 }
1949                 if ($submission) {
1950                     foreach ($this->submissionplugins as $plugin) {
1951                         if ($plugin->is_enabled() && $plugin->is_visible()) {
1952                             $pluginfiles = $plugin->get_files($submission);
1953                             foreach ($pluginfiles as $zipfilename => $file) {
1954                                 $subtype = $plugin->get_subtype();
1955                                 $type = $plugin->get_type();
1956                                 $prefixedfilename = $prefix . $subtype . '_' . $type . '_' . $zipfilename;
1957                                 $filesforzipping[$prefixedfilename] = $file;
1958                             }
1959                         }
1960                     }
1961                 }
1962             }
1963         }
1964         if ($zipfile = $this->pack_files($filesforzipping)) {
1965             $this->add_to_log('download all submissions', get_string('downloadall', 'assign'));
1966             // Send file and delete after sending.
1967             send_temp_file($zipfile, $filename);
1968         }
1969     }
1971     /**
1972      * Util function to add a message to the log
1973      *
1974      * @param string $action The current action
1975      * @param string $info A detailed description of the change. But no more than 255 characters.
1976      * @param string $url The url to the assign module instance.
1977      * @return void
1978      */
1979     public function add_to_log($action = '', $info = '', $url='') {
1980         global $USER;
1982         $fullurl = 'view.php?id=' . $this->get_course_module()->id;
1983         if ($url != '') {
1984             $fullurl .= '&' . $url;
1985         }
1987         add_to_log($this->get_course()->id, 'assign', $action, $fullurl, $info, $this->get_course_module()->id, $USER->id);
1988     }
1990     /**
1991      * Lazy load the page renderer and expose the renderer to plugins
1992      *
1993      * @return assign_renderer
1994      */
1995     public function get_renderer() {
1996         global $PAGE;
1997         if ($this->output) {
1998             return $this->output;
1999         }
2000         $this->output = $PAGE->get_renderer('mod_assign');
2001         return $this->output;
2002     }
2004     /**
2005      * Load the submission object for a particular user, optionally creating it if required
2006      *
2007      * For team assignments there are 2 submissions - the student submission and the team submission
2008      * All files are associated with the team submission but the status of the students contribution is
2009      * recorded separately.
2010      *
2011      * @param int $userid The id of the user whose submission we want or 0 in which case USER->id is used
2012      * @param bool $create optional Defaults to false. If set to true a new submission object will be created in the database
2013      * @return stdClass The submission
2014      */
2015     public function get_user_submission($userid, $create) {
2016         global $DB, $USER;
2018         if (!$userid) {
2019             $userid = $USER->id;
2020         }
2021         // If the userid is not null then use userid.
2022         $params = array('assignment'=>$this->get_instance()->id, 'userid'=>$userid, 'groupid'=>0);
2023         $submission = $DB->get_record('assign_submission', $params);
2025         if ($submission) {
2026             return $submission;
2027         }
2028         if ($create) {
2029             $submission = new stdClass();
2030             $submission->assignment   = $this->get_instance()->id;
2031             $submission->userid       = $userid;
2032             $submission->timecreated = time();
2033             $submission->timemodified = $submission->timecreated;
2034             $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
2035             $sid = $DB->insert_record('assign_submission', $submission);
2036             $submission->id = $sid;
2037             return $submission;
2038         }
2039         return false;
2040     }
2042     /**
2043      * Load the submission object from it's id
2044      *
2045      * @param int $submissionid The id of the submission we want
2046      * @return stdClass The submission
2047      */
2048     private function get_submission($submissionid) {
2049         global $DB;
2051         return $DB->get_record('assign_submission', array('assignment'=>$this->get_instance()->id, 'id'=>$submissionid), '*', MUST_EXIST);
2052     }
2054     /**
2055      * This will retrieve a grade object from the db, optionally creating it if required
2056      *
2057      * @param int $userid The user we are grading
2058      * @param bool $create If true the grade will be created if it does not exist
2059      * @return stdClass The grade record
2060      */
2061     public function get_user_grade($userid, $create) {
2062         global $DB, $USER;
2064         if (!$userid) {
2065             $userid = $USER->id;
2066         }
2068         // if the userid is not null then use userid
2069         $grade = $DB->get_record('assign_grades', array('assignment'=>$this->get_instance()->id, 'userid'=>$userid));
2071         if ($grade) {
2072             return $grade;
2073         }
2074         if ($create) {
2075             $grade = new stdClass();
2076             $grade->assignment   = $this->get_instance()->id;
2077             $grade->userid       = $userid;
2078             $grade->timecreated = time();
2079             $grade->timemodified = $grade->timecreated;
2080             $grade->locked = 0;
2081             $grade->grade = -1;
2082             $grade->grader = $USER->id;
2083             $grade->extensionduedate = 0;
2084             $gid = $DB->insert_record('assign_grades', $grade);
2085             $grade->id = $gid;
2086             return $grade;
2087         }
2088         return false;
2089     }
2091     /**
2092      * This will retrieve a grade object from the db
2093      *
2094      * @param int $gradeid The id of the grade
2095      * @return stdClass The grade record
2096      */
2097     private function get_grade($gradeid) {
2098         global $DB;
2100         return $DB->get_record('assign_grades', array('assignment'=>$this->get_instance()->id, 'id'=>$gradeid), '*', MUST_EXIST);
2101     }
2103     /**
2104      * Print the grading page for a single user submission
2105      *
2106      * @param moodleform $mform
2107      * @param int $offset
2108      * @return string
2109      */
2110     private function view_single_grade_page($mform, $offset=0) {
2111         global $DB, $CFG;
2113         $o = '';
2115         // Include grade form
2116         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
2118         // Need submit permission to submit an assignment
2119         require_capability('mod/assign:grade', $this->context);
2121         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2122                                                       $this->get_context(), false, $this->get_course_module()->id,get_string('grading', 'assign')));
2124         $rownum = required_param('rownum', PARAM_INT) + $offset;
2125         $useridlist = optional_param('useridlist', '', PARAM_TEXT);
2126         if ($useridlist) {
2127             $useridlist = explode(',', $useridlist);
2128         } else {
2129             $useridlist = $this->get_grading_userid_list();
2130         }
2131         $last = false;
2132         $userid = $useridlist[$rownum];
2133         if ($rownum == count($useridlist) - 1) {
2134             $last = true;
2135         }
2136         if (!$userid) {
2137             throw new coding_exception('Row is out of bounds for the current grading table: ' . $rownum);
2138         }
2139         $user = $DB->get_record('user', array('id' => $userid));
2140         if ($user) {
2141             $o .= $this->get_renderer()->render(new assign_user_summary($user,
2142                                                                 $this->get_course()->id,
2143                                                                 has_capability('moodle/site:viewfullnames',
2144                                                                 $this->get_course_context()),
2145                                                                 $this->is_blind_marking(),
2146                                                                 $this->get_uniqueid_for_user($user->id)));
2147         }
2148         $submission = $this->get_user_submission($userid, false);
2149         $submissiongroup = null;
2150         $submissiongroupmemberswhohavenotsubmitted = array();
2151         $teamsubmission = null;
2152         $notsubmitted = array();
2153         if ($this->get_instance()->teamsubmission) {
2154             $teamsubmission = $this->get_group_submission($userid, 0, false);
2155             $submissiongroup = $this->get_submission_group($userid);
2156             $groupid = 0;
2157             if ($submissiongroup) {
2158                 $groupid = $submissiongroup->id;
2159             }
2160             $notsubmitted = $this->get_submission_group_members_who_have_not_submitted($groupid, false);
2162         }
2164         // get the current grade
2165         $grade = $this->get_user_grade($userid, false);
2166         if ($this->can_view_submission($userid)) {
2167             $gradelocked = ($grade && $grade->locked) || $this->grading_disabled($userid);
2168             $extensionduedate = null;
2169             if ($grade) {
2170                 $extensionduedate = $grade->extensionduedate;
2171             }
2172             $showedit = $this->submissions_open($userid) && ($this->is_any_submission_plugin_enabled());
2174             if ($teamsubmission) {
2175                 $showsubmit = $showedit && $teamsubmission && ($teamsubmission->status == ASSIGN_SUBMISSION_STATUS_DRAFT);
2176             } else {
2177                 $showsubmit = $showedit && $submission && ($submission->status == ASSIGN_SUBMISSION_STATUS_DRAFT);
2178             }
2179             if (!$this->get_instance()->submissiondrafts) {
2180                 $showsubmit = false;
2181             }
2182             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
2184             $o .= $this->get_renderer()->render(new assign_submission_status($this->get_instance()->allowsubmissionsfromdate,
2185                                                               $this->get_instance()->alwaysshowdescription,
2186                                                               $submission,
2187                                                               $this->get_instance()->teamsubmission,
2188                                                               $teamsubmission,
2189                                                               $submissiongroup,
2190                                                               $notsubmitted,
2191                                                               $this->is_any_submission_plugin_enabled(),
2192                                                               $gradelocked,
2193                                                               $this->is_graded($userid),
2194                                                               $this->get_instance()->duedate,
2195                                                               $this->get_instance()->cutoffdate,
2196                                                               $this->get_submission_plugins(),
2197                                                               $this->get_return_action(),
2198                                                               $this->get_return_params(),
2199                                                               $this->get_course_module()->id,
2200                                                               $this->get_course()->id,
2201                                                               assign_submission_status::GRADER_VIEW,
2202                                                               $showedit,
2203                                                               $showsubmit,
2204                                                               $viewfullnames,
2205                                                               $extensionduedate,
2206                                                               $this->get_context(),
2207                                                               $this->is_blind_marking(),
2208                                                               ''));
2209         }
2210         if ($grade) {
2211             $data = new stdClass();
2212             if ($grade->grade !== NULL && $grade->grade >= 0) {
2213                 $data->grade = format_float($grade->grade,2);
2214             }
2215         } else {
2216             $data = new stdClass();
2217             $data->grade = '';
2218         }
2220         // now show the grading form
2221         if (!$mform) {
2222             $pagination = array( 'rownum'=>$rownum, 'useridlist'=>$useridlist, 'last'=>$last);
2223             $formparams = array($this, $data, $pagination);
2224             $mform = new mod_assign_grade_form(null,
2225                                                $formparams,
2226                                                'post',
2227                                                '',
2228                                                array('class'=>'gradeform'));
2229         }
2230         $o .= $this->get_renderer()->render(new assign_form('gradingform',$mform));
2232         $msg = get_string('viewgradingformforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user)));
2233         $this->add_to_log('view grading form', $msg);
2235         $o .= $this->view_footer();
2236         return $o;
2237     }
2239     /**
2240      * Show a confirmation page to make sure they want to release student identities
2241      *
2242      * @return string
2243      */
2244     private function view_reveal_identities_confirm() {
2245         global $CFG, $USER;
2247         require_capability('mod/assign:revealidentities', $this->get_context());
2249         $o = '';
2250         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2251                                                       $this->get_context(), false, $this->get_course_module()->id));
2253         $confirmurl = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
2254                                                                     'action'=>'revealidentitiesconfirm',
2255                                                                     'sesskey'=>sesskey()));
2257         $cancelurl = new moodle_url('/mod/assign/view.php', array('id'=>$this->get_course_module()->id,
2258                                                                     'action'=>'grading'));
2260         $o .= $this->get_renderer()->confirm(get_string('revealidentitiesconfirm', 'assign'), $confirmurl, $cancelurl);
2261         $o .= $this->view_footer();
2262         $this->add_to_log('view', get_string('viewrevealidentitiesconfirm', 'assign'));
2263         return $o;
2264     }
2269     /**
2270      * View a link to go back to the previous page. Uses url parameters returnaction and returnparams.
2271      *
2272      * @return string
2273      */
2274     private function view_return_links() {
2276         $returnaction = optional_param('returnaction','', PARAM_ALPHA);
2277         $returnparams = optional_param('returnparams','', PARAM_TEXT);
2279         $params = array();
2280         parse_str($returnparams, $params);
2281         $params = array_merge( array('id' => $this->get_course_module()->id, 'action' => $returnaction), $params);
2283         return $this->get_renderer()->single_button(new moodle_url('/mod/assign/view.php', $params), get_string('back'), 'get');
2285     }
2287     /**
2288      * View the grading table of all submissions for this assignment
2289      *
2290      * @return string
2291      */
2292     private function view_grading_table() {
2293         global $USER, $CFG;
2294         // Include grading options form
2295         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
2296         require_once($CFG->dirroot . '/mod/assign/quickgradingform.php');
2297         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
2298         $o = '';
2300         $links = array();
2301         if (has_capability('gradereport/grader:view', $this->get_course_context()) &&
2302                 has_capability('moodle/grade:viewall', $this->get_course_context())) {
2303             $gradebookurl = '/grade/report/grader/index.php?id=' . $this->get_course()->id;
2304             $links[$gradebookurl] = get_string('viewgradebook', 'assign');
2305         }
2306         if ($this->is_any_submission_plugin_enabled()) {
2307             $downloadurl = '/mod/assign/view.php?id=' . $this->get_course_module()->id . '&action=downloadall';
2308             $links[$downloadurl] = get_string('downloadall', 'assign');
2309         }
2310         if ($this->is_blind_marking() && has_capability('mod/assign:revealidentities', $this->get_context())) {
2311             $revealidentitiesurl = '/mod/assign/view.php?id=' . $this->get_course_module()->id . '&action=revealidentities';
2312             $links[$revealidentitiesurl] = get_string('revealidentities', 'assign');
2313         }
2314         foreach ($this->get_feedback_plugins() as $plugin) {
2315             if ($plugin->is_enabled() && $plugin->is_visible()) {
2316                 foreach ($plugin->get_grading_actions() as $action => $description) {
2317                     $url = '/mod/assign/view.php' .
2318                            '?id=' .  $this->get_course_module()->id .
2319                            '&plugin=' . $plugin->get_type() .
2320                            '&pluginsubtype=assignfeedback' .
2321                            '&action=viewpluginpage&pluginaction=' . $action;
2322                     $links[$url] = $description;
2323                 }
2324             }
2325         }
2327         $gradingactions = new url_select($links);
2328         $gradingactions->set_label(get_string('choosegradingaction', 'assign'));
2330         $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
2332         $perpage = get_user_preferences('assign_perpage', 10);
2333         $filter = get_user_preferences('assign_filter', '');
2334         $controller = $gradingmanager->get_active_controller();
2335         $showquickgrading = empty($controller);
2336         if (optional_param('action', '', PARAM_ALPHA) == 'saveoptions') {
2337             $quickgrading = optional_param('quickgrading', false, PARAM_BOOL);
2338             set_user_preference('assign_quickgrading', $quickgrading);
2339         }
2340         $quickgrading = get_user_preferences('assign_quickgrading', false);
2342         // print options  for changing the filter and changing the number of results per page
2343         $gradingoptionsform = new mod_assign_grading_options_form(null,
2344                                                                   array('cm'=>$this->get_course_module()->id,
2345                                                                         'contextid'=>$this->context->id,
2346                                                                         'userid'=>$USER->id,
2347                                                                         'submissionsenabled'=>$this->is_any_submission_plugin_enabled(),
2348                                                                         'showquickgrading'=>$showquickgrading,
2349                                                                         'quickgrading'=>$quickgrading),
2350                                                                   'post', '',
2351                                                                   array('class'=>'gradingoptionsform'));
2353         $gradingbatchoperationsform = new mod_assign_grading_batch_operations_form(null,
2354                                                                   array('cm'=>$this->get_course_module()->id,
2355                                                                         'submissiondrafts'=>$this->get_instance()->submissiondrafts,
2356                                                                         'duedate'=>$this->get_instance()->duedate,
2357                                                                         'feedbackplugins'=>$this->get_feedback_plugins()),
2358                                                                   'post', '',
2359                                                                   array('class'=>'gradingbatchoperationsform'));
2361         $gradingoptionsdata = new stdClass();
2362         $gradingoptionsdata->perpage = $perpage;
2363         $gradingoptionsdata->filter = $filter;
2364         $gradingoptionsform->set_data($gradingoptionsdata);
2366         $actionformtext = $this->get_renderer()->render($gradingactions);
2367         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2368                                                       $this->get_context(), false, $this->get_course_module()->id, get_string('grading', 'assign'), $actionformtext));
2369         $o .= groups_print_activity_menu($this->get_course_module(), $CFG->wwwroot . '/mod/assign/view.php?id=' . $this->get_course_module()->id.'&action=grading', true);
2371         // plagiarism update status apearring in the grading book
2372         if (!empty($CFG->enableplagiarism)) {
2373             /** Include plagiarismlib.php */
2374             require_once($CFG->libdir . '/plagiarismlib.php');
2375             $o .= plagiarism_update_status($this->get_course(), $this->get_course_module());
2376         }
2378         // load and print the table of submissions
2379         if ($showquickgrading && $quickgrading) {
2380             $table = $this->get_renderer()->render(new assign_grading_table($this, $perpage, $filter, 0, true));
2381             $quickgradingform = new mod_assign_quick_grading_form(null,
2382                                                                   array('cm'=>$this->get_course_module()->id,
2383                                                                         'gradingtable'=>$table));
2384             $o .= $this->get_renderer()->render(new assign_form('quickgradingform', $quickgradingform));
2385         } else {
2386             $o .= $this->get_renderer()->render(new assign_grading_table($this, $perpage, $filter, 0, false));
2387         }
2389         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2390         $users = array_keys($this->list_participants($currentgroup, true));
2391         if (count($users) != 0) {
2392             // if no enrolled user in a course then don't display the batch operations feature
2393             $o .= $this->get_renderer()->render(new assign_form('gradingbatchoperationsform', $gradingbatchoperationsform));
2394         }
2395         $o .= $this->get_renderer()->render(new assign_form('gradingoptionsform', $gradingoptionsform, 'M.mod_assign.init_grading_options'));
2396         return $o;
2397     }
2399     /**
2400      * View entire grading page.
2401      *
2402      * @return string
2403      */
2404     private function view_grading_page() {
2405         global $CFG;
2407         $o = '';
2408         // Need submit permission to submit an assignment
2409         require_capability('mod/assign:grade', $this->context);
2410         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
2412         // only load this if it is
2414         $o .= $this->view_grading_table();
2416         $o .= $this->view_footer();
2417         $this->add_to_log('view submission grading table', get_string('viewsubmissiongradingtable', 'assign'));
2418         return $o;
2419     }
2421     /**
2422      * Capture the output of the plagiarism plugins disclosures and return it as a string
2423      *
2424      * @return void
2425      */
2426     private function plagiarism_print_disclosure() {
2427         global $CFG;
2428         $o = '';
2430         if (!empty($CFG->enableplagiarism)) {
2431             /** Include plagiarismlib.php */
2432             require_once($CFG->libdir . '/plagiarismlib.php');
2434             $o .= plagiarism_print_disclosure($this->get_course_module()->id);
2435         }
2437         return $o;
2438     }
2440     /**
2441      * message for students when assignment submissions have been closed
2442      *
2443      * @return string
2444      */
2445     private function view_student_error_message() {
2446         global $CFG;
2448         $o = '';
2449         // Need submit permission to submit an assignment
2450         require_capability('mod/assign:submit', $this->context);
2452         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2453                                                       $this->get_context(),
2454                                                       $this->show_intro(),
2455                                                       $this->get_course_module()->id,
2456                                                       get_string('editsubmission', 'assign')));
2458         $o .= $this->get_renderer()->notification(get_string('submissionsclosed', 'assign'));
2460         $o .= $this->view_footer();
2462         return $o;
2464     }
2466     /**
2467      * View edit submissions page.
2468      *
2469      * @param moodleform $mform
2470      * @param array $notices A list of notices to display at the top of the edit submission form (e.g. from plugins).
2471      * @return void
2472      */
2473     private function view_edit_submission_page($mform, $notices) {
2474         global $CFG;
2476         $o = '';
2477         // Include submission form
2478         require_once($CFG->dirroot . '/mod/assign/submission_form.php');
2479         // Need submit permission to submit an assignment
2480         require_capability('mod/assign:submit', $this->context);
2482         if (!$this->submissions_open()) {
2483             return $this->view_student_error_message();
2484         }
2485         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2486                                                       $this->get_context(),
2487                                                       $this->show_intro(),
2488                                                       $this->get_course_module()->id,
2489                                                       get_string('editsubmission', 'assign')));
2490         $o .= $this->plagiarism_print_disclosure();
2491         $data = new stdClass();
2493         if (!$mform) {
2494             $mform = new mod_assign_submission_form(null, array($this, $data));
2495         }
2497         foreach ($notices as $notice) {
2498             $o .= $this->get_renderer()->notification($notice);
2499         }
2501         $o .= $this->get_renderer()->render(new assign_form('editsubmissionform',$mform));
2503         $o .= $this->view_footer();
2504         $this->add_to_log('view submit assignment form', get_string('viewownsubmissionform', 'assign'));
2506         return $o;
2507     }
2509     /**
2510      * See if this assignment has a grade yet
2511      *
2512      * @param int $userid
2513      * @return bool
2514      */
2515     private function is_graded($userid) {
2516         $grade = $this->get_user_grade($userid, false);
2517         if ($grade) {
2518             return ($grade->grade !== NULL && $grade->grade >= 0);
2519         }
2520         return false;
2521     }
2524     /**
2525      * Perform an access check to see if the current $USER can view this users submission
2526      *
2527      * @param int $userid
2528      * @return bool
2529      */
2530     public function can_view_submission($userid) {
2531         global $USER;
2533         if (!is_enrolled($this->get_course_context(), $userid)) {
2534             return false;
2535         }
2536         if ($userid == $USER->id && !has_capability('mod/assign:submit', $this->context)) {
2537             return false;
2538         }
2539         if ($userid != $USER->id && !has_capability('mod/assign:grade', $this->context)) {
2540             return false;
2541         }
2542         return true;
2543     }
2545     /**
2546      * Allows the plugin to show a batch grading operation page.
2547      *
2548      * @return none
2549      */
2550     private function view_plugin_grading_batch_operation($mform) {
2551         require_capability('mod/assign:grade', $this->context);
2552         $prefix = 'plugingradingbatchoperation_';
2554         if ($data = $mform->get_data()) {
2555             $tail = substr($data->operation, strlen($prefix));
2556             list($plugintype, $action) = explode('_', $tail, 2);
2558             $plugin = $this->get_feedback_plugin_by_type($plugintype);
2559             if ($plugin) {
2560                 $users = $data->selectedusers;
2561                 $userlist = explode(',', $users);
2562                 echo $plugin->grading_batch_operation($action, $userlist);
2563                 return;
2564             }
2565         }
2566         print_error('invalidformdata', '');
2567     }
2569     /**
2570      * Ask the user to confirm they want to perform this batch operation
2571      * @param moodleform $mform Set to a grading batch operations form
2572      * @return string - the page to view after processing these actions
2573      */
2574     private function process_grading_batch_operation(& $mform) {
2575         global $CFG;
2576         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
2577         require_sesskey();
2579         $mform = new mod_assign_grading_batch_operations_form(null,
2580                                                               array('cm'=>$this->get_course_module()->id,
2581                                                                     'submissiondrafts'=>$this->get_instance()->submissiondrafts,
2582                                                                     'duedate'=>$this->get_instance()->duedate,
2583                                                                     'feedbackplugins'=>$this->get_feedback_plugins()),
2584                                                               'post',
2585                                                               '',
2586                                                               array('class'=>'gradingbatchoperationsform'));
2588         if ($data = $mform->get_data()) {
2589             // get the list of users
2590             $users = $data->selectedusers;
2591             $userlist = explode(',', $users);
2593             $prefix = 'plugingradingbatchoperation_';
2595             if ($data->operation == 'grantextension') {
2596                 // Reset the form so the grant extension page will create the extension form.
2597                 $mform = null;
2598                 return 'grantextension';
2599             } else if (strpos($data->operation, $prefix) === 0) {
2600                 $tail = substr($data->operation, strlen($prefix));
2601                 list($plugintype, $action) = explode('_', $tail, 2);
2603                 $plugin = $this->get_feedback_plugin_by_type($plugintype);
2604                 if ($plugin) {
2605                     return 'plugingradingbatchoperation';
2606                 }
2607             }
2609             foreach ($userlist as $userid) {
2610                 if ($data->operation == 'lock') {
2611                     $this->process_lock($userid);
2612                 } else if ($data->operation == 'unlock') {
2613                     $this->process_unlock($userid);
2614                 } else if ($data->operation == 'reverttodraft') {
2615                     $this->process_revert_to_draft($userid);
2616                 }
2617             }
2618         }
2620         return 'grading';
2621     }
2623     /**
2624      * Ask the user to confirm they want to submit their work for grading
2625      * @param $mform moodleform - null unless form validation has failed
2626      * @return string
2627      */
2628     private function check_submit_for_grading($mform) {
2629         global $USER, $CFG;
2631         require_once($CFG->dirroot . '/mod/assign/submissionconfirmform.php');
2633         // Check that all of the submission plugins are ready for this submission
2634         $notifications = array();
2635         $submission = $this->get_user_submission($USER->id, false);
2636         $plugins = $this->get_submission_plugins();
2637         foreach ($plugins as $plugin) {
2638             if ($plugin->is_enabled() && $plugin->is_visible()) {
2639                 $check = $plugin->precheck_submission($submission);
2640                 if ($check !== true) {
2641                     $notifications[] = $check;
2642                 }
2643             }
2644         }
2646         $data = new stdClass();
2647         $adminconfig = $this->get_admin_config();
2648         $requiresubmissionstatement = (!empty($adminconfig->requiresubmissionstatement) ||
2649                                        $this->get_instance()->requiresubmissionstatement) &&
2650                                        !empty($adminconfig->submissionstatement);
2652         $submissionstatement = '';
2653         if (!empty($adminconfig->submissionstatement)) {
2654             $submissionstatement = $adminconfig->submissionstatement;
2655         }
2657         if ($mform == null) {
2658             $mform = new mod_assign_confirm_submission_form(null, array($requiresubmissionstatement,
2659                                                                         $submissionstatement,
2660                                                                         $this->get_course_module()->id,
2661                                                                         $data));
2662         }
2663         $o = '';
2664         $o .= $this->get_renderer()->header();
2665         $o .= $this->get_renderer()->render(new assign_submit_for_grading_page($notifications, $this->get_course_module()->id, $mform));
2666         $o .= $this->view_footer();
2668         $this->add_to_log('view confirm submit assignment form', get_string('viewownsubmissionform', 'assign'));
2670         return $o;
2671     }
2673     /**
2674      * Print 2 tables of information with no action links -
2675      * the submission summary and the grading summary
2676      *
2677      * @param stdClass $user the user to print the report for
2678      * @param bool $showlinks - Return plain text or links to the profile
2679      * @return string - the html summary
2680      */
2681     public function view_student_summary($user, $showlinks) {
2682         global $CFG, $DB, $PAGE;
2684         $grade = $this->get_user_grade($user->id, false);
2685         $submission = $this->get_user_submission($user->id, false);
2686         $o = '';
2688         $teamsubmission = null;
2689         $submissiongroup = null;
2690         $notsubmitted = array();
2691         if ($this->get_instance()->teamsubmission) {
2692             $teamsubmission = $this->get_group_submission($user->id, 0, false);
2693             $submissiongroup = $this->get_submission_group($user->id);
2694             $groupid = 0;
2695             if ($submissiongroup) {
2696                 $groupid = $submissiongroup->id;
2697             }
2698             $notsubmitted = $this->get_submission_group_members_who_have_not_submitted($groupid, false);
2699         }
2701         if ($this->can_view_submission($user->id)) {
2702             $showedit = has_capability('mod/assign:submit', $this->context) &&
2703                          $this->submissions_open($user->id) && ($this->is_any_submission_plugin_enabled()) && $showlinks;
2704             $gradelocked = ($grade && $grade->locked) || $this->grading_disabled($user->id);
2705             // Grading criteria preview.
2706             $gradingmanager = get_grading_manager($this->context, 'mod_assign', 'submissions');
2707             $gradingcontrollerpreview = '';
2708             if ($gradingmethod = $gradingmanager->get_active_method()) {
2709                 $controller = $gradingmanager->get_controller($gradingmethod);
2710                 if ($controller->is_form_defined()) {
2711                     $gradingcontrollerpreview = $controller->render_preview($PAGE);
2712                 }
2713             }
2715             $showsubmit = ($submission || $teamsubmission) && $showlinks;
2716             if ($teamsubmission && ($teamsubmission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED)) {
2717                 $showsubmit = false;
2718             }
2719             if ($submission && ($submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED)) {
2720                 $showsubmit = false;
2721             }
2722             if (!$this->get_instance()->submissiondrafts) {
2723                 $showsubmit = false;
2724             }
2725             $extensionduedate = null;
2726             if ($grade) {
2727                 $extensionduedate = $grade->extensionduedate;
2728             }
2729             $viewfullnames = has_capability('moodle/site:viewfullnames', $this->get_course_context());
2730             $o .= $this->get_renderer()->render(new assign_submission_status($this->get_instance()->allowsubmissionsfromdate,
2731                                                               $this->get_instance()->alwaysshowdescription,
2732                                                               $submission,
2733                                                               $this->get_instance()->teamsubmission,
2734                                                               $teamsubmission,
2735                                                               $submissiongroup,
2736                                                               $notsubmitted,
2737                                                               $this->is_any_submission_plugin_enabled(),
2738                                                               $gradelocked,
2739                                                               $this->is_graded($user->id),
2740                                                               $this->get_instance()->duedate,
2741                                                               $this->get_instance()->cutoffdate,
2742                                                               $this->get_submission_plugins(),
2743                                                               $this->get_return_action(),
2744                                                               $this->get_return_params(),
2745                                                               $this->get_course_module()->id,
2746                                                               $this->get_course()->id,
2747                                                               assign_submission_status::STUDENT_VIEW,
2748                                                               $showedit,
2749                                                               $showsubmit,
2750                                                               $viewfullnames,
2751                                                               $extensionduedate,
2752                                                               $this->get_context(),
2753                                                               $this->is_blind_marking(),
2754                                                               $gradingcontrollerpreview));
2756             require_once($CFG->libdir.'/gradelib.php');
2757             require_once($CFG->dirroot.'/grade/grading/lib.php');
2759             $gradinginfo = grade_get_grades($this->get_course()->id,
2760                                         'mod',
2761                                         'assign',
2762                                         $this->get_instance()->id,
2763                                         $user->id);
2765             $gradingitem = $gradinginfo->items[0];
2766             $gradebookgrade = $gradingitem->grades[$user->id];
2768             // check to see if all feedback plugins are empty
2769             $emptyplugins = true;
2770             if ($grade) {
2771                 foreach ($this->get_feedback_plugins() as $plugin) {
2772                     if ($plugin->is_visible() && $plugin->is_enabled()) {
2773                         if (!$plugin->is_empty($grade)) {
2774                             $emptyplugins = false;
2775                         }
2776                     }
2777                 }
2778             }
2781             if (!($gradebookgrade->hidden) && ($gradebookgrade->grade !== null || !$emptyplugins)) {
2783                 $gradefordisplay = '';
2784                 $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
2786                 if ($controller = $gradingmanager->get_active_controller()) {
2787                     $controller->set_grade_range(make_grades_menu($this->get_instance()->grade));
2788                     $gradefordisplay = $controller->render_grade($PAGE,
2789                                                                  $grade->id,
2790                                                                  $gradingitem,
2791                                                                  $gradebookgrade->str_long_grade,
2792                                                                  has_capability('mod/assign:grade', $this->get_context()));
2793                 } else {
2794                     $gradefordisplay = $this->display_grade($gradebookgrade->grade, false);
2795                 }
2797                 $gradeddate = $gradebookgrade->dategraded;
2798                 $grader = $DB->get_record('user', array('id'=>$gradebookgrade->usermodified));
2800                 $feedbackstatus = new assign_feedback_status($gradefordisplay,
2801                                                       $gradeddate,
2802                                                       $grader,
2803                                                       $this->get_feedback_plugins(),
2804                                                       $grade,
2805                                                       $this->get_course_module()->id,
2806                                                       $this->get_return_action(),
2807                                                       $this->get_return_params());
2809                 $o .= $this->get_renderer()->render($feedbackstatus);
2810             }
2812         }
2813         return $o;
2814     }
2816     /**
2817      * View submissions page (contains details of current submission).
2818      *
2819      * @return string
2820      */
2821     private function view_submission_page() {
2822         global $CFG, $DB, $USER, $PAGE;
2824         $o = '';
2825         $o .= $this->get_renderer()->render(new assign_header($this->get_instance(),
2826                                                       $this->get_context(),
2827                                                       $this->show_intro(),
2828                                                       $this->get_course_module()->id));
2830         if ($this->can_grade()) {
2831             if ($this->get_instance()->teamsubmission) {
2832                 $summary = new assign_grading_summary($this->count_teams(),
2833                                                       $this->get_instance()->submissiondrafts,
2834                                                       $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_DRAFT),
2835                                                       $this->is_any_submission_plugin_enabled(),
2836                                                       $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED),
2837                                                       $this->get_instance()->cutoffdate,
2838                                                       $this->get_instance()->duedate,
2839                                                       $this->get_course_module()->id,
2840                                                       $this->count_submissions_need_grading(),
2841                                                       $this->get_instance()->teamsubmission);
2842                 $o .= $this->get_renderer()->render($summary);
2843             } else {
2844                 $summary = new assign_grading_summary($this->count_participants(0),
2845                                                       $this->get_instance()->submissiondrafts,
2846                                                       $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_DRAFT),
2847                                                       $this->is_any_submission_plugin_enabled(),
2848                                                       $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED),
2849                                                       $this->get_instance()->cutoffdate,
2850                                                       $this->get_instance()->duedate,
2851                                                       $this->get_course_module()->id,
2852                                                       $this->count_submissions_need_grading(),
2853                                                       $this->get_instance()->teamsubmission);
2854                 $o .= $this->get_renderer()->render($summary);
2855             }
2856         }
2857         $grade = $this->get_user_grade($USER->id, false);
2858         $submission = $this->get_user_submission($USER->id, false);
2860         if ($this->can_view_submission($USER->id)) {
2861             $o .= $this->view_student_summary($USER, true);
2862         }
2865         $o .= $this->view_footer();
2866         $this->add_to_log('view', get_string('viewownsubmissionstatus', 'assign'));
2867         return $o;
2868     }
2870     /**
2871      * convert the final raw grade(s) in the  grading table for the gradebook
2872      *
2873      * @param stdClass $grade
2874      * @return array
2875      */
2876     private function convert_grade_for_gradebook(stdClass $grade) {
2877         $gradebookgrade = array();
2878         // trying to match those array keys in grade update function in gradelib.php
2879         // with keys in th database table assign_grades
2880         // starting around line 262
2881         if ($grade->grade >= 0) {
2882             $gradebookgrade['rawgrade'] = $grade->grade;
2883         }
2884         $gradebookgrade['userid'] = $grade->userid;
2885         $gradebookgrade['usermodified'] = $grade->grader;
2886         $gradebookgrade['datesubmitted'] = NULL;
2887         $gradebookgrade['dategraded'] = $grade->timemodified;
2888         if (isset($grade->feedbackformat)) {
2889             $gradebookgrade['feedbackformat'] = $grade->feedbackformat;
2890         }
2891         if (isset($grade->feedbacktext)) {
2892             $gradebookgrade['feedback'] = $grade->feedbacktext;
2893         }
2895         return $gradebookgrade;
2896     }
2898     /**
2899      * convert submission details for the gradebook
2900      *
2901      * @param stdClass $submission
2902      * @return array
2903      */
2904     private function convert_submission_for_gradebook(stdClass $submission) {
2905         $gradebookgrade = array();
2908         $gradebookgrade['userid'] = $submission->userid;
2909         $gradebookgrade['usermodified'] = $submission->userid;
2910         $gradebookgrade['datesubmitted'] = $submission->timemodified;
2912         return $gradebookgrade;
2913     }
2915     /**
2916      * update grades in the gradebook
2917      *
2918      * @param mixed $submission stdClass|null
2919      * @param mixed $grade stdClass|null
2920      * @return bool
2921      */
2922     private function gradebook_item_update($submission=NULL, $grade=NULL) {
2924         // Do not push grade to gradebook if blind marking is active as the gradebook would reveal the students.
2925         if ($this->is_blind_marking()) {
2926             return false;
2927         }
2928         if ($submission != NULL) {
2929             if ($submission->userid == 0) {
2930                 // This is a group submission update.
2931                 $team = groups_get_members($submission->groupid, 'u.id');
2933                 foreach ($team as $member) {
2934                     $submission->groupid = 0;
2935                     $submission->userid = $member->id;
2936                     $this->gradebook_item_update($submission, null);
2937                 }
2938                 return;
2939             }
2941             $gradebookgrade = $this->convert_submission_for_gradebook($submission);
2943         } else {
2944             $gradebookgrade = $this->convert_grade_for_gradebook($grade);
2945         }
2946         // Grading is disabled, return.
2947         if ($this->grading_disabled($gradebookgrade['userid'])) {
2948             return false;
2949         }
2950         $assign = clone $this->get_instance();
2951         $assign->cmidnumber = $this->get_course_module()->id;
2953         return assign_grade_item_update($assign, $gradebookgrade);
2954     }
2956     /**
2957      * update team submission
2958      *
2959      * @param stdClass $submission
2960      * @param int $userid
2961      * @param bool $updatetime
2962      * @return bool
2963      */
2964     private function update_team_submission(stdClass $submission, $userid, $updatetime) {
2965         global $DB;
2967         if ($updatetime) {
2968             $submission->timemodified = time();
2969         }
2971         // First update the submission for the current user.
2972         $mysubmission = $this->get_user_submission($userid, true);
2973         $mysubmission->status = $submission->status;
2975         $this->update_submission($mysubmission, 0, $updatetime, false);
2977         // Now check the team settings to see if this assignment qualifies as submitted or draft.
2978         $team = $this->get_submission_group_members($submission->groupid, true);
2980         $allsubmitted = true;
2981         $anysubmitted = false;
2982         foreach ($team as $member) {
2983             $membersubmission = $this->get_user_submission($member->id, false);
2985             if (!$membersubmission || $membersubmission->status != ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2986                 $allsubmitted = false;
2987                 if ($anysubmitted) {
2988                     break;
2989                 }
2990             } else {
2991                 $anysubmitted = true;
2992             }
2993         }
2994         if ($this->get_instance()->requireallteammemberssubmit) {
2995             if ($allsubmitted) {
2996                 $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
2997             } else {
2998                 $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
2999             }
3000             $result= $DB->update_record('assign_submission', $submission);
3001         } else {
3002             if ($anysubmitted) {
3003                 $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
3004             } else {
3005                 $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
3006             }
3007             $result= $DB->update_record('assign_submission', $submission);
3008         }
3010         $this->gradebook_item_update($submission);
3011         return $result;
3012     }
3015     /**
3016      * update grades in the gradebook based on submission time
3017      *
3018      * @param stdClass $submission
3019      * @param int $userid
3020      * @param bool $updatetime
3021      * @param bool $teamsubmission
3022      * @return bool
3023      */
3024     private function update_submission(stdClass $submission, $userid, $updatetime, $teamsubmission) {
3025         global $DB;
3027         if ($teamsubmission) {
3028             return $this->update_team_submission($submission, $userid, $updatetime);
3029         }
3031         if ($updatetime) {
3032             $submission->timemodified = time();
3033         }
3034         $result= $DB->update_record('assign_submission', $submission);
3035         if ($result) {
3036             $this->gradebook_item_update($submission);
3037         }
3038         return $result;
3039     }
3041     /**
3042      * Is this assignment open for submissions?
3043      *
3044      * Check the due date,
3045      * prevent late submissions,
3046      * has this person already submitted,
3047      * is the assignment locked?
3048      *
3049      * @param int $userid - Optional userid so we can see if a different user can submit
3050      * @return bool
3051      */
3052     public function submissions_open($userid = 0) {
3053         global $USER;
3055         if (!$userid) {
3056             $userid = $USER->id;
3057         }
3059         $time = time();
3060         $dateopen = true;
3061         $finaldate = false;
3062         if ($this->get_instance()->cutoffdate) {
3063             $finaldate = $this->get_instance()->cutoffdate;
3064         }
3065         // User extensions.
3066         if ($finaldate) {
3067             $grade = $this->get_user_grade($userid, false);
3068             if ($grade && $grade->extensionduedate) {
3069                 // Extension can be before cut off date.
3070                 if ($grade->extensionduedate > $finaldate) {
3071                     $finaldate = $grade->extensionduedate;
3072                 }
3073             }
3074         }
3076         if ($finaldate) {
3077             $dateopen = ($this->get_instance()->allowsubmissionsfromdate <= $time && $time <= $finaldate);
3078         } else {
3079             $dateopen = ($this->get_instance()->allowsubmissionsfromdate <= $time);
3080         }
3082         if (!$dateopen) {
3083             return false;
3084         }
3086         // Now check if this user has already submitted etc.
3087         if (!is_enrolled($this->get_course_context(), $userid)) {
3088             return false;
3089         }
3090         $submission = false;
3091         if ($this->get_instance()->teamsubmission) {
3092             $submission = $this->get_group_submission($userid, 0, false);
3093         } else {
3094             $submission = $this->get_user_submission($userid, false);
3095         }
3096         if ($submission) {
3098             if ($this->get_instance()->submissiondrafts && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
3099                 // drafts are tracked and the student has submitted the assignment
3100                 return false;
3101             }
3102         }
3103         if ($grade = $this->get_user_grade($userid, false)) {
3104             if ($grade->locked) {
3105                 return false;
3106             }
3107         }
3109         if ($this->grading_disabled($userid)) {
3110             return false;
3111         }
3113         return true;
3114     }
3116     /**
3117      * render the files in file area
3118      * @param string $component
3119      * @param string $area
3120      * @param int $submissionid
3121      * @return string
3122      */
3123     public function render_area_files($component, $area, $submissionid) {
3124         global $USER;
3126         $fs = get_file_storage();
3127         $browser = get_file_browser();
3128         $files = $fs->get_area_files($this->get_context()->id, $component, $area , $submissionid , "timemodified", false);
3129         return $this->get_renderer()->assign_files($this->context, $submissionid, $area, $component);
3131     }
3133     /**
3134      * Returns a list of teachers that should be grading given submission
3135      *
3136      * @param int $userid
3137      * @return array
3138      */
3139     private function get_graders($userid) {
3140         //potential graders
3141         $potentialgraders = get_enrolled_users($this->context, "mod/assign:grade");
3143         $graders = array();
3144         if (groups_get_activity_groupmode($this->get_course_module()) == SEPARATEGROUPS) {   // Separate groups are being used
3145             if ($groups = groups_get_all_groups($this->get_course()->id, $userid)) {  // Try to find all groups
3146                 foreach ($groups as $group) {
3147                     foreach ($potentialgraders as $grader) {
3148                         if ($grader->id == $userid) {
3149                             continue; // do not send self
3150                         }
3151                         if (groups_is_member($group->id, $grader->id)) {
3152                             $graders[$grader->id] = $grader;
3153                         }
3154                     }
3155                 }
3156             } else {
3157                 // user not in group, try to find graders without group
3158                 foreach ($potentialgraders as $grader) {
3159                     if ($grader->id == $userid) {
3160                         continue; // do not send self
3161                     }
3162                     if (!groups_has_membership($this->get_course_module(), $grader->id)) {
3163                         $graders[$grader->id] = $grader;
3164                     }
3165                 }
3166             }
3167         } else {
3168             foreach ($potentialgraders as $grader) {
3169                 if ($grader->id == $userid) {
3170                     continue; // do not send self
3171                 }
3172                 // must be enrolled
3173                 if (is_enrolled($this->get_course_context(), $grader->id)) {
3174                     $graders[$grader->id] = $grader;
3175                 }
3176             }
3177         }
3178         return $graders;
3179     }
3181     /**
3182      * Format a notification for plain text
3183      *
3184      * @param string $messagetype
3185      * @param stdClass $info
3186      * @param stdClass $course
3187      * @param stdClass $context
3188      * @param string $modulename
3189      * @param string $assignmentname
3190      */
3191     private static function format_notification_message_text($messagetype, $info, $course, $context, $modulename, $assignmentname) {
3192         $posttext  = format_string($course->shortname, true, array('context' => $context->get_course_context())).' -> '.
3193                      $modulename.' -> '.
3194                      format_string($assignmentname, true, array('context' => $context))."\n";
3195         $posttext .= '---------------------------------------------------------------------'."\n";
3196         $posttext .= get_string($messagetype . 'text', "assign", $info)."\n";
3197         $posttext .= "\n---------------------------------------------------------------------\n";
3198         return $posttext;
3199     }
3201     /**
3202      * Format a notification for HTML
3203      *
3204      * @param string $messagetype
3205      * @param stdClass $info
3206      * @param stdClass $course
3207      * @param stdClass $context
3208      * @param string $modulename
3209      * @param stdClass $coursemodule
3210      * @param string $assignmentname
3211      * @param stdClass $info
3212      */
3213     private static function format_notification_message_html($messagetype, $info, $course, $context, $modulename, $coursemodule, $assignmentname) {
3214         global $CFG;
3215         $posthtml  = '<p><font face="sans-serif">'.
3216                      '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.format_string($course->shortname, true, array('context' => $context->get_course_context())).'</a> ->'.
3217                      '<a href="'.$CFG->wwwroot.'/mod/assign/index.php?id='.$course->id.'">'.$modulename.'</a> ->'.
3218                      '<a href="'.$CFG->wwwroot.'/mod/assign/view.php?id='.$coursemodule->id.'">'.format_string($assignmentname, true, array('context' => $context)).'</a></font></p>';
3219         $posthtml .= '<hr /><font face="sans-serif">';
3220         $posthtml .= '<p>'.get_string($messagetype . 'html', 'assign', $info).'</p>';
3221         $posthtml .= '</font><hr />';
3222         return $posthtml;
3223     }
3225     /**
3226      * Message someone about something (static so it can be called from cron)
3227      *
3228      * @param stdClass $userfrom
3229      * @param stdClass $userto
3230      * @param string $messagetype
3231      * @param string $eventtype
3232      * @param int $updatetime
3233      * @param stdClass $coursemodule
3234      * @param stdClass $context
3235      * @param stdClass $course
3236      * @param string $modulename
3237      * @param string $assignmentname
3238      * @return void
3239      */
3240     public static function send_assignment_notification($userfrom, $userto, $messagetype, $eventtype,
3241                                                         $updatetime, $coursemodule, $context, $course,
3242                                                         $modulename, $assignmentname, $blindmarking,
3243                                                         $uniqueidforuser) {
3244         global $CFG;
3246         $info = new stdClass();
3247         if ($blindmarking) {
3248             $info->username = get_string('participant', 'assign') . ' ' . $uniqueidforuser;
3249         } else {
3250             $info->username = fullname($userfrom, true);
3251         }
3252         $info->assignment = format_string($assignmentname,true, array('context'=>$context));
3253         $info->url = $CFG->wwwroot.'/mod/assign/view.php?id='.$coursemodule->id;
3254         $info->timeupdated = userdate($updatetime, get_string('strftimerecentfull'));
3256         $postsubject = get_string($messagetype . 'small', 'assign', $info);
3257         $posttext = self::format_notification_message_text($messagetype, $info, $course, $context, $modulename, $assignmentname);
3258         $posthtml = ($userto->mailformat == 1) ? self::format_notification_message_html($messagetype, $info, $course, $context, $modulename, $coursemodule, $assignmentname) : '';
3260         $eventdata = new stdClass();
3261         $eventdata->modulename       = 'assign';
3262         $eventdata->userfrom         = $userfrom;
3263         $eventdata->userto           = $userto;