MDL-68758 core_repository: Allow ability to download files on all views.
[moodle.git] / repository / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains classes used to manage the repository plugins in Moodle
19  *
20  * @since Moodle 2.0
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
24  */
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');
37 /**
38  * This class is used to manage repository plugins
39  *
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.
44  * Coding note:
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.
52  *
53  * @package   core_repository
54  * @copyright 2009 Jerome Mouneyrac
55  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
56  */
57 class repository_type implements cacheable_object {
60     /**
61      * Type name (no whitespace) - A type name is unique
62      * Note: for a user-friendly type name see get_readablename()
63      * @var String
64      */
65     private $_typename;
68     /**
69      * Options of this type
70      * They are general options that any instance of this type would share
71      * e.g. API key
72      * These options are saved in config_plugin table
73      * @var array
74      */
75     private $_options;
78     /**
79      * Is the repository type visible or hidden
80      * If false (hidden): no instances can be created, edited, deleted, showned , used...
81      * @var boolean
82      */
83     private $_visible;
86     /**
87      * 0 => not ordered, 1 => first position, 2 => second position...
88      * A not order type would appear in first position (should never happened)
89      * @var integer
90      */
91     private $_sortorder;
93     /**
94      * Return if the instance is visible in a context
95      *
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
99      * @return bool
100      */
101     public function get_contextvisibility($context) {
102         global $USER;
104         if ($context->contextlevel == CONTEXT_COURSE) {
105             return $this->_options['enablecourseinstances'];
106         }
108         if ($context->contextlevel == CONTEXT_USER) {
109             return $this->_options['enableuserinstances'];
110         }
112         //the context is SITE
113         return true;
114     }
118     /**
119      * repository_type constructor
120      *
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)
125      */
126     public function __construct($typename = '', $typeoptions = array(), $visible = true, $sortorder = 0) {
127         global $CFG;
129         //set type attributs
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];
143                 }
144             }
145         }
147         //retrieve visibility from option
148         if (array_key_exists('enablecourseinstances',$typeoptions)) {
149             $this->_options['enablecourseinstances'] = $typeoptions['enablecourseinstances'];
150         } else {
151              $this->_options['enablecourseinstances'] = 0;
152         }
154         if (array_key_exists('enableuserinstances',$typeoptions)) {
155             $this->_options['enableuserinstances'] = $typeoptions['enableuserinstances'];
156         } else {
157              $this->_options['enableuserinstances'] = 0;
158         }
160     }
162     /**
163      * Get the type name (no whitespace)
164      * For a human readable name, use get_readablename()
165      *
166      * @return string the type name
167      */
168     public function get_typename() {
169         return $this->_typename;
170     }
172     /**
173      * Return a human readable and user-friendly type name
174      *
175      * @return string user-friendly type name
176      */
177     public function get_readablename() {
178         return get_string('pluginname','repository_'.$this->_typename);
179     }
181     /**
182      * Return general options
183      *
184      * @return array the general options
185      */
186     public function get_options() {
187         return $this->_options;
188     }
190     /**
191      * Return visibility
192      *
193      * @return bool
194      */
195     public function get_visible() {
196         return $this->_visible;
197     }
199     /**
200      * Return order / position of display in the file picker
201      *
202      * @return int
203      */
204     public function get_sortorder() {
205         return $this->_sortorder;
206     }
208     /**
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
212      */
213     public function create($silent = false) {
214         global $DB;
216         //check that $type has been set
217         $timmedtype = trim($this->_typename);
218         if (empty($timmedtype)) {
219             throw new repository_exception('emptytype', 'repository');
220         }
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);
226         }
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) {
231             //create the type
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'] = '';
251                 } else {
252                     // when admin trying to add a plugin manually, he will type a name
253                     // for it
254                     $instanceoptions['name'] = $this->_options['pluginname'];
255                 }
256                 repository::static_function($this->_typename, 'create', $this->_typename, 0, context_system::instance(), $instanceoptions);
257             }
258             //run plugin_init function
259             if (!repository::static_function($this->_typename, 'plugin_init')) {
260                 $this->update_visibility(false);
261                 if (!$silent) {
262                     throw new repository_exception('cannotinitplugin', 'repository');
263                 }
264             }
266             cache::make('core', 'repositories')->purge();
267             if(!empty($plugin_id)) {
268                 // return plugin_id if create successfully
269                 return $plugin_id;
270             } else {
271                 return false;
272             }
274         } else {
275             if (!$silent) {
276                 throw new repository_exception('existingrepository', 'repository');
277             }
278             // If plugin existed, return false, tell caller no new plugins were created.
279             return false;
280         }
281     }
284     /**
285      * Update plugin options into the config_plugin table
286      *
287      * @param array $options
288      * @return bool
289      */
290     public function update_options($options = null) {
291         global $DB;
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
296             $params = array();
297             $params['type'] = $this->_typename;
298             $instances = repository::get_instances($params);
299             $instance = array_pop($instances);
300             if ($instance) {
301                 $DB->set_field('repository_instances', 'name', $options['pluginname'], array('id'=>$instance->id));
302             }
303             unset($options['pluginname']);
304         }
306         if (!empty($options)) {
307             $this->_options = $options;
308         }
310         foreach ($this->_options as $name => $value) {
311             set_config($name, $value, $this->_typename);
312         }
314         cache::make('core', 'repositories')->purge();
315         return true;
316     }
318     /**
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()
323      *
324      * @param bool $visible
325      * @return bool
326      */
327     private function update_visible($visible = null) {
328         global $DB;
330         if (!empty($visible)) {
331             $this->_visible = $visible;
332         }
333         else if (!isset($this->_visible)) {
334             throw new repository_exception('updateemptyvisible', 'repository');
335         }
337         cache::make('core', 'repositories')->purge();
338         return $DB->set_field('repository', 'visible', $this->_visible, array('type'=>$this->_typename));
339     }
341     /**
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()
346      *
347      * @param int $sortorder
348      * @return bool
349      */
350     private function update_sortorder($sortorder = null) {
351         global $DB;
353         if (!empty($sortorder) && $sortorder!=0) {
354             $this->_sortorder = $sortorder;
355         }
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);
360         }
362         cache::make('core', 'repositories')->purge();
363         return $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$this->_typename));
364     }
366     /**
367      * Change order of the type with its adjacent upper or downer type
368      * (database fields are updated)
369      * Algorithm details:
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
373      *
374      * @param string $move "up" or "down"
375      */
376     public function move_order($move) {
377         global $DB;
379         $types = repository::get_types();    // retrieve all types
381         // retrieve this type into the returned array
382         $i = 0;
383         while (!isset($indice) && $i<count($types)) {
384             if ($types[$i]->get_typename() == $this->_typename) {
385                 $indice = $i;
386             }
387             $i++;
388         }
390         // retrieve adjacent indice
391         switch ($move) {
392             case "up":
393                 $adjacentindice = $indice - 1;
394             break;
395             case "down":
396                 $adjacentindice = $indice + 1;
397             break;
398             default:
399             throw new repository_exception('movenotdefined', 'repository');
400         }
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());
409         }
410     }
412     /**
413      * 1. Change visibility to the value chosen
414      * 2. Update the type
415      *
416      * @param bool $visible
417      * @return bool
418      */
419     public function update_visibility($visible = null) {
420         if (is_bool($visible)) {
421             $this->_visible = $visible;
422         } else {
423             $this->_visible = !$this->_visible;
424         }
425         return $this->update_visible();
426     }
429     /**
430      * Delete a repository_type (general options are removed from config_plugin
431      * table, and all instances are deleted)
432      *
433      * @param bool $downloadcontents download external contents if exist
434      * @return bool
435      */
436     public function delete($downloadcontents = false) {
437         global $DB;
439         //delete all instances of this type
440         $params = array();
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);
447         }
449         //delete all general options
450         foreach ($this->_options as $name => $value) {
451             set_config($name, null, $this->_typename);
452         }
454         cache::make('core', 'repositories')->purge();
455         try {
456             $DB->delete_records('repository', array('type' => $this->_typename));
457         } catch (dml_exception $ex) {
458             return false;
459         }
460         return true;
461     }
463     /**
464      * Prepares the repository type to be cached. Implements method from cacheable_object interface.
465      *
466      * @return array
467      */
468     public function prepare_to_cache() {
469         return array(
470             'typename' => $this->_typename,
471             'typeoptions' => $this->_options,
472             'visible' => $this->_visible,
473             'sortorder' => $this->_sortorder
474         );
475     }
477     /**
478      * Restores repository type from cache. Implements method from cacheable_object interface.
479      *
480      * @return array
481      */
482     public static function wake_from_cache($data) {
483         return new repository_type($data['typename'], $data['typeoptions'], $data['visible'], $data['sortorder']);
484     }
487 /**
488  * This is the base class of the repository class.
489  *
490  * To create repository plugin, see: {@link http://docs.moodle.org/dev/Repository_plugins}
491  * See an example: {@link repository_boxnet}
492  *
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
496  */
497 abstract class repository implements cacheable_object {
498     /**
499      * Timeout in seconds for downloading the external file into moodle
500      * @deprecated since Moodle 2.7, please use $CFG->repositorygetfiletimeout instead
501      */
502     const GETFILE_TIMEOUT = 30;
504     /**
505      * Timeout in seconds for syncronising the external file size
506      * @deprecated since Moodle 2.7, please use $CFG->repositorysyncfiletimeout instead
507      */
508     const SYNCFILE_TIMEOUT = 1;
510     /**
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
513      */
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 */
521     public $id;
522     /** @var stdClass current context */
523     public $context;
524     /** @var array repository options */
525     public $options;
526     /** @var bool Whether or not the repository instance is editable */
527     public $readonly;
528     /** @var int return types */
529     public $returntypes;
530     /** @var stdClass repository instance database record */
531     public $instance;
532     /** @var string Type of repository (webdav, google_docs, dropbox, ...). Read from $this->get_typename(). */
533     protected $typename;
535     /**
536      * Constructor
537      *
538      * @param int $repositoryid repository instance id
539      * @param int|stdClass $context a context id or context object
540      * @param array $options repository options
541      * @param int $readonly indicate this repo is readonly or not
542      */
543     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array(), $readonly = 0) {
544         global $DB;
545         $this->id = $repositoryid;
546         if (is_object($context)) {
547             $this->context = $context;
548         } else {
549             $this->context = context::instance_by_id($context);
550         }
551         $cache = cache::make('core', 'repositories');
552         if (($this->instance = $cache->get('i:'. $this->id)) === false) {
553             $this->instance = $DB->get_record_sql("SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
554                       FROM {repository} r, {repository_instances} i
555                      WHERE i.typeid = r.id and i.id = ?", array('id' => $this->id));
556             $cache->set('i:'. $this->id, $this->instance);
557         }
558         $this->readonly = $readonly;
559         $this->options = array();
561         if (is_array($options)) {
562             // The get_option() method will get stored options in database.
563             $options = array_merge($this->get_option(), $options);
564         } else {
565             $options = $this->get_option();
566         }
567         foreach ($options as $n => $v) {
568             $this->options[$n] = $v;
569         }
570         $this->name = $this->get_name();
571         $this->returntypes = $this->supported_returntypes();
572         $this->super_called = true;
573     }
575     /**
576      * Get repository instance using repository id
577      *
578      * Note that this function does not check permission to access repository contents
579      *
580      * @throws repository_exception
581      *
582      * @param int $repositoryid repository instance ID
583      * @param context|int $context context instance or context ID where this repository will be used
584      * @param array $options additional repository options
585      * @return repository
586      */
587     public static function get_repository_by_id($repositoryid, $context, $options = array()) {
588         global $CFG, $DB;
589         $cache = cache::make('core', 'repositories');
590         if (!is_object($context)) {
591             $context = context::instance_by_id($context);
592         }
593         $cachekey = 'rep:'. $repositoryid. ':'. $context->id. ':'. serialize($options);
594         if ($repository = $cache->get($cachekey)) {
595             return $repository;
596         }
598         if (!$record = $cache->get('i:'. $repositoryid)) {
599             $sql = "SELECT i.*, r.type AS repositorytype, r.visible, r.sortorder
600                       FROM {repository_instances} i
601                       JOIN {repository} r ON r.id = i.typeid
602                      WHERE i.id = ?";
603             if (!$record = $DB->get_record_sql($sql, array($repositoryid))) {
604                 throw new repository_exception('invalidrepositoryid', 'repository');
605             }
606             $cache->set('i:'. $record->id, $record);
607         }
609         $type = $record->repositorytype;
610         if (file_exists($CFG->dirroot . "/repository/$type/lib.php")) {
611             require_once($CFG->dirroot . "/repository/$type/lib.php");
612             $classname = 'repository_' . $type;
613             $options['type'] = $type;
614             $options['typeid'] = $record->typeid;
615             $options['visible'] = $record->visible;
616             if (empty($options['name'])) {
617                 $options['name'] = $record->name;
618             }
619             $repository = new $classname($repositoryid, $context, $options, $record->readonly);
620             if (empty($repository->super_called)) {
621                 // to make sure the super construct is called
622                 debugging('parent::__construct must be called by '.$type.' plugin.');
623             }
624             $cache->set($cachekey, $repository);
625             return $repository;
626         } else {
627             throw new repository_exception('invalidplugin', 'repository');
628         }
629     }
631     /**
632      * Returns the type name of the repository.
633      *
634      * @return string type name of the repository.
635      * @since  Moodle 2.5
636      */
637     public function get_typename() {
638         if (empty($this->typename)) {
639             $matches = array();
640             if (!preg_match("/^repository_(.*)$/", get_class($this), $matches)) {
641                 throw new coding_exception('The class name of a repository should be repository_<typeofrepository>, '.
642                         'e.g. repository_dropbox');
643             }
644             $this->typename = $matches[1];
645         }
646         return $this->typename;
647     }
649     /**
650      * Get a repository type object by a given type name.
651      *
652      * @static
653      * @param string $typename the repository type name
654      * @return repository_type|bool
655      */
656     public static function get_type_by_typename($typename) {
657         global $DB;
658         $cache = cache::make('core', 'repositories');
659         if (($repositorytype = $cache->get('typename:'. $typename)) === false) {
660             $repositorytype = null;
661             if ($record = $DB->get_record('repository', array('type' => $typename))) {
662                 $repositorytype = new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
663                 $cache->set('typeid:'. $record->id, $repositorytype);
664             }
665             $cache->set('typename:'. $typename, $repositorytype);
666         }
667         return $repositorytype;
668     }
670     /**
671      * Get the repository type by a given repository type id.
672      *
673      * @static
674      * @param int $id the type id
675      * @return object
676      */
677     public static function get_type_by_id($id) {
678         global $DB;
679         $cache = cache::make('core', 'repositories');
680         if (($repositorytype = $cache->get('typeid:'. $id)) === false) {
681             $repositorytype = null;
682             if ($record = $DB->get_record('repository', array('id' => $id))) {
683                 $repositorytype = new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
684                 $cache->set('typename:'. $record->type, $repositorytype);
685             }
686             $cache->set('typeid:'. $id, $repositorytype);
687         }
688         return $repositorytype;
689     }
691     /**
692      * Return all repository types ordered by sortorder field
693      * first repository type in returnedarray[0], second repository type in returnedarray[1], ...
694      *
695      * @static
696      * @param bool $visible can return types by visiblity, return all types if null
697      * @return array Repository types
698      */
699     public static function get_types($visible=null) {
700         global $DB, $CFG;
701         $cache = cache::make('core', 'repositories');
702         if (!$visible) {
703             $typesnames = $cache->get('types');
704         } else {
705             $typesnames = $cache->get('typesvis');
706         }
707         $types = array();
708         if ($typesnames === false) {
709             $typesnames = array();
710             $vistypesnames = array();
711             if ($records = $DB->get_records('repository', null ,'sortorder')) {
712                 foreach($records as $type) {
713                     if (($repositorytype = $cache->get('typename:'. $type->type)) === false) {
714                         // Create new instance of repository_type.
715                         if (file_exists($CFG->dirroot . '/repository/'. $type->type .'/lib.php')) {
716                             $repositorytype = new repository_type($type->type, (array)get_config($type->type), $type->visible, $type->sortorder);
717                             $cache->set('typeid:'. $type->id, $repositorytype);
718                             $cache->set('typename:'. $type->type, $repositorytype);
719                         }
720                     }
721                     if ($repositorytype) {
722                         if (empty($visible) || $repositorytype->get_visible()) {
723                             $types[] = $repositorytype;
724                             $vistypesnames[] = $repositorytype->get_typename();
725                         }
726                         $typesnames[] = $repositorytype->get_typename();
727                     }
728                 }
729             }
730             $cache->set('types', $typesnames);
731             $cache->set('typesvis', $vistypesnames);
732         } else {
733             foreach ($typesnames as $typename) {
734                 $types[] = self::get_type_by_typename($typename);
735             }
736         }
737         return $types;
738     }
740     /**
741      * Checks if user has a capability to view the current repository.
742      *
743      * @return bool true when the user can, otherwise throws an exception.
744      * @throws repository_exception when the user does not meet the requirements.
745      */
746     public final function check_capability() {
747         global $USER;
749         // The context we are on.
750         $currentcontext = $this->context;
752         // Ensure that the user can view the repository in the current context.
753         $can = has_capability('repository/'.$this->get_typename().':view', $currentcontext);
755         // Context in which the repository has been created.
756         $repocontext = context::instance_by_id($this->instance->contextid);
758         // Prevent access to private repositories when logged in as.
759         if ($can && \core\session\manager::is_loggedinas()) {
760             if ($this->contains_private_data() || $repocontext->contextlevel == CONTEXT_USER) {
761                 $can = false;
762             }
763         }
765         // We are going to ensure that the current context was legit, and reliable to check
766         // the capability against. (No need to do that if we already cannot).
767         if ($can) {
768             if ($repocontext->contextlevel == CONTEXT_USER) {
769                 // The repository is a user instance, ensure we're the right user to access it!
770                 if ($repocontext->instanceid != $USER->id) {
771                     $can = false;
772                 }
773             } else if ($repocontext->contextlevel == CONTEXT_COURSE) {
774                 // The repository is a course one. Let's check that we are on the right course.
775                 if (in_array($currentcontext->contextlevel, array(CONTEXT_COURSE, CONTEXT_MODULE, CONTEXT_BLOCK))) {
776                     $coursecontext = $currentcontext->get_course_context();
777                     if ($coursecontext->instanceid != $repocontext->instanceid) {
778                         $can = false;
779                     }
780                 } else {
781                     // We are on a parent context, therefore it's legit to check the permissions
782                     // in the current context.
783                 }
784             } else {
785                 // Nothing to check here, system instances can have different permissions on different
786                 // levels. We do not want to prevent URL hack here, because it does not make sense to
787                 // prevent a user to access a repository in a context if it's accessible in another one.
788             }
789         }
791         if ($can) {
792             return true;
793         }
795         throw new repository_exception('nopermissiontoaccess', 'repository');
796     }
798     /**
799      * Check if file already exists in draft area.
800      *
801      * @static
802      * @param int $itemid of the draft area.
803      * @param string $filepath path to the file.
804      * @param string $filename file name.
805      * @return bool
806      */
807     public static function draftfile_exists($itemid, $filepath, $filename) {
808         global $USER;
809         $fs = get_file_storage();
810         $usercontext = context_user::instance($USER->id);
811         return $fs->file_exists($usercontext->id, 'user', 'draft', $itemid, $filepath, $filename);
812     }
814     /**
815      * Parses the moodle file reference and returns an instance of stored_file
816      *
817      * @param string $reference reference to the moodle internal file as retruned by
818      *        {@link repository::get_file_reference()} or {@link file_storage::pack_reference()}
819      * @return stored_file|null
820      */
821     public static function get_moodle_file($reference) {
822         $params = file_storage::unpack_reference($reference, true);
823         $fs = get_file_storage();
824         return $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
825                     $params['itemid'], $params['filepath'], $params['filename']);
826     }
828     /**
829      * Repository method to make sure that user can access particular file.
830      *
831      * This is checked when user tries to pick the file from repository to deal with
832      * potential parameter substitutions is request
833      *
834      * @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
835      * @return bool whether the file is accessible by current user
836      */
837     public function file_is_accessible($source) {
838         if ($this->has_moodle_files()) {
839             $reference = $this->get_file_reference($source);
840             try {
841                 $params = file_storage::unpack_reference($reference, true);
842             } catch (file_reference_exception $e) {
843                 return false;
844             }
845             $browser = get_file_browser();
846             $context = context::instance_by_id($params['contextid']);
847             $file_info = $browser->get_file_info($context, $params['component'], $params['filearea'],
848                     $params['itemid'], $params['filepath'], $params['filename']);
849             return !empty($file_info);
850         }
851         return true;
852     }
854     /**
855      * This function is used to copy a moodle file to draft area.
856      *
857      * It DOES NOT check if the user is allowed to access this file because the actual file
858      * can be located in the area where user does not have access to but there is an alias
859      * to this file in the area where user CAN access it.
860      * {@link file_is_accessible} should be called for alias location before calling this function.
861      *
862      * @param string $source The metainfo of file, it is base64 encoded php serialized data
863      * @param stdClass|array $filerecord contains itemid, filepath, filename and optionally other
864      *      attributes of the new file
865      * @param int $maxbytes maximum allowed size of file, -1 if unlimited. If size of file exceeds
866      *      the limit, the file_exception is thrown.
867      * @param int $areamaxbytes the maximum size of the area. A file_exception is thrown if the
868      *      new file will reach the limit.
869      * @return array The information about the created file
870      */
871     public function copy_to_area($source, $filerecord, $maxbytes = -1, $areamaxbytes = FILE_AREA_MAX_BYTES_UNLIMITED) {
872         global $USER;
873         $fs = get_file_storage();
875         if ($this->has_moodle_files() == false) {
876             throw new coding_exception('Only repository used to browse moodle files can use repository::copy_to_area()');
877         }
879         $user_context = context_user::instance($USER->id);
881         $filerecord = (array)$filerecord;
882         // make sure the new file will be created in user draft area
883         $filerecord['component'] = 'user';
884         $filerecord['filearea'] = 'draft';
885         $filerecord['contextid'] = $user_context->id;
886         $draftitemid = $filerecord['itemid'];
887         $new_filepath = $filerecord['filepath'];
888         $new_filename = $filerecord['filename'];
890         // the file needs to copied to draft area
891         $stored_file = self::get_moodle_file($source);
892         if ($maxbytes != -1 && $stored_file->get_filesize() > $maxbytes) {
893             $maxbytesdisplay = display_size($maxbytes);
894             throw new file_exception('maxbytesfile', (object) array('file' => $filerecord['filename'],
895                                                                     'size' => $maxbytesdisplay));
896         }
897         // Validate the size of the draft area.
898         if (file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $stored_file->get_filesize())) {
899             throw new file_exception('maxareabytes');
900         }
902         if (repository::draftfile_exists($draftitemid, $new_filepath, $new_filename)) {
903             // create new file
904             $unused_filename = repository::get_unused_filename($draftitemid, $new_filepath, $new_filename);
905             $filerecord['filename'] = $unused_filename;
906             $fs->create_file_from_storedfile($filerecord, $stored_file);
907             $event = array();
908             $event['event'] = 'fileexists';
909             $event['newfile'] = new stdClass;
910             $event['newfile']->filepath = $new_filepath;
911             $event['newfile']->filename = $unused_filename;
912             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $unused_filename)->out();
913             $event['existingfile'] = new stdClass;
914             $event['existingfile']->filepath = $new_filepath;
915             $event['existingfile']->filename = $new_filename;
916             $event['existingfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
917             return $event;
918         } else {
919             $fs->create_file_from_storedfile($filerecord, $stored_file);
920             $info = array();
921             $info['itemid'] = $draftitemid;
922             $info['file'] = $new_filename;
923             $info['title'] = $new_filename;
924             $info['contextid'] = $user_context->id;
925             $info['url'] = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
926             $info['filesize'] = $stored_file->get_filesize();
927             return $info;
928         }
929     }
931     /**
932      * Get an unused filename from the current draft area.
933      *
934      * Will check if the file ends with ([0-9]) and increase the number.
935      *
936      * @static
937      * @param int $itemid draft item ID.
938      * @param string $filepath path to the file.
939      * @param string $filename name of the file.
940      * @return string an unused file name.
941      */
942     public static function get_unused_filename($itemid, $filepath, $filename) {
943         global $USER;
944         $contextid = context_user::instance($USER->id)->id;
945         $fs = get_file_storage();
946         return $fs->get_unused_filename($contextid, 'user', 'draft', $itemid, $filepath, $filename);
947     }
949     /**
950      * Append a suffix to filename.
951      *
952      * @static
953      * @param string $filename
954      * @return string
955      * @deprecated since 2.5
956      */
957     public static function append_suffix($filename) {
958         debugging('The function repository::append_suffix() has been deprecated. Use repository::get_unused_filename() instead.',
959             DEBUG_DEVELOPER);
960         $pathinfo = pathinfo($filename);
961         if (empty($pathinfo['extension'])) {
962             return $filename . RENAME_SUFFIX;
963         } else {
964             return $pathinfo['filename'] . RENAME_SUFFIX . '.' . $pathinfo['extension'];
965         }
966     }
968     /**
969      * Return all types that you a user can create/edit and which are also visible
970      * Note: Mostly used in order to know if at least one editable type can be set
971      *
972      * @static
973      * @param stdClass $context the context for which we want the editable types
974      * @return array types
975      */
976     public static function get_editable_types($context = null) {
978         if (empty($context)) {
979             $context = context_system::instance();
980         }
982         $types= repository::get_types(true);
983         $editabletypes = array();
984         foreach ($types as $type) {
985             $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
986             if (!empty($instanceoptionnames)) {
987                 if ($type->get_contextvisibility($context)) {
988                     $editabletypes[]=$type;
989                 }
990              }
991         }
992         return $editabletypes;
993     }
995     /**
996      * Return repository instances
997      *
998      * @static
999      * @param array $args Array containing the following keys:
1000      *           currentcontext : instance of context (default system context)
1001      *           context : array of instances of context (default empty array)
1002      *           onlyvisible : bool (default true)
1003      *           type : string return instances of this type only
1004      *           accepted_types : string|array return instances that contain files of those types (*, web_image, .pdf, ...)
1005      *           return_types : int combination of FILE_INTERNAL & FILE_EXTERNAL & FILE_REFERENCE & FILE_CONTROLLED_LINK.
1006      *                          0 means every type. The default is FILE_INTERNAL | FILE_EXTERNAL.
1007      *           userid : int if specified, instances belonging to other users will not be returned
1008      *
1009      * @return array repository instances
1010      */
1011     public static function get_instances($args = array()) {
1012         global $DB, $CFG, $USER;
1014         // Fill $args attributes with default values unless specified
1015         if (!isset($args['currentcontext']) || !($args['currentcontext'] instanceof context)) {
1016             $current_context = context_system::instance();
1017         } else {
1018             $current_context = $args['currentcontext'];
1019         }
1020         $args['currentcontext'] = $current_context->id;
1021         $contextids = array();
1022         if (!empty($args['context'])) {
1023             foreach ($args['context'] as $context) {
1024                 $contextids[] = $context->id;
1025             }
1026         }
1027         $args['context'] = $contextids;
1028         if (!isset($args['onlyvisible'])) {
1029             $args['onlyvisible'] = true;
1030         }
1031         if (!isset($args['return_types'])) {
1032             $args['return_types'] = FILE_INTERNAL | FILE_EXTERNAL;
1033         }
1034         if (!isset($args['type'])) {
1035             $args['type'] = null;
1036         }
1037         if (empty($args['disable_types']) || !is_array($args['disable_types'])) {
1038             $args['disable_types'] = null;
1039         }
1040         if (empty($args['userid']) || !is_numeric($args['userid'])) {
1041             $args['userid'] = null;
1042         }
1043         if (!isset($args['accepted_types']) || (is_array($args['accepted_types']) && in_array('*', $args['accepted_types']))) {
1044             $args['accepted_types'] = '*';
1045         }
1046         ksort($args);
1047         $cachekey = 'all:'. serialize($args);
1049         // Check if we have cached list of repositories with the same query
1050         $cache = cache::make('core', 'repositories');
1051         if (($cachedrepositories = $cache->get($cachekey)) !== false) {
1052             // convert from cacheable_object_array to array
1053             $repositories = array();
1054             foreach ($cachedrepositories as $repository) {
1055                 $repositories[$repository->id] = $repository;
1056             }
1057             return $repositories;
1058         }
1060         // Prepare DB SQL query to retrieve repositories
1061         $params = array();
1062         $sql = "SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
1063                   FROM {repository} r, {repository_instances} i
1064                  WHERE i.typeid = r.id ";
1066         if ($args['disable_types']) {
1067             list($types, $p) = $DB->get_in_or_equal($args['disable_types'], SQL_PARAMS_NAMED, 'distype', false);
1068             $sql .= " AND r.type $types";
1069             $params = array_merge($params, $p);
1070         }
1072         if ($args['userid']) {
1073             $sql .= " AND (i.userid = 0 or i.userid = :userid)";
1074             $params['userid'] = $args['userid'];
1075         }
1077         if ($args['context']) {
1078             list($ctxsql, $p2) = $DB->get_in_or_equal($args['context'], SQL_PARAMS_NAMED, 'ctx');
1079             $sql .= " AND i.contextid $ctxsql";
1080             $params = array_merge($params, $p2);
1081         }
1083         if ($args['onlyvisible'] == true) {
1084             $sql .= " AND r.visible = 1";
1085         }
1087         if ($args['type'] !== null) {
1088             $sql .= " AND r.type = :type";
1089             $params['type'] = $args['type'];
1090         }
1091         $sql .= " ORDER BY r.sortorder, i.name";
1093         if (!$records = $DB->get_records_sql($sql, $params)) {
1094             $records = array();
1095         }
1097         $repositories = array();
1098         // Sortorder should be unique, which is not true if we use $record->sortorder
1099         // and there are multiple instances of any repository type
1100         $sortorder = 1;
1101         foreach ($records as $record) {
1102             $cache->set('i:'. $record->id, $record);
1103             if (!file_exists($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php')) {
1104                 continue;
1105             }
1106             $repository = self::get_repository_by_id($record->id, $current_context);
1107             $repository->options['sortorder'] = $sortorder++;
1109             $is_supported = true;
1111             // check mimetypes
1112             if ($args['accepted_types'] !== '*' and $repository->supported_filetypes() !== '*') {
1113                 $accepted_ext = file_get_typegroup('extension', $args['accepted_types']);
1114                 $supported_ext = file_get_typegroup('extension', $repository->supported_filetypes());
1115                 $valid_ext = array_intersect($accepted_ext, $supported_ext);
1116                 $is_supported = !empty($valid_ext);
1117             }
1118             // Check return values.
1119             if (!empty($args['return_types']) && !($repository->supported_returntypes() & $args['return_types'])) {
1120                 $is_supported = false;
1121             }
1123             if (!$args['onlyvisible'] || ($repository->is_visible() && !$repository->disabled)) {
1124                 // check capability in current context
1125                 $capability = has_capability('repository/'.$record->repositorytype.':view', $current_context);
1126                 if ($record->repositorytype == 'coursefiles') {
1127                     // coursefiles plugin needs managefiles permission
1128                     $capability = $capability && has_capability('moodle/course:managefiles', $current_context);
1129                 }
1130                 if ($is_supported && $capability) {
1131                     $repositories[$repository->id] = $repository;
1132                 }
1133             }
1134         }
1135         $cache->set($cachekey, new cacheable_object_array($repositories));
1136         return $repositories;
1137     }
1139     /**
1140      * Get single repository instance for administrative actions
1141      *
1142      * Do not use this function to access repository contents, because it
1143      * does not set the current context
1144      *
1145      * @see repository::get_repository_by_id()
1146      *
1147      * @static
1148      * @param integer $id repository instance id
1149      * @return repository
1150      */
1151     public static function get_instance($id) {
1152         return self::get_repository_by_id($id, context_system::instance());
1153     }
1155     /**
1156      * Call a static function. Any additional arguments than plugin and function will be passed through.
1157      *
1158      * @static
1159      * @param string $plugin repository plugin name
1160      * @param string $function function name
1161      * @return mixed
1162      */
1163     public static function static_function($plugin, $function) {
1164         global $CFG;
1166         //check that the plugin exists
1167         $typedirectory = $CFG->dirroot . '/repository/'. $plugin . '/lib.php';
1168         if (!file_exists($typedirectory)) {
1169             //throw new repository_exception('invalidplugin', 'repository');
1170             return false;
1171         }
1173         $args = func_get_args();
1174         if (count($args) <= 2) {
1175             $args = array();
1176         } else {
1177             array_shift($args);
1178             array_shift($args);
1179         }
1181         require_once($typedirectory);
1182         return call_user_func_array(array('repository_' . $plugin, $function), $args);
1183     }
1185     /**
1186      * Scan file, throws exception in case of infected file.
1187      *
1188      * Please note that the scanning engine must be able to access the file,
1189      * permissions of the file are not modified here!
1190      *
1191      * @static
1192      * @deprecated since Moodle 3.0
1193      * @param string $thefile
1194      * @param string $filename name of the file
1195      * @param bool $deleteinfected
1196      */
1197     public static function antivir_scan_file($thefile, $filename, $deleteinfected) {
1198         debugging('Please upgrade your code to use \core\antivirus\manager::scan_file instead', DEBUG_DEVELOPER);
1199         \core\antivirus\manager::scan_file($thefile, $filename, $deleteinfected);
1200     }
1202     /**
1203      * Repository method to serve the referenced file
1204      *
1205      * @see send_stored_file
1206      *
1207      * @param stored_file $storedfile the file that contains the reference
1208      * @param int $lifetime Number of seconds before the file should expire from caches (null means $CFG->filelifetime)
1209      * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1210      * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1211      * @param array $options additional options affecting the file serving
1212      */
1213     public function send_file($storedfile, $lifetime=null , $filter=0, $forcedownload=false, array $options = null) {
1214         if ($this->has_moodle_files()) {
1215             $fs = get_file_storage();
1216             $params = file_storage::unpack_reference($storedfile->get_reference(), true);
1217             $srcfile = null;
1218             if (is_array($params)) {
1219                 $srcfile = $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
1220                         $params['itemid'], $params['filepath'], $params['filename']);
1221             }
1222             if (empty($options)) {
1223                 $options = array();
1224             }
1225             if (!isset($options['filename'])) {
1226                 $options['filename'] = $storedfile->get_filename();
1227             }
1228             if (!$srcfile) {
1229                 send_file_not_found();
1230             } else {
1231                 send_stored_file($srcfile, $lifetime, $filter, $forcedownload, $options);
1232             }
1233         } else {
1234             throw new coding_exception("Repository plugin must implement send_file() method.");
1235         }
1236     }
1238     /**
1239      * Return human readable reference information
1240      *
1241      * @param string $reference value of DB field files_reference.reference
1242      * @param int $filestatus status of the file, 0 - ok, 666 - source missing
1243      * @return string
1244      */
1245     public function get_reference_details($reference, $filestatus = 0) {
1246         if ($this->has_moodle_files()) {
1247             $fileinfo = null;
1248             $params = file_storage::unpack_reference($reference, true);
1249             if (is_array($params)) {
1250                 $context = context::instance_by_id($params['contextid'], IGNORE_MISSING);
1251                 if ($context) {
1252                     $browser = get_file_browser();
1253                     $fileinfo = $browser->get_file_info($context, $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']);
1254                 }
1255             }
1256             if (empty($fileinfo)) {
1257                 if ($filestatus == 666) {
1258                     if (is_siteadmin() || ($context && has_capability('moodle/course:managefiles', $context))) {
1259                         return get_string('lostsource', 'repository',
1260                                 $params['contextid']. '/'. $params['component']. '/'. $params['filearea']. '/'. $params['itemid']. $params['filepath']. $params['filename']);
1261                     } else {
1262                         return get_string('lostsource', 'repository', '');
1263                     }
1264                 }
1265                 return get_string('undisclosedsource', 'repository');
1266             } else {
1267                 return $fileinfo->get_readable_fullname();
1268             }
1269         }
1270         return '';
1271     }
1273     /**
1274      * Cache file from external repository by reference
1275      * {@link repository::get_file_reference()}
1276      * {@link repository::get_file()}
1277      * Invoked at MOODLE/repository/repository_ajax.php
1278      *
1279      * @param string $reference this reference is generated by
1280      *                          repository::get_file_reference()
1281      * @param stored_file $storedfile created file reference
1282      */
1283     public function cache_file_by_reference($reference, $storedfile) {
1284     }
1286     /**
1287      * reference_file_selected
1288      *
1289      * This function is called when a controlled link file is selected in a file picker and the form is
1290      * saved. The expected behaviour for repositories supporting controlled links is to
1291      * - copy the file to the moodle system account
1292      * - put it in a folder that reflects the context it is being used
1293      * - make sure the sharing permissions are correct (read-only with the link)
1294      * - return a new reference string pointing to the newly copied file.
1295      *
1296      * @param string $reference this reference is generated by
1297      *                          repository::get_file_reference()
1298      * @param context $context the target context for this new file.
1299      * @param string $component the target component for this new file.
1300      * @param string $filearea the target filearea for this new file.
1301      * @param string $itemid the target itemid for this new file.
1302      * @return string updated reference (final one before it's saved to db).
1303      */
1304     public function reference_file_selected($reference, $context, $component, $filearea, $itemid) {
1305         return $reference;
1306     }
1308     /**
1309      * Return the source information
1310      *
1311      * The result of the function is stored in files.source field. It may be analysed
1312      * when the source file is lost or repository may use it to display human-readable
1313      * location of reference original.
1314      *
1315      * This method is called when file is picked for the first time only. When file
1316      * (either copy or a reference) is already in moodle and it is being picked
1317      * again to another file area (also as a copy or as a reference), the value of
1318      * files.source is copied.
1319      *
1320      * @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
1321      * @return string|null
1322      */
1323     public function get_file_source_info($source) {
1324         if ($this->has_moodle_files()) {
1325             $reference = $this->get_file_reference($source);
1326             return $this->get_reference_details($reference, 0);
1327         }
1328         return $source;
1329     }
1331     /**
1332      * Move file from download folder to file pool using FILE API
1333      *
1334      * @todo MDL-28637
1335      * @static
1336      * @param string $thefile file path in download folder
1337      * @param stdClass $record
1338      * @return array containing the following keys:
1339      *           icon
1340      *           file
1341      *           id
1342      *           url
1343      */
1344     public static function move_to_filepool($thefile, $record) {
1345         global $DB, $CFG, $USER, $OUTPUT;
1347         // scan for viruses if possible, throws exception if problem found
1348         // TODO: MDL-28637 this repository_no_delete is a bloody hack!
1349         \core\antivirus\manager::scan_file($thefile, $record->filename, empty($CFG->repository_no_delete));
1351         $fs = get_file_storage();
1352         // If file name being used.
1353         if (repository::draftfile_exists($record->itemid, $record->filepath, $record->filename)) {
1354             $draftitemid = $record->itemid;
1355             $new_filename = repository::get_unused_filename($draftitemid, $record->filepath, $record->filename);
1356             $old_filename = $record->filename;
1357             // Create a tmp file.
1358             $record->filename = $new_filename;
1359             $newfile = $fs->create_file_from_pathname($record, $thefile);
1360             $event = array();
1361             $event['event'] = 'fileexists';
1362             $event['newfile'] = new stdClass;
1363             $event['newfile']->filepath = $record->filepath;
1364             $event['newfile']->filename = $new_filename;
1365             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $new_filename)->out();
1367             $event['existingfile'] = new stdClass;
1368             $event['existingfile']->filepath = $record->filepath;
1369             $event['existingfile']->filename = $old_filename;
1370             $event['existingfile']->url      = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $old_filename)->out();
1371             return $event;
1372         }
1373         if ($file = $fs->create_file_from_pathname($record, $thefile)) {
1374             if (empty($CFG->repository_no_delete)) {
1375                 $delete = unlink($thefile);
1376                 unset($CFG->repository_no_delete);
1377             }
1378             return array(
1379                 'url'=>moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename())->out(),
1380                 'id'=>$file->get_itemid(),
1381                 'file'=>$file->get_filename(),
1382                 'icon' => $OUTPUT->image_url(file_extension_icon($thefile, 32))->out(),
1383             );
1384         } else {
1385             return null;
1386         }
1387     }
1389     /**
1390      * Builds a tree of files This function is then called recursively.
1391      *
1392      * @static
1393      * @todo take $search into account, and respect a threshold for dynamic loading
1394      * @param file_info $fileinfo an object returned by file_browser::get_file_info()
1395      * @param string $search searched string
1396      * @param bool $dynamicmode no recursive call is done when in dynamic mode
1397      * @param array $list the array containing the files under the passed $fileinfo
1398      * @return int the number of files found
1399      */
1400     public static function build_tree($fileinfo, $search, $dynamicmode, &$list) {
1401         global $CFG, $OUTPUT;
1403         $filecount = 0;
1404         $children = $fileinfo->get_children();
1406         foreach ($children as $child) {
1407             $filename = $child->get_visible_name();
1408             $filesize = $child->get_filesize();
1409             $filesize = $filesize ? display_size($filesize) : '';
1410             $filedate = $child->get_timemodified();
1411             $filedate = $filedate ? userdate($filedate) : '';
1412             $filetype = $child->get_mimetype();
1414             if ($child->is_directory()) {
1415                 $path = array();
1416                 $level = $child->get_parent();
1417                 while ($level) {
1418                     $params = $level->get_params();
1419                     $path[] = array($params['filepath'], $level->get_visible_name());
1420                     $level = $level->get_parent();
1421                 }
1423                 $tmp = array(
1424                     'title' => $child->get_visible_name(),
1425                     'size' => 0,
1426                     'date' => $filedate,
1427                     'path' => array_reverse($path),
1428                     'thumbnail' => $OUTPUT->image_url(file_folder_icon(90))->out(false)
1429                 );
1431                 //if ($dynamicmode && $child->is_writable()) {
1432                 //    $tmp['children'] = array();
1433                 //} else {
1434                     // if folder name matches search, we send back all files contained.
1435                 $_search = $search;
1436                 if ($search && stristr($tmp['title'], $search) !== false) {
1437                     $_search = false;
1438                 }
1439                 $tmp['children'] = array();
1440                 $_filecount = repository::build_tree($child, $_search, $dynamicmode, $tmp['children']);
1441                 if ($search && $_filecount) {
1442                     $tmp['expanded'] = 1;
1443                 }
1445                 //}
1447                 if (!$search || $_filecount || (stristr($tmp['title'], $search) !== false)) {
1448                     $filecount += $_filecount;
1449                     $list[] = $tmp;
1450                 }
1452             } else { // not a directory
1453                 // skip the file, if we're in search mode and it's not a match
1454                 if ($search && (stristr($filename, $search) === false)) {
1455                     continue;
1456                 }
1457                 $params = $child->get_params();
1458                 $source = serialize(array($params['contextid'], $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']));
1459                 $list[] = array(
1460                     'title' => $filename,
1461                     'size' => $filesize,
1462                     'date' => $filedate,
1463                     //'source' => $child->get_url(),
1464                     'source' => base64_encode($source),
1465                     'icon'=>$OUTPUT->image_url(file_file_icon($child, 24))->out(false),
1466                     'thumbnail'=>$OUTPUT->image_url(file_file_icon($child, 90))->out(false),
1467                 );
1468                 $filecount++;
1469             }
1470         }
1472         return $filecount;
1473     }
1475     /**
1476      * Display a repository instance list (with edit/delete/create links)
1477      *
1478      * @static
1479      * @param stdClass $context the context for which we display the instance
1480      * @param string $typename if set, we display only one type of instance
1481      */
1482     public static function display_instances_list($context, $typename = null) {
1483         global $CFG, $USER, $OUTPUT;
1485         $output = $OUTPUT->box_start('generalbox');
1486         //if the context is SYSTEM, so we call it from administration page
1487         $admin = ($context->id == SYSCONTEXTID) ? true : false;
1488         if ($admin) {
1489             $baseurl = new moodle_url('/'.$CFG->admin.'/repositoryinstance.php', array('sesskey'=>sesskey()));
1490             $output .= $OUTPUT->heading(get_string('siteinstances', 'repository'));
1491         } else {
1492             $baseurl = new moodle_url('/repository/manage_instances.php', array('contextid'=>$context->id, 'sesskey'=>sesskey()));
1493         }
1495         $namestr = get_string('name');
1496         $pluginstr = get_string('plugin', 'repository');
1497         $settingsstr = get_string('settings');
1498         $deletestr = get_string('delete');
1499         // Retrieve list of instances. In administration context we want to display all
1500         // instances of a type, even if this type is not visible. In course/user context we
1501         // want to display only visible instances, but for every type types. The repository::get_instances()
1502         // third parameter displays only visible type.
1503         $params = array();
1504         $params['context'] = array($context);
1505         $params['currentcontext'] = $context;
1506         $params['return_types'] = 0;
1507         $params['onlyvisible'] = !$admin;
1508         $params['type']        = $typename;
1509         $instances = repository::get_instances($params);
1510         $instancesnumber = count($instances);
1511         $alreadyplugins = array();
1513         $table = new html_table();
1514         $table->head = array($namestr, $pluginstr, $settingsstr, $deletestr);
1515         $table->align = array('left', 'left', 'center','center');
1516         $table->data = array();
1518         $updowncount = 1;
1520         foreach ($instances as $i) {
1521             $settings = '';
1522             $delete = '';
1524             $type = repository::get_type_by_id($i->options['typeid']);
1526             if ($type->get_contextvisibility($context)) {
1527                 if (!$i->readonly) {
1529                     $settingurl = new moodle_url($baseurl);
1530                     $settingurl->param('type', $i->options['type']);
1531                     $settingurl->param('edit', $i->id);
1532                     $settings .= html_writer::link($settingurl, $settingsstr);
1534                     $deleteurl = new moodle_url($baseurl);
1535                     $deleteurl->param('delete', $i->id);
1536                     $deleteurl->param('type', $i->options['type']);
1537                     $delete .= html_writer::link($deleteurl, $deletestr);
1538                 }
1539             }
1541             $type = repository::get_type_by_id($i->options['typeid']);
1542             $table->data[] = array(format_string($i->name), $type->get_readablename(), $settings, $delete);
1544             //display a grey row if the type is defined as not visible
1545             if (isset($type) && !$type->get_visible()) {
1546                 $table->rowclasses[] = 'dimmed_text';
1547             } else {
1548                 $table->rowclasses[] = '';
1549             }
1551             if (!in_array($i->name, $alreadyplugins)) {
1552                 $alreadyplugins[] = $i->name;
1553             }
1554         }
1555         $output .= html_writer::table($table);
1556         $instancehtml = '<div>';
1557         $addable = 0;
1559         //if no type is set, we can create all type of instance
1560         if (!$typename) {
1561             $instancehtml .= '<h3>';
1562             $instancehtml .= get_string('createrepository', 'repository');
1563             $instancehtml .= '</h3><ul>';
1564             $types = repository::get_editable_types($context);
1565             foreach ($types as $type) {
1566                 if (!empty($type) && $type->get_visible()) {
1567                     // If the user does not have the permission to view the repository, it won't be displayed in
1568                     // the list of instances. Hiding the link to create new instances will prevent the
1569                     // user from creating them without being able to find them afterwards, which looks like a bug.
1570                     if (!has_capability('repository/'.$type->get_typename().':view', $context)) {
1571                         continue;
1572                     }
1573                     $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
1574                     if (!empty($instanceoptionnames)) {
1575                         $baseurl->param('new', $type->get_typename());
1576                         $instancehtml .= '<li><a href="'.$baseurl->out().'">'.get_string('createxxinstance', 'repository', get_string('pluginname', 'repository_'.$type->get_typename())).  '</a></li>';
1577                         $baseurl->remove_params('new');
1578                         $addable++;
1579                     }
1580                 }
1581             }
1582             $instancehtml .= '</ul>';
1584         } else {
1585             $instanceoptionnames = repository::static_function($typename, 'get_instance_option_names');
1586             if (!empty($instanceoptionnames)) {   //create a unique type of instance
1587                 $addable = 1;
1588                 $baseurl->param('new', $typename);
1589                 $output .= $OUTPUT->single_button($baseurl, get_string('createinstance', 'repository'), 'get');
1590                 $baseurl->remove_params('new');
1591             }
1592         }
1594         if ($addable) {
1595             $instancehtml .= '</div>';
1596             $output .= $instancehtml;
1597         }
1599         $output .= $OUTPUT->box_end();
1601         //print the list + creation links
1602         print($output);
1603     }
1605     /**
1606      * Prepare file reference information
1607      *
1608      * @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
1609      * @return string file reference, ready to be stored
1610      */
1611     public function get_file_reference($source) {
1612         if ($source && $this->has_moodle_files()) {
1613             $params = @json_decode(base64_decode($source), true);
1614             if (!is_array($params) || empty($params['contextid'])) {
1615                 throw new repository_exception('invalidparams', 'repository');
1616             }
1617             $params = array(
1618                 'component' => empty($params['component']) ? ''   : clean_param($params['component'], PARAM_COMPONENT),
1619                 'filearea'  => empty($params['filearea'])  ? ''   : clean_param($params['filearea'], PARAM_AREA),
1620                 'itemid'    => empty($params['itemid'])    ? 0    : clean_param($params['itemid'], PARAM_INT),
1621                 'filename'  => empty($params['filename'])  ? null : clean_param($params['filename'], PARAM_FILE),
1622                 'filepath'  => empty($params['filepath'])  ? null : clean_param($params['filepath'], PARAM_PATH),
1623                 'contextid' => clean_param($params['contextid'], PARAM_INT)
1624             );
1625             // Check if context exists.
1626             if (!context::instance_by_id($params['contextid'], IGNORE_MISSING)) {
1627                 throw new repository_exception('invalidparams', 'repository');
1628             }
1629             return file_storage::pack_reference($params);
1630         }
1631         return $source;
1632     }
1634     /**
1635      * Get a unique file path in which to save the file.
1636      *
1637      * The filename returned will be removed at the end of the request and
1638      * should not be relied upon to exist in subsequent requests.
1639      *
1640      * @param string $filename file name
1641      * @return file path
1642      */
1643     public function prepare_file($filename) {
1644         if (empty($filename)) {
1645             $filename = 'file';
1646         }
1647         return sprintf('%s/%s', make_request_directory(), $filename);
1648     }
1650     /**
1651      * Does this repository used to browse moodle files?
1652      *
1653      * @return bool
1654      */
1655     public function has_moodle_files() {
1656         return false;
1657     }
1659     /**
1660      * Return file URL, for most plugins, the parameter is the original
1661      * url, but some plugins use a file id, so we need this function to
1662      * convert file id to original url.
1663      *
1664      * @param string $url the url of file
1665      * @return string
1666      */
1667     public function get_link($url) {
1668         return $url;
1669     }
1671     /**
1672      * Downloads a file from external repository and saves it in temp dir
1673      *
1674      * Function get_file() must be implemented by repositories that support returntypes
1675      * FILE_INTERNAL or FILE_REFERENCE. It is invoked to pick up the file and copy it
1676      * to moodle. This function is not called for moodle repositories, the function
1677      * {@link repository::copy_to_area()} is used instead.
1678      *
1679      * This function can be overridden by subclass if the files.reference field contains
1680      * not just URL or if request should be done differently.
1681      *
1682      * @see curl
1683      * @throws file_exception when error occured
1684      *
1685      * @param string $url the content of files.reference field, in this implementaion
1686      * it is asssumed that it contains the string with URL of the file
1687      * @param string $filename filename (without path) to save the downloaded file in the
1688      * temporary directory, if omitted or file already exists the new filename will be generated
1689      * @return array with elements:
1690      *   path: internal location of the file
1691      *   url: URL to the source (from parameters)
1692      */
1693     public function get_file($url, $filename = '') {
1694         global $CFG;
1696         $path = $this->prepare_file($filename);
1697         $c = new curl;
1699         $result = $c->download_one($url, null, array('filepath' => $path, 'timeout' => $CFG->repositorygetfiletimeout));
1700         if ($result !== true) {
1701             throw new moodle_exception('errorwhiledownload', 'repository', '', $result);
1702         }
1703         return array('path'=>$path, 'url'=>$url);
1704     }
1706     /**
1707      * Downloads the file from external repository and saves it in moodle filepool.
1708      * This function is different from {@link repository::sync_reference()} because it has
1709      * bigger request timeout and always downloads the content.
1710      *
1711      * This function is invoked when we try to unlink the file from the source and convert
1712      * a reference into a true copy.
1713      *
1714      * @throws exception when file could not be imported
1715      *
1716      * @param stored_file $file
1717      * @param int $maxbytes throw an exception if file size is bigger than $maxbytes (0 means no limit)
1718      */
1719     public function import_external_file_contents(stored_file $file, $maxbytes = 0) {
1720         if (!$file->is_external_file()) {
1721             // nothing to import if the file is not a reference
1722             return;
1723         } else if ($file->get_repository_id() != $this->id) {
1724             // error
1725             debugging('Repository instance id does not match');
1726             return;
1727         } else if ($this->has_moodle_files()) {
1728             // files that are references to local files are already in moodle filepool
1729             // just validate the size
1730             if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1731                 $maxbytesdisplay = display_size($maxbytes);
1732                 throw new file_exception('maxbytesfile', (object) array('file' => $file->get_filename(),
1733                                                                         'size' => $maxbytesdisplay));
1734             }
1735             return;
1736         } else {
1737             if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1738                 // note that stored_file::get_filesize() also calls synchronisation
1739                 $maxbytesdisplay = display_size($maxbytes);
1740                 throw new file_exception('maxbytesfile', (object) array('file' => $file->get_filename(),
1741                                                                         'size' => $maxbytesdisplay));
1742             }
1743             $fs = get_file_storage();
1745             // If a file has been downloaded, the file record should report both a positive file
1746             // size, and a contenthash which does not related to empty content.
1747             // If thereis no file size, or the contenthash is for an empty file, then the file has
1748             // yet to be successfully downloaded.
1749             $contentexists = $file->get_filesize() && !$file->compare_to_string('');
1751             if (!$file->get_status() && $contentexists) {
1752                 // we already have the content in moodle filepool and it was synchronised recently.
1753                 // Repositories may overwrite it if they want to force synchronisation anyway!
1754                 return;
1755             } else {
1756                 // attempt to get a file
1757                 try {
1758                     $fileinfo = $this->get_file($file->get_reference());
1759                     if (isset($fileinfo['path'])) {
1760                         $file->set_synchronised_content_from_file($fileinfo['path']);
1761                     } else {
1762                         throw new moodle_exception('errorwhiledownload', 'repository', '', '');
1763                     }
1764                 } catch (Exception $e) {
1765                     if ($contentexists) {
1766                         // better something than nothing. We have a copy of file. It's sync time
1767                         // has expired but it is still very likely that it is the last version
1768                     } else {
1769                         throw($e);
1770                     }
1771                 }
1772             }
1773         }
1774     }
1776     /**
1777      * Return size of a file in bytes.
1778      *
1779      * @param string $source encoded and serialized data of file
1780      * @return int file size in bytes
1781      */
1782     public function get_file_size($source) {
1783         // TODO MDL-33297 remove this function completely?
1784         $browser    = get_file_browser();
1785         $params     = unserialize(base64_decode($source));
1786         $contextid  = clean_param($params['contextid'], PARAM_INT);
1787         $fileitemid = clean_param($params['itemid'], PARAM_INT);
1788         $filename   = clean_param($params['filename'], PARAM_FILE);
1789         $filepath   = clean_param($params['filepath'], PARAM_PATH);
1790         $filearea   = clean_param($params['filearea'], PARAM_AREA);
1791         $component  = clean_param($params['component'], PARAM_COMPONENT);
1792         $context    = context::instance_by_id($contextid);
1793         $file_info  = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
1794         if (!empty($file_info)) {
1795             $filesize = $file_info->get_filesize();
1796         } else {
1797             $filesize = null;
1798         }
1799         return $filesize;
1800     }
1802     /**
1803      * Return is the instance is visible
1804      * (is the type visible ? is the context enable ?)
1805      *
1806      * @return bool
1807      */
1808     public function is_visible() {
1809         $type = repository::get_type_by_id($this->options['typeid']);
1810         $instanceoptions = repository::static_function($type->get_typename(), 'get_instance_option_names');
1812         if ($type->get_visible()) {
1813             //if the instance is unique so it's visible, otherwise check if the instance has a enabled context
1814             if (empty($instanceoptions) || $type->get_contextvisibility(context::instance_by_id($this->instance->contextid))) {
1815                 return true;
1816             }
1817         }
1819         return false;
1820     }
1822     /**
1823      * Can the instance be edited by the current user?
1824      *
1825      * The property $readonly must not be used within this method because
1826      * it only controls if the options from self::get_instance_option_names()
1827      * can be edited.
1828      *
1829      * @return bool true if the user can edit the instance.
1830      * @since Moodle 2.5
1831      */
1832     public final function can_be_edited_by_user() {
1833         global $USER;
1835         // We need to be able to explore the repository.
1836         try {
1837             $this->check_capability();
1838         } catch (repository_exception $e) {
1839             return false;
1840         }
1842         $repocontext = context::instance_by_id($this->instance->contextid);
1843         if ($repocontext->contextlevel == CONTEXT_USER && $repocontext->instanceid != $USER->id) {
1844             // If the context of this instance is a user context, we need to be this user.
1845             return false;
1846         } else if ($repocontext->contextlevel == CONTEXT_MODULE && !has_capability('moodle/course:update', $repocontext)) {
1847             // We need to have permissions on the course to edit the instance.
1848             return false;
1849         } else if ($repocontext->contextlevel == CONTEXT_SYSTEM && !has_capability('moodle/site:config', $repocontext)) {
1850             // Do not meet the requirements for the context system.
1851             return false;
1852         }
1854         return true;
1855     }
1857     /**
1858      * Return the name of this instance, can be overridden.
1859      *
1860      * @return string
1861      */
1862     public function get_name() {
1863         if ($name = $this->instance->name) {
1864             return $name;
1865         } else {
1866             return get_string('pluginname', 'repository_' . $this->get_typename());
1867         }
1868     }
1870     /**
1871      * Is this repository accessing private data?
1872      *
1873      * This function should return true for the repositories which access external private
1874      * data from a user. This is the case for repositories such as Dropbox, Google Docs or Box.net
1875      * which authenticate the user and then store the auth token.
1876      *
1877      * Of course, many repositories store 'private data', but we only want to set
1878      * contains_private_data() to repositories which are external to Moodle and shouldn't be accessed
1879      * to by the users having the capability to 'login as' someone else. For instance, the repository
1880      * 'Private files' is not considered as private because it's part of Moodle.
1881      *
1882      * You should not set contains_private_data() to true on repositories which allow different types
1883      * of instances as the levels other than 'user' are, by definition, not private. Also
1884      * the user instances will be protected when they need to.
1885      *
1886      * @return boolean True when the repository accesses private external data.
1887      * @since  Moodle 2.5
1888      */
1889     public function contains_private_data() {
1890         return true;
1891     }
1893     /**
1894      * What kind of files will be in this repository?
1895      *
1896      * @return array return '*' means this repository support any files, otherwise
1897      *               return mimetypes of files, it can be an array
1898      */
1899     public function supported_filetypes() {
1900         // return array('text/plain', 'image/gif');
1901         return '*';
1902     }
1904     /**
1905      * Tells how the file can be picked from this repository
1906      *
1907      * Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
1908      *
1909      * @return int
1910      */
1911     public function supported_returntypes() {
1912         return (FILE_INTERNAL | FILE_EXTERNAL);
1913     }
1915     /**
1916      * Tells how the file can be picked from this repository
1917      *
1918      * Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
1919      *
1920      * @return int
1921      */
1922     public function default_returntype() {
1923         return FILE_INTERNAL;
1924     }
1926     /**
1927      * Provide repository instance information for Ajax
1928      *
1929      * @return stdClass
1930      */
1931     final public function get_meta() {
1932         global $CFG, $OUTPUT;
1933         $meta = new stdClass();
1934         $meta->id   = $this->id;
1935         $meta->name = format_string($this->get_name());
1936         $meta->type = $this->get_typename();
1937         $meta->icon = $OUTPUT->image_url('icon', 'repository_'.$meta->type)->out(false);
1938         $meta->supported_types = file_get_typegroup('extension', $this->supported_filetypes());
1939         $meta->return_types = $this->supported_returntypes();
1940         $meta->defaultreturntype = $this->default_returntype();
1941         $meta->sortorder = $this->options['sortorder'];
1942         return $meta;
1943     }
1945     /**
1946      * Create an instance for this plug-in
1947      *
1948      * @static
1949      * @param string $type the type of the repository
1950      * @param int $userid the user id
1951      * @param stdClass $context the context
1952      * @param array $params the options for this instance
1953      * @param int $readonly whether to create it readonly or not (defaults to not)
1954      * @return mixed
1955      */
1956     public static function create($type, $userid, $context, $params, $readonly=0) {
1957         global $CFG, $DB;
1958         $params = (array)$params;
1959         require_once($CFG->dirroot . '/repository/'. $type . '/lib.php');
1960         $classname = 'repository_' . $type;
1961         if ($repo = $DB->get_record('repository', array('type'=>$type))) {
1962             $record = new stdClass();
1963             $record->name = $params['name'];
1964             $record->typeid = $repo->id;
1965             $record->timecreated  = time();
1966             $record->timemodified = time();
1967             $record->contextid = $context->id;
1968             $record->readonly = $readonly;
1969             $record->userid    = $userid;
1970             $id = $DB->insert_record('repository_instances', $record);
1971             cache::make('core', 'repositories')->purge();
1972             $options = array();
1973             $configs = call_user_func($classname . '::get_instance_option_names');
1974             if (!empty($configs)) {
1975                 foreach ($configs as $config) {
1976                     if (isset($params[$config])) {
1977                         $options[$config] = $params[$config];
1978                     } else {
1979                         $options[$config] = null;
1980                     }
1981                 }
1982             }
1984             if (!empty($id)) {
1985                 unset($options['name']);
1986                 $instance = repository::get_instance($id);
1987                 $instance->set_option($options);
1988                 return $id;
1989             } else {
1990                 return null;
1991             }
1992         } else {
1993             return null;
1994         }
1995     }
1997     /**
1998      * delete a repository instance
1999      *
2000      * @param bool $downloadcontents
2001      * @return bool
2002      */
2003     final public function delete($downloadcontents = false) {
2004         global $DB;
2005         if ($downloadcontents) {
2006             $this->convert_references_to_local();
2007         } else {
2008             $this->remove_files();
2009         }
2010         cache::make('core', 'repositories')->purge();
2011         try {
2012             $DB->delete_records('repository_instances', array('id'=>$this->id));
2013             $DB->delete_records('repository_instance_config', array('instanceid'=>$this->id));
2014         } catch (dml_exception $ex) {
2015             return false;
2016         }
2017         return true;
2018     }
2020     /**
2021      * Delete all the instances associated to a context.
2022      *
2023      * This method is intended to be a callback when deleting
2024      * a course or a user to delete all the instances associated
2025      * to their context. The usual way to delete a single instance
2026      * is to use {@link self::delete()}.
2027      *
2028      * @param int $contextid context ID.
2029      * @param boolean $downloadcontents true to convert references to hard copies.
2030      * @return void
2031      */
2032     final public static function delete_all_for_context($contextid, $downloadcontents = true) {
2033         global $DB;
2034         $repoids = $DB->get_fieldset_select('repository_instances', 'id', 'contextid = :contextid', array('contextid' => $contextid));
2035         if ($downloadcontents) {
2036             foreach ($repoids as $repoid) {
2037                 $repo = repository::get_repository_by_id($repoid, $contextid);
2038                 $repo->convert_references_to_local();
2039             }
2040         }
2041         cache::make('core', 'repositories')->purge();
2042         $DB->delete_records_list('repository_instances', 'id', $repoids);
2043         $DB->delete_records_list('repository_instance_config', 'instanceid', $repoids);
2044     }
2046     /**
2047      * Hide/Show a repository
2048      *
2049      * @param string $hide
2050      * @return bool
2051      */
2052     final public function hide($hide = 'toggle') {
2053         global $DB;
2054         if ($entry = $DB->get_record('repository', array('id'=>$this->id))) {
2055             if ($hide === 'toggle' ) {
2056                 if (!empty($entry->visible)) {
2057                     $entry->visible = 0;
2058                 } else {
2059                     $entry->visible = 1;
2060                 }
2061             } else {
2062                 if (!empty($hide)) {
2063                     $entry->visible = 0;
2064                 } else {
2065                     $entry->visible = 1;
2066                 }
2067             }
2068             return $DB->update_record('repository', $entry);
2069         }
2070         return false;
2071     }
2073     /**
2074      * Save settings for repository instance
2075      * $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));
2076      *
2077      * @param array $options settings
2078      * @return bool
2079      */
2080     public function set_option($options = array()) {
2081         global $DB;
2083         if (!empty($options['name'])) {
2084             $r = new stdClass();
2085             $r->id   = $this->id;
2086             $r->name = $options['name'];
2087             $DB->update_record('repository_instances', $r);
2088             unset($options['name']);
2089         }
2090         foreach ($options as $name=>$value) {
2091             if ($id = $DB->get_field('repository_instance_config', 'id', array('name'=>$name, 'instanceid'=>$this->id))) {
2092                 $DB->set_field('repository_instance_config', 'value', $value, array('id'=>$id));
2093             } else {
2094                 $config = new stdClass();
2095                 $config->instanceid = $this->id;
2096                 $config->name   = $name;
2097                 $config->value  = $value;
2098                 $DB->insert_record('repository_instance_config', $config);
2099             }
2100         }
2101         cache::make('core', 'repositories')->purge();
2102         return true;
2103     }
2105     /**
2106      * Get settings for repository instance.
2107      *
2108      * @param string $config a specific option to get.
2109      * @return mixed returns an array of options. If $config is not empty, then it returns that option,
2110      *               or null if the option does not exist.
2111      */
2112     public function get_option($config = '') {
2113         global $DB;
2114         $cache = cache::make('core', 'repositories');
2115         if (($entries = $cache->get('ops:'. $this->id)) === false) {
2116             $entries = $DB->get_records('repository_instance_config', array('instanceid' => $this->id));
2117             $cache->set('ops:'. $this->id, $entries);
2118         }
2120         $ret = array();
2121         foreach($entries as $entry) {
2122             $ret[$entry->name] = $entry->value;
2123         }
2125         if (!empty($config)) {
2126             if (isset($ret[$config])) {
2127                 return $ret[$config];
2128             } else {
2129                 return null;
2130             }
2131         } else {
2132             return $ret;
2133         }
2134     }
2136     /**
2137      * Filter file listing to display specific types
2138      *
2139      * @param array $value
2140      * @return bool
2141      */
2142     public function filter(&$value) {
2143         $accepted_types = optional_param_array('accepted_types', '', PARAM_RAW);
2144         if (isset($value['children'])) {
2145             if (!empty($value['children'])) {
2146                 $value['children'] = array_filter($value['children'], array($this, 'filter'));
2147             }
2148             return true; // always return directories
2149         } else {
2150             if ($accepted_types == '*' or empty($accepted_types)
2151                 or (is_array($accepted_types) and in_array('*', $accepted_types))) {
2152                 return true;
2153             } else {
2154                 foreach ($accepted_types as $ext) {
2155                     if (preg_match('#'.$ext.'$#i', $value['title'])) {
2156                         return true;
2157                     }
2158                 }
2159             }
2160         }
2161         return false;
2162     }
2164     /**
2165      * Given a path, and perhaps a search, get a list of files.
2166      *
2167      * See details on {@link http://docs.moodle.org/dev/Repository_plugins}
2168      *
2169      * @param string $path this parameter can a folder name, or a identification of folder
2170      * @param string $page the page number of file list
2171      * @return array the list of files, including meta infomation, containing the following keys
2172      *           manage, url to manage url
2173      *           client_id
2174      *           login, login form
2175      *           repo_id, active repository id
2176      *           login_btn_action, the login button action
2177      *           login_btn_label, the login button label
2178      *           total, number of results
2179      *           perpage, items per page
2180      *           page
2181      *           pages, total pages
2182      *           issearchresult, is it a search result?
2183      *           list, file list
2184      *           path, current path and parent path
2185      */
2186     public function get_listing($path = '', $page = '') {
2187     }
2190     /**
2191      * Prepare the breadcrumb.
2192      *
2193      * @param array $breadcrumb contains each element of the breadcrumb.
2194      * @return array of breadcrumb elements.
2195      * @since Moodle 2.3.3
2196      */
2197     protected static function prepare_breadcrumb($breadcrumb) {
2198         global $OUTPUT;
2199         $foldericon = $OUTPUT->image_url(file_folder_icon(24))->out(false);
2200         $len = count($breadcrumb);
2201         for ($i = 0; $i < $len; $i++) {
2202             if (is_array($breadcrumb[$i]) && !isset($breadcrumb[$i]['icon'])) {
2203                 $breadcrumb[$i]['icon'] = $foldericon;
2204             } else if (is_object($breadcrumb[$i]) && !isset($breadcrumb[$i]->icon)) {
2205                 $breadcrumb[$i]->icon = $foldericon;
2206             }
2207         }
2208         return $breadcrumb;
2209     }
2211     /**
2212      * Prepare the file/folder listing.
2213      *
2214      * @param array $list of files and folders.
2215      * @return array of files and folders.
2216      * @since Moodle 2.3.3
2217      */
2218     protected static function prepare_list($list) {
2219         global $OUTPUT;
2220         $foldericon = $OUTPUT->image_url(file_folder_icon(24))->out(false);
2222         // Reset the array keys because non-numeric keys will create an object when converted to JSON.
2223         $list = array_values($list);
2225         $len = count($list);
2226         for ($i = 0; $i < $len; $i++) {
2227             if (is_object($list[$i])) {
2228                 $file = (array)$list[$i];
2229                 $converttoobject = true;
2230             } else {
2231                 $file =& $list[$i];
2232                 $converttoobject = false;
2233             }
2235             if (isset($file['source'])) {
2236                 $file['sourcekey'] = sha1($file['source'] . self::get_secret_key() . sesskey());
2237             }
2239             if (isset($file['size'])) {
2240                 $file['size'] = (int)$file['size'];
2241                 $file['size_f'] = display_size($file['size']);
2242             }
2243             if (isset($file['license']) && get_string_manager()->string_exists($file['license'], 'license')) {
2244                 $file['license_f'] = get_string($file['license'], 'license');
2245             }
2246             if (isset($file['image_width']) && isset($file['image_height'])) {
2247                 $a = array('width' => $file['image_width'], 'height' => $file['image_height']);
2248                 $file['dimensions'] = get_string('imagesize', 'repository', (object)$a);
2249             }
2250             foreach (array('date', 'datemodified', 'datecreated') as $key) {
2251                 if (!isset($file[$key]) && isset($file['date'])) {
2252                     $file[$key] = $file['date'];
2253                 }
2254                 if (isset($file[$key])) {
2255                     // must be UNIX timestamp
2256                     $file[$key] = (int)$file[$key];
2257                     if (!$file[$key]) {
2258                         unset($file[$key]);
2259                     } else {
2260                         $file[$key.'_f'] = userdate($file[$key], get_string('strftimedatetime', 'langconfig'));
2261                         $file[$key.'_f_s'] = userdate($file[$key], get_string('strftimedatetimeshort', 'langconfig'));
2262                     }
2263                 }
2264             }
2265             $isfolder = (array_key_exists('children', $file) || (isset($file['type']) && $file['type'] == 'folder'));
2266             $filename = null;
2267             if (isset($file['title'])) {
2268                 $filename = $file['title'];
2269             }
2270             else if (isset($file['fullname'])) {
2271                 $filename = $file['fullname'];
2272             }
2273             if (!isset($file['mimetype']) && !$isfolder && $filename) {
2274                 $file['mimetype'] = get_mimetype_description(array('filename' => $filename));
2275             }
2276             if (!isset($file['icon'])) {
2277                 if ($isfolder) {
2278                     $file['icon'] = $foldericon;
2279                 } else if ($filename) {
2280                     $file['icon'] = $OUTPUT->image_url(file_extension_icon($filename, 24))->out(false);
2281                 }
2282             }
2284             // Recursively loop over children.
2285             if (isset($file['children'])) {
2286                 $file['children'] = self::prepare_list($file['children']);
2287             }
2289             // Convert the array back to an object.
2290             if ($converttoobject) {
2291                 $list[$i] = (object)$file;
2292             }
2293         }
2294         return $list;
2295     }
2297     /**
2298      * Prepares list of files before passing it to AJAX, makes sure data is in the correct
2299      * format and stores formatted values.
2300      *
2301      * @param array|stdClass $listing result of get_listing() or search() or file_get_drafarea_files()
2302      * @return array
2303      */
2304     public static function prepare_listing($listing) {
2305         $wasobject = false;
2306         if (is_object($listing)) {
2307             $listing = (array) $listing;
2308             $wasobject = true;
2309         }
2311         // Prepare the breadcrumb, passed as 'path'.
2312         if (isset($listing['path']) && is_array($listing['path'])) {
2313             $listing['path'] = self::prepare_breadcrumb($listing['path']);
2314         }
2316         // Prepare the listing of objects.
2317         if (isset($listing['list']) && is_array($listing['list'])) {
2318             $listing['list'] = self::prepare_list($listing['list']);
2319         }
2321         // Convert back to an object.
2322         if ($wasobject) {
2323             $listing = (object) $listing;
2324         }
2325         return $listing;
2326     }
2328     /**
2329      * Search files in repository
2330      * When doing global search, $search_text will be used as
2331      * keyword.
2332      *
2333      * @param string $search_text search key word
2334      * @param int $page page
2335      * @return mixed see {@link repository::get_listing()}
2336      */
2337     public function search($search_text, $page = 0) {
2338         $list = array();
2339         $list['list'] = array();
2340         return false;
2341     }
2343     /**
2344      * Logout from repository instance
2345      * By default, this function will return a login form
2346      *
2347      * @return string
2348      */
2349     public function logout(){
2350         return $this->print_login();
2351     }
2353     /**
2354      * To check whether the user is logged in.
2355      *
2356      * @return bool
2357      */
2358     public function check_login(){
2359         return true;
2360     }
2363     /**
2364      * Show the login screen, if required
2365      *
2366      * @return string
2367      */
2368     public function print_login(){
2369         return $this->get_listing();
2370     }
2372     /**
2373      * Show the search screen, if required
2374      *
2375      * @return string
2376      */
2377     public function print_search() {
2378         global $PAGE;
2379         $renderer = $PAGE->get_renderer('core', 'files');
2380         return $renderer->repository_default_searchform();
2381     }
2383     /**
2384      * For oauth like external authentication, when external repository direct user back to moodle,
2385      * this function will be called to set up token and token_secret
2386      */
2387     public function callback() {
2388     }
2390     /**
2391      * is it possible to do glboal search?
2392      *
2393      * @return bool
2394      */
2395     public function global_search() {
2396         return false;
2397     }
2399     /**
2400      * Defines operations that happen occasionally on cron
2401      *
2402      * @return bool
2403      */
2404     public function cron() {
2405         return true;
2406     }
2408     /**
2409      * function which is run when the type is created (moodle administrator add the plugin)
2410      *
2411      * @return bool success or fail?
2412      */
2413     public static function plugin_init() {
2414         return true;
2415     }
2417     /**
2418      * Edit/Create Admin Settings Moodle form
2419      *
2420      * @param moodleform $mform Moodle form (passed by reference)
2421      * @param string $classname repository class name
2422      */
2423     public static function type_config_form($mform, $classname = 'repository') {
2424         $instnaceoptions = call_user_func(array($classname, 'get_instance_option_names'), $mform, $classname);
2425         if (empty($instnaceoptions)) {
2426             // this plugin has only one instance
2427             // so we need to give it a name
2428             // it can be empty, then moodle will look for instance name from language string
2429             $mform->addElement('text', 'pluginname', get_string('pluginname', 'repository'), array('size' => '40'));
2430             $mform->addElement('static', 'pluginnamehelp', '', get_string('pluginnamehelp', 'repository'));
2431             $mform->setType('pluginname', PARAM_TEXT);
2432         }
2433     }
2435     /**
2436      * Validate Admin Settings Moodle form
2437      *
2438      * @static
2439      * @param moodleform $mform Moodle form (passed by reference)
2440      * @param array $data array of ("fieldname"=>value) of submitted data
2441      * @param array $errors array of ("fieldname"=>errormessage) of errors
2442      * @return array array of errors
2443      */
2444     public static function type_form_validation($mform, $data, $errors) {
2445         return $errors;
2446     }
2449     /**
2450      * Edit/Create Instance Settings Moodle form
2451      *
2452      * @param moodleform $mform Moodle form (passed by reference)
2453      */
2454     public static function instance_config_form($mform) {
2455     }
2457     /**
2458      * Return names of the general options.
2459      * By default: no general option name
2460      *
2461      * @return array
2462      */
2463     public static function get_type_option_names() {
2464         return array('pluginname');
2465     }
2467     /**
2468      * Return names of the instance options.
2469      * By default: no instance option name
2470      *
2471      * @return array
2472      */
2473     public static function get_instance_option_names() {
2474         return array();
2475     }
2477     /**
2478      * Validate repository plugin instance form
2479      *
2480      * @param moodleform $mform moodle form
2481      * @param array $data form data
2482      * @param array $errors errors
2483      * @return array errors
2484      */
2485     public static function instance_form_validation($mform, $data, $errors) {
2486         return $errors;
2487     }
2489     /**
2490      * Create a shorten filename
2491      *
2492      * @param string $str filename
2493      * @param int $maxlength max file name length
2494      * @return string short filename
2495      */
2496     public function get_short_filename($str, $maxlength) {
2497         if (core_text::strlen($str) >= $maxlength) {
2498             return trim(core_text::substr($str, 0, $maxlength)).'...';
2499         } else {
2500             return $str;
2501         }
2502     }
2504     /**
2505      * Overwrite an existing file
2506      *
2507      * @param int $itemid
2508      * @param string $filepath
2509      * @param string $filename
2510      * @param string $newfilepath
2511      * @param string $newfilename
2512      * @return bool
2513      */
2514     public static function overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename) {
2515         global $USER;
2516         $fs = get_file_storage();
2517         $user_context = context_user::instance($USER->id);
2518         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $filepath, $filename)) {
2519             if ($tempfile = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $newfilepath, $newfilename)) {
2520                 // Remember original file source field.
2521                 $source = @unserialize($file->get_source());
2522                 // Remember the original sortorder.
2523                 $sortorder = $file->get_sortorder();
2524                 if ($tempfile->is_external_file()) {
2525                     // New file is a reference. Check that existing file does not have any other files referencing to it
2526                     if (isset($source->original) && $fs->search_references_count($source->original)) {
2527                         return (object)array('error' => get_string('errordoublereference', 'repository'));
2528                     }
2529                 }
2530                 // delete existing file to release filename
2531                 $file->delete();
2532                 // create new file
2533                 $newfile = $fs->create_file_from_storedfile(array('filepath'=>$filepath, 'filename'=>$filename), $tempfile);
2534                 // Preserve original file location (stored in source field) for handling references
2535                 if (isset($source->original)) {
2536                     if (!($newfilesource = @unserialize($newfile->get_source()))) {
2537                         $newfilesource = new stdClass();
2538                     }
2539                     $newfilesource->original = $source->original;
2540                     $newfile->set_source(serialize($newfilesource));
2541                 }
2542                 $newfile->set_sortorder($sortorder);
2543                 // remove temp file
2544                 $tempfile->delete();
2545                 return true;
2546             }
2547         }
2548         return false;
2549     }
2551     /**
2552      * Updates a file in draft filearea.
2553      *
2554      * This function can only update fields filepath, filename, author, license.
2555      * If anything (except filepath) is updated, timemodified is set to current time.
2556      * If filename or filepath is updated the file unconnects from it's origin
2557      * and therefore all references to it will be converted to copies when
2558      * filearea is saved.
2559      *
2560      * @param int $draftid
2561      * @param string $filepath path to the directory containing the file, or full path in case of directory
2562      * @param string $filename name of the file, or '.' in case of directory
2563      * @param array $updatedata array of fields to change (only filename, filepath, license and/or author can be updated)
2564      * @throws moodle_exception if for any reason file can not be updated (file does not exist, target already exists, etc.)
2565      */
2566     public static function update_draftfile($draftid, $filepath, $filename, $updatedata) {
2567         global $USER;
2568         $fs = get_file_storage();
2569         $usercontext = context_user::instance($USER->id);
2570         // make sure filename and filepath are present in $updatedata
2571         $updatedata = $updatedata + array('filepath' => $filepath, 'filename' => $filename);
2572         $filemodified = false;
2573         if (!$file = $fs->get_file($usercontext->id, 'user', 'draft', $draftid, $filepath, $filename)) {
2574             if ($filename === '.') {
2575                 throw new moodle_exception('foldernotfound', 'repository');
2576             } else {
2577                 throw new moodle_exception('filenotfound', 'error');
2578             }
2579         }
2580         if (!$file->is_directory()) {
2581             // This is a file
2582             if ($updatedata['filepath'] !== $filepath || $updatedata['filename'] !== $filename) {
2583                 // Rename/move file: check that target file name does not exist.
2584                 if ($fs->file_exists($usercontext->id, 'user', 'draft', $draftid, $updatedata['filepath'], $updatedata['filename'])) {
2585                     throw new moodle_exception('fileexists', 'repository');
2586                 }
2587                 if (($filesource = @unserialize($file->get_source())) && isset($filesource->original)) {
2588                     unset($filesource->original);
2589                     $file->set_source(serialize($filesource));
2590                 }
2591                 $file->rename($updatedata['filepath'], $updatedata['filename']);
2592                 // timemodified is updated only when file is renamed and not updated when file is moved.
2593                 $filemodified = $filemodified || ($updatedata['filename'] !== $filename);
2594             }
2595             if (array_key_exists('license', $updatedata) && $updatedata['license'] !== $file->get_license()) {
2596                 // Update license and timemodified.
2597                 $file->set_license($updatedata['license']);
2598                 $filemodified = true;
2599             }
2600             if (array_key_exists('author', $updatedata) && $updatedata['author'] !== $file->get_author()) {
2601                 // Update author and timemodified.
2602                 $file->set_author($updatedata['author']);
2603                 $filemodified = true;
2604             }
2605             // Update timemodified:
2606             if ($filemodified) {
2607                 $file->set_timemodified(time());
2608             }
2609         } else {
2610             // This is a directory - only filepath can be updated for a directory (it was moved).
2611             if ($updatedata['filepath'] === $filepath) {
2612                 // nothing to update
2613                 return;
2614             }
2615             if ($fs->file_exists($usercontext->id, 'user', 'draft', $draftid, $updatedata['filepath'], '.')) {
2616                 // bad luck, we can not rename if something already exists there
2617                 throw new moodle_exception('folderexists', 'repository');
2618             }
2619             $xfilepath = preg_quote($filepath, '|');
2620             if (preg_match("|^$xfilepath|", $updatedata['filepath'])) {
2621                 // we can not move folder to it's own subfolder
2622                 throw new moodle_exception('folderrecurse', 'repository');
2623             }
2625             // If directory changed the name, update timemodified.
2626             $filemodified = (basename(rtrim($file->get_filepath(), '/')) !== basename(rtrim($updatedata['filepath'], '/')));
2628             // Now update directory and all children.
2629             $files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftid);
2630             foreach ($files as $f) {
2631                 if (preg_match("|^$xfilepath|", $f->get_filepath())) {
2632                     $path = preg_replace("|^$xfilepath|", $updatedata['filepath'], $f->get_filepath());
2633                     if (($filesource = @unserialize($f->get_source())) && isset($filesource->original)) {
2634                         // unset original so the references are not shown any more
2635                         unset($filesource->original);
2636                         $f->set_source(serialize($filesource));
2637                     }
2638                     $f->rename($path, $f->get_filename());
2639                     if ($filemodified && $f->get_filepath() === $updatedata['filepath'] && $f->get_filename() === $filename) {
2640                         $f->set_timemodified(time());
2641                     }
2642                 }
2643             }
2644         }
2645     }
2647     /**
2648      * Delete a temp file from draft area
2649      *
2650      * @param int $draftitemid
2651      * @param string $filepath
2652      * @param string $filename
2653      * @return bool
2654      */
2655     public static function delete_tempfile_from_draft($draftitemid, $filepath, $filename) {
2656         global $USER;
2657         $fs = get_file_storage();
2658         $user_context = context_user::instance($USER->id);
2659         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $draftitemid, $filepath, $filename)) {
2660             $file->delete();
2661             return true;
2662         } else {
2663             return false;
2664         }
2665     }
2667     /**
2668      * Find all external files in this repo and import them
2669      */
2670     public function convert_references_to_local() {
2671         $fs = get_file_storage();
2672         $files = $fs->get_external_files($this->id);
2673         foreach ($files as $storedfile) {
2674             $fs->import_external_file($storedfile);
2675         }
2676     }
2678     /**
2679      * Find all external files linked to this repository and delete them.
2680      */
2681     public function remove_files() {
2682         $fs = get_file_storage();
2683         $files = $fs->get_external_files($this->id);
2684         foreach ($files as $storedfile) {
2685             $storedfile->delete();
2686         }
2687     }
2689     /**
2690      * Function repository::reset_caches() is deprecated, cache is handled by MUC now.
2691      * @deprecated since Moodle 2.6 MDL-42016 - please do not use this function any more.
2692      */
2693     public static function reset_caches() {
2694         throw new coding_exception('Function repository::reset_caches() can not be used any more, cache is handled by MUC now.');
2695     }
2697     /**
2698      * Function repository::sync_external_file() is deprecated. Use repository::sync_reference instead
2699      *
2700      * @deprecated since Moodle 2.6 MDL-42016 - please do not use this function any more.
2701      * @see repository::sync_reference()
2702      */
2703     public static function sync_external_file($file, $resetsynchistory = false) {
2704         throw new coding_exception('Function repository::sync_external_file() can not be used any more. ' .
2705             'Use repository::sync_reference instead.');
2706     }
2708     /**
2709      * Performs synchronisation of an external file if the previous one has expired.
2710      *
2711      * This function must be implemented for external repositories supporting
2712      * FILE_REFERENCE, it is called for existing aliases when their filesize,
2713      * contenthash or timemodified are requested. It is not called for internal
2714      * repositories (see {@link repository::has_moodle_files()}), references to
2715      * internal files are updated immediately when source is modified.
2716      *
2717      * Referenced files may optionally keep their content in Moodle filepool (for
2718      * thumbnail generation or to be able to serve cached copy). In this
2719      * case both contenthash and filesize need to be synchronized. Otherwise repositories
2720      * should use contenthash of empty file and correct filesize in bytes.
2721      *
2722      * Note that this function may be run for EACH file that needs to be synchronised at the
2723      * moment. If anything is being downloaded or requested from external sources there
2724      * should be a small timeout. The synchronisation is performed to update the size of
2725      * the file and/or to update image and re-generated image preview. There is nothing
2726      * fatal if syncronisation fails but it is fatal if syncronisation takes too long
2727      * and hangs the script generating a page.
2728      *
2729      * Note: If you wish to call $file->get_filesize(), $file->get_contenthash() or
2730      * $file->get_timemodified() make sure that recursion does not happen.
2731      *
2732      * Called from {@link stored_file::sync_external_file()}
2733      *
2734      * @uses stored_file::set_missingsource()
2735      * @uses stored_file::set_synchronized()
2736      * @param stored_file $file
2737      * @return bool false when file does not need synchronisation, true if it was synchronised
2738      */
2739     public function sync_reference(stored_file $file) {
2740         if ($file->get_repository_id() != $this->id) {
2741             // This should not really happen because the function can be called from stored_file only.
2742             return false;
2743         }
2745         if ($this->has_moodle_files()) {
2746             // References to local files need to be synchronised only once.
2747             // Later they will be synchronised automatically when the source is changed.
2748             if ($file->get_referencelastsync()) {
2749                 return false;
2750             }
2751             $fs = get_file_storage();
2752             $params = file_storage::unpack_reference($file->get_reference(), true);
2753             if (!is_array($params) || !($storedfile = $fs->get_file($params['contextid'],
2754                     $params['component'], $params['filearea'], $params['itemid'], $params['filepath'],
2755                     $params['filename']))) {
2756                 $file->set_missingsource();
2757             } else {
2758                 $file->set_synchronized($storedfile->get_contenthash(), $storedfile->get_filesize(), 0, $storedfile->get_timemodified());
2759             }
2760             return true;
2761         }
2763         return false;
2764     }
2766     /**
2767      * Build draft file's source field
2768      *
2769      * {@link file_restore_source_field_from_draft_file()}
2770      * XXX: This is a hack for file manager (MDL-28666)
2771      * For newly created  draft files we have to construct
2772      * source filed in php serialized data format.
2773      * File manager needs to know the original file information before copying
2774      * to draft area, so we append these information in mdl_files.source field
2775      *
2776      * @param string $source
2777      * @return string serialised source field
2778      */
2779     public static function build_source_field($source) {
2780         $sourcefield = new stdClass;
2781         $sourcefield->source = $source;
2782         return serialize($sourcefield);
2783     }
2785     /**
2786      * Prepares the repository to be cached. Implements method from cacheable_object interface.
2787      *
2788      * @return array
2789      */
2790     public function prepare_to_cache() {
2791         return array(
2792             'class' => get_class($this),
2793             'id' => $this->id,
2794             'ctxid' => $this->context->id,
2795             'options' => $this->options,
2796             'readonly' => $this->readonly
2797         );
2798     }
2800     /**
2801      * Restores the repository from cache. Implements method from cacheable_object interface.
2802      *
2803      * @return array
2804      */
2805     public static function wake_from_cache($data) {
2806         $classname = $data['class'];
2807         return new $classname($data['id'], $data['ctxid'], $data['options'], $data['readonly']);
2808     }
2810     /**
2811      * Gets a file relative to this file in the repository and sends it to the browser.
2812      * Used to allow relative file linking within a repository without creating file records
2813      * for linked files
2814      *
2815      * Repositories that overwrite this must be very careful - see filesystem repository for example.
2816      *
2817      * @param stored_file $mainfile The main file we are trying to access relative files for.
2818      * @param string $relativepath the relative path to the file we are trying to access.
2819      *
2820      */
2821     public function send_relative_file(stored_file $mainfile, $relativepath) {
2822         // This repository hasn't implemented this so send_file_not_found.
2823         send_file_not_found();
2824     }
2826     /**
2827      * helper function to check if the repository supports send_relative_file.
2828      *
2829      * @return true|false
2830      */
2831     public function supports_relative_file() {
2832         return false;
2833     }
2835     /**
2836      * Helper function to indicate if this repository uses post requests for uploading files.
2837      *
2838      * @deprecated since Moodle 3.2, 3.1.1, 3.0.5
2839      * @return bool
2840      */
2841     public function uses_post_requests() {
2842         debugging('The method repository::uses_post_requests() is deprecated and must not be used anymore.', DEBUG_DEVELOPER);
2843         return false;
2844     }
2846     /**
2847      * Generate a secret key to be used for passing sensitive information around.
2848      *
2849      * @return string repository secret key.
2850      */
2851     final static public function get_secret_key() {
2852         global $CFG;
2854         if (!isset($CFG->reposecretkey)) {
2855             set_config('reposecretkey', time() . random_string(32));
2856         }
2857         return $CFG->reposecretkey;
2858     }
2861 /**
2862  * Exception class for repository api
2863  *
2864  * @since Moodle 2.0
2865  * @package   core_repository
2866  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2867  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2868  */
2869 class repository_exception extends moodle_exception {
2872 /**
2873  * This is a class used to define a repository instance form
2874  *
2875  * @since Moodle 2.0
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
2879  */
2880 final class repository_instance_form extends moodleform {
2881     /** @var stdClass repository instance */
2882     protected $instance;
2883     /** @var string repository plugin type */
2884     protected $plugin;
2886     /**
2887      * Added defaults to moodle form
2888      */
2889     protected function add_defaults() {
2890         $mform =& $this->_form;
2891         $strrequired = get_string('required');
2893         $mform->addElement('hidden', 'edit',  ($this->instance) ? $this->instance->id : 0);
2894         $mform->setType('edit', PARAM_INT);
2895         $mform->addElement('hidden', 'new',   $this->plugin);
2896         $mform->setType('new', PARAM_ALPHANUMEXT);
2897         $mform->addElement('hidden', 'plugin', $this->plugin);
2898         $mform->setType('plugin', PARAM_PLUGIN);
2899         $mform->addElement('hidden', 'typeid', $this->typeid);
2900         $mform->setType('typeid', PARAM_INT);
2901         $mform->addElement('hidden', 'contextid', $this->contextid);
2902         $mform->setType('contextid', PARAM_INT);
2904         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
2905         $mform->addRule('name', $strrequired, 'required', null, 'client');
2906         $mform->setType('name', PARAM_TEXT);
2907     }
2909     /**
2910      * Define moodle form elements
2911      */
2912     public function definition() {
2913         global $CFG;
2914         // type of plugin, string
2915         $this->plugin = $this->_customdata['plugin'];
2916         $this->typeid = $this->_customdata['typeid'];
2917         $this->contextid = $this->_customdata['contextid'];
2918         $this->instance = (isset($this->_customdata['instance'])
2919                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2920             ? $this->_customdata['instance'] : null;
2922         $mform =& $this->_form;
2924         $this->add_defaults();
2926         // Add instance config options.
2927         $result = repository::static_function($this->plugin, 'instance_config_form', $mform);
2928         if ($result === false) {
2929             // Remove the name element if no other config options.
2930             $mform->removeElement('name');
2931         }
2932         if ($this->instance) {
2933             $data = array();
2934             $data['name'] = $this->instance->name;
2935             if (!$this->instance->readonly) {
2936                 // and set the data if we have some.
2937                 foreach ($this->instance->get_instance_option_names() as $config) {
2938                     if (!empty($this->instance->options[$config])) {
2939                         $data[$config] = $this->instance->options[$config];
2940                      } else {
2941                         $data[$config] = '';
2942                      }
2943                 }
2944             }
2945             $this->set_data($data);
2946         }
2948         if ($result === false) {
2949             $mform->addElement('cancel');
2950         } else {
2951             $this->add_action_buttons(true, get_string('save','repository'));
2952         }
2953     }
2955     /**
2956      * Validate moodle form data
2957      *
2958      * @param array $data form data
2959      * @param array $files files in form
2960      * @return array errors
2961      */
2962     public function validation($data, $files) {
2963         global $DB;
2964         $errors = array();
2965         $plugin = $this->_customdata['plugin'];
2966         $instance = (isset($this->_customdata['instance'])
2967                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2968             ? $this->_customdata['instance'] : null;
2970         if (!$instance) {
2971             $errors = repository::static_function($plugin, 'instance_form_validation', $this, $data, $errors);
2972         } else {
2973             $errors = $instance->instance_form_validation($this, $data, $errors);
2974         }
2976         $sql = "SELECT count('x')
2977                   FROM {repository_instances} i, {repository} r
2978                  WHERE r.type=:plugin AND r.id=i.typeid AND i.name=:name AND i.contextid=:contextid";
2979         $params = array('name' => $data['name'], 'plugin' => $this->plugin, 'contextid' => $this->contextid);
2980         if ($instance) {
2981             $sql .= ' AND i.id != :instanceid';
2982             $params['instanceid'] = $instance->id;
2983         }
2984         if ($DB->count_records_sql($sql, $params) > 0) {
2985             $errors['name'] = get_string('erroruniquename', 'repository');
2986         }
2988         return $errors;
2989     }
2992 /**
2993  * This is a class used to define a repository type setting form
2994  *
2995  * @since Moodle 2.0
2996  * @package   core_repository
2997  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2998  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2999  */
3000 final class repository_type_form extends moodleform {
3001     /** @var stdClass repository instance */
3002     protected $instance;
3003     /** @var string repository plugin name */
3004     protected $plugin;
3005     /** @var string action */
3006     protected $action;
3008     /**
3009      * Definition of the moodleform
3010      */
3011     public function definition() {
3012         global $CFG;
3013         // type of plugin, string
3014         $this->plugin = $this->_customdata['plugin'];
3015         $this->instance = (isset($this->_customdata['instance'])
3016                 && is_a($this->_customdata['instance'], 'repository_type'))
3017             ? $this->_customdata['instance'] : null;
3019         $this->action = $this->_customdata['action'];
3020         $this->pluginname = $this->_customdata['pluginname'];
3021         $mform =& $this->_form;
3022         $strrequired = get_string('required');
3024         $mform->addElement('hidden', 'action', $this->action);
3025         $mform->setType('action', PARAM_TEXT);
3026         $mform->addElement('hidden', 'repos', $this->plugin);
3027         $mform->setType('repos', PARAM_PLUGIN);
3029         // let the plugin add its specific fields
3030         $classname = 'repository_' . $this->plugin;
3031         require_once($CFG->dirroot . '/repository/' . $this->plugin . '/lib.php');
3032         //add "enable course/user instances" checkboxes if multiple instances are allowed
3033         $instanceoptionnames = repository::static_function($this->plugin, 'get_instance_option_names');
3035         $result = call_user_func(array($classname, 'type_config_form'), $mform, $classname);
3037         if (!empty($instanceoptionnames)) {
3038             $sm = get_string_manager();
3039             $component = 'repository';
3040             if ($sm->string_exists('enablecourseinstances', 'repository_' . $this->plugin)) {
3041                 $component .= ('_' . $this->plugin);
3042             }
3043             $mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', $component));
3044             $mform->setType('enablecourseinstances', PARAM_BOOL);
3046             $component = 'repository';
3047             if ($sm->string_exists('enableuserinstances', 'repository_' . $this->plugin)) {
3048                 $component .= ('_' . $this->plugin);
3049             }
3050             $mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', $component));
3051             $mform->setType('enableuserinstances', PARAM_BOOL);
3052         }
3054         // set the data if we have some.
3055         if ($this->instance) {
3056             $data = array();
3057             $option_names = call_user_func(array($classname,'get_type_option_names'));
3058             if (!empty($instanceoptionnames)){
3059                 $option_names[] = 'enablecourseinstances';
3060                 $option_names[] = 'enableuserinstances';
3061             }
3063             $instanceoptions = $this->instance->get_options();
3064             foreach ($option_names as $config) {
3065                 if (!empty($instanceoptions[$config])) {
3066                     $data[$config] = $instanceoptions[$config];
3067                 } else {
3068                     $data[$config] = '';
3069                 }
3070             }
3071             // XXX: set plugin name for plugins which doesn't have muliti instances
3072             if (empty($instanceoptionnames)){
3073                 $data['pluginname'] = $this->pluginname;
3074             }
3075             $this->set_data($data);
3076         }
3078         $this->add_action_buttons(true, get_string('save','repository'));
3079     }
3081     /**
3082      * Validate moodle form data
3083      *
3084      * @param array $data moodle form data
3085      * @param array $files
3086      * @return array errors
3087      */
3088     public function validation($data, $files) {
3089         $errors = array();
3090         $plugin = $this->_customdata['plugin'];
3091         $instance = (isset($this->_customdata['instance'])
3092                 && is_subclass_of($this->_customdata['instance'], 'repository'))
3093             ? $this->_customdata['instance'] : null;
3094         if (!$instance) {
3095             $errors = repository::static_function($plugin, 'type_form_validation', $this, $data, $errors);
3096         } else {
3097             $errors = $instance->type_form_validation($this, $data, $errors);
3098         }
3100         return $errors;
3101     }
3104 /**
3105  * Generate all options needed by filepicker
3106  *
3107  * @param array $args including following keys
3108  *          context
3109  *          accepted_types
3110  *          return_types
3111  *
3112  * @return array the list of repository instances, including meta infomation, containing the following keys
3113  *          externallink
3114  *          repositories
3115  *          accepted_types
3116  */
3117 function initialise_filepicker($args) {
3118     global $CFG, $USER, $PAGE, $OUTPUT;
3119     static $templatesinitialized = array();
3120     require_once($CFG->libdir . '/licenselib.php');
3122     $return = new stdClass();
3123     $licenses = array();
3124     if (!empty($CFG->licenses)) {
3125         $array = explode(',', $CFG->licenses);
3126         foreach ($array as $license) {
3127             $l = new stdClass();
3128             $l->shortname = $license;
3129             $l->fullname = get_string($license, 'license');
3130             $licenses[] = $l;
3131         }
3132     }
3133     if (!empty($CFG->sitedefaultlicense)) {
3134         $return->defaultlicense = $CFG->sitedefaultlicense;
3135     }
3137     $return->licenses = $licenses;
3139     $return->author = fullname($USER);
3141     if (empty($args->context)) {
3142         $context = $PAGE->context;
3143     } else {
3144         $context = $args->context;
3145     }
3146     $disable_types = array();
3147     if (!empty($args->disable_types)) {
3148         $disable_types = $args->disable_types;
3149     }
3151     $user_context = context_user::instance($USER->id);
3153     list($context, $course, $cm) = get_context_info_array($context->id);
3154     $contexts = array($user_context, context_system::instance());
3155     if (!empty($course)) {
3156         // adding course context
3157         $contexts[] = context_course::instance($course->id);
3158     }
3159     $externallink = (int)get_config(null, 'repositoryallowexternallinks');
3160     $repositories = repository::get_instances(array(
3161         'context'=>$contexts,
3162         'currentcontext'=> $context,
3163         'accepted_types'=>$args->accepted_types,
3164         'return_types'=>$args->return_types,
3165         'disable_types'=>$disable_types
3166     ));
3168     $return->repositories = array();
3170     if (empty($externallink)) {
3171         $return->externallink = false;
3172     } else {
3173         $return->externallink = true;
3174     }
3176     $return->userprefs = array();
3177     $return->userprefs['recentrepository'] = get_user_preferences('filepicker_recentrepository', '');
3178     $return->userprefs['recentlicense'] = get_user_preferences('filepicker_recentlicense', '');
3179     $return->userprefs['recentviewmode'] = get_user_preferences('filepicker_recentviewmode', '');
3181     user_preference_allow_ajax_update('filepicker_recentrepository', PARAM_INT);
3182     user_preference_allow_ajax_update('filepicker_recentlicense', PARAM_SAFEDIR);
3183     user_preference_allow_ajax_update('filepicker_recentviewmode', PARAM_INT);
3186     // provided by form element
3187     $return->accepted_types = file_get_typegroup('extension', $args->accepted_types);
3188     $return->return_types = $args->return_types;
3189     $templates = array();
3190     foreach ($repositories as $repository) {
3191         $meta = $repository->get_meta();
3192         // Please note that the array keys for repositories are used within
3193         // JavaScript a lot, the key NEEDS to be the repository id.
3194         $return->repositories[$repository->id] = $meta;
3195         // Register custom repository template if it has one
3196         if(method_exists($repository, 'get_upload_template') && !array_key_exists('uploadform_' . $meta->type, $templatesinitialized)) {
3197             $templates['uploadform_' . $meta->type] = $repository->get_upload_template();
3198             $templatesinitialized['uploadform_' . $meta->type] = true;
3199         }
3200     }
3201     if (!array_key_exists('core', $templatesinitialized)) {
3202         // we need to send each filepicker template to the browser just once
3203         $fprenderer = $PAGE->get_renderer('core', 'files');
3204         $templates = array_merge($templates, $fprenderer->filepicker_js_templates());
3205         $templatesinitialized['core'] = true;
3206     }
3207     if (sizeof($templates)) {
3208         $PAGE->requires->js_init_call('M.core_filepicker.set_templates', array($templates), true);
3209     }
3210     return $return;
3213 /**
3214  * Convenience function to handle deletion of files.
3215  *
3216  * @param object $context The context where the delete is called
3217  * @param string $component component
3218  * @param string $filearea filearea
3219  * @param int $itemid the item id
3220  * @param array $files Array of files object with each item having filename/filepath as values
3221  * @return array $return Array of strings matching up to the parent directory of the deleted files
3222  * @throws coding_exception
3223  */
3224 function repository_delete_selected_files($context, string $component, string $filearea, $itemid, array $files) {
3225     $fs = get_file_storage();
3226     $return = [];
3228     foreach ($files as $selectedfile) {
3229         $filename = clean_filename($selectedfile->filename);
3230         $filepath = clean_param($selectedfile->filepath, PARAM_PATH);
3231         $filepath = file_correct_filepath($filepath);
3233         if ($storedfile = $fs->get_file($context->id, $component, $filearea, $itemid, $filepath, $filename)) {
3234             $parentpath = $storedfile->get_parent_directory()->get_filepath();
3235             if ($storedfile->is_directory()) {
3236                 $files = $fs->get_directory_files($context->id, $component, $filearea, $itemid, $filepath, true);
3237                 foreach ($files as $file) {
3238                     $file->delete();
3239                 }
3240                 $storedfile->delete();
3241                 $return[$parentpath] = "";
3242             } else {
3243                 if ($result = $storedfile->delete()) {
3244                     $return[$parentpath] = "";
3245                 }
3246             }
3247         }
3248     }
3250     return $return;
3253 /**
3254  * Convenience function to handle deletion of files.
3255  *
3256  * @param object $context The context where the delete is called
3257  * @param string $component component
3258  * @param string $filearea filearea
3259  * @param int $itemid the item id
3260  * @param array $files Array of files object with each item having filename/filepath as values
3261  * @return array $return Array of strings matching up to the parent directory of the deleted files
3262  * @throws coding_exception
3263  */
3264 function repository_download_selected_files($context, string $component, string $filearea, $itemid, array $files) {
3265     global $USER;
3266     $return = false;
3268     $zipper = get_file_packer('application/zip');
3269     $fs = get_file_storage();
3270     // Archive compressed file to an unused draft area.
3271     $newdraftitemid = file_get_unused_draft_itemid();
3272     $filestoarchive = [];
3274     foreach ($files as $selectedfile) {
3275         $filename = $selectedfile->filename ? clean_filename($selectedfile->filename) : '.'; // Default to '.' for root.
3276         $filepath = clean_param($selectedfile->filepath, PARAM_PATH); // Default to '/' for downloadall.
3277         $filepath = file_correct_filepath($filepath);
3278         $area = file_get_draft_area_info($itemid, $filepath);
3279         if ($area['filecount'] == 0 && $area['foldercount'] == 0) {
3280             continue;
3281         }
3283         $storedfile = $fs->get_file($context->id, $component, $filearea, $itemid, $filepath, $filename);
3284         // If it is empty we are downloading a directory.
3285         $archivefile = $storedfile->get_filename();
3286         if (!$filename || $filename == '.' ) {
3287             $foldername = explode('/', trim($filepath, '/'));
3288             $folder = trim(array_pop($foldername), '/');
3289             $archivefile = $folder ?? '/';
3290         }
3292         $filestoarchive[$archivefile] = $storedfile;
3293     }
3294     $zippedfile = get_string('files') . '.zip';
3295     if ($newfile =
3296         $zipper->archive_to_storage(
3297             $filestoarchive,
3298             $context->id,
3299             $component,
3300             $filearea,
3301             $newdraftitemid,
3302             "/",
3303             $zippedfile, $USER->id)
3304     ) {
3305         $return = new stdClass();
3306         $return->fileurl = moodle_url::make_draftfile_url($newdraftitemid, '/', $zippedfile)->out();
3307         $return->filepath = $filepath;
3308     }
3310     return $return;