MDL-33832 Fixed filling of files.source field
[moodle.git] / repository / upload / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This plugin is used to upload files
20  *
21  * @since 2.0
22  * @package    repository_upload
23  * @copyright  2010 Dongsheng Cai {@link http://dongsheng.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
26 require_once($CFG->dirroot . '/repository/lib.php');
28 /**
29  * A repository plugin to allow user uploading files
30  *
31  * @since 2.0
32  * @package    repository_upload
33  * @copyright  2009 Dongsheng Cai {@link http://dongsheng.org}
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
37 class repository_upload extends repository {
38     private $mimetypes = array();
40     /**
41      * Print a upload form
42      * @return array
43      */
44     public function print_login() {
45         return $this->get_listing();
46     }
48     /**
49      * Process uploaded file
50      * @return array|bool
51      */
52     public function upload($saveas_filename, $maxbytes) {
53         global $CFG;
55         $types = optional_param_array('accepted_types', '*', PARAM_RAW);
56         $savepath = optional_param('savepath', '/', PARAM_PATH);
57         $itemid   = optional_param('itemid', 0, PARAM_INT);
58         $license  = optional_param('license', $CFG->sitedefaultlicense, PARAM_TEXT);
59         $author   = optional_param('author', '', PARAM_TEXT);
61         return $this->process_upload($saveas_filename, $maxbytes, $types, $savepath, $itemid, $license, $author);
62     }
64     /**
65      * Do the actual processing of the uploaded file
66      * @param string $saveas_filename name to give to the file
67      * @param int $maxbytes maximum file size
68      * @param mixed $types optional array of file extensions that are allowed or '*' for all
69      * @param string $savepath optional path to save the file to
70      * @param int $itemid optional the ID for this item within the file area
71      * @param string $license optional the license to use for this file
72      * @param string $author optional the name of the author of this file
73      * @return object containing details of the file uploaded
74      */
75     public function process_upload($saveas_filename, $maxbytes, $types = '*', $savepath = '/', $itemid = 0, $license = null, $author = '') {
76         global $USER, $CFG;
78         if ((is_array($types) and in_array('*', $types)) or $types == '*') {
79             $this->mimetypes = '*';
80         } else {
81             foreach ($types as $type) {
82                 $this->mimetypes[] = mimeinfo('type', $type);
83             }
84         }
86         if ($license == null) {
87             $license = $CFG->sitedefaultlicense;
88         }
90         $record = new stdClass();
91         $record->filearea = 'draft';
92         $record->component = 'user';
93         $record->filepath = $savepath;
94         $record->itemid   = $itemid;
95         $record->license  = $license;
96         $record->author   = $author;
98         $context = get_context_instance(CONTEXT_USER, $USER->id);
99         $elname = 'repo_upload_file';
101         $fs = get_file_storage();
102         $sm = get_string_manager();
104         if ($record->filepath !== '/') {
105             $record->filepath = file_correct_filepath($record->filepath);
106         }
108         if (!isset($_FILES[$elname])) {
109             throw new moodle_exception('nofile');
110         }
111         if (!empty($_FILES[$elname]['error'])) {
112             switch ($_FILES[$elname]['error']) {
113             case UPLOAD_ERR_INI_SIZE:
114                 throw new moodle_exception('upload_error_ini_size', 'repository_upload');
115                 break;
116             case UPLOAD_ERR_FORM_SIZE:
117                 throw new moodle_exception('upload_error_form_size', 'repository_upload');
118                 break;
119             case UPLOAD_ERR_PARTIAL:
120                 throw new moodle_exception('upload_error_partial', 'repository_upload');
121                 break;
122             case UPLOAD_ERR_NO_FILE:
123                 throw new moodle_exception('upload_error_no_file', 'repository_upload');
124                 break;
125             case UPLOAD_ERR_NO_TMP_DIR:
126                 throw new moodle_exception('upload_error_no_tmp_dir', 'repository_upload');
127                 break;
128             case UPLOAD_ERR_CANT_WRITE:
129                 throw new moodle_exception('upload_error_cant_write', 'repository_upload');
130                 break;
131             case UPLOAD_ERR_EXTENSION:
132                 throw new moodle_exception('upload_error_extension', 'repository_upload');
133                 break;
134             default:
135                 throw new moodle_exception('nofile');
136             }
137         }
139         // scan the files, throws exception and deletes if virus found
140         // this is tricky because clamdscan daemon might not be able to access the files
141         $permissions = fileperms($_FILES[$elname]['tmp_name']);
142         @chmod($_FILES[$elname]['tmp_name'], $CFG->filepermissions);
143         self::antivir_scan_file($_FILES[$elname]['tmp_name'], $_FILES[$elname]['name'], true);
144         @chmod($_FILES[$elname]['tmp_name'], $permissions);
146         // {@link repository::build_source_field()}
147         $sourcefield = $this->get_file_source_info($_FILES[$elname]['name']);
148         $record->source = self::build_source_field($sourcefield);
150         if (empty($saveas_filename)) {
151             $record->filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
152         } else {
153             $ext = '';
154             $match = array();
155             $filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
156             if (preg_match('/\.([a-z0-9]+)$/i', $filename, $match)) {
157                 if (isset($match[1])) {
158                     $ext = $match[1];
159                 }
160             }
161             $ext = !empty($ext) ? $ext : '';
162             if (preg_match('#\.(' . $ext . ')$#i', $saveas_filename)) {
163                 // saveas filename contains file extension already
164                 $record->filename = $saveas_filename;
165             } else {
166                 $record->filename = $saveas_filename . '.' . $ext;
167             }
168         }
170         // Check the file has some non-null contents - usually an indication that a user has
171         // tried to upload a folder by mistake
172         if (!$this->check_valid_contents($_FILES[$elname]['tmp_name'])) {
173             throw new moodle_exception('upload_error_invalid_file', 'repository_upload', '', $record->filename);
174         }
176         if ($this->mimetypes != '*') {
177             // check filetype
178             $filemimetype = file_storage::mimetype($_FILES[$elname]['tmp_name'], $record->filename);
179             if (!in_array($filemimetype, $this->mimetypes)) {
180                 throw new moodle_exception('invalidfiletype', 'repository', '', get_mimetype_description(array('filename' => $_FILES[$elname]['name'])));
181             }
182         }
184         if (empty($record->itemid)) {
185             $record->itemid = 0;
186         }
188         if (($maxbytes!==-1) && (filesize($_FILES[$elname]['tmp_name']) > $maxbytes)) {
189             throw new file_exception('maxbytes');
190         }
191         $record->contextid = $context->id;
192         $record->userid    = $USER->id;
194         if (repository::draftfile_exists($record->itemid, $record->filepath, $record->filename)) {
195             $existingfilename = $record->filename;
196             $unused_filename = repository::get_unused_filename($record->itemid, $record->filepath, $record->filename);
197             $record->filename = $unused_filename;
198             $stored_file = $fs->create_file_from_pathname($record, $_FILES[$elname]['tmp_name']);
199             $event = array();
200             $event['event'] = 'fileexists';
201             $event['newfile'] = new stdClass;
202             $event['newfile']->filepath = $record->filepath;
203             $event['newfile']->filename = $unused_filename;
204             $event['newfile']->url = moodle_url::make_draftfile_url($record->itemid, $record->filepath, $unused_filename)->out(false);
206             $event['existingfile'] = new stdClass;
207             $event['existingfile']->filepath = $record->filepath;
208             $event['existingfile']->filename = $existingfilename;
209             $event['existingfile']->url      = moodle_url::make_draftfile_url($record->itemid, $record->filepath, $existingfilename)->out(false);
210             return $event;
211         } else {
212             $stored_file = $fs->create_file_from_pathname($record, $_FILES[$elname]['tmp_name']);
214             return array(
215                 'url'=>moodle_url::make_draftfile_url($record->itemid, $record->filepath, $record->filename)->out(false),
216                 'id'=>$record->itemid,
217                 'file'=>$record->filename);
218         }
219     }
221     /**
222      * Checks the contents of the given file is not completely NULL - this can happen if a
223      * user drags & drops a folder onto a filemanager / filepicker element
224      * @param string $filepath full path (including filename) to file to check
225      * @return true if file has at least one non-null byte within it
226      */
227     protected function check_valid_contents($filepath) {
228         $buffersize = 4096;
230         $fp = fopen($filepath, 'r');
231         if (!$fp) {
232             return false; // Cannot read the file - something has gone wrong
233         }
234         while (!feof($fp)) {
235             // Read the file 4k at a time
236             $data = fread($fp, $buffersize);
237             if (preg_match('/[^\0]+/', $data)) {
238                 fclose($fp);
239                 return true; // Return as soon as a non-null byte is found
240             }
241         }
242         // Entire file is NULL
243         fclose($fp);
244         return false;
245     }
247     /**
248      * Return a upload form
249      * @return array
250      */
251     public function get_listing($path = '', $page = '') {
252         global $CFG;
253         $ret = array();
254         $ret['nologin']  = true;
255         $ret['nosearch'] = true;
256         $ret['norefresh'] = true;
257         $ret['list'] = array();
258         $ret['dynload'] = false;
259         $ret['upload'] = array('label'=>get_string('attachment', 'repository'), 'id'=>'repo-form');
260         $ret['allowcaching'] = true; // indicates that result of get_listing() can be cached in filepicker.js
261         return $ret;
262     }
264     /**
265      * supported return types
266      * @return int
267      */
268     public function supported_returntypes() {
269         return FILE_INTERNAL;
270     }