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