3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * assignment_base is the base class for assignment types
21 * This class provides all the functionality for an assignment
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
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);
41 * Standard base class for all assignment submodules (assignment types).
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
47 class assignment_base {
50 const FILTER_SUBMITTED = 1;
51 const FILTER_REQUIRE_GRADING = 2;
74 * @todo document this var
78 * @todo document this var
85 * Constructor for the base assignment class
87 * Constructor for the base assignment class.
88 * If cmid is set create the cm, course, assignment objects.
89 * If the assignment is hidden and the user is not a teacher then
90 * this prints a page header and notice.
94 * @param int $cmid the current course module id - not set for new assignments
95 * @param object $assignment usually null, but if we have it we pass it to save db access
96 * @param object $cm usually null, but if we have it we pass it to save db access
97 * @param object $course usually null, but if we have it we pass it to save db access
99 function assignment_base($cmid='staticonly', $assignment=NULL, $cm=NULL, $course=NULL) {
102 if ($cmid == 'staticonly') {
103 //use static functions only!
111 } else if (! $this->cm = get_coursemodule_from_id('assignment', $cmid)) {
112 print_error('invalidcoursemodule');
115 $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
118 $this->course = $course;
119 } else if ($this->cm->course == $COURSE->id) {
120 $this->course = $COURSE;
121 } else if (! $this->course = $DB->get_record('course', array('id'=>$this->cm->course))) {
122 print_error('invalidid', 'assignment');
124 $this->coursecontext = get_context_instance(CONTEXT_COURSE, $this->course->id);
125 $courseshortname = format_text($this->course->shortname, true, array('context' => $this->coursecontext));
128 $this->assignment = $assignment;
129 } else if (! $this->assignment = $DB->get_record('assignment', array('id'=>$this->cm->instance))) {
130 print_error('invalidid', 'assignment');
133 $this->assignment->cmidnumber = $this->cm->idnumber; // compatibility with modedit assignment obj
134 $this->assignment->courseid = $this->course->id; // compatibility with modedit assignment obj
136 $this->strassignment = get_string('modulename', 'assignment');
137 $this->strassignments = get_string('modulenameplural', 'assignment');
138 $this->strsubmissions = get_string('submissions', 'assignment');
139 $this->strlastmodified = get_string('lastmodified');
140 $this->pagetitle = strip_tags($courseshortname.': '.$this->strassignment.': '.format_string($this->assignment->name, true, array('context' => $this->context)));
142 // visibility handled by require_login() with $cm parameter
143 // get current group only when really needed
145 /// Set up things for a HTML editor if it's needed
146 $this->defaultformat = editors_get_preferred_format();
150 * Display the assignment, used by view.php
152 * This in turn calls the methods producing individual parts of the page
156 $context = get_context_instance(CONTEXT_MODULE,$this->cm->id);
157 require_capability('mod/assignment:view', $context);
159 add_to_log($this->course->id, "assignment", "view", "view.php?id={$this->cm->id}",
160 $this->assignment->id, $this->cm->id);
162 $this->view_header();
168 $this->view_feedback();
170 $this->view_footer();
174 * Display the header and top of a page
176 * (this doesn't change much for assignment types)
177 * This is used by the view() method to print the header of view.php but
178 * it can be used on other pages in which case the string to denote the
179 * page in the navigation trail should be passed as an argument
182 * @param string $subpage Description of subpage to be used in navigation trail
184 function view_header($subpage='') {
185 global $CFG, $PAGE, $OUTPUT;
188 $PAGE->navbar->add($subpage);
191 $PAGE->set_title($this->pagetitle);
192 $PAGE->set_heading($this->course->fullname);
194 echo $OUTPUT->header();
196 groups_print_activity_menu($this->cm, $CFG->wwwroot . '/mod/assignment/view.php?id=' . $this->cm->id);
198 echo '<div class="reportlink">'.$this->submittedlink().'</div>';
199 echo '<div class="clearer"></div>';
204 * Display the assignment intro
206 * This will most likely be extended by assignment type plug-ins
207 * The default implementation prints the assignment description in a box
209 function view_intro() {
211 echo $OUTPUT->box_start('generalbox boxaligncenter', 'intro');
212 echo format_module_intro('assignment', $this->assignment, $this->cm->id);
213 echo $OUTPUT->box_end();
214 plagiarism_print_disclosure($this->cm->id);
218 * Display the assignment dates
220 * Prints the assignment start and end dates in a box.
221 * This will be suitable for most assignment types
223 function view_dates() {
225 if (!$this->assignment->timeavailable && !$this->assignment->timedue) {
229 echo $OUTPUT->box_start('generalbox boxaligncenter', 'dates');
231 if ($this->assignment->timeavailable) {
232 echo '<tr><td class="c0">'.get_string('availabledate','assignment').':</td>';
233 echo ' <td class="c1">'.userdate($this->assignment->timeavailable).'</td></tr>';
235 if ($this->assignment->timedue) {
236 echo '<tr><td class="c0">'.get_string('duedate','assignment').':</td>';
237 echo ' <td class="c1">'.userdate($this->assignment->timedue).'</td></tr>';
240 echo $OUTPUT->box_end();
245 * Display the bottom and footer of a page
247 * This default method just prints the footer.
248 * This will be suitable for most assignment types
250 function view_footer() {
252 echo $OUTPUT->footer();
256 * Display the feedback to the student
258 * This default method prints the teacher picture and name, date when marked,
259 * grade and teacher submissioncomment.
260 * If advanced grading is used the method render_grade from the
261 * advanced grading controller is called to display the grade.
266 * @param object $submission The submission object or NULL in which case it will be loaded
268 function view_feedback($submission=NULL) {
269 global $USER, $CFG, $DB, $OUTPUT, $PAGE;
270 require_once($CFG->libdir.'/gradelib.php');
271 require_once("$CFG->dirroot/grade/grading/lib.php");
273 if (!$submission) { /// Get submission for this assignment
275 $submission = $this->get_submission($userid);
277 $userid = $submission->userid;
279 // Check the user can submit
280 $canviewfeedback = ($userid == $USER->id && has_capability('mod/assignment:submit', $this->context, $USER->id, false));
281 // If not then check if the user still has the view cap and has a previous submission
282 $canviewfeedback = $canviewfeedback || (!empty($submission) && $submission->userid == $USER->id && has_capability('mod/assignment:view', $this->context));
283 // Or if user can grade (is a teacher or admin)
284 $canviewfeedback = $canviewfeedback || has_capability('mod/assignment:grade', $this->context);
286 if (!$canviewfeedback) {
287 // can not view or submit assignments -> no feedback
291 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid);
292 $item = $grading_info->items[0];
293 $grade = $item->grades[$userid];
295 if ($grade->hidden or $grade->grade === false) { // hidden or error
299 if ($grade->grade === null and empty($grade->str_feedback)) { /// Nothing to show yet
303 $graded_date = $grade->dategraded;
304 $graded_by = $grade->usermodified;
306 /// We need the teacher info
307 if (!$teacher = $DB->get_record('user', array('id'=>$graded_by))) {
308 print_error('cannotfindteacher');
311 /// Print the feedback
312 echo $OUTPUT->heading(get_string('feedbackfromteacher', 'assignment', fullname($teacher)));
314 echo '<table cellspacing="0" class="feedback">';
317 echo '<td class="left picture">';
319 echo $OUTPUT->user_picture($teacher);
322 echo '<td class="topic">';
323 echo '<div class="from">';
325 echo '<div class="fullname">'.fullname($teacher).'</div>';
327 echo '<div class="time">'.userdate($graded_date).'</div>';
333 echo '<td class="left side"> </td>';
334 echo '<td class="content">';
335 $gradestr = '<div class="grade">'. get_string("grade").': '.$grade->str_long_grade. '</div>';
336 if (!empty($submission) && $controller = get_grading_manager($this->context, 'mod_assignment', 'submission')->get_active_controller()) {
337 $controller->set_grade_range(make_grades_menu($this->assignment->grade));
338 echo $controller->render_grade($PAGE, $submission->id, $item, $gradestr, has_capability('mod/assignment:grade', $this->context));
342 echo '<div class="clearer"></div>';
344 echo '<div class="comment">';
345 echo $grade->str_feedback;
349 if ($this->type == 'uploadsingle') { //@TODO: move to overload view_feedback method in the class or is uploadsingle merging into upload?
350 $responsefiles = $this->print_responsefiles($submission->userid, true);
351 if (!empty($responsefiles)) {
353 echo '<td class="left side"> </td>';
354 echo '<td class="content">';
364 * Returns a link with info about the state of the assignment submissions
366 * This is used by view_header to put this link at the top right of the page.
367 * For teachers it gives the number of submitted assignments with a link
368 * For students it gives the time of their submission.
369 * This will be suitable for most assignment types.
373 * @param bool $allgroup print all groups info if user can access all groups, suitable for index.php
376 function submittedlink($allgroups=false) {
381 $urlbase = "{$CFG->wwwroot}/mod/assignment/";
383 $context = get_context_instance(CONTEXT_MODULE,$this->cm->id);
384 if (has_capability('mod/assignment:grade', $context)) {
385 if ($allgroups and has_capability('moodle/site:accessallgroups', $context)) {
388 $group = groups_get_activity_group($this->cm);
390 if ($this->type == 'offline') {
391 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm->id.'">'.
392 get_string('viewfeedback', 'assignment').'</a>';
393 } else if ($count = $this->count_real_submissions($group)) {
394 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm->id.'">'.
395 get_string('viewsubmissions', 'assignment', $count).'</a>';
397 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm->id.'">'.
398 get_string('noattempts', 'assignment').'</a>';
402 if ($submission = $this->get_submission($USER->id)) {
403 if ($submission->timemodified) {
404 if ($submission->timemodified <= $this->assignment->timedue || empty($this->assignment->timedue)) {
405 $submitted = '<span class="early">'.userdate($submission->timemodified).'</span>';
407 $submitted = '<span class="late">'.userdate($submission->timemodified).'</span>';
419 * @todo Document this function
421 function setup_elements(&$mform) {
426 * Any preprocessing needed for the settings form for
427 * this assignment type
429 * @param array $default_values - array to fill in with the default values
430 * in the form 'formelement' => 'value'
431 * @param object $form - the form that is to be displayed
434 function form_data_preprocessing(&$default_values, $form) {
438 * Any extra validation checks needed for the settings
439 * form for this assignment type
441 * See lib/formslib.php, 'validation' function for details
443 function form_validation($data, $files) {
448 * Create a new assignment activity
450 * Given an object containing all the necessary data,
451 * (defined by the form in mod_form.php) this function
452 * will create a new instance and return the id number
453 * of the new instance.
454 * The due data is added to the calendar
455 * This is common to all assignment types.
459 * @param object $assignment The data from the form on mod_form.php
460 * @return int The id of the assignment
462 function add_instance($assignment) {
465 $assignment->timemodified = time();
466 $assignment->courseid = $assignment->course;
468 $returnid = $DB->insert_record("assignment", $assignment);
469 $assignment->id = $returnid;
471 if ($assignment->timedue) {
472 $event = new stdClass();
473 $event->name = $assignment->name;
474 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
475 $event->courseid = $assignment->course;
478 $event->modulename = 'assignment';
479 $event->instance = $returnid;
480 $event->eventtype = 'due';
481 $event->timestart = $assignment->timedue;
482 $event->timeduration = 0;
484 calendar_event::create($event);
487 assignment_grade_item_update($assignment);
493 * Deletes an assignment activity
495 * Deletes all database records, files and calendar events for this assignment.
499 * @param object $assignment The assignment to be deleted
500 * @return boolean False indicates error
502 function delete_instance($assignment) {
505 $assignment->courseid = $assignment->course;
509 // now get rid of all files
510 $fs = get_file_storage();
511 if ($cm = get_coursemodule_from_instance('assignment', $assignment->id)) {
512 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
513 $fs->delete_area_files($context->id);
516 if (! $DB->delete_records('assignment_submissions', array('assignment'=>$assignment->id))) {
520 if (! $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
524 if (! $DB->delete_records('assignment', array('id'=>$assignment->id))) {
527 $mod = $DB->get_field('modules','id',array('name'=>'assignment'));
529 assignment_grade_item_delete($assignment);
535 * Updates a new assignment activity
537 * Given an object containing all the necessary data,
538 * (defined by the form in mod_form.php) this function
539 * will update the assignment instance and return the id number
540 * The due date is updated in the calendar
541 * This is common to all assignment types.
545 * @param object $assignment The data from the form on mod_form.php
546 * @return bool success
548 function update_instance($assignment) {
551 $assignment->timemodified = time();
553 $assignment->id = $assignment->instance;
554 $assignment->courseid = $assignment->course;
556 $DB->update_record('assignment', $assignment);
558 if ($assignment->timedue) {
559 $event = new stdClass();
561 if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
563 $event->name = $assignment->name;
564 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
565 $event->timestart = $assignment->timedue;
567 $calendarevent = calendar_event::load($event->id);
568 $calendarevent->update($event);
570 $event = new stdClass();
571 $event->name = $assignment->name;
572 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
573 $event->courseid = $assignment->course;
576 $event->modulename = 'assignment';
577 $event->instance = $assignment->id;
578 $event->eventtype = 'due';
579 $event->timestart = $assignment->timedue;
580 $event->timeduration = 0;
582 calendar_event::create($event);
585 $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id));
588 // get existing grade item
589 assignment_grade_item_update($assignment);
595 * Update grade item for this submission.
597 function update_grade($submission) {
598 assignment_update_grades($this->assignment, $submission->userid);
602 * Top-level function for handling of submissions called by submissions.php
604 * This is for handling the teacher interaction with the grading interface
605 * This should be suitable for most assignment types.
608 * @param string $mode Specifies the kind of teacher interaction taking place
610 function submissions($mode) {
611 ///The main switch is changed to facilitate
612 ///1) Batch fast grading
613 ///2) Skip to the next one on the popup
614 ///3) Save and Skip to the next one on the popup
616 //make user global so we can use the id
617 global $USER, $OUTPUT, $DB, $PAGE;
619 $mailinfo = optional_param('mailinfo', null, PARAM_BOOL);
621 if (optional_param('next', null, PARAM_BOOL)) {
624 if (optional_param('saveandnext', null, PARAM_BOOL)) {
628 if (is_null($mailinfo)) {
629 if (optional_param('sesskey', null, PARAM_BOOL)) {
630 set_user_preference('assignment_mailinfo', $mailinfo);
632 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
635 set_user_preference('assignment_mailinfo', $mailinfo);
638 if (!($this->validate_and_preprocess_feedback())) {
639 // form was submitted ('Save' or 'Save and next' was pressed, but validation failed)
640 $this->display_submission();
645 case 'grade': // We are in a main window grading
646 if ($submission = $this->process_feedback()) {
647 $this->display_submissions(get_string('changessaved'));
649 $this->display_submissions();
653 case 'single': // We are in a main window displaying one submission
654 if ($submission = $this->process_feedback()) {
655 $this->display_submissions(get_string('changessaved'));
657 $this->display_submission();
661 case 'all': // Main window, display everything
662 $this->display_submissions();
666 ///do the fast grading stuff - this process should work for all 3 subclasses
670 if (isset($_POST['submissioncomment'])) {
671 $col = 'submissioncomment';
674 if (isset($_POST['menu'])) {
679 //both submissioncomment and grade columns collapsed..
680 $this->display_submissions();
684 foreach ($_POST[$col] as $id => $unusedvalue){
686 $id = (int)$id; //clean parameter name
688 $this->process_outcomes($id);
690 if (!$submission = $this->get_submission($id)) {
691 $submission = $this->prepare_new_submission($id);
692 $newsubmission = true;
694 $newsubmission = false;
696 unset($submission->data1); // Don't need to update this.
697 unset($submission->data2); // Don't need to update this.
699 //for fast grade, we need to check if any changes take place
703 $grade = $_POST['menu'][$id];
704 $updatedb = $updatedb || ($submission->grade != $grade);
705 $submission->grade = $grade;
707 if (!$newsubmission) {
708 unset($submission->grade); // Don't need to update this.
712 $commentvalue = trim($_POST['submissioncomment'][$id]);
713 $updatedb = $updatedb || ($submission->submissioncomment != $commentvalue);
714 $submission->submissioncomment = $commentvalue;
716 unset($submission->submissioncomment); // Don't need to update this.
719 $submission->teacher = $USER->id;
721 $submission->mailed = (int)(!$mailinfo);
724 $submission->timemarked = time();
726 //if it is not an update, we don't change the last modified time etc.
727 //this will also not write into database if no submissioncomment and grade is entered.
730 if ($newsubmission) {
731 if (!isset($submission->submissioncomment)) {
732 $submission->submissioncomment = '';
734 $sid = $DB->insert_record('assignment_submissions', $submission);
735 $submission->id = $sid;
737 $DB->update_record('assignment_submissions', $submission);
740 // trigger grade event
741 $this->update_grade($submission);
743 //add to log only if updating
744 add_to_log($this->course->id, 'assignment', 'update grades',
745 'submissions.php?id='.$this->cm->id.'&user='.$submission->userid,
746 $submission->userid, $this->cm->id);
751 $message = $OUTPUT->notification(get_string('changessaved'), 'notifysuccess');
753 $this->display_submissions($message);
758 ///We are in pop up. save the current one and go to the next one.
759 //first we save the current changes
760 if ($submission = $this->process_feedback()) {
761 //print_heading(get_string('changessaved'));
762 //$extra_javascript = $this->update_main_listing($submission);
766 /// We are currently in pop up, but we want to skip to next one without saving.
767 /// This turns out to be similar to a single case
768 /// The URL used is for the next submission.
769 $offset = required_param('offset', PARAM_INT);
770 $nextid = required_param('nextid', PARAM_INT);
771 $id = required_param('id', PARAM_INT);
772 $filter = optional_param('filter', self::FILTER_ALL, PARAM_INT);
774 if ($mode == 'next' || $filter !== self::FILTER_REQUIRE_GRADING) {
775 $offset = (int)$offset+1;
777 $redirect = new moodle_url('submissions.php',
778 array('id' => $id, 'offset' => $offset, 'userid' => $nextid,
779 'mode' => 'single', 'filter' => $filter));
785 $this->display_submission();
789 echo "something seriously is wrong!!";
795 * Checks if grading method allows quickgrade mode. At the moment it is hardcoded
796 * that advanced grading methods do not allow quickgrade.
798 * Assignment type plugins are not allowed to override this method
802 public final function quickgrade_mode_allowed() {
804 require_once("$CFG->dirroot/grade/grading/lib.php");
805 if ($controller = get_grading_manager($this->context, 'mod_assignment', 'submission')->get_active_controller()) {
812 * Helper method updating the listing on the main script from popup using javascript
816 * @param $submission object The submission whose data is to be updated on the main page
818 function update_main_listing($submission) {
819 global $SESSION, $CFG, $OUTPUT;
823 $perpage = get_user_preferences('assignment_perpage', 10);
825 $quickgrade = get_user_preferences('assignment_quickgrade', 0) && $this->quickgrade_mode_allowed();
827 /// Run some Javascript to try and update the parent page
828 $output .= '<script type="text/javascript">'."\n<!--\n";
829 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['submissioncomment'])) {
831 $output.= 'opener.document.getElementById("submissioncomment'.$submission->userid.'").value="'
832 .trim($submission->submissioncomment).'";'."\n";
834 $output.= 'opener.document.getElementById("com'.$submission->userid.
835 '").innerHTML="'.shorten_text(trim(strip_tags($submission->submissioncomment)), 15)."\";\n";
839 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['grade'])) {
840 //echo optional_param('menuindex');
842 $output.= 'opener.document.getElementById("menumenu'.$submission->userid.
843 '").selectedIndex="'.optional_param('menuindex', 0, PARAM_INT).'";'."\n";
845 $output.= 'opener.document.getElementById("g'.$submission->userid.'").innerHTML="'.
846 $this->display_grade($submission->grade)."\";\n";
849 //need to add student's assignments in there too.
850 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['timemodified']) &&
851 $submission->timemodified) {
852 $output.= 'opener.document.getElementById("ts'.$submission->userid.
853 '").innerHTML="'.addslashes_js($this->print_student_answer($submission->userid)).userdate($submission->timemodified)."\";\n";
856 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['timemarked']) &&
857 $submission->timemarked) {
858 $output.= 'opener.document.getElementById("tt'.$submission->userid.
859 '").innerHTML="'.userdate($submission->timemarked)."\";\n";
862 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['status'])) {
863 $output.= 'opener.document.getElementById("up'.$submission->userid.'").className="s1";';
864 $buttontext = get_string('update');
865 $url = new moodle_url('/mod/assignment/submissions.php', array(
866 'id' => $this->cm->id,
867 'userid' => $submission->userid,
869 'offset' => (optional_param('offset', '', PARAM_INT)-1)));
870 $button = $OUTPUT->action_link($url, $buttontext, new popup_action('click', $url, 'grade'.$submission->userid, array('height' => 450, 'width' => 700)), array('ttile'=>$buttontext));
872 $output .= 'opener.document.getElementById("up'.$submission->userid.'").innerHTML="'.addslashes_js($button).'";';
875 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $submission->userid);
877 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['finalgrade'])) {
878 $output.= 'opener.document.getElementById("finalgrade_'.$submission->userid.
879 '").innerHTML="'.$grading_info->items[0]->grades[$submission->userid]->str_grade.'";'."\n";
882 if (!empty($CFG->enableoutcomes) and empty($SESSION->flextable['mod-assignment-submissions']->collapse['outcome'])) {
884 if (!empty($grading_info->outcomes)) {
885 foreach($grading_info->outcomes as $n=>$outcome) {
886 if ($outcome->grades[$submission->userid]->locked) {
891 $output.= 'opener.document.getElementById("outcome_'.$n.'_'.$submission->userid.
892 '").selectedIndex="'.$outcome->grades[$submission->userid]->grade.'";'."\n";
895 $options = make_grades_menu(-$outcome->scaleid);
896 $options[0] = get_string('nooutcome', 'grades');
897 $output.= 'opener.document.getElementById("outcome_'.$n.'_'.$submission->userid.'").innerHTML="'.$options[$outcome->grades[$submission->userid]->grade]."\";\n";
904 $output .= "\n-->\n</script>";
909 * Return a grade in user-friendly form, whether it's a scale or not
912 * @param mixed $grade
913 * @return string User-friendly representation of grade
915 function display_grade($grade) {
918 static $scalegrades = array(); // Cache scales for each assignment - they might have different scales!!
920 if ($this->assignment->grade >= 0) { // Normal number
924 return $grade.' / '.$this->assignment->grade;
928 if (empty($scalegrades[$this->assignment->id])) {
929 if ($scale = $DB->get_record('scale', array('id'=>-($this->assignment->grade)))) {
930 $scalegrades[$this->assignment->id] = make_menu_from_list($scale->scale);
935 if (isset($scalegrades[$this->assignment->id][$grade])) {
936 return $scalegrades[$this->assignment->id][$grade];
943 * Display a single submission, ready for grading on a popup window
945 * This default method prints the teacher info and submissioncomment box at the top and
946 * the student info and submission at the bottom.
947 * This method also fetches the necessary data in order to be able to
948 * provide a "Next submission" button.
949 * Calls preprocess_submission() to give assignment type plug-ins a chance
950 * to process submissions before they are graded
951 * This method gets its arguments from the page parameters userid and offset
955 * @param string $extra_javascript
957 function display_submission($offset=-1,$userid =-1, $display=true) {
958 global $CFG, $DB, $PAGE, $OUTPUT, $USER;
959 require_once($CFG->libdir.'/gradelib.php');
960 require_once($CFG->libdir.'/tablelib.php');
961 require_once("$CFG->dirroot/repository/lib.php");
962 require_once("$CFG->dirroot/grade/grading/lib.php");
964 $userid = required_param('userid', PARAM_INT);
967 $offset = required_param('offset', PARAM_INT);//offset for where to start looking for student.
969 $filter = optional_param('filter', 0, PARAM_INT);
971 if (!$user = $DB->get_record('user', array('id'=>$userid))) {
972 print_error('nousers');
975 if (!$submission = $this->get_submission($user->id)) {
976 $submission = $this->prepare_new_submission($userid);
978 if ($submission->timemodified > $submission->timemarked) {
979 $subtype = 'assignmentnew';
981 $subtype = 'assignmentold';
984 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array($user->id));
985 $gradingdisabled = $grading_info->items[0]->grades[$userid]->locked || $grading_info->items[0]->grades[$userid]->overridden;
987 /// construct SQL, using current offset to find the data of the next student
988 $course = $this->course;
989 $assignment = $this->assignment;
991 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
993 //reset filter to all for offline assignment
994 if ($assignment->assignmenttype == 'offline' && $filter == self::FILTER_SUBMITTED) {
995 $filter = self::FILTER_ALL;
997 /// Get all ppl that can submit assignments
999 $currentgroup = groups_get_activity_group($cm);
1000 $users = get_enrolled_users($context, 'mod/assignment:submit', $currentgroup, 'u.id');
1002 $users = array_keys($users);
1003 // if groupmembersonly used, remove users who are not in any group
1004 if (!empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
1005 if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
1006 $users = array_intersect($users, array_keys($groupingusers));
1013 if($filter == self::FILTER_SUBMITTED) {
1014 $where .= 's.timemodified > 0 AND ';
1015 } else if($filter == self::FILTER_REQUIRE_GRADING) {
1016 $where .= 's.timemarked < s.timemodified AND ';
1020 $userfields = user_picture::fields('u', array('lastaccess'));
1021 $select = "SELECT $userfields,
1022 s.id AS submissionid, s.grade, s.submissioncomment,
1023 s.timemodified, s.timemarked,
1024 CASE WHEN s.timemarked > 0 AND s.timemarked >= s.timemodified THEN 1
1025 ELSE 0 END AS status ";
1027 $sql = 'FROM {user} u '.
1028 'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
1029 AND s.assignment = '.$this->assignment->id.' '.
1030 'WHERE '.$where.'u.id IN ('.implode(',', $users).') ';
1032 if ($sort = flexible_table::get_sort_for_table('mod-assignment-submissions')) {
1033 $sort = 'ORDER BY '.$sort.' ';
1035 $auser = $DB->get_records_sql($select.$sql.$sort, null, $offset, 2);
1037 if (is_array($auser) && count($auser)>1) {
1038 $nextuser = next($auser);
1039 $nextid = $nextuser->id;
1043 if ($submission->teacher) {
1044 $teacher = $DB->get_record('user', array('id'=>$submission->teacher));
1050 $this->preprocess_submission($submission);
1052 $mformdata = new stdClass();
1053 $mformdata->context = $this->context;
1054 $mformdata->maxbytes = $this->course->maxbytes;
1055 $mformdata->courseid = $this->course->id;
1056 $mformdata->teacher = $teacher;
1057 $mformdata->assignment = $assignment;
1058 $mformdata->submission = $submission;
1059 $mformdata->lateness = $this->display_lateness($submission->timemodified);
1060 $mformdata->auser = $auser;
1061 $mformdata->user = $user;
1062 $mformdata->offset = $offset;
1063 $mformdata->userid = $userid;
1064 $mformdata->cm = $this->cm;
1065 $mformdata->grading_info = $grading_info;
1066 $mformdata->enableoutcomes = $CFG->enableoutcomes;
1067 $mformdata->grade = $this->assignment->grade;
1068 $mformdata->gradingdisabled = $gradingdisabled;
1069 $mformdata->nextid = $nextid;
1070 $mformdata->submissioncomment= $submission->submissioncomment;
1071 $mformdata->submissioncommentformat= FORMAT_HTML;
1072 $mformdata->submission_content= $this->print_user_files($user->id,true);
1073 $mformdata->filter = $filter;
1074 $mformdata->mailinfo = get_user_preferences('assignment_mailinfo', 0);
1075 if ($assignment->assignmenttype == 'upload') {
1076 $mformdata->fileui_options = array('subdirs'=>1, 'maxbytes'=>$assignment->maxbytes, 'maxfiles'=>$assignment->var1, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL);
1077 } elseif ($assignment->assignmenttype == 'uploadsingle') {
1078 $mformdata->fileui_options = array('subdirs'=>0, 'maxbytes'=>$CFG->userquota, 'maxfiles'=>1, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL);
1080 $advancedgradingwarning = false;
1081 $gradingmanager = get_grading_manager($this->context, 'mod_assignment', 'submission');
1082 if ($gradingmethod = $gradingmanager->get_active_method()) {
1083 $controller = $gradingmanager->get_controller($gradingmethod);
1084 if ($controller->is_form_available()) {
1086 if (!empty($submission->id)) {
1087 $itemid = $submission->id;
1089 if ($gradingdisabled && $itemid) {
1090 $mformdata->advancedgradinginstance = $controller->get_current_instance($USER->id, $itemid);
1091 } else if (!$gradingdisabled) {
1092 $instanceid = optional_param('advancedgradinginstanceid', 0, PARAM_INT);
1093 $mformdata->advancedgradinginstance = $controller->get_or_create_instance($instanceid, $USER->id, $itemid);
1096 $advancedgradingwarning = $controller->form_unavailable_notification();
1100 $submitform = new mod_assignment_grading_form( null, $mformdata );
1103 $ret_data = new stdClass();
1104 $ret_data->mform = $submitform;
1105 if (isset($mformdata->fileui_options)) {
1106 $ret_data->fileui_options = $mformdata->fileui_options;
1111 if ($submitform->is_cancelled()) {
1112 redirect('submissions.php?id='.$this->cm->id);
1115 $submitform->set_data($mformdata);
1117 $PAGE->set_title($this->course->fullname . ': ' .get_string('feedback', 'assignment').' - '.fullname($user, true));
1118 $PAGE->set_heading($this->course->fullname);
1119 $PAGE->navbar->add(get_string('submissions', 'assignment'), new moodle_url('/mod/assignment/submissions.php', array('id'=>$cm->id)));
1120 $PAGE->navbar->add(fullname($user, true));
1122 echo $OUTPUT->header();
1123 echo $OUTPUT->heading(get_string('feedback', 'assignment').': '.fullname($user, true));
1125 // display mform here...
1126 if ($advancedgradingwarning) {
1127 echo $OUTPUT->notification($advancedgradingwarning, 'error');
1129 $submitform->display();
1131 $customfeedback = $this->custom_feedbackform($submission, true);
1132 if (!empty($customfeedback)) {
1133 echo $customfeedback;
1136 echo $OUTPUT->footer();
1140 * Preprocess submission before grading
1142 * Called by display_submission()
1143 * The default type does nothing here.
1145 * @param object $submission The submission object
1147 function preprocess_submission(&$submission) {
1151 * Display all the submissions ready for grading
1157 * @param string $message
1160 function display_submissions($message='') {
1161 global $CFG, $DB, $USER, $DB, $OUTPUT, $PAGE;
1162 require_once($CFG->libdir.'/gradelib.php');
1164 /* first we check to see if the form has just been submitted
1165 * to request user_preference updates
1168 $filters = array(self::FILTER_ALL => get_string('all'),
1169 self::FILTER_REQUIRE_GRADING => get_string('requiregrading', 'assignment'));
1171 $updatepref = optional_param('updatepref', 0, PARAM_BOOL);
1173 $perpage = optional_param('perpage', 10, PARAM_INT);
1174 $perpage = ($perpage <= 0) ? 10 : $perpage ;
1175 $filter = optional_param('filter', 0, PARAM_INT);
1176 set_user_preference('assignment_perpage', $perpage);
1177 set_user_preference('assignment_quickgrade', optional_param('quickgrade', 0, PARAM_BOOL));
1178 set_user_preference('assignment_filter', $filter);
1181 /* next we get perpage and quickgrade (allow quick grade) params
1184 $perpage = get_user_preferences('assignment_perpage', 10);
1185 $quickgrade = get_user_preferences('assignment_quickgrade', 0) && $this->quickgrade_mode_allowed();
1186 $filter = get_user_preferences('assignment_filter', 0);
1187 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id);
1189 if (!empty($CFG->enableoutcomes) and !empty($grading_info->outcomes)) {
1190 $uses_outcomes = true;
1192 $uses_outcomes = false;
1195 $page = optional_param('page', 0, PARAM_INT);
1196 $strsaveallfeedback = get_string('saveallfeedback', 'assignment');
1198 /// Some shortcuts to make the code read better
1200 $course = $this->course;
1201 $assignment = $this->assignment;
1203 $hassubmission = false;
1205 // reset filter to all for offline assignment only.
1206 if ($assignment->assignmenttype == 'offline') {
1207 if ($filter == self::FILTER_SUBMITTED) {
1208 $filter = self::FILTER_ALL;
1211 $filters[self::FILTER_SUBMITTED] = get_string('submitted', 'assignment');
1214 $tabindex = 1; //tabindex for quick grading tabbing; Not working for dropdowns yet
1215 add_to_log($course->id, 'assignment', 'view submission', 'submissions.php?id='.$this->cm->id, $this->assignment->id, $this->cm->id);
1217 $PAGE->set_title(format_string($this->assignment->name,true));
1218 $PAGE->set_heading($this->course->fullname);
1219 echo $OUTPUT->header();
1221 echo '<div class="usersubmissions">';
1223 //hook to allow plagiarism plugins to update status/print links.
1224 plagiarism_update_status($this->course, $this->cm);
1226 $course_context = get_context_instance(CONTEXT_COURSE, $course->id);
1227 if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
1228 echo '<div class="allcoursegrades"><a href="' . $CFG->wwwroot . '/grade/report/grader/index.php?id=' . $course->id . '">'
1229 . get_string('seeallcoursegrades', 'grades') . '</a></div>';
1232 if (!empty($message)) {
1233 echo $message; // display messages here if any
1236 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1238 /// Check to see if groups are being used in this assignment
1240 /// find out current groups mode
1241 $groupmode = groups_get_activity_groupmode($cm);
1242 $currentgroup = groups_get_activity_group($cm, true);
1243 groups_print_activity_menu($cm, $CFG->wwwroot . '/mod/assignment/submissions.php?id=' . $this->cm->id);
1245 /// Print quickgrade form around the table
1247 $formattrs = array();
1248 $formattrs['action'] = new moodle_url('/mod/assignment/submissions.php');
1249 $formattrs['id'] = 'fastg';
1250 $formattrs['method'] = 'post';
1252 echo html_writer::start_tag('form', $formattrs);
1253 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'id', 'value'=> $this->cm->id));
1254 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'mode', 'value'=> 'fastgrade'));
1255 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'page', 'value'=> $page));
1256 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=> sesskey()));
1259 /// Get all ppl that are allowed to submit assignments
1260 list($esql, $params) = get_enrolled_sql($context, 'mod/assignment:submit', $currentgroup);
1262 if ($filter == self::FILTER_ALL) {
1263 $sql = "SELECT u.id FROM {user} u ".
1264 "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1265 "WHERE u.deleted = 0 AND eu.id=u.id ";
1267 $wherefilter = ' AND s.assignment = '. $this->assignment->id;
1268 $assignmentsubmission = "LEFT JOIN {assignment_submissions} s ON (u.id = s.userid) ";
1269 if($filter == self::FILTER_SUBMITTED) {
1270 $wherefilter .= ' AND s.timemodified > 0 ';
1271 } else if($filter == self::FILTER_REQUIRE_GRADING && $assignment->assignmenttype != 'offline') {
1272 $wherefilter .= ' AND s.timemarked < s.timemodified ';
1273 } else { // require grading for offline assignment
1274 $assignmentsubmission = "";
1278 $sql = "SELECT u.id FROM {user} u ".
1279 "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1280 $assignmentsubmission.
1281 "WHERE u.deleted = 0 AND eu.id=u.id ".
1285 $users = $DB->get_records_sql($sql, $params);
1286 if (!empty($users)) {
1287 if($assignment->assignmenttype == 'offline' && $filter == self::FILTER_REQUIRE_GRADING) {
1288 //remove users who has submitted their assignment
1289 foreach ($this->get_submissions() as $submission) {
1290 if (array_key_exists($submission->userid, $users)) {
1291 unset($users[$submission->userid]);
1295 $users = array_keys($users);
1298 // if groupmembersonly used, remove users who are not in any group
1299 if ($users and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
1300 if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
1301 $users = array_intersect($users, array_keys($groupingusers));
1305 $extrafields = get_extra_user_fields($context);
1306 $tablecolumns = array_merge(array('picture', 'fullname'), $extrafields,
1307 array('grade', 'submissioncomment', 'timemodified', 'timemarked', 'status', 'finalgrade'));
1308 if ($uses_outcomes) {
1309 $tablecolumns[] = 'outcome'; // no sorting based on outcomes column
1312 $extrafieldnames = array();
1313 foreach ($extrafields as $field) {
1314 $extrafieldnames[] = get_user_field_name($field);
1316 $tableheaders = array_merge(
1317 array('', get_string('fullnameuser')),
1320 get_string('grade'),
1321 get_string('comment', 'assignment'),
1322 get_string('lastmodified').' ('.get_string('submission', 'assignment').')',
1323 get_string('lastmodified').' ('.get_string('grade').')',
1324 get_string('status'),
1325 get_string('finalgrade', 'grades'),
1327 if ($uses_outcomes) {
1328 $tableheaders[] = get_string('outcome', 'grades');
1331 require_once($CFG->libdir.'/tablelib.php');
1332 $table = new flexible_table('mod-assignment-submissions');
1334 $table->define_columns($tablecolumns);
1335 $table->define_headers($tableheaders);
1336 $table->define_baseurl($CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id.'&currentgroup='.$currentgroup);
1338 $table->sortable(true, 'lastname');//sorted by lastname by default
1339 $table->collapsible(true);
1340 $table->initialbars(true);
1342 $table->column_suppress('picture');
1343 $table->column_suppress('fullname');
1345 $table->column_class('picture', 'picture');
1346 $table->column_class('fullname', 'fullname');
1347 foreach ($extrafields as $field) {
1348 $table->column_class($field, $field);
1350 $table->column_class('grade', 'grade');
1351 $table->column_class('submissioncomment', 'comment');
1352 $table->column_class('timemodified', 'timemodified');
1353 $table->column_class('timemarked', 'timemarked');
1354 $table->column_class('status', 'status');
1355 $table->column_class('finalgrade', 'finalgrade');
1356 if ($uses_outcomes) {
1357 $table->column_class('outcome', 'outcome');
1360 $table->set_attribute('cellspacing', '0');
1361 $table->set_attribute('id', 'attempts');
1362 $table->set_attribute('class', 'submissions');
1363 $table->set_attribute('width', '100%');
1365 $table->no_sorting('finalgrade');
1366 $table->no_sorting('outcome');
1368 // Start working -- this is necessary as soon as the niceties are over
1371 /// Construct the SQL
1372 list($where, $params) = $table->get_sql_where();
1377 if ($filter == self::FILTER_SUBMITTED) {
1378 $where .= 's.timemodified > 0 AND ';
1379 } else if($filter == self::FILTER_REQUIRE_GRADING) {
1381 if ($assignment->assignmenttype != 'offline') {
1382 $where .= 's.timemarked < s.timemodified AND ';
1386 if ($sort = $table->get_sql_sort()) {
1387 $sort = ' ORDER BY '.$sort;
1390 $ufields = user_picture::fields('u', $extrafields);
1391 if (!empty($users)) {
1392 $select = "SELECT $ufields,
1393 s.id AS submissionid, s.grade, s.submissioncomment,
1394 s.timemodified, s.timemarked,
1395 CASE WHEN s.timemarked > 0 AND s.timemarked >= s.timemodified THEN 1
1396 ELSE 0 END AS status ";
1398 $sql = 'FROM {user} u '.
1399 'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
1400 AND s.assignment = '.$this->assignment->id.' '.
1401 'WHERE '.$where.'u.id IN ('.implode(',',$users).') ';
1403 $ausers = $DB->get_records_sql($select.$sql.$sort, $params, $table->get_page_start(), $table->get_page_size());
1405 $table->pagesize($perpage, count($users));
1407 ///offset used to calculate index of student in that particular query, needed for the pop up to know who's next
1408 $offset = $page * $perpage;
1409 $strupdate = get_string('update');
1410 $strgrade = get_string('grade');
1411 $grademenu = make_grades_menu($this->assignment->grade);
1413 if ($ausers !== false) {
1414 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array_keys($ausers));
1415 $endposition = $offset + $perpage;
1416 $currentposition = 0;
1417 foreach ($ausers as $auser) {
1418 if ($currentposition == $offset && $offset < $endposition) {
1419 $final_grade = $grading_info->items[0]->grades[$auser->id];
1420 $grademax = $grading_info->items[0]->grademax;
1421 $final_grade->formatted_grade = round($final_grade->grade,2) .' / ' . round($grademax,2);
1422 $locked_overridden = 'locked';
1423 if ($final_grade->overridden) {
1424 $locked_overridden = 'overridden';
1427 // TODO add here code if advanced grading grade must be reviewed => $auser->status=0
1429 $picture = $OUTPUT->user_picture($auser);
1431 if (empty($auser->submissionid)) {
1432 $auser->grade = -1; //no submission yet
1435 if (!empty($auser->submissionid)) {
1436 $hassubmission = true;
1437 ///Prints student answer and student modified date
1438 ///attach file or print link to student answer, depending on the type of the assignment.
1439 ///Refer to print_student_answer in inherited classes.
1440 if ($auser->timemodified > 0) {
1441 $studentmodified = '<div id="ts'.$auser->id.'">'.$this->print_student_answer($auser->id)
1442 . userdate($auser->timemodified).'</div>';
1444 $studentmodified = '<div id="ts'.$auser->id.'"> </div>';
1446 ///Print grade, dropdown or text
1447 if ($auser->timemarked > 0) {
1448 $teachermodified = '<div id="tt'.$auser->id.'">'.userdate($auser->timemarked).'</div>';
1450 if ($final_grade->locked or $final_grade->overridden) {
1451 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1452 } else if ($quickgrade) {
1453 $attributes = array();
1454 $attributes['tabindex'] = $tabindex++;
1455 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1456 $grade = '<div id="g'.$auser->id.'">'. $menu .'</div>';
1458 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1462 $teachermodified = '<div id="tt'.$auser->id.'"> </div>';
1463 if ($final_grade->locked or $final_grade->overridden) {
1464 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1465 } else if ($quickgrade) {
1466 $attributes = array();
1467 $attributes['tabindex'] = $tabindex++;
1468 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1469 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1471 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1475 if ($final_grade->locked or $final_grade->overridden) {
1476 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($final_grade->str_feedback),15).'</div>';
1478 } else if ($quickgrade) {
1479 $comment = '<div id="com'.$auser->id.'">'
1480 . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1481 . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1483 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($auser->submissioncomment),15).'</div>';
1486 $studentmodified = '<div id="ts'.$auser->id.'"> </div>';
1487 $teachermodified = '<div id="tt'.$auser->id.'"> </div>';
1488 $status = '<div id="st'.$auser->id.'"> </div>';
1490 if ($final_grade->locked or $final_grade->overridden) {
1491 $grade = '<div id="g'.$auser->id.'">'.$final_grade->formatted_grade . '</div>';
1492 $hassubmission = true;
1493 } else if ($quickgrade) { // allow editing
1494 $attributes = array();
1495 $attributes['tabindex'] = $tabindex++;
1496 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1497 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1498 $hassubmission = true;
1500 $grade = '<div id="g'.$auser->id.'">-</div>';
1503 if ($final_grade->locked or $final_grade->overridden) {
1504 $comment = '<div id="com'.$auser->id.'">'.$final_grade->str_feedback.'</div>';
1505 } else if ($quickgrade) {
1506 $comment = '<div id="com'.$auser->id.'">'
1507 . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1508 . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1510 $comment = '<div id="com'.$auser->id.'"> </div>';
1514 if (empty($auser->status)) { /// Confirm we have exclusively 0 or 1
1520 $buttontext = ($auser->status == 1) ? $strupdate : $strgrade;
1522 ///No more buttons, we use popups ;-).
1523 $popup_url = '/mod/assignment/submissions.php?id='.$this->cm->id
1524 . '&userid='.$auser->id.'&mode=single'.'&filter='.$filter.'&offset='.$offset++;
1526 $button = $OUTPUT->action_link($popup_url, $buttontext);
1528 $status = '<div id="up'.$auser->id.'" class="s'.$auser->status.'">'.$button.'</div>';
1530 $finalgrade = '<span id="finalgrade_'.$auser->id.'">'.$final_grade->str_grade.'</span>';
1534 if ($uses_outcomes) {
1536 foreach($grading_info->outcomes as $n=>$outcome) {
1537 $outcomes .= '<div class="outcome"><label>'.$outcome->name.'</label>';
1538 $options = make_grades_menu(-$outcome->scaleid);
1540 if ($outcome->grades[$auser->id]->locked or !$quickgrade) {
1541 $options[0] = get_string('nooutcome', 'grades');
1542 $outcomes .= ': <span id="outcome_'.$n.'_'.$auser->id.'">'.$options[$outcome->grades[$auser->id]->grade].'</span>';
1544 $attributes = array();
1545 $attributes['tabindex'] = $tabindex++;
1546 $attributes['id'] = 'outcome_'.$n.'_'.$auser->id;
1547 $outcomes .= ' '.html_writer::select($options, 'outcome_'.$n.'['.$auser->id.']', $outcome->grades[$auser->id]->grade, array(0=>get_string('nooutcome', 'grades')), $attributes);
1549 $outcomes .= '</div>';
1553 $userlink = '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $auser->id . '&course=' . $course->id . '">' . fullname($auser, has_capability('moodle/site:viewfullnames', $this->context)) . '</a>';
1554 $extradata = array();
1555 foreach ($extrafields as $field) {
1556 $extradata[] = $auser->{$field};
1558 $row = array_merge(array($picture, $userlink), $extradata,
1559 array($grade, $comment, $studentmodified, $teachermodified,
1560 $status, $finalgrade));
1561 if ($uses_outcomes) {
1564 $table->add_data($row);
1568 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)
1569 echo html_writer::start_tag('div', array('class' => 'mod-assignment-download-link'));
1570 echo html_writer::link(new moodle_url('/mod/assignment/submissions.php', array('id' => $this->cm->id, 'download' => 'zip')), get_string('downloadall', 'assignment'));
1571 echo html_writer::end_tag('div');
1573 $table->print_html(); /// Print the whole table
1575 if ($filter == self::FILTER_SUBMITTED) {
1576 echo html_writer::tag('div', get_string('nosubmisson', 'assignment'), array('class'=>'nosubmisson'));
1577 } else if ($filter == self::FILTER_REQUIRE_GRADING) {
1578 echo html_writer::tag('div', get_string('norequiregrading', 'assignment'), array('class'=>'norequiregrading'));
1583 /// Print quickgrade form around the table
1584 if ($quickgrade && $table->started_output && !empty($users)){
1585 $mailinfopref = false;
1586 if (get_user_preferences('assignment_mailinfo', 1)) {
1587 $mailinfopref = true;
1589 $emailnotification = html_writer::checkbox('mailinfo', 1, $mailinfopref, get_string('enablenotification','assignment'));
1591 $emailnotification .= $OUTPUT->help_icon('enablenotification', 'assignment');
1592 echo html_writer::tag('div', $emailnotification, array('class'=>'emailnotification'));
1594 $savefeedback = html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'fastg', 'value'=>get_string('saveallfeedback', 'assignment')));
1595 echo html_writer::tag('div', $savefeedback, array('class'=>'fastgbutton'));
1597 echo html_writer::end_tag('form');
1598 } else if ($quickgrade) {
1599 echo html_writer::end_tag('form');
1603 /// End of fast grading form
1605 /// Mini form for setting user preference
1607 $formaction = new moodle_url('/mod/assignment/submissions.php', array('id'=>$this->cm->id));
1608 $mform = new MoodleQuickForm('optionspref', 'post', $formaction, '', array('class'=>'optionspref'));
1610 $mform->addElement('hidden', 'updatepref');
1611 $mform->setDefault('updatepref', 1);
1612 $mform->addElement('header', 'qgprefs', get_string('optionalsettings', 'assignment'));
1613 $mform->addElement('select', 'filter', get_string('show'), $filters);
1615 $mform->setDefault('filter', $filter);
1617 $mform->addElement('text', 'perpage', get_string('pagesize', 'assignment'), array('size'=>1));
1618 $mform->setDefault('perpage', $perpage);
1620 if ($this->quickgrade_mode_allowed()) {
1621 $mform->addElement('checkbox', 'quickgrade', get_string('quickgrade','assignment'));
1622 $mform->setDefault('quickgrade', $quickgrade);
1623 $mform->addHelpButton('quickgrade', 'quickgrade', 'assignment');
1626 $mform->addElement('submit', 'savepreferences', get_string('savepreferences'));
1630 echo $OUTPUT->footer();
1634 * If the form was cancelled ('Cancel' or 'Next' was pressed), call cancel method
1635 * from advanced grading (if applicable) and returns true
1636 * If the form was submitted, validates it and returns false if validation did not pass.
1637 * If validation passes, preprocess advanced grading (if applicable) and returns true.
1639 * Note to the developers: This is NOT the correct way to implement advanced grading
1640 * in grading form. The assignment grading was written long time ago and unfortunately
1641 * does not fully use the mforms. Usually function is_validated() is called to
1642 * validate the form and get_data() is called to get the data from the form.
1644 * Here we have to push the calculated grade to $_POST['xgrade'] because further processing
1645 * of the form gets the data not from form->get_data(), but from $_POST (using statement
1646 * like $feedback = data_submitted() )
1648 protected function validate_and_preprocess_feedback() {
1650 require_once($CFG->libdir.'/gradelib.php');
1651 if (!($feedback = data_submitted()) || !isset($feedback->userid) || !isset($feedback->offset)) {
1652 return true; // No incoming data, nothing to validate
1654 $userid = required_param('userid', PARAM_INT);
1655 $offset = required_param('offset', PARAM_INT);
1656 $gradinginfo = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array($userid));
1657 $gradingdisabled = $gradinginfo->items[0]->grades[$userid]->locked || $gradinginfo->items[0]->grades[$userid]->overridden;
1658 if ($gradingdisabled) {
1661 $submissiondata = $this->display_submission($offset, $userid, false);
1662 $mform = $submissiondata->mform;
1663 $gradinginstance = $mform->use_advanced_grading();
1664 if (optional_param('cancel', false, PARAM_BOOL) || optional_param('next', false, PARAM_BOOL)) {
1665 // form was cancelled
1666 if ($gradinginstance) {
1667 $gradinginstance->cancel();
1669 } else if ($mform->is_submitted()) {
1670 // form was submitted (= a submit button other than 'cancel' or 'next' has been clicked)
1671 if (!$mform->is_validated()) {
1674 // preprocess advanced grading here
1675 if ($gradinginstance) {
1676 $data = $mform->get_data();
1677 // create submission if it did not exist yet because we need submission->id for storing the grading instance
1678 $submission = $this->get_submission($userid, true);
1679 $_POST['xgrade'] = $gradinginstance->submit_and_get_grade($data->advancedgrading, $submission->id);
1686 * Process teacher feedback submission
1688 * This is called by submissions() when a grading even has taken place.
1689 * It gets its data from the submitted form.
1694 * @return object|bool The updated submission object or false
1696 function process_feedback($formdata=null) {
1697 global $CFG, $USER, $DB;
1698 require_once($CFG->libdir.'/gradelib.php');
1700 if (!$feedback = data_submitted() or !confirm_sesskey()) { // No incoming data?
1704 ///For save and next, we need to know the userid to save, and the userid to go
1705 ///We use a new hidden field in the form, and set it to -1. If it's set, we use this
1706 ///as the userid to store
1707 if ((int)$feedback->saveuserid !== -1){
1708 $feedback->userid = $feedback->saveuserid;
1711 if (!empty($feedback->cancel)) { // User hit cancel button
1715 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $feedback->userid);
1717 // store outcomes if needed
1718 $this->process_outcomes($feedback->userid);
1720 $submission = $this->get_submission($feedback->userid, true); // Get or make one
1722 if (!($grading_info->items[0]->grades[$feedback->userid]->locked ||
1723 $grading_info->items[0]->grades[$feedback->userid]->overridden) ) {
1725 $submission->grade = $feedback->xgrade;
1726 $submission->submissioncomment = $feedback->submissioncomment_editor['text'];
1727 $submission->teacher = $USER->id;
1728 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
1730 $submission->mailed = 1; // treat as already mailed
1732 $submission->mailed = 0; // Make sure mail goes out (again, even)
1734 $submission->timemarked = time();
1736 unset($submission->data1); // Don't need to update this.
1737 unset($submission->data2); // Don't need to update this.
1739 if (empty($submission->timemodified)) { // eg for offline assignments
1740 // $submission->timemodified = time();
1743 $DB->update_record('assignment_submissions', $submission);
1745 // triger grade event
1746 $this->update_grade($submission);
1748 add_to_log($this->course->id, 'assignment', 'update grades',
1749 'submissions.php?id='.$this->cm->id.'&user='.$feedback->userid, $feedback->userid, $this->cm->id);
1750 if (!is_null($formdata)) {
1751 if ($this->type == 'upload' || $this->type == 'uploadsingle') {
1752 $mformdata = $formdata->mform->get_data();
1753 $mformdata = file_postupdate_standard_filemanager($mformdata, 'files', $formdata->fileui_options, $this->context, 'mod_assignment', 'response', $submission->id);
1762 function process_outcomes($userid) {
1765 if (empty($CFG->enableoutcomes)) {
1769 require_once($CFG->libdir.'/gradelib.php');
1771 if (!$formdata = data_submitted() or !confirm_sesskey()) {
1776 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid);
1778 if (!empty($grading_info->outcomes)) {
1779 foreach($grading_info->outcomes as $n=>$old) {
1780 $name = 'outcome_'.$n;
1781 if (isset($formdata->{$name}[$userid]) and $old->grades[$userid]->grade != $formdata->{$name}[$userid]) {
1782 $data[$n] = $formdata->{$name}[$userid];
1786 if (count($data) > 0) {
1787 grade_update_outcomes('mod/assignment', $this->course->id, 'mod', 'assignment', $this->assignment->id, $userid, $data);
1793 * Load the submission object for a particular user
1797 * @param $userid int The id of the user whose submission we want or 0 in which case USER->id is used
1798 * @param $createnew boolean optional Defaults to false. If set to true a new submission object will be created in the database
1799 * @param bool $teachermodified student submission set if false
1800 * @return object The submission
1802 function get_submission($userid=0, $createnew=false, $teachermodified=false) {
1805 if (empty($userid)) {
1806 $userid = $USER->id;
1809 $submission = $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
1811 if ($submission || !$createnew) {
1814 $newsubmission = $this->prepare_new_submission($userid, $teachermodified);
1815 $DB->insert_record("assignment_submissions", $newsubmission);
1817 return $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
1821 * Instantiates a new submission object for a given user
1823 * Sets the assignment, userid and times, everything else is set to default values.
1825 * @param int $userid The userid for which we want a submission object
1826 * @param bool $teachermodified student submission set if false
1827 * @return object The submission
1829 function prepare_new_submission($userid, $teachermodified=false) {
1830 $submission = new stdClass();
1831 $submission->assignment = $this->assignment->id;
1832 $submission->userid = $userid;
1833 $submission->timecreated = time();
1834 // teachers should not be modifying modified date, except offline assignments
1835 if ($teachermodified) {
1836 $submission->timemodified = 0;
1838 $submission->timemodified = $submission->timecreated;
1840 $submission->numfiles = 0;
1841 $submission->data1 = '';
1842 $submission->data2 = '';
1843 $submission->grade = -1;
1844 $submission->submissioncomment = '';
1845 $submission->format = 0;
1846 $submission->teacher = 0;
1847 $submission->timemarked = 0;
1848 $submission->mailed = 0;
1853 * Return all assignment submissions by ENROLLED students (even empty)
1855 * @param string $sort optional field names for the ORDER BY in the sql query
1856 * @param string $dir optional specifying the sort direction, defaults to DESC
1857 * @return array The submission objects indexed by id
1859 function get_submissions($sort='', $dir='DESC') {
1860 return assignment_get_all_submissions($this->assignment, $sort, $dir);
1864 * Counts all real assignment submissions by ENROLLED students (not empty ones)
1866 * @param int $groupid optional If nonzero then count is restricted to this group
1867 * @return int The number of submissions
1869 function count_real_submissions($groupid=0) {
1870 return assignment_count_real_submissions($this->cm, $groupid);
1874 * Alerts teachers by email of new or changed assignments that need grading
1876 * First checks whether the option to email teachers is set for this assignment.
1877 * Sends an email to ALL teachers in the course (or in the group if using separate groups).
1878 * Uses the methods email_teachers_text() and email_teachers_html() to construct the content.
1882 * @param $submission object The submission that has changed
1885 function email_teachers($submission) {
1888 if (empty($this->assignment->emailteachers)) { // No need to do anything
1892 $user = $DB->get_record('user', array('id'=>$submission->userid));
1894 if ($teachers = $this->get_graders($user)) {
1896 $strassignments = get_string('modulenameplural', 'assignment');
1897 $strassignment = get_string('modulename', 'assignment');
1898 $strsubmitted = get_string('submitted', 'assignment');
1900 foreach ($teachers as $teacher) {
1901 $info = new stdClass();
1902 $info->username = fullname($user, true);
1903 $info->assignment = format_string($this->assignment->name,true);
1904 $info->url = $CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id;
1905 $info->timeupdated = userdate($submission->timemodified, '%c', $teacher->timezone);
1907 $postsubject = $strsubmitted.': '.$info->username.' -> '.$this->assignment->name;
1908 $posttext = $this->email_teachers_text($info);
1909 $posthtml = ($teacher->mailformat == 1) ? $this->email_teachers_html($info) : '';
1911 $eventdata = new stdClass();
1912 $eventdata->modulename = 'assignment';
1913 $eventdata->userfrom = $user;
1914 $eventdata->userto = $teacher;
1915 $eventdata->subject = $postsubject;
1916 $eventdata->fullmessage = $posttext;
1917 $eventdata->fullmessageformat = FORMAT_PLAIN;
1918 $eventdata->fullmessagehtml = $posthtml;
1919 $eventdata->smallmessage = $postsubject;
1921 $eventdata->name = 'assignment_updates';
1922 $eventdata->component = 'mod_assignment';
1923 $eventdata->notification = 1;
1924 $eventdata->contexturl = $info->url;
1925 $eventdata->contexturlname = $info->assignment;
1927 message_send($eventdata);
1933 * @param string $filearea
1934 * @param array $args
1937 function send_file($filearea, $args) {
1938 debugging('plugin does not implement file sending', DEBUG_DEVELOPER);
1943 * Returns a list of teachers that should be grading given submission
1945 * @param object $user
1948 function get_graders($user) {
1950 $potgraders = get_users_by_capability($this->context, 'mod/assignment:grade', '', '', '', '', '', '', false, false);
1953 if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) { // Separate groups are being used
1954 if ($groups = groups_get_all_groups($this->course->id, $user->id)) { // Try to find all groups
1955 foreach ($groups as $group) {
1956 foreach ($potgraders as $t) {
1957 if ($t->id == $user->id) {
1958 continue; // do not send self
1960 if (groups_is_member($group->id, $t->id)) {
1961 $graders[$t->id] = $t;
1966 // user not in group, try to find graders without group
1967 foreach ($potgraders as $t) {
1968 if ($t->id == $user->id) {
1969 continue; // do not send self
1971 if (!groups_get_all_groups($this->course->id, $t->id)) { //ugly hack
1972 $graders[$t->id] = $t;
1977 foreach ($potgraders as $t) {
1978 if ($t->id == $user->id) {
1979 continue; // do not send self
1981 $graders[$t->id] = $t;
1988 * Creates the text content for emails to teachers
1990 * @param $info object The info used by the 'emailteachermail' language string
1993 function email_teachers_text($info) {
1994 $posttext = format_string($this->course->shortname, true, array('context' => $this->coursecontext)).' -> '.
1995 $this->strassignments.' -> '.
1996 format_string($this->assignment->name, true, array('context' => $this->context))."\n";
1997 $posttext .= '---------------------------------------------------------------------'."\n";
1998 $posttext .= get_string("emailteachermail", "assignment", $info)."\n";
1999 $posttext .= "\n---------------------------------------------------------------------\n";
2004 * Creates the html content for emails to teachers
2006 * @param $info object The info used by the 'emailteachermailhtml' language string
2009 function email_teachers_html($info) {
2011 $posthtml = '<p><font face="sans-serif">'.
2012 '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$this->course->id.'">'.format_string($this->course->shortname, true, array('context' => $this->coursecontext)).'</a> ->'.
2013 '<a href="'.$CFG->wwwroot.'/mod/assignment/index.php?id='.$this->course->id.'">'.$this->strassignments.'</a> ->'.
2014 '<a href="'.$CFG->wwwroot.'/mod/assignment/view.php?id='.$this->cm->id.'">'.format_string($this->assignment->name, true, array('context' => $this->context)).'</a></font></p>';
2015 $posthtml .= '<hr /><font face="sans-serif">';
2016 $posthtml .= '<p>'.get_string('emailteachermailhtml', 'assignment', $info).'</p>';
2017 $posthtml .= '</font><hr />';
2022 * Produces a list of links to the files uploaded by a user
2024 * @param $userid int optional id of the user. If 0 then $USER->id is used.
2025 * @param $return boolean optional defaults to false. If true the list is returned rather than printed
2026 * @return string optional
2028 function print_user_files($userid=0, $return=false) {
2029 global $CFG, $USER, $OUTPUT;
2032 if (!isloggedin()) {
2035 $userid = $USER->id;
2040 $submission = $this->get_submission($userid);
2045 $fs = get_file_storage();
2046 $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false);
2047 if (!empty($files)) {
2048 require_once($CFG->dirroot . '/mod/assignment/locallib.php');
2049 if ($CFG->enableportfolios) {
2050 require_once($CFG->libdir.'/portfoliolib.php');
2051 $button = new portfolio_add_button();
2053 foreach ($files as $file) {
2054 $filename = $file->get_filename();
2055 $mimetype = $file->get_mimetype();
2056 $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$this->context->id.'/mod_assignment/submission/'.$submission->id.'/'.$filename);
2057 $output .= '<a href="'.$path.'" ><img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />'.s($filename).'</a>';
2058 if ($CFG->enableportfolios && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
2059 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'submissionid' => $submission->id, 'fileid' => $file->get_id()), '/mod/assignment/locallib.php');
2060 $button->set_format_by_file($file);
2061 $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
2064 if ($CFG->enableplagiarism) {
2065 require_once($CFG->libdir.'/plagiarismlib.php');
2066 $output .= plagiarism_get_links(array('userid'=>$userid, 'file'=>$file, 'cmid'=>$this->cm->id, 'course'=>$this->course, 'assignment'=>$this->assignment));
2067 $output .= '<br />';
2070 if ($CFG->enableportfolios && count($files) > 1 && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
2071 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'submissionid' => $submission->id), '/mod/assignment/locallib.php');
2072 $output .= '<br />' . $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
2076 $output = '<div class="files">'.$output.'</div>';
2085 * Count the files uploaded by a given user
2087 * @param $itemid int The submission's id as the file's itemid.
2090 function count_user_files($itemid) {
2091 $fs = get_file_storage();
2092 $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $itemid, "id", false);
2093 return count($files);
2097 * Returns true if the student is allowed to submit
2099 * Checks that the assignment has started and, if the option to prevent late
2100 * submissions is set, also checks that the assignment has not yet closed.
2105 if ($this->assignment->preventlate && $this->assignment->timedue) {
2106 return ($this->assignment->timeavailable <= $time && $time <= $this->assignment->timedue);
2108 return ($this->assignment->timeavailable <= $time);
2114 * Return true if is set description is hidden till available date
2116 * This is needed by calendar so that hidden descriptions do not
2117 * come up in upcoming events.
2119 * Check that description is hidden till available date
2120 * By default return false
2121 * Assignments types should implement this method if needed
2124 function description_is_hidden() {
2129 * Return an outline of the user's interaction with the assignment
2131 * The default method prints the grade and timemodified
2132 * @param $grade object
2133 * @return object with properties ->info and ->time
2135 function user_outline($grade) {
2137 $result = new stdClass();
2138 $result->info = get_string('grade').': '.$grade->str_long_grade;
2139 $result->time = $grade->dategraded;
2144 * Print complete information about the user's interaction with the assignment
2146 * @param $user object
2148 function user_complete($user, $grade=null) {
2151 if ($submission = $this->get_submission($user->id)) {
2153 $fs = get_file_storage();
2155 if ($files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
2156 $countfiles = count($files)." ".get_string("uploadedfiles", "assignment");
2157 foreach ($files as $file) {
2158 $countfiles .= "; ".$file->get_filename();
2162 echo $OUTPUT->box_start();
2163 echo get_string("lastmodified").": ";
2164 echo userdate($submission->timemodified);
2165 echo $this->display_lateness($submission->timemodified);
2167 $this->print_user_files($user->id);
2171 $this->view_feedback($submission);
2173 echo $OUTPUT->box_end();
2177 echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
2178 if ($grade->str_feedback) {
2179 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
2182 print_string("notsubmittedyet", "assignment");
2187 * Return a string indicating how late a submission is
2189 * @param $timesubmitted int
2192 function display_lateness($timesubmitted) {
2193 return assignment_display_lateness($timesubmitted, $this->assignment->timedue);
2197 * Empty method stub for all delete actions.
2200 //nothing by default
2201 redirect('view.php?id='.$this->cm->id);
2205 * Empty custom feedback grading form.
2207 function custom_feedbackform($submission, $return=false) {
2208 //nothing by default
2213 * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
2214 * for the course (see resource).
2216 * Given a course_module object, this function returns any "extra" information that may be needed
2217 * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php.
2219 * @param $coursemodule object The coursemodule object (record).
2220 * @return cached_cm_info Object used to customise appearance on course page
2222 function get_coursemodule_info($coursemodule) {
2227 * Plugin cron method - do not use $this here, create new assignment instances if needed.
2231 //no plugin cron by default - override if needed
2235 * Reset all submissions
2237 function reset_userdata($data) {
2240 if (!$DB->count_records('assignment', array('course'=>$data->courseid, 'assignmenttype'=>$this->type))) {
2241 return array(); // no assignments of this type present
2244 $componentstr = get_string('modulenameplural', 'assignment');
2247 $typestr = get_string('type'.$this->type, 'assignment');
2248 // ugly hack to support pluggable assignment type titles...
2249 if($typestr === '[[type'.$this->type.']]'){
2250 $typestr = get_string('type'.$this->type, 'assignment_'.$this->type);
2253 if (!empty($data->reset_assignment_submissions)) {
2254 $assignmentssql = "SELECT a.id
2256 WHERE a.course=? AND a.assignmenttype=?";
2257 $params = array($data->courseid, $this->type);
2259 // now get rid of all submissions and responses
2260 $fs = get_file_storage();
2261 if ($assignments = $DB->get_records_sql($assignmentssql, $params)) {
2262 foreach ($assignments as $assignmentid=>$unused) {
2263 if (!$cm = get_coursemodule_from_instance('assignment', $assignmentid)) {
2266 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2267 $fs->delete_area_files($context->id, 'mod_assignment', 'submission');
2268 $fs->delete_area_files($context->id, 'mod_assignment', 'response');
2272 $DB->delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)", $params);
2274 $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false);
2276 if (empty($data->reset_gradebook_grades)) {
2277 // remove all grades from gradebook
2278 assignment_reset_gradebook($data->courseid, $this->type);
2282 /// updating dates - shift may be negative too
2283 if ($data->timeshift) {
2284 shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift, $data->courseid);
2285 $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false);
2292 function portfolio_exportable() {
2297 * base implementation for backing up subtype specific information
2298 * for one single module
2300 * @param filehandle $bf file handle for xml file to write to
2301 * @param mixed $preferences the complete backup preference object
2307 static function backup_one_mod($bf, $preferences, $assignment) {
2312 * base implementation for backing up subtype specific information
2313 * for one single submission
2315 * @param filehandle $bf file handle for xml file to write to
2316 * @param mixed $preferences the complete backup preference object
2317 * @param object $submission the assignment submission db record
2323 static function backup_one_submission($bf, $preferences, $assignment, $submission) {
2328 * base implementation for restoring subtype specific information
2329 * for one single module
2331 * @param array $info the array representing the xml
2332 * @param object $restore the restore preferences
2338 static function restore_one_mod($info, $restore, $assignment) {
2343 * base implementation for restoring subtype specific information
2344 * for one single submission
2346 * @param object $submission the newly created submission
2347 * @param array $info the array representing the xml
2348 * @param object $restore the restore preferences
2354 static function restore_one_submission($info, $restore, $assignment, $submission) {
2358 } ////// End of the assignment_base class
2361 class mod_assignment_grading_form extends moodleform {
2362 /** @var stores the advaned grading instance (if used in grading) */
2363 private $advancegradinginstance;
2365 function definition() {
2367 $mform =& $this->_form;
2369 if (isset($this->_customdata->advancedgradinginstance)) {
2370 $this->use_advanced_grading($this->_customdata->advancedgradinginstance);
2373 $formattr = $mform->getAttributes();
2374 $formattr['id'] = 'submitform';
2375 $mform->setAttributes($formattr);
2377 $mform->addElement('hidden', 'offset', ($this->_customdata->offset+1));
2378 $mform->setType('offset', PARAM_INT);
2379 $mform->addElement('hidden', 'userid', $this->_customdata->userid);
2380 $mform->setType('userid', PARAM_INT);
2381 $mform->addElement('hidden', 'nextid', $this->_customdata->nextid);
2382 $mform->setType('nextid', PARAM_INT);
2383 $mform->addElement('hidden', 'id', $this->_customdata->cm->id);
2384 $mform->setType('id', PARAM_INT);
2385 $mform->addElement('hidden', 'sesskey', sesskey());
2386 $mform->setType('sesskey', PARAM_ALPHANUM);
2387 $mform->addElement('hidden', 'mode', 'grade');
2388 $mform->setType('mode', PARAM_TEXT);
2389 $mform->addElement('hidden', 'menuindex', "0");
2390 $mform->setType('menuindex', PARAM_INT);
2391 $mform->addElement('hidden', 'saveuserid', "-1");
2392 $mform->setType('saveuserid', PARAM_INT);
2393 $mform->addElement('hidden', 'filter', "0");
2394 $mform->setType('filter', PARAM_INT);
2396 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->user),
2397 fullname($this->_customdata->user, true) . '<br/>' .
2398 userdate($this->_customdata->submission->timemodified) .
2399 $this->_customdata->lateness );
2401 $this->add_submission_content();
2402 $this->add_grades_section();
2404 $this->add_feedback_section();
2406 if ($this->_customdata->submission->timemarked) {
2407 $datestring = userdate($this->_customdata->submission->timemarked)." (".format_time(time() - $this->_customdata->submission->timemarked).")";
2408 $mform->addElement('header', 'Last Grade', get_string('lastgrade', 'assignment'));
2409 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->teacher) ,
2410 fullname($this->_customdata->teacher,true).
2411 '<br/>'.$datestring);
2414 $this->add_action_buttons();
2419 * Gets or sets the instance for advanced grading
2421 * @param gradingform_instance $gradinginstance
2423 public function use_advanced_grading($gradinginstance = false) {
2424 if ($gradinginstance !== false) {
2425 $this->advancegradinginstance = $gradinginstance;
2427 return $this->advancegradinginstance;
2430 function add_grades_section() {
2432 $mform =& $this->_form;
2433 $attributes = array();
2434 if ($this->_customdata->gradingdisabled) {
2435 $attributes['disabled'] ='disabled';
2438 $mform->addElement('header', 'Grades', get_string('grades', 'grades'));
2440 $grademenu = make_grades_menu($this->_customdata->assignment->grade);
2441 if ($gradinginstance = $this->use_advanced_grading()) {
2442 $gradinginstance->get_controller()->set_grade_range($grademenu);
2443 $gradingelement = $mform->addElement('grading', 'advancedgrading', get_string('grade').':', array('gradinginstance' => $gradinginstance));
2444 if ($this->_customdata->gradingdisabled) {
2445 $gradingelement->freeze();
2447 $mform->addElement('hidden', 'advancedgradinginstanceid', $gradinginstance->get_id());
2450 // use simple direct grading
2451 $grademenu['-1'] = get_string('nograde');
2453 $mform->addElement('select', 'xgrade', get_string('grade').':', $grademenu, $attributes);
2454 $mform->setDefault('xgrade', $this->_customdata->submission->grade ); //@fixme some bug when element called 'grade' makes it break
2455 $mform->setType('xgrade', PARAM_INT);
2458 if (!empty($this->_customdata->enableoutcomes)) {
2459 foreach($this->_customdata->grading_info->outcomes as $n=>$outcome) {
2460 $options = make_grades_menu(-$outcome->scaleid);
2461 if ($outcome->grades[$this->_customdata->submission->userid]->locked) {
2462 $options[0] = get_string('nooutcome', 'grades');
2463 $mform->addElement('static', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':',
2464 $options[$outcome->grades[$this->_customdata->submission->userid]->grade]);
2466 $options[''] = get_string('nooutcome', 'grades');
2467 $attributes = array('id' => 'menuoutcome_'.$n );
2468 $mform->addElement('select', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':', $options, $attributes );
2469 $mform->setType('outcome_'.$n.'['.$this->_customdata->userid.']', PARAM_INT);
2470 $mform->setDefault('outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->grades[$this->_customdata->submission->userid]->grade );
2474 $course_context = get_context_instance(CONTEXT_MODULE , $this->_customdata->cm->id);
2475 if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
2476 $grade = '<a href="'.$CFG->wwwroot.'/grade/report/grader/index.php?id='. $this->_customdata->courseid .'" >'.
2477 $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade . '</a>';
2479 $grade = $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade;
2481 $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assignment').':' ,$grade);
2482 $mform->setType('finalgrade', PARAM_INT);
2487 * @global core_renderer $OUTPUT
2489 function add_feedback_section() {
2491 $mform =& $this->_form;
2492 $mform->addElement('header', 'Feed Back', get_string('feedback', 'grades'));
2494 if ($this->_customdata->gradingdisabled) {
2495 $mform->addElement('static', 'disabledfeedback', $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_feedback );
2499 $mform->addElement('editor', 'submissioncomment_editor', get_string('feedback', 'assignment').':', null, $this->get_editor_options() );
2500 $mform->setType('submissioncomment_editor', PARAM_RAW); // to be cleaned before display
2501 $mform->setDefault('submissioncomment_editor', $this->_customdata->submission->submissioncomment);
2502 //$mform->addRule('submissioncomment', get_string('required'), 'required', null, 'client');
2503 switch ($this->_customdata->assignment->assignmenttype) {
2505 case 'uploadsingle' :
2506 $mform->addElement('filemanager', 'files_filemanager', get_string('responsefiles', 'assignment'). ':', null, $this->_customdata->fileui_options);
2511 $mform->addElement('hidden', 'mailinfo_h', "0");
2512 $mform->setType('mailinfo_h', PARAM_INT);
2513 $mform->addElement('checkbox', 'mailinfo',get_string('enablenotification','assignment').
2514 $OUTPUT->help_icon('enablenotification', 'assignment') .':' );
2515 $mform->setType('mailinfo', PARAM_INT);
2519 function add_action_buttons() {
2520 $mform =& $this->_form;
2521 //if there are more to be graded.
2522 if ($this->_customdata->nextid>0) {
2523 $buttonarray=array();
2524 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2525 //@todo: fix accessibility: javascript dependency not necessary
2526 $buttonarray[] = &$mform->createElement('submit', 'saveandnext', get_string('saveandnext'));
2527 $buttonarray[] = &$mform->createElement('submit', 'next', get_string('next'));
2528 $buttonarray[] = &$mform->createElement('cancel');
2530 $buttonarray=array();
2531 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2532 $buttonarray[] = &$mform->createElement('cancel');
2534 $mform->addGroup($buttonarray, 'grading_buttonar', '', array(' '), false);
2535 $mform->closeHeaderBefore('grading_buttonar');
2536 $mform->setType('grading_buttonar', PARAM_RAW);
2539 function add_submission_content() {
2540 $mform =& $this->_form;
2541 $mform->addElement('header', 'Submission', get_string('submission', 'assignment'));
2542 $mform->addElement('static', '', '' , $this->_customdata->submission_content );
2545 protected function get_editor_options() {
2546 $editoroptions = array();
2547 $editoroptions['component'] = 'mod_assignment';
2548 $editoroptions['filearea'] = 'feedback';
2549 $editoroptions['noclean'] = false;
2550 $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)
2551 $editoroptions['maxbytes'] = $this->_customdata->maxbytes;
2552 $editoroptions['context'] = $this->_customdata->context;
2553 return $editoroptions;
2556 public function set_data($data) {
2557 $editoroptions = $this->get_editor_options();
2558 if (!isset($data->text)) {
2561 if (!isset($data->format)) {
2562 $data->textformat = FORMAT_HTML;
2564 $data->textformat = $data->format;
2567 if (!empty($this->_customdata->submission->id)) {
2568 $itemid = $this->_customdata->submission->id;
2573 switch ($this->_customdata->assignment->assignmenttype) {
2575 case 'uploadsingle' :
2576 $data = file_prepare_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2582 $data = file_prepare_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2583 return parent::set_data($data);
2586 public function get_data() {
2587 $data = parent::get_data();
2589 if (!empty($this->_customdata->submission->id)) {
2590 $itemid = $this->_customdata->submission->id;
2592 $itemid = null; //TODO: this is wrong, itemid MUST be known when saving files!! (skodak)
2596 $editoroptions = $this->get_editor_options();
2597 switch ($this->_customdata->assignment->assignmenttype) {
2599 case 'uploadsingle' :
2600 $data = file_postupdate_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2605 $data = file_postupdate_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2608 if ($this->use_advanced_grading() && !isset($data->advancedgrading)) {
2609 $data->advancedgrading = null;
2616 /// OTHER STANDARD FUNCTIONS ////////////////////////////////////////////////////////
2619 * Deletes an assignment instance
2621 * This is done by calling the delete_instance() method of the assignment type class
2623 function assignment_delete_instance($id){
2626 if (! $assignment = $DB->get_record('assignment', array('id'=>$id))) {
2630 // fall back to base class if plugin missing
2631 $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
2632 if (file_exists($classfile)) {
2633 require_once($classfile);
2634 $assignmentclass = "assignment_$assignment->assignmenttype";
2637 debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead.");
2638 $assignmentclass = "assignment_base";
2641 $ass = new $assignmentclass();
2642 return $ass->delete_instance($assignment);
2647 * Updates an assignment instance
2649 * This is done by calling the update_instance() method of the assignment type class
2651 function assignment_update_instance($assignment){
2654 $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_PLUGIN);
2656 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2657 $assignmentclass = "assignment_$assignment->assignmenttype";
2658 $ass = new $assignmentclass();
2659 return $ass->update_instance($assignment);
2664 * Adds an assignment instance
2666 * This is done by calling the add_instance() method of the assignment type class
2668 function assignment_add_instance($assignment) {
2671 $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_PLUGIN);
2673 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2674 $assignmentclass = "assignment_$assignment->assignmenttype";
2675 $ass = new $assignmentclass();
2676 return $ass->add_instance($assignment);
2681 * Returns an outline of a user interaction with an assignment
2683 * This is done by calling the user_outline() method of the assignment type class
2685 function assignment_user_outline($course, $user, $mod, $assignment) {
2688 require_once("$CFG->libdir/gradelib.php");
2689 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2690 $assignmentclass = "assignment_$assignment->assignmenttype";
2691 $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2692 $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2693 if (!empty($grades->items[0]->grades)) {
2694 return $ass->user_outline(reset($grades->items[0]->grades));
2701 * Prints the complete info about a user's interaction with an assignment
2703 * This is done by calling the user_complete() method of the assignment type class
2705 function assignment_user_complete($course, $user, $mod, $assignment) {
2708 require_once("$CFG->libdir/gradelib.php");
2709 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2710 $assignmentclass = "assignment_$assignment->assignmenttype";
2711 $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
2712 $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2713 if (empty($grades->items[0]->grades)) {
2716 $grade = reset($grades->items[0]->grades);
2718 return $ass->user_complete($user, $grade);
2722 * Function to be run periodically according to the moodle cron
2724 * Finds all assignment notifications that have yet to be mailed out, and mails them
2726 function assignment_cron () {
2727 global $CFG, $USER, $DB;
2729 /// first execute all crons in plugins
2730 if ($plugins = get_plugin_list('assignment')) {
2731 foreach ($plugins as $plugin=>$dir) {
2732 require_once("$dir/assignment.class.php");
2733 $assignmentclass = "assignment_$plugin";
2734 $ass = new $assignmentclass();
2739 /// Notices older than 1 day will not be mailed. This is to avoid the problem where
2740 /// cron has not been running for a long time, and then suddenly people are flooded
2741 /// with mail from the past few weeks or months
2744 $endtime = $timenow - $CFG->maxeditingtime;
2745 $starttime = $endtime - 24 * 3600; /// One day earlier
2747 if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) {
2749 $realuser = clone($USER);
2751 foreach ($submissions as $key => $submission) {
2752 $DB->set_field("assignment_submissions", "mailed", "1", array("id"=>$submission->id));
2757 foreach ($submissions as $submission) {
2759 echo "Processing assignment submission $submission->id\n";
2761 if (! $user = $DB->get_record("user", array("id"=>$submission->userid))) {
2762 echo "Could not find user $user->id\n";
2766 if (! $course = $DB->get_record("course", array("id"=>$submission->course))) {
2767 echo "Could not find course $submission->course\n";
2771 /// Override the language and timezone of the "current" user, so that
2772 /// mail is customised for the receiver.
2773 cron_setup_user($user, $course);
2775 $coursecontext = get_context_instance(CONTEXT_COURSE, $submission->course);
2776 $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
2777 if (!is_enrolled($coursecontext, $user->id)) {
2778 echo fullname($user)." not an active participant in " . $courseshortname . "\n";
2782 if (! $teacher = $DB->get_record("user", array("id"=>$submission->teacher))) {
2783 echo "Could not find teacher $submission->teacher\n";
2787 if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment, $course->id)) {
2788 echo "Could not find course module for assignment id $submission->assignment\n";
2792 if (! $mod->visible) { /// Hold mail notification for hidden assignments until later
2796 $strassignments = get_string("modulenameplural", "assignment");
2797 $strassignment = get_string("modulename", "assignment");
2799 $assignmentinfo = new stdClass();
2800 $assignmentinfo->teacher = fullname($teacher);
2801 $assignmentinfo->assignment = format_string($submission->name,true);
2802 $assignmentinfo->url = "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id";
2804 $postsubject = "$courseshortname: $strassignments: ".format_string($submission->name,true);
2805 $posttext = "$courseshortname -> $strassignments -> ".format_string($submission->name,true)."\n";
2806 $posttext .= "---------------------------------------------------------------------\n";
2807 $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n";
2808 $posttext .= "---------------------------------------------------------------------\n";
2810 if ($user->mailformat == 1) { // HTML
2811 $posthtml = "<p><font face=\"sans-serif\">".
2812 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$courseshortname</a> ->".
2813 "<a href=\"$CFG->wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments</a> ->".
2814 "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name,true)."</a></font></p>";
2815 $posthtml .= "<hr /><font face=\"sans-serif\">";
2816 $posthtml .= "<p>".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."</p>";
2817 $posthtml .= "</font><hr />";
2822 $eventdata = new stdClass();
2823 $eventdata->modulename = 'assignment';
2824 $eventdata->userfrom = $teacher;
2825 $eventdata->userto = $user;
2826 $eventdata->subject = $postsubject;
2827 $eventdata->fullmessage = $posttext;
2828 $eventdata->fullmessageformat = FORMAT_PLAIN;
2829 $eventdata->fullmessagehtml = $posthtml;
2830 $eventdata->smallmessage = get_string('assignmentmailsmall', 'assignment', $assignmentinfo);
2832 $eventdata->name = 'assignment_updates';
2833 $eventdata->component = 'mod_assignment';
2834 $eventdata->notification = 1;
2835 $eventdata->contexturl = $assignmentinfo->url;
2836 $eventdata->contexturlname = $assignmentinfo->assignment;
2838 message_send($eventdata);
2848 * Return grade for given user or all users.
2850 * @param int $assignmentid id of assignment
2851 * @param int $userid optional user id, 0 means all users
2852 * @return array array of grades, false if none
2854 function assignment_get_user_grades($assignment, $userid=0) {
2858 $user = "AND u.id = :userid";
2859 $params = array('userid'=>$userid);
2863 $params['aid'] = $assignment->id;
2865 $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat,
2866 s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted
2867 FROM {user} u, {assignment_submissions} s
2868 WHERE u.id = s.userid AND s.assignment = :aid
2871 return $DB->get_records_sql($sql, $params);
2875 * Update activity grades
2877 * @param object $assignment
2878 * @param int $userid specific user only, 0 means all
2880 function assignment_update_grades($assignment, $userid=0, $nullifnone=true) {
2882 require_once($CFG->libdir.'/gradelib.php');
2884 if ($assignment->grade == 0) {
2885 assignment_grade_item_update($assignment);
2887 } else if ($grades = assignment_get_user_grades($assignment, $userid)) {
2888 foreach($grades as $k=>$v) {
2889 if ($v->rawgrade == -1) {
2890 $grades[$k]->rawgrade = null;
2893 assignment_grade_item_update($assignment, $grades);
2896 assignment_grade_item_update($assignment);
2901 * Update all grades in gradebook.
2903 function assignment_upgrade_grades() {
2906 $sql = "SELECT COUNT('x')
2907 FROM {assignment} a, {course_modules} cm, {modules} m
2908 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2909 $count = $DB->count_records_sql($sql);
2911 $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
2912 FROM {assignment} a, {course_modules} cm, {modules} m
2913 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2914 $rs = $DB->get_recordset_sql($sql);
2916 // too much debug output
2917 $pbar = new progress_bar('assignmentupgradegrades', 500, true);
2919 foreach ($rs as $assignment) {
2921 upgrade_set_timeout(60*5); // set up timeout, may also abort execution
2922 assignment_update_grades($assignment);
2923 $pbar->update($i, $count, "Updating Assignment grades ($i/$count).");
2925 upgrade_set_timeout(); // reset to default timeout
2931 * Create grade item for given assignment
2933 * @param object $assignment object with extra cmidnumber
2934 * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
2935 * @return int 0 if ok, error code otherwise
2937 function assignment_grade_item_update($assignment, $grades=NULL) {
2939 require_once($CFG->libdir.'/gradelib.php');
2941 if (!isset($assignment->courseid)) {
2942 $assignment->courseid = $assignment->course;
2945 $params = array('itemname'=>$assignment->name, 'idnumber'=>$assignment->cmidnumber);
2947 if ($assignment->grade > 0) {
2948 $params['gradetype'] = GRADE_TYPE_VALUE;
2949 $params['grademax'] = $assignment->grade;
2950 $params['grademin'] = 0;
2952 } else if ($assignment->grade < 0) {
2953 $params['gradetype'] = GRADE_TYPE_SCALE;
2954 $params['scaleid'] = -$assignment->grade;
2957 $params['gradetype'] = GRADE_TYPE_TEXT; // allow text comments only
2960 if ($grades === 'reset') {
2961 $params['reset'] = true;
2965 return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, $grades, $params);
2969 * Delete grade item for given assignment
2971 * @param object $assignment object
2972 * @return object assignment
2974 function assignment_grade_item_delete($assignment) {
2976 require_once($CFG->libdir.'/gradelib.php');
2978 if (!isset($assignment->courseid)) {
2979 $assignment->courseid = $assignment->course;
2982 return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, NULL, array('deleted'=>1));
2986 * Returns the users with data in one assignment (students and teachers)
2988 * @todo: deprecated - to be deleted in 2.2
2990 * @param $assignmentid int
2991 * @return array of user objects
2993 function assignment_get_participants($assignmentid) {
2997 $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2999 {assignment_submissions} a
3000 WHERE a.assignment = ? and
3001 u.id = a.userid", array($assignmentid));
3003 $teachers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
3005 {assignment_submissions} a
3006 WHERE a.assignment = ? and
3007 u.id = a.teacher", array($assignmentid));
3009 //Add teachers to students
3011 foreach ($teachers as $teacher) {
3012 $students[$teacher->id] = $teacher;
3015 //Return students array (it contains an array of unique users)
3020 * Serves assignment submissions and other files.
3022 * @param object $course
3024 * @param object $context
3025 * @param string $filearea
3026 * @param array $args
3027 * @param bool $forcedownload
3028 * @return bool false if file not found, does not return if found - just send the file
3030 function assignment_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
3033 if ($context->contextlevel != CONTEXT_MODULE) {
3037 require_login($course, false, $cm);
3039 if (!$assignment = $DB->get_record('assignment', array('id'=>$cm->instance))) {
3043 require_once($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
3044 $assignmentclass = 'assignment_'.$assignment->assignmenttype;
3045 $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm, $course);
3047 return $assignmentinstance->send_file($filearea, $args);
3050 * Checks if a scale is being used by an assignment
3052 * This is used by the backup code to decide whether to back up a scale
3053 * @param $assignmentid int
3054 * @param $scaleid int
3055 * @return boolean True if the scale is used by the assignment
3057 function assignment_scale_used($assignmentid, $scaleid) {
3062 $rec = $DB->get_record('assignment', array('id'=>$assignmentid,'grade'=>-$scaleid));
3064 if (!empty($rec) && !empty($scaleid)) {
3072 * Checks if scale is being used by any instance of assignment
3074 * This is used to find out if scale used anywhere
3075 * @param $scaleid int
3076 * @return boolean True if the scale is used by any assignment
3078 function assignment_scale_used_anywhere($scaleid) {
3081 if ($scaleid and $DB->record_exists('assignment', array('grade'=>-$scaleid))) {
3089 * Make sure up-to-date events are created for all assignment instances
3091 * This standard function will check all instances of this module
3092 * and make sure there are up-to-date events created for each of them.
3093 * If courseid = 0, then every assignment event in the site is checked, else
3094 * only assignment events belonging to the course specified are checked.
3095 * This function is used, in its new format, by restore_refresh_events()
3097 * @param $courseid int optional If zero then all assignments for all courses are covered
3098 * @return boolean Always returns true
3100 function assignment_refresh_events($courseid = 0) {
3103 if ($courseid == 0) {
3104 if (! $assignments = $DB->get_records("assignment")) {
3108 if (! $assignments = $DB->get_records("assignment", array("course"=>$courseid))) {
3112 $moduleid = $DB->get_field('modules', 'id', array('name'=>'assignment'));
3114 foreach ($assignments as $assignment) {
3115 $cm = get_coursemodule_from_id('assignment', $assignment->id);
3116 $event = new stdClass();
3117 $event->name = $assignment->name;
3118 $event->description = format_module_intro('assignment', $assignment, $cm->id);
3119 $event->timestart = $assignment->timedue;
3121 if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
3122 update_event($event);
3125 $event->courseid = $assignment->course;
3126 $event->groupid = 0;
3128 $event->modulename = 'assignment';
3129 $event->instance = $assignment->id;
3130 $event->eventtype = 'due';
3131 $event->timeduration = 0;
3132 $event->visible = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$assignment->id));
3141 * Print recent activity from all assignments in a given course
3143 * This is used by the recent activity block
3145 function assignment_print_recent_activity($course, $viewfullnames, $timestart) {
3146 global $CFG, $USER, $DB, $OUTPUT;
3148 // do not use log table if possible, it may be huge
3150 if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified, cm.id AS cmid, asb.userid,
3151 u.firstname, u.lastname, u.email, u.picture
3152 FROM {assignment_submissions} asb
3153 JOIN {assignment} a ON a.id = asb.assignment
3154 JOIN {course_modules} cm ON cm.instance = a.id
3155 JOIN {modules} md ON md.id = cm.module
3156 JOIN {user} u ON u.id = asb.userid
3157 WHERE asb.timemodified > ? AND
3159 md.name = 'assignment'
3160 ORDER BY asb.timemodified ASC", array($timestart, $course->id))) {
3164 $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups
3168 foreach($submissions as $submission) {
3169 if (!array_key_exists($submission->cmid, $modinfo->cms)) {
3172 $cm = $modinfo->cms[$submission->cmid];
3173 if (!$cm->uservisible) {
3176 if ($submission->userid == $USER->id) {
3177 $show[] = $submission;
3181 // the act of sumbitting of assignment may be considered private - only graders will see it if specified
3182 if (empty($CFG->assignment_showrecentsubmissions)) {
3183 if (!array_key_exists($cm->id, $grader)) {
3184 $grader[$cm->id] = has_capability('moodle/grade:viewall', get_context_instance(CONTEXT_MODULE, $cm->id));
3186 if (!$grader[$cm->id]) {
3191 $groupmode = groups_get_activity_groupmode($cm, $course);
3193 if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
3194 if (isguestuser()) {
3195 // shortcut - guest user does not belong into any group
3199 if (is_null($modinfo->groups)) {
3200 $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
3203 // this will be slow - show only users that share group with me in this cm
3204 if (empty($modinfo->groups[$cm->id])) {
3207 $usersgroups = groups_get_all_groups($course->id, $submission->userid, $cm->groupingid);
3208 if (is_array($usersgroups)) {
3209 $usersgroups = array_keys($usersgroups);
3210 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
3211 if (empty($intersect)) {
3216 $show[] = $submission;
3223 echo $OUTPUT->heading(get_string('newsubmissions', 'assignment').':', 3);
3225 foreach ($show as $submission) {
3226 $cm = $modinfo->cms[$submission->cmid];
3227 $link = $CFG->wwwroot.'/mod/assignment/view.php?id='.$cm->id;
3228 print_recent_activity_note($submission->timemodified, $submission, $cm->name, $link, false, $viewfullnames);
3236 * Returns all assignments since a given time in specified forum.
3238 function assignment_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0) {
3239 global $CFG, $COURSE, $USER, $DB;
3241 if ($COURSE->id == $courseid) {
3244 $course = $DB->get_record('course', array('id'=>$courseid));
3247 $modinfo =& get_fast_modinfo($course);
3249 $cm = $modinfo->cms[$cmid];
3253 $userselect = "AND u.id = :userid";
3254 $params['userid'] = $userid;
3260 $groupselect = "AND gm.groupid = :groupid";
3261 $groupjoin = "JOIN {groups_members} gm ON gm.userid=u.id";
3262 $params['groupid'] = $groupid;
3268 $params['cminstance'] = $cm->instance;
3269 $params['timestart'] = $timestart;
3271 $userfields = user_picture::fields('u', null, 'userid');
3273 if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified,
3275 FROM {assignment_submissions} asb
3276 JOIN {assignment} a ON a.id = asb.assignment
3277 JOIN {user} u ON u.id = asb.userid
3279 WHERE asb.timemodified > :timestart AND a.id = :cminstance
3280 $userselect $groupselect
3281 ORDER BY asb.timemodified ASC", $params)) {
3285 $groupmode = groups_get_activity_groupmode($cm, $course);
3286 $cm_context = get_context_instance(CONTEXT_MODULE, $cm->id);
3287 $grader = has_capability('moodle/grade:viewall', $cm_context);
3288 $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
3289 $viewfullnames = has_capability('moodle/site:viewfullnames', $cm_context);
3291 if (is_null($modinfo->groups)) {
3292 $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
3297 foreach($submissions as $submission) {
3298 if ($submission->userid == $USER->id) {
3299 $show[] = $submission;
3302 // the act of submitting of assignment may be considered private - only graders will see it if specified
3303 if (empty($CFG->assignment_showrecentsubmissions)) {
3309 if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
3310 if (isguestuser()) {
3311 // shortcut - guest user does not belong into any group
3315 // this will be slow - show only users that share group with me in this cm
3316 if (empty($modinfo->groups[$cm->id])) {
3319 $usersgroups = groups_get_all_groups($course->id, $cm->userid, $cm->groupingid);
3320 if (is_array($usersgroups)) {
3321 $usersgroups = array_keys($usersgroups);