2 // This file is part of Moodle - http://moodle.org/
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.
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.
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 * This file contains classes used to manage the repository plugins in Moodle
21 * @package core_repository
22 * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 defined('MOODLE_INTERNAL') ||
die();
27 require_once($CFG->libdir
. '/filelib.php');
28 require_once($CFG->libdir
. '/formslib.php');
30 define('FILE_EXTERNAL', 1);
31 define('FILE_INTERNAL', 2);
32 define('FILE_REFERENCE', 4);
33 define('FILE_CONTROLLED_LINK', 8);
35 define('RENAME_SUFFIX', '_2');
38 * This class is used to manage repository plugins
40 * A repository_type is a repository plug-in. It can be Box.net, Flick-r, ...
41 * A repository type can be edited, sorted and hidden. It is mandatory for an
42 * administrator to create a repository type in order to be able to create
43 * some instances of this type.
45 * - a repository_type object is mapped to the "repository" database table
46 * - "typename" attibut maps the "type" database field. It is unique.
47 * - general "options" for a repository type are saved in the config_plugin table
48 * - when you delete a repository, all instances are deleted, and general
49 * options are also deleted from database
50 * - When you create a type for a plugin that can't have multiple instances, a
51 * instance is automatically created.
53 * @package core_repository
54 * @copyright 2009 Jerome Mouneyrac
55 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57 class repository_type
implements cacheable_object
{
61 * Type name (no whitespace) - A type name is unique
62 * Note: for a user-friendly type name see get_readablename()
69 * Options of this type
70 * They are general options that any instance of this type would share
72 * These options are saved in config_plugin table
79 * Is the repository type visible or hidden
80 * If false (hidden): no instances can be created, edited, deleted, showned , used...
87 * 0 => not ordered, 1 => first position, 2 => second position...
88 * A not order type would appear in first position (should never happened)
94 * Return if the instance is visible in a context
96 * @todo check if the context visibility has been overwritten by the plugin creator
97 * (need to create special functions to be overvwritten in repository class)
98 * @param stdClass $context context
101 public function get_contextvisibility($context) {
104 if ($context->contextlevel
== CONTEXT_COURSE
) {
105 return $this->_options
['enablecourseinstances'];
108 if ($context->contextlevel
== CONTEXT_USER
) {
109 return $this->_options
['enableuserinstances'];
112 //the context is SITE
119 * repository_type constructor
121 * @param int $typename
122 * @param array $typeoptions
123 * @param bool $visible
124 * @param int $sortorder (don't really need set, it will be during create() call)
126 public function __construct($typename = '', $typeoptions = array(), $visible = true, $sortorder = 0) {
130 $this->_typename
= $typename;
131 $this->_visible
= $visible;
132 $this->_sortorder
= $sortorder;
134 //set options attribut
135 $this->_options
= array();
136 $options = repository
::static_function($typename, 'get_type_option_names');
137 //check that the type can be setup
138 if (!empty($options)) {
139 //set the type options
140 foreach ($options as $config) {
141 if (array_key_exists($config, $typeoptions)) {
142 $this->_options
[$config] = $typeoptions[$config];
147 //retrieve visibility from option
148 if (array_key_exists('enablecourseinstances',$typeoptions)) {
149 $this->_options
['enablecourseinstances'] = $typeoptions['enablecourseinstances'];
151 $this->_options
['enablecourseinstances'] = 0;
154 if (array_key_exists('enableuserinstances',$typeoptions)) {
155 $this->_options
['enableuserinstances'] = $typeoptions['enableuserinstances'];
157 $this->_options
['enableuserinstances'] = 0;
163 * Get the type name (no whitespace)
164 * For a human readable name, use get_readablename()
166 * @return string the type name
168 public function get_typename() {
169 return $this->_typename
;
173 * Return a human readable and user-friendly type name
175 * @return string user-friendly type name
177 public function get_readablename() {
178 return get_string('pluginname','repository_'.$this->_typename
);
182 * Return general options
184 * @return array the general options
186 public function get_options() {
187 return $this->_options
;
195 public function get_visible() {
196 return $this->_visible
;
200 * Return order / position of display in the file picker
204 public function get_sortorder() {
205 return $this->_sortorder
;
209 * Create a repository type (the type name must not already exist)
210 * @param bool $silent throw exception?
211 * @return mixed return int if create successfully, return false if
213 public function create($silent = false) {
216 //check that $type has been set
217 $timmedtype = trim($this->_typename
);
218 if (empty($timmedtype)) {
219 throw new repository_exception('emptytype', 'repository');
222 //set sortorder as the last position in the list
223 if (!isset($this->_sortorder
) ||
$this->_sortorder
== 0 ) {
224 $sql = "SELECT MAX(sortorder) FROM {repository}";
225 $this->_sortorder
= 1 +
$DB->get_field_sql($sql);
228 //only create a new type if it doesn't already exist
229 $existingtype = $DB->get_record('repository', array('type'=>$this->_typename
));
230 if (!$existingtype) {
232 $newtype = new stdClass();
233 $newtype->type
= $this->_typename
;
234 $newtype->visible
= $this->_visible
;
235 $newtype->sortorder
= $this->_sortorder
;
236 $plugin_id = $DB->insert_record('repository', $newtype);
237 //save the options in DB
238 $this->update_options();
240 $instanceoptionnames = repository
::static_function($this->_typename
, 'get_instance_option_names');
242 //if the plugin type has no multiple instance (e.g. has no instance option name) so it wont
243 //be possible for the administrator to create a instance
244 //in this case we need to create an instance
245 if (empty($instanceoptionnames)) {
246 $instanceoptions = array();
247 if (empty($this->_options
['pluginname'])) {
248 // when moodle trying to install some repo plugin automatically
249 // this option will be empty, get it from language string when display
250 $instanceoptions['name'] = '';
252 // when admin trying to add a plugin manually, he will type a name
254 $instanceoptions['name'] = $this->_options
['pluginname'];
256 repository
::static_function($this->_typename
, 'create', $this->_typename
, 0, context_system
::instance(), $instanceoptions);
258 //run plugin_init function
259 if (!repository
::static_function($this->_typename
, 'plugin_init')) {
260 $this->update_visibility(false);
262 throw new repository_exception('cannotinitplugin', 'repository');
266 cache
::make('core', 'repositories')->purge();
267 if(!empty($plugin_id)) {
268 // return plugin_id if create successfully
276 throw new repository_exception('existingrepository', 'repository');
278 // If plugin existed, return false, tell caller no new plugins were created.
285 * Update plugin options into the config_plugin table
287 * @param array $options
290 public function update_options($options = null) {
292 $classname = 'repository_' . $this->_typename
;
293 $instanceoptions = repository
::static_function($this->_typename
, 'get_instance_option_names');
294 if (empty($instanceoptions)) {
295 // update repository instance name if this plugin type doesn't have muliti instances
297 $params['type'] = $this->_typename
;
298 $instances = repository
::get_instances($params);
299 $instance = array_pop($instances);
301 $DB->set_field('repository_instances', 'name', $options['pluginname'], array('id'=>$instance->id
));
303 unset($options['pluginname']);
306 if (!empty($options)) {
307 $this->_options
= $options;
310 foreach ($this->_options
as $name => $value) {
311 set_config($name, $value, $this->_typename
);
314 cache
::make('core', 'repositories')->purge();
319 * Update visible database field with the value given as parameter
320 * or with the visible value of this object
321 * This function is private.
322 * For public access, have a look to switch_and_update_visibility()
324 * @param bool $visible
327 private function update_visible($visible = null) {
330 if (!empty($visible)) {
331 $this->_visible
= $visible;
333 else if (!isset($this->_visible
)) {
334 throw new repository_exception('updateemptyvisible', 'repository');
337 cache
::make('core', 'repositories')->purge();
338 return $DB->set_field('repository', 'visible', $this->_visible
, array('type'=>$this->_typename
));
342 * Update database sortorder field with the value given as parameter
343 * or with the sortorder value of this object
344 * This function is private.
345 * For public access, have a look to move_order()
347 * @param int $sortorder
350 private function update_sortorder($sortorder = null) {
353 if (!empty($sortorder) && $sortorder!=0) {
354 $this->_sortorder
= $sortorder;
356 //if sortorder is not set, we set it as the ;ast position in the list
357 else if (!isset($this->_sortorder
) ||
$this->_sortorder
== 0 ) {
358 $sql = "SELECT MAX(sortorder) FROM {repository}";
359 $this->_sortorder
= 1 +
$DB->get_field_sql($sql);
362 cache
::make('core', 'repositories')->purge();
363 return $DB->set_field('repository', 'sortorder', $this->_sortorder
, array('type'=>$this->_typename
));
367 * Change order of the type with its adjacent upper or downer type
368 * (database fields are updated)
370 * 1. retrieve all types in an array. This array is sorted by sortorder,
371 * and the array keys start from 0 to X (incremented by 1)
372 * 2. switch sortorder values of this type and its adjacent type
374 * @param string $move "up" or "down"
376 public function move_order($move) {
379 $types = repository
::get_types(); // retrieve all types
381 // retrieve this type into the returned array
383 while (!isset($indice) && $i<count($types)) {
384 if ($types[$i]->get_typename() == $this->_typename
) {
390 // retrieve adjacent indice
393 $adjacentindice = $indice - 1;
396 $adjacentindice = $indice +
1;
399 throw new repository_exception('movenotdefined', 'repository');
402 //switch sortorder of this type and the adjacent type
403 //TODO: we could reset sortorder for all types. This is not as good in performance term, but
404 //that prevent from wrong behaviour on a screwed database. As performance are not important in this particular case
405 //it worth to change the algo.
406 if ($adjacentindice>=0 && !empty($types[$adjacentindice])) {
407 $DB->set_field('repository', 'sortorder', $this->_sortorder
, array('type'=>$types[$adjacentindice]->get_typename()));
408 $this->update_sortorder($types[$adjacentindice]->get_sortorder());
413 * 1. Change visibility to the value chosen
416 * @param bool $visible
419 public function update_visibility($visible = null) {
420 if (is_bool($visible)) {
421 $this->_visible
= $visible;
423 $this->_visible
= !$this->_visible
;
425 return $this->update_visible();
430 * Delete a repository_type (general options are removed from config_plugin
431 * table, and all instances are deleted)
433 * @param bool $downloadcontents download external contents if exist
436 public function delete($downloadcontents = false) {
439 //delete all instances of this type
441 $params['context'] = array();
442 $params['onlyvisible'] = false;
443 $params['type'] = $this->_typename
;
444 $instances = repository
::get_instances($params);
445 foreach ($instances as $instance) {
446 $instance->delete($downloadcontents);
449 //delete all general options
450 foreach ($this->_options
as $name => $value) {
451 set_config($name, null, $this->_typename
);
454 cache
::make('core', 'repositories')->purge();
456 $DB->delete_records('repository', array('type' => $this->_typename
));
457 } catch (dml_exception
$ex) {
464 * Prepares the repository type to be cached. Implements method from cacheable_object interface.
468 public function prepare_to_cache() {
470 'typename' => $this->_typename
,
471 'typeoptions' => $this->_options
,
472 'visible' => $this->_visible
,
473 'sortorder' => $this->_sortorder
478 * Restores repository type from cache. Implements method from cacheable_object interface.
482 public static function wake_from_cache($data) {
483 return new repository_type($data['typename'], $data['typeoptions'], $data['visible'], $data['sortorder']);
488 * This is the base class of the repository class.
490 * To create repository plugin, see: {@link https://moodledev.io/docs/apis/plugintypes/repository}
491 * See an example: repository_dropbox
493 * @package core_repository
494 * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
495 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
497 abstract class repository
implements cacheable_object
{
499 * Timeout in seconds for downloading the external file into moodle
500 * @deprecated since Moodle 2.7, please use $CFG->repositorygetfiletimeout instead
502 const GETFILE_TIMEOUT
= 30;
505 * Timeout in seconds for syncronising the external file size
506 * @deprecated since Moodle 2.7, please use $CFG->repositorysyncfiletimeout instead
508 const SYNCFILE_TIMEOUT
= 1;
511 * Timeout in seconds for downloading an image file from external repository during syncronisation
512 * @deprecated since Moodle 2.7, please use $CFG->repositorysyncimagetimeout instead
514 const SYNCIMAGE_TIMEOUT
= 3;
516 // $disabled can be set to true to disable a plugin by force
517 // example: self::$disabled = true
518 /** @var bool force disable repository instance */
519 public $disabled = false;
520 /** @var int repository instance id */
522 /** @var context current context */
524 /** @var array repository options */
526 /** @var bool Whether or not the repository instance is editable */
528 /** @var int return types */
530 /** @var stdClass repository instance database record */
532 /** @var string Type of repository (webdav, google_docs, dropbox, ...). Read from $this->get_typename(). */
534 /** @var string instance name. */
536 /** @var bool true if the super construct is called, otherwise false. */
537 public $super_called;
542 * @param int $repositoryid repository instance id
543 * @param int|stdClass $context a context id or context object
544 * @param array $options repository options
545 * @param int $readonly indicate this repo is readonly or not
547 public function __construct($repositoryid, $context = SYSCONTEXTID
, $options = array(), $readonly = 0) {
549 $this->id
= $repositoryid;
550 if (is_object($context)) {
551 $this->context
= $context;
553 $this->context
= context
::instance_by_id($context);
555 $cache = cache
::make('core', 'repositories');
556 if (($this->instance
= $cache->get('i:'. $this->id
)) === false) {
557 $this->instance
= $DB->get_record_sql("SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
558 FROM {repository} r, {repository_instances} i
559 WHERE i.typeid = r.id and i.id = ?", array('id' => $this->id
));
560 $cache->set('i:'. $this->id
, $this->instance
);
562 $this->readonly
= $readonly;
563 $this->options
= array();
565 if (is_array($options)) {
566 // The get_option() method will get stored options in database.
567 $options = array_merge($this->get_option(), $options);
569 $options = $this->get_option();
571 foreach ($options as $n => $v) {
572 $this->options
[$n] = $v;
574 $this->name
= $this->get_name();
575 $this->returntypes
= $this->supported_returntypes();
576 $this->super_called
= true;
580 * Get repository instance using repository id
582 * Note that this function does not check permission to access repository contents
584 * @throws repository_exception
586 * @param int $repositoryid repository instance ID
587 * @param context|int $context context instance or context ID where this repository will be used
588 * @param array $options additional repository options
591 public static function get_repository_by_id($repositoryid, $context, $options = array()) {
593 $cache = cache
::make('core', 'repositories');
594 if (!is_object($context)) {
595 $context = context
::instance_by_id($context);
597 $cachekey = 'rep:'. $repositoryid. ':'. $context->id
. ':'. serialize($options);
598 if ($repository = $cache->get($cachekey)) {
602 if (!$record = $cache->get('i:'. $repositoryid)) {
603 $sql = "SELECT i.*, r.type AS repositorytype, r.visible, r.sortorder
604 FROM {repository_instances} i
605 JOIN {repository} r ON r.id = i.typeid
607 if (!$record = $DB->get_record_sql($sql, array($repositoryid))) {
608 throw new repository_exception('invalidrepositoryid', 'repository');
610 $cache->set('i:'. $record->id
, $record);
613 $type = $record->repositorytype
;
614 if (file_exists($CFG->dirroot
. "/repository/$type/lib.php")) {
615 require_once($CFG->dirroot
. "/repository/$type/lib.php");
616 $classname = 'repository_' . $type;
617 $options['type'] = $type;
618 $options['typeid'] = $record->typeid
;
619 $options['visible'] = $record->visible
;
620 if (empty($options['name'])) {
621 $options['name'] = $record->name
;
623 $repository = new $classname($repositoryid, $context, $options, $record->readonly
);
624 if (empty($repository->super_called
)) {
625 // to make sure the super construct is called
626 debugging('parent::__construct must be called by '.$type.' plugin.');
628 $cache->set($cachekey, $repository);
631 throw new repository_exception('invalidplugin', 'repository');
636 * Returns the type name of the repository.
638 * @return string type name of the repository.
641 public function get_typename() {
642 if (empty($this->typename
)) {
644 if (!preg_match("/^repository_(.*)$/", get_class($this), $matches)) {
645 throw new coding_exception('The class name of a repository should be repository_<typeofrepository>, '.
646 'e.g. repository_dropbox');
648 $this->typename
= $matches[1];
650 return $this->typename
;
654 * Get a repository type object by a given type name.
657 * @param string $typename the repository type name
658 * @return repository_type|bool
660 public static function get_type_by_typename($typename) {
662 $cache = cache
::make('core', 'repositories');
663 if (($repositorytype = $cache->get('typename:'. $typename)) === false) {
664 $repositorytype = null;
665 if ($record = $DB->get_record('repository', array('type' => $typename))) {
666 $repositorytype = new repository_type($record->type
, (array)get_config($record->type
), $record->visible
, $record->sortorder
);
667 $cache->set('typeid:'. $record->id
, $repositorytype);
669 $cache->set('typename:'. $typename, $repositorytype);
671 return $repositorytype;
675 * Get the repository type by a given repository type id.
678 * @param int $id the type id
681 public static function get_type_by_id($id) {
683 $cache = cache
::make('core', 'repositories');
684 if (($repositorytype = $cache->get('typeid:'. $id)) === false) {
685 $repositorytype = null;
686 if ($record = $DB->get_record('repository', array('id' => $id))) {
687 $repositorytype = new repository_type($record->type
, (array)get_config($record->type
), $record->visible
, $record->sortorder
);
688 $cache->set('typename:'. $record->type
, $repositorytype);
690 $cache->set('typeid:'. $id, $repositorytype);
692 return $repositorytype;
696 * Return all repository types ordered by sortorder field
697 * first repository type in returnedarray[0], second repository type in returnedarray[1], ...
700 * @param bool $visible can return types by visiblity, return all types if null
701 * @return array Repository types
703 public static function get_types($visible=null) {
705 $cache = cache
::make('core', 'repositories');
707 $typesnames = $cache->get('types');
709 $typesnames = $cache->get('typesvis');
712 if ($typesnames === false) {
713 $typesnames = array();
714 $vistypesnames = array();
715 if ($records = $DB->get_records('repository', null ,'sortorder')) {
716 foreach($records as $type) {
717 if (($repositorytype = $cache->get('typename:'. $type->type
)) === false) {
718 // Create new instance of repository_type.
719 if (file_exists($CFG->dirroot
. '/repository/'. $type->type
.'/lib.php')) {
720 $repositorytype = new repository_type($type->type
, (array)get_config($type->type
), $type->visible
, $type->sortorder
);
721 $cache->set('typeid:'. $type->id
, $repositorytype);
722 $cache->set('typename:'. $type->type
, $repositorytype);
725 if ($repositorytype) {
726 if (empty($visible) ||
$repositorytype->get_visible()) {
727 $types[] = $repositorytype;
728 $vistypesnames[] = $repositorytype->get_typename();
730 $typesnames[] = $repositorytype->get_typename();
734 $cache->set('types', $typesnames);
735 $cache->set('typesvis', $vistypesnames);
737 foreach ($typesnames as $typename) {
738 $types[] = self
::get_type_by_typename($typename);
745 * Checks if user has a capability to view the current repository.
747 * @return bool true when the user can, otherwise throws an exception.
748 * @throws repository_exception when the user does not meet the requirements.
750 final public function check_capability() {
753 // The context we are on.
754 $currentcontext = $this->context
;
756 // Ensure that the user can view the repository in the current context.
757 $can = has_capability('repository/'.$this->get_typename().':view', $currentcontext);
759 // Context in which the repository has been created.
760 $repocontext = context
::instance_by_id($this->instance
->contextid
);
762 // Prevent access to private repositories when logged in as.
763 if ($can && \core\session\manager
::is_loggedinas()) {
764 if ($this->contains_private_data() ||
$repocontext->contextlevel
== CONTEXT_USER
) {
769 // We are going to ensure that the current context was legit, and reliable to check
770 // the capability against. (No need to do that if we already cannot).
772 if ($repocontext->contextlevel
== CONTEXT_USER
) {
773 // The repository is a user instance, ensure we're the right user to access it!
774 if ($repocontext->instanceid
!= $USER->id
) {
777 } else if ($repocontext->contextlevel
== CONTEXT_COURSE
) {
778 // The repository is a course one. Let's check that we are on the right course.
779 if (in_array($currentcontext->contextlevel
, array(CONTEXT_COURSE
, CONTEXT_MODULE
, CONTEXT_BLOCK
))) {
780 $coursecontext = $currentcontext->get_course_context();
781 if ($coursecontext->instanceid
!= $repocontext->instanceid
) {
785 // We are on a parent context, therefore it's legit to check the permissions
786 // in the current context.
789 // Nothing to check here, system instances can have different permissions on different
790 // levels. We do not want to prevent URL hack here, because it does not make sense to
791 // prevent a user to access a repository in a context if it's accessible in another one.
799 throw new repository_exception('nopermissiontoaccess', 'repository');
803 * Check if file already exists in draft area.
806 * @param int $itemid of the draft area.
807 * @param string $filepath path to the file.
808 * @param string $filename file name.
811 public static function draftfile_exists($itemid, $filepath, $filename) {
813 $fs = get_file_storage();
814 $usercontext = context_user
::instance($USER->id
);
815 return $fs->file_exists($usercontext->id
, 'user', 'draft', $itemid, $filepath, $filename);
819 * Parses the moodle file reference and returns an instance of stored_file
821 * @param string $reference reference to the moodle internal file as retruned by
822 * {@link repository::get_file_reference()} or {@link file_storage::pack_reference()}
823 * @return stored_file|null
825 public static function get_moodle_file($reference) {
826 $params = file_storage
::unpack_reference($reference, true);
827 $fs = get_file_storage();
828 return $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
829 $params['itemid'], $params['filepath'], $params['filename']);
833 * Repository method to make sure that user can access particular file.
835 * This is checked when user tries to pick the file from repository to deal with
836 * potential parameter substitutions is request
838 * @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
839 * @return bool whether the file is accessible by current user
841 public function file_is_accessible($source) {
842 if ($this->has_moodle_files()) {
843 $reference = $this->get_file_reference($source);
845 $params = file_storage
::unpack_reference($reference, true);
846 } catch (file_reference_exception
$e) {
849 $browser = get_file_browser();
850 $context = context
::instance_by_id($params['contextid']);
851 $file_info = $browser->get_file_info($context, $params['component'], $params['filearea'],
852 $params['itemid'], $params['filepath'], $params['filename']);
853 return !empty($file_info);
859 * This function is used to copy a moodle file to draft area.
861 * It DOES NOT check if the user is allowed to access this file because the actual file
862 * can be located in the area where user does not have access to but there is an alias
863 * to this file in the area where user CAN access it.
864 * {@link file_is_accessible} should be called for alias location before calling this function.
866 * @param string $source The metainfo of file, it is base64 encoded php serialized data
867 * @param stdClass|array $filerecord contains itemid, filepath, filename and optionally other
868 * attributes of the new file
869 * @param int $maxbytes maximum allowed size of file, -1 if unlimited. If size of file exceeds
870 * the limit, the file_exception is thrown.
871 * @param int $areamaxbytes the maximum size of the area. A file_exception is thrown if the
872 * new file will reach the limit.
873 * @return array The information about the created file
875 public function copy_to_area($source, $filerecord, $maxbytes = -1, $areamaxbytes = FILE_AREA_MAX_BYTES_UNLIMITED
) {
877 $fs = get_file_storage();
879 if ($this->has_moodle_files() == false) {
880 throw new coding_exception('Only repository used to browse moodle files can use repository::copy_to_area()');
883 $user_context = context_user
::instance($USER->id
);
885 $filerecord = (array)$filerecord;
886 // make sure the new file will be created in user draft area
887 $filerecord['component'] = 'user';
888 $filerecord['filearea'] = 'draft';
889 $filerecord['contextid'] = $user_context->id
;
890 $draftitemid = $filerecord['itemid'];
891 $new_filepath = $filerecord['filepath'];
892 $new_filename = $filerecord['filename'];
894 // the file needs to copied to draft area
895 $stored_file = self
::get_moodle_file($source);
896 if ($maxbytes != -1 && $stored_file->get_filesize() > $maxbytes) {
897 $maxbytesdisplay = display_size($maxbytes, 0);
898 throw new file_exception('maxbytesfile', (object) array('file' => $filerecord['filename'],
899 'size' => $maxbytesdisplay));
901 // Validate the size of the draft area.
902 if (file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $stored_file->get_filesize())) {
903 throw new file_exception('maxareabytes');
906 if (repository
::draftfile_exists($draftitemid, $new_filepath, $new_filename)) {
908 $unused_filename = repository
::get_unused_filename($draftitemid, $new_filepath, $new_filename);
909 $filerecord['filename'] = $unused_filename;
910 $fs->create_file_from_storedfile($filerecord, $stored_file);
912 $event['event'] = 'fileexists';
913 $event['newfile'] = new stdClass
;
914 $event['newfile']->filepath
= $new_filepath;
915 $event['newfile']->filename
= $unused_filename;
916 $event['newfile']->url
= moodle_url
::make_draftfile_url($draftitemid, $new_filepath, $unused_filename)->out();
917 $event['existingfile'] = new stdClass
;
918 $event['existingfile']->filepath
= $new_filepath;
919 $event['existingfile']->filename
= $new_filename;
920 $event['existingfile']->url
= moodle_url
::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
923 $fs->create_file_from_storedfile($filerecord, $stored_file);
925 $info['itemid'] = $draftitemid;
926 $info['file'] = $new_filename;
927 $info['title'] = $new_filename;
928 $info['contextid'] = $user_context->id
;
929 $info['url'] = moodle_url
::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
930 $info['filesize'] = $stored_file->get_filesize();
936 * Get an unused filename from the current draft area.
938 * Will check if the file ends with ([0-9]) and increase the number.
941 * @param int $itemid draft item ID.
942 * @param string $filepath path to the file.
943 * @param string $filename name of the file.
944 * @return string an unused file name.
946 public static function get_unused_filename($itemid, $filepath, $filename) {
948 $contextid = context_user
::instance($USER->id
)->id
;
949 $fs = get_file_storage();
950 return $fs->get_unused_filename($contextid, 'user', 'draft', $itemid, $filepath, $filename);
954 * Append a suffix to filename.
957 * @param string $filename
959 * @deprecated since 2.5
961 public static function append_suffix($filename) {
962 debugging('The function repository::append_suffix() has been deprecated. Use repository::get_unused_filename() instead.',
964 $pathinfo = pathinfo($filename);
965 if (empty($pathinfo['extension'])) {
966 return $filename . RENAME_SUFFIX
;
968 return $pathinfo['filename'] . RENAME_SUFFIX
. '.' . $pathinfo['extension'];
973 * Return all types that you a user can create/edit and which are also visible
974 * Note: Mostly used in order to know if at least one editable type can be set
977 * @param stdClass $context the context for which we want the editable types
978 * @return array types
980 public static function get_editable_types($context = null) {
982 if (empty($context)) {
983 $context = context_system
::instance();
986 $types= repository
::get_types(true);
987 $editabletypes = array();
988 foreach ($types as $type) {
989 $instanceoptionnames = repository
::static_function($type->get_typename(), 'get_instance_option_names');
990 if (!empty($instanceoptionnames)) {
991 if ($type->get_contextvisibility($context)) {
992 $editabletypes[]=$type;
996 return $editabletypes;
1000 * Return repository instances
1003 * @param array $args Array containing the following keys:
1004 * currentcontext : instance of context (default system context)
1005 * context : array of instances of context (default empty array)
1006 * onlyvisible : bool (default true)
1007 * type : string return instances of this type only
1008 * accepted_types : string|array return instances that contain files of those types (*, web_image, .pdf, ...)
1009 * return_types : int combination of FILE_INTERNAL & FILE_EXTERNAL & FILE_REFERENCE & FILE_CONTROLLED_LINK.
1010 * 0 means every type. The default is FILE_INTERNAL | FILE_EXTERNAL.
1011 * userid : int if specified, instances belonging to other users will not be returned
1013 * @return array repository instances
1015 public static function get_instances($args = array()) {
1016 global $DB, $CFG, $USER;
1018 // Fill $args attributes with default values unless specified
1019 if (isset($args['currentcontext'])) {
1020 if ($args['currentcontext'] instanceof context
) {
1021 $current_context = $args['currentcontext'];
1023 debugging('currentcontext passed to repository::get_instances was ' .
1024 'not a context object. Using system context instead, but ' .
1025 'you should probably fix your code.', DEBUG_DEVELOPER
);
1026 $current_context = context_system
::instance();
1029 $current_context = context_system
::instance();
1031 $args['currentcontext'] = $current_context->id
;
1032 $contextids = array();
1033 if (!empty($args['context'])) {
1034 foreach ($args['context'] as $context) {
1035 $contextids[] = $context->id
;
1038 $args['context'] = $contextids;
1039 if (!isset($args['onlyvisible'])) {
1040 $args['onlyvisible'] = true;
1042 if (!isset($args['return_types'])) {
1043 $args['return_types'] = FILE_INTERNAL | FILE_EXTERNAL
;
1045 if (!isset($args['type'])) {
1046 $args['type'] = null;
1048 if (empty($args['disable_types']) ||
!is_array($args['disable_types'])) {
1049 $args['disable_types'] = null;
1051 if (empty($args['userid']) ||
!is_numeric($args['userid'])) {
1052 $args['userid'] = null;
1054 if (!isset($args['accepted_types']) ||
(is_array($args['accepted_types']) && in_array('*', $args['accepted_types']))) {
1055 $args['accepted_types'] = '*';
1058 $cachekey = 'all:'. serialize($args);
1060 // Check if we have cached list of repositories with the same query
1061 $cache = cache
::make('core', 'repositories');
1062 if (($cachedrepositories = $cache->get($cachekey)) !== false) {
1063 // convert from cacheable_object_array to array
1064 $repositories = array();
1065 foreach ($cachedrepositories as $repository) {
1066 $repositories[$repository->id
] = $repository;
1068 return $repositories;
1071 // Prepare DB SQL query to retrieve repositories
1073 $sql = "SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
1074 FROM {repository} r, {repository_instances} i
1075 WHERE i.typeid = r.id ";
1077 if ($args['disable_types']) {
1078 list($types, $p) = $DB->get_in_or_equal($args['disable_types'], SQL_PARAMS_NAMED
, 'distype', false);
1079 $sql .= " AND r.type $types";
1080 $params = array_merge($params, $p);
1083 if ($args['userid']) {
1084 $sql .= " AND (i.userid = 0 or i.userid = :userid)";
1085 $params['userid'] = $args['userid'];
1088 if ($args['context']) {
1089 list($ctxsql, $p2) = $DB->get_in_or_equal($args['context'], SQL_PARAMS_NAMED
, 'ctx');
1090 $sql .= " AND i.contextid $ctxsql";
1091 $params = array_merge($params, $p2);
1094 if ($args['onlyvisible'] == true) {
1095 $sql .= " AND r.visible = 1";
1098 if ($args['type'] !== null) {
1099 $sql .= " AND r.type = :type";
1100 $params['type'] = $args['type'];
1102 $sql .= " ORDER BY r.sortorder, i.name";
1104 if (!$records = $DB->get_records_sql($sql, $params)) {
1108 $repositories = array();
1109 // Sortorder should be unique, which is not true if we use $record->sortorder
1110 // and there are multiple instances of any repository type
1112 foreach ($records as $record) {
1113 $cache->set('i:'. $record->id
, $record);
1114 if (!file_exists($CFG->dirroot
. '/repository/'. $record->repositorytype
.'/lib.php')) {
1117 $repository = self
::get_repository_by_id($record->id
, $current_context);
1118 $repository->options
['sortorder'] = $sortorder++
;
1120 $is_supported = true;
1123 if ($args['accepted_types'] !== '*' and $repository->supported_filetypes() !== '*') {
1124 $accepted_ext = file_get_typegroup('extension', $args['accepted_types']);
1125 $supported_ext = file_get_typegroup('extension', $repository->supported_filetypes());
1126 $valid_ext = array_intersect($accepted_ext, $supported_ext);
1127 $is_supported = !empty($valid_ext);
1129 // Check return values.
1130 if (!empty($args['return_types']) && !($repository->supported_returntypes() & $args['return_types'])) {
1131 $is_supported = false;
1134 if (!$args['onlyvisible'] ||
($repository->is_visible() && !$repository->disabled
)) {
1135 // check capability in current context
1136 $capability = has_capability('repository/'.$record->repositorytype
.':view', $current_context);
1137 if ($record->repositorytype
== 'coursefiles') {
1138 // coursefiles plugin needs managefiles permission
1139 $capability = $capability && has_capability('moodle/course:managefiles', $current_context);
1141 if ($is_supported && $capability) {
1142 $repositories[$repository->id
] = $repository;
1146 $cache->set($cachekey, new cacheable_object_array($repositories));
1147 return $repositories;
1151 * Get single repository instance for administrative actions
1153 * Do not use this function to access repository contents, because it
1154 * does not set the current context
1156 * @see repository::get_repository_by_id()
1159 * @param integer $id repository instance id
1160 * @return repository
1162 public static function get_instance($id) {
1163 return self
::get_repository_by_id($id, context_system
::instance());
1167 * Call a static function. Any additional arguments than plugin and function will be passed through.
1170 * @param string $plugin repository plugin name
1171 * @param string $function function name
1174 public static function static_function($plugin, $function) {
1177 //check that the plugin exists
1178 $typedirectory = $CFG->dirroot
. '/repository/'. $plugin . '/lib.php';
1179 if (!file_exists($typedirectory)) {
1180 //throw new repository_exception('invalidplugin', 'repository');
1184 $args = func_get_args();
1185 if (count($args) <= 2) {
1192 require_once($typedirectory);
1193 return call_user_func_array(array('repository_' . $plugin, $function), $args);
1197 * Scan file, throws exception in case of infected file.
1199 * Please note that the scanning engine must be able to access the file,
1200 * permissions of the file are not modified here!
1203 * @deprecated since Moodle 3.0
1204 * @param string $thefile
1205 * @param string $filename name of the file
1206 * @param bool $deleteinfected
1208 public static function antivir_scan_file($thefile, $filename, $deleteinfected) {
1209 debugging('Please upgrade your code to use \core\antivirus\manager::scan_file instead', DEBUG_DEVELOPER
);
1210 \core\antivirus\manager
::scan_file($thefile, $filename, $deleteinfected);
1214 * Repository method to serve the referenced file
1216 * @see send_stored_file
1218 * @param stored_file $storedfile the file that contains the reference
1219 * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
1220 * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1221 * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1222 * @param array $options additional options affecting the file serving
1224 public function send_file($storedfile, $lifetime=null , $filter=0, $forcedownload=false, array $options = null) {
1225 if ($this->has_moodle_files()) {
1226 $fs = get_file_storage();
1227 $params = file_storage
::unpack_reference($storedfile->get_reference(), true);
1229 if (is_array($params)) {
1230 $srcfile = $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
1231 $params['itemid'], $params['filepath'], $params['filename']);
1233 if (empty($options)) {
1236 if (!isset($options['filename'])) {
1237 $options['filename'] = $storedfile->get_filename();
1240 send_file_not_found();
1242 send_stored_file($srcfile, $lifetime, $filter, $forcedownload, $options);
1245 throw new coding_exception("Repository plugin must implement send_file() method.");
1250 * Return human readable reference information
1252 * @param string $reference value of DB field files_reference.reference
1253 * @param int $filestatus status of the file, 0 - ok, 666 - source missing
1256 public function get_reference_details($reference, $filestatus = 0) {
1257 if ($this->has_moodle_files()) {
1259 $params = file_storage
::unpack_reference($reference, true);
1260 if (is_array($params)) {
1261 $context = context
::instance_by_id($params['contextid'], IGNORE_MISSING
);
1263 $browser = get_file_browser();
1264 $fileinfo = $browser->get_file_info($context, $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']);
1267 if (empty($fileinfo)) {
1268 if ($filestatus == 666) {
1269 if (is_siteadmin() ||
($context && has_capability('moodle/course:managefiles', $context))) {
1270 return get_string('lostsource', 'repository',
1271 $params['contextid']. '/'. $params['component']. '/'. $params['filearea']. '/'. $params['itemid']. $params['filepath']. $params['filename']);
1273 return get_string('lostsource', 'repository', '');
1276 return get_string('undisclosedsource', 'repository');
1278 return $fileinfo->get_readable_fullname();
1285 * Cache file from external repository by reference
1286 * {@link repository::get_file_reference()}
1287 * {@link repository::get_file()}
1288 * Invoked at MOODLE/repository/repository_ajax.php
1290 * @param string $reference this reference is generated by
1291 * repository::get_file_reference()
1292 * @param stored_file $storedfile created file reference
1294 public function cache_file_by_reference($reference, $storedfile) {
1298 * reference_file_selected
1300 * This function is called when a controlled link file is selected in a file picker and the form is
1301 * saved. The expected behaviour for repositories supporting controlled links is to
1302 * - copy the file to the moodle system account
1303 * - put it in a folder that reflects the context it is being used
1304 * - make sure the sharing permissions are correct (read-only with the link)
1305 * - return a new reference string pointing to the newly copied file.
1307 * @param string $reference this reference is generated by
1308 * repository::get_file_reference()
1309 * @param context $context the target context for this new file.
1310 * @param string $component the target component for this new file.
1311 * @param string $filearea the target filearea for this new file.
1312 * @param string $itemid the target itemid for this new file.
1313 * @return string updated reference (final one before it's saved to db).
1315 public function reference_file_selected($reference, $context, $component, $filearea, $itemid) {
1320 * Return the source information
1322 * The result of the function is stored in files.source field. It may be analysed
1323 * when the source file is lost or repository may use it to display human-readable
1324 * location of reference original.
1326 * This method is called when file is picked for the first time only. When file
1327 * (either copy or a reference) is already in moodle and it is being picked
1328 * again to another file area (also as a copy or as a reference), the value of
1329 * files.source is copied.
1331 * @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
1332 * @return string|null
1334 public function get_file_source_info($source) {
1335 if ($this->has_moodle_files()) {
1336 $reference = $this->get_file_reference($source);
1337 return $this->get_reference_details($reference, 0);
1343 * Move file from download folder to file pool using FILE API
1347 * @param string $thefile file path in download folder
1348 * @param stdClass $record
1349 * @return array containing the following keys:
1355 public static function move_to_filepool($thefile, $record) {
1356 global $DB, $CFG, $USER, $OUTPUT;
1358 // scan for viruses if possible, throws exception if problem found
1359 // TODO: MDL-28637 this repository_no_delete is a bloody hack!
1360 \core\antivirus\manager
::scan_file($thefile, $record->filename
, empty($CFG->repository_no_delete
));
1362 $fs = get_file_storage();
1363 // If file name being used.
1364 if (repository
::draftfile_exists($record->itemid
, $record->filepath
, $record->filename
)) {
1365 $draftitemid = $record->itemid
;
1366 $new_filename = repository
::get_unused_filename($draftitemid, $record->filepath
, $record->filename
);
1367 $old_filename = $record->filename
;
1368 // Create a tmp file.
1369 $record->filename
= $new_filename;
1370 $newfile = $fs->create_file_from_pathname($record, $thefile);
1372 $event['event'] = 'fileexists';
1373 $event['newfile'] = new stdClass
;
1374 $event['newfile']->filepath
= $record->filepath
;
1375 $event['newfile']->filename
= $new_filename;
1376 $event['newfile']->url
= moodle_url
::make_draftfile_url($draftitemid, $record->filepath
, $new_filename)->out();
1378 $event['existingfile'] = new stdClass
;
1379 $event['existingfile']->filepath
= $record->filepath
;
1380 $event['existingfile']->filename
= $old_filename;
1381 $event['existingfile']->url
= moodle_url
::make_draftfile_url($draftitemid, $record->filepath
, $old_filename)->out();
1384 if ($file = $fs->create_file_from_pathname($record, $thefile)) {
1385 if (empty($CFG->repository_no_delete
)) {
1386 $delete = unlink($thefile);
1387 unset($CFG->repository_no_delete
);
1390 'url'=>moodle_url
::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename())->out(),
1391 'id'=>$file->get_itemid(),
1392 'file'=>$file->get_filename(),
1393 'icon' => $OUTPUT->image_url(file_extension_icon($thefile))->out(),
1401 * Builds a tree of files This function is then called recursively.
1404 * @todo take $search into account, and respect a threshold for dynamic loading
1405 * @param file_info $fileinfo an object returned by file_browser::get_file_info()
1406 * @param string $search searched string
1407 * @param bool $dynamicmode no recursive call is done when in dynamic mode
1408 * @param array $list the array containing the files under the passed $fileinfo
1409 * @return int the number of files found
1411 public static function build_tree($fileinfo, $search, $dynamicmode, &$list) {
1412 global $CFG, $OUTPUT;
1415 $children = $fileinfo->get_children();
1417 foreach ($children as $child) {
1418 $filename = $child->get_visible_name();
1419 $filesize = $child->get_filesize();
1420 $filesize = $filesize ?
display_size($filesize) : '';
1421 $filedate = $child->get_timemodified();
1422 $filedate = $filedate ?
userdate($filedate) : '';
1423 $filetype = $child->get_mimetype();
1425 if ($child->is_directory()) {
1427 $level = $child->get_parent();
1429 $params = $level->get_params();
1430 $path[] = array($params['filepath'], $level->get_visible_name());
1431 $level = $level->get_parent();
1435 'title' => $child->get_visible_name(),
1437 'date' => $filedate,
1438 'path' => array_reverse($path),
1439 'thumbnail' => $OUTPUT->image_url(file_folder_icon())->out(false)
1442 //if ($dynamicmode && $child->is_writable()) {
1443 // $tmp['children'] = array();
1445 // if folder name matches search, we send back all files contained.
1447 if ($search && stristr($tmp['title'], $search) !== false) {
1450 $tmp['children'] = array();
1451 $_filecount = repository
::build_tree($child, $_search, $dynamicmode, $tmp['children']);
1452 if ($search && $_filecount) {
1453 $tmp['expanded'] = 1;
1458 if (!$search ||
$_filecount ||
(stristr($tmp['title'], $search) !== false)) {
1459 $filecount +
= $_filecount;
1463 } else { // not a directory
1464 // skip the file, if we're in search mode and it's not a match
1465 if ($search && (stristr($filename, $search) === false)) {
1468 $params = $child->get_params();
1469 $source = serialize(array($params['contextid'], $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']));
1471 'title' => $filename,
1472 'size' => $filesize,
1473 'date' => $filedate,
1474 //'source' => $child->get_url(),
1475 'source' => base64_encode($source),
1476 'icon' => $OUTPUT->image_url(file_file_icon($child))->out(false),
1477 'thumbnail' => $OUTPUT->image_url(file_file_icon($child))->out(false),
1487 * Display a repository instance list (with edit/delete/create links)
1490 * @param stdClass $context the context for which we display the instance
1491 * @param string $typename if set, we display only one type of instance
1493 public static function display_instances_list($context, $typename = null) {
1494 global $CFG, $USER, $OUTPUT;
1496 $output = $OUTPUT->box_start('generalbox');
1497 //if the context is SYSTEM, so we call it from administration page
1498 $admin = ($context->id
== SYSCONTEXTID
) ?
true : false;
1500 $baseurl = new moodle_url('/admin/repositoryinstance.php');
1501 $output .= $OUTPUT->heading(get_string('siteinstances', 'repository'));
1503 $baseurl = new moodle_url('/repository/manage_instances.php', ['contextid' => $context->id
]);
1506 $namestr = get_string('name');
1507 $pluginstr = get_string('plugin', 'repository');
1508 $settingsstr = get_string('settings');
1509 $deletestr = get_string('delete');
1510 // Retrieve list of instances. In administration context we want to display all
1511 // instances of a type, even if this type is not visible. In course/user context we
1512 // want to display only visible instances, but for every type types. The repository::get_instances()
1513 // third parameter displays only visible type.
1515 $params['context'] = array($context);
1516 $params['currentcontext'] = $context;
1517 $params['return_types'] = 0;
1518 $params['onlyvisible'] = !$admin;
1519 $params['type'] = $typename;
1520 $instances = repository
::get_instances($params);
1521 $instancesnumber = count($instances);
1522 $alreadyplugins = array();
1524 $table = new html_table();
1525 $table->head
= array($namestr, $pluginstr, $settingsstr, $deletestr);
1526 $table->align
= array('left', 'left', 'center','center');
1527 $table->data
= array();
1531 foreach ($instances as $i) {
1535 $type = repository
::get_type_by_id($i->options
['typeid']);
1537 if ($type->get_contextvisibility($context)) {
1538 if (!$i->readonly
) {
1540 $settingurl = new moodle_url($baseurl);
1541 $settingurl->param('type', $i->options
['type']);
1542 $settingurl->param('edit', $i->id
);
1543 $settings .= html_writer
::link($settingurl, $settingsstr);
1545 $deleteurl = new moodle_url($baseurl);
1546 $deleteurl->param('delete', $i->id
);
1547 $deleteurl->param('type', $i->options
['type']);
1548 $delete .= html_writer
::link($deleteurl, $deletestr);
1552 $type = repository
::get_type_by_id($i->options
['typeid']);
1553 $table->data
[] = array(format_string($i->name
), $type->get_readablename(), $settings, $delete);
1555 //display a grey row if the type is defined as not visible
1556 if (isset($type) && !$type->get_visible()) {
1557 $table->rowclasses
[] = 'dimmed_text';
1559 $table->rowclasses
[] = '';
1562 if (!in_array($i->name
, $alreadyplugins)) {
1563 $alreadyplugins[] = $i->name
;
1566 $output .= html_writer
::table($table);
1567 $instancehtml = '<div>';
1570 //if no type is set, we can create all type of instance
1572 $instancehtml .= '<h3>';
1573 $instancehtml .= get_string('createrepository', 'repository');
1574 $instancehtml .= '</h3><ul>';
1575 $types = repository
::get_editable_types($context);
1576 foreach ($types as $type) {
1577 if (!empty($type) && $type->get_visible()) {
1578 // If the user does not have the permission to view the repository, it won't be displayed in
1579 // the list of instances. Hiding the link to create new instances will prevent the
1580 // user from creating them without being able to find them afterwards, which looks like a bug.
1581 if (!has_capability('repository/'.$type->get_typename().':view', $context)) {
1584 $instanceoptionnames = repository
::static_function($type->get_typename(), 'get_instance_option_names');
1585 if (!empty($instanceoptionnames)) {
1586 $baseurl->param('new', $type->get_typename());
1587 $instancehtml .= '<li><a href="'.$baseurl->out().'">'.get_string('createxxinstance', 'repository', get_string('pluginname', 'repository_'.$type->get_typename())). '</a></li>';
1588 $baseurl->remove_params('new');
1593 $instancehtml .= '</ul>';
1596 $instanceoptionnames = repository
::static_function($typename, 'get_instance_option_names');
1597 if (!empty($instanceoptionnames)) { //create a unique type of instance
1599 $baseurl->param('new', $typename);
1600 $output .= $OUTPUT->single_button($baseurl, get_string('createinstance', 'repository'), 'get');
1601 $baseurl->remove_params('new');
1606 $instancehtml .= '</div>';
1607 $output .= $instancehtml;
1610 $output .= $OUTPUT->box_end();
1612 //print the list + creation links
1617 * Prepare file reference information
1619 * @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
1620 * @return string file reference, ready to be stored
1622 public function get_file_reference($source) {
1623 if ($source && $this->has_moodle_files()) {
1624 $params = @json_decode
(base64_decode($source), true);
1625 if (!is_array($params) ||
empty($params['contextid'])) {
1626 throw new repository_exception('invalidparams', 'repository');
1629 'component' => empty($params['component']) ?
'' : clean_param($params['component'], PARAM_COMPONENT
),
1630 'filearea' => empty($params['filearea']) ?
'' : clean_param($params['filearea'], PARAM_AREA
),
1631 'itemid' => empty($params['itemid']) ?
0 : clean_param($params['itemid'], PARAM_INT
),
1632 'filename' => empty($params['filename']) ?
null : clean_param($params['filename'], PARAM_FILE
),
1633 'filepath' => empty($params['filepath']) ?
null : clean_param($params['filepath'], PARAM_PATH
),
1634 'contextid' => clean_param($params['contextid'], PARAM_INT
)
1636 // Check if context exists.
1637 if (!context
::instance_by_id($params['contextid'], IGNORE_MISSING
)) {
1638 throw new repository_exception('invalidparams', 'repository');
1640 return file_storage
::pack_reference($params);
1646 * Get a unique file path in which to save the file.
1648 * The filename returned will be removed at the end of the request and
1649 * should not be relied upon to exist in subsequent requests.
1651 * @param string $filename file name
1654 public function prepare_file($filename) {
1655 if (empty($filename)) {
1658 return sprintf('%s/%s', make_request_directory(), $filename);
1662 * Does this repository used to browse moodle files?
1666 public function has_moodle_files() {
1671 * Return file URL, for most plugins, the parameter is the original
1672 * url, but some plugins use a file id, so we need this function to
1673 * convert file id to original url.
1675 * @param string $url the url of file
1678 public function get_link($url) {
1683 * Downloads a file from external repository and saves it in temp dir
1685 * Function get_file() must be implemented by repositories that support returntypes
1686 * FILE_INTERNAL or FILE_REFERENCE. It is invoked to pick up the file and copy it
1687 * to moodle. This function is not called for moodle repositories, the function
1688 * {@link repository::copy_to_area()} is used instead.
1690 * This function can be overridden by subclass if the files.reference field contains
1691 * not just URL or if request should be done differently.
1694 * @throws file_exception when error occured
1696 * @param string $url the content of files.reference field, in this implementaion
1697 * it is asssumed that it contains the string with URL of the file
1698 * @param string $filename filename (without path) to save the downloaded file in the
1699 * temporary directory, if omitted or file already exists the new filename will be generated
1700 * @return array with elements:
1701 * path: internal location of the file
1702 * url: URL to the source (from parameters)
1704 public function get_file($url, $filename = '') {
1707 $path = $this->prepare_file($filename);
1710 $result = $c->download_one($url, null, array('filepath' => $path, 'timeout' => $CFG->repositorygetfiletimeout
));
1711 if ($result !== true) {
1712 throw new moodle_exception('errorwhiledownload', 'repository', '', $result);
1714 return array('path'=>$path, 'url'=>$url);
1718 * Downloads the file from external repository and saves it in moodle filepool.
1719 * This function is different from {@link repository::sync_reference()} because it has
1720 * bigger request timeout and always downloads the content.
1722 * This function is invoked when we try to unlink the file from the source and convert
1723 * a reference into a true copy.
1725 * @throws exception when file could not be imported
1727 * @param stored_file $file
1728 * @param int $maxbytes throw an exception if file size is bigger than $maxbytes (0 means no limit)
1730 public function import_external_file_contents(stored_file
$file, $maxbytes = 0) {
1731 if (!$file->is_external_file()) {
1732 // nothing to import if the file is not a reference
1734 } else if ($file->get_repository_id() != $this->id
) {
1736 debugging('Repository instance id does not match');
1738 } else if ($this->has_moodle_files()) {
1739 // files that are references to local files are already in moodle filepool
1740 // just validate the size
1741 if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1742 $maxbytesdisplay = display_size($maxbytes, 0);
1743 throw new file_exception('maxbytesfile', (object) array('file' => $file->get_filename(),
1744 'size' => $maxbytesdisplay));
1748 if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1749 // note that stored_file::get_filesize() also calls synchronisation
1750 $maxbytesdisplay = display_size($maxbytes, 0);
1751 throw new file_exception('maxbytesfile', (object) array('file' => $file->get_filename(),
1752 'size' => $maxbytesdisplay));
1754 $fs = get_file_storage();
1756 // If a file has been downloaded, the file record should report both a positive file
1757 // size, and a contenthash which does not related to empty content.
1758 // If thereis no file size, or the contenthash is for an empty file, then the file has
1759 // yet to be successfully downloaded.
1760 $contentexists = $file->get_filesize() && !$file->compare_to_string('');
1762 if (!$file->get_status() && $contentexists) {
1763 // we already have the content in moodle filepool and it was synchronised recently.
1764 // Repositories may overwrite it if they want to force synchronisation anyway!
1767 // attempt to get a file
1769 $fileinfo = $this->get_file($file->get_reference());
1770 if (isset($fileinfo['path'])) {
1771 $file->set_synchronised_content_from_file($fileinfo['path']);
1773 throw new moodle_exception('errorwhiledownload', 'repository', '', '');
1775 } catch (Exception
$e) {
1776 if ($contentexists) {
1777 // better something than nothing. We have a copy of file. It's sync time
1778 // has expired but it is still very likely that it is the last version
1788 * Return size of a file in bytes.
1790 * @param string $source encoded and serialized data of file
1791 * @return int file size in bytes
1793 * @deprecated since Moodle 4.3
1795 public function get_file_size($source) {
1796 debugging(__FUNCTION__
. ' is deprecated, please do not use it any more', DEBUG_DEVELOPER
);
1798 $browser = get_file_browser();
1799 $params = unserialize(base64_decode($source));
1800 $contextid = clean_param($params['contextid'], PARAM_INT
);
1801 $fileitemid = clean_param($params['itemid'], PARAM_INT
);
1802 $filename = clean_param($params['filename'], PARAM_FILE
);
1803 $filepath = clean_param($params['filepath'], PARAM_PATH
);
1804 $filearea = clean_param($params['filearea'], PARAM_AREA
);
1805 $component = clean_param($params['component'], PARAM_COMPONENT
);
1806 $context = context
::instance_by_id($contextid);
1807 $file_info = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
1808 if (!empty($file_info)) {
1809 $filesize = $file_info->get_filesize();
1817 * Return is the instance is visible
1818 * (is the type visible ? is the context enable ?)
1822 public function is_visible() {
1823 $type = repository
::get_type_by_id($this->options
['typeid']);
1824 $instanceoptions = repository
::static_function($type->get_typename(), 'get_instance_option_names');
1826 if ($type->get_visible()) {
1827 //if the instance is unique so it's visible, otherwise check if the instance has a enabled context
1828 if (empty($instanceoptions) ||
$type->get_contextvisibility(context
::instance_by_id($this->instance
->contextid
))) {
1837 * Can the instance be edited by the current user?
1839 * The property $readonly must not be used within this method because
1840 * it only controls if the options from self::get_instance_option_names()
1843 * @return bool true if the user can edit the instance.
1846 final public function can_be_edited_by_user() {
1849 // We need to be able to explore the repository.
1851 $this->check_capability();
1852 } catch (repository_exception
$e) {
1856 $repocontext = context
::instance_by_id($this->instance
->contextid
);
1857 if ($repocontext->contextlevel
== CONTEXT_USER
&& $repocontext->instanceid
!= $USER->id
) {
1858 // If the context of this instance is a user context, we need to be this user.
1860 } else if ($repocontext->contextlevel
== CONTEXT_MODULE
&& !has_capability('moodle/course:update', $repocontext)) {
1861 // We need to have permissions on the course to edit the instance.
1863 } else if ($repocontext->contextlevel
== CONTEXT_SYSTEM
&& !has_capability('moodle/site:config', $repocontext)) {
1864 // Do not meet the requirements for the context system.
1872 * Return the name of this instance, can be overridden.
1876 public function get_name() {
1877 if ($name = $this->instance
->name
) {
1880 return get_string('pluginname', 'repository_' . $this->get_typename());
1885 * Is this repository accessing private data?
1887 * This function should return true for the repositories which access external private
1888 * data from a user. This is the case for repositories such as Dropbox, Google Docs or Box.net
1889 * which authenticate the user and then store the auth token.
1891 * Of course, many repositories store 'private data', but we only want to set
1892 * contains_private_data() to repositories which are external to Moodle and shouldn't be accessed
1893 * to by the users having the capability to 'login as' someone else. For instance, the repository
1894 * 'Private files' is not considered as private because it's part of Moodle.
1896 * You should not set contains_private_data() to true on repositories which allow different types
1897 * of instances as the levels other than 'user' are, by definition, not private. Also
1898 * the user instances will be protected when they need to.
1900 * @return boolean True when the repository accesses private external data.
1903 public function contains_private_data() {
1908 * What kind of files will be in this repository?
1910 * @return array return '*' means this repository support any files, otherwise
1911 * return mimetypes of files, it can be an array
1913 public function supported_filetypes() {
1914 // return array('text/plain', 'image/gif');
1919 * Tells how the file can be picked from this repository
1921 * Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
1925 public function supported_returntypes() {
1926 return (FILE_INTERNAL | FILE_EXTERNAL
);
1930 * Tells how the file can be picked from this repository
1932 * Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
1936 public function default_returntype() {
1937 return FILE_INTERNAL
;
1941 * Provide repository instance information for Ajax
1945 final public function get_meta() {
1946 global $CFG, $OUTPUT;
1947 $meta = new stdClass();
1948 $meta->id
= $this->id
;
1949 $meta->name
= format_string($this->get_name());
1950 $meta->type
= $this->get_typename();
1951 $meta->icon
= $OUTPUT->image_url('icon', 'repository_'.$meta->type
)->out(false);
1952 $meta->supported_types
= file_get_typegroup('extension', $this->supported_filetypes());
1953 $meta->return_types
= $this->supported_returntypes();
1954 $meta->defaultreturntype
= $this->default_returntype();
1955 $meta->sortorder
= $this->options
['sortorder'];
1960 * Create an instance for this plug-in
1963 * @param string $type the type of the repository
1964 * @param int $userid the user id
1965 * @param stdClass $context the context
1966 * @param array $params the options for this instance
1967 * @param int $readonly whether to create it readonly or not (defaults to not)
1970 public static function create($type, $userid, $context, $params, $readonly=0) {
1972 $params = (array)$params;
1973 require_once($CFG->dirroot
. '/repository/'. $type . '/lib.php');
1974 $classname = 'repository_' . $type;
1975 if ($repo = $DB->get_record('repository', array('type'=>$type))) {
1976 $record = new stdClass();
1977 $record->name
= $params['name'];
1978 $record->typeid
= $repo->id
;
1979 $record->timecreated
= time();
1980 $record->timemodified
= time();
1981 $record->contextid
= $context->id
;
1982 $record->readonly
= $readonly;
1983 $record->userid
= $userid;
1984 $id = $DB->insert_record('repository_instances', $record);
1985 cache
::make('core', 'repositories')->purge();
1987 $configs = call_user_func($classname . '::get_instance_option_names');
1988 if (!empty($configs)) {
1989 foreach ($configs as $config) {
1990 if (isset($params[$config])) {
1991 $options[$config] = $params[$config];
1993 $options[$config] = null;
1999 unset($options['name']);
2000 $instance = repository
::get_instance($id);
2001 $instance->set_option($options);
2012 * delete a repository instance
2014 * @param bool $downloadcontents
2017 final public function delete($downloadcontents = false) {
2019 if ($downloadcontents) {
2020 $this->convert_references_to_local();
2022 $this->remove_files();
2024 cache
::make('core', 'repositories')->purge();
2026 $DB->delete_records('repository_instances', array('id'=>$this->id
));
2027 $DB->delete_records('repository_instance_config', array('instanceid'=>$this->id
));
2028 } catch (dml_exception
$ex) {
2035 * Delete all the instances associated to a context.
2037 * This method is intended to be a callback when deleting
2038 * a course or a user to delete all the instances associated
2039 * to their context. The usual way to delete a single instance
2040 * is to use {@link self::delete()}.
2042 * @param int $contextid context ID.
2043 * @param boolean $downloadcontents true to convert references to hard copies.
2046 final public static function delete_all_for_context($contextid, $downloadcontents = true) {
2048 $repoids = $DB->get_fieldset_select('repository_instances', 'id', 'contextid = :contextid', array('contextid' => $contextid));
2049 if ($downloadcontents) {
2050 foreach ($repoids as $repoid) {
2051 $repo = repository
::get_repository_by_id($repoid, $contextid);
2052 $repo->convert_references_to_local();
2055 cache
::make('core', 'repositories')->purge();
2056 $DB->delete_records_list('repository_instances', 'id', $repoids);
2057 $DB->delete_records_list('repository_instance_config', 'instanceid', $repoids);
2061 * Hide/Show a repository
2063 * @param string $hide
2066 final public function hide($hide = 'toggle') {
2068 if ($entry = $DB->get_record('repository', array('id'=>$this->id
))) {
2069 if ($hide === 'toggle' ) {
2070 if (!empty($entry->visible
)) {
2071 $entry->visible
= 0;
2073 $entry->visible
= 1;
2076 if (!empty($hide)) {
2077 $entry->visible
= 0;
2079 $entry->visible
= 1;
2082 return $DB->update_record('repository', $entry);
2088 * Save settings for repository instance
2089 * $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));
2091 * @param array $options settings
2094 public function set_option($options = array()) {
2097 if (!empty($options['name'])) {
2098 $r = new stdClass();
2100 $r->name
= $options['name'];
2101 $DB->update_record('repository_instances', $r);
2102 unset($options['name']);
2104 foreach ($options as $name=>$value) {
2105 if ($id = $DB->get_field('repository_instance_config', 'id', array('name'=>$name, 'instanceid'=>$this->id
))) {
2106 $DB->set_field('repository_instance_config', 'value', $value, array('id'=>$id));
2108 $config = new stdClass();
2109 $config->instanceid
= $this->id
;
2110 $config->name
= $name;
2111 $config->value
= $value;
2112 $DB->insert_record('repository_instance_config', $config);
2115 cache
::make('core', 'repositories')->purge();
2120 * Get settings for repository instance.
2122 * @param string $config a specific option to get.
2123 * @return mixed returns an array of options. If $config is not empty, then it returns that option,
2124 * or null if the option does not exist.
2126 public function get_option($config = '') {
2128 $cache = cache
::make('core', 'repositories');
2129 if (($entries = $cache->get('ops:'. $this->id
)) === false) {
2130 $entries = $DB->get_records('repository_instance_config', array('instanceid' => $this->id
));
2131 $cache->set('ops:'. $this->id
, $entries);
2135 foreach($entries as $entry) {
2136 $ret[$entry->name
] = $entry->value
;
2139 if (!empty($config)) {
2140 if (isset($ret[$config])) {
2141 return $ret[$config];
2151 * Filter file listing to display specific types
2153 * @param array $value
2156 public function filter($value) {
2157 $accepted_types = optional_param_array('accepted_types', '', PARAM_RAW
);
2158 if (isset($value['children'])) {
2159 return true; // always return directories
2161 if ($accepted_types == '*' or empty($accepted_types)
2162 or (is_array($accepted_types) and in_array('*', $accepted_types))) {
2165 foreach ($accepted_types as $ext) {
2166 if (preg_match('#'.$ext.'$#i', $value['title'])) {
2176 * Given a path, and perhaps a search, get a list of files.
2178 * See details on {@link https://moodledev.io/docs/apis/plugintypes/repository}
2180 * @param string $path this parameter can a folder name, or a identification of folder
2181 * @param string $page the page number of file list
2182 * @return array the list of files, including meta infomation, containing the following keys
2183 * manage, url to manage url
2186 * repo_id, active repository id
2187 * login_btn_action, the login button action
2188 * login_btn_label, the login button label
2189 * total, number of results
2190 * perpage, items per page
2192 * pages, total pages
2193 * issearchresult, is it a search result?
2195 * path, current path and parent path
2197 public function get_listing($path = '', $page = '') {
2202 * Prepare the breadcrumb.
2204 * @param array $breadcrumb contains each element of the breadcrumb.
2205 * @return array of breadcrumb elements.
2206 * @since Moodle 2.3.3
2208 protected static function prepare_breadcrumb($breadcrumb) {
2210 $foldericon = $OUTPUT->image_url(file_folder_icon())->out(false);
2211 $len = count($breadcrumb);
2212 for ($i = 0; $i < $len; $i++
) {
2213 if (is_array($breadcrumb[$i]) && !isset($breadcrumb[$i]['icon'])) {
2214 $breadcrumb[$i]['icon'] = $foldericon;
2215 } else if (is_object($breadcrumb[$i]) && !isset($breadcrumb[$i]->icon
)) {
2216 $breadcrumb[$i]->icon
= $foldericon;
2223 * Prepare the file/folder listing.
2225 * @param array $list of files and folders.
2226 * @return array of files and folders.
2227 * @since Moodle 2.3.3
2229 protected static function prepare_list($list) {
2231 $foldericon = $OUTPUT->image_url(file_folder_icon())->out(false);
2233 // Reset the array keys because non-numeric keys will create an object when converted to JSON.
2234 $list = array_values($list);
2236 $len = count($list);
2237 for ($i = 0; $i < $len; $i++
) {
2238 if (is_object($list[$i])) {
2239 $file = (array)$list[$i];
2240 $converttoobject = true;
2243 $converttoobject = false;
2246 if (isset($file['source'])) {
2247 $file['sourcekey'] = sha1($file['source'] . self
::get_secret_key() . sesskey());
2250 if (isset($file['size'])) {
2251 $file['size'] = (int)$file['size'];
2252 $file['size_f'] = display_size($file['size']);
2254 if (isset($file['license']) && get_string_manager()->string_exists($file['license'], 'license')) {
2255 $file['license_f'] = get_string($file['license'], 'license');
2257 if (isset($file['image_width']) && isset($file['image_height'])) {
2258 $a = array('width' => $file['image_width'], 'height' => $file['image_height']);
2259 $file['dimensions'] = get_string('imagesize', 'repository', (object)$a);
2261 foreach (array('date', 'datemodified', 'datecreated') as $key) {
2262 if (!isset($file[$key]) && isset($file['date'])) {
2263 $file[$key] = $file['date'];
2265 if (isset($file[$key])) {
2266 // must be UNIX timestamp
2267 $file[$key] = (int)$file[$key];
2271 $file[$key.'_f'] = userdate($file[$key], get_string('strftimedatetime', 'langconfig'));
2272 $file[$key.'_f_s'] = userdate($file[$key], get_string('strftimedatetimeshort', 'langconfig'));
2276 $isfolder = (array_key_exists('children', $file) ||
(isset($file['type']) && $file['type'] == 'folder'));
2278 if (isset($file['title'])) {
2279 $filename = $file['title'];
2281 else if (isset($file['fullname'])) {
2282 $filename = $file['fullname'];
2284 if (!isset($file['mimetype']) && !$isfolder && $filename) {
2285 $file['mimetype'] = get_mimetype_description(array('filename' => $filename));
2287 if (!isset($file['icon'])) {
2289 $file['icon'] = $foldericon;
2290 } else if ($filename) {
2291 $file['icon'] = $OUTPUT->image_url(file_extension_icon($filename))->out(false);
2295 // Recursively loop over children.
2296 if (isset($file['children'])) {
2297 $file['children'] = self
::prepare_list($file['children']);
2300 // Convert the array back to an object.
2301 if ($converttoobject) {
2302 $list[$i] = (object)$file;
2309 * Prepares list of files before passing it to AJAX, makes sure data is in the correct
2310 * format and stores formatted values.
2312 * @param array|stdClass $listing result of get_listing() or search() or file_get_drafarea_files()
2315 public static function prepare_listing($listing) {
2317 if (is_object($listing)) {
2318 $listing = (array) $listing;
2322 // Prepare the breadcrumb, passed as 'path'.
2323 if (isset($listing['path']) && is_array($listing['path'])) {
2324 $listing['path'] = self
::prepare_breadcrumb($listing['path']);
2327 // Prepare the listing of objects.
2328 if (isset($listing['list']) && is_array($listing['list'])) {
2329 $listing['list'] = self
::prepare_list($listing['list']);
2332 // Convert back to an object.
2334 $listing = (object) $listing;
2340 * Search files in repository
2341 * When doing global search, $search_text will be used as
2344 * @param string $search_text search key word
2345 * @param int $page page
2346 * @return mixed see {@link repository::get_listing()}
2348 public function search($search_text, $page = 0) {
2350 $list['list'] = array();
2355 * Logout from repository instance
2356 * By default, this function will return a login form
2360 public function logout(){
2361 return $this->print_login();
2365 * To check whether the user is logged in.
2369 public function check_login(){
2375 * Show the login screen, if required
2379 public function print_login(){
2380 return $this->get_listing();
2384 * Show the search screen, if required
2388 public function print_search() {
2390 $renderer = $PAGE->get_renderer('core', 'files');
2391 return $renderer->repository_default_searchform();
2395 * For oauth like external authentication, when external repository direct user back to moodle,
2396 * this function will be called to set up token and token_secret
2398 public function callback() {
2402 * is it possible to do glboal search?
2406 public function global_search() {
2411 * Defines operations that happen occasionally on cron
2415 public function cron() {
2420 * function which is run when the type is created (moodle administrator add the plugin)
2422 * @return bool success or fail?
2424 public static function plugin_init() {
2429 * Edit/Create Admin Settings Moodle form
2431 * @param MoodleQuickForm $mform Moodle form (passed by reference)
2432 * @param string $classname repository class name
2434 public static function type_config_form($mform, $classname = 'repository') {
2435 $instnaceoptions = call_user_func(array($classname, 'get_instance_option_names'), $mform, $classname);
2436 if (empty($instnaceoptions)) {
2437 // this plugin has only one instance
2438 // so we need to give it a name
2439 // it can be empty, then moodle will look for instance name from language string
2440 $mform->addElement('text', 'pluginname', get_string('pluginname', 'repository'), array('size' => '40'));
2441 $mform->addElement('static', 'pluginnamehelp', '', get_string('pluginnamehelp', 'repository'));
2442 $mform->setType('pluginname', PARAM_TEXT
);
2447 * Validate Admin Settings Moodle form
2450 * @param moodleform $mform Moodle form (passed by reference)
2451 * @param array $data array of ("fieldname"=>value) of submitted data
2452 * @param array $errors array of ("fieldname"=>errormessage) of errors
2453 * @return array array of errors
2455 public static function type_form_validation($mform, $data, $errors) {
2461 * Edit/Create Instance Settings Moodle form
2463 * @param moodleform $mform Moodle form (passed by reference)
2465 public static function instance_config_form($mform) {
2469 * Return names of the general options.
2470 * By default: no general option name
2474 public static function get_type_option_names() {
2475 return array('pluginname');
2479 * Return names of the instance options.
2480 * By default: no instance option name
2484 public static function get_instance_option_names() {
2489 * Validate repository plugin instance form
2491 * @param moodleform $mform moodle form
2492 * @param array $data form data
2493 * @param array $errors errors
2494 * @return array errors
2496 public static function instance_form_validation($mform, $data, $errors) {
2501 * Create a shorten filename
2503 * @param string $str filename
2504 * @param int $maxlength max file name length
2505 * @return string short filename
2507 public function get_short_filename($str, $maxlength) {
2508 if (core_text
::strlen($str) >= $maxlength) {
2509 return trim(core_text
::substr($str, 0, $maxlength)).'...';
2516 * Overwrite an existing file
2518 * @param int $itemid
2519 * @param string $filepath
2520 * @param string $filename
2521 * @param string $newfilepath
2522 * @param string $newfilename
2525 public static function overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename) {
2527 $fs = get_file_storage();
2528 $user_context = context_user
::instance($USER->id
);
2529 if ($file = $fs->get_file($user_context->id
, 'user', 'draft', $itemid, $filepath, $filename)) {
2530 if ($tempfile = $fs->get_file($user_context->id
, 'user', 'draft', $itemid, $newfilepath, $newfilename)) {
2531 // Remember original file source field.
2532 $source = @unserialize
($file->get_source());
2533 // Remember the original sortorder.
2534 $sortorder = $file->get_sortorder();
2535 if ($tempfile->is_external_file()) {
2536 // New file is a reference. Check that existing file does not have any other files referencing to it
2537 if (isset($source->original
) && $fs->search_references_count($source->original
)) {
2538 return (object)array('error' => get_string('errordoublereference', 'repository'));
2541 // delete existing file to release filename
2544 $newfile = $fs->create_file_from_storedfile(array('filepath'=>$filepath, 'filename'=>$filename), $tempfile);
2545 // Preserve original file location (stored in source field) for handling references
2546 if (isset($source->original
)) {
2547 if (!($newfilesource = @unserialize
($newfile->get_source()))) {
2548 $newfilesource = new stdClass();
2550 $newfilesource->original
= $source->original
;
2551 $newfile->set_source(serialize($newfilesource));
2553 $newfile->set_sortorder($sortorder);
2555 $tempfile->delete();
2563 * Updates a file in draft filearea.
2565 * This function can only update fields filepath, filename, author, license.
2566 * If anything (except filepath) is updated, timemodified is set to current time.
2567 * If filename or filepath is updated the file unconnects from it's origin
2568 * and therefore all references to it will be converted to copies when
2569 * filearea is saved.
2571 * @param int $draftid
2572 * @param string $filepath path to the directory containing the file, or full path in case of directory
2573 * @param string $filename name of the file, or '.' in case of directory
2574 * @param array $updatedata array of fields to change (only filename, filepath, license and/or author can be updated)
2575 * @throws moodle_exception if for any reason file can not be updated (file does not exist, target already exists, etc.)
2577 public static function update_draftfile($draftid, $filepath, $filename, $updatedata) {
2579 $fs = get_file_storage();
2580 $usercontext = context_user
::instance($USER->id
);
2581 // make sure filename and filepath are present in $updatedata
2582 $updatedata = $updatedata +
array('filepath' => $filepath, 'filename' => $filename);
2583 $filemodified = false;
2584 if (!$file = $fs->get_file($usercontext->id
, 'user', 'draft', $draftid, $filepath, $filename)) {
2585 if ($filename === '.') {
2586 throw new moodle_exception('foldernotfound', 'repository');
2588 throw new moodle_exception('filenotfound', 'error');
2591 if (!$file->is_directory()) {
2593 if ($updatedata['filepath'] !== $filepath ||
$updatedata['filename'] !== $filename) {
2594 // Rename/move file: check that target file name does not exist.
2595 if ($fs->file_exists($usercontext->id
, 'user', 'draft', $draftid, $updatedata['filepath'], $updatedata['filename'])) {
2596 throw new moodle_exception('fileexists', 'repository');
2598 if (($filesource = @unserialize
($file->get_source())) && isset($filesource->original
)) {
2599 unset($filesource->original
);
2600 $file->set_source(serialize($filesource));
2602 $file->rename($updatedata['filepath'], $updatedata['filename']);
2603 // timemodified is updated only when file is renamed and not updated when file is moved.
2604 $filemodified = $filemodified ||
($updatedata['filename'] !== $filename);
2606 if (array_key_exists('license', $updatedata) && $updatedata['license'] !== $file->get_license()) {
2607 // Update license and timemodified.
2608 $file->set_license($updatedata['license']);
2609 $filemodified = true;
2611 if (array_key_exists('author', $updatedata) && $updatedata['author'] !== $file->get_author()) {
2612 // Update author and timemodified.
2613 $file->set_author($updatedata['author']);
2614 $filemodified = true;
2616 // Update timemodified:
2617 if ($filemodified) {
2618 $file->set_timemodified(time());
2621 // This is a directory - only filepath can be updated for a directory (it was moved).
2622 if ($updatedata['filepath'] === $filepath) {
2623 // nothing to update
2626 if ($fs->file_exists($usercontext->id
, 'user', 'draft', $draftid, $updatedata['filepath'], '.')) {
2627 // bad luck, we can not rename if something already exists there
2628 throw new moodle_exception('folderexists', 'repository');
2630 $xfilepath = preg_quote($filepath, '|');
2631 if (preg_match("|^$xfilepath|", $updatedata['filepath'])) {
2632 // we can not move folder to it's own subfolder
2633 throw new moodle_exception('folderrecurse', 'repository');
2636 // If directory changed the name, update timemodified.
2637 $filemodified = (basename(rtrim($file->get_filepath(), '/')) !== basename(rtrim($updatedata['filepath'], '/')));
2639 // Now update directory and all children.
2640 $files = $fs->get_area_files($usercontext->id
, 'user', 'draft', $draftid);
2641 foreach ($files as $f) {
2642 if (preg_match("|^$xfilepath|", $f->get_filepath())) {
2643 $path = preg_replace("|^$xfilepath|", $updatedata['filepath'], $f->get_filepath());
2644 if (($filesource = @unserialize
($f->get_source())) && isset($filesource->original
)) {
2645 // unset original so the references are not shown any more
2646 unset($filesource->original
);
2647 $f->set_source(serialize($filesource));
2649 $f->rename($path, $f->get_filename());
2650 if ($filemodified && $f->get_filepath() === $updatedata['filepath'] && $f->get_filename() === $filename) {
2651 $f->set_timemodified(time());
2659 * Delete a temp file from draft area
2661 * @param int $draftitemid
2662 * @param string $filepath
2663 * @param string $filename
2666 public static function delete_tempfile_from_draft($draftitemid, $filepath, $filename) {
2668 $fs = get_file_storage();
2669 $user_context = context_user
::instance($USER->id
);
2670 if ($file = $fs->get_file($user_context->id
, 'user', 'draft', $draftitemid, $filepath, $filename)) {
2679 * Find all external files in this repo and import them
2681 public function convert_references_to_local() {
2682 $fs = get_file_storage();
2683 $files = $fs->get_external_files($this->id
);
2684 foreach ($files as $storedfile) {
2685 $fs->import_external_file($storedfile);
2690 * Find all external files linked to this repository and delete them.
2692 public function remove_files() {
2693 $fs = get_file_storage();
2694 $files = $fs->get_external_files($this->id
);
2695 foreach ($files as $storedfile) {
2696 $storedfile->delete();
2701 * Function repository::reset_caches() is deprecated, cache is handled by MUC now.
2702 * @deprecated since Moodle 2.6 MDL-42016 - please do not use this function any more.
2704 public static function reset_caches() {
2705 throw new coding_exception('Function repository::reset_caches() can not be used any more, cache is handled by MUC now.');
2709 * Function repository::sync_external_file() is deprecated. Use repository::sync_reference instead
2711 * @deprecated since Moodle 2.6 MDL-42016 - please do not use this function any more.
2712 * @see repository::sync_reference()
2714 public static function sync_external_file($file, $resetsynchistory = false) {
2715 throw new coding_exception('Function repository::sync_external_file() can not be used any more. ' .
2716 'Use repository::sync_reference instead.');
2720 * Performs synchronisation of an external file if the previous one has expired.
2722 * This function must be implemented for external repositories supporting
2723 * FILE_REFERENCE, it is called for existing aliases when their filesize,
2724 * contenthash or timemodified are requested. It is not called for internal
2725 * repositories (see {@link repository::has_moodle_files()}), references to
2726 * internal files are updated immediately when source is modified.
2728 * Referenced files may optionally keep their content in Moodle filepool (for
2729 * thumbnail generation or to be able to serve cached copy). In this
2730 * case both contenthash and filesize need to be synchronized. Otherwise repositories
2731 * should use contenthash of empty file and correct filesize in bytes.
2733 * Note that this function may be run for EACH file that needs to be synchronised at the
2734 * moment. If anything is being downloaded or requested from external sources there
2735 * should be a small timeout. The synchronisation is performed to update the size of
2736 * the file and/or to update image and re-generated image preview. There is nothing
2737 * fatal if syncronisation fails but it is fatal if syncronisation takes too long
2738 * and hangs the script generating a page.
2740 * Note: If you wish to call $file->get_filesize(), $file->get_contenthash() or
2741 * $file->get_timemodified() make sure that recursion does not happen.
2743 * Called from {@link stored_file::sync_external_file()}
2745 * @uses stored_file::set_missingsource()
2746 * @uses stored_file::set_synchronized()
2747 * @param stored_file $file
2748 * @return bool false when file does not need synchronisation, true if it was synchronised
2750 public function sync_reference(stored_file
$file) {
2751 if ($file->get_repository_id() != $this->id
) {
2752 // This should not really happen because the function can be called from stored_file only.
2756 if ($this->has_moodle_files()) {
2757 // References to local files need to be synchronised only once.
2758 // Later they will be synchronised automatically when the source is changed.
2759 if ($file->get_referencelastsync()) {
2762 $fs = get_file_storage();
2763 $params = file_storage
::unpack_reference($file->get_reference(), true);
2764 if (!is_array($params) ||
!($storedfile = $fs->get_file($params['contextid'],
2765 $params['component'], $params['filearea'], $params['itemid'], $params['filepath'],
2766 $params['filename']))) {
2767 $file->set_missingsource();
2769 $file->set_synchronized($storedfile->get_contenthash(), $storedfile->get_filesize(), 0, $storedfile->get_timemodified());
2778 * Build draft file's source field
2780 * {@link file_restore_source_field_from_draft_file()}
2781 * XXX: This is a hack for file manager (MDL-28666)
2782 * For newly created draft files we have to construct
2783 * source filed in php serialized data format.
2784 * File manager needs to know the original file information before copying
2785 * to draft area, so we append these information in mdl_files.source field
2787 * @param string $source
2788 * @return string serialised source field
2790 public static function build_source_field($source) {
2791 $sourcefield = new stdClass
;
2792 $sourcefield->source
= $source;
2793 return serialize($sourcefield);
2797 * Prepares the repository to be cached. Implements method from cacheable_object interface.
2801 public function prepare_to_cache() {
2803 'class' => get_class($this),
2805 'ctxid' => $this->context
->id
,
2806 'options' => $this->options
,
2807 'readonly' => $this->readonly
2812 * Restores the repository from cache. Implements method from cacheable_object interface.
2816 public static function wake_from_cache($data) {
2817 $classname = $data['class'];
2818 return new $classname($data['id'], $data['ctxid'], $data['options'], $data['readonly']);
2822 * Gets a file relative to this file in the repository and sends it to the browser.
2823 * Used to allow relative file linking within a repository without creating file records
2826 * Repositories that overwrite this must be very careful - see filesystem repository for example.
2828 * @param stored_file $mainfile The main file we are trying to access relative files for.
2829 * @param string $relativepath the relative path to the file we are trying to access.
2832 public function send_relative_file(stored_file
$mainfile, $relativepath) {
2833 // This repository hasn't implemented this so send_file_not_found.
2834 send_file_not_found();
2838 * helper function to check if the repository supports send_relative_file.
2840 * @return true|false
2842 public function supports_relative_file() {
2847 * Helper function to indicate if this repository uses post requests for uploading files.
2849 * @deprecated since Moodle 3.2, 3.1.1, 3.0.5
2852 public function uses_post_requests() {
2853 debugging('The method repository::uses_post_requests() is deprecated and must not be used anymore.', DEBUG_DEVELOPER
);
2858 * Generate a secret key to be used for passing sensitive information around.
2860 * @return string repository secret key.
2862 final public static function get_secret_key() {
2865 if (!isset($CFG->reposecretkey
)) {
2866 set_config('reposecretkey', time() . random_string(32));
2868 return $CFG->reposecretkey
;
2873 * Exception class for repository api
2876 * @package core_repository
2877 * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2878 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2880 class repository_exception
extends moodle_exception
{
2884 * This is a class used to define a repository instance form
2887 * @package core_repository
2888 * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2889 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2891 final class repository_instance_form
extends moodleform
{
2892 /** @var stdClass repository instance */
2893 protected $instance;
2894 /** @var string repository plugin type */
2896 /** @var string repository type ID */
2898 /** @var string repository context ID */
2899 protected $contextid;
2902 * Added defaults to moodle form
2904 protected function add_defaults() {
2905 $mform =& $this->_form
;
2906 $strrequired = get_string('required');
2908 $mform->addElement('hidden', 'edit', ($this->instance
) ?
$this->instance
->id
: 0);
2909 $mform->setType('edit', PARAM_INT
);
2910 $mform->addElement('hidden', 'new', $this->plugin
);
2911 $mform->setType('new', PARAM_ALPHANUMEXT
);
2912 $mform->addElement('hidden', 'plugin', $this->plugin
);
2913 $mform->setType('plugin', PARAM_PLUGIN
);
2914 $mform->addElement('hidden', 'typeid', $this->typeid
);
2915 $mform->setType('typeid', PARAM_INT
);
2916 $mform->addElement('hidden', 'contextid', $this->contextid
);
2917 $mform->setType('contextid', PARAM_INT
);
2919 $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
2920 $mform->addRule('name', $strrequired, 'required', null, 'client');
2921 $mform->setType('name', PARAM_TEXT
);
2925 * Define moodle form elements
2927 public function definition() {
2929 // type of plugin, string
2930 $this->plugin
= $this->_customdata
['plugin'];
2931 $this->typeid
= $this->_customdata
['typeid'];
2932 $this->contextid
= $this->_customdata
['contextid'];
2933 $this->instance
= (isset($this->_customdata
['instance'])
2934 && is_subclass_of($this->_customdata
['instance'], 'repository'))
2935 ?
$this->_customdata
['instance'] : null;
2937 $mform =& $this->_form
;
2939 $this->add_defaults();
2941 // Add instance config options.
2942 $result = repository
::static_function($this->plugin
, 'instance_config_form', $mform);
2943 if ($result === false) {
2944 // Remove the name element if no other config options.
2945 $mform->removeElement('name');
2947 if ($this->instance
) {
2949 $data['name'] = $this->instance
->name
;
2950 if (!$this->instance
->readonly
) {
2951 // and set the data if we have some.
2952 foreach ($this->instance
->get_instance_option_names() as $config) {
2953 if (!empty($this->instance
->options
[$config])) {
2954 $data[$config] = $this->instance
->options
[$config];
2956 $data[$config] = '';
2960 $this->set_data($data);
2963 if ($result === false) {
2964 $mform->addElement('cancel');
2966 $this->add_action_buttons(true, get_string('save','repository'));
2971 * Validate moodle form data
2973 * @param array $data form data
2974 * @param array $files files in form
2975 * @return array errors
2977 public function validation($data, $files) {
2980 $plugin = $this->_customdata
['plugin'];
2981 $instance = (isset($this->_customdata
['instance'])
2982 && is_subclass_of($this->_customdata
['instance'], 'repository'))
2983 ?
$this->_customdata
['instance'] : null;
2986 $errors = repository
::static_function($plugin, 'instance_form_validation', $this, $data, $errors);
2988 $errors = $instance->instance_form_validation($this, $data, $errors);
2991 $sql = "SELECT count('x')
2992 FROM {repository_instances} i, {repository} r
2993 WHERE r.type=:plugin AND r.id=i.typeid AND i.name=:name AND i.contextid=:contextid";
2994 $params = array('name' => $data['name'], 'plugin' => $this->plugin
, 'contextid' => $this->contextid
);
2996 $sql .= ' AND i.id != :instanceid';
2997 $params['instanceid'] = $instance->id
;
2999 if ($DB->count_records_sql($sql, $params) > 0) {
3000 $errors['name'] = get_string('erroruniquename', 'repository');
3008 * This is a class used to define a repository type setting form
3011 * @package core_repository
3012 * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
3013 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3015 final class repository_type_form
extends moodleform
{
3016 /** @var stdClass repository instance */
3017 protected $instance;
3018 /** @var string repository plugin name */
3020 /** @var string action */
3022 /** @var string plugin name */
3023 protected $pluginname;
3026 * Definition of the moodleform
3028 public function definition() {
3030 // type of plugin, string
3031 $this->plugin
= $this->_customdata
['plugin'];
3032 $this->instance
= (isset($this->_customdata
['instance'])
3033 && is_a($this->_customdata
['instance'], 'repository_type'))
3034 ?
$this->_customdata
['instance'] : null;
3036 $this->action
= $this->_customdata
['action'];
3037 $this->pluginname
= $this->_customdata
['pluginname'];
3038 $mform =& $this->_form
;
3039 $strrequired = get_string('required');
3041 $mform->addElement('hidden', 'action', $this->action
);
3042 $mform->setType('action', PARAM_TEXT
);
3043 $mform->addElement('hidden', 'repos', $this->plugin
);
3044 $mform->setType('repos', PARAM_PLUGIN
);
3046 // let the plugin add its specific fields
3047 $classname = 'repository_' . $this->plugin
;
3048 require_once($CFG->dirroot
. '/repository/' . $this->plugin
. '/lib.php');
3049 //add "enable course/user instances" checkboxes if multiple instances are allowed
3050 $instanceoptionnames = repository
::static_function($this->plugin
, 'get_instance_option_names');
3052 $result = call_user_func(array($classname, 'type_config_form'), $mform, $classname);
3054 if (!empty($instanceoptionnames)) {
3055 $sm = get_string_manager();
3056 $component = 'repository';
3057 if ($sm->string_exists('enablecourseinstances', 'repository_' . $this->plugin
)) {
3058 $component .= ('_' . $this->plugin
);
3060 $mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', $component));
3061 $mform->setType('enablecourseinstances', PARAM_BOOL
);
3063 $component = 'repository';
3064 if ($sm->string_exists('enableuserinstances', 'repository_' . $this->plugin
)) {
3065 $component .= ('_' . $this->plugin
);
3067 $mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', $component));
3068 $mform->setType('enableuserinstances', PARAM_BOOL
);
3071 // set the data if we have some.
3072 if ($this->instance
) {
3074 $option_names = call_user_func(array($classname,'get_type_option_names'));
3075 if (!empty($instanceoptionnames)){
3076 $option_names[] = 'enablecourseinstances';
3077 $option_names[] = 'enableuserinstances';
3080 $instanceoptions = $this->instance
->get_options();
3081 foreach ($option_names as $config) {
3082 if (!empty($instanceoptions[$config])) {
3083 $data[$config] = $instanceoptions[$config];
3085 $data[$config] = '';
3088 // XXX: set plugin name for plugins which doesn't have muliti instances
3089 if (empty($instanceoptionnames)){
3090 $data['pluginname'] = $this->pluginname
;
3092 $this->set_data($data);
3095 $this->add_action_buttons(true, get_string('save','repository'));
3099 * Validate moodle form data
3101 * @param array $data moodle form data
3102 * @param array $files
3103 * @return array errors
3105 public function validation($data, $files) {
3107 $plugin = $this->_customdata
['plugin'];
3108 $instance = (isset($this->_customdata
['instance'])
3109 && is_subclass_of($this->_customdata
['instance'], 'repository'))
3110 ?
$this->_customdata
['instance'] : null;
3112 $errors = repository
::static_function($plugin, 'type_form_validation', $this, $data, $errors);
3114 $errors = $instance->type_form_validation($this, $data, $errors);
3122 * Generate all options needed by filepicker
3124 * @param stdClass $args including following keys
3129 * @return stdClass the list of repository instances, including meta infomation, containing the following keys
3134 function initialise_filepicker($args) {
3135 global $CFG, $USER, $PAGE;
3136 static $templatesinitialized = array();
3137 require_once($CFG->libdir
. '/licenselib.php');
3139 $return = new stdClass();
3141 $licenses = license_manager
::get_licenses();
3143 if (!empty($CFG->sitedefaultlicense
)) {
3144 $return->defaultlicense
= $CFG->sitedefaultlicense
;
3147 $return->licenses
= $licenses;
3149 $return->author
= fullname($USER);
3151 if (empty($args->context
)) {
3152 $context = $PAGE->context
;
3154 $context = $args->context
;
3156 $disable_types = array();
3157 if (!empty($args->disable_types
)) {
3158 $disable_types = $args->disable_types
;
3161 $user_context = context_user
::instance($USER->id
);
3163 list($context, $course, $cm) = get_context_info_array($context->id
);
3164 $contexts = array($user_context, context_system
::instance());
3165 if (!empty($course)) {
3166 // adding course context
3167 $contexts[] = context_course
::instance($course->id
);
3169 $externallink = (int)get_config(null, 'repositoryallowexternallinks');
3170 $repositories = repository
::get_instances(array(
3171 'context'=>$contexts,
3172 'currentcontext'=> $context,
3173 'accepted_types'=>$args->accepted_types
,
3174 'return_types'=>$args->return_types
,
3175 'disable_types'=>$disable_types
3178 $return->repositories
= array();
3180 if (empty($externallink)) {
3181 $return->externallink
= false;
3183 $return->externallink
= true;
3186 $return->rememberuserlicensepref
= (bool) get_config(null, 'rememberuserlicensepref');
3188 $return->userprefs
= array();
3189 $return->userprefs
['recentrepository'] = get_user_preferences('filepicker_recentrepository', '');
3190 $return->userprefs
['recentlicense'] = get_user_preferences('filepicker_recentlicense', '');
3191 $return->userprefs
['recentviewmode'] = get_user_preferences('filepicker_recentviewmode', '');
3193 // provided by form element
3194 $return->accepted_types
= file_get_typegroup('extension', $args->accepted_types
);
3195 $return->return_types
= $args->return_types
;
3196 $templates = array();
3197 foreach ($repositories as $repository) {
3198 $meta = $repository->get_meta();
3199 // Please note that the array keys for repositories are used within
3200 // JavaScript a lot, the key NEEDS to be the repository id.
3201 $return->repositories
[$repository->id
] = $meta;
3202 // Register custom repository template if it has one
3203 if(method_exists($repository, 'get_upload_template') && !array_key_exists('uploadform_' . $meta->type
, $templatesinitialized)) {
3204 $templates['uploadform_' . $meta->type
] = $repository->get_upload_template();
3205 $templatesinitialized['uploadform_' . $meta->type
] = true;
3208 if (!array_key_exists('core', $templatesinitialized)) {
3209 // we need to send each filepicker template to the browser just once
3210 $fprenderer = $PAGE->get_renderer('core', 'files');
3211 $templates = array_merge($templates, $fprenderer->filepicker_js_templates());
3212 $templatesinitialized['core'] = true;
3214 if (sizeof($templates)) {
3215 $PAGE->requires
->js_init_call('M.core_filepicker.set_templates', array($templates), true);
3221 * Convenience function to handle deletion of files.
3223 * @param object $context The context where the delete is called
3224 * @param string $component component
3225 * @param string $filearea filearea
3226 * @param int $itemid the item id
3227 * @param array $files Array of files object with each item having filename/filepath as values
3228 * @return array $return Array of strings matching up to the parent directory of the deleted files
3229 * @throws coding_exception
3231 function repository_delete_selected_files($context, string $component, string $filearea, $itemid, array $files) {
3232 $fs = get_file_storage();
3235 foreach ($files as $selectedfile) {
3236 $filename = clean_filename($selectedfile->filename
);
3237 $filepath = clean_param($selectedfile->filepath
, PARAM_PATH
);
3238 $filepath = file_correct_filepath($filepath);
3240 if ($storedfile = $fs->get_file($context->id
, $component, $filearea, $itemid, $filepath, $filename)) {
3241 $parentpath = $storedfile->get_parent_directory()->get_filepath();
3242 if ($storedfile->is_directory()) {
3243 $files = $fs->get_directory_files($context->id
, $component, $filearea, $itemid, $filepath, true);
3244 foreach ($files as $file) {
3246 // Log the event when a file is deleted from the draft area.
3247 create_event_draft_file_deleted($context, $file);
3249 $storedfile->delete();
3250 create_event_draft_file_deleted($context, $storedfile);
3251 $return[$parentpath] = "";
3253 if ($result = $storedfile->delete()) {
3254 create_event_draft_file_deleted($context, $storedfile);
3255 $return[$parentpath] = "";
3265 * Convenience function to create draft_file_deleted log event.
3267 * @param context $context The context where delete is called.
3268 * @param stored_file $storedfile the file to be logged.
3270 function create_event_draft_file_deleted(context
$context, stored_file
$storedfile): void
{
3271 $logevent = \core\event\draft_file_deleted
::create([
3272 'objectid' => $storedfile->get_id(),
3273 'context' => $context,
3275 'itemid' => $storedfile->get_itemid(),
3276 'filename' => $storedfile->get_filename(),
3277 'filesize' => $storedfile->get_filesize(),
3278 'filepath' => $storedfile->get_filepath(),
3279 'contenthash' => $storedfile->get_contenthash(),
3282 $logevent->trigger();
3286 * Convenience function to handle deletion of files.
3288 * @param object $context The context where the delete is called
3289 * @param string $component component
3290 * @param string $filearea filearea
3291 * @param int $itemid the item id
3292 * @param array $files Array of files object with each item having filename/filepath as values
3293 * @return array $return Array of strings matching up to the parent directory of the deleted files
3294 * @throws coding_exception
3296 function repository_download_selected_files($context, string $component, string $filearea, $itemid, array $files) {
3300 $zipper = get_file_packer('application/zip');
3301 $fs = get_file_storage();
3302 // Archive compressed file to an unused draft area.
3303 $newdraftitemid = file_get_unused_draft_itemid();
3304 $filestoarchive = [];
3306 foreach ($files as $selectedfile) {
3307 $filename = $selectedfile->filename ?
clean_filename($selectedfile->filename
) : '.'; // Default to '.' for root.
3308 $filepath = clean_param($selectedfile->filepath
, PARAM_PATH
); // Default to '/' for downloadall.
3309 $filepath = file_correct_filepath($filepath);
3310 $area = file_get_draft_area_info($itemid, $filepath);
3311 if ($area['filecount'] == 0 && $area['foldercount'] == 0) {
3315 $storedfile = $fs->get_file($context->id
, $component, $filearea, $itemid, $filepath, $filename);
3316 // If it is empty we are downloading a directory.
3317 $archivefile = $storedfile->get_filename();
3318 if (!$filename ||
$filename == '.' ) {
3319 $foldername = explode('/', trim($filepath, '/'));
3320 $folder = trim(array_pop($foldername), '/');
3321 $archivefile = $folder ??
'/';
3324 $filestoarchive[$archivefile] = $storedfile;
3326 $zippedfile = get_string('files') . '.zip';
3328 $zipper->archive_to_storage(
3335 $zippedfile, $USER->id
)
3337 $return = new stdClass();
3338 $return->fileurl
= moodle_url
::make_draftfile_url($newdraftitemid, '/', $zippedfile)->out();
3339 $return->filepath
= $filepath;