8554b7373f2c2bfadc024c775594c292ab404fe4
[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      * Note that this function does not check permission to access repository contents
531      *
532      * @throws repository_exception
533      *
534      * @param int $repositoryid repository instance ID
535      * @param context|int $context context instance or context ID where this repository will be used
536      * @param array $options additional repository options
537      * @return repository
538      */
539     public static function get_repository_by_id($repositoryid, $context, $options = array()) {
540         global $CFG, $DB;
541         if (!is_object($context)) {
542             $context = context::instance_by_id($context);
543         }
545         $sql = "SELECT i.id, i.name, i.typeid, i.readonly, r.type AS repositorytype, r.visible
546                   FROM {repository_instances} i
547                   JOIN {repository} r ON r.id = i.typeid
548                  WHERE i.id = ?";
550         if (!$record = $DB->get_record_sql($sql, array($repositoryid))) {
551             throw new repository_exception('invalidrepositoryid', 'repository');
552         } else {
553             $type = $record->repositorytype;
554             if (file_exists($CFG->dirroot . "/repository/$type/lib.php")) {
555                 require_once($CFG->dirroot . "/repository/$type/lib.php");
556                 $classname = 'repository_' . $type;
557                 $options['type'] = $type;
558                 $options['typeid'] = $record->typeid;
559                 $options['visible'] = $record->visible;
560                 if (empty($options['name'])) {
561                     $options['name'] = $record->name;
562                 }
563                 $repository = new $classname($repositoryid, $context, $options, $record->readonly);
564                 return $repository;
565             } else {
566                 throw new repository_exception('invalidplugin', 'repository');
567             }
568         }
569     }
571     /**
572      * Returns the type name of the repository.
573      *
574      * @return string type name of the repository.
575      * @since  2.5
576      */
577     public function get_typename() {
578         if (empty($this->typename)) {
579             $matches = array();
580             if (!preg_match("/^repository_(.*)$/", get_class($this), $matches)) {
581                 throw new coding_exception('The class name of a repository should be repository_<typeofrepository>, '.
582                         'e.g. repository_dropbox');
583             }
584             $this->typename = $matches[1];
585         }
586         return $this->typename;
587     }
589     /**
590      * Get a repository type object by a given type name.
591      *
592      * @static
593      * @param string $typename the repository type name
594      * @return repository_type|bool
595      */
596     public static function get_type_by_typename($typename) {
597         global $DB;
599         if (!$record = $DB->get_record('repository',array('type' => $typename))) {
600             return false;
601         }
603         return new repository_type($typename, (array)get_config($typename), $record->visible, $record->sortorder);
604     }
606     /**
607      * Get the repository type by a given repository type id.
608      *
609      * @static
610      * @param int $id the type id
611      * @return object
612      */
613     public static function get_type_by_id($id) {
614         global $DB;
616         if (!$record = $DB->get_record('repository',array('id' => $id))) {
617             return false;
618         }
620         return new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
621     }
623     /**
624      * Return all repository types ordered by sortorder field
625      * first repository type in returnedarray[0], second repository type in returnedarray[1], ...
626      *
627      * @static
628      * @param bool $visible can return types by visiblity, return all types if null
629      * @return array Repository types
630      */
631     public static function get_types($visible=null) {
632         global $DB, $CFG;
634         $types = array();
635         $params = null;
636         if (!empty($visible)) {
637             $params = array('visible' => $visible);
638         }
639         if ($records = $DB->get_records('repository',$params,'sortorder')) {
640             foreach($records as $type) {
641                 if (file_exists($CFG->dirroot . '/repository/'. $type->type .'/lib.php')) {
642                     $types[] = new repository_type($type->type, (array)get_config($type->type), $type->visible, $type->sortorder);
643                 }
644             }
645         }
647         return $types;
648     }
650     /**
651      * Checks if user has a capability to view the current repository.
652      *
653      * @return bool true when the user can, otherwise throws an exception.
654      * @throws repository_exception when the user does not meet the requirements.
655      */
656     public final function check_capability() {
657         global $USER;
659         // The context we are on.
660         $currentcontext = $this->context;
662         // Ensure that the user can view the repository in the current context.
663         $can = has_capability('repository/'.$this->get_typename().':view', $currentcontext);
665         // Context in which the repository has been created.
666         $repocontext = context::instance_by_id($this->instance->contextid);
668         // Prevent access to private repositories when logged in as.
669         if ($can && session_is_loggedinas()) {
670             if ($this->contains_private_data() || $repocontext->contextlevel == CONTEXT_USER) {
671                 $can = false;
672             }
673         }
675         // We are going to ensure that the current context was legit, and reliable to check
676         // the capability against. (No need to do that if we already cannot).
677         if ($can) {
678             if ($repocontext->contextlevel == CONTEXT_USER) {
679                 // The repository is a user instance, ensure we're the right user to access it!
680                 if ($repocontext->instanceid != $USER->id) {
681                     $can = false;
682                 }
683             } else if ($repocontext->contextlevel == CONTEXT_COURSE) {
684                 // The repository is a course one. Let's check that we are on the right course.
685                 if (in_array($currentcontext->contextlevel, array(CONTEXT_COURSE, CONTEXT_MODULE, CONTEXT_BLOCK))) {
686                     $coursecontext = $currentcontext->get_course_context();
687                     if ($coursecontext->instanceid != $repocontext->instanceid) {
688                         $can = false;
689                     }
690                 } else {
691                     // We are on a parent context, therefore it's legit to check the permissions
692                     // in the current context.
693                 }
694             } else {
695                 // Nothing to check here, system instances can have different permissions on different
696                 // levels. We do not want to prevent URL hack here, because it does not make sense to
697                 // prevent a user to access a repository in a context if it's accessible in another one.
698             }
699         }
701         if ($can) {
702             return true;
703         }
705         throw new repository_exception('nopermissiontoaccess', 'repository');
706     }
708     /**
709      * Check if file already exists in draft area.
710      *
711      * @static
712      * @param int $itemid of the draft area.
713      * @param string $filepath path to the file.
714      * @param string $filename file name.
715      * @return bool
716      */
717     public static function draftfile_exists($itemid, $filepath, $filename) {
718         global $USER;
719         $fs = get_file_storage();
720         $usercontext = context_user::instance($USER->id);
721         return $fs->file_exists($usercontext->id, 'user', 'draft', $itemid, $filepath, $filename);
722     }
724     /**
725      * Parses the 'source' returned by moodle repositories and returns an instance of stored_file
726      *
727      * @param string $source
728      * @return stored_file|null
729      */
730     public static function get_moodle_file($source) {
731         $params = file_storage::unpack_reference($source, true);
732         $fs = get_file_storage();
733         return $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
734                     $params['itemid'], $params['filepath'], $params['filename']);
735     }
737     /**
738      * Repository method to make sure that user can access particular file.
739      *
740      * This is checked when user tries to pick the file from repository to deal with
741      * potential parameter substitutions is request
742      *
743      * @param string $source
744      * @return bool whether the file is accessible by current user
745      */
746     public function file_is_accessible($source) {
747         if ($this->has_moodle_files()) {
748             try {
749                 $params = file_storage::unpack_reference($source, true);
750             } catch (file_reference_exception $e) {
751                 return false;
752             }
753             $browser = get_file_browser();
754             $context = context::instance_by_id($params['contextid']);
755             $file_info = $browser->get_file_info($context, $params['component'], $params['filearea'],
756                     $params['itemid'], $params['filepath'], $params['filename']);
757             return !empty($file_info);
758         }
759         return true;
760     }
762     /**
763      * This function is used to copy a moodle file to draft area.
764      *
765      * It DOES NOT check if the user is allowed to access this file because the actual file
766      * can be located in the area where user does not have access to but there is an alias
767      * to this file in the area where user CAN access it.
768      * {@link file_is_accessible} should be called for alias location before calling this function.
769      *
770      * @param string $source The metainfo of file, it is base64 encoded php serialized data
771      * @param stdClass|array $filerecord contains itemid, filepath, filename and optionally other
772      *      attributes of the new file
773      * @param int $maxbytes maximum allowed size of file, -1 if unlimited. If size of file exceeds
774      *      the limit, the file_exception is thrown.
775      * @param int $areamaxbytes the maximum size of the area. A file_exception is thrown if the
776      *      new file will reach the limit.
777      * @return array The information about the created file
778      */
779     public function copy_to_area($source, $filerecord, $maxbytes = -1, $areamaxbytes = FILE_AREA_MAX_BYTES_UNLIMITED) {
780         global $USER;
781         $fs = get_file_storage();
783         if ($this->has_moodle_files() == false) {
784             throw new coding_exception('Only repository used to browse moodle files can use repository::copy_to_area()');
785         }
787         $user_context = context_user::instance($USER->id);
789         $filerecord = (array)$filerecord;
790         // make sure the new file will be created in user draft area
791         $filerecord['component'] = 'user';
792         $filerecord['filearea'] = 'draft';
793         $filerecord['contextid'] = $user_context->id;
794         $draftitemid = $filerecord['itemid'];
795         $new_filepath = $filerecord['filepath'];
796         $new_filename = $filerecord['filename'];
798         // the file needs to copied to draft area
799         $stored_file = self::get_moodle_file($source);
800         if ($maxbytes != -1 && $stored_file->get_filesize() > $maxbytes) {
801             throw new file_exception('maxbytes');
802         }
803         // Validate the size of the draft area.
804         if (file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $stored_file->get_filesize())) {
805             throw new file_exception('maxareabytes');
806         }
808         if (repository::draftfile_exists($draftitemid, $new_filepath, $new_filename)) {
809             // create new file
810             $unused_filename = repository::get_unused_filename($draftitemid, $new_filepath, $new_filename);
811             $filerecord['filename'] = $unused_filename;
812             $fs->create_file_from_storedfile($filerecord, $stored_file);
813             $event = array();
814             $event['event'] = 'fileexists';
815             $event['newfile'] = new stdClass;
816             $event['newfile']->filepath = $new_filepath;
817             $event['newfile']->filename = $unused_filename;
818             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $unused_filename)->out();
819             $event['existingfile'] = new stdClass;
820             $event['existingfile']->filepath = $new_filepath;
821             $event['existingfile']->filename = $new_filename;
822             $event['existingfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
823             return $event;
824         } else {
825             $fs->create_file_from_storedfile($filerecord, $stored_file);
826             $info = array();
827             $info['itemid'] = $draftitemid;
828             $info['file'] = $new_filename;
829             $info['title'] = $new_filename;
830             $info['contextid'] = $user_context->id;
831             $info['url'] = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();
832             $info['filesize'] = $stored_file->get_filesize();
833             return $info;
834         }
835     }
837     /**
838      * Get an unused filename from the current draft area.
839      *
840      * Will check if the file ends with ([0-9]) and increase the number.
841      *
842      * @static
843      * @param int $itemid draft item ID.
844      * @param string $filepath path to the file.
845      * @param string $filename name of the file.
846      * @return string an unused file name.
847      */
848     public static function get_unused_filename($itemid, $filepath, $filename) {
849         global $USER;
850         $contextid = context_user::instance($USER->id)->id;
851         $fs = get_file_storage();
852         return $fs->get_unused_filename($contextid, 'user', 'draft', $itemid, $filepath, $filename);
853     }
855     /**
856      * Append a suffix to filename.
857      *
858      * @static
859      * @param string $filename
860      * @return string
861      * @deprecated since 2.5
862      */
863     public static function append_suffix($filename) {
864         debugging('The function repository::append_suffix() has been deprecated. Use repository::get_unused_filename() instead.',
865             DEBUG_DEVELOPER);
866         $pathinfo = pathinfo($filename);
867         if (empty($pathinfo['extension'])) {
868             return $filename . RENAME_SUFFIX;
869         } else {
870             return $pathinfo['filename'] . RENAME_SUFFIX . '.' . $pathinfo['extension'];
871         }
872     }
874     /**
875      * Return all types that you a user can create/edit and which are also visible
876      * Note: Mostly used in order to know if at least one editable type can be set
877      *
878      * @static
879      * @param stdClass $context the context for which we want the editable types
880      * @return array types
881      */
882     public static function get_editable_types($context = null) {
884         if (empty($context)) {
885             $context = get_system_context();
886         }
888         $types= repository::get_types(true);
889         $editabletypes = array();
890         foreach ($types as $type) {
891             $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
892             if (!empty($instanceoptionnames)) {
893                 if ($type->get_contextvisibility($context)) {
894                     $editabletypes[]=$type;
895                 }
896              }
897         }
898         return $editabletypes;
899     }
901     /**
902      * Return repository instances
903      *
904      * @static
905      * @param array $args Array containing the following keys:
906      *           currentcontext
907      *           context
908      *           onlyvisible
909      *           type
910      *           accepted_types
911      *           return_types
912      *           userid
913      *
914      * @return array repository instances
915      */
916     public static function get_instances($args = array()) {
917         global $DB, $CFG, $USER;
919         if (isset($args['currentcontext'])) {
920             $current_context = $args['currentcontext'];
921         } else {
922             $current_context = get_system_context();
923         }
925         if (!empty($args['context'])) {
926             $contexts = $args['context'];
927         } else {
928             $contexts = array();
929         }
931         $onlyvisible = isset($args['onlyvisible']) ? $args['onlyvisible'] : true;
932         $returntypes = isset($args['return_types']) ? $args['return_types'] : 3;
933         $type        = isset($args['type']) ? $args['type'] : null;
935         $params = array();
936         $sql = "SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
937                   FROM {repository} r, {repository_instances} i
938                  WHERE i.typeid = r.id ";
940         if (!empty($args['disable_types']) && is_array($args['disable_types'])) {
941             list($types, $p) = $DB->get_in_or_equal($args['disable_types'], SQL_PARAMS_QM, 'param', false);
942             $sql .= " AND r.type $types";
943             $params = array_merge($params, $p);
944         }
946         if (!empty($args['userid']) && is_numeric($args['userid'])) {
947             $sql .= " AND (i.userid = 0 or i.userid = ?)";
948             $params[] = $args['userid'];
949         }
951         foreach ($contexts as $context) {
952             if (empty($firstcontext)) {
953                 $firstcontext = true;
954                 $sql .= " AND ((i.contextid = ?)";
955             } else {
956                 $sql .= " OR (i.contextid = ?)";
957             }
958             $params[] = $context->id;
959         }
961         if (!empty($firstcontext)) {
962            $sql .=')';
963         }
965         if ($onlyvisible == true) {
966             $sql .= " AND (r.visible = 1)";
967         }
969         if (isset($type)) {
970             $sql .= " AND (r.type = ?)";
971             $params[] = $type;
972         }
973         $sql .= " ORDER BY r.sortorder, i.name";
975         if (!$records = $DB->get_records_sql($sql, $params)) {
976             $records = array();
977         }
979         $repositories = array();
980         if (isset($args['accepted_types'])) {
981             $accepted_types = $args['accepted_types'];
982             if (is_array($accepted_types) && in_array('*', $accepted_types)) {
983                 $accepted_types = '*';
984             }
985         } else {
986             $accepted_types = '*';
987         }
988         // Sortorder should be unique, which is not true if we use $record->sortorder
989         // and there are multiple instances of any repository type
990         $sortorder = 1;
991         foreach ($records as $record) {
992             if (!file_exists($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php')) {
993                 continue;
994             }
995             require_once($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php');
996             $options['visible'] = $record->visible;
997             $options['type']    = $record->repositorytype;
998             $options['typeid']  = $record->typeid;
999             // tell instance what file types will be accepted by file picker
1000             $classname = 'repository_' . $record->repositorytype;
1002             $repository = new $classname($record->id, $current_context, $options, $record->readonly);
1003             $repository->options['sortorder'] = $sortorder++;
1005             $is_supported = true;
1007             if (empty($repository->super_called)) {
1008                 // to make sure the super construct is called
1009                 debugging('parent::__construct must be called by '.$record->repositorytype.' plugin.');
1010             } else {
1011                 // check mimetypes
1012                 if ($accepted_types !== '*' and $repository->supported_filetypes() !== '*') {
1013                     $accepted_ext = file_get_typegroup('extension', $accepted_types);
1014                     $supported_ext = file_get_typegroup('extension', $repository->supported_filetypes());
1015                     $valid_ext = array_intersect($accepted_ext, $supported_ext);
1016                     $is_supported = !empty($valid_ext);
1017                 }
1018                 // check return values
1019                 if ($returntypes !== 3 and $repository->supported_returntypes() !== 3) {
1020                     $type = $repository->supported_returntypes();
1021                     if ($type & $returntypes) {
1022                         //
1023                     } else {
1024                         $is_supported = false;
1025                     }
1026                 }
1028                 if (!$onlyvisible || ($repository->is_visible() && !$repository->disabled)) {
1029                     // check capability in current context
1030                     $capability = has_capability('repository/'.$record->repositorytype.':view', $current_context);
1031                     if ($record->repositorytype == 'coursefiles') {
1032                         // coursefiles plugin needs managefiles permission
1033                         $capability = $capability && has_capability('moodle/course:managefiles', $current_context);
1034                     }
1035                     if ($is_supported && $capability) {
1036                         $repositories[$repository->id] = $repository;
1037                     }
1038                 }
1039             }
1040         }
1041         return $repositories;
1042     }
1044     /**
1045      * Get single repository instance for administrative actions
1046      *
1047      * Do not use this function to access repository contents, because it
1048      * does not set the current context
1049      *
1050      * @see rpository::get_repository_by_id()
1051      *
1052      * @static
1053      * @param integer $id repository instance id
1054      * @return repository
1055      */
1056     public static function get_instance($id) {
1057         return self::get_repository_by_id($id, context_system::instance());
1058     }
1060     /**
1061      * Call a static function. Any additional arguments than plugin and function will be passed through.
1062      *
1063      * @static
1064      * @param string $plugin repository plugin name
1065      * @param string $function funciton name
1066      * @return mixed
1067      */
1068     public static function static_function($plugin, $function) {
1069         global $CFG;
1071         //check that the plugin exists
1072         $typedirectory = $CFG->dirroot . '/repository/'. $plugin . '/lib.php';
1073         if (!file_exists($typedirectory)) {
1074             //throw new repository_exception('invalidplugin', 'repository');
1075             return false;
1076         }
1078         $pname = null;
1079         if (is_object($plugin) || is_array($plugin)) {
1080             $plugin = (object)$plugin;
1081             $pname = $plugin->name;
1082         } else {
1083             $pname = $plugin;
1084         }
1086         $args = func_get_args();
1087         if (count($args) <= 2) {
1088             $args = array();
1089         } else {
1090             array_shift($args);
1091             array_shift($args);
1092         }
1094         require_once($typedirectory);
1095         return call_user_func_array(array('repository_' . $plugin, $function), $args);
1096     }
1098     /**
1099      * Scan file, throws exception in case of infected file.
1100      *
1101      * Please note that the scanning engine must be able to access the file,
1102      * permissions of the file are not modified here!
1103      *
1104      * @static
1105      * @param string $thefile
1106      * @param string $filename name of the file
1107      * @param bool $deleteinfected
1108      */
1109     public static function antivir_scan_file($thefile, $filename, $deleteinfected) {
1110         global $CFG;
1112         if (!is_readable($thefile)) {
1113             // this should not happen
1114             return;
1115         }
1117         if (empty($CFG->runclamonupload) or empty($CFG->pathtoclam)) {
1118             // clam not enabled
1119             return;
1120         }
1122         $CFG->pathtoclam = trim($CFG->pathtoclam);
1124         if (!file_exists($CFG->pathtoclam) or !is_executable($CFG->pathtoclam)) {
1125             // misconfigured clam - use the old notification for now
1126             require("$CFG->libdir/uploadlib.php");
1127             $notice = get_string('clamlost', 'moodle', $CFG->pathtoclam);
1128             clam_message_admins($notice);
1129             return;
1130         }
1132         // do NOT mess with permissions here, the calling party is responsible for making
1133         // sure the scanner engine can access the files!
1135         // execute test
1136         $cmd = escapeshellcmd($CFG->pathtoclam).' --stdout '.escapeshellarg($thefile);
1137         exec($cmd, $output, $return);
1139         if ($return == 0) {
1140             // perfect, no problem found
1141             return;
1143         } else if ($return == 1) {
1144             // infection found
1145             if ($deleteinfected) {
1146                 unlink($thefile);
1147             }
1148             throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1150         } else {
1151             //unknown problem
1152             require("$CFG->libdir/uploadlib.php");
1153             $notice = get_string('clamfailed', 'moodle', get_clam_error_code($return));
1154             $notice .= "\n\n". implode("\n", $output);
1155             clam_message_admins($notice);
1156             if ($CFG->clamfailureonupload === 'actlikevirus') {
1157                 if ($deleteinfected) {
1158                     unlink($thefile);
1159                 }
1160                 throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1161             } else {
1162                 return;
1163             }
1164         }
1165     }
1167     /**
1168      * Repository method to serve the referenced file
1169      *
1170      * @see send_stored_file
1171      *
1172      * @param stored_file $storedfile the file that contains the reference
1173      * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
1174      * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1175      * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1176      * @param array $options additional options affecting the file serving
1177      */
1178     public function send_file($storedfile, $lifetime=86400 , $filter=0, $forcedownload=false, array $options = null) {
1179         if ($this->has_moodle_files()) {
1180             $fs = get_file_storage();
1181             $params = file_storage::unpack_reference($storedfile->get_reference(), true);
1182             $srcfile = null;
1183             if (is_array($params)) {
1184                 $srcfile = $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
1185                         $params['itemid'], $params['filepath'], $params['filename']);
1186             }
1187             if (empty($options)) {
1188                 $options = array();
1189             }
1190             if (!isset($options['filename'])) {
1191                 $options['filename'] = $storedfile->get_filename();
1192             }
1193             if (!$srcfile) {
1194                 send_file_not_found();
1195             } else {
1196                 send_stored_file($srcfile, $lifetime, $filter, $forcedownload, $options);
1197             }
1198         } else {
1199             throw new coding_exception("Repository plugin must implement send_file() method.");
1200         }
1201     }
1203     /**
1204      * Return reference file life time
1205      *
1206      * @param string $ref
1207      * @return int
1208      */
1209     public function get_reference_file_lifetime($ref) {
1210         // One day
1211         return 60 * 60 * 24;
1212     }
1214     /**
1215      * Decide whether or not the file should be synced
1216      *
1217      * @param stored_file $storedfile
1218      * @return bool
1219      */
1220     public function sync_individual_file(stored_file $storedfile) {
1221         return true;
1222     }
1224     /**
1225      * Return human readable reference information
1226      *
1227      * @param string $reference value of DB field files_reference.reference
1228      * @param int $filestatus status of the file, 0 - ok, 666 - source missing
1229      * @return string
1230      */
1231     public function get_reference_details($reference, $filestatus = 0) {
1232         if ($this->has_moodle_files()) {
1233             $fileinfo = null;
1234             $params = file_storage::unpack_reference($reference, true);
1235             if (is_array($params)) {
1236                 $context = context::instance_by_id($params['contextid'], IGNORE_MISSING);
1237                 if ($context) {
1238                     $browser = get_file_browser();
1239                     $fileinfo = $browser->get_file_info($context, $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']);
1240                 }
1241             }
1242             if (empty($fileinfo)) {
1243                 if ($filestatus == 666) {
1244                     if (is_siteadmin() || ($context && has_capability('moodle/course:managefiles', $context))) {
1245                         return get_string('lostsource', 'repository',
1246                                 $params['contextid']. '/'. $params['component']. '/'. $params['filearea']. '/'. $params['itemid']. $params['filepath']. $params['filename']);
1247                     } else {
1248                         return get_string('lostsource', 'repository', '');
1249                     }
1250                 }
1251                 return get_string('undisclosedsource', 'repository');
1252             } else {
1253                 return $fileinfo->get_readable_fullname();
1254             }
1255         }
1256         return '';
1257     }
1259     /**
1260      * Cache file from external repository by reference
1261      * {@link repository::get_file_reference()}
1262      * {@link repository::get_file()}
1263      * Invoked at MOODLE/repository/repository_ajax.php
1264      *
1265      * @param string $reference this reference is generated by
1266      *                          repository::get_file_reference()
1267      * @param stored_file $storedfile created file reference
1268      */
1269     public function cache_file_by_reference($reference, $storedfile) {
1270     }
1272     /**
1273      * Returns information about file in this repository by reference
1274      *
1275      * This function must be implemented for repositories supporting FILE_REFERENCE, it is called
1276      * for existing aliases when the lifetime of the previous syncronisation has expired.
1277      *
1278      * Returns null if file not found or is not readable or timeout occured during request.
1279      * Note that this function may be run for EACH file that needs to be synchronised at the
1280      * moment. If anything is being downloaded or requested from external sources there
1281      * should be a small timeout. The synchronisation is performed to update the size of
1282      * the file and/or to update image and re-generated image preview. There is nothing
1283      * fatal if syncronisation fails but it is fatal if syncronisation takes too long
1284      * and hangs the script generating a page.
1285      *
1286      * If get_file_by_reference() returns filesize just the record in {files} table is being updated.
1287      * If filepath, handle or content are returned - the file is also stored in moodle filepool
1288      * (recommended for images to generate the thumbnails). For non-image files it is not
1289      * recommended to download them to moodle during syncronisation since it may take
1290      * unnecessary long time.
1291      *
1292      * @param stdClass $reference record from DB table {files_reference}
1293      * @return stdClass|null contains one of the following:
1294      *   - 'filesize' and optionally 'contenthash'
1295      *   - 'filepath'
1296      *   - 'handle'
1297      *   - 'content'
1298      */
1299     public function get_file_by_reference($reference) {
1300         if ($this->has_moodle_files() && isset($reference->reference)) {
1301             $fs = get_file_storage();
1302             $params = file_storage::unpack_reference($reference->reference, true);
1303             if (!is_array($params) || !($storedfile = $fs->get_file($params['contextid'],
1304                     $params['component'], $params['filearea'], $params['itemid'], $params['filepath'],
1305                     $params['filename']))) {
1306                 return null;
1307             }
1308             return (object)array(
1309                 'contenthash' => $storedfile->get_contenthash(),
1310                 'filesize'    => $storedfile->get_filesize()
1311             );
1312         }
1313         return null;
1314     }
1316     /**
1317      * Return the source information
1318      *
1319      * The result of the function is stored in files.source field. It may be analysed
1320      * when the source file is lost or repository may use it to display human-readable
1321      * location of reference original.
1322      *
1323      * This method is called when file is picked for the first time only. When file
1324      * (either copy or a reference) is already in moodle and it is being picked
1325      * again to another file area (also as a copy or as a reference), the value of
1326      * files.source is copied.
1327      *
1328      * @param string $source the value that repository returned in listing as 'source'
1329      * @return string|null
1330      */
1331     public function get_file_source_info($source) {
1332         if ($this->has_moodle_files()) {
1333             return $this->get_reference_details($source, 0);
1334         }
1335         return $source;
1336     }
1338     /**
1339      * Move file from download folder to file pool using FILE API
1340      *
1341      * @todo MDL-28637
1342      * @static
1343      * @param string $thefile file path in download folder
1344      * @param stdClass $record
1345      * @return array containing the following keys:
1346      *           icon
1347      *           file
1348      *           id
1349      *           url
1350      */
1351     public static function move_to_filepool($thefile, $record) {
1352         global $DB, $CFG, $USER, $OUTPUT;
1354         // scan for viruses if possible, throws exception if problem found
1355         self::antivir_scan_file($thefile, $record->filename, empty($CFG->repository_no_delete)); //TODO: MDL-28637 this repository_no_delete is a bloody hack!
1357         $fs = get_file_storage();
1358         // If file name being used.
1359         if (repository::draftfile_exists($record->itemid, $record->filepath, $record->filename)) {
1360             $draftitemid = $record->itemid;
1361             $new_filename = repository::get_unused_filename($draftitemid, $record->filepath, $record->filename);
1362             $old_filename = $record->filename;
1363             // Create a tmp file.
1364             $record->filename = $new_filename;
1365             $newfile = $fs->create_file_from_pathname($record, $thefile);
1366             $event = array();
1367             $event['event'] = 'fileexists';
1368             $event['newfile'] = new stdClass;
1369             $event['newfile']->filepath = $record->filepath;
1370             $event['newfile']->filename = $new_filename;
1371             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $new_filename)->out();
1373             $event['existingfile'] = new stdClass;
1374             $event['existingfile']->filepath = $record->filepath;
1375             $event['existingfile']->filename = $old_filename;
1376             $event['existingfile']->url      = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $old_filename)->out();
1377             return $event;
1378         }
1379         if ($file = $fs->create_file_from_pathname($record, $thefile)) {
1380             if (empty($CFG->repository_no_delete)) {
1381                 $delete = unlink($thefile);
1382                 unset($CFG->repository_no_delete);
1383             }
1384             return array(
1385                 'url'=>moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename())->out(),
1386                 'id'=>$file->get_itemid(),
1387                 'file'=>$file->get_filename(),
1388                 'icon' => $OUTPUT->pix_url(file_extension_icon($thefile, 32))->out(),
1389             );
1390         } else {
1391             return null;
1392         }
1393     }
1395     /**
1396      * Builds a tree of files This function is then called recursively.
1397      *
1398      * @static
1399      * @todo take $search into account, and respect a threshold for dynamic loading
1400      * @param file_info $fileinfo an object returned by file_browser::get_file_info()
1401      * @param string $search searched string
1402      * @param bool $dynamicmode no recursive call is done when in dynamic mode
1403      * @param array $list the array containing the files under the passed $fileinfo
1404      * @return int the number of files found
1405      */
1406     public static function build_tree($fileinfo, $search, $dynamicmode, &$list) {
1407         global $CFG, $OUTPUT;
1409         $filecount = 0;
1410         $children = $fileinfo->get_children();
1412         foreach ($children as $child) {
1413             $filename = $child->get_visible_name();
1414             $filesize = $child->get_filesize();
1415             $filesize = $filesize ? display_size($filesize) : '';
1416             $filedate = $child->get_timemodified();
1417             $filedate = $filedate ? userdate($filedate) : '';
1418             $filetype = $child->get_mimetype();
1420             if ($child->is_directory()) {
1421                 $path = array();
1422                 $level = $child->get_parent();
1423                 while ($level) {
1424                     $params = $level->get_params();
1425                     $path[] = array($params['filepath'], $level->get_visible_name());
1426                     $level = $level->get_parent();
1427                 }
1429                 $tmp = array(
1430                     'title' => $child->get_visible_name(),
1431                     'size' => 0,
1432                     'date' => $filedate,
1433                     'path' => array_reverse($path),
1434                     'thumbnail' => $OUTPUT->pix_url(file_folder_icon(90))->out(false)
1435                 );
1437                 //if ($dynamicmode && $child->is_writable()) {
1438                 //    $tmp['children'] = array();
1439                 //} else {
1440                     // if folder name matches search, we send back all files contained.
1441                 $_search = $search;
1442                 if ($search && stristr($tmp['title'], $search) !== false) {
1443                     $_search = false;
1444                 }
1445                 $tmp['children'] = array();
1446                 $_filecount = repository::build_tree($child, $_search, $dynamicmode, $tmp['children']);
1447                 if ($search && $_filecount) {
1448                     $tmp['expanded'] = 1;
1449                 }
1451                 //}
1453                 if (!$search || $_filecount || (stristr($tmp['title'], $search) !== false)) {
1454                     $filecount += $_filecount;
1455                     $list[] = $tmp;
1456                 }
1458             } else { // not a directory
1459                 // skip the file, if we're in search mode and it's not a match
1460                 if ($search && (stristr($filename, $search) === false)) {
1461                     continue;
1462                 }
1463                 $params = $child->get_params();
1464                 $source = serialize(array($params['contextid'], $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']));
1465                 $list[] = array(
1466                     'title' => $filename,
1467                     'size' => $filesize,
1468                     'date' => $filedate,
1469                     //'source' => $child->get_url(),
1470                     'source' => base64_encode($source),
1471                     'icon'=>$OUTPUT->pix_url(file_file_icon($child, 24))->out(false),
1472                     'thumbnail'=>$OUTPUT->pix_url(file_file_icon($child, 90))->out(false),
1473                 );
1474                 $filecount++;
1475             }
1476         }
1478         return $filecount;
1479     }
1481     /**
1482      * Display a repository instance list (with edit/delete/create links)
1483      *
1484      * @static
1485      * @param stdClass $context the context for which we display the instance
1486      * @param string $typename if set, we display only one type of instance
1487      */
1488     public static function display_instances_list($context, $typename = null) {
1489         global $CFG, $USER, $OUTPUT;
1491         $output = $OUTPUT->box_start('generalbox');
1492         //if the context is SYSTEM, so we call it from administration page
1493         $admin = ($context->id == SYSCONTEXTID) ? true : false;
1494         if ($admin) {
1495             $baseurl = new moodle_url('/'.$CFG->admin.'/repositoryinstance.php', array('sesskey'=>sesskey()));
1496             $output .= $OUTPUT->heading(get_string('siteinstances', 'repository'));
1497         } else {
1498             $baseurl = new moodle_url('/repository/manage_instances.php', array('contextid'=>$context->id, 'sesskey'=>sesskey()));
1499         }
1501         $namestr = get_string('name');
1502         $pluginstr = get_string('plugin', 'repository');
1503         $settingsstr = get_string('settings');
1504         $deletestr = get_string('delete');
1505         // Retrieve list of instances. In administration context we want to display all
1506         // instances of a type, even if this type is not visible. In course/user context we
1507         // want to display only visible instances, but for every type types. The repository::get_instances()
1508         // third parameter displays only visible type.
1509         $params = array();
1510         $params['context'] = array($context);
1511         $params['currentcontext'] = $context;
1512         $params['onlyvisible'] = !$admin;
1513         $params['type']        = $typename;
1514         $instances = repository::get_instances($params);
1515         $instancesnumber = count($instances);
1516         $alreadyplugins = array();
1518         $table = new html_table();
1519         $table->head = array($namestr, $pluginstr, $settingsstr, $deletestr);
1520         $table->align = array('left', 'left', 'center','center');
1521         $table->data = array();
1523         $updowncount = 1;
1525         foreach ($instances as $i) {
1526             $settings = '';
1527             $delete = '';
1529             $type = repository::get_type_by_id($i->options['typeid']);
1531             if ($type->get_contextvisibility($context)) {
1532                 if (!$i->readonly) {
1534                     $settingurl = new moodle_url($baseurl);
1535                     $settingurl->param('type', $i->options['type']);
1536                     $settingurl->param('edit', $i->id);
1537                     $settings .= html_writer::link($settingurl, $settingsstr);
1539                     $deleteurl = new moodle_url($baseurl);
1540                     $deleteurl->param('delete', $i->id);
1541                     $deleteurl->param('type', $i->options['type']);
1542                     $delete .= html_writer::link($deleteurl, $deletestr);
1543                 }
1544             }
1546             $type = repository::get_type_by_id($i->options['typeid']);
1547             $table->data[] = array(format_string($i->name), $type->get_readablename(), $settings, $delete);
1549             //display a grey row if the type is defined as not visible
1550             if (isset($type) && !$type->get_visible()) {
1551                 $table->rowclasses[] = 'dimmed_text';
1552             } else {
1553                 $table->rowclasses[] = '';
1554             }
1556             if (!in_array($i->name, $alreadyplugins)) {
1557                 $alreadyplugins[] = $i->name;
1558             }
1559         }
1560         $output .= html_writer::table($table);
1561         $instancehtml = '<div>';
1562         $addable = 0;
1564         //if no type is set, we can create all type of instance
1565         if (!$typename) {
1566             $instancehtml .= '<h3>';
1567             $instancehtml .= get_string('createrepository', 'repository');
1568             $instancehtml .= '</h3><ul>';
1569             $types = repository::get_editable_types($context);
1570             foreach ($types as $type) {
1571                 if (!empty($type) && $type->get_visible()) {
1572                     // If the user does not have the permission to view the repository, it won't be displayed in
1573                     // the list of instances. Hiding the link to create new instances will prevent the
1574                     // user from creating them without being able to find them afterwards, which looks like a bug.
1575                     if (!has_capability('repository/'.$type->get_typename().':view', $context)) {
1576                         continue;
1577                     }
1578                     $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
1579                     if (!empty($instanceoptionnames)) {
1580                         $baseurl->param('new', $type->get_typename());
1581                         $instancehtml .= '<li><a href="'.$baseurl->out().'">'.get_string('createxxinstance', 'repository', get_string('pluginname', 'repository_'.$type->get_typename())).  '</a></li>';
1582                         $baseurl->remove_params('new');
1583                         $addable++;
1584                     }
1585                 }
1586             }
1587             $instancehtml .= '</ul>';
1589         } else {
1590             $instanceoptionnames = repository::static_function($typename, 'get_instance_option_names');
1591             if (!empty($instanceoptionnames)) {   //create a unique type of instance
1592                 $addable = 1;
1593                 $baseurl->param('new', $typename);
1594                 $output .= $OUTPUT->single_button($baseurl, get_string('createinstance', 'repository'), 'get');
1595                 $baseurl->remove_params('new');
1596             }
1597         }
1599         if ($addable) {
1600             $instancehtml .= '</div>';
1601             $output .= $instancehtml;
1602         }
1604         $output .= $OUTPUT->box_end();
1606         //print the list + creation links
1607         print($output);
1608     }
1610     /**
1611      * Prepare file reference information
1612      *
1613      * @param string $source
1614      * @return string file referece
1615      */
1616     public function get_file_reference($source) {
1617         if ($this->has_moodle_files() && ($this->supported_returntypes() & FILE_REFERENCE)) {
1618             $params = file_storage::unpack_reference($source);
1619             if (!is_array($params)) {
1620                 throw new repository_exception('invalidparams', 'repository');
1621             }
1622             return file_storage::pack_reference($params);
1623         }
1624         return $source;
1625     }
1627     /**
1628      * Decide where to save the file, can be overwriten by subclass
1629      *
1630      * @param string $filename file name
1631      * @return file path
1632      */
1633     public function prepare_file($filename) {
1634         global $CFG;
1635         $dir = make_temp_directory('download/'.get_class($this).'/');
1636         while (empty($filename) || file_exists($dir.$filename)) {
1637             $filename = uniqid('', true).'_'.time().'.tmp';
1638         }
1639         return $dir.$filename;
1640     }
1642     /**
1643      * Does this repository used to browse moodle files?
1644      *
1645      * @return bool
1646      */
1647     public function has_moodle_files() {
1648         return false;
1649     }
1651     /**
1652      * Return file URL, for most plugins, the parameter is the original
1653      * url, but some plugins use a file id, so we need this function to
1654      * convert file id to original url.
1655      *
1656      * @param string $url the url of file
1657      * @return string
1658      */
1659     public function get_link($url) {
1660         return $url;
1661     }
1663     /**
1664      * Downloads a file from external repository and saves it in temp dir
1665      *
1666      * Function get_file() must be implemented by repositories that support returntypes
1667      * FILE_INTERNAL or FILE_REFERENCE. It is invoked to pick up the file and copy it
1668      * to moodle. This function is not called for moodle repositories, the function
1669      * {@link repository::copy_to_area()} is used instead.
1670      *
1671      * This function can be overridden by subclass if the files.reference field contains
1672      * not just URL or if request should be done differently.
1673      *
1674      * @see curl
1675      * @throws file_exception when error occured
1676      *
1677      * @param string $url the content of files.reference field, in this implementaion
1678      * it is asssumed that it contains the string with URL of the file
1679      * @param string $filename filename (without path) to save the downloaded file in the
1680      * temporary directory, if omitted or file already exists the new filename will be generated
1681      * @return array with elements:
1682      *   path: internal location of the file
1683      *   url: URL to the source (from parameters)
1684      */
1685     public function get_file($url, $filename = '') {
1686         $path = $this->prepare_file($filename);
1687         $c = new curl;
1688         $result = $c->download_one($url, null, array('filepath' => $path, 'timeout' => self::GETFILE_TIMEOUT));
1689         if ($result !== true) {
1690             throw new moodle_exception('errorwhiledownload', 'repository', '', $result);
1691         }
1692         return array('path'=>$path, 'url'=>$url);
1693     }
1695     /**
1696      * Downloads the file from external repository and saves it in moodle filepool.
1697      * This function is different from {@link repository::sync_external_file()} because it has
1698      * bigger request timeout and always downloads the content.
1699      *
1700      * This function is invoked when we try to unlink the file from the source and convert
1701      * a reference into a true copy.
1702      *
1703      * @throws exception when file could not be imported
1704      *
1705      * @param stored_file $file
1706      * @param int $maxbytes throw an exception if file size is bigger than $maxbytes (0 means no limit)
1707      */
1708     public function import_external_file_contents(stored_file $file, $maxbytes = 0) {
1709         if (!$file->is_external_file()) {
1710             // nothing to import if the file is not a reference
1711             return;
1712         } else if ($file->get_repository_id() != $this->id) {
1713             // error
1714             debugging('Repository instance id does not match');
1715             return;
1716         } else if ($this->has_moodle_files()) {
1717             // files that are references to local files are already in moodle filepool
1718             // just validate the size
1719             if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1720                 throw new file_exception('maxbytes');
1721             }
1722             return;
1723         } else {
1724             if ($maxbytes > 0 && $file->get_filesize() > $maxbytes) {
1725                 // note that stored_file::get_filesize() also calls synchronisation
1726                 throw new file_exception('maxbytes');
1727             }
1728             $fs = get_file_storage();
1729             $contentexists = $fs->content_exists($file->get_contenthash());
1730             if ($contentexists && $file->get_filesize() && $file->get_contenthash() === sha1('')) {
1731                 // even when 'file_storage::content_exists()' returns true this may be an empty
1732                 // content for the file that was not actually downloaded
1733                 $contentexists = false;
1734             }
1735             $now = time();
1736             if ($file->get_referencelastsync() + $file->get_referencelifetime() >= $now &&
1737                         !$file->get_status() &&
1738                         $contentexists) {
1739                 // we already have the content in moodle filepool and it was synchronised recently.
1740                 // Repositories may overwrite it if they want to force synchronisation anyway!
1741                 return;
1742             } else {
1743                 // attempt to get a file
1744                 try {
1745                     $fileinfo = $this->get_file($file->get_reference());
1746                     if (isset($fileinfo['path'])) {
1747                         list($contenthash, $filesize, $newfile) = $fs->add_file_to_pool($fileinfo['path']);
1748                         // set this file and other similar aliases synchronised
1749                         $lifetime = $this->get_reference_file_lifetime($file->get_reference());
1750                         $file->set_synchronized($contenthash, $filesize, 0, $lifetime);
1751                     } else {
1752                         throw new moodle_exception('errorwhiledownload', 'repository', '', '');
1753                     }
1754                 } catch (Exception $e) {
1755                     if ($contentexists) {
1756                         // better something than nothing. We have a copy of file. It's sync time
1757                         // has expired but it is still very likely that it is the last version
1758                     } else {
1759                         throw($e);
1760                     }
1761                 }
1762             }
1763         }
1764     }
1766     /**
1767      * Return size of a file in bytes.
1768      *
1769      * @param string $source encoded and serialized data of file
1770      * @return int file size in bytes
1771      */
1772     public function get_file_size($source) {
1773         // TODO MDL-33297 remove this function completely?
1774         $browser    = get_file_browser();
1775         $params     = unserialize(base64_decode($source));
1776         $contextid  = clean_param($params['contextid'], PARAM_INT);
1777         $fileitemid = clean_param($params['itemid'], PARAM_INT);
1778         $filename   = clean_param($params['filename'], PARAM_FILE);
1779         $filepath   = clean_param($params['filepath'], PARAM_PATH);
1780         $filearea   = clean_param($params['filearea'], PARAM_AREA);
1781         $component  = clean_param($params['component'], PARAM_COMPONENT);
1782         $context    = context::instance_by_id($contextid);
1783         $file_info  = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
1784         if (!empty($file_info)) {
1785             $filesize = $file_info->get_filesize();
1786         } else {
1787             $filesize = null;
1788         }
1789         return $filesize;
1790     }
1792     /**
1793      * Return is the instance is visible
1794      * (is the type visible ? is the context enable ?)
1795      *
1796      * @return bool
1797      */
1798     public function is_visible() {
1799         $type = repository::get_type_by_id($this->options['typeid']);
1800         $instanceoptions = repository::static_function($type->get_typename(), 'get_instance_option_names');
1802         if ($type->get_visible()) {
1803             //if the instance is unique so it's visible, otherwise check if the instance has a enabled context
1804             if (empty($instanceoptions) || $type->get_contextvisibility($this->context)) {
1805                 return true;
1806             }
1807         }
1809         return false;
1810     }
1812     /**
1813      * Can the instance be edited by the current user?
1814      *
1815      * The property $readonly must not be used within this method because
1816      * it only controls if the options from self::get_instance_option_names()
1817      * can be edited.
1818      *
1819      * @return bool true if the user can edit the instance.
1820      * @since 2.5
1821      */
1822     public final function can_be_edited_by_user() {
1823         global $USER;
1825         // We need to be able to explore the repository.
1826         try {
1827             $this->check_capability();
1828         } catch (repository_exception $e) {
1829             return false;
1830         }
1832         $repocontext = context::instance_by_id($this->instance->contextid);
1833         if ($repocontext->contextlevel == CONTEXT_USER && $repocontext->instanceid != $USER->id) {
1834             // If the context of this instance is a user context, we need to be this user.
1835             return false;
1836         } else if ($repocontext->contextlevel == CONTEXT_MODULE && !has_capability('moodle/course:update', $repocontext)) {
1837             // We need to have permissions on the course to edit the instance.
1838             return false;
1839         } else if ($repocontext->contextlevel == CONTEXT_SYSTEM && !has_capability('moodle/site:config', $repocontext)) {
1840             // Do not meet the requirements for the context system.
1841             return false;
1842         }
1844         return true;
1845     }
1847     /**
1848      * Return the name of this instance, can be overridden.
1849      *
1850      * @return string
1851      */
1852     public function get_name() {
1853         global $DB;
1854         if ($name = $this->instance->name) {
1855             return $name;
1856         } else {
1857             return get_string('pluginname', 'repository_' . $this->get_typename());
1858         }
1859     }
1861     /**
1862      * Is this repository accessing private data?
1863      *
1864      * This function should return true for the repositories which access external private
1865      * data from a user. This is the case for repositories such as Dropbox, Google Docs or Box.net
1866      * which authenticate the user and then store the auth token.
1867      *
1868      * Of course, many repositories store 'private data', but we only want to set
1869      * contains_private_data() to repositories which are external to Moodle and shouldn't be accessed
1870      * to by the users having the capability to 'login as' someone else. For instance, the repository
1871      * 'Private files' is not considered as private because it's part of Moodle.
1872      *
1873      * You should not set contains_private_data() to true on repositories which allow different types
1874      * of instances as the levels other than 'user' are, by definition, not private. Also
1875      * the user instances will be protected when they need to.
1876      *
1877      * @return boolean True when the repository accesses private external data.
1878      * @since  2.5
1879      */
1880     public function contains_private_data() {
1881         return true;
1882     }
1884     /**
1885      * What kind of files will be in this repository?
1886      *
1887      * @return array return '*' means this repository support any files, otherwise
1888      *               return mimetypes of files, it can be an array
1889      */
1890     public function supported_filetypes() {
1891         // return array('text/plain', 'image/gif');
1892         return '*';
1893     }
1895     /**
1896      * Tells how the file can be picked from this repository
1897      *
1898      * Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
1899      *
1900      * @return int
1901      */
1902     public function supported_returntypes() {
1903         return (FILE_INTERNAL | FILE_EXTERNAL);
1904     }
1906     /**
1907      * Provide repository instance information for Ajax
1908      *
1909      * @return stdClass
1910      */
1911     final public function get_meta() {
1912         global $CFG, $OUTPUT;
1913         $meta = new stdClass();
1914         $meta->id   = $this->id;
1915         $meta->name = format_string($this->get_name());
1916         $meta->type = $this->get_typename();
1917         $meta->icon = $OUTPUT->pix_url('icon', 'repository_'.$meta->type)->out(false);
1918         $meta->supported_types = file_get_typegroup('extension', $this->supported_filetypes());
1919         $meta->return_types = $this->supported_returntypes();
1920         $meta->sortorder = $this->options['sortorder'];
1921         return $meta;
1922     }
1924     /**
1925      * Create an instance for this plug-in
1926      *
1927      * @static
1928      * @param string $type the type of the repository
1929      * @param int $userid the user id
1930      * @param stdClass $context the context
1931      * @param array $params the options for this instance
1932      * @param int $readonly whether to create it readonly or not (defaults to not)
1933      * @return mixed
1934      */
1935     public static function create($type, $userid, $context, $params, $readonly=0) {
1936         global $CFG, $DB;
1937         $params = (array)$params;
1938         require_once($CFG->dirroot . '/repository/'. $type . '/lib.php');
1939         $classname = 'repository_' . $type;
1940         if ($repo = $DB->get_record('repository', array('type'=>$type))) {
1941             $record = new stdClass();
1942             $record->name = $params['name'];
1943             $record->typeid = $repo->id;
1944             $record->timecreated  = time();
1945             $record->timemodified = time();
1946             $record->contextid = $context->id;
1947             $record->readonly = $readonly;
1948             $record->userid    = $userid;
1949             $id = $DB->insert_record('repository_instances', $record);
1950             $options = array();
1951             $configs = call_user_func($classname . '::get_instance_option_names');
1952             if (!empty($configs)) {
1953                 foreach ($configs as $config) {
1954                     if (isset($params[$config])) {
1955                         $options[$config] = $params[$config];
1956                     } else {
1957                         $options[$config] = null;
1958                     }
1959                 }
1960             }
1962             if (!empty($id)) {
1963                 unset($options['name']);
1964                 $instance = repository::get_instance($id);
1965                 $instance->set_option($options);
1966                 return $id;
1967             } else {
1968                 return null;
1969             }
1970         } else {
1971             return null;
1972         }
1973     }
1975     /**
1976      * delete a repository instance
1977      *
1978      * @param bool $downloadcontents
1979      * @return bool
1980      */
1981     final public function delete($downloadcontents = false) {
1982         global $DB;
1983         if ($downloadcontents) {
1984             $this->convert_references_to_local();
1985         }
1986         try {
1987             $DB->delete_records('repository_instances', array('id'=>$this->id));
1988             $DB->delete_records('repository_instance_config', array('instanceid'=>$this->id));
1989         } catch (dml_exception $ex) {
1990             return false;
1991         }
1992         return true;
1993     }
1995     /**
1996      * Hide/Show a repository
1997      *
1998      * @param string $hide
1999      * @return bool
2000      */
2001     final public function hide($hide = 'toggle') {
2002         global $DB;
2003         if ($entry = $DB->get_record('repository', array('id'=>$this->id))) {
2004             if ($hide === 'toggle' ) {
2005                 if (!empty($entry->visible)) {
2006                     $entry->visible = 0;
2007                 } else {
2008                     $entry->visible = 1;
2009                 }
2010             } else {
2011                 if (!empty($hide)) {
2012                     $entry->visible = 0;
2013                 } else {
2014                     $entry->visible = 1;
2015                 }
2016             }
2017             return $DB->update_record('repository', $entry);
2018         }
2019         return false;
2020     }
2022     /**
2023      * Save settings for repository instance
2024      * $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));
2025      *
2026      * @param array $options settings
2027      * @return bool
2028      */
2029     public function set_option($options = array()) {
2030         global $DB;
2032         if (!empty($options['name'])) {
2033             $r = new stdClass();
2034             $r->id   = $this->id;
2035             $r->name = $options['name'];
2036             $DB->update_record('repository_instances', $r);
2037             unset($options['name']);
2038         }
2039         foreach ($options as $name=>$value) {
2040             if ($id = $DB->get_field('repository_instance_config', 'id', array('name'=>$name, 'instanceid'=>$this->id))) {
2041                 $DB->set_field('repository_instance_config', 'value', $value, array('id'=>$id));
2042             } else {
2043                 $config = new stdClass();
2044                 $config->instanceid = $this->id;
2045                 $config->name   = $name;
2046                 $config->value  = $value;
2047                 $DB->insert_record('repository_instance_config', $config);
2048             }
2049         }
2050         return true;
2051     }
2053     /**
2054      * Get settings for repository instance
2055      *
2056      * @param string $config
2057      * @return array Settings
2058      */
2059     public function get_option($config = '') {
2060         global $DB;
2061         $entries = $DB->get_records('repository_instance_config', array('instanceid'=>$this->id));
2062         $ret = array();
2063         if (empty($entries)) {
2064             return $ret;
2065         }
2066         foreach($entries as $entry) {
2067             $ret[$entry->name] = $entry->value;
2068         }
2069         if (!empty($config)) {
2070             if (isset($ret[$config])) {
2071                 return $ret[$config];
2072             } else {
2073                 return null;
2074             }
2075         } else {
2076             return $ret;
2077         }
2078     }
2080     /**
2081      * Filter file listing to display specific types
2082      *
2083      * @param array $value
2084      * @return bool
2085      */
2086     public function filter(&$value) {
2087         $accepted_types = optional_param_array('accepted_types', '', PARAM_RAW);
2088         if (isset($value['children'])) {
2089             if (!empty($value['children'])) {
2090                 $value['children'] = array_filter($value['children'], array($this, 'filter'));
2091             }
2092             return true; // always return directories
2093         } else {
2094             if ($accepted_types == '*' or empty($accepted_types)
2095                 or (is_array($accepted_types) and in_array('*', $accepted_types))) {
2096                 return true;
2097             } else {
2098                 foreach ($accepted_types as $ext) {
2099                     if (preg_match('#'.$ext.'$#i', $value['title'])) {
2100                         return true;
2101                     }
2102                 }
2103             }
2104         }
2105         return false;
2106     }
2108     /**
2109      * Given a path, and perhaps a search, get a list of files.
2110      *
2111      * See details on {@link http://docs.moodle.org/dev/Repository_plugins}
2112      *
2113      * @param string $path this parameter can a folder name, or a identification of folder
2114      * @param string $page the page number of file list
2115      * @return array the list of files, including meta infomation, containing the following keys
2116      *           manage, url to manage url
2117      *           client_id
2118      *           login, login form
2119      *           repo_id, active repository id
2120      *           login_btn_action, the login button action
2121      *           login_btn_label, the login button label
2122      *           total, number of results
2123      *           perpage, items per page
2124      *           page
2125      *           pages, total pages
2126      *           issearchresult, is it a search result?
2127      *           list, file list
2128      *           path, current path and parent path
2129      */
2130     public function get_listing($path = '', $page = '') {
2131     }
2134     /**
2135      * Prepare the breadcrumb.
2136      *
2137      * @param array $breadcrumb contains each element of the breadcrumb.
2138      * @return array of breadcrumb elements.
2139      * @since 2.3.3
2140      */
2141     protected static function prepare_breadcrumb($breadcrumb) {
2142         global $OUTPUT;
2143         $foldericon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
2144         $len = count($breadcrumb);
2145         for ($i = 0; $i < $len; $i++) {
2146             if (is_array($breadcrumb[$i]) && !isset($breadcrumb[$i]['icon'])) {
2147                 $breadcrumb[$i]['icon'] = $foldericon;
2148             } else if (is_object($breadcrumb[$i]) && !isset($breadcrumb[$i]->icon)) {
2149                 $breadcrumb[$i]->icon = $foldericon;
2150             }
2151         }
2152         return $breadcrumb;
2153     }
2155     /**
2156      * Prepare the file/folder listing.
2157      *
2158      * @param array $list of files and folders.
2159      * @return array of files and folders.
2160      * @since 2.3.3
2161      */
2162     protected static function prepare_list($list) {
2163         global $OUTPUT;
2164         $foldericon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
2166         // Reset the array keys because non-numeric keys will create an object when converted to JSON.
2167         $list = array_values($list);
2169         $len = count($list);
2170         for ($i = 0; $i < $len; $i++) {
2171             if (is_object($list[$i])) {
2172                 $file = (array)$list[$i];
2173                 $converttoobject = true;
2174             } else {
2175                 $file =& $list[$i];
2176                 $converttoobject = false;
2177             }
2178             if (isset($file['size'])) {
2179                 $file['size'] = (int)$file['size'];
2180                 $file['size_f'] = display_size($file['size']);
2181             }
2182             if (isset($file['license']) && get_string_manager()->string_exists($file['license'], 'license')) {
2183                 $file['license_f'] = get_string($file['license'], 'license');
2184             }
2185             if (isset($file['image_width']) && isset($file['image_height'])) {
2186                 $a = array('width' => $file['image_width'], 'height' => $file['image_height']);
2187                 $file['dimensions'] = get_string('imagesize', 'repository', (object)$a);
2188             }
2189             foreach (array('date', 'datemodified', 'datecreated') as $key) {
2190                 if (!isset($file[$key]) && isset($file['date'])) {
2191                     $file[$key] = $file['date'];
2192                 }
2193                 if (isset($file[$key])) {
2194                     // must be UNIX timestamp
2195                     $file[$key] = (int)$file[$key];
2196                     if (!$file[$key]) {
2197                         unset($file[$key]);
2198                     } else {
2199                         $file[$key.'_f'] = userdate($file[$key], get_string('strftimedatetime', 'langconfig'));
2200                         $file[$key.'_f_s'] = userdate($file[$key], get_string('strftimedatetimeshort', 'langconfig'));
2201                     }
2202                 }
2203             }
2204             $isfolder = (array_key_exists('children', $file) || (isset($file['type']) && $file['type'] == 'folder'));
2205             $filename = null;
2206             if (isset($file['title'])) {
2207                 $filename = $file['title'];
2208             }
2209             else if (isset($file['fullname'])) {
2210                 $filename = $file['fullname'];
2211             }
2212             if (!isset($file['mimetype']) && !$isfolder && $filename) {
2213                 $file['mimetype'] = get_mimetype_description(array('filename' => $filename));
2214             }
2215             if (!isset($file['icon'])) {
2216                 if ($isfolder) {
2217                     $file['icon'] = $foldericon;
2218                 } else if ($filename) {
2219                     $file['icon'] = $OUTPUT->pix_url(file_extension_icon($filename, 24))->out(false);
2220                 }
2221             }
2223             // Recursively loop over children.
2224             if (isset($file['children'])) {
2225                 $file['children'] = self::prepare_list($file['children']);
2226             }
2228             // Convert the array back to an object.
2229             if ($converttoobject) {
2230                 $list[$i] = (object)$file;
2231             }
2232         }
2233         return $list;
2234     }
2236     /**
2237      * Prepares list of files before passing it to AJAX, makes sure data is in the correct
2238      * format and stores formatted values.
2239      *
2240      * @param array|stdClass $listing result of get_listing() or search() or file_get_drafarea_files()
2241      * @return array
2242      */
2243     public static function prepare_listing($listing) {
2244         $wasobject = false;
2245         if (is_object($listing)) {
2246             $listing = (array) $listing;
2247             $wasobject = true;
2248         }
2250         // Prepare the breadcrumb, passed as 'path'.
2251         if (isset($listing['path']) && is_array($listing['path'])) {
2252             $listing['path'] = self::prepare_breadcrumb($listing['path']);
2253         }
2255         // Prepare the listing of objects.
2256         if (isset($listing['list']) && is_array($listing['list'])) {
2257             $listing['list'] = self::prepare_list($listing['list']);
2258         }
2260         // Convert back to an object.
2261         if ($wasobject) {
2262             $listing = (object) $listing;
2263         }
2264         return $listing;
2265     }
2267     /**
2268      * Search files in repository
2269      * When doing global search, $search_text will be used as
2270      * keyword.
2271      *
2272      * @param string $search_text search key word
2273      * @param int $page page
2274      * @return mixed see {@link repository::get_listing()}
2275      */
2276     public function search($search_text, $page = 0) {
2277         $list = array();
2278         $list['list'] = array();
2279         return false;
2280     }
2282     /**
2283      * Logout from repository instance
2284      * By default, this function will return a login form
2285      *
2286      * @return string
2287      */
2288     public function logout(){
2289         return $this->print_login();
2290     }
2292     /**
2293      * To check whether the user is logged in.
2294      *
2295      * @return bool
2296      */
2297     public function check_login(){
2298         return true;
2299     }
2302     /**
2303      * Show the login screen, if required
2304      *
2305      * @return string
2306      */
2307     public function print_login(){
2308         return $this->get_listing();
2309     }
2311     /**
2312      * Show the search screen, if required
2313      *
2314      * @return string
2315      */
2316     public function print_search() {
2317         global $PAGE;
2318         $renderer = $PAGE->get_renderer('core', 'files');
2319         return $renderer->repository_default_searchform();
2320     }
2322     /**
2323      * For oauth like external authentication, when external repository direct user back to moodle,
2324      * this funciton will be called to set up token and token_secret
2325      */
2326     public function callback() {
2327     }
2329     /**
2330      * is it possible to do glboal search?
2331      *
2332      * @return bool
2333      */
2334     public function global_search() {
2335         return false;
2336     }
2338     /**
2339      * Defines operations that happen occasionally on cron
2340      *
2341      * @return bool
2342      */
2343     public function cron() {
2344         return true;
2345     }
2347     /**
2348      * function which is run when the type is created (moodle administrator add the plugin)
2349      *
2350      * @return bool success or fail?
2351      */
2352     public static function plugin_init() {
2353         return true;
2354     }
2356     /**
2357      * Edit/Create Admin Settings Moodle form
2358      *
2359      * @param moodleform $mform Moodle form (passed by reference)
2360      * @param string $classname repository class name
2361      */
2362     public static function type_config_form($mform, $classname = 'repository') {
2363         $instnaceoptions = call_user_func(array($classname, 'get_instance_option_names'), $mform, $classname);
2364         if (empty($instnaceoptions)) {
2365             // this plugin has only one instance
2366             // so we need to give it a name
2367             // it can be empty, then moodle will look for instance name from language string
2368             $mform->addElement('text', 'pluginname', get_string('pluginname', 'repository'), array('size' => '40'));
2369             $mform->addElement('static', 'pluginnamehelp', '', get_string('pluginnamehelp', 'repository'));
2370             $mform->setType('pluginname', PARAM_TEXT);
2371         }
2372     }
2374     /**
2375      * Validate Admin Settings Moodle form
2376      *
2377      * @static
2378      * @param moodleform $mform Moodle form (passed by reference)
2379      * @param array $data array of ("fieldname"=>value) of submitted data
2380      * @param array $errors array of ("fieldname"=>errormessage) of errors
2381      * @return array array of errors
2382      */
2383     public static function type_form_validation($mform, $data, $errors) {
2384         return $errors;
2385     }
2388     /**
2389      * Edit/Create Instance Settings Moodle form
2390      *
2391      * @param moodleform $mform Moodle form (passed by reference)
2392      */
2393     public static function instance_config_form($mform) {
2394     }
2396     /**
2397      * Return names of the general options.
2398      * By default: no general option name
2399      *
2400      * @return array
2401      */
2402     public static function get_type_option_names() {
2403         return array('pluginname');
2404     }
2406     /**
2407      * Return names of the instance options.
2408      * By default: no instance option name
2409      *
2410      * @return array
2411      */
2412     public static function get_instance_option_names() {
2413         return array();
2414     }
2416     /**
2417      * Validate repository plugin instance form
2418      *
2419      * @param moodleform $mform moodle form
2420      * @param array $data form data
2421      * @param array $errors errors
2422      * @return array errors
2423      */
2424     public static function instance_form_validation($mform, $data, $errors) {
2425         return $errors;
2426     }
2428     /**
2429      * Create a shorten filename
2430      *
2431      * @param string $str filename
2432      * @param int $maxlength max file name length
2433      * @return string short filename
2434      */
2435     public function get_short_filename($str, $maxlength) {
2436         if (textlib::strlen($str) >= $maxlength) {
2437             return trim(textlib::substr($str, 0, $maxlength)).'...';
2438         } else {
2439             return $str;
2440         }
2441     }
2443     /**
2444      * Overwrite an existing file
2445      *
2446      * @param int $itemid
2447      * @param string $filepath
2448      * @param string $filename
2449      * @param string $newfilepath
2450      * @param string $newfilename
2451      * @return bool
2452      */
2453     public static function overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename) {
2454         global $USER;
2455         $fs = get_file_storage();
2456         $user_context = context_user::instance($USER->id);
2457         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $filepath, $filename)) {
2458             if ($tempfile = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $newfilepath, $newfilename)) {
2459                 // delete existing file to release filename
2460                 $file->delete();
2461                 // create new file
2462                 $newfile = $fs->create_file_from_storedfile(array('filepath'=>$filepath, 'filename'=>$filename), $tempfile);
2463                 // remove temp file
2464                 $tempfile->delete();
2465                 return true;
2466             }
2467         }
2468         return false;
2469     }
2471     /**
2472      * Delete a temp file from draft area
2473      *
2474      * @param int $draftitemid
2475      * @param string $filepath
2476      * @param string $filename
2477      * @return bool
2478      */
2479     public static function delete_tempfile_from_draft($draftitemid, $filepath, $filename) {
2480         global $USER;
2481         $fs = get_file_storage();
2482         $user_context = context_user::instance($USER->id);
2483         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $draftitemid, $filepath, $filename)) {
2484             $file->delete();
2485             return true;
2486         } else {
2487             return false;
2488         }
2489     }
2491     /**
2492      * Find all external files in this repo and import them
2493      */
2494     public function convert_references_to_local() {
2495         $fs = get_file_storage();
2496         $files = $fs->get_external_files($this->id);
2497         foreach ($files as $storedfile) {
2498             $fs->import_external_file($storedfile);
2499         }
2500     }
2502     /**
2503      * Called from phpunit between tests, resets whatever was cached
2504      */
2505     public static function reset_caches() {
2506         self::sync_external_file(null, true);
2507     }
2509     /**
2510      * Performs synchronisation of reference to an external file if the previous one has expired.
2511      *
2512      * @param stored_file $file
2513      * @param bool $resetsynchistory whether to reset all history of sync (used by phpunit)
2514      * @return bool success
2515      */
2516     public static function sync_external_file($file, $resetsynchistory = false) {
2517         global $DB;
2518         // TODO MDL-25290 static should be replaced with MUC code.
2519         static $synchronized = array();
2520         if ($resetsynchistory) {
2521             $synchronized = array();
2522         }
2524         $fs = get_file_storage();
2526         if (!$file || !$file->get_referencefileid()) {
2527             return false;
2528         }
2529         if (array_key_exists($file->get_id(), $synchronized)) {
2530             return $synchronized[$file->get_id()];
2531         }
2533         // remember that we already cached in current request to prevent from querying again
2534         $synchronized[$file->get_id()] = false;
2536         if (!$reference = $DB->get_record('files_reference', array('id'=>$file->get_referencefileid()))) {
2537             return false;
2538         }
2540         if (!empty($reference->lastsync) and ($reference->lastsync + $reference->lifetime > time())) {
2541             $synchronized[$file->get_id()] = true;
2542             return true;
2543         }
2545         if (!$repository = self::get_repository_by_id($reference->repositoryid, SYSCONTEXTID)) {
2546             return false;
2547         }
2549         if (!$repository->sync_individual_file($file)) {
2550             return false;
2551         }
2553         $lifetime = $repository->get_reference_file_lifetime($reference);
2554         $fileinfo = $repository->get_file_by_reference($reference);
2555         if ($fileinfo === null) {
2556             // does not exist any more - set status to missing
2557             $file->set_missingsource($lifetime);
2558             $synchronized[$file->get_id()] = true;
2559             return true;
2560         }
2562         $contenthash = null;
2563         $filesize = null;
2564         if (!empty($fileinfo->filesize)) {
2565             // filesize returned
2566             if (!empty($fileinfo->contenthash) && $fs->content_exists($fileinfo->contenthash)) {
2567                 // contenthash is specified and valid
2568                 $contenthash = $fileinfo->contenthash;
2569             } else if ($fileinfo->filesize == $file->get_filesize()) {
2570                 // we don't know the new contenthash but the filesize did not change,
2571                 // assume the contenthash did not change either
2572                 $contenthash = $file->get_contenthash();
2573             } else {
2574                 // we can't save empty contenthash so generate contenthash from empty string
2575                 $fs->add_string_to_pool('');
2576                 $contenthash = sha1('');
2577             }
2578             $filesize = $fileinfo->filesize;
2579         } else if (!empty($fileinfo->filepath)) {
2580             // File path returned
2581             list($contenthash, $filesize, $newfile) = $fs->add_file_to_pool($fileinfo->filepath);
2582         } else if (!empty($fileinfo->handle) && is_resource($fileinfo->handle)) {
2583             // File handle returned
2584             $contents = '';
2585             while (!feof($fileinfo->handle)) {
2586                 $contents .= fread($handle, 8192);
2587             }
2588             fclose($fileinfo->handle);
2589             list($contenthash, $filesize, $newfile) = $fs->add_string_to_pool($content);
2590         } else if (isset($fileinfo->content)) {
2591             // File content returned
2592             list($contenthash, $filesize, $newfile) = $fs->add_string_to_pool($fileinfo->content);
2593         }
2595         if (!isset($contenthash) or !isset($filesize)) {
2596             return false;
2597         }
2599         // update files table
2600         $file->set_synchronized($contenthash, $filesize, 0, $lifetime);
2601         $synchronized[$file->get_id()] = true;
2602         return true;
2603     }
2605     /**
2606      * Build draft file's source field
2607      *
2608      * {@link file_restore_source_field_from_draft_file()}
2609      * XXX: This is a hack for file manager (MDL-28666)
2610      * For newly created  draft files we have to construct
2611      * source filed in php serialized data format.
2612      * File manager needs to know the original file information before copying
2613      * to draft area, so we append these information in mdl_files.source field
2614      *
2615      * @param string $source
2616      * @return string serialised source field
2617      */
2618     public static function build_source_field($source) {
2619         $sourcefield = new stdClass;
2620         $sourcefield->source = $source;
2621         return serialize($sourcefield);
2622     }
2625 /**
2626  * Exception class for repository api
2627  *
2628  * @since 2.0
2629  * @package   core_repository
2630  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2631  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2632  */
2633 class repository_exception extends moodle_exception {
2636 /**
2637  * This is a class used to define a repository instance form
2638  *
2639  * @since 2.0
2640  * @package   core_repository
2641  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2642  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2643  */
2644 final class repository_instance_form extends moodleform {
2645     /** @var stdClass repository instance */
2646     protected $instance;
2647     /** @var string repository plugin type */
2648     protected $plugin;
2650     /**
2651      * Added defaults to moodle form
2652      */
2653     protected function add_defaults() {
2654         $mform =& $this->_form;
2655         $strrequired = get_string('required');
2657         $mform->addElement('hidden', 'edit',  ($this->instance) ? $this->instance->id : 0);
2658         $mform->setType('edit', PARAM_INT);
2659         $mform->addElement('hidden', 'new',   $this->plugin);
2660         $mform->setType('new', PARAM_ALPHANUMEXT);
2661         $mform->addElement('hidden', 'plugin', $this->plugin);
2662         $mform->setType('plugin', PARAM_PLUGIN);
2663         $mform->addElement('hidden', 'typeid', $this->typeid);
2664         $mform->setType('typeid', PARAM_INT);
2665         $mform->addElement('hidden', 'contextid', $this->contextid);
2666         $mform->setType('contextid', PARAM_INT);
2668         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
2669         $mform->addRule('name', $strrequired, 'required', null, 'client');
2670         $mform->setType('name', PARAM_TEXT);
2671     }
2673     /**
2674      * Define moodle form elements
2675      */
2676     public function definition() {
2677         global $CFG;
2678         // type of plugin, string
2679         $this->plugin = $this->_customdata['plugin'];
2680         $this->typeid = $this->_customdata['typeid'];
2681         $this->contextid = $this->_customdata['contextid'];
2682         $this->instance = (isset($this->_customdata['instance'])
2683                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2684             ? $this->_customdata['instance'] : null;
2686         $mform =& $this->_form;
2688         $this->add_defaults();
2690         // Add instance config options.
2691         $result = repository::static_function($this->plugin, 'instance_config_form', $mform);
2692         if ($result === false) {
2693             // Remove the name element if no other config options.
2694             $mform->removeElement('name');
2695         }
2696         if ($this->instance) {
2697             $data = array();
2698             $data['name'] = $this->instance->name;
2699             if (!$this->instance->readonly) {
2700                 // and set the data if we have some.
2701                 foreach ($this->instance->get_instance_option_names() as $config) {
2702                     if (!empty($this->instance->options[$config])) {
2703                         $data[$config] = $this->instance->options[$config];
2704                      } else {
2705                         $data[$config] = '';
2706                      }
2707                 }
2708             }
2709             $this->set_data($data);
2710         }
2712         if ($result === false) {
2713             $mform->addElement('cancel');
2714         } else {
2715             $this->add_action_buttons(true, get_string('save','repository'));
2716         }
2717     }
2719     /**
2720      * Validate moodle form data
2721      *
2722      * @param array $data form data
2723      * @param array $files files in form
2724      * @return array errors
2725      */
2726     public function validation($data, $files) {
2727         global $DB;
2728         $errors = array();
2729         $plugin = $this->_customdata['plugin'];
2730         $instance = (isset($this->_customdata['instance'])
2731                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2732             ? $this->_customdata['instance'] : null;
2733         if (!$instance) {
2734             $errors = repository::static_function($plugin, 'instance_form_validation', $this, $data, $errors);
2735         } else {
2736             $errors = $instance->instance_form_validation($this, $data, $errors);
2737         }
2739         $sql = "SELECT count('x')
2740                   FROM {repository_instances} i, {repository} r
2741                  WHERE r.type=:plugin AND r.id=i.typeid AND i.name=:name";
2742         if ($DB->count_records_sql($sql, array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
2743             $errors['name'] = get_string('erroruniquename', 'repository');
2744         }
2746         return $errors;
2747     }
2750 /**
2751  * This is a class used to define a repository type setting form
2752  *
2753  * @since 2.0
2754  * @package   core_repository
2755  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2756  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2757  */
2758 final class repository_type_form extends moodleform {
2759     /** @var stdClass repository instance */
2760     protected $instance;
2761     /** @var string repository plugin name */
2762     protected $plugin;
2763     /** @var string action */
2764     protected $action;
2766     /**
2767      * Definition of the moodleform
2768      */
2769     public function definition() {
2770         global $CFG;
2771         // type of plugin, string
2772         $this->plugin = $this->_customdata['plugin'];
2773         $this->instance = (isset($this->_customdata['instance'])
2774                 && is_a($this->_customdata['instance'], 'repository_type'))
2775             ? $this->_customdata['instance'] : null;
2777         $this->action = $this->_customdata['action'];
2778         $this->pluginname = $this->_customdata['pluginname'];
2779         $mform =& $this->_form;
2780         $strrequired = get_string('required');
2782         $mform->addElement('hidden', 'action', $this->action);
2783         $mform->setType('action', PARAM_TEXT);
2784         $mform->addElement('hidden', 'repos', $this->plugin);
2785         $mform->setType('repos', PARAM_PLUGIN);
2787         // let the plugin add its specific fields
2788         $classname = 'repository_' . $this->plugin;
2789         require_once($CFG->dirroot . '/repository/' . $this->plugin . '/lib.php');
2790         //add "enable course/user instances" checkboxes if multiple instances are allowed
2791         $instanceoptionnames = repository::static_function($this->plugin, 'get_instance_option_names');
2793         $result = call_user_func(array($classname, 'type_config_form'), $mform, $classname);
2795         if (!empty($instanceoptionnames)) {
2796             $sm = get_string_manager();
2797             $component = 'repository';
2798             if ($sm->string_exists('enablecourseinstances', 'repository_' . $this->plugin)) {
2799                 $component .= ('_' . $this->plugin);
2800             }
2801             $mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', $component));
2803             $component = 'repository';
2804             if ($sm->string_exists('enableuserinstances', 'repository_' . $this->plugin)) {
2805                 $component .= ('_' . $this->plugin);
2806             }
2807             $mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', $component));
2808         }
2810         // set the data if we have some.
2811         if ($this->instance) {
2812             $data = array();
2813             $option_names = call_user_func(array($classname,'get_type_option_names'));
2814             if (!empty($instanceoptionnames)){
2815                 $option_names[] = 'enablecourseinstances';
2816                 $option_names[] = 'enableuserinstances';
2817             }
2819             $instanceoptions = $this->instance->get_options();
2820             foreach ($option_names as $config) {
2821                 if (!empty($instanceoptions[$config])) {
2822                     $data[$config] = $instanceoptions[$config];
2823                 } else {
2824                     $data[$config] = '';
2825                 }
2826             }
2827             // XXX: set plugin name for plugins which doesn't have muliti instances
2828             if (empty($instanceoptionnames)){
2829                 $data['pluginname'] = $this->pluginname;
2830             }
2831             $this->set_data($data);
2832         }
2834         $this->add_action_buttons(true, get_string('save','repository'));
2835     }
2837     /**
2838      * Validate moodle form data
2839      *
2840      * @param array $data moodle form data
2841      * @param array $files
2842      * @return array errors
2843      */
2844     public function validation($data, $files) {
2845         $errors = array();
2846         $plugin = $this->_customdata['plugin'];
2847         $instance = (isset($this->_customdata['instance'])
2848                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2849             ? $this->_customdata['instance'] : null;
2850         if (!$instance) {
2851             $errors = repository::static_function($plugin, 'type_form_validation', $this, $data, $errors);
2852         } else {
2853             $errors = $instance->type_form_validation($this, $data, $errors);
2854         }
2856         return $errors;
2857     }
2860 /**
2861  * Generate all options needed by filepicker
2862  *
2863  * @param array $args including following keys
2864  *          context
2865  *          accepted_types
2866  *          return_types
2867  *
2868  * @return array the list of repository instances, including meta infomation, containing the following keys
2869  *          externallink
2870  *          repositories
2871  *          accepted_types
2872  */
2873 function initialise_filepicker($args) {
2874     global $CFG, $USER, $PAGE, $OUTPUT;
2875     static $templatesinitialized = array();
2876     require_once($CFG->libdir . '/licenselib.php');
2878     $return = new stdClass();
2879     $licenses = array();
2880     if (!empty($CFG->licenses)) {
2881         $array = explode(',', $CFG->licenses);
2882         foreach ($array as $license) {
2883             $l = new stdClass();
2884             $l->shortname = $license;
2885             $l->fullname = get_string($license, 'license');
2886             $licenses[] = $l;
2887         }
2888     }
2889     if (!empty($CFG->sitedefaultlicense)) {
2890         $return->defaultlicense = $CFG->sitedefaultlicense;
2891     }
2893     $return->licenses = $licenses;
2895     $return->author = fullname($USER);
2897     if (empty($args->context)) {
2898         $context = $PAGE->context;
2899     } else {
2900         $context = $args->context;
2901     }
2902     $disable_types = array();
2903     if (!empty($args->disable_types)) {
2904         $disable_types = $args->disable_types;
2905     }
2907     $user_context = context_user::instance($USER->id);
2909     list($context, $course, $cm) = get_context_info_array($context->id);
2910     $contexts = array($user_context, get_system_context());
2911     if (!empty($course)) {
2912         // adding course context
2913         $contexts[] = context_course::instance($course->id);
2914     }
2915     $externallink = (int)get_config(null, 'repositoryallowexternallinks');
2916     $repositories = repository::get_instances(array(
2917         'context'=>$contexts,
2918         'currentcontext'=> $context,
2919         'accepted_types'=>$args->accepted_types,
2920         'return_types'=>$args->return_types,
2921         'disable_types'=>$disable_types
2922     ));
2924     $return->repositories = array();
2926     if (empty($externallink)) {
2927         $return->externallink = false;
2928     } else {
2929         $return->externallink = true;
2930     }
2932     $return->userprefs = array();
2933     $return->userprefs['recentrepository'] = get_user_preferences('filepicker_recentrepository', '');
2934     $return->userprefs['recentlicense'] = get_user_preferences('filepicker_recentlicense', '');
2935     $return->userprefs['recentviewmode'] = get_user_preferences('filepicker_recentviewmode', '');
2937     user_preference_allow_ajax_update('filepicker_recentrepository', PARAM_INT);
2938     user_preference_allow_ajax_update('filepicker_recentlicense', PARAM_SAFEDIR);
2939     user_preference_allow_ajax_update('filepicker_recentviewmode', PARAM_INT);
2942     // provided by form element
2943     $return->accepted_types = file_get_typegroup('extension', $args->accepted_types);
2944     $return->return_types = $args->return_types;
2945     $templates = array();
2946     foreach ($repositories as $repository) {
2947         $meta = $repository->get_meta();
2948         // Please note that the array keys for repositories are used within
2949         // JavaScript a lot, the key NEEDS to be the repository id.
2950         $return->repositories[$repository->id] = $meta;
2951         // Register custom repository template if it has one
2952         if(method_exists($repository, 'get_upload_template') && !array_key_exists('uploadform_' . $meta->type, $templatesinitialized)) {
2953             $templates['uploadform_' . $meta->type] = $repository->get_upload_template();
2954             $templatesinitialized['uploadform_' . $meta->type] = true;
2955         }
2956     }
2957     if (!array_key_exists('core', $templatesinitialized)) {
2958         // we need to send each filepicker template to the browser just once
2959         $fprenderer = $PAGE->get_renderer('core', 'files');
2960         $templates = array_merge($templates, $fprenderer->filepicker_js_templates());
2961         $templatesinitialized['core'] = true;
2962     }
2963     if (sizeof($templates)) {
2964         $PAGE->requires->js_init_call('M.core_filepicker.set_templates', array($templates), true);
2965     }
2966     return $return;
2969 /**
2970  * Small function to walk an array to attach repository ID
2971  *
2972  * @param array $value
2973  * @param string $key
2974  * @param int $id
2975  */
2976 function repository_attach_id(&$value, $key, $id){
2977     $value['repo_id'] = $id;