MDL-58712 core_user: Do not count the root directory
[moodle.git] / lib / filelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Functions for file handling.
19  *
20  * @package   core_files
21  * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * BYTESERVING_BOUNDARY - string unique string constant.
29  */
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
32 /**
33  * Unlimited area size constant
34  */
35 define('FILE_AREA_MAX_BYTES_UNLIMITED', -1);
37 require_once("$CFG->libdir/filestorage/file_exceptions.php");
38 require_once("$CFG->libdir/filestorage/file_storage.php");
39 require_once("$CFG->libdir/filestorage/zip_packer.php");
40 require_once("$CFG->libdir/filebrowser/file_browser.php");
42 /**
43  * Encodes file serving url
44  *
45  * @deprecated use moodle_url factory methods instead
46  *
47  * @todo MDL-31071 deprecate this function
48  * @global stdClass $CFG
49  * @param string $urlbase
50  * @param string $path /filearea/itemid/dir/dir/file.exe
51  * @param bool $forcedownload
52  * @param bool $https https url required
53  * @return string encoded file url
54  */
55 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
56     global $CFG;
58 //TODO: deprecate this
60     if ($CFG->slasharguments) {
61         $parts = explode('/', $path);
62         $parts = array_map('rawurlencode', $parts);
63         $path  = implode('/', $parts);
64         $return = $urlbase.$path;
65         if ($forcedownload) {
66             $return .= '?forcedownload=1';
67         }
68     } else {
69         $path = rawurlencode($path);
70         $return = $urlbase.'?file='.$path;
71         if ($forcedownload) {
72             $return .= '&amp;forcedownload=1';
73         }
74     }
76     if ($https) {
77         $return = str_replace('http://', 'https://', $return);
78     }
80     return $return;
81 }
83 /**
84  * Detects if area contains subdirs,
85  * this is intended for file areas that are attached to content
86  * migrated from 1.x where subdirs were allowed everywhere.
87  *
88  * @param context $context
89  * @param string $component
90  * @param string $filearea
91  * @param string $itemid
92  * @return bool
93  */
94 function file_area_contains_subdirs(context $context, $component, $filearea, $itemid) {
95     global $DB;
97     if (!isset($itemid)) {
98         // Not initialised yet.
99         return false;
100     }
102     // Detect if any directories are already present, this is necessary for content upgraded from 1.x.
103     $select = "contextid = :contextid AND component = :component AND filearea = :filearea AND itemid = :itemid AND filepath <> '/' AND filename = '.'";
104     $params = array('contextid'=>$context->id, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
105     return $DB->record_exists_select('files', $select, $params);
108 /**
109  * Prepares 'editor' formslib element from data in database
110  *
111  * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
112  * function then copies the embedded files into draft area (assigning itemids automatically),
113  * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
114  * displayed.
115  * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
116  * your mform's set_data() supplying the object returned by this function.
117  *
118  * @category files
119  * @param stdClass $data database field that holds the html text with embedded media
120  * @param string $field the name of the database field that holds the html text with embedded media
121  * @param array $options editor options (like maxifiles, maxbytes etc.)
122  * @param stdClass $context context of the editor
123  * @param string $component
124  * @param string $filearea file area name
125  * @param int $itemid item id, required if item exists
126  * @return stdClass modified data object
127  */
128 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
129     $options = (array)$options;
130     if (!isset($options['trusttext'])) {
131         $options['trusttext'] = false;
132     }
133     if (!isset($options['forcehttps'])) {
134         $options['forcehttps'] = false;
135     }
136     if (!isset($options['subdirs'])) {
137         $options['subdirs'] = false;
138     }
139     if (!isset($options['maxfiles'])) {
140         $options['maxfiles'] = 0; // no files by default
141     }
142     if (!isset($options['noclean'])) {
143         $options['noclean'] = false;
144     }
146     //sanity check for passed context. This function doesn't expect $option['context'] to be set
147     //But this function is called before creating editor hence, this is one of the best places to check
148     //if context is used properly. This check notify developer that they missed passing context to editor.
149     if (isset($context) && !isset($options['context'])) {
150         //if $context is not null then make sure $option['context'] is also set.
151         debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER);
152     } else if (isset($options['context']) && isset($context)) {
153         //If both are passed then they should be equal.
154         if ($options['context']->id != $context->id) {
155             $exceptionmsg = 'Editor context ['.$options['context']->id.'] is not equal to passed context ['.$context->id.']';
156             throw new coding_exception($exceptionmsg);
157         }
158     }
160     if (is_null($itemid) or is_null($context)) {
161         $contextid = null;
162         $itemid = null;
163         if (!isset($data)) {
164             $data = new stdClass();
165         }
166         if (!isset($data->{$field})) {
167             $data->{$field} = '';
168         }
169         if (!isset($data->{$field.'format'})) {
170             $data->{$field.'format'} = editors_get_preferred_format();
171         }
172         if (!$options['noclean']) {
173             $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
174         }
176     } else {
177         if ($options['trusttext']) {
178             // noclean ignored if trusttext enabled
179             if (!isset($data->{$field.'trust'})) {
180                 $data->{$field.'trust'} = 0;
181             }
182             $data = trusttext_pre_edit($data, $field, $context);
183         } else {
184             if (!$options['noclean']) {
185                 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
186             }
187         }
188         $contextid = $context->id;
189     }
191     if ($options['maxfiles'] != 0) {
192         $draftid_editor = file_get_submitted_draft_itemid($field);
193         $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
194         $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
195     } else {
196         $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
197     }
199     return $data;
202 /**
203  * Prepares the content of the 'editor' form element with embedded media files to be saved in database
204  *
205  * This function moves files from draft area to the destination area and
206  * encodes URLs to the draft files so they can be safely saved into DB. The
207  * form has to contain the 'editor' element named foobar_editor, where 'foobar'
208  * is the name of the database field to hold the wysiwyg editor content. The
209  * editor data comes as an array with text, format and itemid properties. This
210  * function automatically adds $data properties foobar, foobarformat and
211  * foobartrust, where foobar has URL to embedded files encoded.
212  *
213  * @category files
214  * @param stdClass $data raw data submitted by the form
215  * @param string $field name of the database field containing the html with embedded media files
216  * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
217  * @param stdClass $context context, required for existing data
218  * @param string $component file component
219  * @param string $filearea file area name
220  * @param int $itemid item id, required if item exists
221  * @return stdClass modified data object
222  */
223 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
224     $options = (array)$options;
225     if (!isset($options['trusttext'])) {
226         $options['trusttext'] = false;
227     }
228     if (!isset($options['forcehttps'])) {
229         $options['forcehttps'] = false;
230     }
231     if (!isset($options['subdirs'])) {
232         $options['subdirs'] = false;
233     }
234     if (!isset($options['maxfiles'])) {
235         $options['maxfiles'] = 0; // no files by default
236     }
237     if (!isset($options['maxbytes'])) {
238         $options['maxbytes'] = 0; // unlimited
239     }
241     if ($options['trusttext']) {
242         $data->{$field.'trust'} = trusttext_trusted($context);
243     } else {
244         $data->{$field.'trust'} = 0;
245     }
247     $editor = $data->{$field.'_editor'};
249     if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
250         $data->{$field} = $editor['text'];
251     } else {
252         $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
253     }
254     $data->{$field.'format'} = $editor['format'];
256     return $data;
259 /**
260  * Saves text and files modified by Editor formslib element
261  *
262  * @category files
263  * @param stdClass $data $database entry field
264  * @param string $field name of data field
265  * @param array $options various options
266  * @param stdClass $context context - must already exist
267  * @param string $component
268  * @param string $filearea file area name
269  * @param int $itemid must already exist, usually means data is in db
270  * @return stdClass modified data obejct
271  */
272 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
273     $options = (array)$options;
274     if (!isset($options['subdirs'])) {
275         $options['subdirs'] = false;
276     }
277     if (is_null($itemid) or is_null($context)) {
278         $itemid = null;
279         $contextid = null;
280     } else {
281         $contextid = $context->id;
282     }
284     $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
285     file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
286     $data->{$field.'_filemanager'} = $draftid_editor;
288     return $data;
291 /**
292  * Saves files modified by File manager formslib element
293  *
294  * @todo MDL-31073 review this function
295  * @category files
296  * @param stdClass $data $database entry field
297  * @param string $field name of data field
298  * @param array $options various options
299  * @param stdClass $context context - must already exist
300  * @param string $component
301  * @param string $filearea file area name
302  * @param int $itemid must already exist, usually means data is in db
303  * @return stdClass modified data obejct
304  */
305 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
306     $options = (array)$options;
307     if (!isset($options['subdirs'])) {
308         $options['subdirs'] = false;
309     }
310     if (!isset($options['maxfiles'])) {
311         $options['maxfiles'] = -1; // unlimited
312     }
313     if (!isset($options['maxbytes'])) {
314         $options['maxbytes'] = 0; // unlimited
315     }
317     if (empty($data->{$field.'_filemanager'})) {
318         $data->$field = '';
320     } else {
321         file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id, $component, $filearea, $itemid, $options);
322         $fs = get_file_storage();
324         if ($fs->get_area_files($context->id, $component, $filearea, $itemid)) {
325             $data->$field = '1'; // TODO: this is an ugly hack (skodak)
326         } else {
327             $data->$field = '';
328         }
329     }
331     return $data;
334 /**
335  * Generate a draft itemid
336  *
337  * @category files
338  * @global moodle_database $DB
339  * @global stdClass $USER
340  * @return int a random but available draft itemid that can be used to create a new draft
341  * file area.
342  */
343 function file_get_unused_draft_itemid() {
344     global $DB, $USER;
346     if (isguestuser() or !isloggedin()) {
347         // guests and not-logged-in users can not be allowed to upload anything!!!!!!
348         print_error('noguest');
349     }
351     $contextid = context_user::instance($USER->id)->id;
353     $fs = get_file_storage();
354     $draftitemid = rand(1, 999999999);
355     while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
356         $draftitemid = rand(1, 999999999);
357     }
359     return $draftitemid;
362 /**
363  * Initialise a draft file area from a real one by copying the files. A draft
364  * area will be created if one does not already exist. Normally you should
365  * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
366  *
367  * @category files
368  * @global stdClass $CFG
369  * @global stdClass $USER
370  * @param int $draftitemid the id of the draft area to use, or 0 to create a new one, in which case this parameter is updated.
371  * @param int $contextid This parameter and the next two identify the file area to copy files from.
372  * @param string $component
373  * @param string $filearea helps indentify the file area.
374  * @param int $itemid helps identify the file area. Can be null if there are no files yet.
375  * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
376  * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
377  * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
378  */
379 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
380     global $CFG, $USER, $CFG;
382     $options = (array)$options;
383     if (!isset($options['subdirs'])) {
384         $options['subdirs'] = false;
385     }
386     if (!isset($options['forcehttps'])) {
387         $options['forcehttps'] = false;
388     }
390     $usercontext = context_user::instance($USER->id);
391     $fs = get_file_storage();
393     if (empty($draftitemid)) {
394         // create a new area and copy existing files into
395         $draftitemid = file_get_unused_draft_itemid();
396         $file_record = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
397         if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
398             foreach ($files as $file) {
399                 if ($file->is_directory() and $file->get_filepath() === '/') {
400                     // we need a way to mark the age of each draft area,
401                     // by not copying the root dir we force it to be created automatically with current timestamp
402                     continue;
403                 }
404                 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
405                     continue;
406                 }
407                 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
408                 // XXX: This is a hack for file manager (MDL-28666)
409                 // File manager needs to know the original file information before copying
410                 // to draft area, so we append these information in mdl_files.source field
411                 // {@link file_storage::search_references()}
412                 // {@link file_storage::search_references_count()}
413                 $sourcefield = $file->get_source();
414                 $newsourcefield = new stdClass;
415                 $newsourcefield->source = $sourcefield;
416                 $original = new stdClass;
417                 $original->contextid = $contextid;
418                 $original->component = $component;
419                 $original->filearea  = $filearea;
420                 $original->itemid    = $itemid;
421                 $original->filename  = $file->get_filename();
422                 $original->filepath  = $file->get_filepath();
423                 $newsourcefield->original = file_storage::pack_reference($original);
424                 $draftfile->set_source(serialize($newsourcefield));
425                 // End of file manager hack
426             }
427         }
428         if (!is_null($text)) {
429             // at this point there should not be any draftfile links yet,
430             // because this is a new text from database that should still contain the @@pluginfile@@ links
431             // this happens when developers forget to post process the text
432             $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
433         }
434     } else {
435         // nothing to do
436     }
438     if (is_null($text)) {
439         return null;
440     }
442     // relink embedded files - editor can not handle @@PLUGINFILE@@ !
443     return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id, 'user', 'draft', $draftitemid, $options);
446 /**
447  * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
448  * Passing a new option reverse = true in the $options var will make the function to convert actual URLs in $text to encoded URLs
449  * in the @@PLUGINFILE@@ form.
450  *
451  * @category files
452  * @global stdClass $CFG
453  * @param string $text The content that may contain ULRs in need of rewriting.
454  * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
455  * @param int $contextid This parameter and the next two identify the file area to use.
456  * @param string $component
457  * @param string $filearea helps identify the file area.
458  * @param int $itemid helps identify the file area.
459  * @param array $options text and file options ('forcehttps'=>false), use reverse = true to reverse the behaviour of the function.
460  * @return string the processed text.
461  */
462 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
463     global $CFG;
465     $options = (array)$options;
466     if (!isset($options['forcehttps'])) {
467         $options['forcehttps'] = false;
468     }
470     if (!$CFG->slasharguments) {
471         $file = $file . '?file=';
472     }
474     $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
476     if ($itemid !== null) {
477         $baseurl .= "$itemid/";
478     }
480     if ($options['forcehttps']) {
481         $baseurl = str_replace('http://', 'https://', $baseurl);
482     }
484     if (!empty($options['reverse'])) {
485         return str_replace($baseurl, '@@PLUGINFILE@@/', $text);
486     } else {
487         return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
488     }
491 /**
492  * Returns information about files in a draft area.
493  *
494  * @global stdClass $CFG
495  * @global stdClass $USER
496  * @param int $draftitemid the draft area item id.
497  * @param string $filepath path to the directory from which the information have to be retrieved.
498  * @return array with the following entries:
499  *      'filecount' => number of files in the draft area.
500  *      'filesize' => total size of the files in the draft area.
501  *      'foldercount' => number of folders in the draft area.
502  *      'filesize_without_references' => total size of the area excluding file references.
503  * (more information will be added as needed).
504  */
505 function file_get_draft_area_info($draftitemid, $filepath = '/') {
506     global $USER;
508     $usercontext = context_user::instance($USER->id);
509     return file_get_file_area_info($usercontext->id, 'user', 'draft', $draftitemid, $filepath);
512 /**
513  * Returns information about files in an area.
514  *
515  * @param int $contextid context id
516  * @param string $component component
517  * @param string $filearea file area name
518  * @param int $itemid item id or all files if not specified
519  * @param string $filepath path to the directory from which the information have to be retrieved.
520  * @return array with the following entries:
521  *      'filecount' => number of files in the area.
522  *      'filesize' => total size of the files in the area.
523  *      'foldercount' => number of folders in the area.
524  *      'filesize_without_references' => total size of the area excluding file references.
525  * @since Moodle 3.4
526  */
527 function file_get_file_area_info($contextid, $component, $filearea, $itemid = 0, $filepath = '/') {
529     $fs = get_file_storage();
531     $results = array(
532         'filecount' => 0,
533         'foldercount' => 0,
534         'filesize' => 0,
535         'filesize_without_references' => 0
536     );
538     $draftfiles = $fs->get_directory_files($contextid, $component, $filearea, $itemid, $filepath, true, true);
540     foreach ($draftfiles as $file) {
541         if ($file->is_directory()) {
542             $results['foldercount'] += 1;
543         } else {
544             $results['filecount'] += 1;
545         }
547         $filesize = $file->get_filesize();
548         $results['filesize'] += $filesize;
549         if (!$file->is_external_file()) {
550             $results['filesize_without_references'] += $filesize;
551         }
552     }
554     return $results;
557 /**
558  * Returns whether a draft area has exceeded/will exceed its size limit.
559  *
560  * Please note that the unlimited value for $areamaxbytes is -1 {@link FILE_AREA_MAX_BYTES_UNLIMITED}, not 0.
561  *
562  * @param int $draftitemid the draft area item id.
563  * @param int $areamaxbytes the maximum size allowed in this draft area.
564  * @param int $newfilesize the size that would be added to the current area.
565  * @param bool $includereferences true to include the size of the references in the area size.
566  * @return bool true if the area will/has exceeded its limit.
567  * @since Moodle 2.4
568  */
569 function file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $newfilesize = 0, $includereferences = false) {
570     if ($areamaxbytes != FILE_AREA_MAX_BYTES_UNLIMITED) {
571         $draftinfo = file_get_draft_area_info($draftitemid);
572         $areasize = $draftinfo['filesize_without_references'];
573         if ($includereferences) {
574             $areasize = $draftinfo['filesize'];
575         }
576         if ($areasize + $newfilesize > $areamaxbytes) {
577             return true;
578         }
579     }
580     return false;
583 /**
584  * Get used space of files
585  * @global moodle_database $DB
586  * @global stdClass $USER
587  * @return int total bytes
588  */
589 function file_get_user_used_space() {
590     global $DB, $USER;
592     $usercontext = context_user::instance($USER->id);
593     $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
594             JOIN (SELECT contenthash, filename, MAX(id) AS id
595             FROM {files}
596             WHERE contextid = ? AND component = ? AND filearea != ?
597             GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
598     $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
599     $record = $DB->get_record_sql($sql, $params);
600     return (int)$record->totalbytes;
603 /**
604  * Convert any string to a valid filepath
605  * @todo review this function
606  * @param string $str
607  * @return string path
608  */
609 function file_correct_filepath($str) { //TODO: what is this? (skodak) - No idea (Fred)
610     if ($str == '/' or empty($str)) {
611         return '/';
612     } else {
613         return '/'.trim($str, '/').'/';
614     }
617 /**
618  * Generate a folder tree of draft area of current USER recursively
619  *
620  * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
621  * @param int $draftitemid
622  * @param string $filepath
623  * @param mixed $data
624  */
625 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
626     global $USER, $OUTPUT, $CFG;
627     $data->children = array();
628     $context = context_user::instance($USER->id);
629     $fs = get_file_storage();
630     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
631         foreach ($files as $file) {
632             if ($file->is_directory()) {
633                 $item = new stdClass();
634                 $item->sortorder = $file->get_sortorder();
635                 $item->filepath = $file->get_filepath();
637                 $foldername = explode('/', trim($item->filepath, '/'));
638                 $item->fullname = trim(array_pop($foldername), '/');
640                 $item->id = uniqid();
641                 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
642                 $data->children[] = $item;
643             } else {
644                 continue;
645             }
646         }
647     }
650 /**
651  * Listing all files (including folders) in current path (draft area)
652  * used by file manager
653  * @param int $draftitemid
654  * @param string $filepath
655  * @return stdClass
656  */
657 function file_get_drafarea_files($draftitemid, $filepath = '/') {
658     global $USER, $OUTPUT, $CFG;
660     $context = context_user::instance($USER->id);
661     $fs = get_file_storage();
663     $data = new stdClass();
664     $data->path = array();
665     $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
667     // will be used to build breadcrumb
668     $trail = '/';
669     if ($filepath !== '/') {
670         $filepath = file_correct_filepath($filepath);
671         $parts = explode('/', $filepath);
672         foreach ($parts as $part) {
673             if ($part != '' && $part != null) {
674                 $trail .= ($part.'/');
675                 $data->path[] = array('name'=>$part, 'path'=>$trail);
676             }
677         }
678     }
680     $list = array();
681     $maxlength = 12;
682     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
683         foreach ($files as $file) {
684             $item = new stdClass();
685             $item->filename = $file->get_filename();
686             $item->filepath = $file->get_filepath();
687             $item->fullname = trim($item->filename, '/');
688             $filesize = $file->get_filesize();
689             $item->size = $filesize ? $filesize : null;
690             $item->filesize = $filesize ? display_size($filesize) : '';
692             $item->sortorder = $file->get_sortorder();
693             $item->author = $file->get_author();
694             $item->license = $file->get_license();
695             $item->datemodified = $file->get_timemodified();
696             $item->datecreated = $file->get_timecreated();
697             $item->isref = $file->is_external_file();
698             if ($item->isref && $file->get_status() == 666) {
699                 $item->originalmissing = true;
700             }
701             // find the file this draft file was created from and count all references in local
702             // system pointing to that file
703             $source = @unserialize($file->get_source());
704             if (isset($source->original)) {
705                 $item->refcount = $fs->search_references_count($source->original);
706             }
708             if ($file->is_directory()) {
709                 $item->filesize = 0;
710                 $item->icon = $OUTPUT->image_url(file_folder_icon(24))->out(false);
711                 $item->type = 'folder';
712                 $foldername = explode('/', trim($item->filepath, '/'));
713                 $item->fullname = trim(array_pop($foldername), '/');
714                 $item->thumbnail = $OUTPUT->image_url(file_folder_icon(90))->out(false);
715             } else {
716                 // do NOT use file browser here!
717                 $item->mimetype = get_mimetype_description($file);
718                 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
719                     $item->type = 'zip';
720                 } else {
721                     $item->type = 'file';
722                 }
723                 $itemurl = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename);
724                 $item->url = $itemurl->out();
725                 $item->icon = $OUTPUT->image_url(file_file_icon($file, 24))->out(false);
726                 $item->thumbnail = $OUTPUT->image_url(file_file_icon($file, 90))->out(false);
727                 if ($imageinfo = $file->get_imageinfo()) {
728                     $item->realthumbnail = $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
729                     $item->realicon = $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
730                     $item->image_width = $imageinfo['width'];
731                     $item->image_height = $imageinfo['height'];
732                 }
733             }
734             $list[] = $item;
735         }
736     }
737     $data->itemid = $draftitemid;
738     $data->list = $list;
739     return $data;
742 /**
743  * Returns draft area itemid for a given element.
744  *
745  * @category files
746  * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
747  * @return int the itemid, or 0 if there is not one yet.
748  */
749 function file_get_submitted_draft_itemid($elname) {
750     // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
751     if (!isset($_REQUEST[$elname])) {
752         return 0;
753     }
754     if (is_array($_REQUEST[$elname])) {
755         $param = optional_param_array($elname, 0, PARAM_INT);
756         if (!empty($param['itemid'])) {
757             $param = $param['itemid'];
758         } else {
759             debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
760             return false;
761         }
763     } else {
764         $param = optional_param($elname, 0, PARAM_INT);
765     }
767     if ($param) {
768         require_sesskey();
769     }
771     return $param;
774 /**
775  * Restore the original source field from draft files
776  *
777  * Do not use this function because it makes field files.source inconsistent
778  * for draft area files. This function will be deprecated in 2.6
779  *
780  * @param stored_file $storedfile This only works with draft files
781  * @return stored_file
782  */
783 function file_restore_source_field_from_draft_file($storedfile) {
784     $source = @unserialize($storedfile->get_source());
785     if (!empty($source)) {
786         if (is_object($source)) {
787             $restoredsource = $source->source;
788             $storedfile->set_source($restoredsource);
789         } else {
790             throw new moodle_exception('invalidsourcefield', 'error');
791         }
792     }
793     return $storedfile;
795 /**
796  * Saves files from a draft file area to a real one (merging the list of files).
797  * Can rewrite URLs in some content at the same time if desired.
798  *
799  * @category files
800  * @global stdClass $USER
801  * @param int $draftitemid the id of the draft area to use. Normally obtained
802  *      from file_get_submitted_draft_itemid('elementname') or similar.
803  * @param int $contextid This parameter and the next two identify the file area to save to.
804  * @param string $component
805  * @param string $filearea indentifies the file area.
806  * @param int $itemid helps identifies the file area.
807  * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
808  * @param string $text some html content that needs to have embedded links rewritten
809  *      to the @@PLUGINFILE@@ form for saving in the database.
810  * @param bool $forcehttps force https urls.
811  * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
812  */
813 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
814     global $USER;
816     $usercontext = context_user::instance($USER->id);
817     $fs = get_file_storage();
819     $options = (array)$options;
820     if (!isset($options['subdirs'])) {
821         $options['subdirs'] = false;
822     }
823     if (!isset($options['maxfiles'])) {
824         $options['maxfiles'] = -1; // unlimited
825     }
826     if (!isset($options['maxbytes']) || $options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS) {
827         $options['maxbytes'] = 0; // unlimited
828     }
829     if (!isset($options['areamaxbytes'])) {
830         $options['areamaxbytes'] = FILE_AREA_MAX_BYTES_UNLIMITED; // Unlimited.
831     }
832     $allowreferences = true;
833     if (isset($options['return_types']) && !($options['return_types'] & (FILE_REFERENCE | FILE_CONTROLLED_LINK))) {
834         // we assume that if $options['return_types'] is NOT specified, we DO allow references.
835         // this is not exactly right. BUT there are many places in code where filemanager options
836         // are not passed to file_save_draft_area_files()
837         $allowreferences = false;
838     }
840     // Check if the draft area has exceeded the authorised limit. This should never happen as validation
841     // should have taken place before, unless the user is doing something nauthly. If so, let's just not save
842     // anything at all in the next area.
843     if (file_is_draft_area_limit_reached($draftitemid, $options['areamaxbytes'])) {
844         return null;
845     }
847     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
848     $oldfiles   = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
850     // One file in filearea means it is empty (it has only top-level directory '.').
851     if (count($draftfiles) > 1 || count($oldfiles) > 1) {
852         // we have to merge old and new files - we want to keep file ids for files that were not changed
853         // we change time modified for all new and changed files, we keep time created as is
855         $newhashes = array();
856         $filecount = 0;
857         foreach ($draftfiles as $file) {
858             if (!$options['subdirs'] && $file->get_filepath() !== '/') {
859                 continue;
860             }
861             if (!$allowreferences && $file->is_external_file()) {
862                 continue;
863             }
864             if (!$file->is_directory()) {
865                 if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
866                     // oversized file - should not get here at all
867                     continue;
868                 }
869                 if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
870                     // more files - should not get here at all
871                     continue;
872                 }
873                 $filecount++;
874             }
875             $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
876             $newhashes[$newhash] = $file;
877         }
879         // Loop through oldfiles and decide which we need to delete and which to update.
880         // After this cycle the array $newhashes will only contain the files that need to be added.
881         foreach ($oldfiles as $oldfile) {
882             $oldhash = $oldfile->get_pathnamehash();
883             if (!isset($newhashes[$oldhash])) {
884                 // delete files not needed any more - deleted by user
885                 $oldfile->delete();
886                 continue;
887             }
889             $newfile = $newhashes[$oldhash];
890             // Now we know that we have $oldfile and $newfile for the same path.
891             // Let's check if we can update this file or we need to delete and create.
892             if ($newfile->is_directory()) {
893                 // Directories are always ok to just update.
894             } else if (($source = @unserialize($newfile->get_source())) && isset($source->original)) {
895                 // File has the 'original' - we need to update the file (it may even have not been changed at all).
896                 $original = file_storage::unpack_reference($source->original);
897                 if ($original['filename'] !== $oldfile->get_filename() || $original['filepath'] !== $oldfile->get_filepath()) {
898                     // Very odd, original points to another file. Delete and create file.
899                     $oldfile->delete();
900                     continue;
901                 }
902             } else {
903                 // The same file name but absence of 'original' means that file was deteled and uploaded again.
904                 // By deleting and creating new file we properly manage all existing references.
905                 $oldfile->delete();
906                 continue;
907             }
909             // status changed, we delete old file, and create a new one
910             if ($oldfile->get_status() != $newfile->get_status()) {
911                 // file was changed, use updated with new timemodified data
912                 $oldfile->delete();
913                 // This file will be added later
914                 continue;
915             }
917             // Updated author
918             if ($oldfile->get_author() != $newfile->get_author()) {
919                 $oldfile->set_author($newfile->get_author());
920             }
921             // Updated license
922             if ($oldfile->get_license() != $newfile->get_license()) {
923                 $oldfile->set_license($newfile->get_license());
924             }
926             // Updated file source
927             // Field files.source for draftarea files contains serialised object with source and original information.
928             // We only store the source part of it for non-draft file area.
929             $newsource = $newfile->get_source();
930             if ($source = @unserialize($newfile->get_source())) {
931                 $newsource = $source->source;
932             }
933             if ($oldfile->get_source() !== $newsource) {
934                 $oldfile->set_source($newsource);
935             }
937             // Updated sort order
938             if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
939                 $oldfile->set_sortorder($newfile->get_sortorder());
940             }
942             // Update file timemodified
943             if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
944                 $oldfile->set_timemodified($newfile->get_timemodified());
945             }
947             // Replaced file content
948             if (!$oldfile->is_directory() &&
949                     ($oldfile->get_contenthash() != $newfile->get_contenthash() ||
950                     $oldfile->get_filesize() != $newfile->get_filesize() ||
951                     $oldfile->get_referencefileid() != $newfile->get_referencefileid() ||
952                     $oldfile->get_userid() != $newfile->get_userid())) {
953                 $oldfile->replace_file_with($newfile);
954             }
956             // unchanged file or directory - we keep it as is
957             unset($newhashes[$oldhash]);
958         }
960         // Add fresh file or the file which has changed status
961         // the size and subdirectory tests are extra safety only, the UI should prevent it
962         foreach ($newhashes as $file) {
963             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
964             if ($source = @unserialize($file->get_source())) {
965                 // Field files.source for draftarea files contains serialised object with source and original information.
966                 // We only store the source part of it for non-draft file area.
967                 $file_record['source'] = $source->source;
968             }
970             if ($file->is_external_file()) {
971                 $repoid = $file->get_repository_id();
972                 if (!empty($repoid)) {
973                     $context = context::instance_by_id($contextid, MUST_EXIST);
974                     $repo = repository::get_repository_by_id($repoid, $context);
976                     $file_record['repositoryid'] = $repoid;
977                     // This hook gives the repo a place to do some house cleaning, and update the $reference before it's saved
978                     // to the file store. E.g. transfer ownership of the file to a system account etc.
979                     $reference = $repo->reference_file_selected($file->get_reference(), $context, $component, $filearea, $itemid);
981                     $file_record['reference'] = $reference;
982                 }
983             }
985             $fs->create_file_from_storedfile($file_record, $file);
986         }
987     }
989     // note: do not purge the draft area - we clean up areas later in cron,
990     //       the reason is that user might press submit twice and they would loose the files,
991     //       also sometimes we might want to use hacks that save files into two different areas
993     if (is_null($text)) {
994         return null;
995     } else {
996         return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
997     }
1000 /**
1001  * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
1002  * ready to be saved in the database. Normally, this is done automatically by
1003  * {@link file_save_draft_area_files()}.
1004  *
1005  * @category files
1006  * @param string $text the content to process.
1007  * @param int $draftitemid the draft file area the content was using.
1008  * @param bool $forcehttps whether the content contains https URLs. Default false.
1009  * @return string the processed content.
1010  */
1011 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
1012     global $CFG, $USER;
1014     $usercontext = context_user::instance($USER->id);
1016     $wwwroot = $CFG->wwwroot;
1017     if ($forcehttps) {
1018         $wwwroot = str_replace('http://', 'https://', $wwwroot);
1019     }
1021     // relink embedded files if text submitted - no absolute links allowed in database!
1022     $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1024     if (strpos($text, 'draftfile.php?file=') !== false) {
1025         $matches = array();
1026         preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
1027         if ($matches) {
1028             foreach ($matches[0] as $match) {
1029                 $replace = str_ireplace('%2F', '/', $match);
1030                 $text = str_replace($match, $replace, $text);
1031             }
1032         }
1033         $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1034     }
1036     return $text;
1039 /**
1040  * Set file sort order
1041  *
1042  * @global moodle_database $DB
1043  * @param int $contextid the context id
1044  * @param string $component file component
1045  * @param string $filearea file area.
1046  * @param int $itemid itemid.
1047  * @param string $filepath file path.
1048  * @param string $filename file name.
1049  * @param int $sortorder the sort order of file.
1050  * @return bool
1051  */
1052 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
1053     global $DB;
1054     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
1055     if ($file_record = $DB->get_record('files', $conditions)) {
1056         $sortorder = (int)$sortorder;
1057         $file_record->sortorder = $sortorder;
1058         $DB->update_record('files', $file_record);
1059         return true;
1060     }
1061     return false;
1064 /**
1065  * reset file sort order number to 0
1066  * @global moodle_database $DB
1067  * @param int $contextid the context id
1068  * @param string $component
1069  * @param string $filearea file area.
1070  * @param int|bool $itemid itemid.
1071  * @return bool
1072  */
1073 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
1074     global $DB;
1076     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
1077     if ($itemid !== false) {
1078         $conditions['itemid'] = $itemid;
1079     }
1081     $file_records = $DB->get_records('files', $conditions);
1082     foreach ($file_records as $file_record) {
1083         $file_record->sortorder = 0;
1084         $DB->update_record('files', $file_record);
1085     }
1086     return true;
1089 /**
1090  * Returns description of upload error
1091  *
1092  * @param int $errorcode found in $_FILES['filename.ext']['error']
1093  * @return string error description string, '' if ok
1094  */
1095 function file_get_upload_error($errorcode) {
1097     switch ($errorcode) {
1098     case 0: // UPLOAD_ERR_OK - no error
1099         $errmessage = '';
1100         break;
1102     case 1: // UPLOAD_ERR_INI_SIZE
1103         $errmessage = get_string('uploadserverlimit');
1104         break;
1106     case 2: // UPLOAD_ERR_FORM_SIZE
1107         $errmessage = get_string('uploadformlimit');
1108         break;
1110     case 3: // UPLOAD_ERR_PARTIAL
1111         $errmessage = get_string('uploadpartialfile');
1112         break;
1114     case 4: // UPLOAD_ERR_NO_FILE
1115         $errmessage = get_string('uploadnofilefound');
1116         break;
1118     // Note: there is no error with a value of 5
1120     case 6: // UPLOAD_ERR_NO_TMP_DIR
1121         $errmessage = get_string('uploadnotempdir');
1122         break;
1124     case 7: // UPLOAD_ERR_CANT_WRITE
1125         $errmessage = get_string('uploadcantwrite');
1126         break;
1128     case 8: // UPLOAD_ERR_EXTENSION
1129         $errmessage = get_string('uploadextension');
1130         break;
1132     default:
1133         $errmessage = get_string('uploadproblem');
1134     }
1136     return $errmessage;
1139 /**
1140  * Recursive function formating an array in POST parameter
1141  * @param array $arraydata - the array that we are going to format and add into &$data array
1142  * @param string $currentdata - a row of the final postdata array at instant T
1143  *                when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1144  * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1145  */
1146 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1147         foreach ($arraydata as $k=>$v) {
1148             $newcurrentdata = $currentdata;
1149             if (is_array($v)) { //the value is an array, call the function recursively
1150                 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1151                 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1152             }  else { //add the POST parameter to the $data array
1153                 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1154             }
1155         }
1158 /**
1159  * Transform a PHP array into POST parameter
1160  * (see the recursive function format_array_postdata_for_curlcall)
1161  * @param array $postdata
1162  * @return array containing all POST parameters  (1 row = 1 POST parameter)
1163  */
1164 function format_postdata_for_curlcall($postdata) {
1165         $data = array();
1166         foreach ($postdata as $k=>$v) {
1167             if (is_array($v)) {
1168                 $currentdata = urlencode($k);
1169                 format_array_postdata_for_curlcall($v, $currentdata, $data);
1170             }  else {
1171                 $data[] = urlencode($k).'='.urlencode($v);
1172             }
1173         }
1174         $convertedpostdata = implode('&', $data);
1175         return $convertedpostdata;
1178 /**
1179  * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1180  * Due to security concerns only downloads from http(s) sources are supported.
1181  *
1182  * @category files
1183  * @param string $url file url starting with http(s)://
1184  * @param array $headers http headers, null if none. If set, should be an
1185  *   associative array of header name => value pairs.
1186  * @param array $postdata array means use POST request with given parameters
1187  * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1188  *   (if false, just returns content)
1189  * @param int $timeout timeout for complete download process including all file transfer
1190  *   (default 5 minutes)
1191  * @param int $connecttimeout timeout for connection to server; this is the timeout that
1192  *   usually happens if the remote server is completely down (default 20 seconds);
1193  *   may not work when using proxy
1194  * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1195  *   Only use this when already in a trusted location.
1196  * @param string $tofile store the downloaded content to file instead of returning it.
1197  * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1198  *   filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1199  * @return stdClass|string|bool stdClass object if $fullresponse is true, false if request failed, true
1200  *   if file downloaded into $tofile successfully or the file content as a string.
1201  */
1202 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1203     global $CFG;
1205     // Only http and https links supported.
1206     if (!preg_match('|^https?://|i', $url)) {
1207         if ($fullresponse) {
1208             $response = new stdClass();
1209             $response->status        = 0;
1210             $response->headers       = array();
1211             $response->response_code = 'Invalid protocol specified in url';
1212             $response->results       = '';
1213             $response->error         = 'Invalid protocol specified in url';
1214             return $response;
1215         } else {
1216             return false;
1217         }
1218     }
1220     $options = array();
1222     $headers2 = array();
1223     if (is_array($headers)) {
1224         foreach ($headers as $key => $value) {
1225             if (is_numeric($key)) {
1226                 $headers2[] = $value;
1227             } else {
1228                 $headers2[] = "$key: $value";
1229             }
1230         }
1231     }
1233     if ($skipcertverify) {
1234         $options['CURLOPT_SSL_VERIFYPEER'] = false;
1235     } else {
1236         $options['CURLOPT_SSL_VERIFYPEER'] = true;
1237     }
1239     $options['CURLOPT_CONNECTTIMEOUT'] = $connecttimeout;
1241     $options['CURLOPT_FOLLOWLOCATION'] = 1;
1242     $options['CURLOPT_MAXREDIRS'] = 5;
1244     // Use POST if requested.
1245     if (is_array($postdata)) {
1246         $postdata = format_postdata_for_curlcall($postdata);
1247     } else if (empty($postdata)) {
1248         $postdata = null;
1249     }
1251     // Optionally attempt to get more correct timeout by fetching the file size.
1252     if (!isset($CFG->curltimeoutkbitrate)) {
1253         // Use very slow rate of 56kbps as a timeout speed when not set.
1254         $bitrate = 56;
1255     } else {
1256         $bitrate = $CFG->curltimeoutkbitrate;
1257     }
1258     if ($calctimeout and !isset($postdata)) {
1259         $curl = new curl();
1260         $curl->setHeader($headers2);
1262         $curl->head($url, $postdata, $options);
1264         $info = $curl->get_info();
1265         $error_no = $curl->get_errno();
1266         if (!$error_no && $info['download_content_length'] > 0) {
1267             // No curl errors - adjust for large files only - take max timeout.
1268             $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024)));
1269         }
1270     }
1272     $curl = new curl();
1273     $curl->setHeader($headers2);
1275     $options['CURLOPT_RETURNTRANSFER'] = true;
1276     $options['CURLOPT_NOBODY'] = false;
1277     $options['CURLOPT_TIMEOUT'] = $timeout;
1279     if ($tofile) {
1280         $fh = fopen($tofile, 'w');
1281         if (!$fh) {
1282             if ($fullresponse) {
1283                 $response = new stdClass();
1284                 $response->status        = 0;
1285                 $response->headers       = array();
1286                 $response->response_code = 'Can not write to file';
1287                 $response->results       = false;
1288                 $response->error         = 'Can not write to file';
1289                 return $response;
1290             } else {
1291                 return false;
1292             }
1293         }
1294         $options['CURLOPT_FILE'] = $fh;
1295     }
1297     if (isset($postdata)) {
1298         $content = $curl->post($url, $postdata, $options);
1299     } else {
1300         $content = $curl->get($url, null, $options);
1301     }
1303     if ($tofile) {
1304         fclose($fh);
1305         @chmod($tofile, $CFG->filepermissions);
1306     }
1308 /*
1309     // Try to detect encoding problems.
1310     if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1311         curl_setopt($ch, CURLOPT_ENCODING, 'none');
1312         $result = curl_exec($ch);
1313     }
1314 */
1316     $info       = $curl->get_info();
1317     $error_no   = $curl->get_errno();
1318     $rawheaders = $curl->get_raw_response();
1320     if ($error_no) {
1321         $error = $content;
1322         if (!$fullresponse) {
1323             debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1324             return false;
1325         }
1327         $response = new stdClass();
1328         if ($error_no == 28) {
1329             $response->status    = '-100'; // Mimic snoopy.
1330         } else {
1331             $response->status    = '0';
1332         }
1333         $response->headers       = array();
1334         $response->response_code = $error;
1335         $response->results       = false;
1336         $response->error         = $error;
1337         return $response;
1338     }
1340     if ($tofile) {
1341         $content = true;
1342     }
1344     if (empty($info['http_code'])) {
1345         // For security reasons we support only true http connections (Location: file:// exploit prevention).
1346         $response = new stdClass();
1347         $response->status        = '0';
1348         $response->headers       = array();
1349         $response->response_code = 'Unknown cURL error';
1350         $response->results       = false; // do NOT change this, we really want to ignore the result!
1351         $response->error         = 'Unknown cURL error';
1353     } else {
1354         $response = new stdClass();
1355         $response->status        = (string)$info['http_code'];
1356         $response->headers       = $rawheaders;
1357         $response->results       = $content;
1358         $response->error         = '';
1360         // There might be multiple headers on redirect, find the status of the last one.
1361         $firstline = true;
1362         foreach ($rawheaders as $line) {
1363             if ($firstline) {
1364                 $response->response_code = $line;
1365                 $firstline = false;
1366             }
1367             if (trim($line, "\r\n") === '') {
1368                 $firstline = true;
1369             }
1370         }
1371     }
1373     if ($fullresponse) {
1374         return $response;
1375     }
1377     if ($info['http_code'] != 200) {
1378         debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1379         return false;
1380     }
1381     return $response->results;
1384 /**
1385  * Returns a list of information about file types based on extensions.
1386  *
1387  * The following elements expected in value array for each extension:
1388  * 'type' - mimetype
1389  * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1390  *     or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1391  *     also files with bigger sizes under names
1392  *     FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1393  * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1394  *     commonly used in moodle the following groups:
1395  *       - web_image - image that can be included as <img> in HTML
1396  *       - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1397  *       - video - file that can be imported as video in text editor
1398  *       - audio - file that can be imported as audio in text editor
1399  *       - archive - we can extract files from this archive
1400  *       - spreadsheet - used for portfolio format
1401  *       - document - used for portfolio format
1402  *       - presentation - used for portfolio format
1403  * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1404  *     human-readable description for this filetype;
1405  *     Function {@link get_mimetype_description()} first looks at the presence of string for
1406  *     particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1407  *     attribute, if not found returns the value of 'type';
1408  * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1409  *     an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1410  *     this function will return first found icon; Especially usefull for types such as 'text/plain'
1411  *
1412  * @category files
1413  * @return array List of information about file types based on extensions.
1414  *   Associative array of extension (lower-case) to associative array
1415  *   from 'element name' to data. Current element names are 'type' and 'icon'.
1416  *   Unknown types should use the 'xxx' entry which includes defaults.
1417  */
1418 function &get_mimetypes_array() {
1419     // Get types from the core_filetypes function, which includes caching.
1420     return core_filetypes::get_types();
1423 /**
1424  * Determine a file's MIME type based on the given filename using the function mimeinfo.
1425  *
1426  * This function retrieves a file's MIME type for a file that will be sent to the user.
1427  * This should only be used for file-sending purposes just like in send_stored_file, send_file, and send_temp_file.
1428  * Should the file's MIME type cannot be determined by mimeinfo, it will return 'application/octet-stream' as a default
1429  * MIME type which should tell the browser "I don't know what type of file this is, so just download it.".
1430  *
1431  * @param string $filename The file's filename.
1432  * @return string The file's MIME type or 'application/octet-stream' if it cannot be determined.
1433  */
1434 function get_mimetype_for_sending($filename = '') {
1435     // Guess the file's MIME type using mimeinfo.
1436     $mimetype = mimeinfo('type', $filename);
1438     // Use octet-stream as fallback if MIME type cannot be determined by mimeinfo.
1439     if (!$mimetype || $mimetype === 'document/unknown') {
1440         $mimetype = 'application/octet-stream';
1441     }
1443     return $mimetype;
1446 /**
1447  * Obtains information about a filetype based on its extension. Will
1448  * use a default if no information is present about that particular
1449  * extension.
1450  *
1451  * @category files
1452  * @param string $element Desired information (usually 'icon'
1453  *   for icon filename or 'type' for MIME type. Can also be
1454  *   'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1455  * @param string $filename Filename we're looking up
1456  * @return string Requested piece of information from array
1457  */
1458 function mimeinfo($element, $filename) {
1459     global $CFG;
1460     $mimeinfo = & get_mimetypes_array();
1461     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1463     $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1464     if (empty($filetype)) {
1465         $filetype = 'xxx'; // file without extension
1466     }
1467     if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1468         $iconsize = max(array(16, (int)$iconsizematch[1]));
1469         $filenames = array($mimeinfo['xxx']['icon']);
1470         if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1471             array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1472         }
1473         // find the file with the closest size, first search for specific icon then for default icon
1474         foreach ($filenames as $filename) {
1475             foreach ($iconpostfixes as $size => $postfix) {
1476                 $fullname = $CFG->dirroot.'/pix/f/'.$filename.$postfix;
1477                 if ($iconsize >= $size &&
1478                         (file_exists($fullname.'.svg') || file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1479                     return $filename.$postfix;
1480                 }
1481             }
1482         }
1483     } else if (isset($mimeinfo[$filetype][$element])) {
1484         return $mimeinfo[$filetype][$element];
1485     } else if (isset($mimeinfo['xxx'][$element])) {
1486         return $mimeinfo['xxx'][$element];   // By default
1487     } else {
1488         return null;
1489     }
1492 /**
1493  * Obtains information about a filetype based on the MIME type rather than
1494  * the other way around.
1495  *
1496  * @category files
1497  * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1498  * @param string $mimetype MIME type we're looking up
1499  * @return string Requested piece of information from array
1500  */
1501 function mimeinfo_from_type($element, $mimetype) {
1502     /* array of cached mimetype->extension associations */
1503     static $cached = array();
1504     $mimeinfo = & get_mimetypes_array();
1506     if (!array_key_exists($mimetype, $cached)) {
1507         $cached[$mimetype] = null;
1508         foreach($mimeinfo as $filetype => $values) {
1509             if ($values['type'] == $mimetype) {
1510                 if ($cached[$mimetype] === null) {
1511                     $cached[$mimetype] = '.'.$filetype;
1512                 }
1513                 if (!empty($values['defaulticon'])) {
1514                     $cached[$mimetype] = '.'.$filetype;
1515                     break;
1516                 }
1517             }
1518         }
1519         if (empty($cached[$mimetype])) {
1520             $cached[$mimetype] = '.xxx';
1521         }
1522     }
1523     if ($element === 'extension') {
1524         return $cached[$mimetype];
1525     } else {
1526         return mimeinfo($element, $cached[$mimetype]);
1527     }
1530 /**
1531  * Return the relative icon path for a given file
1532  *
1533  * Usage:
1534  * <code>
1535  * // $file - instance of stored_file or file_info
1536  * $icon = $OUTPUT->image_url(file_file_icon($file))->out();
1537  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1538  * </code>
1539  * or
1540  * <code>
1541  * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1542  * </code>
1543  *
1544  * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1545  *     and $file->mimetype are expected)
1546  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1547  * @return string
1548  */
1549 function file_file_icon($file, $size = null) {
1550     if (!is_object($file)) {
1551         $file = (object)$file;
1552     }
1553     if (isset($file->filename)) {
1554         $filename = $file->filename;
1555     } else if (method_exists($file, 'get_filename')) {
1556         $filename = $file->get_filename();
1557     } else if (method_exists($file, 'get_visible_name')) {
1558         $filename = $file->get_visible_name();
1559     } else {
1560         $filename = '';
1561     }
1562     if (isset($file->mimetype)) {
1563         $mimetype = $file->mimetype;
1564     } else if (method_exists($file, 'get_mimetype')) {
1565         $mimetype = $file->get_mimetype();
1566     } else {
1567         $mimetype = '';
1568     }
1569     $mimetypes = &get_mimetypes_array();
1570     if ($filename) {
1571         $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1572         if ($extension && !empty($mimetypes[$extension])) {
1573             // if file name has known extension, return icon for this extension
1574             return file_extension_icon($filename, $size);
1575         }
1576     }
1577     return file_mimetype_icon($mimetype, $size);
1580 /**
1581  * Return the relative icon path for a folder image
1582  *
1583  * Usage:
1584  * <code>
1585  * $icon = $OUTPUT->image_url(file_folder_icon())->out();
1586  * echo html_writer::empty_tag('img', array('src' => $icon));
1587  * </code>
1588  * or
1589  * <code>
1590  * echo $OUTPUT->pix_icon(file_folder_icon(32), '');
1591  * </code>
1592  *
1593  * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1594  * @return string
1595  */
1596 function file_folder_icon($iconsize = null) {
1597     global $CFG;
1598     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1599     static $cached = array();
1600     $iconsize = max(array(16, (int)$iconsize));
1601     if (!array_key_exists($iconsize, $cached)) {
1602         foreach ($iconpostfixes as $size => $postfix) {
1603             $fullname = $CFG->dirroot.'/pix/f/folder'.$postfix;
1604             if ($iconsize >= $size &&
1605                     (file_exists($fullname.'.svg') || file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1606                 $cached[$iconsize] = 'f/folder'.$postfix;
1607                 break;
1608             }
1609         }
1610     }
1611     return $cached[$iconsize];
1614 /**
1615  * Returns the relative icon path for a given mime type
1616  *
1617  * This function should be used in conjunction with $OUTPUT->image_url to produce
1618  * a return the full path to an icon.
1619  *
1620  * <code>
1621  * $mimetype = 'image/jpg';
1622  * $icon = $OUTPUT->image_url(file_mimetype_icon($mimetype))->out();
1623  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1624  * </code>
1625  *
1626  * @category files
1627  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1628  * to conform with that.
1629  * @param string $mimetype The mimetype to fetch an icon for
1630  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1631  * @return string The relative path to the icon
1632  */
1633 function file_mimetype_icon($mimetype, $size = NULL) {
1634     return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1637 /**
1638  * Returns the relative icon path for a given file name
1639  *
1640  * This function should be used in conjunction with $OUTPUT->image_url to produce
1641  * a return the full path to an icon.
1642  *
1643  * <code>
1644  * $filename = '.jpg';
1645  * $icon = $OUTPUT->image_url(file_extension_icon($filename))->out();
1646  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1647  * </code>
1648  *
1649  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1650  * to conform with that.
1651  * @todo MDL-31074 Implement $size
1652  * @category files
1653  * @param string $filename The filename to get the icon for
1654  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1655  * @return string
1656  */
1657 function file_extension_icon($filename, $size = NULL) {
1658     return 'f/'.mimeinfo('icon'.$size, $filename);
1661 /**
1662  * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1663  * mimetypes.php language file.
1664  *
1665  * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1666  *   'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1667  *   have filename); In case of array/stdClass the field 'mimetype' is optional.
1668  * @param bool $capitalise If true, capitalises first character of result
1669  * @return string Text description
1670  */
1671 function get_mimetype_description($obj, $capitalise=false) {
1672     $filename = $mimetype = '';
1673     if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1674         // this is an instance of stored_file
1675         $mimetype = $obj->get_mimetype();
1676         $filename = $obj->get_filename();
1677     } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1678         // this is an instance of file_info
1679         $mimetype = $obj->get_mimetype();
1680         $filename = $obj->get_visible_name();
1681     } else if (is_array($obj) || is_object ($obj)) {
1682         $obj = (array)$obj;
1683         if (!empty($obj['filename'])) {
1684             $filename = $obj['filename'];
1685         }
1686         if (!empty($obj['mimetype'])) {
1687             $mimetype = $obj['mimetype'];
1688         }
1689     } else {
1690         $mimetype = $obj;
1691     }
1692     $mimetypefromext = mimeinfo('type', $filename);
1693     if (empty($mimetype) || $mimetypefromext !== 'document/unknown') {
1694         // if file has a known extension, overwrite the specified mimetype
1695         $mimetype = $mimetypefromext;
1696     }
1697     $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1698     if (empty($extension)) {
1699         $mimetypestr = mimeinfo_from_type('string', $mimetype);
1700         $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1701     } else {
1702         $mimetypestr = mimeinfo('string', $filename);
1703     }
1704     $chunks = explode('/', $mimetype, 2);
1705     $chunks[] = '';
1706     $attr = array(
1707         'mimetype' => $mimetype,
1708         'ext' => $extension,
1709         'mimetype1' => $chunks[0],
1710         'mimetype2' => $chunks[1],
1711     );
1712     $a = array();
1713     foreach ($attr as $key => $value) {
1714         $a[$key] = $value;
1715         $a[strtoupper($key)] = strtoupper($value);
1716         $a[ucfirst($key)] = ucfirst($value);
1717     }
1719     // MIME types may include + symbol but this is not permitted in string ids.
1720     $safemimetype = str_replace('+', '_', $mimetype);
1721     $safemimetypestr = str_replace('+', '_', $mimetypestr);
1722     $customdescription = mimeinfo('customdescription', $filename);
1723     if ($customdescription) {
1724         // Call format_string on the custom description so that multilang
1725         // filter can be used (if enabled on system context). We use system
1726         // context because it is possible that the page context might not have
1727         // been defined yet.
1728         $result = format_string($customdescription, true,
1729                 array('context' => context_system::instance()));
1730     } else if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
1731         $result = get_string($safemimetype, 'mimetypes', (object)$a);
1732     } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
1733         $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
1734     } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1735         $result = get_string('default', 'mimetypes', (object)$a);
1736     } else {
1737         $result = $mimetype;
1738     }
1739     if ($capitalise) {
1740         $result=ucfirst($result);
1741     }
1742     return $result;
1745 /**
1746  * Returns array of elements of type $element in type group(s)
1747  *
1748  * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1749  * @param string|array $groups one group or array of groups/extensions/mimetypes
1750  * @return array
1751  */
1752 function file_get_typegroup($element, $groups) {
1753     static $cached = array();
1754     if (!is_array($groups)) {
1755         $groups = array($groups);
1756     }
1757     if (!array_key_exists($element, $cached)) {
1758         $cached[$element] = array();
1759     }
1760     $result = array();
1761     foreach ($groups as $group) {
1762         if (!array_key_exists($group, $cached[$element])) {
1763             // retrieive and cache all elements of type $element for group $group
1764             $mimeinfo = & get_mimetypes_array();
1765             $cached[$element][$group] = array();
1766             foreach ($mimeinfo as $extension => $value) {
1767                 $value['extension'] = '.'.$extension;
1768                 if (empty($value[$element])) {
1769                     continue;
1770                 }
1771                 if (($group === '.'.$extension || $group === $value['type'] ||
1772                         (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1773                         !in_array($value[$element], $cached[$element][$group])) {
1774                     $cached[$element][$group][] = $value[$element];
1775                 }
1776             }
1777         }
1778         $result = array_merge($result, $cached[$element][$group]);
1779     }
1780     return array_values(array_unique($result));
1783 /**
1784  * Checks if file with name $filename has one of the extensions in groups $groups
1785  *
1786  * @see get_mimetypes_array()
1787  * @param string $filename name of the file to check
1788  * @param string|array $groups one group or array of groups to check
1789  * @param bool $checktype if true and extension check fails, find the mimetype and check if
1790  * file mimetype is in mimetypes in groups $groups
1791  * @return bool
1792  */
1793 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
1794     $extension = pathinfo($filename, PATHINFO_EXTENSION);
1795     if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
1796         return true;
1797     }
1798     return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
1801 /**
1802  * Checks if mimetype $mimetype belongs to one of the groups $groups
1803  *
1804  * @see get_mimetypes_array()
1805  * @param string $mimetype
1806  * @param string|array $groups one group or array of groups to check
1807  * @return bool
1808  */
1809 function file_mimetype_in_typegroup($mimetype, $groups) {
1810     return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
1813 /**
1814  * Requested file is not found or not accessible, does not return, terminates script
1815  *
1816  * @global stdClass $CFG
1817  * @global stdClass $COURSE
1818  */
1819 function send_file_not_found() {
1820     global $CFG, $COURSE;
1822     // Allow cross-origin requests only for Web Services.
1823     // This allow to receive requests done by Web Workers or webapps in different domains.
1824     if (WS_SERVER) {
1825         header('Access-Control-Allow-Origin: *');
1826     }
1828     send_header_404();
1829     print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1831 /**
1832  * Helper function to send correct 404 for server.
1833  */
1834 function send_header_404() {
1835     if (substr(php_sapi_name(), 0, 3) == 'cgi') {
1836         header("Status: 404 Not Found");
1837     } else {
1838         header('HTTP/1.0 404 not found');
1839     }
1842 /**
1843  * The readfile function can fail when files are larger than 2GB (even on 64-bit
1844  * platforms). This wrapper uses readfile for small files and custom code for
1845  * large ones.
1846  *
1847  * @param string $path Path to file
1848  * @param int $filesize Size of file (if left out, will get it automatically)
1849  * @return int|bool Size read (will always be $filesize) or false if failed
1850  */
1851 function readfile_allow_large($path, $filesize = -1) {
1852     // Automatically get size if not specified.
1853     if ($filesize === -1) {
1854         $filesize = filesize($path);
1855     }
1856     if ($filesize <= 2147483647) {
1857         // If the file is up to 2^31 - 1, send it normally using readfile.
1858         return readfile($path);
1859     } else {
1860         // For large files, read and output in 64KB chunks.
1861         $handle = fopen($path, 'r');
1862         if ($handle === false) {
1863             return false;
1864         }
1865         $left = $filesize;
1866         while ($left > 0) {
1867             $size = min($left, 65536);
1868             $buffer = fread($handle, $size);
1869             if ($buffer === false) {
1870                 return false;
1871             }
1872             echo $buffer;
1873             $left -= $size;
1874         }
1875         return $filesize;
1876     }
1879 /**
1880  * Enhanced readfile() with optional acceleration.
1881  * @param string|stored_file $file
1882  * @param string $mimetype
1883  * @param bool $accelerate
1884  * @return void
1885  */
1886 function readfile_accel($file, $mimetype, $accelerate) {
1887     global $CFG;
1889     if ($mimetype === 'text/plain') {
1890         // there is no encoding specified in text files, we need something consistent
1891         header('Content-Type: text/plain; charset=utf-8');
1892     } else {
1893         header('Content-Type: '.$mimetype);
1894     }
1896     $lastmodified = is_object($file) ? $file->get_timemodified() : filemtime($file);
1897     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1899     if (is_object($file)) {
1900         header('Etag: "' . $file->get_contenthash() . '"');
1901         if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and trim($_SERVER['HTTP_IF_NONE_MATCH'], '"') === $file->get_contenthash()) {
1902             header('HTTP/1.1 304 Not Modified');
1903             return;
1904         }
1905     }
1907     // if etag present for stored file rely on it exclusively
1908     if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
1909         // get unixtime of request header; clip extra junk off first
1910         $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1911         if ($since && $since >= $lastmodified) {
1912             header('HTTP/1.1 304 Not Modified');
1913             return;
1914         }
1915     }
1917     if ($accelerate and !empty($CFG->xsendfile)) {
1918         if (empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1919             header('Accept-Ranges: bytes');
1920         } else {
1921             header('Accept-Ranges: none');
1922         }
1924         if (is_object($file)) {
1925             $fs = get_file_storage();
1926             if ($fs->xsendfile($file->get_contenthash())) {
1927                 return;
1928             }
1930         } else {
1931             require_once("$CFG->libdir/xsendfilelib.php");
1932             if (xsendfile($file)) {
1933                 return;
1934             }
1935         }
1936     }
1938     $filesize = is_object($file) ? $file->get_filesize() : filesize($file);
1940     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1942     if ($accelerate and empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1943         header('Accept-Ranges: bytes');
1945         if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1946             // byteserving stuff - for acrobat reader and download accelerators
1947             // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1948             // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
1949             $ranges = false;
1950             if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
1951                 foreach ($ranges as $key=>$value) {
1952                     if ($ranges[$key][1] == '') {
1953                         //suffix case
1954                         $ranges[$key][1] = $filesize - $ranges[$key][2];
1955                         $ranges[$key][2] = $filesize - 1;
1956                     } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
1957                         //fix range length
1958                         $ranges[$key][2] = $filesize - 1;
1959                     }
1960                     if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
1961                         //invalid byte-range ==> ignore header
1962                         $ranges = false;
1963                         break;
1964                     }
1965                     //prepare multipart header
1966                     $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
1967                     $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
1968                 }
1969             } else {
1970                 $ranges = false;
1971             }
1972             if ($ranges) {
1973                 if (is_object($file)) {
1974                     $handle = $file->get_content_file_handle();
1975                 } else {
1976                     $handle = fopen($file, 'rb');
1977                 }
1978                 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
1979             }
1980         }
1981     } else {
1982         // Do not byteserve
1983         header('Accept-Ranges: none');
1984     }
1986     header('Content-Length: '.$filesize);
1988     if ($filesize > 10000000) {
1989         // for large files try to flush and close all buffers to conserve memory
1990         while(@ob_get_level()) {
1991             if (!@ob_end_flush()) {
1992                 break;
1993             }
1994         }
1995     }
1997     // send the whole file content
1998     if (is_object($file)) {
1999         $file->readfile();
2000     } else {
2001         readfile_allow_large($file, $filesize);
2002     }
2005 /**
2006  * Similar to readfile_accel() but designed for strings.
2007  * @param string $string
2008  * @param string $mimetype
2009  * @param bool $accelerate
2010  * @return void
2011  */
2012 function readstring_accel($string, $mimetype, $accelerate) {
2013     global $CFG;
2015     if ($mimetype === 'text/plain') {
2016         // there is no encoding specified in text files, we need something consistent
2017         header('Content-Type: text/plain; charset=utf-8');
2018     } else {
2019         header('Content-Type: '.$mimetype);
2020     }
2021     header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2022     header('Accept-Ranges: none');
2024     if ($accelerate and !empty($CFG->xsendfile)) {
2025         $fs = get_file_storage();
2026         if ($fs->xsendfile(sha1($string))) {
2027             return;
2028         }
2029     }
2031     header('Content-Length: '.strlen($string));
2032     echo $string;
2035 /**
2036  * Handles the sending of temporary file to user, download is forced.
2037  * File is deleted after abort or successful sending, does not return, script terminated
2038  *
2039  * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2040  * @param string $filename proposed file name when saving file
2041  * @param bool $pathisstring If the path is string
2042  */
2043 function send_temp_file($path, $filename, $pathisstring=false) {
2044     global $CFG;
2046     // Guess the file's MIME type.
2047     $mimetype = get_mimetype_for_sending($filename);
2049     // close session - not needed anymore
2050     \core\session\manager::write_close();
2052     if (!$pathisstring) {
2053         if (!file_exists($path)) {
2054             send_header_404();
2055             print_error('filenotfound', 'error', $CFG->wwwroot.'/');
2056         }
2057         // executed after normal finish or abort
2058         core_shutdown_manager::register_function('send_temp_file_finished', array($path));
2059     }
2061     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2062     if (core_useragent::is_ie()) {
2063         $filename = urlencode($filename);
2064     }
2066     header('Content-Disposition: attachment; filename="'.$filename.'"');
2067     if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2068         header('Cache-Control: private, max-age=10, no-transform');
2069         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2070         header('Pragma: ');
2071     } else { //normal http - prevent caching at all cost
2072         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2073         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2074         header('Pragma: no-cache');
2075     }
2077     // send the contents - we can not accelerate this because the file will be deleted asap
2078     if ($pathisstring) {
2079         readstring_accel($path, $mimetype, false);
2080     } else {
2081         readfile_accel($path, $mimetype, false);
2082         @unlink($path);
2083     }
2085     die; //no more chars to output
2088 /**
2089  * Internal callback function used by send_temp_file()
2090  *
2091  * @param string $path
2092  */
2093 function send_temp_file_finished($path) {
2094     if (file_exists($path)) {
2095         @unlink($path);
2096     }
2099 /**
2100  * Serve content which is not meant to be cached.
2101  *
2102  * This is only intended to be used for volatile public files, for instance
2103  * when development is enabled, or when caching is not required on a public resource.
2104  *
2105  * @param string $content Raw content.
2106  * @param string $filename The file name.
2107  * @return void
2108  */
2109 function send_content_uncached($content, $filename) {
2110     $mimetype = mimeinfo('type', $filename);
2111     $charset = strpos($mimetype, 'text/') === 0 ? '; charset=utf-8' : '';
2113     header('Content-Disposition: inline; filename="' . $filename . '"');
2114     header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
2115     header('Expires: ' . gmdate('D, d M Y H:i:s', time() + 2) . ' GMT');
2116     header('Pragma: ');
2117     header('Accept-Ranges: none');
2118     header('Content-Type: ' . $mimetype . $charset);
2119     header('Content-Length: ' . strlen($content));
2121     echo $content;
2122     die();
2125 /**
2126  * Safely save content to a certain path.
2127  *
2128  * This function tries hard to be atomic by first copying the content
2129  * to a separate file, and then moving the file across. It also prevents
2130  * the user to abort a request to prevent half-safed files.
2131  *
2132  * This function is intended to be used when saving some content to cache like
2133  * $CFG->localcachedir. If you're not caching a file you should use the File API.
2134  *
2135  * @param string $content The file content.
2136  * @param string $destination The absolute path of the final file.
2137  * @return void
2138  */
2139 function file_safe_save_content($content, $destination) {
2140     global $CFG;
2142     clearstatcache();
2143     if (!file_exists(dirname($destination))) {
2144         @mkdir(dirname($destination), $CFG->directorypermissions, true);
2145     }
2147     // Prevent serving of incomplete file from concurrent request,
2148     // the rename() should be more atomic than fwrite().
2149     ignore_user_abort(true);
2150     if ($fp = fopen($destination . '.tmp', 'xb')) {
2151         fwrite($fp, $content);
2152         fclose($fp);
2153         rename($destination . '.tmp', $destination);
2154         @chmod($destination, $CFG->filepermissions);
2155         @unlink($destination . '.tmp'); // Just in case anything fails.
2156     }
2157     ignore_user_abort(false);
2158     if (connection_aborted()) {
2159         die();
2160     }
2163 /**
2164  * Handles the sending of file data to the user's browser, including support for
2165  * byteranges etc.
2166  *
2167  * @category files
2168  * @param string|stored_file $path Path of file on disk (including real filename),
2169  *                                 or actual content of file as string,
2170  *                                 or stored_file object
2171  * @param string $filename Filename to send
2172  * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2173  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2174  * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname.
2175  *                           Forced to false when $path is a stored_file object.
2176  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2177  * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2178  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2179  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2180  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
2181  *                        and should not be reopened.
2182  * @param array $options An array of options, currently accepts:
2183  *                       - (string) cacheability: public, or private.
2184  *                       - (string|null) immutable
2185  * @return null script execution stopped unless $dontdie is true
2186  */
2187 function send_file($path, $filename, $lifetime = null , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='',
2188                    $dontdie=false, array $options = array()) {
2189     global $CFG, $COURSE;
2191     if ($dontdie) {
2192         ignore_user_abort(true);
2193     }
2195     if ($lifetime === 'default' or is_null($lifetime)) {
2196         $lifetime = $CFG->filelifetime;
2197     }
2199     if (is_object($path)) {
2200         $pathisstring = false;
2201     }
2203     \core\session\manager::write_close(); // Unlock session during file serving.
2205     // Use given MIME type if specified, otherwise guess it.
2206     if (!$mimetype || $mimetype === 'document/unknown') {
2207         $mimetype = get_mimetype_for_sending($filename);
2208     }
2210     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2211     if (core_useragent::is_ie()) {
2212         $filename = rawurlencode($filename);
2213     }
2215     if ($forcedownload) {
2216         header('Content-Disposition: attachment; filename="'.$filename.'"');
2217     } else if ($mimetype !== 'application/x-shockwave-flash') {
2218         // If this is an swf don't pass content-disposition with filename as this makes the flash player treat the file
2219         // as an upload and enforces security that may prevent the file from being loaded.
2221         header('Content-Disposition: inline; filename="'.$filename.'"');
2222     }
2224     if ($lifetime > 0) {
2225         $immutable = '';
2226         if (!empty($options['immutable'])) {
2227             $immutable = ', immutable';
2228             // Overwrite lifetime accordingly:
2229             // 90 days only - based on Moodle point release cadence being every 3 months.
2230             $lifetimemin = 60 * 60 * 24 * 90;
2231             $lifetime = max($lifetime, $lifetimemin);
2232         }
2233         $cacheability = ' public,';
2234         if (!empty($options['cacheability']) && ($options['cacheability'] === 'public')) {
2235             // This file must be cache-able by both browsers and proxies.
2236             $cacheability = ' public,';
2237         } else if (!empty($options['cacheability']) && ($options['cacheability'] === 'private')) {
2238             // This file must be cache-able only by browsers.
2239             $cacheability = ' private,';
2240         } else if (isloggedin() and !isguestuser()) {
2241             // By default, under the conditions above, this file must be cache-able only by browsers.
2242             $cacheability = ' private,';
2243         }
2244         $nobyteserving = false;
2245         header('Cache-Control:'.$cacheability.' max-age='.$lifetime.', no-transform'.$immutable);
2246         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2247         header('Pragma: ');
2249     } else { // Do not cache files in proxies and browsers
2250         $nobyteserving = true;
2251         if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2252             header('Cache-Control: private, max-age=10, no-transform');
2253             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2254             header('Pragma: ');
2255         } else { //normal http - prevent caching at all cost
2256             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2257             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2258             header('Pragma: no-cache');
2259         }
2260     }
2262     if (empty($filter)) {
2263         // send the contents
2264         if ($pathisstring) {
2265             readstring_accel($path, $mimetype, !$dontdie);
2266         } else {
2267             readfile_accel($path, $mimetype, !$dontdie);
2268         }
2270     } else {
2271         // Try to put the file through filters
2272         if ($mimetype == 'text/html' || $mimetype == 'application/xhtml+xml') {
2273             $options = new stdClass();
2274             $options->noclean = true;
2275             $options->nocache = true; // temporary workaround for MDL-5136
2276             if (is_object($path)) {
2277                 $text = $path->get_content();
2278             } else if ($pathisstring) {
2279                 $text = $path;
2280             } else {
2281                 $text = implode('', file($path));
2282             }
2283             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2285             readstring_accel($output, $mimetype, false);
2287         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2288             // only filter text if filter all files is selected
2289             $options = new stdClass();
2290             $options->newlines = false;
2291             $options->noclean = true;
2292             if (is_object($path)) {
2293                 $text = htmlentities($path->get_content(), ENT_QUOTES, 'UTF-8');
2294             } else if ($pathisstring) {
2295                 $text = htmlentities($path, ENT_QUOTES, 'UTF-8');
2296             } else {
2297                 $text = htmlentities(implode('', file($path)), ENT_QUOTES, 'UTF-8');
2298             }
2299             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2301             readstring_accel($output, $mimetype, false);
2303         } else {
2304             // send the contents
2305             if ($pathisstring) {
2306                 readstring_accel($path, $mimetype, !$dontdie);
2307             } else {
2308                 readfile_accel($path, $mimetype, !$dontdie);
2309             }
2310         }
2311     }
2312     if ($dontdie) {
2313         return;
2314     }
2315     die; //no more chars to output!!!
2318 /**
2319  * Handles the sending of file data to the user's browser, including support for
2320  * byteranges etc.
2321  *
2322  * The $options parameter supports the following keys:
2323  *  (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2324  *  (string|null) filename - overrides the implicit filename
2325  *  (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2326  *      if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2327  *      you must detect this case when control is returned using connection_aborted. Please not that session is closed
2328  *      and should not be reopened
2329  *  (string|null) cacheability - force the cacheability setting of the HTTP response, "private" or "public",
2330  *      when $lifetime is greater than 0. Cacheability defaults to "private" when logged in as other than guest; otherwise,
2331  *      defaults to "public".
2332  *  (string|null) immutable - set the immutable cache setting in the HTTP response, when served under HTTPS.
2333  *      Note: it's up to the consumer to set it properly i.e. when serving a "versioned" URL.
2334  *
2335  * @category files
2336  * @param stored_file $stored_file local file object
2337  * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2338  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2339  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2340  * @param array $options additional options affecting the file serving
2341  * @return null script execution stopped unless $options['dontdie'] is true
2342  */
2343 function send_stored_file($stored_file, $lifetime=null, $filter=0, $forcedownload=false, array $options=array()) {
2344     global $CFG, $COURSE;
2346     if (empty($options['filename'])) {
2347         $filename = null;
2348     } else {
2349         $filename = $options['filename'];
2350     }
2352     if (empty($options['dontdie'])) {
2353         $dontdie = false;
2354     } else {
2355         $dontdie = true;
2356     }
2358     if ($lifetime === 'default' or is_null($lifetime)) {
2359         $lifetime = $CFG->filelifetime;
2360     }
2362     if (!empty($options['preview'])) {
2363         // replace the file with its preview
2364         $fs = get_file_storage();
2365         $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2366         if (!$preview_file) {
2367             // unable to create a preview of the file, send its default mime icon instead
2368             if ($options['preview'] === 'tinyicon') {
2369                 $size = 24;
2370             } else if ($options['preview'] === 'thumb') {
2371                 $size = 90;
2372             } else {
2373                 $size = 256;
2374             }
2375             $fileicon = file_file_icon($stored_file, $size);
2376             send_file($CFG->dirroot.'/pix/'.$fileicon.'.svg', basename($fileicon).'.svg');
2377         } else {
2378             // preview images have fixed cache lifetime and they ignore forced download
2379             // (they are generated by GD and therefore they are considered reasonably safe).
2380             $stored_file = $preview_file;
2381             $lifetime = DAYSECS;
2382             $filter = 0;
2383             $forcedownload = false;
2384         }
2385     }
2387     // handle external resource
2388     if ($stored_file && $stored_file->is_external_file() && !isset($options['sendcachedexternalfile'])) {
2389         $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2390         die;
2391     }
2393     if (!$stored_file or $stored_file->is_directory()) {
2394         // nothing to serve
2395         if ($dontdie) {
2396             return;
2397         }
2398         die;
2399     }
2401     $filename = is_null($filename) ? $stored_file->get_filename() : $filename;
2403     // Use given MIME type if specified.
2404     $mimetype = $stored_file->get_mimetype();
2406     // Allow cross-origin requests only for Web Services.
2407     // This allow to receive requests done by Web Workers or webapps in different domains.
2408     if (WS_SERVER) {
2409         header('Access-Control-Allow-Origin: *');
2410     }
2412     send_file($stored_file, $filename, $lifetime, $filter, false, $forcedownload, $mimetype, $dontdie, $options);
2415 /**
2416  * Recursively delete the file or folder with path $location. That is,
2417  * if it is a file delete it. If it is a folder, delete all its content
2418  * then delete it. If $location does not exist to start, that is not
2419  * considered an error.
2420  *
2421  * @param string $location the path to remove.
2422  * @return bool
2423  */
2424 function fulldelete($location) {
2425     if (empty($location)) {
2426         // extra safety against wrong param
2427         return false;
2428     }
2429     if (is_dir($location)) {
2430         if (!$currdir = opendir($location)) {
2431             return false;
2432         }
2433         while (false !== ($file = readdir($currdir))) {
2434             if ($file <> ".." && $file <> ".") {
2435                 $fullfile = $location."/".$file;
2436                 if (is_dir($fullfile)) {
2437                     if (!fulldelete($fullfile)) {
2438                         return false;
2439                     }
2440                 } else {
2441                     if (!unlink($fullfile)) {
2442                         return false;
2443                     }
2444                 }
2445             }
2446         }
2447         closedir($currdir);
2448         if (! rmdir($location)) {
2449             return false;
2450         }
2452     } else if (file_exists($location)) {
2453         if (!unlink($location)) {
2454             return false;
2455         }
2456     }
2457     return true;
2460 /**
2461  * Send requested byterange of file.
2462  *
2463  * @param resource $handle A file handle
2464  * @param string $mimetype The mimetype for the output
2465  * @param array $ranges An array of ranges to send
2466  * @param string $filesize The size of the content if only one range is used
2467  */
2468 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2469     // better turn off any kind of compression and buffering
2470     ini_set('zlib.output_compression', 'Off');
2472     $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2473     if ($handle === false) {
2474         die;
2475     }
2476     if (count($ranges) == 1) { //only one range requested
2477         $length = $ranges[0][2] - $ranges[0][1] + 1;
2478         header('HTTP/1.1 206 Partial content');
2479         header('Content-Length: '.$length);
2480         header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2481         header('Content-Type: '.$mimetype);
2483         while(@ob_get_level()) {
2484             if (!@ob_end_flush()) {
2485                 break;
2486             }
2487         }
2489         fseek($handle, $ranges[0][1]);
2490         while (!feof($handle) && $length > 0) {
2491             core_php_time_limit::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2492             $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2493             echo $buffer;
2494             flush();
2495             $length -= strlen($buffer);
2496         }
2497         fclose($handle);
2498         die;
2499     } else { // multiple ranges requested - not tested much
2500         $totallength = 0;
2501         foreach($ranges as $range) {
2502             $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2503         }
2504         $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2505         header('HTTP/1.1 206 Partial content');
2506         header('Content-Length: '.$totallength);
2507         header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2509         while(@ob_get_level()) {
2510             if (!@ob_end_flush()) {
2511                 break;
2512             }
2513         }
2515         foreach($ranges as $range) {
2516             $length = $range[2] - $range[1] + 1;
2517             echo $range[0];
2518             fseek($handle, $range[1]);
2519             while (!feof($handle) && $length > 0) {
2520                 core_php_time_limit::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2521                 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2522                 echo $buffer;
2523                 flush();
2524                 $length -= strlen($buffer);
2525             }
2526         }
2527         echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2528         fclose($handle);
2529         die;
2530     }
2533 /**
2534  * Tells whether the filename is executable.
2535  *
2536  * @link http://php.net/manual/en/function.is-executable.php
2537  * @link https://bugs.php.net/bug.php?id=41062
2538  * @param string $filename Path to the file.
2539  * @return bool True if the filename exists and is executable; otherwise, false.
2540  */
2541 function file_is_executable($filename) {
2542     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
2543         if (is_executable($filename)) {
2544             return true;
2545         } else {
2546             $fileext = strrchr($filename, '.');
2547             // If we have an extension we can check if it is listed as executable.
2548             if ($fileext && file_exists($filename) && !is_dir($filename)) {
2549                 $winpathext = strtolower(getenv('PATHEXT'));
2550                 $winpathexts = explode(';', $winpathext);
2552                 return in_array(strtolower($fileext), $winpathexts);
2553             }
2555             return false;
2556         }
2557     } else {
2558         return is_executable($filename);
2559     }
2562 /**
2563  * Overwrite an existing file in a draft area.
2564  *
2565  * @param  stored_file $newfile      the new file with the new content and meta-data
2566  * @param  stored_file $existingfile the file that will be overwritten
2567  * @throws moodle_exception
2568  * @since Moodle 3.2
2569  */
2570 function file_overwrite_existing_draftfile(stored_file $newfile, stored_file $existingfile) {
2571     if ($existingfile->get_component() != 'user' or $existingfile->get_filearea() != 'draft') {
2572         throw new coding_exception('The file to overwrite is not in a draft area.');
2573     }
2575     $fs = get_file_storage();
2576     // Remember original file source field.
2577     $source = @unserialize($existingfile->get_source());
2578     // Remember the original sortorder.
2579     $sortorder = $existingfile->get_sortorder();
2580     if ($newfile->is_external_file()) {
2581         // New file is a reference. Check that existing file does not have any other files referencing to it
2582         if (isset($source->original) && $fs->search_references_count($source->original)) {
2583             throw new moodle_exception('errordoublereference', 'repository');
2584         }
2585     }
2587     // Delete existing file to release filename.
2588     $newfilerecord = array(
2589         'contextid' => $existingfile->get_contextid(),
2590         'component' => 'user',
2591         'filearea' => 'draft',
2592         'itemid' => $existingfile->get_itemid(),
2593         'timemodified' => time()
2594     );
2595     $existingfile->delete();
2597     // Create new file.
2598     $newfile = $fs->create_file_from_storedfile($newfilerecord, $newfile);
2599     // Preserve original file location (stored in source field) for handling references.
2600     if (isset($source->original)) {
2601         if (!($newfilesource = @unserialize($newfile->get_source()))) {
2602             $newfilesource = new stdClass();
2603         }
2604         $newfilesource->original = $source->original;
2605         $newfile->set_source(serialize($newfilesource));
2606     }
2607     $newfile->set_sortorder($sortorder);
2610 /**
2611  * Add files from a draft area into a final area.
2612  *
2613  * Most of the time you do not want to use this. It is intended to be used
2614  * by asynchronous services which cannot direcly manipulate a final
2615  * area through a draft area. Instead they add files to a new draft
2616  * area and merge that new draft into the final area when ready.
2617  *
2618  * @param int $draftitemid the id of the draft area to use.
2619  * @param int $contextid this parameter and the next two identify the file area to save to.
2620  * @param string $component component name
2621  * @param string $filearea indentifies the file area
2622  * @param int $itemid identifies the item id or false for all items in the file area
2623  * @param array $options area options (subdirs=false, maxfiles=-1, maxbytes=0, areamaxbytes=FILE_AREA_MAX_BYTES_UNLIMITED)
2624  * @see file_save_draft_area_files
2625  * @since Moodle 3.2
2626  */
2627 function file_merge_files_from_draft_area_into_filearea($draftitemid, $contextid, $component, $filearea, $itemid,
2628                                                         array $options = null) {
2629     // We use 0 here so file_prepare_draft_area creates a new one, finaldraftid will be updated with the new draft id.
2630     $finaldraftid = 0;
2631     file_prepare_draft_area($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
2632     file_merge_draft_area_into_draft_area($draftitemid, $finaldraftid);
2633     file_save_draft_area_files($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
2636 /**
2637  * Merge files from two draftarea areas.
2638  *
2639  * This does not handle conflict resolution, files in the destination area which appear
2640  * to be more recent will be kept disregarding the intended ones.
2641  *
2642  * @param int $getfromdraftid the id of the draft area where are the files to merge.
2643  * @param int $mergeintodraftid the id of the draft area where new files will be merged.
2644  * @throws coding_exception
2645  * @since Moodle 3.2
2646  */
2647 function file_merge_draft_area_into_draft_area($getfromdraftid, $mergeintodraftid) {
2648     global $USER;
2650     $fs = get_file_storage();
2651     $contextid = context_user::instance($USER->id)->id;
2653     if (!$filestomerge = $fs->get_area_files($contextid, 'user', 'draft', $getfromdraftid)) {
2654         throw new coding_exception('Nothing to merge or area does not belong to current user');
2655     }
2657     $currentfiles = $fs->get_area_files($contextid, 'user', 'draft', $mergeintodraftid);
2659     // Get hashes of the files to merge.
2660     $newhashes = array();
2661     foreach ($filestomerge as $filetomerge) {
2662         $filepath = $filetomerge->get_filepath();
2663         $filename = $filetomerge->get_filename();
2665         $newhash = $fs->get_pathname_hash($contextid, 'user', 'draft', $mergeintodraftid, $filepath, $filename);
2666         $newhashes[$newhash] = $filetomerge;
2667     }
2669     // Calculate wich files must be added.
2670     foreach ($currentfiles as $file) {
2671         $filehash = $file->get_pathnamehash();
2672         // One file to be merged already exists.
2673         if (isset($newhashes[$filehash])) {
2674             $updatedfile = $newhashes[$filehash];
2676             // Avoid race conditions.
2677             if ($file->get_timemodified() > $updatedfile->get_timemodified()) {
2678                 // The existing file is more recent, do not copy the suposedly "new" one.
2679                 unset($newhashes[$filehash]);
2680                 continue;
2681             }
2682             // Update existing file (not only content, meta-data too).
2683             file_overwrite_existing_draftfile($updatedfile, $file);
2684             unset($newhashes[$filehash]);
2685         }
2686     }
2688     foreach ($newhashes as $newfile) {
2689         $newfilerecord = array(
2690             'contextid' => $contextid,
2691             'component' => 'user',
2692             'filearea' => 'draft',
2693             'itemid' => $mergeintodraftid,
2694             'timemodified' => time()
2695         );
2697         $fs->create_file_from_storedfile($newfilerecord, $newfile);
2698     }
2701 /**
2702  * RESTful cURL class
2703  *
2704  * This is a wrapper class for curl, it is quite easy to use:
2705  * <code>
2706  * $c = new curl;
2707  * // enable cache
2708  * $c = new curl(array('cache'=>true));
2709  * // enable cookie
2710  * $c = new curl(array('cookie'=>true));
2711  * // enable proxy
2712  * $c = new curl(array('proxy'=>true));
2713  *
2714  * // HTTP GET Method
2715  * $html = $c->get('http://example.com');
2716  * // HTTP POST Method
2717  * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2718  * // HTTP PUT Method
2719  * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2720  * </code>
2721  *
2722  * @package   core_files
2723  * @category files
2724  * @copyright Dongsheng Cai <dongsheng@moodle.com>
2725  * @license   http://www.gnu.org/copyleft/gpl.html GNU Public License
2726  */
2727 class curl {
2728     /** @var bool Caches http request contents */
2729     public  $cache    = false;
2730     /** @var bool Uses proxy, null means automatic based on URL */
2731     public  $proxy    = null;
2732     /** @var string library version */
2733     public  $version  = '0.4 dev';
2734     /** @var array http's response */
2735     public  $response = array();
2736     /** @var array Raw response headers, needed for BC in download_file_content(). */
2737     public $rawresponse = array();
2738     /** @var array http header */
2739     public  $header   = array();
2740     /** @var string cURL information */
2741     public  $info;
2742     /** @var string error */
2743     public  $error;
2744     /** @var int error code */
2745     public  $errno;
2746     /** @var bool use workaround for open_basedir restrictions, to be changed from unit tests only! */
2747     public $emulateredirects = null;
2749     /** @var array cURL options */
2750     private $options;
2752     /** @var string Proxy host */
2753     private $proxy_host = '';
2754     /** @var string Proxy auth */
2755     private $proxy_auth = '';
2756     /** @var string Proxy type */
2757     private $proxy_type = '';
2758     /** @var bool Debug mode on */
2759     private $debug    = false;
2760     /** @var bool|string Path to cookie file */
2761     private $cookie   = false;
2762     /** @var bool tracks multiple headers in response - redirect detection */
2763     private $responsefinished = false;
2764     /** @var security helper class, responsible for checking host/ports against blacklist/whitelist entries.*/
2765     private $securityhelper;
2766     /** @var bool ignoresecurity a flag which can be supplied to the constructor, allowing security to be bypassed. */
2767     private $ignoresecurity;
2768     /** @var array $mockresponses For unit testing only - return the head of this list instead of making the next request. */
2769     private static $mockresponses = [];
2771     /**
2772      * Curl constructor.
2773      *
2774      * Allowed settings are:
2775      *  proxy: (bool) use proxy server, null means autodetect non-local from url
2776      *  debug: (bool) use debug output
2777      *  cookie: (string) path to cookie file, false if none
2778      *  cache: (bool) use cache
2779      *  module_cache: (string) type of cache
2780      *  securityhelper: (\core\files\curl_security_helper_base) helper object providing URL checking for requests.
2781      *  ignoresecurity: (bool) set true to override and ignore the security helper when making requests.
2782      *
2783      * @param array $settings
2784      */
2785     public function __construct($settings = array()) {
2786         global $CFG;
2787         if (!function_exists('curl_init')) {
2788             $this->error = 'cURL module must be enabled!';
2789             trigger_error($this->error, E_USER_ERROR);
2790             return false;
2791         }
2793         // All settings of this class should be init here.
2794         $this->resetopt();
2795         if (!empty($settings['debug'])) {
2796             $this->debug = true;
2797         }
2798         if (!empty($settings['cookie'])) {
2799             if($settings['cookie'] === true) {
2800                 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2801             } else {
2802                 $this->cookie = $settings['cookie'];
2803             }
2804         }
2805         if (!empty($settings['cache'])) {
2806             if (class_exists('curl_cache')) {
2807                 if (!empty($settings['module_cache'])) {
2808                     $this->cache = new curl_cache($settings['module_cache']);
2809                 } else {
2810                     $this->cache = new curl_cache('misc');
2811                 }
2812             }
2813         }
2814         if (!empty($CFG->proxyhost)) {
2815             if (empty($CFG->proxyport)) {
2816                 $this->proxy_host = $CFG->proxyhost;
2817             } else {
2818                 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2819             }
2820             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2821                 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2822                 $this->setopt(array(
2823                             'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2824                             'proxyuserpwd'=>$this->proxy_auth));
2825             }
2826             if (!empty($CFG->proxytype)) {
2827                 if ($CFG->proxytype == 'SOCKS5') {
2828                     $this->proxy_type = CURLPROXY_SOCKS5;
2829                 } else {
2830                     $this->proxy_type = CURLPROXY_HTTP;
2831                     $this->setopt(array('httpproxytunnel'=>false));
2832                 }
2833                 $this->setopt(array('proxytype'=>$this->proxy_type));
2834             }
2836             if (isset($settings['proxy'])) {
2837                 $this->proxy = $settings['proxy'];
2838             }
2839         } else {
2840             $this->proxy = false;
2841         }
2843         if (!isset($this->emulateredirects)) {
2844             $this->emulateredirects = ini_get('open_basedir');
2845         }
2847         // Curl security setup. Allow injection of a security helper, but if not found, default to the core helper.
2848         if (isset($settings['securityhelper']) && $settings['securityhelper'] instanceof \core\files\curl_security_helper_base) {
2849             $this->set_security($settings['securityhelper']);
2850         } else {
2851             $this->set_security(new \core\files\curl_security_helper());
2852         }
2853         $this->ignoresecurity = isset($settings['ignoresecurity']) ? $settings['ignoresecurity'] : false;
2854     }
2856     /**
2857      * Resets the CURL options that have already been set
2858      */
2859     public function resetopt() {
2860         $this->options = array();
2861         $this->options['CURLOPT_USERAGENT']         = 'MoodleBot/1.0';
2862         // True to include the header in the output
2863         $this->options['CURLOPT_HEADER']            = 0;
2864         // True to Exclude the body from the output
2865         $this->options['CURLOPT_NOBODY']            = 0;
2866         // Redirect ny default.
2867         $this->options['CURLOPT_FOLLOWLOCATION']    = 1;
2868         $this->options['CURLOPT_MAXREDIRS']         = 10;
2869         $this->options['CURLOPT_ENCODING']          = '';
2870         // TRUE to return the transfer as a string of the return
2871         // value of curl_exec() instead of outputting it out directly.
2872         $this->options['CURLOPT_RETURNTRANSFER']    = 1;
2873         $this->options['CURLOPT_SSL_VERIFYPEER']    = 0;
2874         $this->options['CURLOPT_SSL_VERIFYHOST']    = 2;
2875         $this->options['CURLOPT_CONNECTTIMEOUT']    = 30;
2877         if ($cacert = self::get_cacert()) {
2878             $this->options['CURLOPT_CAINFO'] = $cacert;
2879         }
2880     }
2882     /**
2883      * Get the location of ca certificates.
2884      * @return string absolute file path or empty if default used
2885      */
2886     public static function get_cacert() {
2887         global $CFG;
2889         // Bundle in dataroot always wins.
2890         if (is_readable("$CFG->dataroot/moodleorgca.crt")) {
2891             return realpath("$CFG->dataroot/moodleorgca.crt");
2892         }
2894         // Next comes the default from php.ini
2895         $cacert = ini_get('curl.cainfo');
2896         if (!empty($cacert) and is_readable($cacert)) {
2897             return realpath($cacert);
2898         }
2900         // Windows PHP does not have any certs, we need to use something.
2901         if ($CFG->ostype === 'WINDOWS') {
2902             if (is_readable("$CFG->libdir/cacert.pem")) {
2903                 return realpath("$CFG->libdir/cacert.pem");
2904             }
2905         }
2907         // Use default, this should work fine on all properly configured *nix systems.
2908         return null;
2909     }
2911     /**
2912      * Reset Cookie
2913      */
2914     public function resetcookie() {
2915         if (!empty($this->cookie)) {
2916             if (is_file($this->cookie)) {
2917                 $fp = fopen($this->cookie, 'w');
2918                 if (!empty($fp)) {
2919                     fwrite($fp, '');
2920                     fclose($fp);
2921                 }
2922             }
2923         }
2924     }
2926     /**
2927      * Set curl options.
2928      *
2929      * Do not use the curl constants to define the options, pass a string
2930      * corresponding to that constant. Ie. to set CURLOPT_MAXREDIRS, pass
2931      * array('CURLOPT_MAXREDIRS' => 10) or array('maxredirs' => 10) to this method.
2932      *
2933      * @param array $options If array is null, this function will reset the options to default value.
2934      * @return void
2935      * @throws coding_exception If an option uses constant value instead of option name.
2936      */
2937     public function setopt($options = array()) {
2938         if (is_array($options)) {
2939             foreach ($options as $name => $val) {
2940                 if (!is_string($name)) {
2941                     throw new coding_exception('Curl options should be defined using strings, not constant values.');
2942                 }
2943                 if (stripos($name, 'CURLOPT_') === false) {
2944                     $name = strtoupper('CURLOPT_'.$name);
2945                 } else {
2946                     $name = strtoupper($name);
2947                 }
2948                 $this->options[$name] = $val;
2949             }
2950         }
2951     }
2953     /**
2954      * Reset http method
2955      */
2956     public function cleanopt() {
2957         unset($this->options['CURLOPT_HTTPGET']);
2958         unset($this->options['CURLOPT_POST']);
2959         unset($this->options['CURLOPT_POSTFIELDS']);
2960         unset($this->options['CURLOPT_PUT']);
2961         unset($this->options['CURLOPT_INFILE']);
2962         unset($this->options['CURLOPT_INFILESIZE']);
2963         unset($this->options['CURLOPT_CUSTOMREQUEST']);
2964         unset($this->options['CURLOPT_FILE']);
2965     }
2967     /**
2968      * Resets the HTTP Request headers (to prepare for the new request)
2969      */
2970     public function resetHeader() {
2971         $this->header = array();
2972     }
2974     /**
2975      * Set HTTP Request Header
2976      *
2977      * @param array $header
2978      * @param bool $replace If true, will remove any existing headers before appending the new one.
2979      */
2980     public function setHeader($header) {
2981         if (is_array($header)) {
2982             foreach ($header as $v) {
2983                 $this->setHeader($v);
2984             }
2985         } else {
2986             // Remove newlines, they are not allowed in headers.
2987             $this->header[] = preg_replace('/[\r\n]/', '', $header);
2988         }
2989     }
2991     /**
2992      * Get HTTP Response Headers
2993      * @return array of arrays
2994      */
2995     public function getResponse() {
2996         return $this->response;
2997     }
2999     /**
3000      * Get raw HTTP Response Headers
3001      * @return array of strings
3002      */
3003     public function get_raw_response() {
3004         return $this->rawresponse;
3005     }
3007     /**
3008      * private callback function
3009      * Formatting HTTP Response Header
3010      *
3011      * We only keep the last headers returned. For example during a redirect the
3012      * redirect headers will not appear in {@link self::getResponse()}, if you need
3013      * to use those headers, refer to {@link self::get_raw_response()}.
3014      *
3015      * @param resource $ch Apparently not used
3016      * @param string $header
3017      * @return int The strlen of the header
3018      */
3019     private function formatHeader($ch, $header) {
3020         $this->rawresponse[] = $header;
3022         if (trim($header, "\r\n") === '') {
3023             // This must be the last header.
3024             $this->responsefinished = true;
3025         }
3027         if (strlen($header) > 2) {
3028             if ($this->responsefinished) {
3029                 // We still have headers after the supposedly last header, we must be
3030                 // in a redirect so let's empty the response to keep the last headers.
3031                 $this->responsefinished = false;
3032                 $this->response = array();
3033             }
3034             $parts = explode(" ", rtrim($header, "\r\n"), 2);
3035             $key = rtrim($parts[0], ':');
3036             $value = isset($parts[1]) ? $parts[1] : null;
3037             if (!empty($this->response[$key])) {
3038                 if (is_array($this->response[$key])) {
3039                     $this->response[$key][] = $value;
3040                 } else {
3041                     $tmp = $this->response[$key];
3042                     $this->response[$key] = array();
3043                     $this->response[$key][] = $tmp;
3044                     $this->response[$key][] = $value;
3046                 }
3047             } else {
3048                 $this->response[$key] = $value;
3049             }
3050         }
3051         return strlen($header);
3052     }
3054     /**
3055      * Set options for individual curl instance
3056      *
3057      * @param resource $curl A curl handle
3058      * @param array $options
3059      * @return resource The curl handle
3060      */
3061     private function apply_opt($curl, $options) {
3062         // Clean up
3063         $this->cleanopt();
3064         // set cookie
3065         if (!empty($this->cookie) || !empty($options['cookie'])) {
3066             $this->setopt(array('cookiejar'=>$this->cookie,
3067                             'cookiefile'=>$this->cookie
3068                              ));
3069         }
3071         // Bypass proxy if required.
3072         if ($this->proxy === null) {
3073             if (!empty($this->options['CURLOPT_URL']) and is_proxybypass($this->options['CURLOPT_URL'])) {
3074                 $proxy = false;
3075             } else {
3076                 $proxy = true;
3077             }
3078         } else {
3079             $proxy = (bool)$this->proxy;
3080         }
3082         // Set proxy.
3083         if ($proxy) {
3084             $options['CURLOPT_PROXY'] = $this->proxy_host;
3085         } else {
3086             unset($this->options['CURLOPT_PROXY']);
3087         }
3089         $this->setopt($options);
3091         // Reset before set options.
3092         curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
3094         // Setting the User-Agent based on options provided.
3095         $useragent = '';
3097         if (!empty($options['CURLOPT_USERAGENT'])) {
3098             $useragent = $options['CURLOPT_USERAGENT'];
3099         } else if (!empty($this->options['CURLOPT_USERAGENT'])) {
3100             $useragent = $this->options['CURLOPT_USERAGENT'];
3101         } else {
3102             $useragent = 'MoodleBot/1.0';
3103         }
3105         // Set headers.
3106         if (empty($this->header)) {
3107             $this->setHeader(array(
3108                 'User-Agent: ' . $useragent,
3109                 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
3110                 'Connection: keep-alive'
3111                 ));
3112         } else if (!in_array('User-Agent: ' . $useragent, $this->header)) {
3113             // Remove old User-Agent if one existed.
3114             // We have to partial search since we don't know what the original User-Agent is.
3115             if ($match = preg_grep('/User-Agent.*/', $this->header)) {
3116                 $key = array_keys($match)[0];
3117                 unset($this->header[$key]);
3118             }
3119             $this->setHeader(array('User-Agent: ' . $useragent));
3120         }
3121         curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
3123         if ($this->debug) {
3124             echo '<h1>Options</h1>';
3125             var_dump($this->options);
3126             echo '<h1>Header</h1>';
3127             var_dump($this->header);
3128         }
3130         // Do not allow infinite redirects.
3131         if (!isset($this->options['CURLOPT_MAXREDIRS'])) {
3132             $this->options['CURLOPT_MAXREDIRS'] = 0;
3133         } else if ($this->options['CURLOPT_MAXREDIRS'] > 100) {
3134             $this->options['CURLOPT_MAXREDIRS'] = 100;
3135         } else {
3136             $this->options['CURLOPT_MAXREDIRS'] = (int)$this->options['CURLOPT_MAXREDIRS'];
3137         }
3139         // Make sure we always know if redirects expected.
3140         if (!isset($this->options['CURLOPT_FOLLOWLOCATION'])) {
3141             $this->options['CURLOPT_FOLLOWLOCATION'] = 0;
3142         }
3144         // Limit the protocols to HTTP and HTTPS.
3145         if (defined('CURLOPT_PROTOCOLS')) {
3146             $this->options['CURLOPT_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS);
3147             $this->options['CURLOPT_REDIR_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS);
3148         }
3150         // Set options.
3151         foreach($this->options as $name => $val) {
3152             if ($name === 'CURLOPT_FOLLOWLOCATION' and $this->emulateredirects) {
3153                 // The redirects are emulated elsewhere.
3154                 curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 0);
3155                 continue;
3156             }
3157             $name = constant($name);
3158             curl_setopt($curl, $name, $val);
3159         }
3161         return $curl;
3162     }
3164     /**
3165      * Download multiple files in parallel
3166      *
3167      * Calls {@link multi()} with specific download headers
3168      *
3169      * <code>
3170      * $c = new curl();
3171      * $file1 = fopen('a', 'wb');
3172      * $file2 = fopen('b', 'wb');
3173      * $c->download(array(
3174      *     array('url'=>'http://localhost/', 'file'=>$file1),
3175      *     array('url'=>'http://localhost/20/', 'file'=>$file2)
3176      * ));
3177      * fclose($file1);
3178      * fclose($file2);
3179      * </code>
3180      *
3181      * or
3182      *
3183      * <code>
3184      * $c = new curl();
3185      * $c->download(array(
3186      *              array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3187      *              array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3188      *              ));
3189      * </code>
3190      *
3191      * @param array $requests An array of files to request {
3192      *                  url => url to download the file [required]
3193      *                  file => file handler, or
3194      *                  filepath => file path
3195      * }
3196      * If 'file' and 'filepath' parameters are both specified in one request, the
3197      * open file handle in the 'file' parameter will take precedence and 'filepath'
3198      * will be ignored.
3199      *
3200      * @param array $options An array of options to set
3201      * @return array An array of results
3202      */
3203     public function download($requests, $options = array()) {
3204         $options['RETURNTRANSFER'] = false;
3205         return $this->multi($requests, $options);
3206     }
3208     /**
3209      * Returns the current curl security helper.
3210      *
3211      * @return \core\files\curl_security_helper instance.
3212      */
3213     public function get_security() {
3214         return $this->securityhelper;
3215     }
3217     /**
3218      * Sets the curl security helper.
3219      *
3220      * @param \core\files\curl_security_helper $securityobject instance/subclass of the base curl_security_helper class.
3221      * @return bool true if the security helper could be set, false otherwise.
3222      */
3223     public function set_security($securityobject) {
3224         if ($securityobject instanceof \core\files\curl_security_helper) {
3225             $this->securityhelper = $securityobject;
3226             return true;
3227         }
3228         return false;
3229     }
3231     /**
3232      * Multi HTTP Requests
3233      * This function could run multi-requests in parallel.
3234      *
3235      * @param array $requests An array of files to request
3236      * @param array $options An array of options to set
3237      * @return array An array of results
3238      */
3239     protected function multi($requests, $options = array()) {
3240         $count   = count($requests);
3241         $handles = array();
3242         $results = array();
3243         $main    = curl_multi_init();
3244         for ($i = 0; $i < $count; $i++) {
3245             if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3246                 // open file
3247                 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3248                 $requests[$i]['auto-handle'] = true;
3249             }
3250             foreach($requests[$i] as $n=>$v) {
3251                 $options[$n] = $v;
3252             }
3253             $handles[$i] = curl_init($requests[$i]['url']);
3254             $this->apply_opt($handles[$i], $options);
3255             curl_multi_add_handle($main, $handles[$i]);
3256         }
3257         $running = 0;
3258         do {
3259             curl_multi_exec($main, $running);
3260         } while($running > 0);
3261         for ($i = 0; $i < $count; $i++) {
3262             if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3263                 $results[] = true;
3264             } else {
3265                 $results[] = curl_multi_getcontent($handles[$i]);
3266             }
3267             curl_multi_remove_handle($main, $handles[$i]);
3268         }
3269         curl_multi_close($main);
3271         for ($i = 0; $i < $count; $i++) {
3272             if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3273                 // close file handler if file is opened in this function
3274                 fclose($requests[$i]['file']);
3275             }
3276         }
3277         return $results;
3278     }
3280     /**
3281      * Helper function to reset the request state vars.
3282      *
3283      * @return void.
3284      */
3285     protected function reset_request_state_vars() {
3286         $this->info             = array();
3287         $this->error            = '';
3288         $this->errno            = 0;
3289         $this->response         = array();
3290         $this->rawresponse      = array();
3291         $this->responsefinished = false;
3292     }
3294     /**
3295      * For use only in unit tests - we can pre-set the next curl response.
3296      * This is useful for unit testing APIs that call external systems.
3297      * @param string $response
3298      */
3299     public static function mock_response($response) {
3300         if ((defined('PHPUNIT_TEST') && PHPUNIT_TEST)) {
3301             array_push(self::$mockresponses, $response);
3302         } else {
3303             throw new coding_excpetion('mock_response function is only available for unit tests.');
3304         }
3305     }
3307     /**
3308      * Single HTTP Request
3309      *
3310      * @param string $url The URL to request
3311      * @param array $options
3312      * @return bool
3313      */
3314     protected function request($url, $options = array()) {
3315         // Reset here so that the data is valid when result returned from cache, or if we return due to a blacklist hit.
3316         $this->reset_request_state_vars();
3318         if ((defined('PHPUNIT_TEST') && PHPUNIT_TEST)) {
3319             if ($mockresponse = array_pop(self::$mockresponses)) {
3320                 $this->info = [ 'http_code' => 200 ];
3321                 return $mockresponse;
3322             }
3323         }
3325         // If curl security is enabled, check the URL against the blacklist before calling curl_exec.
3326         // Note: This will only check the base url. In the case of redirects, the blacklist is also after the curl_exec.
3327         if (!$this->ignoresecurity && $this->securityhelper->url_is_blocked($url)) {
3328             $this->error = $this->securityhelper->get_blocked_url_string();
3329             return $this->error;
3330         }
3332         // Set the URL as a curl option.
3333         $this->setopt(array('CURLOPT_URL' => $url));
3335         // Create curl instance.
3336         $curl = curl_init();
3338         $this->apply_opt($curl, $options);
3339         if ($this->cache && $ret = $this->cache->get($this->options)) {
3340             return $ret;
3341         }
3343         $ret = curl_exec($curl);
3344         $this->info  = curl_getinfo($curl);
3345         $this->error = curl_error($curl);
3346         $this->errno = curl_errno($curl);
3347         // Note: $this->response and $this->rawresponse are filled by $hits->formatHeader callback.
3349         // In the case of redirects (which curl blindly follows), check the post-redirect URL against the blacklist entries too.
3350         if (intval($this->info['redirect_count']) > 0 && !$this->ignoresecurity
3351             && $this->securityhelper->url_is_blocked($this->info['url'])) {
3352             $this->reset_request_state_vars();
3353             $this->error = $this->securityhelper->get_blocked_url_string();
3354             curl_close($curl);
3355             return $this->error;
3356         }
3358         if ($this->emulateredirects and $this->options['CURLOPT_FOLLOWLOCATION'] and $this->info['http_code'] != 200) {
3359             $redirects = 0;
3361             while($redirects <= $this->options['CURLOPT_MAXREDIRS']) {
3363                 if ($this->info['http_code'] == 301) {
3364                     // Moved Permanently - repeat the same request on new URL.
3366                 } else if ($this->info['http_code'] == 302) {
3367                     // Found - the standard redirect - repeat the same request on new URL.
3369                 } else if ($this->info['http_code'] == 303) {
3370                     // 303 See Other - repeat only if GET, do not bother with POSTs.
3371                     if (empty($this->options['CURLOPT_HTTPGET'])) {
3372                         break;
3373                     }
3375                 } else if ($this->info['http_code'] == 307) {
3376                     // Temporary Redirect - must repeat using the same request type.
3378                 } else if ($this->info['http_code'] == 308) {
3379                     // Permanent Redirect - must repeat using the same request type.
3381                 } else {
3382                     // Some other http code means do not retry!
3383                     break;
3384                 }
3386                 $redirects++;
3388                 $redirecturl = null;
3389                 if (isset($this->info['redirect_url'])) {
3390                     if (preg_match('|^https?://|i', $this->info['redirect_url'])) {
3391                         $redirecturl = $this->info['redirect_url'];
3392                     }
3393                 }
3394                 if (!$redirecturl) {
3395                     foreach ($this->response as $k => $v) {
3396                         if (strtolower($k) === 'location') {
3397                             $redirecturl = $v;
3398                             break;
3399                         }
3400                     }
3401                     if (preg_match('|^https?://|i', $redirecturl)) {
3402                         // Great, this is the correct location format!
3404                     } else if ($redirecturl) {
3405                         $current = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL);
3406                         if (strpos($redirecturl, '/') === 0) {
3407                             // Relative to server root - just guess.
3408                             $pos = strpos('/', $current, 8);
3409                             if ($pos === false) {
3410                                 $redirecturl = $current.$redirecturl;
3411                             } else {
3412                                 $redirecturl = substr($current, 0, $pos).$redirecturl;
3413                             }
3414                         } else {
3415                             // Relative to current script.
3416                             $redirecturl = dirname($current).'/'.$redirecturl;
3417                         }
3418                     }
3419                 }
3421                 curl_setopt($curl, CURLOPT_URL, $redirecturl);
3422                 $ret = curl_exec($curl);
3424                 $this->info  = curl_getinfo($curl);
3425                 $this->error = curl_error($curl);
3426                 $this->errno = curl_errno($curl);
3428                 $this->info['redirect_count'] = $redirects;
3430                 if ($this->info['http_code'] === 200) {
3431                     // Finally this is what we wanted.
3432                     break;
3433                 }
3434                 if ($this->errno != CURLE_OK) {
3435                     // Something wrong is going on.
3436                     break;
3437                 }
3438             }
3439             if ($redirects > $this->options['CURLOPT_MAXREDIRS']) {
3440                 $this->errno = CURLE_TOO_MANY_REDIRECTS;
3441                 $this->error = 'Maximum ('.$this->options['CURLOPT_MAXREDIRS'].') redirects followed';
3442             }
3443         }
3445         if ($this->cache) {
3446             $this->cache->set($this->options, $ret);
3447         }
3449         if ($this->debug) {
3450             echo '<h1>Return Data</h1>';
3451             var_dump($ret);
3452             echo '<h1>Info</h1>';
3453             var_dump($this->info);
3454             echo '<h1>Error</h1>';
3455             var_dump($this->error);
3456         }
3458         curl_close($curl);
3460         if (empty($this->error)) {
3461             return $ret;
3462         } else {
3463             return $this->error;
3464             // exception is not ajax friendly
3465             //throw new moodle_exception($this->error, 'curl');
3466         }
3467     }
3469     /**
3470      * HTTP HEAD method
3471      *
3472      * @see request()
3473      *
3474      * @param string $url
3475      * @param array $options
3476      * @return bool
3477      */
3478     public function head($url, $options = array()) {
3479         $options['CURLOPT_HTTPGET'] = 0;
3480         $options['CURLOPT_HEADER']  = 1;
3481         $options['CURLOPT_NOBODY']  = 1;
3482         return $this->request($url, $options);
3483     }
3485     /**
3486      * HTTP PATCH method
3487      *
3488      * @param string $url
3489      * @param array|string $params
3490      * @param array $options
3491      * @return bool
3492      */
3493     public function patch($url, $params = '', $options = array()) {
3494         $options['CURLOPT_CUSTOMREQUEST'] = 'PATCH';
3495         if (is_array($params)) {
3496             $this->_tmp_file_post_params = array();
3497             foreach ($params as $key => $value) {
3498                 if ($value instanceof stored_file) {
3499                     $value->add_to_curl_request($this, $key);
3500                 } else {
3501                     $this->_tmp_file_post_params[$key] = $value;
3502                 }
3503             }
3504             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3505             unset($this->_tmp_file_post_params);
3506         } else {
3507             // The variable $params is the raw post data.
3508             $options['CURLOPT_POSTFIELDS'] = $params;
3509         }
3510         return $this->request($url, $options);
3511     }
3513     /**
3514      * HTTP POST method
3515      *
3516      * @param string $url
3517      * @param array|string $params
3518      * @param array $options
3519      * @return bool
3520      */
3521     public function post($url, $params = '', $options = array()) {
3522         $options['CURLOPT_POST']       = 1;
3523         if (is_array($params)) {
3524             $this->_tmp_file_post_params = array();
3525             foreach ($params as $key => $value) {
3526                 if ($value instanceof stored_file) {
3527                     $value->add_to_curl_request($this, $key);
3528                 } else {
3529                     $this->_tmp_file_post_params[$key] = $value;
3530                 }
3531             }
3532             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3533             unset($this->_tmp_file_post_params);
3534         } else {
3535             // $params is the raw post data
3536             $options['CURLOPT_POSTFIELDS'] = $params;
3537         }
3538         return $this->request($url, $options);
3539     }
3541     /**
3542      * HTTP GET method
3543      *
3544      * @param string $url
3545      * @param array $params
3546      * @param array $options
3547      * @return bool
3548      */
3549     public function get($url, $params = array(), $options = array()) {
3550         $options['CURLOPT_HTTPGET'] = 1;
3552         if (!empty($params)) {
3553             $url .= (stripos($url, '?') !== false) ? '&' : '?';
3554             $url .= http_build_query($params, '', '&');
3555         }
3556         return $this->request($url, $options);
3557     }
3559     /**
3560      * Downloads one file and writes it to the specified file handler
3561      *
3562      * <code>
3563      * $c = new curl();
3564      * $file = fopen('savepath', 'w');
3565      * $result = $c->download_one('http://localhost/', null,
3566      *   array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3567      * fclose($file);
3568      * $download_info = $c->get_info();
3569      * if ($result === true) {
3570      *   // file downloaded successfully
3571      * } else {
3572      *   $error_text = $result;
3573      *   $error_code = $c->get_errno();