2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Functions for file handling.
21 * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 defined('MOODLE_INTERNAL') ||
die();
28 * BYTESERVING_BOUNDARY - string unique string constant.
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
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");
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) {
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;
66 $return .= '?forcedownload=1';
69 $path = rawurlencode($path);
70 $return = $urlbase.'?file='.$path;
72 $return .= '&forcedownload=1';
77 $return = str_replace('http://', 'https://', $return);
84 * Prepares 'editor' formslib element from data in database
86 * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
87 * function then copies the embedded files into draft area (assigning itemids automatically),
88 * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
90 * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
91 * your mform's set_data() supplying the object returned by this function.
94 * @param stdClass $data database field that holds the html text with embedded media
95 * @param string $field the name of the database field that holds the html text with embedded media
96 * @param array $options editor options (like maxifiles, maxbytes etc.)
97 * @param stdClass $context context of the editor
98 * @param string $component
99 * @param string $filearea file area name
100 * @param int $itemid item id, required if item exists
101 * @return stdClass modified data object
103 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
104 $options = (array)$options;
105 if (!isset($options['trusttext'])) {
106 $options['trusttext'] = false;
108 if (!isset($options['forcehttps'])) {
109 $options['forcehttps'] = false;
111 if (!isset($options['subdirs'])) {
112 $options['subdirs'] = false;
114 if (!isset($options['maxfiles'])) {
115 $options['maxfiles'] = 0; // no files by default
117 if (!isset($options['noclean'])) {
118 $options['noclean'] = false;
121 //sanity check for passed context. This function doesn't expect $option['context'] to be set
122 //But this function is called before creating editor hence, this is one of the best places to check
123 //if context is used properly. This check notify developer that they missed passing context to editor.
124 if (isset($context) && !isset($options['context'])) {
125 //if $context is not null then make sure $option['context'] is also set.
126 debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER
);
127 } else if (isset($options['context']) && isset($context)) {
128 //If both are passed then they should be equal.
129 if ($options['context']->id
!= $context->id
) {
130 $exceptionmsg = 'Editor context ['.$options['context']->id
.'] is not equal to passed context ['.$context->id
.']';
131 throw new coding_exception($exceptionmsg);
135 if (is_null($itemid) or is_null($context)) {
139 $data = new stdClass();
141 if (!isset($data->{$field})) {
142 $data->{$field} = '';
144 if (!isset($data->{$field.'format'})) {
145 $data->{$field.'format'} = editors_get_preferred_format();
147 if (!$options['noclean']) {
148 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
152 if ($options['trusttext']) {
153 // noclean ignored if trusttext enabled
154 if (!isset($data->{$field.'trust'})) {
155 $data->{$field.'trust'} = 0;
157 $data = trusttext_pre_edit($data, $field, $context);
159 if (!$options['noclean']) {
160 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
163 $contextid = $context->id
;
166 if ($options['maxfiles'] != 0) {
167 $draftid_editor = file_get_submitted_draft_itemid($field);
168 $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
169 $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
171 $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
178 * Prepares the content of the 'editor' form element with embedded media files to be saved in database
180 * This function moves files from draft area to the destination area and
181 * encodes URLs to the draft files so they can be safely saved into DB. The
182 * form has to contain the 'editor' element named foobar_editor, where 'foobar'
183 * is the name of the database field to hold the wysiwyg editor content. The
184 * editor data comes as an array with text, format and itemid properties. This
185 * function automatically adds $data properties foobar, foobarformat and
186 * foobartrust, where foobar has URL to embedded files encoded.
189 * @param stdClass $data raw data submitted by the form
190 * @param string $field name of the database field containing the html with embedded media files
191 * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
192 * @param stdClass $context context, required for existing data
193 * @param string $component file component
194 * @param string $filearea file area name
195 * @param int $itemid item id, required if item exists
196 * @return stdClass modified data object
198 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
199 $options = (array)$options;
200 if (!isset($options['trusttext'])) {
201 $options['trusttext'] = false;
203 if (!isset($options['forcehttps'])) {
204 $options['forcehttps'] = false;
206 if (!isset($options['subdirs'])) {
207 $options['subdirs'] = false;
209 if (!isset($options['maxfiles'])) {
210 $options['maxfiles'] = 0; // no files by default
212 if (!isset($options['maxbytes'])) {
213 $options['maxbytes'] = 0; // unlimited
216 if ($options['trusttext']) {
217 $data->{$field.'trust'} = trusttext_trusted($context);
219 $data->{$field.'trust'} = 0;
222 $editor = $data->{$field.'_editor'};
224 if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
225 $data->{$field} = $editor['text'];
227 $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id
, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
229 $data->{$field.'format'} = $editor['format'];
235 * Saves text and files modified by Editor formslib element
238 * @param stdClass $data $database entry field
239 * @param string $field name of data field
240 * @param array $options various options
241 * @param stdClass $context context - must already exist
242 * @param string $component
243 * @param string $filearea file area name
244 * @param int $itemid must already exist, usually means data is in db
245 * @return stdClass modified data obejct
247 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
248 $options = (array)$options;
249 if (!isset($options['subdirs'])) {
250 $options['subdirs'] = false;
252 if (is_null($itemid) or is_null($context)) {
256 $contextid = $context->id
;
259 $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
260 file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
261 $data->{$field.'_filemanager'} = $draftid_editor;
267 * Saves files modified by File manager formslib element
269 * @todo MDL-31073 review this function
271 * @param stdClass $data $database entry field
272 * @param string $field name of data field
273 * @param array $options various options
274 * @param stdClass $context context - must already exist
275 * @param string $component
276 * @param string $filearea file area name
277 * @param int $itemid must already exist, usually means data is in db
278 * @return stdClass modified data obejct
280 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
281 $options = (array)$options;
282 if (!isset($options['subdirs'])) {
283 $options['subdirs'] = false;
285 if (!isset($options['maxfiles'])) {
286 $options['maxfiles'] = -1; // unlimited
288 if (!isset($options['maxbytes'])) {
289 $options['maxbytes'] = 0; // unlimited
292 if (empty($data->{$field.'_filemanager'})) {
296 file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id
, $component, $filearea, $itemid, $options);
297 $fs = get_file_storage();
299 if ($fs->get_area_files($context->id
, $component, $filearea, $itemid)) {
300 $data->$field = '1'; // TODO: this is an ugly hack (skodak)
310 * Generate a draft itemid
313 * @global moodle_database $DB
314 * @global stdClass $USER
315 * @return int a random but available draft itemid that can be used to create a new draft
318 function file_get_unused_draft_itemid() {
321 if (isguestuser() or !isloggedin()) {
322 // guests and not-logged-in users can not be allowed to upload anything!!!!!!
323 print_error('noguest');
326 $contextid = context_user
::instance($USER->id
)->id
;
328 $fs = get_file_storage();
329 $draftitemid = rand(1, 999999999);
330 while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
331 $draftitemid = rand(1, 999999999);
338 * Initialise a draft file area from a real one by copying the files. A draft
339 * area will be created if one does not already exist. Normally you should
340 * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
343 * @global stdClass $CFG
344 * @global stdClass $USER
345 * @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.
346 * @param int $contextid This parameter and the next two identify the file area to copy files from.
347 * @param string $component
348 * @param string $filearea helps indentify the file area.
349 * @param int $itemid helps identify the file area. Can be null if there are no files yet.
350 * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
351 * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
352 * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
354 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
355 global $CFG, $USER, $CFG;
357 $options = (array)$options;
358 if (!isset($options['subdirs'])) {
359 $options['subdirs'] = false;
361 if (!isset($options['forcehttps'])) {
362 $options['forcehttps'] = false;
365 $usercontext = context_user
::instance($USER->id
);
366 $fs = get_file_storage();
368 if (empty($draftitemid)) {
369 // create a new area and copy existing files into
370 $draftitemid = file_get_unused_draft_itemid();
371 $file_record = array('contextid'=>$usercontext->id
, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
372 if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
373 foreach ($files as $file) {
374 if ($file->is_directory() and $file->get_filepath() === '/') {
375 // we need a way to mark the age of each draft area,
376 // by not copying the root dir we force it to be created automatically with current timestamp
379 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
382 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
383 // XXX: This is a hack for file manager (MDL-28666)
384 // File manager needs to know the original file information before copying
385 // to draft area, so we append these information in mdl_files.source field
386 // {@link file_storage::search_references()}
387 // {@link file_storage::search_references_count()}
388 $sourcefield = $file->get_source();
389 $newsourcefield = new stdClass
;
390 $newsourcefield->source
= $sourcefield;
391 $original = new stdClass
;
392 $original->contextid
= $contextid;
393 $original->component
= $component;
394 $original->filearea
= $filearea;
395 $original->itemid
= $itemid;
396 $original->filename
= $file->get_filename();
397 $original->filepath
= $file->get_filepath();
398 $newsourcefield->original
= file_storage
::pack_reference($original);
399 $draftfile->set_source(serialize($newsourcefield));
400 // End of file manager hack
403 if (!is_null($text)) {
404 // at this point there should not be any draftfile links yet,
405 // because this is a new text from database that should still contain the @@pluginfile@@ links
406 // this happens when developers forget to post process the text
407 $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
413 if (is_null($text)) {
417 // relink embedded files - editor can not handle @@PLUGINFILE@@ !
418 return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id
, 'user', 'draft', $draftitemid, $options);
422 * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
425 * @global stdClass $CFG
426 * @param string $text The content that may contain ULRs in need of rewriting.
427 * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
428 * @param int $contextid This parameter and the next two identify the file area to use.
429 * @param string $component
430 * @param string $filearea helps identify the file area.
431 * @param int $itemid helps identify the file area.
432 * @param array $options text and file options ('forcehttps'=>false)
433 * @return string the processed text.
435 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
438 $options = (array)$options;
439 if (!isset($options['forcehttps'])) {
440 $options['forcehttps'] = false;
443 if (!$CFG->slasharguments
) {
444 $file = $file . '?file=';
447 $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
449 if ($itemid !== null) {
450 $baseurl .= "$itemid/";
453 if ($options['forcehttps']) {
454 $baseurl = str_replace('http://', 'https://', $baseurl);
457 return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
461 * Returns information about files in a draft area.
463 * @global stdClass $CFG
464 * @global stdClass $USER
465 * @param int $draftitemid the draft area item id.
466 * @param string $filepath path to the directory from which the information have to be retrieved.
467 * @return array with the following entries:
468 * 'filecount' => number of files in the draft area.
469 * 'filesize' => total size of the files in the draft area.
470 * 'foldercount' => number of folders in the draft area.
471 * 'filesize_without_references' => total size of the area excluding file references.
472 * (more information will be added as needed).
474 function file_get_draft_area_info($draftitemid, $filepath = '/') {
477 $usercontext = context_user
::instance($USER->id
);
478 $fs = get_file_storage();
484 'filesize_without_references' => 0
487 if ($filepath != '/') {
488 $draftfiles = $fs->get_directory_files($usercontext->id
, 'user', 'draft', $draftitemid, $filepath, true, true);
490 $draftfiles = $fs->get_area_files($usercontext->id
, 'user', 'draft', $draftitemid, 'id', true);
492 foreach ($draftfiles as $file) {
493 if ($file->is_directory()) {
494 $results['foldercount'] +
= 1;
496 $results['filecount'] +
= 1;
499 $filesize = $file->get_filesize();
500 $results['filesize'] +
= $filesize;
501 if (!$file->is_external_file()) {
502 $results['filesize_without_references'] +
= $filesize;
510 * Returns whether a draft area has exceeded/will exceed its size limit.
512 * Please note that the unlimited value for $areamaxbytes is -1 {@link FILE_AREA_MAX_BYTES_UNLIMITED}, not 0.
514 * @param int $draftitemid the draft area item id.
515 * @param int $areamaxbytes the maximum size allowed in this draft area.
516 * @param int $newfilesize the size that would be added to the current area.
517 * @param bool $includereferences true to include the size of the references in the area size.
518 * @return bool true if the area will/has exceeded its limit.
521 function file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $newfilesize = 0, $includereferences = false) {
522 if ($areamaxbytes != FILE_AREA_MAX_BYTES_UNLIMITED
) {
523 $draftinfo = file_get_draft_area_info($draftitemid);
524 $areasize = $draftinfo['filesize_without_references'];
525 if ($includereferences) {
526 $areasize = $draftinfo['filesize'];
528 if ($areasize +
$newfilesize > $areamaxbytes) {
536 * Get used space of files
537 * @global moodle_database $DB
538 * @global stdClass $USER
539 * @return int total bytes
541 function file_get_user_used_space() {
544 $usercontext = context_user
::instance($USER->id
);
545 $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
546 JOIN (SELECT contenthash, filename, MAX(id) AS id
548 WHERE contextid = ? AND component = ? AND filearea != ?
549 GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
550 $params = array('contextid'=>$usercontext->id
, 'component'=>'user', 'filearea'=>'draft');
551 $record = $DB->get_record_sql($sql, $params);
552 return (int)$record->totalbytes
;
556 * Convert any string to a valid filepath
557 * @todo review this function
559 * @return string path
561 function file_correct_filepath($str) { //TODO: what is this? (skodak) - No idea (Fred)
562 if ($str == '/' or empty($str)) {
565 return '/'.trim($str, '/').'/';
570 * Generate a folder tree of draft area of current USER recursively
572 * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
573 * @param int $draftitemid
574 * @param string $filepath
577 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
578 global $USER, $OUTPUT, $CFG;
579 $data->children
= array();
580 $context = context_user
::instance($USER->id
);
581 $fs = get_file_storage();
582 if ($files = $fs->get_directory_files($context->id
, 'user', 'draft', $draftitemid, $filepath, false)) {
583 foreach ($files as $file) {
584 if ($file->is_directory()) {
585 $item = new stdClass();
586 $item->sortorder
= $file->get_sortorder();
587 $item->filepath
= $file->get_filepath();
589 $foldername = explode('/', trim($item->filepath
, '/'));
590 $item->fullname
= trim(array_pop($foldername), '/');
592 $item->id
= uniqid();
593 file_get_drafarea_folders($draftitemid, $item->filepath
, $item);
594 $data->children
[] = $item;
603 * Listing all files (including folders) in current path (draft area)
604 * used by file manager
605 * @param int $draftitemid
606 * @param string $filepath
609 function file_get_drafarea_files($draftitemid, $filepath = '/') {
610 global $USER, $OUTPUT, $CFG;
612 $context = context_user
::instance($USER->id
);
613 $fs = get_file_storage();
615 $data = new stdClass();
616 $data->path
= array();
617 $data->path
[] = array('name'=>get_string('files'), 'path'=>'/');
619 // will be used to build breadcrumb
621 if ($filepath !== '/') {
622 $filepath = file_correct_filepath($filepath);
623 $parts = explode('/', $filepath);
624 foreach ($parts as $part) {
625 if ($part != '' && $part != null) {
626 $trail .= ($part.'/');
627 $data->path
[] = array('name'=>$part, 'path'=>$trail);
634 if ($files = $fs->get_directory_files($context->id
, 'user', 'draft', $draftitemid, $filepath, false)) {
635 foreach ($files as $file) {
636 $item = new stdClass();
637 $item->filename
= $file->get_filename();
638 $item->filepath
= $file->get_filepath();
639 $item->fullname
= trim($item->filename
, '/');
640 $filesize = $file->get_filesize();
641 $item->size
= $filesize ?
$filesize : null;
642 $item->filesize
= $filesize ?
display_size($filesize) : '';
644 $item->sortorder
= $file->get_sortorder();
645 $item->author
= $file->get_author();
646 $item->license
= $file->get_license();
647 $item->datemodified
= $file->get_timemodified();
648 $item->datecreated
= $file->get_timecreated();
649 $item->isref
= $file->is_external_file();
650 if ($item->isref
&& $file->get_status() == 666) {
651 $item->originalmissing
= true;
653 // find the file this draft file was created from and count all references in local
654 // system pointing to that file
655 $source = @unserialize
($file->get_source());
656 if (isset($source->original
)) {
657 $item->refcount
= $fs->search_references_count($source->original
);
660 if ($file->is_directory()) {
662 $item->icon
= $OUTPUT->pix_url(file_folder_icon(24))->out(false);
663 $item->type
= 'folder';
664 $foldername = explode('/', trim($item->filepath
, '/'));
665 $item->fullname
= trim(array_pop($foldername), '/');
666 $item->thumbnail
= $OUTPUT->pix_url(file_folder_icon(90))->out(false);
668 // do NOT use file browser here!
669 $item->mimetype
= get_mimetype_description($file);
670 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
673 $item->type
= 'file';
675 $itemurl = moodle_url
::make_draftfile_url($draftitemid, $item->filepath
, $item->filename
);
676 $item->url
= $itemurl->out();
677 $item->icon
= $OUTPUT->pix_url(file_file_icon($file, 24))->out(false);
678 $item->thumbnail
= $OUTPUT->pix_url(file_file_icon($file, 90))->out(false);
679 if ($imageinfo = $file->get_imageinfo()) {
680 $item->realthumbnail
= $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
681 $item->realicon
= $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
682 $item->image_width
= $imageinfo['width'];
683 $item->image_height
= $imageinfo['height'];
689 $data->itemid
= $draftitemid;
695 * Returns draft area itemid for a given element.
698 * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
699 * @return int the itemid, or 0 if there is not one yet.
701 function file_get_submitted_draft_itemid($elname) {
702 // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
703 if (!isset($_REQUEST[$elname])) {
706 if (is_array($_REQUEST[$elname])) {
707 $param = optional_param_array($elname, 0, PARAM_INT
);
708 if (!empty($param['itemid'])) {
709 $param = $param['itemid'];
711 debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER
);
716 $param = optional_param($elname, 0, PARAM_INT
);
727 * Restore the original source field from draft files
729 * @param stored_file $storedfile This only works with draft files
730 * @return stored_file
732 function file_restore_source_field_from_draft_file($storedfile) {
733 $source = @unserialize
($storedfile->get_source());
734 if (!empty($source)) {
735 if (is_object($source)) {
736 $restoredsource = $source->source
;
737 $storedfile->set_source($restoredsource);
739 throw new moodle_exception('invalidsourcefield', 'error');
745 * Saves files from a draft file area to a real one (merging the list of files).
746 * Can rewrite URLs in some content at the same time if desired.
749 * @global stdClass $USER
750 * @param int $draftitemid the id of the draft area to use. Normally obtained
751 * from file_get_submitted_draft_itemid('elementname') or similar.
752 * @param int $contextid This parameter and the next two identify the file area to save to.
753 * @param string $component
754 * @param string $filearea indentifies the file area.
755 * @param int $itemid helps identifies the file area.
756 * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
757 * @param string $text some html content that needs to have embedded links rewritten
758 * to the @@PLUGINFILE@@ form for saving in the database.
759 * @param bool $forcehttps force https urls.
760 * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
762 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
765 $usercontext = context_user
::instance($USER->id
);
766 $fs = get_file_storage();
768 $options = (array)$options;
769 if (!isset($options['subdirs'])) {
770 $options['subdirs'] = false;
772 if (!isset($options['maxfiles'])) {
773 $options['maxfiles'] = -1; // unlimited
775 if (!isset($options['maxbytes']) ||
$options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS
) {
776 $options['maxbytes'] = 0; // unlimited
778 if (!isset($options['areamaxbytes'])) {
779 $options['areamaxbytes'] = FILE_AREA_MAX_BYTES_UNLIMITED
; // Unlimited.
781 $allowreferences = true;
782 if (isset($options['return_types']) && !($options['return_types'] & FILE_REFERENCE
)) {
783 // we assume that if $options['return_types'] is NOT specified, we DO allow references.
784 // this is not exactly right. BUT there are many places in code where filemanager options
785 // are not passed to file_save_draft_area_files()
786 $allowreferences = false;
789 // Check if the draft area has exceeded the authorised limit. This should never happen as validation
790 // should have taken place before, unless the user is doing something nauthly. If so, let's just not save
791 // anything at all in the next area.
792 if (file_is_draft_area_limit_reached($draftitemid, $options['areamaxbytes'])) {
796 $draftfiles = $fs->get_area_files($usercontext->id
, 'user', 'draft', $draftitemid, 'id');
797 $oldfiles = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
799 if (count($draftfiles) < 2) {
800 // means there are no files - one file means root dir only ;-)
801 $fs->delete_area_files($contextid, $component, $filearea, $itemid);
803 } else if (count($oldfiles) < 2) {
805 // there were no files before - one file means root dir only ;-)
806 foreach ($draftfiles as $file) {
807 $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
808 if ($source = @unserialize
($file->get_source())) {
809 // Field files.source for draftarea files contains serialised object with source and original information.
810 $file_record['source'] = $source->source
;
812 if (!$options['subdirs']) {
813 if ($file->get_filepath() !== '/' or $file->is_directory()) {
817 if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
818 // oversized file - should not get here at all
821 if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
822 // more files - should not get here at all
825 if (!$file->is_directory()) {
829 if ($file->is_external_file()) {
830 if (!$allowreferences) {
833 $repoid = $file->get_repository_id();
834 if (!empty($repoid)) {
835 $file_record['repositoryid'] = $repoid;
836 $file_record['reference'] = $file->get_reference();
840 $fs->create_file_from_storedfile($file_record, $file);
844 // we have to merge old and new files - we want to keep file ids for files that were not changed
845 // we change time modified for all new and changed files, we keep time created as is
847 $newhashes = array();
848 foreach ($draftfiles as $file) {
849 $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
850 $newhashes[$newhash] = $file;
853 foreach ($oldfiles as $oldfile) {
854 $oldhash = $oldfile->get_pathnamehash();
855 if (!isset($newhashes[$oldhash])) {
856 // delete files not needed any more - deleted by user
861 $newfile = $newhashes[$oldhash];
862 // Now we know that we have $oldfile and $newfile for the same path.
863 // Let's check if we can update this file or we need to delete and create.
864 if ($newfile->is_directory()) {
865 // Directories are always ok to just update.
866 } else if (($source = @unserialize
($newfile->get_source())) && isset($source->original
)) {
867 // File has the 'original' - we need to update the file (it may even have not been changed at all).
868 $original = file_storage
::unpack_reference($source->original
);
869 if ($original['filename'] !== $oldfile->get_filename() ||
$original['filepath'] !== $oldfile->get_filepath()) {
870 // Very odd, original points to another file. Delete and create file.
875 // The same file name but absence of 'original' means that file was deteled and uploaded again.
876 // By deleting and creating new file we properly manage all existing references.
881 // status changed, we delete old file, and create a new one
882 if ($oldfile->get_status() != $newfile->get_status()) {
883 // file was changed, use updated with new timemodified data
885 // This file will be added later
890 if ($oldfile->get_author() != $newfile->get_author()) {
891 $oldfile->set_author($newfile->get_author());
894 if ($oldfile->get_license() != $newfile->get_license()) {
895 $oldfile->set_license($newfile->get_license());
898 // Updated file source
899 $newsource = $newfile->get_source();
900 if ($source = @unserialize
($newfile->get_source())) {
901 $newsource = $source->source
;
903 if ($oldfile->get_source() !== $newsource) {
904 $oldfile->set_source($newsource);
907 // Updated sort order
908 if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
909 $oldfile->set_sortorder($newfile->get_sortorder());
912 // Update file timemodified
913 if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
914 $oldfile->set_timemodified($newfile->get_timemodified());
917 if ($newfile->is_external_file() && !$allowreferences) {
920 // Replaced file content
921 if (!$oldfile->is_directory() &&
922 ($oldfile->get_contenthash() != $newfile->get_contenthash() ||
923 $oldfile->get_filesize() != $newfile->get_filesize() ||
924 $oldfile->get_referencefileid() != $newfile->get_referencefileid())) {
925 $oldfile->replace_file_with($newfile);
926 // push changes to all local files that are referencing this file
927 $fs->update_references_to_storedfile($oldfile);
930 // unchanged file or directory - we keep it as is
931 unset($newhashes[$oldhash]);
932 if (!$oldfile->is_directory()) {
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 $file_record['source'] = $source->source
;
945 if (!$options['subdirs']) {
946 if ($file->get_filepath() !== '/' or $file->is_directory()) {
950 if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
951 // oversized file - should not get here at all
954 if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
955 // more files - should not get here at all
958 if (!$file->is_directory()) {
962 if ($file->is_external_file()) {
963 if (!$allowreferences) {
966 $repoid = $file->get_repository_id();
967 if (!empty($repoid)) {
968 $file_record['repositoryid'] = $repoid;
969 $file_record['reference'] = $file->get_reference();
973 $fs->create_file_from_storedfile($file_record, $file);
977 // note: do not purge the draft area - we clean up areas later in cron,
978 // the reason is that user might press submit twice and they would loose the files,
979 // also sometimes we might want to use hacks that save files into two different areas
981 if (is_null($text)) {
984 return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
989 * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
990 * ready to be saved in the database. Normally, this is done automatically by
991 * {@link file_save_draft_area_files()}.
994 * @param string $text the content to process.
995 * @param int $draftitemid the draft file area the content was using.
996 * @param bool $forcehttps whether the content contains https URLs. Default false.
997 * @return string the processed content.
999 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
1002 $usercontext = context_user
::instance($USER->id
);
1004 $wwwroot = $CFG->wwwroot
;
1006 $wwwroot = str_replace('http://', 'https://', $wwwroot);
1009 // relink embedded files if text submitted - no absolute links allowed in database!
1010 $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1012 if (strpos($text, 'draftfile.php?file=') !== false) {
1014 preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
1016 foreach ($matches[0] as $match) {
1017 $replace = str_ireplace('%2F', '/', $match);
1018 $text = str_replace($match, $replace, $text);
1021 $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1028 * Set file sort order
1030 * @global moodle_database $DB
1031 * @param int $contextid the context id
1032 * @param string $component file component
1033 * @param string $filearea file area.
1034 * @param int $itemid itemid.
1035 * @param string $filepath file path.
1036 * @param string $filename file name.
1037 * @param int $sortorder the sort order of file.
1040 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
1042 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
1043 if ($file_record = $DB->get_record('files', $conditions)) {
1044 $sortorder = (int)$sortorder;
1045 $file_record->sortorder
= $sortorder;
1046 $DB->update_record('files', $file_record);
1053 * reset file sort order number to 0
1054 * @global moodle_database $DB
1055 * @param int $contextid the context id
1056 * @param string $component
1057 * @param string $filearea file area.
1058 * @param int|bool $itemid itemid.
1061 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
1064 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
1065 if ($itemid !== false) {
1066 $conditions['itemid'] = $itemid;
1069 $file_records = $DB->get_records('files', $conditions);
1070 foreach ($file_records as $file_record) {
1071 $file_record->sortorder
= 0;
1072 $DB->update_record('files', $file_record);
1078 * Returns description of upload error
1080 * @param int $errorcode found in $_FILES['filename.ext']['error']
1081 * @return string error description string, '' if ok
1083 function file_get_upload_error($errorcode) {
1085 switch ($errorcode) {
1086 case 0: // UPLOAD_ERR_OK - no error
1090 case 1: // UPLOAD_ERR_INI_SIZE
1091 $errmessage = get_string('uploadserverlimit');
1094 case 2: // UPLOAD_ERR_FORM_SIZE
1095 $errmessage = get_string('uploadformlimit');
1098 case 3: // UPLOAD_ERR_PARTIAL
1099 $errmessage = get_string('uploadpartialfile');
1102 case 4: // UPLOAD_ERR_NO_FILE
1103 $errmessage = get_string('uploadnofilefound');
1106 // Note: there is no error with a value of 5
1108 case 6: // UPLOAD_ERR_NO_TMP_DIR
1109 $errmessage = get_string('uploadnotempdir');
1112 case 7: // UPLOAD_ERR_CANT_WRITE
1113 $errmessage = get_string('uploadcantwrite');
1116 case 8: // UPLOAD_ERR_EXTENSION
1117 $errmessage = get_string('uploadextension');
1121 $errmessage = get_string('uploadproblem');
1128 * Recursive function formating an array in POST parameter
1129 * @param array $arraydata - the array that we are going to format and add into &$data array
1130 * @param string $currentdata - a row of the final postdata array at instant T
1131 * when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1132 * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1134 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1135 foreach ($arraydata as $k=>$v) {
1136 $newcurrentdata = $currentdata;
1137 if (is_array($v)) { //the value is an array, call the function recursively
1138 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1139 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1140 } else { //add the POST parameter to the $data array
1141 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1147 * Transform a PHP array into POST parameter
1148 * (see the recursive function format_array_postdata_for_curlcall)
1149 * @param array $postdata
1150 * @return array containing all POST parameters (1 row = 1 POST parameter)
1152 function format_postdata_for_curlcall($postdata) {
1154 foreach ($postdata as $k=>$v) {
1156 $currentdata = urlencode($k);
1157 format_array_postdata_for_curlcall($v, $currentdata, $data);
1159 $data[] = urlencode($k).'='.urlencode($v);
1162 $convertedpostdata = implode('&', $data);
1163 return $convertedpostdata;
1167 * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1168 * Due to security concerns only downloads from http(s) sources are supported.
1170 * @todo MDL-31073 add version test for '7.10.5'
1172 * @param string $url file url starting with http(s)://
1173 * @param array $headers http headers, null if none. If set, should be an
1174 * associative array of header name => value pairs.
1175 * @param array $postdata array means use POST request with given parameters
1176 * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1177 * (if false, just returns content)
1178 * @param int $timeout timeout for complete download process including all file transfer
1179 * (default 5 minutes)
1180 * @param int $connecttimeout timeout for connection to server; this is the timeout that
1181 * usually happens if the remote server is completely down (default 20 seconds);
1182 * may not work when using proxy
1183 * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1184 * Only use this when already in a trusted location.
1185 * @param string $tofile store the downloaded content to file instead of returning it.
1186 * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1187 * filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1188 * @return mixed false if request failed or content of the file as string if ok. True if file downloaded into $tofile successfully.
1190 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1193 // some extra security
1194 $newlines = array("\r", "\n");
1195 if (is_array($headers) ) {
1196 foreach ($headers as $key => $value) {
1197 $headers[$key] = str_replace($newlines, '', $value);
1200 $url = str_replace($newlines, '', $url);
1201 if (!preg_match('|^https?://|i', $url)) {
1202 if ($fullresponse) {
1203 $response = new stdClass();
1204 $response->status
= 0;
1205 $response->headers
= array();
1206 $response->response_code
= 'Invalid protocol specified in url';
1207 $response->results
= '';
1208 $response->error
= 'Invalid protocol specified in url';
1215 // check if proxy (if used) should be bypassed for this url
1216 $proxybypass = is_proxybypass($url);
1218 if (!$ch = curl_init($url)) {
1219 debugging('Can not init curl.');
1223 // set extra headers
1224 if (is_array($headers) ) {
1225 $headers2 = array();
1226 foreach ($headers as $key => $value) {
1227 $headers2[] = "$key: $value";
1229 curl_setopt($ch, CURLOPT_HTTPHEADER
, $headers2);
1232 if ($skipcertverify) {
1233 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, false);
1236 // use POST if requested
1237 if (is_array($postdata)) {
1238 $postdata = format_postdata_for_curlcall($postdata);
1239 curl_setopt($ch, CURLOPT_POST
, true);
1240 curl_setopt($ch, CURLOPT_POSTFIELDS
, $postdata);
1243 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, true);
1244 curl_setopt($ch, CURLOPT_HEADER
, false);
1245 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT
, $connecttimeout);
1247 if ($cacert = curl
::get_cacert()) {
1248 curl_setopt($ch, CURLOPT_CAINFO
, $cacert);
1251 if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
1252 // TODO: add version test for '7.10.5'
1253 curl_setopt($ch, CURLOPT_FOLLOWLOCATION
, true);
1254 curl_setopt($ch, CURLOPT_MAXREDIRS
, 5);
1257 if (!empty($CFG->proxyhost
) and !$proxybypass) {
1258 // SOCKS supported in PHP5 only
1259 if (!empty($CFG->proxytype
) and ($CFG->proxytype
== 'SOCKS5')) {
1260 if (defined('CURLPROXY_SOCKS5')) {
1261 curl_setopt($ch, CURLOPT_PROXYTYPE
, CURLPROXY_SOCKS5
);
1264 if ($fullresponse) {
1265 $response = new stdClass();
1266 $response->status
= '0';
1267 $response->headers
= array();
1268 $response->response_code
= 'SOCKS5 proxy is not supported in PHP4';
1269 $response->results
= '';
1270 $response->error
= 'SOCKS5 proxy is not supported in PHP4';
1273 debugging("SOCKS5 proxy is not supported in PHP4.", DEBUG_ALL
);
1279 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL
, false);
1281 if (empty($CFG->proxyport
)) {
1282 curl_setopt($ch, CURLOPT_PROXY
, $CFG->proxyhost
);
1284 curl_setopt($ch, CURLOPT_PROXY
, $CFG->proxyhost
.':'.$CFG->proxyport
);
1287 if (!empty($CFG->proxyuser
) and !empty($CFG->proxypassword
)) {
1288 curl_setopt($ch, CURLOPT_PROXYUSERPWD
, $CFG->proxyuser
.':'.$CFG->proxypassword
);
1289 if (defined('CURLOPT_PROXYAUTH')) {
1290 // any proxy authentication if PHP 5.1
1291 curl_setopt($ch, CURLOPT_PROXYAUTH
, CURLAUTH_BASIC | CURLAUTH_NTLM
);
1296 // set up header and content handlers
1297 $received = new stdClass();
1298 $received->headers
= array(); // received headers array
1299 $received->tofile
= $tofile;
1300 $received->fh
= null;
1301 curl_setopt($ch, CURLOPT_HEADERFUNCTION
, partial('download_file_content_header_handler', $received));
1303 curl_setopt($ch, CURLOPT_WRITEFUNCTION
, partial('download_file_content_write_handler', $received));
1306 if (!isset($CFG->curltimeoutkbitrate
)) {
1307 //use very slow rate of 56kbps as a timeout speed when not set
1310 $bitrate = $CFG->curltimeoutkbitrate
;
1313 // try to calculate the proper amount for timeout from remote file size.
1314 // if disabled or zero, we won't do any checks nor head requests.
1315 if ($calctimeout && $bitrate > 0) {
1316 //setup header request only options
1317 curl_setopt_array ($ch, array(
1318 CURLOPT_RETURNTRANSFER
=> false,
1319 CURLOPT_NOBODY
=> true)
1323 $info = curl_getinfo($ch);
1324 $err = curl_error($ch);
1326 if ($err === '' && $info['download_content_length'] > 0) { //no curl errors
1327 $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024))); //adjust for large files only - take max timeout.
1329 //reinstate affected curl options
1330 curl_setopt_array ($ch, array(
1331 CURLOPT_RETURNTRANSFER
=> true,
1332 CURLOPT_NOBODY
=> false,
1333 CURLOPT_HTTPGET
=> true)
1337 curl_setopt($ch, CURLOPT_TIMEOUT
, $timeout);
1338 $result = curl_exec($ch);
1340 // try to detect encoding problems
1341 if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1342 curl_setopt($ch, CURLOPT_ENCODING
, 'none');
1343 $result = curl_exec($ch);
1346 if ($received->fh
) {
1347 fclose($received->fh
);
1350 if (curl_errno($ch)) {
1351 $error = curl_error($ch);
1352 $error_no = curl_errno($ch);
1355 if ($fullresponse) {
1356 $response = new stdClass();
1357 if ($error_no == 28) {
1358 $response->status
= '-100'; // mimic snoopy
1360 $response->status
= '0';
1362 $response->headers
= array();
1363 $response->response_code
= $error;
1364 $response->results
= false;
1365 $response->error
= $error;
1368 debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL
);
1373 $info = curl_getinfo($ch);
1376 if (empty($info['http_code'])) {
1377 // for security reasons we support only true http connections (Location: file:// exploit prevention)
1378 $response = new stdClass();
1379 $response->status
= '0';
1380 $response->headers
= array();
1381 $response->response_code
= 'Unknown cURL error';
1382 $response->results
= false; // do NOT change this, we really want to ignore the result!
1383 $response->error
= 'Unknown cURL error';
1386 $response = new stdClass();
1387 $response->status
= (string)$info['http_code'];
1388 $response->headers
= $received->headers
;
1389 $response->response_code
= $received->headers
[0];
1390 $response->results
= $result;
1391 $response->error
= '';
1394 if ($fullresponse) {
1396 } else if ($info['http_code'] != 200) {
1397 debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code
, DEBUG_ALL
);
1400 return $response->results
;
1406 * internal implementation
1407 * @param stdClass $received
1408 * @param resource $ch
1409 * @param mixed $header
1410 * @return int header length
1412 function download_file_content_header_handler($received, $ch, $header) {
1413 $received->headers
[] = $header;
1414 return strlen($header);
1418 * internal implementation
1419 * @param stdClass $received
1420 * @param resource $ch
1421 * @param mixed $data
1423 function download_file_content_write_handler($received, $ch, $data) {
1424 if (!$received->fh
) {
1425 $received->fh
= fopen($received->tofile
, 'w');
1426 if ($received->fh
=== false) {
1427 // bad luck, file creation or overriding failed
1431 if (fwrite($received->fh
, $data) === false) {
1432 // bad luck, write failed, let's abort completely
1435 return strlen($data);
1439 * Returns a list of information about file types based on extensions.
1441 * The following elements expected in value array for each extension:
1443 * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1444 * or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1445 * also files with bigger sizes under names
1446 * FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1447 * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1448 * commonly used in moodle the following groups:
1449 * - web_image - image that can be included as <img> in HTML
1450 * - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1451 * - video - file that can be imported as video in text editor
1452 * - audio - file that can be imported as audio in text editor
1453 * - archive - we can extract files from this archive
1454 * - spreadsheet - used for portfolio format
1455 * - document - used for portfolio format
1456 * - presentation - used for portfolio format
1457 * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1458 * human-readable description for this filetype;
1459 * Function {@link get_mimetype_description()} first looks at the presence of string for
1460 * particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1461 * attribute, if not found returns the value of 'type';
1462 * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1463 * an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1464 * this function will return first found icon; Especially usefull for types such as 'text/plain'
1467 * @return array List of information about file types based on extensions.
1468 * Associative array of extension (lower-case) to associative array
1469 * from 'element name' to data. Current element names are 'type' and 'icon'.
1470 * Unknown types should use the 'xxx' entry which includes defaults.
1472 function &get_mimetypes_array() {
1473 static $mimearray = array (
1474 'xxx' => array ('type'=>'document/unknown', 'icon'=>'unknown'),
1475 '3gp' => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1476 'aac' => array ('type'=>'audio/aac', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1477 'accdb' => array ('type'=>'application/msaccess', 'icon'=>'base'),
1478 'ai' => array ('type'=>'application/postscript', 'icon'=>'eps', 'groups'=>array('image'), 'string'=>'image'),
1479 'aif' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1480 'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1481 'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1482 'applescript' => array ('type'=>'text/plain', 'icon'=>'text'),
1483 'asc' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1484 'asm' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1485 'au' => array ('type'=>'audio/au', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1486 'avi' => array ('type'=>'video/x-ms-wm', 'icon'=>'avi', 'groups'=>array('video','web_video'), 'string'=>'video'),
1487 'bmp' => array ('type'=>'image/bmp', 'icon'=>'bmp', 'groups'=>array('image'), 'string'=>'image'),
1488 'c' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1489 'cct' => array ('type'=>'shockwave/director', 'icon'=>'flash'),
1490 'cpp' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1491 'cs' => array ('type'=>'application/x-csh', 'icon'=>'sourcecode'),
1492 'css' => array ('type'=>'text/css', 'icon'=>'text', 'groups'=>array('web_file')),
1493 'csv' => array ('type'=>'text/csv', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1494 'dv' => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1495 'dmg' => array ('type'=>'application/octet-stream', 'icon'=>'unknown'),
1497 'doc' => array ('type'=>'application/msword', 'icon'=>'document', 'groups'=>array('document')),
1498 'docx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'icon'=>'document', 'groups'=>array('document')),
1499 'docm' => array ('type'=>'application/vnd.ms-word.document.macroEnabled.12', 'icon'=>'document'),
1500 'dotx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'icon'=>'document'),
1501 'dotm' => array ('type'=>'application/vnd.ms-word.template.macroEnabled.12', 'icon'=>'document'),
1503 'dcr' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1504 'dif' => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1505 'dir' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1506 'dxr' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1507 'eps' => array ('type'=>'application/postscript', 'icon'=>'eps'),
1508 'epub' => array ('type'=>'application/epub+zip', 'icon'=>'epub', 'groups'=>array('document')),
1509 'fdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1510 'flv' => array ('type'=>'video/x-flv', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1511 'f4v' => array ('type'=>'video/mp4', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1513 'gallery' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1514 'galleryitem' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1515 'gallerycollection' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1516 'gif' => array ('type'=>'image/gif', 'icon'=>'gif', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1517 'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1518 'tgz' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1519 'gz' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1520 'gzip' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1521 'h' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1522 'hpp' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1523 'hqx' => array ('type'=>'application/mac-binhex40', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1524 'htc' => array ('type'=>'text/x-component', 'icon'=>'markup'),
1525 'html' => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1526 'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'html', 'groups'=>array('web_file')),
1527 'htm' => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1528 'ico' => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1529 'ics' => array ('type'=>'text/calendar', 'icon'=>'text'),
1530 'isf' => array ('type'=>'application/inspiration', 'icon'=>'isf'),
1531 'ist' => array ('type'=>'application/inspiration.template', 'icon'=>'isf'),
1532 'java' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1533 'jar' => array ('type'=>'application/java-archive', 'icon' => 'archive'),
1534 'jcb' => array ('type'=>'text/xml', 'icon'=>'markup'),
1535 'jcl' => array ('type'=>'text/xml', 'icon'=>'markup'),
1536 'jcw' => array ('type'=>'text/xml', 'icon'=>'markup'),
1537 'jmt' => array ('type'=>'text/xml', 'icon'=>'markup'),
1538 'jmx' => array ('type'=>'text/xml', 'icon'=>'markup'),
1539 'jpe' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1540 'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1541 'jpg' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1542 'jqz' => array ('type'=>'text/xml', 'icon'=>'markup'),
1543 'js' => array ('type'=>'application/x-javascript', 'icon'=>'text', 'groups'=>array('web_file')),
1544 'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text'),
1545 'm' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1546 'mbz' => array ('type'=>'application/vnd.moodle.backup', 'icon'=>'moodle'),
1547 'mdb' => array ('type'=>'application/x-msaccess', 'icon'=>'base'),
1548 'mht' => array ('type'=>'message/rfc822', 'icon'=>'archive'),
1549 'mhtml'=> array ('type'=>'message/rfc822', 'icon'=>'archive'),
1550 'mov' => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1551 'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1552 'm3u' => array ('type'=>'audio/x-mpegurl', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1553 'mp3' => array ('type'=>'audio/mp3', 'icon'=>'mp3', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1554 'mp4' => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1555 'm4v' => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1556 'm4a' => array ('type'=>'audio/mp4', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1557 'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1558 'mpe' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1559 'mpg' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1561 'nbk' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1562 'notebook' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1564 'odt' => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'writer', 'groups'=>array('document')),
1565 'ott' => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'writer', 'groups'=>array('document')),
1566 'oth' => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'oth', 'groups'=>array('document')),
1567 'odm' => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'writer'),
1568 'odg' => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'draw'),
1569 'otg' => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'draw'),
1570 'odp' => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'impress'),
1571 'otp' => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'impress'),
1572 'ods' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1573 'ots' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1574 'odc' => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'chart'),
1575 'odf' => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'math'),
1576 'odb' => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'base'),
1577 'odi' => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'draw'),
1578 'oga' => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1579 'ogg' => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1580 'ogv' => array ('type'=>'video/ogg', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1582 'pct' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1583 'pdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1584 'php' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1585 'pic' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1586 'pict' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1587 'png' => array ('type'=>'image/png', 'icon'=>'png', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1589 'pps' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1590 'ppt' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1591 'pptx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'icon'=>'powerpoint'),
1592 'pptm' => array ('type'=>'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 'icon'=>'powerpoint'),
1593 'potx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.template', 'icon'=>'powerpoint'),
1594 'potm' => array ('type'=>'application/vnd.ms-powerpoint.template.macroEnabled.12', 'icon'=>'powerpoint'),
1595 'ppam' => array ('type'=>'application/vnd.ms-powerpoint.addin.macroEnabled.12', 'icon'=>'powerpoint'),
1596 'ppsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'icon'=>'powerpoint'),
1597 'ppsm' => array ('type'=>'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 'icon'=>'powerpoint'),
1599 'ps' => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1600 'qt' => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1601 'ra' => array ('type'=>'audio/x-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1602 'ram' => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1603 'rhb' => array ('type'=>'text/xml', 'icon'=>'markup'),
1604 'rm' => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1605 'rmvb' => array ('type'=>'application/vnd.rn-realmedia-vbr', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1606 'rtf' => array ('type'=>'text/rtf', 'icon'=>'text', 'groups'=>array('document')),
1607 'rtx' => array ('type'=>'text/richtext', 'icon'=>'text'),
1608 'rv' => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('video'), 'string'=>'video'),
1609 'sh' => array ('type'=>'application/x-sh', 'icon'=>'sourcecode'),
1610 'sit' => array ('type'=>'application/x-stuffit', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1611 'smi' => array ('type'=>'application/smil', 'icon'=>'text'),
1612 'smil' => array ('type'=>'application/smil', 'icon'=>'text'),
1613 'sqt' => array ('type'=>'text/xml', 'icon'=>'markup'),
1614 'svg' => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1615 'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1616 'swa' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1617 'swf' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1618 'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1620 'sxw' => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'writer'),
1621 'stw' => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'writer'),
1622 'sxc' => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'calc'),
1623 'stc' => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'calc'),
1624 'sxd' => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'draw'),
1625 'std' => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'draw'),
1626 'sxi' => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'impress'),
1627 'sti' => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'impress'),
1628 'sxg' => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'writer'),
1629 'sxm' => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'math'),
1631 'tar' => array ('type'=>'application/x-tar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1632 'tif' => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1633 'tiff' => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1634 'tex' => array ('type'=>'application/x-tex', 'icon'=>'text'),
1635 'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1636 'texinfo' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1637 'tsv' => array ('type'=>'text/tab-separated-values', 'icon'=>'text'),
1638 'txt' => array ('type'=>'text/plain', 'icon'=>'text', 'defaulticon'=>true),
1639 'wav' => array ('type'=>'audio/wav', 'icon'=>'wav', 'groups'=>array('audio'), 'string'=>'audio'),
1640 'webm' => array ('type'=>'video/webm', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1641 'wmv' => array ('type'=>'video/x-ms-wmv', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1642 'asf' => array ('type'=>'video/x-ms-asf', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1644 'xbk' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1645 'xdp' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1646 'xfd' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1647 'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1649 'xls' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1650 'xlsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'icon'=>'spreadsheet'),
1651 'xlsm' => array ('type'=>'application/vnd.ms-excel.sheet.macroEnabled.12', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1652 'xltx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'icon'=>'spreadsheet'),
1653 'xltm' => array ('type'=>'application/vnd.ms-excel.template.macroEnabled.12', 'icon'=>'spreadsheet'),
1654 'xlsb' => array ('type'=>'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 'icon'=>'spreadsheet'),
1655 'xlam' => array ('type'=>'application/vnd.ms-excel.addin.macroEnabled.12', 'icon'=>'spreadsheet'),
1657 'xml' => array ('type'=>'application/xml', 'icon'=>'markup'),
1658 'xsl' => array ('type'=>'text/xml', 'icon'=>'markup'),
1660 'zip' => array ('type'=>'application/zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive')
1666 * Obtains information about a filetype based on its extension. Will
1667 * use a default if no information is present about that particular
1671 * @param string $element Desired information (usually 'icon'
1672 * for icon filename or 'type' for MIME type. Can also be
1673 * 'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1674 * @param string $filename Filename we're looking up
1675 * @return string Requested piece of information from array
1677 function mimeinfo($element, $filename) {
1679 $mimeinfo = & get_mimetypes_array();
1680 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1682 $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1683 if (empty($filetype)) {
1684 $filetype = 'xxx'; // file without extension
1686 if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1687 $iconsize = max(array(16, (int)$iconsizematch[1]));
1688 $filenames = array($mimeinfo['xxx']['icon']);
1689 if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1690 array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1692 // find the file with the closest size, first search for specific icon then for default icon
1693 foreach ($filenames as $filename) {
1694 foreach ($iconpostfixes as $size => $postfix) {
1695 $fullname = $CFG->dirroot
.'/pix/f/'.$filename.$postfix;
1696 if ($iconsize >= $size && (file_exists($fullname.'.png') ||
file_exists($fullname.'.gif'))) {
1697 return $filename.$postfix;
1701 } else if (isset($mimeinfo[$filetype][$element])) {
1702 return $mimeinfo[$filetype][$element];
1703 } else if (isset($mimeinfo['xxx'][$element])) {
1704 return $mimeinfo['xxx'][$element]; // By default
1711 * Obtains information about a filetype based on the MIME type rather than
1712 * the other way around.
1715 * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1716 * @param string $mimetype MIME type we're looking up
1717 * @return string Requested piece of information from array
1719 function mimeinfo_from_type($element, $mimetype) {
1720 /* array of cached mimetype->extension associations */
1721 static $cached = array();
1722 $mimeinfo = & get_mimetypes_array();
1724 if (!array_key_exists($mimetype, $cached)) {
1725 $cached[$mimetype] = null;
1726 foreach($mimeinfo as $filetype => $values) {
1727 if ($values['type'] == $mimetype) {
1728 if ($cached[$mimetype] === null) {
1729 $cached[$mimetype] = '.'.$filetype;
1731 if (!empty($values['defaulticon'])) {
1732 $cached[$mimetype] = '.'.$filetype;
1737 if (empty($cached[$mimetype])) {
1738 $cached[$mimetype] = '.xxx';
1741 if ($element === 'extension') {
1742 return $cached[$mimetype];
1744 return mimeinfo($element, $cached[$mimetype]);
1749 * Return the relative icon path for a given file
1753 * // $file - instance of stored_file or file_info
1754 * $icon = $OUTPUT->pix_url(file_file_icon($file))->out();
1755 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1759 * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1762 * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1763 * and $file->mimetype are expected)
1764 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1767 function file_file_icon($file, $size = null) {
1768 if (!is_object($file)) {
1769 $file = (object)$file;
1771 if (isset($file->filename
)) {
1772 $filename = $file->filename
;
1773 } else if (method_exists($file, 'get_filename')) {
1774 $filename = $file->get_filename();
1775 } else if (method_exists($file, 'get_visible_name')) {
1776 $filename = $file->get_visible_name();
1780 if (isset($file->mimetype
)) {
1781 $mimetype = $file->mimetype
;
1782 } else if (method_exists($file, 'get_mimetype')) {
1783 $mimetype = $file->get_mimetype();
1787 $mimetypes = &get_mimetypes_array();
1789 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1790 if ($extension && !empty($mimetypes[$extension])) {
1791 // if file name has known extension, return icon for this extension
1792 return file_extension_icon($filename, $size);
1795 return file_mimetype_icon($mimetype, $size);
1799 * Return the relative icon path for a folder image
1803 * $icon = $OUTPUT->pix_url(file_folder_icon())->out();
1804 * echo html_writer::empty_tag('img', array('src' => $icon));
1808 * echo $OUTPUT->pix_icon(file_folder_icon(32));
1811 * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1814 function file_folder_icon($iconsize = null) {
1816 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1817 static $cached = array();
1818 $iconsize = max(array(16, (int)$iconsize));
1819 if (!array_key_exists($iconsize, $cached)) {
1820 foreach ($iconpostfixes as $size => $postfix) {
1821 $fullname = $CFG->dirroot
.'/pix/f/folder'.$postfix;
1822 if ($iconsize >= $size && (file_exists($fullname.'.png') ||
file_exists($fullname.'.gif'))) {
1823 $cached[$iconsize] = 'f/folder'.$postfix;
1828 return $cached[$iconsize];
1832 * Returns the relative icon path for a given mime type
1834 * This function should be used in conjunction with $OUTPUT->pix_url to produce
1835 * a return the full path to an icon.
1838 * $mimetype = 'image/jpg';
1839 * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype))->out();
1840 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1844 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1845 * to conform with that.
1846 * @param string $mimetype The mimetype to fetch an icon for
1847 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1848 * @return string The relative path to the icon
1850 function file_mimetype_icon($mimetype, $size = NULL) {
1851 return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1855 * Returns the relative icon path for a given file name
1857 * This function should be used in conjunction with $OUTPUT->pix_url to produce
1858 * a return the full path to an icon.
1861 * $filename = '.jpg';
1862 * $icon = $OUTPUT->pix_url(file_extension_icon($filename))->out();
1863 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1866 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1867 * to conform with that.
1868 * @todo MDL-31074 Implement $size
1870 * @param string $filename The filename to get the icon for
1871 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1874 function file_extension_icon($filename, $size = NULL) {
1875 return 'f/'.mimeinfo('icon'.$size, $filename);
1879 * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1880 * mimetypes.php language file.
1882 * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1883 * 'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1884 * have filename); In case of array/stdClass the field 'mimetype' is optional.
1885 * @param bool $capitalise If true, capitalises first character of result
1886 * @return string Text description
1888 function get_mimetype_description($obj, $capitalise=false) {
1889 $filename = $mimetype = '';
1890 if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1891 // this is an instance of stored_file
1892 $mimetype = $obj->get_mimetype();
1893 $filename = $obj->get_filename();
1894 } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1895 // this is an instance of file_info
1896 $mimetype = $obj->get_mimetype();
1897 $filename = $obj->get_visible_name();
1898 } else if (is_array($obj) ||
is_object ($obj)) {
1900 if (!empty($obj['filename'])) {
1901 $filename = $obj['filename'];
1903 if (!empty($obj['mimetype'])) {
1904 $mimetype = $obj['mimetype'];
1909 $mimetypefromext = mimeinfo('type', $filename);
1910 if (empty($mimetype) ||
$mimetypefromext !== 'document/unknown') {
1911 // if file has a known extension, overwrite the specified mimetype
1912 $mimetype = $mimetypefromext;
1914 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1915 if (empty($extension)) {
1916 $mimetypestr = mimeinfo_from_type('string', $mimetype);
1917 $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1919 $mimetypestr = mimeinfo('string', $filename);
1921 $chunks = explode('/', $mimetype, 2);
1924 'mimetype' => $mimetype,
1925 'ext' => $extension,
1926 'mimetype1' => $chunks[0],
1927 'mimetype2' => $chunks[1],
1930 foreach ($attr as $key => $value) {
1932 $a[strtoupper($key)] = strtoupper($value);
1933 $a[ucfirst($key)] = ucfirst($value);
1936 // MIME types may include + symbol but this is not permitted in string ids.
1937 $safemimetype = str_replace('+', '_', $mimetype);
1938 $safemimetypestr = str_replace('+', '_', $mimetypestr);
1939 if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
1940 $result = get_string($safemimetype, 'mimetypes', (object)$a);
1941 } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
1942 $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
1943 } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1944 $result = get_string('default', 'mimetypes', (object)$a);
1946 $result = $mimetype;
1949 $result=ucfirst($result);
1955 * Returns array of elements of type $element in type group(s)
1957 * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1958 * @param string|array $groups one group or array of groups/extensions/mimetypes
1961 function file_get_typegroup($element, $groups) {
1962 static $cached = array();
1963 if (!is_array($groups)) {
1964 $groups = array($groups);
1966 if (!array_key_exists($element, $cached)) {
1967 $cached[$element] = array();
1970 foreach ($groups as $group) {
1971 if (!array_key_exists($group, $cached[$element])) {
1972 // retrieive and cache all elements of type $element for group $group
1973 $mimeinfo = & get_mimetypes_array();
1974 $cached[$element][$group] = array();
1975 foreach ($mimeinfo as $extension => $value) {
1976 $value['extension'] = '.'.$extension;
1977 if (empty($value[$element])) {
1980 if (($group === '.'.$extension ||
$group === $value['type'] ||
1981 (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1982 !in_array($value[$element], $cached[$element][$group])) {
1983 $cached[$element][$group][] = $value[$element];
1987 $result = array_merge($result, $cached[$element][$group]);
1989 return array_unique($result);
1993 * Checks if file with name $filename has one of the extensions in groups $groups
1995 * @see get_mimetypes_array()
1996 * @param string $filename name of the file to check
1997 * @param string|array $groups one group or array of groups to check
1998 * @param bool $checktype if true and extension check fails, find the mimetype and check if
1999 * file mimetype is in mimetypes in groups $groups
2002 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
2003 $extension = pathinfo($filename, PATHINFO_EXTENSION
);
2004 if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
2007 return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
2011 * Checks if mimetype $mimetype belongs to one of the groups $groups
2013 * @see get_mimetypes_array()
2014 * @param string $mimetype
2015 * @param string|array $groups one group or array of groups to check
2018 function file_mimetype_in_typegroup($mimetype, $groups) {
2019 return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
2023 * Requested file is not found or not accessible, does not return, terminates script
2025 * @global stdClass $CFG
2026 * @global stdClass $COURSE
2028 function send_file_not_found() {
2029 global $CFG, $COURSE;
2031 print_error('filenotfound', 'error', $CFG->wwwroot
.'/course/view.php?id='.$COURSE->id
); //this is not displayed on IIS??
2034 * Helper function to send correct 404 for server.
2036 function send_header_404() {
2037 if (substr(php_sapi_name(), 0, 3) == 'cgi') {
2038 header("Status: 404 Not Found");
2040 header('HTTP/1.0 404 not found');
2045 * Enhanced readfile() with optional acceleration.
2046 * @param string|stored_file $file
2047 * @param string $mimetype
2048 * @param bool $accelerate
2051 function readfile_accel($file, $mimetype, $accelerate) {
2054 if ($mimetype === 'text/plain') {
2055 // there is no encoding specified in text files, we need something consistent
2056 header('Content-Type: text/plain; charset=utf-8');
2058 header('Content-Type: '.$mimetype);
2061 $lastmodified = is_object($file) ?
$file->get_timemodified() : filemtime($file);
2062 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2064 if (is_object($file)) {
2065 header('ETag: ' . $file->get_contenthash());
2066 if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and $_SERVER['HTTP_IF_NONE_MATCH'] === $file->get_contenthash()) {
2067 header('HTTP/1.1 304 Not Modified');
2072 // if etag present for stored file rely on it exclusively
2073 if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
2074 // get unixtime of request header; clip extra junk off first
2075 $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
2076 if ($since && $since >= $lastmodified) {
2077 header('HTTP/1.1 304 Not Modified');
2082 if ($accelerate and !empty($CFG->xsendfile
)) {
2083 if (empty($CFG->disablebyteserving
) and $mimetype !== 'text/plain') {
2084 header('Accept-Ranges: bytes');
2086 header('Accept-Ranges: none');
2089 if (is_object($file)) {
2090 $fs = get_file_storage();
2091 if ($fs->xsendfile($file->get_contenthash())) {
2096 require_once("$CFG->libdir/xsendfilelib.php");
2097 if (xsendfile($file)) {
2103 $filesize = is_object($file) ?
$file->get_filesize() : filesize($file);
2105 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2107 if ($accelerate and empty($CFG->disablebyteserving
) and $mimetype !== 'text/plain') {
2108 header('Accept-Ranges: bytes');
2110 if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
2111 // byteserving stuff - for acrobat reader and download accelerators
2112 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
2113 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
2115 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER
)) {
2116 foreach ($ranges as $key=>$value) {
2117 if ($ranges[$key][1] == '') {
2119 $ranges[$key][1] = $filesize - $ranges[$key][2];
2120 $ranges[$key][2] = $filesize - 1;
2121 } else if ($ranges[$key][2] == '' ||
$ranges[$key][2] > $filesize - 1) {
2123 $ranges[$key][2] = $filesize - 1;
2125 if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
2126 //invalid byte-range ==> ignore header
2130 //prepare multipart header
2131 $ranges[$key][0] = "\r\n--".BYTESERVING_BOUNDARY
."\r\nContent-Type: $mimetype\r\n";
2132 $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
2138 if (is_object($file)) {
2139 $handle = $file->get_content_file_handle();
2141 $handle = fopen($file, 'rb');
2143 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
2148 header('Accept-Ranges: none');
2151 header('Content-Length: '.$filesize);
2153 if ($filesize > 10000000) {
2154 // for large files try to flush and close all buffers to conserve memory
2155 while(@ob_get_level
()) {
2156 if (!@ob_end_flush
()) {
2162 // send the whole file content
2163 if (is_object($file)) {
2171 * Similar to readfile_accel() but designed for strings.
2172 * @param string $string
2173 * @param string $mimetype
2174 * @param bool $accelerate
2177 function readstring_accel($string, $mimetype, $accelerate) {
2180 if ($mimetype === 'text/plain') {
2181 // there is no encoding specified in text files, we need something consistent
2182 header('Content-Type: text/plain; charset=utf-8');
2184 header('Content-Type: '.$mimetype);
2186 header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2187 header('Accept-Ranges: none');
2189 if ($accelerate and !empty($CFG->xsendfile
)) {
2190 $fs = get_file_storage();
2191 if ($fs->xsendfile(sha1($string))) {
2196 header('Content-Length: '.strlen($string));
2201 * Handles the sending of temporary file to user, download is forced.
2202 * File is deleted after abort or successful sending, does not return, script terminated
2204 * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2205 * @param string $filename proposed file name when saving file
2206 * @param bool $pathisstring If the path is string
2208 function send_temp_file($path, $filename, $pathisstring=false) {
2211 if (check_browser_version('Firefox', '1.5')) {
2212 // only FF is known to correctly save to disk before opening...
2213 $mimetype = mimeinfo('type', $filename);
2215 $mimetype = 'application/x-forcedownload';
2218 // close session - not needed anymore
2219 session_get_instance()->write_close();
2221 if (!$pathisstring) {
2222 if (!file_exists($path)) {
2224 print_error('filenotfound', 'error', $CFG->wwwroot
.'/');
2226 // executed after normal finish or abort
2227 @register_shutdown_function
('send_temp_file_finished', $path);
2230 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2231 if (check_browser_version('MSIE')) {
2232 $filename = urlencode($filename);
2235 header('Content-Disposition: attachment; filename="'.$filename.'"');
2236 if (strpos($CFG->wwwroot
, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2237 header('Cache-Control: max-age=10');
2238 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2240 } else { //normal http - prevent caching at all cost
2241 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2242 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2243 header('Pragma: no-cache');
2246 // send the contents - we can not accelerate this because the file will be deleted asap
2247 if ($pathisstring) {
2248 readstring_accel($path, $mimetype, false);
2250 readfile_accel($path, $mimetype, false);
2254 die; //no more chars to output
2258 * Internal callback function used by send_temp_file()
2260 * @param string $path
2262 function send_temp_file_finished($path) {
2263 if (file_exists($path)) {
2269 * Handles the sending of file data to the user's browser, including support for
2273 * @param string $path Path of file on disk (including real filename), or actual content of file as string
2274 * @param string $filename Filename to send
2275 * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2276 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2277 * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
2278 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2279 * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2280 * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2281 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2282 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2283 * and should not be reopened.
2284 * @return null script execution stopped unless $dontdie is true
2286 function send_file($path, $filename, $lifetime = 'default' , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
2287 global $CFG, $COURSE;
2290 ignore_user_abort(true);
2293 // MDL-11789, apply $CFG->filelifetime here
2294 if ($lifetime === 'default') {
2295 if (!empty($CFG->filelifetime
)) {
2296 $lifetime = $CFG->filelifetime
;
2302 session_get_instance()->write_close(); // unlock session during fileserving
2304 // Use given MIME type if specified, otherwise guess it using mimeinfo.
2305 // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2306 // only Firefox saves all files locally before opening when content-disposition: attachment stated
2307 $isFF = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2308 $mimetype = ($forcedownload and !$isFF) ?
'application/x-forcedownload' :
2309 ($mimetype ?
$mimetype : mimeinfo('type', $filename));
2311 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2312 if (check_browser_version('MSIE')) {
2313 $filename = rawurlencode($filename);
2316 if ($forcedownload) {
2317 header('Content-Disposition: attachment; filename="'.$filename.'"');
2319 header('Content-Disposition: inline; filename="'.$filename.'"');
2322 if ($lifetime > 0) {
2323 $nobyteserving = false;
2324 header('Cache-Control: max-age='.$lifetime);
2325 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
$lifetime) .' GMT');
2328 } else { // Do not cache files in proxies and browsers
2329 $nobyteserving = true;
2330 if (strpos($CFG->wwwroot
, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2331 header('Cache-Control: max-age=10');
2332 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2334 } else { //normal http - prevent caching at all cost
2335 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2336 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2337 header('Pragma: no-cache');
2341 if (empty($filter)) {
2342 // send the contents
2343 if ($pathisstring) {
2344 readstring_accel($path, $mimetype, !$dontdie);
2346 readfile_accel($path, $mimetype, !$dontdie);
2350 // Try to put the file through filters
2351 if ($mimetype == 'text/html') {
2352 $options = new stdClass();
2353 $options->noclean
= true;
2354 $options->nocache
= true; // temporary workaround for MDL-5136
2355 $text = $pathisstring ?
$path : implode('', file($path));
2357 $text = file_modify_html_header($text);
2358 $output = format_text($text, FORMAT_HTML
, $options, $COURSE->id
);
2360 readstring_accel($output, $mimetype, false);
2362 } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2363 // only filter text if filter all files is selected
2364 $options = new stdClass();
2365 $options->newlines
= false;
2366 $options->noclean
= true;
2367 $text = htmlentities($pathisstring ?
$path : implode('', file($path)), ENT_QUOTES
, 'UTF-8');
2368 $output = '<pre>'. format_text($text, FORMAT_MOODLE
, $options, $COURSE->id
) .'</pre>';
2370 readstring_accel($output, $mimetype, false);
2373 // send the contents
2374 if ($pathisstring) {
2375 readstring_accel($path, $mimetype, !$dontdie);
2377 readfile_accel($path, $mimetype, !$dontdie);
2384 die; //no more chars to output!!!
2388 * Handles the sending of file data to the user's browser, including support for
2391 * The $options parameter supports the following keys:
2392 * (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2393 * (string|null) filename - overrides the implicit filename
2394 * (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2395 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2396 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2397 * and should not be reopened.
2400 * @param stored_file $stored_file local file object
2401 * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2402 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2403 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2404 * @param array $options additional options affecting the file serving
2405 * @return null script execution stopped unless $options['dontdie'] is true
2407 function send_stored_file($stored_file, $lifetime=86400 , $filter=0, $forcedownload=false, array $options=array()) {
2408 global $CFG, $COURSE;
2410 if (empty($options['filename'])) {
2413 $filename = $options['filename'];
2416 if (empty($options['dontdie'])) {
2422 if (!empty($options['preview'])) {
2423 // replace the file with its preview
2424 $fs = get_file_storage();
2425 $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2426 if (!$preview_file) {
2427 // unable to create a preview of the file, send its default mime icon instead
2428 if ($options['preview'] === 'tinyicon') {
2430 } else if ($options['preview'] === 'thumb') {
2435 $fileicon = file_file_icon($stored_file, $size);
2436 send_file($CFG->dirroot
.'/pix/'.$fileicon.'.png', basename($fileicon).'.png');
2438 // preview images have fixed cache lifetime and they ignore forced download
2439 // (they are generated by GD and therefore they are considered reasonably safe).
2440 $stored_file = $preview_file;
2441 $lifetime = DAYSECS
;
2443 $forcedownload = false;
2447 // handle external resource
2448 if ($stored_file && $stored_file->is_external_file() && !isset($options['sendcachedexternalfile'])) {
2449 $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2453 if (!$stored_file or $stored_file->is_directory()) {
2462 ignore_user_abort(true);
2465 session_get_instance()->write_close(); // unlock session during fileserving
2467 // Use given MIME type if specified, otherwise guess it using mimeinfo.
2468 // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2469 // only Firefox saves all files locally before opening when content-disposition: attachment stated
2470 $filename = is_null($filename) ?
$stored_file->get_filename() : $filename;
2471 $isFF = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2472 $mimetype = ($forcedownload and !$isFF) ?
'application/x-forcedownload' :
2473 ($stored_file->get_mimetype() ?
$stored_file->get_mimetype() : mimeinfo('type', $filename));
2475 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2476 if (check_browser_version('MSIE')) {
2477 $filename = rawurlencode($filename);
2480 if ($forcedownload) {
2481 header('Content-Disposition: attachment; filename="'.$filename.'"');
2483 header('Content-Disposition: inline; filename="'.$filename.'"');
2486 if ($lifetime > 0) {
2487 header('Cache-Control: max-age='.$lifetime);
2488 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
$lifetime) .' GMT');
2491 } else { // Do not cache files in proxies and browsers
2492 if (strpos($CFG->wwwroot
, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2493 header('Cache-Control: max-age=10');
2494 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2496 } else { //normal http - prevent caching at all cost
2497 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2498 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2499 header('Pragma: no-cache');
2503 if (empty($filter)) {
2504 // send the contents
2505 readfile_accel($stored_file, $mimetype, !$dontdie);
2507 } else { // Try to put the file through filters
2508 if ($mimetype == 'text/html') {
2509 $options = new stdClass();
2510 $options->noclean
= true;
2511 $options->nocache
= true; // temporary workaround for MDL-5136
2512 $text = $stored_file->get_content();
2513 $text = file_modify_html_header($text);
2514 $output = format_text($text, FORMAT_HTML
, $options, $COURSE->id
);
2516 readstring_accel($output, $mimetype, false);
2518 } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2519 // only filter text if filter all files is selected
2520 $options = new stdClass();
2521 $options->newlines
= false;
2522 $options->noclean
= true;
2523 $text = $stored_file->get_content();
2524 $output = '<pre>'. format_text($text, FORMAT_MOODLE
, $options, $COURSE->id
) .'</pre>';
2526 readstring_accel($output, $mimetype, false);
2528 } else { // Just send it out raw
2529 readfile_accel($stored_file, $mimetype, !$dontdie);
2535 die; //no more chars to output!!!
2539 * Retrieves an array of records from a CSV file and places
2540 * them into a given table structure
2542 * @global stdClass $CFG
2543 * @global moodle_database $DB
2544 * @param string $file The path to a CSV file
2545 * @param string $table The table to retrieve columns from
2546 * @return bool|array Returns an array of CSV records or false
2548 function get_records_csv($file, $table) {
2551 if (!$metacolumns = $DB->get_columns($table)) {
2555 if(!($handle = @fopen
($file, 'r'))) {
2556 print_error('get_records_csv failed to open '.$file);
2559 $fieldnames = fgetcsv($handle, 4096);
2560 if(empty($fieldnames)) {
2567 foreach($metacolumns as $metacolumn) {
2568 $ord = array_search($metacolumn->name
, $fieldnames);
2570 $columns[$metacolumn->name
] = $ord;
2576 while (($data = fgetcsv($handle, 4096)) !== false) {
2577 $item = new stdClass
;
2578 foreach($columns as $name => $ord) {
2579 $item->$name = $data[$ord];
2589 * Create a file with CSV contents
2591 * @global stdClass $CFG
2592 * @global moodle_database $DB
2593 * @param string $file The file to put the CSV content into
2594 * @param array $records An array of records to write to a CSV file
2595 * @param string $table The table to get columns from
2596 * @return bool success
2598 function put_records_csv($file, $records, $table = NULL) {
2601 if (empty($records)) {
2605 $metacolumns = NULL;
2606 if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2612 if(!($fp = @fopen
($CFG->tempdir
.'/'.$file, 'w'))) {
2613 print_error('put_records_csv failed to open '.$file);
2616 $proto = reset($records);
2617 if(is_object($proto)) {
2618 $fields_records = array_keys(get_object_vars($proto));
2620 else if(is_array($proto)) {
2621 $fields_records = array_keys($proto);
2628 if(!empty($metacolumns)) {
2629 $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2630 $fields = array_intersect($fields_records, $fields_table);
2633 $fields = $fields_records;
2636 fwrite($fp, implode(',', $fields));
2637 fwrite($fp, "\r\n");
2639 foreach($records as $record) {
2640 $array = (array)$record;
2642 foreach($fields as $field) {
2643 if(strpos($array[$field], ',')) {
2644 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2647 $values[] = $array[$field];
2650 fwrite($fp, implode(',', $values)."\r\n");
2659 * Recursively delete the file or folder with path $location. That is,
2660 * if it is a file delete it. If it is a folder, delete all its content
2661 * then delete it. If $location does not exist to start, that is not
2662 * considered an error.
2664 * @param string $location the path to remove.
2667 function fulldelete($location) {
2668 if (empty($location)) {
2669 // extra safety against wrong param
2672 if (is_dir($location)) {
2673 if (!$currdir = opendir($location)) {
2676 while (false !== ($file = readdir($currdir))) {
2677 if ($file <> ".." && $file <> ".") {
2678 $fullfile = $location."/".$file;
2679 if (is_dir($fullfile)) {
2680 if (!fulldelete($fullfile)) {
2684 if (!unlink($fullfile)) {
2691 if (! rmdir($location)) {
2695 } else if (file_exists($location)) {
2696 if (!unlink($location)) {
2704 * Send requested byterange of file.
2706 * @param resource $handle A file handle
2707 * @param string $mimetype The mimetype for the output
2708 * @param array $ranges An array of ranges to send
2709 * @param string $filesize The size of the content if only one range is used
2711 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2712 // better turn off any kind of compression and buffering
2713 @ini_set
('zlib.output_compression', 'Off');
2715 $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2716 if ($handle === false) {
2719 if (count($ranges) == 1) { //only one range requested
2720 $length = $ranges[0][2] - $ranges[0][1] +
1;
2721 header('HTTP/1.1 206 Partial content');
2722 header('Content-Length: '.$length);
2723 header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2724 header('Content-Type: '.$mimetype);
2726 while(@ob_get_level
()) {
2727 if (!@ob_end_flush
()) {
2732 fseek($handle, $ranges[0][1]);
2733 while (!feof($handle) && $length > 0) {
2734 @set_time_limit
(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2735 $buffer = fread($handle, ($chunksize < $length ?
$chunksize : $length));
2738 $length -= strlen($buffer);
2742 } else { // multiple ranges requested - not tested much
2744 foreach($ranges as $range) {
2745 $totallength +
= strlen($range[0]) +
$range[2] - $range[1] +
1;
2747 $totallength +
= strlen("\r\n--".BYTESERVING_BOUNDARY
."--\r\n");
2748 header('HTTP/1.1 206 Partial content');
2749 header('Content-Length: '.$totallength);
2750 header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY
);
2752 while(@ob_get_level
()) {
2753 if (!@ob_end_flush
()) {
2758 foreach($ranges as $range) {
2759 $length = $range[2] - $range[1] +
1;
2761 fseek($handle, $range[1]);
2762 while (!feof($handle) && $length > 0) {
2763 @set_time_limit
(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2764 $buffer = fread($handle, ($chunksize < $length ?
$chunksize : $length));
2767 $length -= strlen($buffer);
2770 echo "\r\n--".BYTESERVING_BOUNDARY
."--\r\n";
2777 * add includes (js and css) into uploaded files
2778 * before returning them, useful for themes and utf.js includes
2780 * @global stdClass $CFG
2781 * @param string $text text to search and replace
2782 * @return string text with added head includes
2785 function file_modify_html_header($text) {
2786 // first look for <head> tag
2789 $stylesheetshtml = '';
2790 /* foreach ($CFG->stylesheets as $stylesheet) {
2792 $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2796 if (filter_is_enabled('mediaplugin')) {
2797 // this script is needed by most media filter plugins.
2798 $attributes = array('type'=>'text/javascript', 'src'=>$CFG->httpswwwroot
. '/lib/ufo.js');
2799 $ufo = html_writer
::tag('script', '', $attributes) . "\n";
2802 preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2804 $replacement = '<head>'.$ufo.$stylesheetshtml;
2805 $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2809 // if not, look for <html> tag, and stick <head> right after
2810 preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2812 // replace <html> tag with <html><head>includes</head>
2813 $replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
2814 $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2818 // if not, look for <body> tag, and stick <head> before body
2819 preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2821 $replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
2822 $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2826 // if not, just stick a <head> tag at the beginning
2827 $text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
2832 * RESTful cURL class
2834 * This is a wrapper class for curl, it is quite easy to use:
2838 * $c = new curl(array('cache'=>true));
2840 * $c = new curl(array('cookie'=>true));
2842 * $c = new curl(array('proxy'=>true));
2844 * // HTTP GET Method
2845 * $html = $c->get('http://example.com');
2846 * // HTTP POST Method
2847 * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2848 * // HTTP PUT Method
2849 * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2852 * @package core_files
2854 * @copyright Dongsheng Cai <dongsheng@moodle.com>
2855 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
2858 /** @var bool Caches http request contents */
2859 public $cache = false;
2860 /** @var bool Uses proxy */
2861 public $proxy = false;
2862 /** @var string library version */
2863 public $version = '0.4 dev';
2864 /** @var array http's response */
2865 public $response = array();
2866 /** @var array http header */
2867 public $header = array();
2868 /** @var string cURL information */
2870 /** @var string error */
2872 /** @var int error code */
2875 /** @var array cURL options */
2877 /** @var string Proxy host */
2878 private $proxy_host = '';
2879 /** @var string Proxy auth */
2880 private $proxy_auth = '';
2881 /** @var string Proxy type */
2882 private $proxy_type = '';
2883 /** @var bool Debug mode on */
2884 private $debug = false;
2885 /** @var bool|string Path to cookie file */
2886 private $cookie = false;
2891 * @global stdClass $CFG
2892 * @param array $options
2894 public function __construct($options = array()){
2896 if (!function_exists('curl_init')) {
2897 $this->error
= 'cURL module must be enabled!';
2898 trigger_error($this->error
, E_USER_ERROR
);
2901 // the options of curl should be init here.
2903 if (!empty($options['debug'])) {
2904 $this->debug
= true;
2906 if(!empty($options['cookie'])) {
2907 if($options['cookie'] === true) {
2908 $this->cookie
= $CFG->dataroot
.'/curl_cookie.txt';
2910 $this->cookie
= $options['cookie'];
2913 if (!empty($options['cache'])) {
2914 if (class_exists('curl_cache')) {
2915 if (!empty($options['module_cache'])) {
2916 $this->cache
= new curl_cache($options['module_cache']);
2918 $this->cache
= new curl_cache('misc');
2922 if (!empty($CFG->proxyhost
)) {
2923 if (empty($CFG->proxyport
)) {
2924 $this->proxy_host
= $CFG->proxyhost
;
2926 $this->proxy_host
= $CFG->proxyhost
.':'.$CFG->proxyport
;
2928 if (!empty($CFG->proxyuser
) and !empty($CFG->proxypassword
)) {
2929 $this->proxy_auth
= $CFG->proxyuser
.':'.$CFG->proxypassword
;
2930 $this->setopt(array(
2931 'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM
,
2932 'proxyuserpwd'=>$this->proxy_auth
));
2934 if (!empty($CFG->proxytype
)) {
2935 if ($CFG->proxytype
== 'SOCKS5') {
2936 $this->proxy_type
= CURLPROXY_SOCKS5
;
2938 $this->proxy_type
= CURLPROXY_HTTP
;
2939 $this->setopt(array('httpproxytunnel'=>false));
2941 $this->setopt(array('proxytype'=>$this->proxy_type
));
2944 if (!empty($this->proxy_host
)) {
2945 $this->proxy
= array('proxy'=>$this->proxy_host
);
2949 * Resets the CURL options that have already been set
2951 public function resetopt(){
2952 $this->options
= array();
2953 $this->options
['CURLOPT_USERAGENT'] = 'MoodleBot/1.0';
2954 // True to include the header in the output
2955 $this->options
['CURLOPT_HEADER'] = 0;
2956 // True to Exclude the body from the output
2957 $this->options
['CURLOPT_NOBODY'] = 0;
2958 // TRUE to follow any "Location: " header that the server
2959 // sends as part of the HTTP header (note this is recursive,
2960 // PHP will follow as many "Location: " headers that it is sent,
2961 // unless CURLOPT_MAXREDIRS is set).
2962 //$this->options['CURLOPT_FOLLOWLOCATION'] = 1;
2963 $this->options
['CURLOPT_MAXREDIRS'] = 10;
2964 $this->options
['CURLOPT_ENCODING'] = '';
2965 // TRUE to return the transfer as a string of the return
2966 // value of curl_exec() instead of outputting it out directly.
2967 $this->options
['CURLOPT_RETURNTRANSFER'] = 1;
2968 $this->options
['CURLOPT_BINARYTRANSFER'] = 0;
2969 $this->options
['CURLOPT_SSL_VERIFYPEER'] = 0;
2970 $this->options
['CURLOPT_SSL_VERIFYHOST'] = 2;
2971 $this->options
['CURLOPT_CONNECTTIMEOUT'] = 30;
2973 if ($cacert = self
::get_cacert()) {
2974 $this->options
['CURLOPT_CAINFO'] = $cacert;
2979 * Get the location of ca certificates.
2980 * @return string absolute file path or empty if default used
2982 public static function get_cacert() {
2985 // Bundle in dataroot always wins.
2986 if (is_readable("$CFG->dataroot/moodleorgca.crt")) {
2987 return realpath("$CFG->dataroot/moodleorgca.crt");
2990 // Next comes the default from php.ini
2991 $cacert = ini_get('curl.cainfo');
2992 if (!empty($cacert) and is_readable($cacert)) {
2993 return realpath($cacert);
2996 // Windows PHP does not have any certs, we need to use something.
2997 if ($CFG->ostype
=== 'WINDOWS') {
2998 if (is_readable("$CFG->libdir/cacert.pem")) {
2999 return realpath("$CFG->libdir/cacert.pem");
3003 // Use default, this should work fine on all properly configured *nix systems.
3010 public function resetcookie() {
3011 if (!empty($this->cookie
)) {
3012 if (is_file($this->cookie
)) {
3013 $fp = fopen($this->cookie
, 'w');
3025 * Do not use the curl constants to define the options, pass a string
3026 * corresponding to that constant. Ie. to set CURLOPT_MAXREDIRS, pass
3027 * array('CURLOPT_MAXREDIRS' => 10) or array('maxredirs' => 10) to this method.
3029 * @param array $options If array is null, this function will reset the options to default value.
3031 * @throws coding_exception If an option uses constant value instead of option name.
3033 public function setopt($options = array()) {
3034 if (is_array($options)) {
3035 foreach ($options as $name => $val){
3036 if (!is_string($name)) {
3037 throw new coding_exception('Curl options should be defined using strings, not constant values.');
3039 if (stripos($name, 'CURLOPT_') === false) {
3040 $name = strtoupper('CURLOPT_'.$name);
3042 $this->options
[$name] = $val;
3050 public function cleanopt(){
3051 unset($this->options
['CURLOPT_HTTPGET']);
3052 unset($this->options
['CURLOPT_POST']);
3053 unset($this->options
['CURLOPT_POSTFIELDS']);
3054 unset($this->options
['CURLOPT_PUT']);
3055 unset($this->options
['CURLOPT_INFILE']);
3056 unset($this->options
['CURLOPT_INFILESIZE']);
3057 unset($this->options
['CURLOPT_CUSTOMREQUEST']);
3058 unset($this->options
['CURLOPT_FILE']);
3062 * Resets the HTTP Request headers (to prepare for the new request)
3064 public function resetHeader() {
3065 $this->header
= array();
3069 * Set HTTP Request Header
3071 * @param array $header
3073 public function setHeader($header) {
3074 if (is_array($header)){
3075 foreach ($header as $v) {
3076 $this->setHeader($v);
3079 $this->header
[] = $header;
3084 * Set HTTP Response Header
3087 public function getResponse(){
3088 return $this->response
;
3092 * private callback function
3093 * Formatting HTTP Response Header
3095 * @param resource $ch Apparently not used
3096 * @param string $header
3097 * @return int The strlen of the header
3099 private function formatHeader($ch, $header)
3101 if (strlen($header) > 2) {
3102 list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
3103 $key = rtrim($key, ':');
3104 if (!empty($this->response
[$key])) {
3105 if (is_array($this->response
[$key])){
3106 $this->response
[$key][] = $value;
3108 $tmp = $this->response
[$key];
3109 $this->response
[$key] = array();
3110 $this->response
[$key][] = $tmp;
3111 $this->response
[$key][] = $value;
3115 $this->response
[$key] = $value;
3118 return strlen($header);
3122 * Set options for individual curl instance
3124 * @param resource $curl A curl handle
3125 * @param array $options
3126 * @return resource The curl handle
3128 private function apply_opt($curl, $options) {
3132 if (!empty($this->cookie
) ||
!empty($options['cookie'])) {
3133 $this->setopt(array('cookiejar'=>$this->cookie
,
3134 'cookiefile'=>$this->cookie
3139 if (!empty($this->proxy
) ||
!empty($options['proxy'])) {
3140 $this->setopt($this->proxy
);
3142 $this->setopt($options);
3143 // reset before set options
3144 curl_setopt($curl, CURLOPT_HEADERFUNCTION
, array(&$this,'formatHeader'));
3146 if (empty($this->header
)){
3147 $this->setHeader(array(
3148 'User-Agent: MoodleBot/1.0',
3149 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
3150 'Connection: keep-alive'
3153 curl_setopt($curl, CURLOPT_HTTPHEADER
, $this->header
);
3155 // Bypass proxy (for this request only) if required.
3156 if (!empty($this->options
['CURLOPT_URL']) &&
3157 is_proxybypass($this->options
['CURLOPT_URL'])) {
3158 unset($this->options
['CURLOPT_PROXY']);
3162 echo '<h1>Options</h1>';
3163 var_dump($this->options
);
3164 echo '<h1>Header</h1>';
3165 var_dump($this->header
);
3169 foreach($this->options
as $name => $val) {
3170 $name = constant(strtoupper($name));
3171 curl_setopt($curl, $name, $val);
3177 * Download multiple files in parallel
3179 * Calls {@link multi()} with specific download headers
3183 * $file1 = fopen('a', 'wb');
3184 * $file2 = fopen('b', 'wb');
3185 * $c->download(array(
3186 * array('url'=>'http://localhost/', 'file'=>$file1),
3187 * array('url'=>'http://localhost/20/', 'file'=>$file2)
3197 * $c->download(array(
3198 * array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3199 * array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3203 * @param array $requests An array of files to request {
3204 * url => url to download the file [required]
3205 * file => file handler, or
3206 * filepath => file path
3208 * If 'file' and 'filepath' parameters are both specified in one request, the
3209 * open file handle in the 'file' parameter will take precedence and 'filepath'
3212 * @param array $options An array of options to set
3213 * @return array An array of results
3215 public function download($requests, $options = array()) {
3216 $options['CURLOPT_BINARYTRANSFER'] = 1;
3217 $options['RETURNTRANSFER'] = false;
3218 return $this->multi($requests, $options);
3222 * Mulit HTTP Requests
3223 * This function could run multi-requests in parallel.
3225 * @param array $requests An array of files to request
3226 * @param array $options An array of options to set
3227 * @return array An array of results
3229 protected function multi($requests, $options = array()) {
3230 $count = count($requests);
3233 $main = curl_multi_init();
3234 for ($i = 0; $i < $count; $i++
) {
3235 if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3237 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3238 $requests[$i]['auto-handle'] = true;
3240 foreach($requests[$i] as $n=>$v){
3243 $handles[$i] = curl_init($requests[$i]['url']);
3244 $this->apply_opt($handles[$i], $options);
3245 curl_multi_add_handle($main, $handles[$i]);
3249 curl_multi_exec($main, $running);
3250 } while($running > 0);
3251 for ($i = 0; $i < $count; $i++
) {
3252 if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3255 $results[] = curl_multi_getcontent($handles[$i]);
3257 curl_multi_remove_handle($main, $handles[$i]);
3259 curl_multi_close($main);
3261 for ($i = 0; $i < $count; $i++
) {
3262 if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3263 // close file handler if file is opened in this function
3264 fclose($requests[$i]['file']);
3271 * Single HTTP Request
3273 * @param string $url The URL to request
3274 * @param array $options
3277 protected function request($url, $options = array()){
3278 // create curl instance
3279 $curl = curl_init($url);
3280 $options['url'] = $url;
3281 $this->apply_opt($curl, $options);
3282 if ($this->cache
&& $ret = $this->cache
->get($this->options
)) {
3285 $ret = curl_exec($curl);
3287 $this->cache
->set($this->options
, $ret);
3291 $this->info
= curl_getinfo($curl);
3292 $this->error
= curl_error($curl);
3293 $this->errno
= curl_errno($curl);
3296 echo '<h1>Return Data</h1>';
3298 echo '<h1>Info</h1>';
3299 var_dump($this->info
);
3300 echo '<h1>Error</h1>';
3301 var_dump($this->error
);
3306 if (empty($this->error
)){
3309 return $this->error
;
3310 // exception is not ajax friendly
3311 //throw new moodle_exception($this->error, 'curl');
3320 * @param string $url
3321 * @param array $options
3324 public function head($url, $options = array()){
3325 $options['CURLOPT_HTTPGET'] = 0;
3326 $options['CURLOPT_HEADER'] = 1;
3327 $options['CURLOPT_NOBODY'] = 1;
3328 return $this->request($url, $options);
3334 * @param string $url
3335 * @param array|string $params
3336 * @param array $options
3339 public function post($url, $params = '', $options = array()){
3340 $options['CURLOPT_POST'] = 1;
3341 if (is_array($params)) {
3342 $this->_tmp_file_post_params
= array();
3343 foreach ($params as $key => $value) {
3344 if ($value instanceof stored_file
) {
3345 $value->add_to_curl_request($this, $key);
3347 $this->_tmp_file_post_params
[$key] = $value;
3350 $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params
;
3351 unset($this->_tmp_file_post_params
);
3353 // $params is the raw post data
3354 $options['CURLOPT_POSTFIELDS'] = $params;
3356 return $this->request($url, $options);
3362 * @param string $url
3363 * @param array $params
3364 * @param array $options
3367 public function get($url, $params = array(), $options = array()){
3368 $options['CURLOPT_HTTPGET'] = 1;
3370 if (!empty($params)){
3371 $url .= (stripos($url, '?') !== false) ?
'&' : '?';
3372 $url .= http_build_query($params, '', '&');
3374 return $this->request($url, $options);
3378 * Downloads one file and writes it to the specified file handler
3382 * $file = fopen('savepath', 'w');
3383 * $result = $c->download_one('http://localhost/', null,
3384 * array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3386 * $download_info = $c->get_info();
3387 * if ($result === true) {
3388 * // file downloaded successfully
3390 * $error_text = $result;
3391 * $error_code = $c->get_errno();
3397 * $result = $c->download_one('http://localhost/', null,
3398 * array('filepath' => 'savepath', 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3399 * // ... see above, no need to close handle and remove file if unsuccessful
3402 * @param string $url
3403 * @param array|null $params key-value pairs to be added to $url as query string
3404 * @param array $options request options. Must include either 'file' or 'filepath'
3405 * @return bool|string true on success or error string on failure
3407 public function download_one($url, $params, $options = array()) {
3408 $options['CURLOPT_HTTPGET'] = 1;
3409 $options['CURLOPT_BINARYTRANSFER'] = true;
3410 if (!empty($params)){
3411 $url .= (stripos($url, '?') !== false) ?
'&' : '?';
3412 $url .= http_build_query($params, '', '&');
3414 if (!empty($options['filepath']) && empty($options['file'])) {
3416 if (!($options['file'] = fopen($options['filepath'], 'w'))) {
3418 return get_string('cannotwritefile', 'error', $options['filepath']);
3420 $filepath = $options['filepath'];
3422 unset($options['filepath']);
3423 $result = $this->request($url, $options);
3424 if (isset($filepath)) {
3425 fclose($options['file']);
3426 if ($result !== true) {
3436 * @param string $url
3437 * @param array $params
3438 * @param array $options
3441 public function put($url, $params = array(), $options = array()){
3442 $file = $params['file'];
3443 if (!is_file($file)){
3446 $fp = fopen($file, 'r');
3447 $size = filesize($file);
3448 $options['CURLOPT_PUT'] = 1;
3449 $options['CURLOPT_INFILESIZE'] = $size;
3450 $options['CURLOPT_INFILE'] = $fp;
3451 if (!isset($this->options
['CURLOPT_USERPWD'])){
3452 $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
3454 $ret = $this->request($url, $options);
3460 * HTTP DELETE method
3462 * @param string $url
3463 * @param array $param
3464 * @param array $options
3467 public function delete($url, $param = array(), $options = array()){
3468 $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
3469 if (!isset($options['CURLOPT_USERPWD'])) {
3470 $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
3472 $ret = $this->request($url, $options);
3479 * @param string $url
3480 * @param array $options
3483 public function trace($url, $options = array()){
3484 $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
3485 $ret = $this->request($url, $options);
3490 * HTTP OPTIONS method
3492 * @param string $url
3493 * @param array $options
3496 public function options($url, $options = array()){
3497 $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
3498 $ret = $this->request($url, $options);
3503 * Get curl information
3507 public function get_info() {
3512 * Get curl error code
3516 public function get_errno() {
3517 return $this->errno
;
3521 * When using a proxy, an additional HTTP response code may appear at
3522 * the start of the header. For example, when using https over a proxy
3523 * there may be 'HTTP/1.0 200 Connection Established'. Other codes are
3524 * also possible and some may come with their own headers.
3526 * If using the return value containing all headers, this function can be
3527 * called to remove unwanted doubles.
3529 * Note that it is not possible to distinguish this situation from valid
3530 * data unless you know the actual response part (below the headers)
3531 * will not be included in this string, or else will not 'look like' HTTP
3532 * headers. As a result it is not safe to call this function for general
3535 * @param string $input Input HTTP response
3536 * @return string HTTP response with additional headers stripped if any
3538 public static function strip_double_headers($input) {
3539 // I have tried to make this regular expression as specific as possible
3540 // to avoid any case where it does weird stuff if you happen to put
3541 // HTTP/1.1 200 at the start of any line in your RSS file. This should
3542 // also make it faster because it can abandon regex processing as soon
3543 // as it hits something that doesn't look like an http header. The
3544 // header definition is taken from RFC 822, except I didn't support
3545 // folding which is never used in practice.
3547 return preg_replace(
3548 // HTTP version and status code (ignore value of code).
3549 '~^HTTP/1\..*' . $crlf .
3550 // Header name: character between 33 and 126 decimal, except colon.
3551 // Colon. Header value: any character except \r and \n. CRLF.
3552 '(?:[\x21-\x39\x3b-\x7e]+:[^' . $crlf . ']+' . $crlf . ')*' .
3553 // Headers are terminated by another CRLF (blank line).
3555 // Second HTTP status code, this time must be 200.
3556 '(HTTP/1.[01] 200 )~', '$1', $input);
3561 * This class is used by cURL class, use case:
3564 * $CFG->repositorycacheexpire = 120;
3565 * $CFG->curlcache = 120;
3567 * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
3568 * $ret = $c->get('http://www.google.com');
3571 * @package core_files
3572 * @copyright Dongsheng Cai <dongsheng@moodle.com>
3573 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3576 /** @var string Path to cache directory */
3582 * @global stdClass $CFG
3583 * @param string $module which module is using curl_cache
3585 public function __construct($module = 'repository') {
3587 if (!empty($module)) {
3588 $this->dir
= $CFG->cachedir
.'/'.$module.'/';
3590 $this->dir
= $CFG->cachedir
.'/misc/';
3592 if (!file_exists($this->dir
)) {
3593 mkdir($this->dir
, $CFG->directorypermissions
, true);
3595 if ($module == 'repository') {
3596 if (empty($CFG->repositorycacheexpire
)) {
3597 $CFG->repositorycacheexpire
= 120;
3599 $this->ttl
= $CFG->repositorycacheexpire
;
3601 if (empty($CFG->curlcache
)) {
3602 $CFG->curlcache
= 120;
3604 $this->ttl
= $CFG->curlcache
;
3611 * @global stdClass $CFG
3612 * @global stdClass $USER
3613 * @param mixed $param
3614 * @return bool|string
3616 public function get($param) {
3618 $this->cleanup($this->ttl
);
3619 $filename = 'u'.$USER->id
.'_'.md5(serialize($param));
3620 if(file_exists($this->dir
.$filename)) {
3621 $lasttime = filemtime($this->dir
.$filename);
3622 if (time()-$lasttime > $this->ttl
) {
3625 $fp = fopen($this->dir
.$filename, 'r');
3626 $size = filesize($this->dir
.$filename);
3627 $content = fread($fp, $size);
3628 return unserialize($content);
3637 * @global object $CFG
3638 * @global object $USER
3639 * @param mixed $param
3642 public function set($param, $val) {
3644 $filename = 'u'.$USER->id
.'_'.md5(serialize($param));
3645 $fp = fopen($this->dir
.$filename, 'w');
3646 fwrite($fp, serialize($val));
3651 * Remove cache files
3653 * @param int $expire The number of seconds before expiry
3655 public function cleanup($expire) {
3656 if ($dir = opendir($this->dir
)) {
3657 while (false !== ($file = readdir($dir))) {
3658 if(!is_dir($file) && $file != '.' && $file != '..') {
3659 $lasttime = @filemtime
($this->dir
.$file);
3660 if (time() - $lasttime > $expire) {
3661 @unlink
($this->dir
.$file);
3669 * delete current user's cache file
3671 * @global object $CFG
3672 * @global object $USER
3674 public function refresh() {
3676 if ($dir = opendir($this->dir
)) {
3677 while (false !== ($file = readdir($dir))) {
3678 if (!is_dir($file) && $file != '.' && $file != '..') {
3679 if (strpos($file, 'u'.$USER->id
.'_') !== false) {
3680 @unlink
($this->dir
.$file);
3689 * This function delegates file serving to individual plugins
3691 * @param string $relativepath
3692 * @param bool $forcedownload
3693 * @param null|string $preview the preview mode, defaults to serving the original file
3694 * @todo MDL-31088 file serving improments
3696 function file_pluginfile($relativepath, $forcedownload, $preview = null) {
3697 global $DB, $CFG, $USER;
3698 // relative path must start with '/'
3699 if (!$relativepath) {
3700 print_error('invalidargorconf');
3701 } else if ($relativepath[0] != '/') {
3702 print_error('pathdoesnotstartslash');
3705 // extract relative path components
3706 $args = explode('/', ltrim($relativepath, '/'));
3708 if (count($args) < 3) { // always at least context, component and filearea
3709 print_error('invalidarguments');
3712 $contextid = (int)array_shift($args);
3713 $component = clean_param(array_shift($args), PARAM_COMPONENT
);
3714 $filearea = clean_param(array_shift($args), PARAM_AREA
);
3716 list($context, $course, $cm) = get_context_info_array($contextid);
3718 $fs = get_file_storage();
3720 // ========================================================================================================================
3721 if ($component === 'blog') {
3722 // Blog file serving
3723 if ($context->contextlevel
!= CONTEXT_SYSTEM
) {
3724 send_file_not_found();
3726 if ($filearea !== 'attachment' and $filearea !== 'post') {
3727 send_file_not_found();
3730 if (empty($CFG->enableblogs
)) {
3731 print_error('siteblogdisable', 'blog');
3734 $entryid = (int)array_shift($args);
3735 if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3736 send_file_not_found();
3738 if ($CFG->bloglevel
< BLOG_GLOBAL_LEVEL
) {
3740 if (isguestuser()) {
3741 print_error('noguest');
3743 if ($CFG->bloglevel
== BLOG_USER_LEVEL
) {
3744 if ($USER->id
!= $entry->userid
) {
3745 send_file_not_found();
3750 if ($entry->publishstate
=== 'public') {
3751 if ($CFG->forcelogin
) {
3755 } else if ($entry->publishstate
=== 'site') {
3758 } else if ($entry->publishstate
=== 'draft') {
3760 if ($USER->id
!= $entry->userid
) {
3761 send_file_not_found();
3765 $filename = array_pop($args);
3766 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
3768 if (!$file = $fs->get_file($context->id
, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3769 send_file_not_found();
3772 send_stored_file($file, 10*60, 0, true, array('preview' => $preview)); // download MUST be forced - security!
3774 // ========================================================================================================================
3775 } else if ($component === 'grade') {
3776 if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel
== CONTEXT_SYSTEM
) {
3777 // Global gradebook files
3778 if ($CFG->forcelogin
) {
3782 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3784 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3785 send_file_not_found();
3788 session_get_instance()->write_close(); // unlock session during fileserving
3789 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3791 } else if ($filearea === 'feedback' and $context->contextlevel
== CONTEXT_COURSE
) {
3792 //TODO: nobody implemented this yet in grade edit form!!
3793 send_file_not_found();
3795 if ($CFG->forcelogin ||
$course->id
!= SITEID
) {
3796 require_login($course);
3799 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3801 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3802 send_file_not_found();
3805 session_get_instance()->write_close(); // unlock session during fileserving
3806 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3808 send_file_not_found();
3811 // ========================================================================================================================
3812 } else if ($component === 'tag') {
3813 if ($filearea === 'description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
3815 // All tag descriptions are going to be public but we still need to respect forcelogin
3816 if ($CFG->forcelogin
) {
3820 $fullpath = "/$context->id/tag/description/".implode('/', $args);
3822 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3823 send_file_not_found();
3826 session_get_instance()->write_close(); // unlock session during fileserving
3827 send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3830 send_file_not_found();
3832 // ========================================================================================================================
3833 } else if ($component === 'badges') {
3834 require_once($CFG->libdir
. '/badgeslib.php');
3836 $badgeid = (int)array_shift($args);
3837 $badge = new badge($badgeid);
3838 $filename = array_pop($args);
3840 if ($filearea === 'badgeimage') {
3841 if ($filename !== 'f1' && $filename !== 'f2') {
3842 send_file_not_found();
3844 if (!$file = $fs->get_file($context->id
, 'badges', 'badgeimage', $badge->id
, '/', $filename.'.png')) {
3845 send_file_not_found();
3848 session_get_instance()->write_close();
3849 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3850 } else if ($filearea === 'userbadge' and $context->contextlevel
== CONTEXT_USER
) {
3851 if (!$file = $fs->get_file($context->id
, 'badges', 'userbadge', $badge->id
, '/', $filename.'.png')) {
3852 send_file_not_found();
3855 session_get_instance()->write_close();
3856 send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3858 // ========================================================================================================================
3859 } else if ($component === 'calendar') {
3860 if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
3862 // All events here are public the one requirement is that we respect forcelogin
3863 if ($CFG->forcelogin
) {
3867 // Get the event if from the args array
3868 $eventid = array_shift($args);
3870 // Load the event from the database
3871 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
3872 send_file_not_found();
3875 // Get the file and serve if successful
3876 $filename = array_pop($args);
3877 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
3878 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3879 send_file_not_found();
3882 session_get_instance()->write_close(); // unlock session during fileserving
3883 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3885 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_USER
) {
3887 // Must be logged in, if they are not then they obviously can't be this user
3890 // Don't want guests here, potentially saves a DB call
3891 if (isguestuser()) {
3892 send_file_not_found();
3895 // Get the event if from the args array
3896 $eventid = array_shift($args);
3898 // Load the event from the database - user id must match
3899 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id
, 'eventtype'=>'user'))) {
3900 send_file_not_found();
3903 // Get the file and serve if successful
3904 $filename = array_pop($args);
3905 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
3906 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3907 send_file_not_found();
3910 session_get_instance()->write_close(); // unlock session during fileserving
3911 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3913 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_COURSE
) {
3915 // Respect forcelogin and require login unless this is the site.... it probably
3916 // should NEVER be the site
3917 if ($CFG->forcelogin ||
$course->id
!= SITEID
) {
3918 require_login($course);
3921 // Must be able to at least view the course. This does not apply to the front page.
3922 if ($course->id
!= SITEID
&& (!is_enrolled($context)) && (!is_viewing($context))) {
3923 //TODO: hmm, do we really want to block guests here?
3924 send_file_not_found();
3928 $eventid = array_shift($args);
3930 // Load the event from the database we need to check whether it is
3931 // a) valid course event
3933 // Group events use the course context (there is no group context)
3934 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id
))) {
3935 send_file_not_found();
3938 // If its a group event require either membership of view all groups capability
3939 if ($event->eventtype
=== 'group') {
3940 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid
, $USER->id
)) {
3941 send_file_not_found();
3943 } else if ($event->eventtype
=== 'course' ||
$event->eventtype
=== 'site') {
3944 // Ok. Please note that the event type 'site' still uses a course context.
3947 send_file_not_found();
3950 // If we get this far we can serve the file
3951 $filename = array_pop($args);
3952 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
3953 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3954 send_file_not_found();
3957 session_get_instance()->write_close(); // unlock session during fileserving
3958 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3961 send_file_not_found();
3964 // ========================================================================================================================
3965 } else if ($component === 'user') {
3966 if ($filearea === 'icon' and $context->contextlevel
== CONTEXT_USER
) {
3967 if (count($args) == 1) {
3968 $themename = theme_config
::DEFAULT_THEME
;
3969 $filename = array_shift($args);
3971 $themename = array_shift($args);
3972 $filename = array_shift($args);
3975 // fix file name automatically
3976 if ($filename !== 'f1' and $filename !== 'f2' and $filename !== 'f3') {
3980 if ((!empty($CFG->forcelogin
) and !isloggedin()) ||
3981 (!empty($CFG->forceloginforprofileimage
) && (!isloggedin() ||
isguestuser()))) {
3982 // protect images if login required and not logged in;
3983 // also if login is required for profile images and is not logged in or guest
3984 // do not use require_login() because it is expensive and not suitable here anyway
3985 $theme = theme_config
::load($themename);
3986 redirect($theme->pix_url('u/'.$filename, 'moodle')); // intentionally not cached
3989 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'.png')) {
3990 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'.jpg')) {
3991 if ($filename === 'f3') {
3992 // f3 512x512px was introduced in 2.3, there might be only the smaller version.
3993 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', 'f1.png')) {
3994 $file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', 'f1.jpg');
4000 // bad reference - try to prevent future retries as hard as possible!
4001 if ($user = $DB->get_record('user', array('id'=>$context->instanceid
), 'id, picture')) {
4002 if ($user->picture
> 0) {
4003 $DB->set_field('user', 'picture', 0, array('id'=>$user->id
));
4006 // no redirect here because it is not cached
4007 $theme = theme_config
::load($themename);
4008 $imagefile = $theme->resolve_image_location('u/'.$filename, 'moodle', null);
4009 send_file($imagefile, basename($imagefile), 60*60*24*14);
4012 send_stored_file($file, 60*60*24*365, 0, false, array('preview' => $preview)); // enable long caching, there are many images on each page
4014 } else if ($filearea === 'private' and $context->contextlevel
== CONTEXT_USER
) {
4017 if (isguestuser()) {
4018 send_file_not_found();
4021 if ($USER->id
!== $context->instanceid
) {
4022 send_file_not_found();
4025 $filename = array_pop($args);
4026 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4027 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4028 send_file_not_found();
4031 session_get_instance()->write_close(); // unlock session during fileserving
4032 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4034 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_USER
) {
4036 if ($CFG->forcelogin
) {
4040 $userid = $context->instanceid
;
4042 if ($USER->id
== $userid) {
4043 // always can access own
4045 } else if (!empty($CFG->forceloginforprofiles
)) {
4048 if (isguestuser()) {
4049 send_file_not_found();
4052 // we allow access to site profile of all course contacts (usually teachers)
4053 if (!has_coursecontact_role($userid) && !has_capability('moodle/user:viewdetails', $context)) {
4054 send_file_not_found();
4058 if (has_capability('moodle/user:viewdetails', $context)) {
4061 $courses = enrol_get_my_courses();
4064 while (!$canview && count($courses) > 0) {
4065 $course = array_shift($courses);
4066 if (has_capability('moodle/user:viewdetails', context_course
::instance($course->id
))) {
4072 $filename = array_pop($args);
4073 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4074 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4075 send_file_not_found();
4078 session_get_instance()->write_close(); // unlock session during fileserving
4079 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4081 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_COURSE
) {
4082 $userid = (int)array_shift($args);
4083 $usercontext = context_user
::instance($userid);
4085 if ($CFG->forcelogin
) {
4089 if (!empty($CFG->forceloginforprofiles
)) {
4091 if (isguestuser()) {
4092 print_error('noguest');
4095 //TODO: review this logic of user profile access prevention
4096 if (!has_coursecontact_role($userid) and !has_capability('moodle/user:viewdetails', $usercontext)) {
4097 print_error('usernotavailable');
4099 if (!has_capability('moodle/user:viewdetails', $context) && !has_capability('moodle/user:viewdetails', $usercontext)) {
4100 print_error('cannotviewprofile');
4102 if (!is_enrolled($context, $userid)) {
4103 print_error('notenrolledprofile');
4105 if (groups_get_course_groupmode($course) == SEPARATEGROUPS
and !has_capability('moodle/site:accessallgroups', $context)) {
4106 print_error('groupnotamember');
4110 $filename = array_pop($args);
4111 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4112 if (!$file = $fs->get_file($usercontext->id
, 'user', 'profile', 0, $filepath, $filename) or $file->is_directory()) {
4113 send_file_not_found();
4116 session_get_instance()->write_close(); // unlock session during fileserving
4117 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4119 } else if ($filearea === 'backup' and $context->contextlevel
== CONTEXT_USER
) {
4122 if (isguestuser()) {
4123 send_file_not_found();
4125 $userid = $context->instanceid
;
4127 if ($USER->id
!= $userid) {
4128 send_file_not_found();
4131 $filename = array_pop($args);
4132 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4133 if (!$file = $fs->get_file($context->id
, 'user', 'backup', 0, $filepath, $filename) or $file->is_directory()) {
4134 send_file_not_found();
4137 session_get_instance()->write_close(); // unlock session during fileserving
4138 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4141 send_file_not_found();
4144 // ========================================================================================================================
4145 } else if ($component === 'coursecat') {
4146 if ($context->contextlevel
!= CONTEXT_COURSECAT
) {
4147 send_file_not_found();
4150 if ($filearea === 'description') {
4151 if ($CFG->forcelogin
) {
4152 // no login necessary - unless login forced everywhere
4156 $filename = array_pop($args);
4157 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4158 if (!$file = $fs->get_file($context->id
, 'coursecat', 'description', 0, $filepath, $filename) or $file->is_directory()) {
4159 send_file_not_found();
4162 session_get_instance()->write_close(); // unlock session during fileserving
4163 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4165 send_file_not_found();
4168 // ========================================================================================================================
4169 } else if ($component === 'course') {
4170 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4171 send_file_not_found();
4174 if ($filearea === 'summary' ||
$filearea === 'overviewfiles') {
4175 if ($CFG->forcelogin
) {
4179 $filename = array_pop($args);
4180 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4181 if (!$file = $fs->get_file($context->id
, 'course', $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4182 send_file_not_found();
4185 session_get_instance()->write_close(); // unlock session during fileserving
4186 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4188 } else if ($filearea === 'section') {
4189 if ($CFG->forcelogin
) {
4190 require_login($course);
4191 } else if ($course->id
!= SITEID
) {
4192 require_login($course);
4195 $sectionid = (int)array_shift($args);
4197 if (!$section = $DB->get_record('course_sections', array('id'=>$sectionid, 'course'=>$course->id
))) {
4198 send_file_not_found();
4201 $filename = array_pop($args);
4202 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4203 if (!$file = $fs->get_file($context->id
, 'course', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4204 send_file_not_found();
4207 session_get_instance()->write_close(); // unlock session during fileserving
4208 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4211 send_file_not_found();
4214 } else if ($component === 'group') {
4215 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4216 send_file_not_found();
4219 require_course_login($course, true, null, false);
4221 $groupid = (int)array_shift($args);
4223 $group = $DB->get_record('groups', array('id'=>$groupid, 'courseid'=>$course->id
), '*', MUST_EXIST
);
4224 if (($course->groupmodeforce
and $course->groupmode
== SEPARATEGROUPS
) and !has_capability('moodle/site:accessallgroups', $context) and !groups_is_member($group->id
, $USER->id
)) {
4225 // do not allow access to separate group info if not member or teacher
4226 send_file_not_found();
4229 if ($filearea === 'description') {
4231 require_login($course);
4233 $filename = array_pop($args);
4234 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4235 if (!$file = $fs->get_file($context->id
, 'group', 'description', $group->id
, $filepath, $filename) or $file->is_directory()) {
4236 send_file_not_found();
4239 session_get_instance()->write_close(); // unlock session during fileserving
4240 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4242 } else if ($filearea === 'icon') {
4243 $filename = array_pop($args);
4245 if ($filename !== 'f1' and $filename !== 'f2') {
4246 send_file_not_found();
4248 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.png')) {
4249 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.jpg')) {
4250 send_file_not_found();
4254 session_get_instance()->write_close(); // unlock session during fileserving
4255 send_stored_file($file, 60*60, 0, false, array('preview' => $preview));
4258 send_file_not_found();
4261 } else if ($component === 'grouping') {
4262 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4263 send_file_not_found();
4266 require_login($course);
4268 $groupingid = (int)array_shift($args);
4270 // note: everybody has access to grouping desc images for now
4271 if ($filearea === 'description') {
4273 $filename = array_pop($args);
4274 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4275 if (!$file = $fs->get_file($context->id
, 'grouping', 'description', $groupingid, $filepath, $filename) or $file->is_directory()) {
4276 send_file_not_found();
4279 session_get_instance()->write_close(); // unlock session during fileserving
4280 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4283 send_file_not_found();
4286 // ========================================================================================================================
4287 } else if ($component === 'backup') {
4288 if ($filearea === 'course' and $context->contextlevel
== CONTEXT_COURSE
) {
4289 require_login($course);
4290 require_capability('moodle/backup:downloadfile', $context);
4292 $filename = array_pop($args);
4293 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4294 if (!$file = $fs->get_file($context->id
, 'backup', 'course', 0, $filepath, $filename) or $file->is_directory()) {
4295 send_file_not_found();
4298 session_get_instance()->write_close(); // unlock session during fileserving
4299 send_stored_file($file, 0, 0, $forcedownload, array('preview' => $preview));
4301 } else if ($filearea === 'section' and $context->contextlevel
== CONTEXT_COURSE
) {
4302 require_login($course);
4303 require_capability('moodle/backup:downloadfile', $context);
4305 $sectionid = (int)array_shift($args);
4307 $filename = array_pop($args);
4308 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4309 if (!$file = $fs->get_file($context->id
, 'backup', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4310 send_file_not_found();
4313 session_get_instance()->write_close();
4314 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4316 } else if ($filearea === 'activity' and $context->contextlevel
== CONTEXT_MODULE
) {
4317 require_login($course, false, $cm);
4318 require_capability('moodle/backup:downloadfile', $context);
4320 $filename = array_pop($args);
4321 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4322 if (!$file = $fs->get_file($context->id
, 'backup', 'activity', 0, $filepath, $filename) or $file->is_directory()) {
4323 send_file_not_found();
4326 session_get_instance()->write_close();
4327 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4329 } else if ($filearea === 'automated' and $context->contextlevel
== CONTEXT_COURSE
) {
4330 // Backup files that were generated by the automated backup systems.
4332 require_login($course);
4333 require_capability('moodle/site:config', $context);
4335 $filename = array_pop($args);
4336 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4337 if (!$file = $fs->get_file($context->id
, 'backup', 'automated', 0, $filepath, $filename) or $file->is_directory()) {
4338 send_file_not_found();
4341 session_get_instance()->write_close(); // unlock session during fileserving
4342 send_stored_file($file, 0, 0, $forcedownload, array('preview' => $preview));
4345 send_file_not_found();
4348 // ========================================================================================================================
4349 } else if ($component === 'question') {
4350 require_once($CFG->libdir
. '/questionlib.php');
4351 question_pluginfile($course, $context, 'question', $filearea, $args, $forcedownload);
4352 send_file_not_found();
4354 // ========================================================================================================================
4355 } else if ($component === 'grading') {
4356 if ($filearea === 'description') {
4357 // files embedded into the form definition description
4359 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4362 } else if ($context->contextlevel
>= CONTEXT_COURSE
) {
4363 require_login($course, false, $cm);
4366 send_file_not_found();
4369 $formid = (int)array_shift($args);
4371 $sql = "SELECT ga.id
4372 FROM {grading_areas} ga
4373 JOIN {grading_definitions} gd ON (gd.areaid = ga.id)
4374 WHERE gd.id = ? AND ga.contextid = ?";
4375 $areaid = $DB->get_field_sql($sql, array($formid, $context->id
), IGNORE_MISSING
);
4378 send_file_not_found();
4381 $fullpath = "/$context->id/$component/$filearea/$formid/".implode('/', $args);
4383 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4384 send_file_not_found();
4387 session_get_instance()->write_close(); // unlock session during fileserving
4388 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4391 // ========================================================================================================================
4392 } else if (strpos($component, 'mod_') === 0) {
4393 $modname = substr($component, 4);
4394 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
4395 send_file_not_found();
4397 require_once("$CFG->dirroot/mod/$modname/lib.php");
4399 if ($context->contextlevel
== CONTEXT_MODULE
) {
4400 if ($cm->modname
!== $modname) {
4401 // somebody tries to gain illegal access, cm type must match the component!
4402 send_file_not_found();
4406 if ($filearea === 'intro') {
4407 if (!plugin_supports('mod', $modname, FEATURE_MOD_INTRO
, true)) {
4408 send_file_not_found();
4410 require_course_login($course, true, $cm);
4412 // all users may access it
4413 $filename = array_pop($args);
4414 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4415 if (!$file = $fs->get_file($context->id
, 'mod_'.$modname, 'intro', 0, $filepath, $filename) or $file->is_directory()) {
4416 send_file_not_found();
4419 $lifetime = isset($CFG->filelifetime
) ?
$CFG->filelifetime
: 86400;
4421 // finally send the file
4422 send_stored_file($file, $lifetime, 0, false, array('preview' => $preview));
4425 $filefunction = $component.'_pluginfile';
4426 $filefunctionold = $modname.'_pluginfile';
4427 if (function_exists($filefunction)) {
4428 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4429 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4430 } else if (function_exists($filefunctionold)) {
4431 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4432 $filefunctionold($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4435 send_file_not_found();
4437 // ========================================================================================================================
4438 } else if (strpos($component, 'block_') === 0) {
4439 $blockname = substr($component, 6);
4440 // note: no more class methods in blocks please, that is ....
4441 if (!file_exists("$CFG->dirroot/blocks/$blockname/lib.php")) {
4442 send_file_not_found();
4444 require_once("$CFG->dirroot/blocks/$blockname/lib.php");
4446 if ($context->contextlevel
== CONTEXT_BLOCK
) {
4447 $birecord = $DB->get_record('block_instances', array('id'=>$context->instanceid
), '*',MUST_EXIST
);
4448 if ($birecord->blockname
!== $blockname) {
4449 // somebody tries to gain illegal access, cm type must match the component!
4450 send_file_not_found();
4453 $bprecord = $DB->get_record('block_positions', array('contextid' => $context->id
, 'blockinstanceid' => $context->instanceid
));
4454 // User can't access file, if block is hidden or doesn't have block:view capability
4455 if (($bprecord && !$bprecord->visible
) ||
!has_capability('moodle/block:view', $context)) {
4456 send_file_not_found();
4462 $filefunction = $component.'_pluginfile';
4463 if (function_exists($filefunction)) {
4464 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4465 $filefunction($course, $birecord, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4468 send_file_not_found();
4470 // ========================================================================================================================
4471 } else if (strpos($component, '_') === false) {
4472 // all core subsystems have to be specified above, no more guessing here!
4473 send_file_not_found();
4476 // try to serve general plugin file in arbitrary context
4477 $dir = get_component_directory($component);
4478 if (!file_exists("$dir/lib.php")) {
4479 send_file_not_found();
4481 include_once("$dir/lib.php");
4483 $filefunction = $component.'_pluginfile';
4484 if (function_exists($filefunction)) {
4485 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4486 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4489 send_file_not_found();