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