MDL-46375 core_files: Split parts of file_storage into new file system
[moodle.git] / lib / filestorage / stored_file.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Definition of a class stored_file.
20  *
21  * @package   core_files
22  * @copyright 2008 Petr Skoda {@link http://skodak.org}
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->dirroot . '/lib/filestorage/file_progress.php');
29 require_once($CFG->dirroot . '/lib/filestorage/file_system.php');
31 /**
32  * Class representing local files stored in a sha1 file pool.
33  *
34  * Since Moodle 2.0 file contents are stored in sha1 pool and
35  * all other file information is stored in new "files" database table.
36  *
37  * @package   core_files
38  * @category  files
39  * @copyright 2008 Petr Skoda {@link http://skodak.org}
40  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  * @since     Moodle 2.0
42  */
43 class stored_file {
44     /** @var file_storage file storage pool instance */
45     private $fs;
46     /** @var stdClass record from the files table left join files_reference table */
47     private $file_record;
48     /** @var repository repository plugin instance */
49     private $repository;
50     /** @var file_system filesystem instance */
51     private $filesystem;
53     /**
54      * @var int Indicates a file handle of the type returned by fopen.
55      */
56     const FILE_HANDLE_FOPEN = 0;
58     /**
59      * @var int Indicates a file handle of the type returned by gzopen.
60      */
61     const FILE_HANDLE_GZOPEN = 1;
64     /**
65      * Constructor, this constructor should be called ONLY from the file_storage class!
66      *
67      * @param file_storage $fs file  storage instance
68      * @param stdClass $file_record description of file
69      * @param string $deprecated
70      */
71     public function __construct(file_storage $fs, stdClass $file_record, $deprecated = null) {
72         global $DB, $CFG;
73         $this->fs          = $fs;
74         $this->file_record = clone($file_record); // prevent modifications
76         if (!empty($file_record->repositoryid)) {
77             require_once("$CFG->dirroot/repository/lib.php");
78             $this->repository = repository::get_repository_by_id($file_record->repositoryid, SYSCONTEXTID);
79             if ($this->repository->supported_returntypes() & FILE_REFERENCE != FILE_REFERENCE) {
80                 // Repository cannot do file reference.
81                 throw new moodle_exception('error');
82             }
83         } else {
84             $this->repository = null;
85         }
86         // make sure all reference fields exist in file_record even when it is not a reference
87         foreach (array('referencelastsync', 'referencefileid', 'reference', 'repositoryid') as $key) {
88             if (empty($this->file_record->$key)) {
89                 $this->file_record->$key = null;
90             }
91         }
93         $this->filesystem = $fs->get_file_system();
94     }
96     /**
97      * Whether or not this is a external resource
98      *
99      * @return bool
100      */
101     public function is_external_file() {
102         return !empty($this->repository);
103     }
105     /**
106      * Update some file record fields
107      * NOTE: Must remain protected
108      *
109      * @param stdClass $dataobject
110      */
111     protected function update($dataobject) {
112         global $DB;
113         $updatereferencesneeded = false;
114         $keys = array_keys((array)$this->file_record);
115         foreach ($dataobject as $field => $value) {
116             if (in_array($field, $keys)) {
117                 if ($field == 'contextid' and (!is_number($value) or $value < 1)) {
118                     throw new file_exception('storedfileproblem', 'Invalid contextid');
119                 }
121                 if ($field == 'component') {
122                     $value = clean_param($value, PARAM_COMPONENT);
123                     if (empty($value)) {
124                         throw new file_exception('storedfileproblem', 'Invalid component');
125                     }
126                 }
128                 if ($field == 'filearea') {
129                     $value = clean_param($value, PARAM_AREA);
130                     if (empty($value)) {
131                         throw new file_exception('storedfileproblem', 'Invalid filearea');
132                     }
133                 }
135                 if ($field == 'itemid' and (!is_number($value) or $value < 0)) {
136                     throw new file_exception('storedfileproblem', 'Invalid itemid');
137                 }
140                 if ($field == 'filepath') {
141                     $value = clean_param($value, PARAM_PATH);
142                     if (strpos($value, '/') !== 0 or strrpos($value, '/') !== strlen($value)-1) {
143                         // path must start and end with '/'
144                         throw new file_exception('storedfileproblem', 'Invalid file path');
145                     }
146                 }
148                 if ($field == 'filename') {
149                     // folder has filename == '.', so we pass this
150                     if ($value != '.') {
151                         $value = clean_param($value, PARAM_FILE);
152                     }
153                     if ($value === '') {
154                         throw new file_exception('storedfileproblem', 'Invalid file name');
155                     }
156                 }
158                 if ($field === 'timecreated' or $field === 'timemodified') {
159                     if (!is_number($value)) {
160                         throw new file_exception('storedfileproblem', 'Invalid timestamp');
161                     }
162                     if ($value < 0) {
163                         $value = 0;
164                     }
165                 }
167                 if ($field === 'referencefileid') {
168                     if (!is_null($value) and !is_number($value)) {
169                         throw new file_exception('storedfileproblem', 'Invalid reference info');
170                     }
171                 }
173                 if (($field == 'contenthash' || $field == 'filesize') && $this->file_record->$field != $value) {
174                     $updatereferencesneeded = true;
175                 }
177                 // adding the field
178                 $this->file_record->$field = $value;
179             } else {
180                 throw new coding_exception("Invalid field name, $field doesn't exist in file record");
181             }
182         }
183         // Validate mimetype field
184         $mimetype = $this->filesystem->mimetype_from_storedfile($this);
185         $this->file_record->mimetype = $mimetype;
187         $DB->update_record('files', $this->file_record);
188         if ($updatereferencesneeded) {
189             // Either filesize or contenthash of this file have changed. Update all files that reference to it.
190             $this->fs->update_references_to_storedfile($this);
191         }
192     }
194     /**
195      * Rename filename
196      *
197      * @param string $filepath file path
198      * @param string $filename file name
199      */
200     public function rename($filepath, $filename) {
201         if ($this->fs->file_exists($this->get_contextid(), $this->get_component(), $this->get_filearea(), $this->get_itemid(), $filepath, $filename)) {
202             $a = new stdClass();
203             $a->contextid = $this->get_contextid();
204             $a->component = $this->get_component();
205             $a->filearea  = $this->get_filearea();
206             $a->itemid    = $this->get_itemid();
207             $a->filepath  = $filepath;
208             $a->filename  = $filename;
209             throw new file_exception('storedfilenotcreated', $a, 'file exists, cannot rename');
210         }
211         $filerecord = new stdClass;
212         $filerecord->filepath = $filepath;
213         $filerecord->filename = $filename;
214         // populate the pathname hash
215         $filerecord->pathnamehash = $this->fs->get_pathname_hash($this->file_record->contextid, $this->file_record->component, $this->file_record->filearea, $this->file_record->itemid, $filepath, $filename);
216         $this->update($filerecord);
217     }
219     /**
220      * Function stored_file::replace_content_with() is deprecated. Please use stored_file::replace_file_with()
221      *
222      * @deprecated since Moodle 2.6 MDL-42016 - please do not use this function any more.
223      * @see stored_file::replace_file_with()
224      */
225     public function replace_content_with(stored_file $storedfile) {
226         throw new coding_exception('Function stored_file::replace_content_with() can not be used any more . ' .
227             'Please use stored_file::replace_file_with()');
228     }
230     /**
231      * Replaces the fields that might have changed when file was overriden in filepicker:
232      * reference, contenthash, filesize, userid
233      *
234      * Note that field 'source' must be updated separately because
235      * it has different format for draft and non-draft areas and
236      * this function will usually be used to replace non-draft area
237      * file with draft area file.
238      *
239      * @param stored_file $newfile
240      * @throws coding_exception
241      */
242     public function replace_file_with(stored_file $newfile) {
243         if ($newfile->get_referencefileid() &&
244                 $this->fs->get_references_count_by_storedfile($this)) {
245             // The new file is a reference.
246             // The current file has other local files referencing to it.
247             // Double reference is not allowed.
248             throw new moodle_exception('errordoublereference', 'repository');
249         }
251         $filerecord = new stdClass;
252         if ($this->filesystem->is_file_readable_remotely_by_storedfile($newfile)) {
253             $contenthash = $newfile->get_contenthash();
254             $filerecord->contenthash = $contenthash;
255         } else {
256             throw new file_exception('storedfileproblem', 'Invalid contenthash, content must be already in filepool', $contenthash);
257         }
258         $filerecord->filesize = $newfile->get_filesize();
259         $filerecord->referencefileid = $newfile->get_referencefileid();
260         $filerecord->userid = $newfile->get_userid();
261         $this->update($filerecord);
262     }
264     /**
265      * Unlink the stored file from the referenced file
266      *
267      * This methods destroys the link to the record in files_reference table. This effectively
268      * turns the stored file from being an alias to a plain copy. However, the caller has
269      * to make sure that the actual file's content has beed synced prior to calling this method.
270      */
271     public function delete_reference() {
272         global $DB;
274         if (!$this->is_external_file()) {
275             throw new coding_exception('An attempt to unlink a non-reference file.');
276         }
278         $transaction = $DB->start_delegated_transaction();
280         // Are we the only one referring to the original file? If so, delete the
281         // referenced file record. Note we do not use file_storage::search_references_count()
282         // here because we want to count draft files too and we are at a bit lower access level here.
283         $countlinks = $DB->count_records('files',
284             array('referencefileid' => $this->file_record->referencefileid));
285         if ($countlinks == 1) {
286             $DB->delete_records('files_reference', array('id' => $this->file_record->referencefileid));
287         }
289         // Update the underlying record in the database.
290         $update = new stdClass();
291         $update->referencefileid = null;
292         $this->update($update);
294         $transaction->allow_commit();
296         // Update our properties and the record in the memory.
297         $this->repository = null;
298         $this->file_record->repositoryid = null;
299         $this->file_record->reference = null;
300         $this->file_record->referencefileid = null;
301         $this->file_record->referencelastsync = null;
302     }
304     /**
305      * Is this a directory?
306      *
307      * Directories are only emulated, internally they are stored as empty
308      * files with a "." instead of name - this means empty directory contains
309      * exactly one empty file with name dot.
310      *
311      * @return bool true means directory, false means file
312      */
313     public function is_directory() {
314         return ($this->file_record->filename === '.');
315     }
317     /**
318      * Delete file from files table.
319      *
320      * The content of files stored in sha1 pool is reclaimed
321      * later - the occupied disk space is reclaimed much later.
322      *
323      * @return bool always true or exception if error occurred
324      */
325     public function delete() {
326         global $DB;
328         if ($this->is_directory()) {
329             // Directories can not be referenced, just delete the record.
330             $DB->delete_records('files', array('id'=>$this->file_record->id));
332         } else {
333             $transaction = $DB->start_delegated_transaction();
335             // If there are other files referring to this file, convert them to copies.
336             if ($files = $this->fs->get_references_by_storedfile($this)) {
337                 foreach ($files as $file) {
338                     $this->fs->import_external_file($file);
339                 }
340             }
342             // If this file is a reference (alias) to another file, unlink it first.
343             if ($this->is_external_file()) {
344                 $this->delete_reference();
345             }
347             // Now delete the file record.
348             $DB->delete_records('files', array('id'=>$this->file_record->id));
350             $transaction->allow_commit();
351         }
353         // Move pool file to trash if content not needed any more.
354         $this->filesystem->remove_file($this->file_record->contenthash);
355         return true; // BC only
356     }
358     /**
359     * adds this file path to a curl request (POST only)
360     *
361     * @param curl $curlrequest the curl request object
362     * @param string $key what key to use in the POST request
363     * @return void
364     */
365     public function add_to_curl_request(&$curlrequest, $key) {
366         return $this->filesystem->add_to_curl_request($this, $curlrequest, $key);
367     }
369     /**
370      * Returns file handle - read only mode, no writing allowed into pool files!
371      *
372      * When you want to modify a file, create a new file and delete the old one.
373      *
374      * @param int $type Type of file handle (FILE_HANDLE_xx constant)
375      * @return resource file handle
376      */
377     public function get_content_file_handle($type = self::FILE_HANDLE_FOPEN) {
378         return $this->filesystem->get_content_file_handle($this, $type);
379     }
381     /**
382      * Dumps file content to page.
383      */
384     public function readfile() {
385         return $this->filesystem->readfile($this);
386     }
388     /**
389      * Returns file content as string.
390      *
391      * @return string content
392      */
393     public function get_content() {
394         return $this->filesystem->get_content($this);
395     }
397     /**
398      * Copy content of file to given pathname.
399      *
400      * @param string $pathname real path to the new file
401      * @return bool success
402      */
403     public function copy_content_to($pathname) {
404         return $this->filesystem->copy_content_from_storedfile($this, $pathname);
405     }
407     /**
408      * Copy content of file to temporary folder and returns file path
409      *
410      * @param string $dir name of the temporary directory
411      * @param string $fileprefix prefix of temporary file.
412      * @return string|bool path of temporary file or false.
413      */
414     public function copy_content_to_temp($dir = 'files', $fileprefix = 'tempup_') {
415         $tempfile = false;
416         if (!$dir = make_temp_directory($dir)) {
417             return false;
418         }
419         if (!$tempfile = tempnam($dir, $fileprefix)) {
420             return false;
421         }
422         if (!$this->copy_content_to($tempfile)) {
423             // something went wrong
424             @unlink($tempfile);
425             return false;
426         }
427         return $tempfile;
428     }
430     /**
431      * List contents of archive.
432      *
433      * @param file_packer $packer file packer instance
434      * @return array of file infos
435      */
436     public function list_files(file_packer $packer) {
437         return $this->filesystem->list_files($this, $packer);
438     }
440     /**
441      * Extract file to given file path (real OS filesystem), existing files are overwritten.
442      *
443      * @param file_packer $packer file packer instance
444      * @param string $pathname target directory
445      * @param file_progress $progress Progress indicator callback or null if not required
446      * @return array|bool list of processed files; false if error
447      */
448     public function extract_to_pathname(file_packer $packer, $pathname,
449             file_progress $progress = null) {
450         return $this->filesystem->extract_to_pathname($this, $packer, $pathname, $progress);
451     }
453     /**
454      * Extract file to given file path (real OS filesystem), existing files are overwritten.
455      *
456      * @param file_packer $packer file packer instance
457      * @param int $contextid context ID
458      * @param string $component component
459      * @param string $filearea file area
460      * @param int $itemid item ID
461      * @param string $pathbase path base
462      * @param int $userid user ID
463      * @param file_progress $progress Progress indicator callback or null if not required
464      * @return array|bool list of processed files; false if error
465      */
466     public function extract_to_storage(file_packer $packer, $contextid,
467             $component, $filearea, $itemid, $pathbase, $userid = null, file_progress $progress = null) {
469         return $this->filesystem->extract_to_storage($this, $packer, $contextid, $component, $filearea,
470                 $itemid, $pathbase, $userid, $progress);
471     }
473     /**
474      * Add file/directory into archive.
475      *
476      * @param file_archive $filearch file archive instance
477      * @param string $archivepath pathname in archive
478      * @return bool success
479      */
480     public function archive_file(file_archive $filearch, $archivepath) {
481         return $this->filesystem->add_storedfile_to_archive($this, $filearch, $archivepath);
482     }
484     /**
485      * Returns information about image,
486      * information is determined from the file content
487      *
488      * @return mixed array with width, height and mimetype; false if not an image
489      */
490     public function get_imageinfo() {
491         return $this->filesystem->get_imageinfo($this);
492     }
494     /**
495      * Verifies the file is a valid web image - gif, png and jpeg only.
496      *
497      * It should be ok to serve this image from server without any other security workarounds.
498      *
499      * @return bool true if file ok
500      */
501     public function is_valid_image() {
502         $mimetype = $this->get_mimetype();
503         if (!file_mimetype_in_typegroup($mimetype, 'web_image')) {
504             return false;
505         }
506         if (!$info = $this->get_imageinfo()) {
507             return false;
508         }
509         if ($info['mimetype'] !== $mimetype) {
510             return false;
511         }
512         // ok, GD likes this image
513         return true;
514     }
516     /**
517      * Returns parent directory, creates missing parents if needed.
518      *
519      * @return stored_file
520      */
521     public function get_parent_directory() {
522         if ($this->file_record->filepath === '/' and $this->file_record->filename === '.') {
523             //root dir does not have parent
524             return null;
525         }
527         if ($this->file_record->filename !== '.') {
528             return $this->fs->create_directory($this->file_record->contextid, $this->file_record->component, $this->file_record->filearea, $this->file_record->itemid, $this->file_record->filepath);
529         }
531         $filepath = $this->file_record->filepath;
532         $filepath = trim($filepath, '/');
533         $dirs = explode('/', $filepath);
534         array_pop($dirs);
535         $filepath = implode('/', $dirs);
536         $filepath = ($filepath === '') ? '/' : "/$filepath/";
538         return $this->fs->create_directory($this->file_record->contextid, $this->file_record->component, $this->file_record->filearea, $this->file_record->itemid, $filepath);
539     }
541     /**
542      * Synchronize file if it is a reference and needs synchronizing
543      *
544      * Updates contenthash and filesize
545      */
546     public function sync_external_file() {
547         if (!empty($this->repository)) {
548             $this->repository->sync_reference($this);
549         }
550     }
552     /**
553      * Returns context id of the file
554      *
555      * @return int context id
556      */
557     public function get_contextid() {
558         return $this->file_record->contextid;
559     }
561     /**
562      * Returns component name - this is the owner of the areas,
563      * nothing else is allowed to read or modify the files directly!!
564      *
565      * @return string
566      */
567     public function get_component() {
568         return $this->file_record->component;
569     }
571     /**
572      * Returns file area name, this divides files of one component into groups with different access control.
573      * All files in one area have the same access control.
574      *
575      * @return string
576      */
577     public function get_filearea() {
578         return $this->file_record->filearea;
579     }
581     /**
582      * Returns returns item id of file.
583      *
584      * @return int
585      */
586     public function get_itemid() {
587         return $this->file_record->itemid;
588     }
590     /**
591      * Returns file path - starts and ends with /, \ are not allowed.
592      *
593      * @return string
594      */
595     public function get_filepath() {
596         return $this->file_record->filepath;
597     }
599     /**
600      * Returns file name or '.' in case of directories.
601      *
602      * @return string
603      */
604     public function get_filename() {
605         return $this->file_record->filename;
606     }
608     /**
609      * Returns id of user who created the file.
610      *
611      * @return int
612      */
613     public function get_userid() {
614         return $this->file_record->userid;
615     }
617     /**
618      * Returns the size of file in bytes.
619      *
620      * @return int bytes
621      */
622     public function get_filesize() {
623         $this->sync_external_file();
624         return $this->file_record->filesize;
625     }
627      /**
628      * Function stored_file::set_filesize() is deprecated. Please use stored_file::replace_file_with
629      *
630      * @deprecated since Moodle 2.6 MDL-42016 - please do not use this function any more.
631      * @see stored_file::replace_file_with()
632      */
633     public function set_filesize($filesize) {
634         throw new coding_exception('Function stored_file::set_filesize() can not be used any more. ' .
635             'Please use stored_file::replace_file_with()');
636     }
638     /**
639      * Returns mime type of file.
640      *
641      * @return string
642      */
643     public function get_mimetype() {
644         return $this->file_record->mimetype;
645     }
647     /**
648      * Returns unix timestamp of file creation date.
649      *
650      * @return int
651      */
652     public function get_timecreated() {
653         return $this->file_record->timecreated;
654     }
656     /**
657      * Returns unix timestamp of last file modification.
658      *
659      * @return int
660      */
661     public function get_timemodified() {
662         $this->sync_external_file();
663         return $this->file_record->timemodified;
664     }
666     /**
667      * set timemodified
668      *
669      * @param int $timemodified
670      */
671     public function set_timemodified($timemodified) {
672         $filerecord = new stdClass;
673         $filerecord->timemodified = $timemodified;
674         $this->update($filerecord);
675     }
677     /**
678      * Returns file status flag.
679      *
680      * @return int 0 means file OK, anything else is a problem and file can not be used
681      */
682     public function get_status() {
683         return $this->file_record->status;
684     }
686     /**
687      * Returns file id.
688      *
689      * @return int
690      */
691     public function get_id() {
692         return $this->file_record->id;
693     }
695     /**
696      * Returns sha1 hash of file content.
697      *
698      * @return string
699      */
700     public function get_contenthash() {
701         $this->sync_external_file();
702         return $this->file_record->contenthash;
703     }
705     /**
706      * Returns sha1 hash of all file path components sha1("contextid/component/filearea/itemid/dir/dir/filename.ext").
707      *
708      * @return string
709      */
710     public function get_pathnamehash() {
711         return $this->file_record->pathnamehash;
712     }
714     /**
715      * Returns the license type of the file, it is a short name referred from license table.
716      *
717      * @return string
718      */
719     public function get_license() {
720         return $this->file_record->license;
721     }
723     /**
724      * Set license
725      *
726      * @param string $license license
727      */
728     public function set_license($license) {
729         $filerecord = new stdClass;
730         $filerecord->license = $license;
731         $this->update($filerecord);
732     }
734     /**
735      * Returns the author name of the file.
736      *
737      * @return string
738      */
739     public function get_author() {
740         return $this->file_record->author;
741     }
743     /**
744      * Set author
745      *
746      * @param string $author
747      */
748     public function set_author($author) {
749         $filerecord = new stdClass;
750         $filerecord->author = $author;
751         $this->update($filerecord);
752     }
754     /**
755      * Returns the source of the file, usually it is a url.
756      *
757      * @return string
758      */
759     public function get_source() {
760         return $this->file_record->source;
761     }
763     /**
764      * Set license
765      *
766      * @param string $license license
767      */
768     public function set_source($source) {
769         $filerecord = new stdClass;
770         $filerecord->source = $source;
771         $this->update($filerecord);
772     }
775     /**
776      * Returns the sort order of file
777      *
778      * @return int
779      */
780     public function get_sortorder() {
781         return $this->file_record->sortorder;
782     }
784     /**
785      * Set file sort order
786      *
787      * @param int $sortorder
788      * @return int
789      */
790     public function set_sortorder($sortorder) {
791         $filerecord = new stdClass;
792         $filerecord->sortorder = $sortorder;
793         $this->update($filerecord);
794     }
796     /**
797      * Returns repository id
798      *
799      * @return int|null
800      */
801     public function get_repository_id() {
802         if (!empty($this->repository)) {
803             return $this->repository->id;
804         } else {
805             return null;
806         }
807     }
809     /**
810      * get reference file id
811      * @return int
812      */
813     public function get_referencefileid() {
814         return $this->file_record->referencefileid;
815     }
817     /**
818      * Get reference last sync time
819      * @return int
820      */
821     public function get_referencelastsync() {
822         return $this->file_record->referencelastsync;
823     }
825     /**
826      * Function stored_file::get_referencelifetime() is deprecated as reference
827      * life time is no longer stored in DB or returned by repository. Each
828      * repository should decide by itself when to synchronise the references.
829      *
830      * @deprecated since Moodle 2.6 MDL-42016 - please do not use this function any more.
831      * @see repository::sync_reference()
832      */
833     public function get_referencelifetime() {
834         throw new coding_exception('Function stored_file::get_referencelifetime() can not be used any more. ' .
835             'See repository::sync_reference().');
836     }
837     /**
838      * Returns file reference
839      *
840      * @return string
841      */
842     public function get_reference() {
843         return $this->file_record->reference;
844     }
846     /**
847      * Get human readable file reference information
848      *
849      * @return string
850      */
851     public function get_reference_details() {
852         return $this->repository->get_reference_details($this->get_reference(), $this->get_status());
853     }
855     /**
856      * Called after reference-file has been synchronized with the repository
857      *
858      * We update contenthash, filesize and status in files table if changed
859      * and we always update lastsync in files_reference table
860      *
861      * @param null|string $contenthash if set to null contenthash is not changed
862      * @param int $filesize new size of the file
863      * @param int $status new status of the file (0 means OK, 666 - source missing)
864      * @param int $timemodified last time modified of the source, if known
865      */
866     public function set_synchronized($contenthash, $filesize, $status = 0, $timemodified = null) {
867         if (!$this->is_external_file()) {
868             return;
869         }
870         $now = time();
871         if ($contenthash === null) {
872             $contenthash = $this->file_record->contenthash;
873         }
874         if ($contenthash != $this->file_record->contenthash) {
875             $oldcontenthash = $this->file_record->contenthash;
876         }
877         // this will update all entries in {files} that have the same filereference id
878         $this->fs->update_references($this->file_record->referencefileid, $now, null, $contenthash, $filesize, $status, $timemodified);
879         // we don't need to call update() for this object, just set the values of changed fields
880         $this->file_record->contenthash = $contenthash;
881         $this->file_record->filesize = $filesize;
882         $this->file_record->status = $status;
883         $this->file_record->referencelastsync = $now;
884         if ($timemodified) {
885             $this->file_record->timemodified = $timemodified;
886         }
887         if (isset($oldcontenthash)) {
888             $this->filesystem->remove_file($oldcontenthash);
889         }
890     }
892     /**
893      * Sets the error status for a file that could not be synchronised
894      */
895     public function set_missingsource() {
896         $this->set_synchronized($this->file_record->contenthash, $this->file_record->filesize, 666);
897     }
899     /**
900      * Send file references
901      *
902      * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
903      * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
904      * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
905      * @param array $options additional options affecting the file serving
906      */
907     public function send_file($lifetime, $filter, $forcedownload, $options) {
908         $this->repository->send_file($this, $lifetime, $filter, $forcedownload, $options);
909     }
911     /**
912      * Imports the contents of an external file into moodle filepool.
913      *
914      * @throws moodle_exception if file could not be downloaded or is too big
915      * @param int $maxbytes throw an exception if file size is bigger than $maxbytes (0 means no limit)
916      */
917     public function import_external_file_contents($maxbytes = 0) {
918         if ($this->repository) {
919             $this->repository->import_external_file_contents($this, $maxbytes);
920         }
921     }
923     /**
924      * Gets a file relative to this file in the repository and sends it to the browser.
925      * Checks the function repository::supports_relative_file() to make sure it can be used.
926      *
927      * @param string $relativepath the relative path to the file we are trying to access
928      */
929     public function send_relative_file($relativepath) {
930         if ($this->repository && $this->repository->supports_relative_file()) {
931             $relativepath = clean_param($relativepath, PARAM_PATH);
932             $this->repository->send_relative_file($this, $relativepath);
933         } else {
934             send_file_not_found();
935         }
936     }
938     /**
939      * Generates a thumbnail for this stored_file.
940      *
941      * If the GD library has at least version 2 and PNG support is available, the returned data
942      * is the content of a transparent PNG file containing the thumbnail. Otherwise, the function
943      * returns contents of a JPEG file with black background containing the thumbnail.
944      *
945      * @param   int $width the width of the requested thumbnail
946      * @param   int $height the height of the requested thumbnail
947      * @return  string|bool false if a problem occurs, the thumbnail image data otherwise
948      */
949     public function generate_image_thumbnail($width, $height) {
950         if (empty($width) or empty($height)) {
951             return false;
952         }
954         $content = $this->get_content();
956         // Fetch the image information for this image.
957         $imageinfo = @getimagesizefromstring($content);
958         if (empty($imageinfo)) {
959             return false;
960         }
962         // Create a new image from the file.
963         $original = @imagecreatefromstring($content);
965         // Generate the thumbnail.
966         return generate_image_thumbnail_from_image($original, $imageinfo, $width, $height);
967     }
969     /**
970      * Generate a resized image for this stored_file.
971      *
972      * @param int|null $width The desired width, or null to only use the height.
973      * @param int|null $height The desired height, or null to only use the width.
974      * @return string|false False when a problem occurs, else the image data.
975      */
976     public function resize_image($width, $height) {
977         global $CFG;
978         require_once($CFG->libdir . '/gdlib.php');
980         $content = $this->get_content();
982         // Fetch the image information for this image.
983         $imageinfo = @getimagesizefromstring($content);
984         if (empty($imageinfo)) {
985             return false;
986         }
988         // Create a new image from the file.
989         $original = @imagecreatefromstring($content);
991         // Generate the resized image.
992         return resize_image_from_image($original, $imageinfo, $width, $height);
993     }