032734811fa80b19d7d9fc034df5eb987937545a
[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;
1732                 $info->timeupdated = strftime('%c',$submission->timemodified);
1734                 $postsubject = $strsubmitted.': '.$info->username.' -> '.$this->assignment->name;
1735                 $posttext = $this->email_teachers_text($info);
1736                 $posthtml = ($teacher->mailformat == 1) ? $this->email_teachers_html($info) : '';
1738                 $eventdata = new stdClass();
1739                 $eventdata->modulename       = 'assignment';
1740                 $eventdata->userfrom         = $user;
1741                 $eventdata->userto           = $teacher;
1742                 $eventdata->subject          = $postsubject;
1743                 $eventdata->fullmessage      = $posttext;
1744                 $eventdata->fullmessageformat = FORMAT_PLAIN;
1745                 $eventdata->fullmessagehtml  = $posthtml;
1746                 $eventdata->smallmessage     = '';
1748                 $eventdata->name            = 'assignment_updates';
1749                 $eventdata->component       = 'mod_assignment';
1750                 $eventdata->notification    = 1;
1751                 $eventdata->contexturl      = $info->url;
1752                 $eventdata->contexturlname  = $info->assignment;
1753                 
1754                 message_send($eventdata);
1755             }
1756         }
1757     }
1759     /**
1760      * @param string $filearea
1761      * @param array $args
1762      * @return bool
1763      */
1764     function send_file($filearea, $args) {
1765         debugging('plugin does not implement file sending', DEBUG_DEVELOPER);
1766         return false;
1767     }
1769     /**
1770      * Returns a list of teachers that should be grading given submission
1771      *
1772      * @param object $user
1773      * @return array
1774      */
1775     function get_graders($user) {
1776         //potential graders
1777         $potgraders = get_users_by_capability($this->context, 'mod/assignment:grade', '', '', '', '', '', '', false, false);
1779         $graders = array();
1780         if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) {   // Separate groups are being used
1781             if ($groups = groups_get_all_groups($this->course->id, $user->id)) {  // Try to find all groups
1782                 foreach ($groups as $group) {
1783                     foreach ($potgraders as $t) {
1784                         if ($t->id == $user->id) {
1785                             continue; // do not send self
1786                         }
1787                         if (groups_is_member($group->id, $t->id)) {
1788                             $graders[$t->id] = $t;
1789                         }
1790                     }
1791                 }
1792             } else {
1793                 // user not in group, try to find graders without group
1794                 foreach ($potgraders as $t) {
1795                     if ($t->id == $user->id) {
1796                         continue; // do not send self
1797                     }
1798                     if (!groups_get_all_groups($this->course->id, $t->id)) { //ugly hack
1799                         $graders[$t->id] = $t;
1800                     }
1801                 }
1802             }
1803         } else {
1804             foreach ($potgraders as $t) {
1805                 if ($t->id == $user->id) {
1806                     continue; // do not send self
1807                 }
1808                 $graders[$t->id] = $t;
1809             }
1810         }
1811         return $graders;
1812     }
1814     /**
1815      * Creates the text content for emails to teachers
1816      *
1817      * @param $info object The info used by the 'emailteachermail' language string
1818      * @return string
1819      */
1820     function email_teachers_text($info) {
1821         $posttext  = format_string($this->course->shortname).' -> '.$this->strassignments.' -> '.
1822                      format_string($this->assignment->name)."\n";
1823         $posttext .= '---------------------------------------------------------------------'."\n";
1824         $posttext .= get_string("emailteachermail", "assignment", $info)."\n";
1825         $posttext .= "\n---------------------------------------------------------------------\n";
1826         return $posttext;
1827     }
1829      /**
1830      * Creates the html content for emails to teachers
1831      *
1832      * @param $info object The info used by the 'emailteachermailhtml' language string
1833      * @return string
1834      */
1835     function email_teachers_html($info) {
1836         global $CFG;
1837         $posthtml  = '<p><font face="sans-serif">'.
1838                      '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$this->course->id.'">'.format_string($this->course->shortname).'</a> ->'.
1839                      '<a href="'.$CFG->wwwroot.'/mod/assignment/index.php?id='.$this->course->id.'">'.$this->strassignments.'</a> ->'.
1840                      '<a href="'.$CFG->wwwroot.'/mod/assignment/view.php?id='.$this->cm->id.'">'.format_string($this->assignment->name).'</a></font></p>';
1841         $posthtml .= '<hr /><font face="sans-serif">';
1842         $posthtml .= '<p>'.get_string('emailteachermailhtml', 'assignment', $info).'</p>';
1843         $posthtml .= '</font><hr />';
1844         return $posthtml;
1845     }
1847     /**
1848      * Produces a list of links to the files uploaded by a user
1849      *
1850      * @param $userid int optional id of the user. If 0 then $USER->id is used.
1851      * @param $return boolean optional defaults to false. If true the list is returned rather than printed
1852      * @return string optional
1853      */
1854     function print_user_files($userid=0, $return=false) {
1855         global $CFG, $USER, $OUTPUT;
1857         if (!$userid) {
1858             if (!isloggedin()) {
1859                 return '';
1860             }
1861             $userid = $USER->id;
1862         }
1864         $output = '';
1866         $fs = get_file_storage();
1868         $found = false;
1870         $submission = $this->get_submission($userid);
1872         if (($submission) && $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
1873             require_once($CFG->libdir.'/portfoliolib.php');
1874             require_once($CFG->dirroot . '/mod/assignment/locallib.php');
1875             $button = new portfolio_add_button();
1876             foreach ($files as $file) {
1877                 $filename = $file->get_filename();
1878                 $found = true;
1879                 $mimetype = $file->get_mimetype();
1880                 $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$this->context->id.'/mod_assignment/submission/'.$submission->id.'/'.$filename);
1881                 $output .= '<a href="'.$path.'" ><img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />'.s($filename).'</a>';
1882                 if ($this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
1883                     $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'fileid' => $file->get_id()), '/mod/assignment/locallib.php');
1884                     $button->set_format_by_file($file);
1885                     $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1886                 }
1887                 $output .= plagiarism_get_links(array('userid'=>$userid, 'file'=>$file, 'cmid'=>$this->cm->id, 'course'=>$this->course, 'assignment'=>$this->assignment));
1888                 $output .= '<br />';
1889             }
1890             if (count($files) > 1  && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
1891                 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id), '/mod/assignment/locallib.php');
1892                 $output .= '<br />'  . $button->to_html();
1893             }
1894         }
1896         $output = '<div class="files">'.$output.'</div>';
1898         if ($return) {
1899             return $output;
1900         }
1901         echo $output;
1902     }
1904     /**
1905      * Count the files uploaded by a given user
1906      *
1907      * @param $itemid int The submission's id as the file's itemid.
1908      * @return int
1909      */
1910     function count_user_files($itemid) {
1911         $fs = get_file_storage();
1912         $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $itemid, "id", false);
1913         return count($files);
1914     }
1916     /**
1917      * Returns true if the student is allowed to submit
1918      *
1919      * Checks that the assignment has started and, if the option to prevent late
1920      * submissions is set, also checks that the assignment has not yet closed.
1921      * @return boolean
1922      */
1923     function isopen() {
1924         $time = time();
1925         if ($this->assignment->preventlate && $this->assignment->timedue) {
1926             return ($this->assignment->timeavailable <= $time && $time <= $this->assignment->timedue);
1927         } else {
1928             return ($this->assignment->timeavailable <= $time);
1929         }
1930     }
1933     /**
1934      * Return true if is set description is hidden till available date
1935      *
1936      * This is needed by calendar so that hidden descriptions do not
1937      * come up in upcoming events.
1938      *
1939      * Check that description is hidden till available date
1940      * By default return false
1941      * Assignments types should implement this method if needed
1942      * @return boolen
1943      */
1944     function description_is_hidden() {
1945         return false;
1946     }
1948     /**
1949      * Return an outline of the user's interaction with the assignment
1950      *
1951      * The default method prints the grade and timemodified
1952      * @param $grade object
1953      * @return object with properties ->info and ->time
1954      */
1955     function user_outline($grade) {
1957         $result = new stdClass();
1958         $result->info = get_string('grade').': '.$grade->str_long_grade;
1959         $result->time = $grade->dategraded;
1960         return $result;
1961     }
1963     /**
1964      * Print complete information about the user's interaction with the assignment
1965      *
1966      * @param $user object
1967      */
1968     function user_complete($user, $grade=null) {
1969         global $OUTPUT;
1970         if ($grade) {
1971             echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1972             if ($grade->str_feedback) {
1973                 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1974             }
1975         }
1977         if ($submission = $this->get_submission($user->id)) {
1979             $fs = get_file_storage();
1981             if ($files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
1982                 $countfiles = count($files)." ".get_string("uploadedfiles", "assignment");
1983                 foreach ($files as $file) {
1984                     $countfiles .= "; ".$file->get_filename();
1985                 }
1986             }
1988             echo $OUTPUT->box_start();
1989             echo get_string("lastmodified").": ";
1990             echo userdate($submission->timemodified);
1991             echo $this->display_lateness($submission->timemodified);
1993             $this->print_user_files($user->id);
1995             echo '<br />';
1997             $this->view_feedback($submission);
1999             echo $OUTPUT->box_end();
2001         } else {
2002             print_string("notsubmittedyet", "assignment");
2003         }
2004     }
2006     /**
2007      * Return a string indicating how late a submission is
2008      *
2009      * @param $timesubmitted int
2010      * @return string
2011      */
2012     function display_lateness($timesubmitted) {
2013         return assignment_display_lateness($timesubmitted, $this->assignment->timedue);
2014     }
2016     /**
2017      * Empty method stub for all delete actions.
2018      */
2019     function delete() {
2020         //nothing by default
2021         redirect('view.php?id='.$this->cm->id);
2022     }
2024     /**
2025      * Empty custom feedback grading form.
2026      */
2027     function custom_feedbackform($submission, $return=false) {
2028         //nothing by default
2029         return '';
2030     }
2032     /**
2033      * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
2034      * for the course (see resource).
2035      *
2036      * Given a course_module object, this function returns any "extra" information that may be needed
2037      * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
2038      *
2039      * @param $coursemodule object The coursemodule object (record).
2040      * @return object An object on information that the courses will know about (most noticeably, an icon).
2041      *
2042      */
2043     function get_coursemodule_info($coursemodule) {
2044         return false;
2045     }
2047     /**
2048      * Plugin cron method - do not use $this here, create new assignment instances if needed.
2049      * @return void
2050      */
2051     function cron() {
2052         //no plugin cron by default - override if needed
2053     }
2055     /**
2056      * Reset all submissions
2057      */
2058     function reset_userdata($data) {
2059         global $CFG, $DB;
2061         if (!$DB->count_records('assignment', array('course'=>$data->courseid, 'assignmenttype'=>$this->type))) {
2062             return array(); // no assignments of this type present
2063         }
2065         $componentstr = get_string('modulenameplural', 'assignment');
2066         $status = array();
2068         $typestr = get_string('type'.$this->type, 'assignment');
2069         // ugly hack to support pluggable assignment type titles...
2070         if($typestr === '[[type'.$this->type.']]'){
2071             $typestr = get_string('type'.$this->type, 'assignment_'.$this->type);
2072         }
2074         if (!empty($data->reset_assignment_submissions)) {
2075             $assignmentssql = "SELECT a.id
2076                                  FROM {assignment} a
2077                                 WHERE a.course=? AND a.assignmenttype=?";
2078             $params = array($data->courseid, $this->type);
2080             // now get rid of all submissions and responses
2081             $fs = get_file_storage();
2082             if ($assignments = $DB->get_records_sql($assignmentssql, $params)) {
2083                 foreach ($assignments as $assignmentid=>$unused) {
2084                     if (!$cm = get_coursemodule_from_instance('assignment', $assignmentid)) {
2085                         continue;
2086                     }
2087                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2088                     $fs->delete_area_files($context->id, 'mod_assignment', 'submission');
2089                     $fs->delete_area_files($context->id, 'mod_assignment', 'response');
2090                 }
2091             }
2093             $DB->delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)", $params);
2095             $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false);
2097             if (empty($data->reset_gradebook_grades)) {
2098                 // remove all grades from gradebook
2099                 assignment_reset_gradebook($data->courseid, $this->type);
2100             }
2101         }
2103         /// updating dates - shift may be negative too
2104         if ($data->timeshift) {
2105             shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift, $data->courseid);
2106             $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false);
2107         }
2109         return $status;
2110     }
2113     function portfolio_exportable() {
2114         return false;
2115     }
2117     /**
2118      * base implementation for backing up subtype specific information
2119      * for one single module
2120      *
2121      * @param filehandle $bf file handle for xml file to write to
2122      * @param mixed $preferences the complete backup preference object
2123      *
2124      * @return boolean
2125      *
2126      * @static
2127      */
2128     static function backup_one_mod($bf, $preferences, $assignment) {
2129         return true;
2130     }
2132     /**
2133      * base implementation for backing up subtype specific information
2134      * for one single submission
2135      *
2136      * @param filehandle $bf file handle for xml file to write to
2137      * @param mixed $preferences the complete backup preference object
2138      * @param object $submission the assignment submission db record
2139      *
2140      * @return boolean
2141      *
2142      * @static
2143      */
2144     static function backup_one_submission($bf, $preferences, $assignment, $submission) {
2145         return true;
2146     }
2148     /**
2149      * base implementation for restoring subtype specific information
2150      * for one single module
2151      *
2152      * @param array  $info the array representing the xml
2153      * @param object $restore the restore preferences
2154      *
2155      * @return boolean
2156      *
2157      * @static
2158      */
2159     static function restore_one_mod($info, $restore, $assignment) {
2160         return true;
2161     }
2163     /**
2164      * base implementation for restoring subtype specific information
2165      * for one single submission
2166      *
2167      * @param object $submission the newly created submission
2168      * @param array  $info the array representing the xml
2169      * @param object $restore the restore preferences
2170      *
2171      * @return boolean
2172      *
2173      * @static
2174      */
2175     static function restore_one_submission($info, $restore, $assignment, $submission) {
2176         return true;
2177     }
2179 } ////// End of the assignment_base class
2182 class mod_assignment_grading_form extends moodleform {
2184     function definition() {
2185         global $OUTPUT;
2186         $mform =& $this->_form;
2188         $formattr = $mform->getAttributes();
2189         $formattr['id'] = 'submitform';
2190         $mform->setAttributes($formattr);
2191         // hidden params
2192         $mform->addElement('hidden', 'offset', ($this->_customdata->offset+1));
2193         $mform->setType('offset', PARAM_INT);
2194         $mform->addElement('hidden', 'userid', $this->_customdata->userid);
2195         $mform->setType('userid', PARAM_INT);
2196         $mform->addElement('hidden', 'nextid', $this->_customdata->nextid);
2197         $mform->setType('nextid', PARAM_INT);
2198         $mform->addElement('hidden', 'id', $this->_customdata->cm->id);
2199         $mform->setType('id', PARAM_INT);
2200         $mform->addElement('hidden', 'sesskey', sesskey());
2201         $mform->setType('sesskey', PARAM_ALPHANUM);
2202         $mform->addElement('hidden', 'mode', 'grade');
2203         $mform->setType('mode', PARAM_TEXT);
2204         $mform->addElement('hidden', 'menuindex', "0");
2205         $mform->setType('menuindex', PARAM_INT);
2206         $mform->addElement('hidden', 'saveuserid', "-1");
2207         $mform->setType('saveuserid', PARAM_INT);
2208         $mform->addElement('hidden', 'filter', "0");
2209         $mform->setType('filter', PARAM_INT);
2211         $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->user),
2212                                                 fullname($this->_customdata->user, true) . '<br/>' .
2213                                                 userdate($this->_customdata->submission->timemodified) .
2214                                                 $this->_customdata->lateness );
2216         $this->add_submission_content();
2217         $this->add_grades_section();
2219         $this->add_feedback_section();
2221         if ($this->_customdata->submission->timemarked) {
2222             $datestring = userdate($this->_customdata->submission->timemarked)."&nbsp; (".format_time(time() - $this->_customdata->submission->timemarked).")";
2223             $mform->addElement('header', 'Last Grade', get_string('lastgrade', 'assignment'));
2224             $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->teacher) ,
2225                                                     fullname($this->_customdata->teacher,true).
2226                                                     '<br/>'.$datestring);
2227         }
2228         // buttons
2229         $this->add_action_buttons();
2231     }
2233     function add_grades_section() {
2234         global $CFG;
2235         $mform =& $this->_form;
2236         $attributes = array();
2237         if ($this->_customdata->gradingdisabled) {
2238             $attributes['disabled'] ='disabled';
2239         }
2241         $grademenu = make_grades_menu($this->_customdata->assignment->grade);
2242         $grademenu['-1'] = get_string('nograde');
2244         $mform->addElement('header', 'Grades', get_string('grades', 'grades'));
2245         $mform->addElement('select', 'xgrade', get_string('grade').':', $grademenu, $attributes);
2246         $mform->setDefault('xgrade', $this->_customdata->submission->grade ); //@fixme some bug when element called 'grade' makes it break
2247         $mform->setType('xgrade', PARAM_INT);
2249         if (!empty($this->_customdata->enableoutcomes)) {
2250             foreach($this->_customdata->grading_info->outcomes as $n=>$outcome) {
2251                 $options = make_grades_menu(-$outcome->scaleid);
2252                 if ($outcome->grades[$this->_customdata->submission->userid]->locked) {
2253                     $options[0] = get_string('nooutcome', 'grades');
2254                     echo $options[$outcome->grades[$this->_customdata->submission->userid]->grade];
2255                 } else {
2256                     $options[''] = get_string('nooutcome', 'grades');
2257                     $attributes = array('id' => 'menuoutcome_'.$n );
2258                     $mform->addElement('select', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':', $options, $attributes );
2259                     $mform->setType('outcome_'.$n.'['.$this->_customdata->userid.']', PARAM_INT);
2260                     $mform->setDefault('outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->grades[$this->_customdata->submission->userid]->grade );
2261                 }
2262             }
2263         }
2264         $course_context = get_context_instance(CONTEXT_MODULE , $this->_customdata->cm->id);
2265         if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
2266             $grade = '<a href="'.$CFG->wwwroot.'/grade/report/grader/index.php?id='. $this->_customdata->courseid .'" >'.
2267                         $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade . '</a>';
2268         }else{
2269             $grade = $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade;
2270         }
2271         $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assignment').':' ,$grade);
2272         $mform->setType('finalgrade', PARAM_INT);
2273     }
2275     /**
2276      *
2277      * @global core_renderer $OUTPUT
2278      */
2279     function add_feedback_section() {
2280         global $OUTPUT;
2281         $mform =& $this->_form;
2282         $mform->addElement('header', 'Feed Back', get_string('feedback', 'grades'));
2284         if ($this->_customdata->gradingdisabled) {
2285             $mform->addElement('static', 'disabledfeedback', $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_feedback );
2286         } else {
2287             // visible elements
2289             $mform->addElement('editor', 'submissioncomment_editor', get_string('feedback', 'assignment').':', null, $this->get_editor_options() );
2290             $mform->setType('submissioncomment_editor', PARAM_RAW); // to be cleaned before display
2291             $mform->setDefault('submissioncomment_editor', $this->_customdata->submission->submissioncomment);
2292             //$mform->addRule('submissioncomment', get_string('required'), 'required', null, 'client');
2293             switch ($this->_customdata->assignment->assignmenttype) {
2294                 case 'upload' :
2295                 case 'uploadsingle' :
2296                     $mform->addElement('filemanager', 'files_filemanager', get_string('responsefiles', 'assignment'). ':', null, $this->_customdata->fileui_options);
2297                     break;
2298                 default :
2299                     break;
2300             }
2301             $lastmailinfo = get_user_preferences('assignment_mailinfo', 1) ? array('checked'=>'checked') : array();
2302             $mform->addElement('hidden', 'mailinfo_h', "0");
2303             $mform->setType('mailinfo_h', PARAM_INT);
2304             $mform->addElement('checkbox', 'mailinfo',get_string('enableemailnotification','assignment').
2305             $OUTPUT->help_icon('enableemailnotification', 'assignment') .':' );
2306             $mform->updateElementAttr('mailinfo', $lastmailinfo);
2307             $mform->setType('mailinfo', PARAM_INT);
2308         }
2309     }
2311     function add_action_buttons() {
2312         $mform =& $this->_form;
2313         //if there are more to be graded.
2314         if ($this->_customdata->nextid>0) {
2315             $buttonarray=array();
2316             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2317             //@todo: fix accessibility: javascript dependency not necessary
2318             $buttonarray[] = &$mform->createElement('submit', 'saveandnext', get_string('saveandnext'));
2319             $buttonarray[] = &$mform->createElement('submit', 'next', get_string('next'));
2320             $buttonarray[] = &$mform->createElement('cancel');
2321         } else {
2322             $buttonarray=array();
2323             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2324             $buttonarray[] = &$mform->createElement('cancel');
2325         }
2326         $mform->addGroup($buttonarray, 'grading_buttonar', '', array(' '), false);
2327         $mform->closeHeaderBefore('grading_buttonar');
2328         $mform->setType('grading_buttonar', PARAM_RAW);
2329     }
2331     function add_submission_content() {
2332         $mform =& $this->_form;
2333         $mform->addElement('header', 'Submission', get_string('submission', 'assignment'));
2334         $mform->addElement('static', '', '' , $this->_customdata->submission_content );
2335     }
2337     protected function get_editor_options() {
2338         $editoroptions = array();
2339         $editoroptions['component'] = 'mod_assignment';
2340         $editoroptions['filearea'] = 'feedback';
2341         $editoroptions['noclean'] = false;
2342         $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)
2343         $editoroptions['maxbytes'] = $this->_customdata->maxbytes;
2344         return $editoroptions;
2345     }
2347     public function set_data($data) {
2348         $editoroptions = $this->get_editor_options();
2349         if (!isset($data->text)) {
2350             $data->text = '';
2351         }
2352         if (!isset($data->format)) {
2353             $data->textformat = FORMAT_HTML;
2354         } else {
2355             $data->textformat = $data->format;
2356         }
2358         if (!empty($this->_customdata->submission->id)) {
2359             $itemid = $this->_customdata->submission->id;
2360         } else {
2361             $itemid = null;
2362         }
2364         switch ($this->_customdata->assignment->assignmenttype) {
2365                 case 'upload' :
2366                 case 'uploadsingle' :
2367                     $data = file_prepare_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2368                     break;
2369                 default :
2370                     break;
2371         }
2373         $data = file_prepare_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2374         return parent::set_data($data);
2375     }
2377     public function get_data() {
2378         $data = parent::get_data();
2380         if (!empty($this->_customdata->submission->id)) {
2381             $itemid = $this->_customdata->submission->id;
2382         } else {
2383             $itemid = null; //TODO: this is wrong, itemid MUST be known when saving files!! (skodak)
2384         }
2386         if ($data) {
2387             $editoroptions = $this->get_editor_options();
2388             switch ($this->_customdata->assignment->assignmenttype) {
2389                 case 'upload' :
2390                 case 'uploadsingle' :
2391                     $data = file_postupdate_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2392                     break;
2393                 default :
2394                     break;
2395             }
2396             $data = file_postupdate_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2397         }
2398         return $data;
2399     }
2402 /// OTHER STANDARD FUNCTIONS ////////////////////////////////////////////////////////
2404 /**
2405  * Deletes an assignment instance
2406  *
2407  * This is done by calling the delete_instance() method of the assignment type class
2408  */
2409 function assignment_delete_instance($id){
2410     global $CFG, $DB;
2412     if (! $assignment = $DB->get_record('assignment', array('id'=>$id))) {
2413         return false;
2414     }
2416     // fall back to base class if plugin missing
2417     $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
2418     if (file_exists($classfile)) {
2419         require_once($classfile);
2420         $assignmentclass = "assignment_$assignment->assignmenttype";
2422     } else {
2423         debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead.");
2424         $assignmentclass = "assignment_base";
2425     }
2427     $ass = new $assignmentclass();
2428     return $ass->delete_instance($assignment);
2432 /**
2433  * Updates an assignment instance
2434  *
2435  * This is done by calling the update_instance() method of the assignment type class
2436  */
2437 function assignment_update_instance($assignment){
2438     global $CFG;
2440     $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2442     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2443     $assignmentclass = "assignment_$assignment->assignmenttype";
2444     $ass = new $assignmentclass();
2445     return $ass->update_instance($assignment);
2449 /**
2450  * Adds an assignment instance
2451  *
2452  * This is done by calling the add_instance() method of the assignment type class
2453  */
2454 function assignment_add_instance($assignment) {
2455     global $CFG;
2457     $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2459     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2460     $assignmentclass = "assignment_$assignment->assignmenttype";
2461     $ass = new $assignmentclass();
2462     return $ass->add_instance($assignment);
2466 /**
2467  * Returns an outline of a user interaction with an assignment
2468  *
2469  * This is done by calling the user_outline() method of the assignment type class
2470  */
2471 function assignment_user_outline($course, $user, $mod, $assignment) {
2472     global $CFG;
2474     require_once("$CFG->libdir/gradelib.php");
2475     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2476     $assignmentclass = "assignment_$assignment->assignmenttype";
2477     $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2478     $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2479     if (!empty($grades->items[0]->grades)) {
2480         return $ass->user_outline(reset($grades->items[0]->grades));
2481     } else {
2482         return null;
2483     }
2486 /**
2487  * Prints the complete info about a user's interaction with an assignment
2488  *
2489  * This is done by calling the user_complete() method of the assignment type class
2490  */
2491 function assignment_user_complete($course, $user, $mod, $assignment) {
2492     global $CFG;
2494     require_once("$CFG->libdir/gradelib.php");
2495     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2496     $assignmentclass = "assignment_$assignment->assignmenttype";
2497     $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2498     $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2499     if (empty($grades->items[0]->grades)) {
2500         $grade = false;
2501     } else {
2502         $grade = reset($grades->items[0]->grades);
2503     }
2504     return $ass->user_complete($user, $grade);
2507 /**
2508  * Function to be run periodically according to the moodle cron
2509  *
2510  * Finds all assignment notifications that have yet to be mailed out, and mails them
2511  */
2512 function assignment_cron () {
2513     global $CFG, $USER, $DB;
2515     /// first execute all crons in plugins
2516     if ($plugins = get_plugin_list('assignment')) {
2517         foreach ($plugins as $plugin=>$dir) {
2518             require_once("$dir/assignment.class.php");
2519             $assignmentclass = "assignment_$plugin";
2520             $ass = new $assignmentclass();
2521             $ass->cron();
2522         }
2523     }
2525     /// Notices older than 1 day will not be mailed.  This is to avoid the problem where
2526     /// cron has not been running for a long time, and then suddenly people are flooded
2527     /// with mail from the past few weeks or months
2529     $timenow   = time();
2530     $endtime   = $timenow - $CFG->maxeditingtime;
2531     $starttime = $endtime - 24 * 3600;   /// One day earlier
2533     if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) {
2535         $realuser = clone($USER);
2537         foreach ($submissions as $key => $submission) {
2538             $DB->set_field("assignment_submissions", "mailed", "1", array("id"=>$submission->id));
2539         }
2541         $timenow = time();
2543         foreach ($submissions as $submission) {
2545             echo "Processing assignment submission $submission->id\n";
2547             if (! $user = $DB->get_record("user", array("id"=>$submission->userid))) {
2548                 echo "Could not find user $user->id\n";
2549                 continue;
2550             }
2552             if (! $course = $DB->get_record("course", array("id"=>$submission->course))) {
2553                 echo "Could not find course $submission->course\n";
2554                 continue;
2555             }
2557             /// Override the language and timezone of the "current" user, so that
2558             /// mail is customised for the receiver.
2559             cron_setup_user($user, $course);
2561             if (!is_enrolled(get_context_instance(CONTEXT_COURSE, $submission->course), $user->id)) {
2562                 echo fullname($user)." not an active participant in " . format_string($course->shortname) . "\n";
2563                 continue;
2564             }
2566             if (! $teacher = $DB->get_record("user", array("id"=>$submission->teacher))) {
2567                 echo "Could not find teacher $submission->teacher\n";
2568                 continue;
2569             }
2571             if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment, $course->id)) {
2572                 echo "Could not find course module for assignment id $submission->assignment\n";
2573                 continue;
2574             }
2576             if (! $mod->visible) {    /// Hold mail notification for hidden assignments until later
2577                 continue;
2578             }
2580             $strassignments = get_string("modulenameplural", "assignment");
2581             $strassignment  = get_string("modulename", "assignment");
2583             $assignmentinfo = new stdClass();
2584             $assignmentinfo->teacher = fullname($teacher);
2585             $assignmentinfo->assignment = format_string($submission->name,true);
2586             $assignmentinfo->url = "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id";
2588             $postsubject = "$course->shortname: $strassignments: ".format_string($submission->name,true);
2589             $posttext  = "$course->shortname -> $strassignments -> ".format_string($submission->name,true)."\n";
2590             $posttext .= "---------------------------------------------------------------------\n";
2591             $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n";
2592             $posttext .= "---------------------------------------------------------------------\n";
2594             if ($user->mailformat == 1) {  // HTML
2595                 $posthtml = "<p><font face=\"sans-serif\">".
2596                 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> ->".
2597                 "<a href=\"$CFG->wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments</a> ->".
2598                 "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name,true)."</a></font></p>";
2599                 $posthtml .= "<hr /><font face=\"sans-serif\">";
2600                 $posthtml .= "<p>".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."</p>";
2601                 $posthtml .= "</font><hr />";
2602             } else {
2603                 $posthtml = "";
2604             }
2606             $eventdata = new stdClass();
2607             $eventdata->modulename       = 'assignment';
2608             $eventdata->userfrom         = $teacher;
2609             $eventdata->userto           = $user;
2610             $eventdata->subject          = $postsubject;
2611             $eventdata->fullmessage      = $posttext;
2612             $eventdata->fullmessageformat = FORMAT_PLAIN;
2613             $eventdata->fullmessagehtml  = $posthtml;
2614             $eventdata->smallmessage     = '';
2615             message_send($eventdata);
2616         }
2618         cron_setup_user();
2619     }
2621     return true;
2624 /**
2625  * Return grade for given user or all users.
2626  *
2627  * @param int $assignmentid id of assignment
2628  * @param int $userid optional user id, 0 means all users
2629  * @return array array of grades, false if none
2630  */
2631 function assignment_get_user_grades($assignment, $userid=0) {
2632     global $CFG, $DB;
2634     if ($userid) {
2635         $user = "AND u.id = :userid";
2636         $params = array('userid'=>$userid);
2637     } else {
2638         $user = "";
2639     }
2640     $params['aid'] = $assignment->id;
2642     $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat,
2643                    s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted
2644               FROM {user} u, {assignment_submissions} s
2645              WHERE u.id = s.userid AND s.assignment = :aid
2646                    $user";
2648     return $DB->get_records_sql($sql, $params);
2651 /**
2652  * Update activity grades
2653  *
2654  * @param object $assignment
2655  * @param int $userid specific user only, 0 means all
2656  */
2657 function assignment_update_grades($assignment, $userid=0, $nullifnone=true) {
2658     global $CFG, $DB;
2659     require_once($CFG->libdir.'/gradelib.php');
2661     if ($assignment->grade == 0) {
2662         assignment_grade_item_update($assignment);
2664     } else if ($grades = assignment_get_user_grades($assignment, $userid)) {
2665         foreach($grades as $k=>$v) {
2666             if ($v->rawgrade == -1) {
2667                 $grades[$k]->rawgrade = null;
2668             }
2669         }
2670         assignment_grade_item_update($assignment, $grades);
2672     } else {
2673         assignment_grade_item_update($assignment);
2674     }
2677 /**
2678  * Update all grades in gradebook.
2679  */
2680 function assignment_upgrade_grades() {
2681     global $DB;
2683     $sql = "SELECT COUNT('x')
2684               FROM {assignment} a, {course_modules} cm, {modules} m
2685              WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2686     $count = $DB->count_records_sql($sql);
2688     $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
2689               FROM {assignment} a, {course_modules} cm, {modules} m
2690              WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2691     if ($rs = $DB->get_recordset_sql($sql)) {
2692         // too much debug output
2693         $pbar = new progress_bar('assignmentupgradegrades', 500, true);
2694         $i=0;
2695         foreach ($rs as $assignment) {
2696             $i++;
2697             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
2698             assignment_update_grades($assignment);
2699             $pbar->update($i, $count, "Updating Assignment grades ($i/$count).");
2700         }
2701         $rs->close();
2702         upgrade_set_timeout(); // reset to default timeout
2703     }
2706 /**
2707  * Create grade item for given assignment
2708  *
2709  * @param object $assignment object with extra cmidnumber
2710  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
2711  * @return int 0 if ok, error code otherwise
2712  */
2713 function assignment_grade_item_update($assignment, $grades=NULL) {
2714     global $CFG;
2715     require_once($CFG->libdir.'/gradelib.php');
2717     if (!isset($assignment->courseid)) {
2718         $assignment->courseid = $assignment->course;
2719     }
2721     $params = array('itemname'=>$assignment->name, 'idnumber'=>$assignment->cmidnumber);
2723     if ($assignment->grade > 0) {
2724         $params['gradetype'] = GRADE_TYPE_VALUE;
2725         $params['grademax']  = $assignment->grade;
2726         $params['grademin']  = 0;
2728     } else if ($assignment->grade < 0) {
2729         $params['gradetype'] = GRADE_TYPE_SCALE;
2730         $params['scaleid']   = -$assignment->grade;
2732     } else {
2733         $params['gradetype'] = GRADE_TYPE_TEXT; // allow text comments only
2734     }
2736     if ($grades  === 'reset') {
2737         $params['reset'] = true;
2738         $grades = NULL;
2739     }
2741     return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, $grades, $params);
2744 /**
2745  * Delete grade item for given assignment
2746  *
2747  * @param object $assignment object
2748  * @return object assignment
2749  */
2750 function assignment_grade_item_delete($assignment) {
2751     global $CFG;
2752     require_once($CFG->libdir.'/gradelib.php');
2754     if (!isset($assignment->courseid)) {
2755         $assignment->courseid = $assignment->course;
2756     }
2758     return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, NULL, array('deleted'=>1));
2761 /**
2762  * Returns the users with data in one assignment (students and teachers)
2763  *
2764  * @param $assignmentid int
2765  * @return array of user objects
2766  */
2767 function assignment_get_participants($assignmentid) {
2768     global $CFG, $DB;
2770     //Get students
2771     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2772                                         FROM {user} u,
2773                                              {assignment_submissions} a
2774                                        WHERE a.assignment = ? and
2775                                              u.id = a.userid", array($assignmentid));
2776     //Get teachers
2777     $teachers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2778                                         FROM {user} u,
2779                                              {assignment_submissions} a
2780                                        WHERE a.assignment = ? and
2781                                              u.id = a.teacher", array($assignmentid));
2783     //Add teachers to students
2784     if ($teachers) {
2785         foreach ($teachers as $teacher) {
2786             $students[$teacher->id] = $teacher;
2787         }
2788     }
2789     //Return students array (it contains an array of unique users)
2790     return ($students);
2793 /**
2794  * Serves assignment submissions and other files.
2795  *
2796  * @param object $course
2797  * @param object $cm
2798  * @param object $context
2799  * @param string $filearea
2800  * @param array $args
2801  * @param bool $forcedownload
2802  * @return bool false if file not found, does not return if found - just send the file
2803  */
2804 function assignment_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
2805     global $CFG, $DB;
2807     if ($context->contextlevel != CONTEXT_MODULE) {
2808         return false;
2809     }
2811     require_login($course, false, $cm);
2813     if (!$assignment = $DB->get_record('assignment', array('id'=>$cm->instance))) {
2814         return false;
2815     }
2817     require_once($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
2818     $assignmentclass = 'assignment_'.$assignment->assignmenttype;
2819     $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm, $course);
2821     return $assignmentinstance->send_file($filearea, $args);
2823 /**
2824  * Checks if a scale is being used by an assignment
2825  *
2826  * This is used by the backup code to decide whether to back up a scale
2827  * @param $assignmentid int
2828  * @param $scaleid int
2829  * @return boolean True if the scale is used by the assignment
2830  */
2831 function assignment_scale_used($assignmentid, $scaleid) {
2832     global $DB;
2834     $return = false;
2836     $rec = $DB->get_record('assignment', array('id'=>$assignmentid,'grade'=>-$scaleid));
2838     if (!empty($rec) && !empty($scaleid)) {
2839         $return = true;
2840     }
2842     return $return;
2845 /**
2846  * Checks if scale is being used by any instance of assignment
2847  *
2848  * This is used to find out if scale used anywhere
2849  * @param $scaleid int
2850  * @return boolean True if the scale is used by any assignment
2851  */
2852 function assignment_scale_used_anywhere($scaleid) {
2853     global $DB;
2855     if ($scaleid and $DB->record_exists('assignment', array('grade'=>-$scaleid))) {
2856         return true;
2857     } else {
2858         return false;
2859     }
2862 /**
2863  * Make sure up-to-date events are created for all assignment instances
2864  *
2865  * This standard function will check all instances of this module
2866  * and make sure there are up-to-date events created for each of them.
2867  * If courseid = 0, then every assignment event in the site is checked, else
2868  * only assignment events belonging to the course specified are checked.
2869  * This function is used, in its new format, by restore_refresh_events()
2870  *
2871  * @param $courseid int optional If zero then all assignments for all courses are covered
2872  * @return boolean Always returns true
2873  */
2874 function assignment_refresh_events($courseid = 0) {
2875     global $DB;
2877     if ($courseid == 0) {
2878         if (! $assignments = $DB->get_records("assignment")) {
2879             return true;
2880         }
2881     } else {
2882         if (! $assignments = $DB->get_records("assignment", array("course"=>$courseid))) {
2883             return true;
2884         }
2885     }
2886     $moduleid = $DB->get_field('modules', 'id', array('name'=>'assignment'));
2888     foreach ($assignments as $assignment) {
2889         $cm = get_coursemodule_from_id('assignment', $assignment->id);
2890         $event = new stdClass();
2891         $event->name        = $assignment->name;
2892         $event->description = format_module_intro('assignment', $assignment, $cm->id);
2893         $event->timestart   = $assignment->timedue;
2895         if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
2896             update_event($event);
2898         } else {
2899             $event->courseid    = $assignment->course;
2900             $event->groupid     = 0;
2901             $event->userid      = 0;
2902             $event->modulename  = 'assignment';
2903             $event->instance    = $assignment->id;
2904             $event->eventtype   = 'due';
2905             $event->timeduration = 0;
2906             $event->visible     = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$assignment->id));
2907             add_event($event);
2908         }
2910     }
2911     return true;
2914 /**
2915  * Print recent activity from all assignments in a given course
2916  *
2917  * This is used by the recent activity block
2918  */
2919 function assignment_print_recent_activity($course, $viewfullnames, $timestart) {
2920     global $CFG, $USER, $DB, $OUTPUT;
2922     // do not use log table if possible, it may be huge
2924     if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified, cm.id AS cmid, asb.userid,
2925                                                      u.firstname, u.lastname, u.email, u.picture
2926                                                 FROM {assignment_submissions} asb
2927                                                      JOIN {assignment} a      ON a.id = asb.assignment
2928                                                      JOIN {course_modules} cm ON cm.instance = a.id
2929                                                      JOIN {modules} md        ON md.id = cm.module
2930                                                      JOIN {user} u            ON u.id = asb.userid
2931                                                WHERE asb.timemodified > ? AND
2932                                                      a.course = ? AND
2933                                                      md.name = 'assignment'
2934                                             ORDER BY asb.timemodified ASC", array($timestart, $course->id))) {
2935          return false;
2936     }
2938     $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups
2939     $show    = array();
2940     $grader  = array();
2942     foreach($submissions as $submission) {
2943         if (!array_key_exists($submission->cmid, $modinfo->cms)) {
2944             continue;
2945         }
2946         $cm = $modinfo->cms[$submission->cmid];
2947         if (!$cm->uservisible) {
2948             continue;
2949         }
2950         if ($submission->userid == $USER->id) {
2951             $show[] = $submission;
2952             continue;
2953         }
2955         // the act of sumbitting of assignment may be considered private - only graders will see it if specified
2956         if (empty($CFG->assignment_showrecentsubmissions)) {
2957             if (!array_key_exists($cm->id, $grader)) {
2958                 $grader[$cm->id] = has_capability('moodle/grade:viewall', get_context_instance(CONTEXT_MODULE, $cm->id));
2959             }
2960             if (!$grader[$cm->id]) {
2961                 continue;
2962             }
2963         }
2965         $groupmode = groups_get_activity_groupmode($cm, $course);
2967         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2968             if (isguestuser()) {
2969                 // shortcut - guest user does not belong into any group
2970                 continue;
2971             }
2973             if (is_null($modinfo->groups)) {
2974                 $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
2975             }
2977             // this will be slow - show only users that share group with me in this cm
2978             if (empty($modinfo->groups[$cm->id])) {
2979                 continue;
2980             }
2981             $usersgroups =  groups_get_all_groups($course->id, $submission->userid, $cm->groupingid);
2982             if (is_array($usersgroups)) {
2983                 $usersgroups = array_keys($usersgroups);
2984                 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
2985                 if (empty($intersect)) {
2986                     continue;
2987                 }
2988             }
2989         }
2990         $show[] = $submission;
2991     }
2993     if (empty($show)) {
2994         return false;
2995     }
2997     echo $OUTPUT->heading(get_string('newsubmissions', 'assignment').':', 3);
2999     foreach ($show as $submission) {
3000         $cm = $modinfo->cms[$submission->cmid];
3001         $link = $CFG->wwwroot.'/mod/assignment/view.php?id='.$cm->id;
3002         print_recent_activity_note($submission->timemodified, $submission, $cm->name, $link, false, $viewfullnames);
3003     }
3005     return true;
3009 /**
3010  * Returns all assignments since a given time in specified forum.
3011  */
3012 function assignment_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)  {
3013     global $CFG, $COURSE, $USER, $DB;
3015     if ($COURSE->id == $courseid) {
3016         $course = $COURSE;
3017     } else {
3018         $course = $DB->get_record('course', array('id'=>$courseid));
3019     }
3021     $modinfo =& get_fast_modinfo($course);
3023     $cm = $modinfo->cms[$cmid];
3025     $params = array();
3026     if ($userid) {
3027         $userselect = "AND u.id = :userid";
3028         $params['userid'] = $userid;
3029     } else {
3030         $userselect = "";
3031     }
3033     if ($groupid) {
3034         $groupselect = "AND gm.groupid = :groupid";
3035         $groupjoin   = "JOIN {groups_members} gm ON  gm.userid=u.id";
3036         $params['groupid'] = $groupid;
3037     } else {
3038         $groupselect = "";
3039         $groupjoin   = "";
3040     }
3042     $params['cminstance'] = $cm->instance;
3043     $params['timestart'] = $timestart;
3045     $userfields = user_picture::fields('u', null, 'userid');
3047     if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified,
3048                                                      $userfields
3049                                                 FROM {assignment_submissions} asb
3050                                                 JOIN {assignment} a      ON a.id = asb.assignment
3051                                                 JOIN {user} u            ON u.id = asb.userid
3052                                           $groupjoin
3053                                                WHERE asb.timemodified > :timestart AND a.id = :cminstance
3054                                                      $userselect $groupselect
3055                                             ORDER BY asb.timemodified ASC", $params)) {
3056          return;
3057     }
3059     $groupmode       = groups_get_activity_groupmode($cm, $course);
3060     $cm_context      = get_context_instance(CONTEXT_MODULE, $cm->id);
3061     $grader          = has_capability('moodle/grade:viewall', $cm_context);
3062     $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
3063     $viewfullnames   = has_capability('moodle/site:viewfullnames', $cm_context);
3065     if (is_null($modinfo->groups)) {
3066         $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
3067     }
3069     $show = array();
3071     foreach($submissions as $submission) {
3072         if ($submission->userid == $USER->id) {
3073             $show[] = $submission;
3074             continue;
3075         }
3076         // the act of submitting of assignment may be considered private - only graders will see it if specified
3077         if (empty($CFG->assignment_showrecentsubmissions)) {
3078             if (!$grader) {
3079                 continue;
3080             }
3081         }
3083         if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
3084             if (isguestuser()) {
3085                 // shortcut - guest user does not belong into any group
3086                 continue;
3087             }
3089             // this will be slow - show only users that share group with me in this cm
3090             if (empty($modinfo->groups[$cm->id])) {
3091                 continue;
3092             }
3093             $usersgroups = groups_get_all_groups($course->id, $cm->userid, $cm->groupingid);
3094             if (is_array($usersgroups)) {
3095                 $usersgroups = array_keys($usersgroups);
3096                 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
3097                 if (empty($intersect)) {
3098                     continue;
3099                 }
3100             }
3101         }
3102         $show[] = $submission;
3103     }
3105     if (empty($show)) {
3106         return;
3107     }
3109     if ($grader) {
3110         require_once($CFG->libdir.'/gradelib.php');
3111         $userids = array();
3112         foreach ($show as $id=>$submission) {
3113             $userids[] = $submission->userid;
3115         }
3116         $grades = grade_get_grades($courseid, 'mod', 'assignment', $cm->instance, $userids);
3117     }
3119     $aname = format_string($cm->name,true);
3120     foreach ($show as $submission) {
3121         $tmpactivity = new stdClass();
3123         $tmpactivity->type         = 'assignment';
3124         $tmpactivity->cmid         = $cm->id;
3125         $tmpactivity->name         = $aname;
3126         $tmpactivity->sectionnum   = $cm->sectionnum;
3127         $tmpactivity->timestamp    = $submission->timemodified;
3129         if ($grader) {
3130             $tmpactivity->grade = $grades->items[0]->grades[$submission->userid]->str_long_grade;
3131         }
3133         $userfields = explode(',', user_picture::fields());
3134         foreach ($userfields as $userfield) {
3135             if ($userfield == 'id') {
3136                 $tmpactivity->user->{$userfield} = $submission->userid; // aliased in SQL above
3137             } else {
3138                 $tmpactivity->user->{$userfield} = $submission->{$userfield};
3139             }
3140         }
3141         $tmpactivity->user->fullname = fullname($submission, $viewfullnames);
3143         $activities[$index++] = $tmpactivity;
3144     }
3146     return;
3149 /**
3150  * Print recent activity from all assignments in a given course
3151  *
3152  * This is used by course/recent.php
3153  */
3154 function assignment_print_recent_mod_activity($activity, $courseid, $detail, $modnames)  {
3155     global $CFG, $OUTPUT;
3157     echo '<table border="0" cellpadding="3" cellspacing="0" class="assignment-recent">';
3159     echo "<tr><td class=\"userpicture\" valign=\"top\">";
3160     echo $OUTPUT->user_picture($activity->user);
3161     echo "</td><td>";
3163     if ($detail) {
3164         $modname = $modnames[$activity->type];
3165         echo '<div class="title">';
3166         echo "<img src=\"" . $OUTPUT->pix_url('icon', 'assignment') . "\" ".
3167              "class=\"icon\" alt=\"$modname\">";
3168         echo "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id={$activity->cmid}\">{$activity->name}</a>";
3169         echo '</div>';
3170     }
3172     if (isset($activity->grade)) {
3173         echo '<div class="grade">';
3174         echo get_string('grade').': ';
3175         echo $activity->grade;
3176         echo '</div>';
3177     }
3179     echo '<div class="user">';
3180     echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&amp;course=$courseid\">"
3181          ."{$activity->user->fullname}</a>  - ".userdate($activity->timestamp);
3182     echo '</div>';
3184     echo "</td></tr></table>";
3187 /// GENERIC SQL FUNCTIONS
3189 /**
3190  * Fetch info from logs
3191  *
3192  * @param $log object with properties ->info (the assignment id) and ->userid
3193  * @return array with assignment name and user firstname and lastname
3194  */
3195 function assignment_log_info($log) {
3196     global $CFG, $DB;
3198     return $DB->get_record_sql("SELECT a.name, u.firstname, u.lastname
3199                                   FROM {assignment} a, {user} u
3200                                  WHERE a.id = ? AND u.id = ?", array($log->info, $log->userid));
3203 /**
3204  * Return list of marked submissions that have not been mailed out for currently enrolled students
3205  *
3206  * @return array
3207  */
3208 function assignment_get_unmailed_submissions($starttime, $endtime) {
3209     global $CFG, $DB;
3211     return $DB->get_records_sql("SELECT s.*, a.course, a.name
3212                                    FROM {assignment_submissions} s,
3213                                         {assignment} a
3214                                   WHERE s.mailed = 0
3215                                         AND s.timemarked <= ?
3216                                         AND s.timemarked >= ?
3217                                         AND s.assignment = a.id", array($endtime, $starttime));
3220 /**
3221  * Counts all real assignment submissions by ENROLLED students (not empty ones)
3222  *
3223  * There are also assignment type methods count_real_submissions() which in the default
3224  * implementation simply call this function.
3225  * @param $groupid int optional If nonzero then count is restricted to this group
3226  * @return int The number of submissions
3227  */
3228 function assignment_count_real_submissions($cm, $groupid=0) {
3229     global $CFG, $DB;
3231     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
3233     // this is all the users with this capability set, in this context or higher
3234     if ($users = get_enrolled_users($context, 'mod/assignment:view', $groupid, 'u.id')) {
3235         $users = array_keys($users);
3236     }
3238     // if groupmembersonly used, remove users who are not in any group
3239     if ($users and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3240         if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
3241             $users = array_intersect($users, array_keys($groupingusers));
3242         }
3243     }
3245     if (empty($users)) {
3246         return 0;
3247     }
3249     $userlists = implode(',', $users);
3251     return $DB->count_records_sql("SELECT COUNT('x')
3252                                      FROM {assignment_submissions}
3253                                     WHERE assignment = ? AND
3254                                           timemodified > 0 AND
3255                                           userid IN ($userlists)", array($cm->instance));
3259 /**
3260  * Return all assignment submissions by ENROLLED students (even empty)
3261  *
3262  * There are also assignment type methods get_submissions() wich in the default
3263  * implementation simply call this function.
3264  * @param $sort string optional field names for the ORDER BY in the sql query
3265  * @param $dir string optional specifying the sort direction, defaults to DESC
3266  * @return array The submission objects indexed by id
3267  */
3268 function assignment_get_all_submissions($assignment, $sort="", $dir="DESC") {
3269 /// Return all assignment submissions by ENROLLED students (even empty)
3270     global $CFG, $DB;
3272     if ($sort == "lastname" or $sort == "firstname") {
3273         $sort = "u.$sort $dir";
3274     } else if (empty($sort)) {
3275         $sort = "a.timemodified DESC";
3276     } else {
3277         $sort = "a.$sort $dir";
3278     }
3280     /* not sure this is needed at all since assignment already has a course define, so this join?
3281     $select = "s.course = '$assignment->course' AND";
3282     if ($assignment->course == SITEID) {
3283         $select = '';
3284     }*/
3286     return $DB->get_records_sql("SELECT a.*
3287                                    FROM {assignment_submissions} a, {user} u
3288                                   WHERE u.id = a.userid
3289                                         AND a.assignment = ?
3290                                ORDER BY $sort", array($assignment->id));
3294 /**
3295  * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
3296  * for the course (see resource).
3297  *
3298  * Given a course_module object, this function returns any "extra" information that may be needed
3299  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
3300  *
3301  * @param $coursemodule object The coursemodule object (record).
3302  * @return object An object on information that the courses will know about (most noticeably, an icon).
3303  *
3304  */
3305 function assignment_get_coursemodule_info($coursemodule) {
3306     global $CFG, $DB;
3308     if (! $assignment = $DB->get_record('assignment', array('id'=>$coursemodule->instance), 'id, assignmenttype, name')) {
3309         return false;
3310     }
3312     $libfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
3314     if (file_exists($libfile)) {
3315         require_once($libfile);
3316         $assignmentclass = "assignment_$assignment->assignmenttype";
3317         $ass = new $assignmentclass('staticonly');
3318         if ($result = $ass->get_coursemodule_info($coursemodule)) {
3319             return $result;
3320         } else {
3321             $info = new stdClass();
3322             $info->name = $assignment->name;
3323             return $info;
3324         }
3326     } else {
3327         debugging('Incorrect assignment type: '.$assignment->assignmenttype);
3328         return false;
3329     }
3334 /// OTHER GENERAL FUNCTIONS FOR ASSIGNMENTS  ///////////////////////////////////////
3336 /**
3337  * Returns an array of installed assignment types indexed and sorted by name
3338  *
3339  * @return array The index is the name of the assignment type, the value its full name from the language strings
3340  */
3341 function assignment_types() {
3342     $types = array();
3343     $names = get_plugin_list('assignment');
3344     foreach ($names as $name=>$dir) {
3345         $types[$name] = get_string('type'.$name, 'assignment');
3347         // ugly hack to support pluggable assignment type titles..
3348         if ($types[$name] == '[[type'.$name.']]') {
3349             $types[$name] = get_string('type'.$name, 'assignment_'.$name);
3350         }
3351     }
3352     asort($types);
3353     return $types;
3356 function assignment_print_overview($courses, &$htmlarray) {
3357     global $USER, $CFG, $DB;
3359     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
3360         return array();
3361     }
3363     if (!$assignments = get_all_instances_in_courses('assignment',$courses)) {
3364         return;
3365     }
3367     $assignmentids = array();
3369     // Do assignment_base::isopen() here without loading the whole thing for speed
3370     foreach ($assignments as $key => $assignment) {
3371         $time = time();
3372         if ($assignment->timedue) {
3373             if ($assignment->preventlate) {
3374                 $isopen = ($assignment->timeavailable <= $time && $time <= $assignment->timedue);
3375             } else {
3376                 $isopen = ($assignment->timeavailable <= $time);
3377             }
3378         }
3379         if (empty($isopen) || empty($assignment->timedue)) {
3380             unset($assignments[$key]);
3381         } else {
3382             $assignmentids[] = $assignment->id;
3383         }
3384     }
3386     if (empty($assignmentids)){
3387         // no assignments to look at - we're done
3388         return true;
3389     }
3391     $strduedate = get_string('duedate', 'assignment');
3392     $strduedateno = get_string('duedateno', 'assignment');
3393     $strgraded = get_string('graded', 'assignment');
3394     $strnotgradedyet = get_string('notgradedyet', 'assignment');
3395     $strnotsubmittedyet = get_string('notsubmittedyet', 'assignment');
3396     $strsubmitted = get_string('submitted', 'assignment');
3397     $strassignment = get_string('modulename', 'assignment');
3398     $strreviewed = get_string('reviewed','assignment');
3401     // NOTE: we do all possible database work here *outside* of the loop to ensure this scales
3402     //
3403     list($sqlassignmentids, $assignmentidparams) = $DB->get_in_or_equal($assignmentids);
3405     // build up and array of unmarked submissions indexed by assignment id/ userid
3406     // for use where the user has grading rights on assignment
3407     $rs = $DB->get_recordset_sql("SELECT id, assignment, userid
3408                             FROM {assignment_submissions}
3409                             WHERE teacher = 0 AND timemarked = 0
3410                             AND assignment $sqlassignmentids", $assignmentidparams);
3412     $unmarkedsubmissions = array();
3413     foreach ($rs as $rd) {
3414         $unmarkedsubmissions[$rd->assignment][$rd->userid] = $rd->id;
3415     }
3416     $rs->close();
3419     // get all user submissions, indexed by assignment id
3420     $mysubmissions = $DB->get_records_sql("SELECT assignment, timemarked, teacher, grade
3421                                       FROM {assignment_submissions}
3422                                       WHERE userid = ? AND
3423                                       assignment $sqlassignmentids", array_merge(array($USER->id), $assignmentidparams));
3425     foreach ($assignments as $assignment) {
3426         $str = '<div class="assignment overview"><div class="name">'.$strassignment. ': '.
3427                '<a '.($assignment->visible ? '':' class="dimmed"').
3428                'title="'.$strassignment.'" href="'.$CFG->wwwroot.
3429                '/mod/assignment/view.php?id='.$assignment->coursemodule.'">'.
3430                $assignment->name.'</a></div>';
3431         if ($assignment->timedue) {
3432             $str .= '<div class="info">'.$strduedate.': '.userdate($assignment->timedue).'</div>';
3433         } else {
3434             $str .= '<div class="info">'.$strduedateno.'</div>';
3435         }
3436         $context = get_context_instance(CONTEXT_MODULE, $assignment->coursemodule);
3437         if (has_capability('mod/assignment:grade', $context)) {
3439             // count how many people can submit
3440             $submissions = 0; // init
3441             if ($students = get_enrolled_users($context, 'mod/assignment:view', 0, 'u.id')) {
3442                 foreach ($students as $student) {
3443                     if (isset($unmarkedsubmissions[$assignment->id][$student->id])) {
3444                         $submissions++;
3445                     }
3446                 }
3447             }
3449             if ($submissions) {
3450                 $link = new moodle_url('/mod/assignment/submissions.php', array('id'=>$assignment->coursemodule));
3451                 $str .= '<div class="details"><a href="'.$link.'">'.get_string('submissionsnotgraded', 'assignment', $submissions).'</a></div>';
3452             }
3453         } else {
3454             $str .= '<div class="details">';
3455             if (isset($mysubmissions[$assignment->id])) {
3457                 $submission = $mysubmissions[$assignment->id];
3459                 if ($submission->teacher == 0 && $submission->timemarked == 0) {
3460                     $str .= $strsubmitted . ', ' . $strnotgradedyet;
3461                 } else if ($submission->grade <= 0) {
3462                     $str .= $strsubmitted . ', ' . $strreviewed;
3463                 } else {
3464                     $str .= $strsubmitted . ', ' . $strgraded;
3465                 }
3466             } else {
3467                 $str .= $strnotsubmittedyet . ' ' . assignment_display_lateness(time(), $assignment->timedue);
3468             }
3469             $str .= '</div>';
3470         }
3471         $str .= '</div>';
3472         if (empty($htmlarray[$assignment->course]['assignment'])) {
3473             $htmlarray[$assignment->course]['assignment'] = $str;
3474         } else {
3475             $htmlarray[$assignment->course]['assignment'] .= $str;
3476         }
3477     }
3480 function assignment_display_lateness($timesubmitted, $timedue) {
3481     if (!$timedue) {
3482         return '';
3483     }
3484     $time = $timedue - $timesubmitted;
3485     if ($time < 0) {
3486         $timetext = get_string('late', 'assignment', format_time($time));
3487         return ' (<span class="late">'.$timetext.'</span>)';
3488     } else {
3489         $timetext = get_string('early', 'assignment', format_time($time));
3490         return ' (<span class="early">'.$timetext.'</span>)';
3491     }
3494 function assignment_get_view_actions() {
3495     return array('view');
3498 function assignment_get_post_actions() {
3499     return array('upload');
3502 function assignment_get_types() {
3503     global $CFG;
3504     $types = array();
3506     $type = new stdClass();
3507     $type->modclass = MOD_CLASS_ACTIVITY;
3508     $type->type = "assignment_group_start";
3509     $type->typestr = '--'.get_string('modulenameplural', 'assignment');
3510     $types[] = $type;
3512     $standardassignments = array('upload','online','uploadsingle','offline');
3513     foreach ($standardassignments as $assignmenttype) {
3514         $type = new stdClass();
3515         $type->modclass = MOD_CLASS_ACTIVITY;
3516         $type->type = "assignment&amp;type=$assignmenttype";
3517         $type->typestr = get_string("type$assignmenttype", 'assignment');
3518         $types[] = $type;
3519     }
3521     /// Drop-in extra assignment types
3522     $assignmenttypes = get_list_of_plugins('mod/assignment/type');
3523     foreach ($assignmenttypes as $assignmenttype) {
3524         if (!empty($CFG->{'assignment_hide_'.$assignmenttype})) {  // Not wanted
3525             continue;
3526         }
3527         if (!in_array($assignmenttype, $standardassignments)) {
3528             $type = new stdClass();
3529             $type->modclass = MOD_CLASS_ACTIVITY;
3530             $type->type = "assignment&amp;type=$assignmenttype";
3531             $type->typestr = get_string("type$assignmenttype", 'assignment_'.$assignmenttype);
3532             $types[] = $type;
3533         }
3534     }
3536     $type = new stdClass();
3537     $type->modclass = MOD_CLASS_ACTIVITY;
3538     $type->type = "assignment_group_end";
3539     $type->typestr = '--';
3540     $types[] = $type;
3542     return $types;
3545 /**
3546  * Removes all grades from gradebook
3547  * @param int $courseid
3548  * @param string optional type
3549  */
3550 function assignment_reset_gradebook($courseid, $type='') {
3551     global $CFG, $DB;
3553     $params = array('courseid'=>$courseid);
3554     if ($type) {
3555         $type = "AND a.assignmenttype= :type";
3556         $params['type'] = $type;
3557     }
3559     $sql = "SELECT a.*, cm.idnumber as cmidnumber, a.course as courseid
3560               FROM {assignment} a, {course_modules} cm, {modules} m
3561              WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id AND a.course=:courseid $type";
3563     if ($assignments = $DB->get_records_sql($sql, $params)) {
3564         foreach ($assignments as $assignment) {
3565             assignment_grade_item_update($assignment, 'reset');
3566         }
3567     }
3570 /**
3571  * This function is used by the reset_course_userdata function in moodlelib.
3572  * This function will remove all posts from the specified assignment
3573  * and clean up any related data.
3574  * @param $data the data submitted from the reset course.
3575  * @return array status array
3576  */
3577 function assignment_reset_userdata($data) {
3578     global $CFG;
3580     $status = array();
3581     foreach (get_plugin_list('assignment') as $type=>$dir) {
3582         require_once("$dir/assignment.class.php");
3583         $assignmentclass = "assignment_$type";
3584         $ass = new $assignmentclass();
3585         $status = array_merge($status, $ass->reset_userdata($data));
3586     }
3588     return $status;
3591 /**
3592  * Implementation of the function for printing the form elements that control
3593  * whether the course reset functionality affects the assignment.
3594  * @param $mform form passed by reference
3595  */
3596 function assignment_reset_course_form_definition(&$mform) {
3597     $mform->addElement('header', 'assignmentheader', get_string('modulenameplural', 'assignment'));
3598     $mform->addElement('advcheckbox', 'reset_assignment_submissions', get_string('deleteallsubmissions','assignment'));
3601 /**
3602  * Course reset form defaults.
3603  */
3604 function assignment_reset_course_form_defaults($course) {
3605     return array('reset_assignment_submissions'=>1);
3608 /**
3609  * Returns all other caps used in module
3610  */
3611 function assignment_get_extra_capabilities() {
3612     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
3615 /**
3616  * @param string $feature FEATURE_xx constant for requested feature
3617  * @return mixed True if module supports feature, null if doesn't know
3618  */
3619 function assignment_supports($feature) {
3620     switch($feature) {
3621         case FEATURE_GROUPS:                  return true;
3622         case FEATURE_GROUPINGS:               return true;
3623         case FEATURE_GROUPMEMBERSONLY:        return true;
3624         case FEATURE_MOD_INTRO:               return true;
3625         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
3626         case FEATURE_GRADE_HAS_GRADE:         return true;
3627         case FEATURE_GRADE_OUTCOMES:          return true;
3628         case FEATURE_GRADE_HAS_GRADE:         return true;
3629         case FEATURE_BACKUP_MOODLE2:          return true;
3631         default: return null;
3632     }
3635 /**
3636  * Adds module specific settings to the settings block
3637  *
3638  * @param settings_navigation $settings The settings navigation object
3639  * @param navigation_node $assignmentnode The node to add module settings to
3640  */
3641 function assignment_extend_settings_navigation(settings_navigation $settings, navigation_node $assignmentnode) {
3642     global $PAGE, $DB, $USER, $CFG;
3644     $assignmentrow = $DB->get_record("assignment", array("id" => $PAGE->cm->instance));
3645     require_once "$CFG->dirroot/mod/assignment/type/$assignmentrow->assignmenttype/assignment.class.php";
3647     $assignmentclass = 'assignment_'.$assignmentrow->assignmenttype;
3648     $assignmentinstance = new $assignmentclass($PAGE->cm->id, $assignmentrow, $PAGE->cm, $PAGE->course);
3650     $allgroups = false;
3652     // Add assignment submission information
3653     if (has_capability('mod/assignment:grade', $PAGE->cm->context)) {
3654         if ($allgroups && has_capability('moodle/site:accessallgroups', $PAGE->cm->context)) {
3655             $group = 0;
3656         } else {
3657             $group = groups_get_activity_group($PAGE->cm);
3658         }
3659         $link = new moodle_url('/mod/assignment/submissions.php', array('id'=>$PAGE->cm->id));
3660         if ($count = $assignmentinstance->count_real_submissions($group)) {
3661             $string = get_string('viewsubmissions', 'assignment', $count);
3662         } else {
3663             $string = get_string('noattempts', 'assignment');
3664         }
3665         $assignmentnode->add($string, $link, navigation_node::TYPE_SETTING);
3666     }
3668     if (is_object($assignmentinstance) && method_exists($assignmentinstance, 'extend_settings_navigation')) {
3669         $assignmentinstance->extend_settings_navigation($assignmentnode);
3670     }
3673 /**
3674  * generate zip file from array of given files
3675  * @param array $filesforzipping - array of files to pass into archive_to_pathname
3676  * @return path of temp file - note this returned file does not have a .zip extension - it is a temp file.
3677  */
3678 function assignment_pack_files($filesforzipping) {
3679         global $CFG;
3680         //create path for new zip file.
3681         $tempzip = tempnam($CFG->dataroot.'/temp/', 'assignment_');
3682         //zip files
3683         $zipper = new zip_packer();
3684         if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
3685             return $tempzip;
3686         }
3687         return false;
3690 /**
3691  * Lists all file areas current user may browse
3692  *
3693  * @param object $course
3694  * @param object $cm
3695  * @param object $context
3696  * @return array
3697  */
3698 function assignment_get_file_areas($course, $cm, $context) {
3699     $areas = array();
3700     if (has_capability('moodle/course:managefiles', $context)) {
3701         $areas['submission'] = get_string('assignmentsubmission', 'assignment');
3702     }
3703     return $areas;