MDL-27638 Removed buggy status line from query as it is being calculated in php anyway
[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->cm->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             $sql = 'FROM {user} u '.
976                    'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
977                    AND s.assignment = '.$this->assignment->id.' '.
978                    'WHERE '.$where.'u.id IN ('.implode(',', $users).') ';
980             if ($sort = flexible_table::get_sort_for_table('mod-assignment-submissions')) {
981                 $sort = 'ORDER BY '.$sort.' ';
982             }
983             $auser = $DB->get_records_sql($select.$sql.$sort, null, $offset, 2);
985             if (is_array($auser) && count($auser)>1) {
986                 $nextuser = next($auser);
987             /// Calculate user status
988                 $nextuser->status = ($nextuser->timemarked > 0) && ($nextuser->timemarked >= $nextuser->timemodified);
989                 $nextid = $nextuser->id;
990             }
991         }
993         if ($submission->teacher) {
994             $teacher = $DB->get_record('user', array('id'=>$submission->teacher));
995         } else {
996             global $USER;
997             $teacher = $USER;
998         }
1000         $this->preprocess_submission($submission);
1002         $mformdata = new stdClass();
1003         $mformdata->context = $this->context;
1004         $mformdata->maxbytes = $this->course->maxbytes;
1005         $mformdata->courseid = $this->course->id;
1006         $mformdata->teacher = $teacher;
1007         $mformdata->assignment = $assignment;
1008         $mformdata->submission = $submission;
1009         $mformdata->lateness = $this->display_lateness($submission->timemodified);
1010         $mformdata->auser = $auser;
1011         $mformdata->user = $user;
1012         $mformdata->offset = $offset;
1013         $mformdata->userid = $userid;
1014         $mformdata->cm = $this->cm;
1015         $mformdata->grading_info = $grading_info;
1016         $mformdata->enableoutcomes = $CFG->enableoutcomes;
1017         $mformdata->grade = $this->assignment->grade;
1018         $mformdata->gradingdisabled = $gradingdisabled;
1019         $mformdata->nextid = $nextid;
1020         $mformdata->submissioncomment= $submission->submissioncomment;
1021         $mformdata->submissioncommentformat= FORMAT_HTML;
1022         $mformdata->submission_content= $this->print_user_files($user->id,true);
1023         $mformdata->filter = $filter;
1024          if ($assignment->assignmenttype == 'upload') {
1025             $mformdata->fileui_options = array('subdirs'=>1, 'maxbytes'=>$assignment->maxbytes, 'maxfiles'=>$assignment->var1, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL);
1026         } elseif ($assignment->assignmenttype == 'uploadsingle') {
1027             $mformdata->fileui_options = array('subdirs'=>0, 'maxbytes'=>$CFG->userquota, 'maxfiles'=>1, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL);
1028         }
1030         $submitform = new mod_assignment_grading_form( null, $mformdata );
1032          if (!$display) {
1033             $ret_data = new stdClass();
1034             $ret_data->mform = $submitform;
1035             $ret_data->fileui_options = $mformdata->fileui_options;
1036             return $ret_data;
1037         }
1039         if ($submitform->is_cancelled()) {
1040             redirect('submissions.php?id='.$this->cm->id);
1041         }
1043         $submitform->set_data($mformdata);
1045         $PAGE->set_title($this->course->fullname . ': ' .get_string('feedback', 'assignment').' - '.fullname($user, true));
1046         $PAGE->set_heading($this->course->fullname);
1047         $PAGE->navbar->add(get_string('submissions', 'assignment'), new moodle_url('/mod/assignment/submissions.php', array('id'=>$cm->id)));
1048         $PAGE->navbar->add(fullname($user, true));
1050         echo $OUTPUT->header();
1051         echo $OUTPUT->heading(get_string('feedback', 'assignment').': '.fullname($user, true));
1053         // display mform here...
1054         $submitform->display();
1056         $customfeedback = $this->custom_feedbackform($submission, true);
1057         if (!empty($customfeedback)) {
1058             echo $customfeedback;
1059         }
1061         echo $OUTPUT->footer();
1062     }
1064     /**
1065      *  Preprocess submission before grading
1066      *
1067      * Called by display_submission()
1068      * The default type does nothing here.
1069      *
1070      * @param object $submission The submission object
1071      */
1072     function preprocess_submission(&$submission) {
1073     }
1075     /**
1076      *  Display all the submissions ready for grading
1077      *
1078      * @global object
1079      * @global object
1080      * @global object
1081      * @global object
1082      * @param string $message
1083      * @return bool|void
1084      */
1085     function display_submissions($message='') {
1086         global $CFG, $DB, $USER, $DB, $OUTPUT, $PAGE;
1087         require_once($CFG->libdir.'/gradelib.php');
1089         /* first we check to see if the form has just been submitted
1090          * to request user_preference updates
1091          */
1093        $filters = array(self::FILTER_ALL             => get_string('all'),
1094                         self::FILTER_SUBMITTED       => get_string('submitted', 'assignment'),
1095                         self::FILTER_REQUIRE_GRADING => get_string('requiregrading', 'assignment'));
1097         $updatepref = optional_param('updatepref', 0, PARAM_INT);
1099         if (isset($_POST['updatepref'])){
1100             $perpage = optional_param('perpage', 10, PARAM_INT);
1101             $perpage = ($perpage <= 0) ? 10 : $perpage ;
1102             $filter = optional_param('filter', 0, PARAM_INT);
1103             set_user_preference('assignment_perpage', $perpage);
1104             set_user_preference('assignment_quickgrade', optional_param('quickgrade', 0, PARAM_BOOL));
1105             set_user_preference('assignment_filter', $filter);
1106         }
1108         /* next we get perpage and quickgrade (allow quick grade) params
1109          * from database
1110          */
1111         $perpage    = get_user_preferences('assignment_perpage', 10);
1112         $quickgrade = get_user_preferences('assignment_quickgrade', 0);
1113         $filter = get_user_preferences('assignment_filter', 0);
1114         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id);
1116         if (!empty($CFG->enableoutcomes) and !empty($grading_info->outcomes)) {
1117             $uses_outcomes = true;
1118         } else {
1119             $uses_outcomes = false;
1120         }
1122         $page    = optional_param('page', 0, PARAM_INT);
1123         $strsaveallfeedback = get_string('saveallfeedback', 'assignment');
1125     /// Some shortcuts to make the code read better
1127         $course     = $this->course;
1128         $assignment = $this->assignment;
1129         $cm         = $this->cm;
1130         $hassubmission = false;
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('fullnameuser'),
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     /// Construct the SQL
1268         list($where, $params) = $table->get_sql_where();
1269         if ($where) {
1270             $where .= ' AND ';
1271         }
1273         if ($filter == self::FILTER_SUBMITTED) {
1274            $where .= 's.timemodified > 0 AND ';
1275         } else if($filter == self::FILTER_REQUIRE_GRADING) {
1276            $where .= 's.timemarked < s.timemodified AND ';
1277         }
1279         if ($sort = $table->get_sql_sort()) {
1280             $sort = ' ORDER BY '.$sort;
1281         }
1283         $ufields = user_picture::fields('u');
1284         if (!empty($users)) {
1285             $select = "SELECT $ufields,
1286                               s.id AS submissionid, s.grade, s.submissioncomment,
1287                               s.timemodified, s.timemarked ";
1288             $sql = 'FROM {user} u '.
1289                    'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
1290                     AND s.assignment = '.$this->assignment->id.' '.
1291                    'WHERE '.$where.'u.id IN ('.implode(',',$users).') ';
1293             $ausers = $DB->get_records_sql($select.$sql.$sort, $params, $table->get_page_start(), $table->get_page_size());
1295             $table->pagesize($perpage, count($users));
1297             ///offset used to calculate index of student in that particular query, needed for the pop up to know who's next
1298             $offset = $page * $perpage;
1299             $strupdate = get_string('update');
1300             $strgrade  = get_string('grade');
1301             $grademenu = make_grades_menu($this->assignment->grade);
1303             if ($ausers !== false) {
1304                 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array_keys($ausers));
1305                 $endposition = $offset + $perpage;
1306                 $currentposition = 0;
1307                 foreach ($ausers as $auser) {
1308                     if ($currentposition == $offset && $offset < $endposition) {
1309                         $final_grade = $grading_info->items[0]->grades[$auser->id];
1310                         $grademax = $grading_info->items[0]->grademax;
1311                         $final_grade->formatted_grade = round($final_grade->grade,2) .' / ' . round($grademax,2);
1312                         $locked_overridden = 'locked';
1313                         if ($final_grade->overridden) {
1314                             $locked_overridden = 'overridden';
1315                         }
1317                     /// Calculate user status
1318                         $auser->status = ($auser->timemarked > 0) && ($auser->timemarked >= $auser->timemodified);
1319                         $picture = $OUTPUT->user_picture($auser);
1321                         if (empty($auser->submissionid)) {
1322                             $auser->grade = -1; //no submission yet
1323                         }
1325                         if (!empty($auser->submissionid)) {
1326                             $hassubmission = true;
1327                         ///Prints student answer and student modified date
1328                         ///attach file or print link to student answer, depending on the type of the assignment.
1329                         ///Refer to print_student_answer in inherited classes.
1330                             if ($auser->timemodified > 0) {
1331                                 $studentmodified = '<div id="ts'.$auser->id.'">'.$this->print_student_answer($auser->id)
1332                                                  . userdate($auser->timemodified).'</div>';
1333                             } else {
1334                                 $studentmodified = '<div id="ts'.$auser->id.'">&nbsp;</div>';
1335                             }
1336                         ///Print grade, dropdown or text
1337                             if ($auser->timemarked > 0) {
1338                                 $teachermodified = '<div id="tt'.$auser->id.'">'.userdate($auser->timemarked).'</div>';
1340                                 if ($final_grade->locked or $final_grade->overridden) {
1341                                     $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1342                                 } else if ($quickgrade) {
1343                                     $attributes = array();
1344                                     $attributes['tabindex'] = $tabindex++;
1345                                     $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1346                                     $grade = '<div id="g'.$auser->id.'">'. $menu .'</div>';
1347                                 } else {
1348                                     $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1349                                 }
1351                             } else {
1352                                 $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
1353                                 if ($final_grade->locked or $final_grade->overridden) {
1354                                     $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1355                                 } else if ($quickgrade) {
1356                                     $attributes = array();
1357                                     $attributes['tabindex'] = $tabindex++;
1358                                     $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1359                                     $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1360                                 } else {
1361                                     $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1362                                 }
1363                             }
1364                         ///Print Comment
1365                             if ($final_grade->locked or $final_grade->overridden) {
1366                                 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($final_grade->str_feedback),15).'</div>';
1368                             } else if ($quickgrade) {
1369                                 $comment = '<div id="com'.$auser->id.'">'
1370                                          . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1371                                          . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1372                             } else {
1373                                 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($auser->submissioncomment),15).'</div>';
1374                             }
1375                         } else {
1376                             $studentmodified = '<div id="ts'.$auser->id.'">&nbsp;</div>';
1377                             $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
1378                             $status          = '<div id="st'.$auser->id.'">&nbsp;</div>';
1380                             if ($final_grade->locked or $final_grade->overridden) {
1381                                 $grade = '<div id="g'.$auser->id.'">'.$final_grade->formatted_grade . '</div>';
1382                                 $hassubmission = true;
1383                             } else if ($quickgrade) {   // allow editing
1384                                 $attributes = array();
1385                                 $attributes['tabindex'] = $tabindex++;
1386                                 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1387                                 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1388                                 $hassubmission = true;
1389                             } else {
1390                                 $grade = '<div id="g'.$auser->id.'">-</div>';
1391                             }
1393                             if ($final_grade->locked or $final_grade->overridden) {
1394                                 $comment = '<div id="com'.$auser->id.'">'.$final_grade->str_feedback.'</div>';
1395                             } else if ($quickgrade) {
1396                                 $comment = '<div id="com'.$auser->id.'">'
1397                                          . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1398                                          . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1399                             } else {
1400                                 $comment = '<div id="com'.$auser->id.'">&nbsp;</div>';
1401                             }
1402                         }
1404                         if (empty($auser->status)) { /// Confirm we have exclusively 0 or 1
1405                             $auser->status = 0;
1406                         } else {
1407                             $auser->status = 1;
1408                         }
1410                         $buttontext = ($auser->status == 1) ? $strupdate : $strgrade;
1412                         ///No more buttons, we use popups ;-).
1413                         $popup_url = '/mod/assignment/submissions.php?id='.$this->cm->id
1414                                    . '&amp;userid='.$auser->id.'&amp;mode=single'.'&amp;filter='.$filter.'&amp;offset='.$offset++;
1416                         $button = $OUTPUT->action_link($popup_url, $buttontext);
1418                         $status  = '<div id="up'.$auser->id.'" class="s'.$auser->status.'">'.$button.'</div>';
1420                         $finalgrade = '<span id="finalgrade_'.$auser->id.'">'.$final_grade->str_grade.'</span>';
1422                         $outcomes = '';
1424                         if ($uses_outcomes) {
1426                             foreach($grading_info->outcomes as $n=>$outcome) {
1427                                 $outcomes .= '<div class="outcome"><label>'.$outcome->name.'</label>';
1428                                 $options = make_grades_menu(-$outcome->scaleid);
1430                                 if ($outcome->grades[$auser->id]->locked or !$quickgrade) {
1431                                     $options[0] = get_string('nooutcome', 'grades');
1432                                     $outcomes .= ': <span id="outcome_'.$n.'_'.$auser->id.'">'.$options[$outcome->grades[$auser->id]->grade].'</span>';
1433                                 } else {
1434                                     $attributes = array();
1435                                     $attributes['tabindex'] = $tabindex++;
1436                                     $attributes['id'] = 'outcome_'.$n.'_'.$auser->id;
1437                                     $outcomes .= ' '.html_writer::select($options, 'outcome_'.$n.'['.$auser->id.']', $outcome->grades[$auser->id]->grade, array(0=>get_string('nooutcome', 'grades')), $attributes);
1438                                 }
1439                                 $outcomes .= '</div>';
1440                             }
1441                         }
1443                         $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>';
1444                         $row = array($picture, $userlink, $grade, $comment, $studentmodified, $teachermodified, $status, $finalgrade);
1445                         if ($uses_outcomes) {
1446                             $row[] = $outcomes;
1447                         }
1448                         $table->add_data($row);
1449                     }
1450                     $currentposition++;
1451                 }
1452             }
1453             if ($hassubmission && ($this->assignment->assignmenttype=='upload' || $this->assignment->assignmenttype=='online' || $this->assignment->assignmenttype=='uploadsingle')) { //TODO: this is an ugly hack, where is the plugin spirit? (skodak)
1454                 echo html_writer::start_tag('div', array('class' => 'mod-assignment-download-link'));
1455                 echo html_writer::link(new moodle_url('/mod/assignment/submissions.php', array('id' => $this->cm->id, 'download' => 'zip')), get_string('downloadall', 'assignment'));
1456                 echo html_writer::end_tag('div');
1457             }
1458             $table->print_html();  /// Print the whole table
1459         } else {
1460             if ($filter == self::FILTER_SUBMITTED) {
1461                 echo html_writer::tag('div', get_string('nosubmisson', 'assignment'), array('class'=>'nosubmisson'));
1462             } else if ($filter == self::FILTER_REQUIRE_GRADING) {
1463                 echo html_writer::tag('div', get_string('norequiregrading', 'assignment'), array('class'=>'norequiregrading'));
1464             }
1465         }
1467         /// Print quickgrade form around the table
1468         if ($quickgrade && $table->started_output && !empty($users)){
1469             $mailinfopref = false;
1470             if (get_user_preferences('assignment_mailinfo', 1)) {
1471                 $mailinfopref = true;
1472             }
1473             $emailnotification =  html_writer::checkbox('mailinfo', 1, $mailinfopref, get_string('enableemailnotification','assignment'));
1475             $emailnotification .= $OUTPUT->help_icon('enableemailnotification', 'assignment');
1476             echo html_writer::tag('div', $emailnotification, array('class'=>'emailnotification'));
1478             $savefeedback = html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'fastg', 'value'=>get_string('saveallfeedback', 'assignment')));
1479             echo html_writer::tag('div', $savefeedback, array('class'=>'fastgbutton'));
1481             echo html_writer::end_tag('form');
1482         } else if ($quickgrade) {
1483             echo html_writer::end_tag('form');
1484         }
1486         echo '</div>';
1487         /// End of fast grading form
1489         /// Mini form for setting user preference
1491         $formaction = new moodle_url('/mod/assignment/submissions.php', array('id'=>$this->cm->id));
1492         $mform = new MoodleQuickForm('optionspref', 'post', $formaction, '', array('class'=>'optionspref'));
1494         $mform->addElement('hidden', 'updatepref');
1495         $mform->setDefault('updatepref', 1);
1496         $mform->addElement('header', 'qgprefs', get_string('optionalsettings', 'assignment'));
1497         $mform->addElement('select', 'filter', get_string('show'),  $filters);
1499         $mform->setDefault('filter', $filter);
1501         $mform->addElement('text', 'perpage', get_string('pagesize', 'assignment'), array('size'=>1));
1502         $mform->setDefault('perpage', $perpage);
1504         $mform->addElement('checkbox', 'quickgrade', get_string('quickgrade','assignment'));
1505         $mform->setDefault('quickgrade', $quickgrade);
1506         $mform->addHelpButton('quickgrade', 'quickgrade', 'assignment');
1508         $mform->addElement('submit', 'savepreferences', get_string('savepreferences'));
1510         $mform->display();
1512         echo $OUTPUT->footer();
1513     }
1515     /**
1516      *  Process teacher feedback submission
1517      *
1518      * This is called by submissions() when a grading even has taken place.
1519      * It gets its data from the submitted form.
1520      *
1521      * @global object
1522      * @global object
1523      * @global object
1524      * @return object|bool The updated submission object or false
1525      */
1526     function process_feedback($formdata=null) {
1527         global $CFG, $USER, $DB;
1528         require_once($CFG->libdir.'/gradelib.php');
1530         if (!$feedback = data_submitted() or !confirm_sesskey()) {      // No incoming data?
1531             return false;
1532         }
1534         ///For save and next, we need to know the userid to save, and the userid to go
1535         ///We use a new hidden field in the form, and set it to -1. If it's set, we use this
1536         ///as the userid to store
1537         if ((int)$feedback->saveuserid !== -1){
1538             $feedback->userid = $feedback->saveuserid;
1539         }
1541         if (!empty($feedback->cancel)) {          // User hit cancel button
1542             return false;
1543         }
1545         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $feedback->userid);
1547         // store outcomes if needed
1548         $this->process_outcomes($feedback->userid);
1550         $submission = $this->get_submission($feedback->userid, true);  // Get or make one
1552         if (!($grading_info->items[0]->grades[$feedback->userid]->locked ||
1553             $grading_info->items[0]->grades[$feedback->userid]->overridden) ) {
1555             $submission->grade      = $feedback->xgrade;
1556             $submission->submissioncomment    = $feedback->submissioncomment_editor['text'];
1557             $submission->teacher    = $USER->id;
1558             $mailinfo = get_user_preferences('assignment_mailinfo', 0);
1559             if (!$mailinfo) {
1560                 $submission->mailed = 1;       // treat as already mailed
1561             } else {
1562                 $submission->mailed = 0;       // Make sure mail goes out (again, even)
1563             }
1564             $submission->timemarked = time();
1566             unset($submission->data1);  // Don't need to update this.
1567             unset($submission->data2);  // Don't need to update this.
1569             if (empty($submission->timemodified)) {   // eg for offline assignments
1570                 // $submission->timemodified = time();
1571             }
1573             $DB->update_record('assignment_submissions', $submission);
1575             // triger grade event
1576             $this->update_grade($submission);
1578             add_to_log($this->course->id, 'assignment', 'update grades',
1579                        'submissions.php?id='.$this->cm->id.'&user='.$feedback->userid, $feedback->userid, $this->cm->id);
1580              if (!is_null($formdata)) {
1581                     if ($this->type == 'upload' || $this->type == 'uploadsingle') {
1582                         $mformdata = $formdata->mform->get_data();
1583                         $mformdata = file_postupdate_standard_filemanager($mformdata, 'files', $formdata->fileui_options, $this->context, 'mod_assignment', 'response', $submission->id);
1584                     }
1585              }
1586         }
1588         return $submission;
1590     }
1592     function process_outcomes($userid) {
1593         global $CFG, $USER;
1595         if (empty($CFG->enableoutcomes)) {
1596             return;
1597         }
1599         require_once($CFG->libdir.'/gradelib.php');
1601         if (!$formdata = data_submitted() or !confirm_sesskey()) {
1602             return;
1603         }
1605         $data = array();
1606         $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid);
1608         if (!empty($grading_info->outcomes)) {
1609             foreach($grading_info->outcomes as $n=>$old) {
1610                 $name = 'outcome_'.$n;
1611                 if (isset($formdata->{$name}[$userid]) and $old->grades[$userid]->grade != $formdata->{$name}[$userid]) {
1612                     $data[$n] = $formdata->{$name}[$userid];
1613                 }
1614             }
1615         }
1616         if (count($data) > 0) {
1617             grade_update_outcomes('mod/assignment', $this->course->id, 'mod', 'assignment', $this->assignment->id, $userid, $data);
1618         }
1620     }
1622     /**
1623      * Load the submission object for a particular user
1624      *
1625      * @global object
1626      * @global object
1627      * @param $userid int The id of the user whose submission we want or 0 in which case USER->id is used
1628      * @param $createnew boolean optional Defaults to false. If set to true a new submission object will be created in the database
1629      * @param bool $teachermodified student submission set if false
1630      * @return object The submission
1631      */
1632     function get_submission($userid=0, $createnew=false, $teachermodified=false) {
1633         global $USER, $DB;
1635         if (empty($userid)) {
1636             $userid = $USER->id;
1637         }
1639         $submission = $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
1641         if ($submission || !$createnew) {
1642             return $submission;
1643         }
1644         $newsubmission = $this->prepare_new_submission($userid, $teachermodified);
1645         $DB->insert_record("assignment_submissions", $newsubmission);
1647         return $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
1648     }
1650     /**
1651      * Instantiates a new submission object for a given user
1652      *
1653      * Sets the assignment, userid and times, everything else is set to default values.
1654      *
1655      * @param int $userid The userid for which we want a submission object
1656      * @param bool $teachermodified student submission set if false
1657      * @return object The submission
1658      */
1659     function prepare_new_submission($userid, $teachermodified=false) {
1660         $submission = new stdClass();
1661         $submission->assignment   = $this->assignment->id;
1662         $submission->userid       = $userid;
1663         $submission->timecreated = time();
1664         // teachers should not be modifying modified date, except offline assignments
1665         if ($teachermodified) {
1666             $submission->timemodified = 0;
1667         } else {
1668             $submission->timemodified = $submission->timecreated;
1669         }
1670         $submission->numfiles     = 0;
1671         $submission->data1        = '';
1672         $submission->data2        = '';
1673         $submission->grade        = -1;
1674         $submission->submissioncomment      = '';
1675         $submission->format       = 0;
1676         $submission->teacher      = 0;
1677         $submission->timemarked   = 0;
1678         $submission->mailed       = 0;
1679         return $submission;
1680     }
1682     /**
1683      * Return all assignment submissions by ENROLLED students (even empty)
1684      *
1685      * @param string $sort optional field names for the ORDER BY in the sql query
1686      * @param string $dir optional specifying the sort direction, defaults to DESC
1687      * @return array The submission objects indexed by id
1688      */
1689     function get_submissions($sort='', $dir='DESC') {
1690         return assignment_get_all_submissions($this->assignment, $sort, $dir);
1691     }
1693     /**
1694      * Counts all real assignment submissions by ENROLLED students (not empty ones)
1695      *
1696      * @param int $groupid optional If nonzero then count is restricted to this group
1697      * @return int The number of submissions
1698      */
1699     function count_real_submissions($groupid=0) {
1700         return assignment_count_real_submissions($this->cm, $groupid);
1701     }
1703     /**
1704      * Alerts teachers by email of new or changed assignments that need grading
1705      *
1706      * First checks whether the option to email teachers is set for this assignment.
1707      * Sends an email to ALL teachers in the course (or in the group if using separate groups).
1708      * Uses the methods email_teachers_text() and email_teachers_html() to construct the content.
1709      *
1710      * @global object
1711      * @global object
1712      * @param $submission object The submission that has changed
1713      * @return void
1714      */
1715     function email_teachers($submission) {
1716         global $CFG, $DB;
1718         if (empty($this->assignment->emailteachers)) {          // No need to do anything
1719             return;
1720         }
1722         $user = $DB->get_record('user', array('id'=>$submission->userid));
1724         if ($teachers = $this->get_graders($user)) {
1726             $strassignments = get_string('modulenameplural', 'assignment');
1727             $strassignment  = get_string('modulename', 'assignment');
1728             $strsubmitted  = get_string('submitted', 'assignment');
1730             foreach ($teachers as $teacher) {
1731                 $info = new stdClass();
1732                 $info->username = fullname($user, true);
1733                 $info->assignment = format_string($this->assignment->name,true);
1734                 $info->url = $CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id;
1735                 $info->timeupdated = strftime('%c',$submission->timemodified);
1737                 $postsubject = $strsubmitted.': '.$info->username.' -> '.$this->assignment->name;
1738                 $posttext = $this->email_teachers_text($info);
1739                 $posthtml = ($teacher->mailformat == 1) ? $this->email_teachers_html($info) : '';
1741                 $eventdata = new stdClass();
1742                 $eventdata->modulename       = 'assignment';
1743                 $eventdata->userfrom         = $user;
1744                 $eventdata->userto           = $teacher;
1745                 $eventdata->subject          = $postsubject;
1746                 $eventdata->fullmessage      = $posttext;
1747                 $eventdata->fullmessageformat = FORMAT_PLAIN;
1748                 $eventdata->fullmessagehtml  = $posthtml;
1749                 $eventdata->smallmessage     = '';
1751                 $eventdata->name            = 'assignment_updates';
1752                 $eventdata->component       = 'mod_assignment';
1753                 $eventdata->notification    = 1;
1754                 $eventdata->contexturl      = $info->url;
1755                 $eventdata->contexturlname  = $info->assignment;
1756                 
1757                 message_send($eventdata);
1758             }
1759         }
1760     }
1762     /**
1763      * @param string $filearea
1764      * @param array $args
1765      * @return bool
1766      */
1767     function send_file($filearea, $args) {
1768         debugging('plugin does not implement file sending', DEBUG_DEVELOPER);
1769         return false;
1770     }
1772     /**
1773      * Returns a list of teachers that should be grading given submission
1774      *
1775      * @param object $user
1776      * @return array
1777      */
1778     function get_graders($user) {
1779         //potential graders
1780         $potgraders = get_users_by_capability($this->context, 'mod/assignment:grade', '', '', '', '', '', '', false, false);
1782         $graders = array();
1783         if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) {   // Separate groups are being used
1784             if ($groups = groups_get_all_groups($this->course->id, $user->id)) {  // Try to find all groups
1785                 foreach ($groups as $group) {
1786                     foreach ($potgraders as $t) {
1787                         if ($t->id == $user->id) {
1788                             continue; // do not send self
1789                         }
1790                         if (groups_is_member($group->id, $t->id)) {
1791                             $graders[$t->id] = $t;
1792                         }
1793                     }
1794                 }
1795             } else {
1796                 // user not in group, try to find graders without group
1797                 foreach ($potgraders as $t) {
1798                     if ($t->id == $user->id) {
1799                         continue; // do not send self
1800                     }
1801                     if (!groups_get_all_groups($this->course->id, $t->id)) { //ugly hack
1802                         $graders[$t->id] = $t;
1803                     }
1804                 }
1805             }
1806         } else {
1807             foreach ($potgraders as $t) {
1808                 if ($t->id == $user->id) {
1809                     continue; // do not send self
1810                 }
1811                 $graders[$t->id] = $t;
1812             }
1813         }
1814         return $graders;
1815     }
1817     /**
1818      * Creates the text content for emails to teachers
1819      *
1820      * @param $info object The info used by the 'emailteachermail' language string
1821      * @return string
1822      */
1823     function email_teachers_text($info) {
1824         $posttext  = format_string($this->course->shortname).' -> '.$this->strassignments.' -> '.
1825                      format_string($this->assignment->name)."\n";
1826         $posttext .= '---------------------------------------------------------------------'."\n";
1827         $posttext .= get_string("emailteachermail", "assignment", $info)."\n";
1828         $posttext .= "\n---------------------------------------------------------------------\n";
1829         return $posttext;
1830     }
1832      /**
1833      * Creates the html content for emails to teachers
1834      *
1835      * @param $info object The info used by the 'emailteachermailhtml' language string
1836      * @return string
1837      */
1838     function email_teachers_html($info) {
1839         global $CFG;
1840         $posthtml  = '<p><font face="sans-serif">'.
1841                      '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$this->course->id.'">'.format_string($this->course->shortname).'</a> ->'.
1842                      '<a href="'.$CFG->wwwroot.'/mod/assignment/index.php?id='.$this->course->id.'">'.$this->strassignments.'</a> ->'.
1843                      '<a href="'.$CFG->wwwroot.'/mod/assignment/view.php?id='.$this->cm->id.'">'.format_string($this->assignment->name).'</a></font></p>';
1844         $posthtml .= '<hr /><font face="sans-serif">';
1845         $posthtml .= '<p>'.get_string('emailteachermailhtml', 'assignment', $info).'</p>';
1846         $posthtml .= '</font><hr />';
1847         return $posthtml;
1848     }
1850     /**
1851      * Produces a list of links to the files uploaded by a user
1852      *
1853      * @param $userid int optional id of the user. If 0 then $USER->id is used.
1854      * @param $return boolean optional defaults to false. If true the list is returned rather than printed
1855      * @return string optional
1856      */
1857     function print_user_files($userid=0, $return=false) {
1858         global $CFG, $USER, $OUTPUT;
1860         if (!$userid) {
1861             if (!isloggedin()) {
1862                 return '';
1863             }
1864             $userid = $USER->id;
1865         }
1867         $output = '';
1869         $fs = get_file_storage();
1871         $found = false;
1873         $submission = $this->get_submission($userid);
1875         if (($submission) && $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
1876             require_once($CFG->libdir.'/portfoliolib.php');
1877             require_once($CFG->dirroot . '/mod/assignment/locallib.php');
1878             $button = new portfolio_add_button();
1879             foreach ($files as $file) {
1880                 $filename = $file->get_filename();
1881                 $found = true;
1882                 $mimetype = $file->get_mimetype();
1883                 $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$this->context->id.'/mod_assignment/submission/'.$submission->id.'/'.$filename);
1884                 $output .= '<a href="'.$path.'" ><img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />'.s($filename).'</a>';
1885                 if ($this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
1886                     $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'fileid' => $file->get_id()), '/mod/assignment/locallib.php');
1887                     $button->set_format_by_file($file);
1888                     $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1889                 }
1890                 $output .= plagiarism_get_links(array('userid'=>$userid, 'file'=>$file, 'cmid'=>$this->cm->id, 'course'=>$this->course, 'assignment'=>$this->assignment));
1891                 $output .= '<br />';
1892             }
1893             if (count($files) > 1  && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
1894                 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id), '/mod/assignment/locallib.php');
1895                 $output .= '<br />'  . $button->to_html();
1896             }
1897         }
1899         $output = '<div class="files">'.$output.'</div>';
1901         if ($return) {
1902             return $output;
1903         }
1904         echo $output;
1905     }
1907     /**
1908      * Count the files uploaded by a given user
1909      *
1910      * @param $itemid int The submission's id as the file's itemid.
1911      * @return int
1912      */
1913     function count_user_files($itemid) {
1914         $fs = get_file_storage();
1915         $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $itemid, "id", false);
1916         return count($files);
1917     }
1919     /**
1920      * Returns true if the student is allowed to submit
1921      *
1922      * Checks that the assignment has started and, if the option to prevent late
1923      * submissions is set, also checks that the assignment has not yet closed.
1924      * @return boolean
1925      */
1926     function isopen() {
1927         $time = time();
1928         if ($this->assignment->preventlate && $this->assignment->timedue) {
1929             return ($this->assignment->timeavailable <= $time && $time <= $this->assignment->timedue);
1930         } else {
1931             return ($this->assignment->timeavailable <= $time);
1932         }
1933     }
1936     /**
1937      * Return true if is set description is hidden till available date
1938      *
1939      * This is needed by calendar so that hidden descriptions do not
1940      * come up in upcoming events.
1941      *
1942      * Check that description is hidden till available date
1943      * By default return false
1944      * Assignments types should implement this method if needed
1945      * @return boolen
1946      */
1947     function description_is_hidden() {
1948         return false;
1949     }
1951     /**
1952      * Return an outline of the user's interaction with the assignment
1953      *
1954      * The default method prints the grade and timemodified
1955      * @param $grade object
1956      * @return object with properties ->info and ->time
1957      */
1958     function user_outline($grade) {
1960         $result = new stdClass();
1961         $result->info = get_string('grade').': '.$grade->str_long_grade;
1962         $result->time = $grade->dategraded;
1963         return $result;
1964     }
1966     /**
1967      * Print complete information about the user's interaction with the assignment
1968      *
1969      * @param $user object
1970      */
1971     function user_complete($user, $grade=null) {
1972         global $OUTPUT;
1973         if ($grade) {
1974             echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1975             if ($grade->str_feedback) {
1976                 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1977             }
1978         }
1980         if ($submission = $this->get_submission($user->id)) {
1982             $fs = get_file_storage();
1984             if ($files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
1985                 $countfiles = count($files)." ".get_string("uploadedfiles", "assignment");
1986                 foreach ($files as $file) {
1987                     $countfiles .= "; ".$file->get_filename();
1988                 }
1989             }
1991             echo $OUTPUT->box_start();
1992             echo get_string("lastmodified").": ";
1993             echo userdate($submission->timemodified);
1994             echo $this->display_lateness($submission->timemodified);
1996             $this->print_user_files($user->id);
1998             echo '<br />';
2000             $this->view_feedback($submission);
2002             echo $OUTPUT->box_end();
2004         } else {
2005             print_string("notsubmittedyet", "assignment");
2006         }
2007     }
2009     /**
2010      * Return a string indicating how late a submission is
2011      *
2012      * @param $timesubmitted int
2013      * @return string
2014      */
2015     function display_lateness($timesubmitted) {
2016         return assignment_display_lateness($timesubmitted, $this->assignment->timedue);
2017     }
2019     /**
2020      * Empty method stub for all delete actions.
2021      */
2022     function delete() {
2023         //nothing by default
2024         redirect('view.php?id='.$this->cm->id);
2025     }
2027     /**
2028      * Empty custom feedback grading form.
2029      */
2030     function custom_feedbackform($submission, $return=false) {
2031         //nothing by default
2032         return '';
2033     }
2035     /**
2036      * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
2037      * for the course (see resource).
2038      *
2039      * Given a course_module object, this function returns any "extra" information that may be needed
2040      * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
2041      *
2042      * @param $coursemodule object The coursemodule object (record).
2043      * @return object An object on information that the courses will know about (most noticeably, an icon).
2044      *
2045      */
2046     function get_coursemodule_info($coursemodule) {
2047         return false;
2048     }
2050     /**
2051      * Plugin cron method - do not use $this here, create new assignment instances if needed.
2052      * @return void
2053      */
2054     function cron() {
2055         //no plugin cron by default - override if needed
2056     }
2058     /**
2059      * Reset all submissions
2060      */
2061     function reset_userdata($data) {
2062         global $CFG, $DB;
2064         if (!$DB->count_records('assignment', array('course'=>$data->courseid, 'assignmenttype'=>$this->type))) {
2065             return array(); // no assignments of this type present
2066         }
2068         $componentstr = get_string('modulenameplural', 'assignment');
2069         $status = array();
2071         $typestr = get_string('type'.$this->type, 'assignment');
2072         // ugly hack to support pluggable assignment type titles...
2073         if($typestr === '[[type'.$this->type.']]'){
2074             $typestr = get_string('type'.$this->type, 'assignment_'.$this->type);
2075         }
2077         if (!empty($data->reset_assignment_submissions)) {
2078             $assignmentssql = "SELECT a.id
2079                                  FROM {assignment} a
2080                                 WHERE a.course=? AND a.assignmenttype=?";
2081             $params = array($data->courseid, $this->type);
2083             // now get rid of all submissions and responses
2084             $fs = get_file_storage();
2085             if ($assignments = $DB->get_records_sql($assignmentssql, $params)) {
2086                 foreach ($assignments as $assignmentid=>$unused) {
2087                     if (!$cm = get_coursemodule_from_instance('assignment', $assignmentid)) {
2088                         continue;
2089                     }
2090                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2091                     $fs->delete_area_files($context->id, 'mod_assignment', 'submission');
2092                     $fs->delete_area_files($context->id, 'mod_assignment', 'response');
2093                 }
2094             }
2096             $DB->delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)", $params);
2098             $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false);
2100             if (empty($data->reset_gradebook_grades)) {
2101                 // remove all grades from gradebook
2102                 assignment_reset_gradebook($data->courseid, $this->type);
2103             }
2104         }
2106         /// updating dates - shift may be negative too
2107         if ($data->timeshift) {
2108             shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift, $data->courseid);
2109             $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false);
2110         }
2112         return $status;
2113     }
2116     function portfolio_exportable() {
2117         return false;
2118     }
2120     /**
2121      * base implementation for backing up subtype specific information
2122      * for one single module
2123      *
2124      * @param filehandle $bf file handle for xml file to write to
2125      * @param mixed $preferences the complete backup preference object
2126      *
2127      * @return boolean
2128      *
2129      * @static
2130      */
2131     static function backup_one_mod($bf, $preferences, $assignment) {
2132         return true;
2133     }
2135     /**
2136      * base implementation for backing up subtype specific information
2137      * for one single submission
2138      *
2139      * @param filehandle $bf file handle for xml file to write to
2140      * @param mixed $preferences the complete backup preference object
2141      * @param object $submission the assignment submission db record
2142      *
2143      * @return boolean
2144      *
2145      * @static
2146      */
2147     static function backup_one_submission($bf, $preferences, $assignment, $submission) {
2148         return true;
2149     }
2151     /**
2152      * base implementation for restoring subtype specific information
2153      * for one single module
2154      *
2155      * @param array  $info the array representing the xml
2156      * @param object $restore the restore preferences
2157      *
2158      * @return boolean
2159      *
2160      * @static
2161      */
2162     static function restore_one_mod($info, $restore, $assignment) {
2163         return true;
2164     }
2166     /**
2167      * base implementation for restoring subtype specific information
2168      * for one single submission
2169      *
2170      * @param object $submission the newly created submission
2171      * @param array  $info the array representing the xml
2172      * @param object $restore the restore preferences
2173      *
2174      * @return boolean
2175      *
2176      * @static
2177      */
2178     static function restore_one_submission($info, $restore, $assignment, $submission) {
2179         return true;
2180     }
2182 } ////// End of the assignment_base class
2185 class mod_assignment_grading_form extends moodleform {
2187     function definition() {
2188         global $OUTPUT;
2189         $mform =& $this->_form;
2191         $formattr = $mform->getAttributes();
2192         $formattr['id'] = 'submitform';
2193         $mform->setAttributes($formattr);
2194         // hidden params
2195         $mform->addElement('hidden', 'offset', ($this->_customdata->offset+1));
2196         $mform->setType('offset', PARAM_INT);
2197         $mform->addElement('hidden', 'userid', $this->_customdata->userid);
2198         $mform->setType('userid', PARAM_INT);
2199         $mform->addElement('hidden', 'nextid', $this->_customdata->nextid);
2200         $mform->setType('nextid', PARAM_INT);
2201         $mform->addElement('hidden', 'id', $this->_customdata->cm->id);
2202         $mform->setType('id', PARAM_INT);
2203         $mform->addElement('hidden', 'sesskey', sesskey());
2204         $mform->setType('sesskey', PARAM_ALPHANUM);
2205         $mform->addElement('hidden', 'mode', 'grade');
2206         $mform->setType('mode', PARAM_TEXT);
2207         $mform->addElement('hidden', 'menuindex', "0");
2208         $mform->setType('menuindex', PARAM_INT);
2209         $mform->addElement('hidden', 'saveuserid', "-1");
2210         $mform->setType('saveuserid', PARAM_INT);
2211         $mform->addElement('hidden', 'filter', "0");
2212         $mform->setType('filter', PARAM_INT);
2214         $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->user),
2215                                                 fullname($this->_customdata->user, true) . '<br/>' .
2216                                                 userdate($this->_customdata->submission->timemodified) .
2217                                                 $this->_customdata->lateness );
2219         $this->add_submission_content();
2220         $this->add_grades_section();
2222         $this->add_feedback_section();
2224         if ($this->_customdata->submission->timemarked) {
2225             $datestring = userdate($this->_customdata->submission->timemarked)."&nbsp; (".format_time(time() - $this->_customdata->submission->timemarked).")";
2226             $mform->addElement('header', 'Last Grade', get_string('lastgrade', 'assignment'));
2227             $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->teacher) ,
2228                                                     fullname($this->_customdata->teacher,true).
2229                                                     '<br/>'.$datestring);
2230         }
2231         // buttons
2232         $this->add_action_buttons();
2234     }
2236     function add_grades_section() {
2237         global $CFG;
2238         $mform =& $this->_form;
2239         $attributes = array();
2240         if ($this->_customdata->gradingdisabled) {
2241             $attributes['disabled'] ='disabled';
2242         }
2244         $grademenu = make_grades_menu($this->_customdata->assignment->grade);
2245         $grademenu['-1'] = get_string('nograde');
2247         $mform->addElement('header', 'Grades', get_string('grades', 'grades'));
2248         $mform->addElement('select', 'xgrade', get_string('grade').':', $grademenu, $attributes);
2249         $mform->setDefault('xgrade', $this->_customdata->submission->grade ); //@fixme some bug when element called 'grade' makes it break
2250         $mform->setType('xgrade', PARAM_INT);
2252         if (!empty($this->_customdata->enableoutcomes)) {
2253             foreach($this->_customdata->grading_info->outcomes as $n=>$outcome) {
2254                 $options = make_grades_menu(-$outcome->scaleid);
2255                 if ($outcome->grades[$this->_customdata->submission->userid]->locked) {
2256                     $options[0] = get_string('nooutcome', 'grades');
2257                     echo $options[$outcome->grades[$this->_customdata->submission->userid]->grade];
2258                 } else {
2259                     $options[''] = get_string('nooutcome', 'grades');
2260                     $attributes = array('id' => 'menuoutcome_'.$n );
2261                     $mform->addElement('select', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':', $options, $attributes );
2262                     $mform->setType('outcome_'.$n.'['.$this->_customdata->userid.']', PARAM_INT);
2263                     $mform->setDefault('outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->grades[$this->_customdata->submission->userid]->grade );
2264                 }
2265             }
2266         }
2267         $course_context = get_context_instance(CONTEXT_MODULE , $this->_customdata->cm->id);
2268         if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
2269             $grade = '<a href="'.$CFG->wwwroot.'/grade/report/grader/index.php?id='. $this->_customdata->courseid .'" >'.
2270                         $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade . '</a>';
2271         }else{
2272             $grade = $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade;
2273         }
2274         $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assignment').':' ,$grade);
2275         $mform->setType('finalgrade', PARAM_INT);
2276     }
2278     /**
2279      *
2280      * @global core_renderer $OUTPUT
2281      */
2282     function add_feedback_section() {
2283         global $OUTPUT;
2284         $mform =& $this->_form;
2285         $mform->addElement('header', 'Feed Back', get_string('feedback', 'grades'));
2287         if ($this->_customdata->gradingdisabled) {
2288             $mform->addElement('static', 'disabledfeedback', $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_feedback );
2289         } else {
2290             // visible elements
2292             $mform->addElement('editor', 'submissioncomment_editor', get_string('feedback', 'assignment').':', null, $this->get_editor_options() );
2293             $mform->setType('submissioncomment_editor', PARAM_RAW); // to be cleaned before display
2294             $mform->setDefault('submissioncomment_editor', $this->_customdata->submission->submissioncomment);
2295             //$mform->addRule('submissioncomment', get_string('required'), 'required', null, 'client');
2296             switch ($this->_customdata->assignment->assignmenttype) {
2297                 case 'upload' :
2298                 case 'uploadsingle' :
2299                     $mform->addElement('filemanager', 'files_filemanager', get_string('responsefiles', 'assignment'). ':', null, $this->_customdata->fileui_options);
2300                     break;
2301                 default :
2302                     break;
2303             }
2304             $lastmailinfo = get_user_preferences('assignment_mailinfo', 1) ? array('checked'=>'checked') : array();
2305             $mform->addElement('hidden', 'mailinfo_h', "0");
2306             $mform->setType('mailinfo_h', PARAM_INT);
2307             $mform->addElement('checkbox', 'mailinfo',get_string('enableemailnotification','assignment').
2308             $OUTPUT->help_icon('enableemailnotification', 'assignment') .':' );
2309             $mform->updateElementAttr('mailinfo', $lastmailinfo);
2310             $mform->setType('mailinfo', PARAM_INT);
2311         }
2312     }
2314     function add_action_buttons() {
2315         $mform =& $this->_form;
2316         //if there are more to be graded.
2317         if ($this->_customdata->nextid>0) {
2318             $buttonarray=array();
2319             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2320             //@todo: fix accessibility: javascript dependency not necessary
2321             $buttonarray[] = &$mform->createElement('submit', 'saveandnext', get_string('saveandnext'));
2322             $buttonarray[] = &$mform->createElement('submit', 'next', get_string('next'));
2323             $buttonarray[] = &$mform->createElement('cancel');
2324         } else {
2325             $buttonarray=array();
2326             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2327             $buttonarray[] = &$mform->createElement('cancel');
2328         }
2329         $mform->addGroup($buttonarray, 'grading_buttonar', '', array(' '), false);
2330         $mform->closeHeaderBefore('grading_buttonar');
2331         $mform->setType('grading_buttonar', PARAM_RAW);
2332     }
2334     function add_submission_content() {
2335         $mform =& $this->_form;
2336         $mform->addElement('header', 'Submission', get_string('submission', 'assignment'));
2337         $mform->addElement('static', '', '' , $this->_customdata->submission_content );
2338     }
2340     protected function get_editor_options() {
2341         $editoroptions = array();
2342         $editoroptions['component'] = 'mod_assignment';
2343         $editoroptions['filearea'] = 'feedback';
2344         $editoroptions['noclean'] = false;
2345         $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)
2346         $editoroptions['maxbytes'] = $this->_customdata->maxbytes;
2347         return $editoroptions;
2348     }
2350     public function set_data($data) {
2351         $editoroptions = $this->get_editor_options();
2352         if (!isset($data->text)) {
2353             $data->text = '';
2354         }
2355         if (!isset($data->format)) {
2356             $data->textformat = FORMAT_HTML;
2357         } else {
2358             $data->textformat = $data->format;
2359         }
2361         if (!empty($this->_customdata->submission->id)) {
2362             $itemid = $this->_customdata->submission->id;
2363         } else {
2364             $itemid = null;
2365         }
2367         switch ($this->_customdata->assignment->assignmenttype) {
2368                 case 'upload' :
2369                 case 'uploadsingle' :
2370                     $data = file_prepare_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2371                     break;
2372                 default :
2373                     break;
2374         }
2376         $data = file_prepare_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2377         return parent::set_data($data);
2378     }
2380     public function get_data() {
2381         $data = parent::get_data();
2383         if (!empty($this->_customdata->submission->id)) {
2384             $itemid = $this->_customdata->submission->id;
2385         } else {
2386             $itemid = null; //TODO: this is wrong, itemid MUST be known when saving files!! (skodak)
2387         }
2389         if ($data) {
2390             $editoroptions = $this->get_editor_options();
2391             switch ($this->_customdata->assignment->assignmenttype) {
2392                 case 'upload' :
2393                 case 'uploadsingle' :
2394                     $data = file_postupdate_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2395                     break;
2396                 default :
2397                     break;
2398             }
2399             $data = file_postupdate_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2400         }
2401         return $data;
2402     }
2405 /// OTHER STANDARD FUNCTIONS ////////////////////////////////////////////////////////
2407 /**
2408  * Deletes an assignment instance
2409  *
2410  * This is done by calling the delete_instance() method of the assignment type class
2411  */
2412 function assignment_delete_instance($id){
2413     global $CFG, $DB;
2415     if (! $assignment = $DB->get_record('assignment', array('id'=>$id))) {
2416         return false;
2417     }
2419     // fall back to base class if plugin missing
2420     $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
2421     if (file_exists($classfile)) {
2422         require_once($classfile);
2423         $assignmentclass = "assignment_$assignment->assignmenttype";
2425     } else {
2426         debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead.");
2427         $assignmentclass = "assignment_base";
2428     }
2430     $ass = new $assignmentclass();
2431     return $ass->delete_instance($assignment);
2435 /**
2436  * Updates an assignment instance
2437  *
2438  * This is done by calling the update_instance() method of the assignment type class
2439  */
2440 function assignment_update_instance($assignment){
2441     global $CFG;
2443     $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2445     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2446     $assignmentclass = "assignment_$assignment->assignmenttype";
2447     $ass = new $assignmentclass();
2448     return $ass->update_instance($assignment);
2452 /**
2453  * Adds an assignment instance
2454  *
2455  * This is done by calling the add_instance() method of the assignment type class
2456  */
2457 function assignment_add_instance($assignment) {
2458     global $CFG;
2460     $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2462     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2463     $assignmentclass = "assignment_$assignment->assignmenttype";
2464     $ass = new $assignmentclass();
2465     return $ass->add_instance($assignment);
2469 /**
2470  * Returns an outline of a user interaction with an assignment
2471  *
2472  * This is done by calling the user_outline() method of the assignment type class
2473  */
2474 function assignment_user_outline($course, $user, $mod, $assignment) {
2475     global $CFG;
2477     require_once("$CFG->libdir/gradelib.php");
2478     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2479     $assignmentclass = "assignment_$assignment->assignmenttype";
2480     $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2481     $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2482     if (!empty($grades->items[0]->grades)) {
2483         return $ass->user_outline(reset($grades->items[0]->grades));
2484     } else {
2485         return null;
2486     }
2489 /**
2490  * Prints the complete info about a user's interaction with an assignment
2491  *
2492  * This is done by calling the user_complete() method of the assignment type class
2493  */
2494 function assignment_user_complete($course, $user, $mod, $assignment) {
2495     global $CFG;
2497     require_once("$CFG->libdir/gradelib.php");
2498     require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2499     $assignmentclass = "assignment_$assignment->assignmenttype";
2500     $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2501     $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2502     if (empty($grades->items[0]->grades)) {
2503         $grade = false;
2504     } else {
2505         $grade = reset($grades->items[0]->grades);
2506     }
2507     return $ass->user_complete($user, $grade);
2510 /**
2511  * Function to be run periodically according to the moodle cron
2512  *
2513  * Finds all assignment notifications that have yet to be mailed out, and mails them
2514  */
2515 function assignment_cron () {
2516     global $CFG, $USER, $DB;
2518     /// first execute all crons in plugins
2519     if ($plugins = get_plugin_list('assignment')) {
2520         foreach ($plugins as $plugin=>$dir) {
2521             require_once("$dir/assignment.class.php");
2522             $assignmentclass = "assignment_$plugin";
2523             $ass = new $assignmentclass();
2524             $ass->cron();
2525         }
2526     }
2528     /// Notices older than 1 day will not be mailed.  This is to avoid the problem where
2529     /// cron has not been running for a long time, and then suddenly people are flooded
2530     /// with mail from the past few weeks or months
2532     $timenow   = time();
2533     $endtime   = $timenow - $CFG->maxeditingtime;
2534     $starttime = $endtime - 24 * 3600;   /// One day earlier
2536     if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) {
2538         $realuser = clone($USER);
2540         foreach ($submissions as $key => $submission) {
2541             $DB->set_field("assignment_submissions", "mailed", "1", array("id"=>$submission->id));
2542         }
2544         $timenow = time();
2546         foreach ($submissions as $submission) {
2548             echo "Processing assignment submission $submission->id\n";
2550             if (! $user = $DB->get_record("user", array("id"=>$submission->userid))) {
2551                 echo "Could not find user $user->id\n";
2552                 continue;
2553             }
2555             if (! $course = $DB->get_record("course", array("id"=>$submission->course))) {
2556                 echo "Could not find course $submission->course\n";
2557                 continue;
2558             }
2560             /// Override the language and timezone of the "current" user, so that
2561             /// mail is customised for the receiver.
2562             cron_setup_user($user, $course);
2564             if (!is_enrolled(get_context_instance(CONTEXT_COURSE, $submission->course), $user->id)) {
2565                 echo fullname($user)." not an active participant in " . format_string($course->shortname) . "\n";
2566                 continue;
2567             }
2569             if (! $teacher = $DB->get_record("user", array("id"=>$submission->teacher))) {
2570                 echo "Could not find teacher $submission->teacher\n";
2571                 continue;
2572             }
2574             if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment, $course->id)) {
2575                 echo "Could not find course module for assignment id $submission->assignment\n";
2576                 continue;
2577             }
2579             if (! $mod->visible) {    /// Hold mail notification for hidden assignments until later
2580                 continue;
2581             }
2583             $strassignments = get_string("modulenameplural", "assignment");
2584             $strassignment  = get_string("modulename", "assignment");
2586             $assignmentinfo = new stdClass();
2587             $assignmentinfo->teacher = fullname($teacher);
2588             $assignmentinfo->assignment = format_string($submission->name,true);
2589             $assignmentinfo->url = "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id";
2591             $postsubject = "$course->shortname: $strassignments: ".format_string($submission->name,true);
2592             $posttext  = "$course->shortname -> $strassignments -> ".format_string($submission->name,true)."\n";
2593             $posttext .= "---------------------------------------------------------------------\n";
2594             $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n";
2595             $posttext .= "---------------------------------------------------------------------\n";
2597             if ($user->mailformat == 1) {  // HTML
2598                 $posthtml = "<p><font face=\"sans-serif\">".
2599                 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> ->".
2600                 "<a href=\"$CFG->wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments</a> ->".
2601                 "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name,true)."</a></font></p>";
2602                 $posthtml .= "<hr /><font face=\"sans-serif\">";
2603                 $posthtml .= "<p>".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."</p>";
2604                 $posthtml .= "</font><hr />";
2605             } else {
2606                 $posthtml = "";
2607             }
2609             $eventdata = new stdClass();
2610             $eventdata->modulename       = 'assignment';
2611             $eventdata->userfrom         = $teacher;
2612             $eventdata->userto           = $user;
2613             $eventdata->subject          = $postsubject;
2614             $eventdata->fullmessage      = $posttext;
2615             $eventdata->fullmessageformat = FORMAT_PLAIN;
2616             $eventdata->fullmessagehtml  = $posthtml;
2617             $eventdata->smallmessage     = '';
2619             $eventdata->name            = 'assignment_updates';
2620             $eventdata->component       = 'mod_assignment';
2621             $eventdata->notification    = 1;
2623             message_send($eventdata);
2624         }
2626         cron_setup_user();
2627     }
2629     return true;
2632 /**
2633  * Return grade for given user or all users.
2634  *
2635  * @param int $assignmentid id of assignment
2636  * @param int $userid optional user id, 0 means all users
2637  * @return array array of grades, false if none
2638  */
2639 function assignment_get_user_grades($assignment, $userid=0) {
2640     global $CFG, $DB;
2642     if ($userid) {
2643         $user = "AND u.id = :userid";
2644         $params = array('userid'=>$userid);
2645     } else {
2646         $user = "";
2647     }
2648     $params['aid'] = $assignment->id;
2650     $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat,
2651                    s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted
2652               FROM {user} u, {assignment_submissions} s
2653              WHERE u.id = s.userid AND s.assignment = :aid
2654                    $user";
2656     return $DB->get_records_sql($sql, $params);
2659 /**
2660  * Update activity grades
2661  *
2662  * @param object $assignment
2663  * @param int $userid specific user only, 0 means all
2664  */
2665 function assignment_update_grades($assignment, $userid=0, $nullifnone=true) {
2666     global $CFG, $DB;
2667     require_once($CFG->libdir.'/gradelib.php');
2669     if ($assignment->grade == 0) {
2670         assignment_grade_item_update($assignment);
2672     } else if ($grades = assignment_get_user_grades($assignment, $userid)) {
2673         foreach($grades as $k=>$v) {
2674             if ($v->rawgrade == -1) {
2675                 $grades[$k]->rawgrade = null;
2676             }
2677         }
2678         assignment_grade_item_update($assignment, $grades);
2680     } else {
2681         assignment_grade_item_update($assignment);
2682     }
2685 /**
2686  * Update all grades in gradebook.
2687  */
2688 function assignment_upgrade_grades() {
2689     global $DB;
2691     $sql = "SELECT COUNT('x')
2692               FROM {assignment} a, {course_modules} cm, {modules} m
2693              WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2694     $count = $DB->count_records_sql($sql);
2696     $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
2697               FROM {assignment} a, {course_modules} cm, {modules} m
2698              WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2699     $rs = $DB->get_recordset_sql($sql);
2700     if ($rs->valid()) {
2701         // too much debug output
2702         $pbar = new progress_bar('assignmentupgradegrades', 500, true);
2703         $i=0;
2704         foreach ($rs as $assignment) {
2705             $i++;
2706             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
2707             assignment_update_grades($assignment);
2708             $pbar->update($i, $count, "Updating Assignment grades ($i/$count).");
2709         }
2710         upgrade_set_timeout(); // reset to default timeout
2711     }
2712     $rs->close();
2715 /**
2716  * Create grade item for given assignment
2717  *
2718  * @param object $assignment object with extra cmidnumber
2719  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
2720  * @return int 0 if ok, error code otherwise
2721  */
2722 function assignment_grade_item_update($assignment, $grades=NULL) {
2723     global $CFG;
2724     require_once($CFG->libdir.'/gradelib.php');
2726     if (!isset($assignment->courseid)) {
2727         $assignment->courseid = $assignment->course;
2728     }
2730     $params = array('itemname'=>$assignment->name, 'idnumber'=>$assignment->cmidnumber);
2732     if ($assignment->grade > 0) {
2733         $params['gradetype'] = GRADE_TYPE_VALUE;
2734         $params['grademax']  = $assignment->grade;
2735         $params['grademin']  = 0;
2737     } else if ($assignment->grade < 0) {
2738         $params['gradetype'] = GRADE_TYPE_SCALE;
2739         $params['scaleid']   = -$assignment->grade;
2741     } else {
2742         $params['gradetype'] = GRADE_TYPE_TEXT; // allow text comments only
2743     }
2745     if ($grades  === 'reset') {
2746         $params['reset'] = true;
2747         $grades = NULL;
2748     }
2750     return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, $grades, $params);
2753 /**
2754  * Delete grade item for given assignment
2755  *
2756  * @param object $assignment object
2757  * @return object assignment
2758  */
2759 function assignment_grade_item_delete($assignment) {
2760     global $CFG;
2761     require_once($CFG->libdir.'/gradelib.php');
2763     if (!isset($assignment->courseid)) {
2764         $assignment->courseid = $assignment->course;
2765     }
2767     return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, NULL, array('deleted'=>1));
2770 /**
2771  * Returns the users with data in one assignment (students and teachers)
2772  *
2773  * @todo: deprecated - to be deleted in 2.2
2774  *
2775  * @param $assignmentid int
2776  * @return array of user objects
2777  */
2778 function assignment_get_participants($assignmentid) {
2779     global $CFG, $DB;
2781     //Get students
2782     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2783                                         FROM {user} u,
2784                                              {assignment_submissions} a
2785                                        WHERE a.assignment = ? and
2786                                              u.id = a.userid", array($assignmentid));
2787     //Get teachers
2788     $teachers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2789                                         FROM {user} u,
2790                                              {assignment_submissions} a
2791                                        WHERE a.assignment = ? and
2792                                              u.id = a.teacher", array($assignmentid));
2794     //Add teachers to students
2795     if ($teachers) {
2796         foreach ($teachers as $teacher) {
2797             $students[$teacher->id] = $teacher;
2798         }
2799     }
2800     //Return students array (it contains an array of unique users)
2801     return ($students);
2804 /**
2805  * Serves assignment submissions and other files.
2806  *
2807  * @param object $course
2808  * @param object $cm
2809  * @param object $context
2810  * @param string $filearea
2811  * @param array $args
2812  * @param bool $forcedownload
2813  * @return bool false if file not found, does not return if found - just send the file
2814  */
2815 function assignment_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
2816     global $CFG, $DB;
2818     if ($context->contextlevel != CONTEXT_MODULE) {
2819         return false;
2820     }
2822     require_login($course, false, $cm);
2824     if (!$assignment = $DB->get_record('assignment', array('id'=>$cm->instance))) {
2825         return false;
2826     }
2828     require_once($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
2829     $assignmentclass = 'assignment_'.$assignment->assignmenttype;
2830     $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm, $course);
2832     return $assignmentinstance->send_file($filearea, $args);
2834 /**
2835  * Checks if a scale is being used by an assignment
2836  *
2837  * This is used by the backup code to decide whether to back up a scale
2838  * @param $assignmentid int
2839  * @param $scaleid int
2840  * @return boolean True if the scale is used by the assignment
2841  */
2842 function assignment_scale_used($assignmentid, $scaleid) {
2843     global $DB;
2845     $return = false;
2847     $rec = $DB->get_record('assignment', array('id'=>$assignmentid,'grade'=>-$scaleid));
2849     if (!empty($rec) && !empty($scaleid)) {
2850         $return = true;
2851     }
2853     return $return;
2856 /**
2857  * Checks if scale is being used by any instance of assignment
2858  *
2859  * This is used to find out if scale used anywhere
2860  * @param $scaleid int
2861  * @return boolean True if the scale is used by any assignment
2862  */
2863 function assignment_scale_used_anywhere($scaleid) {
2864     global $DB;
2866     if ($scaleid and $DB->record_exists('assignment', array('grade'=>-$scaleid))) {
2867         return true;
2868     } else {
2869         return false;
2870     }
2873 /**
2874  * Make sure up-to-date events are created for all assignment instances
2875  *
2876  * This standard function will check all instances of this module
2877  * and make sure there are up-to-date events created for each of them.
2878  * If courseid = 0, then every assignment event in the site is checked, else
2879  * only assignment events belonging to the course specified are checked.
2880  * This function is used, in its new format, by restore_refresh_events()
2881  *
2882  * @param $courseid int optional If zero then all assignments for all courses are covered
2883  * @return boolean Always returns true
2884  */
2885 function assignment_refresh_events($courseid = 0) {
2886     global $DB;
2888     if ($courseid == 0) {
2889         if (! $assignments = $DB->get_records("assignment")) {
2890             return true;
2891         }
2892     } else {
2893         if (! $assignments = $DB->get_records("assignment", array("course"=>$courseid))) {
2894             return true;
2895         }
2896     }
2897     $moduleid = $DB->get_field('modules', 'id', array('name'=>'assignment'));
2899     foreach ($assignments as $assignment) {
2900         $cm = get_coursemodule_from_id('assignment', $assignment->id);
2901         $event = new stdClass();
2902         $event->name        = $assignment->name;
2903         $event->description = format_module_intro('assignment', $assignment, $cm->id);
2904         $event->timestart   = $assignment->timedue;
2906         if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
2907             update_event($event);
2909         } else {
2910             $event->courseid    = $assignment->course;
2911             $event->groupid     = 0;
2912             $event->userid      = 0;
2913             $event->modulename  = 'assignment';
2914             $event->instance    = $assignment->id;
2915             $event->eventtype   = 'due';
2916             $event->timeduration = 0;
2917             $event->visible     = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$assignment->id));
2918             add_event($event);
2919         }
2921     }
2922     return true;
2925 /**
2926  * Print recent activity from all assignments in a given course
2927  *
2928  * This is used by the recent activity block
2929  */
2930 function assignment_print_recent_activity($course, $viewfullnames, $timestart) {
2931     global $CFG, $USER, $DB, $OUTPUT;
2933     // do not use log table if possible, it may be huge
2935     if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified, cm.id AS cmid, asb.userid,
2936                                                      u.firstname, u.lastname, u.email, u.picture
2937                                                 FROM {assignment_submissions} asb
2938                                                      JOIN {assignment} a      ON a.id = asb.assignment
2939                                                      JOIN {course_modules} cm ON cm.instance = a.id
2940                                                      JOIN {modules} md        ON md.id = cm.module
2941                                                      JOIN {user} u            ON u.id = asb.userid
2942                                                WHERE asb.timemodified > ? AND
2943                                                      a.course = ? AND
2944                                                      md.name = 'assignment'
2945                                             ORDER BY asb.timemodified ASC", array($timestart, $course->id))) {
2946          return false;
2947     }
2949     $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups
2950     $show    = array();
2951     $grader  = array();
2953     foreach($submissions as $submission) {
2954         if (!array_key_exists($submission->cmid, $modinfo->cms)) {
2955             continue;
2956         }
2957         $cm = $modinfo->cms[$submission->cmid];
2958         if (!$cm->uservisible) {
2959             continue;
2960         }
2961         if ($submission->userid == $USER->id) {
2962             $show[] = $submission;
2963             continue;
2964         }
2966         // the act of sumbitting of assignment may be considered private - only graders will see it if specified
2967         if (empty($CFG->assignment_showrecentsubmissions)) {
2968             if (!array_key_exists($cm->id, $grader)) {
2969                 $grader[$cm->id] = has_capability('moodle/grade:viewall', get_context_instance(CONTEXT_MODULE, $cm->id));
2970             }
2971             if (!$grader[$cm->id]) {
2972                 continue;
2973             }
2974         }
2976         $groupmode = groups_get_activity_groupmode($cm, $course);
2978         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2979             if (isguestuser()) {
2980                 // shortcut - guest user does not belong into any group
2981                 continue;
2982             }
2984             if (is_null($modinfo->groups)) {
2985                 $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
2986             }
2988             // this will be slow - show only users that share group with me in this cm
2989             if (empty($modinfo->groups[$cm->id])) {
2990                 continue;
2991             }
2992             $usersgroups =  groups_get_all_groups($course->id, $submission->userid, $cm->groupingid);
2993             if (is_array($usersgroups)) {
2994                 $usersgroups = array_keys($usersgroups);
2995                 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
2996                 if (empty($intersect)) {
2997                     continue;
2998                 }
2999             }
3000         }
3001         $show[] = $submission;
3002     }
3004     if (empty($show)) {
3005         return false;
3006     }
3008     echo $OUTPUT->heading(get_string('newsubmissions', 'assignment').':', 3);
3010     foreach ($show as $submission) {
3011         $cm = $modinfo->cms[$submission->cmid];
3012         $link = $CFG->wwwroot.'/mod/assignment/view.php?id='.$cm->id;
3013         print_recent_activity_note($submission->timemodified, $submission, $cm->name, $link, false, $viewfullnames);
3014     }
3016     return true;
3020 /**
3021  * Returns all assignments since a given time in specified forum.
3022  */
3023 function assignment_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)  {
3024     global $CFG, $COURSE, $USER, $DB;
3026     if ($COURSE->id == $courseid) {
3027         $course = $COURSE;
3028     } else {
3029         $course = $DB->get_record('course', array('id'=>$courseid));
3030     }
3032     $modinfo =& get_fast_modinfo($course);
3034     $cm = $modinfo->cms[$cmid];
3036     $params = array();
3037     if ($userid) {
3038         $userselect = "AND u.id = :userid";
3039         $params['userid'] = $userid;
3040     } else {
3041         $userselect = "";
3042     }
3044     if ($groupid) {
3045         $groupselect = "AND gm.groupid = :groupid";
3046         $groupjoin   = "JOIN {groups_members} gm ON  gm.userid=u.id";
3047         $params['groupid'] = $groupid;
3048     } else {
3049         $groupselect = "";
3050         $groupjoin   = "";
3051     }
3053     $params['cminstance'] = $cm->instance;
3054     $params['timestart'] = $timestart;
3056     $userfields = user_picture::fields('u', null, 'userid');
3058     if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified,
3059                                                      $userfields
3060                                                 FROM {assignment_submissions} asb
3061                                                 JOIN {assignment} a      ON a.id = asb.assignment
3062                                                 JOIN {user} u            ON u.id = asb.userid
3063                                           $groupjoin
3064                                                WHERE asb.timemodified > :timestart AND a.id = :cminstance
3065                                                      $userselect $groupselect
3066                                             ORDER BY asb.timemodified ASC", $params)) {
3067          return;
3068     }
3070     $groupmode       = groups_get_activity_groupmode($cm, $course);
3071     $cm_context      = get_context_instance(CONTEXT_MODULE, $cm->id);
3072     $grader          = has_capability('moodle/grade:viewall', $cm_context);
3073     $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
3074     $viewfullnames   = has_capability('moodle/site:viewfullnames', $cm_context);
3076     if (is_null($modinfo->groups)) {
3077         $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
3078     }
3080     $show = array();
3082     foreach($submissions as $submission) {
3083         if ($submission->userid == $USER->id) {
3084             $show[] = $submission;
3085             continue;
3086         }
3087         // the act of submitting of assignment may be considered private - only graders will see it if specified
3088         if (empty($CFG->assignment_showrecentsubmissions)) {
3089             if (!$grader) {
3090                 continue;
3091             }
3092         }
3094         if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
3095             if (isguestuser()) {
3096                 // shortcut - guest user does not belong into any group
3097                 continue;
3098             }
3100             // this will be slow - show only users that share group with me in this cm
3101             if (empty($modinfo->groups[$cm->id])) {
3102                 continue;
3103             }
3104             $usersgroups = groups_get_all_groups($course->id, $cm->userid, $cm->groupingid);
3105             if (is_array($usersgroups)) {
3106                 $usersgroups = array_keys($usersgroups);
3107                 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
3108                 if (empty($intersect)) {
3109                     continue;
3110                 }
3111             }
3112         }
3113         $show[] = $submission;
3114     }
3116     if (empty($show)) {
3117         return;
3118     }
3120     if ($grader) {
3121         require_once($CFG->libdir.'/gradelib.php');
3122         $userids = array();
3123         foreach ($show as $id=>$submission) {
3124             $userids[] = $submission->userid;
3126         }
3127         $grades = grade_get_grades($courseid, 'mod', 'assignment', $cm->instance, $userids);
3128     }
3130     $aname = format_string($cm->name,true);
3131     foreach ($show as $submission) {
3132         $tmpactivity = new stdClass();
3134         $tmpactivity->type         = 'assignment';
3135         $tmpactivity->cmid         = $cm->id;
3136         $tmpactivity->name         = $aname;
3137         $tmpactivity->sectionnum   = $cm->sectionnum;
3138         $tmpactivity->timestamp    = $submission->timemodified;
3140         if ($grader) {
3141             $tmpactivity->grade = $grades->items[0]->grades[$submission->userid]->str_long_grade;
3142         }
3144         $userfields = explode(',', user_picture::fields());
3145         foreach ($userfields as $userfield) {
3146             if ($userfield == 'id') {
3147                 $tmpactivity->user->{$userfield} = $submission->userid; // aliased in SQL above
3148             } else {
3149                 $tmpactivity->user->{$userfield} = $submission->{$userfield};
3150             }
3151         }
3152         $tmpactivity->user->fullname = fullname($submission, $viewfullnames);
3154         $activities[$index++] = $tmpactivity;
3155     }
3157     return;
3160 /**
3161  * Print recent activity from all assignments in a given course
3162  *
3163  * This is used by course/recent.php
3164  */
3165 function assignment_print_recent_mod_activity($activity, $courseid, $detail, $modnames)  {
3166     global $CFG, $OUTPUT;
3168     echo '<table border="0" cellpadding="3" cellspacing="0" class="assignment-recent">';
3170     echo "<tr><td class=\"userpicture\" valign=\"top\">";
3171     echo $OUTPUT->user_picture($activity->user);
3172     echo "</td><td>";
3174     if ($detail) {
3175         $modname = $modnames[$activity->type];
3176         echo '<div class="title">';
3177         echo "<img src=\"" . $OUTPUT->pix_url('icon', 'assignment') . "\" ".
3178              "class=\"icon\" alt=\"$modname\">";
3179         echo "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id={$activity->cmid}\">{$activity->name}</a>";
3180         echo '</div>';
3181     }
3183     if (isset($activity->grade)) {
3184         echo '<div class="grade">';
3185         echo get_string('grade').': ';
3186         echo $activity->grade;
3187         echo '</div>';
3188     }
3190     echo '<div class="user">';
3191     echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&amp;course=$courseid\">"
3192          ."{$activity->user->fullname}</a>  - ".userdate($activity->timestamp);
3193     echo '</div>';
3195     echo "</td></tr></table>";
3198 /// GENERIC SQL FUNCTIONS
3200 /**
3201  * Fetch info from logs
3202  *
3203  * @param $log object with properties ->info (the assignment id) and ->userid
3204  * @return array with assignment name and user firstname and lastname
3205  */
3206 function assignment_log_info($log) {
3207     global $CFG, $DB;
3209     return $DB->get_record_sql("SELECT a.name, u.firstname, u.lastname
3210                                   FROM {assignment} a, {user} u
3211                                  WHERE a.id = ? AND u.id = ?", array($log->info, $log->userid));
3214 /**
3215  * Return list of marked submissions that have not been mailed out for currently enrolled students
3216  *
3217  * @return array
3218  */
3219 function assignment_get_unmailed_submissions($starttime, $endtime) {
3220     global $CFG, $DB;
3222     return $DB->get_records_sql("SELECT s.*, a.course, a.name
3223                                    FROM {assignment_submissions} s,
3224                                         {assignment} a
3225                                   WHERE s.mailed = 0
3226                                         AND s.timemarked <= ?
3227                                         AND s.timemarked >= ?
3228                                         AND s.assignment = a.id", array($endtime, $starttime));
3231 /**
3232  * Counts all real assignment submissions by ENROLLED students (not empty ones)
3233  *
3234  * There are also assignment type methods count_real_submissions() which in the default
3235  * implementation simply call this function.
3236  * @param $groupid int optional If nonzero then count is restricted to this group
3237  * @return int The number of submissions
3238  */
3239 function assignment_count_real_submissions($cm, $groupid=0) {
3240     global $CFG, $DB;
3242     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
3244     // this is all the users with this capability set, in this context or higher
3245     if ($users = get_enrolled_users($context, 'mod/assignment:view', $groupid, 'u.id')) {
3246         $users = array_keys($users);
3247     }
3249     // if groupmembersonly used, remove users who are not in any group
3250     if ($users and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3251         if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
3252             $users = array_intersect($users, array_keys($groupingusers));
3253         }
3254     }
3256     if (empty($users)) {
3257         return 0;
3258     }
3260     $userlists = implode(',', $users);
3262     return $DB->count_records_sql("SELECT COUNT('x')
3263                                      FROM {assignment_submissions}
3264                                     WHERE assignment = ? AND
3265                                           timemodified > 0 AND
3266                                           userid IN ($userlists)", array($cm->instance));
3270 /**
3271  * Return all assignment submissions by ENROLLED students (even empty)
3272  *
3273  * There are also assignment type methods get_submissions() wich in the default
3274  * implementation simply call this function.
3275  * @param $sort string optional field names for the ORDER BY in the sql query
3276  * @param $dir string optional specifying the sort direction, defaults to DESC
3277  * @return array The submission objects indexed by id
3278  */
3279 function assignment_get_all_submissions($assignment, $sort="", $dir="DESC") {
3280 /// Return all assignment submissions by ENROLLED students (even empty)
3281     global $CFG, $DB;
3283     if ($sort == "lastname" or $sort == "firstname") {
3284         $sort = "u.$sort $dir";
3285     } else if (empty($sort)) {
3286         $sort = "a.timemodified DESC";
3287     } else {
3288         $sort = "a.$sort $dir";
3289     }
3291     /* not sure this is needed at all since assignment already has a course define, so this join?
3292     $select = "s.course = '$assignment->course' AND";
3293     if ($assignment->course == SITEID) {
3294         $select = '';
3295     }*/
3297     return $DB->get_records_sql("SELECT a.*
3298                                    FROM {assignment_submissions} a, {user} u
3299                                   WHERE u.id = a.userid
3300                                         AND a.assignment = ?
3301                                ORDER BY $sort", array($assignment->id));
3305 /**
3306  * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
3307  * for the course (see resource).
3308  *
3309  * Given a course_module object, this function returns any "extra" information that may be needed
3310  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
3311  *
3312  * @param $coursemodule object The coursemodule object (record).
3313  * @return object An object on information that the courses will know about (most noticeably, an icon).
3314  *
3315  */
3316 function assignment_get_coursemodule_info($coursemodule) {
3317     global $CFG, $DB;
3319     if (! $assignment = $DB->get_record('assignment', array('id'=>$coursemodule->instance), 'id, assignmenttype, name')) {
3320         return false;
3321     }
3323     $libfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
3325     if (file_exists($libfile)) {
3326         require_once($libfile);
3327         $assignmentclass = "assignment_$assignment->assignmenttype";
3328         $ass = new $assignmentclass('staticonly');
3329         if ($result = $ass->get_coursemodule_info($coursemodule)) {
3330             return $result;
3331         } else {
3332             $info = new stdClass();
3333             $info->name = $assignment->name;
3334             return $info;
3335         }
3337     } else {
3338         debugging('Incorrect assignment type: '.$assignment->assignmenttype);
3339         return false;
3340     }
3345 /// OTHER GENERAL FUNCTIONS FOR ASSIGNMENTS  ///////////////////////////////////////
3347 /**
3348  * Returns an array of installed assignment types indexed and sorted by name
3349  *
3350  * @return array The index is the name of the assignment type, the value its full name from the language strings
3351  */
3352 function assignment_types() {
3353     $types = array();