Plagiarism API MDL-13680 move update_status call untill after print header so it...
[moodle.git] / mod / assignment / lib.php
1 <?PHP
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * assignment_base is the base class for assignment types
20  *
21  * This class provides all the functionality for an assignment
22  *
23  * @package   mod-assignment
24  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 /** Include eventslib.php */
29 require_once($CFG->libdir.'/eventslib.php');
30 /** Include formslib.php */
31 require_once($CFG->libdir.'/formslib.php');
32 /** Include calendar/lib.php */
33 require_once($CFG->dirroot.'/calendar/lib.php');
35 /** ASSIGNMENT_COUNT_WORDS = 1 */
36 define('ASSIGNMENT_COUNT_WORDS', 1);
37 /** ASSIGNMENT_COUNT_LETTERS = 2 */
38 define('ASSIGNMENT_COUNT_LETTERS', 2);
40 /**
41  * Standard base class for all assignment submodules (assignment types).
42  *
43  * @package   mod-assignment
44  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
45  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46  */
47 class assignment_base {
49     const FILTER_ALL             = 0;
50     const FILTER_SUBMITTED       = 1;
51     const FILTER_REQUIRE_GRADING = 2;
53     /** @var object */
54     var $cm;
55     /** @var object */
56     var $course;
57     /** @var object */
58     var $assignment;
59     /** @var string */
60     var $strassignment;
61     /** @var string */
62     var $strassignments;
63     /** @var string */
64     var $strsubmissions;
65     /** @var string */
66     var $strlastmodified;
67     /** @var string */
68     var $pagetitle;
69     /** @var bool */
70     var $usehtmleditor;
71     /**
72      * @todo document this var
73      */
74     var $defaultformat;
75     /**
76      * @todo document this var
77      */
78     var $context;
79     /** @var string */
80     var $type;
82     /**
83      * Constructor for the base assignment class
84      *
85      * Constructor for the base assignment class.
86      * If cmid is set create the cm, course, assignment objects.
87      * If the assignment is hidden and the user is not a teacher then
88      * this prints a page header and notice.
89      *
90      * @global object
91      * @global object
92      * @param int $cmid the current course module id - not set for new assignments
93      * @param object $assignment usually null, but if we have it we pass it to save db access
94      * @param object $cm usually null, but if we have it we pass it to save db access
95      * @param object $course usually null, but if we have it we pass it to save db access
96      */
97     function assignment_base($cmid='staticonly', $assignment=NULL, $cm=NULL, $course=NULL) {
98         global $COURSE, $DB;
100         if ($cmid == 'staticonly') {
101             //use static functions only!
102             return;
103         }
105         global $CFG;
107         if ($cm) {
108             $this->cm = $cm;
109         } else if (! $this->cm = get_coursemodule_from_id('assignment', $cmid)) {
110             print_error('invalidcoursemodule');
111         }
113         $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
115         if ($course) {
116             $this->course = $course;
117         } else if ($this->cm->course == $COURSE->id) {
118             $this->course = $COURSE;
119         } else if (! $this->course = $DB->get_record('course', array('id'=>$this->cm->course))) {
120             print_error('invalidid', 'assignment');
121         }
123         if ($assignment) {
124             $this->assignment = $assignment;
125         } else if (! $this->assignment = $DB->get_record('assignment', array('id'=>$this->cm->instance))) {
126             print_error('invalidid', 'assignment');
127         }
129         $this->assignment->cmidnumber = $this->cm->idnumber; // compatibility with modedit assignment obj
130         $this->assignment->courseid   = $this->course->id; // compatibility with modedit assignment obj
132         $this->strassignment = get_string('modulename', 'assignment');
133         $this->strassignments = get_string('modulenameplural', 'assignment');
134         $this->strsubmissions = get_string('submissions', 'assignment');
135         $this->strlastmodified = get_string('lastmodified');
136         $this->pagetitle = strip_tags($this->course->shortname.': '.$this->strassignment.': '.format_string($this->assignment->name,true));
138         // visibility handled by require_login() with $cm parameter
139         // get current group only when really needed
141     /// Set up things for a HTML editor if it's needed
142         $this->defaultformat = editors_get_preferred_format();
143     }
145     /**
146      * Display the assignment, used by view.php
147      *
148      * This in turn calls the methods producing individual parts of the page
149      */
150     function view() {
152         $context = get_context_instance(CONTEXT_MODULE,$this->cm->id);
153         require_capability('mod/assignment:view', $context);
155         add_to_log($this->course->id, "assignment", "view", "view.php?id={$this->cm->id}",
156                    $this->assignment->id, $this->cm->id);
158         $this->view_header();
160         $this->view_intro();
162         $this->view_dates();
164         $this->view_feedback();
166         $this->view_footer();
167     }
169     /**
170      * Display the header and top of a page
171      *
172      * (this doesn't change much for assignment types)
173      * This is used by the view() method to print the header of view.php but
174      * it can be used on other pages in which case the string to denote the
175      * page in the navigation trail should be passed as an argument
176      *
177      * @global object
178      * @param string $subpage Description of subpage to be used in navigation trail
179      */
180     function view_header($subpage='') {
181         global $CFG, $PAGE, $OUTPUT;
183         if ($subpage) {
184             $PAGE->navbar->add($subpage);
185         }
187         $PAGE->set_title($this->pagetitle);
188         $PAGE->set_heading($this->course->fullname);
190         echo $OUTPUT->header();
192         groups_print_activity_menu($this->cm, $CFG->wwwroot . '/mod/assignment/view.php?id=' . $this->cm->id);
194         echo '<div class="reportlink">'.$this->submittedlink().'</div>';
195         echo '<div class="clearer"></div>';
196     }
199     /**
200      * Display the assignment intro
201      *
202      * This will most likely be extended by assignment type plug-ins
203      * The default implementation prints the assignment description in a box
204      */
205     function view_intro() {
206         global $OUTPUT;
207         echo $OUTPUT->box_start('generalbox boxaligncenter', 'intro');
208         echo format_module_intro('assignment', $this->assignment, $this->cm->id);
209         echo $OUTPUT->box_end();
210         plagiarism_print_disclosure($this->cm->id);
211     }
213     /**
214      * Display the assignment dates
215      *
216      * Prints the assignment start and end dates in a box.
217      * This will be suitable for most assignment types
218      */
219     function view_dates() {
220         global $OUTPUT;
221         if (!$this->assignment->timeavailable && !$this->assignment->timedue) {
222             return;
223         }
225         echo $OUTPUT->box_start('generalbox boxaligncenter', 'dates');
226         echo '<table>';
227         if ($this->assignment->timeavailable) {
228             echo '<tr><td class="c0">'.get_string('availabledate','assignment').':</td>';
229             echo '    <td class="c1">'.userdate($this->assignment->timeavailable).'</td></tr>';
230         }
231         if ($this->assignment->timedue) {
232             echo '<tr><td class="c0">'.get_string('duedate','assignment').':</td>';
233             echo '    <td class="c1">'.userdate($this->assignment->timedue).'</td></tr>';
234         }
235         echo '</table>';
236         echo $OUTPUT->box_end();
237     }
240     /**
241      * Display the bottom and footer of a page
242      *
243      * This default method just prints the footer.
244      * This will be suitable for most assignment types
245      */
246     function view_footer() {
247         global $OUTPUT;
248         echo $OUTPUT->footer();
249     }
251     /**
252      * Display the feedback to the student
253      *
254      * This default method prints the teacher picture and name, date when marked,
255      * grade and teacher submissioncomment.
256      *
257      * @global object
258      * @global object
259      * @global object
260      * @param object $submission The submission object or NULL in which case it will be loaded
261      */
262     function view_feedback($submission=NULL) {
263         global $USER, $CFG, $DB, $OUTPUT;
264         require_once($CFG->libdir.'/gradelib.php');
266         if (!is_enrolled($this->context, $USER, 'mod/assignment:view')) {
267             // can not submit assignments -> no feedback
268             return;
269         }
271         if (!$submission) { /// Get submission for this assignment
272             $submission = $this->get_submission($USER->id);
273         }
274         // Check the user can submit
275         $cansubmit = has_capability('mod/assignment:submit', $this->context, $USER->id, false);
276         // If not then check if the user still has the view cap and has a previous submission
277         $cansubmit = $cansubmit || (!empty($submission) && has_capability('mod/assignment:view', $this->context, $USER->id, false));
279         if (!$cansubmit) {
280             // can not submit assignments -> no feedback
281             return;
282         }
284         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $USER->id);
285         $item = $grading_info->items[0];
286         $grade = $item->grades[$USER->id];
288         if ($grade->hidden or $grade->grade === false) { // hidden or error
289             return;
290         }
292         if ($grade->grade === null and empty($grade->str_feedback)) {   /// Nothing to show yet
293             return;
294         }
296         $graded_date = $grade->dategraded;
297         $graded_by   = $grade->usermodified;
299     /// We need the teacher info
300         if (!$teacher = $DB->get_record('user', array('id'=>$graded_by))) {
301             print_error('cannotfindteacher');
302         }
304     /// Print the feedback
305         echo $OUTPUT->heading(get_string('feedbackfromteacher', 'assignment', fullname($teacher)));
307         echo '<table cellspacing="0" class="feedback">';
309         echo '<tr>';
310         echo '<td class="left picture">';
311         if ($teacher) {
312             echo $OUTPUT->user_picture($teacher);
313         }
314         echo '</td>';
315         echo '<td class="topic">';
316         echo '<div class="from">';
317         if ($teacher) {
318             echo '<div class="fullname">'.fullname($teacher).'</div>';
319         }
320         echo '<div class="time">'.userdate($graded_date).'</div>';
321         echo '</div>';
322         echo '</td>';
323         echo '</tr>';
325         echo '<tr>';
326         echo '<td class="left side">&nbsp;</td>';
327         echo '<td class="content">';
328         echo '<div class="grade">';
329         echo get_string("grade").': '.$grade->str_long_grade;
330         echo '</div>';
331         echo '<div class="clearer"></div>';
333         echo '<div class="comment">';
334         echo $grade->str_feedback;
335         echo '</div>';
336         echo '</tr>';
338          if ($this->type == 'uploadsingle') { //@TODO: move to overload view_feedback method in the class or is uploadsingle merging into upload?
339             $responsefiles = $this->print_responsefiles($submission->userid, true);
340             if (!empty($responsefiles)) {
341                 echo '<tr>';
342                 echo '<td class="left side">&nbsp;</td>';
343                 echo '<td class="content">';
344                 echo $responsefiles;
345                 echo '</tr>';
346             }
347          }
349         echo '</table>';
350     }
352     /**
353      * Returns a link with info about the state of the assignment submissions
354      *
355      * This is used by view_header to put this link at the top right of the page.
356      * For teachers it gives the number of submitted assignments with a link
357      * For students it gives the time of their submission.
358      * This will be suitable for most assignment types.
359      *
360      * @global object
361      * @global object
362      * @param bool $allgroup print all groups info if user can access all groups, suitable for index.php
363      * @return string
364      */
365     function submittedlink($allgroups=false) {
366         global $USER;
367         global $CFG;
369         $submitted = '';
370         $urlbase = "{$CFG->wwwroot}/mod/assignment/";
372         $context = get_context_instance(CONTEXT_MODULE,$this->cm->id);
373         if (has_capability('mod/assignment:grade', $context)) {
374             if ($allgroups and has_capability('moodle/site:accessallgroups', $context)) {
375                 $group = 0;
376             } else {
377                 $group = groups_get_activity_group($this->cm);
378             }
379             if ($count = $this->count_real_submissions($group)) {
380                 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm->id.'">'.
381                              get_string('viewsubmissions', 'assignment', $count).'</a>';
382             } else {
383                 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm->id.'">'.
384                              get_string('noattempts', 'assignment').'</a>';
385             }
386         } else {
387             if (isloggedin()) {
388                 if ($submission = $this->get_submission($USER->id)) {
389                     if ($submission->timemodified) {
390                         if ($submission->timemodified <= $this->assignment->timedue || empty($this->assignment->timedue)) {
391                             $submitted = '<span class="early">'.userdate($submission->timemodified).'</span>';
392                         } else {
393                             $submitted = '<span class="late">'.userdate($submission->timemodified).'</span>';
394                         }
395                     }
396                 }
397             }
398         }
400         return $submitted;
401     }
404     /**
405      * @todo Document this function
406      */
407     function setup_elements(&$mform) {
409     }
411     /**
412      * Any preprocessing needed for the settings form for
413      * this assignment type
414      *
415      * @param array $default_values - array to fill in with the default values
416      *      in the form 'formelement' => 'value'
417      * @param object $form - the form that is to be displayed
418      * @return none
419      */
420     function form_data_preprocessing(&$default_values, $form) {
421     }
423     /**
424      * Any extra validation checks needed for the settings
425      * form for this assignment type
426      *
427      * See lib/formslib.php, 'validation' function for details
428      */
429     function form_validation($data, $files) {
430         return array();
431     }
433     /**
434      * Create a new assignment activity
435      *
436      * Given an object containing all the necessary data,
437      * (defined by the form in mod_form.php) this function
438      * will create a new instance and return the id number
439      * of the new instance.
440      * The due data is added to the calendar
441      * This is common to all assignment types.
442      *
443      * @global object
444      * @global object
445      * @param object $assignment The data from the form on mod_form.php
446      * @return int The id of the assignment
447      */
448     function add_instance($assignment) {
449         global $COURSE, $DB;
451         $assignment->timemodified = time();
452         $assignment->courseid = $assignment->course;
454         $returnid = $DB->insert_record("assignment", $assignment);
455         $assignment->id = $returnid;
457         if ($assignment->timedue) {
458             $event = new stdClass();
459             $event->name        = $assignment->name;
460             $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
461             $event->courseid    = $assignment->course;
462             $event->groupid     = 0;
463             $event->userid      = 0;
464             $event->modulename  = 'assignment';
465             $event->instance    = $returnid;
466             $event->eventtype   = 'due';
467             $event->timestart   = $assignment->timedue;
468             $event->timeduration = 0;
470             calendar_event::create($event);
471         }
473         assignment_grade_item_update($assignment);
475         return $returnid;
476     }
478     /**
479      * Deletes an assignment activity
480      *
481      * Deletes all database records, files and calendar events for this assignment.
482      *
483      * @global object
484      * @global object
485      * @param object $assignment The assignment to be deleted
486      * @return boolean False indicates error
487      */
488     function delete_instance($assignment) {
489         global $CFG, $DB;
491         $assignment->courseid = $assignment->course;
493         $result = true;
495         // now get rid of all files
496         $fs = get_file_storage();
497         if ($cm = get_coursemodule_from_instance('assignment', $assignment->id)) {
498             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
499             $fs->delete_area_files($context->id);
500         }
502         if (! $DB->delete_records('assignment_submissions', array('assignment'=>$assignment->id))) {
503             $result = false;
504         }
506         if (! $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
507             $result = false;
508         }
510         if (! $DB->delete_records('assignment', array('id'=>$assignment->id))) {
511             $result = false;
512         }
513         $mod = $DB->get_field('modules','id',array('name'=>'assignment'));
515         assignment_grade_item_delete($assignment);
517         return $result;
518     }
520     /**
521      * Updates a new assignment activity
522      *
523      * Given an object containing all the necessary data,
524      * (defined by the form in mod_form.php) this function
525      * will update the assignment instance and return the id number
526      * The due date is updated in the calendar
527      * This is common to all assignment types.
528      *
529      * @global object
530      * @global object
531      * @param object $assignment The data from the form on mod_form.php
532      * @return bool success
533      */
534     function update_instance($assignment) {
535         global $COURSE, $DB;
537         $assignment->timemodified = time();
539         $assignment->id = $assignment->instance;
540         $assignment->courseid = $assignment->course;
542         $DB->update_record('assignment', $assignment);
544         if ($assignment->timedue) {
545             $event = new stdClass();
547             if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
549                 $event->name        = $assignment->name;
550                 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
551                 $event->timestart   = $assignment->timedue;
553                 $calendarevent = calendar_event::load($event->id);
554                 $calendarevent->update($event);
555             } else {
556                 $event = new stdClass();
557                 $event->name        = $assignment->name;
558                 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
559                 $event->courseid    = $assignment->course;
560                 $event->groupid     = 0;
561                 $event->userid      = 0;
562                 $event->modulename  = 'assignment';
563                 $event->instance    = $assignment->id;
564                 $event->eventtype   = 'due';
565                 $event->timestart   = $assignment->timedue;
566                 $event->timeduration = 0;
568                 calendar_event::create($event);
569             }
570         } else {
571             $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id));
572         }
574         // get existing grade item
575         assignment_grade_item_update($assignment);
577         return true;
578     }
580     /**
581      * Update grade item for this submission.
582      */
583     function update_grade($submission) {
584         assignment_update_grades($this->assignment, $submission->userid);
585     }
587     /**
588      * Top-level function for handling of submissions called by submissions.php
589      *
590      * This is for handling the teacher interaction with the grading interface
591      * This should be suitable for most assignment types.
592      *
593      * @global object
594      * @param string $mode Specifies the kind of teacher interaction taking place
595      */
596     function submissions($mode) {
597         ///The main switch is changed to facilitate
598         ///1) Batch fast grading
599         ///2) Skip to the next one on the popup
600         ///3) Save and Skip to the next one on the popup
602         //make user global so we can use the id
603         global $USER, $OUTPUT, $DB, $PAGE;
605         $mailinfo = optional_param('mailinfo', null, PARAM_BOOL);
607         if (optional_param('next', null, PARAM_BOOL)) {
608             $mode='next';
609         }
610         if (optional_param('saveandnext', null, PARAM_BOOL)) {
611             $mode='saveandnext';
612         }
614         if (is_null($mailinfo)) {
615             if (optional_param('sesskey', null, PARAM_BOOL)) {
616                 set_user_preference('assignment_mailinfo', $mailinfo);
617             } else {
618                 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
619             }
620         } else {
621             set_user_preference('assignment_mailinfo', $mailinfo);
622         }
624         switch ($mode) {
625             case 'grade':                         // We are in a main window grading
626                 if ($submission = $this->process_feedback()) {
627                     $this->display_submissions(get_string('changessaved'));
628                 } else {
629                     $this->display_submissions();
630                 }
631                 break;
633             case 'single':                        // We are in a main window displaying one submission
634                 if ($submission = $this->process_feedback()) {
635                     $this->display_submissions(get_string('changessaved'));
636                 } else {
637                     $this->display_submission();
638                 }
639                 break;
641             case 'all':                          // Main window, display everything
642                 $this->display_submissions();
643                 break;
645             case 'fastgrade':
646                 ///do the fast grading stuff  - this process should work for all 3 subclasses
647                 $grading    = false;
648                 $commenting = false;
649                 $col        = false;
650                 if (isset($_POST['submissioncomment'])) {
651                     $col = 'submissioncomment';
652                     $commenting = true;
653                 }
654                 if (isset($_POST['menu'])) {
655                     $col = 'menu';
656                     $grading = true;
657                 }
658                 if (!$col) {
659                     //both submissioncomment and grade columns collapsed..
660                     $this->display_submissions();
661                     break;
662                 }
664                 foreach ($_POST[$col] as $id => $unusedvalue){
666                     $id = (int)$id; //clean parameter name
668                     $this->process_outcomes($id);
670                     if (!$submission = $this->get_submission($id)) {
671                         $submission = $this->prepare_new_submission($id);
672                         $newsubmission = true;
673                     } else {
674                         $newsubmission = false;
675                     }
676                     unset($submission->data1);  // Don't need to update this.
677                     unset($submission->data2);  // Don't need to update this.
679                     //for fast grade, we need to check if any changes take place
680                     $updatedb = false;
682                     if ($grading) {
683                         $grade = $_POST['menu'][$id];
684                         $updatedb = $updatedb || ($submission->grade != $grade);
685                         $submission->grade = $grade;
686                     } else {
687                         if (!$newsubmission) {
688                             unset($submission->grade);  // Don't need to update this.
689                         }
690                     }
691                     if ($commenting) {
692                         $commentvalue = trim($_POST['submissioncomment'][$id]);
693                         $updatedb = $updatedb || ($submission->submissioncomment != $commentvalue);
694                         $submission->submissioncomment = $commentvalue;
695                     } else {
696                         unset($submission->submissioncomment);  // Don't need to update this.
697                     }
699                     $submission->teacher    = $USER->id;
700                     if ($updatedb) {
701                         $submission->mailed = (int)(!$mailinfo);
702                     }
704                     $submission->timemarked = time();
706                     //if it is not an update, we don't change the last modified time etc.
707                     //this will also not write into database if no submissioncomment and grade is entered.
709                     if ($updatedb){
710                         if ($newsubmission) {
711                             if (!isset($submission->submissioncomment)) {
712                                 $submission->submissioncomment = '';
713                             }
714                             $sid = $DB->insert_record('assignment_submissions', $submission);
715                             $submission->id = $sid;
716                         } else {
717                             $DB->update_record('assignment_submissions', $submission);
718                         }
720                         // trigger grade event
721                         $this->update_grade($submission);
723                         //add to log only if updating
724                         add_to_log($this->course->id, 'assignment', 'update grades',
725                                    'submissions.php?id='.$this->assignment->id.'&user='.$submission->userid,
726                                    $submission->userid, $this->cm->id);
727                     }
729                 }
731                 $message = $OUTPUT->notification(get_string('changessaved'), 'notifysuccess');
733                 $this->display_submissions($message);
734                 break;
737             case 'saveandnext':
738                 ///We are in pop up. save the current one and go to the next one.
739                 //first we save the current changes
740                 if ($submission = $this->process_feedback()) {
741                     //print_heading(get_string('changessaved'));
742                     //$extra_javascript = $this->update_main_listing($submission);
743                 }
745             case 'next':
746                 /// We are currently in pop up, but we want to skip to next one without saving.
747                 ///    This turns out to be similar to a single case
748                 /// The URL used is for the next submission.
749                 $offset = required_param('offset', PARAM_INT);
750                 $nextid = required_param('nextid', PARAM_INT);
751                 $id = required_param('id', PARAM_INT);
752                 $offset = (int)$offset+1;
753                 //$this->display_submission($offset+1 , $nextid);
754                 redirect('submissions.php?id='.$id.'&userid='. $nextid . '&mode=single&offset='.$offset);
755                 break;
757             case 'singlenosave':
758                 $this->display_submission();
759                 break;
761             default:
762                 echo "something seriously is wrong!!";
763                 break;
764         }
765     }
767     /**
768      * Helper method updating the listing on the main script from popup using javascript
769      *
770      * @global object
771      * @global object
772      * @param $submission object The submission whose data is to be updated on the main page
773      */
774     function update_main_listing($submission) {
775         global $SESSION, $CFG, $OUTPUT;
777         $output = '';
779         $perpage = get_user_preferences('assignment_perpage', 10);
781         $quickgrade = get_user_preferences('assignment_quickgrade', 0);
783         /// Run some Javascript to try and update the parent page
784         $output .= '<script type="text/javascript">'."\n<!--\n";
785         if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['submissioncomment'])) {
786             if ($quickgrade){
787                 $output.= 'opener.document.getElementById("submissioncomment'.$submission->userid.'").value="'
788                 .trim($submission->submissioncomment).'";'."\n";
789              } else {
790                 $output.= 'opener.document.getElementById("com'.$submission->userid.
791                 '").innerHTML="'.shorten_text(trim(strip_tags($submission->submissioncomment)), 15)."\";\n";
792             }
793         }
795         if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['grade'])) {
796             //echo optional_param('menuindex');
797             if ($quickgrade){
798                 $output.= 'opener.document.getElementById("menumenu'.$submission->userid.
799                 '").selectedIndex="'.optional_param('menuindex', 0, PARAM_INT).'";'."\n";
800             } else {
801                 $output.= 'opener.document.getElementById("g'.$submission->userid.'").innerHTML="'.
802                 $this->display_grade($submission->grade)."\";\n";
803             }
804         }
805         //need to add student's assignments in there too.
806         if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['timemodified']) &&
807             $submission->timemodified) {
808             $output.= 'opener.document.getElementById("ts'.$submission->userid.
809                  '").innerHTML="'.addslashes_js($this->print_student_answer($submission->userid)).userdate($submission->timemodified)."\";\n";
810         }
812         if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['timemarked']) &&
813             $submission->timemarked) {
814             $output.= 'opener.document.getElementById("tt'.$submission->userid.
815                  '").innerHTML="'.userdate($submission->timemarked)."\";\n";
816         }
818         if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['status'])) {
819             $output.= 'opener.document.getElementById("up'.$submission->userid.'").className="s1";';
820             $buttontext = get_string('update');
821             $url = new moodle_url('/mod/assignment/submissions.php', array(
822                     'id' => $this->cm->id,
823                     'userid' => $submission->userid,
824                     'mode' => 'single',
825                     'offset' => (optional_param('offset', '', PARAM_INT)-1)));
826             $button = $OUTPUT->action_link($url, $buttontext, new popup_action('click', $url, 'grade'.$submission->userid, array('height' => 450, 'width' => 700)), array('ttile'=>$buttontext));
828             $output .= 'opener.document.getElementById("up'.$submission->userid.'").innerHTML="'.addslashes_js($button).'";';
829         }
831         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $submission->userid);
833         if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['finalgrade'])) {
834             $output.= 'opener.document.getElementById("finalgrade_'.$submission->userid.
835             '").innerHTML="'.$grading_info->items[0]->grades[$submission->userid]->str_grade.'";'."\n";
836         }
838         if (!empty($CFG->enableoutcomes) and empty($SESSION->flextable['mod-assignment-submissions']->collapse['outcome'])) {
840             if (!empty($grading_info->outcomes)) {
841                 foreach($grading_info->outcomes as $n=>$outcome) {
842                     if ($outcome->grades[$submission->userid]->locked) {
843                         continue;
844                     }
846                     if ($quickgrade){
847                         $output.= 'opener.document.getElementById("outcome_'.$n.'_'.$submission->userid.
848                         '").selectedIndex="'.$outcome->grades[$submission->userid]->grade.'";'."\n";
850                     } else {
851                         $options = make_grades_menu(-$outcome->scaleid);
852                         $options[0] = get_string('nooutcome', 'grades');
853                         $output.= 'opener.document.getElementById("outcome_'.$n.'_'.$submission->userid.'").innerHTML="'.$options[$outcome->grades[$submission->userid]->grade]."\";\n";
854                     }
856                 }
857             }
858         }
860         $output .= "\n-->\n</script>";
861         return $output;
862     }
864     /**
865      *  Return a grade in user-friendly form, whether it's a scale or not
866      *
867      * @global object
868      * @param mixed $grade
869      * @return string User-friendly representation of grade
870      */
871     function display_grade($grade) {
872         global $DB;
874         static $scalegrades = array();   // Cache scales for each assignment - they might have different scales!!
876         if ($this->assignment->grade >= 0) {    // Normal number
877             if ($grade == -1) {
878                 return '-';
879             } else {
880                 return $grade.' / '.$this->assignment->grade;
881             }
883         } else {                                // Scale
884             if (empty($scalegrades[$this->assignment->id])) {
885                 if ($scale = $DB->get_record('scale', array('id'=>-($this->assignment->grade)))) {
886                     $scalegrades[$this->assignment->id] = make_menu_from_list($scale->scale);
887                 } else {
888                     return '-';
889                 }
890             }
891             if (isset($scalegrades[$this->assignment->id][$grade])) {
892                 return $scalegrades[$this->assignment->id][$grade];
893             }
894             return '-';
895         }
896     }
898     /**
899      *  Display a single submission, ready for grading on a popup window
900      *
901      * This default method prints the teacher info and submissioncomment box at the top and
902      * the student info and submission at the bottom.
903      * This method also fetches the necessary data in order to be able to
904      * provide a "Next submission" button.
905      * Calls preprocess_submission() to give assignment type plug-ins a chance
906      * to process submissions before they are graded
907      * This method gets its arguments from the page parameters userid and offset
908      *
909      * @global object
910      * @global object
911      * @param string $extra_javascript
912      */
913     function display_submission($offset=-1,$userid =-1, $display=true) {
914         global $CFG, $DB, $PAGE, $OUTPUT;
915         require_once($CFG->libdir.'/gradelib.php');
916         require_once($CFG->libdir.'/tablelib.php');
917         require_once("$CFG->dirroot/repository/lib.php");
918         if ($userid==-1) {
919             $userid = required_param('userid', PARAM_INT);
920         }
921         if ($offset==-1) {
922             $offset = required_param('offset', PARAM_INT);//offset for where to start looking for student.
923         }
924         $filter = optional_param('filter', 0, PARAM_INT);
926         if (!$user = $DB->get_record('user', array('id'=>$userid))) {
927             print_error('nousers');
928         }
930         if (!$submission = $this->get_submission($user->id)) {
931             $submission = $this->prepare_new_submission($userid);
932         }
933         if ($submission->timemodified > $submission->timemarked) {
934             $subtype = 'assignmentnew';
935         } else {
936             $subtype = 'assignmentold';
937         }
939         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array($user->id));
940         $gradingdisabled = $grading_info->items[0]->grades[$userid]->locked || $grading_info->items[0]->grades[$userid]->overridden;
942     /// construct SQL, using current offset to find the data of the next student
943         $course     = $this->course;
944         $assignment = $this->assignment;
945         $cm         = $this->cm;
946         $context    = get_context_instance(CONTEXT_MODULE, $cm->id);
948         /// Get all ppl that can submit assignments
950         $currentgroup = groups_get_activity_group($cm);
951         $users = get_enrolled_users($context, 'mod/assignment:view', $currentgroup, 'u.id');
952         if ($users) {
953             $users = array_keys($users);
954             // if groupmembersonly used, remove users who are not in any group
955             if (!empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
956                 if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
957                     $users = array_intersect($users, array_keys($groupingusers));
958                 }
959             }
960         }
962         $nextid = 0;
963         $where = '';
964         if($filter == 'submitted') {
965             $where .= 's.timemodified > 0 AND ';
966         } else if($filter == 'requiregrading') {
967             $where .= 's.timemarked < s.timemodified AND ';
968         }
970         if ($users) {
971             $userfields = user_picture::fields('u', array('lastaccess'));
972             $select = "SELECT $userfields,
973                               s.id AS submissionid, s.grade, s.submissioncomment,
974                               s.timemodified, s.timemarked,
975                               COALESCE(SIGN(SIGN(s.timemarked) + SIGN(s.timemarked - s.timemodified)), 0) AS status ";
976             $sql = 'FROM {user} u '.
977                    'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
978                    AND s.assignment = '.$this->assignment->id.' '.
979                    'WHERE '.$where.'u.id IN ('.implode(',', $users).') ';
981             if ($sort = flexible_table::get_sort_for_table('mod-assignment-submissions')) {
982                 $sort = 'ORDER BY '.$sort.' ';
983             }
984             $auser = $DB->get_records_sql($select.$sql.$sort, null, $offset, 2);
986             if (is_array($auser) && count($auser)>1) {
987                 $nextuser = next($auser);
988             /// Calculate user status
989                 $nextuser->status = ($nextuser->timemarked > 0) && ($nextuser->timemarked >= $nextuser->timemodified);
990                 $nextid = $nextuser->id;
991             }
992         }
994         if ($submission->teacher) {
995             $teacher = $DB->get_record('user', array('id'=>$submission->teacher));
996         } else {
997             global $USER;
998             $teacher = $USER;
999         }
1001         $this->preprocess_submission($submission);
1003         $mformdata = new stdClass();
1004         $mformdata->context = $this->context;
1005         $mformdata->maxbytes = $this->course->maxbytes;
1006         $mformdata->courseid = $this->course->id;
1007         $mformdata->teacher = $teacher;
1008         $mformdata->assignment = $assignment;
1009         $mformdata->submission = $submission;
1010         $mformdata->lateness = $this->display_lateness($submission->timemodified);
1011         $mformdata->auser = $auser;
1012         $mformdata->user = $user;
1013         $mformdata->offset = $offset;
1014         $mformdata->userid = $userid;
1015         $mformdata->cm = $this->cm;
1016         $mformdata->grading_info = $grading_info;
1017         $mformdata->enableoutcomes = $CFG->enableoutcomes;
1018         $mformdata->grade = $this->assignment->grade;
1019         $mformdata->gradingdisabled = $gradingdisabled;
1020         $mformdata->nextid = $nextid;
1021         $mformdata->submissioncomment= $submission->submissioncomment;
1022         $mformdata->submissioncommentformat= FORMAT_HTML;
1023         $mformdata->submission_content= $this->print_user_files($user->id,true);
1024         $mformdata->filter = $filter;
1025          if ($assignment->assignmenttype == 'upload') {
1026             $mformdata->fileui_options = array('subdirs'=>1, 'maxbytes'=>$assignment->maxbytes, 'maxfiles'=>$assignment->var1, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL);
1027         } elseif ($assignment->assignmenttype == 'uploadsingle') {
1028             $mformdata->fileui_options = array('subdirs'=>0, 'maxbytes'=>$CFG->userquota, 'maxfiles'=>1, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL);
1029         }
1031         $submitform = new mod_assignment_grading_form( null, $mformdata );
1033          if (!$display) {
1034             $ret_data = new stdClass();
1035             $ret_data->mform = $submitform;
1036             $ret_data->fileui_options = $mformdata->fileui_options;
1037             return $ret_data;
1038         }
1040         if ($submitform->is_cancelled()) {
1041             redirect('submissions.php?id='.$this->cm->id);
1042         }
1044         $submitform->set_data($mformdata);
1046         $PAGE->set_title($this->course->fullname . ': ' .get_string('feedback', 'assignment').' - '.fullname($user, true));
1047         $PAGE->set_heading($this->course->fullname);
1048         $PAGE->navbar->add(get_string('submissions', 'assignment'), new moodle_url('/mod/assignment/submissions.php', array('id'=>$cm->id)));
1049         $PAGE->navbar->add(fullname($user, true));
1051         echo $OUTPUT->header();
1052         echo $OUTPUT->heading(get_string('feedback', 'assignment').': '.fullname($user, true));
1054         // display mform here...
1055         $submitform->display();
1057         $customfeedback = $this->custom_feedbackform($submission, true);
1058         if (!empty($customfeedback)) {
1059             echo $customfeedback;
1060         }
1062         echo $OUTPUT->footer();
1063     }
1065     /**
1066      *  Preprocess submission before grading
1067      *
1068      * Called by display_submission()
1069      * The default type does nothing here.
1070      *
1071      * @param object $submission The submission object
1072      */
1073     function preprocess_submission(&$submission) {
1074     }
1076     /**
1077      *  Display all the submissions ready for grading
1078      *
1079      * @global object
1080      * @global object
1081      * @global object
1082      * @global object
1083      * @param string $message
1084      * @return bool|void
1085      */
1086     function display_submissions($message='') {
1087         global $CFG, $DB, $USER, $DB, $OUTPUT, $PAGE;
1088         require_once($CFG->libdir.'/gradelib.php');
1090         /* first we check to see if the form has just been submitted
1091          * to request user_preference updates
1092          */
1094        $filters = array(self::FILTER_ALL             => get_string('all'),
1095                         self::FILTER_SUBMITTED       => get_string('submitted', 'assignment'),
1096                         self::FILTER_REQUIRE_GRADING => get_string('requiregrading', 'assignment'));
1098         $updatepref = optional_param('updatepref', 0, PARAM_INT);
1100         if (isset($_POST['updatepref'])){
1101             $perpage = optional_param('perpage', 10, PARAM_INT);
1102             $perpage = ($perpage <= 0) ? 10 : $perpage ;
1103             $filter = optional_param('filter', 0, PARAM_INT);
1104             set_user_preference('assignment_perpage', $perpage);
1105             set_user_preference('assignment_quickgrade', optional_param('quickgrade', 0, PARAM_BOOL));
1106             set_user_preference('assignment_filter', $filter);
1107         }
1109         /* next we get perpage and quickgrade (allow quick grade) params
1110          * from database
1111          */
1112         $perpage    = get_user_preferences('assignment_perpage', 10);
1113         $quickgrade = get_user_preferences('assignment_quickgrade', 0);
1114         $filter = get_user_preferences('assignment_filter', 0);
1115         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id);
1117         if (!empty($CFG->enableoutcomes) and !empty($grading_info->outcomes)) {
1118             $uses_outcomes = true;
1119         } else {
1120             $uses_outcomes = false;
1121         }
1123         $page    = optional_param('page', 0, PARAM_INT);
1124         $strsaveallfeedback = get_string('saveallfeedback', 'assignment');
1126     /// Some shortcuts to make the code read better
1128         $course     = $this->course;
1129         $assignment = $this->assignment;
1130         $cm         = $this->cm;
1132         $tabindex = 1; //tabindex for quick grading tabbing; Not working for dropdowns yet
1133         add_to_log($course->id, 'assignment', 'view submission', 'submissions.php?id='.$this->cm->id, $this->assignment->id, $this->cm->id);
1135         $PAGE->set_title(format_string($this->assignment->name,true));
1136         $PAGE->set_heading($this->course->fullname);
1137         echo $OUTPUT->header();
1139         echo '<div class="usersubmissions">';
1141         //hook to allow plagiarism plugins to update status/print links.
1142         plagiarism_update_status($this->course, $this->cm);
1144         /// Print quickgrade form around the table
1145         if ($quickgrade) {
1146             $formattrs = array();
1147             $formattrs['action'] = new moodle_url('/mod/assignment/submissions.php');
1148             $formattrs['id'] = 'fastg';
1149             $formattrs['method'] = 'post';
1151             echo html_writer::start_tag('form', $formattrs);
1152             echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'id',      'value'=> $this->cm->id));
1153             echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'mode',    'value'=> 'fastgrade'));
1154             echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'page',    'value'=> $page));
1155             echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=> sesskey()));
1156         }
1158         $course_context = get_context_instance(CONTEXT_COURSE, $course->id);
1159         if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
1160             echo '<div class="allcoursegrades"><a href="' . $CFG->wwwroot . '/grade/report/grader/index.php?id=' . $course->id . '">'
1161                 . get_string('seeallcoursegrades', 'grades') . '</a></div>';
1162         }
1164         if (!empty($message)) {
1165             echo $message;   // display messages here if any
1166         }
1168         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1170     /// Check to see if groups are being used in this assignment
1172         /// find out current groups mode
1173         $groupmode = groups_get_activity_groupmode($cm);
1174         $currentgroup = groups_get_activity_group($cm, true);
1175         groups_print_activity_menu($cm, $CFG->wwwroot . '/mod/assignment/submissions.php?id=' . $this->cm->id);
1177         /// Get all ppl that are allowed to submit assignments
1178         list($esql, $params) = get_enrolled_sql($context, 'mod/assignment:view', $currentgroup);
1180         if ($filter == self::FILTER_ALL) {
1181             $sql = "SELECT u.id FROM {user} u ".
1182                    "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1183                    "WHERE u.deleted = 0 AND eu.id=u.id ";
1184         } else {
1185             $wherefilter = '';
1186             if($filter == self::FILTER_SUBMITTED) {
1187                $wherefilter = ' AND s.timemodified > 0';
1188             } else if($filter == self::FILTER_REQUIRE_GRADING) {
1189                 $wherefilter = ' AND s.timemarked < s.timemodified ';
1190             }
1192             $sql = "SELECT u.id FROM {user} u ".
1193                    "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1194                    "LEFT JOIN {assignment_submissions} s ON (u.id = s.userid) " .
1195                    "WHERE u.deleted = 0 AND eu.id=u.id ".
1196                    'AND s.assignment = '. $this->assignment->id .
1197                     $wherefilter;
1198         }
1200         $users = $DB->get_records_sql($sql, $params);
1201         if (!empty($users)) {
1202             $users = array_keys($users);
1203         }
1205         // if groupmembersonly used, remove users who are not in any group
1206         if ($users and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
1207             if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
1208                 $users = array_intersect($users, array_keys($groupingusers));
1209             }
1210         }
1212         $tablecolumns = array('picture', 'fullname', 'grade', 'submissioncomment', 'timemodified', 'timemarked', 'status', 'finalgrade');
1213         if ($uses_outcomes) {
1214             $tablecolumns[] = 'outcome'; // no sorting based on outcomes column
1215         }
1217         $tableheaders = array('',
1218                               get_string('fullname'),
1219                               get_string('grade'),
1220                               get_string('comment', 'assignment'),
1221                               get_string('lastmodified').' ('.get_string('submission', 'assignment').')',
1222                               get_string('lastmodified').' ('.get_string('grade').')',
1223                               get_string('status'),
1224                               get_string('finalgrade', 'grades'));
1225         if ($uses_outcomes) {
1226             $tableheaders[] = get_string('outcome', 'grades');
1227         }
1229         require_once($CFG->libdir.'/tablelib.php');
1230         $table = new flexible_table('mod-assignment-submissions');
1232         $table->define_columns($tablecolumns);
1233         $table->define_headers($tableheaders);
1234         $table->define_baseurl($CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id.'&amp;currentgroup='.$currentgroup);
1236         $table->sortable(true, 'lastname');//sorted by lastname by default
1237         $table->collapsible(true);
1238         $table->initialbars(true);
1240         $table->column_suppress('picture');
1241         $table->column_suppress('fullname');
1243         $table->column_class('picture', 'picture');
1244         $table->column_class('fullname', 'fullname');
1245         $table->column_class('grade', 'grade');
1246         $table->column_class('submissioncomment', 'comment');
1247         $table->column_class('timemodified', 'timemodified');
1248         $table->column_class('timemarked', 'timemarked');
1249         $table->column_class('status', 'status');
1250         $table->column_class('finalgrade', 'finalgrade');
1251         if ($uses_outcomes) {
1252             $table->column_class('outcome', 'outcome');
1253         }
1255         $table->set_attribute('cellspacing', '0');
1256         $table->set_attribute('id', 'attempts');
1257         $table->set_attribute('class', 'submissions');
1258         $table->set_attribute('width', '100%');
1259         //$table->set_attribute('align', 'center');
1261         $table->no_sorting('finalgrade');
1262         $table->no_sorting('outcome');
1264         // Start working -- this is necessary as soon as the niceties are over
1265         $table->setup();
1267         if (empty($users)) {
1268             echo $OUTPUT->heading(get_string('nosubmitusers','assignment'));
1269             echo '</div>';
1270             return true;
1271         }
1272         if ($this->assignment->assignmenttype=='upload' || $this->assignment->assignmenttype=='online' || $this->assignment->assignmenttype=='uploadsingle') { //TODO: this is an ugly hack, where is the plugin spirit? (skodak)
1273             echo '<div style="text-align:right"><a href="submissions.php?id='.$this->cm->id.'&amp;download=zip">'.get_string('downloadall', 'assignment').'</a></div>';
1274         }
1275     /// Construct the SQL
1277         list($where, $params) = $table->get_sql_where();
1278         if ($where) {
1279             $where .= ' AND ';
1280         }
1282         if ($filter == self::FILTER_SUBMITTED) {
1283            $where .= 's.timemodified > 0 AND ';
1284         } else if($filter == self::FILTER_REQUIRE_GRADING) {
1285            $where .= 's.timemarked < s.timemodified AND ';
1286         }
1288         if ($sort = $table->get_sql_sort()) {
1289             $sort = ' ORDER BY '.$sort;
1290         }
1292         $ufields = user_picture::fields('u');
1294         $select = "SELECT $ufields,
1295                           s.id AS submissionid, s.grade, s.submissioncomment,
1296                           s.timemodified, s.timemarked,
1297                           COALESCE(SIGN(SIGN(s.timemarked) + SIGN(s.timemarked - s.timemodified)), 0) AS status ";
1298         $sql = 'FROM {user} u '.
1299                'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
1300                 AND s.assignment = '.$this->assignment->id.' '.
1301                'WHERE '.$where.'u.id IN ('.implode(',',$users).') ';
1303         $ausers = $DB->get_records_sql($select.$sql.$sort, $params, $table->get_page_start(), $table->get_page_size());
1305         $table->pagesize($perpage, count($users));
1307         ///offset used to calculate index of student in that particular query, needed for the pop up to know who's next
1308         $offset = $page * $perpage;
1309         $strupdate = get_string('update');
1310         $strgrade  = get_string('grade');
1311         $grademenu = make_grades_menu($this->assignment->grade);
1313         if ($ausers !== false) {
1314             $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array_keys($ausers));
1315             $endposition = $offset + $perpage;
1316             $currentposition = 0;
1317             foreach ($ausers as $auser) {
1318                 if ($currentposition == $offset && $offset < $endposition) {
1319                     $final_grade = $grading_info->items[0]->grades[$auser->id];
1320                     $grademax = $grading_info->items[0]->grademax;
1321                     $final_grade->formatted_grade = round($final_grade->grade,2) .' / ' . round($grademax,2);
1322                     $locked_overridden = 'locked';
1323                     if ($final_grade->overridden) {
1324                         $locked_overridden = 'overridden';
1325                     }
1327                 /// Calculate user status
1328                     $auser->status = ($auser->timemarked > 0) && ($auser->timemarked >= $auser->timemodified);
1329                     $picture = $OUTPUT->user_picture($auser);
1331                     if (empty($auser->submissionid)) {
1332                         $auser->grade = -1; //no submission yet
1333                     }
1335                     if (!empty($auser->submissionid)) {
1336                     ///Prints student answer and student modified date
1337                     ///attach file or print link to student answer, depending on the type of the assignment.
1338                     ///Refer to print_student_answer in inherited classes.
1339                         if ($auser->timemodified > 0) {
1340                             $studentmodified = '<div id="ts'.$auser->id.'">'.$this->print_student_answer($auser->id)
1341                                              . userdate($auser->timemodified).'</div>';
1342                         } else {
1343                             $studentmodified = '<div id="ts'.$auser->id.'">&nbsp;</div>';
1344                         }
1345                     ///Print grade, dropdown or text
1346                         if ($auser->timemarked > 0) {
1347                             $teachermodified = '<div id="tt'.$auser->id.'">'.userdate($auser->timemarked).'</div>';
1349                             if ($final_grade->locked or $final_grade->overridden) {
1350                                 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1351                             } else if ($quickgrade) {
1352                                 $attributes = array();
1353                                 $attributes['tabindex'] = $tabindex++;
1354                                 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1355                                 $grade = '<div id="g'.$auser->id.'">'. $menu .'</div>';
1356                             } else {
1357                                 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1358                             }
1360                         } else {
1361                             $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
1362                             if ($final_grade->locked or $final_grade->overridden) {
1363                                 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1364                             } else if ($quickgrade) {
1365                                 $attributes = array();
1366                                 $attributes['tabindex'] = $tabindex++;
1367                                 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1368                                 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1369                             } else {
1370                                 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1371                             }
1372                         }
1373                     ///Print Comment
1374                         if ($final_grade->locked or $final_grade->overridden) {
1375                             $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($final_grade->str_feedback),15).'</div>';
1377                         } else if ($quickgrade) {
1378                             $comment = '<div id="com'.$auser->id.'">'
1379                                      . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1380                                      . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1381                         } else {
1382                             $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($auser->submissioncomment),15).'</div>';
1383                         }
1384                     } else {
1385                         $studentmodified = '<div id="ts'.$auser->id.'">&nbsp;</div>';
1386                         $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
1387                         $status          = '<div id="st'.$auser->id.'">&nbsp;</div>';
1389                         if ($final_grade->locked or $final_grade->overridden) {
1390                             $grade = '<div id="g'.$auser->id.'">'.$final_grade->formatted_grade . '</div>';
1391                         } else if ($quickgrade) {   // allow editing
1392                             $attributes = array();
1393                             $attributes['tabindex'] = $tabindex++;
1394                             $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1395                             $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1396                         } else {
1397                             $grade = '<div id="g'.$auser->id.'">-</div>';
1398                         }
1400                         if ($final_grade->locked or $final_grade->overridden) {
1401                             $comment = '<div id="com'.$auser->id.'">'.$final_grade->str_feedback.'</div>';
1402                         } else if ($quickgrade) {
1403                             $comment = '<div id="com'.$auser->id.'">'
1404                                      . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1405                                      . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1406                         } else {
1407                             $comment = '<div id="com'.$auser->id.'">&nbsp;</div>';
1408                         }
1409                     }
1411                     if (empty($auser->status)) { /// Confirm we have exclusively 0 or 1
1412                         $auser->status = 0;
1413                     } else {
1414                         $auser->status = 1;
1415                     }
1417                     $buttontext = ($auser->status == 1) ? $strupdate : $strgrade;
1419                     ///No more buttons, we use popups ;-).
1420                     $popup_url = '/mod/assignment/submissions.php?id='.$this->cm->id
1421                                . '&amp;userid='.$auser->id.'&amp;mode=single'.'&amp;filter='.$filter.'&amp;offset='.$offset++;
1423                     $button = $OUTPUT->action_link($popup_url, $buttontext);
1425                     $status  = '<div id="up'.$auser->id.'" class="s'.$auser->status.'">'.$button.'</div>';
1427                     $finalgrade = '<span id="finalgrade_'.$auser->id.'">'.$final_grade->str_grade.'</span>';
1429                     $outcomes = '';
1431                     if ($uses_outcomes) {
1433                         foreach($grading_info->outcomes as $n=>$outcome) {
1434                             $outcomes .= '<div class="outcome"><label>'.$outcome->name.'</label>';
1435                             $options = make_grades_menu(-$outcome->scaleid);
1437                             if ($outcome->grades[$auser->id]->locked or !$quickgrade) {
1438                                 $options[0] = get_string('nooutcome', 'grades');
1439                                 $outcomes .= ': <span id="outcome_'.$n.'_'.$auser->id.'">'.$options[$outcome->grades[$auser->id]->grade].'</span>';
1440                             } else {
1441                                 $attributes = array();
1442                                 $attributes['tabindex'] = $tabindex++;
1443                                 $attributes['id'] = 'outcome_'.$n.'_'.$auser->id;
1444                                 $outcomes .= ' '.html_writer::select($options, 'outcome_'.$n.'['.$auser->id.']', $outcome->grades[$auser->id]->grade, array(0=>get_string('nooutcome', 'grades')), $attributes);
1445                             }
1446                             $outcomes .= '</div>';
1447                         }
1448                     }
1450                     $userlink = '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $auser->id . '&amp;course=' . $course->id . '">' . fullname($auser, has_capability('moodle/site:viewfullnames', $this->context)) . '</a>';
1451                     $row = array($picture, $userlink, $grade, $comment, $studentmodified, $teachermodified, $status, $finalgrade);
1452                     if ($uses_outcomes) {
1453                         $row[] = $outcomes;
1454                     }
1456                     $table->add_data($row);
1457                 }
1458                 $currentposition++;
1459             }
1460         }
1462         $table->print_html();  /// Print the whole table
1464         /// Print quickgrade form around the table
1465         if ($quickgrade && $table->started_output){
1466             $mailinfopref = false;
1467             if (get_user_preferences('assignment_mailinfo', 1)) {
1468                 $mailinfopref = true;
1469             }
1470             $emailnotification =  html_writer::checkbox('mailinfo', 1, $mailinfopref, get_string('enableemailnotification','assignment'));
1472             $emailnotification .= $OUTPUT->help_icon('enableemailnotification', 'assignment');
1473             echo html_writer::tag('div', $emailnotification, array('class'=>'emailnotification'));
1475             $savefeedback = html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'fastg', 'value'=>get_string('saveallfeedback', 'assignment')));
1476             echo html_writer::tag('div', $savefeedback, array('class'=>'fastgbutton'));
1478             echo html_writer::end_tag('form');
1479         } else if ($quickgrade) {
1480             echo html_writer::end_tag('form');
1481         }
1483         echo '</div>';
1484         /// End of fast grading form
1486         /// Mini form for setting user preference
1488         $formaction = new moodle_url('/mod/assignment/submissions.php', array('id'=>$this->cm->id));
1489         $mform = new MoodleQuickForm('optionspref', 'post', $formaction, '', array('class'=>'optionspref'));
1491         $mform->addElement('hidden', 'updatepref');
1492         $mform->setDefault('updatepref', 1);
1493         $mform->addElement('header', 'qgprefs', get_string('optionalsettings', 'assignment'));
1494         $mform->addElement('select', 'filter', get_string('show'),  $filters);
1496         $mform->setDefault('filter', $filter);
1498         $mform->addElement('text', 'perpage', get_string('pagesize', 'assignment'), array('size'=>1));
1499         $mform->setDefault('perpage', $perpage);
1501         $mform->addElement('checkbox', 'quickgrade', get_string('quickgrade','assignment'));
1502         $mform->setDefault('quickgrade', $quickgrade);
1503         $mform->addHelpButton('quickgrade', 'quickgrade', 'assignment');
1505         $mform->addElement('submit', 'savepreferences', get_string('savepreferences'));
1507         $mform->display();
1509         echo $OUTPUT->footer();
1510     }
1512     /**
1513      *  Process teacher feedback submission
1514      *
1515      * This is called by submissions() when a grading even has taken place.
1516      * It gets its data from the submitted form.
1517      *
1518      * @global object
1519      * @global object
1520      * @global object
1521      * @return object|bool The updated submission object or false
1522      */
1523     function process_feedback($formdata=null) {
1524         global $CFG, $USER, $DB;
1525         require_once($CFG->libdir.'/gradelib.php');
1527         if (!$feedback = data_submitted() or !confirm_sesskey()) {      // No incoming data?
1528             return false;
1529         }
1531         ///For save and next, we need to know the userid to save, and the userid to go
1532         ///We use a new hidden field in the form, and set it to -1. If it's set, we use this
1533         ///as the userid to store
1534         if ((int)$feedback->saveuserid !== -1){
1535             $feedback->userid = $feedback->saveuserid;
1536         }
1538         if (!empty($feedback->cancel)) {          // User hit cancel button
1539             return false;
1540         }
1542         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $feedback->userid);
1544         // store outcomes if needed
1545         $this->process_outcomes($feedback->userid);
1547         $submission = $this->get_submission($feedback->userid, true);  // Get or make one
1549         if (!($grading_info->items[0]->grades[$feedback->userid]->locked ||
1550             $grading_info->items[0]->grades[$feedback->userid]->overridden) ) {
1552             $submission->grade      = $feedback->xgrade;
1553             $submission->submissioncomment    = $feedback->submissioncomment_editor['text'];
1554             $submission->teacher    = $USER->id;
1555             $mailinfo = get_user_preferences('assignment_mailinfo', 0);
1556             if (!$mailinfo) {
1557                 $submission->mailed = 1;       // treat as already mailed
1558             } else {
1559                 $submission->mailed = 0;       // Make sure mail goes out (again, even)
1560             }
1561             $submission->timemarked = time();
1563             unset($submission->data1);  // Don't need to update this.
1564             unset($submission->data2);  // Don't need to update this.
1566             if (empty($submission->timemodified)) {   // eg for offline assignments
1567                 // $submission->timemodified = time();
1568             }
1570             $DB->update_record('assignment_submissions', $submission);
1572             // triger grade event
1573             $this->update_grade($submission);
1575             add_to_log($this->course->id, 'assignment', 'update grades',
1576                        'submissions.php?id='.$this->assignment->id.'&user='.$feedback->userid, $feedback->userid, $this->cm->id);
1577              if (!is_null($formdata)) {
1578                     if ($this->type == 'upload' || $this->type == 'uploadsingle') {
1579                         $mformdata = $formdata->mform->get_data();
1580                         $mformdata = file_postupdate_standard_filemanager($mformdata, 'files', $formdata->fileui_options, $this->context, 'mod_assignment', 'response', $submission->id);
1581                     }
1582              }
1583         }
1585         return $submission;
1587     }
1589     function process_outcomes($userid) {
1590         global $CFG, $USER;
1592         if (empty($CFG->enableoutcomes)) {
1593             return;
1594         }
1596         require_once($CFG->libdir.'/gradelib.php');
1598         if (!$formdata = data_submitted() or !confirm_sesskey()) {
1599             return;
1600         }
1602         $data = array();
1603         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid);
1605         if (!empty($grading_info->outcomes)) {
1606             foreach($grading_info->outcomes as $n=>$old) {
1607                 $name = 'outcome_'.$n;
1608                 if (isset($formdata->{$name}[$userid]) and $old->grades[$userid]->grade != $formdata->{$name}[$userid]) {
1609                     $data[$n] = $formdata->{$name}[$userid];
1610                 }
1611             }
1612         }
1613         if (count($data) > 0) {
1614             grade_update_outcomes('mod/assignment', $this->course->id, 'mod', 'assignment', $this->assignment->id, $userid, $data);
1615         }
1617     }
1619     /**
1620      * Load the submission object for a particular user
1621      *
1622      * @global object
1623      * @global object
1624      * @param $userid int The id of the user whose submission we want or 0 in which case USER->id is used
1625      * @param $createnew boolean optional Defaults to false. If set to true a new submission object will be created in the database
1626      * @param bool $teachermodified student submission set if false
1627      * @return object The submission
1628      */
1629     function get_submission($userid=0, $createnew=false, $teachermodified=false) {
1630         global $USER, $DB;
1632         if (empty($userid)) {
1633             $userid = $USER->id;
1634         }
1636         $submission = $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
1638         if ($submission || !$createnew) {
1639             return $submission;
1640         }
1641         $newsubmission = $this->prepare_new_submission($userid, $teachermodified);
1642         $DB->insert_record("assignment_submissions", $newsubmission);
1644         return $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
1645     }
1647     /**
1648      * Instantiates a new submission object for a given user
1649      *
1650      * Sets the assignment, userid and times, everything else is set to default values.
1651      *
1652      * @param int $userid The userid for which we want a submission object
1653      * @param bool $teachermodified student submission set if false
1654      * @return object The submission
1655      */
1656     function prepare_new_submission($userid, $teachermodified=false) {
1657         $submission = new stdClass();
1658         $submission->assignment   = $this->assignment->id;
1659         $submission->userid       = $userid;
1660         $submission->timecreated = time();
1661         // teachers should not be modifying modified date, except offline assignments
1662         if ($teachermodified) {
1663             $submission->timemodified = 0;
1664         } else {
1665             $submission->timemodified = $submission->timecreated;
1666         }
1667         $submission->numfiles     = 0;
1668         $submission->data1        = '';
1669         $submission->data2        = '';
1670         $submission->grade        = -1;
1671         $submission->submissioncomment      = '';
1672         $submission->format       = 0;
1673         $submission->teacher      = 0;
1674         $submission->timemarked   = 0;
1675         $submission->mailed       = 0;
1676         return $submission;
1677     }
1679     /**
1680      * Return all assignment submissions by ENROLLED students (even empty)
1681      *
1682      * @param string $sort optional field names for the ORDER BY in the sql query
1683      * @param string $dir optional specifying the sort direction, defaults to DESC
1684      * @return array The submission objects indexed by id
1685      */
1686     function get_submissions($sort='', $dir='DESC') {
1687         return assignment_get_all_submissions($this->assignment, $sort, $dir);
1688     }
1690     /**
1691      * Counts all real assignment submissions by ENROLLED students (not empty ones)
1692      *
1693      * @param int $groupid optional If nonzero then count is restricted to this group
1694      * @return int The number of submissions
1695      */
1696     function count_real_submissions($groupid=0) {
1697         return assignment_count_real_submissions($this->cm, $groupid);
1698     }
1700     /**
1701      * Alerts teachers by email of new or changed assignments that need grading
1702      *
1703      * First checks whether the option to email teachers is set for this assignment.
1704      * Sends an email to ALL teachers in the course (or in the group if using separate groups).
1705      * Uses the methods email_teachers_text() and email_teachers_html() to construct the content.
1706      *
1707      * @global object
1708      * @global object
1709      * @param $submission object The submission that has changed
1710      * @return void
1711      */
1712     function email_teachers($submission) {
1713         global $CFG, $DB;
1715         if (empty($this->assignment->emailteachers)) {          // No need to do anything
1716             return;
1717         }
1719         $user = $DB->get_record('user', array('id'=>$submission->userid));
1721         if ($teachers = $this->get_graders($user)) {
1723             $strassignments = get_string('modulenameplural', 'assignment');
1724             $strassignment  = get_string('modulename', 'assignment');
1725             $strsubmitted  = get_string('submitted', 'assignment');
1727             foreach ($teachers as $teacher) {
1728                 $info = new stdClass();
1729                 $info->username = fullname($user, true);
1730                 $info->assignment = format_string($this->assignment->name,true);
1731                 $info->url = $CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id;
1733                 $postsubject = $strsubmitted.': '.$info->username.' -> '.$this->assignment->name;
1734                 $posttext = $this->email_teachers_text($info);
1735                 $posthtml = ($teacher->mailformat == 1) ? $this->email_teachers_html($info) : '';
1737                 $eventdata = new stdClass();
1738                 $eventdata->modulename       = 'assignment';
1739                 $eventdata->userfrom         = $user;
1740                 $eventdata->userto           = $teacher;
1741                 $eventdata->subject          = $postsubject;
1742                 $eventdata->fullmessage      = $posttext;
1743                 $eventdata->fullmessageformat = FORMAT_PLAIN;
1744                 $eventdata->fullmessagehtml  = $posthtml;
1745                 $eventdata->smallmessage     = '';
1746                 message_send($eventdata);
1747             }
1748         }
1749     }
1751     /**
1752      * @param string $filearea
1753      * @param array $args
1754      * @return bool
1755      */
1756     function send_file($filearea, $args) {
1757         debugging('plugin does not implement file sending', DEBUG_DEVELOPER);
1758         return false;
1759     }
1761     /**
1762      * Returns a list of teachers that should be grading given submission
1763      *
1764      * @param object $user
1765      * @return array
1766      */
1767     function get_graders($user) {
1768         //potential graders
1769         $potgraders = get_users_by_capability($this->context, 'mod/assignment:grade', '', '', '', '', '', '', false, false);
1771         $graders = array();
1772         if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) {   // Separate groups are being used
1773             if ($groups = groups_get_all_groups($this->course->id, $user->id)) {  // Try to find all groups
1774                 foreach ($groups as $group) {
1775                     foreach ($potgraders as $t) {
1776                         if ($t->id == $user->id) {
1777                             continue; // do not send self
1778                         }
1779                         if (groups_is_member($group->id, $t->id)) {
1780                             $graders[$t->id] = $t;
1781                         }
1782                     }
1783                 }
1784             } else {
1785                 // user not in group, try to find graders without group
1786                 foreach ($potgraders as $t) {
1787                     if ($t->id == $user->id) {
1788                         continue; // do not send self
1789                     }
1790                     if (!groups_get_all_groups($this->course->id, $t->id)) { //ugly hack
1791                         $graders[$t->id] = $t;
1792                     }
1793                 }
1794             }
1795         } else {
1796             foreach ($potgraders as $t) {
1797                 if ($t->id == $user->id) {
1798                     continue; // do not send self
1799                 }
1800                 $graders[$t->id] = $t;
1801             }
1802         }
1803         return $graders;
1804     }
1806     /**
1807      * Creates the text content for emails to teachers
1808      *
1809      * @param $info object The info used by the 'emailteachermail' language string
1810      * @return string
1811      */
1812     function email_teachers_text($info) {
1813         $posttext  = format_string($this->course->shortname).' -> '.$this->strassignments.' -> '.
1814                      format_string($this->assignment->name)."\n";
1815         $posttext .= '---------------------------------------------------------------------'."\n";
1816         $posttext .= get_string("emailteachermail", "assignment", $info)."\n";
1817         $posttext .= "\n---------------------------------------------------------------------\n";
1818         return $posttext;
1819     }
1821      /**
1822      * Creates the html content for emails to teachers
1823      *
1824      * @param $info object The info used by the 'emailteachermailhtml' language string
1825      * @return string
1826      */
1827     function email_teachers_html($info) {
1828         global $CFG;
1829         $posthtml  = '<p><font face="sans-serif">'.
1830                      '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$this->course->id.'">'.format_string($this->course->shortname).'</a> ->'.
1831                      '<a href="'.$CFG->wwwroot.'/mod/assignment/index.php?id='.$this->course->id.'">'.$this->strassignments.'</a> ->'.
1832                      '<a href="'.$CFG->wwwroot.'/mod/assignment/view.php?id='.$this->cm->id.'">'.format_string($this->assignment->name).'</a></font></p>';
1833         $posthtml .= '<hr /><font face="sans-serif">';
1834         $posthtml .= '<p>'.get_string('emailteachermailhtml', 'assignment', $info).'</p>';
1835         $posthtml .= '</font><hr />';
1836         return $posthtml;
1837     }
1839     /**
1840      * Produces a list of links to the files uploaded by a user
1841      *
1842      * @param $userid int optional id of the user. If 0 then $USER->id is used.
1843      * @param $return boolean optional defaults to false. If true the list is returned rather than printed
1844      * @return string optional
1845      */
1846     function print_user_files($userid=0, $return=false) {
1847         global $CFG, $USER, $OUTPUT;
1849         if (!$userid) {
1850             if (!isloggedin()) {
1851                 return '';
1852             }
1853             $userid = $USER->id;
1854         }
1856         $output = '';
1858         $fs = get_file_storage();
1860         $found = false;
1862         $submission = $this->get_submission($userid);
1864         if (($submission) && $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
1865             require_once($CFG->libdir.'/portfoliolib.php');
1866             require_once($CFG->dirroot . '/mod/assignment/locallib.php');
1867             $button = new portfolio_add_button();
1868             foreach ($files as $file) {
1869                 $filename = $file->get_filename();
1870                 $found = true;
1871                 $mimetype = $file->get_mimetype();
1872                 $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$this->context->id.'/mod_assignment/submission/'.$submission->id.'/'.$filename);
1873                 $output .= '<a href="'.$path.'" ><img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />'.s($filename).'</a>';
1874                 if ($this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
1875                     $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'fileid' => $file->get_id()), '/mod/assignment/locallib.php');
1876                     $button->set_format_by_file($file);
1877                     $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1878                 }
1879                 $output .= plagiarism_get_links(array('userid'=>$userid, 'file'=>$file, 'cmid'=>$this->cm->id, 'course'=>$this->course, 'assignment'=>$this->assignment));
1880                 $output .= '<br />';
1881             }
1882             if (count($files) > 1  && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
1883                 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id), '/mod/assignment/locallib.php');
1884                 $output .= '<br />'  . $button->to_html();
1885             }
1886         }
1888         $output = '<div class="files">'.$output.'</div>';
1890         if ($return) {
1891             return $output;
1892         }
1893         echo $output;
1894     }
1896     /**
1897      * Count the files uploaded by a given user
1898      *
1899      * @param $itemid int The submission's id as the file's itemid.
1900      * @return int
1901      */
1902     function count_user_files($itemid) {
1903         $fs = get_file_storage();
1904         $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $itemid, "id", false);
1905         return count($files);
1906     }
1908     /**
1909      * Returns true if the student is allowed to submit
1910      *
1911      * Checks that the assignment has started and, if the option to prevent late
1912      * submissions is set, also checks that the assignment has not yet closed.
1913      * @return boolean
1914      */
1915     function isopen() {
1916         $time = time();
1917         if ($this->assignment->preventlate && $this->assignment->timedue) {
1918             return ($this->assignment->timeavailable <= $time && $time <= $this->assignment->timedue);
1919         } else {
1920             return ($this->assignment->timeavailable <= $time);
1921         }
1922     }
1925     /**
1926      * Return true if is set description is hidden till available date
1927      *
1928      * This is needed by calendar so that hidden descriptions do not
1929      * come up in upcoming events.
1930      *
1931      * Check that description is hidden till available date
1932      * By default return false
1933      * Assignments types should implement this method if needed
1934      * @return boolen
1935      */
1936     function description_is_hidden() {
1937         return false;
1938     }
1940     /**
1941      * Return an outline of the user's interaction with the assignment
1942      *
1943      * The default method prints the grade and timemodified
1944      * @param $grade object
1945      * @return object with properties ->info and ->time
1946      */
1947     function user_outline($grade) {
1949         $result = new stdClass();
1950         $result->info = get_string('grade').': '.$grade->str_long_grade;
1951         $result->time = $grade->dategraded;
1952         return $result;
1953     }
1955     /**
1956      * Print complete information about the user's interaction with the assignment
1957      *
1958      * @param $user object
1959      */
1960     function user_complete($user, $grade=null) {
1961         global $OUTPUT;
1962         if ($grade) {
1963             echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1964             if ($grade->str_feedback) {
1965                 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1966             }
1967         }
1969         if ($submission = $this->get_submission($user->id)) {
1971             $fs = get_file_storage();
1973             if ($files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
1974                 $countfiles = count($files)." ".get_string("uploadedfiles", "assignment");
1975                 foreach ($files as $file) {
1976                     $countfiles .= "; ".$file->get_filename();
1977                 }
1978             }
1980             echo $OUTPUT->box_start();
1981             echo get_string("lastmodified").": ";
1982             echo userdate($submission->timemodified);
1983             echo $this->display_lateness($submission->timemodified);
1985             $this->print_user_files($user->id);
1987             echo '<br />';
1989             $this->view_feedback($submission);
1991             echo $OUTPUT->box_end();
1993         } else {
1994             print_string("notsubmittedyet", "assignment");
1995         }
1996     }
1998     /**
1999      * Return a string indicating how late a submission is
2000      *
2001      * @param $timesubmitted int
2002      * @return string
2003      */
2004     function display_lateness($timesubmitted) {
2005         return assignment_display_lateness($timesubmitted, $this->assignment->timedue);
2006     }
2008     /**
2009      * Empty method stub for all delete actions.
2010      */
2011     function delete() {
2012         //nothing by default
2013         redirect('view.php?id='.$this->cm->id);
2014     }
2016     /**
2017      * Empty custom feedback grading form.
2018      */
2019     function custom_feedbackform($submission, $return=false) {
2020         //nothing by default
2021         return '';
2022     }
2024     /**
2025      * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
2026      * for the course (see resource).
2027      *
2028      * Given a course_module object, this function returns any "extra" information that may be needed
2029      * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
2030      *
2031      * @param $coursemodule object The coursemodule object (record).
2032      * @return object An object on information that the courses will know about (most noticeably, an icon).
2033      *
2034      */
2035     function get_coursemodule_info($coursemodule) {
2036         return false;
2037     }
2039     /**
2040      * Plugin cron method - do not use $this here, create new assignment instances if needed.
2041      * @return void
2042      */
2043     function cron() {
2044         //no plugin cron by default - override if needed
2045     }
2047     /**
2048      * Reset all submissions
2049      */
2050     function reset_userdata($data) {
2051         global $CFG, $DB;
2053         if (!$DB->count_records('assignment', array('course'=>$data->courseid, 'assignmenttype'=>$this->type))) {
2054             return array(); // no assignments of this type present
2055         }
2057         $componentstr = get_string('modulenameplural', 'assignment');
2058         $status = array();
2060         $typestr = get_string('type'.$this->type, 'assignment');
2061         // ugly hack to support pluggable assignment type titles...
2062         if($typestr === '[[type'.$this->type.']]'){
2063             $typestr = get_string('type'.$this->type, 'assignment_'.$this->type);
2064         }
2066         if (!empty($data->reset_assignment_submissions)) {
2067             $assignmentssql = "SELECT a.id
2068                                  FROM {assignment} a
2069                                 WHERE a.course=? AND a.assignmenttype=?";
2070             $params = array($data->courseid, $this->type);
2072             // now get rid of all submissions and responses
2073             $fs = get_file_storage();
2074             if ($assignments = $DB->get_records_sql($assignmentssql, $params)) {
2075                 foreach ($assignments as $assignmentid=>$unused) {
2076                     if (!$cm = get_coursemodule_from_instance('assignment', $assignmentid)) {
2077                         continue;
2078                     }
2079                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2080                     $fs->delete_area_files($context->id, 'mod_assignment', 'submission');
2081                     $fs->delete_area_files($context->id, 'mod_assignment', 'response');
2082                 }
2083             }
2085             $DB->delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)", $params);
2087             $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false);
2089             if (empty($data->reset_gradebook_grades)) {
2090                 // remove all grades from gradebook
2091                 assignment_reset_gradebook($data->courseid, $this->type);
2092             }
2093         }
2095         /// updating dates - shift may be negative too
2096         if ($data->timeshift) {
2097             shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift, $data->courseid);
2098             $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false);
2099         }
2101         return $status;
2102     }
2105     function portfolio_exportable() {
2106         return false;
2107     }
2109     /**
2110      * base implementation for backing up subtype specific information
2111      * for one single module
2112      *
2113      * @param filehandle $bf file handle for xml file to write to
2114      * @param mixed $preferences the complete backup preference object
2115      *
2116      * @return boolean
2117      *
2118      * @static
2119      */
2120     static function backup_one_mod($bf, $preferences, $assignment) {
2121         return true;
2122     }
2124     /**
2125      * base implementation for backing up subtype specific information
2126      * for one single submission
2127      *
2128      * @param filehandle $bf file handle for xml file to write to
2129      * @param mixed $preferences the complete backup preference object
2130      * @param object $submission the assignment submission db record
2131      *
2132      * @return boolean
2133      *
2134      * @static
2135      */
2136     static function backup_one_submission($bf, $preferences, $assignment, $submission) {
2137         return true;
2138     }
2140     /**
2141      * base implementation for restoring subtype specific information
2142      * for one single module
2143      *
2144      * @param array  $info the array representing the xml
2145      * @param object $restore the restore preferences
2146      *
2147      * @return boolean
2148      *
2149      * @static
2150      */
2151     static function restore_one_mod($info, $restore, $assignment) {
2152         return true;
2153     }
2155     /**
2156      * base implementation for restoring subtype specific information
2157      * for one single submission
2158      *
2159      * @param object $submission the newly created submission
2160      * @param array  $info the array representing the xml
2161      * @param object $restore the restore preferences
2162      *
2163      * @return boolean
2164      *
2165      * @static
2166      */
2167     static function restore_one_submission($info, $restore, $assignment, $submission) {
2168         return true;
2169     }
2171 } ////// End of the assignment_base class
2174 class mod_assignment_grading_form extends moodleform {
2176     function definition() {
2177         global $OUTPUT;
2178         $mform =& $this->_form;
2180         $formattr = $mform->getAttributes();
2181         $formattr['id'] = 'submitform';
2182         $mform->setAttributes($formattr);
2183         // hidden params
2184         $mform->addElement('hidden', 'offset', ($this->_customdata->offset+1));
2185         $mform->setType('offset', PARAM_INT);
2186         $mform->addElement('hidden', 'userid', $this->_customdata->userid);
2187         $mform->setType('userid', PARAM_INT);
2188         $mform->addElement('hidden', 'nextid', $this->_customdata->nextid);
2189         $mform->setType('nextid', PARAM_INT);
2190         $mform->addElement('hidden', 'id', $this->_customdata->cm->id);
2191         $mform->setType('id', PARAM_INT);
2192         $mform->addElement('hidden', 'sesskey', sesskey());
2193         $mform->setType('sesskey', PARAM_ALPHANUM);
2194         $mform->addElement('hidden', 'mode', 'grade');
2195         $mform->setType('mode', PARAM_TEXT);
2196         $mform->addElement('hidden', 'menuindex', "0");
2197         $mform->setType('menuindex', PARAM_INT);
2198         $mform->addElement('hidden', 'saveuserid', "-1");
2199         $mform->setType('saveuserid', PARAM_INT);
2200         $mform->addElement('hidden', 'filter', "0");
2201         $mform->setType('filter', PARAM_INT);
2203         $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->user),
2204                                                 fullname($this->_customdata->user, true) . '<br/>' .
2205                                                 userdate($this->_customdata->submission->timemodified) .
2206                                                 $this->_customdata->lateness );
2208         $this->add_submission_content();
2209         $this->add_grades_section();
2211         $this->add_feedback_section();
2213         if ($this->_customdata->submission->timemarked) {
2214             $datestring = userdate($this->_customdata->submission->timemarked)."&nbsp; (".format_time(time() - $this->_customdata->submission->timemarked).")";
2215             $mform->addElement('header', 'Last Grade', get_string('lastgrade', 'assignment'));
2216             $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->teacher) ,
2217                                                     fullname($this->_customdata->teacher,true).
2218                                                     '<br/>'.$datestring);
2219         }
2220         // buttons
2221         $this->add_action_buttons();
2223     }
2225     function add_grades_section() {
2226         global $CFG;
2227         $mform =& $this->_form;
2228         $attributes = array();
2229         if ($this->_customdata->gradingdisabled) {
2230             $attributes['disabled'] ='disabled';
2231         }
2233         $grademenu = make_grades_menu($this->_customdata->assignment->grade);
2234         $grademenu['-1'] = get_string('nograde');
2236         $mform->addElement('header', 'Grades', get_string('grades', 'grades'));
2237         $mform->addElement('select', 'xgrade', get_string('grade').':', $grademenu, $attributes);
2238         $mform->setDefault('xgrade', $this->_customdata->submission->grade ); //@fixme some bug when element called 'grade' makes it break
2239         $mform->setType('xgrade', PARAM_INT);
2241         if (!empty($this->_customdata->enableoutcomes)) {
2242             foreach($this->_customdata->grading_info->outcomes as $n=>$outcome) {
2243                 $options = make_grades_menu(-$outcome->scaleid);
2244                 if ($outcome->grades[$this->_customdata->submission->userid]->locked) {
2245                     $options[0] = get_string('nooutcome', 'grades');
2246                     echo $options[$outcome->grades[$this->_customdata->submission->userid]->grade];
2247                 } else {
2248                     $options[''] = get_string('nooutcome', 'grades');
2249                     $attributes = array('id' => 'menuoutcome_'.$n );
2250                     $mform->addElement('select', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':', $options, $attributes );
2251                     $mform->setType('outcome_'.$n.'['.$this->_customdata->userid.']', PARAM_INT);
2252                     $mform->setDefault('outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->grades[$this->_customdata->submission->userid]->grade );
2253                 }
2254             }
2255         }
2256         $course_context = get_context_instance(CONTEXT_MODULE , $this->_customdata->cm->id);
2257         if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
2258             $grade = '<a href="'.$CFG->wwwroot.'/grade/report/grader/index.php?id='. $this->_customdata->courseid .'" >'.
2259                         $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade . '</a>';
2260         }else{
2261             $grade = $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade;
2262         }
2263         $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assignment').':' ,$grade);
2264         $mform->setType('finalgrade', PARAM_INT);
2265     }
2267     /**
2268      *
2269      * @global core_renderer $OUTPUT
2270      */
2271     function add_feedback_section() {
2272         global $OUTPUT;
2273         $mform =& $this->_form;
2274         $mform->addElement('header', 'Feed Back', get_string('feedback', 'grades'));
2276         if ($this->_customdata->gradingdisabled) {
2277             $mform->addElement('static', 'disabledfeedback', $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_feedback );
2278         } else {
2279             // visible elements
2281             $mform->addElement('editor', 'submissioncomment_editor', get_string('feedback', 'assignment').':', null, $this->get_editor_options() );
2282             $mform->setType('submissioncomment_editor', PARAM_RAW); // to be cleaned before display
2283             $mform->setDefault('submissioncomment_editor', $this->_customdata->submission->submissioncomment);
2284             //$mform->addRule('submissioncomment', get_string('required'), 'required', null, 'client');
2285             switch ($this->_customdata->assignment->assignmenttype) {
2286                 case 'upload' :
2287                 case 'uploadsingle' :
2288                     $mform->addElement('filemanager', 'files_filemanager', get_string('responsefiles', 'assignment'). ':', null, $this->_customdata->fileui_options);
2289                     break;
2290                 default :
2291                     break;
2292             }
2293             $lastmailinfo = get_user_preferences('assignment_mailinfo', 1) ? array('checked'=>'checked') : array();
2294             $mform->addElement('hidden', 'mailinfo_h', "0");
2295             $mform->setType('mailinfo_h', PARAM_INT);
2296             $mform->addElement('checkbox', 'mailinfo',get_string('enableemailnotification','assignment').
2297             $OUTPUT->help_icon('enableemailnotification', 'assignment') .':' );
2298             $mform->updateElementAttr('mailinfo', $lastmailinfo);
2299             $mform->setType('mailinfo', PARAM_INT);
2300         }
2301     }
2303     function add_action_buttons() {
2304         $mform =& $this->_form;
2305         //if there are more to be graded.
2306         if ($this->_customdata->nextid>0) {
2307             $buttonarray=array();
2308             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2309             //@todo: fix accessibility: javascript dependency not necessary
2310             $buttonarray[] = &$mform->createElement('submit', 'saveandnext', get_string('saveandnext'));
2311             $buttonarray[] = &$mform->createElement('submit', 'next', get_string('next'));
2312             $buttonarray[] = &$mform->createElement('cancel');
2313         } else {
2314             $buttonarray=array();
2315             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2316             $buttonarray[] = &$mform->createElement('cancel');
2317         }
2318         $mform->addGroup($buttonarray, 'grading_buttonar', '', array(' '), false);
2319         $mform->closeHeaderBefore('grading_buttonar');
2320         $mform->setType('grading_buttonar', PARAM_RAW);
2321     }
2323     function add_submission_content() {
2324         $mform =& $this->_form;
2325         $mform->addElement('header', 'Submission', get_string('submission', 'assignment'));
2326         $mform->addElement('static', '', '' , $this->_customdata->submission_content );
2327     }
2329     protected function get_editor_options() {
2330         $editoroptions = array();
2331         $editoroptions['component'] = 'mod_assignment';
2332         $editoroptions['filearea'] = 'feedback';
2333         $editoroptions['noclean'] = false;
2334         $editoroptions['maxfiles'] = 0; //TODO: no files for now, we need to first implement assignment_feedback area, integration with gradebook, files support in quickgrading, etc. (skodak)
2335         $editoroptions['maxbytes'] = $this->_customdata->maxbytes;
2336         return $editoroptions;
2337     }
2339     public function set_data($data) {
2340         $editoroptions = $this->get_editor_options();
2341         if (!isset($data->text)) {
2342             $data->text = '';
2343         }
2344         if (!isset($data->format)) {
2345             $data->textformat = FORMAT_HTML;
2346         } else {
2347             $data->textformat = $data->format;
2348         }
2350         if (!empty($this->_customdata->submission->id)) {
2351             $itemid = $this->_customdata->submission->id;
2352         } else {
2353             $itemid = null;
2354         }
2356         switch ($this->_customdata->assignment->assignmenttype) {
2357                 case 'upload' :
2358                 case 'uploadsingle' :
2359                     $data = file_prepare_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2360                     break;
2361                 default :
2362                     break;
2363         }
2365         $data = file_prepare_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2366         return parent::set_data($data);
2367     }
2369     public function get_data() {
2370         $data = parent::get_data();
2372         if (!empty($this->_customdata->submission->id)) {
2373             $itemid = $this->_customdata->submission->id;
2374         } else {
2375             $itemid = null; //TODO: this is wrong, itemid MUST be known when saving files!! (skodak)
2376         }
2378         if ($data) {
2379             $editoroptions = $this->get_editor_options();
2380             switch ($this->_customdata->assignment->assignmenttype) {
2381                 case 'upload' :
2382                 case 'uploadsingle' :
2383                     $data = file_postupdate_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2384                     break;
2385                 default :
2386                     break;
2387             }
2388             $data = file_postupdate_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2389         }
2390         return $data;
2391     }
2394 /// OTHER STANDARD FUNCTIONS ////////////////////////////////////////////////////////
2396 /**
2397  * Deletes an assignment instance
2398  *
2399  * This is done by calling the delete_instance() method of the assignment type class
2400  */
2401 function assignment_delete_instance($id){
2402     global $CFG, $DB;
2404     if (! $assignment = $DB->get_record('assignment', array('id'=>$id))) {
2405         return false;
2406     }
2408     // fall back to base class if plugin missing
2409     $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
2410     if (file_exists($classfile)) {
2411         require_once($classfile);
2412         $assignmentclass = "assignment_$assignment->assignmenttype";
2414     } else {
2415         debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead.");
2416         $assignmentclass = "assignment_base";
2417     }
2419     $ass = new $assignmentclass();
2420     return $ass->delete_instance($assignment);
2424 /**
2425  * Updates an assignment instance
2426  *
2427  * This is done by calling the update_instance() method of the assignment type class
2428  */
2429 function assignment_update_instance($assignment){
2430     global $CFG;
2432     $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2434     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2435     $assignmentclass = "assignment_$assignment->assignmenttype";
2436     $ass = new $assignmentclass();
2437     return $ass->update_instance($assignment);
2441 /**
2442  * Adds an assignment instance
2443  *
2444  * This is done by calling the add_instance() method of the assignment type class
2445  */
2446 function assignment_add_instance($assignment) {
2447     global $CFG;
2449     $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2451     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2452     $assignmentclass = "assignment_$assignment->assignmenttype";
2453     $ass = new $assignmentclass();
2454     return $ass->add_instance($assignment);
2458 /**
2459  * Returns an outline of a user interaction with an assignment
2460  *
2461  * This is done by calling the user_outline() method of the assignment type class
2462  */
2463 function assignment_user_outline($course, $user, $mod, $assignment) {
2464     global $CFG;
2466     require_once("$CFG->libdir/gradelib.php");
2467     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2468     $assignmentclass = "assignment_$assignment->assignmenttype";
2469     $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2470     $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2471     if (!empty($grades->items[0]->grades)) {
2472         return $ass->user_outline(reset($grades->items[0]->grades));
2473     } else {
2474         return null;
2475     }
2478 /**
2479  * Prints the complete info about a user's interaction with an assignment
2480  *
2481  * This is done by calling the user_complete() method of the assignment type class
2482  */
2483 function assignment_user_complete($course, $user, $mod, $assignment) {
2484     global $CFG;
2486     require_once("$CFG->libdir/gradelib.php");
2487     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2488     $assignmentclass = "assignment_$assignment->assignmenttype";
2489     $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2490     $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2491     if (empty($grades->items[0]->grades)) {
2492         $grade = false;
2493     } else {
2494         $grade = reset($grades->items[0]->grades);
2495     }
2496     return $ass->user_complete($user, $grade);
2499 /**
2500  * Function to be run periodically according to the moodle cron
2501  *
2502  * Finds all assignment notifications that have yet to be mailed out, and mails them
2503  */
2504 function assignment_cron () {
2505     global $CFG, $USER, $DB;
2507     /// first execute all crons in plugins
2508     if ($plugins = get_plugin_list('assignment')) {
2509         foreach ($plugins as $plugin=>$dir) {
2510             require_once("$dir/assignment.class.php");
2511             $assignmentclass = "assignment_$plugin";
2512             $ass = new $assignmentclass();
2513             $ass->cron();
2514         }
2515     }
2517     /// Notices older than 1 day will not be mailed.  This is to avoid the problem where
2518     /// cron has not been running for a long time, and then suddenly people are flooded
2519     /// with mail from the past few weeks or months
2521     $timenow   = time();
2522     $endtime   = $timenow - $CFG->maxeditingtime;
2523     $starttime = $endtime - 24 * 3600;   /// One day earlier
2525     if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) {
2527         $realuser = clone($USER);
2529         foreach ($submissions as $key => $submission) {
2530             $DB->set_field("assignment_submissions", "mailed", "1", array("id"=>$submission->id));
2531         }
2533         $timenow = time();
2535         foreach ($submissions as $submission) {
2537             echo "Processing assignment submission $submission->id\n";
2539             if (! $user = $DB->get_record("user", array("id"=>$submission->userid))) {
2540                 echo "Could not find user $user->id\n";
2541                 continue;
2542             }
2544             if (! $course = $DB->get_record("course", array("id"=>$submission->course))) {
2545                 echo "Could not find course $submission->course\n";
2546                 continue;
2547             }
2549             /// Override the language and timezone of the "current" user, so that
2550             /// mail is customised for the receiver.
2551             cron_setup_user($user, $course);
2553             if (!is_enrolled(get_context_instance(CONTEXT_COURSE, $submission->course), $user->id)) {
2554                 echo fullname($user)." not an active participant in " . format_string($course->shortname) . "\n";
2555                 continue;
2556             }
2558             if (! $teacher = $DB->get_record("user", array("id"=>$submission->teacher))) {
2559                 echo "Could not find teacher $submission->teacher\n";
2560                 continue;
2561             }
2563             if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment, $course->id)) {
2564                 echo "Could not find course module for assignment id $submission->assignment\n";
2565                 continue;
2566             }
2568             if (! $mod->visible) {    /// Hold mail notification for hidden assignments until later
2569                 continue;
2570             }
2572             $strassignments = get_string("modulenameplural", "assignment");
2573             $strassignment  = get_string("modulename", "assignment");
2575             $assignmentinfo = new stdClass();
2576             $assignmentinfo->teacher = fullname($teacher);
2577             $assignmentinfo->assignment = format_string($submission->name,true);
2578             $assignmentinfo->url = "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id";
2580             $postsubject = "$course->shortname: $strassignments: ".format_string($submission->name,true);
2581             $posttext  = "$course->shortname -> $strassignments -> ".format_string($submission->name,true)."\n";
2582             $posttext .= "---------------------------------------------------------------------\n";
2583             $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n";
2584             $posttext .= "---------------------------------------------------------------------\n";
2586             if ($user->mailformat == 1) {  // HTML
2587                 $posthtml = "<p><font face=\"sans-serif\">".
2588                 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> ->".
2589                 "<a href=\"$CFG->wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments</a> ->".
2590                 "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name,true)."</a></font></p>";
2591                 $posthtml .= "<hr /><font face=\"sans-serif\">";
2592                 $posthtml .= "<p>".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."</p>";
2593                 $posthtml .= "</font><hr />";
2594             } else {
2595                 $posthtml = "";
2596             }
2598             $eventdata = new stdClass();
2599             $eventdata->modulename       = 'assignment';
2600             $eventdata->userfrom         = $teacher;
2601             $eventdata->userto           = $user;
2602             $eventdata->subject          = $postsubject;
2603             $eventdata->fullmessage      = $posttext;
2604             $eventdata->fullmessageformat = FORMAT_PLAIN;
2605             $eventdata->fullmessagehtml  = $posthtml;
2606             $eventdata->smallmessage     = '';
2607             message_send($eventdata);
2608         }
2610         cron_setup_user();
2611     }
2613     return true;
2616 /**
2617  * Return grade for given user or all users.
2618  *
2619  * @param int $assignmentid id of assignment
2620  * @param int $userid optional user id, 0 means all users
2621  * @return array array of grades, false if none
2622  */
2623 function assignment_get_user_grades($assignment, $userid=0) {
2624     global $CFG, $DB;
2626     if ($userid) {
2627         $user = "AND u.id = :userid";
2628         $params = array('userid'=>$userid);
2629     } else {
2630         $user = "";
2631     }
2632     $params['aid'] = $assignment->id;
2634     $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat,
2635                    s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted
2636               FROM {user} u, {assignment_submissions} s
2637              WHERE u.id = s.userid AND s.assignment = :aid
2638                    $user";
2640     return $DB->get_records_sql($sql, $params);
2643 /**
2644  * Update activity grades
2645  *
2646  * @param object $assignment
2647  * @param int $userid specific user only, 0 means all
2648  */
2649 function assignment_update_grades($assignment, $userid=0, $nullifnone=true) {
2650     global $CFG, $DB;
2651     require_once($CFG->libdir.'/gradelib.php');
2653     if ($assignment->grade == 0) {
2654         assignment_grade_item_update($assignment);
2656     } else if ($grades = assignment_get_user_grades($assignment, $userid)) {
2657         foreach($grades as $k=>$v) {
2658             if ($v->rawgrade == -1) {
2659                 $grades[$k]->rawgrade = null;
2660             }
2661         }
2662         assignment_grade_item_update($assignment, $grades);
2664     } else {
2665         assignment_grade_item_update($assignment);
2666     }
2669 /**
2670  * Update all grades in gradebook.
2671  */
2672 function assignment_upgrade_grades() {
2673     global $DB;
2675     $sql = "SELECT COUNT('x')
2676               FROM {assignment} a, {course_modules} cm, {modules} m
2677              WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2678     $count = $DB->count_records_sql($sql);
2680     $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
2681               FROM {assignment} a, {course_modules} cm, {modules} m
2682              WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2683     if ($rs = $DB->get_recordset_sql($sql)) {
2684         // too much debug output
2685         $pbar = new progress_bar('assignmentupgradegrades', 500, true);
2686         $i=0;
2687         foreach ($rs as $assignment) {
2688             $i++;
2689             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
2690             assignment_update_grades($assignment);
2691             $pbar->update($i, $count, "Updating Assignment grades ($i/$count).");
2692         }
2693         $rs->close();
2694         upgrade_set_timeout(); // reset to default timeout
2695     }
2698 /**
2699  * Create grade item for given assignment
2700  *
2701  * @param object $assignment object with extra cmidnumber
2702  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
2703  * @return int 0 if ok, error code otherwise
2704  */
2705 function assignment_grade_item_update($assignment, $grades=NULL) {
2706     global $CFG;
2707     require_once($CFG->libdir.'/gradelib.php');
2709     if (!isset($assignment->courseid)) {
2710         $assignment->courseid = $assignment->course;
2711     }
2713     $params = array('itemname'=>$assignment->name, 'idnumber'=>$assignment->cmidnumber);
2715     if ($assignment->grade > 0) {
2716         $params['gradetype'] = GRADE_TYPE_VALUE;
2717         $params['grademax']  = $assignment->grade;
2718         $params['grademin']  = 0;
2720     } else if ($assignment->grade < 0) {
2721         $params['gradetype'] = GRADE_TYPE_SCALE;
2722         $params['scaleid']   = -$assignment->grade;
2724     } else {
2725         $params['gradetype'] = GRADE_TYPE_TEXT; // allow text comments only
2726     }
2728     if ($grades  === 'reset') {
2729         $params['reset'] = true;
2730         $grades = NULL;
2731     }
2733     return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, $grades, $params);
2736 /**
2737  * Delete grade item for given assignment
2738  *
2739  * @param object $assignment object
2740  * @return object assignment
2741  */
2742 function assignment_grade_item_delete($assignment) {
2743     global $CFG;
2744     require_once($CFG->libdir.'/gradelib.php');
2746     if (!isset($assignment->courseid)) {
2747         $assignment->courseid = $assignment->course;
2748     }
2750     return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, NULL, array('deleted'=>1));
2753 /**
2754  * Returns the users with data in one assignment (students and teachers)
2755  *
2756  * @param $assignmentid int
2757  * @return array of user objects
2758  */
2759 function assignment_get_participants($assignmentid) {
2760     global $CFG, $DB;
2762     //Get students
2763     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2764                                         FROM {user} u,
2765                                              {assignment_submissions} a
2766                                        WHERE a.assignment = ? and
2767                                              u.id = a.userid", array($assignmentid));
2768     //Get teachers
2769     $teachers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2770                                         FROM {user} u,
2771                                              {assignment_submissions} a
2772                                        WHERE a.assignment = ? and
2773                                              u.id = a.teacher", array($assignmentid));
2775     //Add teachers to students
2776     if ($teachers) {
2777         foreach ($teachers as $teacher) {
2778             $students[$teacher->id] = $teacher;
2779         }
2780     }
2781     //Return students array (it contains an array of unique users)
2782     return ($students);
2785 /**
2786  * Serves assignment submissions and other files.
2787  *
2788  * @param object $course
2789  * @param object $cm
2790  * @param object $context
2791  * @param string $filearea
2792  * @param array $args
2793  * @param bool $forcedownload
2794  * @return bool false if file not found, does not return if found - just send the file
2795  */
2796 function assignment_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
2797     global $CFG, $DB;
2799     if ($context->contextlevel != CONTEXT_MODULE) {
2800         return false;
2801     }
2803     require_login($course, false, $cm);
2805     if (!$assignment = $DB->get_record('assignment', array('id'=>$cm->instance))) {
2806         return false;
2807     }
2809     require_once($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
2810     $assignmentclass = 'assignment_'.$assignment->assignmenttype;
2811     $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm, $course);
2813     return $assignmentinstance->send_file($filearea, $args);
2815 /**
2816  * Checks if a scale is being used by an assignment
2817  *
2818  * This is used by the backup code to decide whether to back up a scale
2819  * @param $assignmentid int
2820  * @param $scaleid int
2821  * @return boolean True if the scale is used by the assignment
2822  */
2823 function assignment_scale_used($assignmentid, $scaleid) {
2824     global $DB;
2826     $return = false;
2828     $rec = $DB->get_record('assignment', array('id'=>$assignmentid,'grade'=>-$scaleid));
2830     if (!empty($rec) && !empty($scaleid)) {
2831         $return = true;
2832     }
2834     return $return;
2837 /**
2838  * Checks if scale is being used by any instance of assignment
2839  *
2840  * This is used to find out if scale used anywhere
2841  * @param $scaleid int
2842  * @return boolean True if the scale is used by any assignment
2843  */
2844 function assignment_scale_used_anywhere($scaleid) {
2845     global $DB;
2847     if ($scaleid and $DB->record_exists('assignment', array('grade'=>-$scaleid))) {
2848         return true;
2849     } else {
2850         return false;
2851     }
2854 /**
2855  * Make sure up-to-date events are created for all assignment instances
2856  *
2857  * This standard function will check all instances of this module
2858  * and make sure there are up-to-date events created for each of them.
2859  * If courseid = 0, then every assignment event in the site is checked, else
2860  * only assignment events belonging to the course specified are checked.
2861  * This function is used, in its new format, by restore_refresh_events()
2862  *
2863  * @param $courseid int optional If zero then all assignments for all courses are covered
2864  * @return boolean Always returns true
2865  */
2866 function assignment_refresh_events($courseid = 0) {
2867     global $DB;
2869     if ($courseid == 0) {
2870         if (! $assignments = $DB->get_records("assignment")) {
2871             return true;
2872         }
2873     } else {
2874         if (! $assignments = $DB->get_records("assignment", array("course"=>$courseid))) {
2875             return true;
2876         }
2877     }
2878     $moduleid = $DB->get_field('modules', 'id', array('name'=>'assignment'));
2880     foreach ($assignments as $assignment) {
2881         $cm = get_coursemodule_from_id('assignment', $assignment->id);
2882         $event = new stdClass();
2883         $event->name        = $assignment->name;
2884         $event->description = format_module_intro('assignment', $assignment, $cm->id);
2885         $event->timestart   = $assignment->timedue;
2887         if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
2888             update_event($event);
2890         } else {
2891             $event->courseid    = $assignment->course;
2892             $event->groupid     = 0;
2893             $event->userid      = 0;
2894             $event->modulename  = 'assignment';
2895             $event->instance    = $assignment->id;
2896             $event->eventtype   = 'due';
2897             $event->timeduration = 0;
2898             $event->visible     = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$assignment->id));
2899             add_event($event);
2900         }
2902     }
2903     return true;
2906 /**
2907  * Print recent activity from all assignments in a given course
2908  *
2909  * This is used by the recent activity block
2910  */
2911 function assignment_print_recent_activity($course, $viewfullnames, $timestart) {
2912     global $CFG, $USER, $DB, $OUTPUT;
2914     // do not use log table if possible, it may be huge
2916     if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified, cm.id AS cmid, asb.userid,
2917                                                      u.firstname, u.lastname, u.email, u.picture
2918                                                 FROM {assignment_submissions} asb
2919                                                      JOIN {assignment} a      ON a.id = asb.assignment
2920                                                      JOIN {course_modules} cm ON cm.instance = a.id
2921                                                      JOIN {modules} md        ON md.id = cm.module
2922                                                      JOIN {user} u            ON u.id = asb.userid
2923                                                WHERE asb.timemodified > ? AND
2924                                                      a.course = ? AND
2925                                                      md.name = 'assignment'
2926                                             ORDER BY asb.timemodified ASC", array($timestart, $course->id))) {
2927          return false;
2928     }
2930     $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups
2931     $show    = array();
2932     $grader  = array();
2934     foreach($submissions as $submission) {
2935         if (!array_key_exists($submission->cmid, $modinfo->cms)) {
2936             continue;
2937         }
2938         $cm = $modinfo->cms[$submission->cmid];
2939         if (!$cm->uservisible) {
2940             continue;
2941         }
2942         if ($submission->userid == $USER->id) {
2943             $show[] = $submission;
2944             continue;
2945         }
2947         // the act of sumbitting of assignment may be considered private - only graders will see it if specified
2948         if (empty($CFG->assignment_showrecentsubmissions)) {
2949             if (!array_key_exists($cm->id, $grader)) {
2950                 $grader[$cm->id] = has_capability('moodle/grade:viewall', get_context_instance(CONTEXT_MODULE, $cm->id));
2951             }
2952             if (!$grader[$cm->id]) {
2953                 continue;
2954             }
2955         }
2957         $groupmode = groups_get_activity_groupmode($cm, $course);
2959         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2960             if (isguestuser()) {
2961                 // shortcut - guest user does not belong into any group
2962                 continue;
2963             }
2965             if (is_null($modinfo->groups)) {
2966                 $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
2967             }
2969             // this will be slow - show only users that share group with me in this cm
2970             if (empty($modinfo->groups[$cm->id])) {
2971                 continue;
2972             }
2973             $usersgroups =  groups_get_all_groups($course->id, $submission->userid, $cm->groupingid);
2974             if (is_array($usersgroups)) {
2975                 $usersgroups = array_keys($usersgroups);
2976                 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
2977                 if (empty($intersect)) {
2978                     continue;
2979                 }
2980             }
2981         }
2982         $show[] = $submission;
2983     }
2985     if (empty($show)) {
2986         return false;
2987     }
2989     echo $OUTPUT->heading(get_string('newsubmissions', 'assignment').':', 3);
2991     foreach ($show as $submission) {
2992         $cm = $modinfo->cms[$submission->cmid];
2993         $link = $CFG->wwwroot.'/mod/assignment/view.php?id='.$cm->id;
2994         print_recent_activity_note($submission->timemodified, $submission, $cm->name, $link, false, $viewfullnames);
2995     }
2997     return true;
3001 /**
3002  * Returns all assignments since a given time in specified forum.
3003  */
3004 function assignment_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)  {
3005     global $CFG, $COURSE, $USER, $DB;
3007     if ($COURSE->id == $courseid) {
3008         $course = $COURSE;
3009     } else {
3010         $course = $DB->get_record('course', array('id'=>$courseid));
3011     }
3013     $modinfo =& get_fast_modinfo($course);
3015     $cm = $modinfo->cms[$cmid];
3017     $params = array();
3018     if ($userid) {
3019         $userselect = "AND u.id = :userid";
3020         $params['userid'] = $userid;
3021     } else {
3022         $userselect = "";
3023     }
3025     if ($groupid) {
3026         $groupselect = "AND gm.groupid = :groupid";
3027         $groupjoin   = "JOIN {groups_members} gm ON  gm.userid=u.id";
3028         $params['groupid'] = $groupid;
3029     } else {
3030         $groupselect = "";
3031         $groupjoin   = "";
3032     }
3034     $params['cminstance'] = $cm->instance;
3035     $params['timestart'] = $timestart;
3037     $userfields = user_picture::fields('u', null, 'userid');
3039     if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified,
3040                                                      $userfields
3041                                                 FROM {assignment_submissions} asb
3042                                                 JOIN {assignment} a      ON a.id = asb.assignment
3043                                                 JOIN {user} u            ON u.id = asb.userid
3044                                           $groupjoin
3045                                                WHERE asb.timemodified > :timestart AND a.id = :cminstance
3046                                                      $userselect $groupselect
3047                                             ORDER BY asb.timemodified ASC", $params)) {
3048          return;
3049     }
3051     $groupmode       = groups_get_activity_groupmode($cm, $course);
3052     $cm_context      = get_context_instance(CONTEXT_MODULE, $cm->id);
3053     $grader          = has_capability('moodle/grade:viewall', $cm_context);
3054     $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
3055     $viewfullnames   = has_capability('moodle/site:viewfullnames', $cm_context);
3057     if (is_null($modinfo->groups)) {
3058         $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
3059     }
3061     $show = array();
3063     foreach($submissions as $submission) {
3064         if ($submission->userid == $USER->id) {
3065             $show[] = $submission;
3066             continue;
3067         }
3068         // the act of submitting of assignment may be considered private - only graders will see it if specified
3069         if (empty($CFG->assignment_showrecentsubmissions)) {
3070             if (!$grader) {
3071                 continue;
3072             }
3073         }
3075         if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
3076             if (isguestuser()) {
3077                 // shortcut - guest user does not belong into any group
3078                 continue;
3079             }
3081             // this will be slow - show only users that share group with me in this cm
3082             if (empty($modinfo->groups[$cm->id])) {
3083                 continue;
3084             }
3085             $usersgroups = groups_get_all_groups($course->id, $cm->userid, $cm->groupingid);
3086             if (is_array($usersgroups)) {
3087                 $usersgroups = array_keys($usersgroups);
3088                 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
3089                 if (empty($intersect)) {
3090                     continue;
3091                 }
3092             }
3093         }
3094         $show[] = $submission;
3095     }
3097     if (empty($show)) {
3098         return;
3099     }
3101     if ($grader) {
3102         require_once($CFG->libdir.'/gradelib.php');
3103         $userids = array();
3104         foreach ($show as $id=>$submission) {
3105             $userids[] = $submission->userid;
3107         }
3108         $grades = grade_get_grades($courseid, 'mod', 'assignment', $cm->instance, $userids);
3109     }
3111     $aname = format_string($cm->name,true);
3112     foreach ($show as $submission) {
3113         $tmpactivity = new stdClass();
3115         $tmpactivity->type         = 'assignment';
3116         $tmpactivity->cmid         = $cm->id;
3117         $tmpactivity->name         = $aname;
3118         $tmpactivity->sectionnum   = $cm->sectionnum;
3119         $tmpactivity->timestamp    = $submission->timemodified;
3121         if ($grader) {
3122             $tmpactivity->grade = $grades->items[0]->grades[$submission->userid]->str_long_grade;
3123         }
3125         $userfields = explode(',', user_picture::fields());
3126         foreach ($userfields as $userfield) {
3127             if ($userfield == 'id') {
3128                 $tmpactivity->user->{$userfield} = $submission->userid; // aliased in SQL above
3129             } else {
3130                 $tmpactivity->user->{$userfield} = $submission->{$userfield};
3131             }
3132         }
3133         $tmpactivity->user->fullname = fullname($submission, $viewfullnames);
3135         $activities[$index++] = $tmpactivity;
3136     }
3138     return;
3141 /**
3142  * Print recent activity from all assignments in a given course
3143  *
3144  * This is used by course/recent.php
3145  */
3146 function assignment_print_recent_mod_activity($activity, $courseid, $detail, $modnames)  {
3147     global $CFG, $OUTPUT;
3149     echo '<table border="0" cellpadding="3" cellspacing="0" class="assignment-recent">';
3151     echo "<tr><td class=\"userpicture\" valign=\"top\">";
3152     echo $OUTPUT->user_picture($activity->user);
3153     echo "</td><td>";
3155     if ($detail) {
3156         $modname = $modnames[$activity->type];
3157         echo '<div class="title">';
3158         echo "<img src=\"" . $OUTPUT->pix_url('icon', 'assignment') . "\" ".
3159              "class=\"icon\" alt=\"$modname\">";
3160         echo "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id={$activity->cmid}\">{$activity->name}</a>";
3161         echo '</div>';
3162     }
3164     if (isset($activity->grade)) {
3165         echo '<div class="grade">';
3166         echo get_string('grade').': ';
3167         echo $activity->grade;
3168         echo '</div>';
3169     }
3171     echo '<div class="user">';
3172     echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&amp;course=$courseid\">"
3173          ."{$activity->user->fullname}</a>  - ".userdate($activity->timestamp);
3174     echo '</div>';
3176     echo "</td></tr></table>";
3179 /// GENERIC SQL FUNCTIONS
3181 /**
3182  * Fetch info from logs
3183  *
3184  * @param $log object with properties ->info (the assignment id) and ->userid
3185  * @return array with assignment name and user firstname and lastname
3186  */
3187 function assignment_log_info($log) {
3188     global $CFG, $DB;
3190     return $DB->get_record_sql("SELECT a.name, u.firstname, u.lastname
3191                                   FROM {assignment} a, {user} u
3192                                  WHERE a.id = ? AND u.id = ?", array($log->info, $log->userid));
3195 /**
3196  * Return list of marked submissions that have not been mailed out for currently enrolled students
3197  *
3198  * @return array
3199  */
3200 function assignment_get_unmailed_submissions($starttime, $endtime) {
3201     global $CFG, $DB;
3203     return $DB->get_records_sql("SELECT s.*, a.course, a.name
3204                                    FROM {assignment_submissions} s,
3205                                         {assignment} a
3206                                   WHERE s.mailed = 0
3207                                         AND s.timemarked <= ?
3208                                         AND s.timemarked >= ?
3209                                         AND s.assignment = a.id", array($endtime, $starttime));
3212 /**
3213  * Counts all real assignment submissions by ENROLLED students (not empty ones)
3214  *
3215  * There are also assignment type methods count_real_submissions() which in the default
3216  * implementation simply call this function.
3217  * @param $groupid int optional If nonzero then count is restricted to this group
3218  * @return int The number of submissions
3219  */
3220 function assignment_count_real_submissions($cm, $groupid=0) {
3221     global $CFG, $DB;
3223     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
3225     // this is all the users with this capability set, in this context or higher
3226     if ($users = get_enrolled_users($context, 'mod/assignment:view', $groupid, 'u.id')) {
3227         $users = array_keys($users);
3228     }
3230     // if groupmembersonly used, remove users who are not in any group
3231     if ($users and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3232         if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
3233             $users = array_intersect($users, array_keys($groupingusers));
3234         }
3235     }
3237     if (empty($users)) {
3238         return 0;
3239     }
3241     $userlists = implode(',', $users);
3243     return $DB->count_records_sql("SELECT COUNT('x')
3244                                      FROM {assignment_submissions}
3245                                     WHERE assignment = ? AND
3246                                           timemodified > 0 AND
3247                                           userid IN ($userlists)", array($cm->instance));
3251 /**
3252  * Return all assignment submissions by ENROLLED students (even empty)
3253  *
3254  * There are also assignment type methods get_submissions() wich in the default
3255  * implementation simply call this function.
3256  * @param $sort string optional field names for the ORDER BY in the sql query
3257  * @param $dir string optional specifying the sort direction, defaults to DESC
3258  * @return array The submission objects indexed by id
3259  */
3260 function assignment_get_all_submissions($assignment, $sort="", $dir="DESC") {
3261 /// Return all assignment submissions by ENROLLED students (even empty)
3262     global $CFG, $DB;
3264     if ($sort == "lastname" or $sort == "firstname") {
3265         $sort = "u.$sort $dir";
3266     } else if (empty($sort)) {
3267         $sort = "a.timemodified DESC";
3268     } else {
3269         $sort = "a.$sort $dir";
3270     }
3272     /* not sure this is needed at all since assignment already has a course define, so this join?
3273     $select = "s.course = '$assignment->course' AND";
3274     if ($assignment->course == SITEID) {
3275         $select = '';
3276     }*/
3278     return $DB->get_records_sql("SELECT a.*
3279                                    FROM {assignment_submissions} a, {user} u
3280                                   WHERE u.id = a.userid
3281                                         AND a.assignment = ?
3282                                ORDER BY $sort", array($assignment->id));
3286 /**
3287  * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
3288  * for the course (see resource).
3289  *
3290  * Given a course_module object, this function returns any "extra" information that may be needed
3291  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
3292  *
3293  * @param $coursemodule object The coursemodule object (record).
3294  * @return object An object on information that the courses will know about (most noticeably, an icon).
3295  *
3296  */
3297 function assignment_get_coursemodule_info($coursemodule) {
3298     global $CFG, $DB;
3300     if (! $assignment = $DB->get_record('assignment', array('id'=>$coursemodule->instance), 'id, assignmenttype, name')) {
3301         return false;
3302     }
3304     $libfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
3306     if (file_exists($libfile)) {
3307         require_once($libfile);
3308         $assignmentclass = "assignment_$assignment->assignmenttype";
3309         $ass = new $assignmentclass('staticonly');
3310         if ($result = $ass->get_coursemodule_info($coursemodule)) {
3311             return $result;
3312         } else {
3313             $info = new stdClass();
3314             $info->name = $assignment->name;
3315             return $info;
3316         }
3318     } else {
3319         debugging('Incorrect assignment type: '.$assignment->assignmenttype);
3320         return false;
3321     }
3326 /// OTHER GENERAL FUNCTIONS FOR ASSIGNMENTS  ///////////////////////////////////////
3328 /**
3329  * Returns an array of installed assignment types indexed and sorted by name
3330  *
3331  * @return array The index is the name of the assignment type, the value its full name from the language strings
3332  */
3333 function assignment_types() {
3334     $types = array();
3335     $names = get_plugin_list('assignment');
3336     foreach ($names as $name=>$dir) {
3337         $types[$name] = get_string('type'.$name, 'assignment');
3339         // ugly hack to support pluggable assignment type titles..
3340         if ($types[$name] == '[[type'.$name.']]') {
3341             $types[$name] = get_string('type'.$name, 'assignment_'.$name);
3342         }
3343     }
3344     asort($types);
3345     return $types;
3348 function assignment_print_overview($courses, &$htmlarray) {
3349     global $USER, $CFG, $DB;
3351     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
3352         return array();
3353     }
3355     if (!$assignments = get_all_instances_in_courses('assignment',$courses)) {
3356         return;
3357     }
3359     $assignmentids = array();
3361     // Do assignment_base::isopen() here without loading the whole thing for speed
3362     foreach ($assignments as $key => $assignment) {
3363         $time = time();
3364         if ($assignment->timedue) {
3365             if ($assignment->preventlate) {
3366                 $isopen = ($assignment->timeavailable <= $time && $time <= $assignment->timedue);
3367             } else {
3368                 $isopen = ($assignment->timeavailable <= $time);
3369             }
3370         }
3371         if (empty($isopen) || e