Merge branch 'MDL-38766/master' of github.com:kemitix/moodle
[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 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('RENAME_SUFFIX', '_2');
35 /**
36  * This class is used to manage repository plugins
37  *
38  * A repository_type is a repository plug-in. It can be Box.net, Flick-r, ...
39  * A repository type can be edited, sorted and hidden. It is mandatory for an
40  * administrator to create a repository type in order to be able to create
41  * some instances of this type.
42  * Coding note:
43  * - a repository_type object is mapped to the "repository" database table
44  * - "typename" attibut maps the "type" database field. It is unique.
45  * - general "options" for a repository type are saved in the config_plugin table
46  * - when you delete a repository, all instances are deleted, and general
47  *   options are also deleted from database
48  * - When you create a type for a plugin that can't have multiple instances, a
49  *   instance is automatically created.
50  *
51  * @package   core_repository
52  * @copyright 2009 Jerome Mouneyrac
53  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
54  */
55 class repository_type {
58     /**
59      * Type name (no whitespace) - A type name is unique
60      * Note: for a user-friendly type name see get_readablename()
61      * @var String
62      */
63     private $_typename;
66     /**
67      * Options of this type
68      * They are general options that any instance of this type would share
69      * e.g. API key
70      * These options are saved in config_plugin table
71      * @var array
72      */
73     private $_options;
76     /**
77      * Is the repository type visible or hidden
78      * If false (hidden): no instances can be created, edited, deleted, showned , used...
79      * @var boolean
80      */
81     private $_visible;
84     /**
85      * 0 => not ordered, 1 => first position, 2 => second position...
86      * A not order type would appear in first position (should never happened)
87      * @var integer
88      */
89     private $_sortorder;
91     /**
92      * Return if the instance is visible in a context
93      *
94      * @todo check if the context visibility has been overwritten by the plugin creator
95      *       (need to create special functions to be overvwritten in repository class)
96      * @param stdClass $context context
97      * @return bool
98      */
99     public function get_contextvisibility($context) {
100         global $USER;
102         if ($context->contextlevel == CONTEXT_COURSE) {
103             return $this->_options['enablecourseinstances'];
104         }
106         if ($context->contextlevel == CONTEXT_USER) {
107             return $this->_options['enableuserinstances'];
108         }
110         //the context is SITE
111         return true;
112     }
116     /**
117      * repository_type constructor
118      *
119      * @param int $typename
120      * @param array $typeoptions
121      * @param bool $visible
122      * @param int $sortorder (don't really need set, it will be during create() call)
123      */
124     public function __construct($typename = '', $typeoptions = array(), $visible = true, $sortorder = 0) {
125         global $CFG;
127         //set type attributs
128         $this->_typename = $typename;
129         $this->_visible = $visible;
130         $this->_sortorder = $sortorder;
132         //set options attribut
133         $this->_options = array();
134         $options = repository::static_function($typename, 'get_type_option_names');
135         //check that the type can be setup
136         if (!empty($options)) {
137             //set the type options
138             foreach ($options as $config) {
139                 if (array_key_exists($config, $typeoptions)) {
140                     $this->_options[$config] = $typeoptions[$config];
141                 }
142             }
143         }
145         //retrieve visibility from option
146         if (array_key_exists('enablecourseinstances',$typeoptions)) {
147             $this->_options['enablecourseinstances'] = $typeoptions['enablecourseinstances'];
148         } else {
149              $this->_options['enablecourseinstances'] = 0;
150         }
152         if (array_key_exists('enableuserinstances',$typeoptions)) {
153             $this->_options['enableuserinstances'] = $typeoptions['enableuserinstances'];
154         } else {
155              $this->_options['enableuserinstances'] = 0;
156         }
158     }
160     /**
161      * Get the type name (no whitespace)
162      * For a human readable name, use get_readablename()
163      *
164      * @return string the type name
165      */
166     public function get_typename() {
167         return $this->_typename;
168     }
170     /**
171      * Return a human readable and user-friendly type name
172      *
173      * @return string user-friendly type name
174      */
175     public function get_readablename() {
176         return get_string('pluginname','repository_'.$this->_typename);
177     }
179     /**
180      * Return general options
181      *
182      * @return array the general options
183      */
184     public function get_options() {
185         return $this->_options;
186     }
188     /**
189      * Return visibility
190      *
191      * @return bool
192      */
193     public function get_visible() {
194         return $this->_visible;
195     }
197     /**
198      * Return order / position of display in the file picker
199      *
200      * @return int
201      */
202     public function get_sortorder() {
203         return $this->_sortorder;
204     }
206     /**
207      * Create a repository type (the type name must not already exist)
208      * @param bool $silent throw exception?
209      * @return mixed return int if create successfully, return false if
210      */
211     public function create($silent = false) {
212         global $DB;
214         //check that $type has been set
215         $timmedtype = trim($this->_typename);
216         if (empty($timmedtype)) {
217             throw new repository_exception('emptytype', 'repository');
218         }
220         //set sortorder as the last position in the list
221         if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
222             $sql = "SELECT MAX(sortorder) FROM {repository}";
223             $this->_sortorder = 1 + $DB->get_field_sql($sql);
224         }
226         //only create a new type if it doesn't already exist
227         $existingtype = $DB->get_record('repository', array('type'=>$this->_typename));
228         if (!$existingtype) {
229             //create the type
230             $newtype = new stdClass();
231             $newtype->type = $this->_typename;
232             $newtype->visible = $this->_visible;
233             $newtype->sortorder = $this->_sortorder;
234             $plugin_id = $DB->insert_record('repository', $newtype);
235             //save the options in DB
236             $this->update_options();
238             $instanceoptionnames = repository::static_function($this->_typename, 'get_instance_option_names');
240             //if the plugin type has no multiple instance (e.g. has no instance option name) so it wont
241             //be possible for the administrator to create a instance
242             //in this case we need to create an instance
243             if (empty($instanceoptionnames)) {
244                 $instanceoptions = array();
245                 if (empty($this->_options['pluginname'])) {
246                     // when moodle trying to install some repo plugin automatically
247                     // this option will be empty, get it from language string when display
248                     $instanceoptions['name'] = '';
249                 } else {
250                     // when admin trying to add a plugin manually, he will type a name
251                     // for it
252                     $instanceoptions['name'] = $this->_options['pluginname'];
253                 }
254                 repository::static_function($this->_typename, 'create', $this->_typename, 0, get_system_context(), $instanceoptions);
255             }
256             //run plugin_init function
257             if (!repository::static_function($this->_typename, 'plugin_init')) {
258                 if (!$silent) {
259                     throw new repository_exception('cannotinitplugin', 'repository');
260                 }
261             }
263             if(!empty($plugin_id)) {
264                 // return plugin_id if create successfully
265                 return $plugin_id;
266             } else {
267                 return false;
268             }
270         } else {
271             if (!$silent) {
272                 throw new repository_exception('existingrepository', 'repository');
273             }
274             // If plugin existed, return false, tell caller no new plugins were created.
275             return false;
276         }
277     }
280     /**
281      * Update plugin options into the config_plugin table
282      *
283      * @param array $options
284      * @return bool
285      */
286     public function update_options($options = null) {
287         global $DB;
288         $classname = 'repository_' . $this->_typename;
289         $instanceoptions = repository::static_function($this->_typename, 'get_instance_option_names');
290         if (empty($instanceoptions)) {
291             // update repository instance name if this plugin type doesn't have muliti instances
292             $params = array();
293             $params['type'] = $this->_typename;
294             $instances = repository::get_instances($params);
295             $instance = array_pop($instances);
296             if ($instance) {
297                 $DB->set_field('repository_instances', 'name', $options['pluginname'], array('id'=>$instance->id));
298             }
299             unset($options['pluginname']);
300         }
302         if (!empty($options)) {
303             $this->_options = $options;
304         }
306         foreach ($this->_options as $name => $value) {
307             set_config($name, $value, $this->_typename);
308         }
310         return true;
311     }
313     /**
314      * Update visible database field with the value given as parameter
315      * or with the visible value of this object
316      * This function is private.
317      * For public access, have a look to switch_and_update_visibility()
318      *
319      * @param bool $visible
320      * @return bool
321      */
322     private function update_visible($visible = null) {
323         global $DB;
325         if (!empty($visible)) {
326             $this->_visible = $visible;
327         }
328         else if (!isset($this->_visible)) {
329             throw new repository_exception('updateemptyvisible', 'repository');
330         }
332         return $DB->set_field('repository', 'visible', $this->_visible, array('type'=>$this->_typename));
333     }
335     /**
336      * Update database sortorder field with the value given as parameter
337      * or with the sortorder value of this object
338      * This function is private.
339      * For public access, have a look to move_order()
340      *
341      * @param int $sortorder
342      * @return bool
343      */
344     private function update_sortorder($sortorder = null) {
345         global $DB;
347         if (!empty($sortorder) && $sortorder!=0) {
348             $this->_sortorder = $sortorder;
349         }
350         //if sortorder is not set, we set it as the ;ast position in the list
351         else if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
352             $sql = "SELECT MAX(sortorder) FROM {repository}";
353             $this->_sortorder = 1 + $DB->get_field_sql($sql);
354         }
356         return $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$this->_typename));
357     }
359     /**
360      * Change order of the type with its adjacent upper or downer type
361      * (database fields are updated)
362      * Algorithm details:
363      * 1. retrieve all types in an array. This array is sorted by sortorder,
364      * and the array keys start from 0 to X (incremented by 1)
365      * 2. switch sortorder values of this type and its adjacent type
366      *
367      * @param string $move "up" or "down"
368      */
369     public function move_order($move) {
370         global $DB;
372         $types = repository::get_types();    // retrieve all types
374         // retrieve this type into the returned array
375         $i = 0;
376         while (!isset($indice) && $i<count($types)) {
377             if ($types[$i]->get_typename() == $this->_typename) {
378                 $indice = $i;
379             }
380             $i++;
381         }
383         // retrieve adjacent indice
384         switch ($move) {
385             case "up":
386                 $adjacentindice = $indice - 1;
387             break;
388             case "down":
389                 $adjacentindice = $indice + 1;
390             break;
391             default:
392             throw new repository_exception('movenotdefined', 'repository');
393         }
395         //switch sortorder of this type and the adjacent type
396         //TODO: we could reset sortorder for all types. This is not as good in performance term, but
397         //that prevent from wrong behaviour on a screwed database. As performance are not important in this particular case
398         //it worth to change the algo.
399         if ($adjacentindice>=0 && !empty($types[$adjacentindice])) {
400             $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$types[$adjacentindice]->get_typename()));
401             $this->update_sortorder($types[$adjacentindice]->get_sortorder());
402         }
403     }
405     /**
406      * 1. Change visibility to the value chosen
407      * 2. Update the type
408      *
409      * @param bool $visible
410      * @return bool
411      */
412     public function update_visibility($visible = null) {
413         if (is_bool($visible)) {
414             $this->_visible = $visible;
415         } else {
416             $this->_visible = !$this->_visible;
417         }
418         return $this->update_visible();
419     }
422     /**
423      * Delete a repository_type (general options are removed from config_plugin
424      * table, and all instances are deleted)
425      *
426      * @param bool $downloadcontents download external contents if exist
427      * @return bool
428      */
429     public function delete($downloadcontents = false) {
430         global $DB;
432         //delete all instances of this type
433         $params = array();
434         $params['context'] = array();
435         $params['onlyvisible'] = false;
436         $params['type'] = $this->_typename;
437         $instances = repository::get_instances($params);
438         foreach ($instances as $instance) {
439             $instance->delete($downloadcontents);
440         }
442         //delete all general options
443         foreach ($this->_options as $name => $value) {
444             set_config($name, null, $this->_typename);
445         }
447         try {
448             $DB->delete_records('repository', array('type' => $this->_typename));
449         } catch (dml_exception $ex) {
450             return false;
451         }
452         return true;
453     }
456 /**
457  * This is the base class of the repository class.
458  *
459  * To create repository plugin, see: {@link http://docs.moodle.org/dev/Repository_plugins}
460  * See an example: {@link repository_boxnet}
461  *
462  * @package   core_repository
463  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
464  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
465  */
466 abstract class repository {
467     /** Timeout in seconds for downloading the external file into moodle */
468     const GETFILE_TIMEOUT = 30;
469     /** Timeout in seconds for syncronising the external file size */
470     const SYNCFILE_TIMEOUT = 1;
471     /** Timeout in seconds for downloading an image file from external repository during syncronisation */
472     const SYNCIMAGE_TIMEOUT = 3;
474     // $disabled can be set to true to disable a plugin by force
475     // example: self::$disabled = true
476     /** @var bool force disable repository instance */
477     public $disabled = false;
478     /** @var int repository instance id */
479     public $id;
480     /** @var stdClass current context */
481     public $context;
482     /** @var array repository options */
483     public $options;
484     /** @var bool Whether or not the repository instance is editable */
485     public $readonly;
486     /** @var int return types */
487     public $returntypes;
488     /** @var stdClass repository instance database record */
489     public $instance;
490     /** @var string Type of repository (webdav, google_docs, dropbox, ...). Read from $this->get_typename(). */
491     protected $typename;
493     /**
494      * Constructor
495      *
496      * @param int $repositoryid repository instance id
497      * @param int|stdClass $context a context id or context object
498      * @param array $options repository options
499      * @param int $readonly indicate this repo is readonly or not
500      */
501     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array(), $readonly = 0) {
502         global $DB;
503         $this->id = $repositoryid;
504         if (is_object($context)) {
505             $this->context = $context;
506         } else {
507             $this->context = context::instance_by_id($context);
508         }
509         $this->instance = $DB->get_record('repository_instances', array('id'=>$this->id));
510         $this->readonly = $readonly;
511         $this->options = array();
513         if (is_array($options)) {
514             // The get_option() method will get stored options in database.
515             $options = array_merge($this->get_option(), $options);
516         } else {
517             $options = $this->get_option();
518         }
519         foreach ($options as $n => $v) {
520             $this->options[$n] = $v;
521         }
522         $this->name = $this->get_name();
523         $this->returntypes = $this->supported_returntypes();
524         $this->super_called = true;
525     }
527     /**
528      * Get repository instance using repository id
529      *
530      * @param int $repositoryid repository ID
531      * @param stdClass|int $context context instance or context ID
532      * @param array $options additional repository options
533      * @return repository
534      */
535     public static function get_repository_by_id($repositoryid, $context, $options = array()) {
536         global $CFG, $DB;
538         $sql = 'SELECT i.name, i.typeid, r.type FROM {repository} r, {repository_instances} i WHERE i.id=? AND i.typeid=r.id';
540         if (!$record = $DB->get_record_sql($sql, array($repositoryid))) {
541             throw new repository_exception('invalidrepositoryid', 'repository');
542         } else {
543             $type = $record->type;
544             if (file_exists($CFG->dirroot . "/repository/$type/lib.php")) {
545                 require_once($CFG->dirroot . "/repository/$type/lib.php");
546                 $classname = 'repository_' . $type;
547                 $contextid = $context;
548                 if (is_object($context)) {
549                     $contextid = $context->id;
550                 }
551                 $options['type'] = $type;
552                 $options['typeid'] = $record->typeid;
553                 if (empty($options['name'])) {
554                     $options['name'] = $record->name;
555                 }
556                 $repository = new $classname($repositoryid, $contextid, $options);
557                 return $repository;
558             } else {
559                 throw new repository_exception('invalidplugin', 'repository');
560             }
561         }
562     }
564     /**
565      * Returns the type name of the repository.
566      *
567      * @return string type name of the repository.
568      * @since  2.5
569      */
570     public function get_typename() {
571         if (empty($this->typename)) {
572             $matches = array();
573             if (!preg_match("/^repository_(.*)$/", get_class($this), $matches)) {
574                 throw new coding_exception('The class name of a repository should be repository_<typeofrepository>, '.
575                         'e.g. repository_dropbox');
576             }
577             $this->typename = $matches[1];
578         }
579         return $this->typename;
580     }
582     /**
583      * Get a repository type object by a given type name.
584      *
585      * @static
586      * @param string $typename the repository type name
587      * @return repository_type|bool
588      */
589     public static function get_type_by_typename($typename) {
590         global $DB;
592         if (!$record = $DB->get_record('repository',array('type' => $typename))) {
593             return false;
594         }
596         return new repository_type($typename, (array)get_config($typename), $record->visible, $record->sortorder);
597     }
599     /**
600      * Get the repository type by a given repository type id.
601      *
602      * @static
603      * @param int $id the type id
604      * @return object
605      */
606     public static function get_type_by_id($id) {
607         global $DB;
609         if (!$record = $DB->get_record('repository',array('id' => $id))) {
610             return false;
611         }
613         return new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
614     }
616     /**
617      * Return all repository types ordered by sortorder field
618      * first repository type in returnedarray[0], second repository type in returnedarray[1], ...
619      *
620      * @static
621      * @param bool $visible can return types by visiblity, return all types if null
622      * @return array Repository types
623      */
624     public static function get_types($visible=null) {
625         global $DB, $CFG;
627         $types = array();
628         $params = null;
629         if (!empty($visible)) {
630             $params = array('visible' => $visible);
631         }
632         if ($records = $DB->get_records('repository',$params,'sortorder')) {
633             foreach($records as $type) {
634                 if (file_exists($CFG->dirroot . '/repository/'. $type->type .'/lib.php')) {
635                     $types[] = new repository_type($type->type, (array)get_config($type->type), $type->visible, $type->sortorder);
636                 }
637             }
638         }
640         return $types;
641     }
643     /**
644      * Checks if user has a capability to view the current repository.
645      *
646      * @return bool true when the user can, otherwise throws an exception.
647      * @throws repository_exception when the user does not meet the requirements.
648      */
649     public final function check_capability() {
650         global $USER;
652         // The context we are on.
653         $currentcontext = $this->context;
655         // Ensure that the user can view the repository in the current context.
656         $can = has_capability('repository/'.$this->get_typename().':view', $currentcontext);
658         // Context in which the repository has been created.
659         $repocontext = context::instance_by_id($this->instance->contextid);
661         // Prevent access to private repositories when logged in as.
662         if ($can && session_is_loggedinas()) {
663             if ($this->contains_private_data() || $repocontext->contextlevel == CONTEXT_USER) {
664                 $can = false;
665             }
666         }
668         // We are going to ensure that the current context was legit, and reliable to check
669         // the capability against. (No need to do that if we already cannot).
670         if ($can) {
671             if ($repocontext->contextlevel == CONTEXT_USER) {
672                 // The repository is a user instance, ensure we're the right user to access it!
673                 if ($repocontext->instanceid != $USER->id) {
674                     $can = false;
675                 }
676             } else if ($repocontext->contextlevel == CONTEXT_COURSE) {
677                 // The repository is a course one. Let's check that we are on the right course.
678                 if (in_array($currentcontext->contextlevel, array(CONTEXT_COURSE, CONTEXT_MODULE, CONTEXT_BLOCK))) {
679                     $coursecontext = $currentcontext->get_course_context();
680                     if ($coursecontext->instanceid != $repocontext->instanceid) {
681                         $can = false;
682                     }
683                 } else {
684                     // We are on a parent context, therefore it's legit to check the permissions
685                     // in the current context.
686                 }
687             } else {
688                 // Nothing to check here, system instances can have different permissions on different
689                 // levels. We do not want to prevent URL hack here, because it does not make sense to
690                 // prevent a user to access a repository in a context if it's accessible in another one.
691             }
692         }
694         if ($can) {
695             return true;
696         }
698         throw new repository_exception('nopermissiontoaccess', 'repository');
699     }
701     /**
702      * Check if file already exists in draft area.
703      *
704      * @static
705      * @param int $itemid of the draft area.
706      * @param string $filepath path to the file.
707      * @param string $filename file name.
708      * @return bool
709      */
710     public static function draftfile_exists($itemid, $filepath, $filename) {
711         global $USER;
712         $fs = get_file_storage();
713         $usercontext = context_user::instance($USER->id);
714         return $fs->file_exists($usercontext->id, 'user', 'draft', $itemid, $filepath, $filename);
715     }
717     /**
718      * Parses the 'source' returned by moodle repositories and returns an instance of stored_file
719      *
720      * @param string $source
721      * @return stored_file|null
722      */
723     public static function get_moodle_file($source) {
724         $params = file_storage::unpack_reference($source, true);
725         $fs = get_file_storage();
726         return $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
727                     $params['itemid'], $params['filepath'], $params['filename']);
728     }
730     /**
731      * Repository method to make sure that user can access particular file.
732      *
733      * This is checked when user tries to pick the file from repository to deal with
734      * potential parameter substitutions is request
735      *
736      * @param string $source
737      * @return bool whether the file is accessible by current user
738      */
739     public function file_is_accessible($source) {
740         if ($this->has_moodle_files()) {
741             try {
742                 $params = file_storage::unpack_reference($source, true);
743             } catch (file_reference_exception $e) {
744                 return false;
745             }
746             $browser = get_file_browser();
747             $context = context::instance_by_id($params['contextid']);
748             $file_info = $browser->get_file_info($context, $params['component'], $params['filearea'],
749                     $params['itemid'], $params['filepath'], $params['filename']);
750             return !empty($file_info);
751         }
752         return true;
753     }
755     /**
756      * This function is used to copy a moodle file to draft area.
757      *
758      * It DOES NOT check if the user is allowed to access this file because the actual file
759      * can be located in the area where user does not have access to but there is an alias
760      * to this file in the area where user CAN access it.
761      * {@link file_is_accessible} should be called for alias location before calling this function.
762      *
763      * @param string $source The metainfo of file, it is base64 encoded php serialized data
764      * @param stdClass|array $filerecord contains itemid, filepath, filename and optionally other
765      *      attributes of the new file
766      * @param int $maxbytes maximum allowed size of file, -1 if unlimited. If size of file exceeds
767      *      the limit, the file_exception is thrown.
768      * @param int $areamaxbytes the maximum size of the area. A file_exception is thrown if the
769      *      new file will reach the limit.
770      * @return array The information about the created file
771      */
772     public function copy_to_area($source, $filerecord, $maxbytes = -1, $areamaxbytes = FILE_AREA_MAX_BYTES_UNLIMITED) {
773         global $USER;
774         $fs = get_file_storage();
776         if ($this->has_moodle_files() == false) {
777             throw new coding_exception('Only repository used to browse moodle files can use repository::copy_to_area()');
778         }
780         $user_context = context_user::instance($USER->id);
782         $filerecord = (array)$filerecord;
783         // make sure the new file will be created in user draft area
784         $filerecord['component'] = 'user';
785         $filerecord['filearea'] = 'draft';
786         $filerecord['contextid'] = $user_context->id;
787         $draftitemid = $filerecord['itemid'];
788         $new_filepath = $filerecord['filepath'];
789         $new_filename = $filerecord['filename'];
791         // the file needs to copied to draft area
792         $stored_file = self::get_moodle_file($source);
793         if ($maxbytes != -1 && $stored_file->get_filesize() > $maxbytes) {
794             throw new file_exception('maxbytes');
795         }
796         // Validate the size of the draft area.
797         if (file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $stored_file->get_filesize())) {
798             throw new file_exception('maxareabytes');
799         }
801         if (repository::draftfile_exists($draftitemid, $new_filepath, $new_filename)) {
802             // create new file
803             $unused_filename = repository::get_unused_filename($draftitemid, $new_filepath, $new_filename);
804             $filerecord['filename'] = $unused_filename;
805             $fs->create_file_from_storedfile($filerecord, $stored_file);
806             $event = array();
807             $event['event'] = 'fileexists';
808             $event['newfile'] = new stdClass;
809             $event['newfile']->filepath = $new_filepath;
810             $event['newfile']->filename = $unused_filename;
811             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $unused_filename)->out();
812             $event['existingfile'] = new stdClass;
813             $event['existingfile']->filepath = $new_filepath;
814             $event['existingfile']->filename = $new_filename;
815             $event['existingfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
816             return $event;
817         } else {
818             $fs->create_file_from_storedfile($filerecord, $stored_file);
819             $info = array();
820             $info['itemid'] = $draftitemid;
821             $info['file'] = $new_filename;
822             $info['title'] = $new_filename;
823             $info['contextid'] = $user_context->id;
824             $info['url'] = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
825             $info['filesize'] = $stored_file->get_filesize();
826             return $info;
827         }
828     }
830     /**
831      * Get an unused filename from the current draft area.
832      *
833      * Will check if the file ends with ([0-9]) and increase the number.
834      *
835      * @static
836      * @param int $itemid draft item ID.
837      * @param string $filepath path to the file.
838      * @param string $filename name of the file.
839      * @return string an unused file name.
840      */
841     public static function get_unused_filename($itemid, $filepath, $filename) {
842         global $USER;
843         $contextid = context_user::instance($USER->id)->id;
844         $fs = get_file_storage();
845         return $fs->get_unused_filename($contextid, 'user', 'draft', $itemid, $filepath, $filename);
846     }
848     /**
849      * Append a suffix to filename.
850      *
851      * @static
852      * @param string $filename
853      * @return string
854      * @deprecated since 2.5
855      */
856     public static function append_suffix($filename) {
857         debugging('The function repository::append_suffix() has been deprecated. Use repository::get_unused_filename() instead.',
858             DEBUG_DEVELOPER);
859         $pathinfo = pathinfo($filename);
860         if (empty($pathinfo['extension'])) {
861             return $filename . RENAME_SUFFIX;
862         } else {
863             return $pathinfo['filename'] . RENAME_SUFFIX . '.' . $pathinfo['extension'];
864         }
865     }
867     /**
868      * Return all types that you a user can create/edit and which are also visible
869      * Note: Mostly used in order to know if at least one editable type can be set
870      *
871      * @static
872      * @param stdClass $context the context for which we want the editable types
873      * @return array types
874      */
875     public static function get_editable_types($context = null) {
877         if (empty($context)) {
878             $context = get_system_context();
879         }
881         $types= repository::get_types(true);
882         $editabletypes = array();
883         foreach ($types as $type) {
884             $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
885             if (!empty($instanceoptionnames)) {
886                 if ($type->get_contextvisibility($context)) {
887                     $editabletypes[]=$type;
888                 }
889              }
890         }
891         return $editabletypes;
892     }
894     /**
895      * Return repository instances
896      *
897      * @static
898      * @param array $args Array containing the following keys:
899      *           currentcontext
900      *           context
901      *           onlyvisible
902      *           type
903      *           accepted_types
904      *           return_types
905      *           userid
906      *
907      * @return array repository instances
908      */
909     public static function get_instances($args = array()) {
910         global $DB, $CFG, $USER;
912         if (isset($args['currentcontext'])) {
913             $current_context = $args['currentcontext'];
914         } else {
915             $current_context = null;
916         }
918         if (!empty($args['context'])) {
919             $contexts = $args['context'];
920         } else {
921             $contexts = array();
922         }
924         $onlyvisible = isset($args['onlyvisible']) ? $args['onlyvisible'] : true;
925         $returntypes = isset($args['return_types']) ? $args['return_types'] : 3;
926         $type        = isset($args['type']) ? $args['type'] : null;
928         $params = array();
929         $sql = "SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
930                   FROM {repository} r, {repository_instances} i
931                  WHERE i.typeid = r.id ";
933         if (!empty($args['disable_types']) && is_array($args['disable_types'])) {
934             list($types, $p) = $DB->get_in_or_equal($args['disable_types'], SQL_PARAMS_QM, 'param', false);
935             $sql .= " AND r.type $types";
936             $params = array_merge($params, $p);
937         }
939         if (!empty($args['userid']) && is_numeric($args['userid'])) {
940             $sql .= " AND (i.userid = 0 or i.userid = ?)";
941             $params[] = $args['userid'];
942         }
944         foreach ($contexts as $context) {
945             if (empty($firstcontext)) {
946                 $firstcontext = true;
947                 $sql .= " AND ((i.contextid = ?)";
948             } else {
949                 $sql .= " OR (i.contextid = ?)";
950             }
951             $params[] = $context->id;
952         }
954         if (!empty($firstcontext)) {
955            $sql .=')';
956         }
958         if ($onlyvisible == true) {
959             $sql .= " AND (r.visible = 1)";
960         }
962         if (isset($type)) {
963             $sql .= " AND (r.type = ?)";
964             $params[] = $type;
965         }
966         $sql .= " ORDER BY r.sortorder, i.name";
968         if (!$records = $DB->get_records_sql($sql, $params)) {
969             $records = array();
970         }
972         $repositories = array();
973         if (isset($args['accepted_types'])) {
974             $accepted_types = $args['accepted_types'];
975             if (is_array($accepted_types) && in_array('*', $accepted_types)) {
976                 $accepted_types = '*';
977             }
978         } else {
979             $accepted_types = '*';
980         }
981         // Sortorder should be unique, which is not true if we use $record->sortorder
982         // and there are multiple instances of any repository type
983         $sortorder = 1;
984         foreach ($records as $record) {
985             if (!file_exists($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php')) {
986                 continue;
987             }
988             require_once($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php');
989             $options['visible'] = $record->visible;
990             $options['type']    = $record->repositorytype;
991             $options['typeid']  = $record->typeid;
992             $options['sortorder'] = $sortorder++;
993             // tell instance what file types will be accepted by file picker
994             $classname = 'repository_' . $record->repositorytype;
996             $repository = new $classname($record->id, $record->contextid, $options, $record->readonly);
998             $is_supported = true;
1000             if (empty($repository->super_called)) {
1001                 // to make sure the super construct is called
1002                 debugging('parent::__construct must be called by '.$record->repositorytype.' plugin.');
1003             } else {
1004                 // check mimetypes
1005                 if ($accepted_types !== '*' and $repository->supported_filetypes() !== '*') {
1006                     $accepted_ext = file_get_typegroup('extension', $accepted_types);
1007                     $supported_ext = file_get_typegroup('extension', $repository->supported_filetypes());
1008                     $valid_ext = array_intersect($accepted_ext, $supported_ext);
1009                     $is_supported = !empty($valid_ext);
1010                 }
1011                 // check return values
1012                 if ($returntypes !== 3 and $repository->supported_returntypes() !== 3) {
1013                     $type = $repository->supported_returntypes();
1014                     if ($type & $returntypes) {
1015                         //
1016                     } else {
1017                         $is_supported = false;
1018                     }
1019                 }
1021                 if (!$onlyvisible || ($repository->is_visible() && !$repository->disabled)) {
1022                     // check capability in current context
1023                     if (!empty($current_context)) {
1024                         $capability = has_capability('repository/'.$record->repositorytype.':view', $current_context);
1025                     } else {
1026                         $capability = has_capability('repository/'.$record->repositorytype.':view', get_system_context());
1027                     }
1028                     if ($record->repositorytype == 'coursefiles') {
1029                         // coursefiles plugin needs managefiles permission
1030                         if (!empty($current_context)) {
1031                             $capability = $capability && has_capability('moodle/course:managefiles', $current_context);
1032                         } else {
1033                             $capability = $capability && has_capability('moodle/course:managefiles', get_system_context());
1034                         }
1035                     }
1036                     if ($is_supported && $capability) {
1037                         $repositories[$repository->id] = $repository;
1038                     }
1039                 }
1040             }
1041         }
1042         return $repositories;
1043     }
1045     /**
1046      * Get single repository instance
1047      *
1048      * @static
1049      * @param integer $id repository id
1050      * @return object repository instance
1051      */
1052     public static function get_instance($id) {
1053         global $DB, $CFG;
1054         $sql = "SELECT i.*, r.type AS repositorytype, r.visible
1055                   FROM {repository} r
1056                   JOIN {repository_instances} i ON i.typeid = r.id
1057                  WHERE i.id = ?";
1059         if (!$instance = $DB->get_record_sql($sql, array($id))) {
1060             return false;
1061         }
1062         require_once($CFG->dirroot . '/repository/'. $instance->repositorytype.'/lib.php');
1063         $classname = 'repository_' . $instance->repositorytype;
1064         $options['typeid'] = $instance->typeid;
1065         $options['type']   = $instance->repositorytype;
1066         $options['name']   = $instance->name;
1067         $obj = new $classname($instance->id, $instance->contextid, $options, $instance->readonly);
1068         if (empty($obj->super_called)) {
1069             debugging('parent::__construct must be called by '.$classname.' plugin.');
1070         }
1071         return $obj;
1072     }
1074     /**
1075      * Call a static function. Any additional arguments than plugin and function will be passed through.
1076      *
1077      * @static
1078      * @param string $plugin repository plugin name
1079      * @param string $function funciton name
1080      * @return mixed
1081      */
1082     public static function static_function($plugin, $function) {
1083         global $CFG;
1085         //check that the plugin exists
1086         $typedirectory = $CFG->dirroot . '/repository/'. $plugin . '/lib.php';
1087         if (!file_exists($typedirectory)) {
1088             //throw new repository_exception('invalidplugin', 'repository');
1089             return false;
1090         }
1092         $pname = null;
1093         if (is_object($plugin) || is_array($plugin)) {
1094             $plugin = (object)$plugin;
1095             $pname = $plugin->name;
1096         } else {
1097             $pname = $plugin;
1098         }
1100         $args = func_get_args();
1101         if (count($args) <= 2) {
1102             $args = array();
1103         } else {
1104             array_shift($args);
1105             array_shift($args);
1106         }
1108         require_once($typedirectory);
1109         return call_user_func_array(array('repository_' . $plugin, $function), $args);
1110     }
1112     /**
1113      * Scan file, throws exception in case of infected file.
1114      *
1115      * Please note that the scanning engine must be able to access the file,
1116      * permissions of the file are not modified here!
1117      *
1118      * @static
1119      * @param string $thefile
1120      * @param string $filename name of the file
1121      * @param bool $deleteinfected
1122      */
1123     public static function antivir_scan_file($thefile, $filename, $deleteinfected) {
1124         global $CFG;
1126         if (!is_readable($thefile)) {
1127             // this should not happen
1128             return;
1129         }
1131         if (empty($CFG->runclamonupload) or empty($CFG->pathtoclam)) {
1132             // clam not enabled
1133             return;
1134         }
1136         $CFG->pathtoclam = trim($CFG->pathtoclam);
1138         if (!file_exists($CFG->pathtoclam) or !is_executable($CFG->pathtoclam)) {
1139             // misconfigured clam - use the old notification for now
1140             require("$CFG->libdir/uploadlib.php");
1141             $notice = get_string('clamlost', 'moodle', $CFG->pathtoclam);
1142             clam_message_admins($notice);
1143             return;
1144         }
1146         // do NOT mess with permissions here, the calling party is responsible for making
1147         // sure the scanner engine can access the files!
1149         // execute test
1150         $cmd = escapeshellcmd($CFG->pathtoclam).' --stdout '.escapeshellarg($thefile);
1151         exec($cmd, $output, $return);
1153         if ($return == 0) {
1154             // perfect, no problem found
1155             return;
1157         } else if ($return == 1) {
1158             // infection found
1159             if ($deleteinfected) {
1160                 unlink($thefile);
1161             }
1162             throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1164         } else {
1165             //unknown problem
1166             require("$CFG->libdir/uploadlib.php");
1167             $notice = get_string('clamfailed', 'moodle', get_clam_error_code($return));
1168             $notice .= "\n\n". implode("\n", $output);
1169             clam_message_admins($notice);
1170             if ($CFG->clamfailureonupload === 'actlikevirus') {
1171                 if ($deleteinfected) {
1172                     unlink($thefile);
1173                 }
1174                 throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1175             } else {
1176                 return;
1177             }
1178         }
1179     }
1181     /**
1182      * Repository method to serve the referenced file
1183      *
1184      * @see send_stored_file
1185      *
1186      * @param stored_file $storedfile the file that contains the reference
1187      * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
1188      * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1189      * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1190      * @param array $options additional options affecting the file serving
1191      */
1192     public function send_file($storedfile, $lifetime=86400 , $filter=0, $forcedownload=false, array $options = null) {
1193         if ($this->has_moodle_files()) {
1194             $fs = get_file_storage();
1195             $params = file_storage::unpack_reference($storedfile->get_reference(), true);
1196             $srcfile = null;
1197             if (is_array($params)) {
1198                 $srcfile = $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
1199                         $params['itemid'], $params['filepath'], $params['filename']);
1200             }
1201             if (empty($options)) {
1202                 $options = array();
1203             }
1204             if (!isset($options['filename'])) {
1205                 $options['filename'] = $storedfile->get_filename();
1206             }
1207             if (!$srcfile) {
1208                 send_file_not_found();
1209             } else {
1210                 send_stored_file($srcfile, $lifetime, $filter, $forcedownload, $options);
1211             }
1212         } else {
1213             throw new coding_exception("Repository plugin must implement send_file() method.");
1214         }
1215     }
1217     /**
1218      * Return reference file life time
1219      *
1220      * @param string $ref
1221      * @return int
1222      */
1223     public function get_reference_file_lifetime($ref) {
1224         // One day
1225         return 60 * 60 * 24;
1226     }
1228     /**
1229      * Decide whether or not the file should be synced
1230      *
1231      * @param stored_file $storedfile
1232      * @return bool
1233      */
1234     public function sync_individual_file(stored_file $storedfile) {
1235         return true;
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      * Returns information about file in this repository by reference
1288      *
1289      * This function must be implemented for repositories supporting FILE_REFERENCE, it is called
1290      * for existing aliases when the lifetime of the previous syncronisation has expired.
1291      *
1292      * Returns null if file not found or is not readable or timeout occured during request.
1293      * Note that this function may be run for EACH file that needs to be synchronised at the
1294      * moment. If anything is being downloaded or requested from external sources there
1295      * should be a small timeout. The synchronisation is performed to update the size of
1296      * the file and/or to update image and re-generated image preview. There is nothing
1297      * fatal if syncronisation fails but it is fatal if syncronisation takes too long
1298      * and hangs the script generating a page.
1299      *
1300      * If get_file_by_reference() returns filesize just the record in {files} table is being updated.
1301      * If filepath, handle or content are returned - the file is also stored in moodle filepool
1302      * (recommended for images to generate the thumbnails). For non-image files it is not
1303      * recommended to download them to moodle during syncronisation since it may take
1304      * unnecessary long time.
1305      *
1306      * @param stdClass $reference record from DB table {files_reference}
1307      * @return stdClass|null contains one of the following:
1308      *   - 'filesize' and optionally 'contenthash'
1309      *   - 'filepath'
1310      *   - 'handle'
1311      *   - 'content'
1312      */
1313     public function get_file_by_reference($reference) {
1314         if ($this->has_moodle_files() && isset($reference->reference)) {
1315             $fs = get_file_storage();
1316             $params = file_storage::unpack_reference($reference->reference, true);
1317             if (!is_array($params) || !($storedfile = $fs->get_file($params['contextid'],
1318                     $params['component'], $params['filearea'], $params['itemid'], $params['filepath'],
1319                     $params['filename']))) {
1320                 return null;
1321             }
1322             return (object)array(
1323                 'contenthash' => $storedfile->get_contenthash(),
1324                 'filesize'    => $storedfile->get_filesize()
1325             );
1326         }
1327         return null;
1328     }
1330     /**
1331      * Return the source information
1332      *
1333      * The result of the function is stored in files.source field. It may be analysed
1334      * when the source file is lost or repository may use it to display human-readable
1335      * location of reference original.
1336      *
1337      * This method is called when file is picked for the first time only. When file
1338      * (either copy or a reference) is already in moodle and it is being picked
1339      * again to another file area (also as a copy or as a reference), the value of
1340      * files.source is copied.
1341      *
1342      * @param string $source the value that repository returned in listing as 'source'
1343      * @return string|null
1344      */
1345     public function get_file_source_info($source) {
1346         if ($this->has_moodle_files()) {
1347             return $this->get_reference_details($source, 0);
1348         }
1349         return $source;
1350     }
1352     /**
1353      * Move file from download folder to file pool using FILE API
1354      *
1355      * @todo MDL-28637
1356      * @static
1357      * @param string $thefile file path in download folder
1358      * @param stdClass $record
1359      * @return array containing the following keys:
1360      *           icon
1361      *           file
1362      *           id
1363      *           url
1364      */
1365     public static function move_to_filepool($thefile, $record) {
1366         global $DB, $CFG, $USER, $OUTPUT;
1368         // scan for viruses if possible, throws exception if problem found
1369         self::antivir_scan_file($thefile, $record->filename, empty($CFG->repository_no_delete)); //TODO: MDL-28637 this repository_no_delete is a bloody hack!
1371         $fs = get_file_storage();
1372         // If file name being used.
1373         if (repository::draftfile_exists($record->itemid, $record->filepath, $record->filename)) {
1374             $draftitemid = $record->itemid;
1375             $new_filename = repository::get_unused_filename($draftitemid, $record->filepath, $record->filename);
1376             $old_filename = $record->filename;
1377             // Create a tmp file.
1378             $record->filename = $new_filename;
1379             $newfile = $fs->create_file_from_pathname($record, $thefile);
1380             $event = array();
1381             $event['event'] = 'fileexists';
1382             $event['newfile'] = new stdClass;
1383             $event['newfile']->filepath = $record->filepath;
1384             $event['newfile']->filename = $new_filename;
1385             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $new_filename)->out();
1387             $event['existingfile'] = new stdClass;
1388             $event['existingfile']->filepath = $record->filepath;
1389             $event['existingfile']->filename = $old_filename;
1390             $event['existingfile']->url      = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $old_filename)->out();
1391             return $event;
1392         }
1393         if ($file = $fs->create_file_from_pathname($record, $thefile)) {
1394             if (empty($CFG->repository_no_delete)) {
1395                 $delete = unlink($thefile);
1396                 unset($CFG->repository_no_delete);
1397             }
1398             return array(
1399                 'url'=>moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename())->out(),
1400                 'id'=>$file->get_itemid(),
1401                 'file'=>$file->get_filename(),
1402                 'icon' => $OUTPUT->pix_url(file_extension_icon($thefile, 32))->out(),
1403             );
1404         } else {
1405             return null;
1406         }
1407     }
1409     /**
1410      * Builds a tree of files This function is then called recursively.
1411      *
1412      * @static
1413      * @todo take $search into account, and respect a threshold for dynamic loading
1414      * @param file_info $fileinfo an object returned by file_browser::get_file_info()
1415      * @param string $search searched string
1416      * @param bool $dynamicmode no recursive call is done when in dynamic mode
1417      * @param array $list the array containing the files under the passed $fileinfo
1418      * @return int the number of files found
1419      */
1420     public static function build_tree($fileinfo, $search, $dynamicmode, &$list) {
1421         global $CFG, $OUTPUT;
1423         $filecount = 0;
1424         $children = $fileinfo->get_children();
1426         foreach ($children as $child) {
1427             $filename = $child->get_visible_name();
1428             $filesize = $child->get_filesize();
1429             $filesize = $filesize ? display_size($filesize) : '';
1430             $filedate = $child->get_timemodified();
1431             $filedate = $filedate ? userdate($filedate) : '';
1432             $filetype = $child->get_mimetype();
1434             if ($child->is_directory()) {
1435                 $path = array();
1436                 $level = $child->get_parent();
1437                 while ($level) {
1438                     $params = $level->get_params();
1439                     $path[] = array($params['filepath'], $level->get_visible_name());
1440                     $level = $level->get_parent();
1441                 }
1443                 $tmp = array(
1444                     'title' => $child->get_visible_name(),
1445                     'size' => 0,
1446                     'date' => $filedate,
1447                     'path' => array_reverse($path),
1448                     'thumbnail' => $OUTPUT->pix_url(file_folder_icon(90))->out(false)
1449                 );
1451                 //if ($dynamicmode && $child->is_writable()) {
1452                 //    $tmp['children'] = array();
1453                 //} else {
1454                     // if folder name matches search, we send back all files contained.
1455                 $_search = $search;
1456                 if ($search && stristr($tmp['title'], $search) !== false) {
1457                     $_search = false;
1458                 }
1459                 $tmp['children'] = array();
1460                 $_filecount = repository::build_tree($child, $_search, $dynamicmode, $tmp['children']);
1461                 if ($search && $_filecount) {
1462                     $tmp['expanded'] = 1;
1463                 }
1465                 //}
1467                 if (!$search || $_filecount || (stristr($tmp['title'], $search) !== false)) {
1468                     $filecount += $_filecount;
1469                     $list[] = $tmp;
1470                 }
1472             } else { // not a directory
1473                 // skip the file, if we're in search mode and it's not a match
1474                 if ($search && (stristr($filename, $search) === false)) {
1475                     continue;
1476                 }
1477                 $params = $child->get_params();
1478                 $source = serialize(array($params['contextid'], $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']));
1479                 $list[] = array(
1480                     'title' => $filename,
1481                     'size' => $filesize,
1482                     'date' => $filedate,
1483                     //'source' => $child->get_url(),
1484                     'source' => base64_encode($source),
1485                     'icon'=>$OUTPUT->pix_url(file_file_icon($child, 24))->out(false),
1486                     'thumbnail'=>$OUTPUT->pix_url(file_file_icon($child, 90))->out(false),
1487                 );
1488                 $filecount++;
1489             }
1490         }
1492         return $filecount;
1493     }
1495     /**
1496      * Display a repository instance list (with edit/delete/create links)
1497      *
1498      * @static
1499      * @param stdClass $context the context for which we display the instance
1500      * @param string $typename if set, we display only one type of instance
1501      */
1502     public static function display_instances_list($context, $typename = null) {
1503         global $CFG, $USER, $OUTPUT;
1505         $output = $OUTPUT->box_start('generalbox');
1506         //if the context is SYSTEM, so we call it from administration page
1507         $admin = ($context->id == SYSCONTEXTID) ? true : false;
1508         if ($admin) {
1509             $baseurl = new moodle_url('/'.$CFG->admin.'/repositoryinstance.php', array('sesskey'=>sesskey()));
1510             $output .= $OUTPUT->heading(get_string('siteinstances', 'repository'));
1511         } else {
1512             $baseurl = new moodle_url('/repository/manage_instances.php', array('contextid'=>$context->id, 'sesskey'=>sesskey()));
1513         }
1515         $namestr = get_string('name');
1516         $pluginstr = get_string('plugin', 'repository');
1517         $settingsstr = get_string('settings');
1518         $deletestr = get_string('delete');
1519         // Retrieve list of instances. In administration context we want to display all
1520         // instances of a type, even if this type is not visible. In course/user context we
1521         // want to display only visible instances, but for every type types. The repository::get_instances()
1522         // third parameter displays only visible type.
1523         $params = array();
1524         $params['context'] = array($context);
1525         $params['currentcontext'] = $context;
1526         $params['onlyvisible'] = !$admin;
1527         $params['type']        = $typename;
1528         $instances = repository::get_instances($params);
1529         $instancesnumber = count($instances);
1530         $alreadyplugins = array();
1532         $table = new html_table();
1533         $table->head = array($namestr, $pluginstr, $settingsstr, $deletestr);
1534         $table->align = array('left', 'left', 'center','center');
1535         $table->data = array();
1537         $updowncount = 1;
1539         foreach ($instances as $i) {
1540             $settings = '';
1541             $delete = '';
1543             $type = repository::get_type_by_id($i->options['typeid']);
1545             if ($type->get_contextvisibility($context)) {
1546                 if (!$i->readonly) {
1548                     $settingurl = new moodle_url($baseurl);
1549                     $settingurl->param('type', $i->options['type']);
1550                     $settingurl->param('edit', $i->id);
1551                     $settings .= html_writer::link($settingurl, $settingsstr);
1553                     $deleteurl = new moodle_url($baseurl);
1554                     $deleteurl->param('delete', $i->id);
1555                     $deleteurl->param('type', $i->options['type']);
1556                     $delete .= html_writer::link($deleteurl, $deletestr);
1557                 }
1558             }
1560             $type = repository::get_type_by_id($i->options['typeid']);
1561             $table->data[] = array(format_string($i->name), $type->get_readablename(), $settings, $delete);
1563             //display a grey row if the type is defined as not visible
1564             if (isset($type) && !$type->get_visible()) {
1565                 $table->rowclasses[] = 'dimmed_text';
1566             } else {
1567                 $table->rowclasses[] = '';
1568             }
1570             if (!in_array($i->name, $alreadyplugins)) {
1571                 $alreadyplugins[] = $i->name;
1572             }
1573         }
1574         $output .= html_writer::table($table);
1575         $instancehtml = '<div>';
1576         $addable = 0;
1578         //if no type is set, we can create all type of instance
1579         if (!$typename) {
1580             $instancehtml .= '<h3>';
1581             $instancehtml .= get_string('createrepository', 'repository');
1582             $instancehtml .= '</h3><ul>';
1583             $types = repository::get_editable_types($context);
1584             foreach ($types as $type) {
1585                 if (!empty($type) && $type->get_visible()) {
1586                     // If the user does not have the permission to view the repository, it won't be displayed in
1587                     // the list of instances. Hiding the link to create new instances will prevent the
1588                     // user from creating them without being able to find them afterwards, which looks like a bug.
1589                     if (!has_capability('repository/'.$type->get_typename().':view', $context)) {
1590                         continue;
1591                     }
1592                     $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
1593                     if (!empty($instanceoptionnames)) {
1594                         $baseurl->param('new', $type->get_typename());
1595                         $instancehtml .= '<li><a href="'.$baseurl->out().'">'.get_string('createxxinstance', 'repository', get_string('pluginname', 'repository_'.$type->get_typename())).  '</a></li>';
1596                         $baseurl->remove_params('new');
1597                         $addable++;
1598                     }
1599                 }
1600             }
1601             $instancehtml .= '</ul>';
1603         } else {
1604             $instanceoptionnames = repository::static_function($typename, 'get_instance_option_names');
1605             if (!empty($instanceoptionnames)) {   //create a unique type of instance
1606                 $addable = 1;
1607                 $baseurl->param('new', $typename);
1608                 $output .= $OUTPUT->single_button($baseurl, get_string('createinstance', 'repository'), 'get');
1609                 $baseurl->remove_params('new');
1610             }
1611         }
1613         if ($addable) {
1614             $instancehtml .= '</div>';
1615             $output .= $instancehtml;
1616         }
1618         $output .= $OUTPUT->box_end();
1620         //print the list + creation links
1621         print($output);
1622     }
1624     /**
1625      * Prepare file reference information
1626      *
1627      * @param string $source
1628      * @return string file referece
1629      */
1630     public function get_file_reference($source) {
1631         if ($this->has_moodle_files() && ($this->supported_returntypes() & FILE_REFERENCE)) {
1632             $params = file_storage::unpack_reference($source);
1633             if (!is_array($params)) {
1634                 throw new repository_exception('invalidparams', 'repository');
1635             }
1636             return file_storage::pack_reference($params);
1637         }
1638         return $source;
1639     }
1641     /**
1642      * Decide where to save the file, can be overwriten by subclass
1643      *
1644      * @param string $filename file name
1645      * @return file path
1646      */
1647     public function prepare_file($filename) {
1648         global $CFG;
1649         $dir = make_temp_directory('download/'.get_class($this).'/');
1650         while (empty($filename) || file_exists($dir.$filename)) {
1651             $filename = uniqid('', true).'_'.time().'.tmp';
1652         }
1653         return $dir.$filename;
1654     }
1656     /**
1657      * Does this repository used to browse moodle files?
1658      *
1659      * @return bool
1660      */
1661     public function has_moodle_files() {
1662         return false;
1663     }
1665     /**
1666      * Return file URL, for most plugins, the parameter is the original
1667      * url, but some plugins use a file id, so we need this function to
1668      * convert file id to original url.
1669      *
1670      * @param string $url the url of file
1671      * @return string
1672      */
1673     public function get_link($url) {
1674         return $url;
1675     }
1677     /**
1678      * Downloads a file from external repository and saves it in temp dir
1679      *
1680      * Function get_file() must be implemented by repositories that support returntypes
1681      * FILE_INTERNAL or FILE_REFERENCE. It is invoked to pick up the file and copy it
1682      * to moodle. This function is not called for moodle repositories, the function
1683      * {@link repository::copy_to_area()} is used instead.
1684      *
1685      * This function can be overridden by subclass if the files.reference field contains
1686      * not just URL or if request should be done differently.
1687      *
1688      * @see curl
1689      * @throws file_exception when error occured
1690      *
1691      * @param string $url the content of files.reference field, in this implementaion
1692      * it is asssumed that it contains the string with URL of the file
1693      * @param string $filename filename (without path) to save the downloaded file in the
1694      * temporary directory, if omitted or file already exists the new filename will be generated
1695      * @return array with elements:
1696      *   path: internal location of the file
1697      *   url: URL to the source (from parameters)
1698      */
1699     public function get_file($url, $filename = '') {
1700         $path = $this->prepare_file($filename);
1701         $c = new curl;
1702         $result = $c->download_one($url, null, array('filepath' => $path, 'timeout' => self::GETFILE_TIMEOUT));
1703         if ($result !== true) {
1704             throw new moodle_exception('errorwhiledownload', 'repository', '', $result);
1705         }
1706         return array('path'=>$path, 'url'=>$url);
1707     }
1709     /**
1710      * Downloads the file from external repository and saves it in moodle filepool.
1711      * This function is different from {@link repository::sync_external_file()} because it has
1712      * bigger request timeout and always downloads the content.
1713      *
1714      * This function is invoked when we try to unlink the file from the source and convert
1715      * a reference into a true copy.
1716      *
1717      * @throws exception when file could not be imported
1718      *
1719      * @param stored_file $file
1720      * @param int $maxbytes throw an exception if file size is bigger than $maxbytes (0 means no limit)
1721      */
1722     public function import_external_file_contents(stored_file $file, $maxbytes = 0) {
1723         if (!$file->is_external_file()) {
1724             // nothing to import if the file is not a reference
1725             return;
1726         } else if ($file->get_repository_id() != $this->id) {
1727             // error
1728             debugging('Repository instance id does not match');
1729             return;
1730         } else if ($this->has_moodle_files()) {
1731             // files that are references to local files are already in moodle filepool
1732             // just validate the size
1733             if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1734                 throw new file_exception('maxbytes');
1735             }
1736             return;
1737         } else {
1738             if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1739                 // note that stored_file::get_filesize() also calls synchronisation
1740                 throw new file_exception('maxbytes');
1741             }
1742             $fs = get_file_storage();
1743             $contentexists = $fs->content_exists($file->get_contenthash());
1744             if ($contentexists && $file->get_filesize() && $file->get_contenthash() === sha1('')) {
1745                 // even when 'file_storage::content_exists()' returns true this may be an empty
1746                 // content for the file that was not actually downloaded
1747                 $contentexists = false;
1748             }
1749             $now = time();
1750             if ($file->get_referencelastsync() + $file->get_referencelifetime() >= $now &&
1751                         !$file->get_status() &&
1752                         $contentexists) {
1753                 // we already have the content in moodle filepool and it was synchronised recently.
1754                 // Repositories may overwrite it if they want to force synchronisation anyway!
1755                 return;
1756             } else {
1757                 // attempt to get a file
1758                 try {
1759                     $fileinfo = $this->get_file($file->get_reference());
1760                     if (isset($fileinfo['path'])) {
1761                         list($contenthash, $filesize, $newfile) = $fs->add_file_to_pool($fileinfo['path']);
1762                         // set this file and other similar aliases synchronised
1763                         $lifetime = $this->get_reference_file_lifetime($file->get_reference());
1764                         $file->set_synchronized($contenthash, $filesize, 0, $lifetime);
1765                     } else {
1766                         throw new moodle_exception('errorwhiledownload', 'repository', '', '');
1767                     }
1768                 } catch (Exception $e) {
1769                     if ($contentexists) {
1770                         // better something than nothing. We have a copy of file. It's sync time
1771                         // has expired but it is still very likely that it is the last version
1772                     } else {
1773                         throw($e);
1774                     }
1775                 }
1776             }
1777         }
1778     }
1780     /**
1781      * Return size of a file in bytes.
1782      *
1783      * @param string $source encoded and serialized data of file
1784      * @return int file size in bytes
1785      */
1786     public function get_file_size($source) {
1787         // TODO MDL-33297 remove this function completely?
1788         $browser    = get_file_browser();
1789         $params     = unserialize(base64_decode($source));
1790         $contextid  = clean_param($params['contextid'], PARAM_INT);
1791         $fileitemid = clean_param($params['itemid'], PARAM_INT);
1792         $filename   = clean_param($params['filename'], PARAM_FILE);
1793         $filepath   = clean_param($params['filepath'], PARAM_PATH);
1794         $filearea   = clean_param($params['filearea'], PARAM_AREA);
1795         $component  = clean_param($params['component'], PARAM_COMPONENT);
1796         $context    = context::instance_by_id($contextid);
1797         $file_info  = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
1798         if (!empty($file_info)) {
1799             $filesize = $file_info->get_filesize();
1800         } else {
1801             $filesize = null;
1802         }
1803         return $filesize;
1804     }
1806     /**
1807      * Return is the instance is visible
1808      * (is the type visible ? is the context enable ?)
1809      *
1810      * @return bool
1811      */
1812     public function is_visible() {
1813         $type = repository::get_type_by_id($this->options['typeid']);
1814         $instanceoptions = repository::static_function($type->get_typename(), 'get_instance_option_names');
1816         if ($type->get_visible()) {
1817             //if the instance is unique so it's visible, otherwise check if the instance has a enabled context
1818             if (empty($instanceoptions) || $type->get_contextvisibility($this->context)) {
1819                 return true;
1820             }
1821         }
1823         return false;
1824     }
1826     /**
1827      * Can the instance be edited by the current user?
1828      *
1829      * The property $readonly must not be used within this method because
1830      * it only controls if the options from self::get_instance_option_names()
1831      * can be edited.
1832      *
1833      * @return bool true if the user can edit the instance.
1834      * @since 2.5
1835      */
1836     public final function can_be_edited_by_user() {
1837         global $USER;
1839         // We need to be able to explore the repository.
1840         try {
1841             $this->check_capability();
1842         } catch (repository_exception $e) {
1843             return false;
1844         }
1846         $repocontext = context::instance_by_id($this->instance->contextid);
1847         if ($repocontext->contextlevel == CONTEXT_USER && $repocontext->instanceid != $USER->id) {
1848             // If the context of this instance is a user context, we need to be this user.
1849             return false;
1850         } else if ($repocontext->contextlevel == CONTEXT_MODULE && !has_capability('moodle/course:update', $repocontext)) {
1851             // We need to have permissions on the course to edit the instance.
1852             return false;
1853         } else if ($repocontext->contextlevel == CONTEXT_SYSTEM && !has_capability('moodle/site:config', $repocontext)) {
1854             // Do not meet the requirements for the context system.
1855             return false;
1856         }
1858         return true;
1859     }
1861     /**
1862      * Return the name of this instance, can be overridden.
1863      *
1864      * @return string
1865      */
1866     public function get_name() {
1867         global $DB;
1868         if ($name = $this->instance->name) {
1869             return $name;
1870         } else {
1871             return get_string('pluginname', 'repository_' . $this->get_typename());
1872         }
1873     }
1875     /**
1876      * Is this repository accessing private data?
1877      *
1878      * This function should return true for the repositories which access external private
1879      * data from a user. This is the case for repositories such as Dropbox, Google Docs or Box.net
1880      * which authenticate the user and then store the auth token.
1881      *
1882      * Of course, many repositories store 'private data', but we only want to set
1883      * contains_private_data() to repositories which are external to Moodle and shouldn't be accessed
1884      * to by the users having the capability to 'login as' someone else. For instance, the repository
1885      * 'Private files' is not considered as private because it's part of Moodle.
1886      *
1887      * You should not set contains_private_data() to true on repositories which allow different types
1888      * of instances as the levels other than 'user' are, by definition, not private. Also
1889      * the user instances will be protected when they need to.
1890      *
1891      * @return boolean True when the repository accesses private external data.
1892      * @since  2.5
1893      */
1894     public function contains_private_data() {
1895         return true;
1896     }
1898     /**
1899      * What kind of files will be in this repository?
1900      *
1901      * @return array return '*' means this repository support any files, otherwise
1902      *               return mimetypes of files, it can be an array
1903      */
1904     public function supported_filetypes() {
1905         // return array('text/plain', 'image/gif');
1906         return '*';
1907     }
1909     /**
1910      * Tells how the file can be picked from this repository
1911      *
1912      * Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
1913      *
1914      * @return int
1915      */
1916     public function supported_returntypes() {
1917         return (FILE_INTERNAL | FILE_EXTERNAL);
1918     }
1920     /**
1921      * Provide repository instance information for Ajax
1922      *
1923      * @return stdClass
1924      */
1925     final public function get_meta() {
1926         global $CFG, $OUTPUT;
1927         $meta = new stdClass();
1928         $meta->id   = $this->id;
1929         $meta->name = format_string($this->get_name());
1930         $meta->type = $this->get_typename();
1931         $meta->icon = $OUTPUT->pix_url('icon', 'repository_'.$meta->type)->out(false);
1932         $meta->supported_types = file_get_typegroup('extension', $this->supported_filetypes());
1933         $meta->return_types = $this->supported_returntypes();
1934         $meta->sortorder = $this->options['sortorder'];
1935         return $meta;
1936     }
1938     /**
1939      * Create an instance for this plug-in
1940      *
1941      * @static
1942      * @param string $type the type of the repository
1943      * @param int $userid the user id
1944      * @param stdClass $context the context
1945      * @param array $params the options for this instance
1946      * @param int $readonly whether to create it readonly or not (defaults to not)
1947      * @return mixed
1948      */
1949     public static function create($type, $userid, $context, $params, $readonly=0) {
1950         global $CFG, $DB;
1951         $params = (array)$params;
1952         require_once($CFG->dirroot . '/repository/'. $type . '/lib.php');
1953         $classname = 'repository_' . $type;
1954         if ($repo = $DB->get_record('repository', array('type'=>$type))) {
1955             $record = new stdClass();
1956             $record->name = $params['name'];
1957             $record->typeid = $repo->id;
1958             $record->timecreated  = time();
1959             $record->timemodified = time();
1960             $record->contextid = $context->id;
1961             $record->readonly = $readonly;
1962             $record->userid    = $userid;
1963             $id = $DB->insert_record('repository_instances', $record);
1964             $options = array();
1965             $configs = call_user_func($classname . '::get_instance_option_names');
1966             if (!empty($configs)) {
1967                 foreach ($configs as $config) {
1968                     if (isset($params[$config])) {
1969                         $options[$config] = $params[$config];
1970                     } else {
1971                         $options[$config] = null;
1972                     }
1973                 }
1974             }
1976             if (!empty($id)) {
1977                 unset($options['name']);
1978                 $instance = repository::get_instance($id);
1979                 $instance->set_option($options);
1980                 return $id;
1981             } else {
1982                 return null;
1983             }
1984         } else {
1985             return null;
1986         }
1987     }
1989     /**
1990      * delete a repository instance
1991      *
1992      * @param bool $downloadcontents
1993      * @return bool
1994      */
1995     final public function delete($downloadcontents = false) {
1996         global $DB;
1997         if ($downloadcontents) {
1998             $this->convert_references_to_local();
1999         }
2000         try {
2001             $DB->delete_records('repository_instances', array('id'=>$this->id));
2002             $DB->delete_records('repository_instance_config', array('instanceid'=>$this->id));
2003         } catch (dml_exception $ex) {
2004             return false;
2005         }
2006         return true;
2007     }
2009     /**
2010      * Hide/Show a repository
2011      *
2012      * @param string $hide
2013      * @return bool
2014      */
2015     final public function hide($hide = 'toggle') {
2016         global $DB;
2017         if ($entry = $DB->get_record('repository', array('id'=>$this->id))) {
2018             if ($hide === 'toggle' ) {
2019                 if (!empty($entry->visible)) {
2020                     $entry->visible = 0;
2021                 } else {
2022                     $entry->visible = 1;
2023                 }
2024             } else {
2025                 if (!empty($hide)) {
2026                     $entry->visible = 0;
2027                 } else {
2028                     $entry->visible = 1;
2029                 }
2030             }
2031             return $DB->update_record('repository', $entry);
2032         }
2033         return false;
2034     }
2036     /**
2037      * Save settings for repository instance
2038      * $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));
2039      *
2040      * @param array $options settings
2041      * @return bool
2042      */
2043     public function set_option($options = array()) {
2044         global $DB;
2046         if (!empty($options['name'])) {
2047             $r = new stdClass();
2048             $r->id   = $this->id;
2049             $r->name = $options['name'];
2050             $DB->update_record('repository_instances', $r);
2051             unset($options['name']);
2052         }
2053         foreach ($options as $name=>$value) {
2054             if ($id = $DB->get_field('repository_instance_config', 'id', array('name'=>$name, 'instanceid'=>$this->id))) {
2055                 $DB->set_field('repository_instance_config', 'value', $value, array('id'=>$id));
2056             } else {
2057                 $config = new stdClass();
2058                 $config->instanceid = $this->id;
2059                 $config->name   = $name;
2060                 $config->value  = $value;
2061                 $DB->insert_record('repository_instance_config', $config);
2062             }
2063         }
2064         return true;
2065     }
2067     /**
2068      * Get settings for repository instance
2069      *
2070      * @param string $config
2071      * @return array Settings
2072      */
2073     public function get_option($config = '') {
2074         global $DB;
2075         $entries = $DB->get_records('repository_instance_config', array('instanceid'=>$this->id));
2076         $ret = array();
2077         if (empty($entries)) {
2078             return $ret;
2079         }
2080         foreach($entries as $entry) {
2081             $ret[$entry->name] = $entry->value;
2082         }
2083         if (!empty($config)) {
2084             if (isset($ret[$config])) {
2085                 return $ret[$config];
2086             } else {
2087                 return null;
2088             }
2089         } else {
2090             return $ret;
2091         }
2092     }
2094     /**
2095      * Filter file listing to display specific types
2096      *
2097      * @param array $value
2098      * @return bool
2099      */
2100     public function filter(&$value) {
2101         $accepted_types = optional_param_array('accepted_types', '', PARAM_RAW);
2102         if (isset($value['children'])) {
2103             if (!empty($value['children'])) {
2104                 $value['children'] = array_filter($value['children'], array($this, 'filter'));
2105             }
2106             return true; // always return directories
2107         } else {
2108             if ($accepted_types == '*' or empty($accepted_types)
2109                 or (is_array($accepted_types) and in_array('*', $accepted_types))) {
2110                 return true;
2111             } else {
2112                 foreach ($accepted_types as $ext) {
2113                     if (preg_match('#'.$ext.'$#i', $value['title'])) {
2114                         return true;
2115                     }
2116                 }
2117             }
2118         }
2119         return false;
2120     }
2122     /**
2123      * Given a path, and perhaps a search, get a list of files.
2124      *
2125      * See details on {@link http://docs.moodle.org/dev/Repository_plugins}
2126      *
2127      * @param string $path this parameter can a folder name, or a identification of folder
2128      * @param string $page the page number of file list
2129      * @return array the list of files, including meta infomation, containing the following keys
2130      *           manage, url to manage url
2131      *           client_id
2132      *           login, login form
2133      *           repo_id, active repository id
2134      *           login_btn_action, the login button action
2135      *           login_btn_label, the login button label
2136      *           total, number of results
2137      *           perpage, items per page
2138      *           page
2139      *           pages, total pages
2140      *           issearchresult, is it a search result?
2141      *           list, file list
2142      *           path, current path and parent path
2143      */
2144     public function get_listing($path = '', $page = '') {
2145     }
2148     /**
2149      * Prepare the breadcrumb.
2150      *
2151      * @param array $breadcrumb contains each element of the breadcrumb.
2152      * @return array of breadcrumb elements.
2153      * @since 2.3.3
2154      */
2155     protected static function prepare_breadcrumb($breadcrumb) {
2156         global $OUTPUT;
2157         $foldericon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
2158         $len = count($breadcrumb);
2159         for ($i = 0; $i < $len; $i++) {
2160             if (is_array($breadcrumb[$i]) && !isset($breadcrumb[$i]['icon'])) {
2161                 $breadcrumb[$i]['icon'] = $foldericon;
2162             } else if (is_object($breadcrumb[$i]) && !isset($breadcrumb[$i]->icon)) {
2163                 $breadcrumb[$i]->icon = $foldericon;
2164             }
2165         }
2166         return $breadcrumb;
2167     }
2169     /**
2170      * Prepare the file/folder listing.
2171      *
2172      * @param array $list of files and folders.
2173      * @return array of files and folders.
2174      * @since 2.3.3
2175      */
2176     protected static function prepare_list($list) {
2177         global $OUTPUT;
2178         $foldericon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
2180         // Reset the array keys because non-numeric keys will create an object when converted to JSON.
2181         $list = array_values($list);
2183         $len = count($list);
2184         for ($i = 0; $i < $len; $i++) {
2185             if (is_object($list[$i])) {
2186                 $file = (array)$list[$i];
2187                 $converttoobject = true;
2188             } else {
2189                 $file =& $list[$i];
2190                 $converttoobject = false;
2191             }
2192             if (isset($file['size'])) {
2193                 $file['size'] = (int)$file['size'];
2194                 $file['size_f'] = display_size($file['size']);
2195             }
2196             if (isset($file['license']) && get_string_manager()->string_exists($file['license'], 'license')) {
2197                 $file['license_f'] = get_string($file['license'], 'license');
2198             }
2199             if (isset($file['image_width']) && isset($file['image_height'])) {
2200                 $a = array('width' => $file['image_width'], 'height' => $file['image_height']);
2201                 $file['dimensions'] = get_string('imagesize', 'repository', (object)$a);
2202             }
2203             foreach (array('date', 'datemodified', 'datecreated') as $key) {
2204                 if (!isset($file[$key]) && isset($file['date'])) {
2205                     $file[$key] = $file['date'];
2206                 }
2207                 if (isset($file[$key])) {
2208                     // must be UNIX timestamp
2209                     $file[$key] = (int)$file[$key];
2210                     if (!$file[$key]) {
2211                         unset($file[$key]);
2212                     } else {
2213                         $file[$key.'_f'] = userdate($file[$key], get_string('strftimedatetime', 'langconfig'));
2214                         $file[$key.'_f_s'] = userdate($file[$key], get_string('strftimedatetimeshort', 'langconfig'));
2215                     }
2216                 }
2217             }
2218             $isfolder = (array_key_exists('children', $file) || (isset($file['type']) && $file['type'] == 'folder'));
2219             $filename = null;
2220             if (isset($file['title'])) {
2221                 $filename = $file['title'];
2222             }
2223             else if (isset($file['fullname'])) {
2224                 $filename = $file['fullname'];
2225             }
2226             if (!isset($file['mimetype']) && !$isfolder && $filename) {
2227                 $file['mimetype'] = get_mimetype_description(array('filename' => $filename));
2228             }
2229             if (!isset($file['icon'])) {
2230                 if ($isfolder) {
2231                     $file['icon'] = $foldericon;
2232                 } else if ($filename) {
2233                     $file['icon'] = $OUTPUT->pix_url(file_extension_icon($filename, 24))->out(false);
2234                 }
2235             }
2237             // Recursively loop over children.
2238             if (isset($file['children'])) {
2239                 $file['children'] = self::prepare_list($file['children']);
2240             }
2242             // Convert the array back to an object.
2243             if ($converttoobject) {
2244                 $list[$i] = (object)$file;
2245             }
2246         }
2247         return $list;
2248     }
2250     /**
2251      * Prepares list of files before passing it to AJAX, makes sure data is in the correct
2252      * format and stores formatted values.
2253      *
2254      * @param array|stdClass $listing result of get_listing() or search() or file_get_drafarea_files()
2255      * @return array
2256      */
2257     public static function prepare_listing($listing) {
2258         $wasobject = false;
2259         if (is_object($listing)) {
2260             $listing = (array) $listing;
2261             $wasobject = true;
2262         }
2264         // Prepare the breadcrumb, passed as 'path'.
2265         if (isset($listing['path']) && is_array($listing['path'])) {
2266             $listing['path'] = self::prepare_breadcrumb($listing['path']);
2267         }
2269         // Prepare the listing of objects.
2270         if (isset($listing['list']) && is_array($listing['list'])) {
2271             $listing['list'] = self::prepare_list($listing['list']);
2272         }
2274         // Convert back to an object.
2275         if ($wasobject) {
2276             $listing = (object) $listing;
2277         }
2278         return $listing;
2279     }
2281     /**
2282      * Search files in repository
2283      * When doing global search, $search_text will be used as
2284      * keyword.
2285      *
2286      * @param string $search_text search key word
2287      * @param int $page page
2288      * @return mixed see {@link repository::get_listing()}
2289      */
2290     public function search($search_text, $page = 0) {
2291         $list = array();
2292         $list['list'] = array();
2293         return false;
2294     }
2296     /**
2297      * Logout from repository instance
2298      * By default, this function will return a login form
2299      *
2300      * @return string
2301      */
2302     public function logout(){
2303         return $this->print_login();
2304     }
2306     /**
2307      * To check whether the user is logged in.
2308      *
2309      * @return bool
2310      */
2311     public function check_login(){
2312         return true;
2313     }
2316     /**
2317      * Show the login screen, if required
2318      *
2319      * @return string
2320      */
2321     public function print_login(){
2322         return $this->get_listing();
2323     }
2325     /**
2326      * Show the search screen, if required
2327      *
2328      * @return string
2329      */
2330     public function print_search() {
2331         global $PAGE;
2332         $renderer = $PAGE->get_renderer('core', 'files');
2333         return $renderer->repository_default_searchform();
2334     }
2336     /**
2337      * For oauth like external authentication, when external repository direct user back to moodle,
2338      * this funciton will be called to set up token and token_secret
2339      */
2340     public function callback() {
2341     }
2343     /**
2344      * is it possible to do glboal search?
2345      *
2346      * @return bool
2347      */
2348     public function global_search() {
2349         return false;
2350     }
2352     /**
2353      * Defines operations that happen occasionally on cron
2354      *
2355      * @return bool
2356      */
2357     public function cron() {
2358         return true;
2359     }
2361     /**
2362      * function which is run when the type is created (moodle administrator add the plugin)
2363      *
2364      * @return bool success or fail?
2365      */
2366     public static function plugin_init() {
2367         return true;
2368     }
2370     /**
2371      * Edit/Create Admin Settings Moodle form
2372      *
2373      * @param moodleform $mform Moodle form (passed by reference)
2374      * @param string $classname repository class name
2375      */
2376     public static function type_config_form($mform, $classname = 'repository') {
2377         $instnaceoptions = call_user_func(array($classname, 'get_instance_option_names'), $mform, $classname);
2378         if (empty($instnaceoptions)) {
2379             // this plugin has only one instance
2380             // so we need to give it a name
2381             // it can be empty, then moodle will look for instance name from language string
2382             $mform->addElement('text', 'pluginname', get_string('pluginname', 'repository'), array('size' => '40'));
2383             $mform->addElement('static', 'pluginnamehelp', '', get_string('pluginnamehelp', 'repository'));
2384             $mform->setType('pluginname', PARAM_TEXT);
2385         }
2386     }
2388     /**
2389      * Validate Admin Settings Moodle form
2390      *
2391      * @static
2392      * @param moodleform $mform Moodle form (passed by reference)
2393      * @param array $data array of ("fieldname"=>value) of submitted data
2394      * @param array $errors array of ("fieldname"=>errormessage) of errors
2395      * @return array array of errors
2396      */
2397     public static function type_form_validation($mform, $data, $errors) {
2398         return $errors;
2399     }
2402     /**
2403      * Edit/Create Instance Settings Moodle form
2404      *
2405      * @param moodleform $mform Moodle form (passed by reference)
2406      */
2407     public static function instance_config_form($mform) {
2408     }
2410     /**
2411      * Return names of the general options.
2412      * By default: no general option name
2413      *
2414      * @return array
2415      */
2416     public static function get_type_option_names() {
2417         return array('pluginname');
2418     }
2420     /**
2421      * Return names of the instance options.
2422      * By default: no instance option name
2423      *
2424      * @return array
2425      */
2426     public static function get_instance_option_names() {
2427         return array();
2428     }
2430     /**
2431      * Validate repository plugin instance form
2432      *
2433      * @param moodleform $mform moodle form
2434      * @param array $data form data
2435      * @param array $errors errors
2436      * @return array errors
2437      */
2438     public static function instance_form_validation($mform, $data, $errors) {
2439         return $errors;
2440     }
2442     /**
2443      * Create a shorten filename
2444      *
2445      * @param string $str filename
2446      * @param int $maxlength max file name length
2447      * @return string short filename
2448      */
2449     public function get_short_filename($str, $maxlength) {
2450         if (textlib::strlen($str) >= $maxlength) {
2451             return trim(textlib::substr($str, 0, $maxlength)).'...';
2452         } else {
2453             return $str;
2454         }
2455     }
2457     /**
2458      * Overwrite an existing file
2459      *
2460      * @param int $itemid
2461      * @param string $filepath
2462      * @param string $filename
2463      * @param string $newfilepath
2464      * @param string $newfilename
2465      * @return bool
2466      */
2467     public static function overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename) {
2468         global $USER;
2469         $fs = get_file_storage();
2470         $user_context = context_user::instance($USER->id);
2471         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $filepath, $filename)) {
2472             if ($tempfile = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $newfilepath, $newfilename)) {
2473                 // delete existing file to release filename
2474                 $file->delete();
2475                 // create new file
2476                 $newfile = $fs->create_file_from_storedfile(array('filepath'=>$filepath, 'filename'=>$filename), $tempfile);
2477                 // remove temp file
2478                 $tempfile->delete();
2479                 return true;
2480             }
2481         }
2482         return false;
2483     }
2485     /**
2486      * Delete a temp file from draft area
2487      *
2488      * @param int $draftitemid
2489      * @param string $filepath
2490      * @param string $filename
2491      * @return bool
2492      */
2493     public static function delete_tempfile_from_draft($draftitemid, $filepath, $filename) {
2494         global $USER;
2495         $fs = get_file_storage();
2496         $user_context = context_user::instance($USER->id);
2497         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $draftitemid, $filepath, $filename)) {
2498             $file->delete();
2499             return true;
2500         } else {
2501             return false;
2502         }
2503     }
2505     /**
2506      * Find all external files in this repo and import them
2507      */
2508     public function convert_references_to_local() {
2509         $fs = get_file_storage();
2510         $files = $fs->get_external_files($this->id);
2511         foreach ($files as $storedfile) {
2512             $fs->import_external_file($storedfile);
2513         }
2514     }
2516     /**
2517      * Called from phpunit between tests, resets whatever was cached
2518      */
2519     public static function reset_caches() {
2520         self::sync_external_file(null, true);
2521     }
2523     /**
2524      * Performs synchronisation of reference to an external file if the previous one has expired.
2525      *
2526      * @param stored_file $file
2527      * @param bool $resetsynchistory whether to reset all history of sync (used by phpunit)
2528      * @return bool success
2529      */
2530     public static function sync_external_file($file, $resetsynchistory = false) {
2531         global $DB;
2532         // TODO MDL-25290 static should be replaced with MUC code.
2533         static $synchronized = array();
2534         if ($resetsynchistory) {
2535             $synchronized = array();
2536         }
2538         $fs = get_file_storage();
2540         if (!$file || !$file->get_referencefileid()) {
2541             return false;
2542         }
2543         if (array_key_exists($file->get_id(), $synchronized)) {
2544             return $synchronized[$file->get_id()];
2545         }
2547         // remember that we already cached in current request to prevent from querying again
2548         $synchronized[$file->get_id()] = false;
2550         if (!$reference = $DB->get_record('files_reference', array('id'=>$file->get_referencefileid()))) {
2551             return false;
2552         }
2554         if (!empty($reference->lastsync) and ($reference->lastsync + $reference->lifetime > time())) {
2555             $synchronized[$file->get_id()] = true;
2556             return true;
2557         }
2559         if (!$repository = self::get_repository_by_id($reference->repositoryid, SYSCONTEXTID)) {
2560             return false;
2561         }
2563         if (!$repository->sync_individual_file($file)) {
2564             return false;
2565         }
2567         $lifetime = $repository->get_reference_file_lifetime($reference);
2568         $fileinfo = $repository->get_file_by_reference($reference);
2569         if ($fileinfo === null) {
2570             // does not exist any more - set status to missing
2571             $file->set_missingsource($lifetime);
2572             $synchronized[$file->get_id()] = true;
2573             return true;
2574         }
2576         $contenthash = null;
2577         $filesize = null;
2578         if (!empty($fileinfo->filesize)) {
2579             // filesize returned
2580             if (!empty($fileinfo->contenthash) && $fs->content_exists($fileinfo->contenthash)) {
2581                 // contenthash is specified and valid
2582                 $contenthash = $fileinfo->contenthash;
2583             } else if ($fileinfo->filesize == $file->get_filesize()) {
2584                 // we don't know the new contenthash but the filesize did not change,
2585                 // assume the contenthash did not change either
2586                 $contenthash = $file->get_contenthash();
2587             } else {
2588                 // we can't save empty contenthash so generate contenthash from empty string
2589                 $fs->add_string_to_pool('');
2590                 $contenthash = sha1('');
2591             }
2592             $filesize = $fileinfo->filesize;
2593         } else if (!empty($fileinfo->filepath)) {
2594             // File path returned
2595             list($contenthash, $filesize, $newfile) = $fs->add_file_to_pool($fileinfo->filepath);
2596         } else if (!empty($fileinfo->handle) && is_resource($fileinfo->handle)) {
2597             // File handle returned
2598             $contents = '';
2599             while (!feof($fileinfo->handle)) {
2600                 $contents .= fread($handle, 8192);
2601             }
2602             fclose($fileinfo->handle);
2603             list($contenthash, $filesize, $newfile) = $fs->add_string_to_pool($content);
2604         } else if (isset($fileinfo->content)) {
2605             // File content returned
2606             list($contenthash, $filesize, $newfile) = $fs->add_string_to_pool($fileinfo->content);
2607         }
2609         if (!isset($contenthash) or !isset($filesize)) {
2610             return false;
2611         }
2613         // update files table
2614         $file->set_synchronized($contenthash, $filesize, 0, $lifetime);
2615         $synchronized[$file->get_id()] = true;
2616         return true;
2617     }
2619     /**
2620      * Build draft file's source field
2621      *
2622      * {@link file_restore_source_field_from_draft_file()}
2623      * XXX: This is a hack for file manager (MDL-28666)
2624      * For newly created  draft files we have to construct
2625      * source filed in php serialized data format.
2626      * File manager needs to know the original file information before copying
2627      * to draft area, so we append these information in mdl_files.source field
2628      *
2629      * @param string $source
2630      * @return string serialised source field
2631      */
2632     public static function build_source_field($source) {
2633         $sourcefield = new stdClass;
2634         $sourcefield->source = $source;
2635         return serialize($sourcefield);
2636     }
2639 /**
2640  * Exception class for repository api
2641  *
2642  * @since 2.0
2643  * @package   core_repository
2644  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2645  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2646  */
2647 class repository_exception extends moodle_exception {
2650 /**
2651  * This is a class used to define a repository instance form
2652  *
2653  * @since 2.0
2654  * @package   core_repository
2655  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2656  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2657  */
2658 final class repository_instance_form extends moodleform {
2659     /** @var stdClass repository instance */
2660     protected $instance;
2661     /** @var string repository plugin type */
2662     protected $plugin;
2664     /**
2665      * Added defaults to moodle form
2666      */
2667     protected function add_defaults() {
2668         $mform =& $this->_form;
2669         $strrequired = get_string('required');
2671         $mform->addElement('hidden', 'edit',  ($this->instance) ? $this->instance->id : 0);
2672         $mform->setType('edit', PARAM_INT);
2673         $mform->addElement('hidden', 'new',   $this->plugin);
2674         $mform->setType('new', PARAM_ALPHANUMEXT);
2675         $mform->addElement('hidden', 'plugin', $this->plugin);
2676         $mform->setType('plugin', PARAM_PLUGIN);
2677         $mform->addElement('hidden', 'typeid', $this->typeid);
2678         $mform->setType('typeid', PARAM_INT);
2679         $mform->addElement('hidden', 'contextid', $this->contextid);
2680         $mform->setType('contextid', PARAM_INT);
2682         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
2683         $mform->addRule('name', $strrequired, 'required', null, 'client');
2684         $mform->setType('name', PARAM_TEXT);
2685     }
2687     /**
2688      * Define moodle form elements
2689      */
2690     public function definition() {
2691         global $CFG;
2692         // type of plugin, string
2693         $this->plugin = $this->_customdata['plugin'];
2694         $this->typeid = $this->_customdata['typeid'];
2695         $this->contextid = $this->_customdata['contextid'];
2696         $this->instance = (isset($this->_customdata['instance'])
2697                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2698             ? $this->_customdata['instance'] : null;
2700         $mform =& $this->_form;
2702         $this->add_defaults();
2704         // Add instance config options.
2705         $result = repository::static_function($this->plugin, 'instance_config_form', $mform);
2706         if ($result === false) {
2707             // Remove the name element if no other config options.
2708             $mform->removeElement('name');
2709         }
2710         if ($this->instance) {
2711             $data = array();
2712             $data['name'] = $this->instance->name;
2713             if (!$this->instance->readonly) {
2714                 // and set the data if we have some.
2715                 foreach ($this->instance->get_instance_option_names() as $config) {
2716                     if (!empty($this->instance->options[$config])) {
2717                         $data[$config] = $this->instance->options[$config];
2718                      } else {
2719                         $data[$config] = '';
2720                      }
2721                 }
2722             }
2723             $this->set_data($data);
2724         }
2726         if ($result === false) {
2727             $mform->addElement('cancel');
2728         } else {
2729             $this->add_action_buttons(true, get_string('save','repository'));
2730         }
2731     }
2733     /**
2734      * Validate moodle form data
2735      *
2736      * @param array $data form data
2737      * @param array $files files in form
2738      * @return array errors
2739      */
2740     public function validation($data, $files) {
2741         global $DB;
2742         $errors = array();
2743         $plugin = $this->_customdata['plugin'];
2744         $instance = (isset($this->_customdata['instance'])
2745                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2746             ? $this->_customdata['instance'] : null;
2747         if (!$instance) {
2748             $errors = repository::static_function($plugin, 'instance_form_validation', $this, $data, $errors);
2749         } else {
2750             $errors = $instance->instance_form_validation($this, $data, $errors);
2751         }
2753         $sql = "SELECT count('x')
2754                   FROM {repository_instances} i, {repository} r
2755                  WHERE r.type=:plugin AND r.id=i.typeid AND i.name=:name";
2756         if ($DB->count_records_sql($sql, array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
2757             $errors['name'] = get_string('erroruniquename', 'repository');
2758         }
2760         return $errors;
2761     }
2764 /**
2765  * This is a class used to define a repository type setting form
2766  *
2767  * @since 2.0
2768  * @package   core_repository
2769  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2770  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2771  */
2772 final class repository_type_form extends moodleform {
2773     /** @var stdClass repository instance */
2774     protected $instance;
2775     /** @var string repository plugin name */
2776     protected $plugin;
2777     /** @var string action */
2778     protected $action;
2780     /**
2781      * Definition of the moodleform
2782      */
2783     public function definition() {
2784         global $CFG;
2785         // type of plugin, string
2786         $this->plugin = $this->_customdata['plugin'];
2787         $this->instance = (isset($this->_customdata['instance'])
2788                 && is_a($this->_customdata['instance'], 'repository_type'))
2789             ? $this->_customdata['instance'] : null;
2791         $this->action = $this->_customdata['action'];
2792         $this->pluginname = $this->_customdata['pluginname'];
2793         $mform =& $this->_form;
2794         $strrequired = get_string('required');
2796         $mform->addElement('hidden', 'action', $this->action);
2797         $mform->setType('action', PARAM_TEXT);
2798         $mform->addElement('hidden', 'repos', $this->plugin);
2799         $mform->setType('repos', PARAM_PLUGIN);
2801         // let the plugin add its specific fields
2802         $classname = 'repository_' . $this->plugin;
2803         require_once($CFG->dirroot . '/repository/' . $this->plugin . '/lib.php');
2804         //add "enable course/user instances" checkboxes if multiple instances are allowed
2805         $instanceoptionnames = repository::static_function($this->plugin, 'get_instance_option_names');
2807         $result = call_user_func(array($classname, 'type_config_form'), $mform, $classname);
2809         if (!empty($instanceoptionnames)) {
2810             $sm = get_string_manager();
2811             $component = 'repository';
2812             if ($sm->string_exists('enablecourseinstances', 'repository_' . $this->plugin)) {
2813                 $component .= ('_' . $this->plugin);
2814             }
2815             $mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', $component));
2817             $component = 'repository';
2818             if ($sm->string_exists('enableuserinstances', 'repository_' . $this->plugin)) {
2819                 $component .= ('_' . $this->plugin);
2820             }
2821             $mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', $component));
2822         }
2824         // set the data if we have some.
2825         if ($this->instance) {
2826             $data = array();
2827             $option_names = call_user_func(array($classname,'get_type_option_names'));
2828             if (!empty($instanceoptionnames)){
2829                 $option_names[] = 'enablecourseinstances';
2830                 $option_names[] = 'enableuserinstances';
2831             }
2833             $instanceoptions = $this->instance->get_options();
2834             foreach ($option_names as $config) {
2835                 if (!empty($instanceoptions[$config])) {
2836                     $data[$config] = $instanceoptions[$config];
2837                 } else {
2838                     $data[$config] = '';
2839                 }
2840             }
2841             // XXX: set plugin name for plugins which doesn't have muliti instances
2842             if (empty($instanceoptionnames)){
2843                 $data['pluginname'] = $this->pluginname;
2844             }
2845             $this->set_data($data);
2846         }
2848         $this->add_action_buttons(true, get_string('save','repository'));
2849     }
2851     /**
2852      * Validate moodle form data
2853      *
2854      * @param array $data moodle form data
2855      * @param array $files
2856      * @return array errors
2857      */
2858     public function validation($data, $files) {
2859         $errors = array();
2860         $plugin = $this->_customdata['plugin'];
2861         $instance = (isset($this->_customdata['instance'])
2862                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2863             ? $this->_customdata['instance'] : null;
2864         if (!$instance) {
2865             $errors = repository::static_function($plugin, 'type_form_validation', $this, $data, $errors);
2866         } else {
2867             $errors = $instance->type_form_validation($this, $data, $errors);
2868         }
2870         return $errors;
2871     }
2874 /**
2875  * Generate all options needed by filepicker
2876  *
2877  * @param array $args including following keys
2878  *          context
2879  *          accepted_types
2880  *          return_types
2881  *
2882  * @return array the list of repository instances, including meta infomation, containing the following keys
2883  *          externallink
2884  *          repositories
2885  *          accepted_types
2886  */
2887 function initialise_filepicker($args) {
2888     global $CFG, $USER, $PAGE, $OUTPUT;
2889     static $templatesinitialized = array();
2890     require_once($CFG->libdir . '/licenselib.php');
2892     $return = new stdClass();
2893     $licenses = array();
2894     if (!empty($CFG->licenses)) {
2895         $array = explode(',', $CFG->licenses);
2896         foreach ($array as $license) {
2897             $l = new stdClass();
2898             $l->shortname = $license;
2899             $l->fullname = get_string($license, 'license');
2900             $licenses[] = $l;
2901         }
2902     }
2903     if (!empty($CFG->sitedefaultlicense)) {
2904         $return->defaultlicense = $CFG->sitedefaultlicense;
2905     }
2907     $return->licenses = $licenses;
2909     $return->author = fullname($USER);
2911     if (empty($args->context)) {
2912         $context = $PAGE->context;
2913     } else {
2914         $context = $args->context;
2915     }
2916     $disable_types = array();
2917     if (!empty($args->disable_types)) {
2918         $disable_types = $args->disable_types;
2919     }
2921     $user_context = context_user::instance($USER->id);
2923     list($context, $course, $cm) = get_context_info_array($context->id);
2924     $contexts = array($user_context, get_system_context());
2925     if (!empty($course)) {
2926         // adding course context
2927         $contexts[] = context_course::instance($course->id);
2928     }
2929     $externallink = (int)get_config(null, 'repositoryallowexternallinks');
2930     $repositories = repository::get_instances(array(
2931         'context'=>$contexts,
2932         'currentcontext'=> $context,
2933         'accepted_types'=>$args->accepted_types,
2934         'return_types'=>$args->return_types,
2935         'disable_types'=>$disable_types
2936     ));
2938     $return->repositories = array();
2940     if (empty($externallink)) {
2941         $return->externallink = false;
2942     } else {
2943         $return->externallink = true;
2944     }
2946     $return->userprefs = array();
2947     $return->userprefs['recentrepository'] = get_user_preferences('filepicker_recentrepository', '');
2948     $return->userprefs['recentlicense'] = get_user_preferences('filepicker_recentlicense', '');
2949     $return->userprefs['recentviewmode'] = get_user_preferences('filepicker_recentviewmode', '');
2951     user_preference_allow_ajax_update('filepicker_recentrepository', PARAM_INT);
2952     user_preference_allow_ajax_update('filepicker_recentlicense', PARAM_SAFEDIR);
2953     user_preference_allow_ajax_update('filepicker_recentviewmode', PARAM_INT);
2956     // provided by form element
2957     $return->accepted_types = file_get_typegroup('extension', $args->accepted_types);
2958     $return->return_types = $args->return_types;
2959     $templates = array();
2960     foreach ($repositories as $repository) {
2961         $meta = $repository->get_meta();
2962         // Please note that the array keys for repositories are used within
2963         // JavaScript a lot, the key NEEDS to be the repository id.
2964         $return->repositories[$repository->id] = $meta;
2965         // Register custom repository template if it has one
2966         if(method_exists($repository, 'get_upload_template') && !array_key_exists('uploadform_' . $meta->type, $templatesinitialized)) {
2967             $templates['uploadform_' . $meta->type] = $repository->get_upload_template();
2968             $templatesinitialized['uploadform_' . $meta->type] = true;
2969         }
2970     }
2971     if (!array_key_exists('core', $templatesinitialized)) {
2972         // we need to send each filepicker template to the browser just once
2973         $fprenderer = $PAGE->get_renderer('core', 'files');
2974         $templates = array_merge($templates, $fprenderer->filepicker_js_templates());
2975         $templatesinitialized['core'] = true;
2976     }
2977     if (sizeof($templates)) {
2978         $PAGE->requires->js_init_call('M.core_filepicker.set_templates', array($templates), true);
2979     }
2980     return $return;
2983 /**
2984  * Small function to walk an array to attach repository ID
2985  *
2986  * @param array $value
2987  * @param string $key
2988  * @param int $id
2989  */
2990 function repository_attach_id(&$value, $key, $id){
2991     $value['repo_id'] = $id;