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 * Detects if area contains subdirs,
85 * this is intended for file areas that are attached to content
86 * migrated from 1.x where subdirs were allowed everywhere.
88 * @param context $context
89 * @param string $component
90 * @param string $filearea
91 * @param string $itemid
94 function file_area_contains_subdirs(context
$context, $component, $filearea, $itemid) {
97 if (!isset($itemid)) {
98 // Not initialised yet.
102 // Detect if any directories are already present, this is necessary for content upgraded from 1.x.
103 $select = "contextid = :contextid AND component = :component AND filearea = :filearea AND itemid = :itemid AND filepath <> '/' AND filename = '.'";
104 $params = array('contextid'=>$context->id
, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
105 return $DB->record_exists_select('files', $select, $params);
109 * Prepares 'editor' formslib element from data in database
111 * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
112 * function then copies the embedded files into draft area (assigning itemids automatically),
113 * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
115 * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
116 * your mform's set_data() supplying the object returned by this function.
119 * @param stdClass $data database field that holds the html text with embedded media
120 * @param string $field the name of the database field that holds the html text with embedded media
121 * @param array $options editor options (like maxifiles, maxbytes etc.)
122 * @param stdClass $context context of the editor
123 * @param string $component
124 * @param string $filearea file area name
125 * @param int $itemid item id, required if item exists
126 * @return stdClass modified data object
128 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
129 $options = (array)$options;
130 if (!isset($options['trusttext'])) {
131 $options['trusttext'] = false;
133 if (!isset($options['forcehttps'])) {
134 $options['forcehttps'] = false;
136 if (!isset($options['subdirs'])) {
137 $options['subdirs'] = false;
139 if (!isset($options['maxfiles'])) {
140 $options['maxfiles'] = 0; // no files by default
142 if (!isset($options['noclean'])) {
143 $options['noclean'] = false;
146 //sanity check for passed context. This function doesn't expect $option['context'] to be set
147 //But this function is called before creating editor hence, this is one of the best places to check
148 //if context is used properly. This check notify developer that they missed passing context to editor.
149 if (isset($context) && !isset($options['context'])) {
150 //if $context is not null then make sure $option['context'] is also set.
151 debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER
);
152 } else if (isset($options['context']) && isset($context)) {
153 //If both are passed then they should be equal.
154 if ($options['context']->id
!= $context->id
) {
155 $exceptionmsg = 'Editor context ['.$options['context']->id
.'] is not equal to passed context ['.$context->id
.']';
156 throw new coding_exception($exceptionmsg);
160 if (is_null($itemid) or is_null($context)) {
164 $data = new stdClass();
166 if (!isset($data->{$field})) {
167 $data->{$field} = '';
169 if (!isset($data->{$field.'format'})) {
170 $data->{$field.'format'} = editors_get_preferred_format();
172 if (!$options['noclean']) {
173 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
177 if ($options['trusttext']) {
178 // noclean ignored if trusttext enabled
179 if (!isset($data->{$field.'trust'})) {
180 $data->{$field.'trust'} = 0;
182 $data = trusttext_pre_edit($data, $field, $context);
184 if (!$options['noclean']) {
185 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
188 $contextid = $context->id
;
191 if ($options['maxfiles'] != 0) {
192 $draftid_editor = file_get_submitted_draft_itemid($field);
193 $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
194 $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
196 $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
203 * Prepares the content of the 'editor' form element with embedded media files to be saved in database
205 * This function moves files from draft area to the destination area and
206 * encodes URLs to the draft files so they can be safely saved into DB. The
207 * form has to contain the 'editor' element named foobar_editor, where 'foobar'
208 * is the name of the database field to hold the wysiwyg editor content. The
209 * editor data comes as an array with text, format and itemid properties. This
210 * function automatically adds $data properties foobar, foobarformat and
211 * foobartrust, where foobar has URL to embedded files encoded.
214 * @param stdClass $data raw data submitted by the form
215 * @param string $field name of the database field containing the html with embedded media files
216 * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
217 * @param stdClass $context context, required for existing data
218 * @param string $component file component
219 * @param string $filearea file area name
220 * @param int $itemid item id, required if item exists
221 * @return stdClass modified data object
223 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
224 $options = (array)$options;
225 if (!isset($options['trusttext'])) {
226 $options['trusttext'] = false;
228 if (!isset($options['forcehttps'])) {
229 $options['forcehttps'] = false;
231 if (!isset($options['subdirs'])) {
232 $options['subdirs'] = false;
234 if (!isset($options['maxfiles'])) {
235 $options['maxfiles'] = 0; // no files by default
237 if (!isset($options['maxbytes'])) {
238 $options['maxbytes'] = 0; // unlimited
241 if ($options['trusttext']) {
242 $data->{$field.'trust'} = trusttext_trusted($context);
244 $data->{$field.'trust'} = 0;
247 $editor = $data->{$field.'_editor'};
249 if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
250 $data->{$field} = $editor['text'];
252 $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id
, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
254 $data->{$field.'format'} = $editor['format'];
260 * Saves text and files modified by Editor formslib element
263 * @param stdClass $data $database entry field
264 * @param string $field name of data field
265 * @param array $options various options
266 * @param stdClass $context context - must already exist
267 * @param string $component
268 * @param string $filearea file area name
269 * @param int $itemid must already exist, usually means data is in db
270 * @return stdClass modified data obejct
272 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
273 $options = (array)$options;
274 if (!isset($options['subdirs'])) {
275 $options['subdirs'] = false;
277 if (is_null($itemid) or is_null($context)) {
281 $contextid = $context->id
;
284 $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
285 file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
286 $data->{$field.'_filemanager'} = $draftid_editor;
292 * Saves files modified by File manager formslib element
294 * @todo MDL-31073 review this function
296 * @param stdClass $data $database entry field
297 * @param string $field name of data field
298 * @param array $options various options
299 * @param stdClass $context context - must already exist
300 * @param string $component
301 * @param string $filearea file area name
302 * @param int $itemid must already exist, usually means data is in db
303 * @return stdClass modified data obejct
305 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
306 $options = (array)$options;
307 if (!isset($options['subdirs'])) {
308 $options['subdirs'] = false;
310 if (!isset($options['maxfiles'])) {
311 $options['maxfiles'] = -1; // unlimited
313 if (!isset($options['maxbytes'])) {
314 $options['maxbytes'] = 0; // unlimited
317 if (empty($data->{$field.'_filemanager'})) {
321 file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id
, $component, $filearea, $itemid, $options);
322 $fs = get_file_storage();
324 if ($fs->get_area_files($context->id
, $component, $filearea, $itemid)) {
325 $data->$field = '1'; // TODO: this is an ugly hack (skodak)
335 * Generate a draft itemid
338 * @global moodle_database $DB
339 * @global stdClass $USER
340 * @return int a random but available draft itemid that can be used to create a new draft
343 function file_get_unused_draft_itemid() {
346 if (isguestuser() or !isloggedin()) {
347 // guests and not-logged-in users can not be allowed to upload anything!!!!!!
348 print_error('noguest');
351 $contextid = context_user
::instance($USER->id
)->id
;
353 $fs = get_file_storage();
354 $draftitemid = rand(1, 999999999);
355 while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
356 $draftitemid = rand(1, 999999999);
363 * Initialise a draft file area from a real one by copying the files. A draft
364 * area will be created if one does not already exist. Normally you should
365 * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
368 * @global stdClass $CFG
369 * @global stdClass $USER
370 * @param int $draftitemid the id of the draft area to use, or 0 to create a new one, in which case this parameter is updated.
371 * @param int $contextid This parameter and the next two identify the file area to copy files from.
372 * @param string $component
373 * @param string $filearea helps indentify the file area.
374 * @param int $itemid helps identify the file area. Can be null if there are no files yet.
375 * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
376 * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
377 * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
379 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
380 global $CFG, $USER, $CFG;
382 $options = (array)$options;
383 if (!isset($options['subdirs'])) {
384 $options['subdirs'] = false;
386 if (!isset($options['forcehttps'])) {
387 $options['forcehttps'] = false;
390 $usercontext = context_user
::instance($USER->id
);
391 $fs = get_file_storage();
393 if (empty($draftitemid)) {
394 // create a new area and copy existing files into
395 $draftitemid = file_get_unused_draft_itemid();
396 $file_record = array('contextid'=>$usercontext->id
, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
397 if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
398 foreach ($files as $file) {
399 if ($file->is_directory() and $file->get_filepath() === '/') {
400 // we need a way to mark the age of each draft area,
401 // by not copying the root dir we force it to be created automatically with current timestamp
404 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
407 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
408 // XXX: This is a hack for file manager (MDL-28666)
409 // File manager needs to know the original file information before copying
410 // to draft area, so we append these information in mdl_files.source field
411 // {@link file_storage::search_references()}
412 // {@link file_storage::search_references_count()}
413 $sourcefield = $file->get_source();
414 $newsourcefield = new stdClass
;
415 $newsourcefield->source
= $sourcefield;
416 $original = new stdClass
;
417 $original->contextid
= $contextid;
418 $original->component
= $component;
419 $original->filearea
= $filearea;
420 $original->itemid
= $itemid;
421 $original->filename
= $file->get_filename();
422 $original->filepath
= $file->get_filepath();
423 $newsourcefield->original
= file_storage
::pack_reference($original);
424 $draftfile->set_source(serialize($newsourcefield));
425 // End of file manager hack
428 if (!is_null($text)) {
429 // at this point there should not be any draftfile links yet,
430 // because this is a new text from database that should still contain the @@pluginfile@@ links
431 // this happens when developers forget to post process the text
432 $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
438 if (is_null($text)) {
442 // relink embedded files - editor can not handle @@PLUGINFILE@@ !
443 return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id
, 'user', 'draft', $draftitemid, $options);
447 * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
450 * @global stdClass $CFG
451 * @param string $text The content that may contain ULRs in need of rewriting.
452 * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
453 * @param int $contextid This parameter and the next two identify the file area to use.
454 * @param string $component
455 * @param string $filearea helps identify the file area.
456 * @param int $itemid helps identify the file area.
457 * @param array $options text and file options ('forcehttps'=>false)
458 * @return string the processed text.
460 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
463 $options = (array)$options;
464 if (!isset($options['forcehttps'])) {
465 $options['forcehttps'] = false;
468 if (!$CFG->slasharguments
) {
469 $file = $file . '?file=';
472 $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
474 if ($itemid !== null) {
475 $baseurl .= "$itemid/";
478 if ($options['forcehttps']) {
479 $baseurl = str_replace('http://', 'https://', $baseurl);
482 return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
486 * Returns information about files in a draft area.
488 * @global stdClass $CFG
489 * @global stdClass $USER
490 * @param int $draftitemid the draft area item id.
491 * @param string $filepath path to the directory from which the information have to be retrieved.
492 * @return array with the following entries:
493 * 'filecount' => number of files in the draft area.
494 * 'filesize' => total size of the files in the draft area.
495 * 'foldercount' => number of folders in the draft area.
496 * 'filesize_without_references' => total size of the area excluding file references.
497 * (more information will be added as needed).
499 function file_get_draft_area_info($draftitemid, $filepath = '/') {
502 $usercontext = context_user
::instance($USER->id
);
503 $fs = get_file_storage();
509 'filesize_without_references' => 0
512 if ($filepath != '/') {
513 $draftfiles = $fs->get_directory_files($usercontext->id
, 'user', 'draft', $draftitemid, $filepath, true, true);
515 $draftfiles = $fs->get_area_files($usercontext->id
, 'user', 'draft', $draftitemid, 'id', true);
517 foreach ($draftfiles as $file) {
518 if ($file->is_directory()) {
519 $results['foldercount'] +
= 1;
521 $results['filecount'] +
= 1;
524 $filesize = $file->get_filesize();
525 $results['filesize'] +
= $filesize;
526 if (!$file->is_external_file()) {
527 $results['filesize_without_references'] +
= $filesize;
535 * Returns whether a draft area has exceeded/will exceed its size limit.
537 * Please note that the unlimited value for $areamaxbytes is -1 {@link FILE_AREA_MAX_BYTES_UNLIMITED}, not 0.
539 * @param int $draftitemid the draft area item id.
540 * @param int $areamaxbytes the maximum size allowed in this draft area.
541 * @param int $newfilesize the size that would be added to the current area.
542 * @param bool $includereferences true to include the size of the references in the area size.
543 * @return bool true if the area will/has exceeded its limit.
546 function file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $newfilesize = 0, $includereferences = false) {
547 if ($areamaxbytes != FILE_AREA_MAX_BYTES_UNLIMITED
) {
548 $draftinfo = file_get_draft_area_info($draftitemid);
549 $areasize = $draftinfo['filesize_without_references'];
550 if ($includereferences) {
551 $areasize = $draftinfo['filesize'];
553 if ($areasize +
$newfilesize > $areamaxbytes) {
561 * Get used space of files
562 * @global moodle_database $DB
563 * @global stdClass $USER
564 * @return int total bytes
566 function file_get_user_used_space() {
569 $usercontext = context_user
::instance($USER->id
);
570 $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
571 JOIN (SELECT contenthash, filename, MAX(id) AS id
573 WHERE contextid = ? AND component = ? AND filearea != ?
574 GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
575 $params = array('contextid'=>$usercontext->id
, 'component'=>'user', 'filearea'=>'draft');
576 $record = $DB->get_record_sql($sql, $params);
577 return (int)$record->totalbytes
;
581 * Convert any string to a valid filepath
582 * @todo review this function
584 * @return string path
586 function file_correct_filepath($str) { //TODO: what is this? (skodak) - No idea (Fred)
587 if ($str == '/' or empty($str)) {
590 return '/'.trim($str, '/').'/';
595 * Generate a folder tree of draft area of current USER recursively
597 * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
598 * @param int $draftitemid
599 * @param string $filepath
602 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
603 global $USER, $OUTPUT, $CFG;
604 $data->children
= array();
605 $context = context_user
::instance($USER->id
);
606 $fs = get_file_storage();
607 if ($files = $fs->get_directory_files($context->id
, 'user', 'draft', $draftitemid, $filepath, false)) {
608 foreach ($files as $file) {
609 if ($file->is_directory()) {
610 $item = new stdClass();
611 $item->sortorder
= $file->get_sortorder();
612 $item->filepath
= $file->get_filepath();
614 $foldername = explode('/', trim($item->filepath
, '/'));
615 $item->fullname
= trim(array_pop($foldername), '/');
617 $item->id
= uniqid();
618 file_get_drafarea_folders($draftitemid, $item->filepath
, $item);
619 $data->children
[] = $item;
628 * Listing all files (including folders) in current path (draft area)
629 * used by file manager
630 * @param int $draftitemid
631 * @param string $filepath
634 function file_get_drafarea_files($draftitemid, $filepath = '/') {
635 global $USER, $OUTPUT, $CFG;
637 $context = context_user
::instance($USER->id
);
638 $fs = get_file_storage();
640 $data = new stdClass();
641 $data->path
= array();
642 $data->path
[] = array('name'=>get_string('files'), 'path'=>'/');
644 // will be used to build breadcrumb
646 if ($filepath !== '/') {
647 $filepath = file_correct_filepath($filepath);
648 $parts = explode('/', $filepath);
649 foreach ($parts as $part) {
650 if ($part != '' && $part != null) {
651 $trail .= ($part.'/');
652 $data->path
[] = array('name'=>$part, 'path'=>$trail);
659 if ($files = $fs->get_directory_files($context->id
, 'user', 'draft', $draftitemid, $filepath, false)) {
660 foreach ($files as $file) {
661 $item = new stdClass();
662 $item->filename
= $file->get_filename();
663 $item->filepath
= $file->get_filepath();
664 $item->fullname
= trim($item->filename
, '/');
665 $filesize = $file->get_filesize();
666 $item->size
= $filesize ?
$filesize : null;
667 $item->filesize
= $filesize ?
display_size($filesize) : '';
669 $item->sortorder
= $file->get_sortorder();
670 $item->author
= $file->get_author();
671 $item->license
= $file->get_license();
672 $item->datemodified
= $file->get_timemodified();
673 $item->datecreated
= $file->get_timecreated();
674 $item->isref
= $file->is_external_file();
675 if ($item->isref
&& $file->get_status() == 666) {
676 $item->originalmissing
= true;
678 // find the file this draft file was created from and count all references in local
679 // system pointing to that file
680 $source = @unserialize
($file->get_source());
681 if (isset($source->original
)) {
682 $item->refcount
= $fs->search_references_count($source->original
);
685 if ($file->is_directory()) {
687 $item->icon
= $OUTPUT->pix_url(file_folder_icon(24))->out(false);
688 $item->type
= 'folder';
689 $foldername = explode('/', trim($item->filepath
, '/'));
690 $item->fullname
= trim(array_pop($foldername), '/');
691 $item->thumbnail
= $OUTPUT->pix_url(file_folder_icon(90))->out(false);
693 // do NOT use file browser here!
694 $item->mimetype
= get_mimetype_description($file);
695 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
698 $item->type
= 'file';
700 $itemurl = moodle_url
::make_draftfile_url($draftitemid, $item->filepath
, $item->filename
);
701 $item->url
= $itemurl->out();
702 $item->icon
= $OUTPUT->pix_url(file_file_icon($file, 24))->out(false);
703 $item->thumbnail
= $OUTPUT->pix_url(file_file_icon($file, 90))->out(false);
704 if ($imageinfo = $file->get_imageinfo()) {
705 $item->realthumbnail
= $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
706 $item->realicon
= $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
707 $item->image_width
= $imageinfo['width'];
708 $item->image_height
= $imageinfo['height'];
714 $data->itemid
= $draftitemid;
720 * Returns draft area itemid for a given element.
723 * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
724 * @return int the itemid, or 0 if there is not one yet.
726 function file_get_submitted_draft_itemid($elname) {
727 // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
728 if (!isset($_REQUEST[$elname])) {
731 if (is_array($_REQUEST[$elname])) {
732 $param = optional_param_array($elname, 0, PARAM_INT
);
733 if (!empty($param['itemid'])) {
734 $param = $param['itemid'];
736 debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER
);
741 $param = optional_param($elname, 0, PARAM_INT
);
752 * Restore the original source field from draft files
754 * Do not use this function because it makes field files.source inconsistent
755 * for draft area files. This function will be deprecated in 2.6
757 * @param stored_file $storedfile This only works with draft files
758 * @return stored_file
760 function file_restore_source_field_from_draft_file($storedfile) {
761 $source = @unserialize
($storedfile->get_source());
762 if (!empty($source)) {
763 if (is_object($source)) {
764 $restoredsource = $source->source
;
765 $storedfile->set_source($restoredsource);
767 throw new moodle_exception('invalidsourcefield', 'error');
773 * Saves files from a draft file area to a real one (merging the list of files).
774 * Can rewrite URLs in some content at the same time if desired.
777 * @global stdClass $USER
778 * @param int $draftitemid the id of the draft area to use. Normally obtained
779 * from file_get_submitted_draft_itemid('elementname') or similar.
780 * @param int $contextid This parameter and the next two identify the file area to save to.
781 * @param string $component
782 * @param string $filearea indentifies the file area.
783 * @param int $itemid helps identifies the file area.
784 * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
785 * @param string $text some html content that needs to have embedded links rewritten
786 * to the @@PLUGINFILE@@ form for saving in the database.
787 * @param bool $forcehttps force https urls.
788 * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
790 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
793 $usercontext = context_user
::instance($USER->id
);
794 $fs = get_file_storage();
796 $options = (array)$options;
797 if (!isset($options['subdirs'])) {
798 $options['subdirs'] = false;
800 if (!isset($options['maxfiles'])) {
801 $options['maxfiles'] = -1; // unlimited
803 if (!isset($options['maxbytes']) ||
$options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS
) {
804 $options['maxbytes'] = 0; // unlimited
806 if (!isset($options['areamaxbytes'])) {
807 $options['areamaxbytes'] = FILE_AREA_MAX_BYTES_UNLIMITED
; // Unlimited.
809 $allowreferences = true;
810 if (isset($options['return_types']) && !($options['return_types'] & FILE_REFERENCE
)) {
811 // we assume that if $options['return_types'] is NOT specified, we DO allow references.
812 // this is not exactly right. BUT there are many places in code where filemanager options
813 // are not passed to file_save_draft_area_files()
814 $allowreferences = false;
817 // Check if the draft area has exceeded the authorised limit. This should never happen as validation
818 // should have taken place before, unless the user is doing something nauthly. If so, let's just not save
819 // anything at all in the next area.
820 if (file_is_draft_area_limit_reached($draftitemid, $options['areamaxbytes'])) {
824 $draftfiles = $fs->get_area_files($usercontext->id
, 'user', 'draft', $draftitemid, 'id');
825 $oldfiles = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
827 // One file in filearea means it is empty (it has only top-level directory '.').
828 if (count($draftfiles) > 1 ||
count($oldfiles) > 1) {
829 // we have to merge old and new files - we want to keep file ids for files that were not changed
830 // we change time modified for all new and changed files, we keep time created as is
832 $newhashes = array();
834 foreach ($draftfiles as $file) {
835 if (!$options['subdirs'] && $file->get_filepath() !== '/') {
838 if (!$allowreferences && $file->is_external_file()) {
841 if (!$file->is_directory()) {
842 if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
843 // oversized file - should not get here at all
846 if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
847 // more files - should not get here at all
852 $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
853 $newhashes[$newhash] = $file;
856 // Loop through oldfiles and decide which we need to delete and which to update.
857 // After this cycle the array $newhashes will only contain the files that need to be added.
858 foreach ($oldfiles as $oldfile) {
859 $oldhash = $oldfile->get_pathnamehash();
860 if (!isset($newhashes[$oldhash])) {
861 // delete files not needed any more - deleted by user
866 $newfile = $newhashes[$oldhash];
867 // Now we know that we have $oldfile and $newfile for the same path.
868 // Let's check if we can update this file or we need to delete and create.
869 if ($newfile->is_directory()) {
870 // Directories are always ok to just update.
871 } else if (($source = @unserialize
($newfile->get_source())) && isset($source->original
)) {
872 // File has the 'original' - we need to update the file (it may even have not been changed at all).
873 $original = file_storage
::unpack_reference($source->original
);
874 if ($original['filename'] !== $oldfile->get_filename() ||
$original['filepath'] !== $oldfile->get_filepath()) {
875 // Very odd, original points to another file. Delete and create file.
880 // The same file name but absence of 'original' means that file was deteled and uploaded again.
881 // By deleting and creating new file we properly manage all existing references.
886 // status changed, we delete old file, and create a new one
887 if ($oldfile->get_status() != $newfile->get_status()) {
888 // file was changed, use updated with new timemodified data
890 // This file will be added later
895 if ($oldfile->get_author() != $newfile->get_author()) {
896 $oldfile->set_author($newfile->get_author());
899 if ($oldfile->get_license() != $newfile->get_license()) {
900 $oldfile->set_license($newfile->get_license());
903 // Updated file source
904 // Field files.source for draftarea files contains serialised object with source and original information.
905 // We only store the source part of it for non-draft file area.
906 $newsource = $newfile->get_source();
907 if ($source = @unserialize
($newfile->get_source())) {
908 $newsource = $source->source
;
910 if ($oldfile->get_source() !== $newsource) {
911 $oldfile->set_source($newsource);
914 // Updated sort order
915 if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
916 $oldfile->set_sortorder($newfile->get_sortorder());
919 // Update file timemodified
920 if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
921 $oldfile->set_timemodified($newfile->get_timemodified());
924 // Replaced file content
925 if (!$oldfile->is_directory() &&
926 ($oldfile->get_contenthash() != $newfile->get_contenthash() ||
927 $oldfile->get_filesize() != $newfile->get_filesize() ||
928 $oldfile->get_referencefileid() != $newfile->get_referencefileid() ||
929 $oldfile->get_userid() != $newfile->get_userid())) {
930 $oldfile->replace_file_with($newfile);
933 // unchanged file or directory - we keep it as is
934 unset($newhashes[$oldhash]);
937 // Add fresh file or the file which has changed status
938 // the size and subdirectory tests are extra safety only, the UI should prevent it
939 foreach ($newhashes as $file) {
940 $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
941 if ($source = @unserialize
($file->get_source())) {
942 // Field files.source for draftarea files contains serialised object with source and original information.
943 // We only store the source part of it for non-draft file area.
944 $file_record['source'] = $source->source
;
947 if ($file->is_external_file()) {
948 $repoid = $file->get_repository_id();
949 if (!empty($repoid)) {
950 $file_record['repositoryid'] = $repoid;
951 $file_record['reference'] = $file->get_reference();
955 $fs->create_file_from_storedfile($file_record, $file);
959 // note: do not purge the draft area - we clean up areas later in cron,
960 // the reason is that user might press submit twice and they would loose the files,
961 // also sometimes we might want to use hacks that save files into two different areas
963 if (is_null($text)) {
966 return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
971 * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
972 * ready to be saved in the database. Normally, this is done automatically by
973 * {@link file_save_draft_area_files()}.
976 * @param string $text the content to process.
977 * @param int $draftitemid the draft file area the content was using.
978 * @param bool $forcehttps whether the content contains https URLs. Default false.
979 * @return string the processed content.
981 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
984 $usercontext = context_user
::instance($USER->id
);
986 $wwwroot = $CFG->wwwroot
;
988 $wwwroot = str_replace('http://', 'https://', $wwwroot);
991 // relink embedded files if text submitted - no absolute links allowed in database!
992 $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
994 if (strpos($text, 'draftfile.php?file=') !== false) {
996 preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
998 foreach ($matches[0] as $match) {
999 $replace = str_ireplace('%2F', '/', $match);
1000 $text = str_replace($match, $replace, $text);
1003 $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
1010 * Set file sort order
1012 * @global moodle_database $DB
1013 * @param int $contextid the context id
1014 * @param string $component file component
1015 * @param string $filearea file area.
1016 * @param int $itemid itemid.
1017 * @param string $filepath file path.
1018 * @param string $filename file name.
1019 * @param int $sortorder the sort order of file.
1022 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
1024 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
1025 if ($file_record = $DB->get_record('files', $conditions)) {
1026 $sortorder = (int)$sortorder;
1027 $file_record->sortorder
= $sortorder;
1028 $DB->update_record('files', $file_record);
1035 * reset file sort order number to 0
1036 * @global moodle_database $DB
1037 * @param int $contextid the context id
1038 * @param string $component
1039 * @param string $filearea file area.
1040 * @param int|bool $itemid itemid.
1043 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
1046 $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
1047 if ($itemid !== false) {
1048 $conditions['itemid'] = $itemid;
1051 $file_records = $DB->get_records('files', $conditions);
1052 foreach ($file_records as $file_record) {
1053 $file_record->sortorder
= 0;
1054 $DB->update_record('files', $file_record);
1060 * Returns description of upload error
1062 * @param int $errorcode found in $_FILES['filename.ext']['error']
1063 * @return string error description string, '' if ok
1065 function file_get_upload_error($errorcode) {
1067 switch ($errorcode) {
1068 case 0: // UPLOAD_ERR_OK - no error
1072 case 1: // UPLOAD_ERR_INI_SIZE
1073 $errmessage = get_string('uploadserverlimit');
1076 case 2: // UPLOAD_ERR_FORM_SIZE
1077 $errmessage = get_string('uploadformlimit');
1080 case 3: // UPLOAD_ERR_PARTIAL
1081 $errmessage = get_string('uploadpartialfile');
1084 case 4: // UPLOAD_ERR_NO_FILE
1085 $errmessage = get_string('uploadnofilefound');
1088 // Note: there is no error with a value of 5
1090 case 6: // UPLOAD_ERR_NO_TMP_DIR
1091 $errmessage = get_string('uploadnotempdir');
1094 case 7: // UPLOAD_ERR_CANT_WRITE
1095 $errmessage = get_string('uploadcantwrite');
1098 case 8: // UPLOAD_ERR_EXTENSION
1099 $errmessage = get_string('uploadextension');
1103 $errmessage = get_string('uploadproblem');
1110 * Recursive function formating an array in POST parameter
1111 * @param array $arraydata - the array that we are going to format and add into &$data array
1112 * @param string $currentdata - a row of the final postdata array at instant T
1113 * when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1114 * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1116 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1117 foreach ($arraydata as $k=>$v) {
1118 $newcurrentdata = $currentdata;
1119 if (is_array($v)) { //the value is an array, call the function recursively
1120 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1121 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1122 } else { //add the POST parameter to the $data array
1123 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1129 * Transform a PHP array into POST parameter
1130 * (see the recursive function format_array_postdata_for_curlcall)
1131 * @param array $postdata
1132 * @return array containing all POST parameters (1 row = 1 POST parameter)
1134 function format_postdata_for_curlcall($postdata) {
1136 foreach ($postdata as $k=>$v) {
1138 $currentdata = urlencode($k);
1139 format_array_postdata_for_curlcall($v, $currentdata, $data);
1141 $data[] = urlencode($k).'='.urlencode($v);
1144 $convertedpostdata = implode('&', $data);
1145 return $convertedpostdata;
1149 * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1150 * Due to security concerns only downloads from http(s) sources are supported.
1153 * @param string $url file url starting with http(s)://
1154 * @param array $headers http headers, null if none. If set, should be an
1155 * associative array of header name => value pairs.
1156 * @param array $postdata array means use POST request with given parameters
1157 * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1158 * (if false, just returns content)
1159 * @param int $timeout timeout for complete download process including all file transfer
1160 * (default 5 minutes)
1161 * @param int $connecttimeout timeout for connection to server; this is the timeout that
1162 * usually happens if the remote server is completely down (default 20 seconds);
1163 * may not work when using proxy
1164 * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1165 * Only use this when already in a trusted location.
1166 * @param string $tofile store the downloaded content to file instead of returning it.
1167 * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1168 * filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1169 * @return mixed false if request failed or content of the file as string if ok. True if file downloaded into $tofile successfully.
1171 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1174 // Only http and https links supported.
1175 if (!preg_match('|^https?://|i', $url)) {
1176 if ($fullresponse) {
1177 $response = new stdClass();
1178 $response->status
= 0;
1179 $response->headers
= array();
1180 $response->response_code
= 'Invalid protocol specified in url';
1181 $response->results
= '';
1182 $response->error
= 'Invalid protocol specified in url';
1191 $headers2 = array();
1192 if (is_array($headers)) {
1193 foreach ($headers as $key => $value) {
1194 if (is_numeric($key)) {
1195 $headers2[] = $value;
1197 $headers2[] = "$key: $value";
1202 if ($skipcertverify) {
1203 $options['CURLOPT_SSL_VERIFYPEER'] = false;
1205 $options['CURLOPT_SSL_VERIFYPEER'] = true;
1208 $options['CURLOPT_CONNECTTIMEOUT'] = $connecttimeout;
1210 $options['CURLOPT_FOLLOWLOCATION'] = 1;
1211 $options['CURLOPT_MAXREDIRS'] = 5;
1213 // Use POST if requested.
1214 if (is_array($postdata)) {
1215 $postdata = format_postdata_for_curlcall($postdata);
1216 } else if (empty($postdata)) {
1220 // Optionally attempt to get more correct timeout by fetching the file size.
1221 if (!isset($CFG->curltimeoutkbitrate
)) {
1222 // Use very slow rate of 56kbps as a timeout speed when not set.
1225 $bitrate = $CFG->curltimeoutkbitrate
;
1227 if ($calctimeout and !isset($postdata)) {
1229 $curl->setHeader($headers2);
1231 $curl->head($url, $postdata, $options);
1233 $info = $curl->get_info();
1234 $error_no = $curl->get_errno();
1235 if (!$error_no && $info['download_content_length'] > 0) {
1236 // No curl errors - adjust for large files only - take max timeout.
1237 $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024)));
1242 $curl->setHeader($headers2);
1244 $options['CURLOPT_RETURNTRANSFER'] = true;
1245 $options['CURLOPT_NOBODY'] = false;
1246 $options['CURLOPT_TIMEOUT'] = $timeout;
1249 $fh = fopen($tofile, 'w');
1251 if ($fullresponse) {
1252 $response = new stdClass();
1253 $response->status
= 0;
1254 $response->headers
= array();
1255 $response->response_code
= 'Can not write to file';
1256 $response->results
= false;
1257 $response->error
= 'Can not write to file';
1263 $options['CURLOPT_FILE'] = $fh;
1266 if (isset($postdata)) {
1267 $content = $curl->post($url, $postdata, $options);
1269 $content = $curl->get($url, null, $options);
1274 @chmod
($tofile, $CFG->filepermissions
);
1278 // Try to detect encoding problems.
1279 if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1280 curl_setopt($ch, CURLOPT_ENCODING, 'none');
1281 $result = curl_exec($ch);
1285 $info = $curl->get_info();
1286 $error_no = $curl->get_errno();
1287 $rawheaders = $curl->get_raw_response();
1291 if (!$fullresponse) {
1292 debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL
);
1296 $response = new stdClass();
1297 if ($error_no == 28) {
1298 $response->status
= '-100'; // Mimic snoopy.
1300 $response->status
= '0';
1302 $response->headers
= array();
1303 $response->response_code
= $error;
1304 $response->results
= false;
1305 $response->error
= $error;
1313 if (empty($info['http_code'])) {
1314 // For security reasons we support only true http connections (Location: file:// exploit prevention).
1315 $response = new stdClass();
1316 $response->status
= '0';
1317 $response->headers
= array();
1318 $response->response_code
= 'Unknown cURL error';
1319 $response->results
= false; // do NOT change this, we really want to ignore the result!
1320 $response->error
= 'Unknown cURL error';
1323 $response = new stdClass();
1324 $response->status
= (string)$info['http_code'];
1325 $response->headers
= $rawheaders;
1326 $response->results
= $content;
1327 $response->error
= '';
1329 // There might be multiple headers on redirect, find the status of the last one.
1331 foreach ($rawheaders as $line) {
1333 $response->response_code
= $line;
1336 if (trim($line, "\r\n") === '') {
1342 if ($fullresponse) {
1346 if ($info['http_code'] != 200) {
1347 debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code
, DEBUG_ALL
);
1350 return $response->results
;
1354 * Returns a list of information about file types based on extensions.
1356 * The following elements expected in value array for each extension:
1358 * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1359 * or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1360 * also files with bigger sizes under names
1361 * FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1362 * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1363 * commonly used in moodle the following groups:
1364 * - web_image - image that can be included as <img> in HTML
1365 * - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1366 * - video - file that can be imported as video in text editor
1367 * - audio - file that can be imported as audio in text editor
1368 * - archive - we can extract files from this archive
1369 * - spreadsheet - used for portfolio format
1370 * - document - used for portfolio format
1371 * - presentation - used for portfolio format
1372 * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1373 * human-readable description for this filetype;
1374 * Function {@link get_mimetype_description()} first looks at the presence of string for
1375 * particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1376 * attribute, if not found returns the value of 'type';
1377 * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1378 * an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1379 * this function will return first found icon; Especially usefull for types such as 'text/plain'
1382 * @return array List of information about file types based on extensions.
1383 * Associative array of extension (lower-case) to associative array
1384 * from 'element name' to data. Current element names are 'type' and 'icon'.
1385 * Unknown types should use the 'xxx' entry which includes defaults.
1387 function &get_mimetypes_array() {
1388 static $mimearray = array (
1389 'xxx' => array ('type'=>'document/unknown', 'icon'=>'unknown'),
1390 '3gp' => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1391 'aac' => array ('type'=>'audio/aac', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1392 'accdb' => array ('type'=>'application/msaccess', 'icon'=>'base'),
1393 'ai' => array ('type'=>'application/postscript', 'icon'=>'eps', 'groups'=>array('image'), 'string'=>'image'),
1394 'aif' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1395 'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1396 'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1397 'applescript' => array ('type'=>'text/plain', 'icon'=>'text'),
1398 'asc' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1399 'asm' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1400 'au' => array ('type'=>'audio/au', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1401 'avi' => array ('type'=>'video/x-ms-wm', 'icon'=>'avi', 'groups'=>array('video','web_video'), 'string'=>'video'),
1402 'bmp' => array ('type'=>'image/bmp', 'icon'=>'bmp', 'groups'=>array('image'), 'string'=>'image'),
1403 'c' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1404 'cct' => array ('type'=>'shockwave/director', 'icon'=>'flash'),
1405 'cpp' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1406 'cs' => array ('type'=>'application/x-csh', 'icon'=>'sourcecode'),
1407 'css' => array ('type'=>'text/css', 'icon'=>'text', 'groups'=>array('web_file')),
1408 'csv' => array ('type'=>'text/csv', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1409 'dv' => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1410 'dmg' => array ('type'=>'application/octet-stream', 'icon'=>'unknown'),
1412 'doc' => array ('type'=>'application/msword', 'icon'=>'document', 'groups'=>array('document')),
1413 'docx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'icon'=>'document', 'groups'=>array('document')),
1414 'docm' => array ('type'=>'application/vnd.ms-word.document.macroEnabled.12', 'icon'=>'document'),
1415 'dotx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'icon'=>'document'),
1416 'dotm' => array ('type'=>'application/vnd.ms-word.template.macroEnabled.12', 'icon'=>'document'),
1418 'dcr' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1419 'dif' => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1420 'dir' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1421 'dxr' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1422 'eps' => array ('type'=>'application/postscript', 'icon'=>'eps'),
1423 'epub' => array ('type'=>'application/epub+zip', 'icon'=>'epub', 'groups'=>array('document')),
1424 'fdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1425 'flv' => array ('type'=>'video/x-flv', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1426 'f4v' => array ('type'=>'video/mp4', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1428 'gallery' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1429 'galleryitem' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1430 'gallerycollection' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1431 'gif' => array ('type'=>'image/gif', 'icon'=>'gif', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1432 'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1433 'tgz' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1434 'gz' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1435 'gzip' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1436 'h' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1437 'hpp' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1438 'hqx' => array ('type'=>'application/mac-binhex40', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1439 'htc' => array ('type'=>'text/x-component', 'icon'=>'markup'),
1440 'html' => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1441 'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'html', 'groups'=>array('web_file')),
1442 'htm' => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1443 'ico' => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1444 'ics' => array ('type'=>'text/calendar', 'icon'=>'text'),
1445 'isf' => array ('type'=>'application/inspiration', 'icon'=>'isf'),
1446 'ist' => array ('type'=>'application/inspiration.template', 'icon'=>'isf'),
1447 'java' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1448 'jar' => array ('type'=>'application/java-archive', 'icon' => 'archive'),
1449 'jcb' => array ('type'=>'text/xml', 'icon'=>'markup'),
1450 'jcl' => array ('type'=>'text/xml', 'icon'=>'markup'),
1451 'jcw' => array ('type'=>'text/xml', 'icon'=>'markup'),
1452 'jmt' => array ('type'=>'text/xml', 'icon'=>'markup'),
1453 'jmx' => array ('type'=>'text/xml', 'icon'=>'markup'),
1454 'jnlp' => array ('type'=>'application/x-java-jnlp-file', 'icon'=>'markup'),
1455 'jpe' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1456 'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1457 'jpg' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1458 'jqz' => array ('type'=>'text/xml', 'icon'=>'markup'),
1459 'js' => array ('type'=>'application/x-javascript', 'icon'=>'text', 'groups'=>array('web_file')),
1460 'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text'),
1461 'm' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1462 'mbz' => array ('type'=>'application/vnd.moodle.backup', 'icon'=>'moodle'),
1463 'mdb' => array ('type'=>'application/x-msaccess', 'icon'=>'base'),
1464 'mht' => array ('type'=>'message/rfc822', 'icon'=>'archive'),
1465 'mhtml'=> array ('type'=>'message/rfc822', 'icon'=>'archive'),
1466 'mov' => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1467 'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1468 'm3u' => array ('type'=>'audio/x-mpegurl', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1469 'mp3' => array ('type'=>'audio/mp3', 'icon'=>'mp3', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1470 'mp4' => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1471 'm4v' => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1472 'm4a' => array ('type'=>'audio/mp4', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1473 'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1474 'mpe' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1475 'mpg' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1476 'mpr' => array ('type'=>'application/vnd.moodle.profiling', 'icon'=>'moodle'),
1478 'nbk' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1479 'notebook' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1481 'odt' => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'writer', 'groups'=>array('document')),
1482 'ott' => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'writer', 'groups'=>array('document')),
1483 'oth' => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'oth', 'groups'=>array('document')),
1484 'odm' => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'writer'),
1485 'odg' => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'draw'),
1486 'otg' => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'draw'),
1487 'odp' => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'impress'),
1488 'otp' => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'impress'),
1489 'ods' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1490 'ots' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1491 'odc' => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'chart'),
1492 'odf' => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'math'),
1493 'odb' => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'base'),
1494 'odi' => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'draw'),
1495 'oga' => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1496 'ogg' => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1497 'ogv' => array ('type'=>'video/ogg', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1499 'pct' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1500 'pdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1501 'php' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1502 'pic' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1503 'pict' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1504 'png' => array ('type'=>'image/png', 'icon'=>'png', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1506 'pps' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1507 'ppt' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1508 'pptx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'icon'=>'powerpoint'),
1509 'pptm' => array ('type'=>'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 'icon'=>'powerpoint'),
1510 'potx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.template', 'icon'=>'powerpoint'),
1511 'potm' => array ('type'=>'application/vnd.ms-powerpoint.template.macroEnabled.12', 'icon'=>'powerpoint'),
1512 'ppam' => array ('type'=>'application/vnd.ms-powerpoint.addin.macroEnabled.12', 'icon'=>'powerpoint'),
1513 'ppsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'icon'=>'powerpoint'),
1514 'ppsm' => array ('type'=>'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 'icon'=>'powerpoint'),
1516 'ps' => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1517 'qt' => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1518 'ra' => array ('type'=>'audio/x-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1519 'ram' => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1520 'rhb' => array ('type'=>'text/xml', 'icon'=>'markup'),
1521 'rm' => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1522 'rmvb' => array ('type'=>'application/vnd.rn-realmedia-vbr', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1523 'rtf' => array ('type'=>'text/rtf', 'icon'=>'text', 'groups'=>array('document')),
1524 'rtx' => array ('type'=>'text/richtext', 'icon'=>'text'),
1525 'rv' => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('video'), 'string'=>'video'),
1526 'sh' => array ('type'=>'application/x-sh', 'icon'=>'sourcecode'),
1527 'sit' => array ('type'=>'application/x-stuffit', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1528 'smi' => array ('type'=>'application/smil', 'icon'=>'text'),
1529 'smil' => array ('type'=>'application/smil', 'icon'=>'text'),
1530 'sqt' => array ('type'=>'text/xml', 'icon'=>'markup'),
1531 'svg' => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1532 'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1533 'swa' => array ('type'=>'application/x-director', 'icon'=>'flash'),
1534 'swf' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1535 'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1537 'sxw' => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'writer'),
1538 'stw' => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'writer'),
1539 'sxc' => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'calc'),
1540 'stc' => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'calc'),
1541 'sxd' => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'draw'),
1542 'std' => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'draw'),
1543 'sxi' => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'impress'),
1544 'sti' => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'impress'),
1545 'sxg' => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'writer'),
1546 'sxm' => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'math'),
1548 'tar' => array ('type'=>'application/x-tar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1549 'tif' => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1550 'tiff' => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1551 'tex' => array ('type'=>'application/x-tex', 'icon'=>'text'),
1552 'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1553 'texinfo' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1554 'tsv' => array ('type'=>'text/tab-separated-values', 'icon'=>'text'),
1555 'txt' => array ('type'=>'text/plain', 'icon'=>'text', 'defaulticon'=>true),
1556 'wav' => array ('type'=>'audio/wav', 'icon'=>'wav', 'groups'=>array('audio'), 'string'=>'audio'),
1557 'webm' => array ('type'=>'video/webm', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1558 'wmv' => array ('type'=>'video/x-ms-wmv', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1559 'asf' => array ('type'=>'video/x-ms-asf', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1561 'xbk' => array ('type'=>'application/x-smarttech-notebook', 'icon'=>'archive'),
1562 'xdp' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1563 'xfd' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1564 'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1566 'xls' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1567 'xlsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'icon'=>'spreadsheet'),
1568 'xlsm' => array ('type'=>'application/vnd.ms-excel.sheet.macroEnabled.12', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1569 'xltx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'icon'=>'spreadsheet'),
1570 'xltm' => array ('type'=>'application/vnd.ms-excel.template.macroEnabled.12', 'icon'=>'spreadsheet'),
1571 'xlsb' => array ('type'=>'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 'icon'=>'spreadsheet'),
1572 'xlam' => array ('type'=>'application/vnd.ms-excel.addin.macroEnabled.12', 'icon'=>'spreadsheet'),
1574 'xml' => array ('type'=>'application/xml', 'icon'=>'markup'),
1575 'xsl' => array ('type'=>'text/xml', 'icon'=>'markup'),
1577 'zip' => array ('type'=>'application/zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive')
1583 * Obtains information about a filetype based on its extension. Will
1584 * use a default if no information is present about that particular
1588 * @param string $element Desired information (usually 'icon'
1589 * for icon filename or 'type' for MIME type. Can also be
1590 * 'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1591 * @param string $filename Filename we're looking up
1592 * @return string Requested piece of information from array
1594 function mimeinfo($element, $filename) {
1596 $mimeinfo = & get_mimetypes_array();
1597 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1599 $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1600 if (empty($filetype)) {
1601 $filetype = 'xxx'; // file without extension
1603 if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1604 $iconsize = max(array(16, (int)$iconsizematch[1]));
1605 $filenames = array($mimeinfo['xxx']['icon']);
1606 if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1607 array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1609 // find the file with the closest size, first search for specific icon then for default icon
1610 foreach ($filenames as $filename) {
1611 foreach ($iconpostfixes as $size => $postfix) {
1612 $fullname = $CFG->dirroot
.'/pix/f/'.$filename.$postfix;
1613 if ($iconsize >= $size && (file_exists($fullname.'.png') ||
file_exists($fullname.'.gif'))) {
1614 return $filename.$postfix;
1618 } else if (isset($mimeinfo[$filetype][$element])) {
1619 return $mimeinfo[$filetype][$element];
1620 } else if (isset($mimeinfo['xxx'][$element])) {
1621 return $mimeinfo['xxx'][$element]; // By default
1628 * Obtains information about a filetype based on the MIME type rather than
1629 * the other way around.
1632 * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1633 * @param string $mimetype MIME type we're looking up
1634 * @return string Requested piece of information from array
1636 function mimeinfo_from_type($element, $mimetype) {
1637 /* array of cached mimetype->extension associations */
1638 static $cached = array();
1639 $mimeinfo = & get_mimetypes_array();
1641 if (!array_key_exists($mimetype, $cached)) {
1642 $cached[$mimetype] = null;
1643 foreach($mimeinfo as $filetype => $values) {
1644 if ($values['type'] == $mimetype) {
1645 if ($cached[$mimetype] === null) {
1646 $cached[$mimetype] = '.'.$filetype;
1648 if (!empty($values['defaulticon'])) {
1649 $cached[$mimetype] = '.'.$filetype;
1654 if (empty($cached[$mimetype])) {
1655 $cached[$mimetype] = '.xxx';
1658 if ($element === 'extension') {
1659 return $cached[$mimetype];
1661 return mimeinfo($element, $cached[$mimetype]);
1666 * Return the relative icon path for a given file
1670 * // $file - instance of stored_file or file_info
1671 * $icon = $OUTPUT->pix_url(file_file_icon($file))->out();
1672 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1676 * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1679 * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1680 * and $file->mimetype are expected)
1681 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1684 function file_file_icon($file, $size = null) {
1685 if (!is_object($file)) {
1686 $file = (object)$file;
1688 if (isset($file->filename
)) {
1689 $filename = $file->filename
;
1690 } else if (method_exists($file, 'get_filename')) {
1691 $filename = $file->get_filename();
1692 } else if (method_exists($file, 'get_visible_name')) {
1693 $filename = $file->get_visible_name();
1697 if (isset($file->mimetype
)) {
1698 $mimetype = $file->mimetype
;
1699 } else if (method_exists($file, 'get_mimetype')) {
1700 $mimetype = $file->get_mimetype();
1704 $mimetypes = &get_mimetypes_array();
1706 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1707 if ($extension && !empty($mimetypes[$extension])) {
1708 // if file name has known extension, return icon for this extension
1709 return file_extension_icon($filename, $size);
1712 return file_mimetype_icon($mimetype, $size);
1716 * Return the relative icon path for a folder image
1720 * $icon = $OUTPUT->pix_url(file_folder_icon())->out();
1721 * echo html_writer::empty_tag('img', array('src' => $icon));
1725 * echo $OUTPUT->pix_icon(file_folder_icon(32));
1728 * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1731 function file_folder_icon($iconsize = null) {
1733 static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1734 static $cached = array();
1735 $iconsize = max(array(16, (int)$iconsize));
1736 if (!array_key_exists($iconsize, $cached)) {
1737 foreach ($iconpostfixes as $size => $postfix) {
1738 $fullname = $CFG->dirroot
.'/pix/f/folder'.$postfix;
1739 if ($iconsize >= $size && (file_exists($fullname.'.png') ||
file_exists($fullname.'.gif'))) {
1740 $cached[$iconsize] = 'f/folder'.$postfix;
1745 return $cached[$iconsize];
1749 * Returns the relative icon path for a given mime type
1751 * This function should be used in conjunction with $OUTPUT->pix_url to produce
1752 * a return the full path to an icon.
1755 * $mimetype = 'image/jpg';
1756 * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype))->out();
1757 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1761 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1762 * to conform with that.
1763 * @param string $mimetype The mimetype to fetch an icon for
1764 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1765 * @return string The relative path to the icon
1767 function file_mimetype_icon($mimetype, $size = NULL) {
1768 return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1772 * Returns the relative icon path for a given file name
1774 * This function should be used in conjunction with $OUTPUT->pix_url to produce
1775 * a return the full path to an icon.
1778 * $filename = '.jpg';
1779 * $icon = $OUTPUT->pix_url(file_extension_icon($filename))->out();
1780 * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1783 * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1784 * to conform with that.
1785 * @todo MDL-31074 Implement $size
1787 * @param string $filename The filename to get the icon for
1788 * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1791 function file_extension_icon($filename, $size = NULL) {
1792 return 'f/'.mimeinfo('icon'.$size, $filename);
1796 * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1797 * mimetypes.php language file.
1799 * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1800 * 'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1801 * have filename); In case of array/stdClass the field 'mimetype' is optional.
1802 * @param bool $capitalise If true, capitalises first character of result
1803 * @return string Text description
1805 function get_mimetype_description($obj, $capitalise=false) {
1806 $filename = $mimetype = '';
1807 if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1808 // this is an instance of stored_file
1809 $mimetype = $obj->get_mimetype();
1810 $filename = $obj->get_filename();
1811 } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1812 // this is an instance of file_info
1813 $mimetype = $obj->get_mimetype();
1814 $filename = $obj->get_visible_name();
1815 } else if (is_array($obj) ||
is_object ($obj)) {
1817 if (!empty($obj['filename'])) {
1818 $filename = $obj['filename'];
1820 if (!empty($obj['mimetype'])) {
1821 $mimetype = $obj['mimetype'];
1826 $mimetypefromext = mimeinfo('type', $filename);
1827 if (empty($mimetype) ||
$mimetypefromext !== 'document/unknown') {
1828 // if file has a known extension, overwrite the specified mimetype
1829 $mimetype = $mimetypefromext;
1831 $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION
));
1832 if (empty($extension)) {
1833 $mimetypestr = mimeinfo_from_type('string', $mimetype);
1834 $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1836 $mimetypestr = mimeinfo('string', $filename);
1838 $chunks = explode('/', $mimetype, 2);
1841 'mimetype' => $mimetype,
1842 'ext' => $extension,
1843 'mimetype1' => $chunks[0],
1844 'mimetype2' => $chunks[1],
1847 foreach ($attr as $key => $value) {
1849 $a[strtoupper($key)] = strtoupper($value);
1850 $a[ucfirst($key)] = ucfirst($value);
1853 // MIME types may include + symbol but this is not permitted in string ids.
1854 $safemimetype = str_replace('+', '_', $mimetype);
1855 $safemimetypestr = str_replace('+', '_', $mimetypestr);
1856 if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
1857 $result = get_string($safemimetype, 'mimetypes', (object)$a);
1858 } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
1859 $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
1860 } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1861 $result = get_string('default', 'mimetypes', (object)$a);
1863 $result = $mimetype;
1866 $result=ucfirst($result);
1872 * Returns array of elements of type $element in type group(s)
1874 * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1875 * @param string|array $groups one group or array of groups/extensions/mimetypes
1878 function file_get_typegroup($element, $groups) {
1879 static $cached = array();
1880 if (!is_array($groups)) {
1881 $groups = array($groups);
1883 if (!array_key_exists($element, $cached)) {
1884 $cached[$element] = array();
1887 foreach ($groups as $group) {
1888 if (!array_key_exists($group, $cached[$element])) {
1889 // retrieive and cache all elements of type $element for group $group
1890 $mimeinfo = & get_mimetypes_array();
1891 $cached[$element][$group] = array();
1892 foreach ($mimeinfo as $extension => $value) {
1893 $value['extension'] = '.'.$extension;
1894 if (empty($value[$element])) {
1897 if (($group === '.'.$extension ||
$group === $value['type'] ||
1898 (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1899 !in_array($value[$element], $cached[$element][$group])) {
1900 $cached[$element][$group][] = $value[$element];
1904 $result = array_merge($result, $cached[$element][$group]);
1906 return array_values(array_unique($result));
1910 * Checks if file with name $filename has one of the extensions in groups $groups
1912 * @see get_mimetypes_array()
1913 * @param string $filename name of the file to check
1914 * @param string|array $groups one group or array of groups to check
1915 * @param bool $checktype if true and extension check fails, find the mimetype and check if
1916 * file mimetype is in mimetypes in groups $groups
1919 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
1920 $extension = pathinfo($filename, PATHINFO_EXTENSION
);
1921 if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
1924 return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
1928 * Checks if mimetype $mimetype belongs to one of the groups $groups
1930 * @see get_mimetypes_array()
1931 * @param string $mimetype
1932 * @param string|array $groups one group or array of groups to check
1935 function file_mimetype_in_typegroup($mimetype, $groups) {
1936 return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
1940 * Requested file is not found or not accessible, does not return, terminates script
1942 * @global stdClass $CFG
1943 * @global stdClass $COURSE
1945 function send_file_not_found() {
1946 global $CFG, $COURSE;
1948 print_error('filenotfound', 'error', $CFG->wwwroot
.'/course/view.php?id='.$COURSE->id
); //this is not displayed on IIS??
1951 * Helper function to send correct 404 for server.
1953 function send_header_404() {
1954 if (substr(php_sapi_name(), 0, 3) == 'cgi') {
1955 header("Status: 404 Not Found");
1957 header('HTTP/1.0 404 not found');
1962 * The readfile function can fail when files are larger than 2GB (even on 64-bit
1963 * platforms). This wrapper uses readfile for small files and custom code for
1966 * @param string $path Path to file
1967 * @param int $filesize Size of file (if left out, will get it automatically)
1968 * @return int|bool Size read (will always be $filesize) or false if failed
1970 function readfile_allow_large($path, $filesize = -1) {
1971 // Automatically get size if not specified.
1972 if ($filesize === -1) {
1973 $filesize = filesize($path);
1975 if ($filesize <= 2147483647) {
1976 // If the file is up to 2^31 - 1, send it normally using readfile.
1977 return readfile($path);
1979 // For large files, read and output in 64KB chunks.
1980 $handle = fopen($path, 'r');
1981 if ($handle === false) {
1986 $size = min($left, 65536);
1987 $buffer = fread($handle, $size);
1988 if ($buffer === false) {
1999 * Enhanced readfile() with optional acceleration.
2000 * @param string|stored_file $file
2001 * @param string $mimetype
2002 * @param bool $accelerate
2005 function readfile_accel($file, $mimetype, $accelerate) {
2008 if ($mimetype === 'text/plain') {
2009 // there is no encoding specified in text files, we need something consistent
2010 header('Content-Type: text/plain; charset=utf-8');
2012 header('Content-Type: '.$mimetype);
2015 $lastmodified = is_object($file) ?
$file->get_timemodified() : filemtime($file);
2016 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2018 if (is_object($file)) {
2019 header('Etag: "' . $file->get_contenthash() . '"');
2020 if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and trim($_SERVER['HTTP_IF_NONE_MATCH'], '"') === $file->get_contenthash()) {
2021 header('HTTP/1.1 304 Not Modified');
2026 // if etag present for stored file rely on it exclusively
2027 if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
2028 // get unixtime of request header; clip extra junk off first
2029 $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
2030 if ($since && $since >= $lastmodified) {
2031 header('HTTP/1.1 304 Not Modified');
2036 if ($accelerate and !empty($CFG->xsendfile
)) {
2037 if (empty($CFG->disablebyteserving
) and $mimetype !== 'text/plain') {
2038 header('Accept-Ranges: bytes');
2040 header('Accept-Ranges: none');
2043 if (is_object($file)) {
2044 $fs = get_file_storage();
2045 if ($fs->xsendfile($file->get_contenthash())) {
2050 require_once("$CFG->libdir/xsendfilelib.php");
2051 if (xsendfile($file)) {
2057 $filesize = is_object($file) ?
$file->get_filesize() : filesize($file);
2059 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2061 if ($accelerate and empty($CFG->disablebyteserving
) and $mimetype !== 'text/plain') {
2062 header('Accept-Ranges: bytes');
2064 if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
2065 // byteserving stuff - for acrobat reader and download accelerators
2066 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
2067 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
2069 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER
)) {
2070 foreach ($ranges as $key=>$value) {
2071 if ($ranges[$key][1] == '') {
2073 $ranges[$key][1] = $filesize - $ranges[$key][2];
2074 $ranges[$key][2] = $filesize - 1;
2075 } else if ($ranges[$key][2] == '' ||
$ranges[$key][2] > $filesize - 1) {
2077 $ranges[$key][2] = $filesize - 1;
2079 if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
2080 //invalid byte-range ==> ignore header
2084 //prepare multipart header
2085 $ranges[$key][0] = "\r\n--".BYTESERVING_BOUNDARY
."\r\nContent-Type: $mimetype\r\n";
2086 $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
2092 if (is_object($file)) {
2093 $handle = $file->get_content_file_handle();
2095 $handle = fopen($file, 'rb');
2097 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
2102 header('Accept-Ranges: none');
2105 header('Content-Length: '.$filesize);
2107 if ($filesize > 10000000) {
2108 // for large files try to flush and close all buffers to conserve memory
2109 while(@ob_get_level
()) {
2110 if (!@ob_end_flush
()) {
2116 // send the whole file content
2117 if (is_object($file)) {
2120 readfile_allow_large($file, $filesize);
2125 * Similar to readfile_accel() but designed for strings.
2126 * @param string $string
2127 * @param string $mimetype
2128 * @param bool $accelerate
2131 function readstring_accel($string, $mimetype, $accelerate) {
2134 if ($mimetype === 'text/plain') {
2135 // there is no encoding specified in text files, we need something consistent
2136 header('Content-Type: text/plain; charset=utf-8');
2138 header('Content-Type: '.$mimetype);
2140 header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2141 header('Accept-Ranges: none');
2143 if ($accelerate and !empty($CFG->xsendfile
)) {
2144 $fs = get_file_storage();
2145 if ($fs->xsendfile(sha1($string))) {
2150 header('Content-Length: '.strlen($string));
2155 * Handles the sending of temporary file to user, download is forced.
2156 * File is deleted after abort or successful sending, does not return, script terminated
2158 * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2159 * @param string $filename proposed file name when saving file
2160 * @param bool $pathisstring If the path is string
2162 function send_temp_file($path, $filename, $pathisstring=false) {
2165 if (core_useragent
::is_firefox()) {
2166 // only FF is known to correctly save to disk before opening...
2167 $mimetype = mimeinfo('type', $filename);
2169 $mimetype = 'application/x-forcedownload';
2172 // close session - not needed anymore
2173 \core\session\manager
::write_close();
2175 if (!$pathisstring) {
2176 if (!file_exists($path)) {
2178 print_error('filenotfound', 'error', $CFG->wwwroot
.'/');
2180 // executed after normal finish or abort
2181 core_shutdown_manager
::register_function('send_temp_file_finished', array($path));
2184 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2185 if (core_useragent
::is_ie()) {
2186 $filename = urlencode($filename);
2189 header('Content-Disposition: attachment; filename="'.$filename.'"');
2190 if (strpos($CFG->wwwroot
, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2191 header('Cache-Control: private, max-age=10');
2192 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2194 } else { //normal http - prevent caching at all cost
2195 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2196 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2197 header('Pragma: no-cache');
2200 // send the contents - we can not accelerate this because the file will be deleted asap
2201 if ($pathisstring) {
2202 readstring_accel($path, $mimetype, false);
2204 readfile_accel($path, $mimetype, false);
2208 die; //no more chars to output
2212 * Internal callback function used by send_temp_file()
2214 * @param string $path
2216 function send_temp_file_finished($path) {
2217 if (file_exists($path)) {
2223 * Handles the sending of file data to the user's browser, including support for
2227 * @param string $path Path of file on disk (including real filename), or actual content of file as string
2228 * @param string $filename Filename to send
2229 * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2230 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2231 * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
2232 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2233 * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2234 * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2235 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2236 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2237 * and should not be reopened.
2238 * @return null script execution stopped unless $dontdie is true
2240 function send_file($path, $filename, $lifetime = null , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
2241 global $CFG, $COURSE;
2244 ignore_user_abort(true);
2247 if ($lifetime === 'default' or is_null($lifetime)) {
2248 $lifetime = $CFG->filelifetime
;
2251 \core\session\manager
::write_close(); // Unlock session during file serving.
2253 // Use given MIME type if specified, otherwise guess it using mimeinfo.
2254 // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2255 // only Firefox saves all files locally before opening when content-disposition: attachment stated
2256 $isFF = core_useragent
::is_firefox(); // only FF properly tested
2257 $mimetype = ($forcedownload and !$isFF) ?
'application/x-forcedownload' :
2258 ($mimetype ?
$mimetype : mimeinfo('type', $filename));
2260 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2261 if (core_useragent
::is_ie()) {
2262 $filename = rawurlencode($filename);
2265 if ($forcedownload) {
2266 header('Content-Disposition: attachment; filename="'.$filename.'"');
2268 header('Content-Disposition: inline; filename="'.$filename.'"');
2271 if ($lifetime > 0) {
2273 if (isloggedin() and !isguestuser()) {
2274 $private = ' private,';
2276 $nobyteserving = false;
2277 header('Cache-Control:'.$private.' max-age='.$lifetime);
2278 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
$lifetime) .' GMT');
2281 } else { // Do not cache files in proxies and browsers
2282 $nobyteserving = true;
2283 if (strpos($CFG->wwwroot
, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2284 header('Cache-Control: private, max-age=10');
2285 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2287 } else { //normal http - prevent caching at all cost
2288 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2289 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2290 header('Pragma: no-cache');
2294 if (empty($filter)) {
2295 // send the contents
2296 if ($pathisstring) {
2297 readstring_accel($path, $mimetype, !$dontdie);
2299 readfile_accel($path, $mimetype, !$dontdie);
2303 // Try to put the file through filters
2304 if ($mimetype == 'text/html') {
2305 $options = new stdClass();
2306 $options->noclean
= true;
2307 $options->nocache
= true; // temporary workaround for MDL-5136
2308 $text = $pathisstring ?
$path : implode('', file($path));
2310 $text = file_modify_html_header($text);
2311 $output = format_text($text, FORMAT_HTML
, $options, $COURSE->id
);
2313 readstring_accel($output, $mimetype, false);
2315 } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2316 // only filter text if filter all files is selected
2317 $options = new stdClass();
2318 $options->newlines
= false;
2319 $options->noclean
= true;
2320 $text = htmlentities($pathisstring ?
$path : implode('', file($path)), ENT_QUOTES
, 'UTF-8');
2321 $output = '<pre>'. format_text($text, FORMAT_MOODLE
, $options, $COURSE->id
) .'</pre>';
2323 readstring_accel($output, $mimetype, false);
2326 // send the contents
2327 if ($pathisstring) {
2328 readstring_accel($path, $mimetype, !$dontdie);
2330 readfile_accel($path, $mimetype, !$dontdie);
2337 die; //no more chars to output!!!
2341 * Handles the sending of file data to the user's browser, including support for
2344 * The $options parameter supports the following keys:
2345 * (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2346 * (string|null) filename - overrides the implicit filename
2347 * (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2348 * if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
2349 * you must detect this case when control is returned using connection_aborted. Please not that session is closed
2350 * and should not be reopened.
2353 * @param stored_file $stored_file local file object
2354 * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
2355 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2356 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2357 * @param array $options additional options affecting the file serving
2358 * @return null script execution stopped unless $options['dontdie'] is true
2360 function send_stored_file($stored_file, $lifetime=null, $filter=0, $forcedownload=false, array $options=array()) {
2361 global $CFG, $COURSE;
2363 if (empty($options['filename'])) {
2366 $filename = $options['filename'];
2369 if (empty($options['dontdie'])) {
2375 if ($lifetime === 'default' or is_null($lifetime)) {
2376 $lifetime = $CFG->filelifetime
;
2379 if (!empty($options['preview'])) {
2380 // replace the file with its preview
2381 $fs = get_file_storage();
2382 $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2383 if (!$preview_file) {
2384 // unable to create a preview of the file, send its default mime icon instead
2385 if ($options['preview'] === 'tinyicon') {
2387 } else if ($options['preview'] === 'thumb') {
2392 $fileicon = file_file_icon($stored_file, $size);
2393 send_file($CFG->dirroot
.'/pix/'.$fileicon.'.png', basename($fileicon).'.png');
2395 // preview images have fixed cache lifetime and they ignore forced download
2396 // (they are generated by GD and therefore they are considered reasonably safe).
2397 $stored_file = $preview_file;
2398 $lifetime = DAYSECS
;
2400 $forcedownload = false;
2404 // handle external resource
2405 if ($stored_file && $stored_file->is_external_file() && !isset($options['sendcachedexternalfile'])) {
2406 $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2410 if (!$stored_file or $stored_file->is_directory()) {
2419 ignore_user_abort(true);
2422 \core\session\manager
::write_close(); // Unlock session during file serving.
2424 // Use given MIME type if specified, otherwise guess it using mimeinfo.
2425 // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2426 // only Firefox saves all files locally before opening when content-disposition: attachment stated
2427 $filename = is_null($filename) ?
$stored_file->get_filename() : $filename;
2428 $isFF = core_useragent
::is_firefox(); // only FF properly tested
2429 $mimetype = ($forcedownload and !$isFF) ?
'application/x-forcedownload' :
2430 ($stored_file->get_mimetype() ?
$stored_file->get_mimetype() : mimeinfo('type', $filename));
2432 // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2433 if (core_useragent
::is_ie()) {
2434 $filename = rawurlencode($filename);
2437 if ($forcedownload) {
2438 header('Content-Disposition: attachment; filename="'.$filename.'"');
2440 header('Content-Disposition: inline; filename="'.$filename.'"');
2443 if ($lifetime > 0) {
2445 if (isloggedin() and !isguestuser()) {
2446 $private = ' private,';
2448 header('Cache-Control:'.$private.' max-age='.$lifetime);
2449 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
$lifetime) .' GMT');
2452 } else { // Do not cache files in proxies and browsers
2453 if (strpos($CFG->wwwroot
, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2454 header('Cache-Control: private, max-age=10');
2455 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2457 } else { //normal http - prevent caching at all cost
2458 header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2459 header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2460 header('Pragma: no-cache');
2464 if (empty($filter)) {
2465 // send the contents
2466 readfile_accel($stored_file, $mimetype, !$dontdie);
2468 } else { // Try to put the file through filters
2469 if ($mimetype == 'text/html') {
2470 $options = new stdClass();
2471 $options->noclean
= true;
2472 $options->nocache
= true; // temporary workaround for MDL-5136
2473 $text = $stored_file->get_content();
2474 $text = file_modify_html_header($text);
2475 $output = format_text($text, FORMAT_HTML
, $options, $COURSE->id
);
2477 readstring_accel($output, $mimetype, false);
2479 } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2480 // only filter text if filter all files is selected
2481 $options = new stdClass();
2482 $options->newlines
= false;
2483 $options->noclean
= true;
2484 $text = $stored_file->get_content();
2485 $output = '<pre>'. format_text($text, FORMAT_MOODLE
, $options, $COURSE->id
) .'</pre>';
2487 readstring_accel($output, $mimetype, false);
2489 } else { // Just send it out raw
2490 readfile_accel($stored_file, $mimetype, !$dontdie);
2496 die; //no more chars to output!!!
2500 * Retrieves an array of records from a CSV file and places
2501 * them into a given table structure
2503 * @global stdClass $CFG
2504 * @global moodle_database $DB
2505 * @param string $file The path to a CSV file
2506 * @param string $table The table to retrieve columns from
2507 * @return bool|array Returns an array of CSV records or false
2509 function get_records_csv($file, $table) {
2512 if (!$metacolumns = $DB->get_columns($table)) {
2516 if(!($handle = @fopen
($file, 'r'))) {
2517 print_error('get_records_csv failed to open '.$file);
2520 $fieldnames = fgetcsv($handle, 4096);
2521 if(empty($fieldnames)) {
2528 foreach($metacolumns as $metacolumn) {
2529 $ord = array_search($metacolumn->name
, $fieldnames);
2531 $columns[$metacolumn->name
] = $ord;
2537 while (($data = fgetcsv($handle, 4096)) !== false) {
2538 $item = new stdClass
;
2539 foreach($columns as $name => $ord) {
2540 $item->$name = $data[$ord];
2550 * Create a file with CSV contents
2552 * @global stdClass $CFG
2553 * @global moodle_database $DB
2554 * @param string $file The file to put the CSV content into
2555 * @param array $records An array of records to write to a CSV file
2556 * @param string $table The table to get columns from
2557 * @return bool success
2559 function put_records_csv($file, $records, $table = NULL) {
2562 if (empty($records)) {
2566 $metacolumns = NULL;
2567 if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2573 if(!($fp = @fopen
($CFG->tempdir
.'/'.$file, 'w'))) {
2574 print_error('put_records_csv failed to open '.$file);
2577 $proto = reset($records);
2578 if(is_object($proto)) {
2579 $fields_records = array_keys(get_object_vars($proto));
2581 else if(is_array($proto)) {
2582 $fields_records = array_keys($proto);
2589 if(!empty($metacolumns)) {
2590 $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2591 $fields = array_intersect($fields_records, $fields_table);
2594 $fields = $fields_records;
2597 fwrite($fp, implode(',', $fields));
2598 fwrite($fp, "\r\n");
2600 foreach($records as $record) {
2601 $array = (array)$record;
2603 foreach($fields as $field) {
2604 if(strpos($array[$field], ',')) {
2605 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2608 $values[] = $array[$field];
2611 fwrite($fp, implode(',', $values)."\r\n");
2615 @chmod
($CFG->tempdir
.'/'.$file, $CFG->filepermissions
);
2621 * Recursively delete the file or folder with path $location. That is,
2622 * if it is a file delete it. If it is a folder, delete all its content
2623 * then delete it. If $location does not exist to start, that is not
2624 * considered an error.
2626 * @param string $location the path to remove.
2629 function fulldelete($location) {
2630 if (empty($location)) {
2631 // extra safety against wrong param
2634 if (is_dir($location)) {
2635 if (!$currdir = opendir($location)) {
2638 while (false !== ($file = readdir($currdir))) {
2639 if ($file <> ".." && $file <> ".") {
2640 $fullfile = $location."/".$file;
2641 if (is_dir($fullfile)) {
2642 if (!fulldelete($fullfile)) {
2646 if (!unlink($fullfile)) {
2653 if (! rmdir($location)) {
2657 } else if (file_exists($location)) {
2658 if (!unlink($location)) {
2666 * Send requested byterange of file.
2668 * @param resource $handle A file handle
2669 * @param string $mimetype The mimetype for the output
2670 * @param array $ranges An array of ranges to send
2671 * @param string $filesize The size of the content if only one range is used
2673 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2674 // better turn off any kind of compression and buffering
2675 @ini_set
('zlib.output_compression', 'Off');
2677 $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2678 if ($handle === false) {
2681 if (count($ranges) == 1) { //only one range requested
2682 $length = $ranges[0][2] - $ranges[0][1] +
1;
2683 header('HTTP/1.1 206 Partial content');
2684 header('Content-Length: '.$length);
2685 header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2686 header('Content-Type: '.$mimetype);
2688 while(@ob_get_level
()) {
2689 if (!@ob_end_flush
()) {
2694 fseek($handle, $ranges[0][1]);
2695 while (!feof($handle) && $length > 0) {
2696 @set_time_limit
(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2697 $buffer = fread($handle, ($chunksize < $length ?
$chunksize : $length));
2700 $length -= strlen($buffer);
2704 } else { // multiple ranges requested - not tested much
2706 foreach($ranges as $range) {
2707 $totallength +
= strlen($range[0]) +
$range[2] - $range[1] +
1;
2709 $totallength +
= strlen("\r\n--".BYTESERVING_BOUNDARY
."--\r\n");
2710 header('HTTP/1.1 206 Partial content');
2711 header('Content-Length: '.$totallength);
2712 header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY
);
2714 while(@ob_get_level
()) {
2715 if (!@ob_end_flush
()) {
2720 foreach($ranges as $range) {
2721 $length = $range[2] - $range[1] +
1;
2723 fseek($handle, $range[1]);
2724 while (!feof($handle) && $length > 0) {
2725 @set_time_limit
(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2726 $buffer = fread($handle, ($chunksize < $length ?
$chunksize : $length));
2729 $length -= strlen($buffer);
2732 echo "\r\n--".BYTESERVING_BOUNDARY
."--\r\n";
2739 * add includes (js and css) into uploaded files
2740 * before returning them, useful for themes and utf.js includes
2742 * @global stdClass $CFG
2743 * @param string $text text to search and replace
2744 * @return string text with added head includes
2747 function file_modify_html_header($text) {
2748 // first look for <head> tag
2751 $stylesheetshtml = '';
2752 /* foreach ($CFG->stylesheets as $stylesheet) {
2754 $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2758 if (filter_is_enabled('mediaplugin')) {
2759 // this script is needed by most media filter plugins.
2760 $attributes = array('type'=>'text/javascript', 'src'=>$CFG->httpswwwroot
. '/lib/ufo.js');
2761 $ufo = html_writer
::tag('script', '', $attributes) . "\n";
2764 preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2766 $replacement = '<head>'.$ufo.$stylesheetshtml;
2767 $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2771 // if not, look for <html> tag, and stick <head> right after
2772 preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2774 // replace <html> tag with <html><head>includes</head>
2775 $replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
2776 $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2780 // if not, look for <body> tag, and stick <head> before body
2781 preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2783 $replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
2784 $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2788 // if not, just stick a <head> tag at the beginning
2789 $text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
2794 * RESTful cURL class
2796 * This is a wrapper class for curl, it is quite easy to use:
2800 * $c = new curl(array('cache'=>true));
2802 * $c = new curl(array('cookie'=>true));
2804 * $c = new curl(array('proxy'=>true));
2806 * // HTTP GET Method
2807 * $html = $c->get('http://example.com');
2808 * // HTTP POST Method
2809 * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2810 * // HTTP PUT Method
2811 * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2814 * @package core_files
2816 * @copyright Dongsheng Cai <dongsheng@moodle.com>
2817 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
2820 /** @var bool Caches http request contents */
2821 public $cache = false;
2822 /** @var bool Uses proxy, null means automatic based on URL */
2823 public $proxy = null;
2824 /** @var string library version */
2825 public $version = '0.4 dev';
2826 /** @var array http's response */
2827 public $response = array();
2828 /** @var array Raw response headers, needed for BC in download_file_content(). */
2829 public $rawresponse = array();
2830 /** @var array http header */
2831 public $header = array();
2832 /** @var string cURL information */
2834 /** @var string error */
2836 /** @var int error code */
2838 /** @var bool use workaround for open_basedir restrictions, to be changed from unit tests only! */
2839 public $emulateredirects = null;
2841 /** @var array cURL options */
2843 /** @var string Proxy host */
2844 private $proxy_host = '';
2845 /** @var string Proxy auth */
2846 private $proxy_auth = '';
2847 /** @var string Proxy type */
2848 private $proxy_type = '';
2849 /** @var bool Debug mode on */
2850 private $debug = false;
2851 /** @var bool|string Path to cookie file */
2852 private $cookie = false;
2853 /** @var bool tracks multiple headers in response - redirect detection */
2854 private $responsefinished = false;
2859 * Allowed settings are:
2860 * proxy: (bool) use proxy server, null means autodetect non-local from url
2861 * debug: (bool) use debug output
2862 * cookie: (string) path to cookie file, false if none
2863 * cache: (bool) use cache
2864 * module_cache: (string) type of cache
2866 * @param array $settings
2868 public function __construct($settings = array()) {
2870 if (!function_exists('curl_init')) {
2871 $this->error
= 'cURL module must be enabled!';
2872 trigger_error($this->error
, E_USER_ERROR
);
2876 // All settings of this class should be init here.
2878 if (!empty($settings['debug'])) {
2879 $this->debug
= true;
2881 if (!empty($settings['cookie'])) {
2882 if($settings['cookie'] === true) {
2883 $this->cookie
= $CFG->dataroot
.'/curl_cookie.txt';
2885 $this->cookie
= $settings['cookie'];
2888 if (!empty($settings['cache'])) {
2889 if (class_exists('curl_cache')) {
2890 if (!empty($settings['module_cache'])) {
2891 $this->cache
= new curl_cache($settings['module_cache']);
2893 $this->cache
= new curl_cache('misc');
2897 if (!empty($CFG->proxyhost
)) {
2898 if (empty($CFG->proxyport
)) {
2899 $this->proxy_host
= $CFG->proxyhost
;
2901 $this->proxy_host
= $CFG->proxyhost
.':'.$CFG->proxyport
;
2903 if (!empty($CFG->proxyuser
) and !empty($CFG->proxypassword
)) {
2904 $this->proxy_auth
= $CFG->proxyuser
.':'.$CFG->proxypassword
;
2905 $this->setopt(array(
2906 'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM
,
2907 'proxyuserpwd'=>$this->proxy_auth
));
2909 if (!empty($CFG->proxytype
)) {
2910 if ($CFG->proxytype
== 'SOCKS5') {
2911 $this->proxy_type
= CURLPROXY_SOCKS5
;
2913 $this->proxy_type
= CURLPROXY_HTTP
;
2914 $this->setopt(array('httpproxytunnel'=>false));
2916 $this->setopt(array('proxytype'=>$this->proxy_type
));
2919 if (isset($settings['proxy'])) {
2920 $this->proxy
= $settings['proxy'];
2923 $this->proxy
= false;
2926 if (!isset($this->emulateredirects
)) {
2927 $this->emulateredirects
= (ini_get('open_basedir') or ini_get('safe_mode'));
2932 * Resets the CURL options that have already been set
2934 public function resetopt() {
2935 $this->options
= array();
2936 $this->options
['CURLOPT_USERAGENT'] = 'MoodleBot/1.0';
2937 // True to include the header in the output
2938 $this->options
['CURLOPT_HEADER'] = 0;
2939 // True to Exclude the body from the output
2940 $this->options
['CURLOPT_NOBODY'] = 0;
2941 // Redirect ny default.
2942 $this->options
['CURLOPT_FOLLOWLOCATION'] = 1;
2943 $this->options
['CURLOPT_MAXREDIRS'] = 10;
2944 $this->options
['CURLOPT_ENCODING'] = '';
2945 // TRUE to return the transfer as a string of the return
2946 // value of curl_exec() instead of outputting it out directly.
2947 $this->options
['CURLOPT_RETURNTRANSFER'] = 1;
2948 $this->options
['CURLOPT_SSL_VERIFYPEER'] = 0;
2949 $this->options
['CURLOPT_SSL_VERIFYHOST'] = 2;
2950 $this->options
['CURLOPT_CONNECTTIMEOUT'] = 30;
2952 if ($cacert = self
::get_cacert()) {
2953 $this->options
['CURLOPT_CAINFO'] = $cacert;
2958 * Get the location of ca certificates.
2959 * @return string absolute file path or empty if default used
2961 public static function get_cacert() {
2964 // Bundle in dataroot always wins.
2965 if (is_readable("$CFG->dataroot/moodleorgca.crt")) {
2966 return realpath("$CFG->dataroot/moodleorgca.crt");
2969 // Next comes the default from php.ini
2970 $cacert = ini_get('curl.cainfo');
2971 if (!empty($cacert) and is_readable($cacert)) {
2972 return realpath($cacert);
2975 // Windows PHP does not have any certs, we need to use something.
2976 if ($CFG->ostype
=== 'WINDOWS') {
2977 if (is_readable("$CFG->libdir/cacert.pem")) {
2978 return realpath("$CFG->libdir/cacert.pem");
2982 // Use default, this should work fine on all properly configured *nix systems.
2989 public function resetcookie() {
2990 if (!empty($this->cookie
)) {
2991 if (is_file($this->cookie
)) {
2992 $fp = fopen($this->cookie
, 'w');
3004 * Do not use the curl constants to define the options, pass a string
3005 * corresponding to that constant. Ie. to set CURLOPT_MAXREDIRS, pass
3006 * array('CURLOPT_MAXREDIRS' => 10) or array('maxredirs' => 10) to this method.
3008 * @param array $options If array is null, this function will reset the options to default value.
3010 * @throws coding_exception If an option uses constant value instead of option name.
3012 public function setopt($options = array()) {
3013 if (is_array($options)) {
3014 foreach ($options as $name => $val) {
3015 if (!is_string($name)) {
3016 throw new coding_exception('Curl options should be defined using strings, not constant values.');
3018 if (stripos($name, 'CURLOPT_') === false) {
3019 $name = strtoupper('CURLOPT_'.$name);
3021 $name = strtoupper($name);
3023 $this->options
[$name] = $val;
3031 public function cleanopt() {
3032 unset($this->options
['CURLOPT_HTTPGET']);
3033 unset($this->options
['CURLOPT_POST']);
3034 unset($this->options
['CURLOPT_POSTFIELDS']);
3035 unset($this->options
['CURLOPT_PUT']);
3036 unset($this->options
['CURLOPT_INFILE']);
3037 unset($this->options
['CURLOPT_INFILESIZE']);
3038 unset($this->options
['CURLOPT_CUSTOMREQUEST']);
3039 unset($this->options
['CURLOPT_FILE']);
3043 * Resets the HTTP Request headers (to prepare for the new request)
3045 public function resetHeader() {
3046 $this->header
= array();
3050 * Set HTTP Request Header
3052 * @param array $header
3054 public function setHeader($header) {
3055 if (is_array($header)) {
3056 foreach ($header as $v) {
3057 $this->setHeader($v);
3060 // Remove newlines, they are not allowed in headers.
3061 $this->header
[] = preg_replace('/[\r\n]/', '', $header);
3066 * Get HTTP Response Headers
3067 * @return array of arrays
3069 public function getResponse() {
3070 return $this->response
;
3074 * Get raw HTTP Response Headers
3075 * @return array of strings
3077 public function get_raw_response() {
3078 return $this->rawresponse
;
3082 * private callback function
3083 * Formatting HTTP Response Header
3085 * @param resource $ch Apparently not used
3086 * @param string $header
3087 * @return int The strlen of the header
3089 private function formatHeader($ch, $header) {
3090 $this->rawresponse
[] = $header;
3092 if (trim($header, "\r\n") === '') {
3093 if ($this->responsefinished
) {
3094 // Multiple headers means redirect, keep just the latest one.
3095 $this->response
= array();
3096 return strlen($header);
3098 $this->responsefinished
= true;
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) {
3129 // Some more security first.
3130 if (defined('CURLOPT_PROTOCOLS')) {
3131 $this->options
['CURLOPT_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS
);
3133 if (defined('CURLOPT_REDIR_PROTOCOLS')) {
3134 $this->options
['CURLOPT_REDIR_PROTOCOLS'] = (CURLPROTO_HTTP | CURLPROTO_HTTPS
);
3140 if (!empty($this->cookie
) ||
!empty($options['cookie'])) {
3141 $this->setopt(array('cookiejar'=>$this->cookie
,
3142 'cookiefile'=>$this->cookie
3146 // Bypass proxy if required.
3147 if ($this->proxy
=== null) {
3148 if (!empty($this->options
['CURLOPT_URL']) and is_proxybypass($this->options
['CURLOPT_URL'])) {
3154 $proxy = (bool)$this->proxy
;
3159 $options['CURLOPT_PROXY'] = $this->proxy_host
;
3161 unset($this->options
['CURLOPT_PROXY']);
3164 $this->setopt($options);
3165 // reset before set options
3166 curl_setopt($curl, CURLOPT_HEADERFUNCTION
, array(&$this,'formatHeader'));
3168 if (empty($this->header
)) {
3169 $this->setHeader(array(
3170 'User-Agent: MoodleBot/1.0',
3171 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
3172 'Connection: keep-alive'
3175 curl_setopt($curl, CURLOPT_HTTPHEADER
, $this->header
);
3178 echo '<h1>Options</h1>';
3179 var_dump($this->options
);
3180 echo '<h1>Header</h1>';
3181 var_dump($this->header
);
3184 // Do not allow infinite redirects.
3185 if (!isset($this->options
['CURLOPT_MAXREDIRS'])) {
3186 $this->options
['CURLOPT_MAXREDIRS'] = 0;
3187 } else if ($this->options
['CURLOPT_MAXREDIRS'] > 100) {
3188 $this->options
['CURLOPT_MAXREDIRS'] = 100;
3190 $this->options
['CURLOPT_MAXREDIRS'] = (int)$this->options
['CURLOPT_MAXREDIRS'];
3193 // Make sure we always know if redirects expected.
3194 if (!isset($this->options
['CURLOPT_FOLLOWLOCATION'])) {
3195 $this->options
['CURLOPT_FOLLOWLOCATION'] = 0;
3199 foreach($this->options
as $name => $val) {
3200 if ($name === 'CURLOPT_PROTOCOLS' or $name === 'CURLOPT_REDIR_PROTOCOLS') {
3201 // These can not be changed, sorry.
3204 if ($name === 'CURLOPT_FOLLOWLOCATION' and $this->emulateredirects
) {
3205 // The redirects are emulated elsewhere.
3206 curl_setopt($curl, CURLOPT_FOLLOWLOCATION
, 0);
3209 $name = constant($name);
3210 curl_setopt($curl, $name, $val);
3217 * Download multiple files in parallel
3219 * Calls {@link multi()} with specific download headers
3223 * $file1 = fopen('a', 'wb');
3224 * $file2 = fopen('b', 'wb');
3225 * $c->download(array(
3226 * array('url'=>'http://localhost/', 'file'=>$file1),
3227 * array('url'=>'http://localhost/20/', 'file'=>$file2)
3237 * $c->download(array(
3238 * array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3239 * array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3243 * @param array $requests An array of files to request {
3244 * url => url to download the file [required]
3245 * file => file handler, or
3246 * filepath => file path
3248 * If 'file' and 'filepath' parameters are both specified in one request, the
3249 * open file handle in the 'file' parameter will take precedence and 'filepath'
3252 * @param array $options An array of options to set
3253 * @return array An array of results
3255 public function download($requests, $options = array()) {
3256 $options['RETURNTRANSFER'] = false;
3257 return $this->multi($requests, $options);
3261 * Multi HTTP Requests
3262 * This function could run multi-requests in parallel.
3264 * @param array $requests An array of files to request
3265 * @param array $options An array of options to set
3266 * @return array An array of results
3268 protected function multi($requests, $options = array()) {
3269 $count = count($requests);
3272 $main = curl_multi_init();
3273 for ($i = 0; $i < $count; $i++
) {
3274 if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3276 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3277 $requests[$i]['auto-handle'] = true;
3279 foreach($requests[$i] as $n=>$v) {
3282 $handles[$i] = curl_init($requests[$i]['url']);
3283 $this->apply_opt($handles[$i], $options);
3284 curl_multi_add_handle($main, $handles[$i]);
3288 curl_multi_exec($main, $running);
3289 } while($running > 0);
3290 for ($i = 0; $i < $count; $i++
) {
3291 if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3294 $results[] = curl_multi_getcontent($handles[$i]);
3296 curl_multi_remove_handle($main, $handles[$i]);
3298 curl_multi_close($main);
3300 for ($i = 0; $i < $count; $i++
) {
3301 if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3302 // close file handler if file is opened in this function
3303 fclose($requests[$i]['file']);
3310 * Single HTTP Request
3312 * @param string $url The URL to request
3313 * @param array $options
3316 protected function request($url, $options = array()) {
3317 // create curl instance
3318 $curl = curl_init($url);
3319 $options['url'] = $url;
3321 // Reset here so that the data is valid when result returned from cache.
3322 $this->info
= array();
3325 $this->response
= array();
3326 $this->rawresponse
= array();
3327 $this->responsefinished
= false;
3329 $this->apply_opt($curl, $options);
3330 if ($this->cache
&& $ret = $this->cache
->get($this->options
)) {
3334 $ret = curl_exec($curl);
3335 $this->info
= curl_getinfo($curl);
3336 $this->error
= curl_error($curl);
3337 $this->errno
= curl_errno($curl);
3338 // Note: $this->response and $this->rawresponse are filled by $hits->formatHeader callback.
3340 if ($this->emulateredirects
and $this->options
['CURLOPT_FOLLOWLOCATION'] and $this->info
['http_code'] != 200) {
3343 while($redirects <= $this->options
['CURLOPT_MAXREDIRS']) {
3345 if ($this->info
['http_code'] == 301) {
3346 // Moved Permanently - repeat the same request on new URL.
3348 } else if ($this->info
['http_code'] == 302) {
3349 // Found - the standard redirect - repeat the same request on new URL.
3351 } else if ($this->info
['http_code'] == 303) {
3352 // 303 See Other - repeat only if GET, do not bother with POSTs.
3353 if (empty($this->options
['CURLOPT_HTTPGET'])) {
3357 } else if ($this->info
['http_code'] == 307) {
3358 // Temporary Redirect - must repeat using the same request type.
3360 } else if ($this->info
['http_code'] == 308) {
3361 // Permanent Redirect - must repeat using the same request type.
3364 // Some other http code means do not retry!
3370 $redirecturl = null;
3371 if (isset($this->info
['redirect_url'])) {
3372 if (preg_match('|^https?://|i', $this->info
['redirect_url'])) {
3373 $redirecturl = $this->info
['redirect_url'];
3376 if (!$redirecturl) {
3377 foreach ($this->response
as $k => $v) {
3378 if (strtolower($k) === 'location') {
3383 if (preg_match('|^https?://|i', $redirecturl)) {
3384 // Great, this is the correct location format!
3386 } else if ($redirecturl) {
3387 $current = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL
);
3388 if (strpos($redirecturl, '/') === 0) {
3389 // Relative to server root - just guess.
3390 $pos = strpos('/', $current, 8);
3391 if ($pos === false) {
3392 $redirecturl = $current.$redirecturl;
3394 $redirecturl = substr($current, 0, $pos).$redirecturl;
3397 // Relative to current script.
3398 $redirecturl = dirname($current).'/'.$redirecturl;
3403 $this->responsefinished
= false;
3404 $this->response
= array();
3406 curl_setopt($curl, CURLOPT_URL
, $redirecturl);
3407 $ret = curl_exec($curl);
3409 $this->info
= curl_getinfo($curl);
3410 $this->error
= curl_error($curl);
3411 $this->errno
= curl_errno($curl);
3413 $this->info
['redirect_count'] = $redirects;
3415 if ($this->info
['http_code'] === 200) {
3416 // Finally this is what we wanted.
3419 if ($this->errno
!= CURLE_OK
) {
3420 // Something wrong is going on.
3424 if ($redirects > $this->options
['CURLOPT_MAXREDIRS']) {
3425 $this->errno
= CURLE_TOO_MANY_REDIRECTS
;
3426 $this->error
= 'Maximum ('.$this->options
['CURLOPT_MAXREDIRS'].') redirects followed';
3431 $this->cache
->set($this->options
, $ret);
3435 echo '<h1>Return Data</h1>';
3437 echo '<h1>Info</h1>';
3438 var_dump($this->info
);
3439 echo '<h1>Error</h1>';
3440 var_dump($this->error
);
3445 if (empty($this->error
)) {
3448 return $this->error
;
3449 // exception is not ajax friendly
3450 //throw new moodle_exception($this->error, 'curl');
3459 * @param string $url
3460 * @param array $options
3463 public function head($url, $options = array()) {
3464 $options['CURLOPT_HTTPGET'] = 0;
3465 $options['CURLOPT_HEADER'] = 1;
3466 $options['CURLOPT_NOBODY'] = 1;
3467 return $this->request($url, $options);
3473 * @param string $url
3474 * @param array|string $params
3475 * @param array $options
3478 public function post($url, $params = '', $options = array()) {
3479 $options['CURLOPT_POST'] = 1;
3480 if (is_array($params)) {
3481 $this->_tmp_file_post_params
= array();
3482 foreach ($params as $key => $value) {
3483 if ($value instanceof stored_file
) {
3484 $value->add_to_curl_request($this, $key);
3486 $this->_tmp_file_post_params
[$key] = $value;
3489 $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params
;
3490 unset($this->_tmp_file_post_params
);
3492 // $params is the raw post data
3493 $options['CURLOPT_POSTFIELDS'] = $params;
3495 return $this->request($url, $options);
3501 * @param string $url
3502 * @param array $params
3503 * @param array $options
3506 public function get($url, $params = array(), $options = array()) {
3507 $options['CURLOPT_HTTPGET'] = 1;
3509 if (!empty($params)) {
3510 $url .= (stripos($url, '?') !== false) ?
'&' : '?';
3511 $url .= http_build_query($params, '', '&');
3513 return $this->request($url, $options);
3517 * Downloads one file and writes it to the specified file handler
3521 * $file = fopen('savepath', 'w');
3522 * $result = $c->download_one('http://localhost/', null,
3523 * array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3525 * $download_info = $c->get_info();
3526 * if ($result === true) {
3527 * // file downloaded successfully
3529 * $error_text = $result;
3530 * $error_code = $c->get_errno();
3536 * $result = $c->download_one('http://localhost/', null,
3537 * array('filepath' => 'savepath', 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3538 * // ... see above, no need to close handle and remove file if unsuccessful
3541 * @param string $url
3542 * @param array|null $params key-value pairs to be added to $url as query string
3543 * @param array $options request options. Must include either 'file' or 'filepath'
3544 * @return bool|string true on success or error string on failure
3546 public function download_one($url, $params, $options = array()) {
3547 $options['CURLOPT_HTTPGET'] = 1;
3548 if (!empty($params)) {
3549 $url .= (stripos($url, '?') !== false) ?
'&' : '?';
3550 $url .= http_build_query($params, '', '&');
3552 if (!empty($options['filepath']) && empty($options['file'])) {
3554 if (!($options['file'] = fopen($options['filepath'], 'w'))) {
3556 return get_string('cannotwritefile', 'error', $options['filepath']);
3558 $filepath = $options['filepath'];
3560 unset($options['filepath']);
3561 $result = $this->request($url, $options);
3562 if (isset($filepath)) {
3563 fclose($options['file']);
3564 if ($result !== true) {
3574 * @param string $url
3575 * @param array $params
3576 * @param array $options
3579 public function put($url, $params = array(), $options = array()) {
3580 $file = $params['file'];
3581 if (!is_file($file)) {
3584 $fp = fopen($file, 'r');
3585 $size = filesize($file);
3586 $options['CURLOPT_PUT'] = 1;
3587 $options['CURLOPT_INFILESIZE'] = $size;
3588 $options['CURLOPT_INFILE'] = $fp;
3589 if (!isset($this->options
['CURLOPT_USERPWD'])) {
3590 $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
3592 $ret = $this->request($url, $options);
3598 * HTTP DELETE method
3600 * @param string $url
3601 * @param array $param
3602 * @param array $options
3605 public function delete($url, $param = array(), $options = array()) {
3606 $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
3607 if (!isset($options['CURLOPT_USERPWD'])) {
3608 $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
3610 $ret = $this->request($url, $options);
3617 * @param string $url
3618 * @param array $options
3621 public function trace($url, $options = array()) {
3622 $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
3623 $ret = $this->request($url, $options);
3628 * HTTP OPTIONS method
3630 * @param string $url
3631 * @param array $options
3634 public function options($url, $options = array()) {
3635 $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
3636 $ret = $this->request($url, $options);
3641 * Get curl information
3645 public function get_info() {
3650 * Get curl error code
3654 public function get_errno() {
3655 return $this->errno
;
3659 * When using a proxy, an additional HTTP response code may appear at
3660 * the start of the header. For example, when using https over a proxy
3661 * there may be 'HTTP/1.0 200 Connection Established'. Other codes are
3662 * also possible and some may come with their own headers.
3664 * If using the return value containing all headers, this function can be
3665 * called to remove unwanted doubles.
3667 * Note that it is not possible to distinguish this situation from valid
3668 * data unless you know the actual response part (below the headers)
3669 * will not be included in this string, or else will not 'look like' HTTP
3670 * headers. As a result it is not safe to call this function for general
3673 * @param string $input Input HTTP response
3674 * @return string HTTP response with additional headers stripped if any
3676 public static function strip_double_headers($input) {
3677 // I have tried to make this regular expression as specific as possible
3678 // to avoid any case where it does weird stuff if you happen to put
3679 // HTTP/1.1 200 at the start of any line in your RSS file. This should
3680 // also make it faster because it can abandon regex processing as soon
3681 // as it hits something that doesn't look like an http header. The
3682 // header definition is taken from RFC 822, except I didn't support
3683 // folding which is never used in practice.
3685 return preg_replace(
3686 // HTTP version and status code (ignore value of code).
3687 '~^HTTP/1\..*' . $crlf .
3688 // Header name: character between 33 and 126 decimal, except colon.
3689 // Colon. Header value: any character except \r and \n. CRLF.
3690 '(?:[\x21-\x39\x3b-\x7e]+:[^' . $crlf . ']+' . $crlf . ')*' .
3691 // Headers are terminated by another CRLF (blank line).
3693 // Second HTTP status code, this time must be 200.
3694 '(HTTP/1.[01] 200 )~', '$1', $input);
3699 * This class is used by cURL class, use case:
3702 * $CFG->repositorycacheexpire = 120;
3703 * $CFG->curlcache = 120;
3705 * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
3706 * $ret = $c->get('http://www.google.com');
3709 * @package core_files
3710 * @copyright Dongsheng Cai <dongsheng@moodle.com>
3711 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3714 /** @var string Path to cache directory */
3720 * @global stdClass $CFG
3721 * @param string $module which module is using curl_cache
3723 public function __construct($module = 'repository') {
3725 if (!empty($module)) {
3726 $this->dir
= $CFG->cachedir
.'/'.$module.'/';
3728 $this->dir
= $CFG->cachedir
.'/misc/';
3730 if (!file_exists($this->dir
)) {
3731 mkdir($this->dir
, $CFG->directorypermissions
, true);
3733 if ($module == 'repository') {
3734 if (empty($CFG->repositorycacheexpire
)) {
3735 $CFG->repositorycacheexpire
= 120;
3737 $this->ttl
= $CFG->repositorycacheexpire
;
3739 if (empty($CFG->curlcache
)) {
3740 $CFG->curlcache
= 120;
3742 $this->ttl
= $CFG->curlcache
;
3749 * @global stdClass $CFG
3750 * @global stdClass $USER
3751 * @param mixed $param
3752 * @return bool|string
3754 public function get($param) {
3756 $this->cleanup($this->ttl
);
3757 $filename = 'u'.$USER->id
.'_'.md5(serialize($param));
3758 if(file_exists($this->dir
.$filename)) {
3759 $lasttime = filemtime($this->dir
.$filename);
3760 if (time()-$lasttime > $this->ttl
) {
3763 $fp = fopen($this->dir
.$filename, 'r');
3764 $size = filesize($this->dir
.$filename);
3765 $content = fread($fp, $size);
3766 return unserialize($content);
3775 * @global object $CFG
3776 * @global object $USER
3777 * @param mixed $param
3780 public function set($param, $val) {
3782 $filename = 'u'.$USER->id
.'_'.md5(serialize($param));
3783 $fp = fopen($this->dir
.$filename, 'w');
3784 fwrite($fp, serialize($val));
3786 @chmod
($this->dir
.$filename, $CFG->filepermissions
);
3790 * Remove cache files
3792 * @param int $expire The number of seconds before expiry
3794 public function cleanup($expire) {
3795 if ($dir = opendir($this->dir
)) {
3796 while (false !== ($file = readdir($dir))) {
3797 if(!is_dir($file) && $file != '.' && $file != '..') {
3798 $lasttime = @filemtime
($this->dir
.$file);
3799 if (time() - $lasttime > $expire) {
3800 @unlink
($this->dir
.$file);
3808 * delete current user's cache file
3810 * @global object $CFG
3811 * @global object $USER
3813 public function refresh() {
3815 if ($dir = opendir($this->dir
)) {
3816 while (false !== ($file = readdir($dir))) {
3817 if (!is_dir($file) && $file != '.' && $file != '..') {
3818 if (strpos($file, 'u'.$USER->id
.'_') !== false) {
3819 @unlink
($this->dir
.$file);
3828 * This function delegates file serving to individual plugins
3830 * @param string $relativepath
3831 * @param bool $forcedownload
3832 * @param null|string $preview the preview mode, defaults to serving the original file
3833 * @todo MDL-31088 file serving improments
3835 function file_pluginfile($relativepath, $forcedownload, $preview = null) {
3836 global $DB, $CFG, $USER;
3837 // relative path must start with '/'
3838 if (!$relativepath) {
3839 print_error('invalidargorconf');
3840 } else if ($relativepath[0] != '/') {
3841 print_error('pathdoesnotstartslash');
3844 // extract relative path components
3845 $args = explode('/', ltrim($relativepath, '/'));
3847 if (count($args) < 3) { // always at least context, component and filearea
3848 print_error('invalidarguments');
3851 $contextid = (int)array_shift($args);
3852 $component = clean_param(array_shift($args), PARAM_COMPONENT
);
3853 $filearea = clean_param(array_shift($args), PARAM_AREA
);
3855 list($context, $course, $cm) = get_context_info_array($contextid);
3857 $fs = get_file_storage();
3859 // ========================================================================================================================
3860 if ($component === 'blog') {
3861 // Blog file serving
3862 if ($context->contextlevel
!= CONTEXT_SYSTEM
) {
3863 send_file_not_found();
3865 if ($filearea !== 'attachment' and $filearea !== 'post') {
3866 send_file_not_found();
3869 if (empty($CFG->enableblogs
)) {
3870 print_error('siteblogdisable', 'blog');
3873 $entryid = (int)array_shift($args);
3874 if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3875 send_file_not_found();
3877 if ($CFG->bloglevel
< BLOG_GLOBAL_LEVEL
) {
3879 if (isguestuser()) {
3880 print_error('noguest');
3882 if ($CFG->bloglevel
== BLOG_USER_LEVEL
) {
3883 if ($USER->id
!= $entry->userid
) {
3884 send_file_not_found();
3889 if ($entry->publishstate
=== 'public') {
3890 if ($CFG->forcelogin
) {
3894 } else if ($entry->publishstate
=== 'site') {
3897 } else if ($entry->publishstate
=== 'draft') {
3899 if ($USER->id
!= $entry->userid
) {
3900 send_file_not_found();
3904 $filename = array_pop($args);
3905 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
3907 if (!$file = $fs->get_file($context->id
, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3908 send_file_not_found();
3911 send_stored_file($file, 10*60, 0, true, array('preview' => $preview)); // download MUST be forced - security!
3913 // ========================================================================================================================
3914 } else if ($component === 'grade') {
3915 if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel
== CONTEXT_SYSTEM
) {
3916 // Global gradebook files
3917 if ($CFG->forcelogin
) {
3921 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3923 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3924 send_file_not_found();
3927 \core\session\manager
::write_close(); // Unlock session during file serving.
3928 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3930 } else if ($filearea === 'feedback' and $context->contextlevel
== CONTEXT_COURSE
) {
3931 //TODO: nobody implemented this yet in grade edit form!!
3932 send_file_not_found();
3934 if ($CFG->forcelogin ||
$course->id
!= SITEID
) {
3935 require_login($course);
3938 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3940 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3941 send_file_not_found();
3944 \core\session\manager
::write_close(); // Unlock session during file serving.
3945 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3947 send_file_not_found();
3950 // ========================================================================================================================
3951 } else if ($component === 'tag') {
3952 if ($filearea === 'description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
3954 // All tag descriptions are going to be public but we still need to respect forcelogin
3955 if ($CFG->forcelogin
) {
3959 $fullpath = "/$context->id/tag/description/".implode('/', $args);
3961 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3962 send_file_not_found();
3965 \core\session\manager
::write_close(); // Unlock session during file serving.
3966 send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3969 send_file_not_found();
3971 // ========================================================================================================================
3972 } else if ($component === 'badges') {
3973 require_once($CFG->libdir
. '/badgeslib.php');
3975 $badgeid = (int)array_shift($args);
3976 $badge = new badge($badgeid);
3977 $filename = array_pop($args);
3979 if ($filearea === 'badgeimage') {
3980 if ($filename !== 'f1' && $filename !== 'f2') {
3981 send_file_not_found();
3983 if (!$file = $fs->get_file($context->id
, 'badges', 'badgeimage', $badge->id
, '/', $filename.'.png')) {
3984 send_file_not_found();
3987 \core\session\manager
::write_close();
3988 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3989 } else if ($filearea === 'userbadge' and $context->contextlevel
== CONTEXT_USER
) {
3990 if (!$file = $fs->get_file($context->id
, 'badges', 'userbadge', $badge->id
, '/', $filename.'.png')) {
3991 send_file_not_found();
3994 \core\session\manager
::write_close();
3995 send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3997 // ========================================================================================================================
3998 } else if ($component === 'calendar') {
3999 if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
4001 // All events here are public the one requirement is that we respect forcelogin
4002 if ($CFG->forcelogin
) {
4006 // Get the event if from the args array
4007 $eventid = array_shift($args);
4009 // Load the event from the database
4010 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
4011 send_file_not_found();
4014 // Get the file and serve if successful
4015 $filename = array_pop($args);
4016 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4017 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4018 send_file_not_found();
4021 \core\session\manager
::write_close(); // Unlock session during file serving.
4022 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4024 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_USER
) {
4026 // Must be logged in, if they are not then they obviously can't be this user
4029 // Don't want guests here, potentially saves a DB call
4030 if (isguestuser()) {
4031 send_file_not_found();
4034 // Get the event if from the args array
4035 $eventid = array_shift($args);
4037 // Load the event from the database - user id must match
4038 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id
, 'eventtype'=>'user'))) {
4039 send_file_not_found();
4042 // Get the file and serve if successful
4043 $filename = array_pop($args);
4044 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4045 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4046 send_file_not_found();
4049 \core\session\manager
::write_close(); // Unlock session during file serving.
4050 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4052 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_COURSE
) {
4054 // Respect forcelogin and require login unless this is the site.... it probably
4055 // should NEVER be the site
4056 if ($CFG->forcelogin ||
$course->id
!= SITEID
) {
4057 require_login($course);
4060 // Must be able to at least view the course. This does not apply to the front page.
4061 if ($course->id
!= SITEID
&& (!is_enrolled($context)) && (!is_viewing($context))) {
4062 //TODO: hmm, do we really want to block guests here?
4063 send_file_not_found();
4067 $eventid = array_shift($args);
4069 // Load the event from the database we need to check whether it is
4070 // a) valid course event
4072 // Group events use the course context (there is no group context)
4073 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id
))) {
4074 send_file_not_found();
4077 // If its a group event require either membership of view all groups capability
4078 if ($event->eventtype
=== 'group') {
4079 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid
, $USER->id
)) {
4080 send_file_not_found();
4082 } else if ($event->eventtype
=== 'course' ||
$event->eventtype
=== 'site') {
4083 // Ok. Please note that the event type 'site' still uses a course context.
4086 send_file_not_found();
4089 // If we get this far we can serve the file
4090 $filename = array_pop($args);
4091 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4092 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
4093 send_file_not_found();
4096 \core\session\manager
::write_close(); // Unlock session during file serving.
4097 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4100 send_file_not_found();
4103 // ========================================================================================================================
4104 } else if ($component === 'user') {
4105 if ($filearea === 'icon' and $context->contextlevel
== CONTEXT_USER
) {
4106 if (count($args) == 1) {
4107 $themename = theme_config
::DEFAULT_THEME
;
4108 $filename = array_shift($args);
4110 $themename = array_shift($args);
4111 $filename = array_shift($args);
4114 // fix file name automatically
4115 if ($filename !== 'f1' and $filename !== 'f2' and $filename !== 'f3') {
4119 if ((!empty($CFG->forcelogin
) and !isloggedin()) ||
4120 (!empty($CFG->forceloginforprofileimage
) && (!isloggedin() ||
isguestuser()))) {
4121 // protect images if login required and not logged in;
4122 // also if login is required for profile images and is not logged in or guest
4123 // do not use require_login() because it is expensive and not suitable here anyway
4124 $theme = theme_config
::load($themename);
4125 redirect($theme->pix_url('u/'.$filename, 'moodle')); // intentionally not cached
4128 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'.png')) {
4129 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'.jpg')) {
4130 if ($filename === 'f3') {
4131 // f3 512x512px was introduced in 2.3, there might be only the smaller version.
4132 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', 'f1.png')) {
4133 $file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', 'f1.jpg');
4139 // bad reference - try to prevent future retries as hard as possible!
4140 if ($user = $DB->get_record('user', array('id'=>$context->instanceid
), 'id, picture')) {
4141 if ($user->picture
> 0) {
4142 $DB->set_field('user', 'picture', 0, array('id'=>$user->id
));
4145 // no redirect here because it is not cached
4146 $theme = theme_config
::load($themename);
4147 $imagefile = $theme->resolve_image_location('u/'.$filename, 'moodle', null);
4148 send_file($imagefile, basename($imagefile), 60*60*24*14);
4151 send_stored_file($file, 60*60*24*365, 0, false, array('preview' => $preview)); // enable long caching, there are many images on each page
4153 } else if ($filearea === 'private' and $context->contextlevel
== CONTEXT_USER
) {
4156 if (isguestuser()) {
4157 send_file_not_found();
4160 if ($USER->id
!== $context->instanceid
) {
4161 send_file_not_found();
4164 $filename = array_pop($args);
4165 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4166 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4167 send_file_not_found();
4170 \core\session\manager
::write_close(); // Unlock session during file serving.
4171 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4173 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_USER
) {
4175 if ($CFG->forcelogin
) {
4179 $userid = $context->instanceid
;
4181 if ($USER->id
== $userid) {
4182 // always can access own
4184 } else if (!empty($CFG->forceloginforprofiles
)) {
4187 if (isguestuser()) {
4188 send_file_not_found();
4191 // we allow access to site profile of all course contacts (usually teachers)
4192 if (!has_coursecontact_role($userid) && !has_capability('moodle/user:viewdetails', $context)) {
4193 send_file_not_found();
4197 if (has_capability('moodle/user:viewdetails', $context)) {
4200 $courses = enrol_get_my_courses();
4203 while (!$canview && count($courses) > 0) {
4204 $course = array_shift($courses);
4205 if (has_capability('moodle/user:viewdetails', context_course
::instance($course->id
))) {
4211 $filename = array_pop($args);
4212 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4213 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4214 send_file_not_found();
4217 \core\session\manager
::write_close(); // Unlock session during file serving.
4218 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4220 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_COURSE
) {
4221 $userid = (int)array_shift($args);
4222 $usercontext = context_user
::instance($userid);
4224 if ($CFG->forcelogin
) {
4228 if (!empty($CFG->forceloginforprofiles
)) {
4230 if (isguestuser()) {
4231 print_error('noguest');
4234 //TODO: review this logic of user profile access prevention
4235 if (!has_coursecontact_role($userid) and !has_capability('moodle/user:viewdetails', $usercontext)) {
4236 print_error('usernotavailable');
4238 if (!has_capability('moodle/user:viewdetails', $context) && !has_capability('moodle/user:viewdetails', $usercontext)) {
4239 print_error('cannotviewprofile');
4241 if (!is_enrolled($context, $userid)) {
4242 print_error('notenrolledprofile');
4244 if (groups_get_course_groupmode($course) == SEPARATEGROUPS
and !has_capability('moodle/site:accessallgroups', $context)) {
4245 print_error('groupnotamember');
4249 $filename = array_pop($args);
4250 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4251 if (!$file = $fs->get_file($usercontext->id
, 'user', 'profile', 0, $filepath, $filename) or $file->is_directory()) {
4252 send_file_not_found();
4255 \core\session\manager
::write_close(); // Unlock session during file serving.
4256 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4258 } else if ($filearea === 'backup' and $context->contextlevel
== CONTEXT_USER
) {
4261 if (isguestuser()) {
4262 send_file_not_found();
4264 $userid = $context->instanceid
;
4266 if ($USER->id
!= $userid) {
4267 send_file_not_found();
4270 $filename = array_pop($args);
4271 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4272 if (!$file = $fs->get_file($context->id
, 'user', 'backup', 0, $filepath, $filename) or $file->is_directory()) {
4273 send_file_not_found();
4276 \core\session\manager
::write_close(); // Unlock session during file serving.
4277 send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
4280 send_file_not_found();
4283 // ========================================================================================================================
4284 } else if ($component === 'coursecat') {
4285 if ($context->contextlevel
!= CONTEXT_COURSECAT
) {
4286 send_file_not_found();
4289 if ($filearea === 'description') {
4290 if ($CFG->forcelogin
) {
4291 // no login necessary - unless login forced everywhere
4295 $filename = array_pop($args);
4296 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4297 if (!$file = $fs->get_file($context->id
, 'coursecat', 'description', 0, $filepath, $filename) or $file->is_directory()) {
4298 send_file_not_found();
4301 \core\session\manager
::write_close(); // Unlock session during file serving.
4302 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4304 send_file_not_found();
4307 // ========================================================================================================================
4308 } else if ($component === 'course') {
4309 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4310 send_file_not_found();
4313 if ($filearea === 'summary' ||
$filearea === 'overviewfiles') {
4314 if ($CFG->forcelogin
) {
4318 $filename = array_pop($args);
4319 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4320 if (!$file = $fs->get_file($context->id
, 'course', $filearea, 0, $filepath, $filename) or $file->is_directory()) {
4321 send_file_not_found();
4324 \core\session\manager
::write_close(); // Unlock session during file serving.
4325 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4327 } else if ($filearea === 'section') {
4328 if ($CFG->forcelogin
) {
4329 require_login($course);
4330 } else if ($course->id
!= SITEID
) {
4331 require_login($course);
4334 $sectionid = (int)array_shift($args);
4336 if (!$section = $DB->get_record('course_sections', array('id'=>$sectionid, 'course'=>$course->id
))) {
4337 send_file_not_found();
4340 $filename = array_pop($args);
4341 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4342 if (!$file = $fs->get_file($context->id
, 'course', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4343 send_file_not_found();
4346 \core\session\manager
::write_close(); // Unlock session during file serving.
4347 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4350 send_file_not_found();
4353 } else if ($component === 'group') {
4354 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4355 send_file_not_found();
4358 require_course_login($course, true, null, false);
4360 $groupid = (int)array_shift($args);
4362 $group = $DB->get_record('groups', array('id'=>$groupid, 'courseid'=>$course->id
), '*', MUST_EXIST
);
4363 if (($course->groupmodeforce
and $course->groupmode
== SEPARATEGROUPS
) and !has_capability('moodle/site:accessallgroups', $context) and !groups_is_member($group->id
, $USER->id
)) {
4364 // do not allow access to separate group info if not member or teacher
4365 send_file_not_found();
4368 if ($filearea === 'description') {
4370 require_login($course);
4372 $filename = array_pop($args);
4373 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4374 if (!$file = $fs->get_file($context->id
, 'group', 'description', $group->id
, $filepath, $filename) or $file->is_directory()) {
4375 send_file_not_found();
4378 \core\session\manager
::write_close(); // Unlock session during file serving.
4379 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4381 } else if ($filearea === 'icon') {
4382 $filename = array_pop($args);
4384 if ($filename !== 'f1' and $filename !== 'f2') {
4385 send_file_not_found();
4387 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.png')) {
4388 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.jpg')) {
4389 send_file_not_found();
4393 \core\session\manager
::write_close(); // Unlock session during file serving.
4394 send_stored_file($file, 60*60, 0, false, array('preview' => $preview));
4397 send_file_not_found();
4400 } else if ($component === 'grouping') {
4401 if ($context->contextlevel
!= CONTEXT_COURSE
) {
4402 send_file_not_found();
4405 require_login($course);
4407 $groupingid = (int)array_shift($args);
4409 // note: everybody has access to grouping desc images for now
4410 if ($filearea === 'description') {
4412 $filename = array_pop($args);
4413 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4414 if (!$file = $fs->get_file($context->id
, 'grouping', 'description', $groupingid, $filepath, $filename) or $file->is_directory()) {
4415 send_file_not_found();
4418 \core\session\manager
::write_close(); // Unlock session during file serving.
4419 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4422 send_file_not_found();
4425 // ========================================================================================================================
4426 } else if ($component === 'backup') {
4427 if ($filearea === 'course' and $context->contextlevel
== CONTEXT_COURSE
) {
4428 require_login($course);
4429 require_capability('moodle/backup:downloadfile', $context);
4431 $filename = array_pop($args);
4432 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4433 if (!$file = $fs->get_file($context->id
, 'backup', 'course', 0, $filepath, $filename) or $file->is_directory()) {
4434 send_file_not_found();
4437 \core\session\manager
::write_close(); // Unlock session during file serving.
4438 send_stored_file($file, 0, 0, $forcedownload, array('preview' => $preview));
4440 } else if ($filearea === 'section' and $context->contextlevel
== CONTEXT_COURSE
) {
4441 require_login($course);
4442 require_capability('moodle/backup:downloadfile', $context);
4444 $sectionid = (int)array_shift($args);
4446 $filename = array_pop($args);
4447 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4448 if (!$file = $fs->get_file($context->id
, 'backup', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4449 send_file_not_found();
4452 \core\session\manager
::write_close();
4453 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4455 } else if ($filearea === 'activity' and $context->contextlevel
== CONTEXT_MODULE
) {
4456 require_login($course, false, $cm);
4457 require_capability('moodle/backup:downloadfile', $context);
4459 $filename = array_pop($args);
4460 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4461 if (!$file = $fs->get_file($context->id
, 'backup', 'activity', 0, $filepath, $filename) or $file->is_directory()) {
4462 send_file_not_found();
4465 \core\session\manager
::write_close();
4466 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4468 } else if ($filearea === 'automated' and $context->contextlevel
== CONTEXT_COURSE
) {
4469 // Backup files that were generated by the automated backup systems.
4471 require_login($course);
4472 require_capability('moodle/site:config', $context);
4474 $filename = array_pop($args);
4475 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4476 if (!$file = $fs->get_file($context->id
, 'backup', 'automated', 0, $filepath, $filename) or $file->is_directory()) {
4477 send_file_not_found();
4480 \core\session\manager
::write_close(); // Unlock session during file serving.
4481 send_stored_file($file, 0, 0, $forcedownload, array('preview' => $preview));
4484 send_file_not_found();
4487 // ========================================================================================================================
4488 } else if ($component === 'question') {
4489 require_once($CFG->libdir
. '/questionlib.php');
4490 question_pluginfile($course, $context, 'question', $filearea, $args, $forcedownload);
4491 send_file_not_found();
4493 // ========================================================================================================================
4494 } else if ($component === 'grading') {
4495 if ($filearea === 'description') {
4496 // files embedded into the form definition description
4498 if ($context->contextlevel
== CONTEXT_SYSTEM
) {
4501 } else if ($context->contextlevel
>= CONTEXT_COURSE
) {
4502 require_login($course, false, $cm);
4505 send_file_not_found();
4508 $formid = (int)array_shift($args);
4510 $sql = "SELECT ga.id
4511 FROM {grading_areas} ga
4512 JOIN {grading_definitions} gd ON (gd.areaid = ga.id)
4513 WHERE gd.id = ? AND ga.contextid = ?";
4514 $areaid = $DB->get_field_sql($sql, array($formid, $context->id
), IGNORE_MISSING
);
4517 send_file_not_found();
4520 $fullpath = "/$context->id/$component/$filearea/$formid/".implode('/', $args);
4522 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
4523 send_file_not_found();
4526 \core\session\manager
::write_close(); // Unlock session during file serving.
4527 send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4530 // ========================================================================================================================
4531 } else if (strpos($component, 'mod_') === 0) {
4532 $modname = substr($component, 4);
4533 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
4534 send_file_not_found();
4536 require_once("$CFG->dirroot/mod/$modname/lib.php");
4538 if ($context->contextlevel
== CONTEXT_MODULE
) {
4539 if ($cm->modname
!== $modname) {
4540 // somebody tries to gain illegal access, cm type must match the component!
4541 send_file_not_found();
4545 if ($filearea === 'intro') {
4546 if (!plugin_supports('mod', $modname, FEATURE_MOD_INTRO
, true)) {
4547 send_file_not_found();
4549 require_course_login($course, true, $cm);
4551 // all users may access it
4552 $filename = array_pop($args);
4553 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
4554 if (!$file = $fs->get_file($context->id
, 'mod_'.$modname, 'intro', 0, $filepath, $filename) or $file->is_directory()) {
4555 send_file_not_found();
4558 // finally send the file
4559 send_stored_file($file, null, 0, false, array('preview' => $preview));
4562 $filefunction = $component.'_pluginfile';
4563 $filefunctionold = $modname.'_pluginfile';
4564 if (function_exists($filefunction)) {
4565 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4566 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4567 } else if (function_exists($filefunctionold)) {
4568 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4569 $filefunctionold($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4572 send_file_not_found();
4574 // ========================================================================================================================
4575 } else if (strpos($component, 'block_') === 0) {
4576 $blockname = substr($component, 6);
4577 // note: no more class methods in blocks please, that is ....
4578 if (!file_exists("$CFG->dirroot/blocks/$blockname/lib.php")) {
4579 send_file_not_found();
4581 require_once("$CFG->dirroot/blocks/$blockname/lib.php");
4583 if ($context->contextlevel
== CONTEXT_BLOCK
) {
4584 $birecord = $DB->get_record('block_instances', array('id'=>$context->instanceid
), '*',MUST_EXIST
);
4585 if ($birecord->blockname
!== $blockname) {
4586 // somebody tries to gain illegal access, cm type must match the component!
4587 send_file_not_found();
4590 $bprecord = $DB->get_record('block_positions', array('contextid' => $context->id
, 'blockinstanceid' => $context->instanceid
));
4591 // User can't access file, if block is hidden or doesn't have block:view capability
4592 if (($bprecord && !$bprecord->visible
) ||
!has_capability('moodle/block:view', $context)) {
4593 send_file_not_found();
4599 $filefunction = $component.'_pluginfile';
4600 if (function_exists($filefunction)) {
4601 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4602 $filefunction($course, $birecord, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4605 send_file_not_found();
4607 // ========================================================================================================================
4608 } else if (strpos($component, '_') === false) {
4609 // all core subsystems have to be specified above, no more guessing here!
4610 send_file_not_found();
4613 // try to serve general plugin file in arbitrary context
4614 $dir = core_component
::get_component_directory($component);
4615 if (!file_exists("$dir/lib.php")) {
4616 send_file_not_found();
4618 include_once("$dir/lib.php");
4620 $filefunction = $component.'_pluginfile';
4621 if (function_exists($filefunction)) {
4622 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
4623 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload, array('preview' => $preview));
4626 send_file_not_found();