e1e5104a0439f0a8ff903f9196db1ef0dff4742c
[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');
66 /**
67  * Standard base class for mod_assign (assignment types).
68  *
69  * @package   mod_assign
70  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
71  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
72  */
73 class assign {
76     /** @var stdClass the assignment record that contains the global settings for this assign instance */
77     private $instance;
79     /** @var context the context of the course module for this assign instance (or just the course if we are
80         creating a new one) */
81     private $context;
83     /** @var stdClass the course this assign instance belongs to */
84     private $course;
86     /** @var stdClass the admin config for all assign instances  */
87     private $adminconfig;
90     /** @var assign_renderer the custom renderer for this module */
91     private $output;
93     /** @var stdClass the course module for this assign instance */
94     private $coursemodule;
96     /** @var array cache for things like the coursemodule name or the scale menu - only lives for a single
97         request */
98     private $cache;
100     /** @var array list of the installed submission plugins */
101     private $submissionplugins;
103     /** @var array list of the installed feedback plugins */
104     private $feedbackplugins;
106     /** @var string action to be used to return to this page (without repeating any form submissions etc.) */
107     private $returnaction = 'view';
109     /** @var array params to be used to return to this page */
110     private $returnparams = array();
112     /** @var string modulename prevents excessive calls to get_string */
113     private static $modulename = null;
115     /** @var string modulenameplural prevents excessive calls to get_string */
116     private static $modulenameplural = null;
118     /**
119      * Constructor for the base assign class
120      *
121      * @param mixed $coursemodulecontext context|null the course module context (or the course context if the coursemodule has not been created yet)
122      * @param mixed $coursemodule the current course module if it was already loaded - otherwise this class will load one from the context as required
123      * @param mixed $course the current course  if it was already loaded - otherwise this class will load one from the context as required
124      */
125     public function __construct($coursemodulecontext, $coursemodule, $course) {
126         global $PAGE;
128         $this->context = $coursemodulecontext;
129         $this->coursemodule = $coursemodule;
130         $this->course = $course;
131         $this->cache = array(); // temporary cache only lives for a single request - used to reduce db lookups
133         $this->submissionplugins = $this->load_plugins('assignsubmission');
134         $this->feedbackplugins = $this->load_plugins('assignfeedback');
135         $this->output = $PAGE->get_renderer('mod_assign');
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     }
219     /**
220      * get a specific submission plugin by its type
221      * @param string $subtype assignsubmission | assignfeedback
222      * @param string $type
223      * @return mixed assign_plugin|null
224      */
225     private function get_plugin_by_type($subtype, $type) {
226         $shortsubtype = substr($subtype, strlen('assign'));
227         $name = $shortsubtype . 'plugins';
228         $pluginlist = $this->$name;
229         foreach ($pluginlist as $plugin) {
230             if ($plugin->get_type() == $type) {
231                 return $plugin;
232             }
233         }
234         return null;
235     }
237     /**
238      * Get a feedback plugin by type
239      * @param string $type - The type of plugin e.g comments
240      * @return mixed assign_feedback_plugin|null
241      */
242     public function get_feedback_plugin_by_type($type) {
243         return $this->get_plugin_by_type('assignfeedback', $type);
244     }
246     /**
247      * Get a submission plugin by type
248      * @param string $type - The type of plugin e.g comments
249      * @return mixed assign_submission_plugin|null
250      */
251     public function get_submission_plugin_by_type($type) {
252         return $this->get_plugin_by_type('assignsubmission', $type);
253     }
255     /**
256      * Load the plugins from the sub folders under subtype
257      * @param string $subtype - either submission or feedback
258      * @return array - The sorted list of plugins
259      */
260     private function load_plugins($subtype) {
261         global $CFG;
262         $result = array();
264         $names = get_plugin_list($subtype);
266         foreach ($names as $name => $path) {
267             if (file_exists($path . '/locallib.php')) {
268                 require_once($path . '/locallib.php');
270                 $shortsubtype = substr($subtype, strlen('assign'));
271                 $pluginclass = 'assign_' . $shortsubtype . '_' . $name;
273                 $plugin = new $pluginclass($this, $name);
275                 if ($plugin instanceof assign_plugin) {
276                     $idx = $plugin->get_sort_order();
277                     while (array_key_exists($idx, $result)) $idx +=1;
278                     $result[$idx] = $plugin;
279                 }
280             }
281         }
282         ksort($result);
283         return $result;
284     }
287     /**
288      * Display the assignment, used by view.php
289      *
290      * The assignment is displayed differently depending on your role,
291      * the settings for the assignment and the status of the assignment.
292      * @param string $action The current action if any.
293      * @return void
294      */
295     public function view($action='') {
297         $o = '';
298         $mform = null;
300         // handle form submissions first
301         if ($action == 'savesubmission') {
302             $action = 'editsubmission';
303             if ($this->process_save_submission($mform)) {
304                 $action = 'view';
305             }
306          } else if ($action == 'lock') {
307             $this->process_lock();
308             $action = 'grading';
309          } else if ($action == 'reverttodraft') {
310             $this->process_revert_to_draft();
311             $action = 'grading';
312          } else if ($action == 'unlock') {
313             $this->process_unlock();
314             $action = 'grading';
315          } else if ($action == 'confirmsubmit') {
316             $this->process_submit_for_grading();
317             // save and show next button
318          } else if ($action == 'batchgradingoperation') {
319             $this->process_batch_grading_operation();
320             $action = 'grading';
321          } else if ($action == 'submitgrade') {
322             if (optional_param('saveandshownext', null, PARAM_ALPHA)) {
323                 //save and show next
324                 $action = 'grade';
325                 if ($this->process_save_grade($mform)) {
326                     $action = 'nextgrade';
327                 }
328             } else if (optional_param('nosaveandprevious', null, PARAM_ALPHA)) {
329                 $action = 'previousgrade';
330             } else if (optional_param('nosaveandnext', null, PARAM_ALPHA)) {
331                 //show next button
332                 $action = 'nextgrade';
333             } else if (optional_param('savegrade', null, PARAM_ALPHA)) {
334                 //save changes button
335                 $action = 'grade';
336                 if ($this->process_save_grade($mform)) {
337                     $action = 'grading';
338                 }
339             } else {
340                 //cancel button
341                 $action = 'grading';
342             }
343         }else if ($action == 'quickgrade') {
344             $message = $this->process_save_quick_grades();
345             $action = 'quickgradingresult';
346         }else if ($action == 'saveoptions') {
347             $this->process_save_grading_options();
348             $action = 'grading';
349         }
351         $returnparams = array('rownum'=>optional_param('rownum', 0, PARAM_INT));
352         $this->register_return_link($action, $returnparams);
354         // now show the right view page
355         if ($action == 'previousgrade') {
356             $mform = null;
357             $o .= $this->view_single_grade_page($mform, -1);
358         } else if ($action == 'quickgradingresult') {
359             $mform = null;
360             $o .= $this->view_quickgrading_result($message);
361         } else if ($action == 'nextgrade') {
362             $mform = null;
363             $o .= $this->view_single_grade_page($mform, 1);
364         } else if ($action == 'grade') {
365             $o .= $this->view_single_grade_page($mform);
366         } else if ($action == 'viewpluginassignfeedback') {
367             $o .= $this->view_plugin_content('assignfeedback');
368         } else if ($action == 'viewpluginassignsubmission') {
369             $o .= $this->view_plugin_content('assignsubmission');
370         } else if ($action == 'editsubmission') {
371             $o .= $this->view_edit_submission_page($mform);
372         } else if ($action == 'grading') {
373             $o .= $this->view_grading_page();
374         } else if ($action == 'downloadall') {
375             $o .= $this->download_submissions();
376         } else if ($action == 'submit') {
377             $o .= $this->check_submit_for_grading();
378         } else {
379             $o .= $this->view_submission_page();
380         }
382         return $o;
383     }
386     /**
387      * Add this instance to the database
388      *
389      * @param stdClass $formdata The data submitted from the form
390      * @param bool $callplugins This is used to skip the plugin code
391      *             when upgrading an old assignment to a new one (the plugins get called manually)
392      * @return mixed false if an error occurs or the int id of the new instance
393      */
394     public function add_instance(stdClass $formdata, $callplugins) {
395         global $DB;
397         $err = '';
399         // add the database record
400         $update = new stdClass();
401         $update->name = $formdata->name;
402         $update->timemodified = time();
403         $update->timecreated = time();
404         $update->course = $formdata->course;
405         $update->courseid = $formdata->course;
406         $update->intro = $formdata->intro;
407         $update->introformat = $formdata->introformat;
408         $update->alwaysshowdescription = $formdata->alwaysshowdescription;
409         $update->preventlatesubmissions = $formdata->preventlatesubmissions;
410         $update->submissiondrafts = $formdata->submissiondrafts;
411         $update->sendnotifications = $formdata->sendnotifications;
412         $update->sendlatenotifications = $formdata->sendlatenotifications;
413         $update->duedate = $formdata->duedate;
414         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
415         $update->grade = $formdata->grade;
416         $returnid = $DB->insert_record('assign', $update);
417         $this->instance = $DB->get_record('assign', array('id'=>$returnid), '*', MUST_EXIST);
418         // cache the course record
419         $this->course = $DB->get_record('course', array('id'=>$formdata->course), '*', MUST_EXIST);
421         if ($callplugins) {
422             // call save_settings hook for submission plugins
423             foreach ($this->submissionplugins as $plugin) {
424                 if (!$this->update_plugin_instance($plugin, $formdata)) {
425                     print_error($plugin->get_error());
426                     return false;
427                 }
428             }
429             foreach ($this->feedbackplugins as $plugin) {
430                 if (!$this->update_plugin_instance($plugin, $formdata)) {
431                     print_error($plugin->get_error());
432                     return false;
433                 }
434             }
436             // in the case of upgrades the coursemodule has not been set so we need to wait before calling these two
437             // TODO: add event to the calendar
438             $this->update_calendar($formdata->coursemodule);
439             // TODO: add the item in the gradebook
440             $this->update_gradebook(false, $formdata->coursemodule);
442         }
444         $update = new stdClass();
445         $update->id = $this->get_instance()->id;
446         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
447         $DB->update_record('assign', $update);
449         return $returnid;
450     }
452     /**
453      * Delete all grades from the gradebook for this assignment
454      *
455      * @return bool
456      */
457     private function delete_grades() {
458         global $CFG;
460         return grade_update('mod/assign', $this->get_course()->id, 'mod', 'assign', $this->get_instance()->id, 0, NULL, array('deleted'=>1)) == GRADE_UPDATE_OK;
461     }
463     /**
464      * Delete this instance from the database
465      *
466      * @return bool false if an error occurs
467      */
468     public function delete_instance() {
469         global $DB;
470         $result = true;
472         foreach ($this->submissionplugins as $plugin) {
473             if (!$plugin->delete_instance()) {
474                 print_error($plugin->get_error());
475                 $result = false;
476             }
477         }
478         foreach ($this->feedbackplugins as $plugin) {
479             if (!$plugin->delete_instance()) {
480                 print_error($plugin->get_error());
481                 $result = false;
482             }
483         }
485         // delete files associated with this assignment
486         $fs = get_file_storage();
487         if (! $fs->delete_area_files($this->context->id) ) {
488             $result = false;
489         }
491         // delete_records will throw an exception if it fails - so no need for error checking here
493         $DB->delete_records('assign_submission', array('assignment'=>$this->get_instance()->id));
494         $DB->delete_records('assign_grades', array('assignment'=>$this->get_instance()->id));
495         $DB->delete_records('assign_plugin_config', array('assignment'=>$this->get_instance()->id));
497         // delete items from the gradebook
498         if (! $this->delete_grades()) {
499             $result = false;
500         }
502         // delete the instance
503         $DB->delete_records('assign', array('id'=>$this->get_instance()->id));
505         return $result;
506     }
508     /**
509      * Update the settings for a single plugin
510      *
511      * @param assign_plugin $plugin The plugin to update
512      * @param stdClass $formdata The form data
513      * @return bool false if an error occurs
514      */
515     private function update_plugin_instance(assign_plugin $plugin, stdClass $formdata) {
516         if ($plugin->is_visible()) {
517             $enabledname = $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled';
518             if ($formdata->$enabledname) {
519                 $plugin->enable();
520                 if (!$plugin->save_settings($formdata)) {
521                     print_error($plugin->get_error());
522                     return false;
523                 }
524             } else {
525                 $plugin->disable();
526             }
527         }
528         return true;
529     }
531     /**
532      * Update the gradebook information for this assignment
533      *
534      * @param bool $reset If true, will reset all grades in the gradbook for this assignment
535      * @param int $coursemoduleid This is required because it might not exist in the database yet
536      * @return bool
537      */
538     public function update_gradebook($reset, $coursemoduleid) {
539          global $CFG;
540         /** Include lib.php */
541         require_once($CFG->dirroot.'/mod/assign/lib.php');
542         $assign = clone $this->get_instance();
543         $assign->cmidnumber = $coursemoduleid;
544         $param = null;
545         if ($reset) {
546             $param = 'reset';
547         }
549         return assign_grade_item_update($assign, $param);
550     }
552     /** Load and cache the admin config for this module
553      *
554      * @return stdClass the plugin config
555      */
556     public function get_admin_config() {
557         if ($this->adminconfig) {
558             return $this->adminconfig;
559         }
560         $this->adminconfig = get_config('assign');
561         return $this->adminconfig;
562     }
565     /**
566      * Update the calendar entries for this assignment
567      *
568      * @param int $coursemoduleid - Required to pass this in because it might not exist in the database yet
569      * @return bool
570      */
571     public function update_calendar($coursemoduleid) {
572         global $DB, $CFG;
573         require_once($CFG->dirroot.'/calendar/lib.php');
575         // special case for add_instance as the coursemodule has not been set yet.
577         if ($this->get_instance()->duedate) {
578             $event = new stdClass();
580             if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assign', 'instance'=>$this->get_instance()->id))) {
582                 $event->name        = $this->get_instance()->name;
584                 $event->description = format_module_intro('assign', $this->get_instance(), $coursemoduleid);
585                 $event->timestart   = $this->get_instance()->duedate;
587                 $calendarevent = calendar_event::load($event->id);
588                 $calendarevent->update($event);
589             } else {
590                 $event = new stdClass();
591                 $event->name        = $this->get_instance()->name;
592                 $event->description = format_module_intro('assign', $this->get_instance(), $coursemoduleid);
593                 $event->courseid    = $this->get_instance()->course;
594                 $event->groupid     = 0;
595                 $event->userid      = 0;
596                 $event->modulename  = 'assign';
597                 $event->instance    = $this->get_instance()->id;
598                 $event->eventtype   = 'due';
599                 $event->timestart   = $this->get_instance()->duedate;
600                 $event->timeduration = 0;
602                 calendar_event::create($event);
603             }
604         } else {
605             $DB->delete_records('event', array('modulename'=>'assign', 'instance'=>$this->get_instance()->id));
606         }
607     }
610     /**
611      * Update this instance in the database
612      *
613      * @param stdClass $formdata - the data submitted from the form
614      * @return bool false if an error occurs
615      */
616     public function update_instance($formdata) {
617         global $DB;
619         $update = new stdClass();
620         $update->id = $formdata->instance;
621         $update->name = $formdata->name;
622         $update->timemodified = time();
623         $update->course = $formdata->course;
624         $update->intro = $formdata->intro;
625         $update->introformat = $formdata->introformat;
626         $update->alwaysshowdescription = $formdata->alwaysshowdescription;
627         $update->preventlatesubmissions = $formdata->preventlatesubmissions;
628         $update->submissiondrafts = $formdata->submissiondrafts;
629         $update->sendnotifications = $formdata->sendnotifications;
630         $update->sendlatenotifications = $formdata->sendlatenotifications;
631         $update->duedate = $formdata->duedate;
632         $update->allowsubmissionsfromdate = $formdata->allowsubmissionsfromdate;
633         $update->grade = $formdata->grade;
635         $result = $DB->update_record('assign', $update);
636         $this->instance = $DB->get_record('assign', array('id'=>$update->id), '*', MUST_EXIST);
638         // load the assignment so the plugins have access to it
640         // call save_settings hook for submission plugins
641         foreach ($this->submissionplugins as $plugin) {
642             if (!$this->update_plugin_instance($plugin, $formdata)) {
643                 print_error($plugin->get_error());
644                 return false;
645             }
646         }
647         foreach ($this->feedbackplugins as $plugin) {
648             if (!$this->update_plugin_instance($plugin, $formdata)) {
649                 print_error($plugin->get_error());
650                 return false;
651             }
652         }
655         // update the database record
658         // update all the calendar events
659         $this->update_calendar($this->get_course_module()->id);
661         $this->update_gradebook(false, $this->get_course_module()->id);
663         $update = new stdClass();
664         $update->id = $this->get_instance()->id;
665         $update->nosubmissions = (!$this->is_any_submission_plugin_enabled()) ? 1: 0;
666         $DB->update_record('assign', $update);
672         return $result;
673     }
675     /**
676      * add elements in grading plugin form
677      *
678      * @param mixed $grade stdClass|null
679      * @param MoodleQuickForm $mform
680      * @param stdClass $data
681      * @return void
682      */
683     private function add_plugin_grade_elements($grade, MoodleQuickForm $mform, stdClass $data) {
684         foreach ($this->feedbackplugins as $plugin) {
685             if ($plugin->is_enabled() && $plugin->is_visible()) {
686                 $mform->addElement('header', 'header_' . $plugin->get_type(), $plugin->get_name());
687                 if (!$plugin->get_form_elements($grade, $mform, $data)) {
688                     $mform->removeElement('header_' . $plugin->get_type());
689                 }
690             }
691         }
692     }
696     /**
697      * Add one plugins settings to edit plugin form
698      *
699      * @param assign_plugin $plugin The plugin to add the settings from
700      * @param MoodleQuickForm $mform The form to add the configuration settings to. This form is modified directly (not returned)
701      * @return void
702      */
703     private function add_plugin_settings(assign_plugin $plugin, MoodleQuickForm $mform) {
704         global $CFG;
705         if ($plugin->is_visible()) {
706             // enabled
707             //tied disableIf rule to this select element
708             $mform->addElement('selectyesno', $plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $plugin->get_name());
709             $mform->addHelpButton($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', 'enabled', $plugin->get_subtype() . '_' . $plugin->get_type());
712             $default = get_config($plugin->get_subtype() . '_' . $plugin->get_type(), 'default');
713             if ($plugin->get_config('enabled') !== false) {
714                 $default = $plugin->is_enabled();
715             }
716             $mform->setDefault($plugin->get_subtype() . '_' . $plugin->get_type() . '_enabled', $default);
718             $plugin->get_settings($mform);
720         }
722     }
725     /**
726      * Add settings to edit plugin form
727      *
728      * @param MoodleQuickForm $mform The form to add the configuration settings to. This form is modified directly (not returned)
729      * @return void
730      */
731     public function add_all_plugin_settings(MoodleQuickForm $mform) {
732         $mform->addElement('header', 'general', get_string('submissionsettings', 'assign'));
734         foreach ($this->submissionplugins as $plugin) {
735             $this->add_plugin_settings($plugin, $mform);
737         }
738         $mform->addElement('header', 'general', get_string('feedbacksettings', 'assign'));
739         foreach ($this->feedbackplugins as $plugin) {
740             $this->add_plugin_settings($plugin, $mform);
741         }
742     }
744     /**
745      * Allow each plugin an opportunity to update the defaultvalues
746      * passed in to the settings form (needed to set up draft areas for
747      * editor and filemanager elements)
748      * @param array $defaultvalues
749      */
750     public function plugin_data_preprocessing(&$defaultvalues) {
751         foreach ($this->submissionplugins as $plugin) {
752             if ($plugin->is_visible()) {
753                 $plugin->data_preprocessing($defaultvalues);
754             }
755         }
756         foreach ($this->feedbackplugins as $plugin) {
757             if ($plugin->is_visible()) {
758                 $plugin->data_preprocessing($defaultvalues);
759             }
760         }
761     }
763     /**
764      * Get the name of the current module.
765      *
766      * @return string the module name (Assignment)
767      */
768     protected function get_module_name() {
769         if (isset(self::$modulename)) {
770             return self::$modulename;
771         }
772         self::$modulename = get_string('modulename', 'assign');
773         return self::$modulename;
774     }
776     /**
777      * Get the plural name of the current module.
778      *
779      * @return string the module name plural (Assignments)
780      */
781     protected function get_module_name_plural() {
782         if (isset(self::$modulenameplural)) {
783             return self::$modulenameplural;
784         }
785         self::$modulenameplural = get_string('modulenameplural', 'assign');
786         return self::$modulenameplural;
787     }
789     /**
790      * Has this assignment been constructed from an instance?
791      *
792      * @return bool
793      */
794     public function has_instance() {
795         return $this->instance || $this->get_course_module();
796     }
798     /**
799      * Get the settings for the current instance of this assignment
800      *
801      * @return stdClass The settings
802      */
803     public function get_instance() {
804         global $DB;
805         if ($this->instance) {
806             return $this->instance;
807         }
808         if ($this->get_course_module()) {
809             $this->instance = $DB->get_record('assign', array('id' => $this->get_course_module()->instance), '*', MUST_EXIST);
810         }
811         if (!$this->instance) {
812             throw new coding_exception('Improper use of the assignment class. Cannot load the assignment record.');
813         }
814         return $this->instance;
815     }
817     /**
818      * Get the context of the current course
819      * @return mixed context|null The course context
820      */
821     public function get_course_context() {
822         if (!$this->context && !$this->course) {
823             throw new coding_exception('Improper use of the assignment class. Cannot load the course context.');
824         }
825         if ($this->context) {
826             return $this->context->get_course_context();
827         } else {
828             return context_course::instance($this->course->id);
829         }
830     }
833     /**
834      * Get the current course module
835      *
836      * @return mixed stdClass|null The course module
837      */
838     public function get_course_module() {
839         if ($this->coursemodule) {
840             return $this->coursemodule;
841         }
842         if (!$this->context) {
843             return null;
844         }
846         if ($this->context->contextlevel == CONTEXT_MODULE) {
847             $this->coursemodule = get_coursemodule_from_id('assign', $this->context->instanceid, 0, false, MUST_EXIST);
848             return $this->coursemodule;
849         }
850         return null;
851     }
853     /**
854      * Get context module
855      *
856      * @return context
857      */
858     public function get_context() {
859         return $this->context;
860     }
862     /**
863      * Get the current course
864      * @return mixed stdClass|null The course
865      */
866     public function get_course() {
867         global $DB;
868         if ($this->course) {
869             return $this->course;
870         }
872         if (!$this->context) {
873             return null;
874         }
875         $this->course = $DB->get_record('course', array('id' => $this->get_course_context()->instanceid), '*', MUST_EXIST);
876         return $this->course;
877     }
879     /**
880      * Return a grade in user-friendly form, whether it's a scale or not
881      *
882      * @param mixed $grade int|null
883      * @param boolean $editing Are we allowing changes to this grade?
884      * @param int $userid The user id the grade belongs to
885      * @param int $modified Timestamp from when the grade was last modified
886      * @return string User-friendly representation of grade
887      */
888     public function display_grade($grade, $editing, $userid=0, $modified=0) {
889         global $DB;
891         static $scalegrades = array();
893         if ($this->get_instance()->grade >= 0) {
894             // Normal number
895             if ($editing && $this->get_instance()->grade > 0) {
896                 if ($grade < 0) {
897                     $displaygrade = '';
898                 } else {
899                     $displaygrade = format_float($grade);
900                 }
901                 $o = '<input type="text" name="quickgrade_' . $userid . '" value="' . $displaygrade . '" size="6" maxlength="10" class="quickgrade"/>';
902                 $o .= '&nbsp;/&nbsp;' . format_float($this->get_instance()->grade,2);
903                 $o .= '<input type="hidden" name="grademodified_' . $userid . '" value="' . $modified . '"/>';
904                 return $o;
905             } else {
906                 if ($grade == -1 || $grade === null) {
907                     return '-';
908                 } else {
909                     return format_float(($grade),2) .'&nbsp;/&nbsp;'. format_float($this->get_instance()->grade,2);
910                 }
911             }
913         } else {
914             // Scale
915             if (empty($this->cache['scale'])) {
916                 if ($scale = $DB->get_record('scale', array('id'=>-($this->get_instance()->grade)))) {
917                     $this->cache['scale'] = make_menu_from_list($scale->scale);
918                 } else {
919                     return '-';
920                 }
921             }
922             if ($editing) {
923                 $o = '<select name="quickgrade_' . $userid . '" class="quickgrade">';
924                 $o .= '<option value="-1">' . get_string('nograde') . '</option>';
925                 foreach ($this->cache['scale'] as $optionid => $option) {
926                     $selected = '';
927                     if ($grade == $optionid) {
928                         $selected = 'selected="selected"';
929                     }
930                     $o .= '<option value="' . $optionid . '" ' . $selected . '>' . $option . '</option>';
931                 }
932                 $o .= '</select>';
933                 $o .= '<input type="hidden" name="grademodified_' . $userid . '" value="' . $modified . '"/>';
934                 return $o;
935             } else {
936                 $scaleid = (int)$grade;
937                 if (isset($this->cache['scale'][$scaleid])) {
938                     return $this->cache['scale'][$scaleid];
939                 }
940                 return '-';
941             }
942         }
943     }
945     /**
946      * Load a list of users enrolled in the current course with the specified permission and group (0 for no group)
947      *
948      * @param int $currentgroup
949      * @param bool $idsonly
950      * @return array List of user records
951      */
952     public function list_participants($currentgroup, $idsonly) {
953         if ($idsonly) {
954             return get_enrolled_users($this->context, "mod/assign:submit", $currentgroup, 'u.id');
955         } else {
956             return get_enrolled_users($this->context, "mod/assign:submit", $currentgroup);
957         }
958     }
960     /**
961      * Load a count of users enrolled in the current course with the specified permission and group (0 for no group)
962      *
963      * @param int $currentgroup
964      * @return int number of matching users
965      */
966     public function count_participants($currentgroup) {
967         return count_enrolled_users($this->context, "mod/assign:submit", $currentgroup);
968     }
970     /**
971      * Load a count of users submissions in the current module that require grading
972      * This means the submission modification time is more recent than the
973      * grading modification time.
974      *
975      * @return int number of matching submissions
976      */
977     public function count_submissions_need_grading() {
978         global $DB;
980         $params = array($this->get_course_module()->instance);
982         return $DB->count_records_sql("SELECT COUNT('x')
983                                        FROM {assign_submission} s
984                                        LEFT JOIN {assign_grades} g ON s.assignment = g.assignment AND s.userid = g.userid
985                                        WHERE s.assignment = ?
986                                            AND s.timemodified IS NOT NULL
987                                            AND (s.timemodified > g.timemodified OR g.timemodified IS NULL)",
988                                        $params);
989     }
991     /**
992      * Load a count of users enrolled in the current course with the specified permission and group (optional)
993      *
994      * @param string $status The submission status - should match one of the constants
995      * @return int number of matching submissions
996      */
997     public function count_submissions_with_status($status) {
998         global $DB;
999         return $DB->count_records_sql("SELECT COUNT('x')
1000                                      FROM {assign_submission}
1001                                     WHERE assignment = ? AND
1002                                           status = ?", array($this->get_course_module()->instance, $status));
1003     }
1005     /**
1006      * Utility function to get the userid for every row in the grading table
1007      * so the order can be frozen while we iterate it
1008      *
1009      * @return array An array of userids
1010      */
1011     private function get_grading_userid_list(){
1012         $filter = get_user_preferences('assign_filter', '');
1013         $table = new assign_grading_table($this, 0, $filter, 0, false);
1015         $useridlist = $table->get_column_data('userid');
1017         return $useridlist;
1018     }
1021     /**
1022      * Utility function get the userid based on the row number of the grading table.
1023      * This takes into account any active filters on the table.
1024      *
1025      * @param int $num The row number of the user
1026      * @param bool $last This is set to true if this is the last user in the table
1027      * @return mixed The user id of the matching user or false if there was an error
1028      */
1029     private function get_userid_for_row($num, $last){
1030         if (!array_key_exists('userid_for_row', $this->cache)) {
1031             $this->cache['userid_for_row'] = array();
1032         }
1033         if (array_key_exists($num, $this->cache['userid_for_row'])) {
1034             list($userid, $last) = $this->cache['userid_for_row'][$num];
1035             return $userid;
1036         }
1038         $filter = get_user_preferences('assign_filter', '');
1039         $table = new assign_grading_table($this, 0, $filter, 0, false);
1041         $userid = $table->get_cell_data($num, 'userid', $last);
1043         $this->cache['userid_for_row'][$num] = array($userid, $last);
1044         return $userid;
1045     }
1047     /**
1048      * Return all assignment submissions by ENROLLED students (even empty)
1049      *
1050      * @param string $sort optional field names for the ORDER BY in the sql query
1051      * @param string $dir optional specifying the sort direction, defaults to DESC
1052      * @return array The submission objects indexed by id
1053      */
1054     private function get_all_submissions( $sort="", $dir="DESC") {
1055         global $CFG, $DB;
1057         if ($sort == "lastname" or $sort == "firstname") {
1058             $sort = "u.$sort $dir";
1059         } else if (empty($sort)) {
1060             $sort = "a.timemodified DESC";
1061         } else {
1062             $sort = "a.$sort $dir";
1063         }
1065         return $DB->get_records_sql("SELECT a.*
1066                                        FROM {assign_submission} a, {user} u
1067                                       WHERE u.id = a.userid
1068                                             AND a.assignment = ?
1069                                    ORDER BY $sort", array($this->get_instance()->id));
1071     }
1073     /**
1074      * Generate zip file from array of given files
1075      *
1076      * @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
1077      * @return path of temp file - note this returned file does not have a .zip extension - it is a temp file.
1078      */
1079      private function pack_files($filesforzipping) {
1080          global $CFG;
1081          //create path for new zip file.
1082          $tempzip = tempnam($CFG->tempdir.'/', 'assignment_');
1083          //zip files
1084          $zipper = new zip_packer();
1085          if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
1086              return $tempzip;
1087          }
1088          return false;
1089     }
1091     /**
1092      * Finds all assignment notifications that have yet to be mailed out, and mails them.
1093      *
1094      * Cron function to be run periodically according to the moodle cron
1095      *
1096      * @return bool
1097      */
1098     static function cron() {
1099         global $DB;
1101         // only ever send a max of one days worth of updates
1102         $yesterday = time() - (24 * 3600);
1103         $timenow   = time();
1105         // Collect all submissions from the past 24 hours that require mailing.
1106         $sql = "SELECT s.*, a.course, a.name, g.*, g.id as gradeid, g.timemodified as lastmodified
1107                  FROM {assign} a
1108                  JOIN {assign_grades} g ON g.assignment = a.id
1109             LEFT JOIN {assign_submission} s ON s.assignment = a.id AND s.userid = g.userid
1110                 WHERE g.timemodified >= :yesterday AND
1111                       g.timemodified <= :today AND
1112                       g.mailed = 0";
1113         $params = array('yesterday' => $yesterday, 'today' => $timenow);
1114         $submissions = $DB->get_records_sql($sql, $params);
1116         if (empty($submissions)) {
1117             mtrace('done.');
1118             return true;
1119         }
1121         mtrace('Processing ' . count($submissions) . ' assignment submissions ...');
1123         // Preload courses we are going to need those.
1124         $courseids = array();
1125         foreach ($submissions as $submission) {
1126             $courseids[] = $submission->course;
1127         }
1128         // Filter out duplicates
1129         $courseids = array_unique($courseids);
1130         $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
1131         list($courseidsql, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
1132         $sql = "SELECT c.*, {$ctxselect}
1133                   FROM {course} c
1134              LEFT JOIN {context} ctx ON ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel
1135                  WHERE c.id {$courseidsql}";
1136         $params['contextlevel'] = CONTEXT_COURSE;
1137         $courses = $DB->get_records_sql($sql, $params);
1138         // Clean up... this could go on for a while.
1139         unset($courseids);
1140         unset($ctxselect);
1141         unset($courseidsql);
1142         unset($params);
1144         // Simple array we'll use for caching modules.
1145         $modcache = array();
1147         // Message students about new feedback
1148         foreach ($submissions as $submission) {
1150             mtrace("Processing assignment submission $submission->id ...");
1152             // do not cache user lookups - could be too many
1153             if (!$user = $DB->get_record("user", array("id"=>$submission->userid))) {
1154                 mtrace("Could not find user $submission->userid");
1155                 continue;
1156             }
1158             // use a cache to prevent the same DB queries happening over and over
1159             if (!array_key_exists($submission->course, $courses)) {
1160                 mtrace("Could not find course $submission->course");
1161                 continue;
1162             }
1163             $course = $courses[$submission->course];
1164             if (isset($course->ctxid)) {
1165                 // Context has not yet been preloaded. Do so now.
1166                 context_helper::preload_from_record($course);
1167             }
1169             // Override the language and timezone of the "current" user, so that
1170             // mail is customised for the receiver.
1171             cron_setup_user($user, $course);
1173             // context lookups are already cached
1174             $coursecontext = context_course::instance($course->id);
1175             if (!is_enrolled($coursecontext, $user->id)) {
1176                 $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
1177                 mtrace(fullname($user)." not an active participant in " . $courseshortname);
1178                 continue;
1179             }
1181             if (!$grader = $DB->get_record("user", array("id"=>$submission->grader))) {
1182                 mtrace("Could not find grader $submission->grader");
1183                 continue;
1184             }
1186             if (!array_key_exists($submission->assignment, $modcache)) {
1187                 if (! $mod = get_coursemodule_from_instance("assign", $submission->assignment, $course->id)) {
1188                     mtrace("Could not find course module for assignment id $submission->assignment");
1189                     continue;
1190                 }
1191                 $modcache[$submission->assignment] = $mod;
1192             } else {
1193                 $mod = $modcache[$submission->assignment];
1194             }
1195             // context lookups are already cached
1196             $contextmodule = context_module::instance($mod->id);
1198             if (!$mod->visible) {
1199                 // Hold mail notification for hidden assignments until later
1200                 continue;
1201             }
1203             // need to send this to the student
1204             $messagetype = 'feedbackavailable';
1205             $eventtype = 'assign_notification';
1206             $updatetime = $submission->lastmodified;
1207             $modulename = get_string('modulename', 'assign');
1208             self::send_assignment_notification($grader, $user, $messagetype, $eventtype, $updatetime, $mod, $contextmodule, $course, $modulename, $submission->name);
1210             $grade = new stdClass();
1211             $grade->id = $submission->gradeid;
1212             $grade->mailed = 1;
1213             $DB->update_record('assign_grades', $grade);
1215             mtrace('Done');
1216         }
1217         mtrace('Done processing ' . count($submissions) . ' assignment submissions');
1219         cron_setup_user();
1221         // Free up memory just to be sure
1222         unset($courses);
1223         unset($modcache);
1225         return true;
1226     }
1228     /**
1229      * Update a grade in the grade table for the assignment and in the gradebook
1230      *
1231      * @param stdClass $grade a grade record keyed on id
1232      * @return bool true for success
1233      */
1234     private function update_grade($grade) {
1235         global $DB;
1237         $grade->timemodified = time();
1239         if ($grade->grade && $grade->grade != -1) {
1240             if ($this->get_instance()->grade > 0) {
1241                 if (!is_numeric($grade->grade)) {
1242                     return false;
1243                 } else if ($grade->grade > $this->get_instance()->grade) {
1244                     return false;
1245                 } else if ($grade->grade < 0) {
1246                     return false;
1247                 }
1248             } else {
1249                 // this is a scale
1250                 if ($scale = $DB->get_record('scale', array('id' => -($this->get_instance()->grade)))) {
1251                     $scaleoptions = make_menu_from_list($scale->scale);
1252                     if (!array_key_exists((int) $grade->grade, $scaleoptions)) {
1253                         return false;
1254                     }
1255                 }
1256             }
1257         }
1259         $result = $DB->update_record('assign_grades', $grade);
1260         if ($result) {
1261             $this->gradebook_item_update(null, $grade);
1262         }
1263         return $result;
1264     }
1266     /**
1267      * display the submission that is used by a plugin
1268      * Uses url parameters 'sid', 'gid' and 'plugin'
1269      * @param string $pluginsubtype
1270      * @return string
1271      */
1272     private function view_plugin_content($pluginsubtype) {
1273         global $USER;
1275         $o = '';
1277         $submissionid = optional_param('sid', 0, PARAM_INT);
1278         $gradeid = optional_param('gid', 0, PARAM_INT);
1279         $plugintype = required_param('plugin', PARAM_TEXT);
1280         $item = null;
1281         if ($pluginsubtype == 'assignsubmission') {
1282             $plugin = $this->get_submission_plugin_by_type($plugintype);
1283             if ($submissionid <= 0) {
1284                 throw new coding_exception('Submission id should not be 0');
1285             }
1286             $item = $this->get_submission($submissionid);
1288             // permissions
1289             if ($item->userid != $USER->id) {
1290                 require_capability('mod/assign:grade', $this->context);
1291             }
1292             $o .= $this->output->render(new assign_header($this->get_instance(),
1293                                                               $this->get_context(),
1294                                                               $this->show_intro(),
1295                                                               $this->get_course_module()->id,
1296                                                               $plugin->get_name()));
1297             $o .= $this->output->render(new assign_submission_plugin_submission($plugin,
1298                                                               $item,
1299                                                               assign_submission_plugin_submission::FULL,
1300                                                               $this->get_course_module()->id,
1301                                                               $this->get_return_action(),
1302                                                               $this->get_return_params()));
1304             $this->add_to_log('view submission', get_string('viewsubmissionforuser', 'assign', $item->userid));
1305         } else {
1306             $plugin = $this->get_feedback_plugin_by_type($plugintype);
1307             if ($gradeid <= 0) {
1308                 throw new coding_exception('Grade id should not be 0');
1309             }
1310             $item = $this->get_grade($gradeid);
1311             // permissions
1312             if ($item->userid != $USER->id) {
1313                 require_capability('mod/assign:grade', $this->context);
1314             }
1315             $o .= $this->output->render(new assign_header($this->get_instance(),
1316                                                               $this->get_context(),
1317                                                               $this->show_intro(),
1318                                                               $this->get_course_module()->id,
1319                                                               $plugin->get_name()));
1320             $o .= $this->output->render(new assign_feedback_plugin_feedback($plugin,
1321                                                               $item,
1322                                                               assign_feedback_plugin_feedback::FULL,
1323                                                               $this->get_course_module()->id,
1324                                                               $this->get_return_action(),
1325                                                               $this->get_return_params()));
1326             $this->add_to_log('view feedback', get_string('viewfeedbackforuser', 'assign', $item->userid));
1327         }
1330         $o .= $this->view_return_links();
1332         $o .= $this->view_footer();
1333         return $o;
1334     }
1336     /**
1337      * render the content in editor that is often used by plugin
1338      *
1339      * @param string $filearea
1340      * @param int  $submissionid
1341      * @param string $plugintype
1342      * @param string $editor
1343      * @param string $component
1344      * @return string
1345      */
1346     public function render_editor_content($filearea, $submissionid, $plugintype, $editor, $component) {
1347         global $CFG;
1349         $result = '';
1351         $plugin = $this->get_submission_plugin_by_type($plugintype);
1353         $text = $plugin->get_editor_text($editor, $submissionid);
1354         $format = $plugin->get_editor_format($editor, $submissionid);
1356         $finaltext = file_rewrite_pluginfile_urls($text, 'pluginfile.php', $this->get_context()->id, $component, $filearea, $submissionid);
1357         $result .= format_text($finaltext, $format, array('overflowdiv' => true, 'context' => $this->get_context()));
1361         if ($CFG->enableportfolios) {
1362             require_once($CFG->libdir . '/portfoliolib.php');
1364             $button = new portfolio_add_button();
1365             $button->set_callback_options('assign_portfolio_caller', array('cmid' => $this->get_course_module()->id, 'sid' => $submissionid, 'plugin' => $plugintype, 'editor' => $editor, 'area'=>$filearea), '/mod/assign/portfolio_callback.php');
1366             $fs = get_file_storage();
1368             if ($files = $fs->get_area_files($this->context->id, $component,$filearea, $submissionid, "timemodified", false)) {
1369                 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1370             } else {
1371                 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1372             }
1373             $result .= $button->to_html();
1374         }
1375         return $result;
1376     }
1378     /**
1379      * Display a grading error
1380      *
1381      * @param string $message - The description of the result
1382      * @return string
1383      */
1384     private function view_quickgrading_result($message) {
1385         $o = '';
1386         $o .= $this->output->render(new assign_header($this->get_instance(),
1387                                                       $this->get_context(),
1388                                                       $this->show_intro(),
1389                                                       $this->get_course_module()->id,
1390                                                       get_string('quickgradingresult', 'assign')));
1391         $o .= $this->output->render(new assign_quickgrading_result($message, $this->get_course_module()->id));
1392         $o .= $this->view_footer();
1393         return $o;
1394     }
1396     /**
1397      * Display the page footer
1398      *
1399      * @return string
1400      */
1401     private function view_footer() {
1402         return $this->output->render_footer();
1403     }
1405     /**
1406      * Does this user have grade permission for this assignment
1407      *
1408      * @return bool
1409      */
1410     private function can_grade() {
1411         // Permissions check
1412         if (!has_capability('mod/assign:grade', $this->context)) {
1413             return false;
1414         }
1416         return true;
1417     }
1419     /**
1420      * Download a zip file of all assignment submissions
1421      *
1422      * @return void
1423      */
1424     private function download_submissions() {
1425         global $CFG,$DB;
1427         // more efficient to load this here
1428         require_once($CFG->libdir.'/filelib.php');
1430         // load all submissions
1431         $submissions = $this->get_all_submissions('','');
1433         if (empty($submissions)) {
1434             print_error('errornosubmissions', 'assign');
1435             return;
1436         }
1438         // build a list of files to zip
1439         $filesforzipping = array();
1440         $fs = get_file_storage();
1442         $groupmode = groups_get_activity_groupmode($this->get_course_module());
1443         $groupid = 0;   // All users
1444         $groupname = '';
1445         if ($groupmode) {
1446             $groupid = groups_get_activity_group($this->get_course_module(), true);
1447             $groupname = groups_get_group_name($groupid).'-';
1448         }
1450         // construct the zip file name
1451         $filename = str_replace(' ', '_', clean_filename($this->get_course()->shortname.'-'.$this->get_instance()->name.'-'.$groupname.$this->get_course_module()->id.".zip")); //name of new zip file.
1453         // get all the files for each submission
1454         foreach ($submissions as $submission) {
1455             $userid = $submission->userid; //get userid
1456             if ((groups_is_member($groupid,$userid) or !$groupmode or !$groupid)) {
1457                 // get the plugins to add their own files to the zip
1459                 $user = $DB->get_record("user", array("id"=>$userid),'id,username,firstname,lastname', MUST_EXIST);
1461                 $prefix = clean_filename(fullname($user) . "_" .$userid . "_");
1463                 foreach ($this->submissionplugins as $plugin) {
1464                     if ($plugin->is_enabled() && $plugin->is_visible()) {
1465                         $pluginfiles = $plugin->get_files($submission);
1468                         foreach ($pluginfiles as $zipfilename => $file) {
1469                             $filesforzipping[$prefix . $zipfilename] = $file;
1470                         }
1471                     }
1472                 }
1474             }
1475         } // end of foreach loop
1476         if ($zipfile = $this->pack_files($filesforzipping)) {
1477             $this->add_to_log('download all submissions', get_string('downloadall', 'assign'));
1478             send_temp_file($zipfile, $filename); //send file and delete after sending.
1479         }
1480     }
1482     /**
1483      * Util function to add a message to the log
1484      *
1485      * @param string $action The current action
1486      * @param string $info A detailed description of the change. But no more than 255 characters.
1487      * @param string $url The url to the assign module instance.
1488      * @return void
1489      */
1490     public function add_to_log($action = '', $info = '', $url='') {
1491         global $USER;
1493         $fullurl = 'view.php?id=' . $this->get_course_module()->id;
1494         if ($url != '') {
1495             $fullurl .= '&' . $url;
1496         }
1498         add_to_log($this->get_course()->id, 'assign', $action, $fullurl, $info, $this->get_course_module()->id, $USER->id);
1499     }
1501     /**
1502      * Load the submission object for a particular user, optionally creating it if required
1503      *
1504      * @param int $userid The id of the user whose submission we want or 0 in which case USER->id is used
1505      * @param bool $create optional Defaults to false. If set to true a new submission object will be created in the database
1506      * @return stdClass The submission
1507      */
1508     private function get_user_submission($userid, $create) {
1509         global $DB, $USER;
1511         if (!$userid) {
1512             $userid = $USER->id;
1513         }
1514         // if the userid is not null then use userid
1515         $submission = $DB->get_record('assign_submission', array('assignment'=>$this->get_instance()->id, 'userid'=>$userid));
1517         if ($submission) {
1518             return $submission;
1519         }
1520         if ($create) {
1521             $submission = new stdClass();
1522             $submission->assignment   = $this->get_instance()->id;
1523             $submission->userid       = $userid;
1524             $submission->timecreated = time();
1525             $submission->timemodified = $submission->timecreated;
1527             if ($this->get_instance()->submissiondrafts) {
1528                 $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
1529             } else {
1530                 $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
1531             }
1532             $sid = $DB->insert_record('assign_submission', $submission);
1533             $submission->id = $sid;
1534             return $submission;
1535         }
1536         return false;
1537     }
1539     /**
1540      * Load the submission object from it's id
1541      *
1542      * @param int $submissionid The id of the submission we want
1543      * @return stdClass The submission
1544      */
1545     private function get_submission($submissionid) {
1546         global $DB;
1548         return $DB->get_record('assign_submission', array('assignment'=>$this->get_instance()->id, 'id'=>$submissionid), '*', MUST_EXIST);
1549     }
1551     /**
1552      * This will retrieve a grade object from the db, optionally creating it if required
1553      *
1554      * @param int $userid The user we are grading
1555      * @param bool $create If true the grade will be created if it does not exist
1556      * @return stdClass The grade record
1557      */
1558     private function get_user_grade($userid, $create) {
1559         global $DB, $USER;
1561         if (!$userid) {
1562             $userid = $USER->id;
1563         }
1565         // if the userid is not null then use userid
1566         $grade = $DB->get_record('assign_grades', array('assignment'=>$this->get_instance()->id, 'userid'=>$userid));
1568         if ($grade) {
1569             return $grade;
1570         }
1571         if ($create) {
1572             $grade = new stdClass();
1573             $grade->assignment   = $this->get_instance()->id;
1574             $grade->userid       = $userid;
1575             $grade->timecreated = time();
1576             $grade->timemodified = $grade->timecreated;
1577             $grade->locked = 0;
1578             $grade->grade = -1;
1579             $grade->grader = $USER->id;
1580             $gid = $DB->insert_record('assign_grades', $grade);
1581             $grade->id = $gid;
1582             return $grade;
1583         }
1584         return false;
1585     }
1587     /**
1588      * This will retrieve a grade object from the db
1589      *
1590      * @param int $gradeid The id of the grade
1591      * @return stdClass The grade record
1592      */
1593     private function get_grade($gradeid) {
1594         global $DB;
1596         return $DB->get_record('assign_grades', array('assignment'=>$this->get_instance()->id, 'id'=>$gradeid), '*', MUST_EXIST);
1597     }
1599     /**
1600      * Print the grading page for a single user submission
1601      *
1602      * @param moodleform $mform
1603      * @param int $offset
1604      * @return string
1605      */
1606     private function view_single_grade_page($mform, $offset=0) {
1607         global $DB, $CFG;
1609         $o = '';
1611         // Include grade form
1612         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
1614         // Need submit permission to submit an assignment
1615         require_capability('mod/assign:grade', $this->context);
1617         $o .= $this->output->render(new assign_header($this->get_instance(),
1618                                                       $this->get_context(), false, $this->get_course_module()->id,get_string('grading', 'assign')));
1620         $rownum = required_param('rownum', PARAM_INT) + $offset;
1621         $useridlist = optional_param('useridlist', '', PARAM_TEXT);
1622         if ($useridlist) {
1623             $useridlist = explode(',', $useridlist);
1624         } else {
1625             $useridlist = $this->get_grading_userid_list();
1626         }
1627         $last = false;
1628         $userid = $useridlist[$rownum];
1629         if ($rownum == count($useridlist) - 1) {
1630             $last = true;
1631         }
1632         // the placement of this is important so can pass the list of userids above
1633         if ($offset) {
1634             $_POST = array();
1635         }
1636         if(!$userid){
1637             throw new coding_exception('Row is out of bounds for the current grading table: ' . $rownum);
1638         }
1639         $user = $DB->get_record('user', array('id' => $userid));
1640         if ($user) {
1641             $o .= $this->output->render(new assign_user_summary($user, $this->get_course()->id, has_capability('moodle/site:viewfullnames', $this->get_course_context())));
1642         }
1643         $submission = $this->get_user_submission($userid, false);
1644         // get the current grade
1645         $grade = $this->get_user_grade($userid, false);
1646         if ($this->can_view_submission($userid)) {
1647             $gradelocked = ($grade && $grade->locked) || $this->grading_disabled($userid);
1648             $o .= $this->output->render(new assign_submission_status($this->get_instance()->allowsubmissionsfromdate,
1649                                                               $this->get_instance()->alwaysshowdescription,
1650                                                               $submission,
1651                                                               $this->is_any_submission_plugin_enabled(),
1652                                                               $gradelocked,
1653                                                               $this->is_graded($userid),
1654                                                               $this->get_instance()->duedate,
1655                                                               $this->get_submission_plugins(),
1656                                                               $this->get_return_action(),
1657                                                               $this->get_return_params(),
1658                                                               $this->get_course_module()->id,
1659                                                               assign_submission_status::GRADER_VIEW,
1660                                                               false,
1661                                                               false));
1662         }
1663         if ($grade) {
1664             $data = new stdClass();
1665             if ($grade->grade !== NULL && $grade->grade >= 0) {
1666                 $data->grade = format_float($grade->grade,2);
1667             }
1668         } else {
1669             $data = new stdClass();
1670             $data->grade = '';
1671         }
1673         // now show the grading form
1674         if (!$mform) {
1675             $mform = new mod_assign_grade_form(null, array($this, $data, array('rownum'=>$rownum, 'useridlist'=>$useridlist, 'last'=>$last)), 'post', '', array('class'=>'gradeform'));
1676         }
1677         $o .= $this->output->render(new assign_form('gradingform',$mform));
1679         $this->add_to_log('view grading form', get_string('viewgradingformforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
1681         $o .= $this->view_footer();
1682         return $o;
1683     }
1687     /**
1688      * View a link to go back to the previous page. Uses url parameters returnaction and returnparams.
1689      *
1690      * @return string
1691      */
1692     private function view_return_links() {
1694         $returnaction = optional_param('returnaction','', PARAM_ALPHA);
1695         $returnparams = optional_param('returnparams','', PARAM_TEXT);
1697         $params = array();
1698         parse_str($returnparams, $params);
1699         $params = array_merge( array('id' => $this->get_course_module()->id, 'action' => $returnaction), $params);
1701         return $this->output->single_button(new moodle_url('/mod/assign/view.php', $params), get_string('back'), 'get');
1703     }
1705     /**
1706      * View the grading table of all submissions for this assignment
1707      *
1708      * @return string
1709      */
1710     private function view_grading_table() {
1711         global $USER, $CFG;
1712         // Include grading options form
1713         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
1714         require_once($CFG->dirroot . '/mod/assign/quickgradingform.php');
1715         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
1716         $o = '';
1718         $links = array();
1719         if (has_capability('gradereport/grader:view', $this->get_course_context()) &&
1720                 has_capability('moodle/grade:viewall', $this->get_course_context())) {
1721             $gradebookurl = '/grade/report/grader/index.php?id=' . $this->get_course()->id;
1722             $links[$gradebookurl] = get_string('viewgradebook', 'assign');
1723         }
1724         if ($this->is_any_submission_plugin_enabled()) {
1725             $downloadurl = '/mod/assign/view.php?id=' . $this->get_course_module()->id . '&action=downloadall';
1726             $links[$downloadurl] = get_string('downloadall', 'assign');
1727         }
1729         $gradingactions = new url_select($links);
1731         $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
1733         $perpage = get_user_preferences('assign_perpage', 10);
1734         $filter = get_user_preferences('assign_filter', '');
1735         $controller = $gradingmanager->get_active_controller();
1736         $showquickgrading = empty($controller);
1737         if (optional_param('action', '', PARAM_ALPHA) == 'saveoptions') {
1738             $quickgrading = optional_param('quickgrading', false, PARAM_BOOL);
1739             set_user_preference('assign_quickgrading', $quickgrading);
1740         }
1741         $quickgrading = get_user_preferences('assign_quickgrading', false);
1743         // print options  for changing the filter and changing the number of results per page
1744         $gradingoptionsform = new mod_assign_grading_options_form(null,
1745                                                                   array('cm'=>$this->get_course_module()->id,
1746                                                                         'contextid'=>$this->context->id,
1747                                                                         'userid'=>$USER->id,
1748                                                                         'submissionsenabled'=>$this->is_any_submission_plugin_enabled(),
1749                                                                         'showquickgrading'=>$showquickgrading,
1750                                                                         'quickgrading'=>$quickgrading),
1751                                                                   'post', '',
1752                                                                   array('class'=>'gradingoptionsform'));
1754         $gradingbatchoperationsform = new mod_assign_grading_batch_operations_form(null,
1755                                                                   array('cm'=>$this->get_course_module()->id,
1756                                                                         'submissiondrafts'=>$this->get_instance()->submissiondrafts),
1757                                                                   'post', '',
1758                                                                   array('class'=>'gradingbatchoperationsform'));
1760         $gradingoptionsdata = new stdClass();
1761         $gradingoptionsdata->perpage = $perpage;
1762         $gradingoptionsdata->filter = $filter;
1763         $gradingoptionsform->set_data($gradingoptionsdata);
1765         $actionformtext = $this->output->render($gradingactions);
1766         $o .= $this->output->render(new assign_header($this->get_instance(),
1767                                                       $this->get_context(), false, $this->get_course_module()->id, get_string('grading', 'assign'), $actionformtext));
1768         $o .= groups_print_activity_menu($this->get_course_module(), $CFG->wwwroot . '/mod/assign/view.php?id=' . $this->get_course_module()->id.'&action=grading', true);
1770         // plagiarism update status apearring in the grading book
1771         if (!empty($CFG->enableplagiarism)) {
1772             /** Include plagiarismlib.php */
1773             require_once($CFG->libdir . '/plagiarismlib.php');
1774             $o .= plagiarism_update_status($this->get_course(), $this->get_course_module());
1775         }
1777         // load and print the table of submissions
1778         if ($showquickgrading && $quickgrading) {
1779             $table = $this->output->render(new assign_grading_table($this, $perpage, $filter, 0, true));
1780             $quickgradingform = new mod_assign_quick_grading_form(null,
1781                                                                   array('cm'=>$this->get_course_module()->id,
1782                                                                         'gradingtable'=>$table));
1783             $o .= $this->output->render(new assign_form('quickgradingform', $quickgradingform));
1784         } else {
1785             $o .= $this->output->render(new assign_grading_table($this, $perpage, $filter, 0, false));
1786         }
1788         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1789         $users = array_keys($this->list_participants($currentgroup, true));
1790         if (count($users) != 0) {
1791             // if no enrolled user in a course then don't display the batch operations feature
1792             $o .= $this->output->render(new assign_form('gradingbatchoperationsform', $gradingbatchoperationsform));
1793         }
1794         $o .= $this->output->render(new assign_form('gradingoptionsform', $gradingoptionsform, 'M.mod_assign.init_grading_options'));
1795         return $o;
1796     }
1798     /**
1799      * View entire grading page.
1800      *
1801      * @return string
1802      */
1803     private function view_grading_page() {
1804         global $CFG;
1806         $o = '';
1807         // Need submit permission to submit an assignment
1808         require_capability('mod/assign:grade', $this->context);
1809         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
1811         // only load this if it is
1813         $o .= $this->view_grading_table();
1815         $o .= $this->view_footer();
1816         $this->add_to_log('view submission grading table', get_string('viewsubmissiongradingtable', 'assign'));
1817         return $o;
1818     }
1820     /**
1821      * Capture the output of the plagiarism plugins disclosures and return it as a string
1822      *
1823      * @return void
1824      */
1825     private function plagiarism_print_disclosure() {
1826         global $CFG;
1827         $o = '';
1829         if (!empty($CFG->enableplagiarism)) {
1830             /** Include plagiarismlib.php */
1831             require_once($CFG->libdir . '/plagiarismlib.php');
1833             $o .= plagiarism_print_disclosure($this->get_course_module()->id);
1834         }
1836         return $o;
1837     }
1839     /**
1840      * message for students when assignment submissions have been closed
1841      *
1842      * @return string
1843      */
1844     private function view_student_error_message() {
1845         global $CFG;
1847         $o = '';
1848         // Need submit permission to submit an assignment
1849         require_capability('mod/assign:submit', $this->context);
1851         $o .= $this->output->render(new assign_header($this->get_instance(),
1852                                                       $this->get_context(),
1853                                                       $this->show_intro(),
1854                                                       $this->get_course_module()->id,
1855                                                       get_string('editsubmission', 'assign')));
1857         $o .= $this->output->notification(get_string('submissionsclosed', 'assign'));
1859         $o .= $this->view_footer();
1861         return $o;
1863     }
1865     /**
1866      * View edit submissions page.
1867      *
1868      * @param moodleform $mform
1869      * @return void
1870      */
1871     private function view_edit_submission_page($mform) {
1872         global $CFG;
1874         $o = '';
1875         // Include submission form
1876         require_once($CFG->dirroot . '/mod/assign/submission_form.php');
1877         // Need submit permission to submit an assignment
1878         require_capability('mod/assign:submit', $this->context);
1880         if (!$this->submissions_open()) {
1881             return $this->view_student_error_message();
1882         }
1883         $o .= $this->output->render(new assign_header($this->get_instance(),
1884                                                       $this->get_context(),
1885                                                       $this->show_intro(),
1886                                                       $this->get_course_module()->id,
1887                                                       get_string('editsubmission', 'assign')));
1888         $o .= $this->plagiarism_print_disclosure();
1889         $data = new stdClass();
1891         if (!$mform) {
1892             $mform = new mod_assign_submission_form(null, array($this, $data));
1893         }
1895         $o .= $this->output->render(new assign_form('editsubmissionform',$mform));
1897         $o .= $this->view_footer();
1898         $this->add_to_log('view submit assignment form', get_string('viewownsubmissionform', 'assign'));
1900         return $o;
1901     }
1903     /**
1904      * See if this assignment has a grade yet
1905      *
1906      * @param int $userid
1907      * @return bool
1908      */
1909     private function is_graded($userid) {
1910         $grade = $this->get_user_grade($userid, false);
1911         if ($grade) {
1912             return ($grade->grade !== NULL && $grade->grade >= 0);
1913         }
1914         return false;
1915     }
1918     /**
1919      * Perform an access check to see if the current $USER can view this users submission
1920      *
1921      * @param int $userid
1922      * @return bool
1923      */
1924     public function can_view_submission($userid) {
1925         global $USER;
1927         if (!is_enrolled($this->get_course_context(), $userid)) {
1928             return false;
1929         }
1930         if ($userid == $USER->id && !has_capability('mod/assign:submit', $this->context)) {
1931             return false;
1932         }
1933         if ($userid != $USER->id && !has_capability('mod/assign:grade', $this->context)) {
1934             return false;
1935         }
1936         return true;
1937     }
1939     /**
1940      * Ask the user to confirm they want to perform this batch operation
1941      * @return string
1942      */
1943     private function process_batch_grading_operation() {
1944         global $CFG;
1945         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
1946         require_sesskey();
1948         $gradingbatchoperationsform = new mod_assign_grading_batch_operations_form(null,
1949                                                                   array('cm'=>$this->get_course_module()->id,
1950                                                                         'submissiondrafts'=>$this->get_instance()->submissiondrafts),
1951                                                                   'post', '',
1952                                                                   array('class'=>'gradingbatchoperationsform'));
1954         if ($data = $gradingbatchoperationsform->get_data()) {
1955             // get the list of users
1956             $users = $data->selectedusers;
1957             $userlist = explode(',', $users);
1959             foreach ($userlist as $userid) {
1960                 if ($data->operation == 'lock') {
1961                     $this->process_lock($userid);
1962                 } else if ($data->operation == 'unlock') {
1963                     $this->process_unlock($userid);
1964                 } else if ($data->operation == 'reverttodraft') {
1965                     $this->process_revert_to_draft($userid);
1966                 }
1967             }
1968         }
1970         return true;
1971     }
1973     /**
1974      * Ask the user to confirm they want to submit their work for grading
1975      * @return string
1976      */
1977     private function check_submit_for_grading() {
1978         global $USER;
1979         // Check that all of the submission plugins are ready for this submission
1980         $notifications = array();
1981         $submission = $this->get_user_submission($USER->id, false);
1982         $plugins = $this->get_submission_plugins();
1983         foreach ($plugins as $plugin) {
1984             if ($plugin->is_enabled() && $plugin->is_visible()) {
1985                 $check = $plugin->precheck_submission($submission);
1986                 if ($check !== true) {
1987                     $notifications[] = $check;
1988                 }
1989             }
1990         }
1992         $o = '';
1993         $o .= $this->output->header();
1994         $o .= $this->output->render(new assign_submit_for_grading_page($notifications, $this->get_course_module()->id));
1995         $o .= $this->view_footer();
1996         return $o;
1997     }
1999     /**
2000      * Print 2 tables of information with no action links -
2001      * the submission summary and the grading summary
2002      *
2003      * @param stdClass $user the user to print the report for
2004      * @param bool $showlinks - Return plain text or links to the profile
2005      * @return string - the html summary
2006      */
2007     public function view_student_summary($user, $showlinks) {
2008         global $CFG, $DB, $PAGE;
2010         $grade = $this->get_user_grade($user->id, false);
2011         $submission = $this->get_user_submission($user->id, false);
2012         $o = '';
2014         if ($this->can_view_submission($user->id)) {
2015             $showedit = has_capability('mod/assign:submit', $this->context) &&
2016                          $this->submissions_open() && ($this->is_any_submission_plugin_enabled()) && $showlinks;
2017             $showsubmit = $submission && ($submission->status == ASSIGN_SUBMISSION_STATUS_DRAFT) && $showlinks;
2018             $gradelocked = ($grade && $grade->locked) || $this->grading_disabled($user->id);
2020             $o .= $this->output->render(new assign_submission_status($this->get_instance()->allowsubmissionsfromdate,
2021                                                               $this->get_instance()->alwaysshowdescription,
2022                                                               $submission,
2023                                                               $this->is_any_submission_plugin_enabled(),
2024                                                               $gradelocked,
2025                                                               $this->is_graded($user->id),
2026                                                               $this->get_instance()->duedate,
2027                                                               $this->get_submission_plugins(),
2028                                                               $this->get_return_action(),
2029                                                               $this->get_return_params(),
2030                                                               $this->get_course_module()->id,
2031                                                               assign_submission_status::STUDENT_VIEW,
2032                                                               $showedit,
2033                                                               $showsubmit));
2034             require_once($CFG->libdir.'/gradelib.php');
2035             require_once($CFG->dirroot.'/grade/grading/lib.php');
2037             $gradinginfo = grade_get_grades($this->get_course()->id,
2038                                         'mod',
2039                                         'assign',
2040                                         $this->get_instance()->id,
2041                                         $user->id);
2043             $gradingitem = $gradinginfo->items[0];
2044             $gradebookgrade = $gradingitem->grades[$user->id];
2046             // check to see if all feedback plugins are empty
2047             $emptyplugins = true;
2048             if ($grade) {
2049                 foreach ($this->get_feedback_plugins() as $plugin) {
2050                     if ($plugin->is_visible() && $plugin->is_enabled()) {
2051                         if (!$plugin->is_empty($grade)) {
2052                             $emptyplugins = false;
2053                         }
2054                     }
2055                 }
2056             }
2059             if (!($gradebookgrade->hidden) && ($gradebookgrade->grade !== null || !$emptyplugins)) {
2061                 $gradefordisplay = '';
2062                 $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
2064                 if ($controller = $gradingmanager->get_active_controller()) {
2065                     $controller->set_grade_range(make_grades_menu($this->get_instance()->grade));
2066                     $gradefordisplay = $controller->render_grade($PAGE,
2067                                                                  $grade->id,
2068                                                                  $gradingitem,
2069                                                                  $gradebookgrade->str_long_grade,
2070                                                                  has_capability('mod/assign:grade', $this->get_context()));
2071                 } else {
2072                     $gradefordisplay = $this->display_grade($gradebookgrade->grade, false);
2073                 }
2075                 $gradeddate = $gradebookgrade->dategraded;
2076                 $grader = $DB->get_record('user', array('id'=>$gradebookgrade->usermodified));
2078                 $feedbackstatus = new assign_feedback_status($gradefordisplay,
2079                                                       $gradeddate,
2080                                                       $grader,
2081                                                       $this->get_feedback_plugins(),
2082                                                       $grade,
2083                                                       $this->get_course_module()->id,
2084                                                       $this->get_return_action(),
2085                                                       $this->get_return_params());
2087                 $o .= $this->output->render($feedbackstatus);
2088             }
2090         }
2091         return $o;
2092     }
2094     /**
2095      * View submissions page (contains details of current submission).
2096      *
2097      * @return string
2098      */
2099     private function view_submission_page() {
2100         global $CFG, $DB, $USER, $PAGE;
2102         $o = '';
2103         $o .= $this->output->render(new assign_header($this->get_instance(),
2104                                                       $this->get_context(),
2105                                                       $this->show_intro(),
2106                                                       $this->get_course_module()->id));
2108         if ($this->can_grade()) {
2109             $o .= $this->output->render(new assign_grading_summary($this->count_participants(0),
2110                                                             $this->get_instance()->submissiondrafts,
2111                                                             $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_DRAFT),
2112                                                             $this->is_any_submission_plugin_enabled(),
2113                                                             $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED),
2114                                                             $this->get_instance()->duedate,
2115                                                             $this->get_course_module()->id,
2116                                                             $this->count_submissions_need_grading()
2117                                                             ));
2118         }
2119         $grade = $this->get_user_grade($USER->id, false);
2120         $submission = $this->get_user_submission($USER->id, false);
2122         if ($this->can_view_submission($USER->id)) {
2123             $o .= $this->view_student_summary($USER, true);
2124         }
2127         $o .= $this->view_footer();
2128         $this->add_to_log('view', get_string('viewownsubmissionstatus', 'assign'));
2129         return $o;
2130     }
2132     /**
2133      * convert the final raw grade(s) in the  grading table for the gradebook
2134      *
2135      * @param stdClass $grade
2136      * @return array
2137      */
2138     private function convert_grade_for_gradebook(stdClass $grade) {
2139         $gradebookgrade = array();
2140         // trying to match those array keys in grade update function in gradelib.php
2141         // with keys in th database table assign_grades
2142         // starting around line 262
2143         if ($grade->grade >= 0) {
2144             $gradebookgrade['rawgrade'] = $grade->grade;
2145         }
2146         $gradebookgrade['userid'] = $grade->userid;
2147         $gradebookgrade['usermodified'] = $grade->grader;
2148         $gradebookgrade['datesubmitted'] = NULL;
2149         $gradebookgrade['dategraded'] = $grade->timemodified;
2150         if (isset($grade->feedbackformat)) {
2151             $gradebookgrade['feedbackformat'] = $grade->feedbackformat;
2152         }
2153         if (isset($grade->feedbacktext)) {
2154             $gradebookgrade['feedback'] = $grade->feedbacktext;
2155         }
2157         return $gradebookgrade;
2158     }
2160     /**
2161      * convert submission details for the gradebook
2162      *
2163      * @param stdClass $submission
2164      * @return array
2165      */
2166     private function convert_submission_for_gradebook(stdClass $submission) {
2167         $gradebookgrade = array();
2170         $gradebookgrade['userid'] = $submission->userid;
2171         $gradebookgrade['usermodified'] = $submission->userid;
2172         $gradebookgrade['datesubmitted'] = $submission->timemodified;
2174         return $gradebookgrade;
2175     }
2177     /**
2178      * update grades in the gradebook
2179      *
2180      * @param mixed $submission stdClass|null
2181      * @param mixed $grade stdClass|null
2182      * @return bool
2183      */
2184     private function gradebook_item_update($submission=NULL, $grade=NULL) {
2186         if($submission != NULL){
2187             $gradebookgrade = $this->convert_submission_for_gradebook($submission);
2188         }else{
2189             $gradebookgrade = $this->convert_grade_for_gradebook($grade);
2190         }
2191         // Grading is disabled, return.
2192         if ($this->grading_disabled($gradebookgrade['userid'])) {
2193             return false;
2194         }
2195         $assign = clone $this->get_instance();
2196         $assign->cmidnumber = $this->get_course_module()->id;
2198         return assign_grade_item_update($assign, $gradebookgrade);
2199     }
2201     /**
2202      * update grades in the gradebook based on submission time
2203      *
2204      * @param stdClass $submission
2205      * @param bool $updatetime
2206      * @return bool
2207      */
2208     private function update_submission(stdClass $submission, $updatetime=true) {
2209         global $DB;
2211         if ($updatetime) {
2212             $submission->timemodified = time();
2213         }
2214         $result= $DB->update_record('assign_submission', $submission);
2215         if ($result) {
2216             $this->gradebook_item_update($submission);
2217         }
2218         return $result;
2219     }
2221     /**
2222      * Is this assignment open for submissions?
2223      *
2224      * Check the due date,
2225      * prevent late submissions,
2226      * has this person already submitted,
2227      * is the assignment locked?
2228      *
2229      * @return bool
2230      */
2231     private function submissions_open() {
2232         global $USER;
2234         $time = time();
2235         $dateopen = true;
2236         if ($this->get_instance()->preventlatesubmissions && $this->get_instance()->duedate) {
2237             $dateopen = ($this->get_instance()->allowsubmissionsfromdate <= $time && $time <= $this->get_instance()->duedate);
2238         } else {
2239             $dateopen = ($this->get_instance()->allowsubmissionsfromdate <= $time);
2240         }
2242         if (!$dateopen) {
2243             return false;
2244         }
2246         // now check if this user has already submitted etc.
2247         if (!is_enrolled($this->get_course_context(), $USER)) {
2248             return false;
2249         }
2250         if ($submission = $this->get_user_submission($USER->id, false)) {
2251             if ($this->get_instance()->submissiondrafts && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2252                 // drafts are tracked and the student has submitted the assignment
2253                 return false;
2254             }
2255         }
2256         if ($grade = $this->get_user_grade($USER->id, false)) {
2257             if ($grade->locked) {
2258                 return false;
2259             }
2260         }
2262         if ($this->grading_disabled($USER->id)) {
2263             return false;
2264         }
2266         return true;
2267     }
2269     /**
2270      * render the files in file area
2271      * @param string $component
2272      * @param string $area
2273      * @param int $submissionid
2274      * @return string
2275      */
2276     public function render_area_files($component, $area, $submissionid) {
2277         global $USER;
2279         if (!$submissionid) {
2280             $submission = $this->get_user_submission($USER->id,false);
2281             $submissionid = $submission->id;
2282         }
2284         $fs = get_file_storage();
2285         $browser = get_file_browser();
2286         $files = $fs->get_area_files($this->get_context()->id, $component, $area , $submissionid , "timemodified", false);
2287         return $this->output->assign_files($this->context, $submissionid, $area, $component);
2289     }
2291     /**
2292      * Returns a list of teachers that should be grading given submission
2293      *
2294      * @param int $userid
2295      * @return array
2296      */
2297     private function get_graders($userid) {
2298         //potential graders
2299         $potentialgraders = get_enrolled_users($this->context, "mod/assign:grade");
2301         $graders = array();
2302         if (groups_get_activity_groupmode($this->get_course_module()) == SEPARATEGROUPS) {   // Separate groups are being used
2303             if ($groups = groups_get_all_groups($this->get_course()->id, $userid)) {  // Try to find all groups
2304                 foreach ($groups as $group) {
2305                     foreach ($potentialgraders as $grader) {
2306                         if ($grader->id == $userid) {
2307                             continue; // do not send self
2308                         }
2309                         if (groups_is_member($group->id, $grader->id)) {
2310                             $graders[$grader->id] = $grader;
2311                         }
2312                     }
2313                 }
2314             } else {
2315                 // user not in group, try to find graders without group
2316                 foreach ($potentialgraders as $grader) {
2317                     if ($grader->id == $userid) {
2318                         continue; // do not send self
2319                     }
2320                     if (!groups_has_membership($this->get_course_module(), $grader->id)) {
2321                         $graders[$grader->id] = $grader;
2322                     }
2323                 }
2324             }
2325         } else {
2326             foreach ($potentialgraders as $grader) {
2327                 if ($grader->id == $userid) {
2328                     continue; // do not send self
2329                 }
2330                 // must be enrolled
2331                 if (is_enrolled($this->get_course_context(), $grader->id)) {
2332                     $graders[$grader->id] = $grader;
2333                 }
2334             }
2335         }
2336         return $graders;
2337     }
2339     /**
2340      * Format a notification for plain text
2341      *
2342      * @param string $messagetype
2343      * @param stdClass $info
2344      * @param stdClass $course
2345      * @param stdClass $context
2346      * @param string $modulename
2347      * @param string $assignmentname
2348      */
2349     private static function format_notification_message_text($messagetype, $info, $course, $context, $modulename, $assignmentname) {
2350         $posttext  = format_string($course->shortname, true, array('context' => $context->get_course_context())).' -> '.
2351                      $modulename.' -> '.
2352                      format_string($assignmentname, true, array('context' => $context))."\n";
2353         $posttext .= '---------------------------------------------------------------------'."\n";
2354         $posttext .= get_string($messagetype . 'text', "assign", $info)."\n";
2355         $posttext .= "\n---------------------------------------------------------------------\n";
2356         return $posttext;
2357     }
2359     /**
2360      * Format a notification for HTML
2361      *
2362      * @param string $messagetype
2363      * @param stdClass $info
2364      * @param stdClass $course
2365      * @param stdClass $context
2366      * @param string $modulename
2367      * @param stdClass $coursemodule
2368      * @param string $assignmentname
2369      * @param stdClass $info
2370      */
2371     private static function format_notification_message_html($messagetype, $info, $course, $context, $modulename, $coursemodule, $assignmentname) {
2372         global $CFG;
2373         $posthtml  = '<p><font face="sans-serif">'.
2374                      '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.format_string($course->shortname, true, array('context' => $context->get_course_context())).'</a> ->'.
2375                      '<a href="'.$CFG->wwwroot.'/mod/assign/index.php?id='.$course->id.'">'.$modulename.'</a> ->'.
2376                      '<a href="'.$CFG->wwwroot.'/mod/assign/view.php?id='.$coursemodule->id.'">'.format_string($assignmentname, true, array('context' => $context)).'</a></font></p>';
2377         $posthtml .= '<hr /><font face="sans-serif">';
2378         $posthtml .= '<p>'.get_string($messagetype . 'html', 'assign', $info).'</p>';
2379         $posthtml .= '</font><hr />';
2380         return $posthtml;
2381     }
2383     /**
2384      * Message someone about something (static so it can be called from cron)
2385      *
2386      * @param stdClass $userfrom
2387      * @param stdClass $userto
2388      * @param string $messagetype
2389      * @param string $eventtype
2390      * @param int $updatetime
2391      * @param stdClass $coursemodule
2392      * @param stdClass $context
2393      * @param stdClass $course
2394      * @param string $modulename
2395      * @param string $assignmentname
2396      * @return void
2397      */
2398     public static function send_assignment_notification($userfrom, $userto, $messagetype, $eventtype,
2399                                                         $updatetime, $coursemodule, $context, $course,
2400                                                         $modulename, $assignmentname) {
2401         global $CFG;
2403         $info = new stdClass();
2404         $info->username = fullname($userfrom, true);
2405         $info->assignment = format_string($assignmentname,true, array('context'=>$context));
2406         $info->url = $CFG->wwwroot.'/mod/assign/view.php?id='.$coursemodule->id;
2407         $info->timeupdated = strftime('%c',$updatetime);
2409         $postsubject = get_string($messagetype . 'small', 'assign', $info);
2410         $posttext = self::format_notification_message_text($messagetype, $info, $course, $context, $modulename, $assignmentname);
2411         $posthtml = ($userto->mailformat == 1) ? self::format_notification_message_html($messagetype, $info, $course, $context, $modulename, $coursemodule, $assignmentname) : '';
2413         $eventdata = new stdClass();
2414         $eventdata->modulename       = 'assign';
2415         $eventdata->userfrom         = $userfrom;
2416         $eventdata->userto           = $userto;
2417         $eventdata->subject          = $postsubject;
2418         $eventdata->fullmessage      = $posttext;
2419         $eventdata->fullmessageformat = FORMAT_PLAIN;
2420         $eventdata->fullmessagehtml  = $posthtml;
2421         $eventdata->smallmessage     = $postsubject;
2423         $eventdata->name            = $eventtype;
2424         $eventdata->component       = 'mod_assign';
2425         $eventdata->notification    = 1;
2426         $eventdata->contexturl      = $info->url;
2427         $eventdata->contexturlname  = $info->assignment;
2429         message_send($eventdata);
2430     }
2432     /**
2433      * Message someone about something
2434      *
2435      * @param stdClass $userfrom
2436      * @param stdClass $userto
2437      * @param string $messagetype
2438      * @param string $eventtype
2439      * @param int $updatetime
2440      * @return void
2441      */
2442     public function send_notification($userfrom, $userto, $messagetype, $eventtype, $updatetime) {
2443         self::send_assignment_notification($userfrom, $userto, $messagetype, $eventtype, $updatetime, $this->get_course_module(), $this->get_context(), $this->get_course(), $this->get_module_name(), $this->get_instance()->name);
2444     }
2446     /**
2447      * Notify student upon successful submission
2448      *
2449      * @global moodle_database $DB
2450      * @param stdClass $submission
2451      * @return void
2452      */
2453     private function notify_student_submission_receipt(stdClass $submission) {
2454         global $DB;
2456         $adminconfig = $this->get_admin_config();
2457         if (!$adminconfig->submissionreceipts) {
2458             // No need to do anything
2459             return;
2460         }
2461         $user = $DB->get_record('user', array('id'=>$submission->userid), '*', MUST_EXIST);
2462         $this->send_notification($user, $user, 'submissionreceipt', 'assign_notification', $submission->timemodified);
2463     }
2465     /**
2466      * Send notifications to graders upon student submissions
2467      *
2468      * @global moodle_database $DB
2469      * @param stdClass $submission
2470      * @return void
2471      */
2472     private function notify_graders(stdClass $submission) {
2473         global $DB;
2475         $late = $this->get_instance()->duedate && ($this->get_instance()->duedate < time());
2477         if (!$this->get_instance()->sendnotifications && !($late && $this->get_instance()->sendlatenotifications)) {          // No need to do anything
2478             return;
2479         }
2481         $user = $DB->get_record('user', array('id'=>$submission->userid), '*', MUST_EXIST);
2482         if ($teachers = $this->get_graders($user->id)) {
2483             foreach ($teachers as $teacher) {
2484                 $this->send_notification($user, $teacher, 'gradersubmissionupdated', 'assign_notification', $submission->timemodified);
2485             }
2486         }
2487     }
2489     /**
2490      * assignment submission is processed before grading
2491      *
2492      * @return void
2493      */
2494     private function process_submit_for_grading() {
2495         global $USER;
2497         // Need submit permission to submit an assignment
2498         require_capability('mod/assign:submit', $this->context);
2499         require_sesskey();
2501         $submission = $this->get_user_submission($USER->id,true);
2502         if ($submission->status != ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2503             // Give each submission plugin a chance to process the submission
2504             $plugins = $this->get_submission_plugins();
2505             foreach ($plugins as $plugin) {
2506                 $plugin->submit_for_grading();
2507             }
2509             $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
2510             $this->update_submission($submission);
2511             $this->add_to_log('submit for grading', $this->format_submission_for_log($submission));
2512             $this->notify_graders($submission);
2513             $this->notify_student_submission_receipt($submission);
2514         }
2515     }
2517     /**
2518      * save quick grades
2519      *
2520      * @global moodle_database $DB
2521      * @return string The result of the save operation
2522      */
2523     private function process_save_quick_grades() {
2524         global $USER, $DB, $CFG;
2526         // Need grade permission
2527         require_capability('mod/assign:grade', $this->context);
2529         // make sure advanced grading is disabled
2530         $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
2531         $controller = $gradingmanager->get_active_controller();
2532         if (!empty($controller)) {
2533             return get_string('errorquickgradingvsadvancedgrading', 'assign');
2534         }
2536         $users = array();
2537         // first check all the last modified values
2538         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2539         $participants = $this->list_participants($currentgroup, true);
2541         // gets a list of possible users and look for values based upon that.
2542         foreach ($participants as $userid => $unused) {
2543             $modified = optional_param('grademodified_' . $userid, -1, PARAM_INT);
2544             if ($modified >= 0) {
2545                 // gather the userid, updated grade and last modified value
2546                 $record = new stdClass();
2547                 $record->userid = $userid;
2548                 $record->grade = unformat_float(required_param('quickgrade_' . $record->userid, PARAM_TEXT));
2549                 $record->lastmodified = $modified;
2550                 $record->gradinginfo = grade_get_grades($this->get_course()->id, 'mod', 'assign', $this->get_instance()->id, array($userid));
2551                 $users[$userid] = $record;
2552             }
2553         }
2554         if (empty($users)) {
2555             // Quick check to see whether we have any users to update and we don't
2556             return get_string('quickgradingchangessaved', 'assign'); // Technical lie
2557         }
2559         list($userids, $params) = $DB->get_in_or_equal(array_keys($users), SQL_PARAMS_NAMED);
2560         $params['assignment'] = $this->get_instance()->id;
2561         // check them all for currency
2562         $sql = 'SELECT u.id as userid, g.grade as grade, g.timemodified as lastmodified
2563                   FROM {user} u
2564              LEFT JOIN {assign_grades} g ON u.id = g.userid AND g.assignment = :assignment
2565                  WHERE u.id ' . $userids;
2566         $currentgrades = $DB->get_recordset_sql($sql, $params);
2568         $modifiedusers = array();
2569         foreach ($currentgrades as $current) {
2570             $modified = $users[(int)$current->userid];
2571             $grade = $this->get_user_grade($userid, false);
2573             // check to see if the outcomes were modified
2574             if ($CFG->enableoutcomes) {
2575                 foreach ($modified->gradinginfo->outcomes as $outcomeid => $outcome) {
2576                     $oldoutcome = $outcome->grades[$modified->userid]->grade;
2577                     $newoutcome = optional_param('outcome_' . $outcomeid . '_' . $modified->userid, -1, PARAM_FLOAT);
2578                     if ($oldoutcome != $newoutcome) {
2579                         // can't check modified time for outcomes because it is not reported
2580                         $modifiedusers[$modified->userid] = $modified;
2581                         continue;
2582                     }
2583                 }
2584             }
2586             // let plugins participate
2587             foreach ($this->feedbackplugins as $plugin) {
2588                 if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->supports_quickgrading()) {
2589                     if ($plugin->is_quickgrading_modified($modified->userid, $grade)) {
2590                         if ((int)$current->lastmodified > (int)$modified->lastmodified) {
2591                             return get_string('errorrecordmodified', 'assign');
2592                         } else {
2593                             $modifiedusers[$modified->userid] = $modified;
2594                             continue;
2595                         }
2596                     }
2597                 }
2598             }
2601             if (($current->grade < 0 || $current->grade === NULL) &&
2602                 ($modified->grade < 0 || $modified->grade === NULL)) {
2603                 // different ways to indicate no grade
2604                 continue;
2605             }
2606             // Treat 0 and null as different values
2607             if ($current->grade !== null) {
2608                 $current->grade = floatval($current->grade);
2609             }
2610             if ($current->grade !== $modified->grade) {
2611                 // grade changed
2612                 if ($this->grading_disabled($modified->userid)) {
2613                     continue;
2614                 }
2615                 if ((int)$current->lastmodified > (int)$modified->lastmodified) {
2616                     // error - record has been modified since viewing the page
2617                     return get_string('errorrecordmodified', 'assign');
2618                 } else {
2619                     $modifiedusers[$modified->userid] = $modified;
2620                 }
2621             }
2623         }
2624         $currentgrades->close();
2626         // ok - ready to process the updates
2627         foreach ($modifiedusers as $userid => $modified) {
2628             $grade = $this->get_user_grade($userid, true);
2629             $grade->grade= grade_floatval(unformat_float($modified->grade));
2630             $grade->grader= $USER->id;
2632             $this->update_grade($grade);
2634             // save plugins data
2635             foreach ($this->feedbackplugins as $plugin) {
2636                 if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->supports_quickgrading()) {
2637                     $plugin->save_quickgrading_changes($userid, $grade);
2638                 }
2639             }
2641             // save outcomes
2642             if ($CFG->enableoutcomes) {
2643                 $data = array();
2644                 foreach ($modified->gradinginfo->outcomes as $outcomeid => $outcome) {
2645                     $oldoutcome = $outcome->grades[$modified->userid]->grade;
2646                     $newoutcome = optional_param('outcome_' . $outcomeid . '_' . $modified->userid, -1, PARAM_INT);
2647                     if ($oldoutcome != $newoutcome) {
2648                         $data[$outcomeid] = $newoutcome;
2649                     }
2650                 }
2651                 if (count($data) > 0) {
2652                     grade_update_outcomes('mod/assign', $this->course->id, 'mod', 'assign', $this->get_instance()->id, $userid, $data);
2653                 }
2654             }
2656             $this->add_to_log('grade submission', $this->format_grade_for_log($grade));
2657         }
2659         return get_string('quickgradingchangessaved', 'assign');
2660     }
2662     /**
2663      * save grading options
2664      *
2665      * @return void
2666      */
2667     private function process_save_grading_options() {
2668         global $USER, $CFG;
2670         // Include grading options form
2671         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
2673         // Need submit permission to submit an assignment
2674         require_capability('mod/assign:grade', $this->context);
2676         $mform = new mod_assign_grading_options_form(null, array('cm'=>$this->get_course_module()->id,
2677                                                                  'contextid'=>$this->context->id,
2678                                                                  'userid'=>$USER->id,
2679                                                                  'submissionsenabled'=>$this->is_any_submission_plugin_enabled(),
2680                                                                  'showquickgrading'=>false));
2681         if ($formdata = $mform->get_data()) {
2682             set_user_preference('assign_perpage', $formdata->perpage);
2683             set_user_preference('assign_filter', $formdata->filter);
2684         }
2685     }
2687    /**
2688     * Take a grade object and print a short summary for the log file.
2689     * The size limit for the log file is 255 characters, so be careful not
2690     * to include too much information.
2691     *
2692     * @param stdClass $grade
2693     * @return string
2694     */
2695     private function format_grade_for_log(stdClass $grade) {
2696         global $DB;
2698         $user = $DB->get_record('user', array('id' => $grade->userid), '*', MUST_EXIST);
2700         $info = get_string('gradestudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user)));
2701         if ($grade->grade != '') {
2702             $info .= get_string('grade') . ': ' . $this->display_grade($grade->grade, false) . '. ';
2703         } else {
2704             $info .= get_string('nograde', 'assign');
2705         }
2706         if ($grade->locked) {
2707             $info .= get_string('submissionslocked', 'assign') . '. ';
2708         }
2709         return $info;
2710     }
2712     /**
2713      * Take a submission object and print a short summary for the log file.
2714      * The size limit for the log file is 255 characters, so be careful not
2715      * to include too much information.
2716      *
2717      * @param stdClass $submission
2718      * @return string
2719      */
2720     private function format_submission_for_log(stdClass $submission) {
2721         $info = '';
2722         $info .= get_string('submissionstatus', 'assign') . ': ' . get_string('submissionstatus_' . $submission->status, 'assign') . '. <br>';
2723         // format_for_log here iterating every single log INFO  from either submission or grade in every assignment plugin
2725         foreach ($this->submissionplugins as $plugin) {
2726             if ($plugin->is_enabled() && $plugin->is_visible()) {
2729                 $info .= "<br>" . $plugin->format_for_log($submission);
2730             }
2731         }
2734         return $info;
2735     }
2737     /**
2738      * save assignment submission
2739      *
2740      * @param  moodleform $mform
2741      * @return bool
2742      */
2743     private function process_save_submission(&$mform) {
2744         global $USER, $CFG;
2746         // Include submission form
2747         require_once($CFG->dirroot . '/mod/assign/submission_form.php');
2749         // Need submit permission to submit an assignment
2750         require_capability('mod/assign:submit', $this->context);
2751         require_sesskey();
2753         $data = new stdClass();
2754         $mform = new mod_assign_submission_form(null, array($this, $data));
2755         if ($mform->is_cancelled()) {
2756             return true;
2757         }
2758         if ($data = $mform->get_data()) {
2759             $submission = $this->get_user_submission($USER->id, true); //create the submission if needed & its id
2760             $grade = $this->get_user_grade($USER->id, false); // get the grade to check if it is locked
2761             if ($grade && $grade->locked) {
2762                 print_error('submissionslocked', 'assign');
2763                 return true;
2764             }
2767             foreach ($this->submissionplugins as $plugin) {
2768                 if ($plugin->is_enabled()) {
2769                     if (!$plugin->save($submission, $data)) {
2770                         print_error($plugin->get_error());
2771                     }
2772                 }
2773             }
2775             $this->update_submission($submission);
2777             // Logging
2778             $this->add_to_log('submit', $this->format_submission_for_log($submission));
2780             if (!$this->get_instance()->submissiondrafts) {
2781                 $this->notify_student_submission_receipt($submission);
2782                 $this->notify_graders($submission);
2783             }
2784             return true;
2785         }
2786         return false;
2787     }
2790     /**
2791      * Determine if this users grade is locked or overridden
2792      *
2793      * @param int $userid - The student userid
2794      * @return bool $gradingdisabled
2795      */
2796     public function grading_disabled($userid) {
2797         global $CFG;
2799         $gradinginfo = grade_get_grades($this->get_course()->id, 'mod', 'assign', $this->get_instance()->id, array($userid));
2800         if (!$gradinginfo) {
2801             return false;
2802         }
2804         if (!isset($gradinginfo->items[0]->grades[$userid])) {
2805             return false;
2806         }
2807         $gradingdisabled = $gradinginfo->items[0]->grades[$userid]->locked || $gradinginfo->items[0]->grades[$userid]->overridden;
2808         return $gradingdisabled;
2809     }
2812     /**
2813      * Get an instance of a grading form if advanced grading is enabled
2814      * This is specific to the assignment, marker and student
2815      *
2816      * @param int $userid - The student userid
2817      * @param bool $gradingdisabled
2818      * @return mixed gradingform_instance|null $gradinginstance
2819      */
2820     private function get_grading_instance($userid, $gradingdisabled) {
2821         global $CFG, $USER;
2823         $grade = $this->get_user_grade($userid, false);
2824         $grademenu = make_grades_menu($this->get_instance()->grade);
2826         $advancedgradingwarning = false;
2827         $gradingmanager = get_grading_manager($this->context, 'mod_assign', 'submissions');
2828         $gradinginstance = null;
2829         if ($gradingmethod = $gradingmanager->get_active_method()) {
2830             $controller = $gradingmanager->get_controller($gradingmethod);
2831             if ($controller->is_form_available()) {
2832                 $itemid = null;
2833                 if ($grade) {
2834                     $itemid = $grade->id;
2835                 }
2836                 if ($gradingdisabled && $itemid) {
2837                     $gradinginstance = ($controller->get_current_instance($USER->id, $itemid));
2838                 } else if (!$gradingdisabled) {
2839                     $instanceid = optional_param('advancedgradinginstanceid', 0, PARAM_INT);
2840                     $gradinginstance = ($controller->get_or_create_instance($instanceid, $USER->id, $itemid));
2841                 }
2842             } else {
2843                 $advancedgradingwarning = $controller->form_unavailable_notification();
2844             }
2845         }
2846         if ($gradinginstance) {
2847             $gradinginstance->get_controller()->set_grade_range($grademenu);
2848         }
2849         return $gradinginstance;
2850     }
2852     /**
2853      * add elements to grade form
2854      *
2855      * @param MoodleQuickForm $mform
2856      * @param stdClass $data
2857      * @param array $params
2858      * @return void
2859      */
2860     public function add_grade_form_elements(MoodleQuickForm $mform, stdClass $data, $params) {
2861         global $USER, $CFG;
2862         $settings = $this->get_instance();
2864         $rownum = $params['rownum'];
2865         $last = $params['last'];
2866         $useridlist = $params['useridlist'];
2867         $userid = $useridlist[$rownum];
2868         $grade = $this->get_user_grade($userid, false);
2870         // add advanced grading
2871         $gradingdisabled = $this->grading_disabled($userid);
2872         $gradinginstance = $this->get_grading_instance($userid, $gradingdisabled);
2874         if ($gradinginstance) {
2875             $gradingelement = $mform->addElement('grading', 'advancedgrading', get_string('grade').':', array('gradinginstance' => $gradinginstance));
2876             if ($gradingdisabled) {
2877                 $gradingelement->freeze();
2878             } else {
2879                 $mform->addElement('hidden', 'advancedgradinginstanceid', $gradinginstance->get_id());
2880             }
2881         } else {
2882             // use simple direct grading
2883             if ($this->get_instance()->grade > 0) {
2884                 $gradingelement = $mform->addElement('text', 'grade', get_string('gradeoutof', 'assign',$this->get_instance()->grade));
2885                 $mform->addHelpButton('grade', 'gradeoutofhelp', 'assign');
2886                 $mform->setType('grade', PARAM_TEXT);
2887                 if ($gradingdisabled) {
2888                     $gradingelement->freeze();
2889                 }
2890             } else {
2891                 $grademenu = make_grades_menu($this->get_instance()->grade);
2892                 if (count($grademenu) > 0) {
2893                     $gradingelement = $mform->addElement('select', 'grade', get_string('grade').':', $grademenu);
2894                     $mform->setType('grade', PARAM_INT);
2895                     if ($gradingdisabled) {
2896                         $gradingelement->freeze();
2897                     }
2898                 }
2899             }
2900         }
2902         $gradinginfo = grade_get_grades($this->get_course()->id,
2903                                         'mod',
2904                                         'assign',
2905                                         $this->get_instance()->id,
2906                                         $userid);
2907         if (!empty($CFG->enableoutcomes)) {
2908             foreach($gradinginfo->outcomes as $index=>$outcome) {
2909                 $options = make_grades_menu(-$outcome->scaleid);
2910                 if ($outcome->grades[$userid]->locked) {
2911                     $options[0] = get_string('nooutcome', 'grades');
2912                     $mform->addElement('static', 'outcome_'.$index.'['.$userid.']', $outcome->name.':',
2913                             $options[$outcome->grades[$userid]->grade]);
2914                 } else {
2915                     $options[''] = get_string('nooutcome', 'grades');
2916                     $attributes = array('id' => 'menuoutcome_'.$index );
2917                     $mform->addElement('select', 'outcome_'.$index.'['.$userid.']', $outcome->name.':', $options, $attributes );
2918                     $mform->setType('outcome_'.$index.'['.$userid.']', PARAM_INT);
2919                     $mform->setDefault('outcome_'.$index.'['.$userid.']', $outcome->grades[$userid]->grade );
2920                 }
2921             }
2922         }
2924         if (has_all_capabilities(array('gradereport/grader:view', 'moodle/grade:viewall'), $this->get_course_context())) {
2925             $gradestring = $this->output->action_link(new moodle_url('/grade/report/grader/index.php',
2926                                                               array('id'=>$this->get_course()->id)),
2927                                                 $gradinginfo->items[0]->grades[$userid]->str_grade);
2928         } else {
2929             $gradestring = $gradinginfo->items[0]->grades[$userid]->str_grade;
2930         }
2931         $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assign').':', $gradestring);
2934         $mform->addElement('static', 'progress', '', get_string('gradingstudentprogress', 'assign', array('index'=>$rownum+1, 'count'=>count($useridlist))));
2936         // plugins
2937         $this->add_plugin_grade_elements($grade, $mform, $data);
2939         // hidden params
2940         $mform->addElement('hidden', 'id', $this->get_course_module()->id);
2941         $mform->setType('id', PARAM_INT);
2942         $mform->addElement('hidden', 'rownum', $rownum);
2943         $mform->setType('rownum', PARAM_INT);
2944         $mform->addElement('hidden', 'useridlist', implode(',', $useridlist));
2945         $mform->setType('useridlist', PARAM_TEXT);
2946         $mform->addElement('hidden', 'ajax', optional_param('ajax', 0, PARAM_INT));
2947         $mform->setType('ajax', PARAM_INT);
2949         $mform->addElement('hidden', 'action', 'submitgrade');
2950         $mform->setType('action', PARAM_ALPHA);
2953         $buttonarray=array();
2954         $buttonarray[] = $mform->createElement('submit', 'savegrade', get_string('savechanges', 'assign'));
2955         if (!$last){
2956             $buttonarray[] = $mform->createElement('submit', 'saveandshownext', get_string('savenext','assign'));
2957         }
2958         $buttonarray[] = $mform->createElement('cancel', 'cancelbutton', get_string('cancel'));
2959         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
2960         $mform->closeHeaderBefore('buttonar');
2961         $buttonarray=array();
2963         if ($rownum > 0) {
2964             $buttonarray[] = $mform->createElement('submit', 'nosaveandprevious', get_string('previous','assign'));
2965         }
2967         if (!$last){
2968             $buttonarray[] = $mform->createElement('submit', 'nosaveandnext', get_string('nosavebutnext', 'assign'));
2969         }
2970         $mform->addGroup($buttonarray, 'navar', '', array(' '), false);
2971     }
2974     /**
2975      * add elements in submission plugin form
2976      *
2977      * @param mixed $submission stdClass|null
2978      * @param MoodleQuickForm $mform
2979      * @param stdClass $data
2980      * @return void
2981      */
2982     private function add_plugin_submission_elements($submission, MoodleQuickForm $mform, stdClass $data) {
2983         foreach ($this->submissionplugins as $plugin) {
2984             if ($plugin->is_enabled() && $plugin->is_visible() && $plugin->allow_submissions()) {
2985                 $mform->addElement('header', 'header_' . $plugin->get_type(), $plugin->get_name());
2986                 if (!$plugin->get_form_elements($submission, $mform, $data)) {
2987                     $mform->removeElement('header_' . $plugin->get_type());
2988                 }
2989             }
2990         }
2991     }
2993     /**
2994      * check if feedback plugins installed are enabled
2995      *
2996      * @return bool
2997      */
2998     public function is_any_feedback_plugin_enabled() {
2999         if (!isset($this->cache['any_feedback_plugin_enabled'])) {
3000             $this->cache['any_feedback_plugin_enabled'] = false;
3001             foreach ($this->feedbackplugins as $plugin) {
3002                 if ($plugin->is_enabled() && $plugin->is_visible()) {
3003                     $this->cache['any_feedback_plugin_enabled'] = true;
3004                     break;
3005                 }
3006             }
3007         }
3009         return $this->cache['any_feedback_plugin_enabled'];
3011     }
3013     /**
3014      * check if submission plugins installed are enabled
3015      *
3016      * @return bool
3017      */
3018     public function is_any_submission_plugin_enabled() {
3019         if (!isset($this->cache['any_submission_plugin_enabled'])) {
3020             $this->cache['any_submission_plugin_enabled'] = false;
3021             foreach ($this->submissionplugins as $plugin) {
3022                 if ($plugin->is_enabled() && $plugin->is_visible() && $plugin->allow_submissions()) {
3023                     $this->cache['any_submission_plugin_enabled'] = true;
3024                     break;
3025                 }
3026             }
3027         }
3029         return $this->cache['any_submission_plugin_enabled'];
3031     }
3033     /**
3034      * add elements to submission form
3035      * @param MoodleQuickForm $mform
3036      * @param stdClass $data
3037      * @return void
3038      */
3039     public function add_submission_form_elements(MoodleQuickForm $mform, stdClass $data) {
3040         global $USER;
3042         // online text submissions
3044         $submission = $this->get_user_submission($USER->id, false);
3046         $this->add_plugin_submission_elements($submission, $mform, $data);
3048         // hidden params
3049         $mform->addElement('hidden', 'id', $this->get_course_module()->id);
3050         $mform->setType('id', PARAM_INT);
3052         $mform->addElement('hidden', 'action', 'savesubmission');
3053         $mform->setType('action', PARAM_TEXT);
3054         // buttons
3056     }
3058     /**
3059      * revert to draft
3060      * Uses url parameter userid
3061      *
3062      * @param int $userid
3063      * @return void
3064      */
3065     private function process_revert_to_draft($userid = 0) {
3066         global $USER, $DB;
3068         // Need grade permission
3069         require_capability('mod/assign:grade', $this->context);
3070         require_sesskey();
3072         if (!$userid) {
3073             $userid = required_param('userid', PARAM_INT);
3074         }
3076         $submission = $this->get_user_submission($userid, false);
3077         if (!$submission) {
3078             return;
3079         }
3080         $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
3081         $this->update_submission($submission, false);
3083         // update the modified time on the grade (grader modified)
3084         $grade = $this->get_user_grade($userid, true);
3085         $this->update_grade($grade);
3087         $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3089         $this->add_to_log('revert submission to draft', get_string('reverttodraftforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
3091     }
3093     /**
3094      * lock  the process
3095      * Uses url parameter userid
3096      * @param int $userid
3097      * @return void
3098      */
3099     private function process_lock($userid = 0) {
3100         global $USER, $DB;
3102         // Need grade permission
3103         require_capability('mod/assign:grade', $this->context);
3104         require_sesskey();
3106         if (!$userid) {
3107             $userid = required_param('userid', PARAM_INT);
3108         }
3110         $grade = $this->get_user_grade($userid, true);
3111         $grade->locked = 1;
3112         $grade->grader = $USER->id;
3113         $this->update_grade($grade);
3115         $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3117         $this->add_to_log('lock submission', get_string('locksubmissionforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
3118     }
3120     /**
3121      * unlock the process
3122      *
3123      * @param int $userid
3124      * @return void
3125      */
3126     private function process_unlock($userid = 0) {
3127         global $USER, $DB;
3129         // Need grade permission
3130         require_capability('mod/assign:grade', $this->context);
3131         require_sesskey();
3133         if (!$userid) {
3134             $userid = required_param('userid', PARAM_INT);
3135         }
3137         $grade = $this->get_user_grade($userid, true);
3138         $grade->locked = 0;
3139         $grade->grader = $USER->id;
3140         $this->update_grade($grade);
3142         $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3144         $this->add_to_log('unlock submission', get_string('unlocksubmissionforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
3145     }
3147     /**
3148      * save outcomes submitted from grading form
3149      *
3150      * @param int $userid
3151      * @param stdClass $formdata
3152      */
3153     private function process_outcomes($userid, $formdata) {
3154         global $CFG, $USER;
3156         if (empty($CFG->enableoutcomes)) {
3157             return;
3158         }
3159         if ($this->grading_disabled($userid)) {
3160             return;
3161         }
3163         require_once($CFG->libdir.'/gradelib.php');
3165         $data = array();
3166         $gradinginfo = grade_get_grades($this->get_course()->id,
3167                                         'mod',
3168                                         'assign',
3169                                         $this->get_instance()->id,
3170                                         $userid);
3172         if (!empty($gradinginfo->outcomes)) {
3173             foreach($gradinginfo->outcomes as $index=>$oldoutcome) {
3174                 $name = 'outcome_'.$index;
3175                 if (isset($formdata->{$name}[$userid]) and $oldoutcome->grades[$userid]->grade != $formdata->{$name}[$userid]) {
3176                     $data[$index] = $formdata->{$name}[$userid];
3177                 }
3178             }
3179         }
3180         if (count($data) > 0) {
3181             grade_update_outcomes('mod/assign', $this->course->id, 'mod', 'assign', $this->get_instance()->id, $userid, $data);
3182         }
3184     }
3187     /**
3188      * save grade
3189      *
3190      * @param  moodleform $mform
3191      * @return bool - was the grade saved
3192      */
3193     private function process_save_grade(&$mform) {
3194         global $USER, $DB, $CFG;
3195         // Include grade form
3196         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
3198         // Need submit permission to submit an assignment
3199         require_capability('mod/assign:grade', $this->context);
3200         require_sesskey();
3202         $rownum = required_param('rownum', PARAM_INT);
3203         $useridlist = optional_param('useridlist', '', PARAM_TEXT);
3204         if ($useridlist) {
3205             $useridlist = explode(',', $useridlist);
3206         } else {
3207             $useridlist = $this->get_grading_userid_list();
3208         }
3209         $last = false;
3210         $userid = $useridlist[$rownum];
3211         if ($rownum == count($useridlist) - 1) {
3212             $last = true;
3213         }
3215         $data = new stdClass();
3216         $mform = new mod_assign_grade_form(null, array($this, $data, array('rownum'=>$rownum, 'useridlist'=>$useridlist, 'last'=>false)), 'post', '', array('class'=>'gradeform'));
3218         if ($formdata = $mform->get_data()) {
3219             $grade = $this->get_user_grade($userid, true);
3220             $gradingdisabled = $this->grading_disabled($userid);
3221             $gradinginstance = $this->get_grading_instance($userid, $gradingdisabled);
3222             if (!$gradingdisabled) {
3223                 if ($gradinginstance) {
3224                     $grade->grade = $gradinginstance->submit_and_get_grade($formdata->advancedgrading, $grade->id);
3225                 } else {
3226                     // handle the case when grade is set to No Grade
3227                     if (isset($formdata->grade)) {
3228                         $grade->grade = grade_floatval(unformat_float($formdata->grade));
3229                     }
3230                 }
3231             }
3232             $grade->grader= $USER->id;
3234             $adminconfig = $this->get_admin_config();
3235             $gradebookplugin = $adminconfig->feedback_plugin_for_gradebook;
3237             // call save in plugins
3238             foreach ($this->feedbackplugins as $plugin) {
3239                 if ($plugin->is_enabled() && $plugin->is_visible()) {
3240                     if (!$plugin->save($grade, $formdata)) {
3241                         $result = false;
3242                         print_error($plugin->get_error());
3243                     }
3244                     if (('assignfeedback_' . $plugin->get_type()) == $gradebookplugin) {
3245                         // this is the feedback plugin chose to push comments to the gradebook
3246                         $grade->feedbacktext = $plugin->text_for_gradebook($grade);
3247                         $grade->feedbackformat = $plugin->format_for_gradebook($grade);
3248                     }
3249                 }
3250             }
3251             $this->process_outcomes($userid, $formdata);
3253             $grade->mailed = 0;
3255             $this->update_grade($grade);
3257             $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3259             $this->add_to_log('grade submission', $this->format_grade_for_log($grade));
3262         } else {
3263             return false;
3264         }
3265         return true;
3266     }
3268     /**
3269      * This function is a static wrapper around can_upgrade
3270      *
3271      * @param string $type The plugin type
3272      * @param int $version The plugin version
3273      * @return bool
3274      */
3275     public static function can_upgrade_assignment($type, $version) {
3276         $assignment = new assign(null, null, null);
3277         return $assignment->can_upgrade($type, $version);
3278     }
3280     /**
3281      * This function returns true if it can upgrade an assignment from the 2.2
3282      * module.
3283      * @param string $type The plugin type
3284      * @param int $version The plugin version
3285      * @return bool
3286      */
3287     public function can_upgrade($type, $version) {
3288         if ($type == 'offline' && $version >= 2011112900) {
3289             return true;
3290         }
3291         foreach ($this->submissionplugins as $plugin) {
3292             if ($plugin->can_upgrade($type, $version)) {
3293                 return true;
3294             }
3295         }
3296         foreach ($this->feedbackplugins as $plugin) {
3297             if ($plugin->can_upgrade($type, $version)) {
3298                 return true;
3299             }
3300         }
3301         return false;
3302     }
3304     /**
3305      * Copy all the files from the old assignment files area to the new one.
3306      * This is used by the plugin upgrade code.
3307      *
3308      * @param int $oldcontextid The old assignment context id
3309      * @param int $oldcomponent The old assignment component ('assignment')
3310      * @param int $oldfilearea The old assignment filearea ('submissions')
3311      * @param int $olditemid The old submissionid (can be null e.g. intro)
3312      * @param int $newcontextid The new assignment context id
3313      * @param int $newcomponent The new assignment component ('assignment')
3314      * @param int $newfilearea The new assignment filearea ('submissions')
3315      * @param int $newitemid The new submissionid (can be null e.g. intro)
3316      * @return int The number of files copied
3317      */
3318     public function copy_area_files_for_upgrade($oldcontextid, $oldcomponent, $oldfilearea, $olditemid, $newcontextid, $newcomponent, $newfilearea, $newitemid) {
3319         // Note, this code is based on some code in filestorage - but that code
3320         // deleted the old files (which we don't want)
3321         $count = 0;
3323         $fs = get_file_storage();
3325         $oldfiles = $fs->get_area_files($oldcontextid, $oldcomponent, $oldfilearea, $olditemid, 'id', false);
3326         foreach ($oldfiles as $oldfile) {
3327             $filerecord = new stdClass();
3328             $filerecord->contextid = $newcontextid;
3329             $filerecord->component = $newcomponent;
3330             $filerecord->filearea = $newfilearea;
3331             $filerecord->itemid = $newitemid;
3332             $fs->create_file_from_storedfile($filerecord, $oldfile);
3333             $count += 1;
3334         }
3336         return $count;
3337     }
3339     /**
3340      * Get an upto date list of user grades and feedback for the gradebook
3341      *
3342      * @param int $userid int or 0 for all users
3343      * @return array of grade data formated for the gradebook api
3344      *         The data required by the gradebook api is userid,