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