2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Functions for file handling.
21 * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 defined('MOODLE_INTERNAL') ||
die();
28 * BYTESERVING_BOUNDARY - string unique string constant.
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
34 * Do not process file merging when working with draft area files.
36 define('IGNORE_FILE_MERGE', -1);
39 * Unlimited area size constant
41 define('FILE_AREA_MAX_BYTES_UNLIMITED', -1);
44 * Capacity of the draft area bucket when using the leaking bucket technique to limit the draft upload rate.
46 define('DRAFT_AREA_BUCKET_CAPACITY', 50);
49 * Leaking rate of the draft area bucket when using the leaking bucket technique to limit the draft upload rate.
51 define('DRAFT_AREA_BUCKET_LEAK', 0.2);
53 require_once("$CFG->libdir/filestorage/file_exceptions.php");
54 require_once("$CFG->libdir/filestorage/file_storage.php");
55 require_once("$CFG->libdir/filestorage/zip_packer.php");
56 require_once("$CFG->libdir/filebrowser/file_browser.php");
59 * Encodes file serving url
61 * @deprecated use moodle_url factory methods instead
63 * @todo MDL-31071 deprecate this function
64 * @global stdClass $CFG
65 * @param string $urlbase
66 * @param string $path /filearea/itemid/dir/dir/file.exe
67 * @param bool $forcedownload
68 * @param bool $https https url required
69 * @return string encoded file url
71 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
74 //TODO: deprecate this
76 if ($CFG->slasharguments
) {
77 $parts = explode('/', $path);
78 $parts = array_map('rawurlencode', $parts);
79 $path = implode('/', $parts);
80 $return = $urlbase.$path;
82 $return .= '?forcedownload=1';
85 $path = rawurlencode($path);
86 $return = $urlbase.'?file='.$path;
88 $return .= '&forcedownload=1';
93 $return = str_replace('http://', 'https://', $return);
100 * Detects if area contains subdirs,
101 * this is intended for file areas that are attached to content
102 * migrated from 1.x where subdirs were allowed everywhere.
104 * @param context $context
105 * @param string $component
106 * @param string $filearea
107 * @param string $itemid
110 function file_area_contains_subdirs(context
$context, $component, $filearea, $itemid) {
113 if (!isset($itemid)) {
114 // Not initialised yet.
118 // Detect if any directories are already present, this is necessary for content upgraded from 1.x.
119 $select = "contextid = :contextid AND component = :component AND filearea = :filearea AND itemid = :itemid AND filepath <> '/' AND filename = '.'";
120 $params = array('contextid'=>$context->id
, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
121 return $DB->record_exists_select('files', $select, $params);
125 * Prepares 'editor' formslib element from data in database
127 * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
128 * function then copies the embedded files into draft area (assigning itemids automatically),
129 * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
131 * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
132 * your mform's set_data() supplying the object returned by this function.
135 * @param stdClass $data database field that holds the html text with embedded media
136 * @param string $field the name of the database field that holds the html text with embedded media
137 * @param array $options editor options (like maxifiles, maxbytes etc.)
138 * @param stdClass $context context of the editor
139 * @param string $component
140 * @param string $filearea file area name
141 * @param int $itemid item id, required if item exists
142 * @return stdClass modified data object
144 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
145 $options = (array)$options;
146 if (!isset($options['trusttext'])) {
147 $options['trusttext'] = false;
149 if (!isset($options['forcehttps'])) {
150 $options['forcehttps'] = false;
152 if (!isset($options['subdirs'])) {
153 $options['subdirs'] = false;
155 if (!isset($options['maxfiles'])) {
156 $options['maxfiles'] = 0; // no files by default
158 if (!isset($options['noclean'])) {
159 $options['noclean'] = false;
162 //sanity check for passed context. This function doesn't expect $option['context'] to be set
163 //But this function is called before creating editor hence, this is one of the best places to check
164 //if context is used properly. This check notify developer that they missed passing context to editor.
165 if (isset($context) && !isset($options['context'])) {
166 //if $context is not null then make sure $option['context'] is also set.
167 debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER
);
168 } else if (isset($options['context']) && isset($context)) {
169 //If both are passed then they should be equal.
170 if ($options['context']->id
!= $context->id
) {
171 $exceptionmsg = 'Editor context ['.$options['context']->id
.'] is not equal to passed context ['.$context->id
.']';
172 throw new coding_exception($exceptionmsg);
176 if (is_null($itemid) or is_null($context)) {
180 $data = new stdClass();
182 if (!isset($data->{$field})) {
183 $data->{$field} = '';
185 if (!isset($data->{$field.'format'})) {
186 $data->{$field.'format'} = editors_get_preferred_format();
188 if (!$options['noclean']) {
189 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
193 if ($options['trusttext']) {
194 // noclean ignored if trusttext enabled
195 if (!isset($data->{$field.'trust'})) {
196 $data->{$field.'trust'} = 0;
198 $data = trusttext_pre_edit($data, $field, $context);
200 if (!$options['noclean']) {
201 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
204 $contextid = $context->id
;
207 if ($options['maxfiles'] != 0) {
208 $draftid_editor = file_get_submitted_draft_itemid($field);
209 $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
210 $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
212 $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
219 * Prepares the content of the 'editor' form element with embedded media files to be saved in database
221 * This function moves files from draft area to the destination area and
222 * encodes URLs to the draft files so they can be safely saved into DB. The
223 * form has to contain the 'editor' element named foobar_editor, where 'foobar'
224 * is the name of the database field to hold the wysiwyg editor content. The
225 * editor data comes as an array with text, format and itemid properties. This
226 * function automatically adds $data properties foobar, foobarformat and
227 * foobartrust, where foobar has URL to embedded files encoded.
230 * @param stdClass $data raw data submitted by the form
231 * @param string $field name of the database field containing the html with embedded media files
232 * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
233 * @param stdClass $context context, required for existing data
234 * @param string $component file component
235 * @param string $filearea file area name
236 * @param int $itemid item id, required if item exists
237 * @return stdClass modified data object
239 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
240 $options = (array)$options;
241 if (!isset($options['trusttext'])) {
242 $options['trusttext'] = false;
244 if (!isset($options['forcehttps'])) {
245 $options['forcehttps'] = false;
247 if (!isset($options['subdirs'])) {
248 $options['subdirs'] = false;
250 if (!isset($options['maxfiles'])) {
251 $options['maxfiles'] = 0; // no files by default
253 if (!isset($options['maxbytes'])) {
254 $options['maxbytes'] = 0; // unlimited
256 if (!isset($options['removeorphaneddrafts'])) {
257 $options['removeorphaneddrafts'] = false; // Don't remove orphaned draft files by default.
260 if ($options['trusttext']) {
261 $data->{$field.'trust'} = trusttext_trusted($context);
263 $data->{$field.'trust'} = 0;
266 $editor = $data->{$field.'_editor'};
268 if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
269 $data->{$field} = $editor['text'];
271 // Clean the user drafts area of any files not referenced in the editor text.
272 if ($options['removeorphaneddrafts']) {
273 file_remove_editor_orphaned_files($editor);
275 $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id
, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
277 $data->{$field.'format'} = $editor['format'];
283 * Saves text and files modified by Editor formslib element
286 * @param stdClass $data $database entry field
287 * @param string $field name of data field
288 * @param array $options various options
289 * @param stdClass $context context - must already exist
290 * @param string $component
291 * @param string $filearea file area name
292 * @param int $itemid must already exist, usually means data is in db
293 * @return stdClass modified data obejct
295 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
296 $options = (array)$options;
297 if (!isset($options['subdirs'])) {
298 $options['subdirs'] = false;
300 if (is_null($itemid) or is_null($context)) {
304 $contextid = $context->id
;
307 $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
308 file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
309 $data->{$field.'_filemanager'} = $draftid_editor;
315 * Saves files modified by File manager formslib element
317 * @todo MDL-31073 review this function
319 * @param stdClass $data $database entry field
320 * @param string $field name of data field
321 * @param array $options various options
322 * @param stdClass $context context - must already exist
323 * @param string $component
324 * @param string $filearea file area name
325 * @param int $itemid must already exist, usually means data is in db
326 * @return stdClass modified data obejct
328 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
329 $options = (array)$options;
330 if (!isset($options['subdirs'])) {
331 $options['subdirs'] = false;
333 if (!isset($options['maxfiles'])) {
334 $options['maxfiles'] = -1; // unlimited
336 if (!isset($options['maxbytes'])) {
337 $options['maxbytes'] = 0; // unlimited
340 if (empty($data->{$field.'_filemanager'})) {
344 file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id
, $component, $filearea, $itemid, $options);
345 $fs = get_file_storage();
347 if ($fs->get_area_files($context->id
, $component, $filearea, $itemid)) {
348 $data->$field = '1'; // TODO: this is an ugly hack (skodak)
358 * Generate a draft itemid
361 * @global moodle_database $DB
362 * @global stdClass $USER
363 * @return int a random but available draft itemid that can be used to create a new draft
366 function file_get_unused_draft_itemid() {
369 if (isguestuser() or !isloggedin()) {
370 // guests and not-logged-in users can not be allowed to upload anything!!!!!!
371 print_error('noguest');
374 $contextid = context_user
::instance($USER->id
)->id
;
376 $fs = get_file_storage();
377 $draftitemid = rand(1, 999999999);
378 while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
379 $draftitemid = rand(1, 999999999);
386 * Initialise a draft file area from a real one by copying the files. A draft
387 * area will be created if one does not already exist. Normally you should
388 * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
391 * @global stdClass $CFG
392 * @global stdClass $USER
393 * @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.
394 * @param int $contextid This parameter and the next two identify the file area to copy files from.
395 * @param string $component
396 * @param string $filearea helps indentify the file area.
397 * @param int $itemid helps identify the file area. Can be null if there are no files yet.
398 * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
399 * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
400 * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
402 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
405 $options = (array)$options;
406 if (!isset($options['subdirs'])) {
407 $options['subdirs'] = false;
409 if (!isset($options['forcehttps'])) {
410 $options['forcehttps'] = false;
413 $usercontext = context_user
::instance($USER->id
);
414 $fs = get_file_storage();
416 if (empty($draftitemid)) {
417 // create a new area and copy existing files into
418 $draftitemid = file_get_unused_draft_itemid();
419 $file_record = array('contextid'=>$usercontext->id
, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
420 if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
421 foreach ($files as $file) {
422 if ($file->is_directory() and $file->get_filepath() === '/') {
423 // we need a way to mark the age of each draft area,
424 // by not copying the root dir we force it to be created automatically with current timestamp
427 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
430 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
431 // XXX: This is a hack for file manager (MDL-28666)
432 // File manager needs to know the original file information before copying
433 // to draft area, so we append these information in mdl_files.source field
434 // {@link file_storage::search_references()}
435 // {@link file_storage::search_references_count()}
436 $sourcefield = $file->get_source();
437 $newsourcefield = new stdClass
;
438 $newsourcefield->source
= $sourcefield;
439 $original = new stdClass
;
440 $original->contextid
= $contextid;
441 $original->component
= $component;
442 $original->filearea
= $filearea;
443 $original->itemid
= $itemid;
444 $original->filename
= $file->get_filename();
445 $original->filepath
= $file->get_filepath();
446 $newsourcefield->original
= file_storage
::pack_reference($original);
447 $draftfile->set_source(serialize($newsourcefield));
448 // End of file manager hack
451 if (!is_null($text)) {
452 // at this point there should not be any draftfile links yet,
453 // because this is a new text from database that should still contain the @@pluginfile@@ links
454 // this happens when developers forget to post process the text
455 $text = str_replace("\"$CFG->wwwroot/draftfile.php", "\"$CFG->wwwroot/brokenfile.php#", $text);
461 if (is_null($text)) {
465 // relink embedded files - editor can not handle @@PLUGINFILE@@ !
466 return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id
, 'user', 'draft', $draftitemid, $options);
470 * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
471 * Passing a new option reverse = true in the $options var will make the function to convert actual URLs in $text to encoded URLs
472 * in the @@PLUGINFILE@@ form.
474 * @param string $text The content that may contain ULRs in need of rewriting.
475 * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
476 * @param int $contextid This parameter and the next two identify the file area to use.
477 * @param string $component
478 * @param string $filearea helps identify the file area.
479 * @param int $itemid helps identify the file area.
480 * @param array $options
481 * bool $options.forcehttps Force the user of https
482 * bool $options.reverse Reverse the behaviour of the function
483 * mixed $options.includetoken Use a token for authentication. True for current user, int value for other user id.
484 * string The processed text.
486 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
489 $options = (array)$options;
490 if (!isset($options['forcehttps'])) {
491 $options['forcehttps'] = false;
494 $baseurl = "{$CFG->wwwroot}/{$file}";
495 if (!empty($options['includetoken'])) {
496 $userid = $options['includetoken'] === true ?
$USER->id
: $options['includetoken'];
497 $token = get_user_key('core_files', $userid);
498 $finalfile = basename($file);
499 $tokenfile = "token{$finalfile}";
500 $file = substr($file, 0, strlen($file) - strlen($finalfile)) . $tokenfile;
501 $baseurl = "{$CFG->wwwroot}/{$file}";
503 if (!$CFG->slasharguments
) {
504 $baseurl .= "?token={$token}&file=";
506 $baseurl .= "/{$token}";
510 $baseurl .= "/{$contextid}/{$component}/{$filearea}/";
512 if ($itemid !== null) {
513 $baseurl .= "$itemid/";
516 if ($options['forcehttps']) {
517 $baseurl = str_replace('http://', 'https://', $baseurl);
520 if (!empty($options['reverse'])) {
521 return str_replace($baseurl, '@@PLUGINFILE@@/', $text);
523 return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
528 * Returns information about files in a draft area.
530 * @global stdClass $CFG
531 * @global stdClass $USER
532 * @param int $draftitemid the draft area item id.
533 * @param string $filepath path to the directory from which the information have to be retrieved.
534 * @return array with the following entries:
535 * 'filecount' => number of files in the draft area.
536 * 'filesize' => total size of the files in the draft area.
537 * 'foldercount' => number of folders in the draft area.
538 * 'filesize_without_references' => total size of the area excluding file references.
539 * (more information will be added as needed).
541 function file_get_draft_area_info($draftitemid, $filepath = '/') {
544 $usercontext = context_user
::instance($USER->id
);
545 return file_get_file_area_info($usercontext->id
, 'user', 'draft', $draftitemid, $filepath);
549 * Returns information about files in an area.
551 * @param int $contextid context id
552 * @param string $component component
553 * @param string $filearea file area name
554 * @param int $itemid item id or all files if not specified
555 * @param string $filepath path to the directory from which the information have to be retrieved.
556 * @return array with the following entries:
557 * 'filecount' => number of files in the area.
558 * 'filesize' => total size of the files in the area.
559 * 'foldercount' => number of folders in the area.
560 * 'filesize_without_references' => total size of the area excluding file references.
563 function file_get_file_area_info($contextid, $component, $filearea, $itemid = 0, $filepath = '/') {
565 $fs = get_file_storage();
571 'filesize_without_references' => 0
574 $draftfiles = $fs->get_directory_files($contextid, $component, $filearea, $itemid, $filepath, true, true);
576 foreach ($draftfiles as $file) {
577 if ($file->is_directory()) {
578 $results['foldercount'] +
= 1;
580 $results['filecount'] +
= 1;
583 $filesize = $file->get_filesize();
584 $results['filesize'] +
= $filesize;
585 if (!$file->is_external_file()) {
586 $results['filesize_without_references'] +
= $filesize;
594 * Returns whether a draft area has exceeded/will exceed its size limit.
596 * Please note that the unlimited value for $areamaxbytes is -1 {@link FILE_AREA_MAX_BYTES_UNLIMITED}, not 0.
598 * @param int $draftitemid the draft area item id.
599 * @param int $areamaxbytes the maximum size allowed in this draft area.
600 * @param int $newfilesize the size that would be added to the current area.
601 * @param bool $includereferences true to include the size of the references in the area size.
602 * @return bool true if the area will/has exceeded its limit.
605 function file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $newfilesize = 0, $includereferences = false) {
606 if ($areamaxbytes != FILE_AREA_MAX_BYTES_UNLIMITED
) {
607 $draftinfo = file_get_draft_area_info($draftitemid);
608 $areasize = $draftinfo['filesize_without_references'];
609 if ($includereferences) {
610 $areasize = $draftinfo['filesize'];
612 if ($areasize +
$newfilesize > $areamaxbytes) {
620 * Returns whether a user has reached their draft area upload rate.
622 * @param int $userid The user id
625 function file_is_draft_areas_limit_reached(int $userid): bool {
628 $capacity = $CFG->draft_area_bucket_capacity ?? DRAFT_AREA_BUCKET_CAPACITY
;
629 $leak = $CFG->draft_area_bucket_leak ?? DRAFT_AREA_BUCKET_LEAK
;
631 $since = time() - floor($capacity / $leak); // The items that were in the bucket before this time are already leaked by now.
632 // We are going to be a bit generous to the user when using the leaky bucket
633 // algorithm below. We are going to assume that the bucket is empty at $since.
634 // We have to do an assumption here unless we really want to get ALL user's draft
635 // items without any limit and put all of them in the leaking bucket.
636 // I decided to favour performance over accuracy here.
638 $fs = get_file_storage();
639 $items = $fs->get_user_draft_items($userid, $since);
640 $items = array_reverse($items); // So that the items are sorted based on time in the ascending direction.
642 // We only need to store the time that each element in the bucket is going to leak. So $bucket is array of leaking times.
644 foreach ($items as $item) {
645 $now = $item->timemodified
;
646 // First let's see if items can be dropped from the bucket as a result of leakage.
647 while (!empty($bucket) && ($now >= $bucket[0])) {
648 array_shift($bucket);
651 // Calculate the time that the new item we put into the bucket will be leaked from it, and store it into the bucket.
653 $bucket[] = max($bucket[count($bucket) - 1], $now) +
(1 / $leak);
655 $bucket[] = $now +
(1 / $leak);
659 // Recalculate the bucket's content based on the leakage until now.
661 while (!empty($bucket) && ($now >= $bucket[0])) {
662 array_shift($bucket);
665 return count($bucket) >= $capacity;
669 * Get used space of files
670 * @global moodle_database $DB
671 * @global stdClass $USER
672 * @return int total bytes
674 function file_get_user_used_space() {
677 $usercontext = context_user
::instance($USER->id
);
678 $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
679 JOIN (SELECT contenthash, filename, MAX(id) AS id
681 WHERE contextid = ? AND component = ? AND filearea != ?
682 GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
683 $params = array('contextid'=>$usercontext->id
, 'component'=>'user', 'filearea'=>'draft');
684 $record = $DB->get_record_sql($sql, $params);
685 return (int)$record->totalbytes
;
689 * Convert any string to a valid filepath
690 * @todo review this function
692 * @return string path
694 function file_correct_filepath($str) { //TODO: what is this? (skodak) - No idea (Fred)
695 if ($str == '/' or empty($str)) {
698 return '/'.trim($str, '/').'/';
703 * Generate a folder tree of draft area of current USER recursively
705 * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
706 * @param int $draftitemid
707 * @param string $filepath
710 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
711 global $USER, $OUTPUT, $CFG;
712 $data->children
= array();
713 $context = context_user
::instance($USER->id
);
714 $fs = get_file_storage();
715 if ($files = $fs->get_directory_files($context->id
, 'user', 'draft', $draftitemid, $filepath, false)) {
716 foreach ($files as $file) {
717 if ($file->is_directory()) {
718 $item = new stdClass();
719 $item->sortorder
= $file->get_sortorder();
720 $item->filepath
= $file->get_filepath();
722 $foldername = explode('/', trim($item->filepath
, '/'));
723 $item->fullname
= trim(array_pop($foldername), '/');
725 $item->id
= uniqid();
726 file_get_drafarea_folders($draftitemid, $item->filepath
, $item);
727 $data->children
[] = $item;
736 * Listing all files (including folders) in current path (draft area)
737 * used by file manager
738 * @param int $draftitemid
739 * @param string $filepath
742 function file_get_drafarea_files($draftitemid, $filepath = '/') {
743 global $USER, $OUTPUT, $CFG;
745 $context = context_user
::instance($USER->id
);
746 $fs = get_file_storage();
748 $data = new stdClass();
749 $data->path
= array();
750 $data->path
[] = array('name'=>get_string('files'), 'path'=>'/');
752 // will be used to build breadcrumb
754 if ($filepath !== '/') {
755 $filepath = file_correct_filepath($filepath);
756 $parts = explode('/', $filepath);
757 foreach ($parts as $part) {
758 if ($part != '' && $part != null) {
759 $trail .= ($part.'/');
760 $data->path
[] = array('name'=>$part, 'path'=>$trail);
767 if ($files = $fs->get_directory_files($context->id
, 'user', 'draft', $draftitemid, $filepath, false)) {
768 foreach ($files as $file) {
769 $item = new stdClass();
770 $item->filename
= $file->get_filename();
771 $item->filepath
= $file->get_filepath();
772 $item->fullname
= trim($item->filename
, '/');
773 $filesize = $file->get_filesize();
774 $item->size
= $filesize ?
$filesize : null;
775 $item->filesize
= $filesize ?
display_size($filesize) : '';
777 $item->sortorder
= $file->get_sortorder();
778 $item->author
= $file->get_author();
779 $item->license
= $file->get_license();
780 $item->datemodified
= $file->get_timemodified();
781 $item->datecreated
= $file->get_timecreated();
782 $item->isref
= $file->is_external_file();
783 if ($item->isref
&& $file->get_status() == 666) {
784 $item->originalmissing
= true;
786 // find the file this draft file was created from and count all references in local
787 // system pointing to that file
788 $source = @unserialize
($file->get_source());
789 if (isset($source->original
)) {
790 $item->refcount
= $fs->search_references_count($source->original
);
793 if ($file->is_directory()) {
795 $item->icon
= $OUTPUT->image_url(file_folder_icon(24))->out(false);
796 $item->type
= 'folder';
797 $foldername = explode('/', trim($item->filepath
, '/'));
798 $item->fullname
= trim(array_pop($foldername), '/');
799 $item->thumbnail
= $OUTPUT->image_url(file_folder_icon(90))->out(false);
801 // do NOT use file browser here!
802 $item->mimetype
= get_mimetype_description($file);
803 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
806 $item->type
= 'file';
808 $itemurl = moodle_url
::make_draftfile_url($draftitemid, $item->filepath
, $item->filename
);
809 $item->url
= $itemurl->out();
810 $item->icon
= $OUTPUT->image_url(file_file_icon($file, 24))->out(false);
811 $item->thumbnail
= $OUTPUT->image_url(file_file_icon($file, 90))->out(false);
813 // The call to $file->get_imageinfo() fails with an exception if the file can't be read on the file system.
814 // We still want to add such files to the list, so the owner can view and delete them if needed. So, we only call
815 // get_imageinfo() on files that can be read, and we also spoof the file status based on whether it was found.
816 // We'll use the same status types used by stored_file->get_status(), where 0 = OK. 1 = problem, as these will be
817 // used by the widget to display a warning about the problem files.
818 // The value of stored_file->get_status(), and the file record are unaffected by this. It's only superficially set.
819 $item->status
= $fs->get_file_system()->is_file_readable_remotely_by_storedfile($file) ?
0 : 1;
820 if ($item->status
== 0) {
821 if ($imageinfo = $file->get_imageinfo()) {
822 $item->realthumbnail
= $itemurl->out(false, array('preview' => 'thumb',
823 'oid' => $file->get_timemodified()));
824 $item->realicon
= $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
825 $item->image_width
= $imageinfo['width'];
826 $item->image_height
= $imageinfo['height'];
833 $data->itemid
= $draftitemid;
839 * Returns all of the files in the draftarea.
841 * @param int $draftitemid The draft item ID
842 * @param string $filepath path for the uploaded files.
843 * @return array An array of files associated with this draft item id.
845 function file_get_all_files_in_draftarea(int $draftitemid, string $filepath = '/') : array {
847 $draftfiles = file_get_drafarea_files($draftitemid, $filepath);
848 file_get_drafarea_folders($draftitemid, $filepath, $draftfiles);
850 if (!empty($draftfiles)) {
851 foreach ($draftfiles->list as $draftfile) {
852 if ($draftfile->type
== 'file') {
853 $files[] = $draftfile;
857 if (isset($draftfiles->children
)) {
858 foreach ($draftfiles->children
as $draftfile) {
859 $files = array_merge($files, file_get_all_files_in_draftarea($draftitemid, $draftfile->filepath
));
867 * Returns draft area itemid for a given element.
870 * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
871 * @return int the itemid, or 0 if there is not one yet.
873 function file_get_submitted_draft_itemid($elname) {
874 // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
875 if (!isset($_REQUEST[$elname])) {
878 if (is_array($_REQUEST[$elname])) {
879 $param = optional_param_array($elname, 0, PARAM_INT
);
880 if (!empty($param['itemid'])) {
881 $param = $param['itemid'];
883 debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER
);
888 $param = optional_param($elname, 0, PARAM_INT
);
899 * Restore the original source field from draft files
901 * Do not use this function because it makes field files.source inconsistent
902 * for draft area files. This function will be deprecated in 2.6
904 * @param stored_file $storedfile This only works with draft files
905 * @return stored_file
907 function file_restore_source_field_from_draft_file($storedfile) {
908 $source = @unserialize
($storedfile->get_source());
909 if (!empty($source)) {
910 if (is_object($source)) {
911 $restoredsource = $source->source
;
912 $storedfile->set_source($restoredsource);
914 throw new moodle_exception('invalidsourcefield', 'error');
921 * Removes those files from the user drafts filearea which are not referenced in the editor text.
923 * @param stdClass $editor The online text editor element from the submitted form data.
925 function file_remove_editor_orphaned_files($editor) {
928 // Find those draft files included in the text, and generate their hashes.
929 $context = context_user
::instance($USER->id
);
930 $baseurl = $CFG->wwwroot
. '/draftfile.php/' . $context->id
. '/user/draft/' . $editor['itemid'] . '/';
931 $pattern = "/" . preg_quote($baseurl, '/') . "(.+?)[\?\"']/";
932 preg_match_all($pattern, $editor['text'], $matches);
933 $usedfilehashes = [];
934 foreach ($matches[1] as $matchedfilename) {
935 $matchedfilename = urldecode($matchedfilename);
936 $usedfilehashes[] = \file_storage
::get_pathname_hash($context->id
, 'user', 'draft', $editor['itemid'], '/',
940 // Now, compare the hashes of all draft files, and remove those which don't match used files.
941 $fs = get_file_storage();
942 $files = $fs->get_area_files($context->id
, 'user', 'draft', $editor['itemid'], 'id', false);
943 foreach ($files as $file) {
944 $tmphash = $file->get_pathnamehash();
945 if (!in_array($tmphash, $usedfilehashes)) {
952 * Finds all draft areas used in a textarea and copies the files into the primary textarea. If a user copies and pastes
953 * content from another draft area it's possible for a single textarea to reference multiple draft areas.
956 * @param int $draftitemid the id of the primary draft area.
957 * When set to -1 (probably, by a WebService) it won't process file merging, keeping the original state of the file area.
958 * @param int $usercontextid the user's context id.
959 * @param string $text some html content that needs to have files copied to the correct draft area.
960 * @param bool $forcehttps force https urls.
962 * @return string $text html content modified with new draft links
964 function file_merge_draft_areas($draftitemid, $usercontextid, $text, $forcehttps = false) {
965 if (is_null($text)) {
969 // Do not merge files, leave it as it was.
970 if ($draftitemid === IGNORE_FILE_MERGE
) {
974 $urls = extract_draft_file_urls_from_text($text, $forcehttps, $usercontextid, 'user', 'draft');
976 // No draft areas to rewrite.
981 foreach ($urls as $url) {
982 // Do not process the "home" draft area.
983 if ($url['itemid'] == $draftitemid) {
987 // Decode the filename.
988 $filename = urldecode($url['filename']);
991 file_copy_file_to_file_area($url, $filename, $draftitemid);
993 // Rewrite draft area.
994 $text = file_replace_file_area_in_text($url, $draftitemid, $text, $forcehttps);
1000 * Rewrites a file area in arbitrary text.
1002 * @param array $file General information about the file.
1003 * @param int $newid The new file area itemid.
1004 * @param string $text The text to rewrite.
1005 * @param bool $forcehttps force https urls.
1006 * @return string The rewritten text.
1008 function file_replace_file_area_in_text($file, $newid, $text, $forcehttps = false) {
1011 $wwwroot = $CFG->wwwroot
;
1013 $wwwroot = str_replace('http://', 'https://', $wwwroot);
1035 $text = str_ireplace( implode('/', $search), implode('/', $replace), $text);
1040 * Copies a file from one file area to another.
1042 * @param array $file Information about the file to be copied.
1043 * @param string $filename The filename.
1044 * @param int $itemid The new file area.
1046 function file_copy_file_to_file_area($file, $filename, $itemid) {
1047 $fs = get_file_storage();
1049 // Load the current file in the old draft area.
1051 'component' => $file['component'],
1052 'filearea' => $file['filearea'],
1053 'itemid' => $file['itemid'],
1054 'contextid' => $file['contextid'],
1056 'filename' => $filename
1058 $oldfile = $fs->get_file($fileinfo['contextid'], $fileinfo['component'], $fileinfo['filearea'],
1059 $fileinfo['itemid'], $fileinfo['filepath'], $fileinfo['filename']);
1060 $newfileinfo = array(
1061 'component' => $file['component'],
1062 'filearea' => $file['filearea'],
1063 'itemid' => $itemid,
1064 'contextid' => $file['contextid'],
1066 'filename' => $filename
1069 $newcontextid = $newfileinfo['contextid'];
1070 $newcomponent = $newfileinfo['component'];
1071 $newfilearea = $newfileinfo['filearea'];
1072 $newitemid = $newfileinfo['itemid'];
1073 $newfilepath = $newfileinfo['filepath'];
1074 $newfilename = $newfileinfo['filename'];
1076 // Check if the file exists.
1077 if (!$fs->file_exists($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
1078 $fs->create_file_from_storedfile($newfileinfo, $oldfile);
1083 * Saves files from a draft file area to a real one (merging the list of files).
1084 * Can rewrite URLs in some content at the same time if desired.
1087 * @global stdClass $USER
1088 * @param int $draftitemid the id of the draft area to use. Normally obtained
1089 * from file_get_submitted_draft_itemid('elementname') or similar.
1090 * When set to -1 (probably, by a WebService) it won't process file merging, keeping the original state of the file area.
1091 * @param int $contextid This parameter and the next two identify the file area to save to.
1092 * @param string $component
1093 * @param string $filearea indentifies the file area.
1094 * @param int $itemid helps identifies the file area.
1095 * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
1096 * @param string $text some html content that needs to have embedded links rewritten
1097 * to the @@PLUGINFILE@@ form for saving in the database.
1098 * @param bool $forcehttps force https urls.
1099 * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
1101 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
1104 // Do not merge files, leave it as it was.
1105 if ($draftitemid === IGNORE_FILE_MERGE
) {
1106 // Safely return $text, no need to rewrite pluginfile because this is mostly comming from an external client like the app.
1110 $usercontext = context_user
::instance($USER->id
);
1111 $fs = get_file_storage();
1113 $options = (array)$options;
1114 if (!isset($options['subdirs'])) {
1115 $options['subdirs'] = false;
1117 if (!isset($options['maxfiles'])) {
1118 $options['maxfiles'] = -1; // unlimited
1120 if (!isset($options['maxbytes']) ||
$options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS
) {
1121 $options['maxbytes'] = 0; // unlimited
1123 if (!isset($options['areamaxbytes'])) {
1124 $options['areamaxbytes'] = FILE_AREA_MAX_BYTES_UNLIMITED
; // Unlimited.
1126 $allowreferences = true;
1127 if (isset($options['return_types']) && !($options['return_types'] & (FILE_REFERENCE | FILE_CONTROLLED_LINK
))) {
1128 // we assume that if $options['return_types'] is NOT specified, we DO allow references.
1129 // this is not exactly right. BUT there are many places in code where filemanager options
1130 // are not passed to file_save_draft_area_files()
1131 $allowreferences = false;
1134 // Check if the user has copy-pasted from other draft areas. Those files will be located in different draft
1135 // areas and need to be copied into the current draft area.
1136 $text = file_merge_draft_areas($draftitemid, $usercontext->id
, $text, $forcehttps);
1138 // Check if the draft area has exceeded the authorised limit. This should never happen as validation
1139 // should have taken place before, unless the user is doing something nauthly. If so, let's just not save
1140 // anything at all in the next area.
1141 if (file_is_draft_area_limit_reached($draftitemid, $options['areamaxbytes'])) {
1145 $draftfiles = $fs->get_area_files($usercontext->id
, 'user', 'draft', $draftitemid, 'id');
1146 $oldfiles = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
1148 // One file in filearea means it is empty (it has only top-level directory '.').
1149 if (count($draftfiles) > 1 ||
count($oldfiles) > 1) {
1150 // we have to merge old and new files - we want to keep file ids for files that were not changed
1151 // we change time modified for all new and changed files, we keep time created as is
1153 $newhashes = array();
1155 $context = context
::instance_by_id($contextid, MUST_EXIST
);
1156 foreach ($draftfiles as $file) {
1157 if (!$options['subdirs'] && $file->get_filepath() !== '/') {
1160 if (!$allowreferences && $file->is_external_file()) {
1163 if (!$file->is_directory()) {
1164 // Check to see if this file was uploaded by someone who can ignore the file size limits.
1165 $fileusermaxbytes = get_user_max_upload_file_size($context, $options['maxbytes'], 0, 0, $file->get_userid());
1166 if ($fileusermaxbytes != USER_CAN_IGNORE_FILE_SIZE_LIMITS
1167 && ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize())) {
1171 if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
1172 // more files - should not get here at all
1177 $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
1178 $newhashes[$newhash] = $file;
1181 // Loop through oldfiles and decide which we need to delete and which to update.
1182 // After this cycle the array $newhashes will only contain the files that need to be added.
1183 foreach ($oldfiles as $oldfile) {
1184 $oldhash = $oldfile->get_pathnamehash();
1185 if (!isset($newhashes[$oldhash])) {
1186 // delete files not needed any more - deleted by user
1191 $newfile = $newhashes[$oldhash];
1192 // Now we know that we have $oldfile and $newfile for the same path.
1193 // Let's check if we can update this file or we need to delete and create.
1194 if ($newfile->is_directory()) {
1195 // Directories are always ok to just update.
1196 } else if (($source = @unserialize
($newfile->get_source())) && isset($source->original
)) {
1197 // File has the 'original' - we need to update the file (it may even have not been changed at all).
1198 $original = file_storage
::unpack_reference($source->original
);
1199 if ($original['filename'] !== $oldfile->get_filename() ||
$original['filepath'] !== $oldfile->get_filepath()) {
1200 // Very odd, original points to another file. Delete and create file.
1205 // The same file name but absence of 'original' means that file was deteled and uploaded again.
1206 // By deleting and creating new file we properly manage all existing references.
1211 // status changed, we delete old file, and create a new one
1212 if ($oldfile->get_status() != $newfile->get_status()) {
1213 // file was changed, use updated with new timemodified data
1215 // This file will be added later
1220 if ($oldfile->get_author() != $newfile->get_author()) {
1221 $oldfile->set_author($newfile->get_author());
1224 if ($oldfile->get_license() != $newfile->get_license()) {
1225 $oldfile->set_license($newfile->get_license());
1228 // Updated file source
1229 // Field files.source for draftarea files contains serialised object with source and original information.
1230 // We only store the source part of it for non-draft file area.
1231 $newsource = $newfile->get_source();
1232 if ($source = @unserialize
($newfile->get_source())) {
1233 $newsource = $source->source
;
1235 if ($oldfile->get_source() !== $newsource) {
1236 $oldfile->set_source($newsource);
1239 // Updated sort order
1240 if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
1241 $oldfile->set_sortorder($newfile->get_sortorder());
1244 // Update file timemodified
1245 if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
1246 $oldfile->set_timemodified($newfile->get_timemodified());
1249 // Replaced file content
1250 if (!$oldfile->is_directory() &&
1251 ($oldfile->get_contenthash() != $newfile->get_contenthash() ||
1252 $oldfile->get_filesize() != $newfile->get_filesize() ||
1253 $oldfile->get_referencefileid() != $newfile->get_referencefileid() ||
1254 $oldfile->get_userid() != $newfile->get_userid())) {
1255 $oldfile->replace_file_with($newfile);
1258 // unchanged file or directory - we keep it as is
1259 unset($newhashes[$oldhash]);
1262 // Add fresh file or the file which has changed status
1263 // the size and subdirectory tests are extra safety only, the UI should prevent it
1264 foreach ($newhashes as $file) {
1265 $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
1266 if ($source = @unserialize
($file->get_source())) {
1267 // Field files.source for draftarea files contains serialised object with source and original information.
1268 // We only store the source part of it for non-draft file area.
1269 $file_record['source'] = $source->source
;
1272 if ($file->is_external_file()) {
1273 $repoid = $file->get_repository_id();
1274 if (!empty($repoid)) {
1275 $context = context
::instance_by_id($contextid, MUST_EXIST
);
1276 $repo = repository
::get_repository_by_id($repoid, $context);
1277 if (!empty($options)) {
1278 $repo->options
= $options;
1280 $file_record['repositoryid'] = $repoid;
1281 // This hook gives the repo a place to do some house cleaning, and update the $reference before it's saved
1282 // to the file store. E.g. transfer ownership of the file to a system account etc.
1283 $reference = $repo->reference_file_selected($file->get_reference(), $context, $component, $filearea, $itemid);
1285 $file_record['reference'] = $reference;
1289 $fs->create_file_from_storedfile($file_record, $file);
1293 // note: do not purge the draft area - we clean up areas later in cron,
1294 // the reason is that user might press submit twice and they would loose the files,
1295 // also sometimes we might want to use hacks that save files into two different areas
1297 if (is_null($text)) {
1300 return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
1305 * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
1306 * ready to be saved in the database. Normally, this is done automatically by
1307 * {@link file_save_draft_area_files()}.
1310 * @param string $text the content to process.
1311 * @param int $draftitemid the draft file area the content was using.
1312 * @param bool $forcehttps whether the content contains https URLs. Default false.
1313 * @return string the processed content.
1315 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
1318 $usercontext = context_user
::instance($USER->id
);
1320 $wwwroot = $CFG->wwwroot
;
1322 $wwwroot = str_replace('http://', 'https://', $wwwroot);
1325 // relink embedded files if text submitted - no absolute links allowed in database!
1326 $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1328 if (strpos($text, 'draftfile.php?file=') !== false) {
1330 preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
1332 foreach ($matches[0] as $match) {
1333 $replace = str_ireplace('%2F', '/', $match);
1334 $text = str_replace($match, $replace, $text);
1337 $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1344 * Set file sort order
1346 * @global moodle_database $DB
1347 * @param int $contextid the context id
1348 * @param string $component file component
1349 * @param string $filearea file area.
1350 * @param int $itemid itemid.
1351 * @param string $filepath file path.
1352 * @param string $filename file name.
1353 * @param int $sortorder the sort order of file.
1356 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
1358 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
1359 if ($file_record = $DB->get_record('files', $conditions)) {
1360 $sortorder = (int)$sortorder;
1361 $file_record->sortorder
= $sortorder;
1362 $DB->update_record('files', $file_record);
1369 * reset file sort order number to 0
1370 * @global moodle_database $DB
1371 * @param int $contextid the context id
1372 * @param string $component
1373 * @param string $filearea file area.
1374 * @param int|bool $itemid itemid.
1377 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
1380 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
1381 if ($itemid !== false) {
1382 $conditions['itemid'] = $itemid;
1385 $file_records = $DB->get_records('files', $conditions);
1386 foreach ($file_records as $file_record) {
1387 $file_record->sortorder
= 0;
1388 $DB->update_record('files', $file_record);
1394 * Returns description of upload error
1396 * @param int $errorcode found in $_FILES['filename.ext']['error']
1397 * @return string error description string, '' if ok
1399 function file_get_upload_error($errorcode) {
1401 switch ($errorcode) {
1402 case 0: // UPLOAD_ERR_OK - no error
1406 case 1: // UPLOAD_ERR_INI_SIZE
1407 $errmessage = get_string('uploadserverlimit');
1410 case 2: // UPLOAD_ERR_FORM_SIZE
1411 $errmessage = get_string('uploadformlimit');
1414 case 3: // UPLOAD_ERR_PARTIAL
1415 $errmessage = get_string('uploadpartialfile');
1418 case 4: // UPLOAD_ERR_NO_FILE
1419 $errmessage = get_string('uploadnofilefound');
1422 // Note: there is no error with a value of 5
1424 case 6: // UPLOAD_ERR_NO_TMP_DIR
1425 $errmessage = get_string('uploadnotempdir');
1428 case 7: // UPLOAD_ERR_CANT_WRITE
1429 $errmessage = get_string('uploadcantwrite');
1432 case 8: // UPLOAD_ERR_EXTENSION
1433 $errmessage = get_string('uploadextension');
1437 $errmessage = get_string('uploadproblem');
1444 * Recursive function formating an array in POST parameter
1445 * @param array $arraydata - the array that we are going to format and add into &$data array
1446 * @param string $currentdata - a row of the final postdata array at instant T
1447 * when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1448 * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1450 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1451 foreach ($arraydata as $k=>$v) {
1452 $newcurrentdata = $currentdata;
1453 if (is_array($v)) { //the value is an array, call the function recursively
1454 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1455 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1456 } else { //add the POST parameter to the $data array
1457 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1463 * Transform a PHP array into POST parameter
1464 * (see the recursive function format_array_postdata_for_curlcall)
1465 * @param array $postdata
1466 * @return array containing all POST parameters (1 row = 1 POST parameter)
1468 function format_postdata_for_curlcall($postdata) {
1470 foreach ($postdata as $k=>$v) {
1472 $currentdata = urlencode($k);
1473 format_array_postdata_for_curlcall($v, $currentdata, $data);
1475 $data[] = urlencode($k).'='.urlencode($v);
1478 $convertedpostdata = implode('&', $data);
1479 return $convertedpostdata;
1483 * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1484 * Due to security concerns only downloads from http(s) sources are supported.
1487 * @param string $url file url starting with http(s)://
1488 * @param array $headers http headers, null if none. If set, should be an
1489 * associative array of header name => value pairs.
1490 * @param array $postdata array means use POST request with given parameters
1491 * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1492 * (if false, just returns content)
1493 * @param int $timeout timeout for complete download process including all file transfer
1494 * (default 5 minutes)
1495 * @param int $connecttimeout timeout for connection to server; this is the timeout that
1496 * usually happens if the remote server is completely down (default 20 seconds);
1497 * may not work when using proxy
1498 * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1499 * Only use this when already in a trusted location.
1500 * @param string $tofile store the downloaded content to file instead of returning it.
1501 * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1502 * filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1503 * @return stdClass|string|bool stdClass object if $fullresponse is true, false if request failed, true
1504 * if file downloaded into $tofile successfully or the file content as a string.
1506 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1509 // Only http and https links supported.
1510 if (!preg_match('|^https?://|i', $url)) {
1511 if ($fullresponse) {
1512 $response = new stdClass();
1513 $response->status
= 0;
1514 $response->headers
= array();
1515 $response->response_code
= 'Invalid protocol specified in url';
1516 $response->results
= '';
1517 $response->error
= 'Invalid protocol specified in url';
1526 $headers2 = array();
1527 if (is_array($headers)) {
1528 foreach ($headers as $key => $value) {
1529 if (is_numeric($key)) {
1530 $headers2[] = $value;
1532 $headers2[] = "$key: $value";
1537 if ($skipcertverify) {
1538 $options['CURLOPT_SSL_VERIFYPEER'] = false;
1540 $options['CURLOPT_SSL_VERIFYPEER'] = true;
1543 $options['CURLOPT_CONNECTTIMEOUT'] = $connecttimeout;
1545 $options['CURLOPT_FOLLOWLOCATION'] = 1;
1546 $options['CURLOPT_MAXREDIRS'] = 5;
1548 // Use POST if requested.
1549 if (is_array($postdata)) {
1550 $postdata = format_postdata_for_curlcall($postdata);
1551 } else if (empty($postdata)) {
1555 // Optionally attempt to get more correct timeout by fetching the file size.
1556 if (!isset($CFG->curltimeoutkbitrate
)) {
1557 // Use very slow rate of 56kbps as a timeout speed when not set.
1560 $bitrate = $CFG->curltimeoutkbitrate
;
1562 if ($calctimeout and !isset($postdata)) {
1564 $curl->setHeader($headers2);
1566 $curl->head($url, $postdata, $options);
1568 $info = $curl->get_info();
1569 $error_no = $curl->get_errno();
1570 if (!$error_no && $info['download_content_length'] > 0) {
1571 // No curl errors - adjust for large files only - take max timeout.
1572 $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024)));
1577 $curl->setHeader($headers2);
1579 $options['CURLOPT_RETURNTRANSFER'] = true;
1580 $options['CURLOPT_NOBODY'] = false;
1581 $options['CURLOPT_TIMEOUT'] = $timeout;
1584 $fh = fopen($tofile, 'w');
1586 if ($fullresponse) {
1587 $response = new stdClass();
1588 $response->status
= 0;
1589 $response->headers
= array();
1590 $response->response_code
= 'Can not write to file';
1591 $response->results
= false;
1592 $response->error
= 'Can not write to file';
1598 $options['CURLOPT_FILE'] = $fh;
1601 if (isset($postdata)) {
1602 $content = $curl->post($url, $postdata, $options);
1604 $content = $curl->get($url, null, $options);
1609 @chmod
($tofile, $CFG->filepermissions
);
1613 // Try to detect encoding problems.
1614 if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1615 curl_setopt($ch, CURLOPT_ENCODING, 'none');
1616 $result = curl_exec($ch);
1620 $info = $curl->get_info();
1621 $error_no = $curl->get_errno();
1622 $rawheaders = $curl->get_raw_response();
1626 if (!$fullresponse) {
1627 debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL
);
1631 $response = new stdClass();
1632 if ($error_no == 28) {
1633 $response->status
= '-100'; // Mimic snoopy.
1635 $response->status
= '0';
1637 $response->headers
= array();
1638 $response->response_code
= $error;
1639 $response->results
= false;
1640 $response->error
= $error;
1648 if (empty($info['http_code'])) {
1649 // For security reasons we support only true http connections (Location: file:// exploit prevention).
1650 $response = new stdClass();
1651 $response->status
= '0';
1652 $response->headers
= array();
1653 $response->response_code
= 'Unknown cURL error';
1654 $response->results
= false; // do NOT change this, we really want to ignore the result!
1655 $response->error
= 'Unknown cURL error';
1658 $response = new stdClass();
1659 $response->status
= (string)$info['http_code'];
1660 $response->headers
= $rawheaders;
1661 $response->results
= $content;
1662 $response->error
= '';
1664 // There might be multiple headers on redirect, find the status of the last one.
1666 foreach ($rawheaders as $line) {
1668 $response->response_code
= $line;
1671 if (trim($line, "\r\n") === '') {
1677 if ($fullresponse) {
1681 if ($info['http_code'] != 200) {
1682 debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code
, DEBUG_ALL
);
1685 return $response->results
;
1689 * Returns a list of information about file types based on extensions.
1691 * The following elements expected in value array for each extension:
1693 * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1694 * or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1695 * also files with bigger sizes under names
1696 * FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1697 * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1698 * commonly used in moodle the following groups:
1699 * - web_image - image that can be included as <img> in HTML
1700 * - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1701 * - optimised_image - image that will be processed and optimised
1702 * - video - file that can be imported as video in text editor
1703 * - audio - file that can be imported as audio in text editor
1704 * - archive - we can extract files from this archive
1705 * - spreadsheet - used for portfolio format
1706 * - document - used for portfolio format
1707 * - presentation - used for portfolio format
1708 * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1709 * human-readable description for this filetype;
1710 * Function {@link get_mimetype_description()} first looks at the presence of string for
1711 * particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1712 * attribute, if not found returns the value of 'type';
1713 * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1714 * an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1715 * this function will return first found icon; Especially usefull for types such as 'text/plain'
1718 * @return array List of information about file types based on extensions.
1719 * Associative array of extension (lower-case) to associative array
1720 * from 'element name' to data. Current element names are 'type' and 'icon'.
1721 * Unknown types should use the 'xxx' entry which includes defaults.
1723 function &get_mimetypes_array() {
1724 // Get types from the core_filetypes function, which includes caching.
1725 return core_filetypes
::get_types();
1729 * Determine a file's MIME type based on the given filename using the function mimeinfo.
1731 * This function retrieves a file's MIME type for a file that will be sent to the user.
1732 * This should only be used for file-sending purposes just like in send_stored_file, send_file, and send_temp_file.
1733 * Should the file's MIME type cannot be determined by mimeinfo, it will return 'application/octet-stream' as a default
1734 * MIME type which should tell the browser "I don't know what type of file this is, so just download it.".
1736 * @param string $filename The file's filename.
1737 * @return string The file's MIME type or 'application/octet-stream' if it cannot be determined.
1739 function get_mimetype_for_sending($filename = '') {
1740 // Guess the file's MIME type using mimeinfo.
1741 $mimetype = mimeinfo('type', $filename);
1743 // Use octet-stream as fallback if MIME type cannot be determined by mimeinfo.
1744 if (!$mimetype ||
$mimetype === 'document/unknown') {
1745 $mimetype = 'application/octet-stream';
1752 * Obtains information about a filetype based on its extension. Will
1753 * use a default if no information is present about that particular
1757 * @param string $element Desired information (usually 'icon'
1758 * for icon filename or 'type' for MIME type. Can also be
1759 * 'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1760 * @param string $filename Filename we're looking up
1761 * @return string Requested piece of information from array
1763 function mimeinfo($element, $filename) {
1765 $mimeinfo = & get_mimetypes_array();
1766 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1768 $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1769 if (empty($filetype)) {
1770 $filetype = 'xxx'; // file without extension
1772 if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1773 $iconsize = max(array(16, (int)$iconsizematch[1]));
1774 $filenames = array($mimeinfo['xxx']['icon']);
1775 if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1776 array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1778 // find the file with the closest size, first search for specific icon then for default icon
1779 foreach ($filenames as $filename) {
1780 foreach ($iconpostfixes as $size => $postfix) {
1781 $fullname = $CFG->dirroot
.'/pix/f/'.$filename.$postfix;
1782 if ($iconsize >= $size &&
1783 (file_exists($fullname.'.svg') ||
file_exists($fullname.'.png') ||
file_exists($fullname.'.gif'))) {
1784 return $filename.$postfix;
1788 } else if (isset($mimeinfo[$filetype][$element])) {
1789 return $mimeinfo[$filetype][$element];
1790 } else if (isset($mimeinfo['xxx'][$element])) {
1791 return $mimeinfo['xxx'][$element]; // By default
1798 * Obtains information about a filetype based on the MIME type rather than
1799 * the other way around.
1802 * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1803 * @param string $mimetype MIME type we're looking up
1804 * @return string Requested piece of information from array
1806 function mimeinfo_from_type($element, $mimetype) {
1807 /* array of cached mimetype->extension associations */
1808 static $cached = array();
1809 $mimeinfo = & get_mimetypes_array();
1811 if (!array_key_exists($mimetype, $cached)) {
1812 $cached[$mimetype] = null;
1813 foreach($mimeinfo as $filetype => $values) {
1814 if ($values['type'] == $mimetype) {
1815 if ($cached[$mimetype] === null) {
1816 $cached[$mimetype] = '.'.$filetype;
1818 if (!empty($values['defaulticon'])) {
1819 $cached[$mimetype] = '.'.$filetype;
1824 if (empty($cached[$mimetype])) {
1825 $cached[$mimetype] = '.xxx';
1828 if ($element === 'extension') {
1829 return $cached[$mimetype];
1831 return mimeinfo($element, $cached[$mimetype]);
1836 * Return the relative icon path for a given file
1840 * // $file - instance of stored_file or file_info
1841 * $icon = $OUTPUT->image_url(file_file_icon($file))->out();
1842 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1846 * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1849 * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1850 * and $file->mimetype are expected)
1851 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1854 function file_file_icon($file, $size = null) {
1855 if (!is_object($file)) {
1856 $file = (object)$file;
1858 if (isset($file->filename
)) {
1859 $filename = $file->filename
;
1860 } else if (method_exists($file, 'get_filename')) {
1861 $filename = $file->get_filename();
1862 } else if (method_exists($file, 'get_visible_name')) {
1863 $filename = $file->get_visible_name();
1867 if (isset($file->mimetype
)) {
1868 $mimetype = $file->mimetype
;
1869 } else if (method_exists($file, 'get_mimetype')) {
1870 $mimetype = $file->get_mimetype();
1874 $mimetypes = &get_mimetypes_array();
1876 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1877 if ($extension && !empty($mimetypes[$extension])) {
1878 // if file name has known extension, return icon for this extension
1879 return file_extension_icon($filename, $size);
1882 return file_mimetype_icon($mimetype, $size);
1886 * Return the relative icon path for a folder image
1890 * $icon = $OUTPUT->image_url(file_folder_icon())->out();
1891 * echo html_writer::empty_tag('img', array('src' => $icon));
1895 * echo $OUTPUT->pix_icon(file_folder_icon(32), '');
1898 * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1901 function file_folder_icon($iconsize = null) {
1903 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1904 static $cached = array();
1905 $iconsize = max(array(16, (int)$iconsize));
1906 if (!array_key_exists($iconsize, $cached)) {
1907 foreach ($iconpostfixes as $size => $postfix) {
1908 $fullname = $CFG->dirroot
.'/pix/f/folder'.$postfix;
1909 if ($iconsize >= $size &&
1910 (file_exists($fullname.'.svg') ||
file_exists($fullname.'.png') ||
file_exists($fullname.'.gif'))) {
1911 $cached[$iconsize] = 'f/folder'.$postfix;
1916 return $cached[$iconsize];
1920 * Returns the relative icon path for a given mime type
1922 * This function should be used in conjunction with $OUTPUT->image_url to produce
1923 * a return the full path to an icon.
1926 * $mimetype = 'image/jpg';
1927 * $icon = $OUTPUT->image_url(file_mimetype_icon($mimetype))->out();
1928 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1932 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1933 * to conform with that.
1934 * @param string $mimetype The mimetype to fetch an icon for
1935 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1936 * @return string The relative path to the icon
1938 function file_mimetype_icon($mimetype, $size = NULL) {
1939 return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1943 * Returns the relative icon path for a given file name
1945 * This function should be used in conjunction with $OUTPUT->image_url to produce
1946 * a return the full path to an icon.
1949 * $filename = '.jpg';
1950 * $icon = $OUTPUT->image_url(file_extension_icon($filename))->out();
1951 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1954 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1955 * to conform with that.
1956 * @todo MDL-31074 Implement $size
1958 * @param string $filename The filename to get the icon for
1959 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1962 function file_extension_icon($filename, $size = NULL) {
1963 return 'f/'.mimeinfo('icon'.$size, $filename);
1967 * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1968 * mimetypes.php language file.
1970 * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1971 * 'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1972 * have filename); In case of array/stdClass the field 'mimetype' is optional.
1973 * @param bool $capitalise If true, capitalises first character of result
1974 * @return string Text description
1976 function get_mimetype_description($obj, $capitalise=false) {
1977 $filename = $mimetype = '';
1978 if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1979 // this is an instance of stored_file
1980 $mimetype = $obj->get_mimetype();
1981 $filename = $obj->get_filename();
1982 } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1983 // this is an instance of file_info
1984 $mimetype = $obj->get_mimetype();
1985 $filename = $obj->get_visible_name();
1986 } else if (is_array($obj) ||
is_object ($obj)) {
1988 if (!empty($obj['filename'])) {
1989 $filename = $obj['filename'];
1991 if (!empty($obj['mimetype'])) {
1992 $mimetype = $obj['mimetype'];
1997 $mimetypefromext = mimeinfo('type', $filename);
1998 if (empty($mimetype) ||
$mimetypefromext !== 'document/unknown') {
1999 // if file has a known extension, overwrite the specified mimetype
2000 $mimetype = $mimetypefromext;
2002 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
2003 if (empty($extension)) {
2004 $mimetypestr = mimeinfo_from_type('string', $mimetype);
2005 $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
2007 $mimetypestr = mimeinfo('string', $filename);
2009 $chunks = explode('/', $mimetype, 2);
2012 'mimetype' => $mimetype,
2013 'ext' => $extension,
2014 'mimetype1' => $chunks[0],
2015 'mimetype2' => $chunks[1],
2018 foreach ($attr as $key => $value) {
2020 $a[strtoupper($key)] = strtoupper($value);
2021 $a[ucfirst($key)] = ucfirst($value);
2024 // MIME types may include + symbol but this is not permitted in string ids.
2025 $safemimetype = str_replace('+', '_', $mimetype);
2026 $safemimetypestr = str_replace('+', '_', $mimetypestr);
2027 $customdescription = mimeinfo('customdescription', $filename);
2028 if ($customdescription) {
2029 // Call format_string on the custom description so that multilang
2030 // filter can be used (if enabled on system context). We use system
2031 // context because it is possible that the page context might not have
2032 // been defined yet.
2033 $result = format_string($customdescription, true,
2034 array('context' => context_system
::instance()));
2035 } else if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
2036 $result = get_string($safemimetype, 'mimetypes', (object)$a);
2037 } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
2038 $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
2039 } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
2040 $result = get_string('default', 'mimetypes', (object)$a);
2042 $result = $mimetype;
2045 $result=ucfirst($result);
2051 * Returns array of elements of type $element in type group(s)
2053 * @param string $element name of the element we are interested in, usually 'type' or 'extension'
2054 * @param string|array $groups one group or array of groups/extensions/mimetypes
2057 function file_get_typegroup($element, $groups) {
2058 static $cached = array();
2059 if (!is_array($groups)) {
2060 $groups = array($groups);
2062 if (!array_key_exists($element, $cached)) {
2063 $cached[$element] = array();
2066 foreach ($groups as $group) {
2067 if (!array_key_exists($group, $cached[$element])) {
2068 // retrieive and cache all elements of type $element for group $group
2069 $mimeinfo = & get_mimetypes_array();
2070 $cached[$element][$group] = array();
2071 foreach ($mimeinfo as $extension => $value) {
2072 $value['extension'] = '.'.$extension;
2073 if (empty($value[$element])) {
2076 if (($group === '.'.$extension ||
$group === $value['type'] ||
2077 (!empty($value['groups']) && in_array($group, $value['groups']))) &&
2078 !in_array($value[$element], $cached[$element][$group])) {
2079 $cached[$element][$group][] = $value[$element];
2083 $result = array_merge($result, $cached[$element][$group]);
2085 return array_values(array_unique($result));
2089 * Checks if file with name $filename has one of the extensions in groups $groups
2091 * @see get_mimetypes_array()
2092 * @param string $filename name of the file to check
2093 * @param string|array $groups one group or array of groups to check
2094 * @param bool $checktype if true and extension check fails, find the mimetype and check if
2095 * file mimetype is in mimetypes in groups $groups
2098 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
2099 $extension = pathinfo($filename, PATHINFO_EXTENSION
);
2100 if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
2103 return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
2107 * Checks if mimetype $mimetype belongs to one of the groups $groups
2109 * @see get_mimetypes_array()
2110 * @param string $mimetype
2111 * @param string|array $groups one group or array of groups to check
2114 function file_mimetype_in_typegroup($mimetype, $groups) {
2115 return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
2119 * Requested file is not found or not accessible, does not return, terminates script
2121 * @global stdClass $CFG
2122 * @global stdClass $COURSE
2124 function send_file_not_found() {
2125 global $CFG, $COURSE;
2127 // Allow cross-origin requests only for Web Services.
2128 // This allow to receive requests done by Web Workers or webapps in different domains.
2130 header('Access-Control-Allow-Origin: *');
2134 print_error('filenotfound', 'error', $CFG->wwwroot
.'/course/view.php?id='.$COURSE->id
); //this is not displayed on IIS??
2137 * Helper function to send correct 404 for server.
2139 function send_header_404() {
2140 if (substr(php_sapi_name(), 0, 3) == 'cgi') {
2141 header("Status: 404 Not Found");
2143 header('HTTP/1.0 404 not found');
2148 * The readfile function can fail when files are larger than 2GB (even on 64-bit
2149 * platforms). This wrapper uses readfile for small files and custom code for
2152 * @param string $path Path to file
2153 * @param int $filesize Size of file (if left out, will get it automatically)
2154 * @return int|bool Size read (will always be $filesize) or false if failed
2156 function readfile_allow_large($path, $filesize = -1) {
2157 // Automatically get size if not specified.
2158 if ($filesize === -1) {
2159 $filesize = filesize($path);
2161 if ($filesize <= 2147483647) {
2162 // If the file is up to 2^31 - 1, send it normally using readfile.
2163 return readfile($path);
2165 // For large files, read and output in 64KB chunks.
2166 $handle = fopen($path, 'r');
2167 if ($handle === false) {
2172 $size = min($left, 65536);
2173 $buffer = fread($handle, $size);
2174 if ($buffer === false) {
2185 * Enhanced readfile() with optional acceleration.
2186 * @param string|stored_file $file
2187 * @param string $mimetype
2188 * @param bool $accelerate
2191 function readfile_accel($file, $mimetype, $accelerate) {
2194 if ($mimetype === 'text/plain') {
2195 // there is no encoding specified in text files, we need something consistent
2196 header('Content-Type: text/plain; charset=utf-8');
2198 header('Content-Type: '.$mimetype);
2201 $lastmodified = is_object($file) ?
$file->get_timemodified() : filemtime($file);
2202 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2204 if (is_object($file)) {
2205 header('Etag: "' . $file->get_contenthash() . '"');
2206 if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and trim($_SERVER['HTTP_IF_NONE_MATCH'], '"') === $file->get_contenthash()) {
2207 header('HTTP/1.1 304 Not Modified');
2212 // if etag present for stored file rely on it exclusively
2213 if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
2214 // get unixtime of request header; clip extra junk off first
2215 $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
2216 if ($since && $since >= $lastmodified) {
2217 header('HTTP/1.1 304 Not Modified');
2222 if ($accelerate and empty($CFG->disablebyteserving
) and $mimetype !== 'text/plain') {
2223 header('Accept-Ranges: bytes');
2225 header('Accept-Ranges: none');
2229 if (is_object($file)) {
2230 $fs = get_file_storage();
2231 if ($fs->supports_xsendfile()) {
2232 if ($fs->xsendfile_file($file)) {
2237 if (!empty($CFG->xsendfile
)) {
2238 require_once("$CFG->libdir/xsendfilelib.php");
2239 if (xsendfile($file)) {
2246 $filesize = is_object($file) ?
$file->get_filesize() : filesize($file);
2248 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2250 if ($accelerate and empty($CFG->disablebyteserving
) and $mimetype !== 'text/plain') {
2252 if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
2253 // byteserving stuff - for acrobat reader and download accelerators
2254 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
2255 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
2257 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER
)) {
2258 foreach ($ranges as $key=>$value) {
2259 if ($ranges[$key][1] == '') {
2261 $ranges[$key][1] = $filesize - $ranges[$key][2];
2262 $ranges[$key][2] = $filesize - 1;
2263 } else if ($ranges[$key][2] == '' ||
$ranges[$key][2] > $filesize - 1) {
2265 $ranges[$key][2] = $filesize - 1;
2267 if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
2268 //invalid byte-range ==> ignore header
2272 //prepare multipart header
2273 $ranges[$key][0] = "\r\n--".BYTESERVING_BOUNDARY
."\r\nContent-Type: $mimetype\r\n";
2274 $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
2280 if (is_object($file)) {
2281 $handle = $file->get_content_file_handle();
2282 if ($handle === false) {
2283 throw new file_exception('storedfilecannotreadfile', $file->get_filename());
2286 $handle = fopen($file, 'rb');
2287 if ($handle === false) {
2288 throw new file_exception('cannotopenfile', $file);
2291 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
2296 header('Content-Length: ' . $filesize);
2298 if (!empty($_SERVER['REQUEST_METHOD']) and $_SERVER['REQUEST_METHOD'] === 'HEAD') {
2302 while (ob_get_level()) {
2303 $handlerstack = ob_list_handlers();
2304 $activehandler = array_pop($handlerstack);
2305 if ($activehandler === 'default output handler') {
2306 // We do not expect any content in the buffer when we are serving files.
2307 $buffercontents = ob_get_clean();
2308 if ($buffercontents !== '') {
2309 error_log('Non-empty default output handler buffer detected while serving the file ' . $file);
2312 // Some handlers such as zlib output compression may have file signature buffered - flush it.
2317 // send the whole file content
2318 if (is_object($file)) {
2321 if (readfile_allow_large($file, $filesize) === false) {
2322 throw new file_exception('cannotopenfile', $file);
2328 * Similar to readfile_accel() but designed for strings.
2329 * @param string $string
2330 * @param string $mimetype
2331 * @param bool $accelerate Ignored
2334 function readstring_accel($string, $mimetype, $accelerate = false) {
2337 if ($mimetype === 'text/plain') {
2338 // there is no encoding specified in text files, we need something consistent
2339 header('Content-Type: text/plain; charset=utf-8');
2341 header('Content-Type: '.$mimetype);
2343 header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2344 header('Accept-Ranges: none');
2345 header('Content-Length: '.strlen($string));
2350 * Handles the sending of temporary file to user, download is forced.
2351 * File is deleted after abort or successful sending, does not return, script terminated
2353 * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2354 * @param string $filename proposed file name when saving file
2355 * @param bool $pathisstring If the path is string
2357 function send_temp_file($path, $filename, $pathisstring=false) {
2360 // Guess the file's MIME type.
2361 $mimetype = get_mimetype_for_sending($filename);
2363 // close session - not needed anymore
2364 \core\session\manager
::write_close();
2366 if (!$pathisstring) {
2367 if (!file_exists($path)) {
2369 print_error('filenotfound', 'error', $CFG->wwwroot
.'/');
2371 // executed after normal finish or abort
2372 core_shutdown_manager
::register_function('send_temp_file_finished', array($path));
2375 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2376 if (core_useragent
::is_ie() || core_useragent
::is_edge()) {
2377 $filename = urlencode($filename);
2380 // If this file was requested from a form, then mark download as complete.
2381 \core_form\util
::form_download_complete();
2383 header('Content-Disposition: attachment; filename="'.$filename.'"');
2384 if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2385 header('Cache-Control: private, max-age=10, no-transform');
2386 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2388 } else { //normal http - prevent caching at all cost
2389 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2390 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2391 header('Pragma: no-cache');
2394 // send the contents - we can not accelerate this because the file will be deleted asap
2395 if ($pathisstring) {
2396 readstring_accel($path, $mimetype);
2398 readfile_accel($path, $mimetype, false);
2402 die; //no more chars to output
2406 * Internal callback function used by send_temp_file()
2408 * @param string $path
2410 function send_temp_file_finished($path) {
2411 if (file_exists($path)) {
2417 * Serve content which is not meant to be cached.
2419 * This is only intended to be used for volatile public files, for instance
2420 * when development is enabled, or when caching is not required on a public resource.
2422 * @param string $content Raw content.
2423 * @param string $filename The file name.
2426 function send_content_uncached($content, $filename) {
2427 $mimetype = mimeinfo('type', $filename);
2428 $charset = strpos($mimetype, 'text/') === 0 ?
'; charset=utf-8' : '';
2430 header('Content-Disposition: inline; filename="' . $filename . '"');
2431 header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
2432 header('Expires: ' . gmdate('D, d M Y H:i:s', time() +
2) . ' GMT');
2434 header('Accept-Ranges: none');
2435 header('Content-Type: ' . $mimetype . $charset);
2436 header('Content-Length: ' . strlen($content));
2443 * Safely save content to a certain path.
2445 * This function tries hard to be atomic by first copying the content
2446 * to a separate file, and then moving the file across. It also prevents
2447 * the user to abort a request to prevent half-safed files.
2449 * This function is intended to be used when saving some content to cache like
2450 * $CFG->localcachedir. If you're not caching a file you should use the File API.
2452 * @param string $content The file content.
2453 * @param string $destination The absolute path of the final file.
2456 function file_safe_save_content($content, $destination) {
2460 if (!file_exists(dirname($destination))) {
2461 @mkdir
(dirname($destination), $CFG->directorypermissions
, true);
2464 // Prevent serving of incomplete file from concurrent request,
2465 // the rename() should be more atomic than fwrite().
2466 ignore_user_abort(true);
2467 if ($fp = fopen($destination . '.tmp', 'xb')) {
2468 fwrite($fp, $content);
2470 rename($destination . '.tmp', $destination);
2471 @chmod
($destination, $CFG->filepermissions
);
2472 @unlink
($destination . '.tmp'); // Just in case anything fails.
2474 ignore_user_abort(false);
2475 if (connection_aborted()) {
2481 * Handles the sending of file data to the user's browser, including support for
2485 * @param string|stored_file $path Path of file on disk (including real filename),
2486 * or actual content of file as string,
2487 * or stored_file object
2488 * @param string $filename Filename to send
2489 * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2490 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2491 * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname.
2492 * Forced to false when $path is a stored_file object.
2493 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2494 * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2495 * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2496 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2497 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2498 * and should not be reopened.
2499 * @param array $options An array of options, currently accepts:
2500 * - (string) cacheability: public, or private.
2501 * - (string|null) immutable
2502 * - (bool) dontforcesvgdownload: true if force download should be disabled on SVGs.
2503 * Note: This overrides a security feature, so should only be applied to "trusted" content
2504 * (eg module content that is created using an XSS risk flagged capability, such as SCORM).
2505 * @return null script execution stopped unless $dontdie is true
2507 function send_file($path, $filename, $lifetime = null , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='',
2508 $dontdie=false, array $options = array()) {
2509 global $CFG, $COURSE;
2512 ignore_user_abort(true);
2515 if ($lifetime === 'default' or is_null($lifetime)) {
2516 $lifetime = $CFG->filelifetime
;
2519 if (is_object($path)) {
2520 $pathisstring = false;
2523 \core\session\manager
::write_close(); // Unlock session during file serving.
2525 // Use given MIME type if specified, otherwise guess it.
2526 if (!$mimetype ||
$mimetype === 'document/unknown') {
2527 $mimetype = get_mimetype_for_sending($filename);
2530 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2531 if (core_useragent
::is_ie() || core_useragent
::is_edge()) {
2532 $filename = rawurlencode($filename);
2535 // Make sure we force download of SVG files, unless the module explicitly allows them (eg within SCORM content).
2536 // This is for security reasons (https://digi.ninja/blog/svg_xss.php).
2537 if (file_is_svg_image_from_mimetype($mimetype) && empty($options['dontforcesvgdownload'])) {
2538 $forcedownload = true;
2541 if ($forcedownload) {
2542 header('Content-Disposition: attachment; filename="'.$filename.'"');
2544 // If this file was requested from a form, then mark download as complete.
2545 \core_form\util
::form_download_complete();
2546 } else if ($mimetype !== 'application/x-shockwave-flash') {
2547 // If this is an swf don't pass content-disposition with filename as this makes the flash player treat the file
2548 // as an upload and enforces security that may prevent the file from being loaded.
2550 header('Content-Disposition: inline; filename="'.$filename.'"');
2553 if ($lifetime > 0) {
2555 if (!empty($options['immutable'])) {
2556 $immutable = ', immutable';
2557 // Overwrite lifetime accordingly:
2558 // 90 days only - based on Moodle point release cadence being every 3 months.
2559 $lifetimemin = 60 * 60 * 24 * 90;
2560 $lifetime = max($lifetime, $lifetimemin);
2562 $cacheability = ' public,';
2563 if (!empty($options['cacheability']) && ($options['cacheability'] === 'public')) {
2564 // This file must be cache-able by both browsers and proxies.
2565 $cacheability = ' public,';
2566 } else if (!empty($options['cacheability']) && ($options['cacheability'] === 'private')) {
2567 // This file must be cache-able only by browsers.
2568 $cacheability = ' private,';
2569 } else if (isloggedin() and !isguestuser()) {
2570 // By default, under the conditions above, this file must be cache-able only by browsers.
2571 $cacheability = ' private,';
2573 $nobyteserving = false;
2574 header('Cache-Control:'.$cacheability.' max-age='.$lifetime.', no-transform'.$immutable);
2575 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
$lifetime) .' GMT');
2578 } else { // Do not cache files in proxies and browsers
2579 $nobyteserving = true;
2580 if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2581 header('Cache-Control: private, max-age=10, no-transform');
2582 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2584 } else { //normal http - prevent caching at all cost
2585 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2586 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2587 header('Pragma: no-cache');
2591 if (empty($filter)) {
2592 // send the contents
2593 if ($pathisstring) {
2594 readstring_accel($path, $mimetype);
2596 readfile_accel($path, $mimetype, !$dontdie);
2600 // Try to put the file through filters
2601 if ($mimetype == 'text/html' ||
$mimetype == 'application/xhtml+xml' ||
file_is_svg_image_from_mimetype($mimetype)) {
2602 $options = new stdClass();
2603 $options->noclean
= true;
2604 $options->nocache
= true; // temporary workaround for MDL-5136
2605 if (is_object($path)) {
2606 $text = $path->get_content();
2607 } else if ($pathisstring) {
2610 $text = implode('', file($path));
2612 $output = format_text($text, FORMAT_HTML
, $options, $COURSE->id
);
2614 readstring_accel($output, $mimetype);
2616 } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2617 // only filter text if filter all files is selected
2618 $options = new stdClass();
2619 $options->newlines
= false;
2620 $options->noclean
= true;
2621 if (is_object($path)) {
2622 $text = htmlentities($path->get_content(), ENT_QUOTES
, 'UTF-8');
2623 } else if ($pathisstring) {
2624 $text = htmlentities($path, ENT_QUOTES
, 'UTF-8');
2626 $text = htmlentities(implode('', file($path)), ENT_QUOTES
, 'UTF-8');
2628 $output = '<pre>'. format_text($text, FORMAT_MOODLE
, $options, $COURSE->id
) .'</pre>';
2630 readstring_accel($output, $mimetype);
2633 // send the contents
2634 if ($pathisstring) {
2635 readstring_accel($path, $mimetype);
2637 readfile_accel($path, $mimetype, !$dontdie);
2644 die; //no more chars to output!!!
2648 * Handles the sending of file data to the user's browser, including support for
2651 * The $options parameter supports the following keys:
2652 * (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2653 * (string|null) filename - overrides the implicit filename
2654 * (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2655 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2656 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2657 * and should not be reopened
2658 * (string|null) cacheability - force the cacheability setting of the HTTP response, "private" or "public",
2659 * when $lifetime is greater than 0. Cacheability defaults to "private" when logged in as other than guest; otherwise,
2660 * defaults to "public".
2661 * (string|null) immutable - set the immutable cache setting in the HTTP response, when served under HTTPS.
2662 * Note: it's up to the consumer to set it properly i.e. when serving a "versioned" URL.
2665 * @param stored_file $stored_file local file object
2666 * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2667 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2668 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2669 * @param array $options additional options affecting the file serving
2670 * @return null script execution stopped unless $options['dontdie'] is true
2672 function send_stored_file($stored_file, $lifetime=null, $filter=0, $forcedownload=false, array $options=array()) {
2673 global $CFG, $COURSE;
2675 static $recursion = 0;
2677 if (empty($options['filename'])) {
2680 $filename = $options['filename'];
2683 if (empty($options['dontdie'])) {
2689 if ($lifetime === 'default' or is_null($lifetime)) {
2690 $lifetime = $CFG->filelifetime
;
2693 if (!empty($options['preview'])) {
2694 // replace the file with its preview
2695 $fs = get_file_storage();
2696 $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2697 if (!$preview_file) {
2698 // unable to create a preview of the file, send its default mime icon instead
2699 if ($options['preview'] === 'tinyicon') {
2701 } else if ($options['preview'] === 'thumb') {
2706 $fileicon = file_file_icon($stored_file, $size);
2707 send_file($CFG->dirroot
.'/pix/'.$fileicon.'.png', basename($fileicon).'.png');
2709 // preview images have fixed cache lifetime and they ignore forced download
2710 // (they are generated by GD and therefore they are considered reasonably safe).
2711 $stored_file = $preview_file;
2712 $lifetime = DAYSECS
;
2714 $forcedownload = false;
2718 // handle external resource
2719 if ($stored_file && $stored_file->is_external_file() && !isset($options['sendcachedexternalfile'])) {
2721 // Have we been here before?
2723 if ($recursion > 10) {
2724 throw new coding_exception('Recursive file serving detected');
2727 $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2731 if (!$stored_file or $stored_file->is_directory()) {
2739 $filename = is_null($filename) ?
$stored_file->get_filename() : $filename;
2741 // Use given MIME type if specified.
2742 $mimetype = $stored_file->get_mimetype();
2744 // Allow cross-origin requests only for Web Services.
2745 // This allow to receive requests done by Web Workers or webapps in different domains.
2747 header('Access-Control-Allow-Origin: *');
2750 send_file($stored_file, $filename, $lifetime, $filter, false, $forcedownload, $mimetype, $dontdie, $options);
2754 * Recursively delete the file or folder with path $location. That is,
2755 * if it is a file delete it. If it is a folder, delete all its content
2756 * then delete it. If $location does not exist to start, that is not
2757 * considered an error.
2759 * @param string $location the path to remove.
2762 function fulldelete($location) {
2763 if (empty($location)) {
2764 // extra safety against wrong param
2767 if (is_dir($location)) {
2768 if (!$currdir = opendir($location)) {
2771 while (false !== ($file = readdir($currdir))) {
2772 if ($file <> ".." && $file <> ".") {
2773 $fullfile = $location."/".$file;
2774 if (is_dir($fullfile)) {
2775 if (!fulldelete($fullfile)) {
2779 if (!unlink($fullfile)) {
2786 if (! rmdir($location)) {
2790 } else if (file_exists($location)) {
2791 if (!unlink($location)) {
2799 * Send requested byterange of file.
2801 * @param resource $handle A file handle
2802 * @param string $mimetype The mimetype for the output
2803 * @param array $ranges An array of ranges to send
2804 * @param string $filesize The size of the content if only one range is used
2806 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2807 // better turn off any kind of compression and buffering
2808 ini_set('zlib.output_compression', 'Off');
2810 $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2811 if ($handle === false) {
2814 if (count($ranges) == 1) { //only one range requested
2815 $length = $ranges[0][2] - $ranges[0][1] +
1;
2816 header('HTTP/1.1 206 Partial content');
2817 header('Content-Length: '.$length);
2818 header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2819 header('Content-Type: '.$mimetype);
2821 while(@ob_get_level
()) {
2822 if (!@ob_end_flush
()) {
2827 fseek($handle, $ranges[0][1]);
2828 while (!feof($handle) && $length > 0) {
2829 core_php_time_limit
::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2830 $buffer = fread($handle, ($chunksize < $length ?
$chunksize : $length));
2833 $length -= strlen($buffer);
2837 } else { // multiple ranges requested - not tested much
2839 foreach($ranges as $range) {
2840 $totallength +
= strlen($range[0]) +
$range[2] - $range[1] +
1;
2842 $totallength +
= strlen("\r\n--".BYTESERVING_BOUNDARY
."--\r\n");
2843 header('HTTP/1.1 206 Partial content');
2844 header('Content-Length: '.$totallength);
2845 header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY
);
2847 while(@ob_get_level
()) {
2848 if (!@ob_end_flush
()) {
2853 foreach($ranges as $range) {
2854 $length = $range[2] - $range[1] +
1;
2856 fseek($handle, $range[1]);
2857 while (!feof($handle) && $length > 0) {
2858 core_php_time_limit
::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2859 $buffer = fread($handle, ($chunksize < $length ?
$chunksize : $length));
2862 $length -= strlen($buffer);
2865 echo "\r\n--".BYTESERVING_BOUNDARY
."--\r\n";
2872 * Tells whether the filename is executable.
2874 * @link http://php.net/manual/en/function.is-executable.php
2875 * @link https://bugs.php.net/bug.php?id=41062
2876 * @param string $filename Path to the file.
2877 * @return bool True if the filename exists and is executable; otherwise, false.
2879 function file_is_executable($filename) {
2880 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
2881 if (is_executable($filename)) {
2884 $fileext = strrchr($filename, '.');
2885 // If we have an extension we can check if it is listed as executable.
2886 if ($fileext && file_exists($filename) && !is_dir($filename)) {
2887 $winpathext = strtolower(getenv('PATHEXT'));
2888 $winpathexts = explode(';', $winpathext);
2890 return in_array(strtolower($fileext), $winpathexts);
2896 return is_executable($filename);
2901 * Overwrite an existing file in a draft area.
2903 * @param stored_file $newfile the new file with the new content and meta-data
2904 * @param stored_file $existingfile the file that will be overwritten
2905 * @throws moodle_exception
2908 function file_overwrite_existing_draftfile(stored_file
$newfile, stored_file
$existingfile) {
2909 if ($existingfile->get_component() != 'user' or $existingfile->get_filearea() != 'draft') {
2910 throw new coding_exception('The file to overwrite is not in a draft area.');
2913 $fs = get_file_storage();
2914 // Remember original file source field.
2915 $source = @unserialize
($existingfile->get_source());
2916 // Remember the original sortorder.
2917 $sortorder = $existingfile->get_sortorder();
2918 if ($newfile->is_external_file()) {
2919 // New file is a reference. Check that existing file does not have any other files referencing to it
2920 if (isset($source->original
) && $fs->search_references_count($source->original
)) {
2921 throw new moodle_exception('errordoublereference', 'repository');
2925 // Delete existing file to release filename.
2926 $newfilerecord = array(
2927 'contextid' => $existingfile->get_contextid(),
2928 'component' => 'user',
2929 'filearea' => 'draft',
2930 'itemid' => $existingfile->get_itemid(),
2931 'timemodified' => time()
2933 $existingfile->delete();
2936 $newfile = $fs->create_file_from_storedfile($newfilerecord, $newfile);
2937 // Preserve original file location (stored in source field) for handling references.
2938 if (isset($source->original
)) {
2939 if (!($newfilesource = @unserialize
($newfile->get_source()))) {
2940 $newfilesource = new stdClass();
2942 $newfilesource->original
= $source->original
;
2943 $newfile->set_source(serialize($newfilesource));
2945 $newfile->set_sortorder($sortorder);
2949 * Add files from a draft area into a final area.
2951 * Most of the time you do not want to use this. It is intended to be used
2952 * by asynchronous services which cannot direcly manipulate a final
2953 * area through a draft area. Instead they add files to a new draft
2954 * area and merge that new draft into the final area when ready.
2956 * @param int $draftitemid the id of the draft area to use.
2957 * @param int $contextid this parameter and the next two identify the file area to save to.
2958 * @param string $component component name
2959 * @param string $filearea indentifies the file area
2960 * @param int $itemid identifies the item id or false for all items in the file area
2961 * @param array $options area options (subdirs=false, maxfiles=-1, maxbytes=0, areamaxbytes=FILE_AREA_MAX_BYTES_UNLIMITED)
2962 * @see file_save_draft_area_files
2965 function file_merge_files_from_draft_area_into_filearea($draftitemid, $contextid, $component, $filearea, $itemid,
2966 array $options = null) {
2967 // We use 0 here so file_prepare_draft_area creates a new one, finaldraftid will be updated with the new draft id.
2969 file_prepare_draft_area($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
2970 file_merge_draft_area_into_draft_area($draftitemid, $finaldraftid);
2971 file_save_draft_area_files($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
2975 * Merge files from two draftarea areas.
2977 * This does not handle conflict resolution, files in the destination area which appear
2978 * to be more recent will be kept disregarding the intended ones.
2980 * @param int $getfromdraftid the id of the draft area where are the files to merge.
2981 * @param int $mergeintodraftid the id of the draft area where new files will be merged.
2982 * @throws coding_exception
2985 function file_merge_draft_area_into_draft_area($getfromdraftid, $mergeintodraftid) {
2988 $fs = get_file_storage();
2989 $contextid = context_user
::instance($USER->id
)->id
;
2991 if (!$filestomerge = $fs->get_area_files($contextid, 'user', 'draft', $getfromdraftid)) {
2992 throw new coding_exception('Nothing to merge or area does not belong to current user');
2995 $currentfiles = $fs->get_area_files($contextid, 'user', 'draft', $mergeintodraftid);
2997 // Get hashes of the files to merge.
2998 $newhashes = array();
2999 foreach ($filestomerge as $filetomerge) {
3000 $filepath = $filetomerge->get_filepath();
3001 $filename = $filetomerge->get_filename();
3003 $newhash = $fs->get_pathname_hash($contextid, 'user', 'draft', $mergeintodraftid, $filepath, $filename);
3004 $newhashes[$newhash] = $filetomerge;
3007 // Calculate wich files must be added.
3008 foreach ($currentfiles as $file) {
3009 $filehash = $file->get_pathnamehash();
3010 // One file to be merged already exists.
3011 if (isset($newhashes[$filehash])) {
3012 $updatedfile = $newhashes[$filehash];
3014 // Avoid race conditions.
3015 if ($file->get_timemodified() > $updatedfile->get_timemodified()) {
3016 // The existing file is more recent, do not copy the suposedly "new" one.
3017 unset($newhashes[$filehash]);
3020 // Update existing file (not only content, meta-data too).
3021 file_overwrite_existing_draftfile($updatedfile, $file);
3022 unset($newhashes[$filehash]);
3026 foreach ($newhashes as $newfile) {
3027 $newfilerecord = array(
3028 'contextid' => $contextid,
3029 'component' => 'user',
3030 'filearea' => 'draft',
3031 'itemid' => $mergeintodraftid,
3032 'timemodified' => time()
3035 $fs->create_file_from_storedfile($newfilerecord, $newfile);
3040 * Attempt to determine whether the specified mime-type is an SVG image or not.
3042 * @param string $mimetype Mime-type
3043 * @return bool True if it is an SVG file
3045 function file_is_svg_image_from_mimetype(string $mimetype): bool {
3046 return preg_match('|^image/svg|', $mimetype);
3050 * RESTful cURL class
3052 * This is a wrapper class for curl, it is quite easy to use:
3056 * $c = new curl(array('cache'=>true));
3058 * $c = new curl(array('cookie'=>true));
3060 * $c = new curl(array('proxy'=>true));
3062 * // HTTP GET Method
3063 * $html = $c->get('http://example.com');
3064 * // HTTP POST Method
3065 * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
3066 * // HTTP PUT Method
3067 * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
3070 * @package core_files
3072 * @copyright Dongsheng Cai <dongsheng@moodle.com>
3073 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
3076 /** @var bool Caches http request contents */
3077 public $cache = false;
3078 /** @var bool Uses proxy, null means automatic based on URL */
3079 public $proxy = null;
3080 /** @var string library version */
3081 public $version = '0.4 dev';
3082 /** @var array http's response */
3083 public $response = array();
3084 /** @var array Raw response headers, needed for BC in download_file_content(). */
3085 public $rawresponse = array();
3086 /** @var array http header */
3087 public $header = array();
3088 /** @var string cURL information */
3090 /** @var string error */
3092 /** @var int error code */
3094 /** @var bool Perform redirects at PHP level instead of relying on native cURL functionality. Always true now. */
3095 public $emulateredirects = null;
3097 /** @var array cURL options */
3100 /** @var string Proxy host */
3101 private $proxy_host = '';
3102 /** @var string Proxy auth */
3103 private $proxy_auth = '';
3104 /** @var string Proxy type */
3105 private $proxy_type = '';
3106 /** @var bool Debug mode on */
3107 private $debug = false;
3108 /** @var bool|string Path to cookie file */
3109 private $cookie = false;
3110 /** @var bool tracks multiple headers in response - redirect detection */
3111 private $responsefinished = false;
3112 /** @var security helper class, responsible for checking host/ports against allowed/blocked entries.*/
3113 private $securityhelper;
3114 /** @var bool ignoresecurity a flag which can be supplied to the constructor, allowing security to be bypassed. */
3115 private $ignoresecurity;
3116 /** @var array $mockresponses For unit testing only - return the head of this list instead of making the next request. */
3117 private static $mockresponses = [];
3122 * Allowed settings are:
3123 * proxy: (bool) use proxy server, null means autodetect non-local from url
3124 * debug: (bool) use debug output
3125 * cookie: (string) path to cookie file, false if none
3126 * cache: (bool) use cache
3127 * module_cache: (string) type of cache
3128 * securityhelper: (\core\files\curl_security_helper_base) helper object providing URL checking for requests.
3129 * ignoresecurity: (bool) set true to override and ignore the security helper when making requests.
3131 * @param array $settings
3133 public function __construct($settings = array()) {
3135 if (!function_exists('curl_init')) {
3136 $this->error
= 'cURL module must be enabled!';
3137 trigger_error($this->error
, E_USER_ERROR
);
3141 // All settings of this class should be init here.
3143 if (!empty($settings['debug'])) {
3144 $this->debug
= true;
3146 if (!empty($settings['cookie'])) {
3147 if($settings['cookie'] === true) {
3148 $this->cookie
= $CFG->dataroot
.'/curl_cookie.txt';
3150 $this->cookie
= $settings['cookie'];
3153 if (!empty($settings['cache'])) {
3154 if (class_exists('curl_cache')) {
3155 if (!empty($settings['module_cache'])) {
3156 $this->cache
= new curl_cache($settings['module_cache']);
3158 $this->cache
= new curl_cache('misc');
3162 if (!empty($CFG->proxyhost
)) {
3163 if (empty($CFG->proxyport
)) {
3164 $this->proxy_host
= $CFG->proxyhost
;
3166 $this->proxy_host
= $CFG->proxyhost
.':'.$CFG->proxyport
;
3168 if (!empty($CFG->proxyuser
) and !empty($CFG->proxypassword
)) {
3169 $this->proxy_auth
= $CFG->proxyuser
.':'.$CFG->proxypassword
;
3170 $this->setopt(array(
3171 'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM
,
3172 'proxyuserpwd'=>$this->proxy_auth
));
3174 if (!empty($CFG->proxytype
)) {
3175 if ($CFG->proxytype
== 'SOCKS5') {
3176 $this->proxy_type
= CURLPROXY_SOCKS5
;
3178 $this->proxy_type
= CURLPROXY_HTTP
;
3179 $this->setopt(array('httpproxytunnel'=>false));
3181 $this->setopt(array('proxytype'=>$this->proxy_type
));
3184 if (isset($settings['proxy'])) {
3185 $this->proxy
= $settings['proxy'];
3188 $this->proxy
= false;
3191 // All redirects are performed at PHP level now and each one is checked against blocked URLs rules. We do not
3192 // want to let cURL naively follow the redirect chain and visit every URL for security reasons. Even when the
3193 // caller explicitly wants to ignore the security checks, we would need to fall back to the original
3194 // implementation and use emulated redirects if open_basedir is in effect to avoid the PHP warning
3195 // "CURLOPT_FOLLOWLOCATION cannot be activated when in safe_mode or an open_basedir". So it is better to simply
3196 // ignore this property and always handle redirects at this PHP wrapper level and not inside the native cURL.
3197 $this->emulateredirects
= true;
3199 // Curl security setup. Allow injection of a security helper, but if not found, default to the core helper.
3200 if (isset($settings['securityhelper']) && $settings['securityhelper'] instanceof \core\files\curl_security_helper_base
) {
3201 $this->set_security($settings['securityhelper']);
3203 $this->set_security(new \core\files\
curl_security_helper());
3205 $this->ignoresecurity
= isset($settings['ignoresecurity']) ?
$settings['ignoresecurity'] : false;
3209 * Resets the CURL options that have already been set
3211 public function resetopt() {
3212 $this->options
= array();
3213 $this->options
['CURLOPT_USERAGENT'] = \core_useragent
::get_moodlebot_useragent();
3214 // True to include the header in the output
3215 $this->options
['CURLOPT_HEADER'] = 0;
3216 // True to Exclude the body from the output
3217 $this->options
['CURLOPT_NOBODY'] = 0;
3218 // Redirect ny default.
3219 $this->options
['CURLOPT_FOLLOWLOCATION'] = 1;
3220 $this->options
['CURLOPT_MAXREDIRS'] = 10;
3221 $this->options
['CURLOPT_ENCODING'] = '';
3222 // TRUE to return the transfer as a string of the return
3223 // value of curl_exec() instead of outputting it out directly.
3224 $this->options
['CURLOPT_RETURNTRANSFER'] = 1;
3225 $this->options
['CURLOPT_SSL_VERIFYPEER'] = 0;
3226 $this->options
['CURLOPT_SSL_VERIFYHOST'] = 2;
3227 $this->options
['CURLOPT_CONNECTTIMEOUT'] = 30;
3229 if ($cacert = self
::get_cacert()) {
3230 $this->options
['CURLOPT_CAINFO'] = $cacert;
3235 * Get the location of ca certificates.
3236 * @return string absolute file path or empty if default used
3238 public static function get_cacert() {
3241 // Bundle in dataroot always wins.
3242 if (is_readable("$CFG->dataroot/moodleorgca.crt")) {
3243 return realpath("$CFG->dataroot/moodleorgca.crt");
3246 // Next comes the default from php.ini
3247 $cacert = ini_get('curl.cainfo');
3248 if (!empty($cacert) and is_readable($cacert)) {
3249 return realpath($cacert);
3252 // Windows PHP does not have any certs, we need to use something.
3253 if ($CFG->ostype
=== 'WINDOWS') {
3254 if (is_readable("$CFG->libdir/cacert.pem")) {
3255 return realpath("$CFG->libdir/cacert.pem");
3259 // Use default, this should work fine on all properly configured *nix systems.
3266 public function resetcookie() {
3267 if (!empty($this->cookie
)) {
3268 if (is_file($this->cookie
)) {
3269 $fp = fopen($this->cookie
, 'w');
3281 * Do not use the curl constants to define the options, pass a string
3282 * corresponding to that constant. Ie. to set CURLOPT_MAXREDIRS, pass
3283 * array('CURLOPT_MAXREDIRS' => 10) or array('maxredirs' => 10) to this method.
3285 * @param array $options If array is null, this function will reset the options to default value.
3287 * @throws coding_exception If an option uses constant value instead of option name.
3289 public function setopt($options = array()) {
3290 if (is_array($options)) {
3291 foreach ($options as $name => $val) {
3292 if (!is_string($name)) {
3293 throw new coding_exception('Curl options should be defined using strings, not constant values.');
3295 if (stripos($name, 'CURLOPT_') === false) {
3296 $name = strtoupper('CURLOPT_'.$name);
3298 $name = strtoupper($name);
3300 $this->options
[$name] = $val;
3308 public function cleanopt() {
3309 unset($this->options
['CURLOPT_HTTPGET']);
3310 unset($this->options
['CURLOPT_POST']);
3311 unset($this->options
['CURLOPT_POSTFIELDS']);
3312 unset($this->options
['CURLOPT_PUT']);
3313 unset($this->options
['CURLOPT_INFILE']);
3314 unset($this->options
['CURLOPT_INFILESIZE']);
3315 unset($this->options
['CURLOPT_CUSTOMREQUEST']);
3316 unset($this->options
['CURLOPT_FILE']);
3320 * Resets the HTTP Request headers (to prepare for the new request)
3322 public function resetHeader() {
3323 $this->header
= array();
3327 * Set HTTP Request Header
3329 * @param array $header
3331 public function setHeader($header) {
3332 if (is_array($header)) {
3333 foreach ($header as $v) {
3334 $this->setHeader($v);
3337 // Remove newlines, they are not allowed in headers.
3338 $newvalue = preg_replace('/[\r\n]/', '', $header);
3339 if (!in_array($newvalue, $this->header
)) {
3340 $this->header
[] = $newvalue;
3346 * Get HTTP Response Headers
3347 * @return array of arrays
3349 public function getResponse() {
3350 return $this->response
;
3354 * Get raw HTTP Response Headers
3355 * @return array of strings
3357 public function get_raw_response() {
3358 return $this->rawresponse
;
3362 * private callback function
3363 * Formatting HTTP Response Header
3365 * We only keep the last headers returned. For example during a redirect the
3366 * redirect headers will not appear in {@link self::getResponse()}, if you need
3367 * to use those headers, refer to {@link self::get_raw_response()}.
3369 * @param resource $ch Apparently not used
3370 * @param string $header
3371 * @return int The strlen of the header
3373 private function formatHeader($ch, $header) {
3374 $this->rawresponse
[] = $header;
3376 if (trim($header, "\r\n") === '') {
3377 // This must be the last header.
3378 $this->responsefinished
= true;
3381 if (strlen($header) > 2) {
3382 if ($this->responsefinished
) {
3383 // We still have headers after the supposedly last header, we must be
3384 // in a redirect so let's empty the response to keep the last headers.
3385 $this->responsefinished
= false;
3386 $this->response
= array();
3388 $parts = explode(" ", rtrim($header, "\r\n"), 2);
3389 $key = rtrim($parts[0], ':');
3390 $value = isset($parts[1]) ?
$parts[1] : null;
3391 if (!empty($this->response
[$key])) {
3392 if (is_array($this->response
[$key])) {
3393 $this->response
[$key][] = $value;
3395 $tmp = $this->response
[$key];
3396 $this->response
[$key] = array();
3397 $this->response
[$key][] = $tmp;
3398 $this->response
[$key][] = $value;
3402 $this->response
[$key] = $value;
3405 return strlen($header);
3409 * Set options for individual curl instance
3411 * @param resource $curl A curl handle
3412 * @param array $options
3413 * @return resource The curl handle
3415 private function apply_opt($curl, $options) {
3419 if (!empty($this->cookie
) ||
!empty($options['cookie'])) {
3420 $this->setopt(array('cookiejar'=>$this->cookie
,
3421 'cookiefile'=>$this->cookie
3425 // Bypass proxy if required.
3426 if ($this->proxy
=== null) {
3427 if (!empty($this->options
['CURLOPT_URL']) and is_proxybypass($this->options
['CURLOPT_URL'])) {
3433 $proxy = (bool)$this->proxy
;
3438 $options['CURLOPT_PROXY'] = $this->proxy_host
;
3440 unset($this->options
['CURLOPT_PROXY']);
3443 $this->setopt($options);
3445 // Reset before set options.
3446 curl_setopt($curl, CURLOPT_HEADERFUNCTION
, array(&$this,'formatHeader'));
3448 // Setting the User-Agent based on options provided.
3451 if (!empty($options['CURLOPT_USERAGENT'])) {
3452 $useragent = $options['CURLOPT_USERAGENT'];
3453 } else if (!empty($this->options
['CURLOPT_USERAGENT'])) {
3454 $useragent = $this->options
['CURLOPT_USERAGENT'];
3456 $useragent = \core_useragent
::get_moodlebot_useragent();
3460 if (empty($this->header
)) {
3461 $this->setHeader(array(
3462 'User-Agent: ' . $useragent,
3463 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
3464 'Connection: keep-alive'
3466 } else if (!in_array('User-Agent: ' . $useragent, $this->header
)) {
3467 // Remove old User-Agent if one existed.
3468 // We have to partial search since we don't know what the original User-Agent is.
3469 if ($match = preg_grep('/User-Agent.*/', $this->header
)) {
3470 $key = array_keys($match)[0];
3471 unset($this->header
[$key]);
3473 $this->setHeader(array('User-Agent: ' . $useragent));
3475 curl_setopt($curl, CURLOPT_HTTPHEADER
, $this->header
);
3478 echo '<h1>Options</h1>';
3479 var_dump($this->options
);
3480 echo '<h1>Header</h1>';
3481 var_dump($this->header
);
3484 // Do not allow infinite redirects.
3485 if (!isset($this->options
['CURLOPT_MAXREDIRS'])) {
3486 $this->options
['CURLOPT_MAXREDIRS'] = 0;
3487 } else if ($this->options
['CURLOPT_MAXREDIRS'] > 100) {
3488 $this->options
['CURLOPT_MAXREDIRS'] = 100;
3490 $this->options
['CURLOPT_MAXREDIRS'] = (int)$this->options
['CURLOPT_MAXREDIRS'];
3493 // Make sure we always know if redirects expected.
3494 if (!isset($this->options
['CURLOPT_FOLLOWLOCATION'])) {
3495 $this->options
['CURLOPT_FOLLOWLOCATION'] = 0;
3498 // Limit the protocols to HTTP and HTTPS.
3499 if (defined('CURLOPT_PROTOCOLS')) {
3500 $this->options
['CURLOPT_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS
);
3501 $this->options
['CURLOPT_REDIR_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS
);
3505 foreach($this->options
as $name => $val) {
3506 if ($name === 'CURLOPT_FOLLOWLOCATION') {
3507 // All the redirects are emulated at PHP level.
3508 curl_setopt($curl, CURLOPT_FOLLOWLOCATION
, 0);
3511 $name = constant($name);
3512 curl_setopt($curl, $name, $val);
3519 * Download multiple files in parallel
3521 * Calls {@link multi()} with specific download headers
3525 * $file1 = fopen('a', 'wb');
3526 * $file2 = fopen('b', 'wb');
3527 * $c->download(array(
3528 * array('url'=>'http://localhost/', 'file'=>$file1),
3529 * array('url'=>'http://localhost/20/', 'file'=>$file2)
3539 * $c->download(array(
3540 * array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3541 * array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3545 * @param array $requests An array of files to request {
3546 * url => url to download the file [required]
3547 * file => file handler, or
3548 * filepath => file path
3550 * If 'file' and 'filepath' parameters are both specified in one request, the
3551 * open file handle in the 'file' parameter will take precedence and 'filepath'
3554 * @param array $options An array of options to set
3555 * @return array An array of results
3557 public function download($requests, $options = array()) {
3558 $options['RETURNTRANSFER'] = false;
3559 return $this->multi($requests, $options);
3563 * Returns the current curl security helper.
3565 * @return \core\files\curl_security_helper instance.
3567 public function get_security() {
3568 return $this->securityhelper
;
3572 * Sets the curl security helper.
3574 * @param \core\files\curl_security_helper $securityobject instance/subclass of the base curl_security_helper class.
3575 * @return bool true if the security helper could be set, false otherwise.
3577 public function set_security($securityobject) {
3578 if ($securityobject instanceof \core\files\curl_security_helper
) {
3579 $this->securityhelper
= $securityobject;
3586 * Multi HTTP Requests
3587 * This function could run multi-requests in parallel.
3589 * @param array $requests An array of files to request
3590 * @param array $options An array of options to set
3591 * @return array An array of results
3593 protected function multi($requests, $options = array()) {
3594 $count = count($requests);
3597 $main = curl_multi_init();
3598 for ($i = 0; $i < $count; $i++
) {
3599 if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3601 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3602 $requests[$i]['auto-handle'] = true;
3604 foreach($requests[$i] as $n=>$v) {
3607 $handles[$i] = curl_init($requests[$i]['url']);
3608 $this->apply_opt($handles[$i], $options);
3609 curl_multi_add_handle($main, $handles[$i]);
3613 curl_multi_exec($main, $running);
3614 } while($running > 0);
3615 for ($i = 0; $i < $count; $i++
) {
3616 if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3619 $results[] = curl_multi_getcontent($handles[$i]);
3621 curl_multi_remove_handle($main, $handles[$i]);
3623 curl_multi_close($main);
3625 for ($i = 0; $i < $count; $i++
) {
3626 if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3627 // close file handler if file is opened in this function
3628 fclose($requests[$i]['file']);
3635 * Helper function to reset the request state vars.
3639 protected function reset_request_state_vars() {
3640 $this->info
= array();
3643 $this->response
= array();
3644 $this->rawresponse
= array();
3645 $this->responsefinished
= false;
3649 * For use only in unit tests - we can pre-set the next curl response.
3650 * This is useful for unit testing APIs that call external systems.
3651 * @param string $response
3653 public static function mock_response($response) {
3654 if ((defined('PHPUNIT_TEST') && PHPUNIT_TEST
)) {
3655 array_push(self
::$mockresponses, $response);
3657 throw new coding_exception('mock_response function is only available for unit tests.');
3662 * check_securityhelper_blocklist.
3663 * Checks whether the given URL is blocked by checking both plugin's security helpers
3664 * and core curl security helper or any curl security helper that passed to curl class constructor.
3665 * If ignoresecurity is set to true, skip checking and consider the url is not blocked.
3666 * This augments all installed plugin's security helpers if there is any.
3668 * @param string $url the url to check.
3669 * @return string - an error message if URL is blocked or null if URL is not blocked.
3671 protected function check_securityhelper_blocklist(string $url): ?
string {
3673 // If curl security is not enabled, do not proceed.
3674 if ($this->ignoresecurity
) {
3678 // Augment all installed plugin's security helpers if there is any.
3679 // The plugin's function has to be defined as plugintype_pluginname_security_helper in pluginname/lib.php file.
3680 $plugintypes = get_plugins_with_function('curl_security_helper');
3682 // If any of the security helper's function returns true, treat as URL is blocked.
3683 foreach ($plugintypes as $plugins) {
3684 foreach ($plugins as $pluginfunction) {
3685 // Get curl security helper object from plugin lib.php.
3686 $pluginsecurityhelper = $pluginfunction();
3687 if ($pluginsecurityhelper instanceof \core\files\curl_security_helper_base
) {
3688 if ($pluginsecurityhelper->url_is_blocked($url)) {
3689 $this->error
= $pluginsecurityhelper->get_blocked_url_string();
3690 return $this->error
;
3696 // Check if the URL is blocked in core curl_security_helper or
3697 // curl security helper that passed to curl class constructor.
3698 if ($this->securityhelper
->url_is_blocked($url)) {
3699 $this->error
= $this->securityhelper
->get_blocked_url_string();
3700 return $this->error
;
3707 * Single HTTP Request
3709 * @param string $url The URL to request
3710 * @param array $options
3713 protected function request($url, $options = array()) {
3714 // Reset here so that the data is valid when result returned from cache, or if we return due to a blocked URL hit.
3715 $this->reset_request_state_vars();
3717 if ((defined('PHPUNIT_TEST') && PHPUNIT_TEST
)) {
3718 $mockresponse = array_pop(self
::$mockresponses);
3719 if ($mockresponse !== null) {
3720 $this->info
= [ 'http_code' => 200 ];
3721 return $mockresponse;
3725 if (empty($this->emulateredirects
)) {
3726 // Just in case someone had tried to explicitly disable emulated redirects in legacy code.
3727 debugging('Attempting to disable emulated redirects has no effect any more!', DEBUG_DEVELOPER
);
3730 $urlisblocked = $this->check_securityhelper_blocklist($url);
3731 if (!is_null($urlisblocked)) {
3732 return $urlisblocked;
3735 // Set the URL as a curl option.
3736 $this->setopt(array('CURLOPT_URL' => $url));
3738 // Create curl instance.
3739 $curl = curl_init();
3741 $this->apply_opt($curl, $options);
3742 if ($this->cache
&& $ret = $this->cache
->get($this->options
)) {
3746 $ret = curl_exec($curl);
3747 $this->info
= curl_getinfo($curl);
3748 $this->error
= curl_error($curl);
3749 $this->errno
= curl_errno($curl);
3750 // Note: $this->response and $this->rawresponse are filled by $hits->formatHeader callback.
3752 if (intval($this->info
['redirect_count']) > 0) {
3753 // For security reasons we do not allow the cURL handle to follow redirects on its own.
3754 // See setting CURLOPT_FOLLOWLOCATION in {@see self::apply_opt()} method.
3755 throw new coding_exception('Internal cURL handle should never follow redirects on its own!',
3756 'Reported number of redirects: ' . $this->info
['redirect_count']);
3759 if ($this->options
['CURLOPT_FOLLOWLOCATION'] && $this->info
['http_code'] != 200) {
3762 while($redirects <= $this->options
['CURLOPT_MAXREDIRS']) {
3764 if ($this->info
['http_code'] == 301) {
3765 // Moved Permanently - repeat the same request on new URL.
3767 } else if ($this->info
['http_code'] == 302) {
3768 // Found - the standard redirect - repeat the same request on new URL.
3770 } else if ($this->info
['http_code'] == 303) {
3771 // 303 See Other - repeat only if GET, do not bother with POSTs.
3772 if (empty($this->options
['CURLOPT_HTTPGET'])) {
3776 } else if ($this->info
['http_code'] == 307) {
3777 // Temporary Redirect - must repeat using the same request type.
3779 } else if ($this->info
['http_code'] == 308) {
3780 // Permanent Redirect - must repeat using the same request type.
3783 // Some other http code means do not retry!
3789 $redirecturl = null;
3790 if (isset($this->info
['redirect_url'])) {
3791 if (preg_match('|^https?://|i', $this->info
['redirect_url'])) {
3792 $redirecturl = $this->info
['redirect_url'];
3794 // Emulate CURLOPT_REDIR_PROTOCOLS behaviour which we have set to (CURLPROTO_HTTP | CURLPROTO_HTTPS) only.
3795 $this->errno
= CURLE_UNSUPPORTED_PROTOCOL
;
3796 $this->error
= 'Redirect to a URL with unsuported protocol: ' . $this->info
['redirect_url'];
3798 return $this->error
;
3801 if (!$redirecturl) {
3802 foreach ($this->response
as $k => $v) {
3803 if (strtolower($k) === 'location') {
3808 if (preg_match('|^https?://|i', $redirecturl)) {
3809 // Great, this is the correct location format!
3811 } else if ($redirecturl) {
3812 $current = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL
);
3813 if (strpos($redirecturl, '/') === 0) {
3814 // Relative to server root - just guess.
3815 $pos = strpos('/', $current, 8);
3816 if ($pos === false) {
3817 $redirecturl = $current.$redirecturl;
3819 $redirecturl = substr($current, 0, $pos).$redirecturl;
3822 // Relative to current script.
3823 $redirecturl = dirname($current).'/'.$redirecturl;
3828 $urlisblocked = $this->check_securityhelper_blocklist($redirecturl);
3829 if (!is_null($urlisblocked)) {
3830 $this->reset_request_state_vars();
3832 return $urlisblocked;
3835 // If the response body is written to a seekable stream resource, reset the stream pointer to avoid
3836 // appending multiple response bodies to the same resource.
3837 if (!empty($this->options
['CURLOPT_FILE'])) {
3838 $streammetadata = stream_get_meta_data($this->options
['CURLOPT_FILE']);
3839 if ($streammetadata['seekable']) {
3840 ftruncate($this->options
['CURLOPT_FILE'], 0);
3841 rewind($this->options
['CURLOPT_FILE']);
3845 curl_setopt($curl, CURLOPT_URL
, $redirecturl);
3846 $ret = curl_exec($curl);
3848 $this->info
= curl_getinfo($curl);
3849 $this->error
= curl_error($curl);
3850 $this->errno
= curl_errno($curl);
3852 $this->info
['redirect_count'] = $redirects;
3854 if ($this->info
['http_code'] === 200) {
3855 // Finally this is what we wanted.
3858 if ($this->errno
!= CURLE_OK
) {
3859 // Something wrong is going on.
3863 if ($redirects > $this->options
['CURLOPT_MAXREDIRS']) {
3864 $this->errno
= CURLE_TOO_MANY_REDIRECTS
;
3865 $this->error
= 'Maximum ('.$this->options
['CURLOPT_MAXREDIRS'].') redirects followed';
3870 $this->cache
->set($this->options
, $ret);
3874 echo '<h1>Return Data</h1>';
3876 echo '<h1>Info</h1>';
3877 var_dump($this->info
);
3878 echo '<h1>Error</h1>';
3879 var_dump($this->error
);
3884 if (empty($this->error
)) {
3887 return $this->error
;
3888 // exception is not ajax friendly
3889 //throw new moodle_exception($this->error, 'curl');
3898 * @param string $url
3899 * @param array $options
3902 public function head($url, $options = array()) {
3903 $options['CURLOPT_HTTPGET'] = 0;
3904 $options['CURLOPT_HEADER'] = 1;
3905 $options['CURLOPT_NOBODY'] = 1;
3906 return $this->request($url, $options);
3912 * @param string $url
3913 * @param array|string $params
3914 * @param array $options
3917 public function patch($url, $params = '', $options = array()) {
3918 $options['CURLOPT_CUSTOMREQUEST'] = 'PATCH';
3919 if (is_array($params)) {
3920 $this->_tmp_file_post_params
= array();
3921 foreach ($params as $key => $value) {
3922 if ($value instanceof stored_file
) {
3923 $value->add_to_curl_request($this, $key);
3925 $this->_tmp_file_post_params
[$key] = $value;
3928 $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params
;
3929 unset($this->_tmp_file_post_params
);
3931 // The variable $params is the raw post data.
3932 $options['CURLOPT_POSTFIELDS'] = $params;
3934 return $this->request($url, $options);
3940 * @param string $url
3941 * @param array|string $params
3942 * @param array $options
3945 public function post($url, $params = '', $options = array()) {
3946 $options['CURLOPT_POST'] = 1;
3947 if (is_array($params)) {
3948 $this->_tmp_file_post_params
= array();
3949 foreach ($params as $key => $value) {
3950 if ($value instanceof stored_file
) {
3951 $value->add_to_curl_request($this, $key);
3953 $this->_tmp_file_post_params
[$key] = $value;
3956 $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params
;
3957 unset($this->_tmp_file_post_params
);
3959 // $params is the raw post data
3960 $options['CURLOPT_POSTFIELDS'] = $params;
3962 return $this->request($url, $options);
3968 * @param string $url
3969 * @param array $params
3970 * @param array $options
3973 public function get($url, $params = array(), $options = array()) {
3974 $options['CURLOPT_HTTPGET'] = 1;
3976 if (!empty($params)) {
3977 $url .= (stripos($url, '?') !== false) ?
'&' : '?';
3978 $url .= http_build_query($params, '', '&');
3980 return $this->request($url, $options);
3984 * Downloads one file and writes it to the specified file handler
3988 * $file = fopen('savepath', 'w');
3989 * $result = $c->download_one('http://localhost/', null,
3990 * array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3992 * $download_info = $c->get_info();
3993 * if ($result === true) {
3994 * // file downloaded successfully
3996 * $error_text = $result;
3997 * $error_code = $c->get_errno();
4003 * $result = $c->download_one('http://localhost/', null,
4004 * array('filepath' => 'savepath', 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
4005 * // ... see above, no need to close handle and remove file if unsuccessful
4008 * @param string $url
4009 * @param array|null $params key-value pairs to be added to $url as query string
4010 * @param array $options request options. Must include either 'file' or 'filepath'
4011 * @return bool|string true on success or error string on failure
4013 public function download_one($url, $params, $options = array()) {
4014 $options['CURLOPT_HTTPGET'] = 1;
4015 if (!empty($params)) {
4016 $url .= (stripos($url, '?') !== false) ?
'&' : '?';
4017 $url .= http_build_query($params, '', '&');
4019 if (!empty($options['filepath']) && empty($options['file'])) {
4021 if (!($options['file'] = fopen($options['filepath'], 'w'))) {
4023 return get_string('cannotwritefile', 'error', $options['filepath']);
4025 $filepath = $options['filepath'];
4027 unset($options['filepath']);
4028 $result = $this->request($url, $options);
4029 if (isset($filepath)) {
4030 fclose($options['file']);
4031 if ($result !== true) {
4041 * @param string $url
4042 * @param array $params
4043 * @param array $options
4046 public function put($url, $params = array(), $options = array()) {
4049 if (isset($params['file'])) {
4050 $file = $params['file'];
4051 if (is_file($file)) {
4052 $fp = fopen($file, 'r');
4053 $size = filesize($file);
4054 $options['CURLOPT_PUT'] = 1;
4055 $options['CURLOPT_INFILESIZE'] = $size;
4056 $options['CURLOPT_INFILE'] = $fp;
4060 if (!isset($this->options
['CURLOPT_USERPWD'])) {
4061 $this->setopt(array('CURLOPT_USERPWD' => 'anonymous: noreply@moodle.org'));
4064 $options['CURLOPT_CUSTOMREQUEST'] = 'PUT';
4065 $options['CURLOPT_POSTFIELDS'] = $params;
4068 $ret = $this->request($url, $options);
4069 if ($fp !== false) {
4076 * HTTP DELETE method
4078 * @param string $url
4079 * @param array $param
4080 * @param array $options
4083 public function delete($url, $param = array(), $options = array()) {
4084 $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
4085 if (!isset($options['CURLOPT_USERPWD'])) {
4086 $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
4088 $ret = $this->request($url, $options);
4095 * @param string $url
4096 * @param array $options
4099 public function trace($url, $options = array()) {
4100 $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
4101 $ret = $this->request($url, $options);
4106 * HTTP OPTIONS method
4108 * @param string $url
4109 * @param array $options
4112 public function options($url, $options = array()) {
4113 $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
4114 $ret = $this->request($url, $options);
4119 * Get curl information
4123 public function get_info() {
4128 * Get curl error code
4132 public function get_errno() {
4133 return $this->errno
;
4137 * When using a proxy, an additional HTTP response code may appear at
4138 * the start of the header. For example, when using https over a proxy
4139 * there may be 'HTTP/1.0 200 Connection Established'. Other codes are
4140 * also possible and some may come with their own headers.
4142 * If using the return value containing all headers, this function can be
4143 * called to remove unwanted doubles.
4145 * Note that it is not possible to distinguish this situation from valid
4146 * data unless you know the actual response part (below the headers)
4147 * will not be included in this string, or else will not 'look like' HTTP
4148 * headers. As a result it is not safe to call this function for general
4151 * @param string $input Input HTTP response
4152 * @return string HTTP response with additional headers stripped if any
4154 public static function strip_double_headers($input) {
4155 // I have tried to make this regular expression as specific as possible
4156 // to avoid any case where it does weird stuff if you happen to put
4157 // HTTP/1.1 200 at the start of any line in your RSS file. This should
4158 // also make it faster because it can abandon regex processing as soon
4159 // as it hits something that doesn't look like an http header. The
4160 // header definition is taken from RFC 822, except I didn't support
4161 // folding which is never used in practice.
4163 return preg_replace(
4164 // HTTP version and status code (ignore value of code).
4165 '~^HTTP/[1-9](\.[0-9])?.*' . $crlf .
4166 // Header name: character between 33 and 126 decimal, except colon.
4167 // Colon. Header value: any character except \r and \n. CRLF.
4168 '(?:[\x21-\x39\x3b-\x7e]+:[^' . $crlf . ']+' . $crlf . ')*' .
4169 // Headers are terminated by another CRLF (blank line).
4171 // Second HTTP status code, this time must be 200.
4172 '(HTTP/[1-9](\.[0-9])? 200)~', '$2', $input);
4177 * This class is used by cURL class, use case:
4180 * $CFG->repositorycacheexpire = 120;
4181 * $CFG->curlcache = 120;
4183 * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
4184 * $ret = $c->get('http://www.google.com');
4187 * @package core_files
4188 * @copyright Dongsheng Cai <dongsheng@moodle.com>
4189 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4192 /** @var string Path to cache directory */
4198 * @global stdClass $CFG
4199 * @param string $module which module is using curl_cache
4201 public function __construct($module = 'repository') {
4203 if (!empty($module)) {
4204 $this->dir
= $CFG->cachedir
.'/'.$module.'/';
4206 $this->dir
= $CFG->cachedir
.'/misc/';
4208 if (!file_exists($this->dir
)) {
4209 mkdir($this->dir
, $CFG->directorypermissions
, true);
4211 if ($module == 'repository') {
4212 if (empty($CFG->repositorycacheexpire
)) {
4213 $CFG->repositorycacheexpire
= 120;
4215 $this->ttl
= $CFG->repositorycacheexpire
;
4217 if (empty($CFG->curlcache
)) {
4218 $CFG->curlcache
= 120;
4220 $this->ttl
= $CFG->curlcache
;
4227 * @global stdClass $CFG
4228 * @global stdClass $USER
4229 * @param mixed $param
4230 * @return bool|string
4232 public function get($param) {
4234 $this->cleanup($this->ttl
);
4235 $filename = 'u'.$USER->id
.'_'.md5(serialize($param));
4236 if(file_exists($this->dir
.$filename)) {
4237 $lasttime = filemtime($this->dir
.$filename);
4238 if (time()-$lasttime > $this->ttl
) {
4241 $fp = fopen($this->dir
.$filename, 'r');
4242 $size = filesize($this->dir
.$filename);
4243 $content = fread($fp, $size);
4244 return unserialize($content);
4253 * @global object $CFG
4254 * @global object $USER
4255 * @param mixed $param
4258 public function set($param, $val) {
4260 $filename = 'u'.$USER->id
.'_'.md5(serialize($param));
4261 $fp = fopen($this->dir
.$filename, 'w');
4262 fwrite($fp, serialize($val));
4264 @chmod
($this->dir
.$filename, $CFG->filepermissions
);
4268 * Remove cache files
4270 * @param int $expire The number of seconds before expiry
4272 public function cleanup($expire) {
4273 if ($dir = opendir($this->dir
)) {
4274 while (false !== ($file = readdir($dir))) {
4275 if(!is_dir($file) && $file != '.' && $file != '..') {
4276 $lasttime = @filemtime
($this->dir
.$file);
4277 if (time() - $lasttime > $expire) {
4278 @unlink
($this->dir
.$file);
4286 * delete current user's cache file
4288 * @global object $CFG
4289 * @global object $USER
4291 public function refresh() {
4293 if ($dir = opendir($this->dir
)) {
4294 while (false !== ($file = readdir($dir))) {
4295 if (!is_dir($file) && $file != '.' && $file != '..') {
4296 if (strpos($file, 'u'.$USER->id
.'_') !== false) {
4297 @unlink
($this->dir
.$file);
4306 * This function delegates file serving to individual plugins
4308 * @param string $relativepath
4309 * @param bool $forcedownload
4310 * @param null|string $preview the preview mode, defaults to serving the original file
4311 * @param boolean $offline If offline is requested - don't serve a redirect to an external file, return a file suitable for viewing
4312 * offline (e.g. mobile app).
4313 * @param bool $embed Whether this file will be served embed into an iframe.
4314 * @todo MDL-31088 file serving improments
4316 function file_pluginfile($relativepath, $forcedownload, $preview = null, $offline = false, $embed = false) {
4317 global $DB, $CFG, $USER;
4318 // relative path must start with '/'
4319 if (!$relativepath) {
4320 print_error('invalidargorconf');
4321 } else if ($relativepath[0] != '/') {
4322 print_error('pathdoesnotstartslash');
4325 // extract relative path components
4326 $args = explode('/', ltrim($relativepath, '/'));
4328 if (count($args) < 3) { // always at least context, component and filearea
4329 print_error('invalidarguments');
4332 $contextid = (int)array_shift($args);
4333 $component = clean_param(array_shift($args), PARAM_COMPONENT
);
4334 $filearea = clean_param(array_shift($args), PARAM_AREA
);
4336 list($context, $course, $cm) = get_context_info_array($contextid);
4338 $fs = get_file_storage();
4340 $sendfileoptions = ['preview' => $preview, 'offline' => $offline, 'embed' => $embed];
4342 // ========================================================================================================================
4343 if ($component === 'blog') {
4344 // Blog file serving
4345 if ($context->contextlevel
!= CONTEXT_SYSTEM
) {
4346 send_file_not_found();
4348 if ($filearea !== 'attachment' and $filearea !== 'post') {
4349 send_file_not_found();
4352 if (empty($CFG->enableblogs
)) {
4353 print_error('siteblogdisable', 'blog');
4356 $entryid = (int)array_shift($args);
4357 if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
4358 send_file_not_found();
4360 if ($CFG->bloglevel
< BLOG_GLOBAL_LEVEL
) {
4362 if (isguestuser()) {
4363 print_error('noguest');
4365 if ($CFG->bloglevel
== BLOG_USER_LEVEL
) {
4366 if ($USER->id
!= $entry->userid
) {
4367 send_file_not_found();
4372 if ($entry->publishstate
=== 'public') {
4373 if ($CFG->forcelogin
) {
4377 } else if ($entry->publishstate
=== 'site') {
4380 } else if ($entry->publishstate
=== 'draft') {
4382 if ($USER->id
!= $entry->userid
) {
4383 send_file_not_found();
4387 $filename = array_pop($args);
4388 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4390 if (!$file = $fs->get_file($context->id
, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
4391 send_file_not_found();
4394 send_stored_file($file, 10*60, 0, true, $sendfileoptions); // download MUST be forced - security!
4396 // ========================================================================================================================
4397 } else if ($component === 'grade') {
4399 require_once($CFG->libdir
. '/grade/constants.php');
4401 if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel
== CONTEXT_SYSTEM
) {
4402 // Global gradebook files
4403 if ($CFG->forcelogin
) {
4407 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
4409 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4410 send_file_not_found();
4413 \core\session\manager
::write_close(); // Unlock session during file serving.
4414 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4416 } else if ($filearea == GRADE_FEEDBACK_FILEAREA ||
$filearea == GRADE_HISTORY_FEEDBACK_FILEAREA
) {
4417 if ($context->contextlevel
!= CONTEXT_MODULE
) {
4418 send_file_not_found();
4421 require_login($course, false);
4423 $gradeid = (int) array_shift($args);
4424 $filename = array_pop($args);
4425 if ($filearea == GRADE_HISTORY_FEEDBACK_FILEAREA
) {
4426 $grade = $DB->get_record('grade_grades_history', ['id' => $gradeid]);
4428 $grade = $DB->get_record('grade_grades', ['id' => $gradeid]);
4432 send_file_not_found();
4435 $iscurrentuser = $USER->id
== $grade->userid
;
4437 if (!$iscurrentuser) {
4438 $coursecontext = context_course
::instance($course->id
);
4439 if (!has_capability('moodle/grade:viewall', $coursecontext)) {
4440 send_file_not_found();
4444 $fullpath = "/$context->id/$component/$filearea/$gradeid/$filename";
4446 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4447 send_file_not_found();
4450 \core\session\manager
::write_close(); // Unlock session during file serving.
4451 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4453 send_file_not_found();
4456 // ========================================================================================================================
4457 } else if ($component === 'tag') {
4458 if ($filearea === 'description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
4460 // All tag descriptions are going to be public but we still need to respect forcelogin
4461 if ($CFG->forcelogin
) {
4465 $fullpath = "/$context->id/tag/description/".implode('/', $args);
4467 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4468 send_file_not_found();
4471 \core\session\manager
::write_close(); // Unlock session during file serving.
4472 send_stored_file($file, 60*60, 0, true, $sendfileoptions);
4475 send_file_not_found();
4477 // ========================================================================================================================
4478 } else if ($component === 'badges') {
4479 require_once($CFG->libdir
. '/badgeslib.php');
4481 $badgeid = (int)array_shift($args);
4482 $badge = new badge($badgeid);
4483 $filename = array_pop($args);
4485 if ($filearea === 'badgeimage') {
4486 if ($filename !== 'f1' && $filename !== 'f2' && $filename !== 'f3') {
4487 send_file_not_found();
4489 if (!$file = $fs->get_file($context->id
, 'badges', 'badgeimage', $badge->id
, '/', $filename.'.png')) {
4490 send_file_not_found();
4493 \core\session\manager
::write_close();
4494 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4495 } else if ($filearea === 'userbadge' and $context->contextlevel
== CONTEXT_USER
) {
4496 if (!$file = $fs->get_file($context->id
, 'badges', 'userbadge', $badge->id
, '/', $filename.'.png')) {
4497 send_file_not_found();
4500 \core\session\manager
::write_close();
4501 send_stored_file($file, 60*60, 0, true, $sendfileoptions);
4503 // ========================================================================================================================
4504 } else if ($component === 'calendar') {
4505 if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
4507 // All events here are public the one requirement is that we respect forcelogin
4508 if ($CFG->forcelogin
) {
4512 // Get the event if from the args array
4513 $eventid = array_shift($args);
4515 // Load the event from the database
4516 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
4517 send_file_not_found();
4520 // Get the file and serve if successful
4521 $filename = array_pop($args);
4522 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4523 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4524 send_file_not_found();
4527 \core\session\manager
::write_close(); // Unlock session during file serving.
4528 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4530 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_USER
) {
4532 // Must be logged in, if they are not then they obviously can't be this user
4535 // Don't want guests here, potentially saves a DB call
4536 if (isguestuser()) {
4537 send_file_not_found();
4540 // Get the event if from the args array
4541 $eventid = array_shift($args);
4543 // Load the event from the database - user id must match
4544 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id
, 'eventtype'=>'user'))) {
4545 send_file_not_found();
4548 // Get the file and serve if successful
4549 $filename = array_pop($args);
4550 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4551 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4552 send_file_not_found();
4555 \core\session\manager
::write_close(); // Unlock session during file serving.
4556 send_stored_file($file, 0, 0, true, $sendfileoptions);
4558 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_COURSECAT
) {
4559 if ($CFG->forcelogin
) {
4563 // Get category, this will also validate access.
4564 $category = core_course_category
::get($context->instanceid
);
4566 // Get the event ID from the args array, load event.
4567 $eventid = array_shift($args);
4568 $event = $DB->get_record('event', [
4569 'id' => (int) $eventid,
4570 'eventtype' => 'category',
4571 'categoryid' => $category->id
,
4575 send_file_not_found();
4578 // Retrieve file from storage, and serve.
4579 $filename = array_pop($args);
4580 $filepath = $args ?
'/' . implode('/', $args) .'/' : '/';
4581 $file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename);
4582 if (!$file ||
$file->is_directory()) {
4583 send_file_not_found();
4586 // Unlock session during file serving.
4587 \core\session\manager
::write_close();
4588 send_stored_file($file, HOURSECS
, 0, $forcedownload, $sendfileoptions);
4589 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_COURSE
) {
4591 // Respect forcelogin and require login unless this is the site.... it probably
4592 // should NEVER be the site
4593 if ($CFG->forcelogin ||
$course->id
!= SITEID
) {
4594 require_login($course);
4597 // Must be able to at least view the course. This does not apply to the front page.
4598 if ($course->id
!= SITEID
&& (!is_enrolled($context)) && (!is_viewing($context))) {
4599 //TODO: hmm, do we really want to block guests here?
4600 send_file_not_found();
4604 $eventid = array_shift($args);
4606 // Load the event from the database we need to check whether it is
4607 // a) valid course event
4609 // Group events use the course context (there is no group context)
4610 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id
))) {
4611 send_file_not_found();
4614 // If its a group event require either membership of view all groups capability
4615 if ($event->eventtype
=== 'group') {
4616 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid
, $USER->id
)) {
4617 send_file_not_found();
4619 } else if ($event->eventtype
=== 'course' ||
$event->eventtype
=== 'site') {
4620 // Ok. Please note that the event type 'site' still uses a course context.
4623 send_file_not_found();
4626 // If we get this far we can serve the file
4627 $filename = array_pop($args);
4628 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4629 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4630 send_file_not_found();
4633 \core\session\manager
::write_close(); // Unlock session during file serving.
4634 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4637 send_file_not_found();
4640 // ========================================================================================================================
4641 } else if ($component === 'user') {
4642 if ($filearea === 'icon' and $context->contextlevel
== CONTEXT_USER
) {
4643 if (count($args) == 1) {
4644 $themename = theme_config
::DEFAULT_THEME
;
4645 $filename = array_shift($args);
4647 $themename = array_shift($args);
4648 $filename = array_shift($args);
4651 // fix file name automatically
4652 if ($filename !== 'f1' and $filename !== 'f2' and $filename !== 'f3') {
4656 if ((!empty($CFG->forcelogin
) and !isloggedin()) ||
4657 (!empty($CFG->forceloginforprofileimage
) && (!isloggedin() ||
isguestuser()))) {
4658 // protect images if login required and not logged in;
4659 // also if login is required for profile images and is not logged in or guest
4660 // do not use require_login() because it is expensive and not suitable here anyway
4661 $theme = theme_config
::load($themename);
4662 redirect($theme->image_url('u/'.$filename, 'moodle')); // intentionally not cached
4665 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'.png')) {
4666 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'.jpg')) {
4667 if ($filename === 'f3') {
4668 // f3 512x512px was introduced in 2.3, there might be only the smaller version.
4669 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', 'f1.png')) {
4670 $file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', 'f1.jpg');
4676 // bad reference - try to prevent future retries as hard as possible!
4677 if ($user = $DB->get_record('user', array('id'=>$context->instanceid
), 'id, picture')) {
4678 if ($user->picture
> 0) {
4679 $DB->set_field('user', 'picture', 0, array('id'=>$user->id
));
4682 // no redirect here because it is not cached
4683 $theme = theme_config
::load($themename);
4684 $imagefile = $theme->resolve_image_location('u/'.$filename, 'moodle', null);
4685 send_file($imagefile, basename($imagefile), 60*60*24*14);
4688 $options = $sendfileoptions;
4689 if (empty($CFG->forcelogin
) && empty($CFG->forceloginforprofileimage
)) {
4690 // Profile images should be cache-able by both browsers and proxies according
4691 // to $CFG->forcelogin and $CFG->forceloginforprofileimage.
4692 $options['cacheability'] = 'public';
4694 send_stored_file($file, 60*60*24*365, 0, false, $options); // enable long caching, there are many images on each page
4696 } else if ($filearea === 'private' and $context->contextlevel
== CONTEXT_USER
) {
4699 if (isguestuser()) {
4700 send_file_not_found();
4703 if ($USER->id
!== $context->instanceid
) {
4704 send_file_not_found();
4707 $filename = array_pop($args);
4708 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4709 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4710 send_file_not_found();
4713 \core\session\manager
::write_close(); // Unlock session during file serving.
4714 send_stored_file($file, 0, 0, true, $sendfileoptions); // must force download - security!
4716 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_USER
) {
4718 if ($CFG->forcelogin
) {
4722 $userid = $context->instanceid
;
4724 if (!empty($CFG->forceloginforprofiles
)) {
4725 require_once("{$CFG->dirroot}/user/lib.php");
4729 // Verify the current user is able to view the profile of the supplied user anywhere.
4730 $user = core_user
::get_user($userid);
4731 if (!user_can_view_profile($user, null, $context)) {
4732 send_file_not_found();
4736 $filename = array_pop($args);
4737 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4738 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4739 send_file_not_found();
4742 \core\session\manager
::write_close(); // Unlock session during file serving.
4743 send_stored_file($file, 0, 0, true, $sendfileoptions); // must force download - security!
4745 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_COURSE
) {
4746 $userid = (int)array_shift($args);
4747 $usercontext = context_user
::instance($userid);
4749 if ($CFG->forcelogin
) {
4753 if (!empty($CFG->forceloginforprofiles
)) {
4754 require_once("{$CFG->dirroot}/user/lib.php");
4758 // Verify the current user is able to view the profile of the supplied user in current course.
4759 $user = core_user
::get_user($userid);
4760 if (!user_can_view_profile($user, $course, $usercontext)) {
4761 send_file_not_found();
4765 $filename = array_pop($args);
4766 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4767 if (!$file = $fs->get_file($usercontext->id
, 'user', 'profile', 0, $filepath, $filename) or $file->is_directory()) {
4768 send_file_not_found();
4771 \core\session\manager
::write_close(); // Unlock session during file serving.
4772 send_stored_file($file, 0, 0, true, $sendfileoptions); // must force download - security!
4774 } else if ($filearea === 'backup' and $context->contextlevel
== CONTEXT_USER
) {
4777 if (isguestuser()) {
4778 send_file_not_found();
4780 $userid = $context->instanceid
;
4782 if ($USER->id
!= $userid) {
4783 send_file_not_found();
4786 $filename = array_pop($args);
4787 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4788 if (!$file = $fs->get_file($context->id
, 'user', 'backup', 0, $filepath, $filename) or $file->is_directory()) {
4789 send_file_not_found();
4792 \core\session\manager
::write_close(); // Unlock session during file serving.
4793 send_stored_file($file, 0, 0, true, $sendfileoptions); // must force download - security!
4796 send_file_not_found();
4799 // ========================================================================================================================
4800 } else if ($component === 'coursecat') {
4801 if ($context->contextlevel
!= CONTEXT_COURSECAT
) {
4802 send_file_not_found();
4805 if ($filearea === 'description') {
4806 if ($CFG->forcelogin
) {
4807 // no login necessary - unless login forced everywhere
4811 // Check if user can view this category.
4812 if (!core_course_category
::get($context->instanceid
, IGNORE_MISSING
)) {
4813 send_file_not_found();
4816 $filename = array_pop($args);
4817 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4818 if (!$file = $fs->get_file($context->id
, 'coursecat', 'description', 0, $filepath, $filename) or $file->is_directory()) {
4819 send_file_not_found();
4822 \core\session\manager
::write_close(); // Unlock session during file serving.
4823 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4825 send_file_not_found();
4828 // ========================================================================================================================
4829 } else if ($component === 'course') {
4830 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4831 send_file_not_found();
4834 if ($filearea === 'summary' ||
$filearea === 'overviewfiles') {
4835 if ($CFG->forcelogin
) {
4839 $filename = array_pop($args);
4840 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4841 if (!$file = $fs->get_file($context->id
, 'course', $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4842 send_file_not_found();
4845 \core\session\manager
::write_close(); // Unlock session during file serving.
4846 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4848 } else if ($filearea === 'section') {
4849 if ($CFG->forcelogin
) {
4850 require_login($course);
4851 } else if ($course->id
!= SITEID
) {
4852 require_login($course);
4855 $sectionid = (int)array_shift($args);
4857 if (!$section = $DB->get_record('course_sections', array('id'=>$sectionid, 'course'=>$course->id
))) {
4858 send_file_not_found();
4861 $filename = array_pop($args);
4862 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4863 if (!$file = $fs->get_file($context->id
, 'course', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4864 send_file_not_found();
4867 \core\session\manager
::write_close(); // Unlock session during file serving.
4868 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4871 send_file_not_found();
4874 } else if ($component === 'cohort') {
4876 $cohortid = (int)array_shift($args);
4877 $cohort = $DB->get_record('cohort', array('id' => $cohortid), '*', MUST_EXIST
);
4878 $cohortcontext = context
::instance_by_id($cohort->contextid
);
4880 // The context in the file URL must be either cohort context or context of the course underneath the cohort's context.
4881 if ($context->id
!= $cohort->contextid
&&
4882 ($context->contextlevel
!= CONTEXT_COURSE ||
!in_array($cohort->contextid
, $context->get_parent_context_ids()))) {
4883 send_file_not_found();
4886 // User is able to access cohort if they have view cap on cohort level or
4887 // the cohort is visible and they have view cap on course level.
4888 $canview = has_capability('moodle/cohort:view', $cohortcontext) ||
4889 ($cohort->visible
&& has_capability('moodle/cohort:view', $context));
4891 if ($filearea === 'description' && $canview) {
4892 $filename = array_pop($args);
4893 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4894 if (($file = $fs->get_file($cohortcontext->id
, 'cohort', 'description', $cohort->id
, $filepath, $filename))
4895 && !$file->is_directory()) {
4896 \core\session\manager
::write_close(); // Unlock session during file serving.
4897 send_stored_file($file, 60 * 60, 0, $forcedownload, $sendfileoptions);
4901 send_file_not_found();
4903 } else if ($component === 'group') {
4904 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4905 send_file_not_found();
4908 require_course_login($course, true, null, false);
4910 $groupid = (int)array_shift($args);
4912 $group = $DB->get_record('groups', array('id'=>$groupid, 'courseid'=>$course->id
), '*', MUST_EXIST
);
4913 if (($course->groupmodeforce
and $course->groupmode
== SEPARATEGROUPS
) and !has_capability('moodle/site:accessallgroups', $context) and !groups_is_member($group->id
, $USER->id
)) {
4914 // do not allow access to separate group info if not member or teacher
4915 send_file_not_found();
4918 if ($filearea === 'description') {
4920 require_login($course);
4922 $filename = array_pop($args);
4923 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4924 if (!$file = $fs->get_file($context->id
, 'group', 'description', $group->id
, $filepath, $filename) or $file->is_directory()) {
4925 send_file_not_found();
4928 \core\session\manager
::write_close(); // Unlock session during file serving.
4929 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4931 } else if ($filearea === 'icon') {
4932 $filename = array_pop($args);
4934 if ($filename !== 'f1' and $filename !== 'f2') {
4935 send_file_not_found();
4937 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.png')) {
4938 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.jpg')) {
4939 send_file_not_found();
4943 \core\session\manager
::write_close(); // Unlock session during file serving.
4944 send_stored_file($file, 60*60, 0, false, $sendfileoptions);
4947 send_file_not_found();
4950 } else if ($component === 'grouping') {
4951 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4952 send_file_not_found();
4955 require_login($course);
4957 $groupingid = (int)array_shift($args);
4959 // note: everybody has access to grouping desc images for now
4960 if ($filearea === 'description') {
4962 $filename = array_pop($args);
4963 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4964 if (!$file = $fs->get_file($context->id
, 'grouping', 'description', $groupingid, $filepath, $filename) or $file->is_directory()) {
4965 send_file_not_found();
4968 \core\session\manager
::write_close(); // Unlock session during file serving.
4969 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
4972 send_file_not_found();
4975 // ========================================================================================================================
4976 } else if ($component === 'backup') {
4977 if ($filearea === 'course' and $context->contextlevel
== CONTEXT_COURSE
) {
4978 require_login($course);
4979 require_capability('moodle/backup:downloadfile', $context);
4981 $filename = array_pop($args);
4982 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4983 if (!$file = $fs->get_file($context->id
, 'backup', 'course', 0, $filepath, $filename) or $file->is_directory()) {
4984 send_file_not_found();
4987 \core\session\manager
::write_close(); // Unlock session during file serving.
4988 send_stored_file($file, 0, 0, $forcedownload, $sendfileoptions);
4990 } else if ($filearea === 'section' and $context->contextlevel
== CONTEXT_COURSE
) {
4991 require_login($course);
4992 require_capability('moodle/backup:downloadfile', $context);
4994 $sectionid = (int)array_shift($args);
4996 $filename = array_pop($args);
4997 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4998 if (!$file = $fs->get_file($context->id
, 'backup', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4999 send_file_not_found();
5002 \core\session\manager
::write_close();
5003 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
5005 } else if ($filearea === 'activity' and $context->contextlevel
== CONTEXT_MODULE
) {
5006 require_login($course, false, $cm);
5007 require_capability('moodle/backup:downloadfile', $context);
5009 $filename = array_pop($args);
5010 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
5011 if (!$file = $fs->get_file($context->id
, 'backup', 'activity', 0, $filepath, $filename) or $file->is_directory()) {
5012 send_file_not_found();
5015 \core\session\manager
::write_close();
5016 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
5018 } else if ($filearea === 'automated' and $context->contextlevel
== CONTEXT_COURSE
) {
5019 // Backup files that were generated by the automated backup systems.
5021 require_login($course);
5022 require_capability('moodle/backup:downloadfile', $context);
5023 require_capability('moodle/restore:userinfo', $context);
5025 $filename = array_pop($args);
5026 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
5027 if (!$file = $fs->get_file($context->id
, 'backup', 'automated', 0, $filepath, $filename) or $file->is_directory()) {
5028 send_file_not_found();
5031 \core\session\manager
::write_close(); // Unlock session during file serving.
5032 send_stored_file($file, 0, 0, $forcedownload, $sendfileoptions);
5035 send_file_not_found();
5038 // ========================================================================================================================
5039 } else if ($component === 'question') {
5040 require_once($CFG->libdir
. '/questionlib.php');
5041 question_pluginfile($course, $context, 'question', $filearea, $args, $forcedownload, $sendfileoptions);
5042 send_file_not_found();
5044 // ========================================================================================================================
5045 } else if ($component === 'grading') {
5046 if ($filearea === 'description') {
5047 // files embedded into the form definition description
5049 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
5052 } else if ($context->contextlevel
>= CONTEXT_COURSE
) {
5053 require_login($course, false, $cm);
5056 send_file_not_found();
5059 $formid = (int)array_shift($args);
5061 $sql = "SELECT ga.id
5062 FROM {grading_areas} ga
5063 JOIN {grading_definitions} gd ON (gd.areaid = ga.id)
5064 WHERE gd.id = ? AND ga.contextid = ?";
5065 $areaid = $DB->get_field_sql($sql, array($formid, $context->id
), IGNORE_MISSING
);
5068 send_file_not_found();
5071 $fullpath = "/$context->id/$component/$filearea/$formid/".implode('/', $args);
5073 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
5074 send_file_not_found();
5077 \core\session\manager
::write_close(); // Unlock session during file serving.
5078 send_stored_file($file, 60*60, 0, $forcedownload, $sendfileoptions);
5080 } else if ($component === 'contentbank') {
5081 if ($filearea != 'public' ||
isguestuser()) {
5082 send_file_not_found();
5085 if ($context->contextlevel
== CONTEXT_SYSTEM ||
$context->contextlevel
== CONTEXT_COURSECAT
) {
5087 } else if ($context->contextlevel
== CONTEXT_COURSE
) {
5088 require_login($course);
5090 send_file_not_found();
5093 $itemid = (int)array_shift($args);
5094 $filename = array_pop($args);
5095 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
5096 if (!$file = $fs->get_file($context->id
, $component, $filearea, $itemid, $filepath, $filename) or
5097 $file->is_directory()) {
5098 send_file_not_found();
5101 \core\session\manager
::write_close(); // Unlock session during file serving.
5102 send_stored_file($file, 0, 0, true, $sendfileoptions); // must force download - security!
5103 } else if (strpos($component, 'mod_') === 0) {
5104 $modname = substr($component, 4);
5105 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
5106 send_file_not_found();
5108 require_once("$CFG->dirroot/mod/$modname/lib.php");
5110 if ($context->contextlevel
== CONTEXT_MODULE
) {
5111 if ($cm->modname
!== $modname) {
5112 // somebody tries to gain illegal access, cm type must match the component!
5113 send_file_not_found();
5117 if ($filearea === 'intro') {
5118 if (!plugin_supports('mod', $modname, FEATURE_MOD_INTRO
, true)) {
5119 send_file_not_found();
5122 // Require login to the course first (without login to the module).
5123 require_course_login($course, true);
5125 // Now check if module is available OR it is restricted but the intro is shown on the course page.
5126 $cminfo = cm_info
::create($cm);
5127 if (!$cminfo->uservisible
) {
5128 if (!$cm->showdescription ||
!$cminfo->is_visible_on_course_page()) {
5129 // Module intro is not visible on the course page and module is not available, show access error.
5130 require_course_login($course, true, $cminfo);
5134 // all users may access it
5135 $filename = array_pop($args);
5136 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
5137 if (!$file = $fs->get_file($context->id
, 'mod_'.$modname, 'intro', 0, $filepath, $filename) or $file->is_directory()) {
5138 send_file_not_found();
5141 // finally send the file
5142 send_stored_file($file, null, 0, false, $sendfileoptions);
5145 $filefunction = $component.'_pluginfile';
5146 $filefunctionold = $modname.'_pluginfile';
5147 if (function_exists($filefunction)) {
5148 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
5149 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, $sendfileoptions);
5150 } else if (function_exists($filefunctionold)) {
5151 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
5152 $filefunctionold($course, $cm, $context, $filearea, $args, $forcedownload, $sendfileoptions);
5155 send_file_not_found();
5157 // ========================================================================================================================
5158 } else if (strpos($component, 'block_') === 0) {
5159 $blockname = substr($component, 6);
5160 // note: no more class methods in blocks please, that is ....
5161 if (!file_exists("$CFG->dirroot/blocks/$blockname/lib.php")) {
5162 send_file_not_found();
5164 require_once("$CFG->dirroot/blocks/$blockname/lib.php");
5166 if ($context->contextlevel
== CONTEXT_BLOCK
) {
5167 $birecord = $DB->get_record('block_instances', array('id'=>$context->instanceid
), '*',MUST_EXIST
);
5168 if ($birecord->blockname
!== $blockname) {
5169 // somebody tries to gain illegal access, cm type must match the component!
5170 send_file_not_found();
5173 if ($context->get_course_context(false)) {
5174 // If block is in course context, then check if user has capability to access course.
5175 require_course_login($course);
5176 } else if ($CFG->forcelogin
) {
5177 // If user is logged out, bp record will not be visible, even if the user would have access if logged in.
5181 $bprecord = $DB->get_record('block_positions', array('contextid' => $context->id
, 'blockinstanceid' => $context->instanceid
));
5182 // User can't access file, if block is hidden or doesn't have block:view capability
5183 if (($bprecord && !$bprecord->visible
) ||
!has_capability('moodle/block:view', $context)) {
5184 send_file_not_found();
5190 $filefunction = $component.'_pluginfile';
5191 if (function_exists($filefunction)) {
5192 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
5193 $filefunction($course, $birecord, $context, $filearea, $args, $forcedownload, $sendfileoptions);
5196 send_file_not_found();
5198 // ========================================================================================================================
5199 } else if (strpos($component, '_') === false) {
5200 // all core subsystems have to be specified above, no more guessing here!
5201 send_file_not_found();
5204 // try to serve general plugin file in arbitrary context
5205 $dir = core_component
::get_component_directory($component);
5206 if (!file_exists("$dir/lib.php")) {
5207 send_file_not_found();
5209 include_once("$dir/lib.php");
5211 $filefunction = $component.'_pluginfile';
5212 if (function_exists($filefunction)) {
5213 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
5214 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, $sendfileoptions);
5217 send_file_not_found();