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