assignment MDL-24710 added component and name properties to Event object required...
[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',
725 'submissions.php?id='.$this->assignment->id.'&user='.$submission->userid,
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,
974 s.timemodified, s.timemarked,
3a11c09f 975 COALESCE(SIGN(SIGN(s.timemarked) + SIGN(s.timemarked - s.timemodified)), 0) AS status ";
5053f00f 976 $sql = 'FROM {user} u '.
977 'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
fdb797ad
RW
978 AND s.assignment = '.$this->assignment->id.' '.
979 'WHERE '.$where.'u.id IN ('.implode(',', $users).') ';
dd97c328 980
9baf2670 981 if ($sort = flexible_table::get_sort_for_table('mod-assignment-submissions')) {
dd97c328 982 $sort = 'ORDER BY '.$sort.' ';
983 }
d2b6ee29 984 $auser = $DB->get_records_sql($select.$sql.$sort, null, $offset, 2);
dd97c328 985
d2b6ee29 986 if (is_array($auser) && count($auser)>1) {
987 $nextuser = next($auser);
dd97c328 988 /// Calculate user status
989 $nextuser->status = ($nextuser->timemarked > 0) && ($nextuser->timemarked >= $nextuser->timemodified);
990 $nextid = $nextuser->id;
991 }
9bf660b3 992 }
d699cd1e 993
b0f2597e 994 if ($submission->teacher) {
5053f00f 995 $teacher = $DB->get_record('user', array('id'=>$submission->teacher));
b0f2597e 996 } else {
997 global $USER;
998 $teacher = $USER;
999 }
de75c481 1000
01e2fdfe 1001 $this->preprocess_submission($submission);
1002
6bdfef5d 1003 $mformdata = new stdClass();
d2b6ee29 1004 $mformdata->context = $this->context;
1005 $mformdata->maxbytes = $this->course->maxbytes;
1006 $mformdata->courseid = $this->course->id;
1007 $mformdata->teacher = $teacher;
1008 $mformdata->assignment = $assignment;
1009 $mformdata->submission = $submission;
1010 $mformdata->lateness = $this->display_lateness($submission->timemodified);
1011 $mformdata->auser = $auser;
1012 $mformdata->user = $user;
1013 $mformdata->offset = $offset;
1014 $mformdata->userid = $userid;
1015 $mformdata->cm = $this->cm;
1016 $mformdata->grading_info = $grading_info;
1017 $mformdata->enableoutcomes = $CFG->enableoutcomes;
1018 $mformdata->grade = $this->assignment->grade;
1019 $mformdata->gradingdisabled = $gradingdisabled;
d2b6ee29 1020 $mformdata->nextid = $nextid;
1021 $mformdata->submissioncomment= $submission->submissioncomment;
1022 $mformdata->submissioncommentformat= FORMAT_HTML;
2a576f94 1023 $mformdata->submission_content= $this->print_user_files($user->id,true);
fdb797ad 1024 $mformdata->filter = $filter;
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;
45fa3412 1131
dad55fc5 1132 $tabindex = 1; //tabindex for quick grading tabbing; Not working for dropdowns yet
1133 add_to_log($course->id, 'assignment', 'view submission', 'submissions.php?id='.$this->cm->id, $this->assignment->id, $this->cm->id);
96f4a64b 1134
dad55fc5 1135 $PAGE->set_title(format_string($this->assignment->name,true));
d2b6ee29 1136 $PAGE->set_heading($this->course->fullname);
dad55fc5 1137 echo $OUTPUT->header();
1138
fdb797ad 1139 echo '<div class="usersubmissions">';
de75c481 1140
44729427
DM
1141 //hook to allow plagiarism plugins to update status/print links.
1142 plagiarism_update_status($this->course, $this->cm);
1143
8cb41486 1144 /// Print quickgrade form around the table
261b585d 1145 if ($quickgrade) {
fdb797ad
RW
1146 $formattrs = array();
1147 $formattrs['action'] = new moodle_url('/mod/assignment/submissions.php');
1148 $formattrs['id'] = 'fastg';
1149 $formattrs['method'] = 'post';
1150
1151 echo html_writer::start_tag('form', $formattrs);
1152 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'id', 'value'=> $this->cm->id));
1153 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'mode', 'value'=> 'fastgrade'));
1154 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'page', 'value'=> $page));
1155 echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=> sesskey()));
8cb41486 1156 }
1157
fb739b77 1158 $course_context = get_context_instance(CONTEXT_COURSE, $course->id);
1159 if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
12dce253 1160 echo '<div class="allcoursegrades"><a href="' . $CFG->wwwroot . '/grade/report/grader/index.php?id=' . $course->id . '">'
b64792f6 1161 . get_string('seeallcoursegrades', 'grades') . '</a></div>';
fb739b77 1162 }
7bddd4b7 1163
fb81abe1 1164 if (!empty($message)) {
1165 echo $message; // display messages here if any
1166 }
1167
2d7617c6 1168 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
7bddd4b7 1169
dd97c328 1170 /// Check to see if groups are being used in this assignment
1171
7bddd4b7 1172 /// find out current groups mode
ba3dc7b4 1173 $groupmode = groups_get_activity_groupmode($cm);
1174 $currentgroup = groups_get_activity_group($cm, true);
f1035deb 1175 groups_print_activity_menu($cm, $CFG->wwwroot . '/mod/assignment/submissions.php?id=' . $this->cm->id);
7bddd4b7 1176
1177 /// Get all ppl that are allowed to submit assignments
c7bb34b6 1178 list($esql, $params) = get_enrolled_sql($context, 'mod/assignment:view', $currentgroup);
de75c481 1179
fdb797ad
RW
1180 if ($filter == self::FILTER_ALL) {
1181 $sql = "SELECT u.id FROM {user} u ".
1182 "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1183 "WHERE u.deleted = 0 AND eu.id=u.id ";
1184 } else {
1185 $wherefilter = '';
1186 if($filter == self::FILTER_SUBMITTED) {
1187 $wherefilter = ' AND s.timemodified > 0';
1188 } else if($filter == self::FILTER_REQUIRE_GRADING) {
1189 $wherefilter = ' AND s.timemarked < s.timemodified ';
1190 }
1191
1192 $sql = "SELECT u.id FROM {user} u ".
1193 "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1194 "LEFT JOIN {assignment_submissions} s ON (u.id = s.userid) " .
1195 "WHERE u.deleted = 0 AND eu.id=u.id ".
1196 'AND s.assignment = '. $this->assignment->id .
1197 $wherefilter;
1198 }
1199
1200 $users = $DB->get_records_sql($sql, $params);
1201 if (!empty($users)) {
33150205 1202 $users = array_keys($users);
1203 }
ba3dc7b4 1204
dd97c328 1205 // if groupmembersonly used, remove users who are not in any group
98da6021 1206 if ($users and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
dd97c328 1207 if ($groupingusers = groups_get_grouping_members($cm->groupingid, 'u.id', 'u.id')) {
1208 $users = array_intersect($users, array_keys($groupingusers));
1209 }
ba3dc7b4 1210 }
91719320 1211
5978010d 1212 $tablecolumns = array('picture', 'fullname', 'grade', 'submissioncomment', 'timemodified', 'timemarked', 'status', 'finalgrade');
e46f4d11 1213 if ($uses_outcomes) {
5978010d 1214 $tablecolumns[] = 'outcome'; // no sorting based on outcomes column
fbaa56b2 1215 }
1216
206ab184 1217 $tableheaders = array('',
12dce253 1218 get_string('fullname'),
206ab184 1219 get_string('grade'),
1220 get_string('comment', 'assignment'),
9101efd3 1221 get_string('lastmodified').' ('.get_string('submission', 'assignment').')',
1222 get_string('lastmodified').' ('.get_string('grade').')',
5978010d 1223 get_string('status'),
1224 get_string('finalgrade', 'grades'));
e46f4d11 1225 if ($uses_outcomes) {
5978010d 1226 $tableheaders[] = get_string('outcome', 'grades');
fbaa56b2 1227 }
91719320 1228
b0f2597e 1229 require_once($CFG->libdir.'/tablelib.php');
1230 $table = new flexible_table('mod-assignment-submissions');
45fa3412 1231
b0f2597e 1232 $table->define_columns($tablecolumns);
1233 $table->define_headers($tableheaders);
fa22fd5f 1234 $table->define_baseurl($CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id.'&amp;currentgroup='.$currentgroup);
45fa3412 1235
246444b9 1236 $table->sortable(true, 'lastname');//sorted by lastname by default
b0f2597e 1237 $table->collapsible(true);
1238 $table->initialbars(true);
45fa3412 1239
b0f2597e 1240 $table->column_suppress('picture');
1241 $table->column_suppress('fullname');
45fa3412 1242
b0f2597e 1243 $table->column_class('picture', 'picture');
9437c854 1244 $table->column_class('fullname', 'fullname');
1245 $table->column_class('grade', 'grade');
ea6432fe 1246 $table->column_class('submissioncomment', 'comment');
9437c854 1247 $table->column_class('timemodified', 'timemodified');
1248 $table->column_class('timemarked', 'timemarked');
1249 $table->column_class('status', 'status');
5978010d 1250 $table->column_class('finalgrade', 'finalgrade');
e46f4d11 1251 if ($uses_outcomes) {
5978010d 1252 $table->column_class('outcome', 'outcome');
fbaa56b2 1253 }
45fa3412 1254
b0f2597e 1255 $table->set_attribute('cellspacing', '0');
1256 $table->set_attribute('id', 'attempts');
9437c854 1257 $table->set_attribute('class', 'submissions');
f30036d3 1258 $table->set_attribute('width', '100%');
d9cb14b8 1259 //$table->set_attribute('align', 'center');
45fa3412 1260
5978010d 1261 $table->no_sorting('finalgrade');
1262 $table->no_sorting('outcome');
1263
b0f2597e 1264 // Start working -- this is necessary as soon as the niceties are over
1265 $table->setup();
1266
b0f2597e 1267 if (empty($users)) {
867aeead 1268 echo $OUTPUT->heading(get_string('nosubmitusers','assignment'));
d2b6ee29 1269 echo '</div>';
b0f2597e 1270 return true;
1271 }
64f93798 1272 if ($this->assignment->assignmenttype=='upload' || $this->assignment->assignmenttype=='online' || $this->assignment->assignmenttype=='uploadsingle') { //TODO: this is an ugly hack, where is the plugin spirit? (skodak)
daca72eb 1273 echo '<div style="text-align:right"><a href="submissions.php?id='.$this->cm->id.'&amp;download=zip">'.get_string('downloadall', 'assignment').'</a></div>';
b37ce778 1274 }
b0f2597e 1275 /// Construct the SQL
0f1a97c2 1276
0f21a964
PS
1277 list($where, $params) = $table->get_sql_where();
1278 if ($where) {
b0f2597e 1279 $where .= ' AND ';
1280 }
de75c481 1281
0f21a964 1282 if ($filter == self::FILTER_SUBMITTED) {
de75c481 1283 $where .= 's.timemodified > 0 AND ';
fdb797ad 1284 } else if($filter == self::FILTER_REQUIRE_GRADING) {
de75c481 1285 $where .= 's.timemarked < s.timemodified AND ';
fdb797ad 1286 }
0f1a97c2 1287
b0f2597e 1288 if ($sort = $table->get_sql_sort()) {
86f65395 1289 $sort = ' ORDER BY '.$sort;
b0f2597e 1290 }
9fa49e22 1291
3a11c09f 1292 $ufields = user_picture::fields('u');
fdb797ad 1293
3a11c09f 1294 $select = "SELECT $ufields,
45fa3412 1295 s.id AS submissionid, s.grade, s.submissioncomment,
c9265600 1296 s.timemodified, s.timemarked,
3a11c09f 1297 COALESCE(SIGN(SIGN(s.timemarked) + SIGN(s.timemarked - s.timemodified)), 0) AS status ";
5053f00f 1298 $sql = 'FROM {user} u '.
1299 'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
fdb797ad 1300 AND s.assignment = '.$this->assignment->id.' '.
ba3dc7b4 1301 'WHERE '.$where.'u.id IN ('.implode(',',$users).') ';
45fa3412 1302
0f21a964 1303 $ausers = $DB->get_records_sql($select.$sql.$sort, $params, $table->get_page_start(), $table->get_page_size());
45fa3412 1304
fdb797ad 1305 $table->pagesize($perpage, count($users));
de75c481 1306
9bf660b3 1307 ///offset used to calculate index of student in that particular query, needed for the pop up to know who's next
1308 $offset = $page * $perpage;
b0f2597e 1309 $strupdate = get_string('update');
9437c854 1310 $strgrade = get_string('grade');
b0f2597e 1311 $grademenu = make_grades_menu($this->assignment->grade);
1312
fdb797ad 1313 if ($ausers !== false) {
de75c481 1314 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, array_keys($ausers));
fdb797ad
RW
1315 $endposition = $offset + $perpage;
1316 $currentposition = 0;
d59269cf 1317 foreach ($ausers as $auser) {
fdb797ad
RW
1318 if ($currentposition == $offset && $offset < $endposition) {
1319 $final_grade = $grading_info->items[0]->grades[$auser->id];
1320 $grademax = $grading_info->items[0]->grademax;
1321 $final_grade->formatted_grade = round($final_grade->grade,2) .' / ' . round($grademax,2);
1322 $locked_overridden = 'locked';
1323 if ($final_grade->overridden) {
1324 $locked_overridden = 'overridden';
1325 }
45fa3412 1326
fdb797ad
RW
1327 /// Calculate user status
1328 $auser->status = ($auser->timemarked > 0) && ($auser->timemarked >= $auser->timemodified);
1329 $picture = $OUTPUT->user_picture($auser);
45fa3412 1330
fdb797ad
RW
1331 if (empty($auser->submissionid)) {
1332 $auser->grade = -1; //no submission yet
d59269cf 1333 }
45fa3412 1334
fdb797ad
RW
1335 if (!empty($auser->submissionid)) {
1336 ///Prints student answer and student modified date
1337 ///attach file or print link to student answer, depending on the type of the assignment.
1338 ///Refer to print_student_answer in inherited classes.
1339 if ($auser->timemodified > 0) {
1340 $studentmodified = '<div id="ts'.$auser->id.'">'.$this->print_student_answer($auser->id)
1341 . userdate($auser->timemodified).'</div>';
1342 } else {
1343 $studentmodified = '<div id="ts'.$auser->id.'">&nbsp;</div>';
1344 }
1345 ///Print grade, dropdown or text
1346 if ($auser->timemarked > 0) {
1347 $teachermodified = '<div id="tt'.$auser->id.'">'.userdate($auser->timemarked).'</div>';
1348
1349 if ($final_grade->locked or $final_grade->overridden) {
1350 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1351 } else if ($quickgrade) {
1352 $attributes = array();
1353 $attributes['tabindex'] = $tabindex++;
1354 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1355 $grade = '<div id="g'.$auser->id.'">'. $menu .'</div>';
1356 } else {
1357 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1358 }
1359
1360 } else {
1361 $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
1362 if ($final_grade->locked or $final_grade->overridden) {
1363 $grade = '<div id="g'.$auser->id.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade.'</div>';
1364 } else if ($quickgrade) {
1365 $attributes = array();
1366 $attributes['tabindex'] = $tabindex++;
1367 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
1368 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
1369 } else {
1370 $grade = '<div id="g'.$auser->id.'">'.$this->display_grade($auser->grade).'</div>';
1371 }
1372 }
1373 ///Print Comment
5978010d 1374 if ($final_grade->locked or $final_grade->overridden) {
fdb797ad
RW
1375 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($final_grade->str_feedback),15).'</div>';
1376
5978010d 1377 } else if ($quickgrade) {
fdb797ad
RW
1378 $comment = '<div id="com'.$auser->id.'">'
1379 . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1380 . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
9bf660b3 1381 } else {
fdb797ad 1382 $comment = '<div id="com'.$auser->id.'">'.shorten_text(strip_tags($auser->submissioncomment),15).'</div>';
9bf660b3 1383 }
b0f2597e 1384 } else {
fdb797ad 1385 $studentmodified = '<div id="ts'.$auser->id.'">&nbsp;</div>';
9437c854 1386 $teachermodified = '<div id="tt'.$auser->id.'">&nbsp;</div>';
fdb797ad
RW
1387 $status = '<div id="st'.$auser->id.'">&nbsp;</div>';
1388
5978010d 1389 if ($final_grade->locked or $final_grade->overridden) {
fdb797ad
RW
1390 $grade = '<div id="g'.$auser->id.'">'.$final_grade->formatted_grade . '</div>';
1391 } else if ($quickgrade) { // allow editing
93af06be
PS
1392 $attributes = array();
1393 $attributes['tabindex'] = $tabindex++;
1394 $menu = html_writer::select(make_grades_menu($this->assignment->grade), 'menu['.$auser->id.']', $auser->grade, array(-1=>get_string('nograde')), $attributes);
206ab184 1395 $grade = '<div id="g'.$auser->id.'">'.$menu.'</div>';
9bf660b3 1396 } else {
fdb797ad
RW
1397 $grade = '<div id="g'.$auser->id.'">-</div>';
1398 }
1399
1400 if ($final_grade->locked or $final_grade->overridden) {
1401 $comment = '<div id="com'.$auser->id.'">'.$final_grade->str_feedback.'</div>';
1402 } else if ($quickgrade) {
1403 $comment = '<div id="com'.$auser->id.'">'
1404 . '<textarea tabindex="'.$tabindex++.'" name="submissioncomment['.$auser->id.']" id="submissioncomment'
1405 . $auser->id.'" rows="2" cols="20">'.($auser->submissioncomment).'</textarea></div>';
1406 } else {
1407 $comment = '<div id="com'.$auser->id.'">&nbsp;</div>';
9bf660b3 1408 }
9bf660b3 1409 }
206ab184 1410
fdb797ad
RW
1411 if (empty($auser->status)) { /// Confirm we have exclusively 0 or 1
1412 $auser->status = 0;
9bf660b3 1413 } else {
fdb797ad 1414 $auser->status = 1;
9bf660b3 1415 }
9fa49e22 1416
fdb797ad 1417 $buttontext = ($auser->status == 1) ? $strupdate : $strgrade;
0f7d4e5e 1418
fdb797ad
RW
1419 ///No more buttons, we use popups ;-).
1420 $popup_url = '/mod/assignment/submissions.php?id='.$this->cm->id
1421 . '&amp;userid='.$auser->id.'&amp;mode=single'.'&amp;filter='.$filter.'&amp;offset='.$offset++;
45fa3412 1422
fdb797ad 1423 $button = $OUTPUT->action_link($popup_url, $buttontext);
a9573c08 1424
fdb797ad 1425 $status = '<div id="up'.$auser->id.'" class="s'.$auser->status.'">'.$button.'</div>';
206ab184 1426
fdb797ad 1427 $finalgrade = '<span id="finalgrade_'.$auser->id.'">'.$final_grade->str_grade.'</span>';
cc03871b 1428
fdb797ad 1429 $outcomes = '';
5978010d 1430
fdb797ad 1431 if ($uses_outcomes) {
206ab184 1432
fdb797ad
RW
1433 foreach($grading_info->outcomes as $n=>$outcome) {
1434 $outcomes .= '<div class="outcome"><label>'.$outcome->name.'</label>';
1435 $options = make_grades_menu(-$outcome->scaleid);
206ab184 1436
fdb797ad
RW
1437 if ($outcome->grades[$auser->id]->locked or !$quickgrade) {
1438 $options[0] = get_string('nooutcome', 'grades');
1439 $outcomes .= ': <span id="outcome_'.$n.'_'.$auser->id.'">'.$options[$outcome->grades[$auser->id]->grade].'</span>';
1440 } else {
1441 $attributes = array();
1442 $attributes['tabindex'] = $tabindex++;
1443 $attributes['id'] = 'outcome_'.$n.'_'.$auser->id;
1444 $outcomes .= ' '.html_writer::select($options, 'outcome_'.$n.'['.$auser->id.']', $outcome->grades[$auser->id]->grade, array(0=>get_string('nooutcome', 'grades')), $attributes);
1445 }
1446 $outcomes .= '</div>';
cc03871b 1447 }
cc03871b 1448 }
cc03871b 1449
fdb797ad
RW
1450 $userlink = '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $auser->id . '&amp;course=' . $course->id . '">' . fullname($auser, has_capability('moodle/site:viewfullnames', $this->context)) . '</a>';
1451 $row = array($picture, $userlink, $grade, $comment, $studentmodified, $teachermodified, $status, $finalgrade);
1452 if ($uses_outcomes) {
1453 $row[] = $outcomes;
1454 }
fbaa56b2 1455
de75c481 1456 $table->add_data($row);
fdb797ad
RW
1457 }
1458 $currentposition++;
d59269cf 1459 }
b0f2597e 1460 }
45fa3412 1461
082215e6 1462 $table->print_html(); /// Print the whole table
1463
fdb797ad
RW
1464 /// Print quickgrade form around the table
1465 if ($quickgrade && $table->started_output){
1466 $mailinfopref = false;
1467 if (get_user_preferences('assignment_mailinfo', 1)) {
1468 $mailinfopref = true;
1469 }
1470 $emailnotification = html_writer::checkbox('mailinfo', 1, $mailinfopref, get_string('enableemailnotification','assignment'));
de75c481 1471
fdb797ad
RW
1472 $emailnotification .= $OUTPUT->help_icon('enableemailnotification', 'assignment');
1473 echo html_writer::tag('div', $emailnotification, array('class'=>'emailnotification'));
1474
1475 $savefeedback = html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'fastg', 'value'=>get_string('saveallfeedback', 'assignment')));
1476 echo html_writer::tag('div', $savefeedback, array('class'=>'fastgbutton'));
de75c481
RW
1477
1478 echo html_writer::end_tag('form');
fdb797ad 1479 } else if ($quickgrade) {
de75c481 1480 echo html_writer::end_tag('form');
9bf660b3 1481 }
fdb797ad
RW
1482
1483 echo '</div>';
082215e6 1484 /// End of fast grading form
45fa3412 1485
de75c481
RW
1486 /// Mini form for setting user preference
1487
fdb797ad
RW
1488 $formaction = new moodle_url('/mod/assignment/submissions.php', array('id'=>$this->cm->id));
1489 $mform = new MoodleQuickForm('optionspref', 'post', $formaction, '', array('class'=>'optionspref'));
de75c481 1490
fdb797ad
RW
1491 $mform->addElement('hidden', 'updatepref');
1492 $mform->setDefault('updatepref', 1);
1493 $mform->addElement('header', 'qgprefs', get_string('optionalsettings', 'assignment'));
1494 $mform->addElement('select', 'filter', get_string('show'), $filters);
de75c481 1495
fdb797ad
RW
1496 $mform->setDefault('filter', $filter);
1497
1498 $mform->addElement('text', 'perpage', get_string('pagesize', 'assignment'), array('size'=>1));
de75c481 1499 $mform->setDefault('perpage', $perpage);
fdb797ad
RW
1500
1501 $mform->addElement('checkbox', 'quickgrade', get_string('quickgrade','assignment'));
1502 $mform->setDefault('quickgrade', $quickgrade);
1503 $mform->addHelpButton('quickgrade', 'quickgrade', 'assignment');
de75c481 1504
fdb797ad
RW
1505 $mform->addElement('submit', 'savepreferences', get_string('savepreferences'));
1506
1507 $mform->display();
de75c481 1508
256d2850 1509 echo $OUTPUT->footer();
8e340cb0 1510 }
d699cd1e 1511
7af1e882 1512 /**
1513 * Process teacher feedback submission
1514 *
1515 * This is called by submissions() when a grading even has taken place.
1516 * It gets its data from the submitted form.
256578f6 1517 *
1518 * @global object
1519 * @global object
1520 * @global object
1521 * @return object|bool The updated submission object or false
b0f2597e 1522 */
291ee134 1523 function process_feedback($formdata=null) {
f8c81c01 1524 global $CFG, $USER, $DB;
5978010d 1525 require_once($CFG->libdir.'/gradelib.php');
d699cd1e 1526
a19dffc0 1527 if (!$feedback = data_submitted() or !confirm_sesskey()) { // No incoming data?
b0f2597e 1528 return false;
d699cd1e 1529 }
b7b42874 1530
9bf660b3 1531 ///For save and next, we need to know the userid to save, and the userid to go
1532 ///We use a new hidden field in the form, and set it to -1. If it's set, we use this
1533 ///as the userid to store
1534 if ((int)$feedback->saveuserid !== -1){
1535 $feedback->userid = $feedback->saveuserid;
1536 }
1537
b0f2597e 1538 if (!empty($feedback->cancel)) { // User hit cancel button
1539 return false;
1540 }
d699cd1e 1541
5978010d 1542 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $feedback->userid);
1543
cc03871b 1544 // store outcomes if needed
1545 $this->process_outcomes($feedback->userid);
1546
7af1e882 1547 $submission = $this->get_submission($feedback->userid, true); // Get or make one
d699cd1e 1548
d2b6ee29 1549 if (!($grading_info->items[0]->grades[$feedback->userid]->locked ||
1550 $grading_info->items[0]->grades[$feedback->userid]->overridden) ) {
d699cd1e 1551
d2b6ee29 1552 $submission->grade = $feedback->xgrade;
1553 $submission->submissioncomment = $feedback->submissioncomment_editor['text'];
5978010d 1554 $submission->teacher = $USER->id;
2dc5d980 1555 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
1556 if (!$mailinfo) {
1557 $submission->mailed = 1; // treat as already mailed
1558 } else {
1559 $submission->mailed = 0; // Make sure mail goes out (again, even)
1560 }
5978010d 1561 $submission->timemarked = time();
d4156e80 1562
5978010d 1563 unset($submission->data1); // Don't need to update this.
1564 unset($submission->data2); // Don't need to update this.
d699cd1e 1565
5978010d 1566 if (empty($submission->timemodified)) { // eg for offline assignments
1567 // $submission->timemodified = time();
1568 }
d699cd1e 1569
0bcf8b6f 1570 $DB->update_record('assignment_submissions', $submission);
7bddd4b7 1571
5978010d 1572 // triger grade event
1573 $this->update_grade($submission);
1574
1575 add_to_log($this->course->id, 'assignment', 'update grades',
1576 'submissions.php?id='.$this->assignment->id.'&user='.$feedback->userid, $feedback->userid, $this->cm->id);
291ee134
AB
1577 if (!is_null($formdata)) {
1578 if ($this->type == 'upload' || $this->type == 'uploadsingle') {
1579 $mformdata = $formdata->mform->get_data();
1580 $mformdata = file_postupdate_standard_filemanager($mformdata, 'files', $formdata->fileui_options, $this->context, 'mod_assignment', 'response', $submission->id);
1581 }
1582 }
5978010d 1583 }
45fa3412 1584
7af1e882 1585 return $submission;
d699cd1e 1586
d699cd1e 1587 }
d699cd1e 1588
cc03871b 1589 function process_outcomes($userid) {
1590 global $CFG, $USER;
fbaa56b2 1591
1592 if (empty($CFG->enableoutcomes)) {
1593 return;
1594 }
1595
cc03871b 1596 require_once($CFG->libdir.'/gradelib.php');
1597
a19dffc0 1598 if (!$formdata = data_submitted() or !confirm_sesskey()) {
cc03871b 1599 return;
1600 }
1601
1602 $data = array();
fcac8e51 1603 $grading_info = grade_get_grades($this->course->id, 'mod', 'assignment', $this->assignment->id, $userid);
1604
1605 if (!empty($grading_info->outcomes)) {
d886a7ea 1606 foreach($grading_info->outcomes as $n=>$old) {
1607 $name = 'outcome_'.$n;
1608 if (isset($formdata->{$name}[$userid]) and $old->grades[$userid]->grade != $formdata->{$name}[$userid]) {
1609 $data[$n] = $formdata->{$name}[$userid];
cc03871b 1610 }
1611 }
1612 }
1613 if (count($data) > 0) {
1614 grade_update_outcomes('mod/assignment', $this->course->id, 'mod', 'assignment', $this->assignment->id, $userid, $data);
1615 }
1616
1617 }
1618
7af1e882 1619 /**
1620 * Load the submission object for a particular user
1621 *
256578f6 1622 * @global object
1623 * @global object
7af1e882 1624 * @param $userid int The id of the user whose submission we want or 0 in which case USER->id is used
1625 * @param $createnew boolean optional Defaults to false. If set to true a new submission object will be created in the database
03076be4 1626 * @param bool $teachermodified student submission set if false
7af1e882 1627 * @return object The submission
1628 */
03076be4 1629 function get_submission($userid=0, $createnew=false, $teachermodified=false) {
5053f00f 1630 global $USER, $DB;
f77cfb73 1631
1632 if (empty($userid)) {
1633 $userid = $USER->id;
1634 }
1635
5053f00f 1636 $submission = $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
d699cd1e 1637
b0f2597e 1638 if ($submission || !$createnew) {
1639 return $submission;
1640 }
03076be4 1641 $newsubmission = $this->prepare_new_submission($userid, $teachermodified);
7826abc7 1642 $DB->insert_record("assignment_submissions", $newsubmission);
d699cd1e 1643
5053f00f 1644 return $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment->id, 'userid'=>$userid));
b0f2597e 1645 }
d699cd1e 1646
7af1e882 1647 /**
1648 * Instantiates a new submission object for a given user
1649 *
1650 * Sets the assignment, userid and times, everything else is set to default values.
256578f6 1651 *
1652 * @param int $userid The userid for which we want a submission object
03076be4 1653 * @param bool $teachermodified student submission set if false
7af1e882 1654 * @return object The submission
1655 */
03076be4 1656 function prepare_new_submission($userid, $teachermodified=false) {
39790bd8 1657 $submission = new stdClass();
39e11905 1658 $submission->assignment = $this->assignment->id;
1659 $submission->userid = $userid;
47c96a77 1660 $submission->timecreated = time();
16fc2088 1661 // teachers should not be modifying modified date, except offline assignments
03076be4 1662 if ($teachermodified) {
1663 $submission->timemodified = 0;
1664 } else {
1665 $submission->timemodified = $submission->timecreated;
1666 }
39e11905 1667 $submission->numfiles = 0;
1668 $submission->data1 = '';
1669 $submission->data2 = '';
1670 $submission->grade = -1;
ea6432fe 1671 $submission->submissioncomment = '';
39e11905 1672 $submission->format = 0;
1673 $submission->teacher = 0;
1674 $submission->timemarked = 0;
1675 $submission->mailed = 0;
1676 return $submission;
1677 }
1678
7af1e882 1679 /**
1680 * Return all assignment submissions by ENROLLED students (even empty)
1681 *
256578f6 1682 * @param string $sort optional field names for the ORDER BY in the sql query
1683 * @param string $dir optional specifying the sort direction, defaults to DESC
7af1e882 1684 * @return array The submission objects indexed by id
1685 */
b0f2597e 1686 function get_submissions($sort='', $dir='DESC') {
7af1e882 1687 return assignment_get_all_submissions($this->assignment, $sort, $dir);
b0f2597e 1688 }
1689
7af1e882 1690 /**
1691 * Counts all real assignment submissions by ENROLLED students (not empty ones)
1692 *
256578f6 1693 * @param int $groupid optional If nonzero then count is restricted to this group
7af1e882 1694 * @return int The number of submissions
1695 */
b0f2597e 1696 function count_real_submissions($groupid=0) {
dd97c328 1697 return assignment_count_real_submissions($this->cm, $groupid);
d59269cf 1698 }
d699cd1e 1699
7af1e882 1700 /**
1701 * Alerts teachers by email of new or changed assignments that need grading
1702 *
1703 * First checks whether the option to email teachers is set for this assignment.
1704 * Sends an email to ALL teachers in the course (or in the group if using separate groups).
1705 * Uses the methods email_teachers_text() and email_teachers_html() to construct the content.
256578f6 1706 *
1707 * @global object
1708 * @global object
7af1e882 1709 * @param $submission object The submission that has changed
256578f6 1710 * @return void
7af1e882 1711 */
73097f07 1712 function email_teachers($submission) {
5053f00f 1713 global $CFG, $DB;
73097f07 1714
d8199f1d 1715 if (empty($this->assignment->emailteachers)) { // No need to do anything
73097f07 1716 return;
1717 }
1718
5053f00f 1719 $user = $DB->get_record('user', array('id'=>$submission->userid));
73097f07 1720
413efd22 1721 if ($teachers = $this->get_graders($user)) {
73097f07 1722
1723 $strassignments = get_string('modulenameplural', 'assignment');
1724 $strassignment = get_string('modulename', 'assignment');
1725 $strsubmitted = get_string('submitted', 'assignment');
1726
1727 foreach ($teachers as $teacher) {
39790bd8 1728 $info = new stdClass();
413efd22 1729 $info->username = fullname($user, true);
d8199f1d 1730 $info->assignment = format_string($this->assignment->name,true);
1731 $info->url = $CFG->wwwroot.'/mod/assignment/submissions.php?id='.$this->cm->id;
1732
1733 $postsubject = $strsubmitted.': '.$info->username.' -> '.$this->assignment->name;
1734 $posttext = $this->email_teachers_text($info);
1735 $posthtml = ($teacher->mailformat == 1) ? $this->email_teachers_html($info) : '';
73097f07 1736
39790bd8 1737 $eventdata = new stdClass();
3b120e46 1738 $eventdata->modulename = 'assignment';
1739 $eventdata->userfrom = $user;
1740 $eventdata->userto = $teacher;
1741 $eventdata->subject = $postsubject;
1742 $eventdata->fullmessage = $posttext;
1743 $eventdata->fullmessageformat = FORMAT_PLAIN;
1744 $eventdata->fullmessagehtml = $posthtml;
1745 $eventdata->smallmessage = '';
192bcd76
AB
1746
1747 $eventdata->name = 'assignment_submitted';
1748 $eventdata->component = 'mod_assignment';
1749
7c7d3afa 1750 message_send($eventdata);
73097f07 1751 }
1752 }
1753 }
1754
256578f6 1755 /**
1756 * @param string $filearea
1757 * @param array $args
1758 * @return bool
1759 */
172dd12c 1760 function send_file($filearea, $args) {
1761 debugging('plugin does not implement file sending', DEBUG_DEVELOPER);
1762 return false;
1763 }
1764
413efd22 1765 /**
1766 * Returns a list of teachers that should be grading given submission
256578f6 1767 *
1768 * @param object $user
1769 * @return array
413efd22 1770 */
1771 function get_graders($user) {
1772 //potential graders
7bddd4b7 1773 $potgraders = get_users_by_capability($this->context, 'mod/assignment:grade', '', '', '', '', '', '', false, false);
1774
413efd22 1775 $graders = array();
ba3dc7b4 1776 if (groups_get_activity_groupmode($this->cm) == SEPARATEGROUPS) { // Separate groups are being used
2c386f82 1777 if ($groups = groups_get_all_groups($this->course->id, $user->id)) { // Try to find all groups
413efd22 1778 foreach ($groups as $group) {
1779 foreach ($potgraders as $t) {
1780 if ($t->id == $user->id) {
1781 continue; // do not send self
1782 }
1783 if (groups_is_member($group->id, $t->id)) {
1784 $graders[$t->id] = $t;
1785 }
1786 }
1787 }
1788 } else {
1789 // user not in group, try to find graders without group
1790 foreach ($potgraders as $t) {
1791 if ($t->id == $user->id) {
1792 continue; // do not send self
1793 }
2c386f82 1794 if (!groups_get_all_groups($this->course->id, $t->id)) { //ugly hack
413efd22 1795 $graders[$t->id] = $t;
1796 }
1797 }
1798 }
1799 } else {
1800 foreach ($potgraders as $t) {
1801 if ($t->id == $user->id) {
1802 continue; // do not send self
1803 }
1804 $graders[$t->id] = $t;
1805 }
1806 }
1807 return $graders;
1808 }
1809
7af1e882 1810 /**
1811 * Creates the text content for emails to teachers
1812 *
1813 * @param $info object The info used by the 'emailteachermail' language string
1814 * @return string
1815 */
d8199f1d 1816 function email_teachers_text($info) {
413efd22 1817 $posttext = format_string($this->course->shortname).' -> '.$this->strassignments.' -> '.
1818 format_string($this->assignment->name)."\n";
d8199f1d 1819 $posttext .= '---------------------------------------------------------------------'."\n";
1820 $posttext .= get_string("emailteachermail", "assignment", $info)."\n";
73963212 1821 $posttext .= "\n---------------------------------------------------------------------\n";
d8199f1d 1822 return $posttext;
1823 }
1824
7af1e882 1825 /**
1826 * Creates the html content for emails to teachers
1827 *
1828 * @param $info object The info used by the 'emailteachermailhtml' language string
1829 * @return string
1830 */
d8199f1d 1831 function email_teachers_html($info) {
3554b5c2 1832 global $CFG;
d8199f1d 1833 $posthtml = '<p><font face="sans-serif">'.
413efd22 1834 '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$this->course->id.'">'.format_string($this->course->shortname).'</a> ->'.
d8199f1d 1835 '<a href="'.$CFG->wwwroot.'/mod/assignment/index.php?id='.$this->course->id.'">'.$this->strassignments.'</a> ->'.
413efd22 1836 '<a href="'.$CFG->wwwroot.'/mod/assignment/view.php?id='.$this->cm->id.'">'.format_string($this->assignment->name).'</a></font></p>';
d8199f1d 1837 $posthtml .= '<hr /><font face="sans-serif">';
1838 $posthtml .= '<p>'.get_string('emailteachermailhtml', 'assignment', $info).'</p>';
1839 $posthtml .= '</font><hr />';
815b5ca6 1840 return $posthtml;
d8199f1d 1841 }
1842
7af1e882 1843 /**
1844 * Produces a list of links to the files uploaded by a user
1845 *
1846 * @param $userid int optional id of the user. If 0 then $USER->id is used.
1847 * @param $return boolean optional defaults to false. If true the list is returned rather than printed
1848 * @return string optional
1849 */
d8199f1d 1850 function print_user_files($userid=0, $return=false) {
d436d197 1851 global $CFG, $USER, $OUTPUT;
45fa3412 1852
d8199f1d 1853 if (!$userid) {
1854 if (!isloggedin()) {
1855 return '';
1856 }
1857 $userid = $USER->id;
1858 }
45fa3412 1859
73097f07 1860 $output = '';
45fa3412 1861
172dd12c 1862 $fs = get_file_storage();
172dd12c 1863
1864 $found = false;
1865
31f56ef6 1866 $submission = $this->get_submission($userid);
1867
96f35440 1868 if (($submission) && $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
24ba58ee
PL
1869 require_once($CFG->libdir.'/portfoliolib.php');
1870 require_once($CFG->dirroot . '/mod/assignment/locallib.php');
0d06b6fd 1871 $button = new portfolio_add_button();
172dd12c 1872 foreach ($files as $file) {
1873 $filename = $file->get_filename();
1874 $found = true;
1875 $mimetype = $file->get_mimetype();
437239d1 1876 $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$this->context->id.'/mod_assignment/submission/'.$submission->id.'/'.$filename);
b5d0cafc 1877 $output .= '<a href="'.$path.'" ><img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />'.s($filename).'</a>';
728e1931 1878 if ($this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
24ba58ee 1879 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id, 'fileid' => $file->get_id()), '/mod/assignment/locallib.php');
887160c7 1880 $button->set_format_by_file($file);
0d06b6fd 1881 $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
73097f07 1882 }
bce59524
DM
1883 $output .= plagiarism_get_links(array('userid'=>$userid, 'file'=>$file, 'cmid'=>$this->cm->id, 'course'=>$this->course, 'assignment'=>$this->assignment));
1884 $output .= '<br />';
172dd12c 1885 }
0d06b6fd 1886 if (count($files) > 1 && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context)) {
5fb29115 1887 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm->id), '/mod/assignment/locallib.php');
0d06b6fd 1888 $output .= '<br />' . $button->to_html();
73097f07 1889 }
1890 }
1891
1892 $output = '<div class="files">'.$output.'</div>';
1893
1894 if ($return) {
1895 return $output;
1896 }
1897 echo $output;
1898 }
1899
7af1e882 1900 /**
1901 * Count the files uploaded by a given user
1902 *
b5e1ffe4 1903 * @param $itemid int The submission's id as the file's itemid.
7af1e882 1904 * @return int
1905 */
b5e1ffe4 1906 function count_user_files($itemid) {
172dd12c 1907 $fs = get_file_storage();
b5e1ffe4 1908 $files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $itemid, "id", false);
172dd12c 1909 return count($files);
73097f07 1910 }
1911
7af1e882 1912 /**
1913 * Returns true if the student is allowed to submit
1914 *
1915 * Checks that the assignment has started and, if the option to prevent late
1916 * submissions is set, also checks that the assignment has not yet closed.
1917 * @return boolean
1918 */
f77cfb73 1919 function isopen() {
1920 $time = time();
1e4343a0 1921 if ($this->assignment->preventlate && $this->assignment->timedue) {
f77cfb73 1922 return ($this->assignment->timeavailable <= $time && $time <= $this->assignment->timedue);
1923 } else {
1924 return ($this->assignment->timeavailable <= $time);
1925 }
1926 }
1927
0b5a80a1 1928
1929 /**
dc6cb74e 1930 * Return true if is set description is hidden till available date
1931 *
0b5a80a1 1932 * This is needed by calendar so that hidden descriptions do not
dc6cb74e 1933 * come up in upcoming events.
1934 *
0b5a80a1 1935 * Check that description is hidden till available date
dc6cb74e 1936 * By default return false
1937 * Assignments types should implement this method if needed
1938 * @return boolen
0b5a80a1 1939 */
dc6cb74e 1940 function description_is_hidden() {
1941 return false;
1942 }
1943
7af1e882 1944 /**
1945 * Return an outline of the user's interaction with the assignment
1946 *
1947 * The default method prints the grade and timemodified
1a96363a 1948 * @param $grade object
7af1e882 1949 * @return object with properties ->info and ->time
1950 */
1a96363a 1951 function user_outline($grade) {
39e11905 1952
39790bd8 1953 $result = new stdClass();
1a96363a
NC
1954 $result->info = get_string('grade').': '.$grade->str_long_grade;
1955 $result->time = $grade->dategraded;
1956 return $result;
73097f07 1957 }
7af1e882 1958
1959 /**
1960 * Print complete information about the user's interaction with the assignment
1961 *
1962 * @param $user object
1963 */
1a96363a 1964 function user_complete($user, $grade=null) {
3a003ead 1965 global $OUTPUT;
1a96363a
NC
1966 if ($grade) {
1967 echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1968 if ($grade->str_feedback) {
1969 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1970 }
1971 }
1972
73097f07 1973 if ($submission = $this->get_submission($user->id)) {
172dd12c 1974
1975 $fs = get_file_storage();
26a9dc72 1976
87f702a0 1977 if ($files = $fs->get_area_files($this->context->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
172dd12c 1978 $countfiles = count($files)." ".get_string("uploadedfiles", "assignment");
1979 foreach ($files as $file) {
1980 $countfiles .= "; ".$file->get_filename();
73097f07 1981 }
1982 }
45fa3412 1983
3a003ead 1984 echo $OUTPUT->box_start();
73097f07 1985 echo get_string("lastmodified").": ";
9bf660b3 1986 echo userdate($submission->timemodified);
1987 echo $this->display_lateness($submission->timemodified);
45fa3412 1988
70b2c772 1989 $this->print_user_files($user->id);
45fa3412 1990
73097f07 1991 echo '<br />';
45fa3412 1992
1a96363a 1993 $this->view_feedback($submission);
45fa3412 1994
3a003ead 1995 echo $OUTPUT->box_end();
45fa3412 1996
73097f07 1997 } else {
1998 print_string("notsubmittedyet", "assignment");
1999 }
2000 }
2001
7af1e882 2002 /**
2003 * Return a string indicating how late a submission is
2004 *
45fa3412 2005 * @param $timesubmitted int
7af1e882 2006 * @return string
2007 */
70b2c772 2008 function display_lateness($timesubmitted) {
76a60031 2009 return assignment_display_lateness($timesubmitted, $this->assignment->timedue);
73097f07 2010 }
2011
55b4d096 2012 /**
2013 * Empty method stub for all delete actions.
2014 */
2015 function delete() {
2016 //nothing by default
2017 redirect('view.php?id='.$this->cm->id);
2018 }
2019
2020 /**
2021 * Empty custom feedback grading form.
2022 */
2023 function custom_feedbackform($submission, $return=false) {
2024 //nothing by default
2025 return '';
2026 }
73097f07 2027
09ba8e56 2028 /**
2029 * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
2030 * for the course (see resource).
2031 *
206ab184 2032 * Given a course_module object, this function returns any "extra" information that may be needed
09ba8e56 2033 * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php.
206ab184 2034 *
09ba8e56 2035 * @param $coursemodule object The coursemodule object (record).
91421f3e 2036 * @return object An object on information that the courses will know about (most noticeably, an icon).
206ab184 2037 *
09ba8e56 2038 */
2039 function get_coursemodule_info($coursemodule) {
2040 return false;
2041 }
2042
d014b69b 2043 /**
2044 * Plugin cron method - do not use $this here, create new assignment instances if needed.
2045 * @return void
2046 */
2047 function cron() {
2048 //no plugin cron by default - override if needed
2049 }
2050
0b5a80a1 2051 /**
2052 * Reset all submissions
2053 */
2054 function reset_userdata($data) {
5053f00f 2055 global $CFG, $DB;
0b5a80a1 2056
74d7d735 2057 if (!$DB->count_records('assignment', array('course'=>$data->courseid, 'assignmenttype'=>$this->type))) {
0b5a80a1 2058 return array(); // no assignments of this type present
2059 }
2060
2061 $componentstr = get_string('modulenameplural', 'assignment');
2062 $status = array();
2063
2064 $typestr = get_string('type'.$this->type, 'assignment');
40fcf70c
DP
2065 // ugly hack to support pluggable assignment type titles...
2066 if($typestr === '[[type'.$this->type.']]'){
2067 $typestr = get_string('type'.$this->type, 'assignment_'.$this->type);
2068 }
0b5a80a1 2069
2070 if (!empty($data->reset_assignment_submissions)) {
2071 $assignmentssql = "SELECT a.id
5053f00f 2072 FROM {assignment} a
2073 WHERE a.course=? AND a.assignmenttype=?";
2074 $params = array($data->courseid, $this->type);
0b5a80a1 2075
75dfe830 2076 // now get rid of all submissions and responses
4e866d5e 2077 $fs = get_file_storage();
5053f00f 2078 if ($assignments = $DB->get_records_sql($assignmentssql, $params)) {
0b5a80a1 2079 foreach ($assignments as $assignmentid=>$unused) {
4e866d5e 2080 if (!$cm = get_coursemodule_from_instance('assignment', $assignmentid)) {
2081 continue;
2082 }
2083 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
64f93798
PS
2084 $fs->delete_area_files($context->id, 'mod_assignment', 'submission');
2085 $fs->delete_area_files($context->id, 'mod_assignment', 'response');
0b5a80a1 2086 }
2087 }
2088
75dfe830 2089 $DB->delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)", $params);
2090
0b5a80a1 2091 $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false);
dd97c328 2092
0b5a80a1 2093 if (empty($data->reset_gradebook_grades)) {
2094 // remove all grades from gradebook
2095 assignment_reset_gradebook($data->courseid, $this->type);
2096 }
2097 }
2098
2099 /// updating dates - shift may be negative too
2100 if ($data->timeshift) {
2101 shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift, $data->courseid);
2102 $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false);
2103 }
2104
2105 return $status;
2106 }
67a87e7d 2107
2108
2109 function portfolio_exportable() {
2110 return false;
2111 }
3b804d2d 2112
2113 /**
2114 * base implementation for backing up subtype specific information
2115 * for one single module
2116 *
2117 * @param filehandle $bf file handle for xml file to write to
2118 * @param mixed $preferences the complete backup preference object
2119 *
2120 * @return boolean
2121 *
2122 * @static
2123 */
2124 static function backup_one_mod($bf, $preferences, $assignment) {
2125 return true;
2126 }
2127
2128 /**
2129 * base implementation for backing up subtype specific information
2130 * for one single submission
2131 *
2132 * @param filehandle $bf file handle for xml file to write to
2133 * @param mixed $preferences the complete backup preference object
2134 * @param object $submission the assignment submission db record
2135 *
2136 * @return boolean
2137 *
2138 * @static
2139 */
2140 static function backup_one_submission($bf, $preferences, $assignment, $submission) {
2141 return true;
2142 }
2143
2144 /**
2145 * base implementation for restoring subtype specific information
2146 * for one single module
2147 *
2148 * @param array $info the array representing the xml
2149 * @param object $restore the restore preferences
2150 *
2151 * @return boolean
2152 *
2153 * @static
2154 */
2155 static function restore_one_mod($info, $restore, $assignment) {
2156 return true;
2157 }
2158
2159 /**
2160 * base implementation for restoring subtype specific information
2161 * for one single submission
2162 *
2163 * @param object $submission the newly created submission
2164 * @param array $info the array representing the xml
2165 * @param object $restore the restore preferences
2166 *
2167 * @return boolean
2168 *
2169 * @static
2170 */
2171 static function restore_one_submission($info, $restore, $assignment, $submission) {
2172 return true;
2173 }
2174
b0f2597e 2175} ////// End of the assignment_base class
d699cd1e 2176
04eba58f 2177
7efcb735 2178class mod_assignment_grading_form extends moodleform {
d2b6ee29 2179
2180 function definition() {
2181 global $OUTPUT;
2182 $mform =& $this->_form;
2183
2184 $formattr = $mform->getAttributes();
2185 $formattr['id'] = 'submitform';
2186 $mform->setAttributes($formattr);
2187 // hidden params
2188 $mform->addElement('hidden', 'offset', ($this->_customdata->offset+1));
2189 $mform->setType('offset', PARAM_INT);
2190 $mform->addElement('hidden', 'userid', $this->_customdata->userid);
2191 $mform->setType('userid', PARAM_INT);
2192 $mform->addElement('hidden', 'nextid', $this->_customdata->nextid);
2193 $mform->setType('nextid', PARAM_INT);
2194 $mform->addElement('hidden', 'id', $this->_customdata->cm->id);
2195 $mform->setType('id', PARAM_INT);
2196 $mform->addElement('hidden', 'sesskey', sesskey());
2197 $mform->setType('sesskey', PARAM_ALPHANUM);
2198 $mform->addElement('hidden', 'mode', 'grade');
2d274675 2199 $mform->setType('mode', PARAM_TEXT);
d2b6ee29 2200 $mform->addElement('hidden', 'menuindex', "0");
2201 $mform->setType('menuindex', PARAM_INT);
2202 $mform->addElement('hidden', 'saveuserid', "-1");
2203 $mform->setType('saveuserid', PARAM_INT);
fdb797ad
RW
2204 $mform->addElement('hidden', 'filter', "0");
2205 $mform->setType('filter', PARAM_INT);
d2b6ee29 2206
2207 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->user),
2208 fullname($this->_customdata->user, true) . '<br/>' .
2209 userdate($this->_customdata->submission->timemodified) .
2210 $this->_customdata->lateness );
2211
291ee134 2212 $this->add_submission_content();
d2b6ee29 2213 $this->add_grades_section();
2214
2215 $this->add_feedback_section();
2216
261b585d 2217 if ($this->_customdata->submission->timemarked) {
291ee134 2218 $datestring = userdate($this->_customdata->submission->timemarked)."&nbsp; (".format_time(time() - $this->_customdata->submission->timemarked).")";
d2b6ee29 2219 $mform->addElement('header', 'Last Grade', get_string('lastgrade', 'assignment'));
2220 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata->teacher) ,
2221 fullname($this->_customdata->teacher,true).
291ee134 2222 '<br/>'.$datestring);
d2b6ee29 2223 }
2224 // buttons
2225 $this->add_action_buttons();
2226
d2b6ee29 2227 }
2228
2229 function add_grades_section() {
2230 global $CFG;
2231 $mform =& $this->_form;
2232 $attributes = array();
261b585d 2233 if ($this->_customdata->gradingdisabled) {
2234 $attributes['disabled'] ='disabled';
2235 }
d2b6ee29 2236
2237 $grademenu = make_grades_menu($this->_customdata->assignment->grade);
2238 $grademenu['-1'] = get_string('nograde');
2239
2240 $mform->addElement('header', 'Grades', get_string('grades', 'grades'));
2241 $mform->addElement('select', 'xgrade', get_string('grade').':', $grademenu, $attributes);
2242 $mform->setDefault('xgrade', $this->_customdata->submission->grade ); //@fixme some bug when element called 'grade' makes it break
2243 $mform->setType('xgrade', PARAM_INT);
2244
261b585d 2245 if (!empty($this->_customdata->enableoutcomes)) {
d2b6ee29 2246 foreach($this->_customdata->grading_info->outcomes as $n=>$outcome) {
2247 $options = make_grades_menu(-$outcome->scaleid);
2248 if ($outcome->grades[$this->_customdata->submission->userid]->locked) {
2249 $options[0] = get_string('nooutcome', 'grades');
2250 echo $options[$outcome->grades[$this->_customdata->submission->userid]->grade];
2251 } else {
2252 $options[''] = get_string('nooutcome', 'grades');
2253 $attributes = array('id' => 'menuoutcome_'.$n );
2254 $mform->addElement('select', 'outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->name.':', $options, $attributes );
2255 $mform->setType('outcome_'.$n.'['.$this->_customdata->userid.']', PARAM_INT);
2256 $mform->setDefault('outcome_'.$n.'['.$this->_customdata->userid.']', $outcome->grades[$this->_customdata->submission->userid]->grade );
2257 }
2258 }
2259 }
753c1de5 2260 $course_context = get_context_instance(CONTEXT_MODULE , $this->_customdata->cm->id);
2261 if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
2262 $grade = '<a href="'.$CFG->wwwroot.'/grade/report/grader/index.php?id='. $this->_customdata->courseid .'" >'.
2263 $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade . '</a>';
2264 }else{
2265 $grade = $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_grade;
2266 }
2267 $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assignment').':' ,$grade);
d2b6ee29 2268 $mform->setType('finalgrade', PARAM_INT);
2269 }
2270
2271 /**
2272 *
2273 * @global core_renderer $OUTPUT
2274 */
2275 function add_feedback_section() {
2276 global $OUTPUT;
2277 $mform =& $this->_form;
2278 $mform->addElement('header', 'Feed Back', get_string('feedback', 'grades'));
2279
261b585d 2280 if ($this->_customdata->gradingdisabled) {
d2b6ee29 2281 $mform->addElement('static', 'disabledfeedback', $this->_customdata->grading_info->items[0]->grades[$this->_customdata->userid]->str_feedback );
2282 } else {
2283 // visible elements
2284
2285 $mform->addElement('editor', 'submissioncomment_editor', get_string('feedback', 'assignment').':', null, $this->get_editor_options() );
2286 $mform->setType('submissioncomment_editor', PARAM_RAW); // to be cleaned before display
2287 $mform->setDefault('submissioncomment_editor', $this->_customdata->submission->submissioncomment);
2288 //$mform->addRule('submissioncomment', get_string('required'), 'required', null, 'client');
291ee134
AB
2289 switch ($this->_customdata->assignment->assignmenttype) {
2290 case 'upload' :
2291 case 'uploadsingle' :
2292 $mform->addElement('filemanager', 'files_filemanager', get_string('responsefiles', 'assignment'). ':', null, $this->_customdata->fileui_options);
2293 break;
2294 default :
2295 break;
2296 }
d2b6ee29 2297 $lastmailinfo = get_user_preferences('assignment_mailinfo', 1) ? array('checked'=>'checked') : array();
2298 $mform->addElement('hidden', 'mailinfo_h', "0");
2299 $mform->setType('mailinfo_h', PARAM_INT);
2300 $mform->addElement('checkbox', 'mailinfo',get_string('enableemailnotification','assignment').
1a905dbe 2301 $OUTPUT->help_icon('enableemailnotification', 'assignment') .':' );
d2b6ee29 2302 $mform->updateElementAttr('mailinfo', $lastmailinfo);
2303 $mform->setType('mailinfo', PARAM_INT);
2304 }
2305 }
2306
2307 function add_action_buttons() {
2308 $mform =& $this->_form;
d2b6ee29 2309 //if there are more to be graded.
261b585d 2310 if ($this->_customdata->nextid>0) {
d2b6ee29 2311 $buttonarray=array();
2312 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2313 //@todo: fix accessibility: javascript dependency not necessary
2314 $buttonarray[] = &$mform->createElement('submit', 'saveandnext', get_string('saveandnext'));
2315 $buttonarray[] = &$mform->createElement('submit', 'next', get_string('next'));
2316 $buttonarray[] = &$mform->createElement('cancel');
2317 } else {
2318 $buttonarray=array();
2319 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2320 $buttonarray[] = &$mform->createElement('cancel');
2321 }
2322 $mform->addGroup($buttonarray, 'grading_buttonar', '', array(' '), false);
291ee134 2323 $mform->closeHeaderBefore('grading_buttonar');
d2b6ee29 2324 $mform->setType('grading_buttonar', PARAM_RAW);
2325 }
2326
2327 function add_submission_content() {
2328 $mform =& $this->_form;
2329 $mform->addElement('header', 'Submission', get_string('submission', 'assignment'));
2330 $mform->addElement('static', '', '' , $this->_customdata->submission_content );
2331 }
96f4a64b 2332
d2b6ee29 2333 protected function get_editor_options() {
2334 $editoroptions = array();
64f93798
PS
2335 $editoroptions['component'] = 'mod_assignment';
2336 $editoroptions['filearea'] = 'feedback';
d2b6ee29 2337 $editoroptions['noclean'] = false;
64f93798 2338 $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 2339 $editoroptions['maxbytes'] = $this->_customdata->maxbytes;
2340 return $editoroptions;
2341 }
2342
2343 public function set_data($data) {
2344 $editoroptions = $this->get_editor_options();
2345 if (!isset($data->text)) {
2346 $data->text = '';
2347 }
2348 if (!isset($data->format)) {
2349 $data->textformat = FORMAT_HTML;
2350 } else {
2351 $data->textformat = $data->format;
2352 }
2353
2354 if (!empty($this->_customdata->submission->id)) {
2355 $itemid = $this->_customdata->submission->id;
2356 } else {
2357 $itemid = null;
2358 }
2359
291ee134
AB
2360 switch ($this->_customdata->assignment->assignmenttype) {
2361 case 'upload' :
2362 case 'uploadsingle' :
2363 $data = file_prepare_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2364 break;
2365 default :
2366 break;
2367 }
2368
64f93798 2369 $data = file_prepare_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
d2b6ee29 2370 return parent::set_data($data);
2371 }
2372
2373 public function get_data() {
2374 $data = parent::get_data();
2375
2376 if (!empty($this->_customdata->submission->id)) {
2377 $itemid = $this->_customdata->submission->id;
2378 } else {
64f93798 2379 $itemid = null; //TODO: this is wrong, itemid MUST be known when saving files!! (skodak)
d2b6ee29 2380 }
2381
2382 if ($data) {
2383 $editoroptions = $this->get_editor_options();
291ee134
AB
2384 switch ($this->_customdata->assignment->assignmenttype) {
2385 case 'upload' :
2386 case 'uploadsingle' :
2387 $data = file_postupdate_standard_filemanager($data, 'files', $editoroptions, $this->_customdata->context, 'mod_assignment', 'response', $itemid);
2388 break;
2389 default :
2390 break;
2391 }
64f93798 2392 $data = file_postupdate_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata->context, $editoroptions['component'], $editoroptions['filearea'], $itemid);
d2b6ee29 2393 }
2394 return $data;
2395 }
2396}
2397
b0f2597e 2398/// OTHER STANDARD FUNCTIONS ////////////////////////////////////////////////////////
2399
7af1e882 2400/**
2401 * Deletes an assignment instance
2402 *
2403 * This is done by calling the delete_instance() method of the assignment type class
2404 */
b0f2597e 2405function assignment_delete_instance($id){
c18269c7 2406 global $CFG, $DB;
26b90e70 2407
c18269c7 2408 if (! $assignment = $DB->get_record('assignment', array('id'=>$id))) {
b0f2597e 2409 return false;
26b90e70 2410 }
2411
1fc87774 2412 // fall back to base class if plugin missing
2413 $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
2414 if (file_exists($classfile)) {
2415 require_once($classfile);
2416 $assignmentclass = "assignment_$assignment->assignmenttype";
2417
2418 } else {
2419 debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead.");
2420 $assignmentclass = "assignment_base";
2421 }
2422
b0f2597e 2423 $ass = new $assignmentclass();
2424 return $ass->delete_instance($assignment);
2425}
f466c9ed 2426
ac21ad39 2427
7af1e882 2428/**
2429 * Updates an assignment instance
2430 *
2431 * This is done by calling the update_instance() method of the assignment type class
2432 */
b0f2597e 2433function assignment_update_instance($assignment){
2434 global $CFG;
26b90e70 2435
200c19fb 2436 $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2437
b0f2597e 2438 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2439 $assignmentclass = "assignment_$assignment->assignmenttype";
2440 $ass = new $assignmentclass();
2441 return $ass->update_instance($assignment);
45fa3412 2442}
26b90e70 2443
26b90e70 2444
7af1e882 2445/**
2446 * Adds an assignment instance
2447 *
2448 * This is done by calling the add_instance() method of the assignment type class
2449 */
b0f2597e 2450function assignment_add_instance($assignment) {
2451 global $CFG;
f466c9ed 2452
200c19fb 2453 $assignment->assignmenttype = clean_param($assignment->assignmenttype, PARAM_SAFEDIR);
2454
b0f2597e 2455 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2456 $assignmentclass = "assignment_$assignment->assignmenttype";
2457 $ass = new $assignmentclass();
2458 return $ass->add_instance($assignment);
2459}
f466c9ed 2460
73097f07 2461
7af1e882 2462/**
2463 * Returns an outline of a user interaction with an assignment
2464 *
2465 * This is done by calling the user_outline() method of the assignment type class
2466 */
73097f07 2467function assignment_user_outline($course, $user, $mod, $assignment) {
2468 global $CFG;
2469
1a96363a 2470 require_once("$CFG->libdir/gradelib.php");
73097f07 2471 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2472 $assignmentclass = "assignment_$assignment->assignmenttype";
2473 $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
1a96363a
NC
2474 $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2475 if (!empty($grades->items[0]->grades)) {
2476 return $ass->user_outline(reset($grades->items[0]->grades));
2477 } else {
2478 return null;
2479 }
73097f07 2480}
2481
7af1e882 2482/**
2483 * Prints the complete info about a user's interaction with an assignment
2484 *
2485 * This is done by calling the user_complete() method of the assignment type class
2486 */
73097f07 2487function assignment_user_complete($course, $user, $mod, $assignment) {
2488 global $CFG;
2489
1a96363a 2490 require_once("$CFG->libdir/gradelib.php");
73097f07 2491 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2492 $assignmentclass = "assignment_$assignment->assignmenttype";
2493 $ass = new $assignmentclass($mod->id, $assignment, $mod, $course);
1a96363a
NC
2494 $grades = grade_get_grades($course->id, 'mod', 'assignment', $assignment->id, $user->id);
2495 if (empty($grades->items[0]->grades)) {
2496 $grade = false;
2497 } else {
2498 $grade = reset($grades->items[0]->grades);
2499 }
2500 return $ass->user_complete($user, $grade);
73097f07 2501}
2502
7af1e882 2503/**
2504 * Function to be run periodically according to the moodle cron
2505 *
2506 * Finds all assignment notifications that have yet to be mailed out, and mails them
2507 */
73097f07 2508function assignment_cron () {
5053f00f 2509 global $CFG, $USER, $DB;
73097f07 2510
d014b69b 2511 /// first execute all crons in plugins
17da2e6f 2512 if ($plugins = get_plugin_list('assignment')) {
2513 foreach ($plugins as $plugin=>$dir) {
2514 require_once("$dir/assignment.class.php");
d014b69b 2515 $assignmentclass = "assignment_$plugin";
2516 $ass = new $assignmentclass();
2517 $ass->cron();
2518 }
2519 }
2520
73097f07 2521 /// Notices older than 1 day will not be mailed. This is to avoid the problem where
2522 /// cron has not been running for a long time, and then suddenly people are flooded
2523 /// with mail from the past few weeks or months
2524
2525 $timenow = time();
2526 $endtime = $timenow - $CFG->maxeditingtime;
2527 $starttime = $endtime - 24 * 3600; /// One day earlier
2528
2529 if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) {
2530
98be6ed8 2531 $realuser = clone($USER);
2532
73097f07 2533 foreach ($submissions as $key => $submission) {
f685e830 2534 $DB->set_field("assignment_submissions", "mailed", "1", array("id"=>$submission->id));
73097f07 2535 }
2536
2537 $timenow = time();
2538
2539 foreach ($submissions as $submission) {
2540
2541 echo "Processing assignment submission $submission->id\n";
2542
5053f00f 2543 if (! $user = $DB->get_record("user", array("id"=>$submission->userid))) {
6b1564a8 2544 echo "Could not find user $user->id\n";
73097f07 2545 continue;
2546 }
2547
5053f00f 2548 if (! $course = $DB->get_record("course", array("id"=>$submission->course))) {
73097f07 2549 echo "Could not find course $submission->course\n";
2550 continue;
2551 }
98be6ed8 2552
2553 /// Override the language and timezone of the "current" user, so that
2554 /// mail is customised for the receiver.
e8b7114d 2555 cron_setup_user($user, $course);
98be6ed8 2556
4f0c2d00 2557 if (!is_enrolled(get_context_instance(CONTEXT_COURSE, $submission->course), $user->id)) {
6ba65fa0 2558 echo fullname($user)." not an active participant in " . format_string($course->shortname) . "\n";
73097f07 2559 continue;
2560 }
2561
5053f00f 2562 if (! $teacher = $DB->get_record("user", array("id"=>$submission->teacher))) {
73097f07 2563 echo "Could not find teacher $submission->teacher\n";
2564 continue;
2565 }
2566
2567 if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment, $course->id)) {
2568 echo "Could not find course module for assignment id $submission->assignment\n";
2569 continue;
2570 }
2571
2572 if (! $mod->visible) { /// Hold mail notification for hidden assignments until later
2573 continue;
2574 }
2575
2576 $strassignments = get_string("modulenameplural", "assignment");
2577 $strassignment = get_string("modulename", "assignment");
2578
39790bd8 2579 $assignmentinfo = new stdClass();
73097f07 2580 $assignmentinfo->teacher = fullname($teacher);
2581 $assignmentinfo->assignment = format_string($submission->name,true);
2582 $assignmentinfo->url = "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id";
2583
2584 $postsubject = "$course->shortname: $strassignments: ".format_string($submission->name,true);
2585 $posttext = "$course->shortname -> $strassignments -> ".format_string($submission->name,true)."\n";
2586 $posttext .= "---------------------------------------------------------------------\n";
3f19bff3 2587 $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n";
73097f07 2588 $posttext .= "---------------------------------------------------------------------\n";
2589
2590 if ($user->mailformat == 1) { // HTML
2591 $posthtml = "<p><font face=\"sans-serif\">".
2592 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> ->".
2593 "<a href=\"$CFG->wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments</a> ->".
2594 "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name,true)."</a></font></p>";
2595 $posthtml .= "<hr /><font face=\"sans-serif\">";
2596 $posthtml .= "<p>".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."</p>";
2597 $posthtml .= "</font><hr />";
2598 } else {
2599 $posthtml = "";
2600 }
2601
39790bd8 2602 $eventdata = new stdClass();
3b120e46 2603 $eventdata->modulename = 'assignment';
2604 $eventdata->userfrom = $teacher;
2605 $eventdata->userto = $user;
2606 $eventdata->subject = $postsubject;
2607 $eventdata->fullmessage = $posttext;
2608 $eventdata->fullmessageformat = FORMAT_PLAIN;
2609 $eventdata->fullmessagehtml = $posthtml;
2610 $eventdata->smallmessage = '';
7c7d3afa 2611 message_send($eventdata);
73097f07 2612 }
98be6ed8 2613
e8b7114d 2614 cron_setup_user();
73097f07 2615 }
2616
2617 return true;
2618}
2619
45fa3412 2620/**
2621 * Return grade for given user or all users.
2622 *
2623 * @param int $assignmentid id of assignment
2624 * @param int $userid optional user id, 0 means all users
2625 * @return array array of grades, false if none
2626 */
612607bd 2627function assignment_get_user_grades($assignment, $userid=0) {
5053f00f 2628 global $CFG, $DB;
45fa3412 2629
5053f00f 2630 if ($userid) {
2631 $user = "AND u.id = :userid";
2632 $params = array('userid'=>$userid);
2633 } else {
2634 $user = "";
2635 }
2636 $params['aid'] = $assignment->id;
45fa3412 2637
ced5ee59 2638 $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat,
2639 s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted
5053f00f 2640 FROM {user} u, {assignment_submissions} s
2641 WHERE u.id = s.userid AND s.assignment = :aid
4a1be95c 2642 $user";
45fa3412 2643
5053f00f 2644 return $DB->get_records_sql($sql, $params);
45fa3412 2645}
2646
2647/**
775f811a 2648 * Update activity grades
45fa3412 2649 *
775f811a 2650 * @param object $assignment
2651 * @param int $userid specific user only, 0 means all
45fa3412 2652 */
775f811a 2653function assignment_update_grades($assignment, $userid=0, $nullifnone=true) {
5053f00f 2654 global $CFG, $DB;
2655 require_once($CFG->libdir.'/gradelib.php');
45fa3412 2656
775f811a 2657 if ($assignment->grade == 0) {
2658 assignment_grade_item_update($assignment);
2659
2660 } else if ($grades = assignment_get_user_grades($assignment, $userid)) {
2661 foreach($grades as $k=>$v) {
2662 if ($v->rawgrade == -1) {
2663 $grades[$k]->rawgrade = null;
45fa3412 2664 }
2665 }
775f811a 2666 assignment_grade_item_update($assignment, $grades);
45fa3412 2667
2668 } else {
775f811a 2669 assignment_grade_item_update($assignment);
2670 }
2671}
2672
2673/**
2674 * Update all grades in gradebook.
2675 */
2676function assignment_upgrade_grades() {
2677 global $DB;
2678
2679 $sql = "SELECT COUNT('x')
2680 FROM {assignment} a, {course_modules} cm, {modules} m
2681 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2682 $count = $DB->count_records_sql($sql);
2683
2684 $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
2685 FROM {assignment} a, {course_modules} cm, {modules} m
2686 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2687 if ($rs = $DB->get_recordset_sql($sql)) {
2688 // too much debug output
775f811a 2689 $pbar = new progress_bar('assignmentupgradegrades', 500, true);
2690 $i=0;
2691 foreach ($rs as $assignment) {
2692 $i++;
2693 upgrade_set_timeout(60*5); // set up timeout, may also abort execution
2694 assignment_update_grades($assignment);
2695 $pbar->update($i, $count, "Updating Assignment grades ($i/$count).");
2696 }
775f811a 2697 $rs->close();
2698 upgrade_set_timeout(); // reset to default timeout
45fa3412 2699 }
2700}
2701
2702/**
612607bd 2703 * Create grade item for given assignment
45fa3412 2704 *
8b4fb44e 2705 * @param object $assignment object with extra cmidnumber
0b5a80a1 2706 * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
612607bd 2707 * @return int 0 if ok, error code otherwise
45fa3412 2708 */
ced5ee59 2709function assignment_grade_item_update($assignment, $grades=NULL) {
612607bd 2710 global $CFG;
5053f00f 2711 require_once($CFG->libdir.'/gradelib.php');
45fa3412 2712
8b4fb44e 2713 if (!isset($assignment->courseid)) {
2714 $assignment->courseid = $assignment->course;
2715 }
2716
612607bd 2717 $params = array('itemname'=>$assignment->name, 'idnumber'=>$assignment->cmidnumber);
45fa3412 2718
2719 if ($assignment->grade > 0) {
2720 $params['gradetype'] = GRADE_TYPE_VALUE;
2721 $params['grademax'] = $assignment->grade;
2722 $params['grademin'] = 0;
2723
2724 } else if ($assignment->grade < 0) {
2725 $params['gradetype'] = GRADE_TYPE_SCALE;
2726 $params['scaleid'] = -$assignment->grade;
2727
2728 } else {
5048575d 2729 $params['gradetype'] = GRADE_TYPE_TEXT; // allow text comments only
45fa3412 2730 }
2731
0b5a80a1 2732 if ($grades === 'reset') {
2733 $params['reset'] = true;
2734 $grades = NULL;
2735 }
2736
ced5ee59 2737 return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, $grades, $params);
45fa3412 2738}
2739
2740/**
2741 * Delete grade item for given assignment
2742 *
8b4fb44e 2743 * @param object $assignment object
612607bd 2744 * @return object assignment
45fa3412 2745 */
2746function assignment_grade_item_delete($assignment) {
612607bd 2747 global $CFG;
2748 require_once($CFG->libdir.'/gradelib.php');
2749
8b4fb44e 2750 if (!isset($assignment->courseid)) {
2751 $assignment->courseid = $assignment->course;
2752 }
2753
b67ec72f 2754 return grade_update('mod/assignment', $assignment->courseid, 'mod', 'assignment', $assignment->id, 0, NULL, array('deleted'=>1));
45fa3412 2755}
2756
7af1e882 2757/**
2758 * Returns the users with data in one assignment (students and teachers)
2759 *
2760 * @param $assignmentid int
2761 * @return array of user objects
2762 */
73097f07 2763function assignment_get_participants($assignmentid) {
5053f00f 2764 global $CFG, $DB;
73097f07 2765
2766 //Get students
5053f00f 2767 $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2768 FROM {user} u,
2769 {assignment_submissions} a
2770 WHERE a.assignment = ? and
2771 u.id = a.userid", array($assignmentid));
73097f07 2772 //Get teachers
5053f00f 2773 $teachers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
2774 FROM {user} u,
2775 {assignment_submissions} a
2776 WHERE a.assignment = ? and
2777 u.id = a.teacher", array($assignmentid));
73097f07 2778
2779 //Add teachers to students
2780 if ($teachers) {
2781 foreach ($teachers as $teacher) {
2782 $students[$teacher->id] = $teacher;
2783 }
2784 }
2785 //Return students array (it contains an array of unique users)
2786 return ($students);
2787}
2788
005a41a3 2789/**
64f93798 2790 * Serves assignment submissions and other files.
005a41a3
MH
2791 *
2792 * @param object $course
64f93798 2793 * @param object $cm
005a41a3
MH
2794 * @param object $context
2795 * @param string $filearea
2796 * @param array $args
2797 * @param bool $forcedownload
64f93798 2798 * @return bool false if file not found, does not return if found - just send the file
005a41a3 2799 */
64f93798 2800function assignment_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
172dd12c 2801 global $CFG, $DB;
e7521559 2802
64f93798 2803 if ($context->contextlevel != CONTEXT_MODULE) {
172dd12c 2804 return false;
2805 }
2806
0a8a7b6c 2807 require_login($course, false, $cm);
2808
64f93798
PS
2809 if (!$assignment = $DB->get_record('assignment', array('id'=>$cm->instance))) {
2810 return false;
2811 }
2812
172dd12c 2813 require_once($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
2814 $assignmentclass = 'assignment_'.$assignment->assignmenttype;
2815 $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm, $course);
2816
2817 return $assignmentinstance->send_file($filearea, $args);
2818}
7af1e882 2819/**
2820 * Checks if a scale is being used by an assignment
2821 *
2822 * This is used by the backup code to decide whether to back up a scale
2823 * @param $assignmentid int
2824 * @param $scaleid int
2825 * @return boolean True if the scale is used by the assignment
2826 */
85c9ebb9 2827function assignment_scale_used($assignmentid, $scaleid) {
5053f00f 2828 global $DB;
73097f07 2829
2830 $return = false;
2831
5053f00f 2832 $rec = $DB->get_record('assignment', array('id'=>$assignmentid,'grade'=>-$scaleid));
73097f07 2833
2834 if (!empty($rec) && !empty($scaleid)) {
2835 $return = true;
2836 }
2837
2838 return $return;
2839}
2840
85c9ebb9 2841/**
2842 * Checks if scale is being used by any instance of assignment
2843 *
2844 * This is used to find out if scale used anywhere
2845 * @param $scaleid int
2846 * @return boolean True if the scale is used by any assignment
2847 */
2848function assignment_scale_used_anywhere($scaleid) {
5053f00f 2849 global $DB;
2850
2851 if ($scaleid and $DB->record_exists('assignment', array('grade'=>-$scaleid))) {
85c9ebb9 2852 return true;
2853 } else {
2854 return false;
2855 }
2856}
2857
7af1e882 2858/**
2859 * Make sure up-to-date events are created for all assignment instances
2860 *
2861 * This standard function will check all instances of this module
2862 * and make sure there are up-to-date events created for each of them.
2863 * If courseid = 0, then every assignment event in the site is checked, else
2864 * only assignment events belonging to the course specified are checked.
2865 * This function is used, in its new format, by restore_refresh_events()
2866 *
2867 * @param $courseid int optional If zero then all assignments for all courses are covered
2868 * @return boolean Always returns true
2869 */
73097f07 2870function assignment_refresh_events($courseid = 0) {
5053f00f 2871 global $DB;
73097f07 2872
2873 if ($courseid == 0) {
5053f00f 2874 if (! $assignments = $DB->get_records("assignment")) {
73097f07 2875 return true;
2876 }
2877 } else {
5053f00f 2878 if (! $assignments = $DB->get_records("assignment", array("course"=>$courseid))) {
73097f07 2879 return true;
2880 }
2881 }
5053f00f 2882 $moduleid = $DB->get_field('modules', 'id', array('name'=>'assignment'));
73097f07 2883
2884 foreach ($assignments as $assignment) {
dc5c2bd9 2885 $cm = get_coursemodule_from_id('assignment', $assignment->id);
39790bd8 2886 $event = new stdClass();
5053f00f 2887 $event->name = $assignment->name;
dc5c2bd9 2888 $event->description = format_module_intro('assignment', $assignment, $cm->id);
73097f07 2889 $event->timestart = $assignment->timedue;
2890
5053f00f 2891 if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id))) {
73097f07 2892 update_event($event);
2893
2894 } else {
2895 $event->courseid = $assignment->course;
2896 $event->groupid = 0;
2897 $event->userid = 0;
2898 $event->modulename = 'assignment';
2899 $event->instance = $assignment->id;
2900 $event->eventtype = 'due';
2901 $event->timeduration = 0;
5053f00f 2902 $event->visible = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$assignment->id));
73097f07 2903 add_event($event);
2904 }
2905
2906 }
2907 return true;
2908}
2909
7af1e882 2910/**
2911 * Print recent activity from all assignments in a given course
2912 *
2913 * This is used by the recent activity block
2914 */
dd97c328 2915function assignment_print_recent_activity($course, $viewfullnames, $timestart) {
8af46c3b 2916 global $CFG, $USER, $DB, $OUTPUT;
73097f07 2917
dd97c328 2918 // do not use log table if possible, it may be huge
73097f07 2919
74d7d735 2920 if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified, cm.id AS cmid, asb.userid,
2921 u.firstname, u.lastname, u.email, u.picture
2922 FROM {assignment_submissions} asb
2923 JOIN {assignment} a ON a.id = asb.assignment
2924 JOIN {course_modules} cm ON cm.instance = a.id
2925 JOIN {modules} md ON md.id = cm.module
2926 JOIN {user} u ON u.id = asb.userid
2927 WHERE asb.timemodified > ? AND
2928 a.course = ? AND
2929 md.name = 'assignment'
2930 ORDER BY asb.timemodified ASC", array($timestart, $course->id))) {
dd97c328 2931 return false;
73097f07 2932 }
2933
dd97c328 2934 $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups
2935 $show = array();
2936 $grader = array();
2937
2938 foreach($submissions as $submission) {
2939 if (!array_key_exists($submission->cmid, $modinfo->cms)) {
2940 continue;
2941 }
2942 $cm = $modinfo->cms[$submission->cmid];
2943 if (!$cm->uservisible) {
2944 continue;
2945 }
2946 if ($submission->userid == $USER->id) {
2947 $show[] = $submission;
2948 continue;
2949 }
2950
1160eb5a 2951 // the act of sumbitting of assignment may be considered private - only graders will see it if specified
dd97c328 2952 if (empty($CFG->assignment_showrecentsubmissions)) {
2953 if (!array_key_exists($cm->id, $grader)) {
2954 $grader[$cm->id] = has_capability('moodle/grade:viewall', get_context_instance(CONTEXT_MODULE, $cm->id));
2955 }
2956 if (!$grader[$cm->id]) {
2957 continue;
70b5660a 2958 }
73097f07 2959 }
73097f07 2960
dd97c328 2961 $groupmode = groups_get_activity_groupmode($cm, $course);
2962
2963 if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2964 if (isguestuser()) {
2965 // shortcut - guest user does not belong into any group
2966 continue;
2967 }
2968
2969 if (is_null($modinfo->groups)) {
2970 $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
2971 }
2972
2973 // this will be slow - show only users that share group with me in this cm
2974 if (empty($modinfo->groups[$cm->id])) {
2975 continue;
2976 }
09d35ae3 2977 $usersgroups = groups_get_all_groups($course->id, $submission->userid, $cm->groupingid);
dd97c328 2978 if (is_array($usersgroups)) {
2979 $usersgroups = array_keys($usersgroups);
09d35ae3 2980 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
dd97c328 2981 if (empty($intersect)) {
2982 continue;
2983 }
2984 }
73097f07 2985 }
dd97c328 2986 $show[] = $submission;
73097f07 2987 }
2988
dd97c328 2989 if (empty($show)) {
2990 return false;
2991 }
2992
09d35ae3 2993 echo $OUTPUT->heading(get_string('newsubmissions', 'assignment').':', 3);
dd97c328 2994
2995 foreach ($show as $submission) {
2996 $cm = $modinfo->cms[$submission->cmid];
2997 $link = $CFG->wwwroot.'/mod/assignment/view.php?id='.$cm->id;
2998 print_recent_activity_note($submission->timemodified, $submission, $cm->name, $link, false, $viewfullnames);
2999 }
3000
3001 return true;
73097f07 3002}
3003
3004
7af1e882 3005/**
dd97c328 3006 * Returns all assignments since a given time in specified forum.
7af1e882 3007 */
dd97c328 3008function assignment_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0) {
5053f00f 3009 global $CFG, $COURSE, $USER, $DB;
73097f07 3010
dd97c328 3011 if ($COURSE->id == $courseid) {
3012 $course = $COURSE;
73097f07 3013 } else {
5053f00f 3014 $course = $DB->get_record('course', array('id'=>$courseid));
73097f07 3015 }
dd97c328 3016
3017 $modinfo =& get_fast_modinfo($course);
3018
3019 $cm = $modinfo->cms[$cmid];
3020
5053f00f 3021 $params = array();
dd97c328 3022 if ($userid) {
5053f00f 3023 $userselect = "AND u.id = :userid";
3024 $params['userid'] = $userid;
73097f07 3025 } else {
3026 $userselect = "";
3027 }
3028
dd97c328 3029 if ($groupid) {
5053f00f 3030 $groupselect = "AND gm.groupid = :groupid";
3031 $groupjoin = "JOIN {groups_members} gm ON gm.userid=u.id";
3032 $params['groupid'] = $groupid;
dd97c328 3033 } else {
3034 $groupselect = "";
3035 $groupjoin = "";
3036 }
73097f07 3037
5053f00f 3038 $params['cminstance'] = $cm->instance;
3039 $params['timestart'] = $timestart;
3040
bf1da11a
DM
3041 $userfields = user_picture::fields('u', null, 'userid');
3042
3043 if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified,
3044