Moodle release 2.9
[moodle.git] / lib / filelib.php
blobb893cf22f986152eb121a062679f494d64979a72
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17 /**
18 * Functions for file handling.
20 * @package core_files
21 * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 defined('MOODLE_INTERNAL') || die();
27 /**
28 * BYTESERVING_BOUNDARY - string unique string constant.
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
32 /**
33 * Unlimited area size constant
35 define('FILE_AREA_MAX_BYTES_UNLIMITED', -1);
37 require_once("$CFG->libdir/filestorage/file_exceptions.php");
38 require_once("$CFG->libdir/filestorage/file_storage.php");
39 require_once("$CFG->libdir/filestorage/zip_packer.php");
40 require_once("$CFG->libdir/filebrowser/file_browser.php");
42 /**
43 * Encodes file serving url
45 * @deprecated use moodle_url factory methods instead
47 * @todo MDL-31071 deprecate this function
48 * @global stdClass $CFG
49 * @param string $urlbase
50 * @param string $path /filearea/itemid/dir/dir/file.exe
51 * @param bool $forcedownload
52 * @param bool $https https url required
53 * @return string encoded file url
55 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
56 global $CFG;
58 //TODO: deprecate this
60 if ($CFG->slasharguments) {
61 $parts = explode('/', $path);
62 $parts = array_map('rawurlencode', $parts);
63 $path = implode('/', $parts);
64 $return = $urlbase.$path;
65 if ($forcedownload) {
66 $return .= '?forcedownload=1';
68 } else {
69 $path = rawurlencode($path);
70 $return = $urlbase.'?file='.$path;
71 if ($forcedownload) {
72 $return .= '&amp;forcedownload=1';
76 if ($https) {
77 $return = str_replace('http://', 'https://', $return);
80 return $return;
83 /**
84 * Detects if area contains subdirs,
85 * this is intended for file areas that are attached to content
86 * migrated from 1.x where subdirs were allowed everywhere.
88 * @param context $context
89 * @param string $component
90 * @param string $filearea
91 * @param string $itemid
92 * @return bool
94 function file_area_contains_subdirs(context $context, $component, $filearea, $itemid) {
95 global $DB;
97 if (!isset($itemid)) {
98 // Not initialised yet.
99 return false;
102 // Detect if any directories are already present, this is necessary for content upgraded from 1.x.
103 $select = "contextid = :contextid AND component = :component AND filearea = :filearea AND itemid = :itemid AND filepath <> '/' AND filename = '.'";
104 $params = array('contextid'=>$context->id, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
105 return $DB->record_exists_select('files', $select, $params);
109 * Prepares 'editor' formslib element from data in database
111 * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
112 * function then copies the embedded files into draft area (assigning itemids automatically),
113 * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
114 * displayed.
115 * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
116 * your mform's set_data() supplying the object returned by this function.
118 * @category files
119 * @param stdClass $data database field that holds the html text with embedded media
120 * @param string $field the name of the database field that holds the html text with embedded media
121 * @param array $options editor options (like maxifiles, maxbytes etc.)
122 * @param stdClass $context context of the editor
123 * @param string $component
124 * @param string $filearea file area name
125 * @param int $itemid item id, required if item exists
126 * @return stdClass modified data object
128 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
129 $options = (array)$options;
130 if (!isset($options['trusttext'])) {
131 $options['trusttext'] = false;
133 if (!isset($options['forcehttps'])) {
134 $options['forcehttps'] = false;
136 if (!isset($options['subdirs'])) {
137 $options['subdirs'] = false;
139 if (!isset($options['maxfiles'])) {
140 $options['maxfiles'] = 0; // no files by default
142 if (!isset($options['noclean'])) {
143 $options['noclean'] = false;
146 //sanity check for passed context. This function doesn't expect $option['context'] to be set
147 //But this function is called before creating editor hence, this is one of the best places to check
148 //if context is used properly. This check notify developer that they missed passing context to editor.
149 if (isset($context) && !isset($options['context'])) {
150 //if $context is not null then make sure $option['context'] is also set.
151 debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER);
152 } else if (isset($options['context']) && isset($context)) {
153 //If both are passed then they should be equal.
154 if ($options['context']->id != $context->id) {
155 $exceptionmsg = 'Editor context ['.$options['context']->id.'] is not equal to passed context ['.$context->id.']';
156 throw new coding_exception($exceptionmsg);
160 if (is_null($itemid) or is_null($context)) {
161 $contextid = null;
162 $itemid = null;
163 if (!isset($data)) {
164 $data = new stdClass();
166 if (!isset($data->{$field})) {
167 $data->{$field} = '';
169 if (!isset($data->{$field.'format'})) {
170 $data->{$field.'format'} = editors_get_preferred_format();
172 if (!$options['noclean']) {
173 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
176 } else {
177 if ($options['trusttext']) {
178 // noclean ignored if trusttext enabled
179 if (!isset($data->{$field.'trust'})) {
180 $data->{$field.'trust'} = 0;
182 $data = trusttext_pre_edit($data, $field, $context);
183 } else {
184 if (!$options['noclean']) {
185 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
188 $contextid = $context->id;
191 if ($options['maxfiles'] != 0) {
192 $draftid_editor = file_get_submitted_draft_itemid($field);
193 $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
194 $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
195 } else {
196 $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
199 return $data;
203 * Prepares the content of the 'editor' form element with embedded media files to be saved in database
205 * This function moves files from draft area to the destination area and
206 * encodes URLs to the draft files so they can be safely saved into DB. The
207 * form has to contain the 'editor' element named foobar_editor, where 'foobar'
208 * is the name of the database field to hold the wysiwyg editor content. The
209 * editor data comes as an array with text, format and itemid properties. This
210 * function automatically adds $data properties foobar, foobarformat and
211 * foobartrust, where foobar has URL to embedded files encoded.
213 * @category files
214 * @param stdClass $data raw data submitted by the form
215 * @param string $field name of the database field containing the html with embedded media files
216 * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
217 * @param stdClass $context context, required for existing data
218 * @param string $component file component
219 * @param string $filearea file area name
220 * @param int $itemid item id, required if item exists
221 * @return stdClass modified data object
223 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
224 $options = (array)$options;
225 if (!isset($options['trusttext'])) {
226 $options['trusttext'] = false;
228 if (!isset($options['forcehttps'])) {
229 $options['forcehttps'] = false;
231 if (!isset($options['subdirs'])) {
232 $options['subdirs'] = false;
234 if (!isset($options['maxfiles'])) {
235 $options['maxfiles'] = 0; // no files by default
237 if (!isset($options['maxbytes'])) {
238 $options['maxbytes'] = 0; // unlimited
241 if ($options['trusttext']) {
242 $data->{$field.'trust'} = trusttext_trusted($context);
243 } else {
244 $data->{$field.'trust'} = 0;
247 $editor = $data->{$field.'_editor'};
249 if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
250 $data->{$field} = $editor['text'];
251 } else {
252 $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
254 $data->{$field.'format'} = $editor['format'];
256 return $data;
260 * Saves text and files modified by Editor formslib element
262 * @category files
263 * @param stdClass $data $database entry field
264 * @param string $field name of data field
265 * @param array $options various options
266 * @param stdClass $context context - must already exist
267 * @param string $component
268 * @param string $filearea file area name
269 * @param int $itemid must already exist, usually means data is in db
270 * @return stdClass modified data obejct
272 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
273 $options = (array)$options;
274 if (!isset($options['subdirs'])) {
275 $options['subdirs'] = false;
277 if (is_null($itemid) or is_null($context)) {
278 $itemid = null;
279 $contextid = null;
280 } else {
281 $contextid = $context->id;
284 $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
285 file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
286 $data->{$field.'_filemanager'} = $draftid_editor;
288 return $data;
292 * Saves files modified by File manager formslib element
294 * @todo MDL-31073 review this function
295 * @category files
296 * @param stdClass $data $database entry field
297 * @param string $field name of data field
298 * @param array $options various options
299 * @param stdClass $context context - must already exist
300 * @param string $component
301 * @param string $filearea file area name
302 * @param int $itemid must already exist, usually means data is in db
303 * @return stdClass modified data obejct
305 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
306 $options = (array)$options;
307 if (!isset($options['subdirs'])) {
308 $options['subdirs'] = false;
310 if (!isset($options['maxfiles'])) {
311 $options['maxfiles'] = -1; // unlimited
313 if (!isset($options['maxbytes'])) {
314 $options['maxbytes'] = 0; // unlimited
317 if (empty($data->{$field.'_filemanager'})) {
318 $data->$field = '';
320 } else {
321 file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id, $component, $filearea, $itemid, $options);
322 $fs = get_file_storage();
324 if ($fs->get_area_files($context->id, $component, $filearea, $itemid)) {
325 $data->$field = '1'; // TODO: this is an ugly hack (skodak)
326 } else {
327 $data->$field = '';
331 return $data;
335 * Generate a draft itemid
337 * @category files
338 * @global moodle_database $DB
339 * @global stdClass $USER
340 * @return int a random but available draft itemid that can be used to create a new draft
341 * file area.
343 function file_get_unused_draft_itemid() {
344 global $DB, $USER;
346 if (isguestuser() or !isloggedin()) {
347 // guests and not-logged-in users can not be allowed to upload anything!!!!!!
348 print_error('noguest');
351 $contextid = context_user::instance($USER->id)->id;
353 $fs = get_file_storage();
354 $draftitemid = rand(1, 999999999);
355 while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
356 $draftitemid = rand(1, 999999999);
359 return $draftitemid;
363 * Initialise a draft file area from a real one by copying the files. A draft
364 * area will be created if one does not already exist. Normally you should
365 * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
367 * @category files
368 * @global stdClass $CFG
369 * @global stdClass $USER
370 * @param int $draftitemid the id of the draft area to use, or 0 to create a new one, in which case this parameter is updated.
371 * @param int $contextid This parameter and the next two identify the file area to copy files from.
372 * @param string $component
373 * @param string $filearea helps indentify the file area.
374 * @param int $itemid helps identify the file area. Can be null if there are no files yet.
375 * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
376 * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
377 * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
379 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
380 global $CFG, $USER, $CFG;
382 $options = (array)$options;
383 if (!isset($options['subdirs'])) {
384 $options['subdirs'] = false;
386 if (!isset($options['forcehttps'])) {
387 $options['forcehttps'] = false;
390 $usercontext = context_user::instance($USER->id);
391 $fs = get_file_storage();
393 if (empty($draftitemid)) {
394 // create a new area and copy existing files into
395 $draftitemid = file_get_unused_draft_itemid();
396 $file_record = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
397 if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
398 foreach ($files as $file) {
399 if ($file->is_directory() and $file->get_filepath() === '/') {
400 // we need a way to mark the age of each draft area,
401 // by not copying the root dir we force it to be created automatically with current timestamp
402 continue;
404 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
405 continue;
407 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
408 // XXX: This is a hack for file manager (MDL-28666)
409 // File manager needs to know the original file information before copying
410 // to draft area, so we append these information in mdl_files.source field
411 // {@link file_storage::search_references()}
412 // {@link file_storage::search_references_count()}
413 $sourcefield = $file->get_source();
414 $newsourcefield = new stdClass;
415 $newsourcefield->source = $sourcefield;
416 $original = new stdClass;
417 $original->contextid = $contextid;
418 $original->component = $component;
419 $original->filearea = $filearea;
420 $original->itemid = $itemid;
421 $original->filename = $file->get_filename();
422 $original->filepath = $file->get_filepath();
423 $newsourcefield->original = file_storage::pack_reference($original);
424 $draftfile->set_source(serialize($newsourcefield));
425 // End of file manager hack
428 if (!is_null($text)) {
429 // at this point there should not be any draftfile links yet,
430 // because this is a new text from database that should still contain the @@pluginfile@@ links
431 // this happens when developers forget to post process the text
432 $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
434 } else {
435 // nothing to do
438 if (is_null($text)) {
439 return null;
442 // relink embedded files - editor can not handle @@PLUGINFILE@@ !
443 return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id, 'user', 'draft', $draftitemid, $options);
447 * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
449 * @category files
450 * @global stdClass $CFG
451 * @param string $text The content that may contain ULRs in need of rewriting.
452 * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
453 * @param int $contextid This parameter and the next two identify the file area to use.
454 * @param string $component
455 * @param string $filearea helps identify the file area.
456 * @param int $itemid helps identify the file area.
457 * @param array $options text and file options ('forcehttps'=>false)
458 * @return string the processed text.
460 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
461 global $CFG;
463 $options = (array)$options;
464 if (!isset($options['forcehttps'])) {
465 $options['forcehttps'] = false;
468 if (!$CFG->slasharguments) {
469 $file = $file . '?file=';
472 $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
474 if ($itemid !== null) {
475 $baseurl .= "$itemid/";
478 if ($options['forcehttps']) {
479 $baseurl = str_replace('http://', 'https://', $baseurl);
482 return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
486 * Returns information about files in a draft area.
488 * @global stdClass $CFG
489 * @global stdClass $USER
490 * @param int $draftitemid the draft area item id.
491 * @param string $filepath path to the directory from which the information have to be retrieved.
492 * @return array with the following entries:
493 * 'filecount' => number of files in the draft area.
494 * 'filesize' => total size of the files in the draft area.
495 * 'foldercount' => number of folders in the draft area.
496 * 'filesize_without_references' => total size of the area excluding file references.
497 * (more information will be added as needed).
499 function file_get_draft_area_info($draftitemid, $filepath = '/') {
500 global $CFG, $USER;
502 $usercontext = context_user::instance($USER->id);
503 $fs = get_file_storage();
505 $results = array(
506 'filecount' => 0,
507 'foldercount' => 0,
508 'filesize' => 0,
509 'filesize_without_references' => 0
512 if ($filepath != '/') {
513 $draftfiles = $fs->get_directory_files($usercontext->id, 'user', 'draft', $draftitemid, $filepath, true, true);
514 } else {
515 $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id', true);
517 foreach ($draftfiles as $file) {
518 if ($file->is_directory()) {
519 $results['foldercount'] += 1;
520 } else {
521 $results['filecount'] += 1;
524 $filesize = $file->get_filesize();
525 $results['filesize'] += $filesize;
526 if (!$file->is_external_file()) {
527 $results['filesize_without_references'] += $filesize;
531 return $results;
535 * Returns whether a draft area has exceeded/will exceed its size limit.
537 * Please note that the unlimited value for $areamaxbytes is -1 {@link FILE_AREA_MAX_BYTES_UNLIMITED}, not 0.
539 * @param int $draftitemid the draft area item id.
540 * @param int $areamaxbytes the maximum size allowed in this draft area.
541 * @param int $newfilesize the size that would be added to the current area.
542 * @param bool $includereferences true to include the size of the references in the area size.
543 * @return bool true if the area will/has exceeded its limit.
544 * @since Moodle 2.4
546 function file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $newfilesize = 0, $includereferences = false) {
547 if ($areamaxbytes != FILE_AREA_MAX_BYTES_UNLIMITED) {
548 $draftinfo = file_get_draft_area_info($draftitemid);
549 $areasize = $draftinfo['filesize_without_references'];
550 if ($includereferences) {
551 $areasize = $draftinfo['filesize'];
553 if ($areasize + $newfilesize > $areamaxbytes) {
554 return true;
557 return false;
561 * Get used space of files
562 * @global moodle_database $DB
563 * @global stdClass $USER
564 * @return int total bytes
566 function file_get_user_used_space() {
567 global $DB, $USER;
569 $usercontext = context_user::instance($USER->id);
570 $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
571 JOIN (SELECT contenthash, filename, MAX(id) AS id
572 FROM {files}
573 WHERE contextid = ? AND component = ? AND filearea != ?
574 GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
575 $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
576 $record = $DB->get_record_sql($sql, $params);
577 return (int)$record->totalbytes;
581 * Convert any string to a valid filepath
582 * @todo review this function
583 * @param string $str
584 * @return string path
586 function file_correct_filepath($str) { //TODO: what is this? (skodak) - No idea (Fred)
587 if ($str == '/' or empty($str)) {
588 return '/';
589 } else {
590 return '/'.trim($str, '/').'/';
595 * Generate a folder tree of draft area of current USER recursively
597 * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
598 * @param int $draftitemid
599 * @param string $filepath
600 * @param mixed $data
602 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
603 global $USER, $OUTPUT, $CFG;
604 $data->children = array();
605 $context = context_user::instance($USER->id);
606 $fs = get_file_storage();
607 if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
608 foreach ($files as $file) {
609 if ($file->is_directory()) {
610 $item = new stdClass();
611 $item->sortorder = $file->get_sortorder();
612 $item->filepath = $file->get_filepath();
614 $foldername = explode('/', trim($item->filepath, '/'));
615 $item->fullname = trim(array_pop($foldername), '/');
617 $item->id = uniqid();
618 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
619 $data->children[] = $item;
620 } else {
621 continue;
628 * Listing all files (including folders) in current path (draft area)
629 * used by file manager
630 * @param int $draftitemid
631 * @param string $filepath
632 * @return stdClass
634 function file_get_drafarea_files($draftitemid, $filepath = '/') {
635 global $USER, $OUTPUT, $CFG;
637 $context = context_user::instance($USER->id);
638 $fs = get_file_storage();
640 $data = new stdClass();
641 $data->path = array();
642 $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
644 // will be used to build breadcrumb
645 $trail = '/';
646 if ($filepath !== '/') {
647 $filepath = file_correct_filepath($filepath);
648 $parts = explode('/', $filepath);
649 foreach ($parts as $part) {
650 if ($part != '' && $part != null) {
651 $trail .= ($part.'/');
652 $data->path[] = array('name'=>$part, 'path'=>$trail);
657 $list = array();
658 $maxlength = 12;
659 if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
660 foreach ($files as $file) {
661 $item = new stdClass();
662 $item->filename = $file->get_filename();
663 $item->filepath = $file->get_filepath();
664 $item->fullname = trim($item->filename, '/');
665 $filesize = $file->get_filesize();
666 $item->size = $filesize ? $filesize : null;
667 $item->filesize = $filesize ? display_size($filesize) : '';
669 $item->sortorder = $file->get_sortorder();
670 $item->author = $file->get_author();
671 $item->license = $file->get_license();
672 $item->datemodified = $file->get_timemodified();
673 $item->datecreated = $file->get_timecreated();
674 $item->isref = $file->is_external_file();
675 if ($item->isref && $file->get_status() == 666) {
676 $item->originalmissing = true;
678 // find the file this draft file was created from and count all references in local
679 // system pointing to that file
680 $source = @unserialize($file->get_source());
681 if (isset($source->original)) {
682 $item->refcount = $fs->search_references_count($source->original);
685 if ($file->is_directory()) {
686 $item->filesize = 0;
687 $item->icon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
688 $item->type = 'folder';
689 $foldername = explode('/', trim($item->filepath, '/'));
690 $item->fullname = trim(array_pop($foldername), '/');
691 $item->thumbnail = $OUTPUT->pix_url(file_folder_icon(90))->out(false);
692 } else {
693 // do NOT use file browser here!
694 $item->mimetype = get_mimetype_description($file);
695 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
696 $item->type = 'zip';
697 } else {
698 $item->type = 'file';
700 $itemurl = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename);
701 $item->url = $itemurl->out();
702 $item->icon = $OUTPUT->pix_url(file_file_icon($file, 24))->out(false);
703 $item->thumbnail = $OUTPUT->pix_url(file_file_icon($file, 90))->out(false);
704 if ($imageinfo = $file->get_imageinfo()) {
705 $item->realthumbnail = $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
706 $item->realicon = $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
707 $item->image_width = $imageinfo['width'];
708 $item->image_height = $imageinfo['height'];
711 $list[] = $item;
714 $data->itemid = $draftitemid;
715 $data->list = $list;
716 return $data;
720 * Returns draft area itemid for a given element.
722 * @category files
723 * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
724 * @return int the itemid, or 0 if there is not one yet.
726 function file_get_submitted_draft_itemid($elname) {
727 // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
728 if (!isset($_REQUEST[$elname])) {
729 return 0;
731 if (is_array($_REQUEST[$elname])) {
732 $param = optional_param_array($elname, 0, PARAM_INT);
733 if (!empty($param['itemid'])) {
734 $param = $param['itemid'];
735 } else {
736 debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
737 return false;
740 } else {
741 $param = optional_param($elname, 0, PARAM_INT);
744 if ($param) {
745 require_sesskey();
748 return $param;
752 * Restore the original source field from draft files
754 * Do not use this function because it makes field files.source inconsistent
755 * for draft area files. This function will be deprecated in 2.6
757 * @param stored_file $storedfile This only works with draft files
758 * @return stored_file
760 function file_restore_source_field_from_draft_file($storedfile) {
761 $source = @unserialize($storedfile->get_source());
762 if (!empty($source)) {
763 if (is_object($source)) {
764 $restoredsource = $source->source;
765 $storedfile->set_source($restoredsource);
766 } else {
767 throw new moodle_exception('invalidsourcefield', 'error');
770 return $storedfile;
773 * Saves files from a draft file area to a real one (merging the list of files).
774 * Can rewrite URLs in some content at the same time if desired.
776 * @category files
777 * @global stdClass $USER
778 * @param int $draftitemid the id of the draft area to use. Normally obtained
779 * from file_get_submitted_draft_itemid('elementname') or similar.
780 * @param int $contextid This parameter and the next two identify the file area to save to.
781 * @param string $component
782 * @param string $filearea indentifies the file area.
783 * @param int $itemid helps identifies the file area.
784 * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
785 * @param string $text some html content that needs to have embedded links rewritten
786 * to the @@PLUGINFILE@@ form for saving in the database.
787 * @param bool $forcehttps force https urls.
788 * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
790 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
791 global $USER;
793 $usercontext = context_user::instance($USER->id);
794 $fs = get_file_storage();
796 $options = (array)$options;
797 if (!isset($options['subdirs'])) {
798 $options['subdirs'] = false;
800 if (!isset($options['maxfiles'])) {
801 $options['maxfiles'] = -1; // unlimited
803 if (!isset($options['maxbytes']) || $options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS) {
804 $options['maxbytes'] = 0; // unlimited
806 if (!isset($options['areamaxbytes'])) {
807 $options['areamaxbytes'] = FILE_AREA_MAX_BYTES_UNLIMITED; // Unlimited.
809 $allowreferences = true;
810 if (isset($options['return_types']) && !($options['return_types'] & FILE_REFERENCE)) {
811 // we assume that if $options['return_types'] is NOT specified, we DO allow references.
812 // this is not exactly right. BUT there are many places in code where filemanager options
813 // are not passed to file_save_draft_area_files()
814 $allowreferences = false;
817 // Check if the draft area has exceeded the authorised limit. This should never happen as validation
818 // should have taken place before, unless the user is doing something nauthly. If so, let's just not save
819 // anything at all in the next area.
820 if (file_is_draft_area_limit_reached($draftitemid, $options['areamaxbytes'])) {
821 return null;
824 $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
825 $oldfiles = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
827 // One file in filearea means it is empty (it has only top-level directory '.').
828 if (count($draftfiles) > 1 || count($oldfiles) > 1) {
829 // we have to merge old and new files - we want to keep file ids for files that were not changed
830 // we change time modified for all new and changed files, we keep time created as is
832 $newhashes = array();
833 $filecount = 0;
834 foreach ($draftfiles as $file) {
835 if (!$options['subdirs'] && $file->get_filepath() !== '/') {
836 continue;
838 if (!$allowreferences && $file->is_external_file()) {
839 continue;
841 if (!$file->is_directory()) {
842 if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
843 // oversized file - should not get here at all
844 continue;
846 if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
847 // more files - should not get here at all
848 continue;
850 $filecount++;
852 $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
853 $newhashes[$newhash] = $file;
856 // Loop through oldfiles and decide which we need to delete and which to update.
857 // After this cycle the array $newhashes will only contain the files that need to be added.
858 foreach ($oldfiles as $oldfile) {
859 $oldhash = $oldfile->get_pathnamehash();
860 if (!isset($newhashes[$oldhash])) {
861 // delete files not needed any more - deleted by user
862 $oldfile->delete();
863 continue;
866 $newfile = $newhashes[$oldhash];
867 // Now we know that we have $oldfile and $newfile for the same path.
868 // Let's check if we can update this file or we need to delete and create.
869 if ($newfile->is_directory()) {
870 // Directories are always ok to just update.
871 } else if (($source = @unserialize($newfile->get_source())) && isset($source->original)) {
872 // File has the 'original' - we need to update the file (it may even have not been changed at all).
873 $original = file_storage::unpack_reference($source->original);
874 if ($original['filename'] !== $oldfile->get_filename() || $original['filepath'] !== $oldfile->get_filepath()) {
875 // Very odd, original points to another file. Delete and create file.
876 $oldfile->delete();
877 continue;
879 } else {
880 // The same file name but absence of 'original' means that file was deteled and uploaded again.
881 // By deleting and creating new file we properly manage all existing references.
882 $oldfile->delete();
883 continue;
886 // status changed, we delete old file, and create a new one
887 if ($oldfile->get_status() != $newfile->get_status()) {
888 // file was changed, use updated with new timemodified data
889 $oldfile->delete();
890 // This file will be added later
891 continue;
894 // Updated author
895 if ($oldfile->get_author() != $newfile->get_author()) {
896 $oldfile->set_author($newfile->get_author());
898 // Updated license
899 if ($oldfile->get_license() != $newfile->get_license()) {
900 $oldfile->set_license($newfile->get_license());
903 // Updated file source
904 // Field files.source for draftarea files contains serialised object with source and original information.
905 // We only store the source part of it for non-draft file area.
906 $newsource = $newfile->get_source();
907 if ($source = @unserialize($newfile->get_source())) {
908 $newsource = $source->source;
910 if ($oldfile->get_source() !== $newsource) {
911 $oldfile->set_source($newsource);
914 // Updated sort order
915 if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
916 $oldfile->set_sortorder($newfile->get_sortorder());
919 // Update file timemodified
920 if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
921 $oldfile->set_timemodified($newfile->get_timemodified());
924 // Replaced file content
925 if (!$oldfile->is_directory() &&
926 ($oldfile->get_contenthash() != $newfile->get_contenthash() ||
927 $oldfile->get_filesize() != $newfile->get_filesize() ||
928 $oldfile->get_referencefileid() != $newfile->get_referencefileid() ||
929 $oldfile->get_userid() != $newfile->get_userid())) {
930 $oldfile->replace_file_with($newfile);
933 // unchanged file or directory - we keep it as is
934 unset($newhashes[$oldhash]);
937 // Add fresh file or the file which has changed status
938 // the size and subdirectory tests are extra safety only, the UI should prevent it
939 foreach ($newhashes as $file) {
940 $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
941 if ($source = @unserialize($file->get_source())) {
942 // Field files.source for draftarea files contains serialised object with source and original information.
943 // We only store the source part of it for non-draft file area.
944 $file_record['source'] = $source->source;
947 if ($file->is_external_file()) {
948 $repoid = $file->get_repository_id();
949 if (!empty($repoid)) {
950 $file_record['repositoryid'] = $repoid;
951 $file_record['reference'] = $file->get_reference();
955 $fs->create_file_from_storedfile($file_record, $file);
959 // note: do not purge the draft area - we clean up areas later in cron,
960 // the reason is that user might press submit twice and they would loose the files,
961 // also sometimes we might want to use hacks that save files into two different areas
963 if (is_null($text)) {
964 return null;
965 } else {
966 return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
971 * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
972 * ready to be saved in the database. Normally, this is done automatically by
973 * {@link file_save_draft_area_files()}.
975 * @category files
976 * @param string $text the content to process.
977 * @param int $draftitemid the draft file area the content was using.
978 * @param bool $forcehttps whether the content contains https URLs. Default false.
979 * @return string the processed content.
981 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
982 global $CFG, $USER;
984 $usercontext = context_user::instance($USER->id);
986 $wwwroot = $CFG->wwwroot;
987 if ($forcehttps) {
988 $wwwroot = str_replace('http://', 'https://', $wwwroot);
991 // relink embedded files if text submitted - no absolute links allowed in database!
992 $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
994 if (strpos($text, 'draftfile.php?file=') !== false) {
995 $matches = array();
996 preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
997 if ($matches) {
998 foreach ($matches[0] as $match) {
999 $replace = str_ireplace('%2F', '/', $match);
1000 $text = str_replace($match, $replace, $text);
1003 $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1006 return $text;
1010 * Set file sort order
1012 * @global moodle_database $DB
1013 * @param int $contextid the context id
1014 * @param string $component file component
1015 * @param string $filearea file area.
1016 * @param int $itemid itemid.
1017 * @param string $filepath file path.
1018 * @param string $filename file name.
1019 * @param int $sortorder the sort order of file.
1020 * @return bool
1022 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
1023 global $DB;
1024 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
1025 if ($file_record = $DB->get_record('files', $conditions)) {
1026 $sortorder = (int)$sortorder;
1027 $file_record->sortorder = $sortorder;
1028 $DB->update_record('files', $file_record);
1029 return true;
1031 return false;
1035 * reset file sort order number to 0
1036 * @global moodle_database $DB
1037 * @param int $contextid the context id
1038 * @param string $component
1039 * @param string $filearea file area.
1040 * @param int|bool $itemid itemid.
1041 * @return bool
1043 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
1044 global $DB;
1046 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
1047 if ($itemid !== false) {
1048 $conditions['itemid'] = $itemid;
1051 $file_records = $DB->get_records('files', $conditions);
1052 foreach ($file_records as $file_record) {
1053 $file_record->sortorder = 0;
1054 $DB->update_record('files', $file_record);
1056 return true;
1060 * Returns description of upload error
1062 * @param int $errorcode found in $_FILES['filename.ext']['error']
1063 * @return string error description string, '' if ok
1065 function file_get_upload_error($errorcode) {
1067 switch ($errorcode) {
1068 case 0: // UPLOAD_ERR_OK - no error
1069 $errmessage = '';
1070 break;
1072 case 1: // UPLOAD_ERR_INI_SIZE
1073 $errmessage = get_string('uploadserverlimit');
1074 break;
1076 case 2: // UPLOAD_ERR_FORM_SIZE
1077 $errmessage = get_string('uploadformlimit');
1078 break;
1080 case 3: // UPLOAD_ERR_PARTIAL
1081 $errmessage = get_string('uploadpartialfile');
1082 break;
1084 case 4: // UPLOAD_ERR_NO_FILE
1085 $errmessage = get_string('uploadnofilefound');
1086 break;
1088 // Note: there is no error with a value of 5
1090 case 6: // UPLOAD_ERR_NO_TMP_DIR
1091 $errmessage = get_string('uploadnotempdir');
1092 break;
1094 case 7: // UPLOAD_ERR_CANT_WRITE
1095 $errmessage = get_string('uploadcantwrite');
1096 break;
1098 case 8: // UPLOAD_ERR_EXTENSION
1099 $errmessage = get_string('uploadextension');
1100 break;
1102 default:
1103 $errmessage = get_string('uploadproblem');
1106 return $errmessage;
1110 * Recursive function formating an array in POST parameter
1111 * @param array $arraydata - the array that we are going to format and add into &$data array
1112 * @param string $currentdata - a row of the final postdata array at instant T
1113 * when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1114 * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1116 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1117 foreach ($arraydata as $k=>$v) {
1118 $newcurrentdata = $currentdata;
1119 if (is_array($v)) { //the value is an array, call the function recursively
1120 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1121 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1122 } else { //add the POST parameter to the $data array
1123 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1129 * Transform a PHP array into POST parameter
1130 * (see the recursive function format_array_postdata_for_curlcall)
1131 * @param array $postdata
1132 * @return array containing all POST parameters (1 row = 1 POST parameter)
1134 function format_postdata_for_curlcall($postdata) {
1135 $data = array();
1136 foreach ($postdata as $k=>$v) {
1137 if (is_array($v)) {
1138 $currentdata = urlencode($k);
1139 format_array_postdata_for_curlcall($v, $currentdata, $data);
1140 } else {
1141 $data[] = urlencode($k).'='.urlencode($v);
1144 $convertedpostdata = implode('&', $data);
1145 return $convertedpostdata;
1149 * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1150 * Due to security concerns only downloads from http(s) sources are supported.
1152 * @category files
1153 * @param string $url file url starting with http(s)://
1154 * @param array $headers http headers, null if none. If set, should be an
1155 * associative array of header name => value pairs.
1156 * @param array $postdata array means use POST request with given parameters
1157 * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1158 * (if false, just returns content)
1159 * @param int $timeout timeout for complete download process including all file transfer
1160 * (default 5 minutes)
1161 * @param int $connecttimeout timeout for connection to server; this is the timeout that
1162 * usually happens if the remote server is completely down (default 20 seconds);
1163 * may not work when using proxy
1164 * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1165 * Only use this when already in a trusted location.
1166 * @param string $tofile store the downloaded content to file instead of returning it.
1167 * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1168 * filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1169 * @return stdClass|string|bool stdClass object if $fullresponse is true, false if request failed, true
1170 * if file downloaded into $tofile successfully or the file content as a string.
1172 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1173 global $CFG;
1175 // Only http and https links supported.
1176 if (!preg_match('|^https?://|i', $url)) {
1177 if ($fullresponse) {
1178 $response = new stdClass();
1179 $response->status = 0;
1180 $response->headers = array();
1181 $response->response_code = 'Invalid protocol specified in url';
1182 $response->results = '';
1183 $response->error = 'Invalid protocol specified in url';
1184 return $response;
1185 } else {
1186 return false;
1190 $options = array();
1192 $headers2 = array();
1193 if (is_array($headers)) {
1194 foreach ($headers as $key => $value) {
1195 if (is_numeric($key)) {
1196 $headers2[] = $value;
1197 } else {
1198 $headers2[] = "$key: $value";
1203 if ($skipcertverify) {
1204 $options['CURLOPT_SSL_VERIFYPEER'] = false;
1205 } else {
1206 $options['CURLOPT_SSL_VERIFYPEER'] = true;
1209 $options['CURLOPT_CONNECTTIMEOUT'] = $connecttimeout;
1211 $options['CURLOPT_FOLLOWLOCATION'] = 1;
1212 $options['CURLOPT_MAXREDIRS'] = 5;
1214 // Use POST if requested.
1215 if (is_array($postdata)) {
1216 $postdata = format_postdata_for_curlcall($postdata);
1217 } else if (empty($postdata)) {
1218 $postdata = null;
1221 // Optionally attempt to get more correct timeout by fetching the file size.
1222 if (!isset($CFG->curltimeoutkbitrate)) {
1223 // Use very slow rate of 56kbps as a timeout speed when not set.
1224 $bitrate = 56;
1225 } else {
1226 $bitrate = $CFG->curltimeoutkbitrate;
1228 if ($calctimeout and !isset($postdata)) {
1229 $curl = new curl();
1230 $curl->setHeader($headers2);
1232 $curl->head($url, $postdata, $options);
1234 $info = $curl->get_info();
1235 $error_no = $curl->get_errno();
1236 if (!$error_no && $info['download_content_length'] > 0) {
1237 // No curl errors - adjust for large files only - take max timeout.
1238 $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024)));
1242 $curl = new curl();
1243 $curl->setHeader($headers2);
1245 $options['CURLOPT_RETURNTRANSFER'] = true;
1246 $options['CURLOPT_NOBODY'] = false;
1247 $options['CURLOPT_TIMEOUT'] = $timeout;
1249 if ($tofile) {
1250 $fh = fopen($tofile, 'w');
1251 if (!$fh) {
1252 if ($fullresponse) {
1253 $response = new stdClass();
1254 $response->status = 0;
1255 $response->headers = array();
1256 $response->response_code = 'Can not write to file';
1257 $response->results = false;
1258 $response->error = 'Can not write to file';
1259 return $response;
1260 } else {
1261 return false;
1264 $options['CURLOPT_FILE'] = $fh;
1267 if (isset($postdata)) {
1268 $content = $curl->post($url, $postdata, $options);
1269 } else {
1270 $content = $curl->get($url, null, $options);
1273 if ($tofile) {
1274 fclose($fh);
1275 @chmod($tofile, $CFG->filepermissions);
1279 // Try to detect encoding problems.
1280 if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1281 curl_setopt($ch, CURLOPT_ENCODING, 'none');
1282 $result = curl_exec($ch);
1286 $info = $curl->get_info();
1287 $error_no = $curl->get_errno();
1288 $rawheaders = $curl->get_raw_response();
1290 if ($error_no) {
1291 $error = $content;
1292 if (!$fullresponse) {
1293 debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1294 return false;
1297 $response = new stdClass();
1298 if ($error_no == 28) {
1299 $response->status = '-100'; // Mimic snoopy.
1300 } else {
1301 $response->status = '0';
1303 $response->headers = array();
1304 $response->response_code = $error;
1305 $response->results = false;
1306 $response->error = $error;
1307 return $response;
1310 if ($tofile) {
1311 $content = true;
1314 if (empty($info['http_code'])) {
1315 // For security reasons we support only true http connections (Location: file:// exploit prevention).
1316 $response = new stdClass();
1317 $response->status = '0';
1318 $response->headers = array();
1319 $response->response_code = 'Unknown cURL error';
1320 $response->results = false; // do NOT change this, we really want to ignore the result!
1321 $response->error = 'Unknown cURL error';
1323 } else {
1324 $response = new stdClass();
1325 $response->status = (string)$info['http_code'];
1326 $response->headers = $rawheaders;
1327 $response->results = $content;
1328 $response->error = '';
1330 // There might be multiple headers on redirect, find the status of the last one.
1331 $firstline = true;
1332 foreach ($rawheaders as $line) {
1333 if ($firstline) {
1334 $response->response_code = $line;
1335 $firstline = false;
1337 if (trim($line, "\r\n") === '') {
1338 $firstline = true;
1343 if ($fullresponse) {
1344 return $response;
1347 if ($info['http_code'] != 200) {
1348 debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1349 return false;
1351 return $response->results;
1355 * Returns a list of information about file types based on extensions.
1357 * The following elements expected in value array for each extension:
1358 * 'type' - mimetype
1359 * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1360 * or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1361 * also files with bigger sizes under names
1362 * FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1363 * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1364 * commonly used in moodle the following groups:
1365 * - web_image - image that can be included as <img> in HTML
1366 * - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1367 * - video - file that can be imported as video in text editor
1368 * - audio - file that can be imported as audio in text editor
1369 * - archive - we can extract files from this archive
1370 * - spreadsheet - used for portfolio format
1371 * - document - used for portfolio format
1372 * - presentation - used for portfolio format
1373 * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1374 * human-readable description for this filetype;
1375 * Function {@link get_mimetype_description()} first looks at the presence of string for
1376 * particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1377 * attribute, if not found returns the value of 'type';
1378 * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1379 * an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1380 * this function will return first found icon; Especially usefull for types such as 'text/plain'
1382 * @category files
1383 * @return array List of information about file types based on extensions.
1384 * Associative array of extension (lower-case) to associative array
1385 * from 'element name' to data. Current element names are 'type' and 'icon'.
1386 * Unknown types should use the 'xxx' entry which includes defaults.
1388 function &get_mimetypes_array() {
1389 // Get types from the core_filetypes function, which includes caching.
1390 return core_filetypes::get_types();
1394 * Obtains information about a filetype based on its extension. Will
1395 * use a default if no information is present about that particular
1396 * extension.
1398 * @category files
1399 * @param string $element Desired information (usually 'icon'
1400 * for icon filename or 'type' for MIME type. Can also be
1401 * 'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1402 * @param string $filename Filename we're looking up
1403 * @return string Requested piece of information from array
1405 function mimeinfo($element, $filename) {
1406 global $CFG;
1407 $mimeinfo = & get_mimetypes_array();
1408 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1410 $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1411 if (empty($filetype)) {
1412 $filetype = 'xxx'; // file without extension
1414 if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1415 $iconsize = max(array(16, (int)$iconsizematch[1]));
1416 $filenames = array($mimeinfo['xxx']['icon']);
1417 if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1418 array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1420 // find the file with the closest size, first search for specific icon then for default icon
1421 foreach ($filenames as $filename) {
1422 foreach ($iconpostfixes as $size => $postfix) {
1423 $fullname = $CFG->dirroot.'/pix/f/'.$filename.$postfix;
1424 if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1425 return $filename.$postfix;
1429 } else if (isset($mimeinfo[$filetype][$element])) {
1430 return $mimeinfo[$filetype][$element];
1431 } else if (isset($mimeinfo['xxx'][$element])) {
1432 return $mimeinfo['xxx'][$element]; // By default
1433 } else {
1434 return null;
1439 * Obtains information about a filetype based on the MIME type rather than
1440 * the other way around.
1442 * @category files
1443 * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1444 * @param string $mimetype MIME type we're looking up
1445 * @return string Requested piece of information from array
1447 function mimeinfo_from_type($element, $mimetype) {
1448 /* array of cached mimetype->extension associations */
1449 static $cached = array();
1450 $mimeinfo = & get_mimetypes_array();
1452 if (!array_key_exists($mimetype, $cached)) {
1453 $cached[$mimetype] = null;
1454 foreach($mimeinfo as $filetype => $values) {
1455 if ($values['type'] == $mimetype) {
1456 if ($cached[$mimetype] === null) {
1457 $cached[$mimetype] = '.'.$filetype;
1459 if (!empty($values['defaulticon'])) {
1460 $cached[$mimetype] = '.'.$filetype;
1461 break;
1465 if (empty($cached[$mimetype])) {
1466 $cached[$mimetype] = '.xxx';
1469 if ($element === 'extension') {
1470 return $cached[$mimetype];
1471 } else {
1472 return mimeinfo($element, $cached[$mimetype]);
1477 * Return the relative icon path for a given file
1479 * Usage:
1480 * <code>
1481 * // $file - instance of stored_file or file_info
1482 * $icon = $OUTPUT->pix_url(file_file_icon($file))->out();
1483 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1484 * </code>
1485 * or
1486 * <code>
1487 * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1488 * </code>
1490 * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1491 * and $file->mimetype are expected)
1492 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1493 * @return string
1495 function file_file_icon($file, $size = null) {
1496 if (!is_object($file)) {
1497 $file = (object)$file;
1499 if (isset($file->filename)) {
1500 $filename = $file->filename;
1501 } else if (method_exists($file, 'get_filename')) {
1502 $filename = $file->get_filename();
1503 } else if (method_exists($file, 'get_visible_name')) {
1504 $filename = $file->get_visible_name();
1505 } else {
1506 $filename = '';
1508 if (isset($file->mimetype)) {
1509 $mimetype = $file->mimetype;
1510 } else if (method_exists($file, 'get_mimetype')) {
1511 $mimetype = $file->get_mimetype();
1512 } else {
1513 $mimetype = '';
1515 $mimetypes = &get_mimetypes_array();
1516 if ($filename) {
1517 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1518 if ($extension && !empty($mimetypes[$extension])) {
1519 // if file name has known extension, return icon for this extension
1520 return file_extension_icon($filename, $size);
1523 return file_mimetype_icon($mimetype, $size);
1527 * Return the relative icon path for a folder image
1529 * Usage:
1530 * <code>
1531 * $icon = $OUTPUT->pix_url(file_folder_icon())->out();
1532 * echo html_writer::empty_tag('img', array('src' => $icon));
1533 * </code>
1534 * or
1535 * <code>
1536 * echo $OUTPUT->pix_icon(file_folder_icon(32));
1537 * </code>
1539 * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1540 * @return string
1542 function file_folder_icon($iconsize = null) {
1543 global $CFG;
1544 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1545 static $cached = array();
1546 $iconsize = max(array(16, (int)$iconsize));
1547 if (!array_key_exists($iconsize, $cached)) {
1548 foreach ($iconpostfixes as $size => $postfix) {
1549 $fullname = $CFG->dirroot.'/pix/f/folder'.$postfix;
1550 if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1551 $cached[$iconsize] = 'f/folder'.$postfix;
1552 break;
1556 return $cached[$iconsize];
1560 * Returns the relative icon path for a given mime type
1562 * This function should be used in conjunction with $OUTPUT->pix_url to produce
1563 * a return the full path to an icon.
1565 * <code>
1566 * $mimetype = 'image/jpg';
1567 * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype))->out();
1568 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1569 * </code>
1571 * @category files
1572 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1573 * to conform with that.
1574 * @param string $mimetype The mimetype to fetch an icon for
1575 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1576 * @return string The relative path to the icon
1578 function file_mimetype_icon($mimetype, $size = NULL) {
1579 return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1583 * Returns the relative icon path for a given file name
1585 * This function should be used in conjunction with $OUTPUT->pix_url to produce
1586 * a return the full path to an icon.
1588 * <code>
1589 * $filename = '.jpg';
1590 * $icon = $OUTPUT->pix_url(file_extension_icon($filename))->out();
1591 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1592 * </code>
1594 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1595 * to conform with that.
1596 * @todo MDL-31074 Implement $size
1597 * @category files
1598 * @param string $filename The filename to get the icon for
1599 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1600 * @return string
1602 function file_extension_icon($filename, $size = NULL) {
1603 return 'f/'.mimeinfo('icon'.$size, $filename);
1607 * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1608 * mimetypes.php language file.
1610 * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1611 * 'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1612 * have filename); In case of array/stdClass the field 'mimetype' is optional.
1613 * @param bool $capitalise If true, capitalises first character of result
1614 * @return string Text description
1616 function get_mimetype_description($obj, $capitalise=false) {
1617 $filename = $mimetype = '';
1618 if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1619 // this is an instance of stored_file
1620 $mimetype = $obj->get_mimetype();
1621 $filename = $obj->get_filename();
1622 } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1623 // this is an instance of file_info
1624 $mimetype = $obj->get_mimetype();
1625 $filename = $obj->get_visible_name();
1626 } else if (is_array($obj) || is_object ($obj)) {
1627 $obj = (array)$obj;
1628 if (!empty($obj['filename'])) {
1629 $filename = $obj['filename'];
1631 if (!empty($obj['mimetype'])) {
1632 $mimetype = $obj['mimetype'];
1634 } else {
1635 $mimetype = $obj;
1637 $mimetypefromext = mimeinfo('type', $filename);
1638 if (empty($mimetype) || $mimetypefromext !== 'document/unknown') {
1639 // if file has a known extension, overwrite the specified mimetype
1640 $mimetype = $mimetypefromext;
1642 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1643 if (empty($extension)) {
1644 $mimetypestr = mimeinfo_from_type('string', $mimetype);
1645 $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1646 } else {
1647 $mimetypestr = mimeinfo('string', $filename);
1649 $chunks = explode('/', $mimetype, 2);
1650 $chunks[] = '';
1651 $attr = array(
1652 'mimetype' => $mimetype,
1653 'ext' => $extension,
1654 'mimetype1' => $chunks[0],
1655 'mimetype2' => $chunks[1],
1657 $a = array();
1658 foreach ($attr as $key => $value) {
1659 $a[$key] = $value;
1660 $a[strtoupper($key)] = strtoupper($value);
1661 $a[ucfirst($key)] = ucfirst($value);
1664 // MIME types may include + symbol but this is not permitted in string ids.
1665 $safemimetype = str_replace('+', '_', $mimetype);
1666 $safemimetypestr = str_replace('+', '_', $mimetypestr);
1667 $customdescription = mimeinfo('customdescription', $filename);
1668 if ($customdescription) {
1669 // Call format_string on the custom description so that multilang
1670 // filter can be used (if enabled on system context). We use system
1671 // context because it is possible that the page context might not have
1672 // been defined yet.
1673 $result = format_string($customdescription, true,
1674 array('context' => context_system::instance()));
1675 } else if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
1676 $result = get_string($safemimetype, 'mimetypes', (object)$a);
1677 } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
1678 $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
1679 } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1680 $result = get_string('default', 'mimetypes', (object)$a);
1681 } else {
1682 $result = $mimetype;
1684 if ($capitalise) {
1685 $result=ucfirst($result);
1687 return $result;
1691 * Returns array of elements of type $element in type group(s)
1693 * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1694 * @param string|array $groups one group or array of groups/extensions/mimetypes
1695 * @return array
1697 function file_get_typegroup($element, $groups) {
1698 static $cached = array();
1699 if (!is_array($groups)) {
1700 $groups = array($groups);
1702 if (!array_key_exists($element, $cached)) {
1703 $cached[$element] = array();
1705 $result = array();
1706 foreach ($groups as $group) {
1707 if (!array_key_exists($group, $cached[$element])) {
1708 // retrieive and cache all elements of type $element for group $group
1709 $mimeinfo = & get_mimetypes_array();
1710 $cached[$element][$group] = array();
1711 foreach ($mimeinfo as $extension => $value) {
1712 $value['extension'] = '.'.$extension;
1713 if (empty($value[$element])) {
1714 continue;
1716 if (($group === '.'.$extension || $group === $value['type'] ||
1717 (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1718 !in_array($value[$element], $cached[$element][$group])) {
1719 $cached[$element][$group][] = $value[$element];
1723 $result = array_merge($result, $cached[$element][$group]);
1725 return array_values(array_unique($result));
1729 * Checks if file with name $filename has one of the extensions in groups $groups
1731 * @see get_mimetypes_array()
1732 * @param string $filename name of the file to check
1733 * @param string|array $groups one group or array of groups to check
1734 * @param bool $checktype if true and extension check fails, find the mimetype and check if
1735 * file mimetype is in mimetypes in groups $groups
1736 * @return bool
1738 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
1739 $extension = pathinfo($filename, PATHINFO_EXTENSION);
1740 if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
1741 return true;
1743 return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
1747 * Checks if mimetype $mimetype belongs to one of the groups $groups
1749 * @see get_mimetypes_array()
1750 * @param string $mimetype
1751 * @param string|array $groups one group or array of groups to check
1752 * @return bool
1754 function file_mimetype_in_typegroup($mimetype, $groups) {
1755 return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
1759 * Requested file is not found or not accessible, does not return, terminates script
1761 * @global stdClass $CFG
1762 * @global stdClass $COURSE
1764 function send_file_not_found() {
1765 global $CFG, $COURSE;
1767 // Allow cross-origin requests only for Web Services.
1768 // This allow to receive requests done by Web Workers or webapps in different domains.
1769 if (WS_SERVER) {
1770 header('Access-Control-Allow-Origin: *');
1773 send_header_404();
1774 print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1777 * Helper function to send correct 404 for server.
1779 function send_header_404() {
1780 if (substr(php_sapi_name(), 0, 3) == 'cgi') {
1781 header("Status: 404 Not Found");
1782 } else {
1783 header('HTTP/1.0 404 not found');
1788 * The readfile function can fail when files are larger than 2GB (even on 64-bit
1789 * platforms). This wrapper uses readfile for small files and custom code for
1790 * large ones.
1792 * @param string $path Path to file
1793 * @param int $filesize Size of file (if left out, will get it automatically)
1794 * @return int|bool Size read (will always be $filesize) or false if failed
1796 function readfile_allow_large($path, $filesize = -1) {
1797 // Automatically get size if not specified.
1798 if ($filesize === -1) {
1799 $filesize = filesize($path);
1801 if ($filesize <= 2147483647) {
1802 // If the file is up to 2^31 - 1, send it normally using readfile.
1803 return readfile($path);
1804 } else {
1805 // For large files, read and output in 64KB chunks.
1806 $handle = fopen($path, 'r');
1807 if ($handle === false) {
1808 return false;
1810 $left = $filesize;
1811 while ($left > 0) {
1812 $size = min($left, 65536);
1813 $buffer = fread($handle, $size);
1814 if ($buffer === false) {
1815 return false;
1817 echo $buffer;
1818 $left -= $size;
1820 return $filesize;
1825 * Enhanced readfile() with optional acceleration.
1826 * @param string|stored_file $file
1827 * @param string $mimetype
1828 * @param bool $accelerate
1829 * @return void
1831 function readfile_accel($file, $mimetype, $accelerate) {
1832 global $CFG;
1834 if ($mimetype === 'text/plain') {
1835 // there is no encoding specified in text files, we need something consistent
1836 header('Content-Type: text/plain; charset=utf-8');
1837 } else {
1838 header('Content-Type: '.$mimetype);
1841 $lastmodified = is_object($file) ? $file->get_timemodified() : filemtime($file);
1842 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1844 if (is_object($file)) {
1845 header('Etag: "' . $file->get_contenthash() . '"');
1846 if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and trim($_SERVER['HTTP_IF_NONE_MATCH'], '"') === $file->get_contenthash()) {
1847 header('HTTP/1.1 304 Not Modified');
1848 return;
1852 // if etag present for stored file rely on it exclusively
1853 if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
1854 // get unixtime of request header; clip extra junk off first
1855 $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1856 if ($since && $since >= $lastmodified) {
1857 header('HTTP/1.1 304 Not Modified');
1858 return;
1862 if ($accelerate and !empty($CFG->xsendfile)) {
1863 if (empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1864 header('Accept-Ranges: bytes');
1865 } else {
1866 header('Accept-Ranges: none');
1869 if (is_object($file)) {
1870 $fs = get_file_storage();
1871 if ($fs->xsendfile($file->get_contenthash())) {
1872 return;
1875 } else {
1876 require_once("$CFG->libdir/xsendfilelib.php");
1877 if (xsendfile($file)) {
1878 return;
1883 $filesize = is_object($file) ? $file->get_filesize() : filesize($file);
1885 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1887 if ($accelerate and empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1888 header('Accept-Ranges: bytes');
1890 if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1891 // byteserving stuff - for acrobat reader and download accelerators
1892 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1893 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
1894 $ranges = false;
1895 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
1896 foreach ($ranges as $key=>$value) {
1897 if ($ranges[$key][1] == '') {
1898 //suffix case
1899 $ranges[$key][1] = $filesize - $ranges[$key][2];
1900 $ranges[$key][2] = $filesize - 1;
1901 } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
1902 //fix range length
1903 $ranges[$key][2] = $filesize - 1;
1905 if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
1906 //invalid byte-range ==> ignore header
1907 $ranges = false;
1908 break;
1910 //prepare multipart header
1911 $ranges[$key][0] = "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
1912 $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
1914 } else {
1915 $ranges = false;
1917 if ($ranges) {
1918 if (is_object($file)) {
1919 $handle = $file->get_content_file_handle();
1920 } else {
1921 $handle = fopen($file, 'rb');
1923 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
1926 } else {
1927 // Do not byteserve
1928 header('Accept-Ranges: none');
1931 header('Content-Length: '.$filesize);
1933 if ($filesize > 10000000) {
1934 // for large files try to flush and close all buffers to conserve memory
1935 while(@ob_get_level()) {
1936 if (!@ob_end_flush()) {
1937 break;
1942 // send the whole file content
1943 if (is_object($file)) {
1944 $file->readfile();
1945 } else {
1946 readfile_allow_large($file, $filesize);
1951 * Similar to readfile_accel() but designed for strings.
1952 * @param string $string
1953 * @param string $mimetype
1954 * @param bool $accelerate
1955 * @return void
1957 function readstring_accel($string, $mimetype, $accelerate) {
1958 global $CFG;
1960 if ($mimetype === 'text/plain') {
1961 // there is no encoding specified in text files, we need something consistent
1962 header('Content-Type: text/plain; charset=utf-8');
1963 } else {
1964 header('Content-Type: '.$mimetype);
1966 header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
1967 header('Accept-Ranges: none');
1969 if ($accelerate and !empty($CFG->xsendfile)) {
1970 $fs = get_file_storage();
1971 if ($fs->xsendfile(sha1($string))) {
1972 return;
1976 header('Content-Length: '.strlen($string));
1977 echo $string;
1981 * Handles the sending of temporary file to user, download is forced.
1982 * File is deleted after abort or successful sending, does not return, script terminated
1984 * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
1985 * @param string $filename proposed file name when saving file
1986 * @param bool $pathisstring If the path is string
1988 function send_temp_file($path, $filename, $pathisstring=false) {
1989 global $CFG;
1991 if (core_useragent::is_firefox()) {
1992 // only FF is known to correctly save to disk before opening...
1993 $mimetype = mimeinfo('type', $filename);
1994 } else {
1995 $mimetype = 'application/x-forcedownload';
1998 // close session - not needed anymore
1999 \core\session\manager::write_close();
2001 if (!$pathisstring) {
2002 if (!file_exists($path)) {
2003 send_header_404();
2004 print_error('filenotfound', 'error', $CFG->wwwroot.'/');
2006 // executed after normal finish or abort
2007 core_shutdown_manager::register_function('send_temp_file_finished', array($path));
2010 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2011 if (core_useragent::is_ie()) {
2012 $filename = urlencode($filename);
2015 header('Content-Disposition: attachment; filename="'.$filename.'"');
2016 if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2017 header('Cache-Control: private, max-age=10, no-transform');
2018 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2019 header('Pragma: ');
2020 } else { //normal http - prevent caching at all cost
2021 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2022 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2023 header('Pragma: no-cache');
2026 // send the contents - we can not accelerate this because the file will be deleted asap
2027 if ($pathisstring) {
2028 readstring_accel($path, $mimetype, false);
2029 } else {
2030 readfile_accel($path, $mimetype, false);
2031 @unlink($path);
2034 die; //no more chars to output
2038 * Internal callback function used by send_temp_file()
2040 * @param string $path
2042 function send_temp_file_finished($path) {
2043 if (file_exists($path)) {
2044 @unlink($path);
2049 * Handles the sending of file data to the user's browser, including support for
2050 * byteranges etc.
2052 * @category files
2053 * @param string $path Path of file on disk (including real filename), or actual content of file as string
2054 * @param string $filename Filename to send
2055 * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2056 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2057 * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
2058 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2059 * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2060 * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2061 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2062 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2063 * and should not be reopened.
2064 * @return null script execution stopped unless $dontdie is true
2066 function send_file($path, $filename, $lifetime = null , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
2067 global $CFG, $COURSE;
2069 if ($dontdie) {
2070 ignore_user_abort(true);
2073 if ($lifetime === 'default' or is_null($lifetime)) {
2074 $lifetime = $CFG->filelifetime;
2077 \core\session\manager::write_close(); // Unlock session during file serving.
2079 // Use given MIME type if specified, otherwise guess it using mimeinfo.
2080 // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2081 // only Firefox saves all files locally before opening when content-disposition: attachment stated
2082 $isFF = core_useragent::is_firefox(); // only FF properly tested
2083 $mimetype = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2084 ($mimetype ? $mimetype : mimeinfo('type', $filename));
2086 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2087 if (core_useragent::is_ie()) {
2088 $filename = rawurlencode($filename);
2091 if ($forcedownload) {
2092 header('Content-Disposition: attachment; filename="'.$filename.'"');
2093 } else if ($mimetype !== 'application/x-shockwave-flash') {
2094 // If this is an swf don't pass content-disposition with filename as this makes the flash player treat the file
2095 // as an upload and enforces security that may prevent the file from being loaded.
2097 header('Content-Disposition: inline; filename="'.$filename.'"');
2100 if ($lifetime > 0) {
2101 $cacheability = ' public,';
2102 if (isloggedin() and !isguestuser()) {
2103 // By default, under the conditions above, this file must be cache-able only by browsers.
2104 $cacheability = ' private,';
2106 $nobyteserving = false;
2107 header('Cache-Control:'.$cacheability.' max-age='.$lifetime.', no-transform');
2108 header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2109 header('Pragma: ');
2111 } else { // Do not cache files in proxies and browsers
2112 $nobyteserving = true;
2113 if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2114 header('Cache-Control: private, max-age=10, no-transform');
2115 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2116 header('Pragma: ');
2117 } else { //normal http - prevent caching at all cost
2118 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2119 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2120 header('Pragma: no-cache');
2124 if (empty($filter)) {
2125 // send the contents
2126 if ($pathisstring) {
2127 readstring_accel($path, $mimetype, !$dontdie);
2128 } else {
2129 readfile_accel($path, $mimetype, !$dontdie);
2132 } else {
2133 // Try to put the file through filters
2134 if ($mimetype == 'text/html' || $mimetype == 'application/xhtml+xml') {
2135 $options = new stdClass();
2136 $options->noclean = true;
2137 $options->nocache = true; // temporary workaround for MDL-5136
2138 $text = $pathisstring ? $path : implode('', file($path));
2140 $text = file_modify_html_header($text);
2141 $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2143 readstring_accel($output, $mimetype, false);
2145 } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2146 // only filter text if filter all files is selected
2147 $options = new stdClass();
2148 $options->newlines = false;
2149 $options->noclean = true;
2150 $text = htmlentities($pathisstring ? $path : implode('', file($path)), ENT_QUOTES, 'UTF-8');
2151 $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2153 readstring_accel($output, $mimetype, false);
2155 } else {
2156 // send the contents
2157 if ($pathisstring) {
2158 readstring_accel($path, $mimetype, !$dontdie);
2159 } else {
2160 readfile_accel($path, $mimetype, !$dontdie);
2164 if ($dontdie) {
2165 return;
2167 die; //no more chars to output!!!
2171 * Handles the sending of file data to the user's browser, including support for
2172 * byteranges etc.
2174 * The $options parameter supports the following keys:
2175 * (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2176 * (string|null) filename - overrides the implicit filename
2177 * (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2178 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2179 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2180 * and should not be reopened
2181 * (string|null) cacheability - force the cacheability setting of the HTTP response, "private" or "public",
2182 * when $lifetime is greater than 0. Cacheability defaults to "private" when logged in as other than guest; otherwise,
2183 * defaults to "public".
2185 * @category files
2186 * @param stored_file $stored_file local file object
2187 * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2188 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2189 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2190 * @param array $options additional options affecting the file serving
2191 * @return null script execution stopped unless $options['dontdie'] is true
2193 function send_stored_file($stored_file, $lifetime=null, $filter=0, $forcedownload=false, array $options=array()) {
2194 global $CFG, $COURSE;
2196 if (empty($options['filename'])) {
2197 $filename = null;
2198 } else {
2199 $filename = $options['filename'];
2202 if (empty($options['dontdie'])) {
2203 $dontdie = false;
2204 } else {
2205 $dontdie = true;
2208 if ($lifetime === 'default' or is_null($lifetime)) {
2209 $lifetime = $CFG->filelifetime;
2212 if (!empty($options['preview'])) {
2213 // replace the file with its preview
2214 $fs = get_file_storage();
2215 $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2216 if (!$preview_file) {
2217 // unable to create a preview of the file, send its default mime icon instead
2218 if ($options['preview'] === 'tinyicon') {
2219 $size = 24;
2220 } else if ($options['preview'] === 'thumb') {
2221 $size = 90;
2222 } else {
2223 $size = 256;
2225 $fileicon = file_file_icon($stored_file, $size);
2226 send_file($CFG->dirroot.'/pix/'.$fileicon.'.png', basename($fileicon).'.png');
2227 } else {
2228 // preview images have fixed cache lifetime and they ignore forced download
2229 // (they are generated by GD and therefore they are considered reasonably safe).
2230 $stored_file = $preview_file;
2231 $lifetime = DAYSECS;
2232 $filter = 0;
2233 $forcedownload = false;
2237 // handle external resource
2238 if ($stored_file && $stored_file->is_external_file() && !isset($options['sendcachedexternalfile'])) {
2239 $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2240 die;
2243 if (!$stored_file or $stored_file->is_directory()) {
2244 // nothing to serve
2245 if ($dontdie) {
2246 return;
2248 die;
2251 if ($dontdie) {
2252 ignore_user_abort(true);
2255 \core\session\manager::write_close(); // Unlock session during file serving.
2257 // Use given MIME type if specified, otherwise guess it using mimeinfo.
2258 // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2259 // only Firefox saves all files locally before opening when content-disposition: attachment stated
2260 $filename = is_null($filename) ? $stored_file->get_filename() : $filename;
2261 $isFF = core_useragent::is_firefox(); // only FF properly tested
2262 $mimetype = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2263 ($stored_file->get_mimetype() ? $stored_file->get_mimetype() : mimeinfo('type', $filename));
2265 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2266 if (core_useragent::is_ie()) {
2267 $filename = rawurlencode($filename);
2270 if ($forcedownload) {
2271 header('Content-Disposition: attachment; filename="'.$filename.'"');
2272 } else if ($mimetype !== 'application/x-shockwave-flash') {
2273 // If this is an swf don't pass content-disposition with filename as this makes the flash player treat the file
2274 // as an upload and enforces security that may prevent the file from being loaded.
2276 header('Content-Disposition: inline; filename="'.$filename.'"');
2279 if ($lifetime > 0) {
2280 $cacheability = ' public,';
2281 if (!empty($options['cacheability']) && ($options['cacheability'] === 'public')) {
2282 // This file must be cache-able by both browsers and proxies.
2283 $cacheability = ' public,';
2284 } else if (!empty($options['cacheability']) && ($options['cacheability'] === 'private')) {
2285 // This file must be cache-able only by browsers.
2286 $cacheability = ' private,';
2287 } else if (isloggedin() and !isguestuser()) {
2288 $cacheability = ' private,';
2290 header('Cache-Control:'.$cacheability.' max-age='.$lifetime.', no-transform');
2291 header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2292 header('Pragma: ');
2294 } else { // Do not cache files in proxies and browsers
2295 if (is_https()) { // HTTPS sites - watch out for IE! KB812935 and KB316431.
2296 header('Cache-Control: private, max-age=10, no-transform');
2297 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2298 header('Pragma: ');
2299 } else { //normal http - prevent caching at all cost
2300 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0, no-transform');
2301 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2302 header('Pragma: no-cache');
2306 // Allow cross-origin requests only for Web Services.
2307 // This allow to receive requests done by Web Workers or webapps in different domains.
2308 if (WS_SERVER) {
2309 header('Access-Control-Allow-Origin: *');
2312 if (empty($filter)) {
2313 // send the contents
2314 readfile_accel($stored_file, $mimetype, !$dontdie);
2316 } else { // Try to put the file through filters
2317 if ($mimetype == 'text/html' || $mimetype == 'application/xhtml+xml') {
2318 $options = new stdClass();
2319 $options->noclean = true;
2320 $options->nocache = true; // temporary workaround for MDL-5136
2321 $text = $stored_file->get_content();
2322 $text = file_modify_html_header($text);
2323 $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2325 readstring_accel($output, $mimetype, false);
2327 } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2328 // only filter text if filter all files is selected
2329 $options = new stdClass();
2330 $options->newlines = false;
2331 $options->noclean = true;
2332 $text = $stored_file->get_content();
2333 $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2335 readstring_accel($output, $mimetype, false);
2337 } else { // Just send it out raw
2338 readfile_accel($stored_file, $mimetype, !$dontdie);
2341 if ($dontdie) {
2342 return;
2344 die; //no more chars to output!!!
2348 * Retrieves an array of records from a CSV file and places
2349 * them into a given table structure
2351 * @global stdClass $CFG
2352 * @global moodle_database $DB
2353 * @param string $file The path to a CSV file
2354 * @param string $table The table to retrieve columns from
2355 * @return bool|array Returns an array of CSV records or false
2357 function get_records_csv($file, $table) {
2358 global $CFG, $DB;
2360 if (!$metacolumns = $DB->get_columns($table)) {
2361 return false;
2364 if(!($handle = @fopen($file, 'r'))) {
2365 print_error('get_records_csv failed to open '.$file);
2368 $fieldnames = fgetcsv($handle, 4096);
2369 if(empty($fieldnames)) {
2370 fclose($handle);
2371 return false;
2374 $columns = array();
2376 foreach($metacolumns as $metacolumn) {
2377 $ord = array_search($metacolumn->name, $fieldnames);
2378 if(is_int($ord)) {
2379 $columns[$metacolumn->name] = $ord;
2383 $rows = array();
2385 while (($data = fgetcsv($handle, 4096)) !== false) {
2386 $item = new stdClass;
2387 foreach($columns as $name => $ord) {
2388 $item->$name = $data[$ord];
2390 $rows[] = $item;
2393 fclose($handle);
2394 return $rows;
2398 * Create a file with CSV contents
2400 * @global stdClass $CFG
2401 * @global moodle_database $DB
2402 * @param string $file The file to put the CSV content into
2403 * @param array $records An array of records to write to a CSV file
2404 * @param string $table The table to get columns from
2405 * @return bool success
2407 function put_records_csv($file, $records, $table = NULL) {
2408 global $CFG, $DB;
2410 if (empty($records)) {
2411 return true;
2414 $metacolumns = NULL;
2415 if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2416 return false;
2419 echo "x";
2421 if(!($fp = @fopen($CFG->tempdir.'/'.$file, 'w'))) {
2422 print_error('put_records_csv failed to open '.$file);
2425 $proto = reset($records);
2426 if(is_object($proto)) {
2427 $fields_records = array_keys(get_object_vars($proto));
2429 else if(is_array($proto)) {
2430 $fields_records = array_keys($proto);
2432 else {
2433 return false;
2435 echo "x";
2437 if(!empty($metacolumns)) {
2438 $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2439 $fields = array_intersect($fields_records, $fields_table);
2441 else {
2442 $fields = $fields_records;
2445 fwrite($fp, implode(',', $fields));
2446 fwrite($fp, "\r\n");
2448 foreach($records as $record) {
2449 $array = (array)$record;
2450 $values = array();
2451 foreach($fields as $field) {
2452 if(strpos($array[$field], ',')) {
2453 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2455 else {
2456 $values[] = $array[$field];
2459 fwrite($fp, implode(',', $values)."\r\n");
2462 fclose($fp);
2463 @chmod($CFG->tempdir.'/'.$file, $CFG->filepermissions);
2464 return true;
2469 * Recursively delete the file or folder with path $location. That is,
2470 * if it is a file delete it. If it is a folder, delete all its content
2471 * then delete it. If $location does not exist to start, that is not
2472 * considered an error.
2474 * @param string $location the path to remove.
2475 * @return bool
2477 function fulldelete($location) {
2478 if (empty($location)) {
2479 // extra safety against wrong param
2480 return false;
2482 if (is_dir($location)) {
2483 if (!$currdir = opendir($location)) {
2484 return false;
2486 while (false !== ($file = readdir($currdir))) {
2487 if ($file <> ".." && $file <> ".") {
2488 $fullfile = $location."/".$file;
2489 if (is_dir($fullfile)) {
2490 if (!fulldelete($fullfile)) {
2491 return false;
2493 } else {
2494 if (!unlink($fullfile)) {
2495 return false;
2500 closedir($currdir);
2501 if (! rmdir($location)) {
2502 return false;
2505 } else if (file_exists($location)) {
2506 if (!unlink($location)) {
2507 return false;
2510 return true;
2514 * Send requested byterange of file.
2516 * @param resource $handle A file handle
2517 * @param string $mimetype The mimetype for the output
2518 * @param array $ranges An array of ranges to send
2519 * @param string $filesize The size of the content if only one range is used
2521 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2522 // better turn off any kind of compression and buffering
2523 ini_set('zlib.output_compression', 'Off');
2525 $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2526 if ($handle === false) {
2527 die;
2529 if (count($ranges) == 1) { //only one range requested
2530 $length = $ranges[0][2] - $ranges[0][1] + 1;
2531 header('HTTP/1.1 206 Partial content');
2532 header('Content-Length: '.$length);
2533 header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2534 header('Content-Type: '.$mimetype);
2536 while(@ob_get_level()) {
2537 if (!@ob_end_flush()) {
2538 break;
2542 fseek($handle, $ranges[0][1]);
2543 while (!feof($handle) && $length > 0) {
2544 core_php_time_limit::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2545 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2546 echo $buffer;
2547 flush();
2548 $length -= strlen($buffer);
2550 fclose($handle);
2551 die;
2552 } else { // multiple ranges requested - not tested much
2553 $totallength = 0;
2554 foreach($ranges as $range) {
2555 $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2557 $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2558 header('HTTP/1.1 206 Partial content');
2559 header('Content-Length: '.$totallength);
2560 header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2562 while(@ob_get_level()) {
2563 if (!@ob_end_flush()) {
2564 break;
2568 foreach($ranges as $range) {
2569 $length = $range[2] - $range[1] + 1;
2570 echo $range[0];
2571 fseek($handle, $range[1]);
2572 while (!feof($handle) && $length > 0) {
2573 core_php_time_limit::raise(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2574 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2575 echo $buffer;
2576 flush();
2577 $length -= strlen($buffer);
2580 echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2581 fclose($handle);
2582 die;
2587 * add includes (js and css) into uploaded files
2588 * before returning them, useful for themes and utf.js includes
2590 * @global stdClass $CFG
2591 * @param string $text text to search and replace
2592 * @return string text with added head includes
2593 * @todo MDL-21120
2595 function file_modify_html_header($text) {
2596 // first look for <head> tag
2597 global $CFG;
2599 $stylesheetshtml = '';
2601 foreach ($CFG->stylesheets as $stylesheet) {
2602 //TODO: MDL-21120
2603 $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2606 // TODO The code below is actually a waste of CPU. When MDL-29738 will be implemented it should be re-evaluated too.
2608 preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2609 if ($matches) {
2610 $replacement = '<head>'.$stylesheetshtml;
2611 $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2612 return $text;
2615 // if not, look for <html> tag, and stick <head> right after
2616 preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2617 if ($matches) {
2618 // replace <html> tag with <html><head>includes</head>
2619 $replacement = '<html>'."\n".'<head>'.$stylesheetshtml.'</head>';
2620 $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2621 return $text;
2624 // if not, look for <body> tag, and stick <head> before body
2625 preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2626 if ($matches) {
2627 $replacement = '<head>'.$stylesheetshtml.'</head>'."\n".'<body>';
2628 $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2629 return $text;
2632 // if not, just stick a <head> tag at the beginning
2633 $text = '<head>'.$stylesheetshtml.'</head>'."\n".$text;
2634 return $text;
2638 * RESTful cURL class
2640 * This is a wrapper class for curl, it is quite easy to use:
2641 * <code>
2642 * $c = new curl;
2643 * // enable cache
2644 * $c = new curl(array('cache'=>true));
2645 * // enable cookie
2646 * $c = new curl(array('cookie'=>true));
2647 * // enable proxy
2648 * $c = new curl(array('proxy'=>true));
2650 * // HTTP GET Method
2651 * $html = $c->get('http://example.com');
2652 * // HTTP POST Method
2653 * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2654 * // HTTP PUT Method
2655 * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2656 * </code>
2658 * @package core_files
2659 * @category files
2660 * @copyright Dongsheng Cai <dongsheng@moodle.com>
2661 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
2663 class curl {
2664 /** @var bool Caches http request contents */
2665 public $cache = false;
2666 /** @var bool Uses proxy, null means automatic based on URL */
2667 public $proxy = null;
2668 /** @var string library version */
2669 public $version = '0.4 dev';
2670 /** @var array http's response */
2671 public $response = array();
2672 /** @var array Raw response headers, needed for BC in download_file_content(). */
2673 public $rawresponse = array();
2674 /** @var array http header */
2675 public $header = array();
2676 /** @var string cURL information */
2677 public $info;
2678 /** @var string error */
2679 public $error;
2680 /** @var int error code */
2681 public $errno;
2682 /** @var bool use workaround for open_basedir restrictions, to be changed from unit tests only! */
2683 public $emulateredirects = null;
2685 /** @var array cURL options */
2686 private $options;
2687 /** @var string Proxy host */
2688 private $proxy_host = '';
2689 /** @var string Proxy auth */
2690 private $proxy_auth = '';
2691 /** @var string Proxy type */
2692 private $proxy_type = '';
2693 /** @var bool Debug mode on */
2694 private $debug = false;
2695 /** @var bool|string Path to cookie file */
2696 private $cookie = false;
2697 /** @var bool tracks multiple headers in response - redirect detection */
2698 private $responsefinished = false;
2701 * Curl constructor.
2703 * Allowed settings are:
2704 * proxy: (bool) use proxy server, null means autodetect non-local from url
2705 * debug: (bool) use debug output
2706 * cookie: (string) path to cookie file, false if none
2707 * cache: (bool) use cache
2708 * module_cache: (string) type of cache
2710 * @param array $settings
2712 public function __construct($settings = array()) {
2713 global $CFG;
2714 if (!function_exists('curl_init')) {
2715 $this->error = 'cURL module must be enabled!';
2716 trigger_error($this->error, E_USER_ERROR);
2717 return false;
2720 // All settings of this class should be init here.
2721 $this->resetopt();
2722 if (!empty($settings['debug'])) {
2723 $this->debug = true;
2725 if (!empty($settings['cookie'])) {
2726 if($settings['cookie'] === true) {
2727 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2728 } else {
2729 $this->cookie = $settings['cookie'];
2732 if (!empty($settings['cache'])) {
2733 if (class_exists('curl_cache')) {
2734 if (!empty($settings['module_cache'])) {
2735 $this->cache = new curl_cache($settings['module_cache']);
2736 } else {
2737 $this->cache = new curl_cache('misc');
2741 if (!empty($CFG->proxyhost)) {
2742 if (empty($CFG->proxyport)) {
2743 $this->proxy_host = $CFG->proxyhost;
2744 } else {
2745 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2747 if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2748 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2749 $this->setopt(array(
2750 'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2751 'proxyuserpwd'=>$this->proxy_auth));
2753 if (!empty($CFG->proxytype)) {
2754 if ($CFG->proxytype == 'SOCKS5') {
2755 $this->proxy_type = CURLPROXY_SOCKS5;
2756 } else {
2757 $this->proxy_type = CURLPROXY_HTTP;
2758 $this->setopt(array('httpproxytunnel'=>false));
2760 $this->setopt(array('proxytype'=>$this->proxy_type));
2763 if (isset($settings['proxy'])) {
2764 $this->proxy = $settings['proxy'];
2766 } else {
2767 $this->proxy = false;
2770 if (!isset($this->emulateredirects)) {
2771 $this->emulateredirects = ini_get('open_basedir');
2776 * Resets the CURL options that have already been set
2778 public function resetopt() {
2779 $this->options = array();
2780 $this->options['CURLOPT_USERAGENT'] = 'MoodleBot/1.0';
2781 // True to include the header in the output
2782 $this->options['CURLOPT_HEADER'] = 0;
2783 // True to Exclude the body from the output
2784 $this->options['CURLOPT_NOBODY'] = 0;
2785 // Redirect ny default.
2786 $this->options['CURLOPT_FOLLOWLOCATION'] = 1;
2787 $this->options['CURLOPT_MAXREDIRS'] = 10;
2788 $this->options['CURLOPT_ENCODING'] = '';
2789 // TRUE to return the transfer as a string of the return
2790 // value of curl_exec() instead of outputting it out directly.
2791 $this->options['CURLOPT_RETURNTRANSFER'] = 1;
2792 $this->options['CURLOPT_SSL_VERIFYPEER'] = 0;
2793 $this->options['CURLOPT_SSL_VERIFYHOST'] = 2;
2794 $this->options['CURLOPT_CONNECTTIMEOUT'] = 30;
2796 if ($cacert = self::get_cacert()) {
2797 $this->options['CURLOPT_CAINFO'] = $cacert;
2802 * Get the location of ca certificates.
2803 * @return string absolute file path or empty if default used
2805 public static function get_cacert() {
2806 global $CFG;
2808 // Bundle in dataroot always wins.
2809 if (is_readable("$CFG->dataroot/moodleorgca.crt")) {
2810 return realpath("$CFG->dataroot/moodleorgca.crt");
2813 // Next comes the default from php.ini
2814 $cacert = ini_get('curl.cainfo');
2815 if (!empty($cacert) and is_readable($cacert)) {
2816 return realpath($cacert);
2819 // Windows PHP does not have any certs, we need to use something.
2820 if ($CFG->ostype === 'WINDOWS') {
2821 if (is_readable("$CFG->libdir/cacert.pem")) {
2822 return realpath("$CFG->libdir/cacert.pem");
2826 // Use default, this should work fine on all properly configured *nix systems.
2827 return null;
2831 * Reset Cookie
2833 public function resetcookie() {
2834 if (!empty($this->cookie)) {
2835 if (is_file($this->cookie)) {
2836 $fp = fopen($this->cookie, 'w');
2837 if (!empty($fp)) {
2838 fwrite($fp, '');
2839 fclose($fp);
2846 * Set curl options.
2848 * Do not use the curl constants to define the options, pass a string
2849 * corresponding to that constant. Ie. to set CURLOPT_MAXREDIRS, pass
2850 * array('CURLOPT_MAXREDIRS' => 10) or array('maxredirs' => 10) to this method.
2852 * @param array $options If array is null, this function will reset the options to default value.
2853 * @return void
2854 * @throws coding_exception If an option uses constant value instead of option name.
2856 public function setopt($options = array()) {
2857 if (is_array($options)) {
2858 foreach ($options as $name => $val) {
2859 if (!is_string($name)) {
2860 throw new coding_exception('Curl options should be defined using strings, not constant values.');
2862 if (stripos($name, 'CURLOPT_') === false) {
2863 $name = strtoupper('CURLOPT_'.$name);
2864 } else {
2865 $name = strtoupper($name);
2867 $this->options[$name] = $val;
2873 * Reset http method
2875 public function cleanopt() {
2876 unset($this->options['CURLOPT_HTTPGET']);
2877 unset($this->options['CURLOPT_POST']);
2878 unset($this->options['CURLOPT_POSTFIELDS']);
2879 unset($this->options['CURLOPT_PUT']);
2880 unset($this->options['CURLOPT_INFILE']);
2881 unset($this->options['CURLOPT_INFILESIZE']);
2882 unset($this->options['CURLOPT_CUSTOMREQUEST']);
2883 unset($this->options['CURLOPT_FILE']);
2887 * Resets the HTTP Request headers (to prepare for the new request)
2889 public function resetHeader() {
2890 $this->header = array();
2894 * Set HTTP Request Header
2896 * @param array $header
2898 public function setHeader($header) {
2899 if (is_array($header)) {
2900 foreach ($header as $v) {
2901 $this->setHeader($v);
2903 } else {
2904 // Remove newlines, they are not allowed in headers.
2905 $this->header[] = preg_replace('/[\r\n]/', '', $header);
2910 * Get HTTP Response Headers
2911 * @return array of arrays
2913 public function getResponse() {
2914 return $this->response;
2918 * Get raw HTTP Response Headers
2919 * @return array of strings
2921 public function get_raw_response() {
2922 return $this->rawresponse;
2926 * private callback function
2927 * Formatting HTTP Response Header
2929 * We only keep the last headers returned. For example during a redirect the
2930 * redirect headers will not appear in {@link self::getResponse()}, if you need
2931 * to use those headers, refer to {@link self::get_raw_response()}.
2933 * @param resource $ch Apparently not used
2934 * @param string $header
2935 * @return int The strlen of the header
2937 private function formatHeader($ch, $header) {
2938 $this->rawresponse[] = $header;
2940 if (trim($header, "\r\n") === '') {
2941 // This must be the last header.
2942 $this->responsefinished = true;
2945 if (strlen($header) > 2) {
2946 if ($this->responsefinished) {
2947 // We still have headers after the supposedly last header, we must be
2948 // in a redirect so let's empty the response to keep the last headers.
2949 $this->responsefinished = false;
2950 $this->response = array();
2952 list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
2953 $key = rtrim($key, ':');
2954 if (!empty($this->response[$key])) {
2955 if (is_array($this->response[$key])) {
2956 $this->response[$key][] = $value;
2957 } else {
2958 $tmp = $this->response[$key];
2959 $this->response[$key] = array();
2960 $this->response[$key][] = $tmp;
2961 $this->response[$key][] = $value;
2964 } else {
2965 $this->response[$key] = $value;
2968 return strlen($header);
2972 * Set options for individual curl instance
2974 * @param resource $curl A curl handle
2975 * @param array $options
2976 * @return resource The curl handle
2978 private function apply_opt($curl, $options) {
2979 // Clean up
2980 $this->cleanopt();
2981 // set cookie
2982 if (!empty($this->cookie) || !empty($options['cookie'])) {
2983 $this->setopt(array('cookiejar'=>$this->cookie,
2984 'cookiefile'=>$this->cookie
2988 // Bypass proxy if required.
2989 if ($this->proxy === null) {
2990 if (!empty($this->options['CURLOPT_URL']) and is_proxybypass($this->options['CURLOPT_URL'])) {
2991 $proxy = false;
2992 } else {
2993 $proxy = true;
2995 } else {
2996 $proxy = (bool)$this->proxy;
2999 // Set proxy.
3000 if ($proxy) {
3001 $options['CURLOPT_PROXY'] = $this->proxy_host;
3002 } else {
3003 unset($this->options['CURLOPT_PROXY']);
3006 $this->setopt($options);
3007 // reset before set options
3008 curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
3009 // set headers
3010 if (empty($this->header)) {
3011 $this->setHeader(array(
3012 'User-Agent: MoodleBot/1.0',
3013 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
3014 'Connection: keep-alive'
3017 curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
3019 if ($this->debug) {
3020 echo '<h1>Options</h1>';
3021 var_dump($this->options);
3022 echo '<h1>Header</h1>';
3023 var_dump($this->header);
3026 // Do not allow infinite redirects.
3027 if (!isset($this->options['CURLOPT_MAXREDIRS'])) {
3028 $this->options['CURLOPT_MAXREDIRS'] = 0;
3029 } else if ($this->options['CURLOPT_MAXREDIRS'] > 100) {
3030 $this->options['CURLOPT_MAXREDIRS'] = 100;
3031 } else {
3032 $this->options['CURLOPT_MAXREDIRS'] = (int)$this->options['CURLOPT_MAXREDIRS'];
3035 // Make sure we always know if redirects expected.
3036 if (!isset($this->options['CURLOPT_FOLLOWLOCATION'])) {
3037 $this->options['CURLOPT_FOLLOWLOCATION'] = 0;
3040 // Limit the protocols to HTTP and HTTPS.
3041 if (defined('CURLOPT_PROTOCOLS')) {
3042 $this->options['CURLOPT_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS);
3043 $this->options['CURLOPT_REDIR_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS);
3046 // Set options.
3047 foreach($this->options as $name => $val) {
3048 if ($name === 'CURLOPT_FOLLOWLOCATION' and $this->emulateredirects) {
3049 // The redirects are emulated elsewhere.
3050 curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 0);
3051 continue;
3053 $name = constant($name);
3054 curl_setopt($curl, $name, $val);
3057 return $curl;
3061 * Download multiple files in parallel
3063 * Calls {@link multi()} with specific download headers
3065 * <code>
3066 * $c = new curl();
3067 * $file1 = fopen('a', 'wb');
3068 * $file2 = fopen('b', 'wb');
3069 * $c->download(array(
3070 * array('url'=>'http://localhost/', 'file'=>$file1),
3071 * array('url'=>'http://localhost/20/', 'file'=>$file2)
3072 * ));
3073 * fclose($file1);
3074 * fclose($file2);
3075 * </code>
3077 * or
3079 * <code>
3080 * $c = new curl();
3081 * $c->download(array(
3082 * array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3083 * array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3084 * ));
3085 * </code>
3087 * @param array $requests An array of files to request {
3088 * url => url to download the file [required]
3089 * file => file handler, or
3090 * filepath => file path
3092 * If 'file' and 'filepath' parameters are both specified in one request, the
3093 * open file handle in the 'file' parameter will take precedence and 'filepath'
3094 * will be ignored.
3096 * @param array $options An array of options to set
3097 * @return array An array of results
3099 public function download($requests, $options = array()) {
3100 $options['RETURNTRANSFER'] = false;
3101 return $this->multi($requests, $options);
3105 * Multi HTTP Requests
3106 * This function could run multi-requests in parallel.
3108 * @param array $requests An array of files to request
3109 * @param array $options An array of options to set
3110 * @return array An array of results
3112 protected function multi($requests, $options = array()) {
3113 $count = count($requests);
3114 $handles = array();
3115 $results = array();
3116 $main = curl_multi_init();
3117 for ($i = 0; $i < $count; $i++) {
3118 if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3119 // open file
3120 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3121 $requests[$i]['auto-handle'] = true;
3123 foreach($requests[$i] as $n=>$v) {
3124 $options[$n] = $v;
3126 $handles[$i] = curl_init($requests[$i]['url']);
3127 $this->apply_opt($handles[$i], $options);
3128 curl_multi_add_handle($main, $handles[$i]);
3130 $running = 0;
3131 do {
3132 curl_multi_exec($main, $running);
3133 } while($running > 0);
3134 for ($i = 0; $i < $count; $i++) {
3135 if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3136 $results[] = true;
3137 } else {
3138 $results[] = curl_multi_getcontent($handles[$i]);
3140 curl_multi_remove_handle($main, $handles[$i]);
3142 curl_multi_close($main);
3144 for ($i = 0; $i < $count; $i++) {
3145 if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3146 // close file handler if file is opened in this function
3147 fclose($requests[$i]['file']);
3150 return $results;
3154 * Single HTTP Request
3156 * @param string $url The URL to request
3157 * @param array $options
3158 * @return bool
3160 protected function request($url, $options = array()) {
3161 // Set the URL as a curl option.
3162 $this->setopt(array('CURLOPT_URL' => $url));
3164 // Create curl instance.
3165 $curl = curl_init();
3167 // Reset here so that the data is valid when result returned from cache.
3168 $this->info = array();
3169 $this->error = '';
3170 $this->errno = 0;
3171 $this->response = array();
3172 $this->rawresponse = array();
3173 $this->responsefinished = false;
3175 $this->apply_opt($curl, $options);
3176 if ($this->cache && $ret = $this->cache->get($this->options)) {
3177 return $ret;
3180 $ret = curl_exec($curl);
3181 $this->info = curl_getinfo($curl);
3182 $this->error = curl_error($curl);
3183 $this->errno = curl_errno($curl);
3184 // Note: $this->response and $this->rawresponse are filled by $hits->formatHeader callback.
3186 if ($this->emulateredirects and $this->options['CURLOPT_FOLLOWLOCATION'] and $this->info['http_code'] != 200) {
3187 $redirects = 0;
3189 while($redirects <= $this->options['CURLOPT_MAXREDIRS']) {
3191 if ($this->info['http_code'] == 301) {
3192 // Moved Permanently - repeat the same request on new URL.
3194 } else if ($this->info['http_code'] == 302) {
3195 // Found - the standard redirect - repeat the same request on new URL.
3197 } else if ($this->info['http_code'] == 303) {
3198 // 303 See Other - repeat only if GET, do not bother with POSTs.
3199 if (empty($this->options['CURLOPT_HTTPGET'])) {
3200 break;
3203 } else if ($this->info['http_code'] == 307) {
3204 // Temporary Redirect - must repeat using the same request type.
3206 } else if ($this->info['http_code'] == 308) {
3207 // Permanent Redirect - must repeat using the same request type.
3209 } else {
3210 // Some other http code means do not retry!
3211 break;
3214 $redirects++;
3216 $redirecturl = null;
3217 if (isset($this->info['redirect_url'])) {
3218 if (preg_match('|^https?://|i', $this->info['redirect_url'])) {
3219 $redirecturl = $this->info['redirect_url'];
3222 if (!$redirecturl) {
3223 foreach ($this->response as $k => $v) {
3224 if (strtolower($k) === 'location') {
3225 $redirecturl = $v;
3226 break;
3229 if (preg_match('|^https?://|i', $redirecturl)) {
3230 // Great, this is the correct location format!
3232 } else if ($redirecturl) {
3233 $current = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL);
3234 if (strpos($redirecturl, '/') === 0) {
3235 // Relative to server root - just guess.
3236 $pos = strpos('/', $current, 8);
3237 if ($pos === false) {
3238 $redirecturl = $current.$redirecturl;
3239 } else {
3240 $redirecturl = substr($current, 0, $pos).$redirecturl;
3242 } else {
3243 // Relative to current script.
3244 $redirecturl = dirname($current).'/'.$redirecturl;
3249 curl_setopt($curl, CURLOPT_URL, $redirecturl);
3250 $ret = curl_exec($curl);
3252 $this->info = curl_getinfo($curl);
3253 $this->error = curl_error($curl);
3254 $this->errno = curl_errno($curl);
3256 $this->info['redirect_count'] = $redirects;
3258 if ($this->info['http_code'] === 200) {
3259 // Finally this is what we wanted.
3260 break;
3262 if ($this->errno != CURLE_OK) {
3263 // Something wrong is going on.
3264 break;
3267 if ($redirects > $this->options['CURLOPT_MAXREDIRS']) {
3268 $this->errno = CURLE_TOO_MANY_REDIRECTS;
3269 $this->error = 'Maximum ('.$this->options['CURLOPT_MAXREDIRS'].') redirects followed';
3273 if ($this->cache) {
3274 $this->cache->set($this->options, $ret);
3277 if ($this->debug) {
3278 echo '<h1>Return Data</h1>';
3279 var_dump($ret);
3280 echo '<h1>Info</h1>';
3281 var_dump($this->info);
3282 echo '<h1>Error</h1>';
3283 var_dump($this->error);
3286 curl_close($curl);
3288 if (empty($this->error)) {
3289 return $ret;
3290 } else {
3291 return $this->error;
3292 // exception is not ajax friendly
3293 //throw new moodle_exception($this->error, 'curl');
3298 * HTTP HEAD method
3300 * @see request()
3302 * @param string $url
3303 * @param array $options
3304 * @return bool
3306 public function head($url, $options = array()) {
3307 $options['CURLOPT_HTTPGET'] = 0;
3308 $options['CURLOPT_HEADER'] = 1;
3309 $options['CURLOPT_NOBODY'] = 1;
3310 return $this->request($url, $options);
3314 * HTTP POST method
3316 * @param string $url
3317 * @param array|string $params
3318 * @param array $options
3319 * @return bool
3321 public function post($url, $params = '', $options = array()) {
3322 $options['CURLOPT_POST'] = 1;
3323 if (is_array($params)) {
3324 $this->_tmp_file_post_params = array();
3325 foreach ($params as $key => $value) {
3326 if ($value instanceof stored_file) {
3327 $value->add_to_curl_request($this, $key);
3328 } else {
3329 $this->_tmp_file_post_params[$key] = $value;
3332 $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3333 unset($this->_tmp_file_post_params);
3334 } else {
3335 // $params is the raw post data
3336 $options['CURLOPT_POSTFIELDS'] = $params;
3338 return $this->request($url, $options);
3342 * HTTP GET method
3344 * @param string $url
3345 * @param array $params
3346 * @param array $options
3347 * @return bool
3349 public function get($url, $params = array(), $options = array()) {
3350 $options['CURLOPT_HTTPGET'] = 1;
3352 if (!empty($params)) {
3353 $url .= (stripos($url, '?') !== false) ? '&' : '?';
3354 $url .= http_build_query($params, '', '&');
3356 return $this->request($url, $options);
3360 * Downloads one file and writes it to the specified file handler
3362 * <code>
3363 * $c = new curl();
3364 * $file = fopen('savepath', 'w');
3365 * $result = $c->download_one('http://localhost/', null,
3366 * array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3367 * fclose($file);
3368 * $download_info = $c->get_info();
3369 * if ($result === true) {
3370 * // file downloaded successfully
3371 * } else {
3372 * $error_text = $result;
3373 * $error_code = $c->get_errno();
3375 * </code>
3377 * <code>
3378 * $c = new curl();
3379 * $result = $c->download_one('http://localhost/', null,
3380 * array('filepath' => 'savepath', 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3381 * // ... see above, no need to close handle and remove file if unsuccessful
3382 * </code>
3384 * @param string $url
3385 * @param array|null $params key-value pairs to be added to $url as query string
3386 * @param array $options request options. Must include either 'file' or 'filepath'
3387 * @return bool|string true on success or error string on failure
3389 public function download_one($url, $params, $options = array()) {
3390 $options['CURLOPT_HTTPGET'] = 1;
3391 if (!empty($params)) {
3392 $url .= (stripos($url, '?') !== false) ? '&' : '?';
3393 $url .= http_build_query($params, '', '&');
3395 if (!empty($options['filepath']) && empty($options['file'])) {
3396 // open file
3397 if (!($options['file'] = fopen($options['filepath'], 'w'))) {
3398 $this->errno = 100;
3399 return get_string('cannotwritefile', 'error', $options['filepath']);
3401 $filepath = $options['filepath'];
3403 unset($options['filepath']);
3404 $result = $this->request($url, $options);
3405 if (isset($filepath)) {
3406 fclose($options['file']);
3407 if ($result !== true) {
3408 unlink($filepath);
3411 return $result;
3415 * HTTP PUT method
3417 * @param string $url
3418 * @param array $params
3419 * @param array $options
3420 * @return bool
3422 public function put($url, $params = array(), $options = array()) {
3423 $file = $params['file'];
3424 if (!is_file($file)) {
3425 return null;
3427 $fp = fopen($file, 'r');
3428 $size = filesize($file);
3429 $options['CURLOPT_PUT'] = 1;
3430 $options['CURLOPT_INFILESIZE'] = $size;
3431 $options['CURLOPT_INFILE'] = $fp;
3432 if (!isset($this->options['CURLOPT_USERPWD'])) {
3433 $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
3435 $ret = $this->request($url, $options);
3436 fclose($fp);
3437 return $ret;
3441 * HTTP DELETE method
3443 * @param string $url
3444 * @param array $param
3445 * @param array $options
3446 * @return bool
3448 public function delete($url, $param = array(), $options = array()) {
3449 $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
3450 if (!isset($options['CURLOPT_USERPWD'])) {
3451 $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
3453 $ret = $this->request($url, $options);
3454 return $ret;
3458 * HTTP TRACE method
3460 * @param string $url
3461 * @param array $options
3462 * @return bool
3464 public function trace($url, $options = array()) {
3465 $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
3466 $ret = $this->request($url, $options);
3467 return $ret;
3471 * HTTP OPTIONS method
3473 * @param string $url
3474 * @param array $options
3475 * @return bool
3477 public function options($url, $options = array()) {
3478 $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
3479 $ret = $this->request($url, $options);
3480 return $ret;
3484 * Get curl information
3486 * @return string
3488 public function get_info() {
3489 return $this->info;
3493 * Get curl error code
3495 * @return int
3497 public function get_errno() {
3498 return $this->errno;
3502 * When using a proxy, an additional HTTP response code may appear at
3503 * the start of the header. For example, when using https over a proxy
3504 * there may be 'HTTP/1.0 200 Connection Established'. Other codes are
3505 * also possible and some may come with their own headers.
3507 * If using the return value containing all headers, this function can be
3508 * called to remove unwanted doubles.
3510 * Note that it is not possible to distinguish this situation from valid
3511 * data unless you know the actual response part (below the headers)
3512 * will not be included in this string, or else will not 'look like' HTTP
3513 * headers. As a result it is not safe to call this function for general
3514 * data.
3516 * @param string $input Input HTTP response
3517 * @return string HTTP response with additional headers stripped if any
3519 public static function strip_double_headers($input) {
3520 // I have tried to make this regular expression as specific as possible
3521 // to avoid any case where it does weird stuff if you happen to put
3522 // HTTP/1.1 200 at the start of any line in your RSS file. This should
3523 // also make it faster because it can abandon regex processing as soon
3524 // as it hits something that doesn't look like an http header. The
3525 // header definition is taken from RFC 822, except I didn't support
3526 // folding which is never used in practice.
3527 $crlf = "\r\n";
3528 return preg_replace(
3529 // HTTP version and status code (ignore value of code).
3530 '~^HTTP/1\..*' . $crlf .
3531 // Header name: character between 33 and 126 decimal, except colon.
3532 // Colon. Header value: any character except \r and \n. CRLF.
3533 '(?:[\x21-\x39\x3b-\x7e]+:[^' . $crlf . ']+' . $crlf . ')*' .
3534 // Headers are terminated by another CRLF (blank line).
3535 $crlf .
3536 // Second HTTP status code, this time must be 200.
3537 '(HTTP/1.[01] 200 )~', '$1', $input);
3542 * This class is used by cURL class, use case:
3544 * <code>
3545 * $CFG->repositorycacheexpire = 120;
3546 * $CFG->curlcache = 120;
3548 * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
3549 * $ret = $c->get('http://www.google.com');
3550 * </code>
3552 * @package core_files
3553 * @copyright Dongsheng Cai <dongsheng@moodle.com>
3554 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3556 class curl_cache {
3557 /** @var string Path to cache directory */
3558 public $dir = '';
3561 * Constructor
3563 * @global stdClass $CFG
3564 * @param string $module which module is using curl_cache
3566 public function __construct($module = 'repository') {
3567 global $CFG;
3568 if (!empty($module)) {
3569 $this->dir = $CFG->cachedir.'/'.$module.'/';
3570 } else {
3571 $this->dir = $CFG->cachedir.'/misc/';
3573 if (!file_exists($this->dir)) {
3574 mkdir($this->dir, $CFG->directorypermissions, true);
3576 if ($module == 'repository') {
3577 if (empty($CFG->repositorycacheexpire)) {
3578 $CFG->repositorycacheexpire = 120;
3580 $this->ttl = $CFG->repositorycacheexpire;
3581 } else {
3582 if (empty($CFG->curlcache)) {
3583 $CFG->curlcache = 120;
3585 $this->ttl = $CFG->curlcache;
3590 * Get cached value
3592 * @global stdClass $CFG
3593 * @global stdClass $USER
3594 * @param mixed $param
3595 * @return bool|string
3597 public function get($param) {
3598 global $CFG, $USER;
3599 $this->cleanup($this->ttl);
3600 $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3601 if(file_exists($this->dir.$filename)) {
3602 $lasttime = filemtime($this->dir.$filename);
3603 if (time()-$lasttime > $this->ttl) {
3604 return false;
3605 } else {
3606 $fp = fopen($this->dir.$filename, 'r');
3607 $size = filesize($this->dir.$filename);
3608 $content = fread($fp, $size);
3609 return unserialize($content);
3612 return false;
3616 * Set cache value
3618 * @global object $CFG
3619 * @global object $USER
3620 * @param mixed $param
3621 * @param mixed $val
3623 public function set($param, $val) {
3624 global $CFG, $USER;
3625 $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3626 $fp = fopen($this->dir.$filename, 'w');
3627 fwrite($fp, serialize($val));
3628 fclose($fp);
3629 @chmod($this->dir.$filename, $CFG->filepermissions);
3633 * Remove cache files
3635 * @param int $expire The number of seconds before expiry
3637 public function cleanup($expire) {
3638 if ($dir = opendir($this->dir)) {
3639 while (false !== ($file = readdir($dir))) {
3640 if(!is_dir($file) && $file != '.' && $file != '..') {
3641 $lasttime = @filemtime($this->dir.$file);
3642 if (time() - $lasttime > $expire) {
3643 @unlink($this->dir.$file);
3647 closedir($dir);
3651 * delete current user's cache file
3653 * @global object $CFG
3654 * @global object $USER
3656 public function refresh() {
3657 global $CFG, $USER;
3658 if ($dir = opendir($this->dir)) {
3659 while (false !== ($file = readdir($dir))) {
3660 if (!is_dir($file) && $file != '.' && $file != '..') {
3661 if (strpos($file, 'u'.$USER->id.'_') !== false) {
3662 @unlink($this->dir.$file);
3671 * This function delegates file serving to individual plugins
3673 * @param string $relativepath
3674 * @param bool $forcedownload
3675 * @param null|string $preview the preview mode, defaults to serving the original file
3676 * @todo MDL-31088 file serving improments
3678 function file_pluginfile($relativepath, $forcedownload, $preview = null) {
3679 global $DB, $CFG, $USER;
3680 // relative path must start with '/'
3681 if (!$relativepath) {
3682 print_error('invalidargorconf');
3683 } else if ($relativepath[0] != '/') {
3684 print_error('pathdoesnotstartslash');
3687 // extract relative path components
3688 $args = explode('/', ltrim($relativepath, '/'));
3690 if (count($args) < 3) { // always at least context, component and filearea
3691 print_error('invalidarguments');
3694 $contextid = (int)array_shift($args);
3695 $component = clean_param(array_shift($args), PARAM_COMPONENT);
3696 $filearea = clean_param(array_shift($args), PARAM_AREA);
3698 list($context, $course, $cm) = get_context_info_array($contextid);
3700 $fs = get_file_storage();
3702 // ========================================================================================================================
3703 if ($component === 'blog') {
3704 // Blog file serving
3705 if ($context->contextlevel != CONTEXT_SYSTEM) {
3706 send_file_not_found();
3708 if ($filearea !== 'attachment' and $filearea !== 'post') {
3709 send_file_not_found();
3712 if (empty($CFG->enableblogs)) {
3713 print_error('siteblogdisable', 'blog');
3716 $entryid = (int)array_shift($args);
3717 if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3718 send_file_not_found();
3720 if ($CFG->bloglevel < BLOG_GLOBAL_LEVEL) {
3721 require_login();
3722 if (isguestuser()) {
3723 print_error('noguest');
3725 if ($CFG->bloglevel == BLOG_USER_LEVEL) {
3726 if ($USER->id != $entry->userid) {
3727 send_file_not_found();
3732 if ($entry->publishstate === 'public') {
3733 if ($CFG->forcelogin) {
3734 require_login();
3737 } else if ($entry->publishstate === 'site') {
3738 require_login();
3739 //ok
3740 } else if ($entry->publishstate === 'draft') {
3741 require_login();
3742 if ($USER->id != $entry->userid) {
3743 send_file_not_found();
3747 $filename = array_pop($args);
3748 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3750 if (!$file = $fs->get_file($context->id, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3751 send_file_not_found();
3754 send_stored_file($file, 10*60, 0, true, array('preview' => $preview)); // download MUST be forced - security!
3756 // ========================================================================================================================
3757 } else if ($component === 'grade') {
3758 if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel == CONTEXT_SYSTEM) {
3759 // Global gradebook files
3760 if ($CFG->forcelogin) {
3761 require_login();
3764 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3766 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3767 send_file_not_found();
3770 \core\session\manager::write_close(); // Unlock session during file serving.
3771 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3773 } else if ($filearea === 'feedback' and $context->contextlevel == CONTEXT_COURSE) {
3774 //TODO: nobody implemented this yet in grade edit form!!
3775 send_file_not_found();
3777 if ($CFG->forcelogin || $course->id != SITEID) {
3778 require_login($course);
3781 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3783 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3784 send_file_not_found();
3787 \core\session\manager::write_close(); // Unlock session during file serving.
3788 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3789 } else {
3790 send_file_not_found();
3793 // ========================================================================================================================
3794 } else if ($component === 'tag') {
3795 if ($filearea === 'description' and $context->contextlevel == CONTEXT_SYSTEM) {
3797 // All tag descriptions are going to be public but we still need to respect forcelogin
3798 if ($CFG->forcelogin) {
3799 require_login();
3802 $fullpath = "/$context->id/tag/description/".implode('/', $args);
3804 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3805 send_file_not_found();
3808 \core\session\manager::write_close(); // Unlock session during file serving.
3809 send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3811 } else {
3812 send_file_not_found();
3814 // ========================================================================================================================
3815 } else if ($component === 'badges') {
3816 require_once($CFG->libdir . '/badgeslib.php');
3818 $badgeid = (int)array_shift($args);
3819 $badge = new badge($badgeid);
3820 $filename = array_pop($args);
3822 if ($filearea === 'badgeimage') {
3823 if ($filename !== 'f1' && $filename !== 'f2') {
3824 send_file_not_found();
3826 if (!$file = $fs->get_file($context->id, 'badges', 'badgeimage', $badge->id, '/', $filename.'.png')) {
3827 send_file_not_found();
3830 \core\session\manager::write_close();
3831 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3832 } else if ($filearea === 'userbadge' and $context->contextlevel == CONTEXT_USER) {
3833 if (!$file = $fs->get_file($context->id, 'badges', 'userbadge', $badge->id, '/', $filename.'.png')) {
3834 send_file_not_found();
3837 \core\session\manager::write_close();
3838 send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3840 // ========================================================================================================================
3841 } else if ($component === 'calendar') {
3842 if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_SYSTEM) {
3844 // All events here are public the one requirement is that we respect forcelogin
3845 if ($CFG->forcelogin) {
3846 require_login();
3849 // Get the event if from the args array
3850 $eventid = array_shift($args);
3852 // Load the event from the database
3853 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
3854 send_file_not_found();
3857 // Get the file and serve if successful
3858 $filename = array_pop($args);
3859 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3860 if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3861 send_file_not_found();
3864 \core\session\manager::write_close(); // Unlock session during file serving.
3865 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3867 } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_USER) {
3869 // Must be logged in, if they are not then they obviously can't be this user
3870 require_login();
3872 // Don't want guests here, potentially saves a DB call
3873 if (isguestuser()) {
3874 send_file_not_found();
3877 // Get the event if from the args array
3878 $eventid = array_shift($args);
3880 // Load the event from the database - user id must match
3881 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id, 'eventtype'=>'user'))) {
3882 send_file_not_found();
3885 // Get the file and serve if successful
3886 $filename = array_pop($args);
3887 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3888 if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3889 send_file_not_found();
3892 \core\session\manager::write_close(); // Unlock session during file serving.
3893 send_stored_file($file, 0, 0, true, array('preview' => $preview));
3895 } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_COURSE) {
3897 // Respect forcelogin and require login unless this is the site.... it probably
3898 // should NEVER be the site
3899 if ($CFG->forcelogin || $course->id != SITEID) {
3900 require_login($course);
3903 // Must be able to at least view the course. This does not apply to the front page.
3904 if ($course->id != SITEID && (!is_enrolled($context)) && (!is_viewing($context))) {
3905 //TODO: hmm, do we really want to block guests here?
3906 send_file_not_found();
3909 // Get the event id
3910 $eventid = array_shift($args);
3912 // Load the event from the database we need to check whether it is
3913 // a) valid course event
3914 // b) a group event
3915 // Group events use the course context (there is no group context)
3916 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id))) {
3917 send_file_not_found();
3920 // If its a group event require either membership of view all groups capability
3921 if ($event->eventtype === 'group') {
3922 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid, $USER->id)) {
3923 send_file_not_found();
3925 } else if ($event->eventtype === 'course' || $event->eventtype === 'site') {
3926 // Ok. Please note that the event type 'site' still uses a course context.
3927 } else {
3928 // Some other type.
3929 send_file_not_found();
3932 // If we get this far we can serve the file
3933 $filename = array_pop($args);
3934 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3935 if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3936 send_file_not_found();
3939 \core\session\manager::write_close(); // Unlock session during file serving.
3940 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3942 } else {
3943 send_file_not_found();
3946 // ========================================================================================================================
3947 } else if ($component === 'user') {
3948 if ($filearea === 'icon' and $context->contextlevel == CONTEXT_USER) {
3949 if (count($args) == 1) {
3950 $themename = theme_config::DEFAULT_THEME;
3951 $filename = array_shift($args);
3952 } else {
3953 $themename = array_shift($args);
3954 $filename = array_shift($args);
3957 // fix file name automatically
3958 if ($filename !== 'f1' and $filename !== 'f2' and $filename !== 'f3') {
3959 $filename = 'f1';
3962 if ((!empty($CFG->forcelogin) and !isloggedin()) ||
3963 (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))) {
3964 // protect images if login required and not logged in;
3965 // also if login is required for profile images and is not logged in or guest
3966 // do not use require_login() because it is expensive and not suitable here anyway
3967 $theme = theme_config::load($themename);
3968 redirect($theme->pix_url('u/'.$filename, 'moodle')); // intentionally not cached
3971 if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'.png')) {
3972 if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'.jpg')) {
3973 if ($filename === 'f3') {
3974 // f3 512x512px was introduced in 2.3, there might be only the smaller version.
3975 if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', 'f1.png')) {
3976 $file = $fs->get_file($context->id, 'user', 'icon', 0, '/', 'f1.jpg');
3981 if (!$file) {
3982 // bad reference - try to prevent future retries as hard as possible!
3983 if ($user = $DB->get_record('user', array('id'=>$context->instanceid), 'id, picture')) {
3984 if ($user->picture > 0) {
3985 $DB->set_field('user', 'picture', 0, array('id'=>$user->id));
3988 // no redirect here because it is not cached
3989 $theme = theme_config::load($themename);
3990 $imagefile = $theme->resolve_image_location('u/'.$filename, 'moodle', null);
3991 send_file($imagefile, basename($imagefile), 60*60*24*14);
3994 $options = array('preview' => $preview);
3995 if (empty($CFG->forcelogin) && empty($CFG->forceloginforprofileimage)) {
3996 // Profile images should be cache-able by both browsers and proxies according
3997 // to $CFG->forcelogin and $CFG->forceloginforprofileimage.
3998 $options['cacheability'] = 'public';
4000 send_stored_file($file, 60*60*24*365, 0, false, $options); // enable long caching, there are many images on each page
4002 } else if ($filearea === 'private' and $context->contextlevel == CONTEXT_USER) {
4003 require_login();
4005 if (isguestuser()) {
4006 send_file_not_found();
4009 if ($USER->id !== $context->instanceid) {
4010 send_file_not_found();
4013 $filename = array_pop($args);
4014 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4015 if (!$file = $fs->get_file($context->id, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4016 send_file_not_found();
4019 \core\session\manager::write_close(); // Unlock session during file serving.
4020 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4022 } else if ($filearea === 'profile' and $context->contextlevel == CONTEXT_USER) {
4024 if ($CFG->forcelogin) {
4025 require_login();
4028 $userid = $context->instanceid;
4030 if ($USER->id == $userid) {
4031 // always can access own
4033 } else if (!empty($CFG->forceloginforprofiles)) {
4034 require_login();
4036 if (isguestuser()) {
4037 send_file_not_found();
4040 // we allow access to site profile of all course contacts (usually teachers)
4041 if (!has_coursecontact_role($userid) && !has_capability('moodle/user:viewdetails', $context)) {
4042 send_file_not_found();
4045 $canview = false;
4046 if (has_capability('moodle/user:viewdetails', $context)) {
4047 $canview = true;
4048 } else {
4049 $courses = enrol_get_my_courses();
4052 while (!$canview && count($courses) > 0) {
4053 $course = array_shift($courses);
4054 if (has_capability('moodle/user:viewdetails', context_course::instance($course->id))) {
4055 $canview = true;
4060 $filename = array_pop($args);
4061 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4062 if (!$file = $fs->get_file($context->id, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4063 send_file_not_found();
4066 \core\session\manager::write_close(); // Unlock session during file serving.
4067 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4069 } else if ($filearea === 'profile' and $context->contextlevel == CONTEXT_COURSE) {
4070 $userid = (int)array_shift($args);
4071 $usercontext = context_user::instance($userid);
4073 if ($CFG->forcelogin) {
4074 require_login();
4077 if (!empty($CFG->forceloginforprofiles)) {
4078 require_login();
4079 if (isguestuser()) {
4080 print_error('noguest');
4083 //TODO: review this logic of user profile access prevention
4084 if (!has_coursecontact_role($userid) and !has_capability('moodle/user:viewdetails', $usercontext)) {
4085 print_error('usernotavailable');
4087 if (!has_capability('moodle/user:viewdetails', $context) && !has_capability('moodle/user:viewdetails', $usercontext)) {
4088 print_error('cannotviewprofile');
4090 if (!is_enrolled($context, $userid)) {
4091 print_error('notenrolledprofile');
4093 if (groups_get_course_groupmode($course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
4094 print_error('groupnotamember');
4098 $filename = array_pop($args);
4099 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4100 if (!$file = $fs->get_file($usercontext->id, 'user', 'profile', 0, $filepath, $filename) or $file->is_directory()) {
4101 send_file_not_found();
4104 \core\session\manager::write_close(); // Unlock session during file serving.
4105 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4107 } else if ($filearea === 'backup' and $context->contextlevel == CONTEXT_USER) {
4108 require_login();
4110 if (isguestuser()) {
4111 send_file_not_found();
4113 $userid = $context->instanceid;
4115 if ($USER->id != $userid) {
4116 send_file_not_found();
4119 $filename = array_pop($args);
4120 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4121 if (!$file = $fs->get_file($context->id, 'user', 'backup', 0, $filepath, $filename) or $file->is_directory()) {
4122 send_file_not_found();
4125 \core\session\manager::write_close(); // Unlock session during file serving.
4126 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4128 } else {
4129 send_file_not_found();
4132 // ========================================================================================================================
4133 } else if ($component === 'coursecat') {
4134 if ($context->contextlevel != CONTEXT_COURSECAT) {
4135 send_file_not_found();
4138 if ($filearea === 'description') {
4139 if ($CFG->forcelogin) {
4140 // no login necessary - unless login forced everywhere
4141 require_login();
4144 $filename = array_pop($args);
4145 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4146 if (!$file = $fs->get_file($context->id, 'coursecat', 'description', 0, $filepath, $filename) or $file->is_directory()) {
4147 send_file_not_found();
4150 \core\session\manager::write_close(); // Unlock session during file serving.
4151 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4152 } else {
4153 send_file_not_found();
4156 // ========================================================================================================================
4157 } else if ($component === 'course') {
4158 if ($context->contextlevel != CONTEXT_COURSE) {
4159 send_file_not_found();
4162 if ($filearea === 'summary' || $filearea === 'overviewfiles') {
4163 if ($CFG->forcelogin) {
4164 require_login();
4167 $filename = array_pop($args);
4168 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4169 if (!$file = $fs->get_file($context->id, 'course', $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4170 send_file_not_found();
4173 \core\session\manager::write_close(); // Unlock session during file serving.
4174 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4176 } else if ($filearea === 'section') {
4177 if ($CFG->forcelogin) {
4178 require_login($course);
4179 } else if ($course->id != SITEID) {
4180 require_login($course);
4183 $sectionid = (int)array_shift($args);
4185 if (!$section = $DB->get_record('course_sections', array('id'=>$sectionid, 'course'=>$course->id))) {
4186 send_file_not_found();
4189 $filename = array_pop($args);
4190 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4191 if (!$file = $fs->get_file($context->id, 'course', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4192 send_file_not_found();
4195 \core\session\manager::write_close(); // Unlock session during file serving.
4196 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4198 } else {
4199 send_file_not_found();
4202 } else if ($component === 'group') {
4203 if ($context->contextlevel != CONTEXT_COURSE) {
4204 send_file_not_found();
4207 require_course_login($course, true, null, false);
4209 $groupid = (int)array_shift($args);
4211 $group = $DB->get_record('groups', array('id'=>$groupid, 'courseid'=>$course->id), '*', MUST_EXIST);
4212 if (($course->groupmodeforce and $course->groupmode == SEPARATEGROUPS) and !has_capability('moodle/site:accessallgroups', $context) and !groups_is_member($group->id, $USER->id)) {
4213 // do not allow access to separate group info if not member or teacher
4214 send_file_not_found();
4217 if ($filearea === 'description') {
4219 require_login($course);
4221 $filename = array_pop($args);
4222 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4223 if (!$file = $fs->get_file($context->id, 'group', 'description', $group->id, $filepath, $filename) or $file->is_directory()) {
4224 send_file_not_found();
4227 \core\session\manager::write_close(); // Unlock session during file serving.
4228 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4230 } else if ($filearea === 'icon') {
4231 $filename = array_pop($args);
4233 if ($filename !== 'f1' and $filename !== 'f2') {
4234 send_file_not_found();
4236 if (!$file = $fs->get_file($context->id, 'group', 'icon', $group->id, '/', $filename.'.png')) {
4237 if (!$file = $fs->get_file($context->id, 'group', 'icon', $group->id, '/', $filename.'.jpg')) {
4238 send_file_not_found();
4242 \core\session\manager::write_close(); // Unlock session during file serving.
4243 send_stored_file($file, 60*60, 0, false, array('preview' => $preview));
4245 } else {
4246 send_file_not_found();
4249 } else if ($component === 'grouping') {
4250 if ($context->contextlevel != CONTEXT_COURSE) {
4251 send_file_not_found();
4254 require_login($course);
4256 $groupingid = (int)array_shift($args);
4258 // note: everybody has access to grouping desc images for now
4259 if ($filearea === 'description') {
4261 $filename = array_pop($args);
4262 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4263 if (!$file = $fs->get_file($context->id, 'grouping', 'description', $groupingid, $filepath, $filename) or $file->is_directory()) {
4264 send_file_not_found();
4267 \core\session\manager::write_close(); // Unlock session during file serving.
4268 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4270 } else {
4271 send_file_not_found();
4274 // ========================================================================================================================
4275 } else if ($component === 'backup') {
4276 if ($filearea === 'course' and $context->contextlevel == CONTEXT_COURSE) {
4277 require_login($course);
4278 require_capability('moodle/backup:downloadfile', $context);
4280 $filename = array_pop($args);
4281 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4282 if (!$file = $fs->get_file($context->id, 'backup', 'course', 0, $filepath, $filename) or $file->is_directory()) {
4283 send_file_not_found();
4286 \core\session\manager::write_close(); // Unlock session during file serving.
4287 send_stored_file($file, 0, 0, $forcedownload, array('preview' => $preview));
4289 } else if ($filearea === 'section' and $context->contextlevel == CONTEXT_COURSE) {
4290 require_login($course);
4291 require_capability('moodle/backup:downloadfile', $context);
4293 $sectionid = (int)array_shift($args);
4295 $filename = array_pop($args);
4296 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4297 if (!$file = $fs->get_file($context->id, 'backup', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4298 send_file_not_found();
4301 \core\session\manager::write_close();
4302 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4304 } else if ($filearea === 'activity' and $context->contextlevel == CONTEXT_MODULE) {
4305 require_login($course, false, $cm);
4306 require_capability('moodle/backup:downloadfile', $context);
4308 $filename = array_pop($args);
4309 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4310 if (!$file = $fs->get_file($context->id, 'backup', 'activity', 0, $filepath, $filename) or $file->is_directory()) {
4311 send_file_not_found();
4314 \core\session\manager::write_close();
4315 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4317 } else if ($filearea === 'automated' and $context->contextlevel == CONTEXT_COURSE) {
4318 // Backup files that were generated by the automated backup systems.
4320 require_login($course);
4321 require_capability('moodle/site:config', $context);
4323 $filename = array_pop($args);
4324 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4325 if (!$file = $fs->get_file($context->id, 'backup', 'automated', 0, $filepath, $filename) or $file->is_directory()) {
4326 send_file_not_found();
4329 \core\session\manager::write_close(); // Unlock session during file serving.
4330 send_stored_file($file, 0, 0, $forcedownload, array('preview' => $preview));
4332 } else {
4333 send_file_not_found();
4336 // ========================================================================================================================
4337 } else if ($component === 'question') {
4338 require_once($CFG->libdir . '/questionlib.php');
4339 question_pluginfile($course, $context, 'question', $filearea, $args, $forcedownload);
4340 send_file_not_found();
4342 // ========================================================================================================================
4343 } else if ($component === 'grading') {
4344 if ($filearea === 'description') {
4345 // files embedded into the form definition description
4347 if ($context->contextlevel == CONTEXT_SYSTEM) {
4348 require_login();
4350 } else if ($context->contextlevel >= CONTEXT_COURSE) {
4351 require_login($course, false, $cm);
4353 } else {
4354 send_file_not_found();
4357 $formid = (int)array_shift($args);
4359 $sql = "SELECT ga.id
4360 FROM {grading_areas} ga
4361 JOIN {grading_definitions} gd ON (gd.areaid = ga.id)
4362 WHERE gd.id = ? AND ga.contextid = ?";
4363 $areaid = $DB->get_field_sql($sql, array($formid, $context->id), IGNORE_MISSING);
4365 if (!$areaid) {
4366 send_file_not_found();
4369 $fullpath = "/$context->id/$component/$filearea/$formid/".implode('/', $args);
4371 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4372 send_file_not_found();
4375 \core\session\manager::write_close(); // Unlock session during file serving.
4376 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4379 // ========================================================================================================================
4380 } else if (strpos($component, 'mod_') === 0) {
4381 $modname = substr($component, 4);
4382 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
4383 send_file_not_found();
4385 require_once("$CFG->dirroot/mod/$modname/lib.php");
4387 if ($context->contextlevel == CONTEXT_MODULE) {
4388 if ($cm->modname !== $modname) {
4389 // somebody tries to gain illegal access, cm type must match the component!
4390 send_file_not_found();
4394 if ($filearea === 'intro') {
4395 if (!plugin_supports('mod', $modname, FEATURE_MOD_INTRO, true)) {
4396 send_file_not_found();
4398 require_course_login($course, true, $cm);
4400 // all users may access it
4401 $filename = array_pop($args);
4402 $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4403 if (!$file = $fs->get_file($context->id, 'mod_'.$modname, 'intro', 0, $filepath, $filename) or $file->is_directory()) {
4404 send_file_not_found();
4407 // finally send the file
4408 send_stored_file($file, null, 0, false, array('preview' => $preview));
4411 $filefunction = $component.'_pluginfile';
4412 $filefunctionold = $modname.'_pluginfile';
4413 if (function_exists($filefunction)) {
4414 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4415 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4416 } else if (function_exists($filefunctionold)) {
4417 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4418 $filefunctionold($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4421 send_file_not_found();
4423 // ========================================================================================================================
4424 } else if (strpos($component, 'block_') === 0) {
4425 $blockname = substr($component, 6);
4426 // note: no more class methods in blocks please, that is ....
4427 if (!file_exists("$CFG->dirroot/blocks/$blockname/lib.php")) {
4428 send_file_not_found();
4430 require_once("$CFG->dirroot/blocks/$blockname/lib.php");
4432 if ($context->contextlevel == CONTEXT_BLOCK) {
4433 $birecord = $DB->get_record('block_instances', array('id'=>$context->instanceid), '*',MUST_EXIST);
4434 if ($birecord->blockname !== $blockname) {
4435 // somebody tries to gain illegal access, cm type must match the component!
4436 send_file_not_found();
4439 $bprecord = $DB->get_record('block_positions', array('contextid' => $context->id, 'blockinstanceid' => $context->instanceid));
4440 // User can't access file, if block is hidden or doesn't have block:view capability
4441 if (($bprecord && !$bprecord->visible) || !has_capability('moodle/block:view', $context)) {
4442 send_file_not_found();
4444 } else {
4445 $birecord = null;
4448 $filefunction = $component.'_pluginfile';
4449 if (function_exists($filefunction)) {
4450 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4451 $filefunction($course, $birecord, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4454 send_file_not_found();
4456 // ========================================================================================================================
4457 } else if (strpos($component, '_') === false) {
4458 // all core subsystems have to be specified above, no more guessing here!
4459 send_file_not_found();
4461 } else {
4462 // try to serve general plugin file in arbitrary context
4463 $dir = core_component::get_component_directory($component);
4464 if (!file_exists("$dir/lib.php")) {
4465 send_file_not_found();
4467 include_once("$dir/lib.php");
4469 $filefunction = $component.'_pluginfile';
4470 if (function_exists($filefunction)) {
4471 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4472 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4475 send_file_not_found();