MDL-43289 mod_assign: Creation of new submission events.
[moodle.git] / mod / assign / submission / file / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the definition for the library class for file submission plugin
19  *
20  * This class provides all the functionality for the new assign module.
21  *
22  * @package assignsubmission_file
23  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require_once($CFG->libdir.'/eventslib.php');
29 defined('MOODLE_INTERNAL') || die();
31 // File areas for file submission assignment.
32 define('ASSIGNSUBMISSION_FILE_MAXFILES', 20);
33 define('ASSIGNSUBMISSION_FILE_MAXSUMMARYFILES', 5);
34 define('ASSIGNSUBMISSION_FILE_FILEAREA', 'submission_files');
36 /**
37  * Library class for file submission plugin extending submission plugin base class
38  *
39  * @package   assignsubmission_file
40  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
41  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class assign_submission_file extends assign_submission_plugin {
45     /**
46      * Get the name of the file submission plugin
47      * @return string
48      */
49     public function get_name() {
50         return get_string('file', 'assignsubmission_file');
51     }
53     /**
54      * Get file submission information from the database
55      *
56      * @param int $submissionid
57      * @return mixed
58      */
59     private function get_file_submission($submissionid) {
60         global $DB;
61         return $DB->get_record('assignsubmission_file', array('submission'=>$submissionid));
62     }
64     /**
65      * Get the default setting for file submission plugin
66      *
67      * @param MoodleQuickForm $mform The form to add elements to
68      * @return void
69      */
70     public function get_settings(MoodleQuickForm $mform) {
71         global $CFG, $COURSE;
73         $defaultmaxfilesubmissions = $this->get_config('maxfilesubmissions');
74         $defaultmaxsubmissionsizebytes = $this->get_config('maxsubmissionsizebytes');
76         $settings = array();
77         $options = array();
78         for ($i = 1; $i <= ASSIGNSUBMISSION_FILE_MAXFILES; $i++) {
79             $options[$i] = $i;
80         }
82         $name = get_string('maxfilessubmission', 'assignsubmission_file');
83         $mform->addElement('select', 'assignsubmission_file_maxfiles', $name, $options);
84         $mform->addHelpButton('assignsubmission_file_maxfiles',
85                               'maxfilessubmission',
86                               'assignsubmission_file');
87         $mform->setDefault('assignsubmission_file_maxfiles', $defaultmaxfilesubmissions);
88         $mform->disabledIf('assignsubmission_file_maxfiles', 'assignsubmission_file_enabled', 'notchecked');
90         $choices = get_max_upload_sizes($CFG->maxbytes,
91                                         $COURSE->maxbytes,
92                                         get_config('assignsubmission_file', 'maxbytes'));
94         $settings[] = array('type' => 'select',
95                             'name' => 'maxsubmissionsizebytes',
96                             'description' => get_string('maximumsubmissionsize', 'assignsubmission_file'),
97                             'options'=> $choices,
98                             'default'=> $defaultmaxsubmissionsizebytes);
100         $name = get_string('maximumsubmissionsize', 'assignsubmission_file');
101         $mform->addElement('select', 'assignsubmission_file_maxsizebytes', $name, $choices);
102         $mform->addHelpButton('assignsubmission_file_maxsizebytes',
103                               'maximumsubmissionsize',
104                               'assignsubmission_file');
105         $mform->setDefault('assignsubmission_file_maxsizebytes', $defaultmaxsubmissionsizebytes);
106         $mform->disabledIf('assignsubmission_file_maxsizebytes',
107                            'assignsubmission_file_enabled',
108                            'notchecked');
109     }
111     /**
112      * Save the settings for file submission plugin
113      *
114      * @param stdClass $data
115      * @return bool
116      */
117     public function save_settings(stdClass $data) {
118         $this->set_config('maxfilesubmissions', $data->assignsubmission_file_maxfiles);
119         $this->set_config('maxsubmissionsizebytes', $data->assignsubmission_file_maxsizebytes);
120         return true;
121     }
123     /**
124      * File format options
125      *
126      * @return array
127      */
128     private function get_file_options() {
129         $fileoptions = array('subdirs'=>1,
130                                 'maxbytes'=>$this->get_config('maxsubmissionsizebytes'),
131                                 'maxfiles'=>$this->get_config('maxfilesubmissions'),
132                                 'accepted_types'=>'*',
133                                 'return_types'=>FILE_INTERNAL);
134         return $fileoptions;
135     }
137     /**
138      * Add elements to submission form
139      *
140      * @param mixed $submission stdClass|null
141      * @param MoodleQuickForm $mform
142      * @param stdClass $data
143      * @return bool
144      */
145     public function get_form_elements($submission, MoodleQuickForm $mform, stdClass $data) {
147         if ($this->get_config('maxfilesubmissions') <= 0) {
148             return false;
149         }
151         $fileoptions = $this->get_file_options();
152         $submissionid = $submission ? $submission->id : 0;
154         $data = file_prepare_standard_filemanager($data,
155                                                   'files',
156                                                   $fileoptions,
157                                                   $this->assignment->get_context(),
158                                                   'assignsubmission_file',
159                                                   ASSIGNSUBMISSION_FILE_FILEAREA,
160                                                   $submissionid);
161         $mform->addElement('filemanager', 'files_filemanager', $this->get_name(), null, $fileoptions);
163         return true;
164     }
166     /**
167      * Count the number of files
168      *
169      * @param int $submissionid
170      * @param string $area
171      * @return int
172      */
173     private function count_files($submissionid, $area) {
175         $fs = get_file_storage();
176         $files = $fs->get_area_files($this->assignment->get_context()->id,
177                                      'assignsubmission_file',
178                                      $area,
179                                      $submissionid,
180                                      'id',
181                                      false);
183         return count($files);
184     }
186     /**
187      * Save the files and trigger plagiarism plugin, if enabled,
188      * to scan the uploaded files via events trigger
189      *
190      * @param stdClass $submission
191      * @param stdClass $data
192      * @return bool
193      */
194     public function save(stdClass $submission, stdClass $data) {
195         global $USER, $DB;
197         $fileoptions = $this->get_file_options();
199         $data = file_postupdate_standard_filemanager($data,
200                                                      'files',
201                                                      $fileoptions,
202                                                      $this->assignment->get_context(),
203                                                      'assignsubmission_file',
204                                                      ASSIGNSUBMISSION_FILE_FILEAREA,
205                                                      $submission->id);
207         $filesubmission = $this->get_file_submission($submission->id);
209         // Plagiarism code event trigger when files are uploaded.
211         $fs = get_file_storage();
212         $files = $fs->get_area_files($this->assignment->get_context()->id,
213                                      'assignsubmission_file',
214                                      ASSIGNSUBMISSION_FILE_FILEAREA,
215                                      $submission->id,
216                                      'id',
217                                      false);
219         $count = $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA);
221         $params = array(
222             'context' => context_module::instance($this->assignment->get_course_module()->id),
223             'courseid' => $this->assignment->get_course()->id,
224             'objectid' => $submission->id,
225             'other' => array(
226                 'content' => '',
227                 'pathnamehashes' => array_keys($files)
228             )
229         );
230         $event = \assignsubmission_file\event\assessable_uploaded::create($params);
231         $event->set_legacy_files($files);
232         $event->trigger();
234         $groupname = null;
235         $groupid = 0;
236         // Get the group name as other fields are not transcribed in the logs and this information is important.
237         if (empty($submission->userid) && !empty($submission->groupid)) {
238             $groupname = $DB->get_field('groups', 'name', array('id' => $submission->groupid), '*', MUST_EXIST);
239             $groupid = $submission->groupid;
240         } else {
241             $params['relateduserid'] = $submission->userid;
242         }
244         // Unset the objectid and other field from params for use in submission events.
245         unset($params['objectid']);
246         unset($params['other']);
247         $params['other'] = array(
248             'submissionid' => $submission->id,
249             'submissionattempt' => $submission->attemptnumber,
250             'submissionstatus' => $submission->status,
251             'filesubmissioncount' => $count,
252             'groupid' => $groupid,
253             'groupname' => $groupname
254         );
256         if ($filesubmission) {
257             $filesubmission->numfiles = $this->count_files($submission->id,
258                                                            ASSIGNSUBMISSION_FILE_FILEAREA);
259             $updatestatus = $DB->update_record('assignsubmission_file', $filesubmission);
260             $params['objectid'] = $filesubmission->id;
262             $event = \assignsubmission_file\event\submission_updated::create($params);
263             $event->trigger();
264             return $updatestatus;
265         } else {
266             $filesubmission = new stdClass();
267             $filesubmission->numfiles = $this->count_files($submission->id,
268                                                            ASSIGNSUBMISSION_FILE_FILEAREA);
269             $filesubmission->submission = $submission->id;
270             $filesubmission->assignment = $this->assignment->get_instance()->id;
271             $filesubmission->id = $DB->insert_record('assignsubmission_file', $filesubmission);
272             $params['objectid'] = $filesubmission->id;
274             $event = \assignsubmission_file\event\submission_created::create($params);
275             $event->trigger();
276             return $filesubmission->id > 0;
277         }
278     }
280     /**
281      * Produce a list of files suitable for export that represent this feedback or submission
282      *
283      * @param stdClass $submission The submission
284      * @param stdClass $user The user record - unused
285      * @return array - return an array of files indexed by filename
286      */
287     public function get_files(stdClass $submission, stdClass $user) {
288         $result = array();
289         $fs = get_file_storage();
291         $files = $fs->get_area_files($this->assignment->get_context()->id,
292                                      'assignsubmission_file',
293                                      ASSIGNSUBMISSION_FILE_FILEAREA,
294                                      $submission->id,
295                                      'timemodified',
296                                      false);
298         foreach ($files as $file) {
299             $result[$file->get_filename()] = $file;
300         }
301         return $result;
302     }
304     /**
305      * Display the list of files  in the submission status table
306      *
307      * @param stdClass $submission
308      * @param bool $showviewlink Set this to true if the list of files is long
309      * @return string
310      */
311     public function view_summary(stdClass $submission, & $showviewlink) {
312         $count = $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA);
314         // Show we show a link to view all files for this plugin?
315         $showviewlink = $count > ASSIGNSUBMISSION_FILE_MAXSUMMARYFILES;
316         if ($count <= ASSIGNSUBMISSION_FILE_MAXSUMMARYFILES) {
317             return $this->assignment->render_area_files('assignsubmission_file',
318                                                         ASSIGNSUBMISSION_FILE_FILEAREA,
319                                                         $submission->id);
320         } else {
321             return get_string('countfiles', 'assignsubmission_file', $count);
322         }
323     }
325     /**
326      * No full submission view - the summary contains the list of files and that is the whole submission
327      *
328      * @param stdClass $submission
329      * @return string
330      */
331     public function view(stdClass $submission) {
332         return $this->assignment->render_area_files('assignsubmission_file',
333                                                     ASSIGNSUBMISSION_FILE_FILEAREA,
334                                                     $submission->id);
335     }
339     /**
340      * Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type
341      * and version.
342      *
343      * @param string $type
344      * @param int $version
345      * @return bool True if upgrade is possible
346      */
347     public function can_upgrade($type, $version) {
349         $uploadsingletype ='uploadsingle';
350         $uploadtype ='upload';
352         if (($type == $uploadsingletype || $type == $uploadtype) && $version >= 2011112900) {
353             return true;
354         }
355         return false;
356     }
359     /**
360      * Upgrade the settings from the old assignment
361      * to the new plugin based one
362      *
363      * @param context $oldcontext - the old assignment context
364      * @param stdClass $oldassignment - the old assignment data record
365      * @param string $log record log events here
366      * @return bool Was it a success? (false will trigger rollback)
367      */
368     public function upgrade_settings(context $oldcontext, stdClass $oldassignment, & $log) {
369         global $DB;
371         if ($oldassignment->assignmenttype == 'uploadsingle') {
372             $this->set_config('maxfilesubmissions', 1);
373             $this->set_config('maxsubmissionsizebytes', $oldassignment->maxbytes);
374             return true;
375         } else if ($oldassignment->assignmenttype == 'upload') {
376             $this->set_config('maxfilesubmissions', $oldassignment->var1);
377             $this->set_config('maxsubmissionsizebytes', $oldassignment->maxbytes);
379             // Advanced file upload uses a different setting to do the same thing.
380             $DB->set_field('assign',
381                            'submissiondrafts',
382                            $oldassignment->var4,
383                            array('id'=>$this->assignment->get_instance()->id));
385             // Convert advanced file upload "hide description before due date" setting.
386             $alwaysshow = 0;
387             if (!$oldassignment->var3) {
388                 $alwaysshow = 1;
389             }
390             $DB->set_field('assign',
391                            'alwaysshowdescription',
392                            $alwaysshow,
393                            array('id'=>$this->assignment->get_instance()->id));
394             return true;
395         }
396     }
398     /**
399      * Upgrade the submission from the old assignment to the new one
400      *
401      * @param context $oldcontext The context of the old assignment
402      * @param stdClass $oldassignment The data record for the old oldassignment
403      * @param stdClass $oldsubmission The data record for the old submission
404      * @param stdClass $submission The data record for the new submission
405      * @param string $log Record upgrade messages in the log
406      * @return bool true or false - false will trigger a rollback
407      */
408     public function upgrade(context $oldcontext,
409                             stdClass $oldassignment,
410                             stdClass $oldsubmission,
411                             stdClass $submission,
412                             & $log) {
413         global $DB;
415         $filesubmission = new stdClass();
417         $filesubmission->numfiles = $oldsubmission->numfiles;
418         $filesubmission->submission = $submission->id;
419         $filesubmission->assignment = $this->assignment->get_instance()->id;
421         if (!$DB->insert_record('assignsubmission_file', $filesubmission) > 0) {
422             $log .= get_string('couldnotconvertsubmission', 'mod_assign', $submission->userid);
423             return false;
424         }
426         // Now copy the area files.
427         $this->assignment->copy_area_files_for_upgrade($oldcontext->id,
428                                                         'mod_assignment',
429                                                         'submission',
430                                                         $oldsubmission->id,
431                                                         $this->assignment->get_context()->id,
432                                                         'assignsubmission_file',
433                                                         ASSIGNSUBMISSION_FILE_FILEAREA,
434                                                         $submission->id);
436         return true;
437     }
439     /**
440      * The assignment has been deleted - cleanup
441      *
442      * @return bool
443      */
444     public function delete_instance() {
445         global $DB;
446         // Will throw exception on failure.
447         $DB->delete_records('assignsubmission_file',
448                             array('assignment'=>$this->assignment->get_instance()->id));
450         return true;
451     }
453     /**
454      * Formatting for log info
455      *
456      * @param stdClass $submission The submission
457      * @return string
458      */
459     public function format_for_log(stdClass $submission) {
460         // Format the info for each submission plugin (will be added to log).
461         $filecount = $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA);
463         return get_string('numfilesforlog', 'assignsubmission_file', $filecount);
464     }
466     /**
467      * Return true if there are no submission files
468      * @param stdClass $submission
469      */
470     public function is_empty(stdClass $submission) {
471         return $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA) == 0;
472     }
474     /**
475      * Get file areas returns a list of areas this plugin stores files
476      * @return array - An array of fileareas (keys) and descriptions (values)
477      */
478     public function get_file_areas() {
479         return array(ASSIGNSUBMISSION_FILE_FILEAREA=>$this->get_name());
480     }
482     /**
483      * Copy the student's submission from a previous submission. Used when a student opts to base their resubmission
484      * on the last submission.
485      * @param stdClass $sourcesubmission
486      * @param stdClass $destsubmission
487      */
488     public function copy_submission(stdClass $sourcesubmission, stdClass $destsubmission) {
489         global $DB;
491         // Copy the files across.
492         $contextid = $this->assignment->get_context()->id;
493         $fs = get_file_storage();
494         $files = $fs->get_area_files($contextid,
495                                      'assignsubmission_file',
496                                      ASSIGNSUBMISSION_FILE_FILEAREA,
497                                      $sourcesubmission->id,
498                                      'id',
499                                      false);
500         foreach ($files as $file) {
501             $fieldupdates = array('itemid' => $destsubmission->id);
502             $fs->create_file_from_storedfile($fieldupdates, $file);
503         }
505         // Copy the assignsubmission_file record.
506         if ($filesubmission = $this->get_file_submission($sourcesubmission->id)) {
507             unset($filesubmission->id);
508             $filesubmission->submission = $destsubmission->id;
509             $DB->insert_record('assignsubmission_file', $filesubmission);
510         }
511         return true;
512     }
514     /**
515      * Return a description of external params suitable for uploading a file submission from a webservice.
516      *
517      * @return external_description|null
518      */
519     public function get_external_parameters() {
520         return array(
521             'files_filemanager' => new external_value(
522                 PARAM_INT,
523                 'The id of a draft area containing files for this submission.'
524             )
525         );
526     }