62312099d589027e3808fa963a3e862d1e1dfc6b
[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  * and was introduced as part of the changes occuring in Moodle 2.0
20  *
21  * @since 2.0
22  * @package   repository
23  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require_once(dirname(dirname(__FILE__)) . '/config.php');
28 require_once($CFG->libdir . '/filelib.php');
29 require_once($CFG->libdir . '/formslib.php');
31 define('FILE_EXTERNAL',  1);
32 define('FILE_INTERNAL',  2);
33 define('FILE_REFERENCE', 4);
34 define('RENAME_SUFFIX', '_2');
36 /**
37  * This class is used to manage repository plugins
38  *
39  * A repository_type is a repository plug-in. It can be Box.net, Flick-r, ...
40  * A repository type can be edited, sorted and hidden. It is mandatory for an
41  * administrator to create a repository type in order to be able to create
42  * some instances of this type.
43  * Coding note:
44  * - a repository_type object is mapped to the "repository" database table
45  * - "typename" attibut maps the "type" database field. It is unique.
46  * - general "options" for a repository type are saved in the config_plugin table
47  * - when you delete a repository, all instances are deleted, and general
48  *   options are also deleted from database
49  * - When you create a type for a plugin that can't have multiple instances, a
50  *   instance is automatically created.
51  *
52  * @package   repository
53  * @copyright 2009 Jerome Mouneyrac
54  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
55  */
56 class repository_type {
59     /**
60      * Type name (no whitespace) - A type name is unique
61      * Note: for a user-friendly type name see get_readablename()
62      * @var String
63      */
64     private $_typename;
67     /**
68      * Options of this type
69      * They are general options that any instance of this type would share
70      * e.g. API key
71      * These options are saved in config_plugin table
72      * @var array
73      */
74     private $_options;
77     /**
78      * Is the repository type visible or hidden
79      * If false (hidden): no instances can be created, edited, deleted, showned , used...
80      * @var boolean
81      */
82     private $_visible;
85     /**
86      * 0 => not ordered, 1 => first position, 2 => second position...
87      * A not order type would appear in first position (should never happened)
88      * @var integer
89      */
90     private $_sortorder;
92     /**
93      * Return if the instance is visible in a context
94      *
95      * @todo check if the context visibility has been overwritten by the plugin creator
96      *       (need to create special functions to be overvwritten in repository class)
97      * @param stdClass $context context
98      * @return bool
99      */
100     public function get_contextvisibility($context) {
101         global $USER;
103         if ($context->contextlevel == CONTEXT_COURSE) {
104             return $this->_options['enablecourseinstances'];
105         }
107         if ($context->contextlevel == CONTEXT_USER) {
108             return $this->_options['enableuserinstances'];
109         }
111         //the context is SITE
112         return true;
113     }
117     /**
118      * repository_type constructor
119      *
120      * @param int $typename
121      * @param array $typeoptions
122      * @param bool $visible
123      * @param int $sortorder (don't really need set, it will be during create() call)
124      */
125     public function __construct($typename = '', $typeoptions = array(), $visible = true, $sortorder = 0) {
126         global $CFG;
128         //set type attributs
129         $this->_typename = $typename;
130         $this->_visible = $visible;
131         $this->_sortorder = $sortorder;
133         //set options attribut
134         $this->_options = array();
135         $options = repository::static_function($typename, 'get_type_option_names');
136         //check that the type can be setup
137         if (!empty($options)) {
138             //set the type options
139             foreach ($options as $config) {
140                 if (array_key_exists($config, $typeoptions)) {
141                     $this->_options[$config] = $typeoptions[$config];
142                 }
143             }
144         }
146         //retrieve visibility from option
147         if (array_key_exists('enablecourseinstances',$typeoptions)) {
148             $this->_options['enablecourseinstances'] = $typeoptions['enablecourseinstances'];
149         } else {
150              $this->_options['enablecourseinstances'] = 0;
151         }
153         if (array_key_exists('enableuserinstances',$typeoptions)) {
154             $this->_options['enableuserinstances'] = $typeoptions['enableuserinstances'];
155         } else {
156              $this->_options['enableuserinstances'] = 0;
157         }
159     }
161     /**
162      * Get the type name (no whitespace)
163      * For a human readable name, use get_readablename()
164      *
165      * @return string the type name
166      */
167     public function get_typename() {
168         return $this->_typename;
169     }
171     /**
172      * Return a human readable and user-friendly type name
173      *
174      * @return string user-friendly type name
175      */
176     public function get_readablename() {
177         return get_string('pluginname','repository_'.$this->_typename);
178     }
180     /**
181      * Return general options
182      *
183      * @return array the general options
184      */
185     public function get_options() {
186         return $this->_options;
187     }
189     /**
190      * Return visibility
191      *
192      * @return bool
193      */
194     public function get_visible() {
195         return $this->_visible;
196     }
198     /**
199      * Return order / position of display in the file picker
200      *
201      * @return int
202      */
203     public function get_sortorder() {
204         return $this->_sortorder;
205     }
207     /**
208      * Create a repository type (the type name must not already exist)
209      * @param bool $silent throw exception?
210      * @return mixed return int if create successfully, return false if
211      */
212     public function create($silent = false) {
213         global $DB;
215         //check that $type has been set
216         $timmedtype = trim($this->_typename);
217         if (empty($timmedtype)) {
218             throw new repository_exception('emptytype', 'repository');
219         }
221         //set sortorder as the last position in the list
222         if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
223             $sql = "SELECT MAX(sortorder) FROM {repository}";
224             $this->_sortorder = 1 + $DB->get_field_sql($sql);
225         }
227         //only create a new type if it doesn't already exist
228         $existingtype = $DB->get_record('repository', array('type'=>$this->_typename));
229         if (!$existingtype) {
230             //create the type
231             $newtype = new stdClass();
232             $newtype->type = $this->_typename;
233             $newtype->visible = $this->_visible;
234             $newtype->sortorder = $this->_sortorder;
235             $plugin_id = $DB->insert_record('repository', $newtype);
236             //save the options in DB
237             $this->update_options();
239             $instanceoptionnames = repository::static_function($this->_typename, 'get_instance_option_names');
241             //if the plugin type has no multiple instance (e.g. has no instance option name) so it wont
242             //be possible for the administrator to create a instance
243             //in this case we need to create an instance
244             if (empty($instanceoptionnames)) {
245                 $instanceoptions = array();
246                 if (empty($this->_options['pluginname'])) {
247                     // when moodle trying to install some repo plugin automatically
248                     // this option will be empty, get it from language string when display
249                     $instanceoptions['name'] = '';
250                 } else {
251                     // when admin trying to add a plugin manually, he will type a name
252                     // for it
253                     $instanceoptions['name'] = $this->_options['pluginname'];
254                 }
255                 repository::static_function($this->_typename, 'create', $this->_typename, 0, get_system_context(), $instanceoptions);
256             }
257             //run plugin_init function
258             if (!repository::static_function($this->_typename, 'plugin_init')) {
259                 if (!$silent) {
260                     throw new repository_exception('cannotinitplugin', 'repository');
261                 }
262             }
264             if(!empty($plugin_id)) {
265                 // return plugin_id if create successfully
266                 return $plugin_id;
267             } else {
268                 return false;
269             }
271         } else {
272             if (!$silent) {
273                 throw new repository_exception('existingrepository', 'repository');
274             }
275             // If plugin existed, return false, tell caller no new plugins were created.
276             return false;
277         }
278     }
281     /**
282      * Update plugin options into the config_plugin table
283      *
284      * @param array $options
285      * @return bool
286      */
287     public function update_options($options = null) {
288         global $DB;
289         $classname = 'repository_' . $this->_typename;
290         $instanceoptions = repository::static_function($this->_typename, 'get_instance_option_names');
291         if (empty($instanceoptions)) {
292             // update repository instance name if this plugin type doesn't have muliti instances
293             $params = array();
294             $params['type'] = $this->_typename;
295             $instances = repository::get_instances($params);
296             $instance = array_pop($instances);
297             if ($instance) {
298                 $DB->set_field('repository_instances', 'name', $options['pluginname'], array('id'=>$instance->id));
299             }
300             unset($options['pluginname']);
301         }
303         if (!empty($options)) {
304             $this->_options = $options;
305         }
307         foreach ($this->_options as $name => $value) {
308             set_config($name, $value, $this->_typename);
309         }
311         return true;
312     }
314     /**
315      * Update visible database field with the value given as parameter
316      * or with the visible value of this object
317      * This function is private.
318      * For public access, have a look to switch_and_update_visibility()
319      *
320      * @param bool $visible
321      * @return bool
322      */
323     private function update_visible($visible = null) {
324         global $DB;
326         if (!empty($visible)) {
327             $this->_visible = $visible;
328         }
329         else if (!isset($this->_visible)) {
330             throw new repository_exception('updateemptyvisible', 'repository');
331         }
333         return $DB->set_field('repository', 'visible', $this->_visible, array('type'=>$this->_typename));
334     }
336     /**
337      * Update database sortorder field with the value given as parameter
338      * or with the sortorder value of this object
339      * This function is private.
340      * For public access, have a look to move_order()
341      *
342      * @param int $sortorder
343      * @return bool
344      */
345     private function update_sortorder($sortorder = null) {
346         global $DB;
348         if (!empty($sortorder) && $sortorder!=0) {
349             $this->_sortorder = $sortorder;
350         }
351         //if sortorder is not set, we set it as the ;ast position in the list
352         else if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
353             $sql = "SELECT MAX(sortorder) FROM {repository}";
354             $this->_sortorder = 1 + $DB->get_field_sql($sql);
355         }
357         return $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$this->_typename));
358     }
360     /**
361      * Change order of the type with its adjacent upper or downer type
362      * (database fields are updated)
363      * Algorithm details:
364      * 1. retrieve all types in an array. This array is sorted by sortorder,
365      * and the array keys start from 0 to X (incremented by 1)
366      * 2. switch sortorder values of this type and its adjacent type
367      *
368      * @param string $move "up" or "down"
369      */
370     public function move_order($move) {
371         global $DB;
373         $types = repository::get_types();    // retrieve all types
375         // retrieve this type into the returned array
376         $i = 0;
377         while (!isset($indice) && $i<count($types)) {
378             if ($types[$i]->get_typename() == $this->_typename) {
379                 $indice = $i;
380             }
381             $i++;
382         }
384         // retrieve adjacent indice
385         switch ($move) {
386             case "up":
387                 $adjacentindice = $indice - 1;
388             break;
389             case "down":
390                 $adjacentindice = $indice + 1;
391             break;
392             default:
393             throw new repository_exception('movenotdefined', 'repository');
394         }
396         //switch sortorder of this type and the adjacent type
397         //TODO: we could reset sortorder for all types. This is not as good in performance term, but
398         //that prevent from wrong behaviour on a screwed database. As performance are not important in this particular case
399         //it worth to change the algo.
400         if ($adjacentindice>=0 && !empty($types[$adjacentindice])) {
401             $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$types[$adjacentindice]->get_typename()));
402             $this->update_sortorder($types[$adjacentindice]->get_sortorder());
403         }
404     }
406     /**
407      * 1. Change visibility to the value chosen
408      * 2. Update the type
409      *
410      * @param bool $visible
411      * @return bool
412      */
413     public function update_visibility($visible = null) {
414         if (is_bool($visible)) {
415             $this->_visible = $visible;
416         } else {
417             $this->_visible = !$this->_visible;
418         }
419         return $this->update_visible();
420     }
423     /**
424      * Delete a repository_type (general options are removed from config_plugin
425      * table, and all instances are deleted)
426      *
427      * @param bool $downloadcontents download external contents if exist
428      * @return bool
429      */
430     public function delete($downloadcontents = false) {
431         global $DB;
433         //delete all instances of this type
434         $params = array();
435         $params['context'] = array();
436         $params['onlyvisible'] = false;
437         $params['type'] = $this->_typename;
438         $instances = repository::get_instances($params);
439         foreach ($instances as $instance) {
440             $instance->delete($downloadcontents);
441         }
443         //delete all general options
444         foreach ($this->_options as $name => $value) {
445             set_config($name, null, $this->_typename);
446         }
448         try {
449             $DB->delete_records('repository', array('type' => $this->_typename));
450         } catch (dml_exception $ex) {
451             return false;
452         }
453         return true;
454     }
457 /**
458  * This is the base class of the repository class.
459  *
460  * To create repository plugin, see: {@link http://docs.moodle.org/dev/Repository_plugins}
461  * See an example: {@link repository_boxnet}
462  *
463  * @package   repository
464  * @category  repository
465  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
466  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
467  */
468 abstract class repository {
469     // $disabled can be set to true to disable a plugin by force
470     // example: self::$disabled = true
471     /** @var bool force disable repository instance */
472     public $disabled = false;
473     /** @var int repository instance id */
474     public $id;
475     /** @var stdClass current context */
476     public $context;
477     /** @var array repository options */
478     public $options;
479     /** @var bool Whether or not the repository instance is editable */
480     public $readonly;
481     /** @var int return types */
482     public $returntypes;
483     /** @var stdClass repository instance database record */
484     public $instance;
485     /**
486      * Constructor
487      *
488      * @param int $repositoryid repository instance id
489      * @param int|stdClass $context a context id or context object
490      * @param array $options repository options
491      * @param int $readonly indicate this repo is readonly or not
492      */
493     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array(), $readonly = 0) {
494         global $DB;
495         $this->id = $repositoryid;
496         if (is_object($context)) {
497             $this->context = $context;
498         } else {
499             $this->context = get_context_instance_by_id($context);
500         }
501         $this->instance = $DB->get_record('repository_instances', array('id'=>$this->id));
502         $this->readonly = $readonly;
503         $this->options = array();
505         if (is_array($options)) {
506             // The get_option() method will get stored options in database.
507             $options = array_merge($this->get_option(), $options);
508         } else {
509             $options = $this->get_option();
510         }
511         foreach ($options as $n => $v) {
512             $this->options[$n] = $v;
513         }
514         $this->name = $this->get_name();
515         $this->returntypes = $this->supported_returntypes();
516         $this->super_called = true;
517     }
519     /**
520      * Get repository instance using repository id
521      *
522      * @param int $repositoryid repository ID
523      * @param stdClass|int $context context instance or context ID
524      * @return repository
525      */
526     public static function get_repository_by_id($repositoryid, $context) {
527         global $CFG, $DB;
529         $sql = 'SELECT i.name, i.typeid, r.type FROM {repository} r, {repository_instances} i WHERE i.id=? AND i.typeid=r.id';
531         if (!$record = $DB->get_record_sql($sql, array($repositoryid))) {
532             throw new repository_exception('invalidrepositoryid', 'repository');
533         } else {
534             $type = $record->type;
535             if (file_exists($CFG->dirroot . "/repository/$type/lib.php")) {
536                 require_once($CFG->dirroot . "/repository/$type/lib.php");
537                 $classname = 'repository_' . $type;
538                 $contextid = $context;
539                 if (is_object($context)) {
540                     $contextid = $context->id;
541                 }
542                 $repository = new $classname($repositoryid, $contextid, array('type'=>$type));
543                 return $repository;
544             } else {
545                 throw new moodle_exception('error');
546             }
547         }
548     }
550     /**
551      * Get a repository type object by a given type name.
552      *
553      * @static
554      * @param string $typename the repository type name
555      * @return repository_type|bool
556      */
557     public static function get_type_by_typename($typename) {
558         global $DB;
560         if (!$record = $DB->get_record('repository',array('type' => $typename))) {
561             return false;
562         }
564         return new repository_type($typename, (array)get_config($typename), $record->visible, $record->sortorder);
565     }
567     /**
568      * Get the repository type by a given repository type id.
569      *
570      * @static
571      * @param int $id the type id
572      * @return object
573      */
574     public static function get_type_by_id($id) {
575         global $DB;
577         if (!$record = $DB->get_record('repository',array('id' => $id))) {
578             return false;
579         }
581         return new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
582     }
584     /**
585      * Return all repository types ordered by sortorder field
586      * first repository type in returnedarray[0], second repository type in returnedarray[1], ...
587      *
588      * @static
589      * @param bool $visible can return types by visiblity, return all types if null
590      * @return array Repository types
591      */
592     public static function get_types($visible=null) {
593         global $DB, $CFG;
595         $types = array();
596         $params = null;
597         if (!empty($visible)) {
598             $params = array('visible' => $visible);
599         }
600         if ($records = $DB->get_records('repository',$params,'sortorder')) {
601             foreach($records as $type) {
602                 if (file_exists($CFG->dirroot . '/repository/'. $type->type .'/lib.php')) {
603                     $types[] = new repository_type($type->type, (array)get_config($type->type), $type->visible, $type->sortorder);
604                 }
605             }
606         }
608         return $types;
609     }
611     /**
612      * To check if the context id is valid
613      *
614      * @static
615      * @param int $contextid
616      * @param stdClass $instance
617      * @return bool
618      */
619     public static function check_capability($contextid, $instance) {
620         $context = get_context_instance_by_id($contextid);
621         $capability = has_capability('repository/'.$instance->type.':view', $context);
622         if (!$capability) {
623             throw new repository_exception('nopermissiontoaccess', 'repository');
624         }
625     }
627     /**
628      * Check if file already exists in draft area
629      *
630      * @static
631      * @param int $itemid
632      * @param string $filepath
633      * @param string $filename
634      * @return bool
635      */
636     public static function draftfile_exists($itemid, $filepath, $filename) {
637         global $USER;
638         $fs = get_file_storage();
639         $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
640         if ($fs->get_file($usercontext->id, 'user', 'draft', $itemid, $filepath, $filename)) {
641             return true;
642         } else {
643             return false;
644         }
645     }
647     /**
648      * Parses the 'source' returned by moodle repositories and returns an instance of stored_file
649      *
650      * @param string $source
651      * @return stored_file|null
652      */
653     public static function get_moodle_file($source) {
654         $params = unserialize(base64_decode($source));
655         if (empty($params) || !is_array($params)) {
656             return null;
657         }
658         foreach (array('contextid', 'itemid', 'filename', 'filepath', 'component') as $key) {
659             if (!array_key_exists($key, $params)) {
660                 return null;
661             }
662         }
663         $contextid  = clean_param($params['contextid'], PARAM_INT);
664         $component  = clean_param($params['component'], PARAM_COMPONENT);
665         $filearea   = clean_param($params['filearea'],  PARAM_AREA);
666         $itemid     = clean_param($params['itemid'],    PARAM_INT);
667         $filepath   = clean_param($params['filepath'],  PARAM_PATH);
668         $filename   = clean_param($params['filename'],  PARAM_FILE);
669         $fs = get_file_storage();
670         return $fs->get_file($contextid, $component, $filearea, $itemid, $filepath, $filename);
671     }
673     /**
674      * This function is used to copy a moodle file to draft area
675      *
676      * @param string $encoded The metainfo of file, it is base64 encoded php serialized data
677      * @param stdClass|array $filerecord contains itemid, filepath, filename and optionally other
678      *      attributes of the new file
679      * @param int $maxbytes maximum allowed size of file, -1 if unlimited. If size of file exceeds
680      *      the limit, the file_exception is thrown.
681      * @return array The information of file
682      */
683     public function copy_to_area($encoded, $filerecord, $maxbytes = -1) {
684         global $USER;
685         $fs = get_file_storage();
686         $browser = get_file_browser();
688         if ($this->has_moodle_files() == false) {
689             throw new coding_exception('Only repository used to browse moodle files can use repository::copy_to_area()');
690         }
692         $params = unserialize(base64_decode($encoded));
693         $user_context = context_user::instance($USER->id);
695         $filerecord = (array)$filerecord;
696         // make sure the new file will be created in user draft area
697         $filerecord['component'] = 'user';
698         $filerecord['filearea'] = 'draft';
699         $filerecord['contextid'] = $user_context->id;
700         $draftitemid = $filerecord['itemid'];
701         $new_filepath = $filerecord['filepath'];
702         $new_filename = $filerecord['filename'];
704         $contextid  = clean_param($params['contextid'], PARAM_INT);
705         $fileitemid = clean_param($params['itemid'],    PARAM_INT);
706         $filename   = clean_param($params['filename'],  PARAM_FILE);
707         $filepath   = clean_param($params['filepath'],  PARAM_PATH);;
708         $filearea   = clean_param($params['filearea'],  PARAM_AREA);
709         $component  = clean_param($params['component'], PARAM_COMPONENT);
711         $context    = get_context_instance_by_id($contextid);
712         // the file needs to copied to draft area
713         $file_info  = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
714         if ($maxbytes !== -1 && $file_info->get_filesize() > $maxbytes) {
715             throw new file_exception('maxbytes');
716         }
718         if (repository::draftfile_exists($draftitemid, $new_filepath, $new_filename)) {
719             // create new file
720             $unused_filename = repository::get_unused_filename($draftitemid, $new_filepath, $new_filename);
721             $filerecord['filename'] = $unused_filename;
722             $file_info->copy_to_storage($filerecord);
723             $event = array();
724             $event['event'] = 'fileexists';
725             $event['newfile'] = new stdClass;
726             $event['newfile']->filepath = $new_filepath;
727             $event['newfile']->filename = $unused_filename;
728             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $unused_filename)->out();
729             $event['existingfile'] = new stdClass;
730             $event['existingfile']->filepath = $new_filepath;
731             $event['existingfile']->filename = $new_filename;
732             $event['existingfile']->url      = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();;
733             return $event;
734         } else {
735             $file_info->copy_to_storage($filerecord);
736             $info = array();
737             $info['itemid'] = $draftitemid;
738             $info['file']  = $new_filename;
739             $info['title']  = $new_filename;
740             $info['contextid'] = $user_context->id;
741             $info['url'] = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();;
742             $info['filesize'] = $file_info->get_filesize();
743             return $info;
744         }
745     }
747     /**
748      * Get unused filename by appending suffix
749      *
750      * @static
751      * @param int $itemid
752      * @param string $filepath
753      * @param string $filename
754      * @return string
755      */
756     public static function get_unused_filename($itemid, $filepath, $filename) {
757         global $USER;
758         $fs = get_file_storage();
759         while (repository::draftfile_exists($itemid, $filepath, $filename)) {
760             $filename = repository::append_suffix($filename);
761         }
762         return $filename;
763     }
765     /**
766      * Append a suffix to filename
767      *
768      * @static
769      * @param string $filename
770      * @return string
771      */
772     public static function append_suffix($filename) {
773         $pathinfo = pathinfo($filename);
774         if (empty($pathinfo['extension'])) {
775             return $filename . RENAME_SUFFIX;
776         } else {
777             return $pathinfo['filename'] . RENAME_SUFFIX . '.' . $pathinfo['extension'];
778         }
779     }
781     /**
782      * Return all types that you a user can create/edit and which are also visible
783      * Note: Mostly used in order to know if at least one editable type can be set
784      *
785      * @static
786      * @param stdClass $context the context for which we want the editable types
787      * @return array types
788      */
789     public static function get_editable_types($context = null) {
791         if (empty($context)) {
792             $context = get_system_context();
793         }
795         $types= repository::get_types(true);
796         $editabletypes = array();
797         foreach ($types as $type) {
798             $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
799             if (!empty($instanceoptionnames)) {
800                 if ($type->get_contextvisibility($context)) {
801                     $editabletypes[]=$type;
802                 }
803              }
804         }
805         return $editabletypes;
806     }
808     /**
809      * Return repository instances
810      *
811      * @static
812      * @param array $args Array containing the following keys:
813      *           currentcontext
814      *           context
815      *           onlyvisible
816      *           type
817      *           accepted_types
818      *           return_types
819      *           userid
820      *
821      * @return array repository instances
822      */
823     public static function get_instances($args = array()) {
824         global $DB, $CFG, $USER;
826         if (isset($args['currentcontext'])) {
827             $current_context = $args['currentcontext'];
828         } else {
829             $current_context = null;
830         }
832         if (!empty($args['context'])) {
833             $contexts = $args['context'];
834         } else {
835             $contexts = array();
836         }
838         $onlyvisible = isset($args['onlyvisible']) ? $args['onlyvisible'] : true;
839         $returntypes = isset($args['return_types']) ? $args['return_types'] : 3;
840         $type        = isset($args['type']) ? $args['type'] : null;
842         $params = array();
843         $sql = "SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
844                   FROM {repository} r, {repository_instances} i
845                  WHERE i.typeid = r.id ";
847         if (!empty($args['disable_types']) && is_array($args['disable_types'])) {
848             list($types, $p) = $DB->get_in_or_equal($args['disable_types'], SQL_PARAMS_QM, 'param', false);
849             $sql .= " AND r.type $types";
850             $params = array_merge($params, $p);
851         }
853         if (!empty($args['userid']) && is_numeric($args['userid'])) {
854             $sql .= " AND (i.userid = 0 or i.userid = ?)";
855             $params[] = $args['userid'];
856         }
858         foreach ($contexts as $context) {
859             if (empty($firstcontext)) {
860                 $firstcontext = true;
861                 $sql .= " AND ((i.contextid = ?)";
862             } else {
863                 $sql .= " OR (i.contextid = ?)";
864             }
865             $params[] = $context->id;
866         }
868         if (!empty($firstcontext)) {
869            $sql .=')';
870         }
872         if ($onlyvisible == true) {
873             $sql .= " AND (r.visible = 1)";
874         }
876         if (isset($type)) {
877             $sql .= " AND (r.type = ?)";
878             $params[] = $type;
879         }
880         $sql .= " ORDER BY r.sortorder, i.name";
882         if (!$records = $DB->get_records_sql($sql, $params)) {
883             $records = array();
884         }
886         $repositories = array();
887         if (isset($args['accepted_types'])) {
888             $accepted_types = $args['accepted_types'];
889         } else {
890             $accepted_types = '*';
891         }
892         // Sortorder should be unique, which is not true if we use $record->sortorder
893         // and there are multiple instances of any repository type
894         $sortorder = 1;
895         foreach ($records as $record) {
896             if (!file_exists($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php')) {
897                 continue;
898             }
899             require_once($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php');
900             $options['visible'] = $record->visible;
901             $options['type']    = $record->repositorytype;
902             $options['typeid']  = $record->typeid;
903             $options['sortorder'] = $sortorder++;
904             // tell instance what file types will be accepted by file picker
905             $classname = 'repository_' . $record->repositorytype;
907             $repository = new $classname($record->id, $record->contextid, $options, $record->readonly);
909             $is_supported = true;
911             if (empty($repository->super_called)) {
912                 // to make sure the super construct is called
913                 debugging('parent::__construct must be called by '.$record->repositorytype.' plugin.');
914             } else {
915                 // check mimetypes
916                 if ($accepted_types !== '*' and $repository->supported_filetypes() !== '*') {
917                     $accepted_ext = file_get_typegroup('extension', $accepted_types);
918                     $supported_ext = file_get_typegroup('extension', $repository->supported_filetypes());
919                     $valid_ext = array_intersect($accepted_ext, $supported_ext);
920                     $is_supported = !empty($valid_ext);
921                 }
922                 // check return values
923                 if ($returntypes !== 3 and $repository->supported_returntypes() !== 3) {
924                     $type = $repository->supported_returntypes();
925                     if ($type & $returntypes) {
926                         //
927                     } else {
928                         $is_supported = false;
929                     }
930                 }
932                 if (!$onlyvisible || ($repository->is_visible() && !$repository->disabled)) {
933                     // check capability in current context
934                     if (!empty($current_context)) {
935                         $capability = has_capability('repository/'.$record->repositorytype.':view', $current_context);
936                     } else {
937                         $capability = has_capability('repository/'.$record->repositorytype.':view', get_system_context());
938                     }
939                     if ($record->repositorytype == 'coursefiles') {
940                         // coursefiles plugin needs managefiles permission
941                         if (!empty($current_context)) {
942                             $capability = $capability && has_capability('moodle/course:managefiles', $current_context);
943                         } else {
944                             $capability = $capability && has_capability('moodle/course:managefiles', get_system_context());
945                         }
946                     }
947                     if ($is_supported && $capability) {
948                         $repositories[$repository->id] = $repository;
949                     }
950                 }
951             }
952         }
953         return $repositories;
954     }
956     /**
957      * Get single repository instance
958      *
959      * @static
960      * @param integer $id repository id
961      * @return object repository instance
962      */
963     public static function get_instance($id) {
964         global $DB, $CFG;
965         $sql = "SELECT i.*, r.type AS repositorytype, r.visible
966                   FROM {repository} r
967                   JOIN {repository_instances} i ON i.typeid = r.id
968                  WHERE i.id = ?";
970         if (!$instance = $DB->get_record_sql($sql, array($id))) {
971             return false;
972         }
973         require_once($CFG->dirroot . '/repository/'. $instance->repositorytype.'/lib.php');
974         $classname = 'repository_' . $instance->repositorytype;
975         $options['typeid'] = $instance->typeid;
976         $options['type']   = $instance->repositorytype;
977         $options['name']   = $instance->name;
978         $obj = new $classname($instance->id, $instance->contextid, $options, $instance->readonly);
979         if (empty($obj->super_called)) {
980             debugging('parent::__construct must be called by '.$classname.' plugin.');
981         }
982         return $obj;
983     }
985     /**
986      * Call a static function. Any additional arguments than plugin and function will be passed through.
987      *
988      * @static
989      * @param string $plugin repository plugin name
990      * @param string $function funciton name
991      * @return mixed
992      */
993     public static function static_function($plugin, $function) {
994         global $CFG;
996         //check that the plugin exists
997         $typedirectory = $CFG->dirroot . '/repository/'. $plugin . '/lib.php';
998         if (!file_exists($typedirectory)) {
999             //throw new repository_exception('invalidplugin', 'repository');
1000             return false;
1001         }
1003         $pname = null;
1004         if (is_object($plugin) || is_array($plugin)) {
1005             $plugin = (object)$plugin;
1006             $pname = $plugin->name;
1007         } else {
1008             $pname = $plugin;
1009         }
1011         $args = func_get_args();
1012         if (count($args) <= 2) {
1013             $args = array();
1014         } else {
1015             array_shift($args);
1016             array_shift($args);
1017         }
1019         require_once($typedirectory);
1020         return call_user_func_array(array('repository_' . $plugin, $function), $args);
1021     }
1023     /**
1024      * Scan file, throws exception in case of infected file.
1025      *
1026      * Please note that the scanning engine must be able to access the file,
1027      * permissions of the file are not modified here!
1028      *
1029      * @static
1030      * @param string $thefile
1031      * @param string $filename name of the file
1032      * @param bool $deleteinfected
1033      */
1034     public static function antivir_scan_file($thefile, $filename, $deleteinfected) {
1035         global $CFG;
1037         if (!is_readable($thefile)) {
1038             // this should not happen
1039             return;
1040         }
1042         if (empty($CFG->runclamonupload) or empty($CFG->pathtoclam)) {
1043             // clam not enabled
1044             return;
1045         }
1047         $CFG->pathtoclam = trim($CFG->pathtoclam);
1049         if (!file_exists($CFG->pathtoclam) or !is_executable($CFG->pathtoclam)) {
1050             // misconfigured clam - use the old notification for now
1051             require("$CFG->libdir/uploadlib.php");
1052             $notice = get_string('clamlost', 'moodle', $CFG->pathtoclam);
1053             clam_message_admins($notice);
1054             return;
1055         }
1057         // do NOT mess with permissions here, the calling party is responsible for making
1058         // sure the scanner engine can access the files!
1060         // execute test
1061         $cmd = escapeshellcmd($CFG->pathtoclam).' --stdout '.escapeshellarg($thefile);
1062         exec($cmd, $output, $return);
1064         if ($return == 0) {
1065             // perfect, no problem found
1066             return;
1068         } else if ($return == 1) {
1069             // infection found
1070             if ($deleteinfected) {
1071                 unlink($thefile);
1072             }
1073             throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1075         } else {
1076             //unknown problem
1077             require("$CFG->libdir/uploadlib.php");
1078             $notice = get_string('clamfailed', 'moodle', get_clam_error_code($return));
1079             $notice .= "\n\n". implode("\n", $output);
1080             clam_message_admins($notice);
1081             if ($CFG->clamfailureonupload === 'actlikevirus') {
1082                 if ($deleteinfected) {
1083                     unlink($thefile);
1084                 }
1085                 throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1086             } else {
1087                 return;
1088             }
1089         }
1090     }
1092     /**
1093      * Repository method to serve the referenced file
1094      *
1095      * @see send_stored_file
1096      *
1097      * @param stored_file $storedfile the file that contains the reference
1098      * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
1099      * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1100      * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1101      * @param array $options additional options affecting the file serving
1102      */
1103     public function send_file($storedfile, $lifetime=86400 , $filter=0, $forcedownload=false, array $options = null) {
1104         if ($this->has_moodle_files()) {
1105             $fs = get_file_storage();
1106             $params = file_storage::unpack_reference($storedfile->get_reference(), true);
1107             $srcfile = null;
1108             if (is_array($params)) {
1109                 $srcfile = $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
1110                         $params['itemid'], $params['filepath'], $params['filename']);
1111             }
1112             if (empty($options)) {
1113                 $options = array();
1114             }
1115             if (!isset($options['filename'])) {
1116                 $options['filename'] = $storedfile->get_filename();
1117             }
1118             if (!$srcfile) {
1119                 send_file_not_found();
1120             } else {
1121                 send_stored_file($srcfile, $lifetime, $filter, $forcedownload, $options);
1122             }
1123         } else {
1124             throw new coding_exception("Repository plugin must implement send_file() method.");
1125         }
1126     }
1128     /**
1129      * Return reference file life time
1130      *
1131      * @param string $ref
1132      * @return int
1133      */
1134     public function get_reference_file_lifetime($ref) {
1135         // One day
1136         return 60 * 60 * 24;
1137     }
1139     /**
1140      * Decide whether or not the file should be synced
1141      *
1142      * @param stored_file $storedfile
1143      * @return bool
1144      */
1145     public function sync_individual_file(stored_file $storedfile) {
1146         return true;
1147     }
1149     /**
1150      * Return human readable reference information
1151      * {@link stored_file::get_reference()}
1152      *
1153      * @param string $reference
1154      * @param int $filestatus status of the file, 0 - ok, 666 - source missing
1155      * @return string
1156      */
1157     public function get_reference_details($reference, $filestatus = 0) {
1158         if ($this->has_moodle_files()) {
1159             $fileinfo = null;
1160             $params = file_storage::unpack_reference($reference, true);
1161             if (is_array($params)) {
1162                 $context = get_context_instance_by_id($params['contextid']);
1163                 if ($context) {
1164                     $browser = get_file_browser();
1165                     $fileinfo = $browser->get_file_info($context, $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']);
1166                 }
1167             }
1168             if (empty($fileinfo)) {
1169                 if ($filestatus == 666) {
1170                     if (is_siteadmin() || ($context && has_capability('moodle/course:managefiles', $context))) {
1171                         return get_string('lostsource', 'repository',
1172                                 $params['contextid']. '/'. $params['component']. '/'. $params['filearea']. '/'. $params['itemid']. $params['filepath']. $params['filename']);
1173                     } else {
1174                         return get_string('lostsource', 'repository', '');
1175                     }
1176                 }
1177                 return get_string('undisclosedsource', 'repository');
1178             } else {
1179                 return $fileinfo->get_readable_fullname();
1180             }
1181         }
1182         return '';
1183     }
1185     /**
1186      * Cache file from external repository by reference
1187      * {@link repository::get_file_reference()}
1188      * {@link repository::get_file()}
1189      * Invoked at MOODLE/repository/repository_ajax.php
1190      *
1191      * @param string $reference this reference is generated by
1192      *                          repository::get_file_reference()
1193      * @param stored_file $storedfile created file reference
1194      */
1195     public function cache_file_by_reference($reference, $storedfile) {
1196     }
1198     /**
1199      * Returns information about file in this repository by reference
1200      * {@link repository::get_file_reference()}
1201      * {@link repository::get_file()}
1202      *
1203      * Returns null if file not found or is not readable
1204      *
1205      * @param stdClass $reference file reference db record
1206      * @return stdClass|null contains one of the following:
1207      *   - 'contenthash' and 'filesize'
1208      *   - 'filepath'
1209      *   - 'handle'
1210      *   - 'content'
1211      */
1212     public function get_file_by_reference($reference) {
1213         if ($this->has_moodle_files() && isset($reference->reference)) {
1214             $fs = get_file_storage();
1215             $params = file_storage::unpack_reference($reference->reference, true);
1216             if (!is_array($params) || !($storedfile = $fs->get_file($params['contextid'],
1217                     $params['component'], $params['filearea'], $params['itemid'], $params['filepath'],
1218                     $params['filename']))) {
1219                 return null;
1220             }
1221             return (object)array(
1222                 'contenthash' => $storedfile->get_contenthash(),
1223                 'filesize'    => $storedfile->get_filesize()
1224             );
1225         }
1226         return null;
1227     }
1229     /**
1230      * Return the source information
1231      *
1232      * @param stdClass $url
1233      * @return string|null
1234      */
1235     public function get_file_source_info($url) {
1236         if ($this->has_moodle_files()) {
1237             return $this->get_reference_details($url, 0);
1238         }
1239         return $url;
1240     }
1242     /**
1243      * Move file from download folder to file pool using FILE API
1244      *
1245      * @todo MDL-28637
1246      * @static
1247      * @param string $thefile file path in download folder
1248      * @param stdClass $record
1249      * @return array containing the following keys:
1250      *           icon
1251      *           file
1252      *           id
1253      *           url
1254      */
1255     public static function move_to_filepool($thefile, $record) {
1256         global $DB, $CFG, $USER, $OUTPUT;
1258         // scan for viruses if possible, throws exception if problem found
1259         self::antivir_scan_file($thefile, $record->filename, empty($CFG->repository_no_delete)); //TODO: MDL-28637 this repository_no_delete is a bloody hack!
1261         $fs = get_file_storage();
1262         // If file name being used.
1263         if (repository::draftfile_exists($record->itemid, $record->filepath, $record->filename)) {
1264             $draftitemid = $record->itemid;
1265             $new_filename = repository::get_unused_filename($draftitemid, $record->filepath, $record->filename);
1266             $old_filename = $record->filename;
1267             // Create a tmp file.
1268             $record->filename = $new_filename;
1269             $newfile = $fs->create_file_from_pathname($record, $thefile);
1270             $event = array();
1271             $event['event'] = 'fileexists';
1272             $event['newfile'] = new stdClass;
1273             $event['newfile']->filepath = $record->filepath;
1274             $event['newfile']->filename = $new_filename;
1275             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $new_filename)->out();
1277             $event['existingfile'] = new stdClass;
1278             $event['existingfile']->filepath = $record->filepath;
1279             $event['existingfile']->filename = $old_filename;
1280             $event['existingfile']->url      = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $old_filename)->out();;
1281             return $event;
1282         }
1283         if ($file = $fs->create_file_from_pathname($record, $thefile)) {
1284             if (empty($CFG->repository_no_delete)) {
1285                 $delete = unlink($thefile);
1286                 unset($CFG->repository_no_delete);
1287             }
1288             return array(
1289                 'url'=>moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename())->out(),
1290                 'id'=>$file->get_itemid(),
1291                 'file'=>$file->get_filename(),
1292                 'icon' => $OUTPUT->pix_url(file_extension_icon($thefile, 32))->out(),
1293             );
1294         } else {
1295             return null;
1296         }
1297     }
1299     /**
1300      * Builds a tree of files This function is then called recursively.
1301      *
1302      * @static
1303      * @todo take $search into account, and respect a threshold for dynamic loading
1304      * @param file_info $fileinfo an object returned by file_browser::get_file_info()
1305      * @param string $search searched string
1306      * @param bool $dynamicmode no recursive call is done when in dynamic mode
1307      * @param array $list the array containing the files under the passed $fileinfo
1308      * @returns int the number of files found
1309      *
1310      */
1311     public static function build_tree($fileinfo, $search, $dynamicmode, &$list) {
1312         global $CFG, $OUTPUT;
1314         $filecount = 0;
1315         $children = $fileinfo->get_children();
1317         foreach ($children as $child) {
1318             $filename = $child->get_visible_name();
1319             $filesize = $child->get_filesize();
1320             $filesize = $filesize ? display_size($filesize) : '';
1321             $filedate = $child->get_timemodified();
1322             $filedate = $filedate ? userdate($filedate) : '';
1323             $filetype = $child->get_mimetype();
1325             if ($child->is_directory()) {
1326                 $path = array();
1327                 $level = $child->get_parent();
1328                 while ($level) {
1329                     $params = $level->get_params();
1330                     $path[] = array($params['filepath'], $level->get_visible_name());
1331                     $level = $level->get_parent();
1332                 }
1334                 $tmp = array(
1335                     'title' => $child->get_visible_name(),
1336                     'size' => 0,
1337                     'date' => $filedate,
1338                     'path' => array_reverse($path),
1339                     'thumbnail' => $OUTPUT->pix_url(file_folder_icon(90))->out(false)
1340                 );
1342                 //if ($dynamicmode && $child->is_writable()) {
1343                 //    $tmp['children'] = array();
1344                 //} else {
1345                     // if folder name matches search, we send back all files contained.
1346                 $_search = $search;
1347                 if ($search && stristr($tmp['title'], $search) !== false) {
1348                     $_search = false;
1349                 }
1350                 $tmp['children'] = array();
1351                 $_filecount = repository::build_tree($child, $_search, $dynamicmode, $tmp['children']);
1352                 if ($search && $_filecount) {
1353                     $tmp['expanded'] = 1;
1354                 }
1356                 //}
1358                 if (!$search || $_filecount || (stristr($tmp['title'], $search) !== false)) {
1359                     $filecount += $_filecount;
1360                     $list[] = $tmp;
1361                 }
1363             } else { // not a directory
1364                 // skip the file, if we're in search mode and it's not a match
1365                 if ($search && (stristr($filename, $search) === false)) {
1366                     continue;
1367                 }
1368                 $params = $child->get_params();
1369                 $source = serialize(array($params['contextid'], $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']));
1370                 $list[] = array(
1371                     'title' => $filename,
1372                     'size' => $filesize,
1373                     'date' => $filedate,
1374                     //'source' => $child->get_url(),
1375                     'source' => base64_encode($source),
1376                     'icon'=>$OUTPUT->pix_url(file_file_icon($child, 24))->out(false),
1377                     'thumbnail'=>$OUTPUT->pix_url(file_file_icon($child, 90))->out(false),
1378                 );
1379                 $filecount++;
1380             }
1381         }
1383         return $filecount;
1384     }
1386     /**
1387      * Display a repository instance list (with edit/delete/create links)
1388      *
1389      * @static
1390      * @param stdClass $context the context for which we display the instance
1391      * @param string $typename if set, we display only one type of instance
1392      */
1393     public static function display_instances_list($context, $typename = null) {
1394         global $CFG, $USER, $OUTPUT;
1396         $output = $OUTPUT->box_start('generalbox');
1397         //if the context is SYSTEM, so we call it from administration page
1398         $admin = ($context->id == SYSCONTEXTID) ? true : false;
1399         if ($admin) {
1400             $baseurl = new moodle_url('/'.$CFG->admin.'/repositoryinstance.php', array('sesskey'=>sesskey()));
1401             $output .= $OUTPUT->heading(get_string('siteinstances', 'repository'));
1402         } else {
1403             $baseurl = new moodle_url('/repository/manage_instances.php', array('contextid'=>$context->id, 'sesskey'=>sesskey()));
1404         }
1406         $namestr = get_string('name');
1407         $pluginstr = get_string('plugin', 'repository');
1408         $settingsstr = get_string('settings');
1409         $deletestr = get_string('delete');
1410         //retrieve list of instances. In administration context we want to display all
1411         //instances of a type, even if this type is not visible. In course/user context we
1412         //want to display only visible instances, but for every type types. The repository::get_instances()
1413         //third parameter displays only visible type.
1414         $params = array();
1415         $params['context'] = array($context, get_system_context());
1416         $params['currentcontext'] = $context;
1417         $params['onlyvisible'] = !$admin;
1418         $params['type']        = $typename;
1419         $instances = repository::get_instances($params);
1420         $instancesnumber = count($instances);
1421         $alreadyplugins = array();
1423         $table = new html_table();
1424         $table->head = array($namestr, $pluginstr, $settingsstr, $deletestr);
1425         $table->align = array('left', 'left', 'center','center');
1426         $table->data = array();
1428         $updowncount = 1;
1430         foreach ($instances as $i) {
1431             $settings = '';
1432             $delete = '';
1434             $type = repository::get_type_by_id($i->options['typeid']);
1436             if ($type->get_contextvisibility($context)) {
1437                 if (!$i->readonly) {
1439                     $settingurl = new moodle_url($baseurl);
1440                     $settingurl->param('type', $i->options['type']);
1441                     $settingurl->param('edit', $i->id);
1442                     $settings .= html_writer::link($settingurl, $settingsstr);
1444                     $deleteurl = new moodle_url($baseurl);
1445                     $deleteurl->param('delete', $i->id);
1446                     $deleteurl->param('type', $i->options['type']);
1447                     $delete .= html_writer::link($deleteurl, $deletestr);
1448                 }
1449             }
1451             $type = repository::get_type_by_id($i->options['typeid']);
1452             $table->data[] = array(format_string($i->name), $type->get_readablename(), $settings, $delete);
1454             //display a grey row if the type is defined as not visible
1455             if (isset($type) && !$type->get_visible()) {
1456                 $table->rowclasses[] = 'dimmed_text';
1457             } else {
1458                 $table->rowclasses[] = '';
1459             }
1461             if (!in_array($i->name, $alreadyplugins)) {
1462                 $alreadyplugins[] = $i->name;
1463             }
1464         }
1465         $output .= html_writer::table($table);
1466         $instancehtml = '<div>';
1467         $addable = 0;
1469         //if no type is set, we can create all type of instance
1470         if (!$typename) {
1471             $instancehtml .= '<h3>';
1472             $instancehtml .= get_string('createrepository', 'repository');
1473             $instancehtml .= '</h3><ul>';
1474             $types = repository::get_editable_types($context);
1475             foreach ($types as $type) {
1476                 if (!empty($type) && $type->get_visible()) {
1477                     $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
1478                     if (!empty($instanceoptionnames)) {
1479                         $baseurl->param('new', $type->get_typename());
1480                         $instancehtml .= '<li><a href="'.$baseurl->out().'">'.get_string('createxxinstance', 'repository', get_string('pluginname', 'repository_'.$type->get_typename())).  '</a></li>';
1481                         $baseurl->remove_params('new');
1482                         $addable++;
1483                     }
1484                 }
1485             }
1486             $instancehtml .= '</ul>';
1488         } else {
1489             $instanceoptionnames = repository::static_function($typename, 'get_instance_option_names');
1490             if (!empty($instanceoptionnames)) {   //create a unique type of instance
1491                 $addable = 1;
1492                 $baseurl->param('new', $typename);
1493                 $output .= $OUTPUT->single_button($baseurl, get_string('createinstance', 'repository'), 'get');
1494                 $baseurl->remove_params('new');
1495             }
1496         }
1498         if ($addable) {
1499             $instancehtml .= '</div>';
1500             $output .= $instancehtml;
1501         }
1503         $output .= $OUTPUT->box_end();
1505         //print the list + creation links
1506         print($output);
1507     }
1509     /**
1510      * Prepare file reference information
1511      *
1512      * @param string $source
1513      * @return string file referece
1514      */
1515     public function get_file_reference($source) {
1516         if ($this->has_moodle_files() && ($this->supported_returntypes() & FILE_REFERENCE)) {
1517             $params = file_storage::unpack_reference($source);
1518             if (!is_array($params)) {
1519                 throw new repository_exception('invalidparams', 'repository');
1520             }
1521             return file_storage::pack_reference($params);
1522         }
1523         return $source;
1524     }
1525     /**
1526      * Decide where to save the file, can be overwriten by subclass
1527      *
1528      * @param string $filename file name
1529      * @return file path
1530      */
1531     public function prepare_file($filename) {
1532         global $CFG;
1533         if (!file_exists($CFG->tempdir.'/download')) {
1534             mkdir($CFG->tempdir.'/download/', $CFG->directorypermissions, true);
1535         }
1536         if (is_dir($CFG->tempdir.'/download')) {
1537             $dir = $CFG->tempdir.'/download/';
1538         }
1539         if (empty($filename)) {
1540             $filename = uniqid('repo', true).'_'.time().'.tmp';
1541         }
1542         if (file_exists($dir.$filename)) {
1543             $filename = uniqid('m').$filename;
1544         }
1545         return $dir.$filename;
1546     }
1548     /**
1549      * Does this repository used to browse moodle files?
1550      *
1551      * @return bool
1552      */
1553     public function has_moodle_files() {
1554         return false;
1555     }
1557     /**
1558      * Return file URL, for most plugins, the parameter is the original
1559      * url, but some plugins use a file id, so we need this function to
1560      * convert file id to original url.
1561      *
1562      * @param string $url the url of file
1563      * @return string
1564      */
1565     public function get_link($url) {
1566         return $url;
1567     }
1569     /**
1570      * Download a file, this function can be overridden by subclass. {@link curl}
1571      *
1572      * @param string $url the url of file
1573      * @param string $filename save location
1574      * @return array with elements:
1575      *   path: internal location of the file
1576      *   url: URL to the source (from parameters)
1577      */
1578     public function get_file($url, $filename = '') {
1579         global $CFG;
1580         $path = $this->prepare_file($filename);
1581         $fp = fopen($path, 'w');
1582         $c = new curl;
1583         $result = $c->download(array(array('url'=>$url, 'file'=>$fp)));
1584         // Close file handler.
1585         fclose($fp);
1586         if (empty($result)) {
1587             unlink($path);
1588             return null;
1589         }
1590         return array('path'=>$path, 'url'=>$url);
1591     }
1593     /**
1594      * Return size of a file in bytes.
1595      *
1596      * @param string $source encoded and serialized data of file
1597      * @return int file size in bytes
1598      */
1599     public function get_file_size($source) {
1600         // TODO MDL-33297 remove this function completely?
1601         $browser    = get_file_browser();
1602         $params     = unserialize(base64_decode($source));
1603         $contextid  = clean_param($params['contextid'], PARAM_INT);
1604         $fileitemid = clean_param($params['itemid'], PARAM_INT);
1605         $filename   = clean_param($params['filename'], PARAM_FILE);
1606         $filepath   = clean_param($params['filepath'], PARAM_PATH);
1607         $filearea   = clean_param($params['filearea'], PARAM_AREA);
1608         $component  = clean_param($params['component'], PARAM_COMPONENT);
1609         $context    = get_context_instance_by_id($contextid);
1610         $file_info  = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
1611         if (!empty($file_info)) {
1612             $filesize = $file_info->get_filesize();
1613         } else {
1614             $filesize = null;
1615         }
1616         return $filesize;
1617     }
1619     /**
1620      * Return is the instance is visible
1621      * (is the type visible ? is the context enable ?)
1622      *
1623      * @return bool
1624      */
1625     public function is_visible() {
1626         $type = repository::get_type_by_id($this->options['typeid']);
1627         $instanceoptions = repository::static_function($type->get_typename(), 'get_instance_option_names');
1629         if ($type->get_visible()) {
1630             //if the instance is unique so it's visible, otherwise check if the instance has a enabled context
1631             if (empty($instanceoptions) || $type->get_contextvisibility($this->context)) {
1632                 return true;
1633             }
1634         }
1636         return false;
1637     }
1639     /**
1640      * Return the name of this instance, can be overridden.
1641      *
1642      * @return string
1643      */
1644     public function get_name() {
1645         global $DB;
1646         if ( $name = $this->instance->name ) {
1647             return $name;
1648         } else {
1649             return get_string('pluginname', 'repository_' . $this->options['type']);
1650         }
1651     }
1653     /**
1654      * What kind of files will be in this repository?
1655      *
1656      * @return array return '*' means this repository support any files, otherwise
1657      *               return mimetypes of files, it can be an array
1658      */
1659     public function supported_filetypes() {
1660         // return array('text/plain', 'image/gif');
1661         return '*';
1662     }
1664     /**
1665      * Tells how the file can be picked from this repository
1666      *
1667      * Maximum value is FILE_INTERNAL | FILE_EXTERNAL | FILE_REFERENCE
1668      *
1669      * @return int
1670      */
1671     public function supported_returntypes() {
1672         return (FILE_INTERNAL | FILE_EXTERNAL);
1673     }
1675     /**
1676      * Provide repository instance information for Ajax
1677      *
1678      * @return stdClass
1679      */
1680     final public function get_meta() {
1681         global $CFG, $OUTPUT;
1682         $meta = new stdClass();
1683         $meta->id   = $this->id;
1684         $meta->name = format_string($this->get_name());
1685         $meta->type = $this->options['type'];
1686         $meta->icon = $OUTPUT->pix_url('icon', 'repository_'.$meta->type)->out(false);
1687         $meta->supported_types = file_get_typegroup('extension', $this->supported_filetypes());
1688         $meta->return_types = $this->supported_returntypes();
1689         $meta->sortorder = $this->options['sortorder'];
1690         return $meta;
1691     }
1693     /**
1694      * Create an instance for this plug-in
1695      *
1696      * @static
1697      * @param string $type the type of the repository
1698      * @param int $userid the user id
1699      * @param stdClass $context the context
1700      * @param array $params the options for this instance
1701      * @param int $readonly whether to create it readonly or not (defaults to not)
1702      * @return mixed
1703      */
1704     public static function create($type, $userid, $context, $params, $readonly=0) {
1705         global $CFG, $DB;
1706         $params = (array)$params;
1707         require_once($CFG->dirroot . '/repository/'. $type . '/lib.php');
1708         $classname = 'repository_' . $type;
1709         if ($repo = $DB->get_record('repository', array('type'=>$type))) {
1710             $record = new stdClass();
1711             $record->name = $params['name'];
1712             $record->typeid = $repo->id;
1713             $record->timecreated  = time();
1714             $record->timemodified = time();
1715             $record->contextid = $context->id;
1716             $record->readonly = $readonly;
1717             $record->userid    = $userid;
1718             $id = $DB->insert_record('repository_instances', $record);
1719             $options = array();
1720             $configs = call_user_func($classname . '::get_instance_option_names');
1721             if (!empty($configs)) {
1722                 foreach ($configs as $config) {
1723                     if (isset($params[$config])) {
1724                         $options[$config] = $params[$config];
1725                     } else {
1726                         $options[$config] = null;
1727                     }
1728                 }
1729             }
1731             if (!empty($id)) {
1732                 unset($options['name']);
1733                 $instance = repository::get_instance($id);
1734                 $instance->set_option($options);
1735                 return $id;
1736             } else {
1737                 return null;
1738             }
1739         } else {
1740             return null;
1741         }
1742     }
1744     /**
1745      * delete a repository instance
1746      *
1747      * @param bool $downloadcontents
1748      * @return bool
1749      */
1750     final public function delete($downloadcontents = false) {
1751         global $DB;
1752         if ($downloadcontents) {
1753             $this->convert_references_to_local();
1754         }
1755         try {
1756             $DB->delete_records('repository_instances', array('id'=>$this->id));
1757             $DB->delete_records('repository_instance_config', array('instanceid'=>$this->id));
1758         } catch (dml_exception $ex) {
1759             return false;
1760         }
1761         return true;
1762     }
1764     /**
1765      * Hide/Show a repository
1766      *
1767      * @param string $hide
1768      * @return bool
1769      */
1770     final public function hide($hide = 'toggle') {
1771         global $DB;
1772         if ($entry = $DB->get_record('repository', array('id'=>$this->id))) {
1773             if ($hide === 'toggle' ) {
1774                 if (!empty($entry->visible)) {
1775                     $entry->visible = 0;
1776                 } else {
1777                     $entry->visible = 1;
1778                 }
1779             } else {
1780                 if (!empty($hide)) {
1781                     $entry->visible = 0;
1782                 } else {
1783                     $entry->visible = 1;
1784                 }
1785             }
1786             return $DB->update_record('repository', $entry);
1787         }
1788         return false;
1789     }
1791     /**
1792      * Save settings for repository instance
1793      * $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));
1794      *
1795      * @param array $options settings
1796      * @return bool
1797      */
1798     public function set_option($options = array()) {
1799         global $DB;
1801         if (!empty($options['name'])) {
1802             $r = new stdClass();
1803             $r->id   = $this->id;
1804             $r->name = $options['name'];
1805             $DB->update_record('repository_instances', $r);
1806             unset($options['name']);
1807         }
1808         foreach ($options as $name=>$value) {
1809             if ($id = $DB->get_field('repository_instance_config', 'id', array('name'=>$name, 'instanceid'=>$this->id))) {
1810                 $DB->set_field('repository_instance_config', 'value', $value, array('id'=>$id));
1811             } else {
1812                 $config = new stdClass();
1813                 $config->instanceid = $this->id;
1814                 $config->name   = $name;
1815                 $config->value  = $value;
1816                 $DB->insert_record('repository_instance_config', $config);
1817             }
1818         }
1819         return true;
1820     }
1822     /**
1823      * Get settings for repository instance
1824      *
1825      * @param string $config
1826      * @return array Settings
1827      */
1828     public function get_option($config = '') {
1829         global $DB;
1830         $entries = $DB->get_records('repository_instance_config', array('instanceid'=>$this->id));
1831         $ret = array();
1832         if (empty($entries)) {
1833             return $ret;
1834         }
1835         foreach($entries as $entry) {
1836             $ret[$entry->name] = $entry->value;
1837         }
1838         if (!empty($config)) {
1839             if (isset($ret[$config])) {
1840                 return $ret[$config];
1841             } else {
1842                 return null;
1843             }
1844         } else {
1845             return $ret;
1846         }
1847     }
1849     /**
1850      * Filter file listing to display specific types
1851      *
1852      * @param array $value
1853      * @return bool
1854      */
1855     public function filter(&$value) {
1856         $accepted_types = optional_param_array('accepted_types', '', PARAM_RAW);
1857         if (isset($value['children'])) {
1858             if (!empty($value['children'])) {
1859                 $value['children'] = array_filter($value['children'], array($this, 'filter'));
1860             }
1861             return true; // always return directories
1862         } else {
1863             if ($accepted_types == '*' or empty($accepted_types)
1864                 or (is_array($accepted_types) and in_array('*', $accepted_types))) {
1865                 return true;
1866             } else {
1867                 foreach ($accepted_types as $ext) {
1868                     if (preg_match('#'.$ext.'$#i', $value['title'])) {
1869                         return true;
1870                     }
1871                 }
1872             }
1873         }
1874         return false;
1875     }
1877     /**
1878      * Given a path, and perhaps a search, get a list of files.
1879      *
1880      * See details on {@link http://docs.moodle.org/dev/Repository_plugins}
1881      *
1882      * @param string $path this parameter can a folder name, or a identification of folder
1883      * @param string $page the page number of file list
1884      * @return array the list of files, including meta infomation, containing the following keys
1885      *           manage, url to manage url
1886      *           client_id
1887      *           login, login form
1888      *           repo_id, active repository id
1889      *           login_btn_action, the login button action
1890      *           login_btn_label, the login button label
1891      *           total, number of results
1892      *           perpage, items per page
1893      *           page
1894      *           pages, total pages
1895      *           issearchresult, is it a search result?
1896      *           list, file list
1897      *           path, current path and parent path
1898      */
1899     public function get_listing($path = '', $page = '') {
1900     }
1902     /**
1903      * Prepares list of files before passing it to AJAX, makes sure data is in the correct
1904      * format and stores formatted values.
1905      *
1906      * @param array|stdClass $listing result of get_listing() or search() or file_get_drafarea_files()
1907      * @return array
1908      */
1909     public static function prepare_listing($listing) {
1910         global $OUTPUT;
1912         $defaultfoldericon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
1913         // prepare $listing['path'] or $listing->path
1914         if (is_array($listing) && isset($listing['path']) && is_array($listing['path'])) {
1915             $path = &$listing['path'];
1916         } else if (is_object($listing) && isset($listing->path) && is_array($listing->path)) {
1917             $path = &$listing->path;
1918         }
1919         if (isset($path)) {
1920             $len = count($path);
1921             for ($i=0; $i<$len; $i++) {
1922                 if (is_array($path[$i]) && !isset($path[$i]['icon'])) {
1923                     $path[$i]['icon'] = $defaultfoldericon;
1924                 } else if (is_object($path[$i]) && !isset($path[$i]->icon)) {
1925                     $path[$i]->icon = $defaultfoldericon;
1926                 }
1927             }
1928         }
1930         // prepare $listing['list'] or $listing->list
1931         if (is_array($listing) && isset($listing['list']) && is_array($listing['list'])) {
1932             $listing['list'] = array_values($listing['list']); // convert to array
1933             $files = &$listing['list'];
1934         } else if (is_object($listing) && isset($listing->list) && is_array($listing->list)) {
1935             $listing->list = array_values($listing->list); // convert to array
1936             $files = &$listing->list;
1937         } else {
1938             return $listing;
1939         }
1940         $len = count($files);
1941         for ($i=0; $i<$len; $i++) {
1942             if (is_object($files[$i])) {
1943                 $file = (array)$files[$i];
1944                 $converttoobject = true;
1945             } else {
1946                 $file = & $files[$i];
1947                 $converttoobject = false;
1948             }
1949             if (isset($file['size'])) {
1950                 $file['size'] = (int)$file['size'];
1951                 $file['size_f'] = display_size($file['size']);
1952             }
1953             if (isset($file['license']) &&
1954                     get_string_manager()->string_exists($file['license'], 'license')) {
1955                 $file['license_f'] = get_string($file['license'], 'license');
1956             }
1957             if (isset($file['image_width']) && isset($file['image_height'])) {
1958                 $a = array('width' => $file['image_width'], 'height' => $file['image_height']);
1959                 $file['dimensions'] = get_string('imagesize', 'repository', (object)$a);
1960             }
1961             foreach (array('date', 'datemodified', 'datecreated') as $key) {
1962                 if (!isset($file[$key]) && isset($file['date'])) {
1963                     $file[$key] = $file['date'];
1964                 }
1965                 if (isset($file[$key])) {
1966                     // must be UNIX timestamp
1967                     $file[$key] = (int)$file[$key];
1968                     if (!$file[$key]) {
1969                         unset($file[$key]);
1970                     } else {
1971                         $file[$key.'_f'] = userdate($file[$key], get_string('strftimedatetime', 'langconfig'));
1972                         $file[$key.'_f_s'] = userdate($file[$key], get_string('strftimedatetimeshort', 'langconfig'));
1973                     }
1974                 }
1975             }
1976             $isfolder = (array_key_exists('children', $file) || (isset($file['type']) && $file['type'] == 'folder'));
1977             $filename = null;
1978             if (isset($file['title'])) {
1979                 $filename = $file['title'];
1980             }
1981             else if (isset($file['fullname'])) {
1982                 $filename = $file['fullname'];
1983             }
1984             if (!isset($file['mimetype']) && !$isfolder && $filename) {
1985                 $file['mimetype'] = get_mimetype_description(array('filename' => $filename));
1986             }
1987             if (!isset($file['icon'])) {
1988                 if ($isfolder) {
1989                     $file['icon'] = $defaultfoldericon;
1990                 } else if ($filename) {
1991                     $file['icon'] = $OUTPUT->pix_url(file_extension_icon($filename, 24))->out(false);
1992                 }
1993             }
1994             if ($converttoobject) {
1995                 $files[$i] = (object)$file;
1996             }
1997         }
1998         return $listing;
1999     }
2001     /**
2002      * Search files in repository
2003      * When doing global search, $search_text will be used as
2004      * keyword.
2005      *
2006      * @param string $search_text search key word
2007      * @param int $page page
2008      * @return mixed {@see repository::get_listing}
2009      */
2010     public function search($search_text, $page = 0) {
2011         $list = array();
2012         $list['list'] = array();
2013         return false;
2014     }
2016     /**
2017      * Logout from repository instance
2018      * By default, this function will return a login form
2019      *
2020      * @return string
2021      */
2022     public function logout(){
2023         return $this->print_login();
2024     }
2026     /**
2027      * To check whether the user is logged in.
2028      *
2029      * @return bool
2030      */
2031     public function check_login(){
2032         return true;
2033     }
2036     /**
2037      * Show the login screen, if required
2038      *
2039      * @return string
2040      */
2041     public function print_login(){
2042         return $this->get_listing();
2043     }
2045     /**
2046      * Show the search screen, if required
2047      *
2048      * @return string
2049      */
2050     public function print_search() {
2051         global $PAGE;
2052         $renderer = $PAGE->get_renderer('core', 'files');
2053         return $renderer->repository_default_searchform();
2054     }
2056     /**
2057      * For oauth like external authentication, when external repository direct user back to moodle,
2058      * this funciton will be called to set up token and token_secret
2059      */
2060     public function callback() {
2061     }
2063     /**
2064      * is it possible to do glboal search?
2065      *
2066      * @return bool
2067      */
2068     public function global_search() {
2069         return false;
2070     }
2072     /**
2073      * Defines operations that happen occasionally on cron
2074      *
2075      * @return bool
2076      */
2077     public function cron() {
2078         return true;
2079     }
2081     /**
2082      * function which is run when the type is created (moodle administrator add the plugin)
2083      *
2084      * @return bool success or fail?
2085      */
2086     public static function plugin_init() {
2087         return true;
2088     }
2090     /**
2091      * Edit/Create Admin Settings Moodle form
2092      *
2093      * @param moodleform $mform Moodle form (passed by reference)
2094      * @param string $classname repository class name
2095      */
2096     public static function type_config_form($mform, $classname = 'repository') {
2097         $instnaceoptions = call_user_func(array($classname, 'get_instance_option_names'), $mform, $classname);
2098         if (empty($instnaceoptions)) {
2099             // this plugin has only one instance
2100             // so we need to give it a name
2101             // it can be empty, then moodle will look for instance name from language string
2102             $mform->addElement('text', 'pluginname', get_string('pluginname', 'repository'), array('size' => '40'));
2103             $mform->addElement('static', 'pluginnamehelp', '', get_string('pluginnamehelp', 'repository'));
2104             $mform->setType('pluginname', PARAM_TEXT);
2105         }
2106     }
2108     /**
2109      * Validate Admin Settings Moodle form
2110      *
2111      * @static
2112      * @param moodleform $mform Moodle form (passed by reference)
2113      * @param array $data array of ("fieldname"=>value) of submitted data
2114      * @param array $errors array of ("fieldname"=>errormessage) of errors
2115      * @return array array of errors
2116      */
2117     public static function type_form_validation($mform, $data, $errors) {
2118         return $errors;
2119     }
2122     /**
2123      * Edit/Create Instance Settings Moodle form
2124      *
2125      * @param moodleform $mform Moodle form (passed by reference)
2126      */
2127     public static function instance_config_form($mform) {
2128     }
2130     /**
2131      * Return names of the general options.
2132      * By default: no general option name
2133      *
2134      * @return array
2135      */
2136     public static function get_type_option_names() {
2137         return array('pluginname');
2138     }
2140     /**
2141      * Return names of the instance options.
2142      * By default: no instance option name
2143      *
2144      * @return array
2145      */
2146     public static function get_instance_option_names() {
2147         return array();
2148     }
2150     /**
2151      * Validate repository plugin instance form
2152      *
2153      * @param moodleform $mform moodle form
2154      * @param array $data form data
2155      * @param array $errors errors
2156      * @return array errors
2157      */
2158     public static function instance_form_validation($mform, $data, $errors) {
2159         return $errors;
2160     }
2162     /**
2163      * Create a shorten filename
2164      *
2165      * @param string $str filename
2166      * @param int $maxlength max file name length
2167      * @return string short filename
2168      */
2169     public function get_short_filename($str, $maxlength) {
2170         if (textlib::strlen($str) >= $maxlength) {
2171             return trim(textlib::substr($str, 0, $maxlength)).'...';
2172         } else {
2173             return $str;
2174         }
2175     }
2177     /**
2178      * Overwrite an existing file
2179      *
2180      * @param int $itemid
2181      * @param string $filepath
2182      * @param string $filename
2183      * @param string $newfilepath
2184      * @param string $newfilename
2185      * @return bool
2186      */
2187     public static function overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename) {
2188         global $USER;
2189         $fs = get_file_storage();
2190         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
2191         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $filepath, $filename)) {
2192             if ($tempfile = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $newfilepath, $newfilename)) {
2193                 // delete existing file to release filename
2194                 $file->delete();
2195                 // create new file
2196                 $newfile = $fs->create_file_from_storedfile(array('filepath'=>$filepath, 'filename'=>$filename), $tempfile);
2197                 // remove temp file
2198                 $tempfile->delete();
2199                 return true;
2200             }
2201         }
2202         return false;
2203     }
2205     /**
2206      * Delete a temp file from draft area
2207      *
2208      * @param int $draftitemid
2209      * @param string $filepath
2210      * @param string $filename
2211      * @return bool
2212      */
2213     public static function delete_tempfile_from_draft($draftitemid, $filepath, $filename) {
2214         global $USER;
2215         $fs = get_file_storage();
2216         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
2217         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $draftitemid, $filepath, $filename)) {
2218             $file->delete();
2219             return true;
2220         } else {
2221             return false;
2222         }
2223     }
2225     /**
2226      * Find all external files in this repo and import them
2227      */
2228     public function convert_references_to_local() {
2229         $fs = get_file_storage();
2230         $files = $fs->get_external_files($this->id);
2231         foreach ($files as $storedfile) {
2232             $fs->import_external_file($storedfile);
2233         }
2234     }
2236     /**
2237      * Called from phpunit between tests, resets whatever was cached
2238      */
2239     public static function reset_caches() {
2240         self::sync_external_file(null, true);
2241     }
2243     /**
2244      * Call to request proxy file sync with repository source.
2245      *
2246      * @param stored_file $file
2247      * @param bool $resetsynchistory whether to reset all history of sync (used by phpunit)
2248      * @return bool success
2249      */
2250     public static function sync_external_file($file, $resetsynchistory = false) {
2251         global $DB;
2252         // TODO MDL-25290 static should be replaced with MUC code.
2253         static $synchronized = array();
2254         if ($resetsynchistory) {
2255             $synchronized = array();
2256         }
2258         $fs = get_file_storage();
2260         if (!$file || !$file->get_referencefileid()) {
2261             return false;
2262         }
2263         if (array_key_exists($file->get_id(), $synchronized)) {
2264             return $synchronized[$file->get_id()];
2265         }
2267         // remember that we already cached in current request to prevent from querying again
2268         $synchronized[$file->get_id()] = false;
2270         if (!$reference = $DB->get_record('files_reference', array('id'=>$file->get_referencefileid()))) {
2271             return false;
2272         }
2274         if (!empty($reference->lastsync) and ($reference->lastsync + $reference->lifetime > time())) {
2275             $synchronized[$file->get_id()] = true;
2276             return true;
2277         }
2279         if (!$repository = self::get_repository_by_id($reference->repositoryid, SYSCONTEXTID)) {
2280             return false;
2281         }
2283         if (!$repository->sync_individual_file($file)) {
2284             return false;
2285         }
2287         $fileinfo = $repository->get_file_by_reference($reference);
2288         if ($fileinfo === null) {
2289             // does not exist any more - set status to missing
2290             $file->set_missingsource();
2291             //TODO: purge content from pool if we set some other content hash and it is no used any more
2292             $synchronized[$file->get_id()] = true;
2293             return true;
2294         }
2296         $contenthash = null;
2297         $filesize = null;
2298         if (!empty($fileinfo->contenthash)) {
2299             // contenthash returned, file already in moodle
2300             $contenthash = $fileinfo->contenthash;
2301             $filesize = $fileinfo->filesize;
2302         } else if (!empty($fileinfo->filepath)) {
2303             // File path returned
2304             list($contenthash, $filesize, $newfile) = $fs->add_file_to_pool($fileinfo->filepath);
2305         } else if (!empty($fileinfo->handle) && is_resource($fileinfo->handle)) {
2306             // File handle returned
2307             $contents = '';
2308             while (!feof($fileinfo->handle)) {
2309                 $contents .= fread($handle, 8192);
2310             }
2311             fclose($fileinfo->handle);
2312             list($contenthash, $filesize, $newfile) = $fs->add_string_to_pool($content);
2313         } else if (isset($fileinfo->content)) {
2314             // File content returned
2315             list($contenthash, $filesize, $newfile) = $fs->add_string_to_pool($fileinfo->content);
2316         }
2318         if (!isset($contenthash) or !isset($filesize)) {
2319             return false;
2320         }
2322         // update files table
2323         $file->set_synchronized($contenthash, $filesize);
2324         $synchronized[$file->get_id()] = true;
2325         return true;
2326     }
2328     /**
2329      * Build draft file's source field
2330      *
2331      * {@link file_restore_source_field_from_draft_file()}
2332      * XXX: This is a hack for file manager (MDL-28666)
2333      * For newly created  draft files we have to construct
2334      * source filed in php serialized data format.
2335      * File manager needs to know the original file information before copying
2336      * to draft area, so we append these information in mdl_files.source field
2337      *
2338      * @param string $source
2339      * @return string serialised source field
2340      */
2341     public static function build_source_field($source) {
2342         $sourcefield = new stdClass;
2343         $sourcefield->source = $source;
2344         return serialize($sourcefield);
2345     }
2348 /**
2349  * Exception class for repository api
2350  *
2351  * @since 2.0
2352  * @package   repository
2353  * @category  repository
2354  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2355  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2356  */
2357 class repository_exception extends moodle_exception {
2360 /**
2361  * This is a class used to define a repository instance form
2362  *
2363  * @since 2.0
2364  * @package   repository
2365  * @category  repository
2366  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2367  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2368  */
2369 final class repository_instance_form extends moodleform {
2370     /** @var stdClass repository instance */
2371     protected $instance;
2372     /** @var string repository plugin type */
2373     protected $plugin;
2375     /**
2376      * Added defaults to moodle form
2377      */
2378     protected function add_defaults() {
2379         $mform =& $this->_form;
2380         $strrequired = get_string('required');
2382         $mform->addElement('hidden', 'edit',  ($this->instance) ? $this->instance->id : 0);
2383         $mform->setType('edit', PARAM_INT);
2384         $mform->addElement('hidden', 'new',   $this->plugin);
2385         $mform->setType('new', PARAM_FORMAT);
2386         $mform->addElement('hidden', 'plugin', $this->plugin);
2387         $mform->setType('plugin', PARAM_PLUGIN);
2388         $mform->addElement('hidden', 'typeid', $this->typeid);
2389         $mform->setType('typeid', PARAM_INT);
2390         $mform->addElement('hidden', 'contextid', $this->contextid);
2391         $mform->setType('contextid', PARAM_INT);
2393         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
2394         $mform->addRule('name', $strrequired, 'required', null, 'client');
2395         $mform->setType('name', PARAM_TEXT);
2396     }
2398     /**
2399      * Define moodle form elements
2400      */
2401     public function definition() {
2402         global $CFG;
2403         // type of plugin, string
2404         $this->plugin = $this->_customdata['plugin'];
2405         $this->typeid = $this->_customdata['typeid'];
2406         $this->contextid = $this->_customdata['contextid'];
2407         $this->instance = (isset($this->_customdata['instance'])
2408                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2409             ? $this->_customdata['instance'] : null;
2411         $mform =& $this->_form;
2413         $this->add_defaults();
2415         // Add instance config options.
2416         $result = repository::static_function($this->plugin, 'instance_config_form', $mform);
2417         if ($result === false) {
2418             // Remove the name element if no other config options.
2419             $mform->removeElement('name');
2420         }
2421         if ($this->instance) {
2422             $data = array();
2423             $data['name'] = $this->instance->name;
2424             if (!$this->instance->readonly) {
2425                 // and set the data if we have some.
2426                 foreach ($this->instance->get_instance_option_names() as $config) {
2427                     if (!empty($this->instance->options[$config])) {
2428                         $data[$config] = $this->instance->options[$config];
2429                      } else {
2430                         $data[$config] = '';
2431                      }
2432                 }
2433             }
2434             $this->set_data($data);
2435         }
2437         if ($result === false) {
2438             $mform->addElement('cancel');
2439         } else {
2440             $this->add_action_buttons(true, get_string('save','repository'));
2441         }
2442     }
2444     /**
2445      * Validate moodle form data
2446      *
2447      * @param array $data form data
2448      * @param array $files files in form
2449      * @return array errors
2450      */
2451     public function validation($data, $files) {
2452         global $DB;
2453         $errors = array();
2454         $plugin = $this->_customdata['plugin'];
2455         $instance = (isset($this->_customdata['instance'])
2456                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2457             ? $this->_customdata['instance'] : null;
2458         if (!$instance) {
2459             $errors = repository::static_function($plugin, 'instance_form_validation', $this, $data, $errors);
2460         } else {
2461             $errors = $instance->instance_form_validation($this, $data, $errors);
2462         }
2464         $sql = "SELECT count('x')
2465                   FROM {repository_instances} i, {repository} r
2466                  WHERE r.type=:plugin AND r.id=i.typeid AND i.name=:name";
2467         if ($DB->count_records_sql($sql, array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
2468             $errors['name'] = get_string('erroruniquename', 'repository');
2469         }
2471         return $errors;
2472     }
2475 /**
2476  * This is a class used to define a repository type setting form
2477  *
2478  * @since 2.0
2479  * @package   repository
2480  * @category  repository
2481  * @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
2482  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2483  */
2484 final class repository_type_form extends moodleform {
2485     /** @var stdClass repository instance */
2486     protected $instance;
2487     /** @var string repository plugin name */
2488     protected $plugin;
2489     /** @var string action */
2490     protected $action;
2492     /**
2493      * Definition of the moodleform
2494      */
2495     public function definition() {
2496         global $CFG;
2497         // type of plugin, string
2498         $this->plugin = $this->_customdata['plugin'];
2499         $this->instance = (isset($this->_customdata['instance'])
2500                 && is_a($this->_customdata['instance'], 'repository_type'))
2501             ? $this->_customdata['instance'] : null;
2503         $this->action = $this->_customdata['action'];
2504         $this->pluginname = $this->_customdata['pluginname'];
2505         $mform =& $this->_form;
2506         $strrequired = get_string('required');
2508         $mform->addElement('hidden', 'action', $this->action);
2509         $mform->setType('action', PARAM_TEXT);
2510         $mform->addElement('hidden', 'repos', $this->plugin);
2511         $mform->setType('repos', PARAM_PLUGIN);
2513         // let the plugin add its specific fields
2514         $classname = 'repository_' . $this->plugin;
2515         require_once($CFG->dirroot . '/repository/' . $this->plugin . '/lib.php');
2516         //add "enable course/user instances" checkboxes if multiple instances are allowed
2517         $instanceoptionnames = repository::static_function($this->plugin, 'get_instance_option_names');
2519         $result = call_user_func(array($classname, 'type_config_form'), $mform, $classname);
2521         if (!empty($instanceoptionnames)) {
2522             $sm = get_string_manager();
2523             $component = 'repository';
2524             if ($sm->string_exists('enablecourseinstances', 'repository_' . $this->plugin)) {
2525                 $component .= ('_' . $this->plugin);
2526             }
2527             $mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', $component));
2529             $component = 'repository';
2530             if ($sm->string_exists('enableuserinstances', 'repository_' . $this->plugin)) {
2531                 $component .= ('_' . $this->plugin);
2532             }
2533             $mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', $component));
2534         }
2536         // set the data if we have some.
2537         if ($this->instance) {
2538             $data = array();
2539             $option_names = call_user_func(array($classname,'get_type_option_names'));
2540             if (!empty($instanceoptionnames)){
2541                 $option_names[] = 'enablecourseinstances';
2542                 $option_names[] = 'enableuserinstances';
2543             }
2545             $instanceoptions = $this->instance->get_options();
2546             foreach ($option_names as $config) {
2547                 if (!empty($instanceoptions[$config])) {
2548                     $data[$config] = $instanceoptions[$config];
2549                 } else {
2550                     $data[$config] = '';
2551                 }
2552             }
2553             // XXX: set plugin name for plugins which doesn't have muliti instances
2554             if (empty($instanceoptionnames)){
2555                 $data['pluginname'] = $this->pluginname;
2556             }
2557             $this->set_data($data);
2558         }
2560         $this->add_action_buttons(true, get_string('save','repository'));
2561     }
2563     /**
2564      * Validate moodle form data
2565      *
2566      * @param array $data moodle form data
2567      * @param array $files
2568      * @return array errors
2569      */
2570     public function validation($data, $files) {
2571         $errors = array();
2572         $plugin = $this->_customdata['plugin'];
2573         $instance = (isset($this->_customdata['instance'])
2574                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2575             ? $this->_customdata['instance'] : null;
2576         if (!$instance) {
2577             $errors = repository::static_function($plugin, 'type_form_validation', $this, $data, $errors);
2578         } else {
2579             $errors = $instance->type_form_validation($this, $data, $errors);
2580         }
2582         return $errors;
2583     }
2586 /**
2587  * Generate all options needed by filepicker
2588  *
2589  * @param array $args including following keys
2590  *          context
2591  *          accepted_types
2592  *          return_types
2593  *
2594  * @return array the list of repository instances, including meta infomation, containing the following keys
2595  *          externallink
2596  *          repositories
2597  *          accepted_types
2598  */
2599 function initialise_filepicker($args) {
2600     global $CFG, $USER, $PAGE, $OUTPUT;
2601     static $templatesinitialized;
2602     require_once($CFG->libdir . '/licenselib.php');
2604     $return = new stdClass();
2605     $licenses = array();
2606     if (!empty($CFG->licenses)) {
2607         $array = explode(',', $CFG->licenses);
2608         foreach ($array as $license) {
2609             $l = new stdClass();
2610             $l->shortname = $license;
2611             $l->fullname = get_string($license, 'license');
2612             $licenses[] = $l;
2613         }
2614     }
2615     if (!empty($CFG->sitedefaultlicense)) {
2616         $return->defaultlicense = $CFG->sitedefaultlicense;
2617     }
2619     $return->licenses = $licenses;
2621     $return->author = fullname($USER);
2623     if (empty($args->context)) {
2624         $context = $PAGE->context;
2625     } else {
2626         $context = $args->context;
2627     }
2628     $disable_types = array();
2629     if (!empty($args->disable_types)) {
2630         $disable_types = $args->disable_types;
2631     }
2633     $user_context = get_context_instance(CONTEXT_USER, $USER->id);
2635     list($context, $course, $cm) = get_context_info_array($context->id);
2636     $contexts = array($user_context, get_system_context());
2637     if (!empty($course)) {
2638         // adding course context
2639         $contexts[] = get_context_instance(CONTEXT_COURSE, $course->id);
2640     }
2641     $externallink = (int)get_config(null, 'repositoryallowexternallinks');
2642     $repositories = repository::get_instances(array(
2643         'context'=>$contexts,
2644         'currentcontext'=> $context,
2645         'accepted_types'=>$args->accepted_types,
2646         'return_types'=>$args->return_types,
2647         'disable_types'=>$disable_types
2648     ));
2650     $return->repositories = array();
2652     if (empty($externallink)) {
2653         $return->externallink = false;
2654     } else {
2655         $return->externallink = true;
2656     }
2658     $return->userprefs = array();
2659     $return->userprefs['recentrepository'] = get_user_preferences('filepicker_recentrepository', '');
2660     $return->userprefs['recentlicense'] = get_user_preferences('filepicker_recentlicense', '');
2661     $return->userprefs['recentviewmode'] = get_user_preferences('filepicker_recentviewmode', '');
2663     user_preference_allow_ajax_update('filepicker_recentrepository', PARAM_INT);
2664     user_preference_allow_ajax_update('filepicker_recentlicense', PARAM_SAFEDIR);
2665     user_preference_allow_ajax_update('filepicker_recentviewmode', PARAM_INT);
2668     // provided by form element
2669     $return->accepted_types = file_get_typegroup('extension', $args->accepted_types);
2670     $return->return_types = $args->return_types;
2671     foreach ($repositories as $repository) {
2672         $meta = $repository->get_meta();
2673         // Please note that the array keys for repositories are used within
2674         // JavaScript a lot, the key NEEDS to be the repository id.
2675         $return->repositories[$repository->id] = $meta;
2676     }
2677     if (!$templatesinitialized) {
2678         // we need to send filepicker templates to the browser just once
2679         $fprenderer = $PAGE->get_renderer('core', 'files');
2680         $templates = $fprenderer->filepicker_js_templates();
2681         $PAGE->requires->js_init_call('M.core_filepicker.set_templates', array($templates), true);
2682         $templatesinitialized = true;
2683     }
2684     return $return;
2686 /**
2687  * Small function to walk an array to attach repository ID
2688  *
2689  * @param array $value
2690  * @param string $key
2691  * @param int $id
2692  */
2693 function repository_attach_id(&$value, $key, $id){
2694     $value['repo_id'] = $id;