08123829a38e455e70924068e9a460840b646a61
[moodle.git] / lib / filelib.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  * Functions for file handling.
19  *
20  * @package   core_files
21  * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * BYTESERVING_BOUNDARY - string unique string constant.
29  */
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
32 /**
33  * Unlimited area size constant
34  */
35 define('FILE_AREA_MAX_BYTES_UNLIMITED', -1);
37 require_once("$CFG->libdir/filestorage/file_exceptions.php");
38 require_once("$CFG->libdir/filestorage/file_storage.php");
39 require_once("$CFG->libdir/filestorage/zip_packer.php");
40 require_once("$CFG->libdir/filebrowser/file_browser.php");
42 /**
43  * Encodes file serving url
44  *
45  * @deprecated use moodle_url factory methods instead
46  *
47  * @todo MDL-31071 deprecate this function
48  * @global stdClass $CFG
49  * @param string $urlbase
50  * @param string $path /filearea/itemid/dir/dir/file.exe
51  * @param bool $forcedownload
52  * @param bool $https https url required
53  * @return string encoded file url
54  */
55 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
56     global $CFG;
58 //TODO: deprecate this
60     if ($CFG->slasharguments) {
61         $parts = explode('/', $path);
62         $parts = array_map('rawurlencode', $parts);
63         $path  = implode('/', $parts);
64         $return = $urlbase.$path;
65         if ($forcedownload) {
66             $return .= '?forcedownload=1';
67         }
68     } else {
69         $path = rawurlencode($path);
70         $return = $urlbase.'?file='.$path;
71         if ($forcedownload) {
72             $return .= '&amp;forcedownload=1';
73         }
74     }
76     if ($https) {
77         $return = str_replace('http://', 'https://', $return);
78     }
80     return $return;
81 }
83 /**
84  * Detects if area contains subdirs,
85  * this is intended for file areas that are attached to content
86  * migrated from 1.x where subdirs were allowed everywhere.
87  *
88  * @param context $context
89  * @param string $component
90  * @param string $filearea
91  * @param string $itemid
92  * @return bool
93  */
94 function file_area_contains_subdirs(context $context, $component, $filearea, $itemid) {
95     global $DB;
97     if (!isset($itemid)) {
98         // Not initialised yet.
99         return false;
100     }
102     // Detect if any directories are already present, this is necessary for content upgraded from 1.x.
103     $select = "contextid = :contextid AND component = :component AND filearea = :filearea AND itemid = :itemid AND filepath <> '/' AND filename = '.'";
104     $params = array('contextid'=>$context->id, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
105     return $DB->record_exists_select('files', $select, $params);
108 /**
109  * Prepares 'editor' formslib element from data in database
110  *
111  * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
112  * function then copies the embedded files into draft area (assigning itemids automatically),
113  * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
114  * displayed.
115  * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
116  * your mform's set_data() supplying the object returned by this function.
117  *
118  * @category files
119  * @param stdClass $data database field that holds the html text with embedded media
120  * @param string $field the name of the database field that holds the html text with embedded media
121  * @param array $options editor options (like maxifiles, maxbytes etc.)
122  * @param stdClass $context context of the editor
123  * @param string $component
124  * @param string $filearea file area name
125  * @param int $itemid item id, required if item exists
126  * @return stdClass modified data object
127  */
128 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
129     $options = (array)$options;
130     if (!isset($options['trusttext'])) {
131         $options['trusttext'] = false;
132     }
133     if (!isset($options['forcehttps'])) {
134         $options['forcehttps'] = false;
135     }
136     if (!isset($options['subdirs'])) {
137         $options['subdirs'] = false;
138     }
139     if (!isset($options['maxfiles'])) {
140         $options['maxfiles'] = 0; // no files by default
141     }
142     if (!isset($options['noclean'])) {
143         $options['noclean'] = false;
144     }
146     //sanity check for passed context. This function doesn't expect $option['context'] to be set
147     //But this function is called before creating editor hence, this is one of the best places to check
148     //if context is used properly. This check notify developer that they missed passing context to editor.
149     if (isset($context) && !isset($options['context'])) {
150         //if $context is not null then make sure $option['context'] is also set.
151         debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER);
152     } else if (isset($options['context']) && isset($context)) {
153         //If both are passed then they should be equal.
154         if ($options['context']->id != $context->id) {
155             $exceptionmsg = 'Editor context ['.$options['context']->id.'] is not equal to passed context ['.$context->id.']';
156             throw new coding_exception($exceptionmsg);
157         }
158     }
160     if (is_null($itemid) or is_null($context)) {
161         $contextid = null;
162         $itemid = null;
163         if (!isset($data)) {
164             $data = new stdClass();
165         }
166         if (!isset($data->{$field})) {
167             $data->{$field} = '';
168         }
169         if (!isset($data->{$field.'format'})) {
170             $data->{$field.'format'} = editors_get_preferred_format();
171         }
172         if (!$options['noclean']) {
173             $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
174         }
176     } else {
177         if ($options['trusttext']) {
178             // noclean ignored if trusttext enabled
179             if (!isset($data->{$field.'trust'})) {
180                 $data->{$field.'trust'} = 0;
181             }
182             $data = trusttext_pre_edit($data, $field, $context);
183         } else {
184             if (!$options['noclean']) {
185                 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
186             }
187         }
188         $contextid = $context->id;
189     }
191     if ($options['maxfiles'] != 0) {
192         $draftid_editor = file_get_submitted_draft_itemid($field);
193         $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
194         $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
195     } else {
196         $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
197     }
199     return $data;
202 /**
203  * Prepares the content of the 'editor' form element with embedded media files to be saved in database
204  *
205  * This function moves files from draft area to the destination area and
206  * encodes URLs to the draft files so they can be safely saved into DB. The
207  * form has to contain the 'editor' element named foobar_editor, where 'foobar'
208  * is the name of the database field to hold the wysiwyg editor content. The
209  * editor data comes as an array with text, format and itemid properties. This
210  * function automatically adds $data properties foobar, foobarformat and
211  * foobartrust, where foobar has URL to embedded files encoded.
212  *
213  * @category files
214  * @param stdClass $data raw data submitted by the form
215  * @param string $field name of the database field containing the html with embedded media files
216  * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
217  * @param stdClass $context context, required for existing data
218  * @param string $component file component
219  * @param string $filearea file area name
220  * @param int $itemid item id, required if item exists
221  * @return stdClass modified data object
222  */
223 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
224     $options = (array)$options;
225     if (!isset($options['trusttext'])) {
226         $options['trusttext'] = false;
227     }
228     if (!isset($options['forcehttps'])) {
229         $options['forcehttps'] = false;
230     }
231     if (!isset($options['subdirs'])) {
232         $options['subdirs'] = false;
233     }
234     if (!isset($options['maxfiles'])) {
235         $options['maxfiles'] = 0; // no files by default
236     }
237     if (!isset($options['maxbytes'])) {
238         $options['maxbytes'] = 0; // unlimited
239     }
241     if ($options['trusttext']) {
242         $data->{$field.'trust'} = trusttext_trusted($context);
243     } else {
244         $data->{$field.'trust'} = 0;
245     }
247     $editor = $data->{$field.'_editor'};
249     if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
250         $data->{$field} = $editor['text'];
251     } else {
252         $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
253     }
254     $data->{$field.'format'} = $editor['format'];
256     return $data;
259 /**
260  * Saves text and files modified by Editor formslib element
261  *
262  * @category files
263  * @param stdClass $data $database entry field
264  * @param string $field name of data field
265  * @param array $options various options
266  * @param stdClass $context context - must already exist
267  * @param string $component
268  * @param string $filearea file area name
269  * @param int $itemid must already exist, usually means data is in db
270  * @return stdClass modified data obejct
271  */
272 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
273     $options = (array)$options;
274     if (!isset($options['subdirs'])) {
275         $options['subdirs'] = false;
276     }
277     if (is_null($itemid) or is_null($context)) {
278         $itemid = null;
279         $contextid = null;
280     } else {
281         $contextid = $context->id;
282     }
284     $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
285     file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
286     $data->{$field.'_filemanager'} = $draftid_editor;
288     return $data;
291 /**
292  * Saves files modified by File manager formslib element
293  *
294  * @todo MDL-31073 review this function
295  * @category files
296  * @param stdClass $data $database entry field
297  * @param string $field name of data field
298  * @param array $options various options
299  * @param stdClass $context context - must already exist
300  * @param string $component
301  * @param string $filearea file area name
302  * @param int $itemid must already exist, usually means data is in db
303  * @return stdClass modified data obejct
304  */
305 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
306     $options = (array)$options;
307     if (!isset($options['subdirs'])) {
308         $options['subdirs'] = false;
309     }
310     if (!isset($options['maxfiles'])) {
311         $options['maxfiles'] = -1; // unlimited
312     }
313     if (!isset($options['maxbytes'])) {
314         $options['maxbytes'] = 0; // unlimited
315     }
317     if (empty($data->{$field.'_filemanager'})) {
318         $data->$field = '';
320     } else {
321         file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id, $component, $filearea, $itemid, $options);
322         $fs = get_file_storage();
324         if ($fs->get_area_files($context->id, $component, $filearea, $itemid)) {
325             $data->$field = '1'; // TODO: this is an ugly hack (skodak)
326         } else {
327             $data->$field = '';
328         }
329     }
331     return $data;
334 /**
335  * Generate a draft itemid
336  *
337  * @category files
338  * @global moodle_database $DB
339  * @global stdClass $USER
340  * @return int a random but available draft itemid that can be used to create a new draft
341  * file area.
342  */
343 function file_get_unused_draft_itemid() {
344     global $DB, $USER;
346     if (isguestuser() or !isloggedin()) {
347         // guests and not-logged-in users can not be allowed to upload anything!!!!!!
348         print_error('noguest');
349     }
351     $contextid = context_user::instance($USER->id)->id;
353     $fs = get_file_storage();
354     $draftitemid = rand(1, 999999999);
355     while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
356         $draftitemid = rand(1, 999999999);
357     }
359     return $draftitemid;
362 /**
363  * Initialise a draft file area from a real one by copying the files. A draft
364  * area will be created if one does not already exist. Normally you should
365  * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
366  *
367  * @category files
368  * @global stdClass $CFG
369  * @global stdClass $USER
370  * @param int $draftitemid the id of the draft area to use, or 0 to create a new one, in which case this parameter is updated.
371  * @param int $contextid This parameter and the next two identify the file area to copy files from.
372  * @param string $component
373  * @param string $filearea helps indentify the file area.
374  * @param int $itemid helps identify the file area. Can be null if there are no files yet.
375  * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
376  * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
377  * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
378  */
379 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
380     global $CFG, $USER, $CFG;
382     $options = (array)$options;
383     if (!isset($options['subdirs'])) {
384         $options['subdirs'] = false;
385     }
386     if (!isset($options['forcehttps'])) {
387         $options['forcehttps'] = false;
388     }
390     $usercontext = context_user::instance($USER->id);
391     $fs = get_file_storage();
393     if (empty($draftitemid)) {
394         // create a new area and copy existing files into
395         $draftitemid = file_get_unused_draft_itemid();
396         $file_record = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
397         if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
398             foreach ($files as $file) {
399                 if ($file->is_directory() and $file->get_filepath() === '/') {
400                     // we need a way to mark the age of each draft area,
401                     // by not copying the root dir we force it to be created automatically with current timestamp
402                     continue;
403                 }
404                 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
405                     continue;
406                 }
407                 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
408                 // XXX: This is a hack for file manager (MDL-28666)
409                 // File manager needs to know the original file information before copying
410                 // to draft area, so we append these information in mdl_files.source field
411                 // {@link file_storage::search_references()}
412                 // {@link file_storage::search_references_count()}
413                 $sourcefield = $file->get_source();
414                 $newsourcefield = new stdClass;
415                 $newsourcefield->source = $sourcefield;
416                 $original = new stdClass;
417                 $original->contextid = $contextid;
418                 $original->component = $component;
419                 $original->filearea  = $filearea;
420                 $original->itemid    = $itemid;
421                 $original->filename  = $file->get_filename();
422                 $original->filepath  = $file->get_filepath();
423                 $newsourcefield->original = file_storage::pack_reference($original);
424                 $draftfile->set_source(serialize($newsourcefield));
425                 // End of file manager hack
426             }
427         }
428         if (!is_null($text)) {
429             // at this point there should not be any draftfile links yet,
430             // because this is a new text from database that should still contain the @@pluginfile@@ links
431             // this happens when developers forget to post process the text
432             $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
433         }
434     } else {
435         // nothing to do
436     }
438     if (is_null($text)) {
439         return null;
440     }
442     // relink embedded files - editor can not handle @@PLUGINFILE@@ !
443     return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id, 'user', 'draft', $draftitemid, $options);
446 /**
447  * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
448  * Passing a new option reverse = true in the $options var will make the function to convert actual URLs in $text to encoded URLs
449  * in the @@PLUGINFILE@@ form.
450  *
451  * @category files
452  * @global stdClass $CFG
453  * @param string $text The content that may contain ULRs in need of rewriting.
454  * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
455  * @param int $contextid This parameter and the next two identify the file area to use.
456  * @param string $component
457  * @param string $filearea helps identify the file area.
458  * @param int $itemid helps identify the file area.
459  * @param array $options text and file options ('forcehttps'=>false), use reverse = true to reverse the behaviour of the function.
460  * @return string the processed text.
461  */
462 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
463     global $CFG;
465     $options = (array)$options;
466     if (!isset($options['forcehttps'])) {
467         $options['forcehttps'] = false;
468     }
470     if (!$CFG->slasharguments) {
471         $file = $file . '?file=';
472     }
474     $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
476     if ($itemid !== null) {
477         $baseurl .= "$itemid/";
478     }
480     if ($options['forcehttps']) {
481         $baseurl = str_replace('http://', 'https://', $baseurl);
482     }
484     if (!empty($options['reverse'])) {
485         return str_replace($baseurl, '@@PLUGINFILE@@/', $text);
486     } else {
487         return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
488     }
491 /**
492  * Returns information about files in a draft area.
493  *
494  * @global stdClass $CFG
495  * @global stdClass $USER
496  * @param int $draftitemid the draft area item id.
497  * @param string $filepath path to the directory from which the information have to be retrieved.
498  * @return array with the following entries:
499  *      'filecount' => number of files in the draft area.
500  *      'filesize' => total size of the files in the draft area.
501  *      'foldercount' => number of folders in the draft area.
502  *      'filesize_without_references' => total size of the area excluding file references.
503  * (more information will be added as needed).
504  */
505 function file_get_draft_area_info($draftitemid, $filepath = '/') {
506     global $USER;
508     $usercontext = context_user::instance($USER->id);
509     return file_get_file_area_info($usercontext->id, 'user', 'draft', $draftitemid, $filepath);
512 /**
513  * Returns information about files in an area.
514  *
515  * @param int $contextid context id
516  * @param string $component component
517  * @param string $filearea file area name
518  * @param int $itemid item id or all files if not specified
519  * @param string $filepath path to the directory from which the information have to be retrieved.
520  * @return array with the following entries:
521  *      'filecount' => number of files in the area.
522  *      'filesize' => total size of the files in the area.
523  *      'foldercount' => number of folders in the area.
524  *      'filesize_without_references' => total size of the area excluding file references.
525  * @since Moodle 3.4
526  */
527 function file_get_file_area_info($contextid, $component, $filearea, $itemid = false, $filepath = '/') {
529     $fs = get_file_storage();
531     $results = array(
532         'filecount' => 0,
533         'foldercount' => 0,
534         'filesize' => 0,
535         'filesize_without_references' => 0
536     );
538     if ($filepath != '/') {
539         $draftfiles = $fs->get_directory_files($contextid, $component, $filearea, $itemid, $filepath, true, true);
540     } else {
541         $draftfiles = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id', true);
542     }
543     foreach ($draftfiles as $file) {
544         if ($file->is_directory()) {
545             $results['foldercount'] += 1;
546         } else {
547             $results['filecount'] += 1;
548         }
550         $filesize = $file->get_filesize();
551         $results['filesize'] += $filesize;
552         if (!$file->is_external_file()) {
553             $results['filesize_without_references'] += $filesize;
554         }
555     }
557     return $results;
560 /**
561  * Returns whether a draft area has exceeded/will exceed its size limit.
562  *
563  * Please note that the unlimited value for $areamaxbytes is -1 {@link FILE_AREA_MAX_BYTES_UNLIMITED}, not 0.
564  *
565  * @param int $draftitemid the draft area item id.
566  * @param int $areamaxbytes the maximum size allowed in this draft area.
567  * @param int $newfilesize the size that would be added to the current area.
568  * @param bool $includereferences true to include the size of the references in the area size.
569  * @return bool true if the area will/has exceeded its limit.
570  * @since Moodle 2.4
571  */
572 function file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $newfilesize = 0, $includereferences = false) {
573     if ($areamaxbytes != FILE_AREA_MAX_BYTES_UNLIMITED) {
574         $draftinfo = file_get_draft_area_info($draftitemid);
575         $areasize = $draftinfo['filesize_without_references'];
576         if ($includereferences) {
577             $areasize = $draftinfo['filesize'];
578         }
579         if ($areasize + $newfilesize > $areamaxbytes) {
580             return true;
581         }
582     }
583     return false;
586 /**
587  * Get used space of files
588  * @global moodle_database $DB
589  * @global stdClass $USER
590  * @return int total bytes
591  */
592 function file_get_user_used_space() {
593     global $DB, $USER;
595     $usercontext = context_user::instance($USER->id);
596     $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
597             JOIN (SELECT contenthash, filename, MAX(id) AS id
598             FROM {files}
599             WHERE contextid = ? AND component = ? AND filearea != ?
600             GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
601     $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
602     $record = $DB->get_record_sql($sql, $params);
603     return (int)$record->totalbytes;
606 /**
607  * Convert any string to a valid filepath
608  * @todo review this function
609  * @param string $str
610  * @return string path
611  */
612 function file_correct_filepath($str) { //TODO: what is this? (skodak) - No idea (Fred)
613     if ($str == '/' or empty($str)) {
614         return '/';
615     } else {
616         return '/'.trim($str, '/').'/';
617     }
620 /**
621  * Generate a folder tree of draft area of current USER recursively
622  *
623  * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
624  * @param int $draftitemid
625  * @param string $filepath
626  * @param mixed $data
627  */
628 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
629     global $USER, $OUTPUT, $CFG;
630     $data->children = array();
631     $context = context_user::instance($USER->id);
632     $fs = get_file_storage();
633     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
634         foreach ($files as $file) {
635             if ($file->is_directory()) {
636                 $item = new stdClass();
637                 $item->sortorder = $file->get_sortorder();
638                 $item->filepath = $file->get_filepath();
640                 $foldername = explode('/', trim($item->filepath, '/'));
641                 $item->fullname = trim(array_pop($foldername), '/');
643                 $item->id = uniqid();
644                 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
645                 $data->children[] = $item;
646             } else {
647                 continue;
648             }
649         }
650     }
653 /**
654  * Listing all files (including folders) in current path (draft area)
655  * used by file manager
656  * @param int $draftitemid
657  * @param string $filepath
658  * @return stdClass
659  */
660 function file_get_drafarea_files($draftitemid, $filepath = '/') {
661     global $USER, $OUTPUT, $CFG;
663     $context = context_user::instance($USER->id);
664     $fs = get_file_storage();
666     $data = new stdClass();
667     $data->path = array();
668     $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
670     // will be used to build breadcrumb
671     $trail = '/';
672     if ($filepath !== '/') {
673         $filepath = file_correct_filepath($filepath);
674         $parts = explode('/', $filepath);
675         foreach ($parts as $part) {
676             if ($part != '' && $part != null) {
677                 $trail .= ($part.'/');
678                 $data->path[] = array('name'=>$part, 'path'=>$trail);
679             }
680         }
681     }
683     $list = array();
684     $maxlength = 12;
685     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
686         foreach ($files as $file) {
687             $item = new stdClass();
688             $item->filename = $file->get_filename();
689             $item->filepath = $file->get_filepath();
690             $item->fullname = trim($item->filename, '/');
691             $filesize = $file->get_filesize();
692             $item->size = $filesize ? $filesize : null;
693             $item->filesize = $filesize ? display_size($filesize) : '';
695             $item->sortorder = $file->get_sortorder();
696             $item->author = $file->get_author();
697             $item->license = $file->get_license();
698             $item->datemodified = $file->get_timemodified();
699             $item->datecreated = $file->get_timecreated();
700             $item->isref = $file->is_external_file();
701             if ($item->isref && $file->get_status() == 666) {
702                 $item->originalmissing = true;
703             }
704             // find the file this draft file was created from and count all references in local
705             // system pointing to that file
706             $source = @unserialize($file->get_source());
707             if (isset($source->original)) {
708                 $item->refcount = $fs->search_references_count($source->original);
709             }
711             if ($file->is_directory()) {
712                 $item->filesize = 0;
713                 $item->icon = $OUTPUT->image_url(file_folder_icon(24))->out(false);
714                 $item->type = 'folder';
715                 $foldername = explode('/', trim($item->filepath, '/'));
716                 $item->fullname = trim(array_pop($foldername), '/');
717                 $item->thumbnail = $OUTPUT->image_url(file_folder_icon(90))->out(false);
718             } else {
719                 // do NOT use file browser here!
720                 $item->mimetype = get_mimetype_description($file);
721                 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
722                     $item->type = 'zip';
723                 } else {
724                     $item->type = 'file';
725                 }
726                 $itemurl = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename);
727                 $item->url = $itemurl->out();
728                 $item->icon = $OUTPUT->image_url(file_file_icon($file, 24))->out(false);
729                 $item->thumbnail = $OUTPUT->image_url(file_file_icon($file, 90))->out(false);
730                 if ($imageinfo = $file->get_imageinfo()) {
731                     $item->realthumbnail = $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
732                     $item->realicon = $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
733                     $item->image_width = $imageinfo['width'];
734                     $item->image_height = $imageinfo['height'];
735                 }
736             }
737             $list[] = $item;
738         }
739     }
740     $data->itemid = $draftitemid;
741     $data->list = $list;
742     return $data;
745 /**
746  * Returns draft area itemid for a given element.
747  *
748  * @category files
749  * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
750  * @return int the itemid, or 0 if there is not one yet.
751  */
752 function file_get_submitted_draft_itemid($elname) {
753     // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
754     if (!isset($_REQUEST[$elname])) {
755         return 0;
756     }
757     if (is_array($_REQUEST[$elname])) {
758         $param = optional_param_array($elname, 0, PARAM_INT);
759         if (!empty($param['itemid'])) {
760             $param = $param['itemid'];
761         } else {
762             debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
763             return false;
764         }
766     } else {
767         $param = optional_param($elname, 0, PARAM_INT);
768     }
770     if ($param) {
771         require_sesskey();
772     }
774     return $param;
777 /**
778  * Restore the original source field from draft files
779  *
780  * Do not use this function because it makes field files.source inconsistent
781  * for draft area files. This function will be deprecated in 2.6
782  *
783  * @param stored_file $storedfile This only works with draft files
784  * @return stored_file
785  */
786 function file_restore_source_field_from_draft_file($storedfile) {
787     $source = @unserialize($storedfile->get_source());
788     if (!empty($source)) {
789         if (is_object($source)) {
790             $restoredsource = $source->source;
791             $storedfile->set_source($restoredsource);
792         } else {
793             throw new moodle_exception('invalidsourcefield', 'error');
794         }
795     }
796     return $storedfile;
798 /**
799  * Saves files from a draft file area to a real one (merging the list of files).
800  * Can rewrite URLs in some content at the same time if desired.
801  *
802  * @category files
803  * @global stdClass $USER
804  * @param int $draftitemid the id of the draft area to use. Normally obtained
805  *      from file_get_submitted_draft_itemid('elementname') or similar.
806  * @param int $contextid This parameter and the next two identify the file area to save to.
807  * @param string $component
808  * @param string $filearea indentifies the file area.
809  * @param int $itemid helps identifies the file area.
810  * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
811  * @param string $text some html content that needs to have embedded links rewritten
812  *      to the @@PLUGINFILE@@ form for saving in the database.
813  * @param bool $forcehttps force https urls.
814  * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
815  */
816 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
817     global $USER;
819     $usercontext = context_user::instance($USER->id);
820     $fs = get_file_storage();
822     $options = (array)$options;
823     if (!isset($options['subdirs'])) {
824         $options['subdirs'] = false;
825     }
826     if (!isset($options['maxfiles'])) {
827         $options['maxfiles'] = -1; // unlimited
828     }
829     if (!isset($options['maxbytes']) || $options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS) {
830         $options['maxbytes'] = 0; // unlimited
831     }
832     if (!isset($options['areamaxbytes'])) {
833         $options['areamaxbytes'] = FILE_AREA_MAX_BYTES_UNLIMITED; // Unlimited.
834     }
835     $allowreferences = true;
836     if (isset($options['return_types']) && !($options['return_types'] & (FILE_REFERENCE | FILE_CONTROLLED_LINK))) {
837         // we assume that if $options['return_types'] is NOT specified, we DO allow references.
838         // this is not exactly right. BUT there are many places in code where filemanager options
839         // are not passed to file_save_draft_area_files()
840         $allowreferences = false;
841     }
843     // Check if the draft area has exceeded the authorised limit. This should never happen as validation
844     // should have taken place before, unless the user is doing something nauthly. If so, let's just not save
845     // anything at all in the next area.
846     if (file_is_draft_area_limit_reached($draftitemid, $options['areamaxbytes'])) {
847         return null;
848     }
850     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
851     $oldfiles   = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
853     // One file in filearea means it is empty (it has only top-level directory '.').
854     if (count($draftfiles) > 1 || count($oldfiles) > 1) {
855         // we have to merge old and new files - we want to keep file ids for files that were not changed
856         // we change time modified for all new and changed files, we keep time created as is
858         $newhashes = array();
859         $filecount = 0;
860         foreach ($draftfiles as $file) {
861             if (!$options['subdirs'] && $file->get_filepath() !== '/') {
862                 continue;
863             }
864             if (!$allowreferences && $file->is_external_file()) {
865                 continue;
866             }
867             if (!$file->is_directory()) {
868                 if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
869                     // oversized file - should not get here at all
870                     continue;
871                 }
872                 if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
873                     // more files - should not get here at all
874                     continue;
875                 }
876                 $filecount++;
877             }
878             $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
879             $newhashes[$newhash] = $file;
880         }
882         // Loop through oldfiles and decide which we need to delete and which to update.
883         // After this cycle the array $newhashes will only contain the files that need to be added.
884         foreach ($oldfiles as $oldfile) {
885             $oldhash = $oldfile->get_pathnamehash();
886             if (!isset($newhashes[$oldhash])) {
887                 // delete files not needed any more - deleted by user
888                 $oldfile->delete();
889                 continue;
890             }
892             $newfile = $newhashes[$oldhash];
893             // Now we know that we have $oldfile and $newfile for the same path.
894             // Let's check if we can update this file or we need to delete and create.
895             if ($newfile->is_directory()) {
896                 // Directories are always ok to just update.
897             } else if (($source = @unserialize($newfile->get_source())) && isset($source->original)) {
898                 // File has the 'original' - we need to update the file (it may even have not been changed at all).
899                 $original = file_storage::unpack_reference($source->original);
900                 if ($original['filename'] !== $oldfile->get_filename() || $original['filepath'] !== $oldfile->get_filepath()) {
901                     // Very odd, original points to another file. Delete and create file.
902                     $oldfile->delete();
903                     continue;
904                 }
905             } else {
906                 // The same file name but absence of 'original' means that file was deteled and uploaded again.
907                 // By deleting and creating new file we properly manage all existing references.
908                 $oldfile->delete();
909                 continue;
910             }
912             // status changed, we delete old file, and create a new one
913             if ($oldfile->get_status() != $newfile->get_status()) {
914                 // file was changed, use updated with new timemodified data
915                 $oldfile->delete();
916                 // This file will be added later
917                 continue;
918             }
920             // Updated author
921             if ($oldfile->get_author() != $newfile->get_author()) {
922                 $oldfile->set_author($newfile->get_author());
923             }
924             // Updated license
925             if ($oldfile->get_license() != $newfile->get_license()) {
926                 $oldfile->set_license($newfile->get_license());
927             }
929             // Updated file source
930             // Field files.source for draftarea files contains serialised object with source and original information.
931             // We only store the source part of it for non-draft file area.
932             $newsource = $newfile->get_source();
933             if ($source = @unserialize($newfile->get_source())) {
934                 $newsource = $source->source;
935             }
936             if ($oldfile->get_source() !== $newsource) {
937                 $oldfile->set_source($newsource);
938             }
940             // Updated sort order
941             if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
942                 $oldfile->set_sortorder($newfile->get_sortorder());
943             }
945             // Update file timemodified
946             if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
947                 $oldfile->set_timemodified($newfile->get_timemodified());
948             }
950             // Replaced file content
951             if (!$oldfile->is_directory() &&
952                     ($oldfile->get_contenthash() != $newfile->get_contenthash() ||
953                     $oldfile->get_filesize() != $newfile->get_filesize() ||
954                     $oldfile->get_referencefileid() != $newfile->get_referencefileid() ||
955                     $oldfile->get_userid() != $newfile->get_userid())) {
956                 $oldfile->replace_file_with($newfile);
957             }
959             // unchanged file or directory - we keep it as is
960             unset($newhashes[$oldhash]);
961         }
963         // Add fresh file or the file which has changed status
964         // the size and subdirectory tests are extra safety only, the UI should prevent it
965         foreach ($newhashes as $file) {
966             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
967             if ($source = @unserialize($file->get_source())) {
968                 // Field files.source for draftarea files contains serialised object with source and original information.
969                 // We only store the source part of it for non-draft file area.
970                 $file_record['source'] = $source->source;
971             }
973             if ($file->is_external_file()) {
974                 $repoid = $file->get_repository_id();
975                 if (!empty($repoid)) {
976                     $context = context::instance_by_id($contextid, MUST_EXIST);
977                     $repo = repository::get_repository_by_id($repoid, $context);
979                     $file_record['repositoryid'] = $repoid;
980                     // This hook gives the repo a place to do some house cleaning, and update the $reference before it's saved
981                     // to the file store. E.g. transfer ownership of the file to a system account etc.
982                     $reference = $repo->reference_file_selected($file->get_reference(), $context, $component, $filearea, $itemid);
984                     $file_record['reference'] = $reference;
985                 }
986             }
988             $fs->create_file_from_storedfile($file_record, $file);
989         }
990     }
992     // note: do not purge the draft area - we clean up areas later in cron,
993     //       the reason is that user might press submit twice and they would loose the files,
994     //       also sometimes we might want to use hacks that save files into two different areas
996     if (is_null($text)) {
997         return null;
998     } else {
999         return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
1000     }
1003 /**
1004  * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
1005  * ready to be saved in the database. Normally, this is done automatically by
1006  * {@link file_save_draft_area_files()}.
1007  *
1008  * @category files
1009  * @param string $text the content to process.
1010  * @param int $draftitemid the draft file area the content was using.
1011  * @param bool $forcehttps whether the content contains https URLs. Default false.
1012  * @return string the processed content.
1013  */
1014 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
1015     global $CFG, $USER;
1017     $usercontext = context_user::instance($USER->id);
1019     $wwwroot = $CFG->wwwroot;
1020     if ($forcehttps) {
1021         $wwwroot = str_replace('http://', 'https://', $wwwroot);
1022     }
1024     // relink embedded files if text submitted - no absolute links allowed in database!
1025     $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1027     if (strpos($text, 'draftfile.php?file=') !== false) {
1028         $matches = array();
1029         preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
1030         if ($matches) {
1031             foreach ($matches[0] as $match) {
1032                 $replace = str_ireplace('%2F', '/', $match);
1033                 $text = str_replace($match, $replace, $text);
1034             }
1035         }
1036         $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1037     }
1039     return $text;
1042 /**
1043  * Set file sort order
1044  *
1045  * @global moodle_database $DB
1046  * @param int $contextid the context id
1047  * @param string $component file component
1048  * @param string $filearea file area.
1049  * @param int $itemid itemid.
1050  * @param string $filepath file path.
1051  * @param string $filename file name.
1052  * @param int $sortorder the sort order of file.
1053  * @return bool
1054  */
1055 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
1056     global $DB;
1057     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
1058     if ($file_record = $DB->get_record('files', $conditions)) {
1059         $sortorder = (int)$sortorder;
1060         $file_record->sortorder = $sortorder;
1061         $DB->update_record('files', $file_record);
1062         return true;
1063     }
1064     return false;
1067 /**
1068  * reset file sort order number to 0
1069  * @global moodle_database $DB
1070  * @param int $contextid the context id
1071  * @param string $component
1072  * @param string $filearea file area.
1073  * @param int|bool $itemid itemid.
1074  * @return bool
1075  */
1076 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
1077     global $DB;
1079     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
1080     if ($itemid !== false) {
1081         $conditions['itemid'] = $itemid;
1082     }
1084     $file_records = $DB->get_records('files', $conditions);
1085     foreach ($file_records as $file_record) {
1086         $file_record->sortorder = 0;
1087         $DB->update_record('files', $file_record);
1088     }
1089     return true;
1092 /**
1093  * Returns description of upload error
1094  *
1095  * @param int $errorcode found in $_FILES['filename.ext']['error']
1096  * @return string error description string, '' if ok
1097  */
1098 function file_get_upload_error($errorcode) {
1100     switch ($errorcode) {
1101     case 0: // UPLOAD_ERR_OK - no error
1102         $errmessage = '';
1103         break;
1105     case 1: // UPLOAD_ERR_INI_SIZE
1106         $errmessage = get_string('uploadserverlimit');
1107         break;
1109     case 2: // UPLOAD_ERR_FORM_SIZE
1110         $errmessage = get_string('uploadformlimit');
1111         break;
1113     case 3: // UPLOAD_ERR_PARTIAL
1114         $errmessage = get_string('uploadpartialfile');
1115         break;
1117     case 4: // UPLOAD_ERR_NO_FILE
1118         $errmessage = get_string('uploadnofilefound');
1119         break;
1121     // Note: there is no error with a value of 5
1123     case 6: // UPLOAD_ERR_NO_TMP_DIR
1124         $errmessage = get_string('uploadnotempdir');
1125         break;
1127     case 7: // UPLOAD_ERR_CANT_WRITE
1128         $errmessage = get_string('uploadcantwrite');
1129         break;
1131     case 8: // UPLOAD_ERR_EXTENSION
1132         $errmessage = get_string('uploadextension');
1133         break;
1135     default:
1136         $errmessage = get_string('uploadproblem');
1137     }
1139     return $errmessage;
1142 /**
1143  * Recursive function formating an array in POST parameter
1144  * @param array $arraydata - the array that we are going to format and add into &$data array
1145  * @param string $currentdata - a row of the final postdata array at instant T
1146  *                when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1147  * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1148  */
1149 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1150         foreach ($arraydata as $k=>$v) {
1151             $newcurrentdata = $currentdata;
1152             if (is_array($v)) { //the value is an array, call the function recursively
1153                 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1154                 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1155             }  else { //add the POST parameter to the $data array
1156                 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1157             }
1158         }
1161 /**
1162  * Transform a PHP array into POST parameter
1163  * (see the recursive function format_array_postdata_for_curlcall)
1164  * @param array $postdata
1165  * @return array containing all POST parameters  (1 row = 1 POST parameter)
1166  */
1167 function format_postdata_for_curlcall($postdata) {
1168         $data = array();
1169         foreach ($postdata as $k=>$v) {
1170             if (is_array($v)) {
1171                 $currentdata = urlencode($k);
1172                 format_array_postdata_for_curlcall($v, $currentdata, $data);
1173             }  else {
1174                 $data[] = urlencode($k).'='.urlencode($v);
1175             }
1176         }
1177         $convertedpostdata = implode('&', $data);
1178         return $convertedpostdata;
1181 /**
1182  * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1183  * Due to security concerns only downloads from http(s) sources are supported.
1184  *
1185  * @category files
1186  * @param string $url file url starting with http(s)://
1187  * @param array $headers http headers, null if none. If set, should be an
1188  *   associative array of header name => value pairs.
1189  * @param array $postdata array means use POST request with given parameters
1190  * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1191  *   (if false, just returns content)
1192  * @param int $timeout timeout for complete download process including all file transfer
1193  *   (default 5 minutes)
1194  * @param int $connecttimeout timeout for connection to server; this is the timeout that
1195  *   usually happens if the remote server is completely down (default 20 seconds);
1196  *   may not work when using proxy
1197  * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1198  *   Only use this when already in a trusted location.
1199  * @param string $tofile store the downloaded content to file instead of returning it.
1200  * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1201  *   filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1202  * @return stdClass|string|bool stdClass object if $fullresponse is true, false if request failed, true
1203  *   if file downloaded into $tofile successfully or the file content as a string.
1204  */
1205 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1206     global $CFG;
1208     // Only http and https links supported.
1209     if (!preg_match('|^https?://|i', $url)) {
1210         if ($fullresponse) {
1211             $response = new stdClass();
1212             $response->status        = 0;
1213             $response->headers       = array();
1214             $response->response_code = 'Invalid protocol specified in url';
1215             $response->results       = '';
1216             $response->error         = 'Invalid protocol specified in url';
1217             return $response;
1218         } else {
1219             return false;
1220         }
1221     }
1223     $options = array();
1225     $headers2 = array();
1226     if (is_array($headers)) {
1227         foreach ($headers as $key => $value) {
1228             if (is_numeric($key)) {
1229                 $headers2[] = $value;
1230             } else {
1231                 $headers2[] = "$key: $value";
1232             }
1233         }
1234     }
1236     if ($skipcertverify) {
1237         $options['CURLOPT_SSL_VERIFYPEER'] = false;
1238     } else {
1239         $options['CURLOPT_SSL_VERIFYPEER'] = true;
1240     }
1242     $options['CURLOPT_CONNECTTIMEOUT'] = $connecttimeout;
1244     $options['CURLOPT_FOLLOWLOCATION'] = 1;
1245     $options['CURLOPT_MAXREDIRS'] = 5;
1247     // Use POST if requested.
1248     if (is_array($postdata)) {
1249         $postdata = format_postdata_for_curlcall($postdata);
1250     } else if (empty($postdata)) {
1251         $postdata = null;
1252     }
1254     // Optionally attempt to get more correct timeout by fetching the file size.
1255     if (!isset($CFG->curltimeoutkbitrate)) {
1256         // Use very slow rate of 56kbps as a timeout speed when not set.
1257         $bitrate = 56;
1258     } else {
1259         $bitrate = $CFG->curltimeoutkbitrate;
1260     }
1261     if ($calctimeout and !isset($postdata)) {
1262         $curl = new curl();
1263         $curl->setHeader($headers2);
1265         $curl->head($url, $postdata, $options);
1267         $info = $curl->get_info();
1268         $error_no = $curl->get_errno();
1269         if (!$error_no && $info['download_content_length'] > 0) {
1270             // No curl errors - adjust for large files only - take max timeout.
1271             $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024)));
1272         }
1273     }
1275     $curl = new curl();
1276     $curl->setHeader($headers2);
1278     $options['CURLOPT_RETURNTRANSFER'] = true;
1279     $options['CURLOPT_NOBODY'] = false;
1280     $options['CURLOPT_TIMEOUT'] = $timeout;
1282     if ($tofile) {
1283         $fh = fopen($tofile, 'w');
1284         if (!$fh) {
1285             if ($fullresponse) {
1286                 $response = new stdClass();
1287                 $response->status        = 0;
1288                 $response->headers       = array();
1289                 $response->response_code = 'Can not write to file';
1290                 $response->results       = false;
1291                 $response->error         = 'Can not write to file';
1292                 return $response;
1293             } else {
1294                 return false;
1295             }
1296         }
1297         $options['CURLOPT_FILE'] = $fh;
1298     }
1300     if (isset($postdata)) {
1301         $content = $curl->post($url, $postdata, $options);
1302     } else {
1303         $content = $curl->get($url, null, $options);
1304     }
1306     if ($tofile) {
1307         fclose($fh);
1308         @chmod($tofile, $CFG->filepermissions);
1309     }
1311 /*
1312     // Try to detect encoding problems.
1313     if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1314         curl_setopt($ch, CURLOPT_ENCODING, 'none');
1315         $result = curl_exec($ch);
1316     }
1317 */
1319     $info       = $curl->get_info();
1320     $error_no   = $curl->get_errno();
1321     $rawheaders = $curl->get_raw_response();
1323     if ($error_no) {
1324         $error = $content;
1325         if (!$fullresponse) {
1326             debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1327             return false;
1328         }
1330         $response = new stdClass();
1331         if ($error_no == 28) {
1332             $response->status    = '-100'; // Mimic snoopy.
1333         } else {
1334             $response->status    = '0';
1335         }
1336         $response->headers       = array();
1337         $response->response_code = $error;
1338         $response->results       = false;
1339         $response->error         = $error;
1340         return $response;
1341     }
1343     if ($tofile) {
1344         $content = true;
1345     }
1347     if (empty($info['http_code'])) {
1348         // For security reasons we support only true http connections (Location: file:// exploit prevention).
1349         $response = new stdClass();
1350         $response->status        = '0';
1351         $response->headers       = array();
1352         $response->response_code = 'Unknown cURL error';
1353         $response->results       = false; // do NOT change this, we really want to ignore the result!
1354         $response->error         = 'Unknown cURL error';
1356     } else {
1357         $response = new stdClass();
1358         $response->status        = (string)$info['http_code'];
1359         $response->headers       = $rawheaders;
1360         $response->results       = $content;
1361         $response->error         = '';
1363         // There might be multiple headers on redirect, find the status of the last one.
1364         $firstline = true;
1365         foreach ($rawheaders as $line) {
1366             if ($firstline) {
1367                 $response->response_code = $line;
1368                 $firstline = false;
1369             }
1370             if (trim($line, "\r\n") === '') {
1371                 $firstline = true;
1372             }
1373         }
1374     }
1376     if ($fullresponse) {
1377         return $response;
1378     }
1380     if ($info['http_code'] != 200) {
1381         debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1382         return false;
1383     }
1384     return $response->results;
1387 /**
1388  * Returns a list of information about file types based on extensions.
1389  *
1390  * The following elements expected in value array for each extension:
1391  * 'type' - mimetype
1392  * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1393  *     or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1394  *     also files with bigger sizes under names
1395  *     FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1396  * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1397  *     commonly used in moodle the following groups:
1398  *       - web_image - image that can be included as <img> in HTML
1399  *       - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1400  *       - video - file that can be imported as video in text editor
1401  *       - audio - file that can be imported as audio in text editor
1402  *       - archive - we can extract files from this archive
1403  *       - spreadsheet - used for portfolio format
1404  *       - document - used for portfolio format
1405  *       - presentation - used for portfolio format
1406  * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1407  *     human-readable description for this filetype;
1408  *     Function {@link get_mimetype_description()} first looks at the presence of string for
1409  *     particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1410  *     attribute, if not found returns the value of 'type';
1411  * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1412  *     an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1413  *     this function will return first found icon; Especially usefull for types such as 'text/plain'
1414  *
1415  * @category files
1416  * @return array List of information about file types based on extensions.
1417  *   Associative array of extension (lower-case) to associative array
1418  *   from 'element name' to data. Current element names are 'type' and 'icon'.
1419  *   Unknown types should use the 'xxx' entry which includes defaults.
1420  */
1421 function &get_mimetypes_array() {
1422     // Get types from the core_filetypes function, which includes caching.
1423     return core_filetypes::get_types();
1426 /**
1427  * Determine a file's MIME type based on the given filename using the function mimeinfo.
1428  *
1429  * This function retrieves a file's MIME type for a file that will be sent to the user.
1430  * This should only be used for file-sending purposes just like in send_stored_file, send_file, and send_temp_file.
1431  * Should the file's MIME type cannot be determined by mimeinfo, it will return 'application/octet-stream' as a default
1432  * MIME type which should tell the browser "I don't know what type of file this is, so just download it.".
1433  *
1434  * @param string $filename The file's filename.
1435  * @return string The file's MIME type or 'application/octet-stream' if it cannot be determined.
1436  */
1437 function get_mimetype_for_sending($filename = '') {
1438     // Guess the file's MIME type using mimeinfo.
1439     $mimetype = mimeinfo('type', $filename);
1441     // Use octet-stream as fallback if MIME type cannot be determined by mimeinfo.
1442     if (!$mimetype || $mimetype === 'document/unknown') {
1443         $mimetype = 'application/octet-stream';
1444     }
1446     return $mimetype;
1449 /**
1450  * Obtains information about a filetype based on its extension. Will
1451  * use a default if no information is present about that particular
1452  * extension.
1453  *
1454  * @category files
1455  * @param string $element Desired information (usually 'icon'
1456  *   for icon filename or 'type' for MIME type. Can also be
1457  *   'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1458  * @param string $filename Filename we're looking up
1459  * @return string Requested piece of information from array
1460  */
1461 function mimeinfo($element, $filename) {
1462     global $CFG;
1463     $mimeinfo = & get_mimetypes_array();
1464     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1466     $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1467     if (empty($filetype)) {
1468         $filetype = 'xxx'; // file without extension
1469     }
1470     if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1471         $iconsize = max(array(16, (int)$iconsizematch[1]));
1472         $filenames = array($mimeinfo['xxx']['icon']);
1473         if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1474             array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1475         }
1476         // find the file with the closest size, first search for specific icon then for default icon
1477         foreach ($filenames as $filename) {
1478             foreach ($iconpostfixes as $size => $postfix) {
1479                 $fullname = $CFG->dirroot.'/pix/f/'.$filename.$postfix;
1480                 if ($iconsize >= $size &&
1481                         (file_exists($fullname.'.svg') || file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1482                     return $filename.$postfix;
1483                 }
1484             }
1485         }
1486     } else if (isset($mimeinfo[$filetype][$element])) {
1487         return $mimeinfo[$filetype][$element];
1488     } else if (isset($mimeinfo['xxx'][$element])) {
1489         return $mimeinfo['xxx'][$element];   // By default
1490     } else {
1491         return null;
1492     }
1495 /**
1496  * Obtains information about a filetype based on the MIME type rather than
1497  * the other way around.
1498  *
1499  * @category files
1500  * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1501  * @param string $mimetype MIME type we're looking up
1502  * @return string Requested piece of information from array
1503  */
1504 function mimeinfo_from_type($element, $mimetype) {
1505     /* array of cached mimetype->extension associations */
1506     static $cached = array();
1507     $mimeinfo = & get_mimetypes_array();
1509     if (!array_key_exists($mimetype, $cached)) {
1510         $cached[$mimetype] = null;
1511         foreach($mimeinfo as $filetype => $values) {
1512             if ($values['type'] == $mimetype) {
1513                 if ($cached[$mimetype] === null) {
1514                     $cached[$mimetype] = '.'.$filetype;
1515                 }
1516                 if (!empty($values['defaulticon'])) {
1517                     $cached[$mimetype] = '.'.$filetype;
1518                     break;
1519                 }
1520             }
1521         }
1522         if (empty($cached[$mimetype])) {
1523             $cached[$mimetype] = '.xxx';
1524         }
1525     }
1526     if ($element === 'extension') {
1527         return $cached[$mimetype];
1528     } else {
1529         return mimeinfo($element, $cached[$mimetype]);
1530     }
1533 /**
1534  * Return the relative icon path for a given file
1535  *
1536  * Usage:
1537  * <code>
1538  * // $file - instance of stored_file or file_info
1539  * $icon = $OUTPUT->image_url(file_file_icon($file))->out();
1540  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1541  * </code>
1542  * or
1543  * <code>
1544  * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1545  * </code>
1546  *
1547  * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1548  *     and $file->mimetype are expected)
1549  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1550  * @return string
1551  */
1552 function file_file_icon($file, $size = null) {
1553     if (!is_object($file)) {
1554         $file = (object)$file;
1555     }
1556     if (isset($file->filename)) {
1557         $filename = $file->filename;
1558     } else if (method_exists($file, 'get_filename')) {
1559         $filename = $file->get_filename();
1560     } else if (method_exists($file, 'get_visible_name')) {
1561         $filename = $file->get_visible_name();
1562     } else {
1563         $filename = '';
1564     }
1565     if (isset($file->mimetype)) {
1566         $mimetype = $file->mimetype;
1567     } else if (method_exists($file, 'get_mimetype')) {
1568         $mimetype = $file->get_mimetype();
1569     } else {
1570         $mimetype = '';
1571     }
1572     $mimetypes = &get_mimetypes_array();
1573     if ($filename) {
1574         $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1575         if ($extension && !empty($mimetypes[$extension])) {
1576             // if file name has known extension, return icon for this extension
1577             return file_extension_icon($filename, $size);
1578         }
1579     }
1580     return file_mimetype_icon($mimetype, $size);
1583 /**
1584  * Return the relative icon path for a folder image
1585  *
1586  * Usage:
1587  * <code>
1588  * $icon = $OUTPUT->image_url(file_folder_icon())->out();
1589  * echo html_writer::empty_tag('img', array('src' => $icon));
1590  * </code>
1591  * or
1592  * <code>
1593  * echo $OUTPUT->pix_icon(file_folder_icon(32), '');
1594  * </code>
1595  *
1596  * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1597  * @return string
1598  */
1599 function file_folder_icon($iconsize = null) {
1600     global $CFG;
1601     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1602     static $cached = array();
1603     $iconsize = max(array(16, (int)$iconsize));
1604     if (!array_key_exists($iconsize, $cached)) {
1605         foreach ($iconpostfixes as $size => $postfix) {
1606             $fullname = $CFG->dirroot.'/pix/f/folder'.$postfix;
1607             if ($iconsize >= $size &&
1608                     (file_exists($fullname.'.svg') || file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1609                 $cached[$iconsize] = 'f/folder'.$postfix;
1610                 break;
1611             }
1612         }
1613     }
1614     return $cached[$iconsize];
1617 /**
1618  * Returns the relative icon path for a given mime type
1619  *
1620  * This function should be used in conjunction with $OUTPUT->image_url to produce
1621  * a return the full path to an icon.
1622  *
1623  * <code>
1624  * $mimetype = 'image/jpg';
1625  * $icon = $OUTPUT->image_url(file_mimetype_icon($mimetype))->out();
1626  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1627  * </code>
1628  *
1629  * @category files
1630  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1631  * to conform with that.
1632  * @param string $mimetype The mimetype to fetch an icon for
1633  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1634  * @return string The relative path to the icon
1635  */
1636 function file_mimetype_icon($mimetype, $size = NULL) {
1637     return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1640 /**
1641  * Returns the relative icon path for a given file name
1642  *
1643  * This function should be used in conjunction with $OUTPUT->image_url to produce
1644  * a return the full path to an icon.
1645  *
1646  * <code>
1647  * $filename = '.jpg';
1648  * $icon = $OUTPUT->image_url(file_extension_icon($filename))->out();
1649  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1650  * </code>
1651  *
1652  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1653  * to conform with that.
1654  * @todo MDL-31074 Implement $size
1655  * @category files
1656  * @param string $filename The filename to get the icon for
1657  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1658  * @return string
1659  */
1660 function file_extension_icon($filename, $size = NULL) {
1661     return 'f/'.mimeinfo('icon'.$size, $filename);
1664 /**
1665  * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1666  * mimetypes.php language file.
1667  *
1668  * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1669  *   'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1670  *   have filename); In case of array/stdClass the field 'mimetype' is optional.
1671  * @param bool $capitalise If true, capitalises first character of result
1672  * @return string Text description
1673  */
1674 function get_mimetype_description($obj, $capitalise=false) {
1675     $filename = $mimetype = '';
1676     if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1677         // this is an instance of stored_file
1678         $mimetype = $obj->get_mimetype();
1679         $filename = $obj->get_filename();
1680     } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1681         // this is an instance of file_info
1682         $mimetype = $obj->get_mimetype();
1683         $filename = $obj->get_visible_name();
1684     } else if (is_array($obj) || is_object ($obj)) {
1685         $obj = (array)$obj;
1686         if (!empty($obj['filename'])) {
1687             $filename = $obj['filename'];
1688         }
1689         if (!empty($obj['mimetype'])) {
1690             $mimetype = $obj['mimetype'];
1691         }
1692     } else {
1693         $mimetype = $obj;
1694     }
1695     $mimetypefromext = mimeinfo('type', $filename);
1696     if (empty($mimetype) || $mimetypefromext !== 'document/unknown') {
1697         // if file has a known extension, overwrite the specified mimetype
1698         $mimetype = $mimetypefromext;
1699     }
1700     $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1701     if (empty($extension)) {
1702         $mimetypestr = mimeinfo_from_type('string', $mimetype);
1703         $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1704     } else {
1705         $mimetypestr = mimeinfo('string', $filename);
1706     }
1707     $chunks = explode('/', $mimetype, 2);
1708     $chunks[] = '';
1709     $attr = array(
1710         'mimetype' => $mimetype,
1711         'ext' => $extension,
1712         'mimetype1' => $chunks[0],
1713         'mimetype2' => $chunks[1],
1714     );
1715     $a = array();
1716     foreach ($attr as $key => $value) {
1717         $a[$key] = $value;
1718         $a[strtoupper($key)] = strtoupper($value);
1719         $a[ucfirst($key)] = ucfirst($value);
1720     }
1722     // MIME types may include + symbol but this is not permitted in string ids.
1723     $safemimetype = str_replace('+', '_', $mimetype);
1724     $safemimetypestr = str_replace('+', '_', $mimetypestr);
1725     $customdescription = mimeinfo('customdescription', $filename);
1726     if ($customdescription) {
1727         // Call format_string on the custom description so that multilang
1728         // filter can be used (if enabled on system context). We use system
1729         // context because it is possible that the page context might not have
1730         // been defined yet.
1731         $result = format_string($customdescription, true,
1732                 array('context' => context_system::instance()));
1733     } else if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
1734         $result = get_string($safemimetype, 'mimetypes', (object)$a);
1735     } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
1736         $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
1737     } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1738         $result = get_string('default', 'mimetypes', (object)$a);
1739     } else {
1740         $result = $mimetype;
1741     }
1742     if ($capitalise) {
1743         $result=ucfirst($result);
1744     }
1745     return $result;
1748 /**
1749  * Returns array of elements of type $element in type group(s)
1750  *
1751  * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1752  * @param string|array $groups one group or array of groups/extensions/mimetypes
1753  * @return array
1754  */
1755 function file_get_typegroup($element, $groups) {
1756     static $cached = array();
1757     if (!is_array($groups)) {
1758         $groups = array($groups);
1759     }
1760     if (!array_key_exists($element, $cached)) {
1761         $cached[$element] = array();
1762     }
1763     $result = array();
1764     foreach ($groups as $group) {
1765         if (!array_key_exists($group, $cached[$element])) {
1766             // retrieive and cache all elements of type $element for group $group
1767             $mimeinfo = & get_mimetypes_array();
1768             $cached[$element][$group] = array();
1769             foreach ($mimeinfo as $extension => $value) {
1770                 $value['extension'] = '.'.$extension;
1771                 if (empty($value[$element])) {
1772                     continue;
1773                 }
1774                 if (($group === '.'.$extension || $group === $value['type'] ||
1775                         (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1776                         !in_array($value[$element], $cached[$element][$group])) {
1777                     $cached[$element][$group][] = $value[$element];
1778                 }
1779             }
1780         }
1781         $result = array_merge($result, $cached[$element][$group]);
1782     }
1783     return array_values(array_unique($result));
1786 /**
1787  * Checks if file with name $filename has one of the extensions in groups $groups
1788  *
1789  * @see get_mimetypes_array()
1790  * @param string $filename name of the file to check
1791  * @param string|array $groups one group or array of groups to check
1792  * @param bool $checktype if true and extension check fails, find the mimetype and check if
1793  * file mimetype is in mimetypes in groups $groups
1794  * @return bool
1795  */
1796 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
1797     $extension = pathinfo($filename, PATHINFO_EXTENSION);
1798     if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
1799         return true;
1800     }
1801     return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
1804 /**
1805  * Checks if mimetype $mimetype belongs to one of the groups $groups
1806  *
1807  * @see get_mimetypes_array()
1808  * @param string $mimetype
1809  * @param string|array $groups one group or array of groups to check
1810  * @return bool
1811  */
1812 function file_mimetype_in_typegroup($mimetype, $groups) {
1813     return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
1816 /**
1817  * Requested file is not found or not accessible, does not return, terminates script
1818  *
1819  * @global stdClass $CFG
1820  * @global stdClass $COURSE
1821  */
1822 function send_file_not_found() {
1823     global $CFG, $COURSE;
1825     // Allow cross-origin requests only for Web Services.
1826     // This allow to receive requests done by Web Workers or webapps in different domains.
1827     if (WS_SERVER) {
1828         header('Access-Control-Allow-Origin: *');
1829     }
1831     send_header_404();
1832     print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1834 /**
1835  * Helper function to send correct 404 for server.
1836  */
1837 function send_header_404() {
1838     if (substr(php_sapi_name(), 0, 3) == 'cgi') {
1839         header("Status: 404 Not Found");
1840     } else {
1841         header('HTTP/1.0 404 not found');
1842     }
1845 /**
1846  * The readfile function can fail when files are larger than 2GB (even on 64-bit
1847  * platforms). This wrapper uses readfile for small files and custom code for
1848  * large ones.
1849  *
1850  * @param string $path Path to file
1851  * @param int $filesize Size of file (if left out, will get it automatically)
1852  * @return int|bool Size read (will always be $filesize) or false if failed
1853  */
1854 function readfile_allow_large($path, $filesize = -1) {
1855     // Automatically get size if not specified.
1856     if ($filesize === -1) {
1857         $filesize = filesize($path);
1858     }
1859     if ($filesize <= 2147483647) {
1860         // If the file is up to 2^31 - 1, send it normally using readfile.
1861         return readfile($path);
1862     } else {
1863         // For large files, read and output in 64KB chunks.
1864         $handle = fopen($path, 'r');
1865         if ($handle === false) {
1866             return false;
1867         }
1868         $left = $filesize;
1869         while ($left > 0) {
1870             $size = min($left, 65536);
1871             $buffer = fread($handle, $size);
1872             if ($buffer === false) {
1873                 return false;
1874             }
1875             echo $buffer;
1876             $left -= $size;
1877         }
1878         return $filesize;
1879     }
1882 /**
1883  * Enhanced readfile() with optional acceleration.
1884  * @param string|stored_file $file
1885  * @param string $mimetype
1886  * @param bool $accelerate
1887  * @return void
1888  */
1889 function readfile_accel($file, $mimetype, $accelerate) {
1890     global $CFG;
1892     if ($mimetype === 'text/plain') {
1893         // there is no encoding specified in text files, we need something consistent
1894         header('Content-Type: text/plain; charset=utf-8');
1895     } else {
1896         header('Content-Type: '.$mimetype);
1897     }
1899     $lastmodified = is_object($file) ? $file->get_timemodified() : filemtime($file);
1900     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1902     if (is_object($file)) {
1903         header('Etag: "' . $file->get_contenthash() . '"');
1904         if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and trim($_SERVER['HTTP_IF_NONE_MATCH'], '"') === $file->get_contenthash()) {
1905             header('HTTP/1.1 304 Not Modified');
1906             return;
1907         }
1908     }
1910     // if etag present for stored file rely on it exclusively
1911     if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
1912         // get unixtime of request header; clip extra junk off first
1913         $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1914         if ($since && $since >= $lastmodified) {
1915             header('HTTP/1.1 304 Not Modified');
1916             return;
1917         }
1918     }
1920     if ($accelerate and !empty($CFG->xsendfile)) {
1921         if (empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1922             header('Accept-Ranges: bytes');
1923         } else {
1924             header('Accept-Ranges: none');
1925         }
1927         if (is_object($file)) {
1928             $fs = get_file_storage();
1929             if ($fs->xsendfile($file->get_contenthash())) {
1930                 return;
1931             }
1933         } else {
1934             require_once("$CFG->libdir/xsendfilelib.php");
1935             if (xsendfile($file)) {
1936                 return;
1937             }
1938         }
1939     }
1941     $filesize = is_object($file) ? $file->get_filesize() : filesize($file);
1943     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1945     if ($accelerate and empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1946         header('Accept-Ranges: bytes');
1948         if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1949             // byteserving stuff - for acrobat reader and download accelerators
1950             // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1951             // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
1952             $ranges = false;
1953             if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
1954                 foreach ($ranges as $key=>$value) {
1955                     if ($ranges[$key][1] == '') {
1956                         //suffix case
1957                         $ranges[$key][1] = $filesize - $ranges[$key][2];
1958                         $ranges[$key][2] = $filesize - 1;
1959                     } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
1960                         //fix range length
1961                         $ranges[$key][2] = $filesize - 1;
1962                     }
1963                     if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
1964                         //invalid byte-range ==> ignore header
1965                         $ranges = false;
1966                         break;
1967                     }
1968                     //prepare multipart header
1969                     $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
1970                     $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
1971                 }
1972             } else {
1973                 $ranges = false;
1974             }
1975             if ($ranges) {
1976                 if (is_object($file)) {
1977                     $handle = $file->get_content_file_handle();
1978                 } else {
1979                     $handle = fopen($file, 'rb');
1980                 }
1981                 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
1982             }
1983         }
1984     } else {
1985         // Do not byteserve
1986         header('Accept-Ranges: none');
1987     }
1989     header('Content-Length: '.$filesize);
1991     if ($filesize > 10000000) {
1992         // for large files try to flush and close all buffers to conserve memory
1993         while(@ob_get_level()) {
1994             if (!@ob_end_flush()) {
1995                 break;
1996             }
1997         }
1998     }
2000     // send the whole file content
2001     if (is_object($file)) {
2002         $file->readfile();
2003     } else {
2004         readfile_allow_large($file, $filesize);
2005     }
2008 /**
2009  * Similar to readfile_accel() but designed for strings.
2010  * @param string $string
2011  * @param string $mimetype
2012  * @param bool $accelerate
2013  * @return void
2014  */
2015 function readstring_accel($string, $mimetype, $accelerate) {
2016     global $CFG;
2018     if ($mimetype === 'text/plain') {
2019         // there is no encoding specified in text files, we need something consistent
2020         header('Content-Type: text/plain; charset=utf-8');
2021     } else {
2022         header('Content-Type: '.$mimetype);
2023     }
2024     header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2025     header('Accept-Ranges: none');
2027     if ($accelerate and !empty($CFG->xsendfile)) {
2028         $fs = get_file_storage();
2029         if ($fs->xsendfile(sha1($string))) {
2030             return;
2031         }
2032     }
2034     header('Content-Length: '.strlen($string));
2035     echo $string;
2038 /**
2039  * Handles the sending of temporary file to user, download is forced.
2040  * File is deleted after abort or successful sending, does not return, script terminated
2041  *
2042  * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2043  * @param string $filename proposed file name when saving file
2044  * @param bool $pathisstring If the path is string
2045  */
2046 function send_temp_file($path, $filename, $pathisstring=false) {
2047     global $CFG;
2049     // Guess the file's MIME type.
2050     $mimetype = get_mimetype_for_sending($filename);
2052     // close session - not needed anymore
2053     \core\session\manager::write_close();
2055     if (!$pathisstring) {
2056         if (!file_exists($path)) {
2057             send_header_404();
2058             print_error('filenotfound', 'error', $CFG->wwwroot.'/');
2059         }
2060         // executed after normal finish or abort
2061         core_shutdown_manager::register_function('send_temp_file_finished', array($path));
2062     }
2064     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2065     if (core_useragent::is_ie()) {
2066         $filename = urlencode($filename);
2067     }
2069     header('Content-Disposition: attachment; filename="'.$filename.'"');
2070     if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2071         header('Cache-Control: private, max-age=10, no-transform');
2072         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2073         header('Pragma: ');
2074     } else { //normal http - prevent caching at all cost
2075         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2076         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2077         header('Pragma: no-cache');
2078     }
2080     // send the contents - we can not accelerate this because the file will be deleted asap
2081     if ($pathisstring) {
2082         readstring_accel($path, $mimetype, false);
2083     } else {
2084         readfile_accel($path, $mimetype, false);
2085         @unlink($path);
2086     }
2088     die; //no more chars to output
2091 /**
2092  * Internal callback function used by send_temp_file()
2093  *
2094  * @param string $path
2095  */
2096 function send_temp_file_finished($path) {
2097     if (file_exists($path)) {
2098         @unlink($path);
2099     }
2102 /**
2103  * Serve content which is not meant to be cached.
2104  *
2105  * This is only intended to be used for volatile public files, for instance
2106  * when development is enabled, or when caching is not required on a public resource.
2107  *
2108  * @param string $content Raw content.
2109  * @param string $filename The file name.
2110  * @return void
2111  */
2112 function send_content_uncached($content, $filename) {
2113     $mimetype = mimeinfo('type', $filename);
2114     $charset = strpos($mimetype, 'text/') === 0 ? '; charset=utf-8' : '';
2116     header('Content-Disposition: inline; filename="' . $filename . '"');
2117     header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
2118     header('Expires: ' . gmdate('D, d M Y H:i:s', time() + 2) . ' GMT');
2119     header('Pragma: ');
2120     header('Accept-Ranges: none');
2121     header('Content-Type: ' . $mimetype . $charset);
2122     header('Content-Length: ' . strlen($content));
2124     echo $content;
2125     die();
2128 /**
2129  * Safely save content to a certain path.
2130  *
2131  * This function tries hard to be atomic by first copying the content
2132  * to a separate file, and then moving the file across. It also prevents
2133  * the user to abort a request to prevent half-safed files.
2134  *
2135  * This function is intended to be used when saving some content to cache like
2136  * $CFG->localcachedir. If you're not caching a file you should use the File API.
2137  *
2138  * @param string $content The file content.
2139  * @param string $destination The absolute path of the final file.
2140  * @return void
2141  */
2142 function file_safe_save_content($content, $destination) {
2143     global $CFG;
2145     clearstatcache();
2146     if (!file_exists(dirname($destination))) {
2147         @mkdir(dirname($destination), $CFG->directorypermissions, true);
2148     }
2150     // Prevent serving of incomplete file from concurrent request,
2151     // the rename() should be more atomic than fwrite().
2152     ignore_user_abort(true);
2153     if ($fp = fopen($destination . '.tmp', 'xb')) {
2154         fwrite($fp, $content);
2155         fclose($fp);
2156         rename($destination . '.tmp', $destination);
2157         @chmod($destination, $CFG->filepermissions);
2158         @unlink($destination . '.tmp'); // Just in case anything fails.
2159     }
2160     ignore_user_abort(false);
2161     if (connection_aborted()) {
2162         die();
2163     }
2166 /**
2167  * Handles the sending of file data to the user's browser, including support for
2168  * byteranges etc.
2169  *
2170  * @category files
2171  * @param string|stored_file $path Path of file on disk (including real filename),
2172  *                                 or actual content of file as string,
2173  *                                 or stored_file object
2174  * @param string $filename Filename to send
2175  * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2176  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2177  * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname.
2178  *                           Forced to false when $path is a stored_file object.
2179  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2180  * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2181  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2182  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2183  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
2184  *                        and should not be reopened.
2185  * @param array $options An array of options, currently accepts:
2186  *                       - (string) cacheability: public, or private.
2187  *                       - (string|null) immutable
2188  * @return null script execution stopped unless $dontdie is true
2189  */
2190 function send_file($path, $filename, $lifetime = null , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='',
2191                    $dontdie=false, array $options = array()) {
2192     global $CFG, $COURSE;
2194     if ($dontdie) {
2195         ignore_user_abort(true);
2196     }
2198     if ($lifetime === 'default' or is_null($lifetime)) {
2199         $lifetime = $CFG->filelifetime;
2200     }
2202     if (is_object($path)) {
2203         $pathisstring = false;
2204     }
2206     \core\session\manager::write_close(); // Unlock session during file serving.
2208     // Use given MIME type if specified, otherwise guess it.
2209     if (!$mimetype || $mimetype === 'document/unknown') {
2210         $mimetype = get_mimetype_for_sending($filename);
2211     }
2213     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2214     if (core_useragent::is_ie()) {
2215         $filename = rawurlencode($filename);
2216     }
2218     if ($forcedownload) {
2219         header('Content-Disposition: attachment; filename="'.$filename.'"');
2220     } else if ($mimetype !== 'application/x-shockwave-flash') {
2221         // If this is an swf don't pass content-disposition with filename as this makes the flash player treat the file
2222         // as an upload and enforces security that may prevent the file from being loaded.
2224         header('Content-Disposition: inline; filename="'.$filename.'"');
2225     }
2227     if ($lifetime > 0) {
2228         $immutable = '';
2229         if (!empty($options['immutable'])) {
2230             $immutable = ', immutable';
2231             // Overwrite lifetime accordingly:
2232             // 90 days only - based on Moodle point release cadence being every 3 months.
2233             $lifetimemin = 60 * 60 * 24 * 90;
2234             $lifetime = max($lifetime, $lifetimemin);
2235         }
2236         $cacheability = ' public,';
2237         if (!empty($options['cacheability']) && ($options['cacheability'] === 'public')) {
2238             // This file must be cache-able by both browsers and proxies.
2239             $cacheability = ' public,';
2240         } else if (!empty($options['cacheability']) && ($options['cacheability'] === 'private')) {
2241             // This file must be cache-able only by browsers.
2242             $cacheability = ' private,';
2243         } else if (isloggedin() and !isguestuser()) {
2244             // By default, under the conditions above, this file must be cache-able only by browsers.
2245             $cacheability = ' private,';
2246         }
2247         $nobyteserving = false;
2248         header('Cache-Control:'.$cacheability.' max-age='.$lifetime.', no-transform'.$immutable);
2249         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2250         header('Pragma: ');
2252     } else { // Do not cache files in proxies and browsers
2253         $nobyteserving = true;
2254         if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2255             header('Cache-Control: private, max-age=10, no-transform');
2256             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2257             header('Pragma: ');
2258         } else { //normal http - prevent caching at all cost
2259             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2260             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2261             header('Pragma: no-cache');
2262         }
2263     }
2265     if (empty($filter)) {
2266         // send the contents
2267         if ($pathisstring) {
2268             readstring_accel($path, $mimetype, !$dontdie);
2269         } else {
2270             readfile_accel($path, $mimetype, !$dontdie);
2271         }
2273     } else {
2274         // Try to put the file through filters
2275         if ($mimetype == 'text/html' || $mimetype == 'application/xhtml+xml') {
2276             $options = new stdClass();
2277             $options->noclean = true;
2278             $options->nocache = true; // temporary workaround for MDL-5136
2279             if (is_object($path)) {
2280                 $text = $path->get_content();
2281             } else if ($pathisstring) {
2282                 $text = $path;
2283             } else {
2284                 $text = implode('', file($path));
2285             }
2286             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2288             readstring_accel($output, $mimetype, false);
2290         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2291             // only filter text if filter all files is selected
2292             $options = new stdClass();
2293             $options->newlines = false;
2294             $options->noclean = true;
2295             if (is_object($path)) {
2296                 $text = htmlentities($path->get_content(), ENT_QUOTES, 'UTF-8');
2297             } else if ($pathisstring) {
2298                 $text = htmlentities($path, ENT_QUOTES, 'UTF-8');
2299             } else {
2300                 $text = htmlentities(implode('', file($path)), ENT_QUOTES, 'UTF-8');
2301             }
2302             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2304             readstring_accel($output, $mimetype, false);
2306         } else {
2307             // send the contents
2308             if ($pathisstring) {
2309                 readstring_accel($path, $mimetype, !$dontdie);
2310             } else {
2311                 readfile_accel($path, $mimetype, !$dontdie);
2312             }
2313         }
2314     }
2315     if ($dontdie) {
2316         return;
2317     }
2318     die; //no more chars to output!!!
2321 /**
2322  * Handles the sending of file data to the user's browser, including support for
2323  * byteranges etc.
2324  *
2325  * The $options parameter supports the following keys:
2326  *  (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2327  *  (string|null) filename - overrides the implicit filename
2328  *  (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2329  *      if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2330  *      you must detect this case when control is returned using connection_aborted. Please not that session is closed
2331  *      and should not be reopened
2332  *  (string|null) cacheability - force the cacheability setting of the HTTP response, "private" or "public",
2333  *      when $lifetime is greater than 0. Cacheability defaults to "private" when logged in as other than guest; otherwise,
2334  *      defaults to "public".
2335  *  (string|null) immutable - set the immutable cache setting in the HTTP response, when served under HTTPS.
2336  *      Note: it's up to the consumer to set it properly i.e. when serving a "versioned" URL.
2337  *
2338  * @category files
2339  * @param stored_file $stored_file local file object
2340  * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2341  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2342  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2343  * @param array $options additional options affecting the file serving
2344  * @return null script execution stopped unless $options['dontdie'] is true
2345  */
2346 function send_stored_file($stored_file, $lifetime=null, $filter=0, $forcedownload=false, array $options=array()) {
2347     global $CFG, $COURSE;
2349     if (empty($options['filename'])) {
2350         $filename = null;
2351     } else {
2352         $filename = $options['filename'];
2353     }
2355     if (empty($options['dontdie'])) {
2356         $dontdie = false;
2357     } else {
2358         $dontdie = true;
2359     }
2361     if ($lifetime === 'default' or is_null($lifetime)) {
2362         $lifetime = $CFG->filelifetime;
2363     }
2365     if (!empty($options['preview'])) {
2366         // replace the file with its preview
2367         $fs = get_file_storage();
2368         $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2369         if (!$preview_file) {
2370             // unable to create a preview of the file, send its default mime icon instead
2371             if ($options['preview'] === 'tinyicon') {
2372                 $size = 24;
2373             } else if ($options['preview'] === 'thumb') {
2374                 $size = 90;
2375             } else {
2376                 $size = 256;
2377             }
2378             $fileicon = file_file_icon($stored_file, $size);
2379             send_file($CFG->dirroot.'/pix/'.$fileicon.'.svg', basename($fileicon).'.svg');
2380         } else {
2381             // preview images have fixed cache lifetime and they ignore forced download
2382             // (they are generated by GD and therefore they are considered reasonably safe).
2383             $stored_file = $preview_file;
2384             $lifetime = DAYSECS;
2385             $filter = 0;
2386             $forcedownload = false;
2387         }
2388     }
2390     // handle external resource
2391     if ($stored_file && $stored_file->is_external_file() && !isset($options['sendcachedexternalfile'])) {
2392         $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2393         die;
2394     }
2396     if (!$stored_file or $stored_file->is_directory()) {
2397         // nothing to serve
2398         if ($dontdie) {
2399             return;
2400         }
2401         die;
2402     }
2404     $filename = is_null($filename) ? $stored_file->get_filename() : $filename;
2406     // Use given MIME type if specified.
2407     $mimetype = $stored_file->get_mimetype();
2409     // Allow cross-origin requests only for Web Services.
2410     // This allow to receive requests done by Web Workers or webapps in different domains.
2411     if (WS_SERVER) {
2412         header('Access-Control-Allow-Origin: *');
2413     }
2415     send_file($stored_file, $filename, $lifetime, $filter, false, $forcedownload, $mimetype, $dontdie, $options);
2418 /**
2419  * Recursively delete the file or folder with path $location. That is,
2420  * if it is a file delete it. If it is a folder, delete all its content
2421  * then delete it. If $location does not exist to start, that is not
2422  * considered an error.
2423  *
2424  * @param string $location the path to remove.
2425  * @return bool
2426  */
2427 function fulldelete($location) {
2428     if (empty($location)) {
2429         // extra safety against wrong param
2430         return false;
2431     }
2432     if (is_dir($location)) {
2433         if (!$currdir = opendir($location)) {
2434             return false;
2435         }
2436         while (false !== ($file = readdir($currdir))) {
2437             if ($file <> ".." && $file <> ".") {
2438                 $fullfile = $location."/".$file;
2439                 if (is_dir($fullfile)) {
2440                     if (!fulldelete($fullfile)) {
2441                         return false;
2442                     }
2443                 } else {
2444                     if (!unlink($fullfile)) {
2445                         return false;
2446                     }
2447                 }
2448             }
2449         }
2450         closedir($currdir);
2451         if (! rmdir($location)) {
2452             return false;
2453         }
2455     } else if (file_exists($location)) {
2456         if (!unlink($location)) {
2457             return false;
2458         }
2459     }
2460     return true;
2463 /**
2464  * Send requested byterange of file.
2465  *
2466  * @param resource $handle A file handle
2467  * @param string $mimetype The mimetype for the output
2468  * @param array $ranges An array of ranges to send
2469  * @param string $filesize The size of the content if only one range is used
2470  */
2471 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2472     // better turn off any kind of compression and buffering
2473     ini_set('zlib.output_compression', 'Off');
2475     $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2476     if ($handle === false) {
2477         die;
2478     }
2479     if (count($ranges) == 1) { //only one range requested
2480         $length = $ranges[0][2] - $ranges[0][1] + 1;
2481         header('HTTP/1.1 206 Partial content');
2482         header('Content-Length: '.$length);
2483         header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2484         header('Content-Type: '.$mimetype);
2486         while(@ob_get_level()) {
2487             if (!@ob_end_flush()) {
2488                 break;
2489             }
2490         }
2492         fseek($handle, $ranges[0][1]);
2493         while (!feof($handle) && $length > 0) {
2494             core_php_time_limit::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2495             $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2496             echo $buffer;
2497             flush();
2498             $length -= strlen($buffer);
2499         }
2500         fclose($handle);
2501         die;
2502     } else { // multiple ranges requested - not tested much
2503         $totallength = 0;
2504         foreach($ranges as $range) {
2505             $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2506         }
2507         $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2508         header('HTTP/1.1 206 Partial content');
2509         header('Content-Length: '.$totallength);
2510         header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2512         while(@ob_get_level()) {
2513             if (!@ob_end_flush()) {
2514                 break;
2515             }
2516         }
2518         foreach($ranges as $range) {
2519             $length = $range[2] - $range[1] + 1;
2520             echo $range[0];
2521             fseek($handle, $range[1]);
2522             while (!feof($handle) && $length > 0) {
2523                 core_php_time_limit::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2524                 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2525                 echo $buffer;
2526                 flush();
2527                 $length -= strlen($buffer);
2528             }
2529         }
2530         echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2531         fclose($handle);
2532         die;
2533     }
2536 /**
2537  * Tells whether the filename is executable.
2538  *
2539  * @link http://php.net/manual/en/function.is-executable.php
2540  * @link https://bugs.php.net/bug.php?id=41062
2541  * @param string $filename Path to the file.
2542  * @return bool True if the filename exists and is executable; otherwise, false.
2543  */
2544 function file_is_executable($filename) {
2545     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
2546         if (is_executable($filename)) {
2547             return true;
2548         } else {
2549             $fileext = strrchr($filename, '.');
2550             // If we have an extension we can check if it is listed as executable.
2551             if ($fileext && file_exists($filename) && !is_dir($filename)) {
2552                 $winpathext = strtolower(getenv('PATHEXT'));
2553                 $winpathexts = explode(';', $winpathext);
2555                 return in_array(strtolower($fileext), $winpathexts);
2556             }
2558             return false;
2559         }
2560     } else {
2561         return is_executable($filename);
2562     }
2565 /**
2566  * Overwrite an existing file in a draft area.
2567  *
2568  * @param  stored_file $newfile      the new file with the new content and meta-data
2569  * @param  stored_file $existingfile the file that will be overwritten
2570  * @throws moodle_exception
2571  * @since Moodle 3.2
2572  */
2573 function file_overwrite_existing_draftfile(stored_file $newfile, stored_file $existingfile) {
2574     if ($existingfile->get_component() != 'user' or $existingfile->get_filearea() != 'draft') {
2575         throw new coding_exception('The file to overwrite is not in a draft area.');
2576     }
2578     $fs = get_file_storage();
2579     // Remember original file source field.
2580     $source = @unserialize($existingfile->get_source());
2581     // Remember the original sortorder.
2582     $sortorder = $existingfile->get_sortorder();
2583     if ($newfile->is_external_file()) {
2584         // New file is a reference. Check that existing file does not have any other files referencing to it
2585         if (isset($source->original) && $fs->search_references_count($source->original)) {
2586             throw new moodle_exception('errordoublereference', 'repository');
2587         }
2588     }
2590     // Delete existing file to release filename.
2591     $newfilerecord = array(
2592         'contextid' => $existingfile->get_contextid(),
2593         'component' => 'user',
2594         'filearea' => 'draft',
2595         'itemid' => $existingfile->get_itemid(),
2596         'timemodified' => time()
2597     );
2598     $existingfile->delete();
2600     // Create new file.
2601     $newfile = $fs->create_file_from_storedfile($newfilerecord, $newfile);
2602     // Preserve original file location (stored in source field) for handling references.
2603     if (isset($source->original)) {
2604         if (!($newfilesource = @unserialize($newfile->get_source()))) {
2605             $newfilesource = new stdClass();
2606         }
2607         $newfilesource->original = $source->original;
2608         $newfile->set_source(serialize($newfilesource));
2609     }
2610     $newfile->set_sortorder($sortorder);
2613 /**
2614  * Add files from a draft area into a final area.
2615  *
2616  * Most of the time you do not want to use this. It is intended to be used
2617  * by asynchronous services which cannot direcly manipulate a final
2618  * area through a draft area. Instead they add files to a new draft
2619  * area and merge that new draft into the final area when ready.
2620  *
2621  * @param int $draftitemid the id of the draft area to use.
2622  * @param int $contextid this parameter and the next two identify the file area to save to.
2623  * @param string $component component name
2624  * @param string $filearea indentifies the file area
2625  * @param int $itemid identifies the item id or false for all items in the file area
2626  * @param array $options area options (subdirs=false, maxfiles=-1, maxbytes=0, areamaxbytes=FILE_AREA_MAX_BYTES_UNLIMITED)
2627  * @see file_save_draft_area_files
2628  * @since Moodle 3.2
2629  */
2630 function file_merge_files_from_draft_area_into_filearea($draftitemid, $contextid, $component, $filearea, $itemid,
2631                                                         array $options = null) {
2632     // We use 0 here so file_prepare_draft_area creates a new one, finaldraftid will be updated with the new draft id.
2633     $finaldraftid = 0;
2634     file_prepare_draft_area($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
2635     file_merge_draft_area_into_draft_area($draftitemid, $finaldraftid);
2636     file_save_draft_area_files($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
2639 /**
2640  * Merge files from two draftarea areas.
2641  *
2642  * This does not handle conflict resolution, files in the destination area which appear
2643  * to be more recent will be kept disregarding the intended ones.
2644  *
2645  * @param int $getfromdraftid the id of the draft area where are the files to merge.
2646  * @param int $mergeintodraftid the id of the draft area where new files will be merged.
2647  * @throws coding_exception
2648  * @since Moodle 3.2
2649  */
2650 function file_merge_draft_area_into_draft_area($getfromdraftid, $mergeintodraftid) {
2651     global $USER;
2653     $fs = get_file_storage();
2654     $contextid = context_user::instance($USER->id)->id;
2656     if (!$filestomerge = $fs->get_area_files($contextid, 'user', 'draft', $getfromdraftid)) {
2657         throw new coding_exception('Nothing to merge or area does not belong to current user');
2658     }
2660     $currentfiles = $fs->get_area_files($contextid, 'user', 'draft', $mergeintodraftid);
2662     // Get hashes of the files to merge.
2663     $newhashes = array();
2664     foreach ($filestomerge as $filetomerge) {
2665         $filepath = $filetomerge->get_filepath();
2666         $filename = $filetomerge->get_filename();
2668         $newhash = $fs->get_pathname_hash($contextid, 'user', 'draft', $mergeintodraftid, $filepath, $filename);
2669         $newhashes[$newhash] = $filetomerge;
2670     }
2672     // Calculate wich files must be added.
2673     foreach ($currentfiles as $file) {
2674         $filehash = $file->get_pathnamehash();
2675         // One file to be merged already exists.
2676         if (isset($newhashes[$filehash])) {
2677             $updatedfile = $newhashes[$filehash];
2679             // Avoid race conditions.
2680             if ($file->get_timemodified() > $updatedfile->get_timemodified()) {
2681                 // The existing file is more recent, do not copy the suposedly "new" one.
2682                 unset($newhashes[$filehash]);
2683                 continue;
2684             }
2685             // Update existing file (not only content, meta-data too).
2686             file_overwrite_existing_draftfile($updatedfile, $file);
2687             unset($newhashes[$filehash]);
2688         }
2689     }
2691     foreach ($newhashes as $newfile) {
2692         $newfilerecord = array(
2693             'contextid' => $contextid,
2694             'component' => 'user',
2695             'filearea' => 'draft',
2696             'itemid' => $mergeintodraftid,
2697             'timemodified' => time()
2698         );
2700         $fs->create_file_from_storedfile($newfilerecord, $newfile);
2701     }
2704 /**
2705  * RESTful cURL class
2706  *
2707  * This is a wrapper class for curl, it is quite easy to use:
2708  * <code>
2709  * $c = new curl;
2710  * // enable cache
2711  * $c = new curl(array('cache'=>true));
2712  * // enable cookie
2713  * $c = new curl(array('cookie'=>true));
2714  * // enable proxy
2715  * $c = new curl(array('proxy'=>true));
2716  *
2717  * // HTTP GET Method
2718  * $html = $c->get('http://example.com');
2719  * // HTTP POST Method
2720  * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2721  * // HTTP PUT Method
2722  * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2723  * </code>
2724  *
2725  * @package   core_files
2726  * @category files
2727  * @copyright Dongsheng Cai <dongsheng@moodle.com>
2728  * @license   http://www.gnu.org/copyleft/gpl.html GNU Public License
2729  */
2730 class curl {
2731     /** @var bool Caches http request contents */
2732     public  $cache    = false;
2733     /** @var bool Uses proxy, null means automatic based on URL */
2734     public  $proxy    = null;
2735     /** @var string library version */
2736     public  $version  = '0.4 dev';
2737     /** @var array http's response */
2738     public  $response = array();
2739     /** @var array Raw response headers, needed for BC in download_file_content(). */
2740     public $rawresponse = array();
2741     /** @var array http header */
2742     public  $header   = array();
2743     /** @var string cURL information */
2744     public  $info;
2745     /** @var string error */
2746     public  $error;
2747     /** @var int error code */
2748     public  $errno;
2749     /** @var bool use workaround for open_basedir restrictions, to be changed from unit tests only! */
2750     public $emulateredirects = null;
2752     /** @var array cURL options */
2753     private $options;
2755     /** @var string Proxy host */
2756     private $proxy_host = '';
2757     /** @var string Proxy auth */
2758     private $proxy_auth = '';
2759     /** @var string Proxy type */
2760     private $proxy_type = '';
2761     /** @var bool Debug mode on */
2762     private $debug    = false;
2763     /** @var bool|string Path to cookie file */
2764     private $cookie   = false;
2765     /** @var bool tracks multiple headers in response - redirect detection */
2766     private $responsefinished = false;
2767     /** @var security helper class, responsible for checking host/ports against blacklist/whitelist entries.*/
2768     private $securityhelper;
2769     /** @var bool ignoresecurity a flag which can be supplied to the constructor, allowing security to be bypassed. */
2770     private $ignoresecurity;
2771     /** @var array $mockresponses For unit testing only - return the head of this list instead of making the next request. */
2772     private static $mockresponses = [];
2774     /**
2775      * Curl constructor.
2776      *
2777      * Allowed settings are:
2778      *  proxy: (bool) use proxy server, null means autodetect non-local from url
2779      *  debug: (bool) use debug output
2780      *  cookie: (string) path to cookie file, false if none
2781      *  cache: (bool) use cache
2782      *  module_cache: (string) type of cache
2783      *  securityhelper: (\core\files\curl_security_helper_base) helper object providing URL checking for requests.
2784      *  ignoresecurity: (bool) set true to override and ignore the security helper when making requests.
2785      *
2786      * @param array $settings
2787      */
2788     public function __construct($settings = array()) {
2789         global $CFG;
2790         if (!function_exists('curl_init')) {
2791             $this->error = 'cURL module must be enabled!';
2792             trigger_error($this->error, E_USER_ERROR);
2793             return false;
2794         }
2796         // All settings of this class should be init here.
2797         $this->resetopt();
2798         if (!empty($settings['debug'])) {
2799             $this->debug = true;
2800         }
2801         if (!empty($settings['cookie'])) {
2802             if($settings['cookie'] === true) {
2803                 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2804             } else {
2805                 $this->cookie = $settings['cookie'];
2806             }
2807         }
2808         if (!empty($settings['cache'])) {
2809             if (class_exists('curl_cache')) {
2810                 if (!empty($settings['module_cache'])) {
2811                     $this->cache = new curl_cache($settings['module_cache']);
2812                 } else {
2813                     $this->cache = new curl_cache('misc');
2814                 }
2815             }
2816         }
2817         if (!empty($CFG->proxyhost)) {
2818             if (empty($CFG->proxyport)) {
2819                 $this->proxy_host = $CFG->proxyhost;
2820             } else {
2821                 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2822             }
2823             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2824                 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2825                 $this->setopt(array(
2826                             'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2827                             'proxyuserpwd'=>$this->proxy_auth));
2828             }
2829             if (!empty($CFG->proxytype)) {
2830                 if ($CFG->proxytype == 'SOCKS5') {
2831                     $this->proxy_type = CURLPROXY_SOCKS5;
2832                 } else {
2833                     $this->proxy_type = CURLPROXY_HTTP;
2834                     $this->setopt(array('httpproxytunnel'=>false));
2835                 }
2836                 $this->setopt(array('proxytype'=>$this->proxy_type));
2837             }
2839             if (isset($settings['proxy'])) {
2840                 $this->proxy = $settings['proxy'];
2841             }
2842         } else {
2843             $this->proxy = false;
2844         }
2846         if (!isset($this->emulateredirects)) {
2847             $this->emulateredirects = ini_get('open_basedir');
2848         }
2850         // Curl security setup. Allow injection of a security helper, but if not found, default to the core helper.
2851         if (isset($settings['securityhelper']) && $settings['securityhelper'] instanceof \core\files\curl_security_helper_base) {
2852             $this->set_security($settings['securityhelper']);
2853         } else {
2854             $this->set_security(new \core\files\curl_security_helper());
2855         }
2856         $this->ignoresecurity = isset($settings['ignoresecurity']) ? $settings['ignoresecurity'] : false;
2857     }
2859     /**
2860      * Resets the CURL options that have already been set
2861      */
2862     public function resetopt() {
2863         $this->options = array();
2864         $this->options['CURLOPT_USERAGENT']         = 'MoodleBot/1.0';
2865         // True to include the header in the output
2866         $this->options['CURLOPT_HEADER']            = 0;
2867         // True to Exclude the body from the output
2868         $this->options['CURLOPT_NOBODY']            = 0;
2869         // Redirect ny default.
2870         $this->options['CURLOPT_FOLLOWLOCATION']    = 1;
2871         $this->options['CURLOPT_MAXREDIRS']         = 10;
2872         $this->options['CURLOPT_ENCODING']          = '';
2873         // TRUE to return the transfer as a string of the return
2874         // value of curl_exec() instead of outputting it out directly.
2875         $this->options['CURLOPT_RETURNTRANSFER']    = 1;
2876         $this->options['CURLOPT_SSL_VERIFYPEER']    = 0;
2877         $this->options['CURLOPT_SSL_VERIFYHOST']    = 2;
2878         $this->options['CURLOPT_CONNECTTIMEOUT']    = 30;
2880         if ($cacert = self::get_cacert()) {
2881             $this->options['CURLOPT_CAINFO'] = $cacert;
2882         }
2883     }
2885     /**
2886      * Get the location of ca certificates.
2887      * @return string absolute file path or empty if default used
2888      */
2889     public static function get_cacert() {
2890         global $CFG;
2892         // Bundle in dataroot always wins.
2893         if (is_readable("$CFG->dataroot/moodleorgca.crt")) {
2894             return realpath("$CFG->dataroot/moodleorgca.crt");
2895         }
2897         // Next comes the default from php.ini
2898         $cacert = ini_get('curl.cainfo');
2899         if (!empty($cacert) and is_readable($cacert)) {
2900             return realpath($cacert);
2901         }
2903         // Windows PHP does not have any certs, we need to use something.
2904         if ($CFG->ostype === 'WINDOWS') {
2905             if (is_readable("$CFG->libdir/cacert.pem")) {
2906                 return realpath("$CFG->libdir/cacert.pem");
2907             }
2908         }
2910         // Use default, this should work fine on all properly configured *nix systems.
2911         return null;
2912     }
2914     /**
2915      * Reset Cookie
2916      */
2917     public function resetcookie() {
2918         if (!empty($this->cookie)) {
2919             if (is_file($this->cookie)) {
2920                 $fp = fopen($this->cookie, 'w');
2921                 if (!empty($fp)) {
2922                     fwrite($fp, '');
2923                     fclose($fp);
2924                 }
2925             }
2926         }
2927     }
2929     /**
2930      * Set curl options.
2931      *
2932      * Do not use the curl constants to define the options, pass a string
2933      * corresponding to that constant. Ie. to set CURLOPT_MAXREDIRS, pass
2934      * array('CURLOPT_MAXREDIRS' => 10) or array('maxredirs' => 10) to this method.
2935      *
2936      * @param array $options If array is null, this function will reset the options to default value.
2937      * @return void
2938      * @throws coding_exception If an option uses constant value instead of option name.
2939      */
2940     public function setopt($options = array()) {
2941         if (is_array($options)) {
2942             foreach ($options as $name => $val) {
2943                 if (!is_string($name)) {
2944                     throw new coding_exception('Curl options should be defined using strings, not constant values.');
2945                 }
2946                 if (stripos($name, 'CURLOPT_') === false) {
2947                     $name = strtoupper('CURLOPT_'.$name);
2948                 } else {
2949                     $name = strtoupper($name);
2950                 }
2951                 $this->options[$name] = $val;
2952             }
2953         }
2954     }
2956     /**
2957      * Reset http method
2958      */
2959     public function cleanopt() {
2960         unset($this->options['CURLOPT_HTTPGET']);
2961         unset($this->options['CURLOPT_POST']);
2962         unset($this->options['CURLOPT_POSTFIELDS']);
2963         unset($this->options['CURLOPT_PUT']);
2964         unset($this->options['CURLOPT_INFILE']);
2965         unset($this->options['CURLOPT_INFILESIZE']);
2966         unset($this->options['CURLOPT_CUSTOMREQUEST']);
2967         unset($this->options['CURLOPT_FILE']);
2968     }
2970     /**
2971      * Resets the HTTP Request headers (to prepare for the new request)
2972      */
2973     public function resetHeader() {
2974         $this->header = array();
2975     }
2977     /**
2978      * Set HTTP Request Header
2979      *
2980      * @param array $header
2981      * @param bool $replace If true, will remove any existing headers before appending the new one.
2982      */
2983     public function setHeader($header) {
2984         if (is_array($header)) {
2985             foreach ($header as $v) {
2986                 $this->setHeader($v);
2987             }
2988         } else {
2989             // Remove newlines, they are not allowed in headers.
2990             $this->header[] = preg_replace('/[\r\n]/', '', $header);
2991         }
2992     }
2994     /**
2995      * Get HTTP Response Headers
2996      * @return array of arrays
2997      */
2998     public function getResponse() {
2999         return $this->response;
3000     }
3002     /**
3003      * Get raw HTTP Response Headers
3004      * @return array of strings
3005      */
3006     public function get_raw_response() {
3007         return $this->rawresponse;
3008     }
3010     /**
3011      * private callback function
3012      * Formatting HTTP Response Header
3013      *
3014      * We only keep the last headers returned. For example during a redirect the
3015      * redirect headers will not appear in {@link self::getResponse()}, if you need
3016      * to use those headers, refer to {@link self::get_raw_response()}.
3017      *
3018      * @param resource $ch Apparently not used
3019      * @param string $header
3020      * @return int The strlen of the header
3021      */
3022     private function formatHeader($ch, $header) {
3023         $this->rawresponse[] = $header;
3025         if (trim($header, "\r\n") === '') {
3026             // This must be the last header.
3027             $this->responsefinished = true;
3028         }
3030         if (strlen($header) > 2) {
3031             if ($this->responsefinished) {
3032                 // We still have headers after the supposedly last header, we must be
3033                 // in a redirect so let's empty the response to keep the last headers.
3034                 $this->responsefinished = false;
3035                 $this->response = array();
3036             }
3037             $parts = explode(" ", rtrim($header, "\r\n"), 2);
3038             $key = rtrim($parts[0], ':');
3039             $value = isset($parts[1]) ? $parts[1] : null;
3040             if (!empty($this->response[$key])) {
3041                 if (is_array($this->response[$key])) {
3042                     $this->response[$key][] = $value;
3043                 } else {
3044                     $tmp = $this->response[$key];
3045                     $this->response[$key] = array();
3046                     $this->response[$key][] = $tmp;
3047                     $this->response[$key][] = $value;
3049                 }
3050             } else {
3051                 $this->response[$key] = $value;
3052             }
3053         }
3054         return strlen($header);
3055     }
3057     /**
3058      * Set options for individual curl instance
3059      *
3060      * @param resource $curl A curl handle
3061      * @param array $options
3062      * @return resource The curl handle
3063      */
3064     private function apply_opt($curl, $options) {
3065         // Clean up
3066         $this->cleanopt();
3067         // set cookie
3068         if (!empty($this->cookie) || !empty($options['cookie'])) {
3069             $this->setopt(array('cookiejar'=>$this->cookie,
3070                             'cookiefile'=>$this->cookie
3071                              ));
3072         }
3074         // Bypass proxy if required.
3075         if ($this->proxy === null) {
3076             if (!empty($this->options['CURLOPT_URL']) and is_proxybypass($this->options['CURLOPT_URL'])) {
3077                 $proxy = false;
3078             } else {
3079                 $proxy = true;
3080             }
3081         } else {
3082             $proxy = (bool)$this->proxy;
3083         }
3085         // Set proxy.
3086         if ($proxy) {
3087             $options['CURLOPT_PROXY'] = $this->proxy_host;
3088         } else {
3089             unset($this->options['CURLOPT_PROXY']);
3090         }
3092         $this->setopt($options);
3094         // Reset before set options.
3095         curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
3097         // Setting the User-Agent based on options provided.
3098         $useragent = '';
3100         if (!empty($options['CURLOPT_USERAGENT'])) {
3101             $useragent = $options['CURLOPT_USERAGENT'];
3102         } else if (!empty($this->options['CURLOPT_USERAGENT'])) {
3103             $useragent = $this->options['CURLOPT_USERAGENT'];
3104         } else {
3105             $useragent = 'MoodleBot/1.0';
3106         }
3108         // Set headers.
3109         if (empty($this->header)) {
3110             $this->setHeader(array(
3111                 'User-Agent: ' . $useragent,
3112                 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
3113                 'Connection: keep-alive'
3114                 ));
3115         } else if (!in_array('User-Agent: ' . $useragent, $this->header)) {
3116             // Remove old User-Agent if one existed.
3117             // We have to partial search since we don't know what the original User-Agent is.
3118             if ($match = preg_grep('/User-Agent.*/', $this->header)) {
3119                 $key = array_keys($match)[0];
3120                 unset($this->header[$key]);
3121             }
3122             $this->setHeader(array('User-Agent: ' . $useragent));
3123         }
3124         curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
3126         if ($this->debug) {
3127             echo '<h1>Options</h1>';
3128             var_dump($this->options);
3129             echo '<h1>Header</h1>';
3130             var_dump($this->header);
3131         }
3133         // Do not allow infinite redirects.
3134         if (!isset($this->options['CURLOPT_MAXREDIRS'])) {
3135             $this->options['CURLOPT_MAXREDIRS'] = 0;
3136         } else if ($this->options['CURLOPT_MAXREDIRS'] > 100) {
3137             $this->options['CURLOPT_MAXREDIRS'] = 100;
3138         } else {
3139             $this->options['CURLOPT_MAXREDIRS'] = (int)$this->options['CURLOPT_MAXREDIRS'];
3140         }
3142         // Make sure we always know if redirects expected.
3143         if (!isset($this->options['CURLOPT_FOLLOWLOCATION'])) {
3144             $this->options['CURLOPT_FOLLOWLOCATION'] = 0;
3145         }
3147         // Limit the protocols to HTTP and HTTPS.
3148         if (defined('CURLOPT_PROTOCOLS')) {
3149             $this->options['CURLOPT_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS);
3150             $this->options['CURLOPT_REDIR_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS);
3151         }
3153         // Set options.
3154         foreach($this->options as $name => $val) {
3155             if ($name === 'CURLOPT_FOLLOWLOCATION' and $this->emulateredirects) {
3156                 // The redirects are emulated elsewhere.
3157                 curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 0);
3158                 continue;
3159             }
3160             $name = constant($name);
3161             curl_setopt($curl, $name, $val);
3162         }
3164         return $curl;
3165     }
3167     /**
3168      * Download multiple files in parallel
3169      *
3170      * Calls {@link multi()} with specific download headers
3171      *
3172      * <code>
3173      * $c = new curl();
3174      * $file1 = fopen('a', 'wb');
3175      * $file2 = fopen('b', 'wb');
3176      * $c->download(array(
3177      *     array('url'=>'http://localhost/', 'file'=>$file1),
3178      *     array('url'=>'http://localhost/20/', 'file'=>$file2)
3179      * ));
3180      * fclose($file1);
3181      * fclose($file2);
3182      * </code>
3183      *
3184      * or
3185      *
3186      * <code>
3187      * $c = new curl();
3188      * $c->download(array(
3189      *              array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3190      *              array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3191      *              ));
3192      * </code>
3193      *
3194      * @param array $requests An array of files to request {
3195      *                  url => url to download the file [required]
3196      *                  file => file handler, or
3197      *                  filepath => file path
3198      * }
3199      * If 'file' and 'filepath' parameters are both specified in one request, the
3200      * open file handle in the 'file' parameter will take precedence and 'filepath'
3201      * will be ignored.
3202      *
3203      * @param array $options An array of options to set
3204      * @return array An array of results
3205      */
3206     public function download($requests, $options = array()) {
3207         $options['RETURNTRANSFER'] = false;
3208         return $this->multi($requests, $options);
3209     }
3211     /**
3212      * Returns the current curl security helper.
3213      *
3214      * @return \core\files\curl_security_helper instance.
3215      */
3216     public function get_security() {
3217         return $this->securityhelper;
3218     }
3220     /**
3221      * Sets the curl security helper.
3222      *
3223      * @param \core\files\curl_security_helper $securityobject instance/subclass of the base curl_security_helper class.
3224      * @return bool true if the security helper could be set, false otherwise.
3225      */
3226     public function set_security($securityobject) {
3227         if ($securityobject instanceof \core\files\curl_security_helper) {
3228             $this->securityhelper = $securityobject;
3229             return true;
3230         }
3231         return false;
3232     }
3234     /**
3235      * Multi HTTP Requests
3236      * This function could run multi-requests in parallel.
3237      *
3238      * @param array $requests An array of files to request
3239      * @param array $options An array of options to set
3240      * @return array An array of results
3241      */
3242     protected function multi($requests, $options = array()) {
3243         $count   = count($requests);
3244         $handles = array();
3245         $results = array();
3246         $main    = curl_multi_init();
3247         for ($i = 0; $i < $count; $i++) {
3248             if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3249                 // open file
3250                 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3251                 $requests[$i]['auto-handle'] = true;
3252             }
3253             foreach($requests[$i] as $n=>$v) {
3254                 $options[$n] = $v;
3255             }
3256             $handles[$i] = curl_init($requests[$i]['url']);
3257             $this->apply_opt($handles[$i], $options);
3258             curl_multi_add_handle($main, $handles[$i]);
3259         }
3260         $running = 0;
3261         do {
3262             curl_multi_exec($main, $running);
3263         } while($running > 0);
3264         for ($i = 0; $i < $count; $i++) {
3265             if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3266                 $results[] = true;
3267             } else {
3268                 $results[] = curl_multi_getcontent($handles[$i]);
3269             }
3270             curl_multi_remove_handle($main, $handles[$i]);
3271         }
3272         curl_multi_close($main);
3274         for ($i = 0; $i < $count; $i++) {
3275             if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3276                 // close file handler if file is opened in this function
3277                 fclose($requests[$i]['file']);
3278             }
3279         }
3280         return $results;
3281     }
3283     /**
3284      * Helper function to reset the request state vars.
3285      *
3286      * @return void.
3287      */
3288     protected function reset_request_state_vars() {
3289         $this->info             = array();
3290         $this->error            = '';
3291         $this->errno            = 0;
3292         $this->response         = array();
3293         $this->rawresponse      = array();
3294         $this->responsefinished = false;
3295     }
3297     /**
3298      * For use only in unit tests - we can pre-set the next curl response.
3299      * This is useful for unit testing APIs that call external systems.
3300      * @param string $response
3301      */
3302     public static function mock_response($response) {
3303         if ((defined('PHPUNIT_TEST') && PHPUNIT_TEST)) {
3304             array_push(self::$mockresponses, $response);
3305         } else {
3306             throw new coding_excpetion('mock_response function is only available for unit tests.');
3307         }
3308     }
3310     /**
3311      * Single HTTP Request
3312      *
3313      * @param string $url The URL to request
3314      * @param array $options
3315      * @return bool
3316      */
3317     protected function request($url, $options = array()) {
3318         // Reset here so that the data is valid when result returned from cache, or if we return due to a blacklist hit.
3319         $this->reset_request_state_vars();
3321         if ((defined('PHPUNIT_TEST') && PHPUNIT_TEST)) {
3322             if ($mockresponse = array_pop(self::$mockresponses)) {
3323                 $this->info = [ 'http_code' => 200 ];
3324                 return $mockresponse;
3325             }
3326         }
3328         // If curl security is enabled, check the URL against the blacklist before calling curl_exec.
3329         // Note: This will only check the base url. In the case of redirects, the blacklist is also after the curl_exec.
3330         if (!$this->ignoresecurity && $this->securityhelper->url_is_blocked($url)) {
3331             $this->error = $this->securityhelper->get_blocked_url_string();
3332             return $this->error;
3333         }
3335         // Set the URL as a curl option.
3336         $this->setopt(array('CURLOPT_URL' => $url));
3338         // Create curl instance.
3339         $curl = curl_init();
3341         $this->apply_opt($curl, $options);
3342         if ($this->cache && $ret = $this->cache->get($this->options)) {
3343             return $ret;
3344         }
3346         $ret = curl_exec($curl);
3347         $this->info  = curl_getinfo($curl);
3348         $this->error = curl_error($curl);
3349         $this->errno = curl_errno($curl);
3350         // Note: $this->response and $this->rawresponse are filled by $hits->formatHeader callback.
3352         // In the case of redirects (which curl blindly follows), check the post-redirect URL against the blacklist entries too.
3353         if (intval($this->info['redirect_count']) > 0 && !$this->ignoresecurity
3354             && $this->securityhelper->url_is_blocked($this->info['url'])) {
3355             $this->reset_request_state_vars();
3356             $this->error = $this->securityhelper->get_blocked_url_string();
3357             curl_close($curl);
3358             return $this->error;
3359         }
3361         if ($this->emulateredirects and $this->options['CURLOPT_FOLLOWLOCATION'] and $this->info['http_code'] != 200) {
3362             $redirects = 0;
3364             while($redirects <= $this->options['CURLOPT_MAXREDIRS']) {
3366                 if ($this->info['http_code'] == 301) {
3367                     // Moved Permanently - repeat the same request on new URL.
3369                 } else if ($this->info['http_code'] == 302) {
3370                     // Found - the standard redirect - repeat the same request on new URL.
3372                 } else if ($this->info['http_code'] == 303) {
3373                     // 303 See Other - repeat only if GET, do not bother with POSTs.
3374                     if (empty($this->options['CURLOPT_HTTPGET'])) {
3375                         break;
3376                     }
3378                 } else if ($this->info['http_code'] == 307) {
3379                     // Temporary Redirect - must repeat using the same request type.
3381                 } else if ($this->info['http_code'] == 308) {
3382                     // Permanent Redirect - must repeat using the same request type.
3384                 } else {
3385                     // Some other http code means do not retry!
3386                     break;
3387                 }
3389                 $redirects++;
3391                 $redirecturl = null;
3392                 if (isset($this->info['redirect_url'])) {
3393                     if (preg_match('|^https?://|i', $this->info['redirect_url'])) {
3394                         $redirecturl = $this->info['redirect_url'];
3395                     }
3396                 }
3397                 if (!$redirecturl) {
3398                     foreach ($this->response as $k => $v) {
3399                         if (strtolower($k) === 'location') {
3400                             $redirecturl = $v;
3401                             break;
3402                         }
3403                     }
3404                     if (preg_match('|^https?://|i', $redirecturl)) {
3405                         // Great, this is the correct location format!
3407                     } else if ($redirecturl) {
3408                         $current = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL);
3409                         if (strpos($redirecturl, '/') === 0) {
3410                             // Relative to server root - just guess.
3411                             $pos = strpos('/', $current, 8);
3412                             if ($pos === false) {
3413                                 $redirecturl = $current.$redirecturl;
3414                             } else {
3415                                 $redirecturl = substr($current, 0, $pos).$redirecturl;
3416                             }
3417                         } else {
3418                             // Relative to current script.
3419                             $redirecturl = dirname($current).'/'.$redirecturl;
3420                         }
3421                     }
3422                 }
3424                 curl_setopt($curl, CURLOPT_URL, $redirecturl);
3425                 $ret = curl_exec($curl);
3427                 $this->info  = curl_getinfo($curl);
3428                 $this->error = curl_error($curl);
3429                 $this->errno = curl_errno($curl);
3431                 $this->info['redirect_count'] = $redirects;
3433                 if ($this->info['http_code'] === 200) {
3434                     // Finally this is what we wanted.
3435                     break;
3436                 }
3437                 if ($this->errno != CURLE_OK) {
3438                     // Something wrong is going on.
3439                     break;
3440                 }
3441             }
3442             if ($redirects > $this->options['CURLOPT_MAXREDIRS']) {
3443                 $this->errno = CURLE_TOO_MANY_REDIRECTS;
3444                 $this->error = 'Maximum ('.$this->options['CURLOPT_MAXREDIRS'].') redirects followed';
3445             }
3446         }
3448         if ($this->cache) {
3449             $this->cache->set($this->options, $ret);
3450         }
3452         if ($this->debug) {
3453             echo '<h1>Return Data</h1>';
3454             var_dump($ret);
3455             echo '<h1>Info</h1>';
3456             var_dump($this->info);
3457             echo '<h1>Error</h1>';
3458             var_dump($this->error);
3459         }
3461         curl_close($curl);
3463         if (empty($this->error)) {
3464             return $ret;
3465         } else {
3466             return $this->error;
3467             // exception is not ajax friendly
3468             //throw new moodle_exception($this->error, 'curl');
3469         }
3470     }
3472     /**
3473      * HTTP HEAD method
3474      *
3475      * @see request()
3476      *
3477      * @param string $url
3478      * @param array $options
3479      * @return bool
3480      */
3481     public function head($url, $options = array()) {
3482         $options['CURLOPT_HTTPGET'] = 0;
3483         $options['CURLOPT_HEADER']  = 1;
3484         $options['CURLOPT_NOBODY']  = 1;
3485         return $this->request($url, $options);
3486     }
3488     /**
3489      * HTTP PATCH method
3490      *
3491      * @param string $url
3492      * @param array|string $params
3493      * @param array $options
3494      * @return bool
3495      */
3496     public function patch($url, $params = '', $options = array()) {
3497         $options['CURLOPT_CUSTOMREQUEST'] = 'PATCH';
3498         if (is_array($params)) {
3499             $this->_tmp_file_post_params = array();
3500             foreach ($params as $key => $value) {
3501                 if ($value instanceof stored_file) {
3502                     $value->add_to_curl_request($this, $key);
3503                 } else {
3504                     $this->_tmp_file_post_params[$key] = $value;
3505                 }
3506             }
3507             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3508             unset($this->_tmp_file_post_params);
3509         } else {
3510             // The variable $params is the raw post data.
3511             $options['CURLOPT_POSTFIELDS'] = $params;
3512         }
3513         return $this->request($url, $options);
3514     }
3516     /**
3517      * HTTP POST method
3518      *
3519      * @param string $url
3520      * @param array|string $params
3521      * @param array $options
3522      * @return bool
3523      */
3524     public function post($url, $params = '', $options = array()) {
3525         $options['CURLOPT_POST']       = 1;
3526         if (is_array($params)) {
3527             $this->_tmp_file_post_params = array();
3528             foreach ($params as $key => $value) {
3529                 if ($value instanceof stored_file) {
3530                     $value->add_to_curl_request($this, $key);
3531                 } else {
3532                     $this->_tmp_file_post_params[$key] = $value;
3533                 }
3534             }
3535             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3536             unset($this->_tmp_file_post_params);
3537         } else {
3538             // $params is the raw post data
3539             $options['CURLOPT_POSTFIELDS'] = $params;
3540         }
3541         return $this->request($url, $options);
3542     }
3544     /**
3545      * HTTP GET method
3546      *
3547      * @param string $url
3548      * @param array $params
3549      * @param array $options
3550      * @return bool
3551      */
3552     public function get($url, $params = array(), $options = array()) {
3553         $options['CURLOPT_HTTPGET'] = 1;
3555         if (!empty($params)) {
3556             $url .= (stripos($url, '?') !== false) ? '&' : '?';
3557             $url .= http_build_query($params, '', '&');
3558         }
3559         return $this->request($url, $options);
3560     }
3562     /**
3563      * Downloads one file and writes it to the specified file handler
3564      *
3565      * <code>
3566      * $c = new curl();
3567      * $file = fopen('savepath', 'w');
3568      * $result = $c->download_one('http://localhost/', null,
3569      *   array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3570      * fclose($file);
3571      * $download_info = $c->get_info();
3572      * if ($result === true) {
3573      *   // file downloaded successfully
3574      * } else {
3575      *   $error_text = $result;
3576      *   $error_code = $c->get_errno();
3577      * }
3578      * </code>
3579      *
3580      * <code>
3581      * $c = new curl();
3582      * $result = $c->download_one('http://localhost/', null,
3583      *   array('filepath' => 'savepath', 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3584      * // ... see above, no need to close handle and remove file if unsuccessful
3585      * </code>
3586      *
3587      * @param string $url
3588      * @param array|null $params key-value pairs to be added to $url as query string
3589      * @param array $options request options. Must include either 'file' or 'filepath'
3590      * @return bool|string true on success or error string on failure
3591      */
3592     public function download_one($url, $params, $options = array()) {
3593         $options['CURLOPT_HTTPGET'] = 1;
3594         if (!empty($params)) {
3595             $url .= (stripos($url, '?') !== false) ? '&' : '?';
3596             $url .= http_build_query($params, '', '&');
3597         }
3598         if (!empty($options['filepath']) && empty($options['file'])) {
3599             // open file
3600             if (!($options['file'] = fopen($options['filepath'], 'w'))) {
3601                 $this->errno = 100;
3602                 return get_string('cannotwritefile', 'error', $options['filepath']);
3603             }
3604             $filepath = $options['filepath'];
3605         }
3606         unset($options['filepath']);
3607         $result = $this->request($url, $options);
3608         if (isset($filepath)) {
3609             fclose($options['file']);
3610             if ($result !== true) {
3611                 unlink($filepath);
3612             }
3613         }
3614         return $result;
3615     }
3617     /**
3618      * HTTP PUT method
3619      *
3620      * @param string $url
3621      * @param array $params
3622      * @param array $options
3623      * @return bool
3624      */
3625     public function put($url, $params = array(), $options = array()) {
3626         $file = '';
3627         $fp = false;
3628         if (isset($params['file'])) {
3629             $file = $params['file'];
3630             if (is_file($file)) {
3631                 $fp   = fopen($file, 'r');
3632                 $size = filesize($file);
3633                 $options['CURLOPT_PUT']        = 1;
3634                 $options['CURLOPT_INFILESIZE'] = $size;
3635                 $options['CURLOPT_INFILE']     = $fp;
3636             } else {
3637                 return null;
3638             }
3639             if (!isset($this->options['CURLOPT_USERPWD'])) {
3640                 $this->setopt(array('CURLOPT_USERPWD' => 'anonymous: noreply@moodle.org'));
3641             }
3642         } else {
3643             $options['CURLOPT_CUSTOMREQUEST'] = 'PUT';
3644             $options['CURLOPT_POSTFIELDS'] = $params;
3645         }
3647         $ret = $this->request($url, $options);
3648         if ($fp !== false) {
3649             fclose($fp);
3650         }
3651         return $ret;
3652     }
3654     /**
3655      * HTTP DELETE method
3656      *
3657      * @param string $url
3658      * @param array $param
3659      * @param array $options
3660      * @return bool
3661      */
3662     public function delete($url, $param = array(), $options = array()) {
3663         $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
3664         if (!isset($options['CURLOPT_USERPWD'])) {
3665             $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
3666         }
3667         $ret = $this->request($url, $options);
3668         return $ret;
3669     }
3671     /**
3672      * HTTP TRACE method
3673      *
3674      * @param string $url
3675      * @param array $options
3676      * @return bool
3677      */
3678     public function trace($url, $options = array()) {
3679         $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
3680         $ret = $this->request($url, $options);
3681         return $ret;
3682     }
3684     /**
3685      * HTTP OPTIONS method
3686      *
3687      * @param string $url
3688      * @param array $options
3689      * @return bool
3690      */
3691     public function options($url, $options = array()) {
3692         $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
3693         $ret = $this->request($url, $options);
3694         return $ret;
3695     }
3697     /**
3698      * Get curl information
3699      *
3700      * @return string
3701      */
3702     public function get_info() {
3703         return $this->info;
3704     }
3706     /**
3707      * Get curl error code
3708      *
3709      * @return int
3710      */
3711     public function get_errno() {
3712         return $this->errno;
3713     }
3715     /**
3716      * When using a proxy, an additional HTTP response code may appear at
3717      * the start of the header. For example, when using https over a proxy
3718      * there may be 'HTTP/1.0 200 Connection Established'. Other codes are
3719      * also possible and some may come with their own headers.
3720      *
3721      * If using the return value containing all headers, this function can be
3722      * called to remove unwanted doubles.
3723      *
3724      * Note that it is not possible to distinguish this situation from valid
3725      * data unless you know the actual response part (below the headers)
3726      * will not be included in this string, or else will not 'look like' HTTP
3727      * headers. As a result it is not safe to call this function for general
3728      * data.
3729      *
3730      * @param string $input Input HTTP response
3731      * @return string HTTP response with additional headers stripped if any
3732      */
3733     public static function strip_double_headers($input) {
3734         // I have tried to make this regular expression as specific as possible
3735         // to avoid any case where it does weird stuff if you happen to put
3736         // HTTP/1.1 200 at the start of any line in your RSS file. This should
3737         // also make it faster because it can abandon regex processing as soon
3738         // as it hits something that doesn't look like an http header. The
3739         // header definition is taken from RFC 822, except I didn't support
3740         // folding which is never used in practice.
3741         $crlf = "\r\n";
3742         return preg_replace(
3743                 // HTTP version and status code (ignore value of code).
3744                 '~^HTTP/1\..*' . $crlf .
3745                 // Header name: character between 33 and 126 decimal, except colon.
3746                 // Colon. Header value: any character except \r and \n. CRLF.
3747                 '(?:[\x21-\x39\x3b-\x7e]+:[^' . $crlf . ']+' . $crlf . ')*' .
3748                 // Headers are terminated by another CRLF (blank line).
3749                 $crlf .
3750                 // Second HTTP status code, this time must be 200.
3751                 '(HTTP/1.[01] 200 )~', '$1', $input);
3752     }
3755 /**
3756  * This class is used by cURL class, use case:
3757  *
3758  * <code>
3759  * $CFG->repositorycacheexpire = 120;
3760  * $CFG->curlcache = 120;
3761  *
3762  * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
3763  * $ret = $c->get('http://www.google.com');
3764  * </code>
3765  *
3766  * @package   core_files
3767  * @copyright Dongsheng Cai <dongsheng@moodle.com>
3768  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3769  */
3770 class curl_cache {
3771     /** @var string Path to cache directory */
3772     public $dir = '';
3774     /**
3775      * Constructor
3776      *
3777      * @global stdClass $CFG
3778      * @param string $module which module is using curl_cache
3779      */
3780     public function __construct($module = 'repository') {
3781         global $CFG;
3782         if (!empty($module)) {
3783             $this->dir = $CFG->cachedir.'/'.$module.'/';
3784         } else {
3785             $this->dir = $CFG->cachedir.'/misc/';
3786         }
3787         if (!file_exists($this->dir)) {
3788             mkdir($this->dir, $CFG->directorypermissions, true);
3789         }
3790         if ($module == 'repository') {
3791             if (empty($CFG->repositorycacheexpire)) {
3792                 $CFG->repositorycacheexpire = 120;
3793             }
3794             $this->ttl = $CFG->repositorycacheexpire;
3795         } else {
3796             if (empty($CFG->curlcache)) {
3797                 $CFG->curlcache = 120;
3798             }
3799             $this->ttl = $CFG->curlcache;
3800         }
3801     }
3803     /**
3804      * Get cached value
3805      *
3806      * @global stdClass $CFG
3807      * @global stdClass $USER
3808      * @param mixed $param
3809      * @return bool|string
3810      */
3811     public function get($param) {
3812         global $CFG, $USER;
3813         $this->cleanup($this->ttl);
3814         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3815         if(file_exists($this->dir.$filename)) {
3816             $lasttime = filemtime($this->dir.$filename);
3817             if (time()-$lasttime > $this->ttl) {
3818                 return false;
3819             } else {
3820                 $fp = fopen($this->dir.$filename, 'r');
3821                 $size = filesize($this->dir.$filename);
3822                 $content = fread($fp, $size);
3823                 return unserialize($content);
3824             }
3825         }
3826         return false;
3827     }
3829     /**
3830      * Set cache value
3831      *
3832      * @global object $CFG
3833      * @global object $USER
3834      * @param mixed $param
3835      * @param mixed $val
3836      */
3837     public function set($param, $val) {
3838         global $CFG, $USER;
3839         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3840         $fp = fopen($this->dir.$filename, 'w');
3841         fwrite($fp, serialize($val));
3842         fclose($fp);
3843         @chmod($this->dir.$filename, $CFG->filepermissions);
3844     }
3846     /**
3847      * Remove cache files
3848      *
3849      * @param int $expire The number of seconds before expiry
3850      */
3851     public function cleanup($expire) {
3852         if ($dir = opendir($this->dir)) {
3853             while (false !== ($file = readdir($dir))) {
3854                 if(!is_dir($file) && $file != '.' && $file != '..') {
3855                     $lasttime = @filemtime($this->dir.$file);
3856                     if (time() - $lasttime > $expire) {
3857                         @unlink($this->dir.$file);
3858                     }
3859                 }
3860             }
3861             closedir($dir);
3862         }
3863     }
3864     /**
3865      * delete current user's cache file
3866      *
3867      * @global object $CFG
3868      * @global object $USER
3869      */
3870     public function refresh() {
3871         global $CFG, $USER;
3872         if ($dir = opendir($this->dir)) {
3873             while (false !== ($file = readdir($dir))) {
3874                 if (!is_dir($file) && $file != '.' && $file != '..') {
3875                     if (strpos($file, 'u'.$USER->id.'_') !== false) {
3876                         @unlink($this->dir.$file);
3877                     }
3878                 }
3879             }
3880         }
3881     }
3884 /**
3885  * This function delegates file serving to individual plugins
3886  *
3887  * @param string $relativepath
3888  * @param bool $forcedownload
3889  * @param null|string $preview the preview mode, defaults to serving the original file
3890  * @param boolean $offline If offline is requested - don't serve a redirect to an external file, return a file suitable for viewing
3891  *                         offline (e.g. mobile app).
3892  * @todo MDL-31088 file serving improments
3893  */
3894 function file_pluginfile($relativepath, $forcedownload, $preview = null, $offline = false) {
3895     global $DB, $CFG, $USER;
3896     // relative path must start with '/'
3897     if (!$relativepath) {
3898         print_error('invalidargorconf');
3899     } else if ($relativepath[0] != '/') {
3900         print_error('pathdoesnotstartslash');
3901     }
3903     // extract relative path components
3904     $args = explode('/', ltrim($relativepath, '/'));
3906     if (count($args) < 3) { // always at least context, component and filearea
3907         print_error('invalidarguments');
3908     }
3910     $contextid = (int)array_shift($args);
3911     $component = clean_param(array_shift($args), PARAM_COMPONENT);
3912     $filearea  = clean_param(array_shift($args), PARAM_AREA);
3914     list($context, $course, $cm) = get_context_info_array($contextid);
3916     $fs = get_file_storage();
3918     $sendfileoptions = ['preview' => $preview, 'offline' => $offline];
3920     // ========================================================================================================================
3921     if ($component === 'blog') {
3922         // Blog file serving
3923         if ($context->contextlevel != CONTEXT_SYSTEM) {
3924             send_file_not_found();
3925         }
3926         if ($filearea !== 'attachment' and $filearea !== 'post') {
3927             send_file_not_found();
3928         }
3930         if (empty($CFG->enableblogs)) {
3931             print_error('siteblogdisable', 'blog');
3932         }
3934         $entryid = (int)array_shift($args);
3935         if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3936             send_file_not_found();
3937         }
3938         if ($CFG->bloglevel < BLOG_GLOBAL_LEVEL) {
3939             require_login();
3940             if (isguestuser()) {
3941                 print_error('noguest');
3942             }
3943             if ($CFG->bloglevel == BLOG_USER_LEVEL) {
3944                 if ($USER->id != $entry->userid) {
3945                     send_file_not_found();
3946                 }
3947             }
3948         }
3950         if ($entry->publishstate === 'public') {
3951             if ($CFG->forcelogin) {
3952                 require_login();
3953             }
3955         } else if ($entry->publishstate === 'site') {
3956             require_login();
3957             //ok
3958         } else if ($entry->publishstate === 'draft') {
3959             require_login();
3960             if ($USER->id != $entry->userid) {
3961                 send_file_not_found();
3962             }
3963         }
3965         $filename = array_pop($args);
3966         $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3968         if (!$file = $fs->get_file($context->id, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3969             send_file_not_found();
3970         }
3972         send_stored_file($file, 10*60, 0, true, $sendfileoptions); // download MUST be forced - security!
3974     // ========================================================================================================================
3975     } else if ($component === 'grade') {
3976         if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel == CONTEXT_SYSTEM) {
3977             // Global gradebook files
3978             if ($CFG->forcelogin) {
3979                 require_login();
3980             }
3982             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3984             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3985                 send_file_not_found();
3986             }
3988             \core\session\manager::write_close(); // Unlock session during file serving.
3989             send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
3991         } else if ($filearea === 'feedback' and $context->contextlevel == CONTEXT_COURSE) {
3992             //TODO: nobody implemented this yet in grade edit form!!
3993             send_file_not_found();
3995             if ($CFG->forcelogin || $course->id != SITEID) {
3996                 require_login($course);
3997             }
3999             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
4001             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4002                 send_file_not_found();
4003             }
4005             \core\session\manager::write_close(); // Unlock session during file serving.
4006             send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4007         } else {
4008             send_file_not_found();
4009         }
4011     // ========================================================================================================================
4012     } else if ($component === 'tag') {
4013         if ($filearea === 'description' and $context->contextlevel == CONTEXT_SYSTEM) {
4015             // All tag descriptions are going to be public but we still need to respect forcelogin
4016             if ($CFG->forcelogin) {
4017                 require_login();
4018             }
4020             $fullpath = "/$context->id/tag/description/".implode('/', $args);
4022             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4023                 send_file_not_found();
4024             }
4026             \core\session\manager::write_close(); // Unlock session during file serving.
4027             send_stored_file($file, 60*60, 0, true, $sendfileoptions);
4029         } else {
4030             send_file_not_found();
4031         }
4032     // ========================================================================================================================
4033     } else if ($component === 'badges') {
4034         require_once($CFG->libdir . '/badgeslib.php');
4036         $badgeid = (int)array_shift($args);
4037         $badge = new badge($badgeid);
4038         $filename = array_pop($args);
4040         if ($filearea === 'badgeimage') {
4041             if ($filename !== 'f1' && $filename !== 'f2') {
4042                 send_file_not_found();
4043             }
4044             if (!$file = $fs->get_file($context->id, 'badges', 'badgeimage', $badge->id, '/', $filename.'.png')) {
4045                 send_file_not_found();
4046             }
4048             \core\session\manager::write_close();
4049             send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4050         } else if ($filearea === 'userbadge'  and $context->contextlevel == CONTEXT_USER) {
4051             if (!$file = $fs->get_file($context->id, 'badges', 'userbadge', $badge->id, '/', $filename.'.png')) {
4052                 send_file_not_found();
4053             }
4055             \core\session\manager::write_close();
4056             send_stored_file($file, 60*60, 0, true, $sendfileoptions);
4057         }
4058     // ========================================================================================================================
4059     } else if ($component === 'calendar') {
4060         if ($filearea === 'event_description'  and $context->contextlevel == CONTEXT_SYSTEM) {
4062             // All events here are public the one requirement is that we respect forcelogin
4063             if ($CFG->forcelogin) {
4064                 require_login();
4065             }
4067             // Get the event if from the args array
4068             $eventid = array_shift($args);
4070             // Load the event from the database
4071             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
4072                 send_file_not_found();
4073             }
4075             // Get the file and serve if successful
4076             $filename = array_pop($args);
4077             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4078             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4079                 send_file_not_found();
4080             }
4082             \core\session\manager::write_close(); // Unlock session during file serving.
4083             send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4085         } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_USER) {
4087             // Must be logged in, if they are not then they obviously can't be this user
4088             require_login();
4090             // Don't want guests here, potentially saves a DB call
4091             if (isguestuser()) {
4092                 send_file_not_found();
4093             }
4095             // Get the event if from the args array
4096             $eventid = array_shift($args);
4098             // Load the event from the database - user id must match
4099             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id, 'eventtype'=>'user'))) {
4100                 send_file_not_found();
4101             }
4103             // Get the file and serve if successful
4104             $filename = array_pop($args);
4105             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4106             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4107                 send_file_not_found();
4108             }
4110             \core\session\manager::write_close(); // Unlock session during file serving.
4111             send_stored_file($file, 0, 0, true, $sendfileoptions);
4113         } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_COURSE) {
4115             // Respect forcelogin and require login unless this is the site.... it probably
4116             // should NEVER be the site
4117             if ($CFG->forcelogin || $course->id != SITEID) {
4118                 require_login($course);
4119             }
4121             // Must be able to at least view the course. This does not apply to the front page.
4122             if ($course->id != SITEID && (!is_enrolled($context)) && (!is_viewing($context))) {
4123                 //TODO: hmm, do we really want to block guests here?
4124                 send_file_not_found();
4125             }
4127             // Get the event id
4128             $eventid = array_shift($args);
4130             // Load the event from the database we need to check whether it is
4131             // a) valid course event
4132             // b) a group event
4133             // Group events use the course context (there is no group context)
4134             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id))) {
4135                 send_file_not_found();
4136             }
4138             // If its a group event require either membership of view all groups capability
4139             if ($event->eventtype === 'group') {
4140                 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid, $USER->id)) {
4141                     send_file_not_found();
4142                 }
4143             } else if ($event->eventtype === 'course' || $event->eventtype === 'site') {
4144                 // Ok. Please note that the event type 'site' still uses a course context.
4145             } else {
4146                 // Some other type.
4147                 send_file_not_found();
4148             }
4150             // If we get this far we can serve the file
4151             $filename = array_pop($args);
4152             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4153             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4154                 send_file_not_found();
4155             }
4157             \core\session\manager::write_close(); // Unlock session during file serving.
4158             send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4160         } else {
4161             send_file_not_found();
4162         }
4164     // ========================================================================================================================
4165     } else if ($component === 'user') {
4166         if ($filearea === 'icon' and $context->contextlevel == CONTEXT_USER) {
4167             if (count($args) == 1) {
4168                 $themename = theme_config::DEFAULT_THEME;
4169                 $filename = array_shift($args);
4170             } else {
4171                 $themename = array_shift($args);
4172                 $filename = array_shift($args);
4173             }
4175             // fix file name automatically
4176             if ($filename !== 'f1' and $filename !== 'f2' and $filename !== 'f3') {
4177                 $filename = 'f1';
4178             }
4180             if ((!empty($CFG->forcelogin) and !isloggedin()) ||
4181                     (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))) {
4182                 // protect images if login required and not logged in;
4183                 // also if login is required for profile images and is not logged in or guest
4184                 // do not use require_login() because it is expensive and not suitable here anyway
4185                 $theme = theme_config::load($themename);
4186                 redirect($theme->image_url('u/'.$filename, 'moodle')); // intentionally not cached
4187             }
4189             if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'.png')) {
4190                 if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'.jpg')) {
4191                     if ($filename === 'f3') {
4192                         // f3 512x512px was introduced in 2.3, there might be only the smaller version.
4193                         if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', 'f1.png')) {
4194                 &nbs