Merge branch 'wip-mdl-35047-m23' of git://github.com/rajeshtaneja/moodle into MOODLE_...
[moodle.git] / mod / assign / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the definition for the class assignment
19  *
20  * This class provides all the functionality for the new assign module.
21  *
22  * @package   mod_assign
23  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Assignment submission statuses
31  */
32 define('ASSIGN_SUBMISSION_STATUS_DRAFT', 'draft'); // student thinks it is a draft
33 define('ASSIGN_SUBMISSION_STATUS_SUBMITTED', 'submitted'); // student thinks it is finished
35 /**
36  * Search filters for grading page
37  */
38 define('ASSIGN_FILTER_SUBMITTED', 'submitted');
39 define('ASSIGN_FILTER_SINGLE_USER', 'singleuser');
40 define('ASSIGN_FILTER_REQUIRE_GRADING', 'require_grading');
42 /** Include accesslib.php */
43 require_once($CFG->libdir.'/accesslib.php');
44 /** Include formslib.php */
45 require_once($CFG->libdir.'/formslib.php');
46 /** Include repository/lib.php */
47 require_once($CFG->dirroot . '/repository/lib.php');
48 /** Include local mod_form.php */
49 require_once($CFG->dirroot.'/mod/assign/mod_form.php');
50 /** gradelib.php */
51 require_once($CFG->libdir.'/gradelib.php');
52 /** grading lib.php */
53 require_once($CFG->dirroot.'/grade/grading/lib.php');
54 /** Include feedbackplugin.php */
55 require_once($CFG->dirroot.'/mod/assign/feedbackplugin.php');
56 /** Include submissionplugin.php */
57 require_once($CFG->dirroot.'/mod/assign/submissionplugin.php');
58 /** Include renderable.php */
59 require_once($CFG->dirroot.'/mod/assign/renderable.php');
60 /** Include gradingtable.php */
61 require_once($CFG->dirroot.'/mod/assign/gradingtable.php');
62 /** Include eventslib.php */
63 require_once($CFG->libdir.'/eventslib.php');
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_RAW)) {
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_RAW)) {
329                 $action = 'previousgrade';
330             } else if (optional_param('nosaveandnext', null, PARAM_RAW)) {
331                 //show next button
332                 $action = 'nextgrade';
333             } else if (optional_param('savegrade', null, PARAM_RAW)) {
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         if (!$userid) {
1633             throw new coding_exception('Row is out of bounds for the current grading table: ' . $rownum);
1634         }
1635         $user = $DB->get_record('user', array('id' => $userid));
1636         if ($user) {
1637             $o .= $this->output->render(new assign_user_summary($user, $this->get_course()->id, has_capability('moodle/site:viewfullnames', $this->get_course_context())));
1638         }
1639         $submission = $this->get_user_submission($userid, false);
1640         // get the current grade
1641         $grade = $this->get_user_grade($userid, false);
1642         if ($this->can_view_submission($userid)) {
1643             $gradelocked = ($grade && $grade->locked) || $this->grading_disabled($userid);
1644             $o .= $this->output->render(new assign_submission_status($this->get_instance()->allowsubmissionsfromdate,
1645                                                               $this->get_instance()->alwaysshowdescription,
1646                                                               $submission,
1647                                                               $this->is_any_submission_plugin_enabled(),
1648                                                               $gradelocked,
1649                                                               $this->is_graded($userid),
1650                                                               $this->get_instance()->duedate,
1651                                                               $this->get_submission_plugins(),
1652                                                               $this->get_return_action(),
1653                                                               $this->get_return_params(),
1654                                                               $this->get_course_module()->id,
1655                                                               assign_submission_status::GRADER_VIEW,
1656                                                               false,
1657                                                               false));
1658         }
1659         if ($grade) {
1660             $data = new stdClass();
1661             if ($grade->grade !== NULL && $grade->grade >= 0) {
1662                 $data->grade = format_float($grade->grade,2);
1663             }
1664         } else {
1665             $data = new stdClass();
1666             $data->grade = '';
1667         }
1669         // now show the grading form
1670         if (!$mform) {
1671             $mform = new mod_assign_grade_form(null, array($this, $data, array('rownum'=>$rownum, 'useridlist'=>$useridlist, 'last'=>$last)), 'post', '', array('class'=>'gradeform'));
1672         }
1673         $o .= $this->output->render(new assign_form('gradingform',$mform));
1675         $this->add_to_log('view grading form', get_string('viewgradingformforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
1677         $o .= $this->view_footer();
1678         return $o;
1679     }
1683     /**
1684      * View a link to go back to the previous page. Uses url parameters returnaction and returnparams.
1685      *
1686      * @return string
1687      */
1688     private function view_return_links() {
1690         $returnaction = optional_param('returnaction','', PARAM_ALPHA);
1691         $returnparams = optional_param('returnparams','', PARAM_TEXT);
1693         $params = array();
1694         parse_str($returnparams, $params);
1695         $params = array_merge( array('id' => $this->get_course_module()->id, 'action' => $returnaction), $params);
1697         return $this->output->single_button(new moodle_url('/mod/assign/view.php', $params), get_string('back'), 'get');
1699     }
1701     /**
1702      * View the grading table of all submissions for this assignment
1703      *
1704      * @return string
1705      */
1706     private function view_grading_table() {
1707         global $USER, $CFG;
1708         // Include grading options form
1709         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
1710         require_once($CFG->dirroot . '/mod/assign/quickgradingform.php');
1711         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
1712         $o = '';
1714         $links = array();
1715         if (has_capability('gradereport/grader:view', $this->get_course_context()) &&
1716                 has_capability('moodle/grade:viewall', $this->get_course_context())) {
1717             $gradebookurl = '/grade/report/grader/index.php?id=' . $this->get_course()->id;
1718             $links[$gradebookurl] = get_string('viewgradebook', 'assign');
1719         }
1720         if ($this->is_any_submission_plugin_enabled()) {
1721             $downloadurl = '/mod/assign/view.php?id=' . $this->get_course_module()->id . '&action=downloadall';
1722             $links[$downloadurl] = get_string('downloadall', 'assign');
1723         }
1725         $gradingactions = new url_select($links);
1727         $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
1729         $perpage = get_user_preferences('assign_perpage', 10);
1730         $filter = get_user_preferences('assign_filter', '');
1731         $controller = $gradingmanager->get_active_controller();
1732         $showquickgrading = empty($controller);
1733         if (optional_param('action', '', PARAM_ALPHA) == 'saveoptions') {
1734             $quickgrading = optional_param('quickgrading', false, PARAM_BOOL);
1735             set_user_preference('assign_quickgrading', $quickgrading);
1736         }
1737         $quickgrading = get_user_preferences('assign_quickgrading', false);
1739         // print options  for changing the filter and changing the number of results per page
1740         $gradingoptionsform = new mod_assign_grading_options_form(null,
1741                                                                   array('cm'=>$this->get_course_module()->id,
1742                                                                         'contextid'=>$this->context->id,
1743                                                                         'userid'=>$USER->id,
1744                                                                         'submissionsenabled'=>$this->is_any_submission_plugin_enabled(),
1745                                                                         'showquickgrading'=>$showquickgrading,
1746                                                                         'quickgrading'=>$quickgrading),
1747                                                                   'post', '',
1748                                                                   array('class'=>'gradingoptionsform'));
1750         $gradingbatchoperationsform = new mod_assign_grading_batch_operations_form(null,
1751                                                                   array('cm'=>$this->get_course_module()->id,
1752                                                                         'submissiondrafts'=>$this->get_instance()->submissiondrafts),
1753                                                                   'post', '',
1754                                                                   array('class'=>'gradingbatchoperationsform'));
1756         $gradingoptionsdata = new stdClass();
1757         $gradingoptionsdata->perpage = $perpage;
1758         $gradingoptionsdata->filter = $filter;
1759         $gradingoptionsform->set_data($gradingoptionsdata);
1761         $actionformtext = $this->output->render($gradingactions);
1762         $o .= $this->output->render(new assign_header($this->get_instance(),
1763                                                       $this->get_context(), false, $this->get_course_module()->id, get_string('grading', 'assign'), $actionformtext));
1764         $o .= groups_print_activity_menu($this->get_course_module(), $CFG->wwwroot . '/mod/assign/view.php?id=' . $this->get_course_module()->id.'&action=grading', true);
1766         // plagiarism update status apearring in the grading book
1767         if (!empty($CFG->enableplagiarism)) {
1768             /** Include plagiarismlib.php */
1769             require_once($CFG->libdir . '/plagiarismlib.php');
1770             $o .= plagiarism_update_status($this->get_course(), $this->get_course_module());
1771         }
1773         // load and print the table of submissions
1774         if ($showquickgrading && $quickgrading) {
1775             $table = $this->output->render(new assign_grading_table($this, $perpage, $filter, 0, true));
1776             $quickgradingform = new mod_assign_quick_grading_form(null,
1777                                                                   array('cm'=>$this->get_course_module()->id,
1778                                                                         'gradingtable'=>$table));
1779             $o .= $this->output->render(new assign_form('quickgradingform', $quickgradingform));
1780         } else {
1781             $o .= $this->output->render(new assign_grading_table($this, $perpage, $filter, 0, false));
1782         }
1784         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
1785         $users = array_keys($this->list_participants($currentgroup, true));
1786         if (count($users) != 0) {
1787             // if no enrolled user in a course then don't display the batch operations feature
1788             $o .= $this->output->render(new assign_form('gradingbatchoperationsform', $gradingbatchoperationsform));
1789         }
1790         $o .= $this->output->render(new assign_form('gradingoptionsform', $gradingoptionsform, 'M.mod_assign.init_grading_options'));
1791         return $o;
1792     }
1794     /**
1795      * View entire grading page.
1796      *
1797      * @return string
1798      */
1799     private function view_grading_page() {
1800         global $CFG;
1802         $o = '';
1803         // Need submit permission to submit an assignment
1804         require_capability('mod/assign:grade', $this->context);
1805         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
1807         // only load this if it is
1809         $o .= $this->view_grading_table();
1811         $o .= $this->view_footer();
1812         $this->add_to_log('view submission grading table', get_string('viewsubmissiongradingtable', 'assign'));
1813         return $o;
1814     }
1816     /**
1817      * Capture the output of the plagiarism plugins disclosures and return it as a string
1818      *
1819      * @return void
1820      */
1821     private function plagiarism_print_disclosure() {
1822         global $CFG;
1823         $o = '';
1825         if (!empty($CFG->enableplagiarism)) {
1826             /** Include plagiarismlib.php */
1827             require_once($CFG->libdir . '/plagiarismlib.php');
1829             $o .= plagiarism_print_disclosure($this->get_course_module()->id);
1830         }
1832         return $o;
1833     }
1835     /**
1836      * message for students when assignment submissions have been closed
1837      *
1838      * @return string
1839      */
1840     private function view_student_error_message() {
1841         global $CFG;
1843         $o = '';
1844         // Need submit permission to submit an assignment
1845         require_capability('mod/assign:submit', $this->context);
1847         $o .= $this->output->render(new assign_header($this->get_instance(),
1848                                                       $this->get_context(),
1849                                                       $this->show_intro(),
1850                                                       $this->get_course_module()->id,
1851                                                       get_string('editsubmission', 'assign')));
1853         $o .= $this->output->notification(get_string('submissionsclosed', 'assign'));
1855         $o .= $this->view_footer();
1857         return $o;
1859     }
1861     /**
1862      * View edit submissions page.
1863      *
1864      * @param moodleform $mform
1865      * @return void
1866      */
1867     private function view_edit_submission_page($mform) {
1868         global $CFG;
1870         $o = '';
1871         // Include submission form
1872         require_once($CFG->dirroot . '/mod/assign/submission_form.php');
1873         // Need submit permission to submit an assignment
1874         require_capability('mod/assign:submit', $this->context);
1876         if (!$this->submissions_open()) {
1877             return $this->view_student_error_message();
1878         }
1879         $o .= $this->output->render(new assign_header($this->get_instance(),
1880                                                       $this->get_context(),
1881                                                       $this->show_intro(),
1882                                                       $this->get_course_module()->id,
1883                                                       get_string('editsubmission', 'assign')));
1884         $o .= $this->plagiarism_print_disclosure();
1885         $data = new stdClass();
1887         if (!$mform) {
1888             $mform = new mod_assign_submission_form(null, array($this, $data));
1889         }
1891         $o .= $this->output->render(new assign_form('editsubmissionform',$mform));
1893         $o .= $this->view_footer();
1894         $this->add_to_log('view submit assignment form', get_string('viewownsubmissionform', 'assign'));
1896         return $o;
1897     }
1899     /**
1900      * See if this assignment has a grade yet
1901      *
1902      * @param int $userid
1903      * @return bool
1904      */
1905     private function is_graded($userid) {
1906         $grade = $this->get_user_grade($userid, false);
1907         if ($grade) {
1908             return ($grade->grade !== NULL && $grade->grade >= 0);
1909         }
1910         return false;
1911     }
1914     /**
1915      * Perform an access check to see if the current $USER can view this users submission
1916      *
1917      * @param int $userid
1918      * @return bool
1919      */
1920     public function can_view_submission($userid) {
1921         global $USER;
1923         if (!is_enrolled($this->get_course_context(), $userid)) {
1924             return false;
1925         }
1926         if ($userid == $USER->id && !has_capability('mod/assign:submit', $this->context)) {
1927             return false;
1928         }
1929         if ($userid != $USER->id && !has_capability('mod/assign:grade', $this->context)) {
1930             return false;
1931         }
1932         return true;
1933     }
1935     /**
1936      * Ask the user to confirm they want to perform this batch operation
1937      * @return string
1938      */
1939     private function process_batch_grading_operation() {
1940         global $CFG;
1941         require_once($CFG->dirroot . '/mod/assign/gradingbatchoperationsform.php');
1942         require_sesskey();
1944         $gradingbatchoperationsform = new mod_assign_grading_batch_operations_form(null,
1945                                                                   array('cm'=>$this->get_course_module()->id,
1946                                                                         'submissiondrafts'=>$this->get_instance()->submissiondrafts),
1947                                                                   'post', '',
1948                                                                   array('class'=>'gradingbatchoperationsform'));
1950         if ($data = $gradingbatchoperationsform->get_data()) {
1951             // get the list of users
1952             $users = $data->selectedusers;
1953             $userlist = explode(',', $users);
1955             foreach ($userlist as $userid) {
1956                 if ($data->operation == 'lock') {
1957                     $this->process_lock($userid);
1958                 } else if ($data->operation == 'unlock') {
1959                     $this->process_unlock($userid);
1960                 } else if ($data->operation == 'reverttodraft') {
1961                     $this->process_revert_to_draft($userid);
1962                 }
1963             }
1964         }
1966         return true;
1967     }
1969     /**
1970      * Ask the user to confirm they want to submit their work for grading
1971      * @return string
1972      */
1973     private function check_submit_for_grading() {
1974         global $USER;
1975         // Check that all of the submission plugins are ready for this submission
1976         $notifications = array();
1977         $submission = $this->get_user_submission($USER->id, false);
1978         $plugins = $this->get_submission_plugins();
1979         foreach ($plugins as $plugin) {
1980             if ($plugin->is_enabled() && $plugin->is_visible()) {
1981                 $check = $plugin->precheck_submission($submission);
1982                 if ($check !== true) {
1983                     $notifications[] = $check;
1984                 }
1985             }
1986         }
1988         $o = '';
1989         $o .= $this->output->header();
1990         $o .= $this->output->render(new assign_submit_for_grading_page($notifications, $this->get_course_module()->id));
1991         $o .= $this->view_footer();
1992         return $o;
1993     }
1995     /**
1996      * Print 2 tables of information with no action links -
1997      * the submission summary and the grading summary
1998      *
1999      * @param stdClass $user the user to print the report for
2000      * @param bool $showlinks - Return plain text or links to the profile
2001      * @return string - the html summary
2002      */
2003     public function view_student_summary($user, $showlinks) {
2004         global $CFG, $DB, $PAGE;
2006         $grade = $this->get_user_grade($user->id, false);
2007         $submission = $this->get_user_submission($user->id, false);
2008         $o = '';
2010         if ($this->can_view_submission($user->id)) {
2011             $showedit = has_capability('mod/assign:submit', $this->context) &&
2012                          $this->submissions_open() && ($this->is_any_submission_plugin_enabled()) && $showlinks;
2013             $showsubmit = $submission && ($submission->status == ASSIGN_SUBMISSION_STATUS_DRAFT) && $showlinks;
2014             $gradelocked = ($grade && $grade->locked) || $this->grading_disabled($user->id);
2016             $o .= $this->output->render(new assign_submission_status($this->get_instance()->allowsubmissionsfromdate,
2017                                                               $this->get_instance()->alwaysshowdescription,
2018                                                               $submission,
2019                                                               $this->is_any_submission_plugin_enabled(),
2020                                                               $gradelocked,
2021                                                               $this->is_graded($user->id),
2022                                                               $this->get_instance()->duedate,
2023                                                               $this->get_submission_plugins(),
2024                                                               $this->get_return_action(),
2025                                                               $this->get_return_params(),
2026                                                               $this->get_course_module()->id,
2027                                                               assign_submission_status::STUDENT_VIEW,
2028                                                               $showedit,
2029                                                               $showsubmit));
2030             require_once($CFG->libdir.'/gradelib.php');
2031             require_once($CFG->dirroot.'/grade/grading/lib.php');
2033             $gradinginfo = grade_get_grades($this->get_course()->id,
2034                                         'mod',
2035                                         'assign',
2036                                         $this->get_instance()->id,
2037                                         $user->id);
2039             $gradingitem = $gradinginfo->items[0];
2040             $gradebookgrade = $gradingitem->grades[$user->id];
2042             // check to see if all feedback plugins are empty
2043             $emptyplugins = true;
2044             if ($grade) {
2045                 foreach ($this->get_feedback_plugins() as $plugin) {
2046                     if ($plugin->is_visible() && $plugin->is_enabled()) {
2047                         if (!$plugin->is_empty($grade)) {
2048                             $emptyplugins = false;
2049                         }
2050                     }
2051                 }
2052             }
2055             if (!($gradebookgrade->hidden) && ($gradebookgrade->grade !== null || !$emptyplugins)) {
2057                 $gradefordisplay = '';
2058                 $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
2060                 if ($controller = $gradingmanager->get_active_controller()) {
2061                     $controller->set_grade_range(make_grades_menu($this->get_instance()->grade));
2062                     $gradefordisplay = $controller->render_grade($PAGE,
2063                                                                  $grade->id,
2064                                                                  $gradingitem,
2065                                                                  $gradebookgrade->str_long_grade,
2066                                                                  has_capability('mod/assign:grade', $this->get_context()));
2067                 } else {
2068                     $gradefordisplay = $this->display_grade($gradebookgrade->grade, false);
2069                 }
2071                 $gradeddate = $gradebookgrade->dategraded;
2072                 $grader = $DB->get_record('user', array('id'=>$gradebookgrade->usermodified));
2074                 $feedbackstatus = new assign_feedback_status($gradefordisplay,
2075                                                       $gradeddate,
2076                                                       $grader,
2077                                                       $this->get_feedback_plugins(),
2078                                                       $grade,
2079                                                       $this->get_course_module()->id,
2080                                                       $this->get_return_action(),
2081                                                       $this->get_return_params());
2083                 $o .= $this->output->render($feedbackstatus);
2084             }
2086         }
2087         return $o;
2088     }
2090     /**
2091      * View submissions page (contains details of current submission).
2092      *
2093      * @return string
2094      */
2095     private function view_submission_page() {
2096         global $CFG, $DB, $USER, $PAGE;
2098         $o = '';
2099         $o .= $this->output->render(new assign_header($this->get_instance(),
2100                                                       $this->get_context(),
2101                                                       $this->show_intro(),
2102                                                       $this->get_course_module()->id));
2104         if ($this->can_grade()) {
2105             $o .= $this->output->render(new assign_grading_summary($this->count_participants(0),
2106                                                             $this->get_instance()->submissiondrafts,
2107                                                             $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_DRAFT),
2108                                                             $this->is_any_submission_plugin_enabled(),
2109                                                             $this->count_submissions_with_status(ASSIGN_SUBMISSION_STATUS_SUBMITTED),
2110                                                             $this->get_instance()->duedate,
2111                                                             $this->get_course_module()->id,
2112                                                             $this->count_submissions_need_grading()
2113                                                             ));
2114         }
2115         $grade = $this->get_user_grade($USER->id, false);
2116         $submission = $this->get_user_submission($USER->id, false);
2118         if ($this->can_view_submission($USER->id)) {
2119             $o .= $this->view_student_summary($USER, true);
2120         }
2123         $o .= $this->view_footer();
2124         $this->add_to_log('view', get_string('viewownsubmissionstatus', 'assign'));
2125         return $o;
2126     }
2128     /**
2129      * convert the final raw grade(s) in the  grading table for the gradebook
2130      *
2131      * @param stdClass $grade
2132      * @return array
2133      */
2134     private function convert_grade_for_gradebook(stdClass $grade) {
2135         $gradebookgrade = array();
2136         // trying to match those array keys in grade update function in gradelib.php
2137         // with keys in th database table assign_grades
2138         // starting around line 262
2139         if ($grade->grade >= 0) {
2140             $gradebookgrade['rawgrade'] = $grade->grade;
2141         }
2142         $gradebookgrade['userid'] = $grade->userid;
2143         $gradebookgrade['usermodified'] = $grade->grader;
2144         $gradebookgrade['datesubmitted'] = NULL;
2145         $gradebookgrade['dategraded'] = $grade->timemodified;
2146         if (isset($grade->feedbackformat)) {
2147             $gradebookgrade['feedbackformat'] = $grade->feedbackformat;
2148         }
2149         if (isset($grade->feedbacktext)) {
2150             $gradebookgrade['feedback'] = $grade->feedbacktext;
2151         }
2153         return $gradebookgrade;
2154     }
2156     /**
2157      * convert submission details for the gradebook
2158      *
2159      * @param stdClass $submission
2160      * @return array
2161      */
2162     private function convert_submission_for_gradebook(stdClass $submission) {
2163         $gradebookgrade = array();
2166         $gradebookgrade['userid'] = $submission->userid;
2167         $gradebookgrade['usermodified'] = $submission->userid;
2168         $gradebookgrade['datesubmitted'] = $submission->timemodified;
2170         return $gradebookgrade;
2171     }
2173     /**
2174      * update grades in the gradebook
2175      *
2176      * @param mixed $submission stdClass|null
2177      * @param mixed $grade stdClass|null
2178      * @return bool
2179      */
2180     private function gradebook_item_update($submission=NULL, $grade=NULL) {
2182         if($submission != NULL){
2183             $gradebookgrade = $this->convert_submission_for_gradebook($submission);
2184         }else{
2185             $gradebookgrade = $this->convert_grade_for_gradebook($grade);
2186         }
2187         // Grading is disabled, return.
2188         if ($this->grading_disabled($gradebookgrade['userid'])) {
2189             return false;
2190         }
2191         $assign = clone $this->get_instance();
2192         $assign->cmidnumber = $this->get_course_module()->id;
2194         return assign_grade_item_update($assign, $gradebookgrade);
2195     }
2197     /**
2198      * update grades in the gradebook based on submission time
2199      *
2200      * @param stdClass $submission
2201      * @param bool $updatetime
2202      * @return bool
2203      */
2204     private function update_submission(stdClass $submission, $updatetime=true) {
2205         global $DB;
2207         if ($updatetime) {
2208             $submission->timemodified = time();
2209         }
2210         $result= $DB->update_record('assign_submission', $submission);
2211         if ($result) {
2212             $this->gradebook_item_update($submission);
2213         }
2214         return $result;
2215     }
2217     /**
2218      * Is this assignment open for submissions?
2219      *
2220      * Check the due date,
2221      * prevent late submissions,
2222      * has this person already submitted,
2223      * is the assignment locked?
2224      *
2225      * @return bool
2226      */
2227     private function submissions_open() {
2228         global $USER;
2230         $time = time();
2231         $dateopen = true;
2232         if ($this->get_instance()->preventlatesubmissions && $this->get_instance()->duedate) {
2233             $dateopen = ($this->get_instance()->allowsubmissionsfromdate <= $time && $time <= $this->get_instance()->duedate);
2234         } else {
2235             $dateopen = ($this->get_instance()->allowsubmissionsfromdate <= $time);
2236         }
2238         if (!$dateopen) {
2239             return false;
2240         }
2242         // now check if this user has already submitted etc.
2243         if (!is_enrolled($this->get_course_context(), $USER)) {
2244             return false;
2245         }
2246         if ($submission = $this->get_user_submission($USER->id, false)) {
2247             if ($this->get_instance()->submissiondrafts && $submission->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2248                 // drafts are tracked and the student has submitted the assignment
2249                 return false;
2250             }
2251         }
2252         if ($grade = $this->get_user_grade($USER->id, false)) {
2253             if ($grade->locked) {
2254                 return false;
2255             }
2256         }
2258         if ($this->grading_disabled($USER->id)) {
2259             return false;
2260         }
2262         return true;
2263     }
2265     /**
2266      * render the files in file area
2267      * @param string $component
2268      * @param string $area
2269      * @param int $submissionid
2270      * @return string
2271      */
2272     public function render_area_files($component, $area, $submissionid) {
2273         global $USER;
2275         if (!$submissionid) {
2276             $submission = $this->get_user_submission($USER->id,false);
2277             $submissionid = $submission->id;
2278         }
2280         $fs = get_file_storage();
2281         $browser = get_file_browser();
2282         $files = $fs->get_area_files($this->get_context()->id, $component, $area , $submissionid , "timemodified", false);
2283         return $this->output->assign_files($this->context, $submissionid, $area, $component);
2285     }
2287     /**
2288      * Returns a list of teachers that should be grading given submission
2289      *
2290      * @param int $userid
2291      * @return array
2292      */
2293     private function get_graders($userid) {
2294         //potential graders
2295         $potentialgraders = get_enrolled_users($this->context, "mod/assign:grade");
2297         $graders = array();
2298         if (groups_get_activity_groupmode($this->get_course_module()) == SEPARATEGROUPS) {   // Separate groups are being used
2299             if ($groups = groups_get_all_groups($this->get_course()->id, $userid)) {  // Try to find all groups
2300                 foreach ($groups as $group) {
2301                     foreach ($potentialgraders as $grader) {
2302                         if ($grader->id == $userid) {
2303                             continue; // do not send self
2304                         }
2305                         if (groups_is_member($group->id, $grader->id)) {
2306                             $graders[$grader->id] = $grader;
2307                         }
2308                     }
2309                 }
2310             } else {
2311                 // user not in group, try to find graders without group
2312                 foreach ($potentialgraders as $grader) {
2313                     if ($grader->id == $userid) {
2314                         continue; // do not send self
2315                     }
2316                     if (!groups_has_membership($this->get_course_module(), $grader->id)) {
2317                         $graders[$grader->id] = $grader;
2318                     }
2319                 }
2320             }
2321         } else {
2322             foreach ($potentialgraders as $grader) {
2323                 if ($grader->id == $userid) {
2324                     continue; // do not send self
2325                 }
2326                 // must be enrolled
2327                 if (is_enrolled($this->get_course_context(), $grader->id)) {
2328                     $graders[$grader->id] = $grader;
2329                 }
2330             }
2331         }
2332         return $graders;
2333     }
2335     /**
2336      * Format a notification for plain text
2337      *
2338      * @param string $messagetype
2339      * @param stdClass $info
2340      * @param stdClass $course
2341      * @param stdClass $context
2342      * @param string $modulename
2343      * @param string $assignmentname
2344      */
2345     private static function format_notification_message_text($messagetype, $info, $course, $context, $modulename, $assignmentname) {
2346         $posttext  = format_string($course->shortname, true, array('context' => $context->get_course_context())).' -> '.
2347                      $modulename.' -> '.
2348                      format_string($assignmentname, true, array('context' => $context))."\n";
2349         $posttext .= '---------------------------------------------------------------------'."\n";
2350         $posttext .= get_string($messagetype . 'text', "assign", $info)."\n";
2351         $posttext .= "\n---------------------------------------------------------------------\n";
2352         return $posttext;
2353     }
2355     /**
2356      * Format a notification for HTML
2357      *
2358      * @param string $messagetype
2359      * @param stdClass $info
2360      * @param stdClass $course
2361      * @param stdClass $context
2362      * @param string $modulename
2363      * @param stdClass $coursemodule
2364      * @param string $assignmentname
2365      * @param stdClass $info
2366      */
2367     private static function format_notification_message_html($messagetype, $info, $course, $context, $modulename, $coursemodule, $assignmentname) {
2368         global $CFG;
2369         $posthtml  = '<p><font face="sans-serif">'.
2370                      '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.format_string($course->shortname, true, array('context' => $context->get_course_context())).'</a> ->'.
2371                      '<a href="'.$CFG->wwwroot.'/mod/assign/index.php?id='.$course->id.'">'.$modulename.'</a> ->'.
2372                      '<a href="'.$CFG->wwwroot.'/mod/assign/view.php?id='.$coursemodule->id.'">'.format_string($assignmentname, true, array('context' => $context)).'</a></font></p>';
2373         $posthtml .= '<hr /><font face="sans-serif">';
2374         $posthtml .= '<p>'.get_string($messagetype . 'html', 'assign', $info).'</p>';
2375         $posthtml .= '</font><hr />';
2376         return $posthtml;
2377     }
2379     /**
2380      * Message someone about something (static so it can be called from cron)
2381      *
2382      * @param stdClass $userfrom
2383      * @param stdClass $userto
2384      * @param string $messagetype
2385      * @param string $eventtype
2386      * @param int $updatetime
2387      * @param stdClass $coursemodule
2388      * @param stdClass $context
2389      * @param stdClass $course
2390      * @param string $modulename
2391      * @param string $assignmentname
2392      * @return void
2393      */
2394     public static function send_assignment_notification($userfrom, $userto, $messagetype, $eventtype,
2395                                                         $updatetime, $coursemodule, $context, $course,
2396                                                         $modulename, $assignmentname) {
2397         global $CFG;
2399         $info = new stdClass();
2400         $info->username = fullname($userfrom, true);
2401         $info->assignment = format_string($assignmentname,true, array('context'=>$context));
2402         $info->url = $CFG->wwwroot.'/mod/assign/view.php?id='.$coursemodule->id;
2403         $info->timeupdated = strftime('%c',$updatetime);
2405         $postsubject = get_string($messagetype . 'small', 'assign', $info);
2406         $posttext = self::format_notification_message_text($messagetype, $info, $course, $context, $modulename, $assignmentname);
2407         $posthtml = ($userto->mailformat == 1) ? self::format_notification_message_html($messagetype, $info, $course, $context, $modulename, $coursemodule, $assignmentname) : '';
2409         $eventdata = new stdClass();
2410         $eventdata->modulename       = 'assign';
2411         $eventdata->userfrom         = $userfrom;
2412         $eventdata->userto           = $userto;
2413         $eventdata->subject          = $postsubject;
2414         $eventdata->fullmessage      = $posttext;
2415         $eventdata->fullmessageformat = FORMAT_PLAIN;
2416         $eventdata->fullmessagehtml  = $posthtml;
2417         $eventdata->smallmessage     = $postsubject;
2419         $eventdata->name            = $eventtype;
2420         $eventdata->component       = 'mod_assign';
2421         $eventdata->notification    = 1;
2422         $eventdata->contexturl      = $info->url;
2423         $eventdata->contexturlname  = $info->assignment;
2425         message_send($eventdata);
2426     }
2428     /**
2429      * Message someone about something
2430      *
2431      * @param stdClass $userfrom
2432      * @param stdClass $userto
2433      * @param string $messagetype
2434      * @param string $eventtype
2435      * @param int $updatetime
2436      * @return void
2437      */
2438     public function send_notification($userfrom, $userto, $messagetype, $eventtype, $updatetime) {
2439         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);
2440     }
2442     /**
2443      * Notify student upon successful submission
2444      *
2445      * @global moodle_database $DB
2446      * @param stdClass $submission
2447      * @return void
2448      */
2449     private function notify_student_submission_receipt(stdClass $submission) {
2450         global $DB;
2452         $adminconfig = $this->get_admin_config();
2453         if (!$adminconfig->submissionreceipts) {
2454             // No need to do anything
2455             return;
2456         }
2457         $user = $DB->get_record('user', array('id'=>$submission->userid), '*', MUST_EXIST);
2458         $this->send_notification($user, $user, 'submissionreceipt', 'assign_notification', $submission->timemodified);
2459     }
2461     /**
2462      * Send notifications to graders upon student submissions
2463      *
2464      * @global moodle_database $DB
2465      * @param stdClass $submission
2466      * @return void
2467      */
2468     private function notify_graders(stdClass $submission) {
2469         global $DB;
2471         $late = $this->get_instance()->duedate && ($this->get_instance()->duedate < time());
2473         if (!$this->get_instance()->sendnotifications && !($late && $this->get_instance()->sendlatenotifications)) {          // No need to do anything
2474             return;
2475         }
2477         $user = $DB->get_record('user', array('id'=>$submission->userid), '*', MUST_EXIST);
2478         if ($teachers = $this->get_graders($user->id)) {
2479             foreach ($teachers as $teacher) {
2480                 $this->send_notification($user, $teacher, 'gradersubmissionupdated', 'assign_notification', $submission->timemodified);
2481             }
2482         }
2483     }
2485     /**
2486      * assignment submission is processed before grading
2487      *
2488      * @return void
2489      */
2490     private function process_submit_for_grading() {
2491         global $USER;
2493         // Need submit permission to submit an assignment
2494         require_capability('mod/assign:submit', $this->context);
2495         require_sesskey();
2497         $submission = $this->get_user_submission($USER->id,true);
2498         if ($submission->status != ASSIGN_SUBMISSION_STATUS_SUBMITTED) {
2499             // Give each submission plugin a chance to process the submission
2500             $plugins = $this->get_submission_plugins();
2501             foreach ($plugins as $plugin) {
2502                 $plugin->submit_for_grading();
2503             }
2505             $submission->status = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
2506             $this->update_submission($submission);
2507             $this->add_to_log('submit for grading', $this->format_submission_for_log($submission));
2508             $this->notify_graders($submission);
2509             $this->notify_student_submission_receipt($submission);
2510         }
2511     }
2513     /**
2514      * save quick grades
2515      *
2516      * @global moodle_database $DB
2517      * @return string The result of the save operation
2518      */
2519     private function process_save_quick_grades() {
2520         global $USER, $DB, $CFG;
2522         // Need grade permission
2523         require_capability('mod/assign:grade', $this->context);
2525         // make sure advanced grading is disabled
2526         $gradingmanager = get_grading_manager($this->get_context(), 'mod_assign', 'submissions');
2527         $controller = $gradingmanager->get_active_controller();
2528         if (!empty($controller)) {
2529             return get_string('errorquickgradingvsadvancedgrading', 'assign');
2530         }
2532         $users = array();
2533         // first check all the last modified values
2534         $currentgroup = groups_get_activity_group($this->get_course_module(), true);
2535         $participants = $this->list_participants($currentgroup, true);
2537         // gets a list of possible users and look for values based upon that.
2538         foreach ($participants as $userid => $unused) {
2539             $modified = optional_param('grademodified_' . $userid, -1, PARAM_INT);
2540             if ($modified >= 0) {
2541                 // gather the userid, updated grade and last modified value
2542                 $record = new stdClass();
2543                 $record->userid = $userid;
2544                 $record->grade = unformat_float(required_param('quickgrade_' . $record->userid, PARAM_TEXT));
2545                 $record->lastmodified = $modified;
2546                 $record->gradinginfo = grade_get_grades($this->get_course()->id, 'mod', 'assign', $this->get_instance()->id, array($userid));
2547                 $users[$userid] = $record;
2548             }
2549         }
2550         if (empty($users)) {
2551             // Quick check to see whether we have any users to update and we don't
2552             return get_string('quickgradingchangessaved', 'assign'); // Technical lie
2553         }
2555         list($userids, $params) = $DB->get_in_or_equal(array_keys($users), SQL_PARAMS_NAMED);
2556         $params['assignment'] = $this->get_instance()->id;
2557         // check them all for currency
2558         $sql = 'SELECT u.id as userid, g.grade as grade, g.timemodified as lastmodified
2559                   FROM {user} u
2560              LEFT JOIN {assign_grades} g ON u.id = g.userid AND g.assignment = :assignment
2561                  WHERE u.id ' . $userids;
2562         $currentgrades = $DB->get_recordset_sql($sql, $params);
2564         $modifiedusers = array();
2565         foreach ($currentgrades as $current) {
2566             $modified = $users[(int)$current->userid];
2567             $grade = $this->get_user_grade($userid, false);
2569             // check to see if the outcomes were modified
2570             if ($CFG->enableoutcomes) {
2571                 foreach ($modified->gradinginfo->outcomes as $outcomeid => $outcome) {
2572                     $oldoutcome = $outcome->grades[$modified->userid]->grade;
2573                     $newoutcome = optional_param('outcome_' . $outcomeid . '_' . $modified->userid, -1, PARAM_FLOAT);
2574                     if ($oldoutcome != $newoutcome) {
2575                         // can't check modified time for outcomes because it is not reported
2576                         $modifiedusers[$modified->userid] = $modified;
2577                         continue;
2578                     }
2579                 }
2580             }
2582             // let plugins participate
2583             foreach ($this->feedbackplugins as $plugin) {
2584                 if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->supports_quickgrading()) {
2585                     if ($plugin->is_quickgrading_modified($modified->userid, $grade)) {
2586                         if ((int)$current->lastmodified > (int)$modified->lastmodified) {
2587                             return get_string('errorrecordmodified', 'assign');
2588                         } else {
2589                             $modifiedusers[$modified->userid] = $modified;
2590                             continue;
2591                         }
2592                     }
2593                 }
2594             }
2597             if (($current->grade < 0 || $current->grade === NULL) &&
2598                 ($modified->grade < 0 || $modified->grade === NULL)) {
2599                 // different ways to indicate no grade
2600                 continue;
2601             }
2602             // Treat 0 and null as different values
2603             if ($current->grade !== null) {
2604                 $current->grade = floatval($current->grade);
2605             }
2606             if ($current->grade !== $modified->grade) {
2607                 // grade changed
2608                 if ($this->grading_disabled($modified->userid)) {
2609                     continue;
2610                 }
2611                 if ((int)$current->lastmodified > (int)$modified->lastmodified) {
2612                     // error - record has been modified since viewing the page
2613                     return get_string('errorrecordmodified', 'assign');
2614                 } else {
2615                     $modifiedusers[$modified->userid] = $modified;
2616                 }
2617             }
2619         }
2620         $currentgrades->close();
2622         $adminconfig = $this->get_admin_config();
2623         $gradebookplugin = $adminconfig->feedback_plugin_for_gradebook;
2625         // ok - ready to process the updates
2626         foreach ($modifiedusers as $userid => $modified) {
2627             $grade = $this->get_user_grade($userid, true);
2628             $grade->grade= grade_floatval(unformat_float($modified->grade));
2629             $grade->grader= $USER->id;
2631             // save plugins data
2632             foreach ($this->feedbackplugins as $plugin) {
2633                 if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->supports_quickgrading()) {
2634                     $plugin->save_quickgrading_changes($userid, $grade);
2635                     if (('assignfeedback_' . $plugin->get_type()) == $gradebookplugin) {
2636                         // This is the feedback plugin chose to push comments to the gradebook.
2637                         $grade->feedbacktext = $plugin->text_for_gradebook($grade);
2638                         $grade->feedbackformat = $plugin->format_for_gradebook($grade);
2639                     }
2640                 }
2641             }
2643             $this->update_grade($grade);
2645             // save outcomes
2646             if ($CFG->enableoutcomes) {
2647                 $data = array();
2648                 foreach ($modified->gradinginfo->outcomes as $outcomeid => $outcome) {
2649                     $oldoutcome = $outcome->grades[$modified->userid]->grade;
2650                     $newoutcome = optional_param('outcome_' . $outcomeid . '_' . $modified->userid, -1, PARAM_INT);
2651                     if ($oldoutcome != $newoutcome) {
2652                         $data[$outcomeid] = $newoutcome;
2653                     }
2654                 }
2655                 if (count($data) > 0) {
2656                     grade_update_outcomes('mod/assign', $this->course->id, 'mod', 'assign', $this->get_instance()->id, $userid, $data);
2657                 }
2658             }
2660             $this->add_to_log('grade submission', $this->format_grade_for_log($grade));
2661         }
2663         return get_string('quickgradingchangessaved', 'assign');
2664     }
2666     /**
2667      * save grading options
2668      *
2669      * @return void
2670      */
2671     private function process_save_grading_options() {
2672         global $USER, $CFG;
2674         // Include grading options form
2675         require_once($CFG->dirroot . '/mod/assign/gradingoptionsform.php');
2677         // Need submit permission to submit an assignment
2678         require_capability('mod/assign:grade', $this->context);
2680         $mform = new mod_assign_grading_options_form(null, array('cm'=>$this->get_course_module()->id,
2681                                                                  'contextid'=>$this->context->id,
2682                                                                  'userid'=>$USER->id,
2683                                                                  'submissionsenabled'=>$this->is_any_submission_plugin_enabled(),
2684                                                                  'showquickgrading'=>false));
2685         if ($formdata = $mform->get_data()) {
2686             set_user_preference('assign_perpage', $formdata->perpage);
2687             set_user_preference('assign_filter', $formdata->filter);
2688         }
2689     }
2691    /**
2692     * Take a grade object and print a short summary for the log file.
2693     * The size limit for the log file is 255 characters, so be careful not
2694     * to include too much information.
2695     *
2696     * @param stdClass $grade
2697     * @return string
2698     */
2699     private function format_grade_for_log(stdClass $grade) {
2700         global $DB;
2702         $user = $DB->get_record('user', array('id' => $grade->userid), '*', MUST_EXIST);
2704         $info = get_string('gradestudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user)));
2705         if ($grade->grade != '') {
2706             $info .= get_string('grade') . ': ' . $this->display_grade($grade->grade, false) . '. ';
2707         } else {
2708             $info .= get_string('nograde', 'assign');
2709         }
2710         if ($grade->locked) {
2711             $info .= get_string('submissionslocked', 'assign') . '. ';
2712         }
2713         return $info;
2714     }
2716     /**
2717      * Take a submission object and print a short summary for the log file.
2718      * The size limit for the log file is 255 characters, so be careful not
2719      * to include too much information.
2720      *
2721      * @param stdClass $submission
2722      * @return string
2723      */
2724     private function format_submission_for_log(stdClass $submission) {
2725         $info = '';
2726         $info .= get_string('submissionstatus', 'assign') . ': ' . get_string('submissionstatus_' . $submission->status, 'assign') . '. <br>';
2727         // format_for_log here iterating every single log INFO  from either submission or grade in every assignment plugin
2729         foreach ($this->submissionplugins as $plugin) {
2730             if ($plugin->is_enabled() && $plugin->is_visible()) {
2733                 $info .= "<br>" . $plugin->format_for_log($submission);
2734             }
2735         }
2738         return $info;
2739     }
2741     /**
2742      * save assignment submission
2743      *
2744      * @param  moodleform $mform
2745      * @return bool
2746      */
2747     private function process_save_submission(&$mform) {
2748         global $USER, $CFG;
2750         // Include submission form
2751         require_once($CFG->dirroot . '/mod/assign/submission_form.php');
2753         // Need submit permission to submit an assignment
2754         require_capability('mod/assign:submit', $this->context);
2755         require_sesskey();
2757         $data = new stdClass();
2758         $mform = new mod_assign_submission_form(null, array($this, $data));
2759         if ($mform->is_cancelled()) {
2760             return true;
2761         }
2762         if ($data = $mform->get_data()) {
2763             $submission = $this->get_user_submission($USER->id, true); //create the submission if needed & its id
2764             $grade = $this->get_user_grade($USER->id, false); // get the grade to check if it is locked
2765             if ($grade && $grade->locked) {
2766                 print_error('submissionslocked', 'assign');
2767                 return true;
2768             }
2771             foreach ($this->submissionplugins as $plugin) {
2772                 if ($plugin->is_enabled()) {
2773                     if (!$plugin->save($submission, $data)) {
2774                         print_error($plugin->get_error());
2775                     }
2776                 }
2777             }
2779             $this->update_submission($submission);
2781             // Logging
2782             $this->add_to_log('submit', $this->format_submission_for_log($submission));
2784             if (!$this->get_instance()->submissiondrafts) {
2785                 $this->notify_student_submission_receipt($submission);
2786                 $this->notify_graders($submission);
2787             }
2788             return true;
2789         }
2790         return false;
2791     }
2794     /**
2795      * Determine if this users grade is locked or overridden
2796      *
2797      * @param int $userid - The student userid
2798      * @return bool $gradingdisabled
2799      */
2800     public function grading_disabled($userid) {
2801         global $CFG;
2803         $gradinginfo = grade_get_grades($this->get_course()->id, 'mod', 'assign', $this->get_instance()->id, array($userid));
2804         if (!$gradinginfo) {
2805             return false;
2806         }
2808         if (!isset($gradinginfo->items[0]->grades[$userid])) {
2809             return false;
2810         }
2811         $gradingdisabled = $gradinginfo->items[0]->grades[$userid]->locked || $gradinginfo->items[0]->grades[$userid]->overridden;
2812         return $gradingdisabled;
2813     }
2816     /**
2817      * Get an instance of a grading form if advanced grading is enabled
2818      * This is specific to the assignment, marker and student
2819      *
2820      * @param int $userid - The student userid
2821      * @param bool $gradingdisabled
2822      * @return mixed gradingform_instance|null $gradinginstance
2823      */
2824     private function get_grading_instance($userid, $gradingdisabled) {
2825         global $CFG, $USER;
2827         $grade = $this->get_user_grade($userid, false);
2828         $grademenu = make_grades_menu($this->get_instance()->grade);
2830         $advancedgradingwarning = false;
2831         $gradingmanager = get_grading_manager($this->context, 'mod_assign', 'submissions');
2832         $gradinginstance = null;
2833         if ($gradingmethod = $gradingmanager->get_active_method()) {
2834             $controller = $gradingmanager->get_controller($gradingmethod);
2835             if ($controller->is_form_available()) {
2836                 $itemid = null;
2837                 if ($grade) {
2838                     $itemid = $grade->id;
2839                 }
2840                 if ($gradingdisabled && $itemid) {
2841                     $gradinginstance = ($controller->get_current_instance($USER->id, $itemid));
2842                 } else if (!$gradingdisabled) {
2843                     $instanceid = optional_param('advancedgradinginstanceid', 0, PARAM_INT);
2844                     $gradinginstance = ($controller->get_or_create_instance($instanceid, $USER->id, $itemid));
2845                 }
2846             } else {
2847                 $advancedgradingwarning = $controller->form_unavailable_notification();
2848             }
2849         }
2850         if ($gradinginstance) {
2851             $gradinginstance->get_controller()->set_grade_range($grademenu);
2852         }
2853         return $gradinginstance;
2854     }
2856     /**
2857      * add elements to grade form
2858      *
2859      * @param MoodleQuickForm $mform
2860      * @param stdClass $data
2861      * @param array $params
2862      * @return void
2863      */
2864     public function add_grade_form_elements(MoodleQuickForm $mform, stdClass $data, $params) {
2865         global $USER, $CFG;
2866         $settings = $this->get_instance();
2868         $rownum = $params['rownum'];
2869         $last = $params['last'];
2870         $useridlist = $params['useridlist'];
2871         $userid = $useridlist[$rownum];
2872         $grade = $this->get_user_grade($userid, false);
2874         // add advanced grading
2875         $gradingdisabled = $this->grading_disabled($userid);
2876         $gradinginstance = $this->get_grading_instance($userid, $gradingdisabled);
2878         if ($gradinginstance) {
2879             $gradingelement = $mform->addElement('grading', 'advancedgrading', get_string('grade').':', array('gradinginstance' => $gradinginstance));
2880             if ($gradingdisabled) {
2881                 $gradingelement->freeze();
2882             } else {
2883                 $mform->addElement('hidden', 'advancedgradinginstanceid', $gradinginstance->get_id());
2884             }
2885         } else {
2886             // use simple direct grading
2887             if ($this->get_instance()->grade > 0) {
2888                 $gradingelement = $mform->addElement('text', 'grade', get_string('gradeoutof', 'assign',$this->get_instance()->grade));
2889                 $mform->addHelpButton('grade', 'gradeoutofhelp', 'assign');
2890                 $mform->setType('grade', PARAM_TEXT);
2891                 if ($gradingdisabled) {
2892                     $gradingelement->freeze();
2893                 }
2894             } else {
2895                 $grademenu = make_grades_menu($this->get_instance()->grade);
2896                 if (count($grademenu) > 0) {
2897                     $gradingelement = $mform->addElement('select', 'grade', get_string('grade').':', $grademenu);
2898                     $mform->setType('grade', PARAM_INT);
2899                     if ($gradingdisabled) {
2900                         $gradingelement->freeze();
2901                     }
2902                 }
2903             }
2904         }
2906         $gradinginfo = grade_get_grades($this->get_course()->id,
2907                                         'mod',
2908                                         'assign',
2909                                         $this->get_instance()->id,
2910                                         $userid);
2911         if (!empty($CFG->enableoutcomes)) {
2912             foreach($gradinginfo->outcomes as $index=>$outcome) {
2913                 $options = make_grades_menu(-$outcome->scaleid);
2914                 if ($outcome->grades[$userid]->locked) {
2915                     $options[0] = get_string('nooutcome', 'grades');
2916                     $mform->addElement('static', 'outcome_'.$index.'['.$userid.']', $outcome->name.':',
2917                             $options[$outcome->grades[$userid]->grade]);
2918                 } else {
2919                     $options[''] = get_string('nooutcome', 'grades');
2920                     $attributes = array('id' => 'menuoutcome_'.$index );
2921                     $mform->addElement('select', 'outcome_'.$index.'['.$userid.']', $outcome->name.':', $options, $attributes );
2922                     $mform->setType('outcome_'.$index.'['.$userid.']', PARAM_INT);
2923                     $mform->setDefault('outcome_'.$index.'['.$userid.']', $outcome->grades[$userid]->grade );
2924                 }
2925             }
2926         }
2928         if (has_all_capabilities(array('gradereport/grader:view', 'moodle/grade:viewall'), $this->get_course_context())) {
2929             $gradestring = $this->output->action_link(new moodle_url('/grade/report/grader/index.php',
2930                                                               array('id'=>$this->get_course()->id)),
2931                                                 $gradinginfo->items[0]->grades[$userid]->str_grade);
2932         } else {
2933             $gradestring = $gradinginfo->items[0]->grades[$userid]->str_grade;
2934         }
2935         $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assign').':', $gradestring);
2938         $mform->addElement('static', 'progress', '', get_string('gradingstudentprogress', 'assign', array('index'=>$rownum+1, 'count'=>count($useridlist))));
2940         // plugins
2941         $this->add_plugin_grade_elements($grade, $mform, $data);
2943         // hidden params
2944         $mform->addElement('hidden', 'id', $this->get_course_module()->id);
2945         $mform->setType('id', PARAM_INT);
2946         $mform->addElement('hidden', 'rownum', $rownum);
2947         $mform->setType('rownum', PARAM_INT);
2948         $mform->setConstant('rownum', $rownum);
2949         $mform->addElement('hidden', 'useridlist', implode(',', $useridlist));
2950         $mform->setType('useridlist', PARAM_TEXT);
2951         $mform->addElement('hidden', 'ajax', optional_param('ajax', 0, PARAM_INT));
2952         $mform->setType('ajax', PARAM_INT);
2954         $mform->addElement('hidden', 'action', 'submitgrade');
2955         $mform->setType('action', PARAM_ALPHA);
2958         $buttonarray=array();
2959         $buttonarray[] = $mform->createElement('submit', 'savegrade', get_string('savechanges', 'assign'));
2960         if (!$last){
2961             $buttonarray[] = $mform->createElement('submit', 'saveandshownext', get_string('savenext','assign'));
2962         }
2963         $buttonarray[] = $mform->createElement('cancel', 'cancelbutton', get_string('cancel'));
2964         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
2965         $mform->closeHeaderBefore('buttonar');
2966         $buttonarray=array();
2968         if ($rownum > 0) {
2969             $buttonarray[] = $mform->createElement('submit', 'nosaveandprevious', get_string('previous','assign'));
2970         }
2972         if (!$last){
2973             $buttonarray[] = $mform->createElement('submit', 'nosaveandnext', get_string('nosavebutnext', 'assign'));
2974         }
2975         $mform->addGroup($buttonarray, 'navar', '', array(' '), false);
2976     }
2979     /**
2980      * add elements in submission plugin form
2981      *
2982      * @param mixed $submission stdClass|null
2983      * @param MoodleQuickForm $mform
2984      * @param stdClass $data
2985      * @return void
2986      */
2987     private function add_plugin_submission_elements($submission, MoodleQuickForm $mform, stdClass $data) {
2988         foreach ($this->submissionplugins as $plugin) {
2989             if ($plugin->is_enabled() && $plugin->is_visible() && $plugin->allow_submissions()) {
2990                 $mform->addElement('header', 'header_' . $plugin->get_type(), $plugin->get_name());
2991                 if (!$plugin->get_form_elements($submission, $mform, $data)) {
2992                     $mform->removeElement('header_' . $plugin->get_type());
2993                 }
2994             }
2995         }
2996     }
2998     /**
2999      * check if feedback plugins installed are enabled
3000      *
3001      * @return bool
3002      */
3003     public function is_any_feedback_plugin_enabled() {
3004         if (!isset($this->cache['any_feedback_plugin_enabled'])) {
3005             $this->cache['any_feedback_plugin_enabled'] = false;
3006             foreach ($this->feedbackplugins as $plugin) {
3007                 if ($plugin->is_enabled() && $plugin->is_visible()) {
3008                     $this->cache['any_feedback_plugin_enabled'] = true;
3009                     break;
3010                 }
3011             }
3012         }
3014         return $this->cache['any_feedback_plugin_enabled'];
3016     }
3018     /**
3019      * check if submission plugins installed are enabled
3020      *
3021      * @return bool
3022      */
3023     public function is_any_submission_plugin_enabled() {
3024         if (!isset($this->cache['any_submission_plugin_enabled'])) {
3025             $this->cache['any_submission_plugin_enabled'] = false;
3026             foreach ($this->submissionplugins as $plugin) {
3027                 if ($plugin->is_enabled() && $plugin->is_visible() && $plugin->allow_submissions()) {
3028                     $this->cache['any_submission_plugin_enabled'] = true;
3029                     break;
3030                 }
3031             }
3032         }
3034         return $this->cache['any_submission_plugin_enabled'];
3036     }
3038     /**
3039      * add elements to submission form
3040      * @param MoodleQuickForm $mform
3041      * @param stdClass $data
3042      * @return void
3043      */
3044     public function add_submission_form_elements(MoodleQuickForm $mform, stdClass $data) {
3045         global $USER;
3047         // online text submissions
3049         $submission = $this->get_user_submission($USER->id, false);
3051         $this->add_plugin_submission_elements($submission, $mform, $data);
3053         // hidden params
3054         $mform->addElement('hidden', 'id', $this->get_course_module()->id);
3055         $mform->setType('id', PARAM_INT);
3057         $mform->addElement('hidden', 'action', 'savesubmission');
3058         $mform->setType('action', PARAM_TEXT);
3059         // buttons
3061     }
3063     /**
3064      * revert to draft
3065      * Uses url parameter userid
3066      *
3067      * @param int $userid
3068      * @return void
3069      */
3070     private function process_revert_to_draft($userid = 0) {
3071         global $USER, $DB;
3073         // Need grade permission
3074         require_capability('mod/assign:grade', $this->context);
3075         require_sesskey();
3077         if (!$userid) {
3078             $userid = required_param('userid', PARAM_INT);
3079         }
3081         $submission = $this->get_user_submission($userid, false);
3082         if (!$submission) {
3083             return;
3084         }
3085         $submission->status = ASSIGN_SUBMISSION_STATUS_DRAFT;
3086         $this->update_submission($submission, false);
3088         // update the modified time on the grade (grader modified)
3089         $grade = $this->get_user_grade($userid, true);
3090         $this->update_grade($grade);
3092         $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3094         $this->add_to_log('revert submission to draft', get_string('reverttodraftforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
3096     }
3098     /**
3099      * lock  the process
3100      * Uses url parameter userid
3101      * @param int $userid
3102      * @return void
3103      */
3104     private function process_lock($userid = 0) {
3105         global $USER, $DB;
3107         // Need grade permission
3108         require_capability('mod/assign:grade', $this->context);
3109         require_sesskey();
3111         if (!$userid) {
3112             $userid = required_param('userid', PARAM_INT);
3113         }
3115         $grade = $this->get_user_grade($userid, true);
3116         $grade->locked = 1;
3117         $grade->grader = $USER->id;
3118         $this->update_grade($grade);
3120         $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3122         $this->add_to_log('lock submission', get_string('locksubmissionforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
3123     }
3125     /**
3126      * unlock the process
3127      *
3128      * @param int $userid
3129      * @return void
3130      */
3131     private function process_unlock($userid = 0) {
3132         global $USER, $DB;
3134         // Need grade permission
3135         require_capability('mod/assign:grade', $this->context);
3136         require_sesskey();
3138         if (!$userid) {
3139             $userid = required_param('userid', PARAM_INT);
3140         }
3142         $grade = $this->get_user_grade($userid, true);
3143         $grade->locked = 0;
3144         $grade->grader = $USER->id;
3145         $this->update_grade($grade);
3147         $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3149         $this->add_to_log('unlock submission', get_string('unlocksubmissionforstudent', 'assign', array('id'=>$user->id, 'fullname'=>fullname($user))));
3150     }
3152     /**
3153      * save outcomes submitted from grading form
3154      *
3155      * @param int $userid
3156      * @param stdClass $formdata
3157      */
3158     private function process_outcomes($userid, $formdata) {
3159         global $CFG, $USER;
3161         if (empty($CFG->enableoutcomes)) {
3162             return;
3163         }
3164         if ($this->grading_disabled($userid)) {
3165             return;
3166         }
3168         require_once($CFG->libdir.'/gradelib.php');
3170         $data = array();
3171         $gradinginfo = grade_get_grades($this->get_course()->id,
3172                                         'mod',
3173                                         'assign',
3174                                         $this->get_instance()->id,
3175                                         $userid);
3177         if (!empty($gradinginfo->outcomes)) {
3178             foreach($gradinginfo->outcomes as $index=>$oldoutcome) {
3179                 $name = 'outcome_'.$index;
3180                 if (isset($formdata->{$name}[$userid]) and $oldoutcome->grades[$userid]->grade != $formdata->{$name}[$userid]) {
3181                     $data[$index] = $formdata->{$name}[$userid];
3182                 }
3183             }
3184         }
3185         if (count($data) > 0) {
3186             grade_update_outcomes('mod/assign', $this->course->id, 'mod', 'assign', $this->get_instance()->id, $userid, $data);
3187         }
3189     }
3192     /**
3193      * save grade
3194      *
3195      * @param  moodleform $mform
3196      * @return bool - was the grade saved
3197      */
3198     private function process_save_grade(&$mform) {
3199         global $USER, $DB, $CFG;
3200         // Include grade form
3201         require_once($CFG->dirroot . '/mod/assign/gradeform.php');
3203         // Need submit permission to submit an assignment
3204         require_capability('mod/assign:grade', $this->context);
3205         require_sesskey();
3207         $rownum = required_param('rownum', PARAM_INT);
3208         $useridlist = optional_param('useridlist', '', PARAM_TEXT);
3209         if ($useridlist) {
3210             $useridlist = explode(',', $useridlist);
3211         } else {
3212             $useridlist = $this->get_grading_userid_list();
3213         }
3214         $last = false;
3215         $userid = $useridlist[$rownum];
3216         if ($rownum == count($useridlist) - 1) {
3217             $last = true;
3218         }
3220         $data = new stdClass();
3221         $mform = new mod_assign_grade_form(null, array($this, $data, array('rownum'=>$rownum, 'useridlist'=>$useridlist, 'last'=>false)), 'post', '', array('class'=>'gradeform'));
3223         if ($formdata = $mform->get_data()) {
3224             $grade = $this->get_user_grade($userid, true);
3225             $gradingdisabled = $this->grading_disabled($userid);
3226             $gradinginstance = $this->get_grading_instance($userid, $gradingdisabled);
3227             if (!$gradingdisabled) {
3228                 if ($gradinginstance) {
3229                     $grade->grade = $gradinginstance->submit_and_get_grade($formdata->advancedgrading, $grade->id);
3230                 } else {
3231                     // handle the case when grade is set to No Grade
3232                     if (isset($formdata->grade)) {
3233                         $grade->grade = grade_floatval(unformat_float($formdata->grade));
3234                     }
3235                 }
3236             }
3237             $grade->grader= $USER->id;
3239             $adminconfig = $this->get_admin_config();
3240             $gradebookplugin = $adminconfig->feedback_plugin_for_gradebook;
3242             // call save in plugins
3243             foreach ($this->feedbackplugins as $plugin) {
3244                 if ($plugin->is_enabled() && $plugin->is_visible()) {
3245                     if (!$plugin->save($grade, $formdata)) {
3246                         $result = false;
3247                         print_error($plugin->get_error());
3248                     }
3249                     if (('assignfeedback_' . $plugin->get_type()) == $gradebookplugin) {
3250                         // this is the feedback plugin chose to push comments to the gradebook
3251                         $grade->feedbacktext = $plugin->text_for_gradebook($grade);
3252                         $grade->feedbackformat = $plugin->format_for_gradebook($grade);
3253                     }
3254                 }
3255             }
3256             $this->process_outcomes($userid, $formdata);
3258             $grade->mailed = 0;
3260             $this->update_grade($grade);
3262             $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
3264             $this->add_to_log('grade submission', $this->format_grade_for_log($grade));
3267         } else {
3268             return false;
3269         }
3270         return true;
3271     }
3273     /**
3274      * This function is a static wrapper around can_upgrade
3275      *
3276      * @param string $type The plugin type
3277      * @param int $version The plugin version
3278      * @return bool
3279      */
3280     public static function can_upgrade_assignment($type, $version) {
3281         $assignment = new assign(null, null, null);
3282         return $assignment->can_upgrade($type, $version);
3283     }
3285     /**
3286      * This function returns true if it can upgrade an assignment from the 2.2
3287      * module.
3288      * @param string $type The plugin type
3289      * @param int $version The plugin version
3290      * @return bool
3291      */
3292     public function can_upgrade($type, $version) {
3293         if ($type == 'offline' && $version >= 2011112900) {
3294             return true;
3295         }
3296         foreach ($this->submissionplugins as $plugin) {
3297             if ($plugin->can_upgrade($type, $version)) {
3298                 return true;
3299             }
3300         }
3301         foreach ($this->feedbackplugins as $plugin) {
3302             if ($plugin->can_upgrade($type, $version)) {
3303                 return true;
3304             }
3305         }
3306         return false;
3307     }
3309     /**
3310      * Copy all the files from the old assignment files area to the new one.
3311      * This is used by the plugin upgrade code.
3312      *
3313      * @param int $oldcontextid The old assignment context id
3314      * @param int $oldcomponent The old assignment component ('assignment')
3315      * @param int $oldfilearea The old assignment filearea ('submissions')
3316      * @param int $olditemid The old submissionid (can be null e.g. intro)
3317      * @param int $newcontextid The new assignment context id
3318      * @param int $newcomponent The new assignment component ('assignment')
3319      * @param int $newfilearea The new assignment filearea ('submissions')
3320      * @param int $newitemid The new submissionid (can be null e.g. intro)
3321      * @return int The number of files copied
3322      */
3323     public function copy_area_files_for_upgrade($oldcontextid, $oldcomponent, $oldfilearea, $olditemid, $newcontextid, $newcomponent, $newfilearea, $newitemid) {
3324         // Note, this code is based on some code in filestorage - but that code
3325         // deleted the old files (which we don't want)
3326         $count = 0;
3328         $fs = get_file_storage();
3330         $oldfiles = $fs->get_area_files($oldcontextid, $oldcomponent, $oldfilearea, $olditemid, 'id', false);
3331         foreach ($oldfiles as $oldfile) {
3332             $filerecord = new stdClass();
3333             $filerecord->contextid = $newcontextid;
3334             $filerecord->component = $newcomponent;
3335             $filerecord->filearea = $newfilearea;
3336             $filerecord->itemid = $newitemid;
3337             $fs->create_file_from_storedfile($filerecord, $oldfile);
3338