Merge branch 'MDL-31448_incorrect-comment' of https://github.com/ncsu-delta/moodle
[moodle.git] / repository / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * This file contains classes used to manage the repository plugins in Moodle
21  * and was introduced as part of the changes occuring in Moodle 2.0
22  *
23  * @since 2.0
24  * @package    core
25  * @subpackage repository
26  * @copyright  2009 Dongsheng Cai <dongsheng@moodle.com>
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 require_once(dirname(dirname(__FILE__)) . '/config.php');
31 require_once($CFG->libdir . '/filelib.php');
32 require_once($CFG->libdir . '/formslib.php');
34 define('FILE_EXTERNAL', 1);
35 define('FILE_INTERNAL', 2);
36 define('RENAME_SUFFIX', '_2');
38 /**
39  * This class is used to manage repository plugins
40  *
41  * A repository_type is a repository plug-in. It can be Box.net, Flick-r, ...
42  * A repository type can be edited, sorted and hidden. It is mandatory for an
43  * administrator to create a repository type in order to be able to create
44  * some instances of this type.
45  * Coding note:
46  * - a repository_type object is mapped to the "repository" database table
47  * - "typename" attibut maps the "type" database field. It is unique.
48  * - general "options" for a repository type are saved in the config_plugin table
49  * - when you delete a repository, all instances are deleted, and general
50  *   options are also deleted from database
51  * - When you create a type for a plugin that can't have multiple instances, a
52  *   instance is automatically created.
53  *
54  * @package moodlecore
55  * @subpackage repository
56  * @copyright 2009 Jerome Mouneyrac
57  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
58  */
59 class repository_type {
62     /**
63      * Type name (no whitespace) - A type name is unique
64      * Note: for a user-friendly type name see get_readablename()
65      * @var String
66      */
67     private $_typename;
70     /**
71      * Options of this type
72      * They are general options that any instance of this type would share
73      * e.g. API key
74      * These options are saved in config_plugin table
75      * @var array
76      */
77     private $_options;
80     /**
81      * Is the repository type visible or hidden
82      * If false (hidden): no instances can be created, edited, deleted, showned , used...
83      * @var boolean
84      */
85     private $_visible;
88     /**
89      * 0 => not ordered, 1 => first position, 2 => second position...
90      * A not order type would appear in first position (should never happened)
91      * @var integer
92      */
93     private $_sortorder;
95      /**
96      * Return if the instance is visible in a context
97      * TODO: check if the context visibility has been overwritten by the plugin creator
98      *       (need to create special functions to be overvwritten in repository class)
99      * @param objet $context - context
100      * @return boolean
101      */
102     public function get_contextvisibility($context) {
103         global $USER;
105         if ($context->contextlevel == CONTEXT_COURSE) {
106             return $this->_options['enablecourseinstances'];
107         }
109         if ($context->contextlevel == CONTEXT_USER) {
110             return $this->_options['enableuserinstances'];
111         }
113         //the context is SITE
114         return true;
115     }
119     /**
120      * repository_type constructor
121      * @global object $CFG
122      * @param integer $typename
123      * @param array $typeoptions
124      * @param boolean $visible
125      * @param integer $sortorder (don't really need set, it will be during create() call)
126      */
127     public function __construct($typename = '', $typeoptions = array(), $visible = true, $sortorder = 0) {
128         global $CFG;
130         //set type attributs
131         $this->_typename = $typename;
132         $this->_visible = $visible;
133         $this->_sortorder = $sortorder;
135         //set options attribut
136         $this->_options = array();
137         $options = repository::static_function($typename, 'get_type_option_names');
138         //check that the type can be setup
139         if (!empty($options)) {
140             //set the type options
141             foreach ($options as $config) {
142                 if (array_key_exists($config, $typeoptions)) {
143                     $this->_options[$config] = $typeoptions[$config];
144                 }
145             }
146         }
148         //retrieve visibility from option
149         if (array_key_exists('enablecourseinstances',$typeoptions)) {
150             $this->_options['enablecourseinstances'] = $typeoptions['enablecourseinstances'];
151         } else {
152              $this->_options['enablecourseinstances'] = 0;
153         }
155         if (array_key_exists('enableuserinstances',$typeoptions)) {
156             $this->_options['enableuserinstances'] = $typeoptions['enableuserinstances'];
157         } else {
158              $this->_options['enableuserinstances'] = 0;
159         }
161     }
163     /**
164      * Get the type name (no whitespace)
165      * For a human readable name, use get_readablename()
166      * @return String the type name
167      */
168     public function get_typename() {
169         return $this->_typename;
170     }
172     /**
173      * Return a human readable and user-friendly type name
174      * @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      * @return array the general options
183      */
184     public function get_options() {
185         return $this->_options;
186     }
188     /**
189      * Return visibility
190      * @return boolean
191      */
192     public function get_visible() {
193         return $this->_visible;
194     }
196     /**
197      * Return order / position of display in the file picker
198      * @return integer
199      */
200     public function get_sortorder() {
201         return $this->_sortorder;
202     }
204     /**
205      * Create a repository type (the type name must not already exist)
206      * @param boolean throw exception?
207      * @return mixed return int if create successfully, return false if
208      *         any errors
209      * @global object $DB
210      */
211     public function create($silent = false) {
212         global $DB;
214         //check that $type has been set
215         $timmedtype = trim($this->_typename);
216         if (empty($timmedtype)) {
217             throw new repository_exception('emptytype', 'repository');
218         }
220         //set sortorder as the last position in the list
221         if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
222             $sql = "SELECT MAX(sortorder) FROM {repository}";
223             $this->_sortorder = 1 + $DB->get_field_sql($sql);
224         }
226         //only create a new type if it doesn't already exist
227         $existingtype = $DB->get_record('repository', array('type'=>$this->_typename));
228         if (!$existingtype) {
229             //create the type
230             $newtype = new stdClass();
231             $newtype->type = $this->_typename;
232             $newtype->visible = $this->_visible;
233             $newtype->sortorder = $this->_sortorder;
234             $plugin_id = $DB->insert_record('repository', $newtype);
235             //save the options in DB
236             $this->update_options();
238             $instanceoptionnames = repository::static_function($this->_typename, 'get_instance_option_names');
240             //if the plugin type has no multiple instance (e.g. has no instance option name) so it wont
241             //be possible for the administrator to create a instance
242             //in this case we need to create an instance
243             if (empty($instanceoptionnames)) {
244                 $instanceoptions = array();
245                 if (empty($this->_options['pluginname'])) {
246                     // when moodle trying to install some repo plugin automatically
247                     // this option will be empty, get it from language string when display
248                     $instanceoptions['name'] = '';
249                 } else {
250                     // when admin trying to add a plugin manually, he will type a name
251                     // for it
252                     $instanceoptions['name'] = $this->_options['pluginname'];
253                 }
254                 repository::static_function($this->_typename, 'create', $this->_typename, 0, get_system_context(), $instanceoptions);
255             }
256             //run plugin_init function
257             if (!repository::static_function($this->_typename, 'plugin_init')) {
258                 if (!$silent) {
259                     throw new repository_exception('cannotinitplugin', 'repository');
260                 }
261             }
263             if(!empty($plugin_id)) {
264                 // return plugin_id if create successfully
265                 return $plugin_id;
266             } else {
267                 return false;
268             }
270         } else {
271             if (!$silent) {
272                 throw new repository_exception('existingrepository', 'repository');
273             }
274             // If plugin existed, return false, tell caller no new plugins were created.
275             return false;
276         }
277     }
280     /**
281      * Update plugin options into the config_plugin table
282      * @param array $options
283      * @return boolean
284      */
285     public function update_options($options = null) {
286         global $DB;
287         $classname = 'repository_' . $this->_typename;
288         $instanceoptions = repository::static_function($this->_typename, 'get_instance_option_names');
289         if (empty($instanceoptions)) {
290             // update repository instance name if this plugin type doesn't have muliti instances
291             $params = array();
292             $params['type'] = $this->_typename;
293             $instances = repository::get_instances($params);
294             $instance = array_pop($instances);
295             if ($instance) {
296                 $DB->set_field('repository_instances', 'name', $options['pluginname'], array('id'=>$instance->id));
297             }
298             unset($options['pluginname']);
299         }
301         if (!empty($options)) {
302             $this->_options = $options;
303         }
305         foreach ($this->_options as $name => $value) {
306             set_config($name, $value, $this->_typename);
307         }
309         return true;
310     }
312     /**
313      * Update visible database field with the value given as parameter
314      * or with the visible value of this object
315      * This function is private.
316      * For public access, have a look to switch_and_update_visibility()
317      * @global object $DB
318      * @param boolean $visible
319      * @return boolean
320      */
321     private function update_visible($visible = null) {
322         global $DB;
324         if (!empty($visible)) {
325             $this->_visible = $visible;
326         }
327         else if (!isset($this->_visible)) {
328             throw new repository_exception('updateemptyvisible', 'repository');
329         }
331         return $DB->set_field('repository', 'visible', $this->_visible, array('type'=>$this->_typename));
332     }
334     /**
335      * Update database sortorder field with the value given as parameter
336      * or with the sortorder value of this object
337      * This function is private.
338      * For public access, have a look to move_order()
339      * @global object $DB
340      * @param integer $sortorder
341      * @return boolean
342      */
343     private function update_sortorder($sortorder = null) {
344         global $DB;
346         if (!empty($sortorder) && $sortorder!=0) {
347             $this->_sortorder = $sortorder;
348         }
349         //if sortorder is not set, we set it as the ;ast position in the list
350         else if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
351             $sql = "SELECT MAX(sortorder) FROM {repository}";
352             $this->_sortorder = 1 + $DB->get_field_sql($sql);
353         }
355         return $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$this->_typename));
356     }
358     /**
359      * Change order of the type with its adjacent upper or downer type
360      * (database fields are updated)
361      * Algorithm details:
362      * 1. retrieve all types in an array. This array is sorted by sortorder,
363      * and the array keys start from 0 to X (incremented by 1)
364      * 2. switch sortorder values of this type and its adjacent type
365      * @global object $DB
366      * @param string $move "up" or "down"
367      */
368     public function move_order($move) {
369         global $DB;
371         $types = repository::get_types();    // retrieve all types
373     /// retrieve this type into the returned array
374         $i = 0;
375         while (!isset($indice) && $i<count($types)) {
376             if ($types[$i]->get_typename() == $this->_typename) {
377                 $indice = $i;
378             }
379             $i++;
380         }
382     /// retrieve adjacent indice
383         switch ($move) {
384             case "up":
385                 $adjacentindice = $indice - 1;
386             break;
387             case "down":
388                 $adjacentindice = $indice + 1;
389             break;
390             default:
391             throw new repository_exception('movenotdefined', 'repository');
392         }
394         //switch sortorder of this type and the adjacent type
395         //TODO: we could reset sortorder for all types. This is not as good in performance term, but
396         //that prevent from wrong behaviour on a screwed database. As performance are not important in this particular case
397         //it worth to change the algo.
398         if ($adjacentindice>=0 && !empty($types[$adjacentindice])) {
399             $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$types[$adjacentindice]->get_typename()));
400             $this->update_sortorder($types[$adjacentindice]->get_sortorder());
401         }
402     }
404     /**
405      * 1. Change visibility to the value chosen
406      *
407      * 2. Update the type
408      * @return boolean
409      */
410     public function update_visibility($visible = null) {
411         if (is_bool($visible)) {
412             $this->_visible = $visible;
413         } else {
414             $this->_visible = !$this->_visible;
415         }
416         return $this->update_visible();
417     }
420     /**
421      * Delete a repository_type (general options are removed from config_plugin
422      * table, and all instances are deleted)
423      * @global object $DB
424      * @return boolean
425      */
426     public function delete() {
427         global $DB;
429         //delete all instances of this type
430         $params = array();
431         $params['context'] = array();
432         $params['onlyvisible'] = false;
433         $params['type'] = $this->_typename;
434         $instances = repository::get_instances($params);
435         foreach ($instances as $instance) {
436             $instance->delete();
437         }
439         //delete all general options
440         foreach ($this->_options as $name => $value) {
441             set_config($name, null, $this->_typename);
442         }
444         return $DB->delete_records('repository', array('type' => $this->_typename));
445     }
448 /**
449  * This is the base class of the repository class
450  *
451  * To use repository plugin, see:
452  * http://docs.moodle.org/dev/Repository_How_to_Create_Plugin
453  * class repository is an abstract class, some functions must be implemented in subclass.
454  * See an example: repository/boxnet/lib.php
455  *
456  * A few notes:
457  *   // for ajax file picker, this will print a json string to tell file picker
458  *   // how to build a login form
459  *   $repo->print_login();
460  *   // for ajax file picker, this will return a files list.
461  *   $repo->get_listing();
462  *   // this function will be used for non-javascript version.
463  *   $repo->print_listing();
464  *   // print a search box
465  *   $repo->print_search();
466  *
467  * @package moodlecore
468  * @subpackage repository
469  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
470  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
471  */
472 abstract class repository {
473     // $disabled can be set to true to disable a plugin by force
474     // example: self::$disabled = true
475     public $disabled = false;
476     public $id;
477     /** @var object current context */
478     public $context;
479     public $options;
480     public $readonly;
481     public $returntypes;
482     /** @var object repository instance database record */
483     public $instance;
484     /**
485      * 1. Initialize context and options
486      * 2. Accept necessary parameters
487      *
488      * @param integer $repositoryid repository instance id
489      * @param integer|object a context id or context object
490      * @param array $options repository options
491      */
492     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array(), $readonly = 0) {
493         global $DB;
494         $this->id = $repositoryid;
495         if (is_object($context)) {
496             $this->context = $context;
497         } else {
498             $this->context = get_context_instance_by_id($context);
499         }
500         $this->instance = $DB->get_record('repository_instances', array('id'=>$this->id));
501         $this->readonly = $readonly;
502         $this->options = array();
504         if (is_array($options)) {
505             $options = array_merge($this->get_option(), $options);
506         } else {
507             $options = $this->get_option();
508         }
509         foreach ($options as $n => $v) {
510             $this->options[$n] = $v;
511         }
512         $this->name = $this->get_name();
513         $this->returntypes = $this->supported_returntypes();
514         $this->super_called = true;
515     }
517     /**
518      * Get a repository type object by a given type name.
519      * @global object $DB
520      * @param string $typename the repository type name
521      * @return repository_type|bool
522      */
523     public static function get_type_by_typename($typename) {
524         global $DB;
526         if (!$record = $DB->get_record('repository',array('type' => $typename))) {
527             return false;
528         }
530         return new repository_type($typename, (array)get_config($typename), $record->visible, $record->sortorder);
531     }
533     /**
534      * Get the repository type by a given repository type id.
535      * @global object $DB
536      * @param int $id the type id
537      * @return object
538      */
539     public static function get_type_by_id($id) {
540         global $DB;
542         if (!$record = $DB->get_record('repository',array('id' => $id))) {
543             return false;
544         }
546         return new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
547     }
549     /**
550      * Return all repository types ordered by sortorder field
551      * first repository type in returnedarray[0], second repository type in returnedarray[1], ...
552      * @global object $DB
553      * @global object $CFG
554      * @param boolean $visible can return types by visiblity, return all types if null
555      * @return array Repository types
556      */
557     public static function get_types($visible=null) {
558         global $DB, $CFG;
560         $types = array();
561         $params = null;
562         if (!empty($visible)) {
563             $params = array('visible' => $visible);
564         }
565         if ($records = $DB->get_records('repository',$params,'sortorder')) {
566             foreach($records as $type) {
567                 if (file_exists($CFG->dirroot . '/repository/'. $type->type .'/lib.php')) {
568                     $types[] = new repository_type($type->type, (array)get_config($type->type), $type->visible, $type->sortorder);
569                 }
570             }
571         }
573         return $types;
574     }
576     /**
577      * To check if the context id is valid
578      * @global object $USER
579      * @param int $contextid
580      * @return boolean
581      */
582     public static function check_capability($contextid, $instance) {
583         $context = get_context_instance_by_id($contextid);
584         $capability = has_capability('repository/'.$instance->type.':view', $context);
585         if (!$capability) {
586             throw new repository_exception('nopermissiontoaccess', 'repository');
587         }
588     }
590     /**
591      * Check if file already exists in draft area
592      *
593      * @param int $itemid
594      * @param string $filepath
595      * @param string $filename
596      * @return boolean
597      */
598     public static function draftfile_exists($itemid, $filepath, $filename) {
599         global $USER;
600         $fs = get_file_storage();
601         $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
602         if ($fs->get_file($usercontext->id, 'user', 'draft', $itemid, $filepath, $filename)) {
603             return true;
604         } else {
605             return false;
606         }
607     }
609     /**
610      * Does this repository used to browse moodle files?
611      *
612      * @return boolean
613      */
614     public function has_moodle_files() {
615         return false;
616     }
617     /**
618      * This function is used to copy a moodle file to draft area
619      *
620      * @global object $USER
621      * @global object $DB
622      * @param string $encoded The metainfo of file, it is base64 encoded php serialized data
623      * @param string $draftitemid itemid
624      * @param string $new_filename The intended name of file
625      * @param string $new_filepath the new path in draft area
626      * @return array The information of file
627      */
628     public function copy_to_area($encoded, $draftitemid, $new_filepath, $new_filename) {
629         global $USER, $DB;
631         if ($this->has_moodle_files() == false) {
632             throw new coding_exception('Only repository used to browse moodle files can use copy_to_area');
633         }
635         $browser = get_file_browser();
636         $params = unserialize(base64_decode($encoded));
637         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
639         $contextid  = clean_param($params['contextid'], PARAM_INT);
640         $fileitemid = clean_param($params['itemid'],    PARAM_INT);
641         $filename   = clean_param($params['filename'],  PARAM_FILE);
642         $filepath   = clean_param($params['filepath'],  PARAM_PATH);;
643         $filearea   = clean_param($params['filearea'],  PARAM_AREA);
644         $component  = clean_param($params['component'], PARAM_COMPONENT);
646         $context    = get_context_instance_by_id($contextid);
647         // the file needs to copied to draft area
648         $file_info  = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
650         if (repository::draftfile_exists($draftitemid, $new_filepath, $new_filename)) {
651             // create new file
652             $unused_filename = repository::get_unused_filename($draftitemid, $new_filepath, $new_filename);
653             $file_info->copy_to_storage($user_context->id, 'user', 'draft', $draftitemid, $new_filepath, $unused_filename);
654             $event = array();
655             $event['event'] = 'fileexists';
656             $event['newfile'] = new stdClass;
657             $event['newfile']->filepath = $new_filepath;
658             $event['newfile']->filename = $unused_filename;
659             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $unused_filename)->out();
660             $event['existingfile'] = new stdClass;
661             $event['existingfile']->filepath = $new_filepath;
662             $event['existingfile']->filename = $new_filename;
663             $event['existingfile']->url      = moodle_url::make_draftfile_url($draftitemid, $filepath, $filename)->out();;
664             return $event;
665         } else {
666             $file_info->copy_to_storage($user_context->id, 'user', 'draft', $draftitemid, $new_filepath, $new_filename);
667             $info = array();
668             $info['itemid'] = $draftitemid;
669             $info['title']  = $new_filename;
670             $info['contextid'] = $user_context->id;
671             $info['url'] = moodle_url::make_draftfile_url($draftitemid, $new_filepath, $new_filename)->out();;
672             $info['filesize'] = $file_info->get_filesize();
673             return $info;
674         }
675     }
677     /**
678      * Get unused filename by appending suffix
679      *
680      * @param int $itemid
681      * @param string $filepath
682      * @param string $filename
683      * @return string
684      */
685     public static function get_unused_filename($itemid, $filepath, $filename) {
686         global $USER;
687         $fs = get_file_storage();
688         while (repository::draftfile_exists($itemid, $filepath, $filename)) {
689             $filename = repository::append_suffix($filename);
690         }
691         return $filename;
692     }
694     /**
695      * Append a suffix to filename
696      *
697      * @param string $filename
698      * @return string
699      */
700     function append_suffix($filename) {
701         $pathinfo = pathinfo($filename);
702         if (empty($pathinfo['extension'])) {
703             return $filename . RENAME_SUFFIX;
704         } else {
705             return $pathinfo['filename'] . RENAME_SUFFIX . '.' . $pathinfo['extension'];
706         }
707     }
709     /**
710      * Return all types that you a user can create/edit and which are also visible
711      * Note: Mostly used in order to know if at least one editable type can be set
712      * @param object $context the context for which we want the editable types
713      * @return array types
714      */
715     public static function get_editable_types($context = null) {
717         if (empty($context)) {
718             $context = get_system_context();
719         }
721         $types= repository::get_types(true);
722         $editabletypes = array();
723         foreach ($types as $type) {
724             $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
725             if (!empty($instanceoptionnames)) {
726                 if ($type->get_contextvisibility($context)) {
727                     $editabletypes[]=$type;
728                 }
729              }
730         }
731         return $editabletypes;
732     }
734     /**
735      * Return repository instances
736      * @global object $DB
737      * @global object $CFG
738      * @global object $USER
739      *
740      * @param array $args Array containing the following keys:
741      *           currentcontext
742      *           context
743      *           onlyvisible
744      *           type
745      *           accepted_types
746      *           return_types
747      *           userid
748      *
749      * @return array repository instances
750      */
751     public static function get_instances($args = array()) {
752         global $DB, $CFG, $USER;
754         if (isset($args['currentcontext'])) {
755             $current_context = $args['currentcontext'];
756         } else {
757             $current_context = null;
758         }
760         if (!empty($args['context'])) {
761             $contexts = $args['context'];
762         } else {
763             $contexts = array();
764         }
766         $onlyvisible = isset($args['onlyvisible']) ? $args['onlyvisible'] : true;
767         $returntypes = isset($args['return_types']) ? $args['return_types'] : 3;
768         $type        = isset($args['type']) ? $args['type'] : null;
770         $params = array();
771         $sql = "SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
772                   FROM {repository} r, {repository_instances} i
773                  WHERE i.typeid = r.id ";
775         if (!empty($args['disable_types']) && is_array($args['disable_types'])) {
776             list($types, $p) = $DB->get_in_or_equal($args['disable_types'], SQL_PARAMS_QM, 'param', false);
777             $sql .= " AND r.type $types";
778             $params = array_merge($params, $p);
779         }
781         if (!empty($args['userid']) && is_numeric($args['userid'])) {
782             $sql .= " AND (i.userid = 0 or i.userid = ?)";
783             $params[] = $args['userid'];
784         }
786         foreach ($contexts as $context) {
787             if (empty($firstcontext)) {
788                 $firstcontext = true;
789                 $sql .= " AND ((i.contextid = ?)";
790             } else {
791                 $sql .= " OR (i.contextid = ?)";
792             }
793             $params[] = $context->id;
794         }
796         if (!empty($firstcontext)) {
797            $sql .=')';
798         }
800         if ($onlyvisible == true) {
801             $sql .= " AND (r.visible = 1)";
802         }
804         if (isset($type)) {
805             $sql .= " AND (r.type = ?)";
806             $params[] = $type;
807         }
808         $sql .= " ORDER BY r.sortorder, i.name";
810         if (!$records = $DB->get_records_sql($sql, $params)) {
811             $records = array();
812         }
814         $repositories = array();
815         $ft = new filetype_parser();
816         if (isset($args['accepted_types'])) {
817             $accepted_types = $args['accepted_types'];
818         } else {
819             $accepted_types = '*';
820         }
821         foreach ($records as $record) {
822             if (!file_exists($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php')) {
823                 continue;
824             }
825             require_once($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php');
826             $options['visible'] = $record->visible;
827             $options['type']    = $record->repositorytype;
828             $options['typeid']  = $record->typeid;
829             // tell instance what file types will be accepted by file picker
830             $classname = 'repository_' . $record->repositorytype;
832             $repository = new $classname($record->id, $record->contextid, $options, $record->readonly);
834             $is_supported = true;
836             if (empty($repository->super_called)) {
837                 // to make sure the super construct is called
838                 debugging('parent::__construct must be called by '.$record->repositorytype.' plugin.');
839             } else {
840                 // check mimetypes
841                 if ($accepted_types !== '*' and $repository->supported_filetypes() !== '*') {
842                     $accepted_types = $ft->get_extensions($accepted_types);
843                     $supported_filetypes = $ft->get_extensions($repository->supported_filetypes());
845                     $is_supported = false;
846                     foreach  ($supported_filetypes as $type) {
847                         if (in_array($type, $accepted_types)) {
848                             $is_supported = true;
849                         }
850                     }
852                 }
853                 // check return values
854                 if ($returntypes !== 3 and $repository->supported_returntypes() !== 3) {
855                     $type = $repository->supported_returntypes();
856                     if ($type & $returntypes) {
857                         //
858                     } else {
859                         $is_supported = false;
860                     }
861                 }
863                 if (!$onlyvisible || ($repository->is_visible() && !$repository->disabled)) {
864                     // check capability in current context
865                     if (!empty($current_context)) {
866                         $capability = has_capability('repository/'.$record->repositorytype.':view', $current_context);
867                     } else {
868                         $capability = has_capability('repository/'.$record->repositorytype.':view', get_system_context());
869                     }
870                     if ($record->repositorytype == 'coursefiles') {
871                         // coursefiles plugin needs managefiles permission
872                         if (!empty($current_context)) {
873                             $capability = $capability && has_capability('moodle/course:managefiles', $current_context);
874                         } else {
875                             $capability = $capability && has_capability('moodle/course:managefiles', get_system_context());
876                         }
877                     }
878                     if ($is_supported && $capability) {
879                         $repositories[$repository->id] = $repository;
880                     }
881                 }
882             }
883         }
884         return $repositories;
885     }
887     /**
888      * Get single repository instance
889      * @global object $DB
890      * @global object $CFG
891      * @param integer $id repository id
892      * @return object repository instance
893      */
894     public static function get_instance($id) {
895         global $DB, $CFG;
896         $sql = "SELECT i.*, r.type AS repositorytype, r.visible
897                   FROM {repository} r
898                   JOIN {repository_instances} i ON i.typeid = r.id
899                  WHERE i.id = ?";
901         if (!$instance = $DB->get_record_sql($sql, array($id))) {
902             return false;
903         }
904         require_once($CFG->dirroot . '/repository/'. $instance->repositorytype.'/lib.php');
905         $classname = 'repository_' . $instance->repositorytype;
906         $options['typeid'] = $instance->typeid;
907         $options['type']   = $instance->repositorytype;
908         $options['name']   = $instance->name;
909         $obj = new $classname($instance->id, $instance->contextid, $options, $instance->readonly);
910         if (empty($obj->super_called)) {
911             debugging('parent::__construct must be called by '.$classname.' plugin.');
912         }
913         return $obj;
914     }
916     /**
917      * Call a static function. Any additional arguments than plugin and function will be passed through.
918      * @global object $CFG
919      * @param string $plugin
920      * @param string $function
921      * @return mixed
922      */
923     public static function static_function($plugin, $function) {
924         global $CFG;
926         //check that the plugin exists
927         $typedirectory = $CFG->dirroot . '/repository/'. $plugin . '/lib.php';
928         if (!file_exists($typedirectory)) {
929             //throw new repository_exception('invalidplugin', 'repository');
930             return false;
931         }
933         $pname = null;
934         if (is_object($plugin) || is_array($plugin)) {
935             $plugin = (object)$plugin;
936             $pname = $plugin->name;
937         } else {
938             $pname = $plugin;
939         }
941         $args = func_get_args();
942         if (count($args) <= 2) {
943             $args = array();
944         } else {
945             array_shift($args);
946             array_shift($args);
947         }
949         require_once($typedirectory);
950         return call_user_func_array(array('repository_' . $plugin, $function), $args);
951     }
953     /**
954      * Scan file, throws exception in case of infected file.
955      *
956      * Please note that the scanning engine must be able to access the file,
957      * permissions of the file are not modified here!
958      *
959      * @static
960      * @param string $thefile
961      * @param string $filename name of the file
962      * @param bool $deleteinfected
963      * @return void
964      */
965     public static function antivir_scan_file($thefile, $filename, $deleteinfected) {
966         global $CFG;
968         if (!is_readable($thefile)) {
969             // this should not happen
970             return;
971         }
973         if (empty($CFG->runclamonupload) or empty($CFG->pathtoclam)) {
974             // clam not enabled
975             return;
976         }
978         $CFG->pathtoclam = trim($CFG->pathtoclam);
980         if (!file_exists($CFG->pathtoclam) or !is_executable($CFG->pathtoclam)) {
981             // misconfigured clam - use the old notification for now
982             require("$CFG->libdir/uploadlib.php");
983             $notice = get_string('clamlost', 'moodle', $CFG->pathtoclam);
984             clam_message_admins($notice);
985             return;
986         }
988         // do NOT mess with permissions here, the calling party is responsible for making
989         // sure the scanner engine can access the files!
991         // execute test
992         $cmd = escapeshellcmd($CFG->pathtoclam).' --stdout '.escapeshellarg($thefile);
993         exec($cmd, $output, $return);
995         if ($return == 0) {
996             // perfect, no problem found
997             return;
999         } else if ($return == 1) {
1000             // infection found
1001             if ($deleteinfected) {
1002                 unlink($thefile);
1003             }
1004             throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1006         } else {
1007             //unknown problem
1008             require("$CFG->libdir/uploadlib.php");
1009             $notice = get_string('clamfailed', 'moodle', get_clam_error_code($return));
1010             $notice .= "\n\n". implode("\n", $output);
1011             clam_message_admins($notice);
1012             if ($CFG->clamfailureonupload === 'actlikevirus') {
1013                 if ($deleteinfected) {
1014                     unlink($thefile);
1015                 }
1016                 throw new moodle_exception('virusfounduser', 'moodle', '', array('filename'=>$filename));
1017             } else {
1018                 return;
1019             }
1020         }
1021     }
1023     /**
1024      * Move file from download folder to file pool using FILE API
1025      * @global object $DB
1026      * @global object $CFG
1027      * @global object $USER
1028      * @global object $OUTPUT
1029      * @param string $thefile file path in download folder
1030      * @param object $record
1031      * @return array containing the following keys:
1032      *           icon
1033      *           file
1034      *           id
1035      *           url
1036      */
1037     public static function move_to_filepool($thefile, $record) {
1038         global $DB, $CFG, $USER, $OUTPUT;
1040         // scan for viruses if possible, throws exception if problem found
1041         self::antivir_scan_file($thefile, $record->filename, empty($CFG->repository_no_delete)); //TODO: MDL-28637 this repository_no_delete is a bloody hack!
1043         if ($record->filepath !== '/') {
1044             $record->filepath = trim($record->filepath, '/');
1045             $record->filepath = '/'.$record->filepath.'/';
1046         }
1047         $context = get_context_instance(CONTEXT_USER, $USER->id);
1048         $now = time();
1050         $record->contextid = $context->id;
1051         $record->component = 'user';
1052         $record->filearea  = 'draft';
1053         $record->timecreated  = $now;
1054         $record->timemodified = $now;
1055         $record->userid       = $USER->id;
1056         $record->mimetype     = mimeinfo('type', $thefile);
1057         if(!is_numeric($record->itemid)) {
1058             $record->itemid = 0;
1059         }
1060         $fs = get_file_storage();
1061         if ($existingfile = $fs->get_file($context->id, $record->component, $record->filearea, $record->itemid, $record->filepath, $record->filename)) {
1062             $draftitemid = $record->itemid;
1063             $new_filename = repository::get_unused_filename($draftitemid, $record->filepath, $record->filename);
1064             $old_filename = $record->filename;
1065             // create a tmp file
1066             $record->filename = $new_filename;
1067             $newfile = $fs->create_file_from_pathname($record, $thefile);
1068             $event = array();
1069             $event['event'] = 'fileexists';
1070             $event['newfile'] = new stdClass;
1071             $event['newfile']->filepath = $record->filepath;
1072             $event['newfile']->filename = $new_filename;
1073             $event['newfile']->url = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $new_filename)->out();
1075             $event['existingfile'] = new stdClass;
1076             $event['existingfile']->filepath = $record->filepath;
1077             $event['existingfile']->filename = $old_filename;
1078             $event['existingfile']->url      = moodle_url::make_draftfile_url($draftitemid, $record->filepath, $old_filename)->out();;
1079             return $event;
1080         }
1081         if ($file = $fs->create_file_from_pathname($record, $thefile)) {
1082             if (empty($CFG->repository_no_delete)) {
1083                 $delete = unlink($thefile);
1084                 unset($CFG->repository_no_delete);
1085             }
1086             return array(
1087                 'url'=>moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename())->out(),
1088                 'id'=>$file->get_itemid(),
1089                 'file'=>$file->get_filename(),
1090                 'icon' => $OUTPUT->pix_url(file_extension_icon($thefile, 32))->out(),
1091             );
1092         } else {
1093             return null;
1094         }
1095     }
1097     /**
1098      * Builds a tree of files This function is
1099      * then called recursively.
1100      *
1101      * @param $fileinfo an object returned by file_browser::get_file_info()
1102      * @param $search searched string
1103      * @param $dynamicmode bool no recursive call is done when in dynamic mode
1104      * @param $list - the array containing the files under the passed $fileinfo
1105      * @returns int the number of files found
1106      *
1107      * todo: take $search into account, and respect a threshold for dynamic loading
1108      */
1109     public static function build_tree($fileinfo, $search, $dynamicmode, &$list) {
1110         global $CFG, $OUTPUT;
1112         $filecount = 0;
1113         $children = $fileinfo->get_children();
1115         foreach ($children as $child) {
1116             $filename = $child->get_visible_name();
1117             $filesize = $child->get_filesize();
1118             $filesize = $filesize ? display_size($filesize) : '';
1119             $filedate = $child->get_timemodified();
1120             $filedate = $filedate ? userdate($filedate) : '';
1121             $filetype = $child->get_mimetype();
1123             if ($child->is_directory()) {
1124                 $path = array();
1125                 $level = $child->get_parent();
1126                 while ($level) {
1127                     $params = $level->get_params();
1128                     $path[] = array($params['filepath'], $level->get_visible_name());
1129                     $level = $level->get_parent();
1130                 }
1132                 $tmp = array(
1133                     'title' => $child->get_visible_name(),
1134                     'size' => 0,
1135                     'date' => $filedate,
1136                     'path' => array_reverse($path),
1137                     'thumbnail' => $OUTPUT->pix_url('f/folder-32')
1138                 );
1140                 //if ($dynamicmode && $child->is_writable()) {
1141                 //    $tmp['children'] = array();
1142                 //} else {
1143                     // if folder name matches search, we send back all files contained.
1144                 $_search = $search;
1145                 if ($search && stristr($tmp['title'], $search) !== false) {
1146                     $_search = false;
1147                 }
1148                 $tmp['children'] = array();
1149                 $_filecount = repository::build_tree($child, $_search, $dynamicmode, $tmp['children']);
1150                 if ($search && $_filecount) {
1151                     $tmp['expanded'] = 1;
1152                 }
1154                 //}
1156                 if (!$search || $_filecount || (stristr($tmp['title'], $search) !== false)) {
1157                     $filecount += $_filecount;
1158                     $list[] = $tmp;
1159                 }
1161             } else { // not a directory
1162                 // skip the file, if we're in search mode and it's not a match
1163                 if ($search && (stristr($filename, $search) === false)) {
1164                     continue;
1165                 }
1166                 $params = $child->get_params();
1167                 $source = serialize(array($params['contextid'], $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']));
1168                 $list[] = array(
1169                     'title' => $filename,
1170                     'size' => $filesize,
1171                     'date' => $filedate,
1172                     //'source' => $child->get_url(),
1173                     'source' => base64_encode($source),
1174                     'thumbnail'=>$OUTPUT->pix_url(file_extension_icon($filename, 32)),
1175                 );
1176                 $filecount++;
1177             }
1178         }
1180         return $filecount;
1181     }
1184     /**
1185      * Display a repository instance list (with edit/delete/create links)
1186      * @global object $CFG
1187      * @global object $USER
1188      * @global object $OUTPUT
1189      * @param object $context the context for which we display the instance
1190      * @param string $typename if set, we display only one type of instance
1191      */
1192     public static function display_instances_list($context, $typename = null) {
1193         global $CFG, $USER, $OUTPUT;
1195         $output = $OUTPUT->box_start('generalbox');
1196         //if the context is SYSTEM, so we call it from administration page
1197         $admin = ($context->id == SYSCONTEXTID) ? true : false;
1198         if ($admin) {
1199             $baseurl = new moodle_url('/'.$CFG->admin.'/repositoryinstance.php', array('sesskey'=>sesskey()));
1200             $output .= $OUTPUT->heading(get_string('siteinstances', 'repository'));
1201         } else {
1202             $baseurl = new moodle_url('/repository/manage_instances.php', array('contextid'=>$context->id, 'sesskey'=>sesskey()));
1203         }
1204         $url = $baseurl;
1206         $namestr = get_string('name');
1207         $pluginstr = get_string('plugin', 'repository');
1208         $settingsstr = get_string('settings');
1209         $deletestr = get_string('delete');
1210         //retrieve list of instances. In administration context we want to display all
1211         //instances of a type, even if this type is not visible. In course/user context we
1212         //want to display only visible instances, but for every type types. The repository::get_instances()
1213         //third parameter displays only visible type.
1214         $params = array();
1215         $params['context'] = array($context, get_system_context());
1216         $params['currentcontext'] = $context;
1217         $params['onlyvisible'] = !$admin;
1218         $params['type']        = $typename;
1219         $instances = repository::get_instances($params);
1220         $instancesnumber = count($instances);
1221         $alreadyplugins = array();
1223         $table = new html_table();
1224         $table->head = array($namestr, $pluginstr, $settingsstr, $deletestr);
1225         $table->align = array('left', 'left', 'center','center');
1226         $table->data = array();
1228         $updowncount = 1;
1230         foreach ($instances as $i) {
1231             $settings = '';
1232             $delete = '';
1234             $type = repository::get_type_by_id($i->options['typeid']);
1236             if ($type->get_contextvisibility($context)) {
1237                 if (!$i->readonly) {
1239                     $url->param('type', $i->options['type']);
1240                     $url->param('edit', $i->id);
1241                     $settings .= html_writer::link($url, $settingsstr);
1243                     $url->remove_params('edit');
1244                     $url->param('delete', $i->id);
1245                     $delete .= html_writer::link($url, $deletestr);
1247                     $url->remove_params('type');
1248                 }
1249             }
1251             $type = repository::get_type_by_id($i->options['typeid']);
1252             $table->data[] = array($i->name, $type->get_readablename(), $settings, $delete);
1254             //display a grey row if the type is defined as not visible
1255             if (isset($type) && !$type->get_visible()) {
1256                 $table->rowclasses[] = 'dimmed_text';
1257             } else {
1258                 $table->rowclasses[] = '';
1259             }
1261             if (!in_array($i->name, $alreadyplugins)) {
1262                 $alreadyplugins[] = $i->name;
1263             }
1264         }
1265         $output .= html_writer::table($table);
1266         $instancehtml = '<div>';
1267         $addable = 0;
1269         //if no type is set, we can create all type of instance
1270         if (!$typename) {
1271             $instancehtml .= '<h3>';
1272             $instancehtml .= get_string('createrepository', 'repository');
1273             $instancehtml .= '</h3><ul>';
1274             $types = repository::get_editable_types($context);
1275             foreach ($types as $type) {
1276                 if (!empty($type) && $type->get_visible()) {
1277                     $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
1278                     if (!empty($instanceoptionnames)) {
1279                         $baseurl->param('new', $type->get_typename());
1280                         $instancehtml .= '<li><a href="'.$baseurl->out().'">'.get_string('createxxinstance', 'repository', get_string('pluginname', 'repository_'.$type->get_typename())).  '</a></li>';
1281                         $baseurl->remove_params('new');
1282                         $addable++;
1283                     }
1284                 }
1285             }
1286             $instancehtml .= '</ul>';
1288         } else {
1289             $instanceoptionnames = repository::static_function($typename, 'get_instance_option_names');
1290             if (!empty($instanceoptionnames)) {   //create a unique type of instance
1291                 $addable = 1;
1292                 $baseurl->param('new', $typename);
1293                 $instancehtml .= "<form action='".$baseurl->out()."' method='post'>
1294                     <p><input type='submit' value='".get_string('createinstance', 'repository')."'/></p>
1295                     </form>";
1296                 $baseurl->remove_params('new');
1297             }
1298         }
1300         if ($addable) {
1301             $instancehtml .= '</div>';
1302             $output .= $instancehtml;
1303         }
1305         $output .= $OUTPUT->box_end();
1307         //print the list + creation links
1308         print($output);
1309     }
1311     /**
1312      * Decide where to save the file, can be overwriten by subclass
1313      * @param string filename
1314      */
1315     public function prepare_file($filename) {
1316         global $CFG;
1317         if (!file_exists($CFG->tempdir.'/download')) {
1318             mkdir($CFG->tempdir.'/download/', $CFG->directorypermissions, true);
1319         }
1320         if (is_dir($CFG->tempdir.'/download')) {
1321             $dir = $CFG->tempdir.'/download/';
1322         }
1323         if (empty($filename)) {
1324             $filename = uniqid('repo', true).'_'.time().'.tmp';
1325         }
1326         if (file_exists($dir.$filename)) {
1327             $filename = uniqid('m').$filename;
1328         }
1329         return $dir.$filename;
1330     }
1332     /**
1333      * Return file URL, for most plugins, the parameter is the original
1334      * url, but some plugins use a file id, so we need this function to
1335      * convert file id to original url.
1336      *
1337      * @param string $url the url of file
1338      * @return string
1339      */
1340     public function get_link($url) {
1341         return $url;
1342     }
1344     /**
1345      * Download a file, this function can be overridden by
1346      * subclass.
1347      *
1348      * @global object $CFG
1349      * @param string $url the url of file
1350      * @param string $filename save location
1351      * @return string the location of the file
1352      * @see curl package
1353      */
1354     public function get_file($url, $filename = '') {
1355         global $CFG;
1356         $path = $this->prepare_file($filename);
1357         $fp = fopen($path, 'w');
1358         $c = new curl;
1359         $c->download(array(array('url'=>$url, 'file'=>$fp)));
1360         return array('path'=>$path, 'url'=>$url);
1361     }
1363     /**
1364      * Return size of a file in bytes.
1365      *
1366      * @param string $source encoded and serialized data of file
1367      * @return integer file size in bytes
1368      */
1369     public function get_file_size($source) {
1370         $browser    = get_file_browser();
1371         $params     = unserialize(base64_decode($source));
1372         $contextid  = clean_param($params['contextid'], PARAM_INT);
1373         $fileitemid = clean_param($params['itemid'], PARAM_INT);
1374         $filename   = clean_param($params['filename'], PARAM_FILE);
1375         $filepath   = clean_param($params['filepath'], PARAM_PATH);
1376         $filearea   = clean_param($params['filearea'], PARAM_AREA);
1377         $component  = clean_param($params['component'], PARAM_COMPONENT);
1378         $context    = get_context_instance_by_id($contextid);
1379         $file_info  = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
1380         if (!empty($file_info)) {
1381             $filesize = $file_info->get_filesize();
1382         } else {
1383             $filesize = null;
1384         }
1385         return $filesize;
1386     }
1388     /**
1389      * Return is the instance is visible
1390      * (is the type visible ? is the context enable ?)
1391      * @return boolean
1392      */
1393     public function is_visible() {
1394         $type = repository::get_type_by_id($this->options['typeid']);
1395         $instanceoptions = repository::static_function($type->get_typename(), 'get_instance_option_names');
1397         if ($type->get_visible()) {
1398             //if the instance is unique so it's visible, otherwise check if the instance has a enabled context
1399             if (empty($instanceoptions) || $type->get_contextvisibility($this->context)) {
1400                 return true;
1401             }
1402         }
1404         return false;
1405     }
1407     /**
1408      * Return the name of this instance, can be overridden.
1409      * @global object $DB
1410      * @return string
1411      */
1412     public function get_name() {
1413         global $DB;
1414         if ( $name = $this->instance->name ) {
1415             return $name;
1416         } else {
1417             return get_string('pluginname', 'repository_' . $this->options['type']);
1418         }
1419     }
1421     /**
1422      * what kind of files will be in this repository?
1423      * @return array return '*' means this repository support any files, otherwise
1424      *               return mimetypes of files, it can be an array
1425      */
1426     public function supported_filetypes() {
1427         // return array('text/plain', 'image/gif');
1428         return '*';
1429     }
1431     /**
1432      * does it return a file url or a item_id
1433      * @return string
1434      */
1435     public function supported_returntypes() {
1436         return (FILE_INTERNAL | FILE_EXTERNAL);
1437     }
1439     /**
1440      * Provide repository instance information for Ajax
1441      * @global object $CFG
1442      * @return object
1443      */
1444     final public function get_meta() {
1445         global $CFG, $OUTPUT;
1446         $ft = new filetype_parser;
1447         $meta = new stdClass();
1448         $meta->id   = $this->id;
1449         $meta->name = $this->get_name();
1450         $meta->type = $this->options['type'];
1451         $meta->icon = $OUTPUT->pix_url('icon', 'repository_'.$meta->type)->out(false);
1452         $meta->supported_types = $ft->get_extensions($this->supported_filetypes());
1453         $meta->return_types = $this->supported_returntypes();
1454         return $meta;
1455     }
1457     /**
1458      * Create an instance for this plug-in
1459      * @global object $CFG
1460      * @global object $DB
1461      * @param string $type the type of the repository
1462      * @param integer $userid the user id
1463      * @param object $context the context
1464      * @param array $params the options for this instance
1465      * @param integer $readonly whether to create it readonly or not (defaults to not)
1466      * @return mixed
1467      */
1468     public static function create($type, $userid, $context, $params, $readonly=0) {
1469         global $CFG, $DB;
1470         $params = (array)$params;
1471         require_once($CFG->dirroot . '/repository/'. $type . '/lib.php');
1472         $classname = 'repository_' . $type;
1473         if ($repo = $DB->get_record('repository', array('type'=>$type))) {
1474             $record = new stdClass();
1475             $record->name = $params['name'];
1476             $record->typeid = $repo->id;
1477             $record->timecreated  = time();
1478             $record->timemodified = time();
1479             $record->contextid = $context->id;
1480             $record->readonly = $readonly;
1481             $record->userid    = $userid;
1482             $id = $DB->insert_record('repository_instances', $record);
1483             $options = array();
1484             $configs = call_user_func($classname . '::get_instance_option_names');
1485             if (!empty($configs)) {
1486                 foreach ($configs as $config) {
1487                     if (isset($params[$config])) {
1488                         $options[$config] = $params[$config];
1489                     } else {
1490                         $options[$config] = null;
1491                     }
1492                 }
1493             }
1495             if (!empty($id)) {
1496                 unset($options['name']);
1497                 $instance = repository::get_instance($id);
1498                 $instance->set_option($options);
1499                 return $id;
1500             } else {
1501                 return null;
1502             }
1503         } else {
1504             return null;
1505         }
1506     }
1508     /**
1509      * delete a repository instance
1510      * @global object $DB
1511      * @return mixed
1512      */
1513     final public function delete() {
1514         global $DB;
1515         $DB->delete_records('repository_instances', array('id'=>$this->id));
1516         $DB->delete_records('repository_instance_config', array('instanceid'=>$this->id));
1517         return true;
1518     }
1520     /**
1521      * Hide/Show a repository
1522      * @global object $DB
1523      * @param string $hide
1524      * @return boolean
1525      */
1526     final public function hide($hide = 'toggle') {
1527         global $DB;
1528         if ($entry = $DB->get_record('repository', array('id'=>$this->id))) {
1529             if ($hide === 'toggle' ) {
1530                 if (!empty($entry->visible)) {
1531                     $entry->visible = 0;
1532                 } else {
1533                     $entry->visible = 1;
1534                 }
1535             } else {
1536                 if (!empty($hide)) {
1537                     $entry->visible = 0;
1538                 } else {
1539                     $entry->visible = 1;
1540                 }
1541             }
1542             return $DB->update_record('repository', $entry);
1543         }
1544         return false;
1545     }
1547     /**
1548      * Save settings for repository instance
1549      * $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));
1550      * @global object $DB
1551      * @param array $options settings
1552      * @return int Id of the record
1553      */
1554     public function set_option($options = array()) {
1555         global $DB;
1557         if (!empty($options['name'])) {
1558             $r = new stdClass();
1559             $r->id   = $this->id;
1560             $r->name = $options['name'];
1561             $DB->update_record('repository_instances', $r);
1562             unset($options['name']);
1563         }
1564         foreach ($options as $name=>$value) {
1565             if ($id = $DB->get_field('repository_instance_config', 'id', array('name'=>$name, 'instanceid'=>$this->id))) {
1566                 $DB->set_field('repository_instance_config', 'value', $value, array('id'=>$id));
1567             } else {
1568                 $config = new stdClass();
1569                 $config->instanceid = $this->id;
1570                 $config->name   = $name;
1571                 $config->value  = $value;
1572                 $DB->insert_record('repository_instance_config', $config);
1573             }
1574         }
1575         return true;
1576     }
1578     /**
1579      * Get settings for repository instance
1580      * @global object $DB
1581      * @param string $config
1582      * @return array Settings
1583      */
1584     public function get_option($config = '') {
1585         global $DB;
1586         $entries = $DB->get_records('repository_instance_config', array('instanceid'=>$this->id));
1587         $ret = array();
1588         if (empty($entries)) {
1589             return $ret;
1590         }
1591         foreach($entries as $entry) {
1592             $ret[$entry->name] = $entry->value;
1593         }
1594         if (!empty($config)) {
1595             if (isset($ret[$config])) {
1596                 return $ret[$config];
1597             } else {
1598                 return null;
1599             }
1600         } else {
1601             return $ret;
1602         }
1603     }
1605     public function filter(&$value) {
1606         $pass = false;
1607         $accepted_types = optional_param_array('accepted_types', '', PARAM_RAW);
1608         $ft = new filetype_parser;
1609         //$ext = $ft->get_extensions($this->supported_filetypes());
1610         if (isset($value['children'])) {
1611             $pass = true;
1612             if (!empty($value['children'])) {
1613                 $value['children'] = array_filter($value['children'], array($this, 'filter'));
1614             }
1615         } else {
1616             if ($accepted_types == '*' or empty($accepted_types)
1617                 or (is_array($accepted_types) and in_array('*', $accepted_types))) {
1618                 $pass = true;
1619             } elseif (is_array($accepted_types)) {
1620                 foreach ($accepted_types as $type) {
1621                     $extensions = $ft->get_extensions($type);
1622                     if (!is_array($extensions)) {
1623                         $pass = true;
1624                     } else {
1625                         foreach ($extensions as $ext) {
1626                             if (preg_match('#'.$ext.'$#i', $value['title'])) {
1627                                 $pass = true;
1628                             }
1629                         }
1630                     }
1631                 }
1632             }
1633         }
1634         return $pass;
1635     }
1637     /**
1638      * Given a path, and perhaps a search, get a list of files.
1639      *
1640      * See details on http://docs.moodle.org/dev/Repository_plugins
1641      *
1642      * @param string $path, this parameter can
1643      * a folder name, or a identification of folder
1644      * @param string $page, the page number of file list
1645      * @return array the list of files, including meta infomation, containing the following keys
1646      *           manage, url to manage url
1647      *           client_id
1648      *           login, login form
1649      *           repo_id, active repository id
1650      *           login_btn_action, the login button action
1651      *           login_btn_label, the login button label
1652      *           total, number of results
1653      *           perpage, items per page
1654      *           page
1655      *           pages, total pages
1656      *           issearchresult, is it a search result?
1657      *           list, file list
1658      *           path, current path and parent path
1659      */
1660     public function get_listing($path = '', $page = '') {
1661     }
1663     /**
1664      * Search files in repository
1665      * When doing global search, $search_text will be used as
1666      * keyword.
1667      *
1668      * @return mixed, see get_listing()
1669      */
1670     public function search($search_text) {
1671         $list = array();
1672         $list['list'] = array();
1673         return false;
1674     }
1676     /**
1677      * Logout from repository instance
1678      * By default, this function will return a login form
1679      *
1680      * @return string
1681      */
1682     public function logout(){
1683         return $this->print_login();
1684     }
1686     /**
1687      * To check whether the user is logged in.
1688      *
1689      * @return boolean
1690      */
1691     public function check_login(){
1692         return true;
1693     }
1696     /**
1697      * Show the login screen, if required
1698      */
1699     public function print_login(){
1700         return $this->get_listing();
1701     }
1703     /**
1704      * Show the search screen, if required
1705      * @return null
1706      */
1707     public function print_search() {
1708         $str = '';
1709         $str .= '<input type="hidden" name="repo_id" value="'.$this->id.'" />';
1710         $str .= '<input type="hidden" name="ctx_id" value="'.$this->context->id.'" />';
1711         $str .= '<input type="hidden" name="seekey" value="'.sesskey().'" />';
1712         $str .= '<label>'.get_string('keyword', 'repository').': </label><br/><input name="s" value="" /><br/>';
1713         return $str;
1714     }
1716     /**
1717      * For oauth like external authentication, when external repository direct user back to moodle,
1718      * this funciton will be called to set up token and token_secret
1719      */
1720     public function callback() {
1721     }
1723     /**
1724      * is it possible to do glboal search?
1725      * @return boolean
1726      */
1727     public function global_search() {
1728         return false;
1729     }
1731     /**
1732      * Defines operations that happen occasionally on cron
1733      * @return boolean
1734      */
1735     public function cron() {
1736         return true;
1737     }
1739     /**
1740      * function which is run when the type is created (moodle administrator add the plugin)
1741      * @return boolean success or fail?
1742      */
1743     public static function plugin_init() {
1744         return true;
1745     }
1747     /**
1748      * Edit/Create Admin Settings Moodle form
1749      * @param object $mform Moodle form (passed by reference)
1750      * @param string $classname repository class name
1751      */
1752     public function type_config_form($mform, $classname = 'repository') {
1753         $instnaceoptions = call_user_func(array($classname, 'get_instance_option_names'), $mform, $classname);
1754         if (empty($instnaceoptions)) {
1755             // this plugin has only one instance
1756             // so we need to give it a name
1757             // it can be empty, then moodle will look for instance name from language string
1758             $mform->addElement('text', 'pluginname', get_string('pluginname', 'repository'), array('size' => '40'));
1759             $mform->addElement('static', 'pluginnamehelp', '', get_string('pluginnamehelp', 'repository'));
1760         }
1761     }
1763     /**
1764      * Validate Admin Settings Moodle form
1765      * @param object $mform Moodle form (passed by reference)
1766      * @param array array of ("fieldname"=>value) of submitted data
1767      * @param array array of ("fieldname"=>errormessage) of errors
1768      * @return array array of errors
1769      */
1770     public static function type_form_validation($mform, $data, $errors) {
1771         return $errors;
1772     }
1775     /**
1776      * Edit/Create Instance Settings Moodle form
1777      * @param object $mform Moodle form (passed by reference)
1778      */
1779     public function instance_config_form($mform) {
1780     }
1782     /**
1783      * Return names of the general options
1784      * By default: no general option name
1785      * @return array
1786      */
1787     public static function get_type_option_names() {
1788         return array('pluginname');
1789     }
1791     /**
1792      * Return names of the instance options
1793      * By default: no instance option name
1794      * @return array
1795      */
1796     public static function get_instance_option_names() {
1797         return array();
1798     }
1800     public static function instance_form_validation($mform, $data, $errors) {
1801         return $errors;
1802     }
1804     public function get_short_filename($str, $maxlength) {
1805         if (textlib::strlen($str) >= $maxlength) {
1806             return trim(textlib::substr($str, 0, $maxlength)).'...';
1807         } else {
1808             return $str;
1809         }
1810     }
1812     /**
1813      * Overwrite an existing file
1814      *
1815      * @param int $itemid
1816      * @param string $filepath
1817      * @param string $filename
1818      * @param string $newfilepath
1819      * @param string $newfilename
1820      * @return boolean
1821      */
1822     function overwrite_existing_draftfile($itemid, $filepath, $filename, $newfilepath, $newfilename) {
1823         global $USER;
1824         $fs = get_file_storage();
1825         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
1826         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $filepath, $filename)) {
1827             if ($tempfile = $fs->get_file($user_context->id, 'user', 'draft', $itemid, $newfilepath, $newfilename)) {
1828                 // delete existing file to release filename
1829                 $file->delete();
1830                 // create new file
1831                 $newfile = $fs->create_file_from_storedfile(array('filepath'=>$filepath, 'filename'=>$filename), $tempfile);
1832                 // remove temp file
1833                 $tempfile->delete();
1834                 return true;
1835             }
1836         }
1837         return false;
1838     }
1840     /**
1841      * Delete a temp file from draft area
1842      *
1843      * @param int $draftitemid
1844      * @param string $filepath
1845      * @param string $filename
1846      * @return boolean
1847      */
1848     function delete_tempfile_from_draft($draftitemid, $filepath, $filename) {
1849         global $USER;
1850         $fs = get_file_storage();
1851         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
1852         if ($file = $fs->get_file($user_context->id, 'user', 'draft', $draftitemid, $filepath, $filename)) {
1853             $file->delete();
1854             return true;
1855         } else {
1856             return false;
1857         }
1858     }
1861 /**
1862  * Exception class for repository api
1863  *
1864  * @since 2.0
1865  * @package moodlecore
1866  * @subpackage repository
1867  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
1868  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1869  */
1870 class repository_exception extends moodle_exception {
1873 /**
1874  * This is a class used to define a repository instance form
1875  *
1876  * @since 2.0
1877  * @package moodlecore
1878  * @subpackage repository
1879  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
1880  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1881  */
1882 final class repository_instance_form extends moodleform {
1883     protected $instance;
1884     protected $plugin;
1885     protected function add_defaults() {
1886         $mform =& $this->_form;
1887         $strrequired = get_string('required');
1889         $mform->addElement('hidden', 'edit',  ($this->instance) ? $this->instance->id : 0);
1890         $mform->setType('edit', PARAM_INT);
1891         $mform->addElement('hidden', 'new',   $this->plugin);
1892         $mform->setType('new', PARAM_FORMAT);
1893         $mform->addElement('hidden', 'plugin', $this->plugin);
1894         $mform->setType('plugin', PARAM_PLUGIN);
1895         $mform->addElement('hidden', 'typeid', $this->typeid);
1896         $mform->setType('typeid', PARAM_INT);
1897         $mform->addElement('hidden', 'contextid', $this->contextid);
1898         $mform->setType('contextid', PARAM_INT);
1900         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
1901         $mform->addRule('name', $strrequired, 'required', null, 'client');
1902     }
1904     public function definition() {
1905         global $CFG;
1906         // type of plugin, string
1907         $this->plugin = $this->_customdata['plugin'];
1908         $this->typeid = $this->_customdata['typeid'];
1909         $this->contextid = $this->_customdata['contextid'];
1910         $this->instance = (isset($this->_customdata['instance'])
1911                 && is_subclass_of($this->_customdata['instance'], 'repository'))
1912             ? $this->_customdata['instance'] : null;
1914         $mform =& $this->_form;
1916         $this->add_defaults();
1917         //add fields
1918         if (!$this->instance) {
1919             $result = repository::static_function($this->plugin, 'instance_config_form', $mform);
1920             if ($result === false) {
1921                 $mform->removeElement('name');
1922             }
1923         } else {
1924             $data = array();
1925             $data['name'] = $this->instance->name;
1926             if (!$this->instance->readonly) {
1927                 $result = $this->instance->instance_config_form($mform);
1928                 if ($result === false) {
1929                     $mform->removeElement('name');
1930                 }
1931                 // and set the data if we have some.
1932                 foreach ($this->instance->get_instance_option_names() as $config) {
1933                     if (!empty($this->instance->options[$config])) {
1934                         $data[$config] = $this->instance->options[$config];
1935                      } else {
1936                         $data[$config] = '';
1937                      }
1938                 }
1939             }
1940             $this->set_data($data);
1941         }
1943         if ($result === false) {
1944             $mform->addElement('cancel');
1945         } else {
1946             $this->add_action_buttons(true, get_string('save','repository'));
1947         }
1948     }
1950     public function validation($data) {
1951         global $DB;
1952         $errors = array();
1953         $plugin = $this->_customdata['plugin'];
1954         $instance = (isset($this->_customdata['instance'])
1955                 && is_subclass_of($this->_customdata['instance'], 'repository'))
1956             ? $this->_customdata['instance'] : null;
1957         if (!$instance) {
1958             $errors = repository::static_function($plugin, 'instance_form_validation', $this, $data, $errors);
1959         } else {
1960             $errors = $instance->instance_form_validation($this, $data, $errors);
1961         }
1963         $sql = "SELECT count('x')
1964                   FROM {repository_instances} i, {repository} r
1965                  WHERE r.type=:plugin AND r.id=i.typeid AND i.name=:name";
1966         if ($DB->count_records_sql($sql, array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
1967             $errors['name'] = get_string('erroruniquename', 'repository');
1968         }
1970         return $errors;
1971     }
1974 /**
1975  * This is a class used to define a repository type setting form
1976  *
1977  * @since 2.0
1978  * @package moodlecore
1979  * @subpackage repository
1980  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
1981  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1982  */
1983 final class repository_type_form extends moodleform {
1984     protected $instance;
1985     protected $plugin;
1986     protected $action;
1988     /**
1989      * Definition of the moodleform
1990      * @global object $CFG
1991      */
1992     public function definition() {
1993         global $CFG;
1994         // type of plugin, string
1995         $this->plugin = $this->_customdata['plugin'];
1996         $this->instance = (isset($this->_customdata['instance'])
1997                 && is_a($this->_customdata['instance'], 'repository_type'))
1998             ? $this->_customdata['instance'] : null;
2000         $this->action = $this->_customdata['action'];
2001         $this->pluginname = $this->_customdata['pluginname'];
2002         $mform =& $this->_form;
2003         $strrequired = get_string('required');
2005         $mform->addElement('hidden', 'action', $this->action);
2006         $mform->setType('action', PARAM_TEXT);
2007         $mform->addElement('hidden', 'repos', $this->plugin);
2008         $mform->setType('repos', PARAM_PLUGIN);
2010         // let the plugin add its specific fields
2011         $classname = 'repository_' . $this->plugin;
2012         require_once($CFG->dirroot . '/repository/' . $this->plugin . '/lib.php');
2013         //add "enable course/user instances" checkboxes if multiple instances are allowed
2014         $instanceoptionnames = repository::static_function($this->plugin, 'get_instance_option_names');
2016         $result = call_user_func(array($classname, 'type_config_form'), $mform, $classname);
2018         if (!empty($instanceoptionnames)) {
2019             $sm = get_string_manager();
2020             $component = 'repository';
2021             if ($sm->string_exists('enablecourseinstances', 'repository_' . $this->plugin)) {
2022                 $component .= ('_' . $this->plugin);
2023             }
2024             $mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', $component));
2026             $component = 'repository';
2027             if ($sm->string_exists('enableuserinstances', 'repository_' . $this->plugin)) {
2028                 $component .= ('_' . $this->plugin);
2029             }
2030             $mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', $component));
2031         }
2033         // set the data if we have some.
2034         if ($this->instance) {
2035             $data = array();
2036             $option_names = call_user_func(array($classname,'get_type_option_names'));
2037             if (!empty($instanceoptionnames)){
2038                 $option_names[] = 'enablecourseinstances';
2039                 $option_names[] = 'enableuserinstances';
2040             }
2042             $instanceoptions = $this->instance->get_options();
2043             foreach ($option_names as $config) {
2044                 if (!empty($instanceoptions[$config])) {
2045                     $data[$config] = $instanceoptions[$config];
2046                 } else {
2047                     $data[$config] = '';
2048                 }
2049             }
2050             // XXX: set plugin name for plugins which doesn't have muliti instances
2051             if (empty($instanceoptionnames)){
2052                 $data['pluginname'] = $this->pluginname;
2053             }
2054             $this->set_data($data);
2055         }
2057         $this->add_action_buttons(true, get_string('save','repository'));
2058     }
2060     public function validation($data) {
2061         $errors = array();
2062         $plugin = $this->_customdata['plugin'];
2063         $instance = (isset($this->_customdata['instance'])
2064                 && is_subclass_of($this->_customdata['instance'], 'repository'))
2065             ? $this->_customdata['instance'] : null;
2066         if (!$instance) {
2067             $errors = repository::static_function($plugin, 'type_form_validation', $this, $data, $errors);
2068         } else {
2069             $errors = $instance->type_form_validation($this, $data, $errors);
2070         }
2072         return $errors;
2073     }
2076 /**
2077  * Generate all options needed by filepicker
2078  *
2079  * @param array $args, including following keys
2080  *          context
2081  *          accepted_types
2082  *          return_types
2083  *
2084  * @return array the list of repository instances, including meta infomation, containing the following keys
2085  *          externallink
2086  *          repositories
2087  *          accepted_types
2088  */
2089 function initialise_filepicker($args) {
2090     global $CFG, $USER, $PAGE, $OUTPUT;
2091     require_once($CFG->libdir . '/licenselib.php');
2093     $return = new stdClass();
2094     $licenses = array();
2095     if (!empty($CFG->licenses)) {
2096         $array = explode(',', $CFG->licenses);
2097         foreach ($array as $license) {
2098             $l = new stdClass();
2099             $l->shortname = $license;
2100             $l->fullname = get_string($license, 'license');
2101             $licenses[] = $l;
2102         }
2103     }
2104     if (!empty($CFG->sitedefaultlicense)) {
2105         $return->defaultlicense = $CFG->sitedefaultlicense;
2106     }
2108     $return->licenses = $licenses;
2110     $return->author = fullname($USER);
2112     $ft = new filetype_parser();
2113     if (empty($args->context)) {
2114         $context = $PAGE->context;
2115     } else {
2116         $context = $args->context;
2117     }
2118     $disable_types = array();
2119     if (!empty($args->disable_types)) {
2120         $disable_types = $args->disable_types;
2121     }
2123     $user_context = get_context_instance(CONTEXT_USER, $USER->id);
2125     list($context, $course, $cm) = get_context_info_array($context->id);
2126     $contexts = array($user_context, get_system_context());
2127     if (!empty($course)) {
2128         // adding course context
2129         $contexts[] = get_context_instance(CONTEXT_COURSE, $course->id);
2130     }
2131     $externallink = (int)get_config(null, 'repositoryallowexternallinks');
2132     $repositories = repository::get_instances(array(
2133         'context'=>$contexts,
2134         'currentcontext'=> $context,
2135         'accepted_types'=>$args->accepted_types,
2136         'return_types'=>$args->return_types,
2137         'disable_types'=>$disable_types
2138     ));
2140     $return->repositories = array();
2142     if (empty($externallink)) {
2143         $return->externallink = false;
2144     } else {
2145         $return->externallink = true;
2146     }
2148     // provided by form element
2149     $return->accepted_types = $ft->get_extensions($args->accepted_types);
2150     $return->return_types = $args->return_types;
2151     foreach ($repositories as $repository) {
2152         $meta = $repository->get_meta();
2153         // Please note that the array keys for repositories are used within
2154         // JavaScript a lot, the key NEEDS to be the repository id.
2155         $return->repositories[$repository->id] = $meta;
2156     }
2157     return $return;
2159 /**
2160  * Small function to walk an array to attach repository ID
2161  * @param array $value
2162  * @param string $key
2163  * @param int $id
2164  */
2165 function repository_attach_id(&$value, $key, $id){
2166     $value['repo_id'] = $id;