MDL-30709 mod_assignment Fixed phpdocs for assignment_get_file_info
[moodle.git] / mod / assignment / lib.php
CommitLineData
256578f6 1<?PHP
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
19002f9f 17
b0f2597e 18/**
19 * assignment_base is the base class for assignment types
20 *
21 * This class provides all the functionality for an assignment
256578f6 22 *
b2d5a79a 23 * @package mod-assignment
256578f6 24 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
b0f2597e 26 */
04eba58f 27
256578f6 28/** Include eventslib.php */
3b120e46 29require_once($CFG->libdir.'/eventslib.php');
256578f6 30/** Include formslib.php */
172dd12c 31require_once($CFG->libdir.'/formslib.php');
9b72d37e
SH
32/** Include calendar/lib.php */
33require_once($CFG->dirroot.'/calendar/lib.php');
3b120e46 34
256578f6 35/** ASSIGNMENT_COUNT_WORDS = 1 */
6b1564a8 36define('ASSIGNMENT_COUNT_WORDS', 1);
256578f6 37/** ASSIGNMENT_COUNT_LETTERS = 2 */
6b1564a8 38define('ASSIGNMENT_COUNT_LETTERS', 2);
d699cd1e 39
7af1e882 40/**
b0f2597e 41 * Standard base class for all assignment submodules (assignment types).
e7521559 42 *
b2d5a79a 43 * @package mod-assignment
256578f6 44 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
45 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
b0f2597e 46 */
47class assignment_base {
48
fdb797ad
RW
49 const FILTER_ALL = 0;
50 const FILTER_SUBMITTED = 1;
51 const FILTER_REQUIRE_GRADING = 2;
52
256578f6 53 /** @var object */
b0f2597e 54 var $cm;
256578f6 55 /** @var object */
b0f2597e 56 var $course;
8ebbb06a
SH
57 /** @var stdClass */
58 var $coursecontext;
256578f6 59 /** @var object */
b0f2597e 60 var $assignment;
256578f6 61 /** @var string */
7af1e882 62 var $strassignment;
256578f6 63 /** @var string */
7af1e882 64 var $strassignments;
256578f6 65 /** @var string */
7af1e882 66 var $strsubmissions;
256578f6 67 /** @var string */
7af1e882 68 var $strlastmodified;
256578f6 69 /** @var string */
7af1e882 70 var $pagetitle;
256578f6 71 /** @var bool */
7af1e882 72 var $usehtmleditor;
256578f6 73 /**
74 * @todo document this var
75 */
7af1e882 76 var $defaultformat;
256578f6 77 /**
78 * @todo document this var
79 */
55b4d096 80 var $context;
256578f6 81 /** @var string */
0b5a80a1 82 var $type;
b0f2597e 83
84 /**
85 * Constructor for the base assignment class
86 *
87 * Constructor for the base assignment class.
88 * If cmid is set create the cm, course, assignment objects.
7af1e882 89 * If the assignment is hidden and the user is not a teacher then
90 * this prints a page header and notice.
b0f2597e 91 *
256578f6 92 * @global object
93 * @global object
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
b0f2597e 98 */
7bddd4b7 99 function assignment_base($cmid='staticonly', $assignment=NULL, $cm=NULL, $course=NULL) {
5053f00f 100 global $COURSE, $DB;
dd97c328 101
7bddd4b7 102 if ($cmid == 'staticonly') {
103 //use static functions only!
104 return;
105 }
b0f2597e 106
107 global $CFG;
108
7bddd4b7 109 if ($cm) {
110 $this->cm = $cm;
111 } else if (! $this->cm = get_coursemodule_from_id('assignment', $cmid)) {
a939f681 112 print_error('invalidcoursemodule');
7bddd4b7 113 }
04eba58f 114
dd97c328 115 $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
55b4d096 116
7bddd4b7 117 if ($course) {
118 $this->course = $course;
dd97c328 119 } else if ($this->cm->course == $COURSE->id) {
120 $this->course = $COURSE;
5053f00f 121 } else if (! $this->course = $DB->get_record('course', array('id'=>$this->cm->course))) {
a939f681 122 print_error('invalidid', 'assignment');
7bddd4b7 123 }
8ebbb06a 124 $this->coursecontext = get_context_instance(CONTEXT_COURSE, $this->course->id);
eb38d45b 125 $courseshortname = format_text($this->course->shortname, true, array('context' => $this->coursecontext));
04eba58f 126
7bddd4b7 127 if ($assignment) {
128 $this->assignment = $assignment;
5053f00f 129 } else if (! $this->assignment = $DB->get_record('assignment', array('id'=>$this->cm->instance))) {
a939f681 130 print_error('invalidid', 'assignment');
7bddd4b7 131 }
132
3811c1d4 133 $this->assignment->cmidnumber = $this->cm->idnumber; // compatibility with modedit assignment obj
b5ebd096 134 $this->assignment->courseid = $this->course->id; // compatibility with modedit assignment obj
e6a4906b 135
7bddd4b7 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');
8ebbb06a 140 $this->pagetitle = strip_tags($courseshortname.': '.$this->strassignment.': '.format_string($this->assignment->name, true, array('context' => $this->context)));
7bddd4b7 141
f36cbf1d 142 // visibility handled by require_login() with $cm parameter
143 // get current group only when really needed
e6a4906b 144
73097f07 145 /// Set up things for a HTML editor if it's needed
20e5da7d 146 $this->defaultformat = editors_get_preferred_format();
e6a4906b 147 }
148
7af1e882 149 /**
150 * Display the assignment, used by view.php
151 *
152 * This in turn calls the methods producing individual parts of the page
b0f2597e 153 */
de75c481 154 function view() {
45fa3412 155
dabfd0ed 156 $context = get_context_instance(CONTEXT_MODULE,$this->cm->id);
0468976c 157 require_capability('mod/assignment:view', $context);
45fa3412 158
159 add_to_log($this->course->id, "assignment", "view", "view.php?id={$this->cm->id}",
b0f2597e 160 $this->assignment->id, $this->cm->id);
04eba58f 161
73097f07 162 $this->view_header();
04eba58f 163
f77cfb73 164 $this->view_intro();
04eba58f 165
f77cfb73 166 $this->view_dates();
04eba58f 167
b0f2597e 168 $this->view_feedback();
169
f77cfb73 170 $this->view_footer();
36eb856f 171 }
172
7af1e882 173 /**
174 * Display the header and top of a page
175 *
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
180 *
256578f6 181 * @global object
182 * @param string $subpage Description of subpage to be used in navigation trail
73097f07 183 */
184 function view_header($subpage='') {
83a7f058 185 global $CFG, $PAGE, $OUTPUT;
45fa3412 186
73097f07 187 if ($subpage) {
83a7f058 188 $PAGE->navbar->add($subpage);
73097f07 189 }
45fa3412 190
83a7f058 191 $PAGE->set_title($this->pagetitle);
192 $PAGE->set_heading($this->course->fullname);
83a7f058 193
194 echo $OUTPUT->header();
73097f07 195
f1035deb 196 groups_print_activity_menu($this->cm, $CFG->wwwroot . '/mod/assignment/view.php?id=' . $this->cm->id);
45fa3412 197
73097f07 198 echo '<div class="reportlink">'.$this->submittedlink().'</div>';
7bddd4b7 199 echo '<div class="clearer"></div>';
73097f07 200 }
201
202
7af1e882 203 /**
f77cfb73 204 * Display the assignment intro
7af1e882 205 *
206 * This will most likely be extended by assignment type plug-ins
207 * The default implementation prints the assignment description in a box
f77cfb73 208 */
209 function view_intro() {
3a003ead 210 global $OUTPUT;
211 echo $OUTPUT->box_start('generalbox boxaligncenter', 'intro');
dc5c2bd9 212 echo format_module_intro('assignment', $this->assignment, $this->cm->id);
3a003ead 213 echo $OUTPUT->box_end();
266540eb 214 echo plagiarism_print_disclosure($this->cm->id);
f77cfb73 215 }
216
7af1e882 217 /**
f77cfb73 218 * Display the assignment dates
7af1e882 219 *
220 * Prints the assignment start and end dates in a box.
221 * This will be suitable for most assignment types
f77cfb73 222 */
223 function view_dates() {
3a003ead 224 global $OUTPUT;
f77cfb73 225 if (!$this->assignment->timeavailable && !$this->assignment->timedue) {
226 return;
227 }
228
3a003ead 229 echo $OUTPUT->box_start('generalbox boxaligncenter', 'dates');
f77cfb73 230 echo '<table>';
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>';
234 }
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>';
238 }
239 echo '</table>';
3a003ead 240 echo $OUTPUT->box_end();
f77cfb73 241 }
242
243
7af1e882 244 /**
245 * Display the bottom and footer of a page
246 *
247 * This default method just prints the footer.
248 * This will be suitable for most assignment types
73097f07 249 */
250 function view_footer() {
256d2850 251 global $OUTPUT;
252 echo $OUTPUT->footer();
73097f07 253 }
254
7af1e882 255 /**
256 * Display the feedback to the student
257 *
258 * This default method prints the teacher picture and name, date when marked,
ea6432fe 259 * grade and teacher submissioncomment.
156d6f48
MG
260 * If advanced grading is used the method render_grade from the
261 * advanced grading controller is called to display the grade.
7af1e882 262 *
256578f6 263 * @global object
264 * @global object
265 * @global object
266 * @param object $submission The submission object or NULL in which case it will be loaded
7af1e882 267 */
73097f07 268 function view_feedback($submission=NULL) {
36937f02 269 global $USER, $CFG, $DB, $OUTPUT, $PAGE;
5978010d 270 require_once($CFG->libdir.'/gradelib.php');
36937f02 271 require_once("$CFG->dirroot/grade/grading/lib.php");
e6a4906b 272
73097f07 273 if (!$submission) { /// Get submission for this assignment
156d6f48
MG
274 $userid = $USER->id;
275 $submission = $this->get_submission($userid);
276 } else {
277 $userid = $submission->userid;
70b2c772 278 }
c7bb34b6 279 // Check the user can submit
156d6f48 280 $canviewfeedback = ($userid == $USER->id && has_capability('mod/assignment:submit', $this->context, $USER->id, false));
91421f3e 281 // If not then check if the user still has the view cap and has a previous submission
156d6f48
MG
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);
c7bb34b6 285
156d6f48
MG
286 if (!$canviewfeedback) {
287 // can not view or submit assignments -> no feedback
c7bb34b6
SH
288 return;
289 }
70b2c772 290
156d6f48 291 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid);
5978010d 292 $item = $grading_info->items[0];
156d6f48 293 $grade = $item->grades[$userid];
5978010d 294
295 if ($grade->hidden or $grade->grade === false) { // hidden or error
296 return;
297 }
298
30d61820 299 if ($grade->grade === null and empty($grade->str_feedback)) { /// Nothing to show yet
70b2c772 300 return;
9c48354d 301 }
e6a4906b 302
ced5ee59 303 $graded_date = $grade->dategraded;
12dce253 304 $graded_by = $grade->usermodified;
e6a4906b 305
5978010d 306 /// We need the teacher info
5053f00f 307 if (!$teacher = $DB->get_record('user', array('id'=>$graded_by))) {
a939f681 308 print_error('cannotfindteacher');
12dce253 309 }
5978010d 310
b0f2597e 311 /// Print the feedback
867aeead 312 echo $OUTPUT->heading(get_string('feedbackfromteacher', 'assignment', fullname($teacher)));
6d4ecaec 313
b0f2597e 314 echo '<table cellspacing="0" class="feedback">';
315
316 echo '<tr>';
317 echo '<td class="left picture">';
5978010d 318 if ($teacher) {
812dbaf7 319 echo $OUTPUT->user_picture($teacher);
5978010d 320 }
b0f2597e 321 echo '</td>';
6d4ecaec 322 echo '<td class="topic">';
70b2c772 323 echo '<div class="from">';
5978010d 324 if ($teacher) {
325 echo '<div class="fullname">'.fullname($teacher).'</div>';
326 }
327 echo '<div class="time">'.userdate($graded_date).'</div>';
70b2c772 328 echo '</div>';
b0f2597e 329 echo '</td>';
330 echo '</tr>';
331
332 echo '<tr>';
333 echo '<td class="left side">&nbsp;</td>';
6d4ecaec 334 echo '<td class="content">';
3c2b3cb3 335 $gradestr = '<div class="grade">'. get_string("grade").': '.$grade->str_long_grade. '</div>';
36937f02 336 if (!empty($submission) && $controller = get_grading_manager($this->context, 'mod_assignment', 'submission')->get_active_controller()) {
9e2eca0f 337 $controller->set_grade_range(make_grades_menu($this->assignment->grade));
3c2b3cb3 338 echo $controller->render_grade($PAGE, $submission->id, $item, $gradestr, has_capability('mod/assignment:grade', $this->context));
36937f02 339 } else {
3c2b3cb3 340 echo $gradestr;
36937f02 341 }
5978010d 342 echo '<div class="clearer"></div>';
dcd338ff 343
6d4ecaec 344 echo '<div class="comment">';
5978010d 345 echo $grade->str_feedback;
6d4ecaec 346 echo '</div>';
b0f2597e 347 echo '</tr>';
348
8efd9deb
AB
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)) {
352 echo '<tr>';
353 echo '<td class="left side">&nbsp;</td>';
354 echo '<td class="content">';
355 echo $responsefiles;
356 echo '</tr>';
357 }
358 }
359
b0f2597e 360 echo '</table>';
e6a4906b 361 }
e6a4906b 362
45fa3412 363 /**
ba16713f 364 * Returns a link with info about the state of the assignment submissions
7af1e882 365 *
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.
256578f6 370 *
371 * @global object
372 * @global object
dd97c328 373 * @param bool $allgroup print all groups info if user can access all groups, suitable for index.php
7af1e882 374 * @return string
ba16713f 375 */
dd97c328 376 function submittedlink($allgroups=false) {
ba16713f 377 global $USER;
e1faf3b9 378 global $CFG;
ba16713f 379
380 $submitted = '';
e1faf3b9 381 $urlbase = "{$CFG->wwwroot}/mod/assignment/";
ba16713f 382
bbbf2d40 383 $context = get_context_instance(CONTEXT_MODULE,$this->cm->id);
1648afb2 384 if (has_capability('mod/assignment:grade', $context)) {
dd97c328 385 if ($allgroups and has_capability('moodle/site:accessallgroups', $context)) {
386 $group = 0;
ba16713f 387 } else {
f36cbf1d 388 $group = groups_get_activity_group($this->cm);
dd97c328 389 }
54c37fbd
RW
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)) {
e1faf3b9 394 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm->id.'">'.
dd97c328 395 get_string('viewsubmissions', 'assignment', $count).'</a>';
396 } else {
e1faf3b9 397 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm->id.'">'.
dd97c328 398 get_string('noattempts', 'assignment').'</a>';
ba16713f 399 }
ba16713f 400 } else {
4f0c2d00 401 if (isloggedin()) {
ba16713f 402 if ($submission = $this->get_submission($USER->id)) {
403 if ($submission->timemodified) {
1e4343a0 404 if ($submission->timemodified <= $this->assignment->timedue || empty($this->assignment->timedue)) {
ba16713f 405 $submitted = '<span class="early">'.userdate($submission->timemodified).'</span>';
406 } else {
407 $submitted = '<span class="late">'.userdate($submission->timemodified).'</span>';
408 }
409 }
410 }
411 }
412 }
413
414 return $submitted;
415 }
416
417
256578f6 418 /**
419 * @todo Document this function
420 */
436cfa9f 421 function setup_elements(&$mform) {
45fa3412 422
436cfa9f 423 }
424
493a82f6
DC
425 /**
426 * Any preprocessing needed for the settings form for
427 * this assignment type
428 *
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
432 * @return none
433 */
434 function form_data_preprocessing(&$default_values, $form) {
435 }
436
437 /**
438 * Any extra validation checks needed for the settings
439 * form for this assignment type
440 *
441 * See lib/formslib.php, 'validation' function for details
442 */
443 function form_validation($data, $files) {
444 return array();
445 }
446
7af1e882 447 /**
448 * Create a new assignment activity
449 *
450 * Given an object containing all the necessary data,
7cac0c4b 451 * (defined by the form in mod_form.php) this function
7af1e882 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.
456 *
256578f6 457 * @global object
458 * @global object
459 * @param object $assignment The data from the form on mod_form.php
7af1e882 460 * @return int The id of the assignment
461 */
b0f2597e 462 function add_instance($assignment) {
c18269c7 463 global $COURSE, $DB;
b0f2597e 464
465 $assignment->timemodified = time();
7bddd4b7 466 $assignment->courseid = $assignment->course;
38147229 467
9d97f08e
PS
468 $returnid = $DB->insert_record("assignment", $assignment);
469 $assignment->id = $returnid;
470
471 if ($assignment->timedue) {
39790bd8 472 $event = new stdClass();
9d97f08e
PS
473 $event->name = $assignment->name;
474 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
475 $event->courseid = $assignment->course;
476 $event->groupid = 0;
477 $event->userid = 0;
478 $event->modulename = 'assignment';
479 $event->instance = $returnid;
480 $event->eventtype = 'due';
481 $event->timestart = $assignment->timedue;
482 $event->timeduration = 0;
483
484 calendar_event::create($event);
736f191c 485 }
486
9d97f08e 487 assignment_grade_item_update($assignment);
7bddd4b7 488
736f191c 489 return $returnid;
b0f2597e 490 }
d699cd1e 491
7af1e882 492 /**
493 * Deletes an assignment activity
494 *
1f8c6549 495 * Deletes all database records, files and calendar events for this assignment.
256578f6 496 *
497 * @global object
498 * @global object
499 * @param object $assignment The assignment to be deleted
7af1e882 500 * @return boolean False indicates error
501 */
b0f2597e 502 function delete_instance($assignment) {
c18269c7 503 global $CFG, $DB;
1f8c6549 504
ada917d5 505 $assignment->courseid = $assignment->course;
506
736f191c 507 $result = true;
508
fa686bc4 509 // now get rid of all files
dc85b32c 510 $fs = get_file_storage();
511 if ($cm = get_coursemodule_from_instance('assignment', $assignment->id)) {
512 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
fa686bc4 513 $fs->delete_area_files($context->id);
dc85b32c 514 }
515
c18269c7 516 if (! $DB->delete_records('assignment_submissions', array('assignment'=>$assignment->id))) {
736f191c 517 $result = false;
518 }
519
77318f47 520 if (! $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
736f191c 521 $result = false;
522 }
523
77318f47 524 if (! $DB->delete_records('assignment', array('id'=>$assignment->id))) {
736f191c 525 $result = false;
526 }
cc3b3fae 527 $mod = $DB->get_field('modules','id',array('name'=>'assignment'));
45fa3412 528
45fa3412 529 assignment_grade_item_delete($assignment);
ada917d5 530
736f191c 531 return $result;
b0f2597e 532 }
d699cd1e 533
7af1e882 534 /**
535 * Updates a new assignment activity
536 *
537 * Given an object containing all the necessary data,
7cac0c4b 538 * (defined by the form in mod_form.php) this function
7af1e882 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.
542 *
256578f6 543 * @global object
544 * @global object
545 * @param object $assignment The data from the form on mod_form.php
7efcb735 546 * @return bool success
7af1e882 547 */
b0f2597e 548 function update_instance($assignment) {
c18269c7 549 global $COURSE, $DB;
b0f2597e 550
38147229 551 $assignment->timemodified = time();
38147229 552
b0f2597e 553 $assignment->id = $assignment->instance;
7bddd4b7 554 $assignment->courseid = $assignment->course;
736f191c 555
9d749339 556 $DB->update_record('assignment', $assignment);
736f191c 557
7bddd4b7 558 if ($assignment->timedue) {
39790bd8 559 $event = new stdClass();
736f191c 560
c18269c7 561 if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
736f191c 562
7bddd4b7 563 $event->name = $assignment->name;
dc5c2bd9 564 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
7bddd4b7 565 $event->timestart = $assignment->timedue;
736f191c 566
9b72d37e
SH
567 $calendarevent = calendar_event::load($event->id);
568 $calendarevent->update($event);
47263937 569 } else {
39790bd8 570 $event = new stdClass();
7bddd4b7 571 $event->name = $assignment->name;
dc5c2bd9 572 $event->description = format_module_intro('assignment', $assignment, $assignment->coursemodule);
7bddd4b7 573 $event->courseid = $assignment->course;
574 $event->groupid = 0;
575 $event->userid = 0;
576 $event->modulename = 'assignment';
577 $event->instance = $assignment->id;
578 $event->eventtype = 'due';
579 $event->timestart = $assignment->timedue;
580 $event->timeduration = 0;
581
9b72d37e 582 calendar_event::create($event);
736f191c 583 }
7bddd4b7 584 } else {
c18269c7 585 $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id));
736f191c 586 }
587
7bddd4b7 588 // get existing grade item
45fa3412 589 assignment_grade_item_update($assignment);
7bddd4b7 590
591 return true;
592 }
593
594 /**
45fa3412 595 * Update grade item for this submission.
7bddd4b7 596 */
45fa3412 597 function update_grade($submission) {
612607bd 598 assignment_update_grades($this->assignment, $submission->userid);
b0f2597e 599 }
600
7af1e882 601 /**
b0f2597e 602 * Top-level function for handling of submissions called by submissions.php
7af1e882 603 *
604 * This is for handling the teacher interaction with the grading interface
605 * This should be suitable for most assignment types.
606 *
256578f6 607 * @global object
608 * @param string $mode Specifies the kind of teacher interaction taking place
b0f2597e 609 */
610 function submissions($mode) {
9bf660b3 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
45fa3412 615
9bf660b3 616 //make user global so we can use the id
a19dffc0 617 global $USER, $OUTPUT, $DB, $PAGE;
45fa3412 618
de75c481 619 $mailinfo = optional_param('mailinfo', null, PARAM_BOOL);
d2b6ee29 620
261b585d 621 if (optional_param('next', null, PARAM_BOOL)) {
d2b6ee29 622 $mode='next';
623 }
261b585d 624 if (optional_param('saveandnext', null, PARAM_BOOL)) {
d2b6ee29 625 $mode='saveandnext';
626 }
627
2dc5d980 628 if (is_null($mailinfo)) {
fdb797ad 629 if (optional_param('sesskey', null, PARAM_BOOL)) {
3367f14b 630 set_user_preference('assignment_mailinfo', 0);
fdb797ad
RW
631 } else {
632 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
633 }
2dc5d980 634 } else {
635 set_user_preference('assignment_mailinfo', $mailinfo);
de75c481 636 }
d2b6ee29 637
36937f02
MG
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();
641 return;
642 }
643
b0f2597e 644 switch ($mode) {
d2b6ee29 645 case 'grade': // We are in a main window grading
b0f2597e 646 if ($submission = $this->process_feedback()) {
d2b6ee29 647 $this->display_submissions(get_string('changessaved'));
648 } else {
649 $this->display_submissions();
b0f2597e 650 }
b0f2597e 651 break;
9cc9b7c1 652
d2b6ee29 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'));
656 } else {
657 $this->display_submission();
658 }
b0f2597e 659 break;
a56d79cd 660
1648afb2 661 case 'all': // Main window, display everything
b0f2597e 662 $this->display_submissions();
663 break;
082215e6 664
9bf660b3 665 case 'fastgrade':
082215e6 666 ///do the fast grading stuff - this process should work for all 3 subclasses
39e11905 667 $grading = false;
16907e53 668 $commenting = false;
39e11905 669 $col = false;
ea6432fe 670 if (isset($_POST['submissioncomment'])) {
671 $col = 'submissioncomment';
16907e53 672 $commenting = true;
673 }
674 if (isset($_POST['menu'])) {
39e11905 675 $col = 'menu';
16907e53 676 $grading = true;
677 }
39e11905 678 if (!$col) {
ea6432fe 679 //both submissioncomment and grade columns collapsed..
45fa3412 680 $this->display_submissions();
16907e53 681 break;
682 }
2dc5d980 683
39e11905 684 foreach ($_POST[$col] as $id => $unusedvalue){
77f4b17b 685
686 $id = (int)$id; //clean parameter name
cc03871b 687
688 $this->process_outcomes($id);
689
39e11905 690 if (!$submission = $this->get_submission($id)) {
691 $submission = $this->prepare_new_submission($id);
692 $newsubmission = true;
693 } else {
694 $newsubmission = false;
695 }
696 unset($submission->data1); // Don't need to update this.
697 unset($submission->data2); // Don't need to update this.
16907e53 698
9bf660b3 699 //for fast grade, we need to check if any changes take place
16907e53 700 $updatedb = false;
701
702 if ($grading) {
703 $grade = $_POST['menu'][$id];
39e11905 704 $updatedb = $updatedb || ($submission->grade != $grade);
705 $submission->grade = $grade;
16907e53 706 } else {
39e11905 707 if (!$newsubmission) {
708 unset($submission->grade); // Don't need to update this.
709 }
16907e53 710 }
711 if ($commenting) {
ea6432fe 712 $commentvalue = trim($_POST['submissioncomment'][$id]);
5053f00f 713 $updatedb = $updatedb || ($submission->submissioncomment != $commentvalue);
ea6432fe 714 $submission->submissioncomment = $commentvalue;
16907e53 715 } else {
ea6432fe 716 unset($submission->submissioncomment); // Don't need to update this.
9bf660b3 717 }
718
39e11905 719 $submission->teacher = $USER->id;
2dc5d980 720 if ($updatedb) {
721 $submission->mailed = (int)(!$mailinfo);
722 }
723
39e11905 724 $submission->timemarked = time();
725
726 //if it is not an update, we don't change the last modified time etc.
ea6432fe 727 //this will also not write into database if no submissioncomment and grade is entered.
39e11905 728
16907e53 729 if ($updatedb){
39e11905 730 if ($newsubmission) {
39f563ed 731 if (!isset($submission->submissioncomment)) {
732 $submission->submissioncomment = '';
733 }
9d749339 734 $sid = $DB->insert_record('assignment_submissions', $submission);
7bddd4b7 735 $submission->id = $sid;
39e11905 736 } else {
9d749339 737 $DB->update_record('assignment_submissions', $submission);
7bddd4b7 738 }
739
91421f3e 740 // trigger grade event
45fa3412 741 $this->update_grade($submission);
7bddd4b7 742
39e11905 743 //add to log only if updating
45fa3412 744 add_to_log($this->course->id, 'assignment', 'update grades',
0f66aced 745 'submissions.php?id='.$this->cm->id.'&user='.$submission->userid,
45fa3412 746 $submission->userid, $this->cm->id);
9bf660b3 747 }
45fa3412 748
749 }
cc03871b 750
3a003ead 751 $message = $OUTPUT->notification(get_string('changessaved'), 'notifysuccess');
fb81abe1 752
753 $this->display_submissions($message);
9bf660b3 754 break;
39e11905 755
756
9bf660b3 757 case 'saveandnext':
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'));
d2b6ee29 762 //$extra_javascript = $this->update_main_listing($submission);
9bf660b3 763 }
45fa3412 764
d2b6ee29 765 case 'next':
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);
89a4471b 772 $filter = optional_param('filter', self::FILTER_ALL, PARAM_INT);
70eddb71
ARN
773
774 if ($mode == 'next' || $filter !== self::FILTER_REQUIRE_GRADING) {
775 $offset = (int)$offset+1;
776 }
89a4471b
ARN
777 $redirect = new moodle_url('submissions.php',
778 array('id' => $id, 'offset' => $offset, 'userid' => $nextid,
779 'mode' => 'single', 'filter' => $filter));
780
781 redirect($redirect);
9bf660b3 782 break;
45fa3412 783
2d274675
AB
784 case 'singlenosave':
785 $this->display_submission();
786 break;
787
9bf660b3 788 default:
789 echo "something seriously is wrong!!";
45fa3412 790 break;
a56d79cd 791 }
b0f2597e 792 }
45fa3412 793
9e2eca0f
MG
794 /**
795 * Checks if grading method allows quickgrade mode. At the moment it is hardcoded
796 * that advanced grading methods do not allow quickgrade.
797 *
798 * Assignment type plugins are not allowed to override this method
799 *
800 * @return boolean
801 */
802 public final function quickgrade_mode_allowed() {
803 global $CFG;
804 require_once("$CFG->dirroot/grade/grading/lib.php");
805 if ($controller = get_grading_manager($this->context, 'mod_assignment', 'submission')->get_active_controller()) {
806 return false;
807 }
808 return true;
809 }
810
7af1e882 811 /**
256578f6 812 * Helper method updating the listing on the main script from popup using javascript
813 *
814 * @global object
815 * @global object
816 * @param $submission object The submission whose data is to be updated on the main page
817 */
be86672d 818 function update_main_listing($submission) {
a9573c08 819 global $SESSION, $CFG, $OUTPUT;
45fa3412 820
73963212 821 $output = '';
822
9bf660b3 823 $perpage = get_user_preferences('assignment_perpage', 10);
be86672d 824
9e2eca0f 825 $quickgrade = get_user_preferences('assignment_quickgrade', 0) && $this->quickgrade_mode_allowed();
45fa3412 826
be86672d 827 /// Run some Javascript to try and update the parent page
73963212 828 $output .= '<script type="text/javascript">'."\n<!--\n";
ea6432fe 829 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['submissioncomment'])) {
9bf660b3 830 if ($quickgrade){
16fc2088 831 $output.= 'opener.document.getElementById("submissioncomment'.$submission->userid.'").value="'
ea6432fe 832 .trim($submission->submissioncomment).'";'."\n";
9bf660b3 833 } else {
73963212 834 $output.= 'opener.document.getElementById("com'.$submission->userid.
ea6432fe 835 '").innerHTML="'.shorten_text(trim(strip_tags($submission->submissioncomment)), 15)."\";\n";
9bf660b3 836 }
be86672d 837 }
9bf660b3 838
839 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['grade'])) {
840 //echo optional_param('menuindex');
841 if ($quickgrade){
16fc2088 842 $output.= 'opener.document.getElementById("menumenu'.$submission->userid.
843 '").selectedIndex="'.optional_param('menuindex', 0, PARAM_INT).'";'."\n";
9bf660b3 844 } else {
73963212 845 $output.= 'opener.document.getElementById("g'.$submission->userid.'").innerHTML="'.
9bf660b3 846 $this->display_grade($submission->grade)."\";\n";
45fa3412 847 }
848 }
9bf660b3 849 //need to add student's assignments in there too.
73097f07 850 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['timemodified']) &&
851 $submission->timemodified) {
73963212 852 $output.= 'opener.document.getElementById("ts'.$submission->userid.
3a935caf 853 '").innerHTML="'.addslashes_js($this->print_student_answer($submission->userid)).userdate($submission->timemodified)."\";\n";
be86672d 854 }
45fa3412 855
73097f07 856 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['timemarked']) &&
857 $submission->timemarked) {
73963212 858 $output.= 'opener.document.getElementById("tt'.$submission->userid.
be86672d 859 '").innerHTML="'.userdate($submission->timemarked)."\";\n";
860 }
45fa3412 861
be86672d 862 if (empty($SESSION->flextable['mod-assignment-submissions']->collapse['status'])) {
73963212 863 $output.= 'opener.document.getElementById("up'.$submission->userid.'").className="s1";';
9bf660b3 864 $buttontext = get_string('update');
a9573c08 865 $url = new moodle_url('/mod/assignment/submissions.php', array(
866 'id' => $this->cm->id,
867 'userid' => $submission->userid,
e7521559 868 'mode' => 'single',
a9573c08 869 'offset' => (optional_param('offset', '', PARAM_INT)-1)));
57cd3739 870 $button = $OUTPUT->action_link($url, $buttontext, new popup_action('click', $url, 'grade'.$submission->userid, array('height' => 450, 'width' => 700)), array('ttile'=>$buttontext));
e7521559 871
57cd3739 872 $output .= 'opener.document.getElementById("up'.$submission->userid.'").innerHTML="'.addslashes_js($button).'";';
45fa3412 873 }
f1af7aaa 874
5978010d 875 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $submission->userid);
876
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";
880 }
881
882 if (!empty($CFG->enableoutcomes) and empty($SESSION->flextable['mod-assignment-submissions']->collapse['outcome'])) {
fcac8e51 883
884 if (!empty($grading_info->outcomes)) {
d886a7ea 885 foreach($grading_info->outcomes as $n=>$outcome) {
886 if ($outcome->grades[$submission->userid]->locked) {
887 continue;
888 }
cc03871b 889
d886a7ea 890 if ($quickgrade){
891 $output.= 'opener.document.getElementById("outcome_'.$n.'_'.$submission->userid.
892 '").selectedIndex="'.$outcome->grades[$submission->userid]->grade.'";'."\n";
893
894 } else {
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";
898 }
cc03871b 899
900 }
901 }
902 }
903
73963212 904 $output .= "\n-->\n</script>";
905 return $output;
be86672d 906 }
d699cd1e 907
7af1e882 908 /**
909 * Return a grade in user-friendly form, whether it's a scale or not
45fa3412 910 *
256578f6 911 * @global object
912 * @param mixed $grade
7af1e882 913 * @return string User-friendly representation of grade
d59269cf 914 */
915 function display_grade($grade) {
74d7d735 916 global $DB;
d59269cf 917
c86aa2a4 918 static $scalegrades = array(); // Cache scales for each assignment - they might have different scales!!
d59269cf 919
920 if ($this->assignment->grade >= 0) { // Normal number
082215e6 921 if ($grade == -1) {
922 return '-';
923 } else {
924 return $grade.' / '.$this->assignment->grade;
925 }
d59269cf 926
927 } else { // Scale
c86aa2a4 928 if (empty($scalegrades[$this->assignment->id])) {
74d7d735 929 if ($scale = $DB->get_record('scale', array('id'=>-($this->assignment->grade)))) {
c86aa2a4 930 $scalegrades[$this->assignment->id] = make_menu_from_list($scale->scale);
d59269cf 931 } else {
932 return '-';
933 }
934 }
c86aa2a4 935 if (isset($scalegrades[$this->assignment->id][$grade])) {
936 return $scalegrades[$this->assignment->id][$grade];
0f7d4e5e 937 }
39e11905 938 return '-';
d59269cf 939 }
940 }
941
7af1e882 942 /**
b0f2597e 943 * Display a single submission, ready for grading on a popup window
7af1e882 944 *
ea6432fe 945 * This default method prints the teacher info and submissioncomment box at the top and
7af1e882 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
256578f6 952 *
953 * @global object
954 * @global object
955 * @param string $extra_javascript
b0f2597e 956 */
291ee134 957 function display_submission($offset=-1,$userid =-1, $display=true) {
36937f02 958 global $CFG, $DB, $PAGE, $OUTPUT, $USER;
cc03871b 959 require_once($CFG->libdir.'/gradelib.php');
dd97c328 960 require_once($CFG->libdir.'/tablelib.php');
291ee134 961 require_once("$CFG->dirroot/repository/lib.php");
fba356f3 962 require_once("$CFG->dirroot/grade/grading/lib.php");
261b585d 963 if ($userid==-1) {
964 $userid = required_param('userid', PARAM_INT);
965 }
966 if ($offset==-1) {
967 $offset = required_param('offset', PARAM_INT);//offset for where to start looking for student.
968 }
fdb797ad 969 $filter = optional_param('filter', 0, PARAM_INT);
d699cd1e 970
5053f00f 971 if (!$user = $DB->get_record('user', array('id'=>$userid))) {
a939f681 972 print_error('nousers');
b0f2597e 973 }
d699cd1e 974
39e11905 975 if (!$submission = $this->get_submission($user->id)) {
976 $submission = $this->prepare_new_submission($userid);
b0f2597e 977 }
b0f2597e 978 if ($submission->timemodified > $submission->timemarked) {
979 $subtype = 'assignmentnew';
980 } else {
981 $subtype = 'assignmentold';
982 }
d699cd1e 983
5978010d 984 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array($user->id));
d2b6ee29 985 $gradingdisabled = $grading_info->items[0]->grades[$userid]->locked || $grading_info->items[0]->grades[$userid]->overridden;
5978010d 986
0cfafdc7 987 /// construct SQL, using current offset to find the data of the next student
9bf660b3 988 $course = $this->course;
989 $assignment = $this->assignment;
990 $cm = $this->cm;
16fc2088 991 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
d699cd1e 992
54c37fbd
RW
993 //reset filter to all for offline assignment
994 if ($assignment->assignmenttype == 'offline' && $filter == self::FILTER_SUBMITTED) {
995 $filter = self::FILTER_ALL;
996 }
7bddd4b7 997 /// Get all ppl that can submit assignments
0cfafdc7 998
ba3dc7b4 999 $currentgroup = groups_get_activity_group($cm);
4ac9f470 1000 $users = get_enrolled_users($context, 'mod/assignment:submit', $currentgroup, 'u.id');
c7bb34b6 1001 if ($users) {
dd97c328 1002 $users = array_keys($users);
c7bb34b6
SH
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));
1007 }
dd97c328 1008 }
02828119 1009 }
1010
082215e6 1011 $nextid = 0;
fdb797ad 1012 $where = '';
54c37fbd 1013 if($filter == self::FILTER_SUBMITTED) {
fdb797ad 1014 $where .= 's.timemodified > 0 AND ';
54c37fbd 1015 } else if($filter == self::FILTER_REQUIRE_GRADING) {
fdb797ad
RW
1016 $where .= 's.timemarked < s.timemodified AND ';
1017 }
dd97c328 1018
1019 if ($users) {
3a11c09f
PS
1020 $userfields = user_picture::fields('u', array('lastaccess'));
1021 $select = "SELECT $userfields,
dd97c328 1022 s.id AS submissionid, s.grade, s.submissioncomment,
8c93ab4e
SB
1023 s.timemodified, s.timemarked,
1024 CASE WHEN s.timemarked > 0 AND s.timemarked >= s.timemodified THEN 1
1025 ELSE 0 END AS status ";
1026
5053f00f 1027 $sql = 'FROM {user} u '.
1028 'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
fdb797ad
RW
1029 AND s.assignment = '.$this->assignment->id.' '.
1030 'WHERE '.$where.'u.id IN ('.implode(',', $users).') ';
dd97c328 1031
9baf2670 1032 if ($sort = flexible_table::get_sort_for_table('mod-assignment-submissions')) {
dd97c328 1033 $sort = 'ORDER BY '.$sort.' ';
1034 }
d2b6ee29 1035 $auser = $DB->get_records_sql($select.$sql.$sort, null, $offset, 2);
dd97c328 1036
d2b6ee29 1037 if (is_array($auser) && count($auser)>1) {
1038 $nextuser = next($auser);
dd97c328 1039 $nextid = $nextuser->id;
1040 }
9bf660b3 1041 }
d699cd1e 1042
b0f2597e 1043 if ($submission->teacher) {
5053f00f 1044 $teacher = $DB->get_record('user', array('id'=>$submission->teacher));
b0f2597e 1045 } else {
1046 global $USER;
1047 $teacher = $USER;
1048 }
de75c481 1049
01e2fdfe 1050 $this->preprocess_submission($submission);
1051
6bdfef5d 1052 $mformdata = new stdClass();
d2b6ee29 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;
d2b6ee29 1069 $mformdata->nextid = $nextid;
1070 $mformdata->submissioncomment= $submission->submissioncomment;
1071 $mformdata->submissioncommentformat= FORMAT_HTML;
2a576f94 1072 $mformdata->submission_content= $this->print_user_files($user->id,true);
fdb797ad 1073 $mformdata->filter = $filter;
be34802d 1074 $mformdata->mailinfo = get_user_preferences('assignment_mailinfo', 0);
291ee134
AB
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);
1079 }
0e2a1d75
MG
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()) {
1085 $itemid = null;
1086 if (!empty($submission->id)) {
1087 $itemid = $submission->id;
1088 }
71380f2f
MG
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);
1094 }
0e2a1d75
MG
1095 } else {
1096 $advancedgradingwarning = $controller->form_unavailable_notification();
18e6298c 1097 }
fba356f3 1098 }
de75c481 1099
cd0fe5a4 1100 $submitform = new mod_assignment_grading_form( null, $mformdata );
d2b6ee29 1101
291ee134
AB
1102 if (!$display) {
1103 $ret_data = new stdClass();
1104 $ret_data->mform = $submitform;
18e6298c
MG
1105 if (isset($mformdata->fileui_options)) {
1106 $ret_data->fileui_options = $mformdata->fileui_options;
1107 }
291ee134
AB
1108 return $ret_data;
1109 }
1110
261b585d 1111 if ($submitform->is_cancelled()) {
d2b6ee29 1112 redirect('submissions.php?id='.$this->cm->id);
1113 }
1114
1115 $submitform->set_data($mformdata);
1116
1117 $PAGE->set_title($this->course->fullname . ': ' .get_string('feedback', 'assignment').' - '.fullname($user, true));
1118 $PAGE->set_heading($this->course->fullname);
291ee134
AB
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));
b0f2597e 1121
d2b6ee29 1122 echo $OUTPUT->header();
1123 echo $OUTPUT->heading(get_string('feedback', 'assignment').': '.fullname($user, true));
2dc5d980 1124
d2b6ee29 1125 // display mform here...
0e2a1d75
MG
1126 if ($advancedgradingwarning) {
1127 echo $OUTPUT->notification($advancedgradingwarning, 'error');
1128 }
d2b6ee29 1129 $submitform->display();
55b4d096 1130
1131 $customfeedback = $this->custom_feedbackform($submission, true);
1132 if (!empty($customfeedback)) {
45fa3412 1133 echo $customfeedback;
55b4d096 1134 }
1135
256d2850 1136 echo $OUTPUT->footer();
d699cd1e 1137 }
1138
7af1e882 1139 /**
01e2fdfe 1140 * Preprocess submission before grading
7af1e882 1141 *
1142 * Called by display_submission()
1143 * The default type does nothing here.
256578f6 1144 *
1145 * @param object $submission The submission object
01e2fdfe 1146 */
1147 function preprocess_submission(&$submission) {
1148 }
d699cd1e 1149
7af1e882 1150 /**
b0f2597e 1151 * Display all the submissions ready for grading
256578f6 1152 *
1153 * @global object
1154 * @global object
1155 * @global object
1156 * @global object
1157 * @param string $message
1158 * @return bool|void
b0f2597e 1159 */
fb81abe1 1160 function display_submissions($message='') {
b98b15d7 1161 global $CFG, $DB, $USER, $DB, $OUTPUT, $PAGE;
cc03871b 1162 require_once($CFG->libdir.'/gradelib.php');
3446205d 1163
9bf660b3 1164 /* first we check to see if the form has just been submitted
1165 * to request user_preference updates
1166 */
de75c481 1167
fdb797ad 1168 $filters = array(self::FILTER_ALL => get_string('all'),
fdb797ad
RW
1169 self::FILTER_REQUIRE_GRADING => get_string('requiregrading', 'assignment'));
1170
54c37fbd
RW
1171 $updatepref = optional_param('updatepref', 0, PARAM_BOOL);
1172 if ($updatepref) {
16907e53 1173 $perpage = optional_param('perpage', 10, PARAM_INT);
9bf660b3 1174 $perpage = ($perpage <= 0) ? 10 : $perpage ;
fdb797ad 1175 $filter = optional_param('filter', 0, PARAM_INT);
9bf660b3 1176 set_user_preference('assignment_perpage', $perpage);
de75c481 1177 set_user_preference('assignment_quickgrade', optional_param('quickgrade', 0, PARAM_BOOL));
fdb797ad 1178 set_user_preference('assignment_filter', $filter);
9bf660b3 1179 }
1b5910c4 1180
45fa3412 1181 /* next we get perpage and quickgrade (allow quick grade) params
9bf660b3 1182 * from database
1183 */
1184 $perpage = get_user_preferences('assignment_perpage', 10);
9e2eca0f 1185 $quickgrade = get_user_preferences('assignment_quickgrade', 0) && $this->quickgrade_mode_allowed();
fdb797ad 1186 $filter = get_user_preferences('assignment_filter', 0);
fcac8e51 1187 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id);
45fa3412 1188
fcac8e51 1189 if (!empty($CFG->enableoutcomes) and !empty($grading_info->outcomes)) {
e46f4d11 1190 $uses_outcomes = true;
1191 } else {
1192 $uses_outcomes = false;
1193 }
1194
16907e53 1195 $page = optional_param('page', 0, PARAM_INT);
b0f2597e 1196 $strsaveallfeedback = get_string('saveallfeedback', 'assignment');
d0ac6bc2 1197
b0f2597e 1198 /// Some shortcuts to make the code read better
45fa3412 1199
b0f2597e 1200 $course = $this->course;
1201 $assignment = $this->assignment;
1202 $cm = $this->cm;
e512715b 1203 $hassubmission = false;
45fa3412 1204
54c37fbd
RW
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;
1209 }
1210 } else {
1211 $filters[self::FILTER_SUBMITTED] = get_string('submitted', 'assignment');
1212 }
1213
dad55fc5 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);
96f4a64b 1216
dad55fc5 1217 $PAGE->set_title(format_string($this->assignment->name,true));
d2b6ee29 1218 $PAGE->set_heading($this->course->fullname);
dad55fc5 1219 echo $OUTPUT->header();
1220
fdb797ad 1221 echo '<div class="usersubmissions">';
de75c481 1222
44729427 1223 //hook to allow plagiarism plugins to update status/print links.
266540eb 1224 echo plagiarism_update_status($this->course, $this->cm);
44729427 1225
fb739b77 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)) {
12dce253 1228 echo '<div class="allcoursegrades"><a href="' . $CFG->wwwroot . '/grade/report/grader/index.php?id=' . $course->id . '">'
b64792f6 1229 . get_string('seeallcoursegrades', 'grades') . '</a></div>';
fb739b77 1230 }
7bddd4b7 1231
fb81abe1 1232 if (!empty($message)) {
1233 echo $message; // display messages here if any
1234 }
1235
2d7617c6 1236 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
7bddd4b7 1237
dd97c328 1238 /// Check to see if groups are being used in this assignment
1239
7bddd4b7 1240 /// find out current groups mode
ba3dc7b4 1241 $groupmode = groups_get_activity_groupmode($cm);
1242 $currentgroup = groups_get_activity_group($cm, true);
f1035deb 1243 groups_print_activity_menu($cm, $CFG->wwwroot . '/mod/assignment/submissions.php?id=' . $this->cm->id);
7bddd4b7 1244
13b3f4d4
MG
1245 /// Print quickgrade form around the table
1246 if ($quickgrade) {
1247 $formattrs = array();
1248 $formattrs['action'] = new moodle_url('/mod/assignment/submissions.php');
1249 $formattrs['id'] = 'fastg';
1250 $formattrs['method'] = 'post';
1251
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()));
1257 }
1258
7bddd4b7 1259 /// Get all ppl that are allowed to submit assignments
7d8b217b 1260 list($esql, $params) = get_enrolled_sql($context, 'mod/assignment:submit', $currentgroup);
de75c481 1261
fdb797ad
RW
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 ";
1266 } else {
54c37fbd
RW
1267 $wherefilter = ' AND s.assignment = '. $this->assignment->id;
1268 $assignmentsubmission = "LEFT JOIN {assignment_submissions} s ON (u.id = s.userid) ";
fdb797ad 1269 if($filter == self::FILTER_SUBMITTED) {
54c37fbd
RW
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 = "";
1275 $wherefilter = "";
fdb797ad
RW
1276 }
1277
1278 $sql = "SELECT u.id FROM {user} u ".
1279 "LEFT JOIN ($esql) eu ON eu.id=u.id ".
54c37fbd 1280 $assignmentsubmission.
fdb797ad 1281 "WHERE u.deleted = 0 AND eu.id=u.id ".
54c37fbd 1282 $wherefilter;
fdb797ad
RW
1283 }
1284
1285 $users = $DB->get_records_sql($sql, $params);
1286 if (!empty($users)) {
54c37fbd
RW
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]);
1292 }
1293 }
1294 }
33150205 1295 $users = array_keys($users);
1296 }
ba3dc7b4 1297
dd97c328 1298 // if groupmembersonly used, remove users who are not in any group
98da6021 1299 if ($users and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
dd97c328 1300 if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
1301 $users = array_intersect($users, array_keys($groupingusers));
1302 }
ba3dc7b4 1303 }
91719320 1304
02dd3b9f 1305 $extrafields = get_extra_user_fields($context);
1306 $tablecolumns = array_merge(array('picture', 'fullname'), $extrafields,
1307 array('grade', 'submissioncomment', 'timemodified', 'timemarked', 'status', 'finalgrade'));
e46f4d11 1308 if ($uses_outcomes) {
5978010d 1309 $tablecolumns[] = 'outcome'; // no sorting based on outcomes column
fbaa56b2 1310 }
1311
02dd3b9f 1312 $extrafieldnames = array();
1313 foreach ($extrafields as $field) {
1314 $extrafieldnames[] = get_user_field_name($field);
1315 }
1316 $tableheaders = array_merge(
1317 array('', get_string('fullnameuser')),
1318 $extrafieldnames,
1319 array(
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'),
1326 ));
e46f4d11 1327 if ($uses_outcomes) {
5978010d 1328 $tableheaders[] = get_string('outcome', 'grades');
fbaa56b2 1329 }
91719320 1330
b0f2597e 1331 require_once($CFG->libdir.'/tablelib.php');
1332 $table = new flexible_table('mod-assignment-submissions');
45fa3412 1333
b0f2597e 1334 $table->define_columns($tablecolumns);
1335 $table->define_headers($tableheaders);
fa22fd5f 1336 $table->define_baseurl($CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id.'&amp;currentgroup='.$currentgroup);
45fa3412 1337
246444b9 1338 $table->sortable(true, 'lastname');//sorted by lastname by default
b0f2597e 1339 $table->collapsible(true);
1340 $table->initialbars(true);
45fa3412 1341
b0f2597e 1342 $table->column_suppress('picture');
1343 $table->column_suppress('fullname');
45fa3412 1344
b0f2597e 1345 $table->column_class('picture', 'picture');
9437c854 1346 $table->column_class('fullname', 'fullname');
02dd3b9f 1347 foreach ($extrafields as $field) {
1348 $table->column_class($field, $field);
1349 }
9437c854 1350 $table->column_class('grade', 'grade');
ea6432fe 1351 $table->column_class('submissioncomment', 'comment');
9437c854 1352 $table->column_class('timemodified', 'timemodified');
1353 $table->column_class('timemarked', 'timemarked');
1354 $table->column_class('status', 'status');
5978010d 1355 $table->column_class('finalgrade', 'finalgrade');
e46f4d11 1356 if ($uses_outcomes) {
5978010d 1357 $table->column_class('outcome', 'outcome');
fbaa56b2 1358 }
45fa3412 1359
b0f2597e 1360 $table->set_attribute('cellspacing', '0');
1361 $table->set_attribute('id', 'attempts');
9437c854 1362 $table->set_attribute('class', 'submissions');
f30036d3 1363 $table->set_attribute('width', '100%');
45fa3412 1364
5978010d 1365 $table->no_sorting('finalgrade');
1366 $table->no_sorting('outcome');
1367
b0f2597e 1368 // Start working -- this is necessary as soon as the niceties are over
1369 $table->setup();
1370
54c37fbd 1371 /// Construct the SQL
0f21a964
PS
1372 list($where, $params) = $table->get_sql_where();
1373 if ($where) {
b0f2597e 1374 $where .= ' AND ';
1375 }
de75c481 1376
0f21a964 1377 if ($filter == self::FILTER_SUBMITTED) {
de75c481 1378 $where .= 's.timemodified > 0 AND ';
fdb797ad 1379 } else if($filter == self::FILTER_REQUIRE_GRADING) {
54c37fbd
RW
1380 $where = '';
1381 if ($assignment->assignmenttype != 'offline') {
1382 $where .= 's.timemarked < s.timemodified AND ';
1383 }
fdb797ad 1384 }
0f1a97c2 1385
b0f2597e 1386 if ($sort = $table->get_sql_sort()) {
86f65395 1387 $sort = ' ORDER BY '.$sort;
b0f2597e 1388 }
9fa49e22 1389
02dd3b9f 1390 $ufields = user_picture::fields('u', $extrafields);
e512715b
RW
1391 if (!empty($users)) {
1392 $select = "SELECT $ufields,
1393 s.id AS submissionid, s.grade, s.submissioncomment,
8c93ab4e
SB
1394 s.timemodified, s.timemarked,
1395 CASE WHEN s.timemarked > 0 AND s.timemarked >= s.timemodified THEN 1
1396 ELSE 0 END AS status ";
1397
e512715b
RW
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).') ';
1402
1403 $ausers = $DB->get_records_sql($select.$sql.$sort, $params, $table->get_page_start(), $table->get_page_size());
1404
1405 $table->pagesize($perpage, count($users));
1406
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);
1412
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) {
d50645eb 1419 $rowclass = null;
e512715b
RW
1420 $final_grade = $grading_info->items[0]->grades[$auser->id];
1421 $grademax = $grading_info->items[0]->grademax;
1422 $final_grade->formatted_grade = round($final_grade->grade,2) .' / ' . round($grademax,2);
1423 $locked_overridden = 'locked';
1424 if ($final_grade->overridden) {
1425 $locked_overridden = 'overridden';
1426 }
fdb797ad 1427
9e2eca0f 1428 // TODO add here code if advanced grading grade must be reviewed => $auser->status=0
1ae9aa2b 1429
e512715b 1430 $picture = $OUTPUT->user_picture($auser);
45fa3412 1431
e512715b
RW
1432 if (empty($auser->submissionid)) {
1433 $auser->grade = -1; //no submission yet
1434 }
45fa3412 1435
e512715b
RW
1436 if (!empty($auser->submissionid)) {
1437 $hassubmission = true;
1438 ///Prints student answer and student modified date
1439 ///attach file or print link to student answer, depending on the type of the assignment.
1440 ///Refer to print_student_answer in inherited classes.
1441 if ($auser->timemodified > 0) {
d50645eb
ARN
1442 $studentmodifiedcontent = $this->print_student_answer($auser->id)
1443 . userdate($auser->timemodified);
1444 if ($assignment->timedue && $auser->timemodified > $assignment->timedue) {
1445 $studentmodifiedcontent .= assignment_display_lateness($auser->timemodified, $assignment->timedue);
1446 $rowclass = 'late';
1447 }
e512715b 1448 } else {
d50645eb 1449 $studentmodifiedcontent = '&nbsp;';
e512715b 1450 }
d50645eb 1451 $studentmodified = html_writer::tag('div', $studentmodifiedcontent, array('id' => 'ts' . $auser->id));
e512715b
RW
1452 ///Print grade, dropdown or text
1453 if ($auser->timemarked > 0) {
1454 $teachermodified = '<div id="tt'.$auser->id.'">'.userdate($auser->timemarked).'</div>';
1455
1456 if ($final_grade->locked or $final_grade->overridden) {
1457 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1458 } else if ($quickgrade) {
1459 $attributes = array();
1460 $attributes['tabindex'] = $tabindex++;
1461 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1462 $grade = '<div id="g'.$auser->id.'">'. $menu .'</div>';
1463 } else {
1464 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1465 }
45fa3412 1466
e512715b
RW
1467 } else {
1468 $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
1469 if ($final_grade->locked or $final_grade->overridden) {
1470 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1471 } else if ($quickgrade) {
1472 $attributes = array();
1473 $attributes['tabindex'] = $tabindex++;
1474 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1475 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1476 } else {
1477 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1478 }
1479 }
1480 ///Print Comment
1481 if ($final_grade->locked or $final_grade->overridden) {
1482 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($final_grade->str_feedback),15).'</div>';
1483
1484 } else if ($quickgrade) {
1485 $comment = '<div id="com'.$auser->id.'">'
1486 . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1487 . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1488 } else {
1489 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($auser->submissioncomment),15).'</div>';
1490 }
fdb797ad
RW
1491 } else {
1492 $studentmodified = '<div id="ts'.$auser->id.'">&nbsp;</div>';
e512715b
RW
1493 $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
1494 $status = '<div id="st'.$auser->id.'">&nbsp;</div>';
fdb797ad
RW
1495
1496 if ($final_grade->locked or $final_grade->overridden) {
e512715b
RW
1497 $grade = '<div id="g'.$auser->id.'">'.$final_grade->formatted_grade . '</div>';
1498 $hassubmission = true;
1499 } else if ($quickgrade) { // allow editing
fdb797ad
RW
1500 $attributes = array();
1501 $attributes['tabindex'] = $tabindex++;
1502 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
e512715b
RW
1503 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1504 $hassubmission = true;
fdb797ad 1505 } else {
e512715b 1506 $grade = '<div id="g'.$auser->id.'">-</div>';
fdb797ad
RW
1507 }
1508
fdb797ad 1509 if ($final_grade->locked or $final_grade->overridden) {
e512715b 1510 $comment = '<div id="com'.$auser->id.'">'.$final_grade->str_feedback.'</div>';
fdb797ad 1511 } else if ($quickgrade) {
e512715b
RW
1512 $comment = '<div id="com'.$auser->id.'">'
1513 . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1514 . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
fdb797ad 1515 } else {
e512715b 1516 $comment = '<div id="com'.$auser->id.'">&nbsp;</div>';
fdb797ad
RW
1517 }
1518 }
fdb797ad 1519
e512715b
RW
1520 if (empty($auser->status)) { /// Confirm we have exclusively 0 or 1
1521 $auser->status = 0;
fdb797ad 1522 } else {
e512715b 1523 $auser->status = 1;
9bf660b3 1524 }
206ab184 1525
e512715b 1526 $buttontext = ($auser->status == 1) ? $strupdate : $strgrade;
0f7d4e5e 1527
e512715b
RW
1528 ///No more buttons, we use popups ;-).
1529 $popup_url = '/mod/assignment/submissions.php?id='.$this->cm->id
1530 . '&amp;userid='.$auser->id.'&amp;mode=single'.'&amp;filter='.$filter.'&amp;offset='.$offset++;
45fa3412 1531
e512715b 1532 $button = $OUTPUT->action_link($popup_url, $buttontext);
a9573c08 1533
e512715b 1534 $status = '<div id="up'.$auser->id.'" class="s'.$auser->status.'">'.$button.'</div>';
206ab184 1535
e512715b 1536 $finalgrade = '<span id="finalgrade_'.$auser->id.'">'.$final_grade->str_grade.'</span>';
cc03871b 1537
e512715b 1538 $outcomes = '';
5978010d 1539
e512715b 1540 if ($uses_outcomes) {
206ab184 1541
e512715b
RW
1542 foreach($grading_info->outcomes as $n=>$outcome) {
1543 $outcomes .= '<div class="outcome"><label>'.$outcome->name.'</label>';
1544 $options = make_grades_menu(-$outcome->scaleid);
206ab184 1545
e512715b
RW
1546 if ($outcome->grades[$auser->id]->locked or !$quickgrade) {
1547 $options[0] = get_string('nooutcome', 'grades');
1548 $outcomes .= ': <span id="outcome_'.$n.'_'.$auser->id.'">'.$options[$outcome->grades[$auser->id]->grade].'</span>';
1549 } else {
1550 $attributes = array();
1551 $attributes['tabindex'] = $tabindex++;
1552 $attributes['id'] = 'outcome_'.$n.'_'.$auser->id;
1553 $outcomes .= ' '.html_writer::select($options, 'outcome_'.$n.'['.$auser->id.']', $outcome->grades[$auser->id]->grade, array(0=>get_string('nooutcome', 'grades')), $attributes);
1554 }
1555 $outcomes .= '</div>';
fdb797ad 1556 }
cc03871b 1557 }
cc03871b 1558
e512715b 1559 $userlink = '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $auser->id . '&amp;course=' . $course->id . '">' . fullname($auser, has_capability('moodle/site:viewfullnames', $this->context)) . '</a>';
02dd3b9f 1560 $extradata = array();
1561 foreach ($extrafields as $field) {
1562 $extradata[] = $auser->{$field};
1563 }
1564 $row = array_merge(array($picture, $userlink), $extradata,
1565 array($grade, $comment, $studentmodified, $teachermodified,
1566 $status, $finalgrade));
e512715b
RW
1567 if ($uses_outcomes) {
1568 $row[] = $outcomes;
1569 }
d50645eb 1570 $table->add_data($row, $rowclass);
fdb797ad 1571 }
e512715b 1572 $currentposition++;
fdb797ad 1573 }
54c37fbd
RW
1574 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)
1575 echo html_writer::start_tag('div', array('class' => 'mod-assignment-download-link'));
1576 echo html_writer::link(new moodle_url('/mod/assignment/submissions.php', array('id' => $this->cm->id, 'download' => 'zip')), get_string('downloadall', 'assignment'));
1577 echo html_writer::end_tag('div');
1578 }
1579 $table->print_html(); /// Print the whole table
1580 } else {
1581 if ($filter == self::FILTER_SUBMITTED) {
1582 echo html_writer::tag('div', get_string('nosubmisson', 'assignment'), array('class'=>'nosubmisson'));
1583 } else if ($filter == self::FILTER_REQUIRE_GRADING) {
1584 echo html_writer::tag('div', get_string('norequiregrading', 'assignment'), array('class'=>'norequiregrading'));
1585 }
d59269cf 1586 }
b0f2597e 1587 }
45fa3412 1588
fdb797ad 1589 /// Print quickgrade form around the table
e512715b 1590 if ($quickgrade && $table->started_output && !empty($users)){
fdb797ad
RW
1591 $mailinfopref = false;
1592 if (get_user_preferences('assignment_mailinfo', 1)) {
1593 $mailinfopref = true;
1594 }
be34802d 1595 $emailnotification = html_writer::checkbox('mailinfo', 1, $mailinfopref, get_string('enablenotification','assignment'));
de75c481 1596
be34802d 1597 $emailnotification .= $OUTPUT->help_icon('enablenotification', 'assignment');
fdb797ad
RW
1598 echo html_writer::tag('div', $emailnotification, array('class'=>'emailnotification'));
1599
1600 $savefeedback = html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'fastg', 'value'=>get_string('saveallfeedback', 'assignment')));
1601 echo html_writer::tag('div', $savefeedback, array('class'=>'fastgbutton'));
de75c481
RW
1602
1603 echo html_writer::end_tag('form');
fdb797ad 1604 } else if ($quickgrade) {
de75c481 1605 echo html_writer::end_tag('form');
9bf660b3 1606 }
fdb797ad
RW
1607
1608 echo '</div>';
082215e6 1609 /// End of fast grading form
45fa3412 1610
de75c481
RW
1611 /// Mini form for setting user preference
1612
fdb797ad
RW
1613 $formaction = new moodle_url('/mod/assignment/submissions.php', array('id'=>$this->cm->id));
1614 $mform = new MoodleQuickForm('optionspref', 'post', $formaction, '', array('class'=>'optionspref'));
de75c481 1615
fdb797ad
RW
1616 $mform->addElement('hidden', 'updatepref');
1617 $mform->setDefault('updatepref', 1);
1618 $mform->addElement('header', 'qgprefs', get_string('optionalsettings', 'assignment'));
1619 $mform->addElement('select', 'filter', get_string('show'), $filters);
de75c481 1620
fdb797ad
RW
1621 $mform->setDefault('filter', $filter);
1622
1623 $mform->addElement('text', 'perpage', get_string('pagesize', 'assignment'), array('size'=>1));
de75c481 1624 $mform->setDefault('perpage', $perpage);
fdb797ad 1625
9e2eca0f
MG
1626 if ($this->quickgrade_mode_allowed()) {
1627 $mform->addElement('checkbox', 'quickgrade', get_string('quickgrade','assignment'));
1628 $mform->setDefault('quickgrade', $quickgrade);
1629 $mform->addHelpButton('quickgrade', 'quickgrade', 'assignment');
1630 }
de75c481 1631
fdb797ad
RW
1632 $mform->addElement('submit', 'savepreferences', get_string('savepreferences'));
1633
1634 $mform->display();
de75c481 1635
256d2850 1636 echo $OUTPUT->footer();
8e340cb0 1637 }
d699cd1e 1638
18e6298c 1639 /**
36937f02
MG
1640 * If the form was cancelled ('Cancel' or 'Next' was pressed), call cancel method
1641 * from advanced grading (if applicable) and returns true
1642 * If the form was submitted, validates it and returns false if validation did not pass.
18e6298c 1643 * If validation passes, preprocess advanced grading (if applicable) and returns true.
3c2b3cb3
MG
1644 *
1645 * Note to the developers: This is NOT the correct way to implement advanced grading
1646 * in grading form. The assignment grading was written long time ago and unfortunately
1647 * does not fully use the mforms. Usually function is_validated() is called to
1648 * validate the form and get_data() is called to get the data from the form.
1649 *
1650 * Here we have to push the calculated grade to $_POST['xgrade'] because further processing
1651 * of the form gets the data not from form->get_data(), but from $_POST (using statement
1652 * like $feedback = data_submitted() )
18e6298c 1653 */
3c2b3cb3 1654 protected function validate_and_preprocess_feedback() {
71380f2f
MG
1655 global $USER, $CFG;
1656 require_once($CFG->libdir.'/gradelib.php');
36937f02 1657 if (!($feedback = data_submitted()) || !isset($feedback->userid) || !isset($feedback->offset)) {
18e6298c
MG
1658 return true; // No incoming data, nothing to validate
1659 }
1660 $userid = required_param('userid', PARAM_INT);
1661 $offset = required_param('offset', PARAM_INT);
3c2b3cb3
MG
1662 $gradinginfo = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array($userid));
1663 $gradingdisabled = $gradinginfo->items[0]->grades[$userid]->locked || $gradinginfo->items[0]->grades[$userid]->overridden;
71380f2f
MG
1664 if ($gradingdisabled) {
1665 return true;
1666 }
18e6298c
MG
1667 $submissiondata = $this->display_submission($offset, $userid, false);
1668 $mform = $submissiondata->mform;
36937f02
MG
1669 $gradinginstance = $mform->use_advanced_grading();
1670 if (optional_param('cancel', false, PARAM_BOOL) || optional_param('next', false, PARAM_BOOL)) {
1671 // form was cancelled
1672 if ($gradinginstance) {
1673 $gradinginstance->cancel();
1674 }
1675 } else if ($mform->is_submitted()) {
1676 // form was submitted (= a submit button other than 'cancel' or 'next' has been clicked)
18e6298c
MG
1677 if (!$mform->is_validated()) {
1678 return false;
1679 }
1680 // preprocess advanced grading here
36937f02 1681 if ($gradinginstance) {
18e6298c 1682 $data = $mform->get_data();
fc05f222
MG
1683 // create submission if it did not exist yet because we need submission->id for storing the grading instance
1684 $submission = $this->get_submission($userid, true);
1685 $_POST['xgrade'] = $gradinginstance->submit_and_get_grade($data->advancedgrading, $submission->id);
18e6298c
MG
1686 }
1687 }
1688 return true;
1689 }
1690
7af1e882 1691 /**
1692 * Process teacher feedback submission
1693 *
1694 * This is called by submissions() when a grading even has taken place.
1695 * It gets its data from the submitted form.
256578f6 1696 *
1697 * @global object
1698 * @global object
1699 * @global object
1700 * @return object|bool The updated submission object or false
b0f2597e 1701 */
291ee134 1702 function process_feedback($formdata=null) {
f8c81c01 1703 global $CFG, $USER, $DB;
5978010d 1704 require_once($CFG->libdir.'/gradelib.php');
d699cd1e 1705
a19dffc0 1706 if (!$feedback = data_submitted() or !confirm_sesskey()) { // No incoming data?
b0f2597e 1707 return false;
d699cd1e 1708 }
b7b42874 1709
9bf660b3 1710 ///For save and next, we need to know the userid to save, and the userid to go
1711 ///We use a new hidden field in the form, and set it to -1. If it's set, we use this
1712 ///as the userid to store
1713 if ((int)$feedback->saveuserid !== -1){
1714 $feedback->userid = $feedback->saveuserid;
1715 }
1716
b0f2597e 1717 if (!empty($feedback->cancel)) { // User hit cancel button
1718 return false;
1719 }
d699cd1e 1720
5978010d 1721 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $feedback->userid);
1722
cc03871b 1723 // store outcomes if needed
1724 $this->process_outcomes($feedback->userid);
1725
7af1e882 1726 $submission = $this->get_submission($feedback->userid, true); // Get or make one
d699cd1e 1727
d2b6ee29 1728 if (!($grading_info->items[0]->grades[$feedback->userid]->locked ||
1729 $grading_info->items[0]->grades[$feedback->userid]->overridden) ) {
d699cd1e 1730
d2b6ee29 1731 $submission->grade = $feedback->xgrade;
1732 $submission->submissioncomment = $feedback->submissioncomment_editor['text'];
5978010d 1733 $submission->teacher = $USER->id;
2dc5d980 1734 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
1735 if (!$mailinfo) {
1736 $submission->mailed = 1; // treat as already mailed
1737 } else {
1738 $submission->mailed = 0; // Make sure mail goes out (again, even)
1739 }
5978010d 1740 $submission->timemarked = time();
d4156e80 1741
5978010d 1742 unset($submission->data1); // Don't need to update this.
1743 unset($submission->data2); // Don't need to update this.
d699cd1e 1744
5978010d 1745 if (empty($submission->timemodified)) { // eg for offline assignments
1746 // $submission->timemodified = time();
1747 }
d699cd1e 1748
0bcf8b6f 1749 $DB->update_record('assignment_submissions', $submission);
7bddd4b7 1750
5978010d 1751 // triger grade event
1752 $this->update_grade($submission);
1753
1754 add_to_log($this->course->id, 'assignment', 'update grades',
0f66aced 1755 'submissions.php?id='.$this->cm->id.'&user='.$feedback->userid, $feedback->userid, $this->cm->id);
291ee134
AB
1756 if (!is_null($formdata)) {
1757 if ($this->type == 'upload' || $this->type == 'uploadsingle') {
1758 $mformdata = $formdata->mform->get_data();
1759 $mformdata = file_postupdate_standard_filemanager($mformdata, 'files', $formdata->fileui_options, $this->context, 'mod_assignment', 'response', $submission->id);
1760 }
1761 }
5978010d 1762 }
45fa3412 1763
7af1e882 1764 return $submission;
d699cd1e 1765
d699cd1e 1766 }
d699cd1e 1767
cc03871b 1768 function process_outcomes($userid) {
1769 global $CFG, $USER;
fbaa56b2 1770
1771 if (empty($CFG->enableoutcomes)) {
1772 return;
1773 }
1774
cc03871b 1775 require_once($CFG->libdir.'/gradelib.php');
1776
a19dffc0 1777 if (!$formdata = data_submitted() or !confirm_sesskey()) {
cc03871b 1778 return;
1779 }
1780
1781 $data = array();
fcac8e51 1782 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid);
1783
1784 if (!empty($grading_info->outcomes)) {
d886a7ea 1785 foreach($grading_info->outcomes as $n=>$old) {
1786 $name = 'outcome_'.$n;
1787 if (isset($formdata->{$name}[$userid]) and $old->grades[$userid]->grade != $formdata->{$name}[$userid]) {
1788 $data[$n] = $formdata->{$name}[$userid];
cc03871b 1789 }
1790 }
1791 }
1792 if (count($data) > 0) {
1793 grade_update_outcomes('mod/assignment', $this->course->id, 'mod', 'assignment', $this->assignment->id, $userid, $data);
1794 }
1795
1796 }
1797
7af1e882 1798 /**
1799 * Load the submission object for a particular user
1800 *
256578f6 1801 * @global object
1802 * @global object
7af1e882 1803 * @param $userid int The id of the user whose submission we want or 0 in which case USER->id is used
1804 * @param $createnew boolean optional Defaults to false. If set to true a new submission object will be created in the database
03076be4 1805 * @param bool $teachermodified student submission set if false
7af1e882 1806 * @return object The submission
1807 */
03076be4 1808 function get_submission($userid=0, $createnew=false, $teachermodified=false) {
5053f00f 1809 global $USER, $DB;
f77cfb73 1810
1811 if (empty($userid)) {
1812 $userid = $USER->id;
1813 }
1814
5053f00f 1815 $submission = $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
d699cd1e 1816
b0f2597e 1817 if ($submission || !$createnew) {
1818 return $submission;
1819 }
03076be4 1820 $newsubmission = $this->prepare_new_submission($userid, $teachermodified);
7826abc7 1821 $DB->insert_record("assignment_submissions", $newsubmission);
d699cd1e 1822
5053f00f 1823 return $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
b0f2597e 1824 }
d699cd1e 1825
7af1e882 1826 /**
1827 * Instantiates a new submission object for a given user
1828 *
1829 * Sets the assignment, userid and times, everything else is set to default values.
256578f6 1830 *
1831 * @param int $userid The userid for which we want a submission object
03076be4 1832 * @param bool $teachermodified student submission set if false
7af1e882 1833 * @return object The submission
1834 */
03076be4 1835 function prepare_new_submission($userid, $teachermodified=false) {
39790bd8 1836 $submission = new stdClass();
39e11905 1837 $submission->assignment = $this->assignment->id;
1838 $submission->userid = $userid;
47c96a77 1839 $submission->timecreated = time();
16fc2088 1840 // teachers should not be modifying modified date, except offline assignments
03076be4 1841 if ($teachermodified) {
1842 $submission->timemodified = 0;
1843 } else {
1844 $submission->timemodified = $submission->timecreated;
1845 }
39e11905 1846 $submission->numfiles = 0;
1847 $submission->data1 = '';
1848 $submission->data2 = '';
1849 $submission->grade = -1;
ea6432fe 1850 $submission->submissioncomment = '';
39e11905 1851 $submission->format = 0;
1852 $submission->teacher = 0;
1853 $submission->timemarked = 0;
1854 $submission->mailed = 0;
1855 return $submission;
1856 }
1857
7af1e882 1858 /**
1859 * Return all assignment submissions by ENROLLED students (even empty)
1860 *
256578f6 1861 * @param string $sort optional field names for the ORDER BY in the sql query
1862 * @param string $dir optional specifying the sort direction, defaults to DESC
7af1e882 1863 * @return array The submission objects indexed by id
1864 */
b0f2597e 1865 function get_submissions($sort='', $dir='DESC') {
7af1e882 1866 return assignment_get_all_submissions($this->assignment, $sort, $dir);
b0f2597e 1867 }
1868
7af1e882 1869 /**
1870 * Counts all real assignment submissions by ENROLLED students (not empty ones)
1871 *
256578f6 1872 * @param int $groupid optional If nonzero then count is restricted to this group
7af1e882 1873 * @return int The number of submissions
1874 */
b0f2597e 1875 function count_real_submissions($groupid=0) {
dd97c328 1876 return assignment_count_real_submissions($this->cm, $groupid);
d59269cf 1877 }
d699cd1e 1878
7af1e882 1879 /**
1880 * Alerts teachers by email of new or changed assignments that need grading
1881 *
1882 * First checks whether the option to email teachers is set for this assignment.
1883 * Sends an email to ALL teachers in the course (or in the group if using separate groups).
1884 * Uses the methods email_teachers_text() and email_teachers_html() to construct the content.
256578f6 1885 *
1886 * @global object
1887 * @global object
7af1e882 1888 * @param $submission object The submission that has changed
256578f6 1889 * @return void
7af1e882 1890 */
73097f07 1891 function email_teachers($submission) {
5053f00f 1892 global $CFG, $DB;
73097f07 1893
d8199f1d 1894 if (empty($this->assignment->emailteachers)) { // No need to do anything
73097f07 1895 return;
1896 }
1897
5053f00f 1898 $user = $DB->get_record('user', array('id'=>$submission->userid));
73097f07 1899
413efd22 1900 if ($teachers = $this->get_graders($user)) {
73097f07 1901
1902 $strassignments = get_string('modulenameplural', 'assignment');
1903 $strassignment = get_string('modulename', 'assignment');
1904 $strsubmitted = get_string('submitted', 'assignment');
1905
1906 foreach ($teachers as $teacher) {
39790bd8 1907 $info = new stdClass();
413efd22 1908 $info->username = fullname($user, true);
d8199f1d 1909 $info->assignment = format_string($this->assignment->name,true);
1910 $info->url = $CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id;
92d0dd9f 1911 $info->timeupdated = userdate($submission->timemodified, '%c', $teacher->timezone);
d8199f1d 1912
1913 $postsubject = $strsubmitted.': '.$info->username.' -> '.$this->assignment->name;
1914 $posttext = $this->email_teachers_text($info);
1915 $posthtml = ($teacher->mailformat == 1) ? $this->email_teachers_html($info) : '';
73097f07 1916
39790bd8 1917 $eventdata = new stdClass();
3b120e46 1918 $eventdata->modulename = 'assignment';
1919 $eventdata->userfrom = $user;
1920 $eventdata->userto = $teacher;
1921 $eventdata->subject = $postsubject;
1922 $eventdata->fullmessage = $posttext;
1923 $eventdata->fullmessageformat = FORMAT_PLAIN;
1924 $eventdata->fullmessagehtml = $posthtml;
fa09b5a9 1925 $eventdata->smallmessage = $postsubject;
192bcd76 1926
39e171ac 1927 $eventdata->name = 'assignment_updates';
192bcd76 1928 $eventdata->component = 'mod_assignment';
39e171ac 1929 $eventdata->notification = 1;
6217809c
AB
1930 $eventdata->contexturl = $info->url;
1931 $eventdata->contexturlname = $info->assignment;
54c37fbd 1932
7c7d3afa 1933 message_send($eventdata);
73097f07 1934 }
1935 }
1936 }
1937
256578f6 1938 /**
1939 * @param string $filearea
1940 * @param array $args
1941 * @return bool
1942 */
172dd12c 1943 function send_file($filearea, $args) {
1944 debugging('plugin does not implement file sending', DEBUG_DEVELOPER);
1945 return false;
1946 }
1947
413efd22 1948 /**
1949 * Returns a list of teachers that should be grading given submission
256578f6 1950 *
1951 * @param object $user
1952 * @return array
413efd22 1953 */
1954 function get_graders($user) {
1955 //potential graders
7bddd4b7 1956 $potgraders = get_users_by_capability($this->context, 'mod/assignment:grade', '', '', '', '', '', '', false, false);
1957
413efd22 1958 $graders = array();
ba3dc7b4 1959 if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) { // Separate groups are being used
2c386f82 1960 if ($groups = groups_get_all_groups($this->course->id, $user->id)) { // Try to find all groups
413efd22 1961 foreach ($groups as $group) {
1962 foreach ($potgraders as $t) {
1963 if ($t->id == $user->id) {
1964 continue; // do not send self
1965 }
1966 if (groups_is_member($group->id, $t->id)) {
1967 $graders[$t->id] = $t;
1968 }
1969 }
1970 }
1971 } else {
1972 // user not in group, try to find graders without group
1973 foreach ($potgraders as $t) {
1974 if ($t->id == $user->id) {
1975 continue; // do not send self
1976 }
2c386f82 1977 if (!groups_get_all_groups($this->course->id, $t->id)) { //ugly hack
413efd22 1978 $graders[$t->id] = $t;
1979 }
1980 }
1981 }
1982 } else {
1983 foreach ($potgraders as $t) {
1984 if ($t->id == $user->id) {
1985 continue; // do not send self
1986 }
1987 $graders[$t->id] = $t;
1988 }
1989 }
1990 return $graders;
1991 }
1992
7af1e882 1993 /**
1994 * Creates the text content for emails to teachers
1995 *
1996 * @param $info object The info used by the 'emailteachermail' language string
1997 * @return string
1998 */
d8199f1d 1999 function email_teachers_text($info) {
8ebbb06a
SH
2000 $posttext = format_string($this->course->shortname, true, array('context' => $this->coursecontext)).' -> '.
2001 $this->strassignments.' -> '.
2002 format_string($this->assignment->name, true, array('context' => $this->context))."\n";
d8199f1d 2003 $posttext .= '---------------------------------------------------------------------'."\n";
2004 $posttext .= get_string("emailteachermail", "assignment", $info)."\n";
73963212 2005 $posttext .= "\n---------------------------------------------------------------------\n";
d8199f1d 2006 return $posttext;
2007 }
2008
7af1e882 2009 /**
2010 * Creates the html content for emails to teachers
2011 *
2012 * @param $info object The info used by the 'emailteachermailhtml' language string
2013 * @return string
2014 */
d8199f1d 2015 function email_teachers_html($info) {
3554b5c2 2016 global $CFG;
d8199f1d 2017 $posthtml = '<p><font face="sans-serif">'.
8ebbb06a 2018 '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$this->course->id.'">'.format_string($this->course->shortname, true, array('context' => $this->coursecontext)).'</a> ->'.
d8199f1d 2019 '<a href="'.$CFG->wwwroot.'/mod/assignment/index.php?id='.$this->course->id.'">'.$this->strassignments.'</a> ->'.
8ebbb06a 2020 '<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>';
d8199f1d 2021 $posthtml .= '<hr /><font face="sans-serif">';
2022 $posthtml .= '<p>'.get_string('emailteachermailhtml', 'assignment', $info).'</p>';
2023 $posthtml .= '</font><hr />';
815b5ca6 2024 return $posthtml;
d8199f1d 2025 }
2026
7af1e882 2027 /**
2028 * Produces a list of links to the files uploaded by a user
2029 *
2030 * @param $userid int optional id of the user. If 0 then $USER->id is used.
2031 * @param $return boolean optional defaults to false. If true the list is returned rather than printed
2032 * @return string optional
2033 */
d8199f1d 2034 function print_user_files($userid=0, $return=false) {
d436d197 2035 global $CFG, $USER, $OUTPUT;
45fa3412 2036
d8199f1d 2037 if (!$userid) {
2038 if (!isloggedin()) {
2039 return '';
2040 }
2041 $userid = $USER->id;
2042 }
45fa3412 2043
73097f07 2044 $output = '';
45fa3412 2045
31f56ef6 2046 $submission = $this->get_submission($userid);
6708a1f5
SH
2047 if (!$submission) {
2048 return $output;
2049 }
31f56ef6 2050
6708a1f5
SH
2051 $fs = get_file_storage();
2052 $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false);
2053 if (!empty($files)) {
24ba58ee 2054 require_once($CFG->dirroot . '/mod/assignment/locallib.php');
6708a1f5
SH
2055 if ($CFG->enableportfolios) {
2056 require_once($CFG->libdir.'/portfoliolib.php');
2057 $button = new portfolio_add_button();
2058 }
172dd12c 2059 foreach ($files as $file) {
2060 $filename = $file->get_filename();
172dd12c 2061 $mimetype = $file->get_mimetype();
437239d1 2062 $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$this->context->id.'/mod_assignment/submission/'.$submission->id.'/'.$filename);
b5d0cafc 2063 $output .= '<a href="'.$path.'" ><img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />'.s($filename).'</a>';
6708a1f5 2064 if ($CFG->enableportfolios && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
fd04c5bd 2065 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'submissionid' => $submission->id, 'fileid' => $file->get_id()), '/mod/assignment/locallib.php');
887160c7 2066 $button->set_format_by_file($file);
0d06b6fd 2067 $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
73097f07 2068 }
c676af9f 2069
19f7391c
SB
2070 if ($CFG->enableplagiarism) {
2071 require_once($CFG->libdir.'/plagiarismlib.php');
2072 $output .= plagiarism_get_links(array('userid'=>$userid, 'file'=>$file, 'cmid'=>$this->cm->id, 'course'=>$this->course, 'assignment'=>$this->assignment));
2073 $output .= '<br />';
2074 }
172dd12c 2075 }
6057bf5b 2076 if ($CFG->enableportfolios && count($files) > 1 && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
fd04c5bd 2077 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'submissionid' => $submission->id), '/mod/assignment/locallib.php');
b777c798 2078 $output .= '<br />' . $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
73097f07 2079 }
2080 }
2081
2082 $output = '<div class="files">'.$output.'</div>';
2083
2084 if ($return) {
2085 return $output;
2086 }
2087 echo $output;
2088 }
2089
7af1e882 2090 /**
2091 * Count the files uploaded by a given user
2092 *
b5e1ffe4 2093 * @param $itemid int The submission's id as the file's itemid.
7af1e882 2094 * @return int
2095 */
b5e1ffe4 2096 function count_user_files($itemid) {
172dd12c 2097 $fs = get_file_storage();
b5e1ffe4 2098 $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $itemid, "id", false);
172dd12c 2099 return count($files);
73097f07 2100 }
2101
7af1e882 2102 /**
2103 * Returns true if the student is allowed to submit
2104 *
2105 * Checks that the assignment has started and, if the option to prevent late
2106 * submissions is set, also checks that the assignment has not yet closed.
2107 * @return boolean
2108 */
f77cfb73 2109 function isopen() {
2110 $time = time();
1e4343a0 2111 if ($this->assignment->preventlate && $this->assignment->timedue) {
f77cfb73 2112 return ($this->assignment->timeavailable <= $time && $time <= $this->assignment->timedue);
2113 } else {
2114 return ($this->assignment->timeavailable <= $time);
2115 }
2116 }
2117
0b5a80a1 2118
2119 /**
dc6cb74e 2120 * Return true if is set description is hidden till available date
2121 *
0b5a80a1 2122 * This is needed by calendar so that hidden descriptions do not
dc6cb74e 2123 * come up in upcoming events.
2124 *
0b5a80a1 2125 * Check that description is hidden till available date
dc6cb74e 2126 * By default return false
2127 * Assignments types should implement this method if needed
2128 * @return boolen
0b5a80a1 2129 */
dc6cb74e 2130 function description_is_hidden() {
2131 return false;
2132 }
2133
7af1e882 2134 /**
2135 * Return an outline of the user's interaction with the assignment
2136 *
2137 * The default method prints the grade and timemodified
1a96363a 2138 * @param $grade object
7af1e882 2139 * @return object with properties ->info and ->time
2140 */
1a96363a 2141 function user_outline($grade) {
39e11905 2142
39790bd8 2143 $result = new stdClass();
1a96363a
NC
2144 $result->info = get_string('grade').': '.$grade->str_long_grade;
2145 $result->time = $grade->dategraded;
2146 return $result;
73097f07 2147 }
7af1e882 2148
2149 /**
2150 * Print complete information about the user's interaction with the assignment
2151 *
2152 * @param $user object
2153 */
1a96363a 2154 function user_complete($user, $grade=null) {
3a003ead 2155 global $OUTPUT;
1a96363a 2156
73097f07 2157 if ($submission = $this->get_submission($user->id)) {
172dd12c 2158
2159 $fs = get_file_storage();
26a9dc72 2160
87f702a0 2161 if ($files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
172dd12c 2162 $countfiles = count($files)." ".get_string("uploadedfiles", "assignment");
2163 foreach ($files as $file) {
2164 $countfiles .= "; ".$file->get_filename();
73097f07 2165 }
2166 }
45fa3412 2167
3a003ead 2168 echo $OUTPUT->box_start();
73097f07 2169 echo get_string("lastmodified").": ";
9bf660b3 2170 echo userdate($submission->timemodified);
2171 echo $this->display_lateness($submission->timemodified);
45fa3412 2172
70b2c772 2173 $this->print_user_files($user->id);
45fa3412 2174
73097f07 2175 echo '<br />';
45fa3412 2176
1a96363a 2177 $this->view_feedback($submission);
45fa3412 2178
3a003ead 2179 echo $OUTPUT->box_end();
45fa3412 2180
73097f07 2181 } else {
156d6f48
MG
2182 if ($grade) {
2183 echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
2184 if ($grade->str_feedback) {
2185 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
2186 }
2187 }
73097f07 2188 print_string("notsubmittedyet", "assignment");
2189 }
2190 }
2191
7af1e882 2192 /**
2193 * Return a string indicating how late a submission is
2194 *
45fa3412 2195 * @param $timesubmitted int
7af1e882 2196 * @return string
2197 */
70b2c772 2198 function display_lateness($timesubmitted) {
76a60031 2199 return assignment_display_lateness($timesubmitted, $this->assignment->timedue);
73097f07 2200 }
2201
55b4d096 2202 /**
2203 * Empty method stub for all delete actions.
2204 */
2205 function delete() {
2206 //nothing by default
2207 redirect('view.php?id='.$this->cm->id);
2208 }
2209
2210 /**
2211 * Empty custom feedback grading form.
2212 */
2213 function custom_feedbackform($submission, $return=false) {
2214 //nothing by default
2215 return '';
2216 }
73097f07 2217
09ba8e56 2218 /**
2219 * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
2220 * for the course (see resource).
2221 *
206ab184 2222 * Given a course_module object, this function returns any "extra" information that may be needed
09ba8e56 2223 * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php.
206ab184 2224 *
09ba8e56 2225 * @param $coursemodule object The coursemodule object (record).
3e4c2435 2226 * @return cached_cm_info Object used to customise appearance on course page
09ba8e56 2227 */
2228 function get_coursemodule_info($coursemodule) {
3e4c2435 2229 return null;
09ba8e56 2230 }
2231
d014b69b 2232 /**
2233 * Plugin cron method - do not use $this here, create new assignment instances if needed.
2234 * @return void
2235 */
2236 function cron() {
2237 //no plugin cron by default - override if needed
2238 }
2239
0b5a80a1 2240 /**
2241 * Reset all submissions
2242 */
2243 function reset_userdata($data) {
5053f00f 2244 global $CFG, $DB;
0b5a80a1 2245
74d7d735 2246 if (!$DB->count_records('assignment', array('course'=>$data->courseid, 'assignmenttype'=>$this->type))) {
0b5a80a1 2247 return array(); // no assignments of this type present
2248 }
2249
2250 $componentstr = get_string('modulenameplural', 'assignment');
2251 $status = array();
2252
2253 $typestr = get_string('type'.$this->type, 'assignment');
40fcf70c
DP
2254 // ugly hack to support pluggable assignment type titles...
2255 if($typestr === '[[type'.$this->type.']]'){
2256 $typestr = get_string('type'.$this->type, 'assignment_'.$this->type);
2257 }
0b5a80a1 2258
2259 if (!empty($data->reset_assignment_submissions)) {
2260 $assignmentssql = "SELECT a.id
5053f00f 2261 FROM {assignment} a
2262 WHERE a.course=? AND a.assignmenttype=?";
2263 $params = array($data->courseid, $this->type);
0b5a80a1 2264
75dfe830 2265 // now get rid of all submissions and responses
4e866d5e 2266 $fs = get_file_storage();
5053f00f 2267 if ($assignments = $DB->get_records_sql($assignmentssql, $params)) {
0b5a80a1 2268 foreach ($assignments as $assignmentid=>$unused) {
4e866d5e 2269 if (!$cm = get_coursemodule_from_instance('assignment', $assignmentid)) {
2270 continue;
2271 }
2272 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
64f93798
PS
2273 $fs->delete_area_files($context->id, 'mod_assignment', 'submission');
2274 $fs->delete_area_files($context->id, 'mod_assignment', 'response');
0b5a80a1 2275 }
2276 }
2277
75dfe830 2278 $DB->delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)", $params);
2279
0b5a80a1 2280 $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false);
dd97c328 2281
0b5a80a1 2282 if (empty($data->reset_gradebook_grades)) {
2283 // remove all grades from gradebook
2284 assignment_reset_gradebook($data->courseid, $this->type);
2285 }
2286 }
2287
2288 /// updating dates - shift may be negative too
2289 if ($data->timeshift) {
2290 shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift, $data->courseid);
2291 $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false);
2292 }
2293
2294 return $status;
2295 }
67a87e7d 2296
2297
2298 function portfolio_exportable() {
2299 return false;
2300 }
3b804d2d 2301
2302 /**
2303 * base implementation for backing up subtype specific information
2304 * for one single module
2305 *
2306 * @param filehandle $bf file handle for xml file to write to
2307 * @param mixed $preferences the complete backup preference object
2308 *
2309 * @return boolean
2310 *
2311 * @static
2312 */
2313 static function backup_one_mod($bf, $preferences, $assignment) {
2314 return true;
2315 }
2316
2317 /**
2318 * base implementation for backing up subtype specific information
2319 * for one single submission
2320 *
2321 * @param filehandle $bf file handle for xml file to write to
2322 * @param mixed $preferences the complete backup preference object
2323 * @param object $submission the assignment submission db record
2324 *
2325 * @return boolean
2326 *
2327 * @static
2328 */
2329 static function backup_one_submission($bf, $preferences, $assignment, $submission) {
2330 return true;
2331 }
2332
2333 /**
2334 * base implementation for restoring subtype specific information
2335 * for one single module
2336 *
2337 * @param array $info the array representing the xml
2338 * @param object $restore the restore preferences
2339 *
2340 * @return boolean
2341 *
2342 * @static
2343 */
2344 static function restore_one_mod($info, $restore, $assignment) {
2345 return true;
2346 }
2347
2348 /**
2349 * base implementation for restoring subtype specific information
2350 * for one single submission
2351 *
2352 * @param object $submission the newly created submission
2353 * @param array $info the array representing the xml
2354 * @param object $restore the restore preferences
2355 *
2356 * @return boolean
2357 *
2358 * @static
2359 */
2360 static function restore_one_submission($info, $restore, $assignment, $submission) {
2361 return true;
2362 }
2363
b0f2597e 2364} ////// End of the assignment_base class
d699cd1e 2365
04eba58f 2366
7efcb735 2367class mod_assignment_grading_form extends moodleform {
3c2b3cb3
MG
2368 /** @var stores the advaned grading instance (if used in grading) */
2369 private $advancegradinginstance;
d2b6ee29 2370
2371 function definition() {
2372 global $OUTPUT;
2373 $mform =& $this->_form;
2374
36937f02
MG
2375 if (isset($this->_customdata->advancedgradinginstance)) {
2376 $this->use_advanced_grading($this->_customdata->advancedgradinginstance);
18e6298c
MG
2377 }
2378
d2b6ee29 2379 $formattr = $mform->getAttributes();
2380 $formattr['id'] = 'submitform';
2381 $mform->setAttributes($formattr);
2382 // hidden params
2383 $mform->addElement('hidden', 'offset', ($this->_customdata->offset+1));
2384 $mform->setType('offset', PARAM_INT);
2385 $mform->addElement('hidden', 'userid', $this->_customdata->userid);
2386 $mform->setType('userid', PARAM_INT);
2387 $mform->addElement('hidden', 'nextid', $this->_customdata->nextid);
2388 $mform->setType('nextid', PARAM_INT);
2389 $mform->addElement('hidden', 'id', $this->_customdata->cm->id);
2390 $mform->setType('id', PARAM_INT);
2391 $mform->addElement('hidden', 'sesskey', sesskey());
2392 $mform->setType('sesskey', PARAM_ALPHANUM);
2393 $mform->addElement('hidden', 'mode', 'grade');
2d274675 2394 $mform->setType('mode', PARAM_TEXT);
d2b6ee29 2395 $mform->addElement('hidden', 'menuindex', "0");
2396 $mform->setType('menuindex', PARAM_INT);
2397 $mform->addElement('hidden', 'saveuserid', "-1");
2398 $mform->setType('saveuserid', PARAM_INT);
fdb797ad
RW
2399 $mform->addElement('hidden', 'filter', "0");
2400 $mform->setType('filter', PARAM_INT);
d2b6ee29 2401
2402 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->user),
2403 fullname($this->_customdata->user, true) . '<br/>' .
2404 userdate($this->_customdata->submission->timemodified) .
2405 $this->_customdata->lateness );
2406
291ee134 2407 $this->add_submission_content();
d2b6ee29 2408 $this->add_grades_section();
2409
2410 $this->add_feedback_section();
2411
261b585d 2412 if ($this->_customdata->submission->timemarked) {
291ee134 2413 $datestring = userdate($this->_customdata->submission->timemarked)."&nbsp; (".format_time(time() - $this->_customdata->submission->timemarked).")";
d2b6ee29 2414 $mform->addElement('header', 'Last Grade', get_string('lastgrade', 'assignment'));
2415 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->teacher) ,
2416 fullname($this->_customdata->teacher,true).
291ee134 2417 '<br/>'.$datestring);
d2b6ee29 2418 }
2419 // buttons
2420 $this->add_action_buttons();
2421
d2b6ee29 2422 }
2423
18e6298c 2424 /**
36937f02 2425 * Gets or sets the instance for advanced grading
18e6298c 2426 *
36937f02 2427 * @param gradingform_instance $gradinginstance
18e6298c 2428 */
36937f02
MG
2429 public function use_advanced_grading($gradinginstance = false) {
2430 if ($gradinginstance !== false) {
2431 $this->advancegradinginstance = $gradinginstance;
18e6298c 2432 }
36937f02 2433 return $this->advancegradinginstance;
18e6298c
MG
2434 }
2435
d2b6ee29 2436 function add_grades_section() {
2437 global $CFG;
2438 $mform =& $this->_form;
2439 $attributes = array();
261b585d 2440 if ($this->_customdata->gradingdisabled) {
2441 $attributes['disabled'] ='disabled';
2442 }
d2b6ee29 2443
d2b6ee29 2444 $mform->addElement('header', 'Grades', get_string('grades', 'grades'));
fba356f3 2445
d2b6ee29 2446 $grademenu = make_grades_menu($this->_customdata->assignment->grade);
36937f02 2447 if ($gradinginstance = $this->use_advanced_grading()) {
9e2eca0f 2448 $gradinginstance->get_controller()->set_grade_range($grademenu);
71380f2f
MG
2449 $gradingelement = $mform->addElement('grading', 'advancedgrading', get_string('grade').':', array('gradinginstance' => $gradinginstance));
2450 if ($this->_customdata->gradingdisabled) {
2451 $gradingelement->freeze();
2452 } else {
2453 $mform->addElement('hidden', 'advancedgradinginstanceid', $gradinginstance->get_id());
2454 }
fba356f3
DM
2455 } else {
2456 // use simple direct grading
fba356f3 2457 $grademenu['-1'] = get_string('nograde');
d2b6ee29 2458
fba356f3
DM
2459 $mform->addElement('select', 'xgrade', get_string('grade').':', $grademenu, $attributes);
2460 $mform->setDefault('xgrade', $this->_customdata->submission->grade ); //@fixme some bug when element called 'grade' makes it break
2461 $mform->setType('xgrade', PARAM_INT);
2462 }
d2b6ee29 2463
261b585d 2464 if (!empty($this->_customdata->enableoutcomes)) {
d2b6ee29 2465 foreach($this->_customdata->grading_info->outcomes as $n=>$outcome) {
2466 $options = make_grades_menu(-$outcome->scaleid);
2467 if ($outcome->grades[$this->_customdata->submission->userid]->locked) {
2468 $options[0] = get_string('nooutcome', 'grades');
8545f86c
MG
2469 $mform->addElement('static', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':',
2470 $options[$outcome->grades[$this->_customdata->submission->userid]->grade]);
d2b6ee29 2471 } else {
2472 $options[''] = get_string('nooutcome', 'grades');
2473 $attributes = array('id' => 'menuoutcome_'.$n );
2474 $mform->addElement('select', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':', $options, $attributes );
2475 $mform->setType('outcome_'.$n.'['.$this->_customdata->userid.']', PARAM_INT);
2476 $mform->setDefault('outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->grades[$this->_customdata->submission->userid]->grade );
2477 }
2478 }
2479 }
753c1de5 2480 $course_context = get_context_instance(CONTEXT_MODULE , $this->_customdata->cm->id);
2481 if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
2482 $grade = '<a href="'.$CFG->wwwroot.'/grade/report/grader/index.php?id='. $this->_customdata->courseid .'" >'.
2483 $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade . '</a>';
2484 }else{
2485 $grade = $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade;
2486 }
2487 $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assignment').':' ,$grade);
d2b6ee29 2488 $mform->setType('finalgrade', PARAM_INT);
2489 }
2490
2491 /**
2492 *
2493 * @global core_renderer $OUTPUT
2494 */
2495 function add_feedback_section() {
2496 global $OUTPUT;
2497 $mform =& $this->_form;
2498 $mform->addElement('header', 'Feed Back', get_string('feedback', 'grades'));
2499
261b585d 2500 if ($this->_customdata->gradingdisabled) {
d2b6ee29 2501 $mform->addElement('static', 'disabledfeedback', $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_feedback );
2502 } else {
2503 // visible elements
2504
2505 $mform->addElement('editor', 'submissioncomment_editor', get_string('feedback', 'assignment').':', null, $this->get_editor_options() );
2506 $mform->setType('submissioncomment_editor', PARAM_RAW); // to be cleaned before display
2507 $mform->setDefault('submissioncomment_editor', $this->_customdata->submission->submissioncomment);
2508 //$mform->addRule('submissioncomment', get_string('required'), 'required', null, 'client');
291ee134
AB
2509 switch ($this->_customdata->assignment->assignmenttype) {
2510 case 'upload' :
2511 case 'uploadsingle' :
2512 $mform->addElement('filemanager', 'files_filemanager', get_string('responsefiles', 'assignment'). ':', null, $this->_customdata->fileui_options);
2513 break;
2514 default :
2515 break;
2516 }
d2b6ee29 2517 $mform->addElement('hidden', 'mailinfo_h', "0");
2518 $mform->setType('mailinfo_h', PARAM_INT);
be34802d
AD
2519 $mform->addElement('checkbox', 'mailinfo',get_string('enablenotification','assignment').
2520 $OUTPUT->help_icon('enablenotification', 'assignment') .':' );
d2b6ee29 2521 $mform->setType('mailinfo', PARAM_INT);
2522 }
2523 }
2524
2525 function add_action_buttons() {
2526 $mform =& $this->_form;
d2b6ee29 2527 //if there are more to be graded.
261b585d 2528 if ($this->_customdata->nextid>0) {
d2b6ee29 2529 $buttonarray=array();
2530 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2531 //@todo: fix accessibility: javascript dependency not necessary
2532 $buttonarray[] = &$mform->createElement('submit', 'saveandnext', get_string('saveandnext'));
2533 $buttonarray[] = &$mform->createElement('submit', 'next', get_string('next'));
2534 $buttonarray[] = &$mform->createElement('cancel');
2535 } else {
2536 $buttonarray=array();
2537 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2538 $buttonarray[] = &$mform->createElement('cancel');
2539 }
2540 $mform->addGroup($buttonarray, 'grading_buttonar', '', array(' '), false);
291ee134 2541 $mform->closeHeaderBefore('grading_buttonar');
d2b6ee29 2542 $mform->setType('grading_buttonar', PARAM_RAW);
2543 }
2544
2545 function add_submission_content() {
2546 $mform =& $this->_form;
2547 $mform->addElement('header', 'Submission', get_string('submission', 'assignment'));
2548 $mform->addElement('static', '', '' , $this->_customdata->submission_content );
2549 }
96f4a64b 2550
d2b6ee29 2551 protected function get_editor_options() {
2552 $editoroptions = array();
64f93798
PS
2553 $editoroptions['component'] = 'mod_assignment';
2554 $editoroptions['filearea'] = 'feedback';
d2b6ee29 2555 $editoroptions['noclean'] = false;
64f93798 2556 $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)
d2b6ee29 2557 $editoroptions['maxbytes'] = $this->_customdata->maxbytes;
e9de1cf4 2558 $editoroptions['context'] = $this->_customdata->context;
d2b6ee29 2559 return $editoroptions;
2560 }
2561
2562 public function set_data($data) {
2563 $editoroptions = $this->get_editor_options();
2564 if (!isset($data->text)) {
2565 $data->text = '';
2566 }
2567 if (!isset($data->format)) {
2568 $data->textformat = FORMAT_HTML;
2569 } else {
2570 $data->textformat = $data->format;
2571 }
2572
2573 if (!empty($this->_customdata->submission->id)) {
2574 $itemid = $this->_customdata->submission->id;
2575 } else {
2576 $itemid = null;
2577 }
2578
291ee134
AB
2579 switch ($this->_customdata->assignment->assignmenttype) {
2580 case 'upload' :
2581 case 'uploadsingle' :
2582 $data = file_prepare_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2583 break;
2584 default :
2585 break;
2586 }
2587
64f93798 2588 $data = file_prepare_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
d2b6ee29 2589 return parent::set_data($data);
2590 }
2591
2592 public function get_data() {
2593 $data = parent::get_data();
2594
2595 if (!empty($this->_customdata->submission->id)) {
2596 $itemid = $this->_customdata->submission->id;
2597 } else {
64f93798 2598 $itemid = null; //TODO: this is wrong, itemid MUST be known when saving files!! (skodak)
d2b6ee29 2599 }
2600
2601 if ($data) {
2602 $editoroptions = $this->get_editor_options();
291ee134
AB
2603 switch ($this->_customdata->assignment->assignmenttype) {
2604 case 'upload' :
2605 case 'uploadsingle' :
2606 $data = file_postupdate_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2607 break;
2608 default :
2609 break;
2610 }
64f93798 2611 $data = file_postupdate_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
d2b6ee29 2612 }
18e6298c
MG
2613
2614 if ($this->use_advanced_grading() && !isset($data->advancedgrading)) {
2615 $data->advancedgrading = null;
2616 }
2617
d2b6ee29 2618 return $data;
2619 }
2620}
2621
b0f2597e 2622/// OTHER STANDARD FUNCTIONS ////////////////////////////////////////////////////////
2623
7af1e882 2624/**
2625 * Deletes an assignment instance
2626 *
2627 * This is done by calling the delete_instance() method of the assignment type class
2628 */
b0f2597e 2629function assignment_delete_instance($id){
c18269c7 2630 global $CFG, $DB;
26b90e70 2631
c18269c7 2632 if (! $assignment = $DB->get_record('assignment', array('id'=>$id))) {
b0f2597e 2633 return false;
26b90e70 2634 }
2635
1fc87774 2636 // fall back to base class if plugin missing
2637 $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
2638 if (file_exists($classfile)) {
2639 require_once($classfile);
2640 $assignmentclass = "assignment_$assignment->assignmenttype";
2641
2642 } else {
2643 debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead.");
2644 $assignmentclass = "assignment_base";
2645 }
2646
b0f2597e 2647 $ass = new $assignmentclass();
2648 return $ass->delete_instance($assignment);
2649}
f466c9ed 2650
ac21ad39 2651
7af1e882 2652/**
2653 * Updates an assignment instance
2654 *
2655 * This is done by calling the update_instance() method of the assignment type class
2656 */
b0f2597e 2657function assignment_update_instance($assignment){
2658 global $CFG;
26b90e70 2659
aff24313 2660 $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_PLUGIN);
200c19fb 2661
b0f2597e 2662 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2663 $assignmentclass = "assignment_$assignment->assignmenttype";
2664 $ass = new $assignmentclass();
2665 return $ass->update_instance($assignment);
45fa3412 2666}
26b90e70 2667
26b90e70 2668
7af1e882 2669/**
2670 * Adds an assignment instance
2671 *
2672 * This is done by calling the add_instance() method of the assignment type class
2673 */
b0f2597e 2674function assignment_add_instance($assignment) {
2675 global $CFG;
f466c9ed 2676
aff24313 2677 $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_PLUGIN);
200c19fb 2678
b0f2597e 2679 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2680 $assignmentclass = "assignment_$assignment->assignmenttype";
2681 $ass = new $assignmentclass();
2682 return $ass->add_instance($assignment);
2683}
f466c9ed 2684
73097f07 2685
7af1e882 2686/**
2687 * Returns an outline of a user interaction with an assignment
2688 *
2689 * This is done by calling the user_outline() method of the assignment type class
2690 */
73097f07 2691function assignment_user_outline($course, $user, $mod, $assignment) {
2692 global $CFG;
2693
1a96363a 2694 require_once("$CFG->libdir/gradelib.php");
73097f07 2695 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2696 $assignmentclass = "assignment_$assignment->assignmenttype";
2697 $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
1a96363a
NC
2698 $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2699 if (!empty($grades->items[0]->grades)) {
2700 return $ass->user_outline(reset($grades->items[0]->grades));
2701 } else {
2702 return null;
2703 }
73097f07 2704}
2705
7af1e882 2706/**
2707 * Prints the complete info about a user's interaction with an assignment
2708 *
2709 * This is done by calling the user_complete() method of the assignment type class
2710 */
73097f07 2711function assignment_user_complete($course, $user, $mod, $assignment) {
2712 global $CFG;
2713
1a96363a 2714 require_once("$CFG->libdir/gradelib.php");
73097f07 2715 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2716 $assignmentclass = "assignment_$assignment->assignmenttype";
2717 $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
1a96363a
NC
2718 $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2719 if (empty($grades->items[0]->grades)) {
2720 $grade = false;
2721 } else {
2722 $grade = reset($grades->items[0]->grades);
2723 }
2724 return $ass->user_complete($user, $grade);
73097f07 2725}
2726
7af1e882 2727/**
2728 * Function to be run periodically according to the moodle cron
2729 *
2730 * Finds all assignment notifications that have yet to be mailed out, and mails them
2731 */
73097f07 2732function assignment_cron () {
5053f00f 2733 global $CFG, $USER, $DB;
73097f07 2734
d014b69b 2735 /// first execute all crons in plugins
17da2e6f 2736 if ($plugins = get_plugin_list('assignment')) {
2737 foreach ($plugins as $plugin=>$dir) {
2738 require_once("$dir/assignment.class.php");
d014b69b 2739 $assignmentclass = "assignment_$plugin";
2740 $ass = new $assignmentclass();
2741 $ass->cron();
2742 }
2743 }
2744
73097f07 2745 /// Notices older than 1 day will not be mailed. This is to avoid the problem where
2746 /// cron has not been running for a long time, and then suddenly people are flooded
2747 /// with mail from the past few weeks or months
2748
2749 $timenow = time();
2750 $endtime = $timenow - $CFG->maxeditingtime;
2751 $starttime = $endtime - 24 * 3600; /// One day earlier
2752
2753 if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) {
2754
98be6ed8 2755 $realuser = clone($USER);
2756
73097f07 2757 foreach ($submissions as $key => $submission) {
f685e830 2758 $DB->set_field("assignment_submissions", "mailed", "1", array("id"=>$submission->id));
73097f07 2759 }
2760
2761 $timenow = time();
2762
2763 foreach ($submissions as $submission) {
2764
2765 echo "Processing assignment submission $submission->id\n";
2766
5053f00f 2767 if (! $user = $DB->get_record("user", array("id"=>$submission->userid))) {
6b1564a8 2768 echo "Could not find user $user->id\n";
73097f07 2769 continue;
2770 }
2771
5053f00f 2772 if (! $course = $DB->get_record("course", array("id"=>$submission->course))) {
73097f07 2773 echo "Could not find course $submission->course\n";
2774 continue;
2775 }
98be6ed8 2776
2777 /// Override the language and timezone of the "current" user, so that
2778 /// mail is customised for the receiver.
e8b7114d 2779 cron_setup_user($user, $course);
98be6ed8 2780
8ebbb06a
SH
2781 $coursecontext = get_context_instance(CONTEXT_COURSE, $submission->course);
2782 $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
2783 if (!is_enrolled($coursecontext, $user->id)) {
2784 echo fullname($user)." not an active participant in " . $courseshortname . "\n";
73097f07 2785 continue;
2786 }
2787
5053f00f 2788 if (! $teacher = $DB->get_record("user", array("id"=>$submission->teacher))) {
73097f07 2789 echo "Could not find teacher $submission->teacher\n";
2790 continue;
2791 }
2792
2793 if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment, $course->id)) {
2794 echo "Could not find course module for assignment id $submission->assignment\n";
2795 continue;
2796 }
2797
2798 if (! $mod->visible) { /// Hold mail notification for hidden assignments until later
2799 continue;
2800 }
2801
2802 $strassignments = get_string("modulenameplural", "assignment");
2803 $strassignment = get_string("modulename", "assignment");
2804
39790bd8 2805 $assignmentinfo = new stdClass();
73097f07 2806 $assignmentinfo->teacher = fullname($teacher);
2807 $assignmentinfo->assignment = format_string($submission->name,true);
2808 $assignmentinfo->url = "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id";
2809
8ebbb06a
SH
2810 $postsubject = "$courseshortname: $strassignments: ".format_string($submission->name,true);
2811 $posttext = "$courseshortname -> $strassignments -> ".format_string($submission->name,true)."\n";
73097f07 2812 $posttext .= "---------------------------------------------------------------------\n";
3f19bff3 2813 $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n";
73097f07 2814 $posttext .= "---------------------------------------------------------------------\n";
2815
2816 if ($user->mailformat == 1) { // HTML
2817 $posthtml = "<p><font face=\"sans-serif\">".
8ebbb06a 2818 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$courseshortname</a> ->".
73097f07 2819 "<a href=\"$CFG->wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments</a> ->".
2820 "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name,true)."</a></font></p>";
2821 $posthtml .= "<hr /><font face=\"sans-serif\">";
2822 $posthtml .= "<p>".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."</p>";
2823 $posthtml .= "</font><hr />";
2824 } else {
2825 $posthtml = "";
2826 }
2827
39790bd8 2828 $eventdata = new stdClass();
3b120e46 2829 $eventdata->modulename = 'assignment';
2830 $eventdata->userfrom = $teacher;
2831 $eventdata->userto = $user;
2832 $eventdata->subject = $postsubject;
2833 $eventdata->fullmessage = $posttext;
2834 $eventdata->fullmessageformat = FORMAT_PLAIN;
2835 $eventdata->fullmessagehtml = $posthtml;
5daa7279 2836 $eventdata->smallmessage = get_string('assignmentmailsmall', 'assignment', $assignmentinfo);
d042ff06
AB
2837
2838 $eventdata->name = 'assignment_updates';
2839 $eventdata->component = 'mod_assignment';
2840 $eventdata->notification = 1;
0f1751b0
AD
2841 $eventdata->contexturl = $assignmentinfo->url;
2842 $eventdata->contexturlname = $assignmentinfo->assignment;
d042ff06 2843
7c7d3afa 2844 message_send($eventdata);
73097f07 2845 }
98be6ed8 2846
e8b7114d 2847 cron_setup_user();
73097f07 2848 }
2849
2850 return true;
2851}
2852
45fa3412 2853/**
2854 * Return grade for given user or all users.
2855 *
2856 * @param int $assignmentid id of assignment
2857 * @param int $userid optional user id, 0 means all users
2858 * @return array array of grades, false if none
2859 */
612607bd 2860function assignment_get_user_grades($assignment, $userid=0) {
5053f00f 2861 global $CFG, $DB;
45fa3412 2862
5053f00f 2863 if ($userid) {
2864 $user = "AND u.id = :userid";
2865 $params = array('userid'=>$userid);
2866 } else {
2867 $user = "";
2868 }
2869 $params['aid'] = $assignment->id;
45fa3412 2870
ced5ee59 2871 $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat,
2872 s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted
5053f00f 2873 FROM {user} u, {assignment_submissions} s
2874 WHERE u.id = s.userid AND s.assignment = :aid
4a1be95c 2875 $user";
45fa3412 2876
5053f00f 2877 return $DB->get_records_sql($sql, $params);
45fa3412 2878}
2879
2880/**
775f811a 2881 * Update activity grades
45fa3412 2882 *
775f811a 2883 * @param object $assignment
2884 * @param int $userid specific user only, 0 means all
45fa3412 2885 */
775f811a 2886function assignment_update_grades($assignment, $userid=0, $nullifnone=true) {
5053f00f 2887 global $CFG, $DB;
2888 require_once($CFG->libdir.'/gradelib.php');
45fa3412 2889
775f811a 2890 if ($assignment->grade == 0) {
2891 assignment_grade_item_update($assignment);
2892
2893 } else if ($grades = assignment_get_user_grades($assignment, $userid)) {
2894 foreach($grades as $k=>$v) {
2895 if ($v->rawgrade == -1) {
2896 $grades[$k]->rawgrade = null;
45fa3412 2897 }
2898 }
775f811a 2899 assignment_grade_item_update($assignment, $grades);
45fa3412 2900
2901 } else {
775f811a 2902 assignment_grade_item_update($assignment);
2903 }
2904}
2905
2906/**
2907 * Update all grades in gradebook.
2908 */
2909function assignment_upgrade_grades() {
2910 global $DB;
2911
2912 $sql = "SELECT COUNT('x')
2913 FROM {assignment} a, {course_modules} cm, {modules} m
2914 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2915 $count = $DB->count_records_sql($sql);
2916
2917 $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
2918 FROM {assignment} a, {course_modules} cm, {modules} m
2919 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
6b1b1d03
EL
2920 $rs = $DB->get_recordset_sql($sql);
2921 if ($rs->valid()) {
775f811a 2922 // too much debug output
775f811a 2923 $pbar = new progress_bar('assignmentupgradegrades', 500, true);
2924 $i=0;
2925 foreach ($rs as $assignment) {
2926 $i++;
2927 upgrade_set_timeout(60*5); // set up timeout, may also abort execution
2928 assignment_update_grades($assignment);
2929 $pbar->update($i, $count, "Updating Assignment grades ($i/$count).");
2930 }
775f811a 2931 upgrade_set_timeout(); // reset to default timeout
45fa3412 2932 }
6b1b1d03 2933 $rs->close();
45fa3412 2934}
2935
2936/**
612607bd 2937 * Create grade item for given assignment
45fa3412 2938 *
8b4fb44e 2939 * @param object $assignment object with extra cmidnumber
0b5a80a1 2940 * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
612607bd 2941 * @return int 0 if ok, error code otherwise
45fa3412 2942 */
ced5ee59 2943function assignment_grade_item_update($assignment, $grades=NULL) {
612607bd 2944 global $CFG;
5053f00f 2945 require_once($CFG->libdir.'/gradelib.php');
45fa3412 2946
8b4fb44e 2947 if (!isset($assignment->courseid)) {
2948 $assignment->courseid = $assignment->course;
2949 }
2950
612607bd 2951 $params = array('itemname'=>$assignment->name, 'idnumber'=>$assignment->cmidnumber);
45fa3412 2952
2953 if ($assignment->grade > 0) {
2954 $params['gradetype'] = GRADE_TYPE_VALUE;
2955 $params['grademax'] = $assignment->grade;
2956 $params['grademin'] = 0;
2957
2958 } else if ($assignment->grade < 0) {
2959 $params['gradetype'] = GRADE_TYPE_SCALE;
2960 $params['scaleid'] = -$assignment->grade;
2961
2962 } else {
5048575d 2963 $params['gradetype'] = GRADE_TYPE_TEXT; // allow text comments only
45fa3412 2964 }
2965
0b5a80a1 2966 if ($grades === 'reset') {
2967 $params['reset'] = true;
2968 $grades = NULL;
2969 }
2970
ced5ee59 2971 return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, $grades, $params);
45fa3412 2972}
2973
2974/**
2975 * Delete grade item for given assignment
2976 *
8b4fb44e 2977 * @param object $assignment object
612607bd 2978 * @return object assignment
45fa3412 2979 */
2980function assignment_grade_item_delete($assignment) {
612607bd 2981 global $CFG;
2982 require_once($CFG->libdir.'/gradelib.php');
2983
8b4fb44e 2984 if (!isset($assignment->courseid)) {
2985 $assignment->courseid = $assignment->course;
2986 }
2987
b67ec72f 2988 return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, NULL, array('deleted'=>1));
45fa3412 2989}
2990
7af1e882 2991/**
2992 * Returns the users with data in one assignment (students and teachers)
2993 *
2b04c41c
SH
2994 * @todo: deprecated - to be deleted in 2.2
2995 *
7af1e882 2996 * @param $assignmentid int
2997 * @return array of user objects
2998 */
73097f07 2999function assignment_get_participants($assignmentid) {
5053f00f 3000 global $CFG, $DB;
73097f07