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