Moodle release 3.9
[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 defined('MOODLE_INTERNAL') || die();
29 // File areas for file submission assignment.
30 define('ASSIGNSUBMISSION_FILE_MAXSUMMARYFILES', 5);
31 define('ASSIGNSUBMISSION_FILE_FILEAREA', 'submission_files');
33 /**
34  * Library class for file submission plugin extending submission plugin base class
35  *
36  * @package   assignsubmission_file
37  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class assign_submission_file extends assign_submission_plugin {
42     /**
43      * Get the name of the file submission plugin
44      * @return string
45      */
46     public function get_name() {
47         return get_string('file', 'assignsubmission_file');
48     }
50     /**
51      * Get file submission information from the database
52      *
53      * @param int $submissionid
54      * @return mixed
55      */
56     private function get_file_submission($submissionid) {
57         global $DB;
58         return $DB->get_record('assignsubmission_file', array('submission'=>$submissionid));
59     }
61     /**
62      * Get the default setting for file submission plugin
63      *
64      * @param MoodleQuickForm $mform The form to add elements to
65      * @return void
66      */
67     public function get_settings(MoodleQuickForm $mform) {
68         global $CFG, $COURSE;
70         if ($this->assignment->has_instance()) {
71             $defaultmaxfilesubmissions = $this->get_config('maxfilesubmissions');
72             $defaultmaxsubmissionsizebytes = $this->get_config('maxsubmissionsizebytes');
73             $defaultfiletypes = $this->get_config('filetypeslist');
74         } else {
75             $defaultmaxfilesubmissions = get_config('assignsubmission_file', 'maxfiles');
76             $defaultmaxsubmissionsizebytes = get_config('assignsubmission_file', 'maxbytes');
77             $defaultfiletypes = get_config('assignsubmission_file', 'filetypes');
78         }
79         $defaultfiletypes = (string)$defaultfiletypes;
81         $settings = array();
82         $options = array();
83         for ($i = 1; $i <= get_config('assignsubmission_file', 'maxfiles'); $i++) {
84             $options[$i] = $i;
85         }
87         $name = get_string('maxfilessubmission', 'assignsubmission_file');
88         $mform->addElement('select', 'assignsubmission_file_maxfiles', $name, $options);
89         $mform->addHelpButton('assignsubmission_file_maxfiles',
90                               'maxfilessubmission',
91                               'assignsubmission_file');
92         $mform->setDefault('assignsubmission_file_maxfiles', $defaultmaxfilesubmissions);
93         $mform->hideIf('assignsubmission_file_maxfiles', 'assignsubmission_file_enabled', 'notchecked');
95         $choices = get_max_upload_sizes($CFG->maxbytes,
96                                         $COURSE->maxbytes,
97                                         get_config('assignsubmission_file', 'maxbytes'));
99         $settings[] = array('type' => 'select',
100                             'name' => 'maxsubmissionsizebytes',
101                             'description' => get_string('maximumsubmissionsize', 'assignsubmission_file'),
102                             'options'=> $choices,
103                             'default'=> $defaultmaxsubmissionsizebytes);
105         $name = get_string('maximumsubmissionsize', 'assignsubmission_file');
106         $mform->addElement('select', 'assignsubmission_file_maxsizebytes', $name, $choices);
107         $mform->addHelpButton('assignsubmission_file_maxsizebytes',
108                               'maximumsubmissionsize',
109                               'assignsubmission_file');
110         $mform->setDefault('assignsubmission_file_maxsizebytes', $defaultmaxsubmissionsizebytes);
111         $mform->hideIf('assignsubmission_file_maxsizebytes',
112                            'assignsubmission_file_enabled',
113                            'notchecked');
115         $name = get_string('acceptedfiletypes', 'assignsubmission_file');
116         $mform->addElement('filetypes', 'assignsubmission_file_filetypes', $name);
117         $mform->addHelpButton('assignsubmission_file_filetypes', 'acceptedfiletypes', 'assignsubmission_file');
118         $mform->setDefault('assignsubmission_file_filetypes', $defaultfiletypes);
119         $mform->hideIf('assignsubmission_file_filetypes', 'assignsubmission_file_enabled', 'notchecked');
120     }
122     /**
123      * Save the settings for file submission plugin
124      *
125      * @param stdClass $data
126      * @return bool
127      */
128     public function save_settings(stdClass $data) {
129         $this->set_config('maxfilesubmissions', $data->assignsubmission_file_maxfiles);
130         $this->set_config('maxsubmissionsizebytes', $data->assignsubmission_file_maxsizebytes);
132         if (!empty($data->assignsubmission_file_filetypes)) {
133             $this->set_config('filetypeslist', $data->assignsubmission_file_filetypes);
134         } else {
135             $this->set_config('filetypeslist', '');
136         }
138         return true;
139     }
141     /**
142      * File format options
143      *
144      * @return array
145      */
146     private function get_file_options() {
147         $fileoptions = array('subdirs' => 1,
148                                 'maxbytes' => $this->get_config('maxsubmissionsizebytes'),
149                                 'maxfiles' => $this->get_config('maxfilesubmissions'),
150                                 'accepted_types' => $this->get_configured_typesets(),
151                                 'return_types' => (FILE_INTERNAL | FILE_CONTROLLED_LINK));
152         if ($fileoptions['maxbytes'] == 0) {
153             // Use module default.
154             $fileoptions['maxbytes'] = get_config('assignsubmission_file', 'maxbytes');
155         }
156         return $fileoptions;
157     }
159     /**
160      * Add elements to submission form
161      *
162      * @param mixed $submission stdClass|null
163      * @param MoodleQuickForm $mform
164      * @param stdClass $data
165      * @return bool
166      */
167     public function get_form_elements($submission, MoodleQuickForm $mform, stdClass $data) {
168         global $OUTPUT;
170         if ($this->get_config('maxfilesubmissions') <= 0) {
171             return false;
172         }
174         $fileoptions = $this->get_file_options();
175         $submissionid = $submission ? $submission->id : 0;
177         $data = file_prepare_standard_filemanager($data,
178                                                   'files',
179                                                   $fileoptions,
180                                                   $this->assignment->get_context(),
181                                                   'assignsubmission_file',
182                                                   ASSIGNSUBMISSION_FILE_FILEAREA,
183                                                   $submissionid);
184         $mform->addElement('filemanager', 'files_filemanager', $this->get_name(), null, $fileoptions);
186         return true;
187     }
189     /**
190      * Count the number of files
191      *
192      * @param int $submissionid
193      * @param string $area
194      * @return int
195      */
196     private function count_files($submissionid, $area) {
197         $fs = get_file_storage();
198         $files = $fs->get_area_files($this->assignment->get_context()->id,
199                                      'assignsubmission_file',
200                                      $area,
201                                      $submissionid,
202                                      'id',
203                                      false);
205         return count($files);
206     }
208     /**
209      * Save the files and trigger plagiarism plugin, if enabled,
210      * to scan the uploaded files via events trigger
211      *
212      * @param stdClass $submission
213      * @param stdClass $data
214      * @return bool
215      */
216     public function save(stdClass $submission, stdClass $data) {
217         global $USER, $DB;
219         $fileoptions = $this->get_file_options();
221         $data = file_postupdate_standard_filemanager($data,
222                                                      'files',
223                                                      $fileoptions,
224                                                      $this->assignment->get_context(),
225                                                      'assignsubmission_file',
226                                                      ASSIGNSUBMISSION_FILE_FILEAREA,
227                                                      $submission->id);
229         $filesubmission = $this->get_file_submission($submission->id);
231         // Plagiarism code event trigger when files are uploaded.
233         $fs = get_file_storage();
234         $files = $fs->get_area_files($this->assignment->get_context()->id,
235                                      'assignsubmission_file',
236                                      ASSIGNSUBMISSION_FILE_FILEAREA,
237                                      $submission->id,
238                                      'id',
239                                      false);
241         $count = $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA);
243         $params = array(
244             'context' => context_module::instance($this->assignment->get_course_module()->id),
245             'courseid' => $this->assignment->get_course()->id,
246             'objectid' => $submission->id,
247             'other' => array(
248                 'content' => '',
249                 'pathnamehashes' => array_keys($files)
250             )
251         );
252         if (!empty($submission->userid) && ($submission->userid != $USER->id)) {
253             $params['relateduserid'] = $submission->userid;
254         }
255         if ($this->assignment->is_blind_marking()) {
256             $params['anonymous'] = 1;
257         }
258         $event = \assignsubmission_file\event\assessable_uploaded::create($params);
259         $event->set_legacy_files($files);
260         $event->trigger();
262         $groupname = null;
263         $groupid = 0;
264         // Get the group name as other fields are not transcribed in the logs and this information is important.
265         if (empty($submission->userid) && !empty($submission->groupid)) {
266             $groupname = $DB->get_field('groups', 'name', array('id' => $submission->groupid), MUST_EXIST);
267             $groupid = $submission->groupid;
268         } else {
269             $params['relateduserid'] = $submission->userid;
270         }
272         // Unset the objectid and other field from params for use in submission events.
273         unset($params['objectid']);
274         unset($params['other']);
275         $params['other'] = array(
276             'submissionid' => $submission->id,
277             'submissionattempt' => $submission->attemptnumber,
278             'submissionstatus' => $submission->status,
279             'filesubmissioncount' => $count,
280             'groupid' => $groupid,
281             'groupname' => $groupname
282         );
284         if ($filesubmission) {
285             $filesubmission->numfiles = $this->count_files($submission->id,
286                                                            ASSIGNSUBMISSION_FILE_FILEAREA);
287             $updatestatus = $DB->update_record('assignsubmission_file', $filesubmission);
288             $params['objectid'] = $filesubmission->id;
290             $event = \assignsubmission_file\event\submission_updated::create($params);
291             $event->set_assign($this->assignment);
292             $event->trigger();
293             return $updatestatus;
294         } else {
295             $filesubmission = new stdClass();
296             $filesubmission->numfiles = $this->count_files($submission->id,
297                                                            ASSIGNSUBMISSION_FILE_FILEAREA);
298             $filesubmission->submission = $submission->id;
299             $filesubmission->assignment = $this->assignment->get_instance()->id;
300             $filesubmission->id = $DB->insert_record('assignsubmission_file', $filesubmission);
301             $params['objectid'] = $filesubmission->id;
303             $event = \assignsubmission_file\event\submission_created::create($params);
304             $event->set_assign($this->assignment);
305             $event->trigger();
306             return $filesubmission->id > 0;
307         }
308     }
310     /**
311      * Remove files from this submission.
312      *
313      * @param stdClass $submission The submission
314      * @return boolean
315      */
316     public function remove(stdClass $submission) {
317         global $DB;
318         $fs = get_file_storage();
320         $fs->delete_area_files($this->assignment->get_context()->id,
321                                'assignsubmission_file',
322                                ASSIGNSUBMISSION_FILE_FILEAREA,
323                                $submission->id);
325         $currentsubmission = $this->get_file_submission($submission->id);
326         $currentsubmission->numfiles = 0;
327         $DB->update_record('assignsubmission_file', $currentsubmission);
329         return true;
330     }
332     /**
333      * Produce a list of files suitable for export that represent this feedback or submission
334      *
335      * @param stdClass $submission The submission
336      * @param stdClass $user The user record - unused
337      * @return array - return an array of files indexed by filename
338      */
339     public function get_files(stdClass $submission, stdClass $user) {
340         $result = array();
341         $fs = get_file_storage();
343         $files = $fs->get_area_files($this->assignment->get_context()->id,
344                                      'assignsubmission_file',
345                                      ASSIGNSUBMISSION_FILE_FILEAREA,
346                                      $submission->id,
347                                      'timemodified',
348                                      false);
350         foreach ($files as $file) {
351             // Do we return the full folder path or just the file name?
352             if (isset($submission->exportfullpath) && $submission->exportfullpath == false) {
353                 $result[$file->get_filename()] = $file;
354             } else {
355                 $result[$file->get_filepath().$file->get_filename()] = $file;
356             }
357         }
358         return $result;
359     }
361     /**
362      * Display the list of files  in the submission status table
363      *
364      * @param stdClass $submission
365      * @param bool $showviewlink Set this to true if the list of files is long
366      * @return string
367      */
368     public function view_summary(stdClass $submission, & $showviewlink) {
369         $count = $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA);
371         // Show we show a link to view all files for this plugin?
372         $showviewlink = $count > ASSIGNSUBMISSION_FILE_MAXSUMMARYFILES;
373         if ($count <= ASSIGNSUBMISSION_FILE_MAXSUMMARYFILES) {
374             return $this->assignment->render_area_files('assignsubmission_file',
375                                                         ASSIGNSUBMISSION_FILE_FILEAREA,
376                                                         $submission->id);
377         } else {
378             return get_string('countfiles', 'assignsubmission_file', $count);
379         }
380     }
382     /**
383      * No full submission view - the summary contains the list of files and that is the whole submission
384      *
385      * @param stdClass $submission
386      * @return string
387      */
388     public function view(stdClass $submission) {
389         return $this->assignment->render_area_files('assignsubmission_file',
390                                                     ASSIGNSUBMISSION_FILE_FILEAREA,
391                                                     $submission->id);
392     }
396     /**
397      * Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type
398      * and version.
399      *
400      * @param string $type
401      * @param int $version
402      * @return bool True if upgrade is possible
403      */
404     public function can_upgrade($type, $version) {
406         $uploadsingletype ='uploadsingle';
407         $uploadtype ='upload';
409         if (($type == $uploadsingletype || $type == $uploadtype) && $version >= 2011112900) {
410             return true;
411         }
412         return false;
413     }
416     /**
417      * Upgrade the settings from the old assignment
418      * to the new plugin based one
419      *
420      * @param context $oldcontext - the old assignment context
421      * @param stdClass $oldassignment - the old assignment data record
422      * @param string $log record log events here
423      * @return bool Was it a success? (false will trigger rollback)
424      */
425     public function upgrade_settings(context $oldcontext, stdClass $oldassignment, & $log) {
426         global $DB;
428         if ($oldassignment->assignmenttype == 'uploadsingle') {
429             $this->set_config('maxfilesubmissions', 1);
430             $this->set_config('maxsubmissionsizebytes', $oldassignment->maxbytes);
431             return true;
432         } else if ($oldassignment->assignmenttype == 'upload') {
433             $this->set_config('maxfilesubmissions', $oldassignment->var1);
434             $this->set_config('maxsubmissionsizebytes', $oldassignment->maxbytes);
436             // Advanced file upload uses a different setting to do the same thing.
437             $DB->set_field('assign',
438                            'submissiondrafts',
439                            $oldassignment->var4,
440                            array('id'=>$this->assignment->get_instance()->id));
442             // Convert advanced file upload "hide description before due date" setting.
443             $alwaysshow = 0;
444             if (!$oldassignment->var3) {
445                 $alwaysshow = 1;
446             }
447             $DB->set_field('assign',
448                            'alwaysshowdescription',
449                            $alwaysshow,
450                            array('id'=>$this->assignment->get_instance()->id));
451             return true;
452         }
453     }
455     /**
456      * Upgrade the submission from the old assignment to the new one
457      *
458      * @param context $oldcontext The context of the old assignment
459      * @param stdClass $oldassignment The data record for the old oldassignment
460      * @param stdClass $oldsubmission The data record for the old submission
461      * @param stdClass $submission The data record for the new submission
462      * @param string $log Record upgrade messages in the log
463      * @return bool true or false - false will trigger a rollback
464      */
465     public function upgrade(context $oldcontext,
466                             stdClass $oldassignment,
467                             stdClass $oldsubmission,
468                             stdClass $submission,
469                             & $log) {
470         global $DB;
472         $filesubmission = new stdClass();
474         $filesubmission->numfiles = $oldsubmission->numfiles;
475         $filesubmission->submission = $submission->id;
476         $filesubmission->assignment = $this->assignment->get_instance()->id;
478         if (!$DB->insert_record('assignsubmission_file', $filesubmission) > 0) {
479             $log .= get_string('couldnotconvertsubmission', 'mod_assign', $submission->userid);
480             return false;
481         }
483         // Now copy the area files.
484         $this->assignment->copy_area_files_for_upgrade($oldcontext->id,
485                                                         'mod_assignment',
486                                                         'submission',
487                                                         $oldsubmission->id,
488                                                         $this->assignment->get_context()->id,
489                                                         'assignsubmission_file',
490                                                         ASSIGNSUBMISSION_FILE_FILEAREA,
491                                                         $submission->id);
493         return true;
494     }
496     /**
497      * The assignment has been deleted - cleanup
498      *
499      * @return bool
500      */
501     public function delete_instance() {
502         global $DB;
503         // Will throw exception on failure.
504         $DB->delete_records('assignsubmission_file',
505                             array('assignment'=>$this->assignment->get_instance()->id));
507         return true;
508     }
510     /**
511      * Formatting for log info
512      *
513      * @param stdClass $submission The submission
514      * @return string
515      */
516     public function format_for_log(stdClass $submission) {
517         // Format the info for each submission plugin (will be added to log).
518         $filecount = $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA);
520         return get_string('numfilesforlog', 'assignsubmission_file', $filecount);
521     }
523     /**
524      * Return true if there are no submission files
525      * @param stdClass $submission
526      */
527     public function is_empty(stdClass $submission) {
528         return $this->count_files($submission->id, ASSIGNSUBMISSION_FILE_FILEAREA) == 0;
529     }
531     /**
532      * Determine if a submission is empty
533      *
534      * This is distinct from is_empty in that it is intended to be used to
535      * determine if a submission made before saving is empty.
536      *
537      * @param stdClass $data The submission data
538      * @return bool
539      */
540     public function submission_is_empty(stdClass $data) {
541         global $USER;
542         $fs = get_file_storage();
543         // Get a count of all the draft files, excluding any directories.
544         $files = $fs->get_area_files(context_user::instance($USER->id)->id,
545                                      'user',
546                                      'draft',
547                                      $data->files_filemanager,
548                                      'id',
549                                      false);
550         return count($files) == 0;
551     }
553     /**
554      * Get file areas returns a list of areas this plugin stores files
555      * @return array - An array of fileareas (keys) and descriptions (values)
556      */
557     public function get_file_areas() {
558         return array(ASSIGNSUBMISSION_FILE_FILEAREA=>$this->get_name());
559     }
561     /**
562      * Copy the student's submission from a previous submission. Used when a student opts to base their resubmission
563      * on the last submission.
564      * @param stdClass $sourcesubmission
565      * @param stdClass $destsubmission
566      */
567     public function copy_submission(stdClass $sourcesubmission, stdClass $destsubmission) {
568         global $DB;
570         // Copy the files across.
571         $contextid = $this->assignment->get_context()->id;
572         $fs = get_file_storage();
573         $files = $fs->get_area_files($contextid,
574                                      'assignsubmission_file',
575                                      ASSIGNSUBMISSION_FILE_FILEAREA,
576                                      $sourcesubmission->id,
577                                      'id',
578                                      false);
579         foreach ($files as $file) {
580             $fieldupdates = array('itemid' => $destsubmission->id);
581             $fs->create_file_from_storedfile($fieldupdates, $file);
582         }
584         // Copy the assignsubmission_file record.
585         if ($filesubmission = $this->get_file_submission($sourcesubmission->id)) {
586             unset($filesubmission->id);
587             $filesubmission->submission = $destsubmission->id;
588             $DB->insert_record('assignsubmission_file', $filesubmission);
589         }
590         return true;
591     }
593     /**
594      * Return a description of external params suitable for uploading a file submission from a webservice.
595      *
596      * @return external_description|null
597      */
598     public function get_external_parameters() {
599         return array(
600             'files_filemanager' => new external_value(
601                 PARAM_INT,
602                 'The id of a draft area containing files for this submission.',
603                 VALUE_OPTIONAL
604             )
605         );
606     }
608     /**
609      * Return the plugin configs for external functions.
610      *
611      * @return array the list of settings
612      * @since Moodle 3.2
613      */
614     public function get_config_for_external() {
615         global $CFG;
617         $configs = $this->get_config();
619         // Get a size in bytes.
620         if ($configs->maxsubmissionsizebytes == 0) {
621             $configs->maxsubmissionsizebytes = get_max_upload_file_size($CFG->maxbytes, $this->assignment->get_course()->maxbytes,
622                                                                         get_config('assignsubmission_file', 'maxbytes'));
623         }
624         return (array) $configs;
625     }
627     /**
628      * Get the type sets configured for this assignment.
629      *
630      * @return array('groupname', 'mime/type', ...)
631      */
632     private function get_configured_typesets() {
633         $typeslist = (string)$this->get_config('filetypeslist');
635         $util = new \core_form\filetypes_util();
636         $sets = $util->normalize_file_types($typeslist);
638         return $sets;
639     }
641     /**
642      * Determine if the plugin allows image file conversion
643      * @return bool
644      */
645     public function allow_image_conversion() {
646         return true;
647     }