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