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