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