MDL-35141 Filelib: No icon for epub filetype
[moodle.git] / lib / filelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Functions for file handling.
19  *
20  * @package   core_files
21  * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * BYTESERVING_BOUNDARY - string unique string constant.
29  */
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
32 require_once("$CFG->libdir/filestorage/file_exceptions.php");
33 require_once("$CFG->libdir/filestorage/file_storage.php");
34 require_once("$CFG->libdir/filestorage/zip_packer.php");
35 require_once("$CFG->libdir/filebrowser/file_browser.php");
37 /**
38  * Encodes file serving url
39  *
40  * @deprecated use moodle_url factory methods instead
41  *
42  * @todo MDL-31071 deprecate this function
43  * @global stdClass $CFG
44  * @param string $urlbase
45  * @param string $path /filearea/itemid/dir/dir/file.exe
46  * @param bool $forcedownload
47  * @param bool $https https url required
48  * @return string encoded file url
49  */
50 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
51     global $CFG;
53 //TODO: deprecate this
55     if ($CFG->slasharguments) {
56         $parts = explode('/', $path);
57         $parts = array_map('rawurlencode', $parts);
58         $path  = implode('/', $parts);
59         $return = $urlbase.$path;
60         if ($forcedownload) {
61             $return .= '?forcedownload=1';
62         }
63     } else {
64         $path = rawurlencode($path);
65         $return = $urlbase.'?file='.$path;
66         if ($forcedownload) {
67             $return .= '&amp;forcedownload=1';
68         }
69     }
71     if ($https) {
72         $return = str_replace('http://', 'https://', $return);
73     }
75     return $return;
76 }
78 /**
79  * Prepares 'editor' formslib element from data in database
80  *
81  * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
82  * function then copies the embedded files into draft area (assigning itemids automatically),
83  * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
84  * displayed.
85  * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
86  * your mform's set_data() supplying the object returned by this function.
87  *
88  * @category files
89  * @param stdClass $data database field that holds the html text with embedded media
90  * @param string $field the name of the database field that holds the html text with embedded media
91  * @param array $options editor options (like maxifiles, maxbytes etc.)
92  * @param stdClass $context context of the editor
93  * @param string $component
94  * @param string $filearea file area name
95  * @param int $itemid item id, required if item exists
96  * @return stdClass modified data object
97  */
98 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
99     $options = (array)$options;
100     if (!isset($options['trusttext'])) {
101         $options['trusttext'] = false;
102     }
103     if (!isset($options['forcehttps'])) {
104         $options['forcehttps'] = false;
105     }
106     if (!isset($options['subdirs'])) {
107         $options['subdirs'] = false;
108     }
109     if (!isset($options['maxfiles'])) {
110         $options['maxfiles'] = 0; // no files by default
111     }
112     if (!isset($options['noclean'])) {
113         $options['noclean'] = false;
114     }
116     //sanity check for passed context. This function doesn't expect $option['context'] to be set
117     //But this function is called before creating editor hence, this is one of the best places to check
118     //if context is used properly. This check notify developer that they missed passing context to editor.
119     if (isset($context) && !isset($options['context'])) {
120         //if $context is not null then make sure $option['context'] is also set.
121         debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER);
122     } else if (isset($options['context']) && isset($context)) {
123         //If both are passed then they should be equal.
124         if ($options['context']->id != $context->id) {
125             $exceptionmsg = 'Editor context ['.$options['context']->id.'] is not equal to passed context ['.$context->id.']';
126             throw new coding_exception($exceptionmsg);
127         }
128     }
130     if (is_null($itemid) or is_null($context)) {
131         $contextid = null;
132         $itemid = null;
133         if (!isset($data)) {
134             $data = new stdClass();
135         }
136         if (!isset($data->{$field})) {
137             $data->{$field} = '';
138         }
139         if (!isset($data->{$field.'format'})) {
140             $data->{$field.'format'} = editors_get_preferred_format();
141         }
142         if (!$options['noclean']) {
143             $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
144         }
146     } else {
147         if ($options['trusttext']) {
148             // noclean ignored if trusttext enabled
149             if (!isset($data->{$field.'trust'})) {
150                 $data->{$field.'trust'} = 0;
151             }
152             $data = trusttext_pre_edit($data, $field, $context);
153         } else {
154             if (!$options['noclean']) {
155                 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
156             }
157         }
158         $contextid = $context->id;
159     }
161     if ($options['maxfiles'] != 0) {
162         $draftid_editor = file_get_submitted_draft_itemid($field);
163         $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
164         $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
165     } else {
166         $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
167     }
169     return $data;
172 /**
173  * Prepares the content of the 'editor' form element with embedded media files to be saved in database
174  *
175  * This function moves files from draft area to the destination area and
176  * encodes URLs to the draft files so they can be safely saved into DB. The
177  * form has to contain the 'editor' element named foobar_editor, where 'foobar'
178  * is the name of the database field to hold the wysiwyg editor content. The
179  * editor data comes as an array with text, format and itemid properties. This
180  * function automatically adds $data properties foobar, foobarformat and
181  * foobartrust, where foobar has URL to embedded files encoded.
182  *
183  * @category files
184  * @param stdClass $data raw data submitted by the form
185  * @param string $field name of the database field containing the html with embedded media files
186  * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
187  * @param stdClass $context context, required for existing data
188  * @param string $component file component
189  * @param string $filearea file area name
190  * @param int $itemid item id, required if item exists
191  * @return stdClass modified data object
192  */
193 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
194     $options = (array)$options;
195     if (!isset($options['trusttext'])) {
196         $options['trusttext'] = false;
197     }
198     if (!isset($options['forcehttps'])) {
199         $options['forcehttps'] = false;
200     }
201     if (!isset($options['subdirs'])) {
202         $options['subdirs'] = false;
203     }
204     if (!isset($options['maxfiles'])) {
205         $options['maxfiles'] = 0; // no files by default
206     }
207     if (!isset($options['maxbytes'])) {
208         $options['maxbytes'] = 0; // unlimited
209     }
211     if ($options['trusttext']) {
212         $data->{$field.'trust'} = trusttext_trusted($context);
213     } else {
214         $data->{$field.'trust'} = 0;
215     }
217     $editor = $data->{$field.'_editor'};
219     if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
220         $data->{$field} = $editor['text'];
221     } else {
222         $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
223     }
224     $data->{$field.'format'} = $editor['format'];
226     return $data;
229 /**
230  * Saves text and files modified by Editor formslib element
231  *
232  * @category files
233  * @param stdClass $data $database entry field
234  * @param string $field name of data field
235  * @param array $options various options
236  * @param stdClass $context context - must already exist
237  * @param string $component
238  * @param string $filearea file area name
239  * @param int $itemid must already exist, usually means data is in db
240  * @return stdClass modified data obejct
241  */
242 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
243     $options = (array)$options;
244     if (!isset($options['subdirs'])) {
245         $options['subdirs'] = false;
246     }
247     if (is_null($itemid) or is_null($context)) {
248         $itemid = null;
249         $contextid = null;
250     } else {
251         $contextid = $context->id;
252     }
254     $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
255     file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
256     $data->{$field.'_filemanager'} = $draftid_editor;
258     return $data;
261 /**
262  * Saves files modified by File manager formslib element
263  *
264  * @todo MDL-31073 review this function
265  * @category files
266  * @param stdClass $data $database entry field
267  * @param string $field name of data field
268  * @param array $options various options
269  * @param stdClass $context context - must already exist
270  * @param string $component
271  * @param string $filearea file area name
272  * @param int $itemid must already exist, usually means data is in db
273  * @return stdClass modified data obejct
274  */
275 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
276     $options = (array)$options;
277     if (!isset($options['subdirs'])) {
278         $options['subdirs'] = false;
279     }
280     if (!isset($options['maxfiles'])) {
281         $options['maxfiles'] = -1; // unlimited
282     }
283     if (!isset($options['maxbytes'])) {
284         $options['maxbytes'] = 0; // unlimited
285     }
287     if (empty($data->{$field.'_filemanager'})) {
288         $data->$field = '';
290     } else {
291         file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id, $component, $filearea, $itemid, $options);
292         $fs = get_file_storage();
294         if ($fs->get_area_files($context->id, $component, $filearea, $itemid)) {
295             $data->$field = '1'; // TODO: this is an ugly hack (skodak)
296         } else {
297             $data->$field = '';
298         }
299     }
301     return $data;
304 /**
305  * Generate a draft itemid
306  *
307  * @category files
308  * @global moodle_database $DB
309  * @global stdClass $USER
310  * @return int a random but available draft itemid that can be used to create a new draft
311  * file area.
312  */
313 function file_get_unused_draft_itemid() {
314     global $DB, $USER;
316     if (isguestuser() or !isloggedin()) {
317         // guests and not-logged-in users can not be allowed to upload anything!!!!!!
318         print_error('noguest');
319     }
321     $contextid = context_user::instance($USER->id)->id;
323     $fs = get_file_storage();
324     $draftitemid = rand(1, 999999999);
325     while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
326         $draftitemid = rand(1, 999999999);
327     }
329     return $draftitemid;
332 /**
333  * Initialise a draft file area from a real one by copying the files. A draft
334  * area will be created if one does not already exist. Normally you should
335  * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
336  *
337  * @category files
338  * @global stdClass $CFG
339  * @global stdClass $USER
340  * @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.
341  * @param int $contextid This parameter and the next two identify the file area to copy files from.
342  * @param string $component
343  * @param string $filearea helps indentify the file area.
344  * @param int $itemid helps identify the file area. Can be null if there are no files yet.
345  * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
346  * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
347  * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
348  */
349 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
350     global $CFG, $USER, $CFG;
352     $options = (array)$options;
353     if (!isset($options['subdirs'])) {
354         $options['subdirs'] = false;
355     }
356     if (!isset($options['forcehttps'])) {
357         $options['forcehttps'] = false;
358     }
360     $usercontext = context_user::instance($USER->id);
361     $fs = get_file_storage();
363     if (empty($draftitemid)) {
364         // create a new area and copy existing files into
365         $draftitemid = file_get_unused_draft_itemid();
366         $file_record = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
367         if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
368             foreach ($files as $file) {
369                 if ($file->is_directory() and $file->get_filepath() === '/') {
370                     // we need a way to mark the age of each draft area,
371                     // by not copying the root dir we force it to be created automatically with current timestamp
372                     continue;
373                 }
374                 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
375                     continue;
376                 }
377                 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
378                 // XXX: This is a hack for file manager (MDL-28666)
379                 // File manager needs to know the original file information before copying
380                 // to draft area, so we append these information in mdl_files.source field
381                 // {@link file_storage::search_references()}
382                 // {@link file_storage::search_references_count()}
383                 $sourcefield = $file->get_source();
384                 $newsourcefield = new stdClass;
385                 $newsourcefield->source = $sourcefield;
386                 $original = new stdClass;
387                 $original->contextid = $contextid;
388                 $original->component = $component;
389                 $original->filearea  = $filearea;
390                 $original->itemid    = $itemid;
391                 $original->filename  = $file->get_filename();
392                 $original->filepath  = $file->get_filepath();
393                 $newsourcefield->original = file_storage::pack_reference($original);
394                 $draftfile->set_source(serialize($newsourcefield));
395                 // End of file manager hack
396             }
397         }
398         if (!is_null($text)) {
399             // at this point there should not be any draftfile links yet,
400             // because this is a new text from database that should still contain the @@pluginfile@@ links
401             // this happens when developers forget to post process the text
402             $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
403         }
404     } else {
405         // nothing to do
406     }
408     if (is_null($text)) {
409         return null;
410     }
412     // relink embedded files - editor can not handle @@PLUGINFILE@@ !
413     return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id, 'user', 'draft', $draftitemid, $options);
416 /**
417  * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
418  *
419  * @category files
420  * @global stdClass $CFG
421  * @param string $text The content that may contain ULRs in need of rewriting.
422  * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
423  * @param int $contextid This parameter and the next two identify the file area to use.
424  * @param string $component
425  * @param string $filearea helps identify the file area.
426  * @param int $itemid helps identify the file area.
427  * @param array $options text and file options ('forcehttps'=>false)
428  * @return string the processed text.
429  */
430 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
431     global $CFG;
433     $options = (array)$options;
434     if (!isset($options['forcehttps'])) {
435         $options['forcehttps'] = false;
436     }
438     if (!$CFG->slasharguments) {
439         $file = $file . '?file=';
440     }
442     $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
444     if ($itemid !== null) {
445         $baseurl .= "$itemid/";
446     }
448     if ($options['forcehttps']) {
449         $baseurl = str_replace('http://', 'https://', $baseurl);
450     }
452     return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
455 /**
456  * Returns information about files in a draft area.
457  *
458  * @global stdClass $CFG
459  * @global stdClass $USER
460  * @param int $draftitemid the draft area item id.
461  * @return array with the following entries:
462  *      'filecount' => number of files in the draft area.
463  * (more information will be added as needed).
464  */
465 function file_get_draft_area_info($draftitemid) {
466     global $CFG, $USER;
468     $usercontext = context_user::instance($USER->id);
469     $fs = get_file_storage();
471     $results = array();
473     // The number of files
474     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id', false);
475     $results['filecount'] = count($draftfiles);
476     $results['filesize'] = 0;
477     foreach ($draftfiles as $file) {
478         $results['filesize'] += $file->get_filesize();
479     }
481     return $results;
484 /**
485  * Get used space of files
486  * @global moodle_database $DB
487  * @global stdClass $USER
488  * @return int total bytes
489  */
490 function file_get_user_used_space() {
491     global $DB, $USER;
493     $usercontext = context_user::instance($USER->id);
494     $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
495             JOIN (SELECT contenthash, filename, MAX(id) AS id
496             FROM {files}
497             WHERE contextid = ? AND component = ? AND filearea != ?
498             GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
499     $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
500     $record = $DB->get_record_sql($sql, $params);
501     return (int)$record->totalbytes;
504 /**
505  * Convert any string to a valid filepath
506  * @todo review this function
507  * @param string $str
508  * @return string path
509  */
510 function file_correct_filepath($str) { //TODO: what is this? (skodak)
511     if ($str == '/' or empty($str)) {
512         return '/';
513     } else {
514         return '/'.trim($str, './@#$ ').'/';
515     }
518 /**
519  * Generate a folder tree of draft area of current USER recursively
520  *
521  * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
522  * @param int $draftitemid
523  * @param string $filepath
524  * @param mixed $data
525  */
526 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
527     global $USER, $OUTPUT, $CFG;
528     $data->children = array();
529     $context = context_user::instance($USER->id);
530     $fs = get_file_storage();
531     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
532         foreach ($files as $file) {
533             if ($file->is_directory()) {
534                 $item = new stdClass();
535                 $item->sortorder = $file->get_sortorder();
536                 $item->filepath = $file->get_filepath();
538                 $foldername = explode('/', trim($item->filepath, '/'));
539                 $item->fullname = trim(array_pop($foldername), '/');
541                 $item->id = uniqid();
542                 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
543                 $data->children[] = $item;
544             } else {
545                 continue;
546             }
547         }
548     }
551 /**
552  * Listing all files (including folders) in current path (draft area)
553  * used by file manager
554  * @param int $draftitemid
555  * @param string $filepath
556  * @return stdClass
557  */
558 function file_get_drafarea_files($draftitemid, $filepath = '/') {
559     global $USER, $OUTPUT, $CFG;
561     $context = context_user::instance($USER->id);
562     $fs = get_file_storage();
564     $data = new stdClass();
565     $data->path = array();
566     $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
568     // will be used to build breadcrumb
569     $trail = '/';
570     if ($filepath !== '/') {
571         $filepath = file_correct_filepath($filepath);
572         $parts = explode('/', $filepath);
573         foreach ($parts as $part) {
574             if ($part != '' && $part != null) {
575                 $trail .= ($part.'/');
576                 $data->path[] = array('name'=>$part, 'path'=>$trail);
577             }
578         }
579     }
581     $list = array();
582     $maxlength = 12;
583     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
584         foreach ($files as $file) {
585             $item = new stdClass();
586             $item->filename = $file->get_filename();
587             $item->filepath = $file->get_filepath();
588             $item->fullname = trim($item->filename, '/');
589             $filesize = $file->get_filesize();
590             $item->size = $filesize ? $filesize : null;
591             $item->filesize = $filesize ? display_size($filesize) : '';
593             $item->sortorder = $file->get_sortorder();
594             $item->author = $file->get_author();
595             $item->license = $file->get_license();
596             $item->datemodified = $file->get_timemodified();
597             $item->datecreated = $file->get_timecreated();
598             $item->isref = $file->is_external_file();
599             if ($item->isref && $file->get_status() == 666) {
600                 $item->originalmissing = true;
601             }
602             // find the file this draft file was created from and count all references in local
603             // system pointing to that file
604             $source = @unserialize($file->get_source());
605             if (isset($source->original)) {
606                 $item->refcount = $fs->search_references_count($source->original);
607             }
609             if ($file->is_directory()) {
610                 $item->filesize = 0;
611                 $item->icon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
612                 $item->type = 'folder';
613                 $foldername = explode('/', trim($item->filepath, '/'));
614                 $item->fullname = trim(array_pop($foldername), '/');
615                 $item->thumbnail = $OUTPUT->pix_url(file_folder_icon(90))->out(false);
616             } else {
617                 // do NOT use file browser here!
618                 $item->mimetype = get_mimetype_description($file);
619                 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
620                     $item->type = 'zip';
621                 } else {
622                     $item->type = 'file';
623                 }
624                 $itemurl = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename);
625                 $item->url = $itemurl->out();
626                 $item->icon = $OUTPUT->pix_url(file_file_icon($file, 24))->out(false);
627                 $item->thumbnail = $OUTPUT->pix_url(file_file_icon($file, 90))->out(false);
628                 if ($imageinfo = $file->get_imageinfo()) {
629                     $item->realthumbnail = $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
630                     $item->realicon = $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
631                     $item->image_width = $imageinfo['width'];
632                     $item->image_height = $imageinfo['height'];
633                 }
634             }
635             $list[] = $item;
636         }
637     }
638     $data->itemid = $draftitemid;
639     $data->list = $list;
640     return $data;
643 /**
644  * Returns draft area itemid for a given element.
645  *
646  * @category files
647  * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
648  * @return int the itemid, or 0 if there is not one yet.
649  */
650 function file_get_submitted_draft_itemid($elname) {
651     // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
652     if (!isset($_REQUEST[$elname])) {
653         return 0;
654     }
655     if (is_array($_REQUEST[$elname])) {
656         $param = optional_param_array($elname, 0, PARAM_INT);
657         if (!empty($param['itemid'])) {
658             $param = $param['itemid'];
659         } else {
660             debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
661             return false;
662         }
664     } else {
665         $param = optional_param($elname, 0, PARAM_INT);
666     }
668     if ($param) {
669         require_sesskey();
670     }
672     return $param;
675 /**
676  * Restore the original source field from draft files
677  *
678  * @param stored_file $storedfile This only works with draft files
679  * @return stored_file
680  */
681 function file_restore_source_field_from_draft_file($storedfile) {
682     $source = @unserialize($storedfile->get_source());
683     if (!empty($source)) {
684         if (is_object($source)) {
685             $restoredsource = $source->source;
686             $storedfile->set_source($restoredsource);
687         } else {
688             throw new moodle_exception('invalidsourcefield', 'error');
689         }
690     }
691     return $storedfile;
693 /**
694  * Saves files from a draft file area to a real one (merging the list of files).
695  * Can rewrite URLs in some content at the same time if desired.
696  *
697  * @category files
698  * @global stdClass $USER
699  * @param int $draftitemid the id of the draft area to use. Normally obtained
700  *      from file_get_submitted_draft_itemid('elementname') or similar.
701  * @param int $contextid This parameter and the next two identify the file area to save to.
702  * @param string $component
703  * @param string $filearea indentifies the file area.
704  * @param int $itemid helps identifies the file area.
705  * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
706  * @param string $text some html content that needs to have embedded links rewritten
707  *      to the @@PLUGINFILE@@ form for saving in the database.
708  * @param bool $forcehttps force https urls.
709  * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
710  */
711 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
712     global $USER;
714     $usercontext = context_user::instance($USER->id);
715     $fs = get_file_storage();
717     $options = (array)$options;
718     if (!isset($options['subdirs'])) {
719         $options['subdirs'] = false;
720     }
721     if (!isset($options['maxfiles'])) {
722         $options['maxfiles'] = -1; // unlimited
723     }
724     if (!isset($options['maxbytes']) || $options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS) {
725         $options['maxbytes'] = 0; // unlimited
726     }
727     $allowreferences = true;
728     if (isset($options['return_types']) && !($options['return_types'] & FILE_REFERENCE)) {
729         // we assume that if $options['return_types'] is NOT specified, we DO allow references.
730         // this is not exactly right. BUT there are many places in code where filemanager options
731         // are not passed to file_save_draft_area_files()
732         $allowreferences = false;
733     }
735     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
736     $oldfiles   = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
738     if (count($draftfiles) < 2) {
739         // means there are no files - one file means root dir only ;-)
740         $fs->delete_area_files($contextid, $component, $filearea, $itemid);
742     } else if (count($oldfiles) < 2) {
743         $filecount = 0;
744         // there were no files before - one file means root dir only ;-)
745         foreach ($draftfiles as $file) {
746             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
747             if (!$options['subdirs']) {
748                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
749                     continue;
750                 }
751             }
752             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
753                 // oversized file - should not get here at all
754                 continue;
755             }
756             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
757                 // more files - should not get here at all
758                 break;
759             }
760             if (!$file->is_directory()) {
761                 $filecount++;
762             }
764             if ($file->is_external_file()) {
765                 if (!$allowreferences) {
766                     continue;
767                 }
768                 $repoid = $file->get_repository_id();
769                 if (!empty($repoid)) {
770                     $file_record['repositoryid'] = $repoid;
771                     $file_record['reference'] = $file->get_reference();
772                 }
773             }
774             file_restore_source_field_from_draft_file($file);
776             $fs->create_file_from_storedfile($file_record, $file);
777         }
779     } else {
780         // we have to merge old and new files - we want to keep file ids for files that were not changed
781         // we change time modified for all new and changed files, we keep time created as is
783         $newhashes = array();
784         foreach ($draftfiles as $file) {
785             $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
786             file_restore_source_field_from_draft_file($file);
787             $newhashes[$newhash] = $file;
788         }
789         $filecount = 0;
790         foreach ($oldfiles as $oldfile) {
791             $oldhash = $oldfile->get_pathnamehash();
792             if (!isset($newhashes[$oldhash])) {
793                 // delete files not needed any more - deleted by user
794                 $oldfile->delete();
795                 continue;
796             }
798             $newfile = $newhashes[$oldhash];
799             // status changed, we delete old file, and create a new one
800             if ($oldfile->get_status() != $newfile->get_status()) {
801                 // file was changed, use updated with new timemodified data
802                 $oldfile->delete();
803                 // This file will be added later
804                 continue;
805             }
807             // Replaced file content
808             if ($oldfile->get_contenthash() != $newfile->get_contenthash()) {
809                 $oldfile->replace_content_with($newfile);
810             }
811             // Updated author
812             if ($oldfile->get_author() != $newfile->get_author()) {
813                 $oldfile->set_author($newfile->get_author());
814             }
815             // Updated license
816             if ($oldfile->get_license() != $newfile->get_license()) {
817                 $oldfile->set_license($newfile->get_license());
818             }
820             // Updated file source
821             if ($oldfile->get_source() != $newfile->get_source()) {
822                 $oldfile->set_source($newfile->get_source());
823             }
825             // Updated sort order
826             if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
827                 $oldfile->set_sortorder($newfile->get_sortorder());
828             }
830             // Update file size
831             if ($oldfile->get_filesize() != $newfile->get_filesize()) {
832                 $oldfile->set_filesize($newfile->get_filesize());
833             }
835             // Update file timemodified
836             if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
837                 $oldfile->set_timemodified($newfile->get_timemodified());
838             }
840             // unchanged file or directory - we keep it as is
841             unset($newhashes[$oldhash]);
842             if (!$oldfile->is_directory()) {
843                 $filecount++;
844             }
845         }
847         // Add fresh file or the file which has changed status
848         // the size and subdirectory tests are extra safety only, the UI should prevent it
849         foreach ($newhashes as $file) {
850             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
851             if (!$options['subdirs']) {
852                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
853                     continue;
854                 }
855             }
856             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
857                 // oversized file - should not get here at all
858                 continue;
859             }
860             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
861                 // more files - should not get here at all
862                 break;
863             }
864             if (!$file->is_directory()) {
865                 $filecount++;
866             }
868             if ($file->is_external_file()) {
869                 if (!$allowreferences) {
870                     continue;
871                 }
872                 $repoid = $file->get_repository_id();
873                 if (!empty($repoid)) {
874                     $file_record['repositoryid'] = $repoid;
875                     $file_record['reference'] = $file->get_reference();
876                 }
877             }
879             $fs->create_file_from_storedfile($file_record, $file);
880         }
881     }
883     // note: do not purge the draft area - we clean up areas later in cron,
884     //       the reason is that user might press submit twice and they would loose the files,
885     //       also sometimes we might want to use hacks that save files into two different areas
887     if (is_null($text)) {
888         return null;
889     } else {
890         return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
891     }
894 /**
895  * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
896  * ready to be saved in the database. Normally, this is done automatically by
897  * {@link file_save_draft_area_files()}.
898  *
899  * @category files
900  * @param string $text the content to process.
901  * @param int $draftitemid the draft file area the content was using.
902  * @param bool $forcehttps whether the content contains https URLs. Default false.
903  * @return string the processed content.
904  */
905 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
906     global $CFG, $USER;
908     $usercontext = context_user::instance($USER->id);
910     $wwwroot = $CFG->wwwroot;
911     if ($forcehttps) {
912         $wwwroot = str_replace('http://', 'https://', $wwwroot);
913     }
915     // relink embedded files if text submitted - no absolute links allowed in database!
916     $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
918     if (strpos($text, 'draftfile.php?file=') !== false) {
919         $matches = array();
920         preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
921         if ($matches) {
922             foreach ($matches[0] as $match) {
923                 $replace = str_ireplace('%2F', '/', $match);
924                 $text = str_replace($match, $replace, $text);
925             }
926         }
927         $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
928     }
930     return $text;
933 /**
934  * Set file sort order
935  *
936  * @global moodle_database $DB
937  * @param int $contextid the context id
938  * @param string $component file component
939  * @param string $filearea file area.
940  * @param int $itemid itemid.
941  * @param string $filepath file path.
942  * @param string $filename file name.
943  * @param int $sortorder the sort order of file.
944  * @return bool
945  */
946 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
947     global $DB;
948     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
949     if ($file_record = $DB->get_record('files', $conditions)) {
950         $sortorder = (int)$sortorder;
951         $file_record->sortorder = $sortorder;
952         $DB->update_record('files', $file_record);
953         return true;
954     }
955     return false;
958 /**
959  * reset file sort order number to 0
960  * @global moodle_database $DB
961  * @param int $contextid the context id
962  * @param string $component
963  * @param string $filearea file area.
964  * @param int|bool $itemid itemid.
965  * @return bool
966  */
967 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
968     global $DB;
970     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
971     if ($itemid !== false) {
972         $conditions['itemid'] = $itemid;
973     }
975     $file_records = $DB->get_records('files', $conditions);
976     foreach ($file_records as $file_record) {
977         $file_record->sortorder = 0;
978         $DB->update_record('files', $file_record);
979     }
980     return true;
983 /**
984  * Returns description of upload error
985  *
986  * @param int $errorcode found in $_FILES['filename.ext']['error']
987  * @return string error description string, '' if ok
988  */
989 function file_get_upload_error($errorcode) {
991     switch ($errorcode) {
992     case 0: // UPLOAD_ERR_OK - no error
993         $errmessage = '';
994         break;
996     case 1: // UPLOAD_ERR_INI_SIZE
997         $errmessage = get_string('uploadserverlimit');
998         break;
1000     case 2: // UPLOAD_ERR_FORM_SIZE
1001         $errmessage = get_string('uploadformlimit');
1002         break;
1004     case 3: // UPLOAD_ERR_PARTIAL
1005         $errmessage = get_string('uploadpartialfile');
1006         break;
1008     case 4: // UPLOAD_ERR_NO_FILE
1009         $errmessage = get_string('uploadnofilefound');
1010         break;
1012     // Note: there is no error with a value of 5
1014     case 6: // UPLOAD_ERR_NO_TMP_DIR
1015         $errmessage = get_string('uploadnotempdir');
1016         break;
1018     case 7: // UPLOAD_ERR_CANT_WRITE
1019         $errmessage = get_string('uploadcantwrite');
1020         break;
1022     case 8: // UPLOAD_ERR_EXTENSION
1023         $errmessage = get_string('uploadextension');
1024         break;
1026     default:
1027         $errmessage = get_string('uploadproblem');
1028     }
1030     return $errmessage;
1033 /**
1034  * Recursive function formating an array in POST parameter
1035  * @param array $arraydata - the array that we are going to format and add into &$data array
1036  * @param string $currentdata - a row of the final postdata array at instant T
1037  *                when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1038  * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1039  */
1040 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1041         foreach ($arraydata as $k=>$v) {
1042             $newcurrentdata = $currentdata;
1043             if (is_array($v)) { //the value is an array, call the function recursively
1044                 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1045                 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1046             }  else { //add the POST parameter to the $data array
1047                 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1048             }
1049         }
1052 /**
1053  * Transform a PHP array into POST parameter
1054  * (see the recursive function format_array_postdata_for_curlcall)
1055  * @param array $postdata
1056  * @return array containing all POST parameters  (1 row = 1 POST parameter)
1057  */
1058 function format_postdata_for_curlcall($postdata) {
1059         $data = array();
1060         foreach ($postdata as $k=>$v) {
1061             if (is_array($v)) {
1062                 $currentdata = urlencode($k);
1063                 format_array_postdata_for_curlcall($v, $currentdata, $data);
1064             }  else {
1065                 $data[] = urlencode($k).'='.urlencode($v);
1066             }
1067         }
1068         $convertedpostdata = implode('&', $data);
1069         return $convertedpostdata;
1072 /**
1073  * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1074  * Due to security concerns only downloads from http(s) sources are supported.
1075  *
1076  * @todo MDL-31073 add version test for '7.10.5'
1077  * @category files
1078  * @param string $url file url starting with http(s)://
1079  * @param array $headers http headers, null if none. If set, should be an
1080  *   associative array of header name => value pairs.
1081  * @param array $postdata array means use POST request with given parameters
1082  * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1083  *   (if false, just returns content)
1084  * @param int $timeout timeout for complete download process including all file transfer
1085  *   (default 5 minutes)
1086  * @param int $connecttimeout timeout for connection to server; this is the timeout that
1087  *   usually happens if the remote server is completely down (default 20 seconds);
1088  *   may not work when using proxy
1089  * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1090  *   Only use this when already in a trusted location.
1091  * @param string $tofile store the downloaded content to file instead of returning it.
1092  * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1093  *   filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1094  * @return mixed false if request failed or content of the file as string if ok. True if file downloaded into $tofile successfully.
1095  */
1096 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1097     global $CFG;
1099     // some extra security
1100     $newlines = array("\r", "\n");
1101     if (is_array($headers) ) {
1102         foreach ($headers as $key => $value) {
1103             $headers[$key] = str_replace($newlines, '', $value);
1104         }
1105     }
1106     $url = str_replace($newlines, '', $url);
1107     if (!preg_match('|^https?://|i', $url)) {
1108         if ($fullresponse) {
1109             $response = new stdClass();
1110             $response->status        = 0;
1111             $response->headers       = array();
1112             $response->response_code = 'Invalid protocol specified in url';
1113             $response->results       = '';
1114             $response->error         = 'Invalid protocol specified in url';
1115             return $response;
1116         } else {
1117             return false;
1118         }
1119     }
1121     // check if proxy (if used) should be bypassed for this url
1122     $proxybypass = is_proxybypass($url);
1124     if (!$ch = curl_init($url)) {
1125         debugging('Can not init curl.');
1126         return false;
1127     }
1129     // set extra headers
1130     if (is_array($headers) ) {
1131         $headers2 = array();
1132         foreach ($headers as $key => $value) {
1133             $headers2[] = "$key: $value";
1134         }
1135         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers2);
1136     }
1138     if ($skipcertverify) {
1139         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
1140     }
1142     // use POST if requested
1143     if (is_array($postdata)) {
1144         $postdata = format_postdata_for_curlcall($postdata);
1145         curl_setopt($ch, CURLOPT_POST, true);
1146         curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
1147     }
1149     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
1150     curl_setopt($ch, CURLOPT_HEADER, false);
1151     curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connecttimeout);
1153     if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
1154         // TODO: add version test for '7.10.5'
1155         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
1156         curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
1157     }
1159     if (!empty($CFG->proxyhost) and !$proxybypass) {
1160         // SOCKS supported in PHP5 only
1161         if (!empty($CFG->proxytype) and ($CFG->proxytype == 'SOCKS5')) {
1162             if (defined('CURLPROXY_SOCKS5')) {
1163                 curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
1164             } else {
1165                 curl_close($ch);
1166                 if ($fullresponse) {
1167                     $response = new stdClass();
1168                     $response->status        = '0';
1169                     $response->headers       = array();
1170                     $response->response_code = 'SOCKS5 proxy is not supported in PHP4';
1171                     $response->results       = '';
1172                     $response->error         = 'SOCKS5 proxy is not supported in PHP4';
1173                     return $response;
1174                 } else {
1175                     debugging("SOCKS5 proxy is not supported in PHP4.", DEBUG_ALL);
1176                     return false;
1177                 }
1178             }
1179         }
1181         curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, false);
1183         if (empty($CFG->proxyport)) {
1184             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost);
1185         } else {
1186             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost.':'.$CFG->proxyport);
1187         }
1189         if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
1190             curl_setopt($ch, CURLOPT_PROXYUSERPWD, $CFG->proxyuser.':'.$CFG->proxypassword);
1191             if (defined('CURLOPT_PROXYAUTH')) {
1192                 // any proxy authentication if PHP 5.1
1193                 curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM);
1194             }
1195         }
1196     }
1198     // set up header and content handlers
1199     $received = new stdClass();
1200     $received->headers = array(); // received headers array
1201     $received->tofile  = $tofile;
1202     $received->fh      = null;
1203     curl_setopt($ch, CURLOPT_HEADERFUNCTION, partial('download_file_content_header_handler', $received));
1204     if ($tofile) {
1205         curl_setopt($ch, CURLOPT_WRITEFUNCTION, partial('download_file_content_write_handler', $received));
1206     }
1208     if (!isset($CFG->curltimeoutkbitrate)) {
1209         //use very slow rate of 56kbps as a timeout speed when not set
1210         $bitrate = 56;
1211     } else {
1212         $bitrate = $CFG->curltimeoutkbitrate;
1213     }
1215     // try to calculate the proper amount for timeout from remote file size.
1216     // if disabled or zero, we won't do any checks nor head requests.
1217     if ($calctimeout && $bitrate > 0) {
1218         //setup header request only options
1219         curl_setopt_array ($ch, array(
1220             CURLOPT_RETURNTRANSFER => false,
1221             CURLOPT_NOBODY         => true)
1222         );
1224         curl_exec($ch);
1225         $info = curl_getinfo($ch);
1226         $err = curl_error($ch);
1228         if ($err === '' && $info['download_content_length'] > 0) { //no curl errors
1229             $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024))); //adjust for large files only - take max timeout.
1230         }
1231         //reinstate affected curl options
1232         curl_setopt_array ($ch, array(
1233             CURLOPT_RETURNTRANSFER => true,
1234             CURLOPT_NOBODY         => false)
1235         );
1236     }
1238     curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1239     $result = curl_exec($ch);
1241     // try to detect encoding problems
1242     if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1243         curl_setopt($ch, CURLOPT_ENCODING, 'none');
1244         $result = curl_exec($ch);
1245     }
1247     if ($received->fh) {
1248         fclose($received->fh);
1249     }
1251     if (curl_errno($ch)) {
1252         $error    = curl_error($ch);
1253         $error_no = curl_errno($ch);
1254         curl_close($ch);
1256         if ($fullresponse) {
1257             $response = new stdClass();
1258             if ($error_no == 28) {
1259                 $response->status    = '-100'; // mimic snoopy
1260             } else {
1261                 $response->status    = '0';
1262             }
1263             $response->headers       = array();
1264             $response->response_code = $error;
1265             $response->results       = false;
1266             $response->error         = $error;
1267             return $response;
1268         } else {
1269             debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1270             return false;
1271         }
1273     } else {
1274         $info = curl_getinfo($ch);
1275         curl_close($ch);
1277         if (empty($info['http_code'])) {
1278             // for security reasons we support only true http connections (Location: file:// exploit prevention)
1279             $response = new stdClass();
1280             $response->status        = '0';
1281             $response->headers       = array();
1282             $response->response_code = 'Unknown cURL error';
1283             $response->results       = false; // do NOT change this, we really want to ignore the result!
1284             $response->error         = 'Unknown cURL error';
1286         } else {
1287             $response = new stdClass();;
1288             $response->status        = (string)$info['http_code'];
1289             $response->headers       = $received->headers;
1290             $response->response_code = $received->headers[0];
1291             $response->results       = $result;
1292             $response->error         = '';
1293         }
1295         if ($fullresponse) {
1296             return $response;
1297         } else if ($info['http_code'] != 200) {
1298             debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1299             return false;
1300         } else {
1301             return $response->results;
1302         }
1303     }
1306 /**
1307  * internal implementation
1308  * @param stdClass $received
1309  * @param resource $ch
1310  * @param mixed $header
1311  * @return int header length
1312  */
1313 function download_file_content_header_handler($received, $ch, $header) {
1314     $received->headers[] = $header;
1315     return strlen($header);
1318 /**
1319  * internal implementation
1320  * @param stdClass $received
1321  * @param resource $ch
1322  * @param mixed $data
1323  */
1324 function download_file_content_write_handler($received, $ch, $data) {
1325     if (!$received->fh) {
1326         $received->fh = fopen($received->tofile, 'w');
1327         if ($received->fh === false) {
1328             // bad luck, file creation or overriding failed
1329             return 0;
1330         }
1331     }
1332     if (fwrite($received->fh, $data) === false) {
1333         // bad luck, write failed, let's abort completely
1334         return 0;
1335     }
1336     return strlen($data);
1339 /**
1340  * Returns a list of information about file types based on extensions.
1341  *
1342  * The following elements expected in value array for each extension:
1343  * 'type' - mimetype
1344  * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1345  *     or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1346  *     also files with bigger sizes under names
1347  *     FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1348  * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1349  *     commonly used in moodle the following groups:
1350  *       - web_image - image that can be included as <img> in HTML
1351  *       - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1352  *       - video - file that can be imported as video in text editor
1353  *       - audio - file that can be imported as audio in text editor
1354  *       - archive - we can extract files from this archive
1355  *       - spreadsheet - used for portfolio format
1356  *       - document - used for portfolio format
1357  *       - presentation - used for portfolio format
1358  * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1359  *     human-readable description for this filetype;
1360  *     Function {@link get_mimetype_description()} first looks at the presence of string for
1361  *     particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1362  *     attribute, if not found returns the value of 'type';
1363  * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1364  *     an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1365  *     this function will return first found icon; Especially usefull for types such as 'text/plain'
1366  *
1367  * @category files
1368  * @return array List of information about file types based on extensions.
1369  *   Associative array of extension (lower-case) to associative array
1370  *   from 'element name' to data. Current element names are 'type' and 'icon'.
1371  *   Unknown types should use the 'xxx' entry which includes defaults.
1372  */
1373 function &get_mimetypes_array() {
1374     static $mimearray = array (
1375         'xxx'  => array ('type'=>'document/unknown', 'icon'=>'unknown'),
1376         '3gp'  => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1377         'aac'  => array ('type'=>'audio/aac', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1378         'accdb'  => array ('type'=>'application/msaccess', 'icon'=>'base'),
1379         'ai'   => array ('type'=>'application/postscript', 'icon'=>'eps', 'groups'=>array('image'), 'string'=>'image'),
1380         'aif'  => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1381         'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1382         'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1383         'applescript'  => array ('type'=>'text/plain', 'icon'=>'text'),
1384         'asc'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1385         'asm'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1386         'au'   => array ('type'=>'audio/au', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1387         'avi'  => array ('type'=>'video/x-ms-wm', 'icon'=>'avi', 'groups'=>array('video','web_video'), 'string'=>'video'),
1388         'bmp'  => array ('type'=>'image/bmp', 'icon'=>'bmp', 'groups'=>array('image'), 'string'=>'image'),
1389         'c'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1390         'cct'  => array ('type'=>'shockwave/director', 'icon'=>'flash'),
1391         'cpp'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1392         'cs'   => array ('type'=>'application/x-csh', 'icon'=>'sourcecode'),
1393         'css'  => array ('type'=>'text/css', 'icon'=>'text', 'groups'=>array('web_file')),
1394         'csv'  => array ('type'=>'text/csv', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1395         'dv'   => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1396         'dmg'  => array ('type'=>'application/octet-stream', 'icon'=>'unknown'),
1398         'doc'  => array ('type'=>'application/msword', 'icon'=>'document', 'groups'=>array('document')),
1399         'docx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'icon'=>'document', 'groups'=>array('document')),
1400         'docm' => array ('type'=>'application/vnd.ms-word.document.macroEnabled.12', 'icon'=>'document'),
1401         'dotx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'icon'=>'document'),
1402         'dotm' => array ('type'=>'application/vnd.ms-word.template.macroEnabled.12', 'icon'=>'document'),
1404         'dcr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1405         'dif'  => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1406         'dir'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1407         'dxr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1408         'eps'  => array ('type'=>'application/postscript', 'icon'=>'eps'),
1409         'epub' => array ('type'=>'application/epub+zip', 'icon'=>'epub', 'groups'=>array('document')),
1410         'fdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1411         'flv'  => array ('type'=>'video/x-flv', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1412         'f4v'  => array ('type'=>'video/mp4', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1413         'gif'  => array ('type'=>'image/gif', 'icon'=>'gif', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1414         'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1415         'tgz'  => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1416         'gz'   => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1417         'gzip' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1418         'h'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1419         'hpp'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1420         'hqx'  => array ('type'=>'application/mac-binhex40', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1421         'htc'  => array ('type'=>'text/x-component', 'icon'=>'markup'),
1422         'html' => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1423         'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'html', 'groups'=>array('web_file')),
1424         'htm'  => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1425         'ico'  => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1426         'ics'  => array ('type'=>'text/calendar', 'icon'=>'text'),
1427         'isf'  => array ('type'=>'application/inspiration', 'icon'=>'isf'),
1428         'ist'  => array ('type'=>'application/inspiration.template', 'icon'=>'isf'),
1429         'java' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1430         'jcb'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1431         'jcl'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1432         'jcw'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1433         'jmt'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1434         'jmx'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1435         'jpe'  => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1436         'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1437         'jpg'  => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1438         'jqz'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1439         'js'   => array ('type'=>'application/x-javascript', 'icon'=>'text', 'groups'=>array('web_file')),
1440         'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text'),
1441         'm'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1442         'mbz'  => array ('type'=>'application/vnd.moodle.backup', 'icon'=>'moodle'),
1443         'mdb'  => array ('type'=>'application/x-msaccess', 'icon'=>'base'),
1444         'mov'  => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1445         'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1446         'm3u'  => array ('type'=>'audio/x-mpegurl', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1447         'mp3'  => array ('type'=>'audio/mp3', 'icon'=>'mp3', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1448         'mp4'  => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1449         'm4v'  => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1450         'm4a'  => array ('type'=>'audio/mp4', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1451         'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1452         'mpe'  => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1453         'mpg'  => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1455         'odt'  => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'writer', 'groups'=>array('document')),
1456         'ott'  => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'writer', 'groups'=>array('document')),
1457         'oth'  => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'oth', 'groups'=>array('document')),
1458         'odm'  => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'writer'),
1459         'odg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'draw'),
1460         'otg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'draw'),
1461         'odp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'impress'),
1462         'otp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'impress'),
1463         'ods'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1464         'ots'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1465         'odc'  => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'chart'),
1466         'odf'  => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'math'),
1467         'odb'  => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'base'),
1468         'odi'  => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'draw'),
1469         'oga'  => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1470         'ogg'  => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1471         'ogv'  => array ('type'=>'video/ogg', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1473         'pct'  => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1474         'pdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1475         'php'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1476         'pic'  => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1477         'pict' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1478         'png'  => array ('type'=>'image/png', 'icon'=>'png', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1480         'pps'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1481         'ppt'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1482         'pptx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'icon'=>'powerpoint'),
1483         'pptm' => array ('type'=>'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 'icon'=>'powerpoint'),
1484         'potx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.template', 'icon'=>'powerpoint'),
1485         'potm' => array ('type'=>'application/vnd.ms-powerpoint.template.macroEnabled.12', 'icon'=>'powerpoint'),
1486         'ppam' => array ('type'=>'application/vnd.ms-powerpoint.addin.macroEnabled.12', 'icon'=>'powerpoint'),
1487         'ppsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'icon'=>'powerpoint'),
1488         'ppsm' => array ('type'=>'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 'icon'=>'powerpoint'),
1490         'ps'   => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1491         'qt'   => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1492         'ra'   => array ('type'=>'audio/x-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1493         'ram'  => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1494         'rhb'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1495         'rm'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1496         'rmvb' => array ('type'=>'application/vnd.rn-realmedia-vbr', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1497         'rtf'  => array ('type'=>'text/rtf', 'icon'=>'text', 'groups'=>array('document')),
1498         'rtx'  => array ('type'=>'text/richtext', 'icon'=>'text'),
1499         'rv'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('video'), 'string'=>'video'),
1500         'sh'   => array ('type'=>'application/x-sh', 'icon'=>'sourcecode'),
1501         'sit'  => array ('type'=>'application/x-stuffit', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1502         'smi'  => array ('type'=>'application/smil', 'icon'=>'text'),
1503         'smil' => array ('type'=>'application/smil', 'icon'=>'text'),
1504         'sqt'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1505         'svg'  => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1506         'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1507         'swa'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1508         'swf'  => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1509         'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1511         'sxw'  => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'writer'),
1512         'stw'  => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'writer'),
1513         'sxc'  => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'calc'),
1514         'stc'  => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'calc'),
1515         'sxd'  => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'draw'),
1516         'std'  => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'draw'),
1517         'sxi'  => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'impress'),
1518         'sti'  => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'impress'),
1519         'sxg'  => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'writer'),
1520         'sxm'  => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'math'),
1522         'tar'  => array ('type'=>'application/x-tar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1523         'tif'  => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1524         'tiff' => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1525         'tex'  => array ('type'=>'application/x-tex', 'icon'=>'text'),
1526         'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1527         'texinfo'  => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1528         'tsv'  => array ('type'=>'text/tab-separated-values', 'icon'=>'text'),
1529         'txt'  => array ('type'=>'text/plain', 'icon'=>'text', 'defaulticon'=>true),
1530         'wav'  => array ('type'=>'audio/wav', 'icon'=>'wav', 'groups'=>array('audio'), 'string'=>'audio'),
1531         'webm'  => array ('type'=>'video/webm', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1532         'wmv'  => array ('type'=>'video/x-ms-wmv', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1533         'asf'  => array ('type'=>'video/x-ms-asf', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1534         'xdp'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1535         'xfd'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1536         'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1538         'xls'  => array ('type'=>'application/vnd.ms-excel', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1539         'xlsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'icon'=>'spreadsheet'),
1540         'xlsm' => array ('type'=>'application/vnd.ms-excel.sheet.macroEnabled.12', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1541         'xltx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'icon'=>'spreadsheet'),
1542         'xltm' => array ('type'=>'application/vnd.ms-excel.template.macroEnabled.12', 'icon'=>'spreadsheet'),
1543         'xlsb' => array ('type'=>'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 'icon'=>'spreadsheet'),
1544         'xlam' => array ('type'=>'application/vnd.ms-excel.addin.macroEnabled.12', 'icon'=>'spreadsheet'),
1546         'xml'  => array ('type'=>'application/xml', 'icon'=>'markup'),
1547         'xsl'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1548         'zip'  => array ('type'=>'application/zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive')
1549     );
1550     return $mimearray;
1553 /**
1554  * Obtains information about a filetype based on its extension. Will
1555  * use a default if no information is present about that particular
1556  * extension.
1557  *
1558  * @category files
1559  * @param string $element Desired information (usually 'icon'
1560  *   for icon filename or 'type' for MIME type. Can also be
1561  *   'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1562  * @param string $filename Filename we're looking up
1563  * @return string Requested piece of information from array
1564  */
1565 function mimeinfo($element, $filename) {
1566     global $CFG;
1567     $mimeinfo = & get_mimetypes_array();
1568     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1570     $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1571     if (empty($filetype)) {
1572         $filetype = 'xxx'; // file without extension
1573     }
1574     if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1575         $iconsize = max(array(16, (int)$iconsizematch[1]));
1576         $filenames = array($mimeinfo['xxx']['icon']);
1577         if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1578             array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1579         }
1580         // find the file with the closest size, first search for specific icon then for default icon
1581         foreach ($filenames as $filename) {
1582             foreach ($iconpostfixes as $size => $postfix) {
1583                 $fullname = $CFG->dirroot.'/pix/f/'.$filename.$postfix;
1584                 if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1585                     return $filename.$postfix;
1586                 }
1587             }
1588         }
1589     } else if (isset($mimeinfo[$filetype][$element])) {
1590         return $mimeinfo[$filetype][$element];
1591     } else if (isset($mimeinfo['xxx'][$element])) {
1592         return $mimeinfo['xxx'][$element];   // By default
1593     } else {
1594         return null;
1595     }
1598 /**
1599  * Obtains information about a filetype based on the MIME type rather than
1600  * the other way around.
1601  *
1602  * @category files
1603  * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1604  * @param string $mimetype MIME type we're looking up
1605  * @return string Requested piece of information from array
1606  */
1607 function mimeinfo_from_type($element, $mimetype) {
1608     /* array of cached mimetype->extension associations */
1609     static $cached = array();
1610     $mimeinfo = & get_mimetypes_array();
1612     if (!array_key_exists($mimetype, $cached)) {
1613         $cached[$mimetype] = null;
1614         foreach($mimeinfo as $filetype => $values) {
1615             if ($values['type'] == $mimetype) {
1616                 if ($cached[$mimetype] === null) {
1617                     $cached[$mimetype] = '.'.$filetype;
1618                 }
1619                 if (!empty($values['defaulticon'])) {
1620                     $cached[$mimetype] = '.'.$filetype;
1621                     break;
1622                 }
1623             }
1624         }
1625         if (empty($cached[$mimetype])) {
1626             $cached[$mimetype] = '.xxx';
1627         }
1628     }
1629     if ($element === 'extension') {
1630         return $cached[$mimetype];
1631     } else {
1632         return mimeinfo($element, $cached[$mimetype]);
1633     }
1636 /**
1637  * Return the relative icon path for a given file
1638  *
1639  * Usage:
1640  * <code>
1641  * // $file - instance of stored_file or file_info
1642  * $icon = $OUTPUT->pix_url(file_file_icon($file))->out();
1643  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1644  * </code>
1645  * or
1646  * <code>
1647  * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1648  * </code>
1649  *
1650  * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1651  *     and $file->mimetype are expected)
1652  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1653  * @return string
1654  */
1655 function file_file_icon($file, $size = null) {
1656     if (!is_object($file)) {
1657         $file = (object)$file;
1658     }
1659     if (isset($file->filename)) {
1660         $filename = $file->filename;
1661     } else if (method_exists($file, 'get_filename')) {
1662         $filename = $file->get_filename();
1663     } else if (method_exists($file, 'get_visible_name')) {
1664         $filename = $file->get_visible_name();
1665     } else {
1666         $filename = '';
1667     }
1668     if (isset($file->mimetype)) {
1669         $mimetype = $file->mimetype;
1670     } else if (method_exists($file, 'get_mimetype')) {
1671         $mimetype = $file->get_mimetype();
1672     } else {
1673         $mimetype = '';
1674     }
1675     $mimetypes = &get_mimetypes_array();
1676     if ($filename) {
1677         $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1678         if ($extension && !empty($mimetypes[$extension])) {
1679             // if file name has known extension, return icon for this extension
1680             return file_extension_icon($filename, $size);
1681         }
1682     }
1683     return file_mimetype_icon($mimetype, $size);
1686 /**
1687  * Return the relative icon path for a folder image
1688  *
1689  * Usage:
1690  * <code>
1691  * $icon = $OUTPUT->pix_url(file_folder_icon())->out();
1692  * echo html_writer::empty_tag('img', array('src' => $icon));
1693  * </code>
1694  * or
1695  * <code>
1696  * echo $OUTPUT->pix_icon(file_folder_icon(32));
1697  * </code>
1698  *
1699  * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1700  * @return string
1701  */
1702 function file_folder_icon($iconsize = null) {
1703     global $CFG;
1704     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1705     static $cached = array();
1706     $iconsize = max(array(16, (int)$iconsize));
1707     if (!array_key_exists($iconsize, $cached)) {
1708         foreach ($iconpostfixes as $size => $postfix) {
1709             $fullname = $CFG->dirroot.'/pix/f/folder'.$postfix;
1710             if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1711                 $cached[$iconsize] = 'f/folder'.$postfix;
1712                 break;
1713             }
1714         }
1715     }
1716     return $cached[$iconsize];
1719 /**
1720  * Returns the relative icon path for a given mime type
1721  *
1722  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1723  * a return the full path to an icon.
1724  *
1725  * <code>
1726  * $mimetype = 'image/jpg';
1727  * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype))->out();
1728  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1729  * </code>
1730  *
1731  * @category files
1732  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1733  * to conform with that.
1734  * @param string $mimetype The mimetype to fetch an icon for
1735  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1736  * @return string The relative path to the icon
1737  */
1738 function file_mimetype_icon($mimetype, $size = NULL) {
1739     return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1742 /**
1743  * Returns the relative icon path for a given file name
1744  *
1745  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1746  * a return the full path to an icon.
1747  *
1748  * <code>
1749  * $filename = '.jpg';
1750  * $icon = $OUTPUT->pix_url(file_extension_icon($filename))->out();
1751  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1752  * </code>
1753  *
1754  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1755  * to conform with that.
1756  * @todo MDL-31074 Implement $size
1757  * @category files
1758  * @param string $filename The filename to get the icon for
1759  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1760  * @return string
1761  */
1762 function file_extension_icon($filename, $size = NULL) {
1763     return 'f/'.mimeinfo('icon'.$size, $filename);
1766 /**
1767  * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1768  * mimetypes.php language file.
1769  *
1770  * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1771  *   'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1772  *   have filename); In case of array/stdClass the field 'mimetype' is optional.
1773  * @param bool $capitalise If true, capitalises first character of result
1774  * @return string Text description
1775  */
1776 function get_mimetype_description($obj, $capitalise=false) {
1777     $filename = $mimetype = '';
1778     if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1779         // this is an instance of stored_file
1780         $mimetype = $obj->get_mimetype();
1781         $filename = $obj->get_filename();
1782     } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1783         // this is an instance of file_info
1784         $mimetype = $obj->get_mimetype();
1785         $filename = $obj->get_visible_name();
1786     } else if (is_array($obj) || is_object ($obj)) {
1787         $obj = (array)$obj;
1788         if (!empty($obj['filename'])) {
1789             $filename = $obj['filename'];
1790         }
1791         if (!empty($obj['mimetype'])) {
1792             $mimetype = $obj['mimetype'];
1793         }
1794     } else {
1795         $mimetype = $obj;
1796     }
1797     $mimetypefromext = mimeinfo('type', $filename);
1798     if (empty($mimetype) || $mimetypefromext !== 'document/unknown') {
1799         // if file has a known extension, overwrite the specified mimetype
1800         $mimetype = $mimetypefromext;
1801     }
1802     $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1803     if (empty($extension)) {
1804         $mimetypestr = mimeinfo_from_type('string', $mimetype);
1805         $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1806     } else {
1807         $mimetypestr = mimeinfo('string', $filename);
1808     }
1809     $chunks = explode('/', $mimetype, 2);
1810     $chunks[] = '';
1811     $attr = array(
1812         'mimetype' => $mimetype,
1813         'ext' => $extension,
1814         'mimetype1' => $chunks[0],
1815         'mimetype2' => $chunks[1],
1816     );
1817     $a = array();
1818     foreach ($attr as $key => $value) {
1819         $a[$key] = $value;
1820         $a[strtoupper($key)] = strtoupper($value);
1821         $a[ucfirst($key)] = ucfirst($value);
1822     }
1824     // MIME types may include + symbol but this is not permitted in string ids.
1825     $safemimetype = str_replace('+', '_', $mimetype);
1826     $safemimetypestr = str_replace('+', '_', $mimetypestr);
1827     if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
1828         $result = get_string($safemimetype, 'mimetypes', (object)$a);
1829     } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
1830         $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
1831     } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1832         $result = get_string('default', 'mimetypes', (object)$a);
1833     } else {
1834         $result = $mimetype;
1835     }
1836     if ($capitalise) {
1837         $result=ucfirst($result);
1838     }
1839     return $result;
1842 /**
1843  * Returns array of elements of type $element in type group(s)
1844  *
1845  * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1846  * @param string|array $groups one group or array of groups/extensions/mimetypes
1847  * @return array
1848  */
1849 function file_get_typegroup($element, $groups) {
1850     static $cached = array();
1851     if (!is_array($groups)) {
1852         $groups = array($groups);
1853     }
1854     if (!array_key_exists($element, $cached)) {
1855         $cached[$element] = array();
1856     }
1857     $result = array();
1858     foreach ($groups as $group) {
1859         if (!array_key_exists($group, $cached[$element])) {
1860             // retrieive and cache all elements of type $element for group $group
1861             $mimeinfo = & get_mimetypes_array();
1862             $cached[$element][$group] = array();
1863             foreach ($mimeinfo as $extension => $value) {
1864                 $value['extension'] = '.'.$extension;
1865                 if (empty($value[$element])) {
1866                     continue;
1867                 }
1868                 if (($group === '.'.$extension || $group === $value['type'] ||
1869                         (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1870                         !in_array($value[$element], $cached[$element][$group])) {
1871                     $cached[$element][$group][] = $value[$element];
1872                 }
1873             }
1874         }
1875         $result = array_merge($result, $cached[$element][$group]);
1876     }
1877     return array_unique($result);
1880 /**
1881  * Checks if file with name $filename has one of the extensions in groups $groups
1882  *
1883  * @see get_mimetypes_array()
1884  * @param string $filename name of the file to check
1885  * @param string|array $groups one group or array of groups to check
1886  * @param bool $checktype if true and extension check fails, find the mimetype and check if
1887  * file mimetype is in mimetypes in groups $groups
1888  * @return bool
1889  */
1890 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
1891     $extension = pathinfo($filename, PATHINFO_EXTENSION);
1892     if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
1893         return true;
1894     }
1895     return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
1898 /**
1899  * Checks if mimetype $mimetype belongs to one of the groups $groups
1900  *
1901  * @see get_mimetypes_array()
1902  * @param string $mimetype
1903  * @param string|array $groups one group or array of groups to check
1904  * @return bool
1905  */
1906 function file_mimetype_in_typegroup($mimetype, $groups) {
1907     return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
1910 /**
1911  * Requested file is not found or not accessible, does not return, terminates script
1912  *
1913  * @global stdClass $CFG
1914  * @global stdClass $COURSE
1915  */
1916 function send_file_not_found() {
1917     global $CFG, $COURSE;
1918     send_header_404();
1919     print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1921 /**
1922  * Helper function to send correct 404 for server.
1923  */
1924 function send_header_404() {
1925     if (substr(php_sapi_name(), 0, 3) == 'cgi') {
1926         header("Status: 404 Not Found");
1927     } else {
1928         header('HTTP/1.0 404 not found');
1929     }
1932 /**
1933  * Enhanced readfile() with optional acceleration.
1934  * @param string|stored_file $file
1935  * @param string $mimetype
1936  * @param bool $accelerate
1937  * @return void
1938  */
1939 function readfile_accel($file, $mimetype, $accelerate) {
1940     global $CFG;
1942     if ($mimetype === 'text/plain') {
1943         // there is no encoding specified in text files, we need something consistent
1944         header('Content-Type: text/plain; charset=utf-8');
1945     } else {
1946         header('Content-Type: '.$mimetype);
1947     }
1949     $lastmodified = is_object($file) ? $file->get_timemodified() : filemtime($file);
1950     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1952     if (is_object($file)) {
1953         header('ETag: ' . $file->get_contenthash());
1954         if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and $_SERVER['HTTP_IF_NONE_MATCH'] === $file->get_contenthash()) {
1955             header('HTTP/1.1 304 Not Modified');
1956             return;
1957         }
1958     }
1960     // if etag present for stored file rely on it exclusively
1961     if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
1962         // get unixtime of request header; clip extra junk off first
1963         $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1964         if ($since && $since >= $lastmodified) {
1965             header('HTTP/1.1 304 Not Modified');
1966             return;
1967         }
1968     }
1970     if ($accelerate and !empty($CFG->xsendfile)) {
1971         if (empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1972             header('Accept-Ranges: bytes');
1973         } else {
1974             header('Accept-Ranges: none');
1975         }
1977         if (is_object($file)) {
1978             $fs = get_file_storage();
1979             if ($fs->xsendfile($file->get_contenthash())) {
1980                 return;
1981             }
1983         } else {
1984             require_once("$CFG->libdir/xsendfilelib.php");
1985             if (xsendfile($file)) {
1986                 return;
1987             }
1988         }
1989     }
1991     $filesize = is_object($file) ? $file->get_filesize() : filesize($file);
1993     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1995     if ($accelerate and empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1996         header('Accept-Ranges: bytes');
1998         if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1999             // byteserving stuff - for acrobat reader and download accelerators
2000             // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
2001             // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
2002             $ranges = false;
2003             if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
2004                 foreach ($ranges as $key=>$value) {
2005                     if ($ranges[$key][1] == '') {
2006                         //suffix case
2007                         $ranges[$key][1] = $filesize - $ranges[$key][2];
2008                         $ranges[$key][2] = $filesize - 1;
2009                     } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
2010                         //fix range length
2011                         $ranges[$key][2] = $filesize - 1;
2012                     }
2013                     if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
2014                         //invalid byte-range ==> ignore header
2015                         $ranges = false;
2016                         break;
2017                     }
2018                     //prepare multipart header
2019                     $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
2020                     $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
2021                 }
2022             } else {
2023                 $ranges = false;
2024             }
2025             if ($ranges) {
2026                 if (is_object($file)) {
2027                     $handle = $file->get_content_file_handle();
2028                 } else {
2029                     $handle = fopen($file, 'rb');
2030                 }
2031                 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
2032             }
2033         }
2034     } else {
2035         // Do not byteserve
2036         header('Accept-Ranges: none');
2037     }
2039     header('Content-Length: '.$filesize);
2041     if ($filesize > 10000000) {
2042         // for large files try to flush and close all buffers to conserve memory
2043         while(@ob_get_level()) {
2044             if (!@ob_end_flush()) {
2045                 break;
2046             }
2047         }
2048     }
2050     // send the whole file content
2051     if (is_object($file)) {
2052         $file->readfile();
2053     } else {
2054         readfile($file);
2055     }
2058 /**
2059  * Similar to readfile_accel() but designed for strings.
2060  * @param string $string
2061  * @param string $mimetype
2062  * @param bool $accelerate
2063  * @return void
2064  */
2065 function readstring_accel($string, $mimetype, $accelerate) {
2066     global $CFG;
2068     if ($mimetype === 'text/plain') {
2069         // there is no encoding specified in text files, we need something consistent
2070         header('Content-Type: text/plain; charset=utf-8');
2071     } else {
2072         header('Content-Type: '.$mimetype);
2073     }
2074     header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2075     header('Accept-Ranges: none');
2077     if ($accelerate and !empty($CFG->xsendfile)) {
2078         $fs = get_file_storage();
2079         if ($fs->xsendfile(sha1($string))) {
2080             return;
2081         }
2082     }
2084     header('Content-Length: '.strlen($string));
2085     echo $string;
2088 /**
2089  * Handles the sending of temporary file to user, download is forced.
2090  * File is deleted after abort or successful sending, does not return, script terminated
2091  *
2092  * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2093  * @param string $filename proposed file name when saving file
2094  * @param bool $pathisstring If the path is string
2095  */
2096 function send_temp_file($path, $filename, $pathisstring=false) {
2097     global $CFG;
2099     if (check_browser_version('Firefox', '1.5')) {
2100         // only FF is known to correctly save to disk before opening...
2101         $mimetype = mimeinfo('type', $filename);
2102     } else {
2103         $mimetype = 'application/x-forcedownload';
2104     }
2106     // close session - not needed anymore
2107     session_get_instance()->write_close();
2109     if (!$pathisstring) {
2110         if (!file_exists($path)) {
2111             send_header_404();
2112             print_error('filenotfound', 'error', $CFG->wwwroot.'/');
2113         }
2114         // executed after normal finish or abort
2115         @register_shutdown_function('send_temp_file_finished', $path);
2116     }
2118     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2119     if (check_browser_version('MSIE')) {
2120         $filename = urlencode($filename);
2121     }
2123     header('Content-Disposition: attachment; filename="'.$filename.'"');
2124     if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2125         header('Cache-Control: max-age=10');
2126         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2127         header('Pragma: ');
2128     } else { //normal http - prevent caching at all cost
2129         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2130         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2131         header('Pragma: no-cache');
2132     }
2134     // send the contents - we can not accelerate this because the file will be deleted asap
2135     if ($pathisstring) {
2136         readstring_accel($path, $mimetype, false);
2137     } else {
2138         readfile_accel($path, $mimetype, false);
2139         @unlink($path);
2140     }
2142     die; //no more chars to output
2145 /**
2146  * Internal callback function used by send_temp_file()
2147  *
2148  * @param string $path
2149  */
2150 function send_temp_file_finished($path) {
2151     if (file_exists($path)) {
2152         @unlink($path);
2153     }
2156 /**
2157  * Handles the sending of file data to the user's browser, including support for
2158  * byteranges etc.
2159  *
2160  * @category files
2161  * @param string $path Path of file on disk (including real filename), or actual content of file as string
2162  * @param string $filename Filename to send
2163  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2164  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2165  * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
2166  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2167  * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2168  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2169  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2170  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
2171  *                        and should not be reopened.
2172  * @return null script execution stopped unless $dontdie is true
2173  */
2174 function send_file($path, $filename, $lifetime = 'default' , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
2175     global $CFG, $COURSE;
2177     if ($dontdie) {
2178         ignore_user_abort(true);
2179     }
2181     // MDL-11789, apply $CFG->filelifetime here
2182     if ($lifetime === 'default') {
2183         if (!empty($CFG->filelifetime)) {
2184             $lifetime = $CFG->filelifetime;
2185         } else {
2186             $lifetime = 86400;
2187         }
2188     }
2190     session_get_instance()->write_close(); // unlock session during fileserving
2192     // Use given MIME type if specified, otherwise guess it using mimeinfo.
2193     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2194     // only Firefox saves all files locally before opening when content-disposition: attachment stated
2195     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2196     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2197                          ($mimetype ? $mimetype : mimeinfo('type', $filename));
2199     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2200     if (check_browser_version('MSIE')) {
2201         $filename = rawurlencode($filename);
2202     }
2204     if ($forcedownload) {
2205         header('Content-Disposition: attachment; filename="'.$filename.'"');
2206     } else {
2207         header('Content-Disposition: inline; filename="'.$filename.'"');
2208     }
2210     if ($lifetime > 0) {
2211         $nobyteserving = false;
2212         header('Cache-Control: max-age='.$lifetime);
2213         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2214         header('Pragma: ');
2216     } else { // Do not cache files in proxies and browsers
2217         $nobyteserving = true;
2218         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2219             header('Cache-Control: max-age=10');
2220             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2221             header('Pragma: ');
2222         } else { //normal http - prevent caching at all cost
2223             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2224             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2225             header('Pragma: no-cache');
2226         }
2227     }
2229     if (empty($filter)) {
2230         // send the contents
2231         if ($pathisstring) {
2232             readstring_accel($path, $mimetype, !$dontdie);
2233         } else {
2234             readfile_accel($path, $mimetype, !$dontdie);
2235         }
2237     } else {
2238         // Try to put the file through filters
2239         if ($mimetype == 'text/html') {
2240             $options = new stdClass();
2241             $options->noclean = true;
2242             $options->nocache = true; // temporary workaround for MDL-5136
2243             $text = $pathisstring ? $path : implode('', file($path));
2245             $text = file_modify_html_header($text);
2246             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2248             readstring_accel($output, $mimetype, false);
2250         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2251             // only filter text if filter all files is selected
2252             $options = new stdClass();
2253             $options->newlines = false;
2254             $options->noclean = true;
2255             $text = htmlentities($pathisstring ? $path : implode('', file($path)));
2256             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2258             readstring_accel($output, $mimetype, false);
2260         } else {
2261             // send the contents
2262             if ($pathisstring) {
2263                 readstring_accel($path, $mimetype, !$dontdie);
2264             } else {
2265                 readfile_accel($path, $mimetype, !$dontdie);
2266             }
2267         }
2268     }
2269     if ($dontdie) {
2270         return;
2271     }
2272     die; //no more chars to output!!!
2275 /**
2276  * Handles the sending of file data to the user's browser, including support for
2277  * byteranges etc.
2278  *
2279  * The $options parameter supports the following keys:
2280  *  (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2281  *  (string|null) filename - overrides the implicit filename
2282  *  (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2283  *      if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2284  *      you must detect this case when control is returned using connection_aborted. Please not that session is closed
2285  *      and should not be reopened.
2286  *
2287  * @category files
2288  * @param stored_file $stored_file local file object
2289  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2290  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2291  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2292  * @param array $options additional options affecting the file serving
2293  * @return null script execution stopped unless $options['dontdie'] is true
2294  */
2295 function send_stored_file($stored_file, $lifetime=86400 , $filter=0, $forcedownload=false, array $options=array()) {
2296     global $CFG, $COURSE;
2298     if (empty($options['filename'])) {
2299         $filename = null;
2300     } else {
2301         $filename = $options['filename'];
2302     }
2304     if (empty($options['dontdie'])) {
2305         $dontdie = false;
2306     } else {
2307         $dontdie = true;
2308     }
2310     if (!empty($options['preview'])) {
2311         // replace the file with its preview
2312         $fs = get_file_storage();
2313         $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2314         if (!$preview_file) {
2315             // unable to create a preview of the file, send its default mime icon instead
2316             if ($options['preview'] === 'tinyicon') {
2317                 $size = 24;
2318             } else if ($options['preview'] === 'thumb') {
2319                 $size = 90;
2320             } else {
2321                 $size = 256;
2322             }
2323             $fileicon = file_file_icon($stored_file, $size);
2324             send_file($CFG->dirroot.'/pix/'.$fileicon.'.png', basename($fileicon).'.png');
2325         } else {
2326             // preview images have fixed cache lifetime and they ignore forced download
2327             // (they are generated by GD and therefore they are considered reasonably safe).
2328             $stored_file = $preview_file;
2329             $lifetime = DAYSECS;
2330             $filter = 0;
2331             $forcedownload = false;
2332         }
2333     }
2335     // handle external resource
2336     if ($stored_file && $stored_file->is_external_file()) {
2337         $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2338         die;
2339     }
2341     if (!$stored_file or $stored_file->is_directory()) {
2342         // nothing to serve
2343         if ($dontdie) {
2344             return;
2345         }
2346         die;
2347     }
2349     if ($dontdie) {
2350         ignore_user_abort(true);
2351     }
2353     session_get_instance()->write_close(); // unlock session during fileserving
2355     // Use given MIME type if specified, otherwise guess it using mimeinfo.
2356     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2357     // only Firefox saves all files locally before opening when content-disposition: attachment stated
2358     $filename     = is_null($filename) ? $stored_file->get_filename() : $filename;
2359     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2360     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2361                          ($stored_file->get_mimetype() ? $stored_file->get_mimetype() : mimeinfo('type', $filename));
2363     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2364     if (check_browser_version('MSIE')) {
2365         $filename = rawurlencode($filename);
2366     }
2368     if ($forcedownload) {
2369         header('Content-Disposition: attachment; filename="'.$filename.'"');
2370     } else {
2371         header('Content-Disposition: inline; filename="'.$filename.'"');
2372     }
2374     if ($lifetime > 0) {
2375         header('Cache-Control: max-age='.$lifetime);
2376         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2377         header('Pragma: ');
2379     } else { // Do not cache files in proxies and browsers
2380         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2381             header('Cache-Control: max-age=10');
2382             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2383             header('Pragma: ');
2384         } else { //normal http - prevent caching at all cost
2385             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2386             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2387             header('Pragma: no-cache');
2388         }
2389     }
2391     if (empty($filter)) {
2392         // send the contents
2393         readfile_accel($stored_file, $mimetype, !$dontdie);
2395     } else {     // Try to put the file through filters
2396         if ($mimetype == 'text/html') {
2397             $options = new stdClass();
2398             $options->noclean = true;
2399             $options->nocache = true; // temporary workaround for MDL-5136
2400             $text = $stored_file->get_content();
2401             $text = file_modify_html_header($text);
2402             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2404             readstring_accel($output, $mimetype, false);
2406         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2407             // only filter text if filter all files is selected
2408             $options = new stdClass();
2409             $options->newlines = false;
2410             $options->noclean = true;
2411             $text = $stored_file->get_content();
2412             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2414             readstring_accel($output, $mimetype, false);
2416         } else {    // Just send it out raw
2417             readfile_accel($stored_file, $mimetype, !$dontdie);
2418         }
2419     }
2420     if ($dontdie) {
2421         return;
2422     }
2423     die; //no more chars to output!!!
2426 /**
2427  * Retrieves an array of records from a CSV file and places
2428  * them into a given table structure
2429  *
2430  * @global stdClass $CFG
2431  * @global moodle_database $DB
2432  * @param string $file The path to a CSV file
2433  * @param string $table The table to retrieve columns from
2434  * @return bool|array Returns an array of CSV records or false
2435  */
2436 function get_records_csv($file, $table) {
2437     global $CFG, $DB;
2439     if (!$metacolumns = $DB->get_columns($table)) {
2440         return false;
2441     }
2443     if(!($handle = @fopen($file, 'r'))) {
2444         print_error('get_records_csv failed to open '.$file);
2445     }
2447     $fieldnames = fgetcsv($handle, 4096);
2448     if(empty($fieldnames)) {
2449         fclose($handle);
2450         return false;
2451     }
2453     $columns = array();
2455     foreach($metacolumns as $metacolumn) {
2456         $ord = array_search($metacolumn->name, $fieldnames);
2457         if(is_int($ord)) {
2458             $columns[$metacolumn->name] = $ord;
2459         }
2460     }
2462     $rows = array();
2464     while (($data = fgetcsv($handle, 4096)) !== false) {
2465         $item = new stdClass;
2466         foreach($columns as $name => $ord) {
2467             $item->$name = $data[$ord];
2468         }
2469         $rows[] = $item;
2470     }
2472     fclose($handle);
2473     return $rows;
2476 /**
2477  * Create a file with CSV contents
2478  *
2479  * @global stdClass $CFG
2480  * @global moodle_database $DB
2481  * @param string $file The file to put the CSV content into
2482  * @param array $records An array of records to write to a CSV file
2483  * @param string $table The table to get columns from
2484  * @return bool success
2485  */
2486 function put_records_csv($file, $records, $table = NULL) {
2487     global $CFG, $DB;
2489     if (empty($records)) {
2490         return true;
2491     }
2493     $metacolumns = NULL;
2494     if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2495         return false;
2496     }
2498     echo "x";
2500     if(!($fp = @fopen($CFG->tempdir.'/'.$file, 'w'))) {
2501         print_error('put_records_csv failed to open '.$file);
2502     }
2504     $proto = reset($records);
2505     if(is_object($proto)) {
2506         $fields_records = array_keys(get_object_vars($proto));
2507     }
2508     else if(is_array($proto)) {
2509         $fields_records = array_keys($proto);
2510     }
2511     else {
2512         return false;
2513     }
2514     echo "x";
2516     if(!empty($metacolumns)) {
2517         $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2518         $fields = array_intersect($fields_records, $fields_table);
2519     }
2520     else {
2521         $fields = $fields_records;
2522     }
2524     fwrite($fp, implode(',', $fields));
2525     fwrite($fp, "\r\n");
2527     foreach($records as $record) {
2528         $array  = (array)$record;
2529         $values = array();
2530         foreach($fields as $field) {
2531             if(strpos($array[$field], ',')) {
2532                 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2533             }
2534             else {
2535                 $values[] = $array[$field];
2536             }
2537         }
2538         fwrite($fp, implode(',', $values)."\r\n");
2539     }
2541     fclose($fp);
2542     return true;
2546 /**
2547  * Recursively delete the file or folder with path $location. That is,
2548  * if it is a file delete it. If it is a folder, delete all its content
2549  * then delete it. If $location does not exist to start, that is not
2550  * considered an error.
2551  *
2552  * @param string $location the path to remove.
2553  * @return bool
2554  */
2555 function fulldelete($location) {
2556     if (empty($location)) {
2557         // extra safety against wrong param
2558         return false;
2559     }
2560     if (is_dir($location)) {
2561         if (!$currdir = opendir($location)) {
2562             return false;
2563         }
2564         while (false !== ($file = readdir($currdir))) {
2565             if ($file <> ".." && $file <> ".") {
2566                 $fullfile = $location."/".$file;
2567                 if (is_dir($fullfile)) {
2568                     if (!fulldelete($fullfile)) {
2569                         return false;
2570                     }
2571                 } else {
2572                     if (!unlink($fullfile)) {
2573                         return false;
2574                     }
2575                 }
2576             }
2577         }
2578         closedir($currdir);
2579         if (! rmdir($location)) {
2580             return false;
2581         }
2583     } else if (file_exists($location)) {
2584         if (!unlink($location)) {
2585             return false;
2586         }
2587     }
2588     return true;
2591 /**
2592  * Send requested byterange of file.
2593  *
2594  * @param resource $handle A file handle
2595  * @param string $mimetype The mimetype for the output
2596  * @param array $ranges An array of ranges to send
2597  * @param string $filesize The size of the content if only one range is used
2598  */
2599 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2600     // better turn off any kind of compression and buffering
2601     @ini_set('zlib.output_compression', 'Off');
2603     $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2604     if ($handle === false) {
2605         die;
2606     }
2607     if (count($ranges) == 1) { //only one range requested
2608         $length = $ranges[0][2] - $ranges[0][1] + 1;
2609         header('HTTP/1.1 206 Partial content');
2610         header('Content-Length: '.$length);
2611         header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2612         header('Content-Type: '.$mimetype);
2614         while(@ob_get_level()) {
2615             if (!@ob_end_flush()) {
2616                 break;
2617             }
2618         }
2620         fseek($handle, $ranges[0][1]);
2621         while (!feof($handle) && $length > 0) {
2622             @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2623             $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2624             echo $buffer;
2625             flush();
2626             $length -= strlen($buffer);
2627         }
2628         fclose($handle);
2629         die;
2630     } else { // multiple ranges requested - not tested much
2631         $totallength = 0;
2632         foreach($ranges as $range) {
2633             $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2634         }
2635         $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2636         header('HTTP/1.1 206 Partial content');
2637         header('Content-Length: '.$totallength);
2638         header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2640         while(@ob_get_level()) {
2641             if (!@ob_end_flush()) {
2642                 break;
2643             }
2644         }
2646         foreach($ranges as $range) {
2647             $length = $range[2] - $range[1] + 1;
2648             echo $range[0];
2649             fseek($handle, $range[1]);
2650             while (!feof($handle) && $length > 0) {
2651                 @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2652                 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2653                 echo $buffer;
2654                 flush();
2655                 $length -= strlen($buffer);
2656             }
2657         }
2658         echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2659         fclose($handle);
2660         die;
2661     }
2664 /**
2665  * add includes (js and css) into uploaded files
2666  * before returning them, useful for themes and utf.js includes
2667  *
2668  * @global stdClass $CFG
2669  * @param string $text text to search and replace
2670  * @return string text with added head includes
2671  * @todo MDL-21120
2672  */
2673 function file_modify_html_header($text) {
2674     // first look for <head> tag
2675     global $CFG;
2677     $stylesheetshtml = '';
2678 /*    foreach ($CFG->stylesheets as $stylesheet) {
2679         //TODO: MDL-21120
2680         $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2681     }*/
2683     $ufo = '';
2684     if (filter_is_enabled('filter/mediaplugin')) {
2685         // this script is needed by most media filter plugins.
2686         $attributes = array('type'=>'text/javascript', 'src'=>$CFG->httpswwwroot . '/lib/ufo.js');
2687         $ufo = html_writer::tag('script', '', $attributes) . "\n";
2688     }
2690     preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2691     if ($matches) {
2692         $replacement = '<head>'.$ufo.$stylesheetshtml;
2693         $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2694         return $text;
2695     }
2697     // if not, look for <html> tag, and stick <head> right after
2698     preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2699     if ($matches) {
2700         // replace <html> tag with <html><head>includes</head>
2701         $replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
2702         $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2703         return $text;
2704     }
2706     // if not, look for <body> tag, and stick <head> before body
2707     preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2708     if ($matches) {
2709         $replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
2710         $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2711         return $text;
2712     }
2714     // if not, just stick a <head> tag at the beginning
2715     $text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
2716     return $text;
2719 /**
2720  * RESTful cURL class
2721  *
2722  * This is a wrapper class for curl, it is quite easy to use:
2723  * <code>
2724  * $c = new curl;
2725  * // enable cache
2726  * $c = new curl(array('cache'=>true));
2727  * // enable cookie
2728  * $c = new curl(array('cookie'=>true));
2729  * // enable proxy
2730  * $c = new curl(array('proxy'=>true));
2731  *
2732  * // HTTP GET Method
2733  * $html = $c->get('http://example.com');
2734  * // HTTP POST Method
2735  * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2736  * // HTTP PUT Method
2737  * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2738  * </code>
2739  *
2740  * @package   core_files
2741  * @category files
2742  * @copyright Dongsheng Cai <dongsheng@moodle.com>
2743  * @license   http://www.gnu.org/copyleft/gpl.html GNU Public License
2744  */
2745 class curl {
2746     /** @var bool Caches http request contents */
2747     public  $cache    = false;
2748     /** @var bool Uses proxy */
2749     public  $proxy    = false;
2750     /** @var string library version */
2751     public  $version  = '0.4 dev';
2752     /** @var array http's response */
2753     public  $response = array();
2754     /** @var array http header */
2755     public  $header   = array();
2756     /** @var string cURL information */
2757     public  $info;
2758     /** @var string error */
2759     public  $error;
2761     /** @var array cURL options */
2762     private $options;
2763     /** @var string Proxy host */
2764     private $proxy_host = '';
2765     /** @var string Proxy auth */
2766     private $proxy_auth = '';
2767     /** @var string Proxy type */
2768     private $proxy_type = '';
2769     /** @var bool Debug mode on */
2770     private $debug    = false;
2771     /** @var bool|string Path to cookie file */
2772     private $cookie   = false;
2774     /**
2775      * Constructor
2776      *
2777      * @global stdClass $CFG
2778      * @param array $options
2779      */
2780     public function __construct($options = array()){
2781         global $CFG;
2782         if (!function_exists('curl_init')) {
2783             $this->error = 'cURL module must be enabled!';
2784             trigger_error($this->error, E_USER_ERROR);
2785             return false;
2786         }
2787         // the options of curl should be init here.
2788         $this->resetopt();
2789         if (!empty($options['debug'])) {
2790             $this->debug = true;
2791         }
2792         if(!empty($options['cookie'])) {
2793             if($options['cookie'] === true) {
2794                 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2795             } else {
2796                 $this->cookie = $options['cookie'];
2797             }
2798         }
2799         if (!empty($options['cache'])) {
2800             if (class_exists('curl_cache')) {
2801                 if (!empty($options['module_cache'])) {
2802                     $this->cache = new curl_cache($options['module_cache']);
2803                 } else {
2804                     $this->cache = new curl_cache('misc');
2805                 }
2806             }
2807         }
2808         if (!empty($CFG->proxyhost)) {
2809             if (empty($CFG->proxyport)) {
2810                 $this->proxy_host = $CFG->proxyhost;
2811             } else {
2812                 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2813             }
2814             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2815                 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2816                 $this->setopt(array(
2817                             'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2818                             'proxyuserpwd'=>$this->proxy_auth));
2819             }
2820             if (!empty($CFG->proxytype)) {
2821                 if ($CFG->proxytype == 'SOCKS5') {
2822                     $this->proxy_type = CURLPROXY_SOCKS5;
2823                 } else {
2824                     $this->proxy_type = CURLPROXY_HTTP;
2825                     $this->setopt(array('httpproxytunnel'=>false));
2826                 }
2827                 $this->setopt(array('proxytype'=>$this->proxy_type));
2828             }
2829         }
2830         if (!empty($this->proxy_host)) {
2831             $this->proxy = array('proxy'=>$this->proxy_host);
2832         }
2833     }
2834     /**
2835      * Resets the CURL options that have already been set
2836      */
2837     public function resetopt(){
2838         $this->options = array();
2839         $this->options['CURLOPT_USERAGENT']         = 'MoodleBot/1.0';
2840         // True to include the header in the output
2841         $this->options['CURLOPT_HEADER']            = 0;
2842         // True to Exclude the body from the output
2843         $this->options['CURLOPT_NOBODY']            = 0;
2844         // TRUE to follow any "Location: " header that the server
2845         // sends as part of the HTTP header (note this is recursive,
2846         // PHP will follow as many "Location: " headers that it is sent,
2847         // unless CURLOPT_MAXREDIRS is set).
2848         //$this->options['CURLOPT_FOLLOWLOCATION']    = 1;
2849         $this->options['CURLOPT_MAXREDIRS']         = 10;
2850         $this->options['CURLOPT_ENCODING']          = '';
2851         // TRUE to return the transfer as a string of the return
2852         // value of curl_exec() instead of outputting it out directly.
2853         $this->options['CURLOPT_RETURNTRANSFER']    = 1;
2854         $this->options['CURLOPT_BINARYTRANSFER']    = 0;
2855         $this->options['CURLOPT_SSL_VERIFYPEER']    = 0;
2856         $this->options['CURLOPT_SSL_VERIFYHOST']    = 2;
2857         $this->options['CURLOPT_CONNECTTIMEOUT']    = 30;
2858     }
2860     /**
2861      * Reset Cookie
2862      */
2863     public function resetcookie() {
2864         if (!empty($this->cookie)) {
2865             if (is_file($this->cookie)) {
2866                 $fp = fopen($this->cookie, 'w');
2867                 if (!empty($fp)) {
2868                     fwrite($fp, '');
2869                     fclose($fp);
2870                 }
2871             }
2872         }
2873     }
2875     /**
2876      * Set curl options
2877      *
2878      * @param array $options If array is null, this function will
2879      * reset the options to default value.
2880      */
2881     public function setopt($options = array()) {
2882         if (is_array($options)) {
2883             foreach($options as $name => $val){
2884                 if (stripos($name, 'CURLOPT_') === false) {
2885                     $name = strtoupper('CURLOPT_'.$name);
2886                 }
2887                 $this->options[$name] = $val;
2888             }
2889         }
2890     }
2892     /**
2893      * Reset http method
2894      */
2895     public function cleanopt(){
2896         unset($this->options['CURLOPT_HTTPGET']);
2897         unset($this->options['CURLOPT_POST']);
2898         unset($this->options['CURLOPT_POSTFIELDS']);
2899         unset($this->options['CURLOPT_PUT']);
2900         unset($this->options['CURLOPT_INFILE']);
2901         unset($this->options['CURLOPT_INFILESIZE']);
2902         unset($this->options['CURLOPT_CUSTOMREQUEST']);
2903     }
2905     /**
2906      * Set HTTP Request Header
2907      *
2908      * @param array $header
2909      */
2910     public function setHeader($header) {
2911         if (is_array($header)){
2912             foreach ($header as $v) {
2913                 $this->setHeader($v);
2914             }
2915         } else {
2916             $this->header[] = $header;
2917         }
2918     }
2920     /**
2921      * Set HTTP Response Header
2922      *
2923      */
2924     public function getResponse(){
2925         return $this->response;
2926     }
2928     /**
2929      * private callback function
2930      * Formatting HTTP Response Header
2931      *
2932      * @param resource $ch Apparently not used
2933      * @param string $header
2934      * @return int The strlen of the header
2935      */
2936     private function formatHeader($ch, $header)
2937     {
2938         $this->count++;
2939         if (strlen($header) > 2) {
2940             list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
2941             $key = rtrim($key, ':');
2942             if (!empty($this->response[$key])) {
2943                 if (is_array($this->response[$key])){
2944                     $this->response[$key][] = $value;
2945                 } else {
2946                     $tmp = $this->response[$key];
2947                     $this->response[$key] = array();
2948                     $this->response[$key][] = $tmp;
2949                     $this->response[$key][] = $value;
2951                 }
2952             } else {
2953                 $this->response[$key] = $value;
2954             }
2955         }
2956         return strlen($header);
2957     }
2959     /**
2960      * Set options for individual curl instance
2961      *
2962      * @param resource $curl A curl handle
2963      * @param array $options
2964      * @return resource The curl handle
2965      */
2966     private function apply_opt($curl, $options) {
2967         // Clean up
2968         $this->cleanopt();
2969         // set cookie
2970         if (!empty($this->cookie) || !empty($options['cookie'])) {
2971             $this->setopt(array('cookiejar'=>$this->cookie,
2972                             'cookiefile'=>$this->cookie
2973                              ));
2974         }
2976         // set proxy
2977         if (!empty($this->proxy) || !empty($options['proxy'])) {
2978             $this->setopt($this->proxy);
2979         }
2980         $this->setopt($options);
2981         // reset before set options
2982         curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
2983         // set headers
2984         if (empty($this->header)){
2985             $this->setHeader(array(
2986                 'User-Agent: MoodleBot/1.0',
2987                 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
2988                 'Connection: keep-alive'
2989                 ));
2990         }
2991         curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
2993         if ($this->debug){
2994             echo '<h1>Options</h1>';
2995             var_dump($this->options);
2996             echo '<h1>Header</h1>';
2997             var_dump($this->header);
2998         }
3000         // set options
3001         foreach($this->options as $name => $val) {
3002             if (is_string($name)) {
3003                 $name = constant(strtoupper($name));
3004             }
3005             curl_setopt($curl, $name, $val);
3006         }
3007         return $curl;
3008     }
3010     /**
3011      * Download multiple files in parallel
3012      *
3013      * Calls {@link multi()} with specific download headers
3014      *
3015      * <code>
3016      * $c = new curl();
3017      * $file1 = fopen('a', 'wb');
3018      * $file2 = fopen('b', 'wb');
3019      * $c->download(array(
3020      *     array('url'=>'http://localhost/', 'file'=>$file1),
3021      *     array('url'=>'http://localhost/20/', 'file'=>$file2)
3022      * ));
3023      * fclose($file1);
3024      * fclose($file2);
3025      * </code>
3026      *
3027      * or
3028      *
3029      * <code>
3030      * $c = new curl();
3031      * $c->download(array(
3032      *              array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3033      *              array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3034      *              ));
3035      * </code>
3036      *
3037      * @param array $requests An array of files to request {
3038      *                  url => url to download the file [required]
3039      *                  file => file handler, or
3040      *                  filepath => file path
3041      * }
3042      * If 'file' and 'filepath' parameters are both specified in one request, the
3043      * open file handle in the 'file' parameter will take precedence and 'filepath'
3044      * will be ignored.
3045      *
3046      * @param array $options An array of options to set
3047      * @return array An array of results
3048      */
3049     public function download($requests, $options = array()) {
3050         $options['CURLOPT_BINARYTRANSFER'] = 1;
3051         $options['RETURNTRANSFER'] = false;
3052         return $this->multi($requests, $options);
3053     }
3055     /**
3056      * Mulit HTTP Requests
3057      * This function could run multi-requests in parallel.
3058      *
3059      * @param array $requests An array of files to request
3060      * @param array $options An array of options to set
3061      * @return array An array of results
3062      */
3063     protected function multi($requests, $options = array()) {
3064         $count   = count($requests);
3065         $handles = array();
3066         $results = array();
3067         $main    = curl_multi_init();
3068         for ($i = 0; $i < $count; $i++) {
3069             if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3070                 // open file
3071                 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3072                 $requests[$i]['auto-handle'] = true;
3073             }
3074             foreach($requests[$i] as $n=>$v){
3075                 $options[$n] = $v;
3076             }
3077             $handles[$i] = curl_init($requests[$i]['url']);
3078             $this->apply_opt($handles[$i], $options);
3079             curl_multi_add_handle($main, $handles[$i]);
3080         }
3081         $running = 0;
3082         do {
3083             curl_multi_exec($main, $running);
3084         } while($running > 0);
3085         for ($i = 0; $i < $count; $i++) {
3086             if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3087                 $results[] = true;
3088             } else {
3089                 $results[] = curl_multi_getcontent($handles[$i]);
3090             }
3091             curl_multi_remove_handle($main, $handles[$i]);
3092         }
3093         curl_multi_close($main);
3095         for ($i = 0; $i < $count; $i++) {
3096             if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3097                 // close file handler if file is opened in this function
3098                 fclose($requests[$i]['file']);
3099             }
3100         }
3101         return $results;
3102     }
3104     /**
3105      * Single HTTP Request
3106      *
3107      * @param string $url The URL to request
3108      * @param array $options
3109      * @return bool
3110      */
3111     protected function request($url, $options = array()){
3112         // create curl instance
3113         $curl = curl_init($url);
3114         $options['url'] = $url;
3115         $this->apply_opt($curl, $options);
3116         if ($this->cache && $ret = $this->cache->get($this->options)) {
3117             return $ret;
3118         } else {
3119             $ret = curl_exec($curl);
3120             if ($this->cache) {
3121                 $this->cache->set($this->options, $ret);
3122             }
3123         }
3125         $this->info  = curl_getinfo($curl);
3126         $this->error = curl_error($curl);
3128         if ($this->debug){
3129             echo '<h1>Return Data</h1>';
3130             var_dump($ret);
3131             echo '<h1>Info</h1>';
3132             var_dump($this->info);
3133             echo '<h1>Error</h1>';
3134             var_dump($this->error);
3135         }
3137         curl_close($curl);
3139         if (empty($this->error)){
3140             return $ret;
3141         } else {
3142             return $this->error;
3143             // exception is not ajax friendly
3144             //throw new moodle_exception($this->error, 'curl');
3145         }
3146     }
3148     /**
3149      * HTTP HEAD method
3150      *
3151      * @see request()
3152      *
3153      * @param string $url
3154      * @param array $options
3155      * @return bool
3156      */
3157     public function head($url, $options = array()){
3158         $options['CURLOPT_HTTPGET'] = 0;
3159         $options['CURLOPT_HEADER']  = 1;
3160         $options['CURLOPT_NOBODY']  = 1;
3161         return $this->request($url, $options);
3162     }
3164     /**
3165      * HTTP POST method
3166      *
3167      * @param string $url
3168      * @param array|string $params
3169      * @param array $options
3170      * @return bool
3171      */
3172     public function post($url, $params = '', $options = array()){
3173         $options['CURLOPT_POST']       = 1;
3174         if (is_array($params)) {
3175             $this->_tmp_file_post_params = array();
3176             foreach ($params as $key => $value) {
3177                 if ($value instanceof stored_file) {
3178                     $value->add_to_curl_request($this, $key);
3179                 } else {
3180                     $this->_tmp_file_post_params[$key] = $value;
3181                 }
3182             }
3183             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3184             unset($this->_tmp_file_post_params);
3185         } else {
3186             // $params is the raw post data
3187             $options['CURLOPT_POSTFIELDS'] = $params;
3188         }
3189         return $this->request($url, $options);
3190     }
3192     /**
3193      * HTTP GET method
3194      *
3195      * @param string $url
3196      * @param array $params
3197      * @param array $options
3198      * @return bool
3199      */
3200     public function get($url, $params = array(), $options = array()){
3201         $options['CURLOPT_HTTPGET'] = 1;
3203         if (!empty($params)){
3204             $url .= (stripos($url, '?') !== false) ? '&' : '?';
3205             $url .= http_build_query($params, '', '&');
3206         }
3207         return $this->request($url, $options);
3208     }
3210     /**
3211      * HTTP PUT method
3212      *
3213      * @param string $url
3214      * @param array $params
3215      * @param array $options
3216      * @return bool
3217      */
3218     public function put($url, $params = array(), $options = array()){
3219         $file = $params['file'];
3220         if (!is_file($file)){
3221             return null;
3222         }
3223         $fp   = fopen($file, 'r');
3224         $size = filesize($file);
3225         $options['CURLOPT_PUT']        = 1;
3226         $options['CURLOPT_INFILESIZE'] = $size;
3227         $options['CURLOPT_INFILE']     = $fp;
3228         if (!isset($this->options['CURLOPT_USERPWD'])){
3229             $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
3230         }
3231         $ret = $this->request($url, $options);
3232         fclose($fp);
3233         return $ret;
3234     }
3236     /**
3237      * HTTP DELETE method
3238      *
3239      * @param string $url
3240      * @param array $param
3241      * @param array $options
3242      * @return bool
3243      */
3244     public function delete($url, $param = array(), $options = array()){
3245         $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
3246         if (!isset($options['CURLOPT_USERPWD'])) {
3247             $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
3248         }
3249         $ret = $this->request($url, $options);
3250         return $ret;
3251     }
3253     /**
3254      * HTTP TRACE method
3255      *
3256      * @param string $url
3257      * @param array $options
3258      * @return bool
3259      */
3260     public function trace($url, $options = array()){
3261         $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
3262         $ret = $this->request($url, $options);
3263         return $ret;
3264     }
3266     /**
3267      * HTTP OPTIONS method
3268      *
3269      * @param string $url
3270      * @param array $options
3271      * @return bool
3272      */
3273     public function options($url, $options = array()){
3274         $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
3275         $ret = $this->request($url, $options);
3276         return $ret;
3277     }
3279     /**
3280      * Get curl information
3281      *
3282      * @return string
3283      */
3284     public function get_info() {
3285         return $this->info;
3286     }
3289 /**
3290  * This class is used by cURL class, use case:
3291  *
3292  * <code>
3293  * $CFG->repositorycacheexpire = 120;
3294  * $CFG->curlcache = 120;
3295  *
3296  * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
3297  * $ret = $c->get('http://www.google.com');
3298  * </code>
3299  *
3300  * @package   core_files
3301  * @copyright Dongsheng Cai <dongsheng@moodle.com>
3302  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3303  */
3304 class curl_cache {
3305     /** @var string Path to cache directory */
3306     public $dir = '';
3308     /**
3309      * Constructor
3310      *
3311      * @global stdClass $CFG
3312      * @param string $module which module is using curl_cache
3313      */
3314     public function __construct($module = 'repository') {
3315         global $CFG;
3316         if (!empty($module)) {
3317             $this->dir = $CFG->cachedir.'/'.$module.'/';
3318         } else {
3319             $this->dir = $CFG->cachedir.'/misc/';
3320         }
3321         if (!file_exists($this->dir)) {
3322             mkdir($this->dir, $CFG->directorypermissions, true);
3323         }
3324         if ($module == 'repository') {
3325             if (empty($CFG->repositorycacheexpire)) {
3326                 $CFG->repositorycacheexpire = 120;
3327             }
3328             $this->ttl = $CFG->repositorycacheexpire;
3329         } else {
3330             if (empty($CFG->curlcache)) {
3331                 $CFG->curlcache = 120;
3332             }
3333             $this->ttl = $CFG->curlcache;
3334         }
3335     }
3337     /**
3338      * Get cached value
3339      *
3340      * @global stdClass $CFG
3341      * @global stdClass $USER
3342      * @param mixed $param
3343      * @return bool|string
3344      */
3345     public function get($param) {
3346         global $CFG, $USER;
3347         $this->cleanup($this->ttl);
3348         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3349         if(file_exists($this->dir.$filename)) {
3350             $lasttime = filemtime($this->dir.$filename);
3351             if (time()-$lasttime > $this->ttl) {
3352                 return false;
3353             } else {
3354                 $fp = fopen($this->dir.$filename, 'r');
3355                 $size = filesize($this->dir.$filename);
3356                 $content = fread($fp, $size);
3357                 return unserialize($content);
3358             }
3359         }
3360         return false;
3361     }
3363     /**
3364      * Set cache value
3365      *
3366      * @global object $CFG
3367      * @global object $USER
3368      * @param mixed $param
3369      * @param mixed $val
3370      */
3371     public function set($param, $val) {
3372         global $CFG, $USER;
3373         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3374         $fp = fopen($this->dir.$filename, 'w');
3375         fwrite($fp, serialize($val));
3376         fclose($fp);
3377     }
3379     /**
3380      * Remove cache files
3381      *
3382      * @param int $expire The number of seconds before expiry
3383      */
3384     public function cleanup($expire) {
3385         if ($dir = opendir($this->dir)) {
3386             while (false !== ($file = readdir($dir))) {
3387                 if(!is_dir($file) && $file != '.' && $file != '..') {
3388                     $lasttime = @filemtime($this->dir.$file);
3389                     if (time() - $lasttime > $expire) {
3390                         @unlink($this->dir.$file);
3391                     }
3392                 }
3393             }
3394             closedir($dir);
3395         }
3396     }
3397     /**
3398      * delete current user's cache file
3399      *
3400      * @global object $CFG
3401      * @global object $USER
3402      */
3403     public function refresh() {
3404         global $CFG, $USER;
3405         if ($dir = opendir($this->dir)) {
3406             while (false !== ($file = readdir($dir))) {
3407                 if (!is_dir($file) && $file != '.' && $file != '..') {
3408                     if (strpos($file, 'u'.$USER->id.'_') !== false) {
3409                         @unlink($this->dir.$file);
3410                     }
3411                 }
3412             }
3413         }
3414     }
3417 /**
3418  * This function delegates file serving to individual plugins
3419  *
3420  * @param string $relativepath
3421  * @param bool $forcedownload
3422  * @param null|string $preview the preview mode, defaults to serving the original file
3423  * @todo MDL-31088 file serving improments
3424  */
3425 function file_pluginfile($relativepath, $forcedownload, $preview = null) {
3426     global $DB, $CFG, $USER;
3427     // relative path must start with '/'
3428     if (!$relativepath) {
3429         print_error('invalidargorconf');
3430     } else if ($relativepath[0] != '/') {
3431         print_error('pathdoesnotstartslash');
3432     }
3434     // extract relative path components
3435     $args = explode('/', ltrim($relativepath, '/'));
3437     if (count($args) < 3) { // always at least context, component and filearea
3438         print_error('invalidarguments');
3439     }
3441     $contextid = (int)array_shift($args);
3442     $component = clean_param(array_shift($args), PARAM_COMPONENT);
3443     $filearea  = clean_param(array_shift($args), PARAM_AREA);
3445     list($context, $course, $cm) = get_context_info_array($contextid);
3447     $fs = get_file_storage();
3449     // ========================================================================================================================
3450     if ($component === 'blog') {
3451         // Blog file serving
3452         if ($context->contextlevel != CONTEXT_SYSTEM) {
3453             send_file_not_found();
3454         }
3455         if ($filearea !== 'attachment' and $filearea !== 'post') {
3456             send_file_not_found();
3457         }
3459         if (empty($CFG->enableblogs)) {
3460             print_error('siteblogdisable', 'blog');
3461         }
3463         $entryid = (int)array_shift($args);
3464         if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3465             send_file_not_found();
3466         }
3467         if ($CFG->bloglevel < BLOG_GLOBAL_LEVEL) {
3468             require_login();
3469             if (isguestuser()) {
3470                 print_error('noguest');
3471             }
3472             if ($CFG->bloglevel == BLOG_USER_LEVEL) {
3473                 if ($USER->id != $entry->userid) {
3474                     send_file_not_found();
3475                 }
3476             }
3477         }
3479         if ($entry->publishstate === 'public') {
3480             if ($CFG->forcelogin) {
3481                 require_login();
3482             }
3484         } else if ($entry->publishstate === 'site') {
3485             require_login();
3486             //ok
3487         } else if ($entry->publishstate === 'draft') {
3488             require_login();
3489             if ($USER->id != $entry->userid) {
3490                 send_file_not_found();
3491             }
3492         }
3494         $filename = array_pop($args);
3495         $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3497         if (!$file = $fs->get_file($context->id, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3498             send_file_not_found();
3499         }
3501         send_stored_file($file, 10*60, 0, true, array('preview' => $preview)); // download MUST be forced - security!
3503     // ========================================================================================================================
3504     } else if ($component === 'grade') {
3505         if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel == CONTEXT_SYSTEM) {
3506             // Global gradebook files
3507             if ($CFG->forcelogin) {
3508                 require_login();
3509             }
3511             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3513             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3514                 send_file_not_found();
3515             }
3517             session_get_instance()->write_close(); // unlock session during fileserving
3518             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3520         } else if ($filearea === 'feedback' and $context->contextlevel == CONTEXT_COURSE) {
3521             //TODO: nobody implemented this yet in grade edit form!!
3522             send_file_not_found();
3524             if ($CFG->forcelogin || $course->id != SITEID) {
3525                 require_login($course);
3526             }
3528             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3530             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3531                 send_file_not_found();
3532             }
3534             session_get_instance()->write_close(); // unlock session during fileserving
3535             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3536         } else {
3537             send_file_not_found();
3538         }
3540     // ========================================================================================================================
3541     } else if ($component === 'tag') {
3542         if ($filearea === 'description' and $context->contextlevel == CONTEXT_SYSTEM) {
3544             // All tag descriptions are going to be public but we still need to respect forcelogin