3 // This file is part of Moodle - http://moodle.org/
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
19 * assignment_base is the base class for assignment types
21 * This class provides all the functionality for an assignment
23 * @package mod-assignment
24 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 /** Include eventslib.php */
29 require_once($CFG->libdir
.'/eventslib.php');
30 /** Include formslib.php */
31 require_once($CFG->libdir
.'/formslib.php');
32 /** Include calendar/lib.php */
33 require_once($CFG->dirroot
.'/calendar/lib.php');
35 /** ASSIGNMENT_COUNT_WORDS = 1 */
36 define('ASSIGNMENT_COUNT_WORDS', 1);
37 /** ASSIGNMENT_COUNT_LETTERS = 2 */
38 define('ASSIGNMENT_COUNT_LETTERS', 2);
41 * Standard base class for all assignment submodules (assignment types).
43 * @package mod-assignment
44 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
45 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47 class assignment_base
{
50 const FILTER_SUBMITTED
= 1;
51 const FILTER_REQUIRE_GRADING
= 2;
74 * @todo document this var
78 * @todo document this var
85 * Constructor for the base assignment class
87 * Constructor for the base assignment class.
88 * If cmid is set create the cm, course, assignment objects.
89 * If the assignment is hidden and the user is not a teacher then
90 * this prints a page header and notice.
94 * @param int $cmid the current course module id - not set for new assignments
95 * @param object $assignment usually null, but if we have it we pass it to save db access
96 * @param object $cm usually null, but if we have it we pass it to save db access
97 * @param object $course usually null, but if we have it we pass it to save db access
99 function assignment_base($cmid='staticonly', $assignment=NULL, $cm=NULL, $course=NULL) {
102 if ($cmid == 'staticonly') {
103 //use static functions only!
111 } else if (! $this->cm
= get_coursemodule_from_id('assignment', $cmid)) {
112 print_error('invalidcoursemodule');
115 $this->context
= get_context_instance(CONTEXT_MODULE
, $this->cm
->id
);
118 $this->course
= $course;
119 } else if ($this->cm
->course
== $COURSE->id
) {
120 $this->course
= $COURSE;
121 } else if (! $this->course
= $DB->get_record('course', array('id'=>$this->cm
->course
))) {
122 print_error('invalidid', 'assignment');
124 $this->coursecontext
= get_context_instance(CONTEXT_COURSE
, $this->course
->id
);
125 $courseshortname = format_text($this->course
->shortname
, true, array('context' => $this->coursecontext
));
128 $this->assignment
= $assignment;
129 } else if (! $this->assignment
= $DB->get_record('assignment', array('id'=>$this->cm
->instance
))) {
130 print_error('invalidid', 'assignment');
133 $this->assignment
->cmidnumber
= $this->cm
->idnumber
; // compatibility with modedit assignment obj
134 $this->assignment
->courseid
= $this->course
->id
; // compatibility with modedit assignment obj
136 $this->strassignment
= get_string('modulename', 'assignment');
137 $this->strassignments
= get_string('modulenameplural', 'assignment');
138 $this->strsubmissions
= get_string('submissions', 'assignment');
139 $this->strlastmodified
= get_string('lastmodified');
140 $this->pagetitle
= strip_tags($courseshortname.': '.$this->strassignment
.': '.format_string($this->assignment
->name
, true, array('context' => $this->context
)));
142 // visibility handled by require_login() with $cm parameter
143 // get current group only when really needed
145 /// Set up things for a HTML editor if it's needed
146 $this->defaultformat
= editors_get_preferred_format();
150 * Display the assignment, used by view.php
152 * This in turn calls the methods producing individual parts of the page
156 $context = get_context_instance(CONTEXT_MODULE
,$this->cm
->id
);
157 require_capability('mod/assignment:view', $context);
159 add_to_log($this->course
->id
, "assignment", "view", "view.php?id={$this->cm->id}",
160 $this->assignment
->id
, $this->cm
->id
);
162 $this->view_header();
168 $this->view_feedback();
170 $this->view_footer();
174 * Display the header and top of a page
176 * (this doesn't change much for assignment types)
177 * This is used by the view() method to print the header of view.php but
178 * it can be used on other pages in which case the string to denote the
179 * page in the navigation trail should be passed as an argument
182 * @param string $subpage Description of subpage to be used in navigation trail
184 function view_header($subpage='') {
185 global $CFG, $PAGE, $OUTPUT;
188 $PAGE->navbar
->add($subpage);
191 $PAGE->set_title($this->pagetitle
);
192 $PAGE->set_heading($this->course
->fullname
);
194 echo $OUTPUT->header();
196 groups_print_activity_menu($this->cm
, $CFG->wwwroot
. '/mod/assignment/view.php?id=' . $this->cm
->id
);
198 echo '<div class="reportlink">'.$this->submittedlink().'</div>';
199 echo '<div class="clearer"></div>';
204 * Display the assignment intro
206 * This will most likely be extended by assignment type plug-ins
207 * The default implementation prints the assignment description in a box
209 function view_intro() {
211 echo $OUTPUT->box_start('generalbox boxaligncenter', 'intro');
212 echo format_module_intro('assignment', $this->assignment
, $this->cm
->id
);
213 echo $OUTPUT->box_end();
214 plagiarism_print_disclosure($this->cm
->id
);
218 * Display the assignment dates
220 * Prints the assignment start and end dates in a box.
221 * This will be suitable for most assignment types
223 function view_dates() {
225 if (!$this->assignment
->timeavailable
&& !$this->assignment
->timedue
) {
229 echo $OUTPUT->box_start('generalbox boxaligncenter', 'dates');
231 if ($this->assignment
->timeavailable
) {
232 echo '<tr><td class="c0">'.get_string('availabledate','assignment').':</td>';
233 echo ' <td class="c1">'.userdate($this->assignment
->timeavailable
).'</td></tr>';
235 if ($this->assignment
->timedue
) {
236 echo '<tr><td class="c0">'.get_string('duedate','assignment').':</td>';
237 echo ' <td class="c1">'.userdate($this->assignment
->timedue
).'</td></tr>';
240 echo $OUTPUT->box_end();
245 * Display the bottom and footer of a page
247 * This default method just prints the footer.
248 * This will be suitable for most assignment types
250 function view_footer() {
252 echo $OUTPUT->footer();
256 * Display the feedback to the student
258 * This default method prints the teacher picture and name, date when marked,
259 * grade and teacher submissioncomment.
260 * If advanced grading is used the method render_grade from the
261 * advanced grading controller is called to display the grade.
266 * @param object $submission The submission object or NULL in which case it will be loaded
268 function view_feedback($submission=NULL) {
269 global $USER, $CFG, $DB, $OUTPUT, $PAGE;
270 require_once($CFG->libdir
.'/gradelib.php');
271 require_once("$CFG->dirroot/grade/grading/lib.php");
273 if (!$submission) { /// Get submission for this assignment
275 $submission = $this->get_submission($userid);
277 $userid = $submission->userid
;
279 // Check the user can submit
280 $canviewfeedback = ($userid == $USER->id
&& has_capability('mod/assignment:submit', $this->context
, $USER->id
, false));
281 // If not then check if the user still has the view cap and has a previous submission
282 $canviewfeedback = $canviewfeedback ||
(!empty($submission) && $submission->userid
== $USER->id
&& has_capability('mod/assignment:view', $this->context
));
283 // Or if user can grade (is a teacher or admin)
284 $canviewfeedback = $canviewfeedback ||
has_capability('mod/assignment:grade', $this->context
);
286 if (!$canviewfeedback) {
287 // can not view or submit assignments -> no feedback
291 $grading_info = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, $userid);
292 $item = $grading_info->items
[0];
293 $grade = $item->grades
[$userid];
295 if ($grade->hidden
or $grade->grade
=== false) { // hidden or error
299 if ($grade->grade
=== null and empty($grade->str_feedback
)) { /// Nothing to show yet
303 $graded_date = $grade->dategraded
;
304 $graded_by = $grade->usermodified
;
306 /// We need the teacher info
307 if (!$teacher = $DB->get_record('user', array('id'=>$graded_by))) {
308 print_error('cannotfindteacher');
311 /// Print the feedback
312 echo $OUTPUT->heading(get_string('feedbackfromteacher', 'assignment', fullname($teacher)));
314 echo '<table cellspacing="0" class="feedback">';
317 echo '<td class="left picture">';
319 echo $OUTPUT->user_picture($teacher);
322 echo '<td class="topic">';
323 echo '<div class="from">';
325 echo '<div class="fullname">'.fullname($teacher).'</div>';
327 echo '<div class="time">'.userdate($graded_date).'</div>';
333 echo '<td class="left side"> </td>';
334 echo '<td class="content">';
335 $gradestr = '<div class="grade">'. get_string("grade").': '.$grade->str_long_grade
. '</div>';
336 if (!empty($submission) && $controller = get_grading_manager($this->context
, 'mod_assignment', 'submission')->get_active_controller()) {
337 $controller->set_grade_range(make_grades_menu($this->assignment
->grade
));
338 echo $controller->render_grade($PAGE, $submission->id
, $item, $gradestr, has_capability('mod/assignment:grade', $this->context
));
342 echo '<div class="clearer"></div>';
344 echo '<div class="comment">';
345 echo $grade->str_feedback
;
349 if ($this->type
== 'uploadsingle') { //@TODO: move to overload view_feedback method in the class or is uploadsingle merging into upload?
350 $responsefiles = $this->print_responsefiles($submission->userid
, true);
351 if (!empty($responsefiles)) {
353 echo '<td class="left side"> </td>';
354 echo '<td class="content">';
364 * Returns a link with info about the state of the assignment submissions
366 * This is used by view_header to put this link at the top right of the page.
367 * For teachers it gives the number of submitted assignments with a link
368 * For students it gives the time of their submission.
369 * This will be suitable for most assignment types.
373 * @param bool $allgroup print all groups info if user can access all groups, suitable for index.php
376 function submittedlink($allgroups=false) {
381 $urlbase = "{$CFG->wwwroot}/mod/assignment/";
383 $context = get_context_instance(CONTEXT_MODULE
,$this->cm
->id
);
384 if (has_capability('mod/assignment:grade', $context)) {
385 if ($allgroups and has_capability('moodle/site:accessallgroups', $context)) {
388 $group = groups_get_activity_group($this->cm
);
390 if ($this->type
== 'offline') {
391 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm
->id
.'">'.
392 get_string('viewfeedback', 'assignment').'</a>';
393 } else if ($count = $this->count_real_submissions($group)) {
394 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm
->id
.'">'.
395 get_string('viewsubmissions', 'assignment', $count).'</a>';
397 $submitted = '<a href="'.$urlbase.'submissions.php?id='.$this->cm
->id
.'">'.
398 get_string('noattempts', 'assignment').'</a>';
402 if ($submission = $this->get_submission($USER->id
)) {
403 if ($submission->timemodified
) {
404 if ($submission->timemodified
<= $this->assignment
->timedue ||
empty($this->assignment
->timedue
)) {
405 $submitted = '<span class="early">'.userdate($submission->timemodified
).'</span>';
407 $submitted = '<span class="late">'.userdate($submission->timemodified
).'</span>';
419 * @todo Document this function
421 function setup_elements(&$mform) {
426 * Any preprocessing needed for the settings form for
427 * this assignment type
429 * @param array $default_values - array to fill in with the default values
430 * in the form 'formelement' => 'value'
431 * @param object $form - the form that is to be displayed
434 function form_data_preprocessing(&$default_values, $form) {
438 * Any extra validation checks needed for the settings
439 * form for this assignment type
441 * See lib/formslib.php, 'validation' function for details
443 function form_validation($data, $files) {
448 * Create a new assignment activity
450 * Given an object containing all the necessary data,
451 * (defined by the form in mod_form.php) this function
452 * will create a new instance and return the id number
453 * of the new instance.
454 * The due data is added to the calendar
455 * This is common to all assignment types.
459 * @param object $assignment The data from the form on mod_form.php
460 * @return int The id of the assignment
462 function add_instance($assignment) {
465 $assignment->timemodified
= time();
466 $assignment->courseid
= $assignment->course
;
468 $returnid = $DB->insert_record("assignment", $assignment);
469 $assignment->id
= $returnid;
471 if ($assignment->timedue
) {
472 $event = new stdClass();
473 $event->name
= $assignment->name
;
474 $event->description
= format_module_intro('assignment', $assignment, $assignment->coursemodule
);
475 $event->courseid
= $assignment->course
;
478 $event->modulename
= 'assignment';
479 $event->instance
= $returnid;
480 $event->eventtype
= 'due';
481 $event->timestart
= $assignment->timedue
;
482 $event->timeduration
= 0;
484 calendar_event
::create($event);
487 assignment_grade_item_update($assignment);
493 * Deletes an assignment activity
495 * Deletes all database records, files and calendar events for this assignment.
499 * @param object $assignment The assignment to be deleted
500 * @return boolean False indicates error
502 function delete_instance($assignment) {
505 $assignment->courseid
= $assignment->course
;
509 // now get rid of all files
510 $fs = get_file_storage();
511 if ($cm = get_coursemodule_from_instance('assignment', $assignment->id
)) {
512 $context = get_context_instance(CONTEXT_MODULE
, $cm->id
);
513 $fs->delete_area_files($context->id
);
516 if (! $DB->delete_records('assignment_submissions', array('assignment'=>$assignment->id
))) {
520 if (! $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id
))) {
524 if (! $DB->delete_records('assignment', array('id'=>$assignment->id
))) {
527 $mod = $DB->get_field('modules','id',array('name'=>'assignment'));
529 assignment_grade_item_delete($assignment);
535 * Updates a new assignment activity
537 * Given an object containing all the necessary data,
538 * (defined by the form in mod_form.php) this function
539 * will update the assignment instance and return the id number
540 * The due date is updated in the calendar
541 * This is common to all assignment types.
545 * @param object $assignment The data from the form on mod_form.php
546 * @return bool success
548 function update_instance($assignment) {
551 $assignment->timemodified
= time();
553 $assignment->id
= $assignment->instance
;
554 $assignment->courseid
= $assignment->course
;
556 $DB->update_record('assignment', $assignment);
558 if ($assignment->timedue
) {
559 $event = new stdClass();
561 if ($event->id
= $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id
))) {
563 $event->name
= $assignment->name
;
564 $event->description
= format_module_intro('assignment', $assignment, $assignment->coursemodule
);
565 $event->timestart
= $assignment->timedue
;
567 $calendarevent = calendar_event
::load($event->id
);
568 $calendarevent->update($event);
570 $event = new stdClass();
571 $event->name
= $assignment->name
;
572 $event->description
= format_module_intro('assignment', $assignment, $assignment->coursemodule
);
573 $event->courseid
= $assignment->course
;
576 $event->modulename
= 'assignment';
577 $event->instance
= $assignment->id
;
578 $event->eventtype
= 'due';
579 $event->timestart
= $assignment->timedue
;
580 $event->timeduration
= 0;
582 calendar_event
::create($event);
585 $DB->delete_records('event', array('modulename'=>'assignment', 'instance'=>$assignment->id
));
588 // get existing grade item
589 assignment_grade_item_update($assignment);
595 * Update grade item for this submission.
597 function update_grade($submission) {
598 assignment_update_grades($this->assignment
, $submission->userid
);
602 * Top-level function for handling of submissions called by submissions.php
604 * This is for handling the teacher interaction with the grading interface
605 * This should be suitable for most assignment types.
608 * @param string $mode Specifies the kind of teacher interaction taking place
610 function submissions($mode) {
611 ///The main switch is changed to facilitate
612 ///1) Batch fast grading
613 ///2) Skip to the next one on the popup
614 ///3) Save and Skip to the next one on the popup
616 //make user global so we can use the id
617 global $USER, $OUTPUT, $DB, $PAGE;
619 $mailinfo = optional_param('mailinfo', null, PARAM_BOOL
);
621 if (optional_param('next', null, PARAM_BOOL
)) {
624 if (optional_param('saveandnext', null, PARAM_BOOL
)) {
628 if (is_null($mailinfo)) {
629 if (optional_param('sesskey', null, PARAM_BOOL
)) {
630 set_user_preference('assignment_mailinfo', 0);
632 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
635 set_user_preference('assignment_mailinfo', $mailinfo);
638 if (!($this->validate_and_preprocess_feedback())) {
639 // form was submitted ('Save' or 'Save and next' was pressed, but validation failed)
640 $this->display_submission();
645 case 'grade': // We are in a main window grading
646 if ($submission = $this->process_feedback()) {
647 $this->display_submissions(get_string('changessaved'));
649 $this->display_submissions();
653 case 'single': // We are in a main window displaying one submission
654 if ($submission = $this->process_feedback()) {
655 $this->display_submissions(get_string('changessaved'));
657 $this->display_submission();
661 case 'all': // Main window, display everything
662 $this->display_submissions();
666 ///do the fast grading stuff - this process should work for all 3 subclasses
670 if (isset($_POST['submissioncomment'])) {
671 $col = 'submissioncomment';
674 if (isset($_POST['menu'])) {
679 //both submissioncomment and grade columns collapsed..
680 $this->display_submissions();
684 foreach ($_POST[$col] as $id => $unusedvalue){
686 $id = (int)$id; //clean parameter name
688 $this->process_outcomes($id);
690 if (!$submission = $this->get_submission($id)) {
691 $submission = $this->prepare_new_submission($id);
692 $newsubmission = true;
694 $newsubmission = false;
696 unset($submission->data1
); // Don't need to update this.
697 unset($submission->data2
); // Don't need to update this.
699 //for fast grade, we need to check if any changes take place
703 $grade = $_POST['menu'][$id];
704 $updatedb = $updatedb ||
($submission->grade
!= $grade);
705 $submission->grade
= $grade;
707 if (!$newsubmission) {
708 unset($submission->grade
); // Don't need to update this.
712 $commentvalue = trim($_POST['submissioncomment'][$id]);
713 $updatedb = $updatedb ||
($submission->submissioncomment
!= $commentvalue);
714 $submission->submissioncomment
= $commentvalue;
716 unset($submission->submissioncomment
); // Don't need to update this.
719 $submission->teacher
= $USER->id
;
721 $submission->mailed
= (int)(!$mailinfo);
724 $submission->timemarked
= time();
726 //if it is not an update, we don't change the last modified time etc.
727 //this will also not write into database if no submissioncomment and grade is entered.
730 if ($newsubmission) {
731 if (!isset($submission->submissioncomment
)) {
732 $submission->submissioncomment
= '';
734 $sid = $DB->insert_record('assignment_submissions', $submission);
735 $submission->id
= $sid;
737 $DB->update_record('assignment_submissions', $submission);
740 // trigger grade event
741 $this->update_grade($submission);
743 //add to log only if updating
744 add_to_log($this->course
->id
, 'assignment', 'update grades',
745 'submissions.php?id='.$this->cm
->id
.'&user='.$submission->userid
,
746 $submission->userid
, $this->cm
->id
);
751 $message = $OUTPUT->notification(get_string('changessaved'), 'notifysuccess');
753 $this->display_submissions($message);
758 ///We are in pop up. save the current one and go to the next one.
759 //first we save the current changes
760 if ($submission = $this->process_feedback()) {
761 //print_heading(get_string('changessaved'));
762 //$extra_javascript = $this->update_main_listing($submission);
766 /// We are currently in pop up, but we want to skip to next one without saving.
767 /// This turns out to be similar to a single case
768 /// The URL used is for the next submission.
769 $offset = required_param('offset', PARAM_INT
);
770 $nextid = required_param('nextid', PARAM_INT
);
771 $id = required_param('id', PARAM_INT
);
772 $filter = optional_param('filter', self
::FILTER_ALL
, PARAM_INT
);
774 if ($mode == 'next' ||
$filter !== self
::FILTER_REQUIRE_GRADING
) {
775 $offset = (int)$offset+
1;
777 $redirect = new moodle_url('submissions.php',
778 array('id' => $id, 'offset' => $offset, 'userid' => $nextid,
779 'mode' => 'single', 'filter' => $filter));
785 $this->display_submission();
789 echo "something seriously is wrong!!";
795 * Checks if grading method allows quickgrade mode. At the moment it is hardcoded
796 * that advanced grading methods do not allow quickgrade.
798 * Assignment type plugins are not allowed to override this method
802 public final function quickgrade_mode_allowed() {
804 require_once("$CFG->dirroot/grade/grading/lib.php");
805 if ($controller = get_grading_manager($this->context
, 'mod_assignment', 'submission')->get_active_controller()) {
812 * Helper method updating the listing on the main script from popup using javascript
816 * @param $submission object The submission whose data is to be updated on the main page
818 function update_main_listing($submission) {
819 global $SESSION, $CFG, $OUTPUT;
823 $perpage = get_user_preferences('assignment_perpage', 10);
825 $quickgrade = get_user_preferences('assignment_quickgrade', 0) && $this->quickgrade_mode_allowed();
827 /// Run some Javascript to try and update the parent page
828 $output .= '<script type="text/javascript">'."\n<!--\n";
829 if (empty($SESSION->flextable
['mod-assignment-submissions']->collapse
['submissioncomment'])) {
831 $output.= 'opener.document.getElementById("submissioncomment'.$submission->userid
.'").value="'
832 .trim($submission->submissioncomment
).'";'."\n";
834 $output.= 'opener.document.getElementById("com'.$submission->userid
.
835 '").innerHTML="'.shorten_text(trim(strip_tags($submission->submissioncomment
)), 15)."\";\n";
839 if (empty($SESSION->flextable
['mod-assignment-submissions']->collapse
['grade'])) {
840 //echo optional_param('menuindex');
842 $output.= 'opener.document.getElementById("menumenu'.$submission->userid
.
843 '").selectedIndex="'.optional_param('menuindex', 0, PARAM_INT
).'";'."\n";
845 $output.= 'opener.document.getElementById("g'.$submission->userid
.'").innerHTML="'.
846 $this->display_grade($submission->grade
)."\";\n";
849 //need to add student's assignments in there too.
850 if (empty($SESSION->flextable
['mod-assignment-submissions']->collapse
['timemodified']) &&
851 $submission->timemodified
) {
852 $output.= 'opener.document.getElementById("ts'.$submission->userid
.
853 '").innerHTML="'.addslashes_js($this->print_student_answer($submission->userid
)).userdate($submission->timemodified
)."\";\n";
856 if (empty($SESSION->flextable
['mod-assignment-submissions']->collapse
['timemarked']) &&
857 $submission->timemarked
) {
858 $output.= 'opener.document.getElementById("tt'.$submission->userid
.
859 '").innerHTML="'.userdate($submission->timemarked
)."\";\n";
862 if (empty($SESSION->flextable
['mod-assignment-submissions']->collapse
['status'])) {
863 $output.= 'opener.document.getElementById("up'.$submission->userid
.'").className="s1";';
864 $buttontext = get_string('update');
865 $url = new moodle_url('/mod/assignment/submissions.php', array(
866 'id' => $this->cm
->id
,
867 'userid' => $submission->userid
,
869 'offset' => (optional_param('offset', '', PARAM_INT
)-1)));
870 $button = $OUTPUT->action_link($url, $buttontext, new popup_action('click', $url, 'grade'.$submission->userid
, array('height' => 450, 'width' => 700)), array('ttile'=>$buttontext));
872 $output .= 'opener.document.getElementById("up'.$submission->userid
.'").innerHTML="'.addslashes_js($button).'";';
875 $grading_info = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, $submission->userid
);
877 if (empty($SESSION->flextable
['mod-assignment-submissions']->collapse
['finalgrade'])) {
878 $output.= 'opener.document.getElementById("finalgrade_'.$submission->userid
.
879 '").innerHTML="'.$grading_info->items
[0]->grades
[$submission->userid
]->str_grade
.'";'."\n";
882 if (!empty($CFG->enableoutcomes
) and empty($SESSION->flextable
['mod-assignment-submissions']->collapse
['outcome'])) {
884 if (!empty($grading_info->outcomes
)) {
885 foreach($grading_info->outcomes
as $n=>$outcome) {
886 if ($outcome->grades
[$submission->userid
]->locked
) {
891 $output.= 'opener.document.getElementById("outcome_'.$n.'_'.$submission->userid
.
892 '").selectedIndex="'.$outcome->grades
[$submission->userid
]->grade
.'";'."\n";
895 $options = make_grades_menu(-$outcome->scaleid
);
896 $options[0] = get_string('nooutcome', 'grades');
897 $output.= 'opener.document.getElementById("outcome_'.$n.'_'.$submission->userid
.'").innerHTML="'.$options[$outcome->grades
[$submission->userid
]->grade
]."\";\n";
904 $output .= "\n-->\n</script>";
909 * Return a grade in user-friendly form, whether it's a scale or not
912 * @param mixed $grade
913 * @return string User-friendly representation of grade
915 function display_grade($grade) {
918 static $scalegrades = array(); // Cache scales for each assignment - they might have different scales!!
920 if ($this->assignment
->grade
>= 0) { // Normal number
924 return $grade.' / '.$this->assignment
->grade
;
928 if (empty($scalegrades[$this->assignment
->id
])) {
929 if ($scale = $DB->get_record('scale', array('id'=>-($this->assignment
->grade
)))) {
930 $scalegrades[$this->assignment
->id
] = make_menu_from_list($scale->scale
);
935 if (isset($scalegrades[$this->assignment
->id
][$grade])) {
936 return $scalegrades[$this->assignment
->id
][$grade];
943 * Display a single submission, ready for grading on a popup window
945 * This default method prints the teacher info and submissioncomment box at the top and
946 * the student info and submission at the bottom.
947 * This method also fetches the necessary data in order to be able to
948 * provide a "Next submission" button.
949 * Calls preprocess_submission() to give assignment type plug-ins a chance
950 * to process submissions before they are graded
951 * This method gets its arguments from the page parameters userid and offset
955 * @param string $extra_javascript
957 function display_submission($offset=-1,$userid =-1, $display=true) {
958 global $CFG, $DB, $PAGE, $OUTPUT, $USER;
959 require_once($CFG->libdir
.'/gradelib.php');
960 require_once($CFG->libdir
.'/tablelib.php');
961 require_once("$CFG->dirroot/repository/lib.php");
962 require_once("$CFG->dirroot/grade/grading/lib.php");
964 $userid = required_param('userid', PARAM_INT
);
967 $offset = required_param('offset', PARAM_INT
);//offset for where to start looking for student.
969 $filter = optional_param('filter', 0, PARAM_INT
);
971 if (!$user = $DB->get_record('user', array('id'=>$userid))) {
972 print_error('nousers');
975 if (!$submission = $this->get_submission($user->id
)) {
976 $submission = $this->prepare_new_submission($userid);
978 if ($submission->timemodified
> $submission->timemarked
) {
979 $subtype = 'assignmentnew';
981 $subtype = 'assignmentold';
984 $grading_info = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, array($user->id
));
985 $gradingdisabled = $grading_info->items
[0]->grades
[$userid]->locked ||
$grading_info->items
[0]->grades
[$userid]->overridden
;
987 /// construct SQL, using current offset to find the data of the next student
988 $course = $this->course
;
989 $assignment = $this->assignment
;
991 $context = get_context_instance(CONTEXT_MODULE
, $cm->id
);
993 //reset filter to all for offline assignment
994 if ($assignment->assignmenttype
== 'offline' && $filter == self
::FILTER_SUBMITTED
) {
995 $filter = self
::FILTER_ALL
;
997 /// Get all ppl that can submit assignments
999 $currentgroup = groups_get_activity_group($cm);
1000 $users = get_enrolled_users($context, 'mod/assignment:submit', $currentgroup, 'u.id');
1002 $users = array_keys($users);
1003 // if groupmembersonly used, remove users who are not in any group
1004 if (!empty($CFG->enablegroupmembersonly
) and $cm->groupmembersonly
) {
1005 if ($groupingusers = groups_get_grouping_members($cm->groupingid
, 'u.id', 'u.id')) {
1006 $users = array_intersect($users, array_keys($groupingusers));
1013 if($filter == self
::FILTER_SUBMITTED
) {
1014 $where .= 's.timemodified > 0 AND ';
1015 } else if($filter == self
::FILTER_REQUIRE_GRADING
) {
1016 $where .= 's.timemarked < s.timemodified AND ';
1020 $userfields = user_picture
::fields('u', array('lastaccess'));
1021 $select = "SELECT $userfields,
1022 s.id AS submissionid, s.grade, s.submissioncomment,
1023 s.timemodified, s.timemarked,
1024 CASE WHEN s.timemarked > 0 AND s.timemarked >= s.timemodified THEN 1
1025 ELSE 0 END AS status ";
1027 $sql = 'FROM {user} u '.
1028 'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
1029 AND s.assignment = '.$this->assignment
->id
.' '.
1030 'WHERE '.$where.'u.id IN ('.implode(',', $users).') ';
1032 if ($sort = flexible_table
::get_sort_for_table('mod-assignment-submissions')) {
1033 $sort = 'ORDER BY '.$sort.' ';
1035 $auser = $DB->get_records_sql($select.$sql.$sort, null, $offset, 2);
1037 if (is_array($auser) && count($auser)>1) {
1038 $nextuser = next($auser);
1039 $nextid = $nextuser->id
;
1043 if ($submission->teacher
) {
1044 $teacher = $DB->get_record('user', array('id'=>$submission->teacher
));
1050 $this->preprocess_submission($submission);
1052 $mformdata = new stdClass();
1053 $mformdata->context
= $this->context
;
1054 $mformdata->maxbytes
= $this->course
->maxbytes
;
1055 $mformdata->courseid
= $this->course
->id
;
1056 $mformdata->teacher
= $teacher;
1057 $mformdata->assignment
= $assignment;
1058 $mformdata->submission
= $submission;
1059 $mformdata->lateness
= $this->display_lateness($submission->timemodified
);
1060 $mformdata->auser
= $auser;
1061 $mformdata->user
= $user;
1062 $mformdata->offset
= $offset;
1063 $mformdata->userid
= $userid;
1064 $mformdata->cm
= $this->cm
;
1065 $mformdata->grading_info
= $grading_info;
1066 $mformdata->enableoutcomes
= $CFG->enableoutcomes
;
1067 $mformdata->grade
= $this->assignment
->grade
;
1068 $mformdata->gradingdisabled
= $gradingdisabled;
1069 $mformdata->nextid
= $nextid;
1070 $mformdata->submissioncomment
= $submission->submissioncomment
;
1071 $mformdata->submissioncommentformat
= FORMAT_HTML
;
1072 $mformdata->submission_content
= $this->print_user_files($user->id
,true);
1073 $mformdata->filter
= $filter;
1074 $mformdata->mailinfo
= get_user_preferences('assignment_mailinfo', 0);
1075 if ($assignment->assignmenttype
== 'upload') {
1076 $mformdata->fileui_options
= array('subdirs'=>1, 'maxbytes'=>$assignment->maxbytes
, 'maxfiles'=>$assignment->var1
, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL
);
1077 } elseif ($assignment->assignmenttype
== 'uploadsingle') {
1078 $mformdata->fileui_options
= array('subdirs'=>0, 'maxbytes'=>$CFG->userquota
, 'maxfiles'=>1, 'accepted_types'=>'*', 'return_types'=>FILE_INTERNAL
);
1080 $advancedgradingwarning = false;
1081 $gradingmanager = get_grading_manager($this->context
, 'mod_assignment', 'submission');
1082 if ($gradingmethod = $gradingmanager->get_active_method()) {
1083 $controller = $gradingmanager->get_controller($gradingmethod);
1084 if ($controller->is_form_available()) {
1086 if (!empty($submission->id
)) {
1087 $itemid = $submission->id
;
1089 if ($gradingdisabled && $itemid) {
1090 $mformdata->advancedgradinginstance
= $controller->get_current_instance($USER->id
, $itemid);
1091 } else if (!$gradingdisabled) {
1092 $instanceid = optional_param('advancedgradinginstanceid', 0, PARAM_INT
);
1093 $mformdata->advancedgradinginstance
= $controller->get_or_create_instance($instanceid, $USER->id
, $itemid);
1096 $advancedgradingwarning = $controller->form_unavailable_notification();
1100 $submitform = new mod_assignment_grading_form( null, $mformdata );
1103 $ret_data = new stdClass();
1104 $ret_data->mform
= $submitform;
1105 if (isset($mformdata->fileui_options
)) {
1106 $ret_data->fileui_options
= $mformdata->fileui_options
;
1111 if ($submitform->is_cancelled()) {
1112 redirect('submissions.php?id='.$this->cm
->id
);
1115 $submitform->set_data($mformdata);
1117 $PAGE->set_title($this->course
->fullname
. ': ' .get_string('feedback', 'assignment').' - '.fullname($user, true));
1118 $PAGE->set_heading($this->course
->fullname
);
1119 $PAGE->navbar
->add(get_string('submissions', 'assignment'), new moodle_url('/mod/assignment/submissions.php', array('id'=>$cm->id
)));
1120 $PAGE->navbar
->add(fullname($user, true));
1122 echo $OUTPUT->header();
1123 echo $OUTPUT->heading(get_string('feedback', 'assignment').': '.fullname($user, true));
1125 // display mform here...
1126 if ($advancedgradingwarning) {
1127 echo $OUTPUT->notification($advancedgradingwarning, 'error');
1129 $submitform->display();
1131 $customfeedback = $this->custom_feedbackform($submission, true);
1132 if (!empty($customfeedback)) {
1133 echo $customfeedback;
1136 echo $OUTPUT->footer();
1140 * Preprocess submission before grading
1142 * Called by display_submission()
1143 * The default type does nothing here.
1145 * @param object $submission The submission object
1147 function preprocess_submission(&$submission) {
1151 * Display all the submissions ready for grading
1157 * @param string $message
1160 function display_submissions($message='') {
1161 global $CFG, $DB, $USER, $DB, $OUTPUT, $PAGE;
1162 require_once($CFG->libdir
.'/gradelib.php');
1164 /* first we check to see if the form has just been submitted
1165 * to request user_preference updates
1168 $filters = array(self
::FILTER_ALL
=> get_string('all'),
1169 self
::FILTER_REQUIRE_GRADING
=> get_string('requiregrading', 'assignment'));
1171 $updatepref = optional_param('updatepref', 0, PARAM_BOOL
);
1173 $perpage = optional_param('perpage', 10, PARAM_INT
);
1174 $perpage = ($perpage <= 0) ?
10 : $perpage ;
1175 $filter = optional_param('filter', 0, PARAM_INT
);
1176 set_user_preference('assignment_perpage', $perpage);
1177 set_user_preference('assignment_quickgrade', optional_param('quickgrade', 0, PARAM_BOOL
));
1178 set_user_preference('assignment_filter', $filter);
1181 /* next we get perpage and quickgrade (allow quick grade) params
1184 $perpage = get_user_preferences('assignment_perpage', 10);
1185 $quickgrade = get_user_preferences('assignment_quickgrade', 0) && $this->quickgrade_mode_allowed();
1186 $filter = get_user_preferences('assignment_filter', 0);
1187 $grading_info = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
);
1189 if (!empty($CFG->enableoutcomes
) and !empty($grading_info->outcomes
)) {
1190 $uses_outcomes = true;
1192 $uses_outcomes = false;
1195 $page = optional_param('page', 0, PARAM_INT
);
1196 $strsaveallfeedback = get_string('saveallfeedback', 'assignment');
1198 /// Some shortcuts to make the code read better
1200 $course = $this->course
;
1201 $assignment = $this->assignment
;
1203 $hassubmission = false;
1205 // reset filter to all for offline assignment only.
1206 if ($assignment->assignmenttype
== 'offline') {
1207 if ($filter == self
::FILTER_SUBMITTED
) {
1208 $filter = self
::FILTER_ALL
;
1211 $filters[self
::FILTER_SUBMITTED
] = get_string('submitted', 'assignment');
1214 $tabindex = 1; //tabindex for quick grading tabbing; Not working for dropdowns yet
1215 add_to_log($course->id
, 'assignment', 'view submission', 'submissions.php?id='.$this->cm
->id
, $this->assignment
->id
, $this->cm
->id
);
1217 $PAGE->set_title(format_string($this->assignment
->name
,true));
1218 $PAGE->set_heading($this->course
->fullname
);
1219 echo $OUTPUT->header();
1221 echo '<div class="usersubmissions">';
1223 //hook to allow plagiarism plugins to update status/print links.
1224 plagiarism_update_status($this->course
, $this->cm
);
1226 $course_context = get_context_instance(CONTEXT_COURSE
, $course->id
);
1227 if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
1228 echo '<div class="allcoursegrades"><a href="' . $CFG->wwwroot
. '/grade/report/grader/index.php?id=' . $course->id
. '">'
1229 . get_string('seeallcoursegrades', 'grades') . '</a></div>';
1232 if (!empty($message)) {
1233 echo $message; // display messages here if any
1236 $context = get_context_instance(CONTEXT_MODULE
, $cm->id
);
1238 /// Check to see if groups are being used in this assignment
1240 /// find out current groups mode
1241 $groupmode = groups_get_activity_groupmode($cm);
1242 $currentgroup = groups_get_activity_group($cm, true);
1243 groups_print_activity_menu($cm, $CFG->wwwroot
. '/mod/assignment/submissions.php?id=' . $this->cm
->id
);
1245 /// Print quickgrade form around the table
1247 $formattrs = array();
1248 $formattrs['action'] = new moodle_url('/mod/assignment/submissions.php');
1249 $formattrs['id'] = 'fastg';
1250 $formattrs['method'] = 'post';
1252 echo html_writer
::start_tag('form', $formattrs);
1253 echo html_writer
::empty_tag('input', array('type'=>'hidden', 'name'=>'id', 'value'=> $this->cm
->id
));
1254 echo html_writer
::empty_tag('input', array('type'=>'hidden', 'name'=>'mode', 'value'=> 'fastgrade'));
1255 echo html_writer
::empty_tag('input', array('type'=>'hidden', 'name'=>'page', 'value'=> $page));
1256 echo html_writer
::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=> sesskey()));
1259 /// Get all ppl that are allowed to submit assignments
1260 list($esql, $params) = get_enrolled_sql($context, 'mod/assignment:submit', $currentgroup);
1262 if ($filter == self
::FILTER_ALL
) {
1263 $sql = "SELECT u.id FROM {user} u ".
1264 "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1265 "WHERE u.deleted = 0 AND eu.id=u.id ";
1267 $wherefilter = ' AND s.assignment = '. $this->assignment
->id
;
1268 $assignmentsubmission = "LEFT JOIN {assignment_submissions} s ON (u.id = s.userid) ";
1269 if($filter == self
::FILTER_SUBMITTED
) {
1270 $wherefilter .= ' AND s.timemodified > 0 ';
1271 } else if($filter == self
::FILTER_REQUIRE_GRADING
&& $assignment->assignmenttype
!= 'offline') {
1272 $wherefilter .= ' AND s.timemarked < s.timemodified ';
1273 } else { // require grading for offline assignment
1274 $assignmentsubmission = "";
1278 $sql = "SELECT u.id FROM {user} u ".
1279 "LEFT JOIN ($esql) eu ON eu.id=u.id ".
1280 $assignmentsubmission.
1281 "WHERE u.deleted = 0 AND eu.id=u.id ".
1285 $users = $DB->get_records_sql($sql, $params);
1286 if (!empty($users)) {
1287 if($assignment->assignmenttype
== 'offline' && $filter == self
::FILTER_REQUIRE_GRADING
) {
1288 //remove users who has submitted their assignment
1289 foreach ($this->get_submissions() as $submission) {
1290 if (array_key_exists($submission->userid
, $users)) {
1291 unset($users[$submission->userid
]);
1295 $users = array_keys($users);
1298 // if groupmembersonly used, remove users who are not in any group
1299 if ($users and !empty($CFG->enablegroupmembersonly
) and $cm->groupmembersonly
) {
1300 if ($groupingusers = groups_get_grouping_members($cm->groupingid
, 'u.id', 'u.id')) {
1301 $users = array_intersect($users, array_keys($groupingusers));
1305 $extrafields = get_extra_user_fields($context);
1306 $tablecolumns = array_merge(array('picture', 'fullname'), $extrafields,
1307 array('grade', 'submissioncomment', 'timemodified', 'timemarked', 'status', 'finalgrade'));
1308 if ($uses_outcomes) {
1309 $tablecolumns[] = 'outcome'; // no sorting based on outcomes column
1312 $extrafieldnames = array();
1313 foreach ($extrafields as $field) {
1314 $extrafieldnames[] = get_user_field_name($field);
1316 $tableheaders = array_merge(
1317 array('', get_string('fullnameuser')),
1320 get_string('grade'),
1321 get_string('comment', 'assignment'),
1322 get_string('lastmodified').' ('.get_string('submission', 'assignment').')',
1323 get_string('lastmodified').' ('.get_string('grade').')',
1324 get_string('status'),
1325 get_string('finalgrade', 'grades'),
1327 if ($uses_outcomes) {
1328 $tableheaders[] = get_string('outcome', 'grades');
1331 require_once($CFG->libdir
.'/tablelib.php');
1332 $table = new flexible_table('mod-assignment-submissions');
1334 $table->define_columns($tablecolumns);
1335 $table->define_headers($tableheaders);
1336 $table->define_baseurl($CFG->wwwroot
.'/mod/assignment/submissions.php?id='.$this->cm
->id
.'&currentgroup='.$currentgroup);
1338 $table->sortable(true, 'lastname');//sorted by lastname by default
1339 $table->collapsible(true);
1340 $table->initialbars(true);
1342 $table->column_suppress('picture');
1343 $table->column_suppress('fullname');
1345 $table->column_class('picture', 'picture');
1346 $table->column_class('fullname', 'fullname');
1347 foreach ($extrafields as $field) {
1348 $table->column_class($field, $field);
1350 $table->column_class('grade', 'grade');
1351 $table->column_class('submissioncomment', 'comment');
1352 $table->column_class('timemodified', 'timemodified');
1353 $table->column_class('timemarked', 'timemarked');
1354 $table->column_class('status', 'status');
1355 $table->column_class('finalgrade', 'finalgrade');
1356 if ($uses_outcomes) {
1357 $table->column_class('outcome', 'outcome');
1360 $table->set_attribute('cellspacing', '0');
1361 $table->set_attribute('id', 'attempts');
1362 $table->set_attribute('class', 'submissions');
1363 $table->set_attribute('width', '100%');
1365 $table->no_sorting('finalgrade');
1366 $table->no_sorting('outcome');
1368 // Start working -- this is necessary as soon as the niceties are over
1371 /// Construct the SQL
1372 list($where, $params) = $table->get_sql_where();
1377 if ($filter == self
::FILTER_SUBMITTED
) {
1378 $where .= 's.timemodified > 0 AND ';
1379 } else if($filter == self
::FILTER_REQUIRE_GRADING
) {
1381 if ($assignment->assignmenttype
!= 'offline') {
1382 $where .= 's.timemarked < s.timemodified AND ';
1386 if ($sort = $table->get_sql_sort()) {
1387 $sort = ' ORDER BY '.$sort;
1390 $ufields = user_picture
::fields('u', $extrafields);
1391 if (!empty($users)) {
1392 $select = "SELECT $ufields,
1393 s.id AS submissionid, s.grade, s.submissioncomment,
1394 s.timemodified, s.timemarked,
1395 CASE WHEN s.timemarked > 0 AND s.timemarked >= s.timemodified THEN 1
1396 ELSE 0 END AS status ";
1398 $sql = 'FROM {user} u '.
1399 'LEFT JOIN {assignment_submissions} s ON u.id = s.userid
1400 AND s.assignment = '.$this->assignment
->id
.' '.
1401 'WHERE '.$where.'u.id IN ('.implode(',',$users).') ';
1403 $ausers = $DB->get_records_sql($select.$sql.$sort, $params, $table->get_page_start(), $table->get_page_size());
1405 $table->pagesize($perpage, count($users));
1407 ///offset used to calculate index of student in that particular query, needed for the pop up to know who's next
1408 $offset = $page * $perpage;
1409 $strupdate = get_string('update');
1410 $strgrade = get_string('grade');
1411 $grademenu = make_grades_menu($this->assignment
->grade
);
1413 if ($ausers !== false) {
1414 $grading_info = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, array_keys($ausers));
1415 $endposition = $offset +
$perpage;
1416 $currentposition = 0;
1417 foreach ($ausers as $auser) {
1418 if ($currentposition == $offset && $offset < $endposition) {
1420 $final_grade = $grading_info->items
[0]->grades
[$auser->id
];
1421 $grademax = $grading_info->items
[0]->grademax
;
1422 $final_grade->formatted_grade
= round($final_grade->grade
,2) .' / ' . round($grademax,2);
1423 $locked_overridden = 'locked';
1424 if ($final_grade->overridden
) {
1425 $locked_overridden = 'overridden';
1428 // TODO add here code if advanced grading grade must be reviewed => $auser->status=0
1430 $picture = $OUTPUT->user_picture($auser);
1432 if (empty($auser->submissionid
)) {
1433 $auser->grade
= -1; //no submission yet
1436 if (!empty($auser->submissionid
)) {
1437 $hassubmission = true;
1438 ///Prints student answer and student modified date
1439 ///attach file or print link to student answer, depending on the type of the assignment.
1440 ///Refer to print_student_answer in inherited classes.
1441 if ($auser->timemodified
> 0) {
1442 $studentmodifiedcontent = $this->print_student_answer($auser->id
)
1443 . userdate($auser->timemodified
);
1444 if ($assignment->timedue
&& $auser->timemodified
> $assignment->timedue
) {
1445 $studentmodifiedcontent .= assignment_display_lateness($auser->timemodified
, $assignment->timedue
);
1449 $studentmodifiedcontent = ' ';
1451 $studentmodified = html_writer
::tag('div', $studentmodifiedcontent, array('id' => 'ts' . $auser->id
));
1452 ///Print grade, dropdown or text
1453 if ($auser->timemarked
> 0) {
1454 $teachermodified = '<div id="tt'.$auser->id
.'">'.userdate($auser->timemarked
).'</div>';
1456 if ($final_grade->locked
or $final_grade->overridden
) {
1457 $grade = '<div id="g'.$auser->id
.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade
.'</div>';
1458 } else if ($quickgrade) {
1459 $attributes = array();
1460 $attributes['tabindex'] = $tabindex++
;
1461 $menu = html_writer
::select(make_grades_menu($this->assignment
->grade
), 'menu['.$auser->id
.']', $auser->grade
, array(-1=>get_string('nograde')), $attributes);
1462 $grade = '<div id="g'.$auser->id
.'">'. $menu .'</div>';
1464 $grade = '<div id="g'.$auser->id
.'">'.$this->display_grade($auser->grade
).'</div>';
1468 $teachermodified = '<div id="tt'.$auser->id
.'"> </div>';
1469 if ($final_grade->locked
or $final_grade->overridden
) {
1470 $grade = '<div id="g'.$auser->id
.'" class="'. $locked_overridden .'">'.$final_grade->formatted_grade
.'</div>';
1471 } else if ($quickgrade) {
1472 $attributes = array();
1473 $attributes['tabindex'] = $tabindex++
;
1474 $menu = html_writer
::select(make_grades_menu($this->assignment
->grade
), 'menu['.$auser->id
.']', $auser->grade
, array(-1=>get_string('nograde')), $attributes);
1475 $grade = '<div id="g'.$auser->id
.'">'.$menu.'</div>';
1477 $grade = '<div id="g'.$auser->id
.'">'.$this->display_grade($auser->grade
).'</div>';
1481 if ($final_grade->locked
or $final_grade->overridden
) {
1482 $comment = '<div id="com'.$auser->id
.'">'.shorten_text(strip_tags($final_grade->str_feedback
),15).'</div>';
1484 } else if ($quickgrade) {
1485 $comment = '<div id="com'.$auser->id
.'">'
1486 . '<textarea tabindex="'.$tabindex++
.'" name="submissioncomment['.$auser->id
.']" id="submissioncomment'
1487 . $auser->id
.'" rows="2" cols="20">'.($auser->submissioncomment
).'</textarea></div>';
1489 $comment = '<div id="com'.$auser->id
.'">'.shorten_text(strip_tags($auser->submissioncomment
),15).'</div>';
1492 $studentmodified = '<div id="ts'.$auser->id
.'"> </div>';
1493 $teachermodified = '<div id="tt'.$auser->id
.'"> </div>';
1494 $status = '<div id="st'.$auser->id
.'"> </div>';
1496 if ($final_grade->locked
or $final_grade->overridden
) {
1497 $grade = '<div id="g'.$auser->id
.'">'.$final_grade->formatted_grade
. '</div>';
1498 $hassubmission = true;
1499 } else if ($quickgrade) { // allow editing
1500 $attributes = array();
1501 $attributes['tabindex'] = $tabindex++
;
1502 $menu = html_writer
::select(make_grades_menu($this->assignment
->grade
), 'menu['.$auser->id
.']', $auser->grade
, array(-1=>get_string('nograde')), $attributes);
1503 $grade = '<div id="g'.$auser->id
.'">'.$menu.'</div>';
1504 $hassubmission = true;
1506 $grade = '<div id="g'.$auser->id
.'">-</div>';
1509 if ($final_grade->locked
or $final_grade->overridden
) {
1510 $comment = '<div id="com'.$auser->id
.'">'.$final_grade->str_feedback
.'</div>';
1511 } else if ($quickgrade) {
1512 $comment = '<div id="com'.$auser->id
.'">'
1513 . '<textarea tabindex="'.$tabindex++
.'" name="submissioncomment['.$auser->id
.']" id="submissioncomment'
1514 . $auser->id
.'" rows="2" cols="20">'.($auser->submissioncomment
).'</textarea></div>';
1516 $comment = '<div id="com'.$auser->id
.'"> </div>';
1520 if (empty($auser->status
)) { /// Confirm we have exclusively 0 or 1
1526 $buttontext = ($auser->status
== 1) ?
$strupdate : $strgrade;
1528 ///No more buttons, we use popups ;-).
1529 $popup_url = '/mod/assignment/submissions.php?id='.$this->cm
->id
1530 . '&userid='.$auser->id
.'&mode=single'.'&filter='.$filter.'&offset='.$offset++
;
1532 $button = $OUTPUT->action_link($popup_url, $buttontext);
1534 $status = '<div id="up'.$auser->id
.'" class="s'.$auser->status
.'">'.$button.'</div>';
1536 $finalgrade = '<span id="finalgrade_'.$auser->id
.'">'.$final_grade->str_grade
.'</span>';
1540 if ($uses_outcomes) {
1542 foreach($grading_info->outcomes
as $n=>$outcome) {
1543 $outcomes .= '<div class="outcome"><label>'.$outcome->name
.'</label>';
1544 $options = make_grades_menu(-$outcome->scaleid
);
1546 if ($outcome->grades
[$auser->id
]->locked
or !$quickgrade) {
1547 $options[0] = get_string('nooutcome', 'grades');
1548 $outcomes .= ': <span id="outcome_'.$n.'_'.$auser->id
.'">'.$options[$outcome->grades
[$auser->id
]->grade
].'</span>';
1550 $attributes = array();
1551 $attributes['tabindex'] = $tabindex++
;
1552 $attributes['id'] = 'outcome_'.$n.'_'.$auser->id
;
1553 $outcomes .= ' '.html_writer
::select($options, 'outcome_'.$n.'['.$auser->id
.']', $outcome->grades
[$auser->id
]->grade
, array(0=>get_string('nooutcome', 'grades')), $attributes);
1555 $outcomes .= '</div>';
1559 $userlink = '<a href="' . $CFG->wwwroot
. '/user/view.php?id=' . $auser->id
. '&course=' . $course->id
. '">' . fullname($auser, has_capability('moodle/site:viewfullnames', $this->context
)) . '</a>';
1560 $extradata = array();
1561 foreach ($extrafields as $field) {
1562 $extradata[] = $auser->{$field};
1564 $row = array_merge(array($picture, $userlink), $extradata,
1565 array($grade, $comment, $studentmodified, $teachermodified,
1566 $status, $finalgrade));
1567 if ($uses_outcomes) {
1570 $table->add_data($row, $rowclass);
1574 if ($hassubmission && ($this->assignment
->assignmenttype
=='upload' ||
$this->assignment
->assignmenttype
=='online' ||
$this->assignment
->assignmenttype
=='uploadsingle')) { //TODO: this is an ugly hack, where is the plugin spirit? (skodak)
1575 echo html_writer
::start_tag('div', array('class' => 'mod-assignment-download-link'));
1576 echo html_writer
::link(new moodle_url('/mod/assignment/submissions.php', array('id' => $this->cm
->id
, 'download' => 'zip')), get_string('downloadall', 'assignment'));
1577 echo html_writer
::end_tag('div');
1579 $table->print_html(); /// Print the whole table
1581 if ($filter == self
::FILTER_SUBMITTED
) {
1582 echo html_writer
::tag('div', get_string('nosubmisson', 'assignment'), array('class'=>'nosubmisson'));
1583 } else if ($filter == self
::FILTER_REQUIRE_GRADING
) {
1584 echo html_writer
::tag('div', get_string('norequiregrading', 'assignment'), array('class'=>'norequiregrading'));
1589 /// Print quickgrade form around the table
1590 if ($quickgrade && $table->started_output
&& !empty($users)){
1591 $mailinfopref = false;
1592 if (get_user_preferences('assignment_mailinfo', 1)) {
1593 $mailinfopref = true;
1595 $emailnotification = html_writer
::checkbox('mailinfo', 1, $mailinfopref, get_string('enablenotification','assignment'));
1597 $emailnotification .= $OUTPUT->help_icon('enablenotification', 'assignment');
1598 echo html_writer
::tag('div', $emailnotification, array('class'=>'emailnotification'));
1600 $savefeedback = html_writer
::empty_tag('input', array('type'=>'submit', 'name'=>'fastg', 'value'=>get_string('saveallfeedback', 'assignment')));
1601 echo html_writer
::tag('div', $savefeedback, array('class'=>'fastgbutton'));
1603 echo html_writer
::end_tag('form');
1604 } else if ($quickgrade) {
1605 echo html_writer
::end_tag('form');
1609 /// End of fast grading form
1611 /// Mini form for setting user preference
1613 $formaction = new moodle_url('/mod/assignment/submissions.php', array('id'=>$this->cm
->id
));
1614 $mform = new MoodleQuickForm('optionspref', 'post', $formaction, '', array('class'=>'optionspref'));
1616 $mform->addElement('hidden', 'updatepref');
1617 $mform->setDefault('updatepref', 1);
1618 $mform->addElement('header', 'qgprefs', get_string('optionalsettings', 'assignment'));
1619 $mform->addElement('select', 'filter', get_string('show'), $filters);
1621 $mform->setDefault('filter', $filter);
1623 $mform->addElement('text', 'perpage', get_string('pagesize', 'assignment'), array('size'=>1));
1624 $mform->setDefault('perpage', $perpage);
1626 if ($this->quickgrade_mode_allowed()) {
1627 $mform->addElement('checkbox', 'quickgrade', get_string('quickgrade','assignment'));
1628 $mform->setDefault('quickgrade', $quickgrade);
1629 $mform->addHelpButton('quickgrade', 'quickgrade', 'assignment');
1632 $mform->addElement('submit', 'savepreferences', get_string('savepreferences'));
1636 echo $OUTPUT->footer();
1640 * If the form was cancelled ('Cancel' or 'Next' was pressed), call cancel method
1641 * from advanced grading (if applicable) and returns true
1642 * If the form was submitted, validates it and returns false if validation did not pass.
1643 * If validation passes, preprocess advanced grading (if applicable) and returns true.
1645 * Note to the developers: This is NOT the correct way to implement advanced grading
1646 * in grading form. The assignment grading was written long time ago and unfortunately
1647 * does not fully use the mforms. Usually function is_validated() is called to
1648 * validate the form and get_data() is called to get the data from the form.
1650 * Here we have to push the calculated grade to $_POST['xgrade'] because further processing
1651 * of the form gets the data not from form->get_data(), but from $_POST (using statement
1652 * like $feedback = data_submitted() )
1654 protected function validate_and_preprocess_feedback() {
1656 require_once($CFG->libdir
.'/gradelib.php');
1657 if (!($feedback = data_submitted()) ||
!isset($feedback->userid
) ||
!isset($feedback->offset
)) {
1658 return true; // No incoming data, nothing to validate
1660 $userid = required_param('userid', PARAM_INT
);
1661 $offset = required_param('offset', PARAM_INT
);
1662 $gradinginfo = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, array($userid));
1663 $gradingdisabled = $gradinginfo->items
[0]->grades
[$userid]->locked ||
$gradinginfo->items
[0]->grades
[$userid]->overridden
;
1664 if ($gradingdisabled) {
1667 $submissiondata = $this->display_submission($offset, $userid, false);
1668 $mform = $submissiondata->mform
;
1669 $gradinginstance = $mform->use_advanced_grading();
1670 if (optional_param('cancel', false, PARAM_BOOL
) ||
optional_param('next', false, PARAM_BOOL
)) {
1671 // form was cancelled
1672 if ($gradinginstance) {
1673 $gradinginstance->cancel();
1675 } else if ($mform->is_submitted()) {
1676 // form was submitted (= a submit button other than 'cancel' or 'next' has been clicked)
1677 if (!$mform->is_validated()) {
1680 // preprocess advanced grading here
1681 if ($gradinginstance) {
1682 $data = $mform->get_data();
1683 // create submission if it did not exist yet because we need submission->id for storing the grading instance
1684 $submission = $this->get_submission($userid, true);
1685 $_POST['xgrade'] = $gradinginstance->submit_and_get_grade($data->advancedgrading
, $submission->id
);
1692 * Process teacher feedback submission
1694 * This is called by submissions() when a grading even has taken place.
1695 * It gets its data from the submitted form.
1700 * @return object|bool The updated submission object or false
1702 function process_feedback($formdata=null) {
1703 global $CFG, $USER, $DB;
1704 require_once($CFG->libdir
.'/gradelib.php');
1706 if (!$feedback = data_submitted() or !confirm_sesskey()) { // No incoming data?
1710 ///For save and next, we need to know the userid to save, and the userid to go
1711 ///We use a new hidden field in the form, and set it to -1. If it's set, we use this
1712 ///as the userid to store
1713 if ((int)$feedback->saveuserid
!== -1){
1714 $feedback->userid
= $feedback->saveuserid
;
1717 if (!empty($feedback->cancel
)) { // User hit cancel button
1721 $grading_info = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, $feedback->userid
);
1723 // store outcomes if needed
1724 $this->process_outcomes($feedback->userid
);
1726 $submission = $this->get_submission($feedback->userid
, true); // Get or make one
1728 if (!($grading_info->items
[0]->grades
[$feedback->userid
]->locked ||
1729 $grading_info->items
[0]->grades
[$feedback->userid
]->overridden
) ) {
1731 $submission->grade
= $feedback->xgrade
;
1732 $submission->submissioncomment
= $feedback->submissioncomment_editor
['text'];
1733 $submission->teacher
= $USER->id
;
1734 $mailinfo = get_user_preferences('assignment_mailinfo', 0);
1736 $submission->mailed
= 1; // treat as already mailed
1738 $submission->mailed
= 0; // Make sure mail goes out (again, even)
1740 $submission->timemarked
= time();
1742 unset($submission->data1
); // Don't need to update this.
1743 unset($submission->data2
); // Don't need to update this.
1745 if (empty($submission->timemodified
)) { // eg for offline assignments
1746 // $submission->timemodified = time();
1749 $DB->update_record('assignment_submissions', $submission);
1751 // triger grade event
1752 $this->update_grade($submission);
1754 add_to_log($this->course
->id
, 'assignment', 'update grades',
1755 'submissions.php?id='.$this->cm
->id
.'&user='.$feedback->userid
, $feedback->userid
, $this->cm
->id
);
1756 if (!is_null($formdata)) {
1757 if ($this->type
== 'upload' ||
$this->type
== 'uploadsingle') {
1758 $mformdata = $formdata->mform
->get_data();
1759 $mformdata = file_postupdate_standard_filemanager($mformdata, 'files', $formdata->fileui_options
, $this->context
, 'mod_assignment', 'response', $submission->id
);
1768 function process_outcomes($userid) {
1771 if (empty($CFG->enableoutcomes
)) {
1775 require_once($CFG->libdir
.'/gradelib.php');
1777 if (!$formdata = data_submitted() or !confirm_sesskey()) {
1782 $grading_info = grade_get_grades($this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, $userid);
1784 if (!empty($grading_info->outcomes
)) {
1785 foreach($grading_info->outcomes
as $n=>$old) {
1786 $name = 'outcome_'.$n;
1787 if (isset($formdata->{$name}[$userid]) and $old->grades
[$userid]->grade
!= $formdata->{$name}[$userid]) {
1788 $data[$n] = $formdata->{$name}[$userid];
1792 if (count($data) > 0) {
1793 grade_update_outcomes('mod/assignment', $this->course
->id
, 'mod', 'assignment', $this->assignment
->id
, $userid, $data);
1799 * Load the submission object for a particular user
1803 * @param $userid int The id of the user whose submission we want or 0 in which case USER->id is used
1804 * @param $createnew boolean optional Defaults to false. If set to true a new submission object will be created in the database
1805 * @param bool $teachermodified student submission set if false
1806 * @return object The submission
1808 function get_submission($userid=0, $createnew=false, $teachermodified=false) {
1811 if (empty($userid)) {
1812 $userid = $USER->id
;
1815 $submission = $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment
->id
, 'userid'=>$userid));
1817 if ($submission ||
!$createnew) {
1820 $newsubmission = $this->prepare_new_submission($userid, $teachermodified);
1821 $DB->insert_record("assignment_submissions", $newsubmission);
1823 return $DB->get_record('assignment_submissions', array('assignment'=>$this->assignment
->id
, 'userid'=>$userid));
1827 * Instantiates a new submission object for a given user
1829 * Sets the assignment, userid and times, everything else is set to default values.
1831 * @param int $userid The userid for which we want a submission object
1832 * @param bool $teachermodified student submission set if false
1833 * @return object The submission
1835 function prepare_new_submission($userid, $teachermodified=false) {
1836 $submission = new stdClass();
1837 $submission->assignment
= $this->assignment
->id
;
1838 $submission->userid
= $userid;
1839 $submission->timecreated
= time();
1840 // teachers should not be modifying modified date, except offline assignments
1841 if ($teachermodified) {
1842 $submission->timemodified
= 0;
1844 $submission->timemodified
= $submission->timecreated
;
1846 $submission->numfiles
= 0;
1847 $submission->data1
= '';
1848 $submission->data2
= '';
1849 $submission->grade
= -1;
1850 $submission->submissioncomment
= '';
1851 $submission->format
= 0;
1852 $submission->teacher
= 0;
1853 $submission->timemarked
= 0;
1854 $submission->mailed
= 0;
1859 * Return all assignment submissions by ENROLLED students (even empty)
1861 * @param string $sort optional field names for the ORDER BY in the sql query
1862 * @param string $dir optional specifying the sort direction, defaults to DESC
1863 * @return array The submission objects indexed by id
1865 function get_submissions($sort='', $dir='DESC') {
1866 return assignment_get_all_submissions($this->assignment
, $sort, $dir);
1870 * Counts all real assignment submissions by ENROLLED students (not empty ones)
1872 * @param int $groupid optional If nonzero then count is restricted to this group
1873 * @return int The number of submissions
1875 function count_real_submissions($groupid=0) {
1876 return assignment_count_real_submissions($this->cm
, $groupid);
1880 * Alerts teachers by email of new or changed assignments that need grading
1882 * First checks whether the option to email teachers is set for this assignment.
1883 * Sends an email to ALL teachers in the course (or in the group if using separate groups).
1884 * Uses the methods email_teachers_text() and email_teachers_html() to construct the content.
1888 * @param $submission object The submission that has changed
1891 function email_teachers($submission) {
1894 if (empty($this->assignment
->emailteachers
)) { // No need to do anything
1898 $user = $DB->get_record('user', array('id'=>$submission->userid
));
1900 if ($teachers = $this->get_graders($user)) {
1902 $strassignments = get_string('modulenameplural', 'assignment');
1903 $strassignment = get_string('modulename', 'assignment');
1904 $strsubmitted = get_string('submitted', 'assignment');
1906 foreach ($teachers as $teacher) {
1907 $info = new stdClass();
1908 $info->username
= fullname($user, true);
1909 $info->assignment
= format_string($this->assignment
->name
,true);
1910 $info->url
= $CFG->wwwroot
.'/mod/assignment/submissions.php?id='.$this->cm
->id
;
1911 $info->timeupdated
= userdate($submission->timemodified
, '%c', $teacher->timezone
);
1913 $postsubject = $strsubmitted.': '.$info->username
.' -> '.$this->assignment
->name
;
1914 $posttext = $this->email_teachers_text($info);
1915 $posthtml = ($teacher->mailformat
== 1) ?
$this->email_teachers_html($info) : '';
1917 $eventdata = new stdClass();
1918 $eventdata->modulename
= 'assignment';
1919 $eventdata->userfrom
= $user;
1920 $eventdata->userto
= $teacher;
1921 $eventdata->subject
= $postsubject;
1922 $eventdata->fullmessage
= $posttext;
1923 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
1924 $eventdata->fullmessagehtml
= $posthtml;
1925 $eventdata->smallmessage
= $postsubject;
1927 $eventdata->name
= 'assignment_updates';
1928 $eventdata->component
= 'mod_assignment';
1929 $eventdata->notification
= 1;
1930 $eventdata->contexturl
= $info->url
;
1931 $eventdata->contexturlname
= $info->assignment
;
1933 message_send($eventdata);
1939 * @param string $filearea
1940 * @param array $args
1943 function send_file($filearea, $args) {
1944 debugging('plugin does not implement file sending', DEBUG_DEVELOPER
);
1949 * Returns a list of teachers that should be grading given submission
1951 * @param object $user
1954 function get_graders($user) {
1956 $potgraders = get_users_by_capability($this->context
, 'mod/assignment:grade', '', '', '', '', '', '', false, false);
1959 if (groups_get_activity_groupmode($this->cm
) == SEPARATEGROUPS
) { // Separate groups are being used
1960 if ($groups = groups_get_all_groups($this->course
->id
, $user->id
)) { // Try to find all groups
1961 foreach ($groups as $group) {
1962 foreach ($potgraders as $t) {
1963 if ($t->id
== $user->id
) {
1964 continue; // do not send self
1966 if (groups_is_member($group->id
, $t->id
)) {
1967 $graders[$t->id
] = $t;
1972 // user not in group, try to find graders without group
1973 foreach ($potgraders as $t) {
1974 if ($t->id
== $user->id
) {
1975 continue; // do not send self
1977 if (!groups_get_all_groups($this->course
->id
, $t->id
)) { //ugly hack
1978 $graders[$t->id
] = $t;
1983 foreach ($potgraders as $t) {
1984 if ($t->id
== $user->id
) {
1985 continue; // do not send self
1987 $graders[$t->id
] = $t;
1994 * Creates the text content for emails to teachers
1996 * @param $info object The info used by the 'emailteachermail' language string
1999 function email_teachers_text($info) {
2000 $posttext = format_string($this->course
->shortname
, true, array('context' => $this->coursecontext
)).' -> '.
2001 $this->strassignments
.' -> '.
2002 format_string($this->assignment
->name
, true, array('context' => $this->context
))."\n";
2003 $posttext .= '---------------------------------------------------------------------'."\n";
2004 $posttext .= get_string("emailteachermail", "assignment", $info)."\n";
2005 $posttext .= "\n---------------------------------------------------------------------\n";
2010 * Creates the html content for emails to teachers
2012 * @param $info object The info used by the 'emailteachermailhtml' language string
2015 function email_teachers_html($info) {
2017 $posthtml = '<p><font face="sans-serif">'.
2018 '<a href="'.$CFG->wwwroot
.'/course/view.php?id='.$this->course
->id
.'">'.format_string($this->course
->shortname
, true, array('context' => $this->coursecontext
)).'</a> ->'.
2019 '<a href="'.$CFG->wwwroot
.'/mod/assignment/index.php?id='.$this->course
->id
.'">'.$this->strassignments
.'</a> ->'.
2020 '<a href="'.$CFG->wwwroot
.'/mod/assignment/view.php?id='.$this->cm
->id
.'">'.format_string($this->assignment
->name
, true, array('context' => $this->context
)).'</a></font></p>';
2021 $posthtml .= '<hr /><font face="sans-serif">';
2022 $posthtml .= '<p>'.get_string('emailteachermailhtml', 'assignment', $info).'</p>';
2023 $posthtml .= '</font><hr />';
2028 * Produces a list of links to the files uploaded by a user
2030 * @param $userid int optional id of the user. If 0 then $USER->id is used.
2031 * @param $return boolean optional defaults to false. If true the list is returned rather than printed
2032 * @return string optional
2034 function print_user_files($userid=0, $return=false) {
2035 global $CFG, $USER, $OUTPUT;
2038 if (!isloggedin()) {
2041 $userid = $USER->id
;
2046 $submission = $this->get_submission($userid);
2051 $fs = get_file_storage();
2052 $files = $fs->get_area_files($this->context
->id
, 'mod_assignment', 'submission', $submission->id
, "timemodified", false);
2053 if (!empty($files)) {
2054 require_once($CFG->dirroot
. '/mod/assignment/locallib.php');
2055 if ($CFG->enableportfolios
) {
2056 require_once($CFG->libdir
.'/portfoliolib.php');
2057 $button = new portfolio_add_button();
2059 foreach ($files as $file) {
2060 $filename = $file->get_filename();
2061 $mimetype = $file->get_mimetype();
2062 $path = file_encode_url($CFG->wwwroot
.'/pluginfile.php', '/'.$this->context
->id
.'/mod_assignment/submission/'.$submission->id
.'/'.$filename);
2063 $output .= '<a href="'.$path.'" ><img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />'.s($filename).'</a>';
2064 if ($CFG->enableportfolios
&& $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context
)) {
2065 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm
->id
, 'submissionid' => $submission->id
, 'fileid' => $file->get_id()), '/mod/assignment/locallib.php');
2066 $button->set_format_by_file($file);
2067 $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK
);
2070 if ($CFG->enableplagiarism
) {
2071 require_once($CFG->libdir
.'/plagiarismlib.php');
2072 $output .= plagiarism_get_links(array('userid'=>$userid, 'file'=>$file, 'cmid'=>$this->cm
->id
, 'course'=>$this->course
, 'assignment'=>$this->assignment
));
2073 $output .= '<br />';
2076 if ($CFG->enableportfolios
&& count($files) > 1 && $this->portfolio_exportable() && has_capability('mod/assignment:exportownsubmission', $this->context
)) {
2077 $button->set_callback_options('assignment_portfolio_caller', array('id' => $this->cm
->id
, 'submissionid' => $submission->id
), '/mod/assignment/locallib.php');
2078 $output .= '<br />' . $button->to_html(PORTFOLIO_ADD_TEXT_LINK
);
2082 $output = '<div class="files">'.$output.'</div>';
2091 * Count the files uploaded by a given user
2093 * @param $itemid int The submission's id as the file's itemid.
2096 function count_user_files($itemid) {
2097 $fs = get_file_storage();
2098 $files = $fs->get_area_files($this->context
->id
, 'mod_assignment', 'submission', $itemid, "id", false);
2099 return count($files);
2103 * Returns true if the student is allowed to submit
2105 * Checks that the assignment has started and, if the option to prevent late
2106 * submissions is set, also checks that the assignment has not yet closed.
2111 if ($this->assignment
->preventlate
&& $this->assignment
->timedue
) {
2112 return ($this->assignment
->timeavailable
<= $time && $time <= $this->assignment
->timedue
);
2114 return ($this->assignment
->timeavailable
<= $time);
2120 * Return true if is set description is hidden till available date
2122 * This is needed by calendar so that hidden descriptions do not
2123 * come up in upcoming events.
2125 * Check that description is hidden till available date
2126 * By default return false
2127 * Assignments types should implement this method if needed
2130 function description_is_hidden() {
2135 * Return an outline of the user's interaction with the assignment
2137 * The default method prints the grade and timemodified
2138 * @param $grade object
2139 * @return object with properties ->info and ->time
2141 function user_outline($grade) {
2143 $result = new stdClass();
2144 $result->info
= get_string('grade').': '.$grade->str_long_grade
;
2145 $result->time
= $grade->dategraded
;
2150 * Print complete information about the user's interaction with the assignment
2152 * @param $user object
2154 function user_complete($user, $grade=null) {
2157 if ($submission = $this->get_submission($user->id
)) {
2159 $fs = get_file_storage();
2161 if ($files = $fs->get_area_files($this->context
->id
, 'mod_assignment', 'submission', $submission->id
, "timemodified", false)) {
2162 $countfiles = count($files)." ".get_string("uploadedfiles", "assignment");
2163 foreach ($files as $file) {
2164 $countfiles .= "; ".$file->get_filename();
2168 echo $OUTPUT->box_start();
2169 echo get_string("lastmodified").": ";
2170 echo userdate($submission->timemodified
);
2171 echo $this->display_lateness($submission->timemodified
);
2173 $this->print_user_files($user->id
);
2177 $this->view_feedback($submission);
2179 echo $OUTPUT->box_end();
2183 echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade
);
2184 if ($grade->str_feedback
) {
2185 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback
);
2188 print_string("notsubmittedyet", "assignment");
2193 * Return a string indicating how late a submission is
2195 * @param $timesubmitted int
2198 function display_lateness($timesubmitted) {
2199 return assignment_display_lateness($timesubmitted, $this->assignment
->timedue
);
2203 * Empty method stub for all delete actions.
2206 //nothing by default
2207 redirect('view.php?id='.$this->cm
->id
);
2211 * Empty custom feedback grading form.
2213 function custom_feedbackform($submission, $return=false) {
2214 //nothing by default
2219 * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
2220 * for the course (see resource).
2222 * Given a course_module object, this function returns any "extra" information that may be needed
2223 * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php.
2225 * @param $coursemodule object The coursemodule object (record).
2226 * @return cached_cm_info Object used to customise appearance on course page
2228 function get_coursemodule_info($coursemodule) {
2233 * Plugin cron method - do not use $this here, create new assignment instances if needed.
2237 //no plugin cron by default - override if needed
2241 * Reset all submissions
2243 function reset_userdata($data) {
2246 if (!$DB->count_records('assignment', array('course'=>$data->courseid
, 'assignmenttype'=>$this->type
))) {
2247 return array(); // no assignments of this type present
2250 $componentstr = get_string('modulenameplural', 'assignment');
2253 $typestr = get_string('type'.$this->type
, 'assignment');
2254 // ugly hack to support pluggable assignment type titles...
2255 if($typestr === '[[type'.$this->type
.']]'){
2256 $typestr = get_string('type'.$this->type
, 'assignment_'.$this->type
);
2259 if (!empty($data->reset_assignment_submissions
)) {
2260 $assignmentssql = "SELECT a.id
2262 WHERE a.course=? AND a.assignmenttype=?";
2263 $params = array($data->courseid
, $this->type
);
2265 // now get rid of all submissions and responses
2266 $fs = get_file_storage();
2267 if ($assignments = $DB->get_records_sql($assignmentssql, $params)) {
2268 foreach ($assignments as $assignmentid=>$unused) {
2269 if (!$cm = get_coursemodule_from_instance('assignment', $assignmentid)) {
2272 $context = get_context_instance(CONTEXT_MODULE
, $cm->id
);
2273 $fs->delete_area_files($context->id
, 'mod_assignment', 'submission');
2274 $fs->delete_area_files($context->id
, 'mod_assignment', 'response');
2278 $DB->delete_records_select('assignment_submissions', "assignment IN ($assignmentssql)", $params);
2280 $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallsubmissions','assignment').': '.$typestr, 'error'=>false);
2282 if (empty($data->reset_gradebook_grades
)) {
2283 // remove all grades from gradebook
2284 assignment_reset_gradebook($data->courseid
, $this->type
);
2288 /// updating dates - shift may be negative too
2289 if ($data->timeshift
) {
2290 shift_course_mod_dates('assignment', array('timedue', 'timeavailable'), $data->timeshift
, $data->courseid
);
2291 $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged').': '.$typestr, 'error'=>false);
2298 function portfolio_exportable() {
2303 * base implementation for backing up subtype specific information
2304 * for one single module
2306 * @param filehandle $bf file handle for xml file to write to
2307 * @param mixed $preferences the complete backup preference object
2313 static function backup_one_mod($bf, $preferences, $assignment) {
2318 * base implementation for backing up subtype specific information
2319 * for one single submission
2321 * @param filehandle $bf file handle for xml file to write to
2322 * @param mixed $preferences the complete backup preference object
2323 * @param object $submission the assignment submission db record
2329 static function backup_one_submission($bf, $preferences, $assignment, $submission) {
2334 * base implementation for restoring subtype specific information
2335 * for one single module
2337 * @param array $info the array representing the xml
2338 * @param object $restore the restore preferences
2344 static function restore_one_mod($info, $restore, $assignment) {
2349 * base implementation for restoring subtype specific information
2350 * for one single submission
2352 * @param object $submission the newly created submission
2353 * @param array $info the array representing the xml
2354 * @param object $restore the restore preferences
2360 static function restore_one_submission($info, $restore, $assignment, $submission) {
2364 } ////// End of the assignment_base class
2367 class mod_assignment_grading_form
extends moodleform
{
2368 /** @var stores the advaned grading instance (if used in grading) */
2369 private $advancegradinginstance;
2371 function definition() {
2373 $mform =& $this->_form
;
2375 if (isset($this->_customdata
->advancedgradinginstance
)) {
2376 $this->use_advanced_grading($this->_customdata
->advancedgradinginstance
);
2379 $formattr = $mform->getAttributes();
2380 $formattr['id'] = 'submitform';
2381 $mform->setAttributes($formattr);
2383 $mform->addElement('hidden', 'offset', ($this->_customdata
->offset+
1));
2384 $mform->setType('offset', PARAM_INT
);
2385 $mform->addElement('hidden', 'userid', $this->_customdata
->userid
);
2386 $mform->setType('userid', PARAM_INT
);
2387 $mform->addElement('hidden', 'nextid', $this->_customdata
->nextid
);
2388 $mform->setType('nextid', PARAM_INT
);
2389 $mform->addElement('hidden', 'id', $this->_customdata
->cm
->id
);
2390 $mform->setType('id', PARAM_INT
);
2391 $mform->addElement('hidden', 'sesskey', sesskey());
2392 $mform->setType('sesskey', PARAM_ALPHANUM
);
2393 $mform->addElement('hidden', 'mode', 'grade');
2394 $mform->setType('mode', PARAM_TEXT
);
2395 $mform->addElement('hidden', 'menuindex', "0");
2396 $mform->setType('menuindex', PARAM_INT
);
2397 $mform->addElement('hidden', 'saveuserid', "-1");
2398 $mform->setType('saveuserid', PARAM_INT
);
2399 $mform->addElement('hidden', 'filter', "0");
2400 $mform->setType('filter', PARAM_INT
);
2402 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata
->user
),
2403 fullname($this->_customdata
->user
, true) . '<br/>' .
2404 userdate($this->_customdata
->submission
->timemodified
) .
2405 $this->_customdata
->lateness
);
2407 $this->add_submission_content();
2408 $this->add_grades_section();
2410 $this->add_feedback_section();
2412 if ($this->_customdata
->submission
->timemarked
) {
2413 $datestring = userdate($this->_customdata
->submission
->timemarked
)." (".format_time(time() - $this->_customdata
->submission
->timemarked
).")";
2414 $mform->addElement('header', 'Last Grade', get_string('lastgrade', 'assignment'));
2415 $mform->addElement('static', 'picture', $OUTPUT->user_picture($this->_customdata
->teacher
) ,
2416 fullname($this->_customdata
->teacher
,true).
2417 '<br/>'.$datestring);
2420 $this->add_action_buttons();
2425 * Gets or sets the instance for advanced grading
2427 * @param gradingform_instance $gradinginstance
2429 public function use_advanced_grading($gradinginstance = false) {
2430 if ($gradinginstance !== false) {
2431 $this->advancegradinginstance
= $gradinginstance;
2433 return $this->advancegradinginstance
;
2436 function add_grades_section() {
2438 $mform =& $this->_form
;
2439 $attributes = array();
2440 if ($this->_customdata
->gradingdisabled
) {
2441 $attributes['disabled'] ='disabled';
2444 $mform->addElement('header', 'Grades', get_string('grades', 'grades'));
2446 $grademenu = make_grades_menu($this->_customdata
->assignment
->grade
);
2447 if ($gradinginstance = $this->use_advanced_grading()) {
2448 $gradinginstance->get_controller()->set_grade_range($grademenu);
2449 $gradingelement = $mform->addElement('grading', 'advancedgrading', get_string('grade').':', array('gradinginstance' => $gradinginstance));
2450 if ($this->_customdata
->gradingdisabled
) {
2451 $gradingelement->freeze();
2453 $mform->addElement('hidden', 'advancedgradinginstanceid', $gradinginstance->get_id());
2456 // use simple direct grading
2457 $grademenu['-1'] = get_string('nograde');
2459 $mform->addElement('select', 'xgrade', get_string('grade').':', $grademenu, $attributes);
2460 $mform->setDefault('xgrade', $this->_customdata
->submission
->grade
); //@fixme some bug when element called 'grade' makes it break
2461 $mform->setType('xgrade', PARAM_INT
);
2464 if (!empty($this->_customdata
->enableoutcomes
)) {
2465 foreach($this->_customdata
->grading_info
->outcomes
as $n=>$outcome) {
2466 $options = make_grades_menu(-$outcome->scaleid
);
2467 if ($outcome->grades
[$this->_customdata
->submission
->userid
]->locked
) {
2468 $options[0] = get_string('nooutcome', 'grades');
2469 $mform->addElement('static', 'outcome_'.$n.'['.$this->_customdata
->userid
.']', $outcome->name
.':',
2470 $options[$outcome->grades
[$this->_customdata
->submission
->userid
]->grade
]);
2472 $options[''] = get_string('nooutcome', 'grades');
2473 $attributes = array('id' => 'menuoutcome_'.$n );
2474 $mform->addElement('select', 'outcome_'.$n.'['.$this->_customdata
->userid
.']', $outcome->name
.':', $options, $attributes );
2475 $mform->setType('outcome_'.$n.'['.$this->_customdata
->userid
.']', PARAM_INT
);
2476 $mform->setDefault('outcome_'.$n.'['.$this->_customdata
->userid
.']', $outcome->grades
[$this->_customdata
->submission
->userid
]->grade
);
2480 $course_context = get_context_instance(CONTEXT_MODULE
, $this->_customdata
->cm
->id
);
2481 if (has_capability('gradereport/grader:view', $course_context) && has_capability('moodle/grade:viewall', $course_context)) {
2482 $grade = '<a href="'.$CFG->wwwroot
.'/grade/report/grader/index.php?id='. $this->_customdata
->courseid
.'" >'.
2483 $this->_customdata
->grading_info
->items
[0]->grades
[$this->_customdata
->userid
]->str_grade
. '</a>';
2485 $grade = $this->_customdata
->grading_info
->items
[0]->grades
[$this->_customdata
->userid
]->str_grade
;
2487 $mform->addElement('static', 'finalgrade', get_string('currentgrade', 'assignment').':' ,$grade);
2488 $mform->setType('finalgrade', PARAM_INT
);
2493 * @global core_renderer $OUTPUT
2495 function add_feedback_section() {
2497 $mform =& $this->_form
;
2498 $mform->addElement('header', 'Feed Back', get_string('feedback', 'grades'));
2500 if ($this->_customdata
->gradingdisabled
) {
2501 $mform->addElement('static', 'disabledfeedback', $this->_customdata
->grading_info
->items
[0]->grades
[$this->_customdata
->userid
]->str_feedback
);
2505 $mform->addElement('editor', 'submissioncomment_editor', get_string('feedback', 'assignment').':', null, $this->get_editor_options() );
2506 $mform->setType('submissioncomment_editor', PARAM_RAW
); // to be cleaned before display
2507 $mform->setDefault('submissioncomment_editor', $this->_customdata
->submission
->submissioncomment
);
2508 //$mform->addRule('submissioncomment', get_string('required'), 'required', null, 'client');
2509 switch ($this->_customdata
->assignment
->assignmenttype
) {
2511 case 'uploadsingle' :
2512 $mform->addElement('filemanager', 'files_filemanager', get_string('responsefiles', 'assignment'). ':', null, $this->_customdata
->fileui_options
);
2517 $mform->addElement('hidden', 'mailinfo_h', "0");
2518 $mform->setType('mailinfo_h', PARAM_INT
);
2519 $mform->addElement('checkbox', 'mailinfo',get_string('enablenotification','assignment').
2520 $OUTPUT->help_icon('enablenotification', 'assignment') .':' );
2521 $mform->setType('mailinfo', PARAM_INT
);
2525 function add_action_buttons() {
2526 $mform =& $this->_form
;
2527 //if there are more to be graded.
2528 if ($this->_customdata
->nextid
>0) {
2529 $buttonarray=array();
2530 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2531 //@todo: fix accessibility: javascript dependency not necessary
2532 $buttonarray[] = &$mform->createElement('submit', 'saveandnext', get_string('saveandnext'));
2533 $buttonarray[] = &$mform->createElement('submit', 'next', get_string('next'));
2534 $buttonarray[] = &$mform->createElement('cancel');
2536 $buttonarray=array();
2537 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', get_string('savechanges'));
2538 $buttonarray[] = &$mform->createElement('cancel');
2540 $mform->addGroup($buttonarray, 'grading_buttonar', '', array(' '), false);
2541 $mform->closeHeaderBefore('grading_buttonar');
2542 $mform->setType('grading_buttonar', PARAM_RAW
);
2545 function add_submission_content() {
2546 $mform =& $this->_form
;
2547 $mform->addElement('header', 'Submission', get_string('submission', 'assignment'));
2548 $mform->addElement('static', '', '' , $this->_customdata
->submission_content
);
2551 protected function get_editor_options() {
2552 $editoroptions = array();
2553 $editoroptions['component'] = 'mod_assignment';
2554 $editoroptions['filearea'] = 'feedback';
2555 $editoroptions['noclean'] = false;
2556 $editoroptions['maxfiles'] = 0; //TODO: no files for now, we need to first implement assignment_feedback area, integration with gradebook, files support in quickgrading, etc. (skodak)
2557 $editoroptions['maxbytes'] = $this->_customdata
->maxbytes
;
2558 $editoroptions['context'] = $this->_customdata
->context
;
2559 return $editoroptions;
2562 public function set_data($data) {
2563 $editoroptions = $this->get_editor_options();
2564 if (!isset($data->text
)) {
2567 if (!isset($data->format
)) {
2568 $data->textformat
= FORMAT_HTML
;
2570 $data->textformat
= $data->format
;
2573 if (!empty($this->_customdata
->submission
->id
)) {
2574 $itemid = $this->_customdata
->submission
->id
;
2579 switch ($this->_customdata
->assignment
->assignmenttype
) {
2581 case 'uploadsingle' :
2582 $data = file_prepare_standard_filemanager($data, 'files', $editoroptions, $this->_customdata
->context
, 'mod_assignment', 'response', $itemid);
2588 $data = file_prepare_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata
->context
, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2589 return parent
::set_data($data);
2592 public function get_data() {
2593 $data = parent
::get_data();
2595 if (!empty($this->_customdata
->submission
->id
)) {
2596 $itemid = $this->_customdata
->submission
->id
;
2598 $itemid = null; //TODO: this is wrong, itemid MUST be known when saving files!! (skodak)
2602 $editoroptions = $this->get_editor_options();
2603 switch ($this->_customdata
->assignment
->assignmenttype
) {
2605 case 'uploadsingle' :
2606 $data = file_postupdate_standard_filemanager($data, 'files', $editoroptions, $this->_customdata
->context
, 'mod_assignment', 'response', $itemid);
2611 $data = file_postupdate_standard_editor($data, 'submissioncomment', $editoroptions, $this->_customdata
->context
, $editoroptions['component'], $editoroptions['filearea'], $itemid);
2614 if ($this->use_advanced_grading() && !isset($data->advancedgrading
)) {
2615 $data->advancedgrading
= null;
2622 /// OTHER STANDARD FUNCTIONS ////////////////////////////////////////////////////////
2625 * Deletes an assignment instance
2627 * This is done by calling the delete_instance() method of the assignment type class
2629 function assignment_delete_instance($id){
2632 if (! $assignment = $DB->get_record('assignment', array('id'=>$id))) {
2636 // fall back to base class if plugin missing
2637 $classfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
2638 if (file_exists($classfile)) {
2639 require_once($classfile);
2640 $assignmentclass = "assignment_$assignment->assignmenttype";
2643 debugging("Missing assignment plug-in: {$assignment->assignmenttype}. Using base class for deleting instead.");
2644 $assignmentclass = "assignment_base";
2647 $ass = new $assignmentclass();
2648 return $ass->delete_instance($assignment);
2653 * Updates an assignment instance
2655 * This is done by calling the update_instance() method of the assignment type class
2657 function assignment_update_instance($assignment){
2660 $assignment->assignmenttype
= clean_param($assignment->assignmenttype
, PARAM_PLUGIN
);
2662 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2663 $assignmentclass = "assignment_$assignment->assignmenttype";
2664 $ass = new $assignmentclass();
2665 return $ass->update_instance($assignment);
2670 * Adds an assignment instance
2672 * This is done by calling the add_instance() method of the assignment type class
2674 function assignment_add_instance($assignment) {
2677 $assignment->assignmenttype
= clean_param($assignment->assignmenttype
, PARAM_PLUGIN
);
2679 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2680 $assignmentclass = "assignment_$assignment->assignmenttype";
2681 $ass = new $assignmentclass();
2682 return $ass->add_instance($assignment);
2687 * Returns an outline of a user interaction with an assignment
2689 * This is done by calling the user_outline() method of the assignment type class
2691 function assignment_user_outline($course, $user, $mod, $assignment) {
2694 require_once("$CFG->libdir/gradelib.php");
2695 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2696 $assignmentclass = "assignment_$assignment->assignmenttype";
2697 $ass = new $assignmentclass($mod->id
, $assignment, $mod, $course);
2698 $grades = grade_get_grades($course->id
, 'mod', 'assignment', $assignment->id
, $user->id
);
2699 if (!empty($grades->items
[0]->grades
)) {
2700 return $ass->user_outline(reset($grades->items
[0]->grades
));
2707 * Prints the complete info about a user's interaction with an assignment
2709 * This is done by calling the user_complete() method of the assignment type class
2711 function assignment_user_complete($course, $user, $mod, $assignment) {
2714 require_once("$CFG->libdir/gradelib.php");
2715 require_once("$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php");
2716 $assignmentclass = "assignment_$assignment->assignmenttype";
2717 $ass = new $assignmentclass($mod->id
, $assignment, $mod, $course);
2718 $grades = grade_get_grades($course->id
, 'mod', 'assignment', $assignment->id
, $user->id
);
2719 if (empty($grades->items
[0]->grades
)) {
2722 $grade = reset($grades->items
[0]->grades
);
2724 return $ass->user_complete($user, $grade);
2728 * Function to be run periodically according to the moodle cron
2730 * Finds all assignment notifications that have yet to be mailed out, and mails them
2732 function assignment_cron () {
2733 global $CFG, $USER, $DB;
2735 /// first execute all crons in plugins
2736 if ($plugins = get_plugin_list('assignment')) {
2737 foreach ($plugins as $plugin=>$dir) {
2738 require_once("$dir/assignment.class.php");
2739 $assignmentclass = "assignment_$plugin";
2740 $ass = new $assignmentclass();
2745 /// Notices older than 1 day will not be mailed. This is to avoid the problem where
2746 /// cron has not been running for a long time, and then suddenly people are flooded
2747 /// with mail from the past few weeks or months
2750 $endtime = $timenow - $CFG->maxeditingtime
;
2751 $starttime = $endtime - 24 * 3600; /// One day earlier
2753 if ($submissions = assignment_get_unmailed_submissions($starttime, $endtime)) {
2755 $realuser = clone($USER);
2757 foreach ($submissions as $key => $submission) {
2758 $DB->set_field("assignment_submissions", "mailed", "1", array("id"=>$submission->id
));
2763 foreach ($submissions as $submission) {
2765 echo "Processing assignment submission $submission->id\n";
2767 if (! $user = $DB->get_record("user", array("id"=>$submission->userid
))) {
2768 echo "Could not find user $user->id\n";
2772 if (! $course = $DB->get_record("course", array("id"=>$submission->course
))) {
2773 echo "Could not find course $submission->course\n";
2777 /// Override the language and timezone of the "current" user, so that
2778 /// mail is customised for the receiver.
2779 cron_setup_user($user, $course);
2781 $coursecontext = get_context_instance(CONTEXT_COURSE
, $submission->course
);
2782 $courseshortname = format_string($course->shortname
, true, array('context' => $coursecontext));
2783 if (!is_enrolled($coursecontext, $user->id
)) {
2784 echo fullname($user)." not an active participant in " . $courseshortname . "\n";
2788 if (! $teacher = $DB->get_record("user", array("id"=>$submission->teacher
))) {
2789 echo "Could not find teacher $submission->teacher\n";
2793 if (! $mod = get_coursemodule_from_instance("assignment", $submission->assignment
, $course->id
)) {
2794 echo "Could not find course module for assignment id $submission->assignment\n";
2798 if (! $mod->visible
) { /// Hold mail notification for hidden assignments until later
2802 $strassignments = get_string("modulenameplural", "assignment");
2803 $strassignment = get_string("modulename", "assignment");
2805 $assignmentinfo = new stdClass();
2806 $assignmentinfo->teacher
= fullname($teacher);
2807 $assignmentinfo->assignment
= format_string($submission->name
,true);
2808 $assignmentinfo->url
= "$CFG->wwwroot/mod/assignment/view.php?id=$mod->id";
2810 $postsubject = "$courseshortname: $strassignments: ".format_string($submission->name
,true);
2811 $posttext = "$courseshortname -> $strassignments -> ".format_string($submission->name
,true)."\n";
2812 $posttext .= "---------------------------------------------------------------------\n";
2813 $posttext .= get_string("assignmentmail", "assignment", $assignmentinfo)."\n";
2814 $posttext .= "---------------------------------------------------------------------\n";
2816 if ($user->mailformat
== 1) { // HTML
2817 $posthtml = "<p><font face=\"sans-serif\">".
2818 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$courseshortname</a> ->".
2819 "<a href=\"$CFG->wwwroot/mod/assignment/index.php?id=$course->id\">$strassignments</a> ->".
2820 "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id=$mod->id\">".format_string($submission->name
,true)."</a></font></p>";
2821 $posthtml .= "<hr /><font face=\"sans-serif\">";
2822 $posthtml .= "<p>".get_string("assignmentmailhtml", "assignment", $assignmentinfo)."</p>";
2823 $posthtml .= "</font><hr />";
2828 $eventdata = new stdClass();
2829 $eventdata->modulename
= 'assignment';
2830 $eventdata->userfrom
= $teacher;
2831 $eventdata->userto
= $user;
2832 $eventdata->subject
= $postsubject;
2833 $eventdata->fullmessage
= $posttext;
2834 $eventdata->fullmessageformat
= FORMAT_PLAIN
;
2835 $eventdata->fullmessagehtml
= $posthtml;
2836 $eventdata->smallmessage
= get_string('assignmentmailsmall', 'assignment', $assignmentinfo);
2838 $eventdata->name
= 'assignment_updates';
2839 $eventdata->component
= 'mod_assignment';
2840 $eventdata->notification
= 1;
2841 $eventdata->contexturl
= $assignmentinfo->url
;
2842 $eventdata->contexturlname
= $assignmentinfo->assignment
;
2844 message_send($eventdata);
2854 * Return grade for given user or all users.
2856 * @param int $assignmentid id of assignment
2857 * @param int $userid optional user id, 0 means all users
2858 * @return array array of grades, false if none
2860 function assignment_get_user_grades($assignment, $userid=0) {
2864 $user = "AND u.id = :userid";
2865 $params = array('userid'=>$userid);
2869 $params['aid'] = $assignment->id
;
2871 $sql = "SELECT u.id, u.id AS userid, s.grade AS rawgrade, s.submissioncomment AS feedback, s.format AS feedbackformat,
2872 s.teacher AS usermodified, s.timemarked AS dategraded, s.timemodified AS datesubmitted
2873 FROM {user} u, {assignment_submissions} s
2874 WHERE u.id = s.userid AND s.assignment = :aid
2877 return $DB->get_records_sql($sql, $params);
2881 * Update activity grades
2883 * @param object $assignment
2884 * @param int $userid specific user only, 0 means all
2886 function assignment_update_grades($assignment, $userid=0, $nullifnone=true) {
2888 require_once($CFG->libdir
.'/gradelib.php');
2890 if ($assignment->grade
== 0) {
2891 assignment_grade_item_update($assignment);
2893 } else if ($grades = assignment_get_user_grades($assignment, $userid)) {
2894 foreach($grades as $k=>$v) {
2895 if ($v->rawgrade
== -1) {
2896 $grades[$k]->rawgrade
= null;
2899 assignment_grade_item_update($assignment, $grades);
2902 assignment_grade_item_update($assignment);
2907 * Update all grades in gradebook.
2909 function assignment_upgrade_grades() {
2912 $sql = "SELECT COUNT('x')
2913 FROM {assignment} a, {course_modules} cm, {modules} m
2914 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2915 $count = $DB->count_records_sql($sql);
2917 $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
2918 FROM {assignment} a, {course_modules} cm, {modules} m
2919 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id";
2920 $rs = $DB->get_recordset_sql($sql);
2922 // too much debug output
2923 $pbar = new progress_bar('assignmentupgradegrades', 500, true);
2925 foreach ($rs as $assignment) {
2927 upgrade_set_timeout(60*5); // set up timeout, may also abort execution
2928 assignment_update_grades($assignment);
2929 $pbar->update($i, $count, "Updating Assignment grades ($i/$count).");
2931 upgrade_set_timeout(); // reset to default timeout
2937 * Create grade item for given assignment
2939 * @param object $assignment object with extra cmidnumber
2940 * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
2941 * @return int 0 if ok, error code otherwise
2943 function assignment_grade_item_update($assignment, $grades=NULL) {
2945 require_once($CFG->libdir
.'/gradelib.php');
2947 if (!isset($assignment->courseid
)) {
2948 $assignment->courseid
= $assignment->course
;
2951 $params = array('itemname'=>$assignment->name
, 'idnumber'=>$assignment->cmidnumber
);
2953 if ($assignment->grade
> 0) {
2954 $params['gradetype'] = GRADE_TYPE_VALUE
;
2955 $params['grademax'] = $assignment->grade
;
2956 $params['grademin'] = 0;
2958 } else if ($assignment->grade
< 0) {
2959 $params['gradetype'] = GRADE_TYPE_SCALE
;
2960 $params['scaleid'] = -$assignment->grade
;
2963 $params['gradetype'] = GRADE_TYPE_TEXT
; // allow text comments only
2966 if ($grades === 'reset') {
2967 $params['reset'] = true;
2971 return grade_update('mod/assignment', $assignment->courseid
, 'mod', 'assignment', $assignment->id
, 0, $grades, $params);
2975 * Delete grade item for given assignment
2977 * @param object $assignment object
2978 * @return object assignment
2980 function assignment_grade_item_delete($assignment) {
2982 require_once($CFG->libdir
.'/gradelib.php');
2984 if (!isset($assignment->courseid
)) {
2985 $assignment->courseid
= $assignment->course
;
2988 return grade_update('mod/assignment', $assignment->courseid
, 'mod', 'assignment', $assignment->id
, 0, NULL, array('deleted'=>1));
2992 * Returns the users with data in one assignment (students and teachers)
2994 * @todo: deprecated - to be deleted in 2.2
2996 * @param $assignmentid int
2997 * @return array of user objects
2999 function assignment_get_participants($assignmentid) {
3003 $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
3005 {assignment_submissions} a
3006 WHERE a.assignment = ? and
3007 u.id = a.userid", array($assignmentid));
3009 $teachers = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
3011 {assignment_submissions} a
3012 WHERE a.assignment = ? and
3013 u.id = a.teacher", array($assignmentid));
3015 //Add teachers to students
3017 foreach ($teachers as $teacher) {
3018 $students[$teacher->id
] = $teacher;
3021 //Return students array (it contains an array of unique users)
3026 * Serves assignment submissions and other files.
3028 * @param object $course
3030 * @param object $context
3031 * @param string $filearea
3032 * @param array $args
3033 * @param bool $forcedownload
3034 * @return bool false if file not found, does not return if found - just send the file
3036 function assignment_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
3039 if ($context->contextlevel
!= CONTEXT_MODULE
) {
3043 require_login($course, false, $cm);
3045 if (!$assignment = $DB->get_record('assignment', array('id'=>$cm->instance
))) {
3049 require_once($CFG->dirroot
.'/mod/assignment/type/'.$assignment->assignmenttype
.'/assignment.class.php');
3050 $assignmentclass = 'assignment_'.$assignment->assignmenttype
;
3051 $assignmentinstance = new $assignmentclass($cm->id
, $assignment, $cm, $course);
3053 return $assignmentinstance->send_file($filearea, $args);
3056 * Checks if a scale is being used by an assignment
3058 * This is used by the backup code to decide whether to back up a scale
3059 * @param $assignmentid int
3060 * @param $scaleid int
3061 * @return boolean True if the scale is used by the assignment
3063 function assignment_scale_used($assignmentid, $scaleid) {
3068 $rec = $DB->get_record('assignment', array('id'=>$assignmentid,'grade'=>-$scaleid));
3070 if (!empty($rec) && !empty($scaleid)) {
3078 * Checks if scale is being used by any instance of assignment
3080 * This is used to find out if scale used anywhere
3081 * @param $scaleid int
3082 * @return boolean True if the scale is used by any assignment
3084 function assignment_scale_used_anywhere($scaleid) {
3087 if ($scaleid and $DB->record_exists('assignment', array('grade'=>-$scaleid))) {
3095 * Make sure up-to-date events are created for all assignment instances
3097 * This standard function will check all instances of this module
3098 * and make sure there are up-to-date events created for each of them.
3099 * If courseid = 0, then every assignment event in the site is checked, else
3100 * only assignment events belonging to the course specified are checked.
3101 * This function is used, in its new format, by restore_refresh_events()
3103 * @param $courseid int optional If zero then all assignments for all courses are covered
3104 * @return boolean Always returns true
3106 function assignment_refresh_events($courseid = 0) {
3109 if ($courseid == 0) {
3110 if (! $assignments = $DB->get_records("assignment")) {
3114 if (! $assignments = $DB->get_records("assignment", array("course"=>$courseid))) {
3118 $moduleid = $DB->get_field('modules', 'id', array('name'=>'assignment'));
3120 foreach ($assignments as $assignment) {
3121 $cm = get_coursemodule_from_id('assignment', $assignment->id
);
3122 $event = new stdClass();
3123 $event->name
= $assignment->name
;
3124 $event->description
= format_module_intro('assignment', $assignment, $cm->id
);
3125 $event->timestart
= $assignment->timedue
;
3127 if ($event->id
= $DB->get_field('event', 'id', array('modulename'=>'assignment', 'instance'=>$assignment->id
))) {
3128 update_event($event);
3131 $event->courseid
= $assignment->course
;
3132 $event->groupid
= 0;
3134 $event->modulename
= 'assignment';
3135 $event->instance
= $assignment->id
;
3136 $event->eventtype
= 'due';
3137 $event->timeduration
= 0;
3138 $event->visible
= $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$assignment->id
));
3147 * Print recent activity from all assignments in a given course
3149 * This is used by the recent activity block
3151 function assignment_print_recent_activity($course, $viewfullnames, $timestart) {
3152 global $CFG, $USER, $DB, $OUTPUT;
3154 // do not use log table if possible, it may be huge
3156 if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified, cm.id AS cmid, asb.userid,
3157 u.firstname, u.lastname, u.email, u.picture
3158 FROM {assignment_submissions} asb
3159 JOIN {assignment} a ON a.id = asb.assignment
3160 JOIN {course_modules} cm ON cm.instance = a.id
3161 JOIN {modules} md ON md.id = cm.module
3162 JOIN {user} u ON u.id = asb.userid
3163 WHERE asb.timemodified > ? AND
3165 md.name = 'assignment'
3166 ORDER BY asb.timemodified ASC", array($timestart, $course->id
))) {
3170 $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups
3174 foreach($submissions as $submission) {
3175 if (!array_key_exists($submission->cmid
, $modinfo->cms
)) {
3178 $cm = $modinfo->cms
[$submission->cmid
];
3179 if (!$cm->uservisible
) {
3182 if ($submission->userid
== $USER->id
) {
3183 $show[] = $submission;
3187 // the act of sumbitting of assignment may be considered private - only graders will see it if specified
3188 if (empty($CFG->assignment_showrecentsubmissions
)) {
3189 if (!array_key_exists($cm->id
, $grader)) {
3190 $grader[$cm->id
] = has_capability('moodle/grade:viewall', get_context_instance(CONTEXT_MODULE
, $cm->id
));
3192 if (!$grader[$cm->id
]) {
3197 $groupmode = groups_get_activity_groupmode($cm, $course);
3199 if ($groupmode == SEPARATEGROUPS
and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE
, $cm->id
))) {
3200 if (isguestuser()) {
3201 // shortcut - guest user does not belong into any group
3205 if (is_null($modinfo->groups
)) {
3206 $modinfo->groups
= groups_get_user_groups($course->id
); // load all my groups and cache it in modinfo
3209 // this will be slow - show only users that share group with me in this cm
3210 if (empty($modinfo->groups
[$cm->id
])) {
3213 $usersgroups = groups_get_all_groups($course->id
, $submission->userid
, $cm->groupingid
);
3214 if (is_array($usersgroups)) {
3215 $usersgroups = array_keys($usersgroups);
3216 $intersect = array_intersect($usersgroups, $modinfo->groups
[$cm->id
]);
3217 if (empty($intersect)) {
3222 $show[] = $submission;
3229 echo $OUTPUT->heading(get_string('newsubmissions', 'assignment').':', 3);
3231 foreach ($show as $submission) {
3232 $cm = $modinfo->cms
[$submission->cmid
];
3233 $link = $CFG->wwwroot
.'/mod/assignment/view.php?id='.$cm->id
;
3234 print_recent_activity_note($submission->timemodified
, $submission, $cm->name
, $link, false, $viewfullnames);
3242 * Returns all assignments since a given time in specified forum.
3244 function assignment_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0) {
3245 global $CFG, $COURSE, $USER, $DB;
3247 if ($COURSE->id
== $courseid) {
3250 $course = $DB->get_record('course', array('id'=>$courseid));
3253 $modinfo =& get_fast_modinfo($course);
3255 $cm = $modinfo->cms
[$cmid];
3259 $userselect = "AND u.id = :userid";
3260 $params['userid'] = $userid;
3266 $groupselect = "AND gm.groupid = :groupid";
3267 $groupjoin = "JOIN {groups_members} gm ON gm.userid=u.id";
3268 $params['groupid'] = $groupid;
3274 $params['cminstance'] = $cm->instance
;
3275 $params['timestart'] = $timestart;
3277 $userfields = user_picture
::fields('u', null, 'userid');
3279 if (!$submissions = $DB->get_records_sql("SELECT asb.id, asb.timemodified,
3281 FROM {assignment_submissions} asb
3282 JOIN {assignment} a ON a.id = asb.assignment
3283 JOIN {user} u ON u.id = asb.userid
3285 WHERE asb.timemodified > :timestart AND a.id = :cminstance
3286 $userselect $groupselect
3287 ORDER BY asb.timemodified ASC", $params)) {
3291 $groupmode = groups_get_activity_groupmode($cm, $course);
3292 $cm_context = get_context_instance(CONTEXT_MODULE
, $cm->id
);
3293 $grader = has_capability('moodle/grade:viewall', $cm_context);
3294 $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
3295 $viewfullnames = has_capability('moodle/site:viewfullnames', $cm_context);
3297 if (is_null($modinfo->groups
)) {
3298 $modinfo->groups
= groups_get_user_groups($course->id
); // load all my groups and cache it in modinfo
3303 foreach($submissions as $submission) {
3304 if ($submission->userid
== $USER->id
) {
3305 $show[] = $submission;
3308 // the act of submitting of assignment may be considered private - only graders will see it if specified
3309 if (empty($CFG->assignment_showrecentsubmissions
)) {
3315 if ($groupmode == SEPARATEGROUPS
and !$accessallgroups) {
3316 if (isguestuser()) {
3317 // shortcut - guest user does not belong into any group
3321 // this will be slow - show only users that share group with me in this cm
3322 if (empty($modinfo->groups
[$cm->id
])) {
3325 $usersgroups = groups_get_all_groups($course->id
, $cm->userid
, $cm->groupingid
);
3326 if (is_array($usersgroups)) {
3327 $usersgroups = array_keys($usersgroups);
3328 $intersect = array_intersect($usersgroups, $modinfo->groups
[$cm->id
]);
3329 if (empty($intersect)) {
3334 $show[] = $submission;
3342 require_once($CFG->libdir
.'/gradelib.php');
3344 foreach ($show as $id=>$submission) {
3345 $userids[] = $submission->userid
;
3348 $grades = grade_get_grades($courseid, 'mod', 'assignment', $cm->instance
, $userids);
3351 $aname = format_string($cm->name
,true);
3352 foreach ($show as $submission) {
3353 $tmpactivity = new stdClass();
3355 $tmpactivity->type
= 'assignment';
3356 $tmpactivity->cmid
= $cm->id
;
3357 $tmpactivity->name
= $aname;
3358 $tmpactivity->sectionnum
= $cm->sectionnum
;
3359 $tmpactivity->timestamp
= $submission->timemodified
;
3362 $tmpactivity->grade
= $grades->items
[0]->grades
[$submission->userid
]->str_long_grade
;
3365 $userfields = explode(',', user_picture
::fields());
3366 foreach ($userfields as $userfield) {
3367 if ($userfield == 'id') {
3368 $tmpactivity->user
->{$userfield} = $submission->userid
; // aliased in SQL above
3370 $tmpactivity->user
->{$userfield} = $submission->{$userfield};
3373 $tmpactivity->user
->fullname
= fullname($submission, $viewfullnames);
3375 $activities[$index++
] = $tmpactivity;
3382 * Print recent activity from all assignments in a given course
3384 * This is used by course/recent.php
3386 function assignment_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
3387 global $CFG, $OUTPUT;
3389 echo '<table border="0" cellpadding="3" cellspacing="0" class="assignment-recent">';
3391 echo "<tr><td class=\"userpicture\" valign=\"top\">";
3392 echo $OUTPUT->user_picture($activity->user
);
3396 $modname = $modnames[$activity->type
];
3397 echo '<div class="title">';
3398 echo "<img src=\"" . $OUTPUT->pix_url('icon', 'assignment') . "\" ".
3399 "class=\"icon\" alt=\"$modname\">";
3400 echo "<a href=\"$CFG->wwwroot/mod/assignment/view.php?id={$activity->cmid}\">{$activity->name}</a>";
3404 if (isset($activity->grade
)) {
3405 echo '<div class="grade">';
3406 echo get_string('grade').': ';
3407 echo $activity->grade
;
3411 echo '<div class="user">';
3412 echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&course=$courseid\">"
3413 ."{$activity->user->fullname}</a> - ".userdate($activity->timestamp
);
3416 echo "</td></tr></table>";
3419 /// GENERIC SQL FUNCTIONS
3422 * Fetch info from logs
3424 * @param $log object with properties ->info (the assignment id) and ->userid
3425 * @return array with assignment name and user firstname and lastname
3427 function assignment_log_info($log) {
3430 return $DB->get_record_sql("SELECT a.name, u.firstname, u.lastname
3431 FROM {assignment} a, {user} u
3432 WHERE a.id = ? AND u.id = ?", array($log->info
, $log->userid
));
3436 * Return list of marked submissions that have not been mailed out for currently enrolled students
3440 function assignment_get_unmailed_submissions($starttime, $endtime) {
3443 return $DB->get_records_sql("SELECT s.*, a.course, a.name
3444 FROM {assignment_submissions} s,
3447 AND s.timemarked <= ?
3448 AND s.timemarked >= ?
3449 AND s.assignment = a.id", array($endtime, $starttime));
3453 * Counts all real assignment submissions by ENROLLED students (not empty ones)
3455 * There are also assignment type methods count_real_submissions() which in the default
3456 * implementation simply call this function.
3457 * @param $groupid int optional If nonzero then count is restricted to this group
3458 * @return int The number of submissions
3460 function assignment_count_real_submissions($cm, $groupid=0) {
3463 $context = get_context_instance(CONTEXT_MODULE
, $cm->id
);
3465 // this is all the users with this capability set, in this context or higher
3466 if ($users = get_enrolled_users($context, 'mod/assignment:view', $groupid, 'u.id')) {
3467 $users = array_keys($users);
3470 // if groupmembersonly used, remove users who are not in any group
3471 if ($users and !empty($CFG->enablegroupmembersonly
) and $cm->groupmembersonly
) {
3472 if ($groupingusers = groups_get_grouping_members($cm->groupingid
, 'u.id', 'u.id')) {
3473 $users = array_intersect($users, array_keys($groupingusers));
3477 if (empty($users)) {
3481 $userlists = implode(',', $users);
3483 return $DB->count_records_sql("SELECT COUNT('x')
3484 FROM {assignment_submissions}
3485 WHERE assignment = ? AND
3486 timemodified > 0 AND
3487 userid IN ($userlists)", array($cm->instance
));
3492 * Return all assignment submissions by ENROLLED students (even empty)
3494 * There are also assignment type methods get_submissions() wich in the default
3495 * implementation simply call this function.
3496 * @param $sort string optional field names for the ORDER BY in the sql query
3497 * @param $dir string optional specifying the sort direction, defaults to DESC
3498 * @return array The submission objects indexed by id
3500 function assignment_get_all_submissions($assignment, $sort="", $dir="DESC") {
3501 /// Return all assignment submissions by ENROLLED students (even empty)
3504 if ($sort == "lastname" or $sort == "firstname") {
3505 $sort = "u.$sort $dir";
3506 } else if (empty($sort)) {
3507 $sort = "a.timemodified DESC";
3509 $sort = "a.$sort $dir";
3512 /* not sure this is needed at all since assignment already has a course define, so this join?
3513 $select = "s.course = '$assignment->course' AND";
3514 if ($assignment->course == SITEID) {
3518 return $DB->get_records_sql("SELECT a.*
3519 FROM {assignment_submissions} a, {user} u
3520 WHERE u.id = a.userid
3521 AND a.assignment = ?
3522 ORDER BY $sort", array($assignment->id
));
3527 * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
3528 * for the course (see resource).
3530 * Given a course_module object, this function returns any "extra" information that may be needed
3531 * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php.
3533 * @param $coursemodule object The coursemodule object (record).
3534 * @return cached_cm_info An object on information that the courses will know about (most noticeably, an icon).
3536 function assignment_get_coursemodule_info($coursemodule) {
3539 if (! $assignment = $DB->get_record('assignment', array('id'=>$coursemodule->instance
),
3540 'id, assignmenttype, name, intro, introformat')) {
3544 $libfile = "$CFG->dirroot/mod/assignment/type/$assignment->assignmenttype/assignment.class.php";
3546 if (file_exists($libfile)) {
3547 require_once($libfile);
3548 $assignmentclass = "assignment_$assignment->assignmenttype";
3549 $ass = new $assignmentclass('staticonly');
3550 if (!($result = $ass->get_coursemodule_info($coursemodule))) {
3551 $result = new cached_cm_info();
3552 $result->name
= $assignment->name
;
3554 if ($coursemodule->showdescription
) {
3555 // Convert intro to html. Do not filter cached version, filters run at display time.
3556 $result->content
= format_module_intro('assignment', $assignment, $coursemodule->id
, false);
3560 debugging('Incorrect assignment type: '.$assignment->assignmenttype
);
3567 /// OTHER GENERAL FUNCTIONS FOR ASSIGNMENTS ///////////////////////////////////////
3570 * Returns an array of installed assignment types indexed and sorted by name
3572 * @return array The index is the name of the assignment type, the value its full name from the language strings
3574 function assignment_types() {
3576 $names = get_plugin_list('assignment');
3577 foreach ($names as $name=>$dir) {
3578 $types[$name] = get_string('type'.$name, 'assignment');
3580 // ugly hack to support pluggable assignment type titles..
3581 if ($types[$name] == '[[type'.$name.']]') {
3582 $types[$name] = get_string('type'.$name, 'assignment_'.$name);
3589 function assignment_print_overview($courses, &$htmlarray) {
3590 global $USER, $CFG, $DB;
3592 if (empty($courses) ||
!is_array($courses) ||
count($courses) == 0) {
3596 if (!$assignments = get_all_instances_in_courses('assignment',$courses)) {
3600 $assignmentids = array();
3602 // Do assignment_base::isopen() here without loading the whole thing for speed
3603 foreach ($assignments as $key => $assignment) {
3605 if ($assignment->timedue
) {
3606 if ($assignment->preventlate
) {
3607 $isopen = ($assignment->timeavailable
<= $time && $time <= $assignment->timedue
);
3609 $isopen = ($assignment->timeavailable
<= $time);
3612 if (empty($isopen) ||
empty($assignment->timedue
)) {
3613 unset($assignments[$key]);
3615 $assignmentids[] = $assignment->id
;
3619 if (empty($assignmentids)){
3620 // no assignments to look at - we're done
3624 $strduedate = get_string('duedate', 'assignment');
3625 $strduedateno = get_string('duedateno', 'assignment');
3626 $strgraded = get_string('graded', 'assignment');
3627 $strnotgradedyet = get_string('notgradedyet', 'assignment');
3628 $strnotsubmittedyet = get_string('notsubmittedyet', 'assignment');
3629 $strsubmitted = get_string('submitted', 'assignment');
3630 $strassignment = get_string('modulename', 'assignment');
3631 $strreviewed = get_string('reviewed','assignment');
3634 // NOTE: we do all possible database work here *outside* of the loop to ensure this scales
3636 list($sqlassignmentids, $assignmentidparams) = $DB->get_in_or_equal($assignmentids);
3638 // build up and array of unmarked submissions indexed by assignment id/ userid
3639 // for use where the user has grading rights on assignment
3640 $rs = $DB->get_recordset_sql("SELECT id, assignment, userid
3641 FROM {assignment_submissions}
3642 WHERE teacher = 0 AND timemarked = 0
3643 AND assignment $sqlassignmentids", $assignmentidparams);
3645 $unmarkedsubmissions = array();
3646 foreach ($rs as $rd) {
3647 $unmarkedsubmissions[$rd->assignment
][$rd->userid
] = $rd->id
;
3652 // get all user submissions, indexed by assignment id
3653 $mysubmissions = $DB->get_records_sql("SELECT assignment, timemarked, teacher, grade
3654 FROM {assignment_submissions}
3655 WHERE userid = ? AND
3656 assignment $sqlassignmentids", array_merge(array($USER->id
), $assignmentidparams));
3658 foreach ($assignments as $assignment) {
3659 $str = '<div class="assignment overview"><div class="name">'.$strassignment. ': '.
3660 '<a '.($assignment->visible ?
'':' class="dimmed"').
3661 'title="'.$strassignment.'" href="'.$CFG->wwwroot
.
3662 '/mod/assignment/view.php?id='.$assignment->coursemodule
.'">'.
3663 $assignment->name
.'</a></div>';
3664 if ($assignment->timedue
) {
3665 $str .= '<div class="info">'.$strduedate.': '.userdate($assignment->timedue
).'</div>';
3667 $str .= '<div class="info">'.$strduedateno.'</div>';
3669 $context = get_context_instance(CONTEXT_MODULE
, $assignment->coursemodule
);
3670 if (has_capability('mod/assignment:grade', $context)) {
3672 // count how many people can submit
3673 $submissions = 0; // init
3674 if ($students = get_enrolled_users($context, 'mod/assignment:view', 0, 'u.id')) {
3675 foreach ($students as $student) {
3676 if (isset($unmarkedsubmissions[$assignment->id
][$student->id
])) {
3683 $link = new moodle_url('/mod/assignment/submissions.php', array('id'=>$assignment->coursemodule
));
3684 $str .= '<div class="details"><a href="'.$link.'">'.get_string('submissionsnotgraded', 'assignment', $submissions).'</a></div>';
3687 $str .= '<div class="details">';
3688 if (isset($mysubmissions[$assignment->id
])) {
3690 $submission = $mysubmissions[$assignment->id
];
3692 if ($submission->teacher
== 0 && $submission->timemarked
== 0) {
3693 $str .= $strsubmitted . ', ' . $strnotgradedyet;
3694 } else if ($submission->grade
<= 0) {
3695 $str .= $strsubmitted . ', ' . $strreviewed;
3697 $str .= $strsubmitted . ', ' . $strgraded;
3700 $str .= $strnotsubmittedyet . ' ' . assignment_display_lateness(time(), $assignment->timedue
);
3705 if (empty($htmlarray[$assignment->course
]['assignment'])) {
3706 $htmlarray[$assignment->course
]['assignment'] = $str;
3708 $htmlarray[$assignment->course
]['assignment'] .= $str;
3713 function assignment_display_lateness($timesubmitted, $timedue) {
3717 $time = $timedue - $timesubmitted;
3719 $timetext = get_string('late', 'assignment', format_time($time));
3720 return ' (<span class="late">'.$timetext.'</span>)';
3722 $timetext = get_string('early', 'assignment', format_time($time));
3723 return ' (<span class="early">'.$timetext.'</span>)';
3727 function assignment_get_view_actions() {
3728 return array('view');
3731 function assignment_get_post_actions() {
3732 return array('upload');
3735 function assignment_get_types() {
3739 $type = new stdClass();
3740 $type->modclass
= MOD_CLASS_ACTIVITY
;
3741 $type->type
= "assignment_group_start";
3742 $type->typestr
= '--'.get_string('modulenameplural', 'assignment');
3745 $standardassignments = array('upload','online','uploadsingle','offline');
3746 foreach ($standardassignments as $assignmenttype) {
3747 $type = new stdClass();
3748 $type->modclass
= MOD_CLASS_ACTIVITY
;
3749 $type->type
= "assignment&type=$assignmenttype";
3750 $type->typestr
= get_string("type$assignmenttype", 'assignment');
3754 /// Drop-in extra assignment types
3755 $assignmenttypes = get_list_of_plugins('mod/assignment/type');
3756 foreach ($assignmenttypes as $assignmenttype) {
3757 if (!empty($CFG->{'assignment_hide_'.$assignmenttype})) { // Not wanted
3760 if (!in_array($assignmenttype, $standardassignments)) {
3761 $type = new stdClass();
3762 $type->modclass
= MOD_CLASS_ACTIVITY
;
3763 $type->type
= "assignment&type=$assignmenttype";
3764 $type->typestr
= get_string("type$assignmenttype", 'assignment_'.$assignmenttype);
3769 $type = new stdClass();
3770 $type->modclass
= MOD_CLASS_ACTIVITY
;
3771 $type->type
= "assignment_group_end";
3772 $type->typestr
= '--';
3779 * Removes all grades from gradebook
3780 * @param int $courseid
3781 * @param string optional type
3783 function assignment_reset_gradebook($courseid, $type='') {
3786 $params = array('courseid'=>$courseid);
3788 $type = "AND a.assignmenttype= :type";
3789 $params['type'] = $type;
3792 $sql = "SELECT a.*, cm.idnumber as cmidnumber, a.course as courseid
3793 FROM {assignment} a, {course_modules} cm, {modules} m
3794 WHERE m.name='assignment' AND m.id=cm.module AND cm.instance=a.id AND a.course=:courseid $type";
3796 if ($assignments = $DB->get_records_sql($sql, $params)) {
3797 foreach ($assignments as $assignment) {
3798 assignment_grade_item_update($assignment, 'reset');
3804 * This function is used by the reset_course_userdata function in moodlelib.
3805 * This function will remove all posts from the specified assignment
3806 * and clean up any related data.
3807 * @param $data the data submitted from the reset course.
3808 * @return array status array
3810 function assignment_reset_userdata($data) {
3814 foreach (get_plugin_list('assignment') as $type=>$dir) {
3815 require_once("$dir/assignment.class.php");
3816 $assignmentclass = "assignment_$type";
3817 $ass = new $assignmentclass();
3818 $status = array_merge($status, $ass->reset_userdata($data));
3825 * Implementation of the function for printing the form elements that control
3826 * whether the course reset functionality affects the assignment.
3827 * @param $mform form passed by reference
3829 function assignment_reset_course_form_definition(&$mform) {
3830 $mform->addElement('header', 'assignmentheader', get_string('modulenameplural', 'assignment'));
3831 $mform->addElement('advcheckbox', 'reset_assignment_submissions', get_string('deleteallsubmissions','assignment'));
3835 * Course reset form defaults.
3837 function assignment_reset_course_form_defaults($course) {
3838 return array('reset_assignment_submissions'=>1);
3842 * Returns all other caps used in module
3844 function assignment_get_extra_capabilities() {
3845 return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/grade:managegradingforms');
3849 * @param string $feature FEATURE_xx constant for requested feature
3850 * @return mixed True if module supports feature, null if doesn't know
3852 function assignment_supports($feature) {
3854 case FEATURE_GROUPS
: return true;
3855 case FEATURE_GROUPINGS
: return true;
3856 case FEATURE_GROUPMEMBERSONLY
: return true;
3857 case FEATURE_MOD_INTRO
: return true;
3858 case FEATURE_COMPLETION_TRACKS_VIEWS
: return true;
3859 case FEATURE_GRADE_HAS_GRADE
: return true;
3860 case FEATURE_GRADE_OUTCOMES
: return true;
3861 case FEATURE_GRADE_HAS_GRADE
: return true;
3862 case FEATURE_BACKUP_MOODLE2
: return true;
3863 case FEATURE_SHOW_DESCRIPTION
: return true;
3864 case FEATURE_ADVANCED_GRADING
: return true;
3866 default: return null;
3871 * Adds module specific settings to the settings block
3873 * @param settings_navigation $settings The settings navigation object
3874 * @param navigation_node $assignmentnode The node to add module settings to
3876 function assignment_extend_settings_navigation(settings_navigation
$settings, navigation_node
$assignmentnode) {
3877 global $PAGE, $DB, $USER, $CFG;
3879 $assignmentrow = $DB->get_record("assignment", array("id" => $PAGE->cm
->instance
));
3880 require_once "$CFG->dirroot/mod/assignment/type/$assignmentrow->assignmenttype/assignment.class.php";
3882 $assignmentclass = 'assignment_'.$assignmentrow->assignmenttype
;
3883 $assignmentinstance = new $assignmentclass($PAGE->cm
->id
, $assignmentrow, $PAGE->cm
, $PAGE->course
);
3887 // Add assignment submission information
3888 if (has_capability('mod/assignment:grade', $PAGE->cm
->context
)) {
3889 if ($allgroups && has_capability('moodle/site:accessallgroups', $PAGE->cm
->context
)) {
3892 $group = groups_get_activity_group($PAGE->cm
);
3894 $link = new moodle_url('/mod/assignment/submissions.php', array('id'=>$PAGE->cm
->id
));
3895 if ($assignmentrow->assignmenttype
== 'offline') {
3896 $string = get_string('viewfeedback', 'assignment');
3897 } else if ($count = $assignmentinstance->count_real_submissions($group)) {
3898 $string = get_string('viewsubmissions', 'assignment', $count);
3900 $string = get_string('noattempts', 'assignment');
3902 $assignmentnode->add($string, $link, navigation_node
::TYPE_SETTING
);
3905 if (is_object($assignmentinstance) && method_exists($assignmentinstance, 'extend_settings_navigation')) {
3906 $assignmentinstance->extend_settings_navigation($assignmentnode);
3911 * generate zip file from array of given files
3912 * @param array $filesforzipping - array of files to pass into archive_to_pathname
3913 * @return path of temp file - note this returned file does not have a .zip extension - it is a temp file.
3915 function assignment_pack_files($filesforzipping) {
3917 //create path for new zip file.
3918 $tempzip = tempnam($CFG->tempdir
.'/', 'assignment_');
3920 $zipper = new zip_packer();
3921 if ($zipper->archive_to_pathname($filesforzipping, $tempzip)) {
3928 * Lists all file areas current user may browse
3930 * @param object $course
3932 * @param object $context
3935 function assignment_get_file_areas($course, $cm, $context) {
3937 if (has_capability('moodle/course:managefiles', $context)) {
3938 $areas['submission'] = get_string('assignmentsubmission', 'assignment');
3944 * Return a list of page types
3945 * @param string $pagetype current page type
3946 * @param stdClass $parentcontext Block's parent context
3947 * @param stdClass $currentcontext Current context of block
3949 function assignment_page_type_list($pagetype, $parentcontext, $currentcontext) {
3950 $module_pagetype = array(
3951 'mod-assignment-*'=>get_string('page-mod-assignment-x', 'assignment'),
3952 'mod-assignment-view'=>get_string('page-mod-assignment-view', 'assignment'),
3953 'mod-assignment-submissions'=>get_string('page-mod-assignment-submissions', 'assignment')
3955 return $module_pagetype;
3959 * Lists all gradable areas for the advanced grading methods gramework
3963 function assignment_grading_areas_list() {
3964 return array('submission' => get_string('submissions', 'mod_assignment'));