eb2109653f74a9cf2df1e5f9c7fbe14d1156a8cf
[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 moodlecore
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);
37 /**
38  * This class is used to manage repository plugins
39  *
40  * A repository_type is a repository plug-in. It can be Box.net, Flick-r, ...
41  * A repository type can be edited, sorted and hidden. It is mandatory for an
42  * administrator to create a repository type in order to be able to create
43  * some instances of this type.
44  * Coding note:
45  * - a repository_type object is mapped to the "repository" database table
46  * - "typename" attibut maps the "type" database field. It is unique.
47  * - general "options" for a repository type are saved in the config_plugin table
48  * - when you delete a repository, all instances are deleted, and general
49  *   options are also deleted from database
50  * - When you create a type for a plugin that can't have multiple instances, a
51  *   instance is automatically created.
52  *
53  * @package moodlecore
54  * @subpackage repository
55  * @copyright 2009 Jerome Mouneyrac
56  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57  */
58 class repository_type {
61     /**
62      * Type name (no whitespace) - A type name is unique
63      * Note: for a user-friendly type name see get_readablename()
64      * @var String
65      */
66     private $_typename;
69     /**
70      * Options of this type
71      * They are general options that any instance of this type would share
72      * e.g. API key
73      * These options are saved in config_plugin table
74      * @var array
75      */
76     private $_options;
79     /**
80      * Is the repository type visible or hidden
81      * If false (hidden): no instances can be created, edited, deleted, showned , used...
82      * @var boolean
83      */
84     private $_visible;
87     /**
88      * 0 => not ordered, 1 => first position, 2 => second position...
89      * A not order type would appear in first position (should never happened)
90      * @var integer
91      */
92     private $_sortorder;
94      /**
95      * Return if the instance is visible in a context
96      * TODO: check if the context visibility has been overwritten by the plugin creator
97      *       (need to create special functions to be overvwritten in repository class)
98      * @param objet $context - context
99      * @return boolean
100      */
101     public function get_contextvisibility($context) {
102         global $USER;
104         if ($context->contextlevel == CONTEXT_COURSE) {
105             return $this->_options['enablecourseinstances'];
106         }
108         if ($context->contextlevel == CONTEXT_USER) {
109             return $this->_options['enableuserinstances'];
110         }
112         //the context is SITE
113         return true;
114     }
118     /**
119      * repository_type constructor
120      * @global object $CFG
121      * @param integer $typename
122      * @param array $typeoptions
123      * @param boolean $visible
124      * @param integer $sortorder (don't really need set, it will be during create() call)
125      */
126     public function __construct($typename = '', $typeoptions = array(), $visible = true, $sortorder = 0) {
127         global $CFG;
129         //set type attributs
130         $this->_typename = $typename;
131         $this->_visible = $visible;
132         $this->_sortorder = $sortorder;
134         //set options attribut
135         $this->_options = array();
136         $options = repository::static_function($typename, 'get_type_option_names');
137         //check that the type can be setup
138         if (!empty($options)) {
139             //set the type options
140             foreach ($options as $config) {
141                 if (array_key_exists($config, $typeoptions)) {
142                     $this->_options[$config] = $typeoptions[$config];
143                 }
144             }
145         }
147         //retrieve visibility from option
148         if (array_key_exists('enablecourseinstances',$typeoptions)) {
149             $this->_options['enablecourseinstances'] = $typeoptions['enablecourseinstances'];
150         } else {
151              $this->_options['enablecourseinstances'] = 0;
152         }
154         if (array_key_exists('enableuserinstances',$typeoptions)) {
155             $this->_options['enableuserinstances'] = $typeoptions['enableuserinstances'];
156         } else {
157              $this->_options['enableuserinstances'] = 0;
158         }
160     }
162     /**
163      * Get the type name (no whitespace)
164      * For a human readable name, use get_readablename()
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      * @return string user-friendly type name
174      */
175     public function get_readablename() {
176         return get_string('pluginname','repository_'.$this->_typename);
177     }
179     /**
180      * Return general options
181      * @return array the general options
182      */
183     public function get_options() {
184         return $this->_options;
185     }
187     /**
188      * Return visibility
189      * @return boolean
190      */
191     public function get_visible() {
192         return $this->_visible;
193     }
195     /**
196      * Return order / position of display in the file picker
197      * @return integer
198      */
199     public function get_sortorder() {
200         return $this->_sortorder;
201     }
203     /**
204      * Create a repository type (the type name must not already exist)
205      * @param boolean throw exception?
206      * @return mixed return int if create successfully, return false if
207      *         any errors
208      * @global object $DB
209      */
210     public function create($silent = false) {
211         global $DB;
213         //check that $type has been set
214         $timmedtype = trim($this->_typename);
215         if (empty($timmedtype)) {
216             throw new repository_exception('emptytype', 'repository');
217         }
219         //set sortorder as the last position in the list
220         if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
221             $sql = "SELECT MAX(sortorder) FROM {repository}";
222             $this->_sortorder = 1 + $DB->get_field_sql($sql);
223         }
225         //only create a new type if it doesn't already exist
226         $existingtype = $DB->get_record('repository', array('type'=>$this->_typename));
227         if (!$existingtype) {
228             //create the type
229             $newtype = new stdclass;
230             $newtype->type = $this->_typename;
231             $newtype->visible = $this->_visible;
232             $newtype->sortorder = $this->_sortorder;
233             $plugin_id = $DB->insert_record('repository', $newtype);
234             //save the options in DB
235             $this->update_options();
237             $instanceoptionnames = repository::static_function($this->_typename, 'get_instance_option_names');
239             //if the plugin type has no multiple instance (e.g. has no instance option name) so it wont
240             //be possible for the administrator to create a instance
241             //in this case we need to create an instance
242             if (empty($instanceoptionnames)) {
243                 $instanceoptions = array();
244                 if (empty($this->_options['pluginname'])) {
245                     // when moodle trying to install some repo plugin automatically
246                     // this option will be empty, get it from language string when display
247                     $instanceoptions['name'] = '';
248                 } else {
249                     // when admin trying to add a plugin manually, he will type a name
250                     // for it
251                     $instanceoptions['name'] = $this->_options['pluginname'];
252                 }
253                 repository::static_function($this->_typename, 'create', $this->_typename, 0, get_system_context(), $instanceoptions);
254             }
255             //run plugin_init function
256             if (!repository::static_function($this->_typename, 'plugin_init')) {
257                 if (!$silent) {
258                     throw new repository_exception('cannotinitplugin', 'repository');
259                 }
260             }
262             if(!empty($plugin_id)) {
263                 // return plugin_id if create successfully
264                 return $plugin_id;
265             } else {
266                 return false;
267             }
269         } else {
270             if (!$silent) {
271                 throw new repository_exception('existingrepository', 'repository');
272             }
273             // If plugin existed, return false, tell caller no new plugins were created.
274             return false;
275         }
276     }
279     /**
280      * Update plugin options into the config_plugin table
281      * @param array $options
282      * @return boolean
283      */
284     public function update_options($options = null) {
285         global $DB;
286         $classname = 'repository_' . $this->_typename;
287         $instanceoptions = repository::static_function($this->_typename, 'get_instance_option_names');
288         if (empty($instanceoptions)) {
289             // update repository instance name if this plugin type doesn't have muliti instances
290             $params = array();
291             $params['type'] = $this->_typename;
292             $instances = repository::get_instances($params);
293             $instance = array_pop($instances);
294             if ($instance) {
295                 $DB->set_field('repository_instances', 'name', $options['pluginname'], array('id'=>$instance->id));
296             }
297             unset($options['pluginname']);
298         }
300         if (!empty($options)) {
301             $this->_options = $options;
302         }
304         foreach ($this->_options as $name => $value) {
305             set_config($name, $value, $this->_typename);
306         }
308         return true;
309     }
311     /**
312      * Update visible database field with the value given as parameter
313      * or with the visible value of this object
314      * This function is private.
315      * For public access, have a look to switch_and_update_visibility()
316      * @global object $DB
317      * @param boolean $visible
318      * @return boolean
319      */
320     private function update_visible($visible = null) {
321         global $DB;
323         if (!empty($visible)) {
324             $this->_visible = $visible;
325         }
326         else if (!isset($this->_visible)) {
327             throw new repository_exception('updateemptyvisible', 'repository');
328         }
330         return $DB->set_field('repository', 'visible', $this->_visible, array('type'=>$this->_typename));
331     }
333     /**
334      * Update database sortorder field with the value given as parameter
335      * or with the sortorder value of this object
336      * This function is private.
337      * For public access, have a look to move_order()
338      * @global object $DB
339      * @param integer $sortorder
340      * @return boolean
341      */
342     private function update_sortorder($sortorder = null) {
343         global $DB;
345         if (!empty($sortorder) && $sortorder!=0) {
346             $this->_sortorder = $sortorder;
347         }
348         //if sortorder is not set, we set it as the ;ast position in the list
349         else if (!isset($this->_sortorder) || $this->_sortorder == 0 ) {
350             $sql = "SELECT MAX(sortorder) FROM {repository}";
351             $this->_sortorder = 1 + $DB->get_field_sql($sql);
352         }
354         return $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$this->_typename));
355     }
357     /**
358      * Change order of the type with its adjacent upper or downer type
359      * (database fields are updated)
360      * Algorithm details:
361      * 1. retrieve all types in an array. This array is sorted by sortorder,
362      * and the array keys start from 0 to X (incremented by 1)
363      * 2. switch sortorder values of this type and its adjacent type
364      * @global object $DB
365      * @param string $move "up" or "down"
366      */
367     public function move_order($move) {
368         global $DB;
370         $types = repository::get_types();    // retrieve all types
372     /// retrieve this type into the returned array
373         $i = 0;
374         while (!isset($indice) && $i<count($types)) {
375             if ($types[$i]->get_typename() == $this->_typename) {
376                 $indice = $i;
377             }
378             $i++;
379         }
381     /// retrieve adjacent indice
382         switch ($move) {
383             case "up":
384                 $adjacentindice = $indice - 1;
385             break;
386             case "down":
387                 $adjacentindice = $indice + 1;
388             break;
389             default:
390             throw new repository_exception('movenotdefined', 'repository');
391         }
393         //switch sortorder of this type and the adjacent type
394         //TODO: we could reset sortorder for all types. This is not as good in performance term, but
395         //that prevent from wrong behaviour on a screwed database. As performance are not important in this particular case
396         //it worth to change the algo.
397         if ($adjacentindice>=0 && !empty($types[$adjacentindice])) {
398             $DB->set_field('repository', 'sortorder', $this->_sortorder, array('type'=>$types[$adjacentindice]->get_typename()));
399             $this->update_sortorder($types[$adjacentindice]->get_sortorder());
400         }
401     }
403     /**
404      * 1. Change visibility to the value chosen
405      *
406      * 2. Update the type
407      * @return boolean
408      */
409     public function update_visibility($visible = null) {
410         if (is_bool($visible)) {
411             $this->_visible = $visible;
412         } else {
413             $this->_visible = !$this->_visible;
414         }
415         return $this->update_visible();
416     }
419     /**
420      * Delete a repository_type (general options are removed from config_plugin
421      * table, and all instances are deleted)
422      * @global object $DB
423      * @return boolean
424      */
425     public function delete() {
426         global $DB;
428         //delete all instances of this type
429         $params = array();
430         $params['context'] = array();
431         $params['onlyvisible'] = false;
432         $params['type'] = $this->_typename;
433         $instances = repository::get_instances($params);
434         foreach ($instances as $instance) {
435             $instance->delete();
436         }
438         //delete all general options
439         foreach ($this->_options as $name => $value) {
440             set_config($name, null, $this->_typename);
441         }
443         return $DB->delete_records('repository', array('type' => $this->_typename));
444     }
447 /**
448  * This is the base class of the repository class
449  *
450  * To use repository plugin, see:
451  * http://docs.moodle.org/en/Development:Repository_How_to_Create_Plugin
452  * class repository is an abstract class, some functions must be implemented in subclass.
453  * See an example: repository/boxnet/lib.php
454  *
455  * A few notes:
456  *   // for ajax file picker, this will print a json string to tell file picker
457  *   // how to build a login form
458  *   $repo->print_login();
459  *   // for ajax file picker, this will return a files list.
460  *   $repo->get_listing();
461  *   // this function will be used for non-javascript version.
462  *   $repo->print_listing();
463  *   // print a search box
464  *   $repo->print_search();
465  *
466  * @package moodlecore
467  * @subpackage repository
468  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
469  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
470  */
471 abstract class repository {
472     // $disabled can be set to true to disable a plugin by force
473     // example: self::$disabled = true
474     public $disabled = false;
475     public $id;
476     /** @var object current context */
477     public $context;
478     public $options;
479     public $readonly;
480     public $returntypes;
481     /** @var object repository instance database record */
482     public $instance;
483     /**
484      * 1. Initialize context and options
485      * 2. Accept necessary parameters
486      *
487      * @param integer $repositoryid repository instance id
488      * @param integer|object a context id or context object
489      * @param array $options repository options
490      */
491     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array(), $readonly = 0) {
492         global $DB;
493         $this->id = $repositoryid;
494         if (is_object($context)) {
495             $this->context = $context;
496         } else {
497             $this->context = get_context_instance_by_id($context);
498         }
499         $this->instance = $DB->get_record('repository_instances', array('id'=>$this->id));
500         $this->readonly = $readonly;
501         $this->options = array();
503         if (is_array($options)) {
504             $options = array_merge($this->get_option(), $options);
505         } else {
506             $options = $this->get_option();
507         }
508         foreach ($options as $n => $v) {
509             $this->options[$n] = $v;
510         }
511         $this->name = $this->get_name();
512         $this->returntypes = $this->supported_returntypes();
513         $this->super_called = true;
514     }
516     /**
517      * Get a repository type object by a given type name.
518      * @global object $DB
519      * @param string $typename the repository type name
520      * @return repository_type|bool
521      */
522     public static function get_type_by_typename($typename) {
523         global $DB;
525         if (!$record = $DB->get_record('repository',array('type' => $typename))) {
526             return false;
527         }
529         return new repository_type($typename, (array)get_config($typename), $record->visible, $record->sortorder);
530     }
532     /**
533      * Get the repository type by a given repository type id.
534      * @global object $DB
535      * @param int $id the type id
536      * @return object
537      */
538     public static function get_type_by_id($id) {
539         global $DB;
541         if (!$record = $DB->get_record('repository',array('id' => $id))) {
542             return false;
543         }
545         return new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
546     }
548     /**
549      * Return all repository types ordered by sortorder field
550      * first repository type in returnedarray[0], second repository type in returnedarray[1], ...
551      * @global object $DB
552      * @global object $CFG
553      * @param boolean $visible can return types by visiblity, return all types if null
554      * @return array Repository types
555      */
556     public static function get_types($visible=null) {
557         global $DB, $CFG;
559         $types = array();
560         $params = null;
561         if (!empty($visible)) {
562             $params = array('visible' => $visible);
563         }
564         if ($records = $DB->get_records('repository',$params,'sortorder')) {
565             foreach($records as $type) {
566                 if (file_exists($CFG->dirroot . '/repository/'. $type->type .'/lib.php')) {
567                     $types[] = new repository_type($type->type, (array)get_config($type->type), $type->visible, $type->sortorder);
568                 }
569             }
570         }
572         return $types;
573     }
575     /**
576      * To check if the context id is valid
577      * @global object $USER
578      * @param int $contextid
579      * @return boolean
580      */
581     public static function check_capability($contextid, $instance) {
582         $context = get_context_instance_by_id($contextid);
583         $capability = has_capability('repository/'.$instance->type.':view', $context);
584         if (!$capability) {
585             throw new repository_exception('nopermissiontoaccess', 'repository');
586         }
587     }
589     /**
590      * Return all types that you a user can create/edit and which are also visible
591      * Note: Mostly used in order to know if at least one editable type can be set
592      * @param object $context the context for which we want the editable types
593      * @return array types
594      */
595     public static function get_editable_types($context = null) {
597         if (empty($context)) {
598             $context = get_system_context();
599         }
601         $types= repository::get_types(true);
602         $editabletypes = array();
603         foreach ($types as $type) {
604             $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
605             if (!empty($instanceoptionnames)) {
606                 if ($type->get_contextvisibility($context)) {
607                     $editabletypes[]=$type;
608                 }
609              }
610         }
611         return $editabletypes;
612     }
614     /**
615      * Return repository instances
616      * @global object $DB
617      * @global object $CFG
618      * @global object $USER
619      *
620      * @param array $args Array containing the following keys:
621      *           currentcontext
622      *           context
623      *           onlyvisible
624      *           type
625      *           accepted_types
626      *           return_types
627      *           userid
628      *
629      * @return array repository instances
630      */
631     public static function get_instances($args = array()) {
632         global $DB, $CFG, $USER;
634         if (isset($args['currentcontext'])) {
635             $current_context = $args['currentcontext'];
636         } else {
637             $current_context = null;
638         }
640         if (!empty($args['context'])) {
641             $contexts = $args['context'];
642         } else {
643             $contexts = array();
644         }
646         $onlyvisible = isset($args['onlyvisible']) ? $args['onlyvisible'] : true;
647         $returntypes = isset($args['return_types']) ? $args['return_types'] : 3;
648         $type        = isset($args['type']) ? $args['type'] : null;
650         $params = array();
651         $sql = "SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible
652                   FROM {repository} r, {repository_instances} i
653                  WHERE i.typeid = r.id ";
655         if (!empty($args['disable_types']) && is_array($args['disable_types'])) {
656             list($types, $p) = $DB->get_in_or_equal($args['disable_types'], SQL_PARAMS_QM, 'param0000', false);
657             $sql .= " AND r.type $types";
658             $params = array_merge($params, $p);
659         }
661         if (!empty($args['userid']) && is_numeric($args['userid'])) {
662             $sql .= " AND (i.userid = 0 or i.userid = ?)";
663             $params[] = $args['userid'];
664         }
666         foreach ($contexts as $context) {
667             if (empty($firstcontext)) {
668                 $firstcontext = true;
669                 $sql .= " AND ((i.contextid = ?)";
670             } else {
671                 $sql .= " OR (i.contextid = ?)";
672             }
673             $params[] = $context->id;
674         }
676         if (!empty($firstcontext)) {
677            $sql .=')';
678         }
680         if ($onlyvisible == true) {
681             $sql .= " AND (r.visible = 1)";
682         }
684         if (isset($type)) {
685             $sql .= " AND (r.type = ?)";
686             $params[] = $type;
687         }
688         $sql .= " ORDER BY r.sortorder, i.name";
690         if (!$records = $DB->get_records_sql($sql, $params)) {
691             $records = array();
692         }
694         $repositories = array();
695         $ft = new filetype_parser();
696         if (isset($args['accepted_types'])) {
697             $accepted_types = $args['accepted_types'];
698         } else {
699             $accepted_types = '*';
700         }
701         foreach ($records as $record) {
702             if (!file_exists($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php')) {
703                 continue;
704             }
705             require_once($CFG->dirroot . '/repository/'. $record->repositorytype.'/lib.php');
706             $options['visible'] = $record->visible;
707             $options['type']    = $record->repositorytype;
708             $options['typeid']  = $record->typeid;
709             // tell instance what file types will be accepted by file picker
710             $classname = 'repository_' . $record->repositorytype;
712             $repository = new $classname($record->id, $record->contextid, $options, $record->readonly);
714             $is_supported = true;
716             if (empty($repository->super_called)) {
717                 // to make sure the super construct is called
718                 debugging('parent::__construct must be called by '.$record->repositorytype.' plugin.');
719             } else {
720                 // check mimetypes
721                 if ($accepted_types !== '*' and $repository->supported_filetypes() !== '*') {
722                     $accepted_types = $ft->get_extensions($accepted_types);
723                     $supported_filetypes = $ft->get_extensions($repository->supported_filetypes());
725                     $is_supported = false;
726                     foreach  ($supported_filetypes as $type) {
727                         if (in_array($type, $accepted_types)) {
728                             $is_supported = true;
729                         }
730                     }
732                 }
733                 // check return values
734                 if ($returntypes !== 3 and $repository->supported_returntypes() !== 3) {
735                     $type = $repository->supported_returntypes();
736                     if ($type & $returntypes) {
737                         //
738                     } else {
739                         $is_supported = false;
740                     }
741                 }
742                 if (!$onlyvisible || ($repository->is_visible() && !$repository->disabled)) {
743                     // check capability in current context
744                     if (!empty($current_context)) {
745                         $capability = has_capability('repository/'.$record->repositorytype.':view', $current_context);
746                     } else {
747                         $capability = has_capability('repository/'.$record->repositorytype.':view', get_system_context());
748                     }
749                     if ($is_supported && $capability) {
750                         $repositories[$repository->id] = $repository;
751                     }
752                 }
753             }
754         }
755         return $repositories;
756     }
758     /**
759      * Get single repository instance
760      * @global object $DB
761      * @global object $CFG
762      * @param integer $id repository id
763      * @return object repository instance
764      */
765     public static function get_instance($id) {
766         global $DB, $CFG;
767         $sql = "SELECT i.*, r.type AS repositorytype, r.visible
768                   FROM {repository} r
769                   JOIN {repository_instances} i ON i.typeid = r.id
770                  WHERE i.id = ?";
772         if (!$instance = $DB->get_record_sql($sql, array($id))) {
773             return false;
774         }
775         require_once($CFG->dirroot . '/repository/'. $instance->repositorytype.'/lib.php');
776         $classname = 'repository_' . $instance->repositorytype;
777         $options['typeid'] = $instance->typeid;
778         $options['type']   = $instance->repositorytype;
779         $options['name']   = $instance->name;
780         $obj = new $classname($instance->id, $instance->contextid, $options, $instance->readonly);
781         if (empty($obj->super_called)) {
782             debugging('parent::__construct must be called by '.$classname.' plugin.');
783         }
784         return $obj;
785     }
787     /**
788      * Call a static function. Any additional arguments than plugin and function will be passed through.
789      * @global object $CFG
790      * @param string $plugin
791      * @param string $function
792      * @return mixed
793      */
794     public static function static_function($plugin, $function) {
795         global $CFG;
797         //check that the plugin exists
798         $typedirectory = $CFG->dirroot . '/repository/'. $plugin . '/lib.php';
799         if (!file_exists($typedirectory)) {
800             //throw new repository_exception('invalidplugin', 'repository');
801             return false;
802         }
804         $pname = null;
805         if (is_object($plugin) || is_array($plugin)) {
806             $plugin = (object)$plugin;
807             $pname = $plugin->name;
808         } else {
809             $pname = $plugin;
810         }
812         $args = func_get_args();
813         if (count($args) <= 2) {
814             $args = array();
815         } else {
816             array_shift($args);
817             array_shift($args);
818         }
820         require_once($typedirectory);
821         return call_user_func_array(array('repository_' . $plugin, $function), $args);
822     }
824     /**
825      * Move file from download folder to file pool using FILE API
826      * @global object $DB
827      * @global object $CFG
828      * @global object $USER
829      * @global object $OUTPUT
830      * @param string $thefile file path in download folder
831      * @param object $record
832      * @return array containing the following keys:
833      *           icon
834      *           file
835      *           id
836      *           url
837      */
838     public static function move_to_filepool($thefile, $record) {
839         global $DB, $CFG, $USER, $OUTPUT;
840         if ($record->filepath !== '/') {
841             $record->filepath = trim($record->filepath, '/');
842             $record->filepath = '/'.$record->filepath.'/';
843         }
844         $context = get_context_instance(CONTEXT_USER, $USER->id);
845         $now = time();
847         $record->contextid = $context->id;
848         $record->component = 'user';
849         $record->filearea  = 'draft';
850         $record->timecreated  = $now;
851         $record->timemodified = $now;
852         $record->userid       = $USER->id;
853         $record->mimetype     = mimeinfo('type', $thefile);
854         if(!is_numeric($record->itemid)) {
855             $record->itemid = 0;
856         }
857         $fs = get_file_storage();
858         if ($existingfile = $fs->get_file($context->id, $record->component, $record->filearea, $record->itemid, $record->filepath, $record->filename)) {
859             throw new moodle_exception('fileexists');
860         }
861         if ($file = $fs->create_file_from_pathname($record, $thefile)) {
862             if (empty($CFG->repository_no_delete)) {
863                 $delete = unlink($thefile);
864                 unset($CFG->repository_no_delete);
865             }
866             return array(
867                 'url'=>moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename())->out(),
868                 'id'=>$file->get_itemid(),
869                 'file'=>$file->get_filename(),
870                 'icon' => $OUTPUT->pix_url(file_extension_icon($thefile, 32))->out(),
871             );
872         } else {
873             return null;
874         }
875     }
877     /**
878      * Builds a tree of files This function is
879      * then called recursively.
880      *
881      * @param $fileinfo an object returned by file_browser::get_file_info()
882      * @param $search searched string
883      * @param $dynamicmode bool no recursive call is done when in dynamic mode
884      * @param $list - the array containing the files under the passed $fileinfo
885      * @returns int the number of files found
886      *
887      * todo: take $search into account, and respect a threshold for dynamic loading
888      */
889     public static function build_tree($fileinfo, $search, $dynamicmode, &$list) {
890         global $CFG, $OUTPUT;
892         $filecount = 0;
893         $children = $fileinfo->get_children();
895         foreach ($children as $child) {
896             $filename = $child->get_visible_name();
897             $filesize = $child->get_filesize();
898             $filesize = $filesize ? display_size($filesize) : '';
899             $filedate = $child->get_timemodified();
900             $filedate = $filedate ? userdate($filedate) : '';
901             $filetype = $child->get_mimetype();
903             if ($child->is_directory()) {
904                 $path = array();
905                 $level = $child->get_parent();
906                 while ($level) {
907                     $params = $level->get_params();
908                     $path[] = array($params['filepath'], $level->get_visible_name());
909                     $level = $level->get_parent();
910                 }
912                 $tmp = array(
913                     'title' => $child->get_visible_name(),
914                     'size' => 0,
915                     'date' => $filedate,
916                     'path' => array_reverse($path),
917                     'thumbnail' => $OUTPUT->pix_url('f/folder-32')
918                 );
920                 //if ($dynamicmode && $child->is_writable()) {
921                 //    $tmp['children'] = array();
922                 //} else {
923                     // if folder name matches search, we send back all files contained.
924                 $_search = $search;
925                 if ($search && stristr($tmp['title'], $search) !== false) {
926                     $_search = false;
927                 }
928                 $tmp['children'] = array();
929                 $_filecount = repository::build_tree($child, $_search, $dynamicmode, $tmp['children']);
930                 if ($search && $_filecount) {
931                     $tmp['expanded'] = 1;
932                 }
934                 //}
936                 if (!$search || $_filecount || (stristr($tmp['title'], $search) !== false)) {
937                     $filecount += $_filecount;
938                     $list[] = $tmp;
939                 }
941             } else { // not a directory
942                 // skip the file, if we're in search mode and it's not a match
943                 if ($search && (stristr($filename, $search) === false)) {
944                     continue;
945                 }
946                 $params = $child->get_params();
947                 $source = serialize(array($params['contextid'], $params['component'], $params['filearea'], $params['itemid'], $params['filepath'], $params['filename']));
948                 $list[] = array(
949                     'title' => $filename,
950                     'size' => $filesize,
951                     'date' => $filedate,
952                     //'source' => $child->get_url(),
953                     'source' => base64_encode($source),
954                     'thumbnail'=>$OUTPUT->pix_url(file_extension_icon($filename, 32)),
955                 );
956                 $filecount++;
957             }
958         }
960         return $filecount;
961     }
964     /**
965      * Display a repository instance list (with edit/delete/create links)
966      * @global object $CFG
967      * @global object $USER
968      * @global object $OUTPUT
969      * @param object $context the context for which we display the instance
970      * @param string $typename if set, we display only one type of instance
971      */
972     public static function display_instances_list($context, $typename = null) {
973         global $CFG, $USER, $OUTPUT;
975         $output = $OUTPUT->box_start('generalbox');
976         //if the context is SYSTEM, so we call it from administration page
977         $admin = ($context->id == SYSCONTEXTID) ? true : false;
978         if ($admin) {
979             $baseurl = new moodle_url('/'.$CFG->admin.'/repositoryinstance.php', array('sesskey'=>sesskey()));
980             $output .= $OUTPUT->heading(get_string('siteinstances', 'repository'));
981         } else {
982             $baseurl = new moodle_url('/repository/manage_instances.php', array('contextid'=>$context->id, 'sesskey'=>sesskey()));
983         }
984         $url = $baseurl;
986         $namestr = get_string('name');
987         $pluginstr = get_string('plugin', 'repository');
988         $settingsstr = get_string('settings');
989         $deletestr = get_string('delete');
990         //retrieve list of instances. In administration context we want to display all
991         //instances of a type, even if this type is not visible. In course/user context we
992         //want to display only visible instances, but for every type types. The repository::get_instances()
993         //third parameter displays only visible type.
994         $params = array();
995         $params['context'] = array($context, get_system_context());
996         $params['currentcontext'] = $context;
997         $params['onlyvisible'] = !$admin;
998         $params['type']        = $typename;
999         $instances = repository::get_instances($params);
1000         $instancesnumber = count($instances);
1001         $alreadyplugins = array();
1003         $table = new html_table();
1004         $table->head = array($namestr, $pluginstr, $settingsstr, $deletestr);
1005         $table->align = array('left', 'left', 'center','center');
1006         $table->data = array();
1008         $updowncount = 1;
1010         foreach ($instances as $i) {
1011             $settings = '';
1012             $delete = '';
1014             $type = repository::get_type_by_id($i->options['typeid']);
1016             if ($type->get_contextvisibility($context)) {
1017                 if (!$i->readonly) {
1019                     $url->param('type', $i->options['type']);
1020                     $url->param('edit', $i->id);
1021                     $settings .= html_writer::link($url, $settingsstr);
1023                     $url->remove_params('edit');
1024                     $url->param('delete', $i->id);
1025                     $delete .= html_writer::link($url, $deletestr);
1027                     $url->remove_params('type');
1028                 }
1029             }
1031             $type = repository::get_type_by_id($i->options['typeid']);
1032             $table->data[] = array($i->name, $type->get_readablename(), $settings, $delete);
1034             //display a grey row if the type is defined as not visible
1035             if (isset($type) && !$type->get_visible()) {
1036                 $table->rowclasses[] = 'dimmed_text';
1037             } else {
1038                 $table->rowclasses[] = '';
1039             }
1041             if (!in_array($i->name, $alreadyplugins)) {
1042                 $alreadyplugins[] = $i->name;
1043             }
1044         }
1045         $output .= html_writer::table($table);
1046         $instancehtml = '<div>';
1047         $addable = 0;
1049         //if no type is set, we can create all type of instance
1050         if (!$typename) {
1051             $instancehtml .= '<h3>';
1052             $instancehtml .= get_string('createrepository', 'repository');
1053             $instancehtml .= '</h3><ul>';
1054             $types = repository::get_editable_types($context);
1055             foreach ($types as $type) {
1056                 if (!empty($type) && $type->get_visible()) {
1057                     $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
1058                     if (!empty($instanceoptionnames)) {
1059                         $baseurl->param('new', $type->get_typename());
1060                         $instancehtml .= '<li><a href="'.$baseurl->out().'">'.get_string('createxxinstance', 'repository', get_string('pluginname', 'repository_'.$type->get_typename())).  '</a></li>';
1061                         $baseurl->remove_params('new');
1062                         $addable++;
1063                     }
1064                 }
1065             }
1066             $instancehtml .= '</ul>';
1068         } else {
1069             $instanceoptionnames = repository::static_function($typename, 'get_instance_option_names');
1070             if (!empty($instanceoptionnames)) {   //create a unique type of instance
1071                 $addable = 1;
1072                 $baseurl->param('new', $typename);
1073                 $instancehtml .= "<form action='".$baseurl->out()."' method='post'>
1074                     <p><input type='submit' value='".get_string('createinstance', 'repository')."'/></p>
1075                     </form>";
1076                 $baseurl->remove_params('new');
1077             }
1078         }
1080         if ($addable) {
1081             $instancehtml .= '</div>';
1082             $output .= $instancehtml;
1083         }
1085         $output .= $OUTPUT->box_end();
1087         //print the list + creation links
1088         print($output);
1089     }
1091     /**
1092      * Decide where to save the file, can be overwriten by subclass
1093      * @param string filename
1094      */
1095     public function prepare_file($filename) {
1096         global $CFG;
1097         if (!file_exists($CFG->dataroot.'/temp/download')) {
1098             mkdir($CFG->dataroot.'/temp/download/', $CFG->directorypermissions, true);
1099         }
1100         if (is_dir($CFG->dataroot.'/temp/download')) {
1101             $dir = $CFG->dataroot.'/temp/download/';
1102         }
1103         if (empty($filename)) {
1104             $filename = uniqid('repo').'_'.time().'.tmp';
1105         }
1106         if (file_exists($dir.$filename)) {
1107             $filename = uniqid('m').$filename;
1108         }
1109         return $dir.$filename;
1110     }
1112     /**
1113      * Return file URL, for most plugins, the parameter is the original
1114      * url, but some plugins use a file id, so we need this function to
1115      * convert file id to original url.
1116      *
1117      * @param string $url the url of file
1118      * @return string
1119      */
1120     public function get_link($url) {
1121         return $url;
1122     }
1124     /**
1125      * Download a file, this function can be overridden by
1126      * subclass.
1127      *
1128      * @global object $CFG
1129      * @param string $url the url of file
1130      * @param string $filename save location
1131      * @return string the location of the file
1132      * @see curl package
1133      */
1134     public function get_file($url, $filename = '') {
1135         global $CFG;
1136         $path = $this->prepare_file($filename);
1137         $fp = fopen($path, 'w');
1138         $c = new curl;
1139         $c->download(array(array('url'=>$url, 'file'=>$fp)));
1140         return array('path'=>$path, 'url'=>$url);
1141     }
1143     /**
1144      * Return is the instance is visible
1145      * (is the type visible ? is the context enable ?)
1146      * @return boolean
1147      */
1148     public function is_visible() {
1149         $type = repository::get_type_by_id($this->options['typeid']);
1150         $instanceoptions = repository::static_function($type->get_typename(), 'get_instance_option_names');
1152         if ($type->get_visible()) {
1153             //if the instance is unique so it's visible, otherwise check if the instance has a enabled context
1154             if (empty($instanceoptions) || $type->get_contextvisibility($this->context)) {
1155                 return true;
1156             }
1157         }
1159         return false;
1160     }
1162     /**
1163      * Return the name of this instance, can be overridden.
1164      * @global object $DB
1165      * @return string
1166      */
1167     public function get_name() {
1168         global $DB;
1169         if ( $name = $this->instance->name ) {
1170             return $name;
1171         } else {
1172             return get_string('pluginname', 'repository_' . $this->options['type']);
1173         }
1174     }
1176     /**
1177      * what kind of files will be in this repository?
1178      * @return array return '*' means this repository support any files, otherwise
1179      *               return mimetypes of files, it can be an array
1180      */
1181     public function supported_filetypes() {
1182         // return array('text/plain', 'image/gif');
1183         return '*';
1184     }
1186     /**
1187      * does it return a file url or a item_id
1188      * @return string
1189      */
1190     public function supported_returntypes() {
1191         return (FILE_INTERNAL | FILE_EXTERNAL);
1192     }
1194     /**
1195      * Provide repository instance information for Ajax
1196      * @global object $CFG
1197      * @return object
1198      */
1199     final public function get_meta() {
1200         global $CFG, $OUTPUT;
1201         $ft = new filetype_parser;
1202         $meta = new stdclass;
1203         $meta->id   = $this->id;
1204         $meta->name = $this->get_name();
1205         $meta->type = $this->options['type'];
1206         $meta->icon = $OUTPUT->pix_url('icon', 'repository_'.$meta->type)->out(false);
1207         $meta->supported_types = $ft->get_extensions($this->supported_filetypes());
1208         $meta->return_types = $this->supported_returntypes();
1209         return $meta;
1210     }
1212     /**
1213      * Create an instance for this plug-in
1214      * @global object $CFG
1215      * @global object $DB
1216      * @param string $type the type of the repository
1217      * @param integer $userid the user id
1218      * @param object $context the context
1219      * @param array $params the options for this instance
1220      * @param integer $readonly whether to create it readonly or not (defaults to not)
1221      * @return mixed
1222      */
1223     public static function create($type, $userid, $context, $params, $readonly=0) {
1224         global $CFG, $DB;
1225         $params = (array)$params;
1226         require_once($CFG->dirroot . '/repository/'. $type . '/lib.php');
1227         $classname = 'repository_' . $type;
1228         if ($repo = $DB->get_record('repository', array('type'=>$type))) {
1229             $record = new stdclass;
1230             $record->name = $params['name'];
1231             $record->typeid = $repo->id;
1232             $record->timecreated  = time();
1233             $record->timemodified = time();
1234             $record->contextid = $context->id;
1235             $record->readonly = $readonly;
1236             $record->userid    = $userid;
1237             $id = $DB->insert_record('repository_instances', $record);
1238             $options = array();
1239             $configs = call_user_func($classname . '::get_instance_option_names');
1240             if (!empty($configs)) {
1241                 foreach ($configs as $config) {
1242                     $options[$config] = $params[$config];
1243                 }
1244             }
1246             if (!empty($id)) {
1247                 unset($options['name']);
1248                 $instance = repository::get_instance($id);
1249                 $instance->set_option($options);
1250                 return $id;
1251             } else {
1252                 return null;
1253             }
1254         } else {
1255             return null;
1256         }
1257     }
1259     /**
1260      * delete a repository instance
1261      * @global object $DB
1262      * @return mixed
1263      */
1264     final public function delete() {
1265         global $DB;
1266         $DB->delete_records('repository_instances', array('id'=>$this->id));
1267         $DB->delete_records('repository_instance_config', array('instanceid'=>$this->id));
1268         return true;
1269     }
1271     /**
1272      * Hide/Show a repository
1273      * @global object $DB
1274      * @param string $hide
1275      * @return boolean
1276      */
1277     final public function hide($hide = 'toggle') {
1278         global $DB;
1279         if ($entry = $DB->get_record('repository', array('id'=>$this->id))) {
1280             if ($hide === 'toggle' ) {
1281                 if (!empty($entry->visible)) {
1282                     $entry->visible = 0;
1283                 } else {
1284                     $entry->visible = 1;
1285                 }
1286             } else {
1287                 if (!empty($hide)) {
1288                     $entry->visible = 0;
1289                 } else {
1290                     $entry->visible = 1;
1291                 }
1292             }
1293             return $DB->update_record('repository', $entry);
1294         }
1295         return false;
1296     }
1298     /**
1299      * Save settings for repository instance
1300      * $repo->set_option(array('api_key'=>'f2188bde132', 'name'=>'dongsheng'));
1301      * @global object $DB
1302      * @param array $options settings
1303      * @return int Id of the record
1304      */
1305     public function set_option($options = array()) {
1306         global $DB;
1308         if (!empty($options['name'])) {
1309             $r = new object();
1310             $r->id   = $this->id;
1311             $r->name = $options['name'];
1312             $DB->update_record('repository_instances', $r);
1313             unset($options['name']);
1314         }
1315         $result = true;
1316         foreach ($options as $name=>$value) {
1317             if ($id = $DB->get_field('repository_instance_config', 'id', array('name'=>$name, 'instanceid'=>$this->id))) {
1318                 $result = $result && $DB->set_field('repository_instance_config', 'value', $value, array('id'=>$id));
1319             } else {
1320                 $config = new object();
1321                 $config->instanceid = $this->id;
1322                 $config->name   = $name;
1323                 $config->value  = $value;
1324                 $result = $result && $DB->insert_record('repository_instance_config', $config);
1325             }
1326         }
1327         return $result;
1328     }
1330     /**
1331      * Get settings for repository instance
1332      * @global object $DB
1333      * @param string $config
1334      * @return array Settings
1335      */
1336     public function get_option($config = '') {
1337         global $DB;
1338         $entries = $DB->get_records('repository_instance_config', array('instanceid'=>$this->id));
1339         $ret = array();
1340         if (empty($entries)) {
1341             return $ret;
1342         }
1343         foreach($entries as $entry) {
1344             $ret[$entry->name] = $entry->value;
1345         }
1346         if (!empty($config)) {
1347                 return $ret[$config];
1348         } else {
1349             return $ret;
1350         }
1351     }
1353     public function filter(&$value) {
1354         $pass = false;
1355         $accepted_types = optional_param('accepted_types', '', PARAM_RAW);
1356         $ft = new filetype_parser;
1357         //$ext = $ft->get_extensions($this->supported_filetypes());
1358         if (isset($value['children'])) {
1359             $pass = true;
1360             if (!empty($value['children'])) {
1361                 $value['children'] = array_filter($value['children'], array($this, 'filter'));
1362             }
1363         } else {
1364             if ($accepted_types == '*' or empty($accepted_types)
1365                 or (is_array($accepted_types) and in_array('*', $accepted_types))) {
1366                 $pass = true;
1367             } elseif (is_array($accepted_types)) {
1368                 foreach ($accepted_types as $type) {
1369                     $extensions = $ft->get_extensions($type);
1370                     if (!is_array($extensions)) {
1371                         $pass = true;
1372                     } else {
1373                         foreach ($extensions as $ext) {
1374                             if (preg_match('#'.$ext.'$#', $value['title'])) {
1375                                 $pass = true;
1376                             }
1377                         }
1378                     }
1379                 }
1380             }
1381         }
1382         return $pass;
1383     }
1385     /**
1386      * Given a path, and perhaps a search, get a list of files.
1387      *
1388      * See details on http://docs.moodle.org/en/Development:Repository_plugins
1389      *
1390      * @param string $path, this parameter can
1391      * a folder name, or a identification of folder
1392      * @param string $page, the page number of file list
1393      * @return array the list of files, including meta infomation, containing the following keys
1394      *           manage, url to manage url
1395      *           client_id
1396      *           login, login form
1397      *           repo_id, active repository id
1398      *           login_btn_action, the login button action
1399      *           login_btn_label, the login button label
1400      *           total, number of results
1401      *           perpage, items per page
1402      *           page
1403      *           pages, total pages
1404      *           search_result, is it a search result?
1405      *           list, file list
1406      *           path, current path and parent path
1407      */
1408     public function get_listing($path = '', $page = '') {
1409     }
1411     /**
1412      * Search files in repository
1413      * When doing global search, $search_text will be used as
1414      * keyword.
1415      *
1416      * @return mixed, see get_listing()
1417      */
1418     public function search($search_text) {
1419         $list = array();
1420         $list['list'] = array();
1421         return false;
1422     }
1424     /**
1425      * Logout from repository instance
1426      * By default, this function will return a login form
1427      *
1428      * @return string
1429      */
1430     public function logout(){
1431         return $this->print_login();
1432     }
1434     /**
1435      * To check whether the user is logged in.
1436      *
1437      * @return boolean
1438      */
1439     public function check_login(){
1440         return true;
1441     }
1444     /**
1445      * Show the login screen, if required
1446      */
1447     public function print_login(){
1448         return $this->get_listing();
1449     }
1451     /**
1452      * Show the search screen, if required
1453      * @return null
1454      */
1455     public function print_search() {
1456         $str = '';
1457         $str .= '<input type="hidden" name="repo_id" value="'.$this->id.'" />';
1458         $str .= '<input type="hidden" name="ctx_id" value="'.$this->context->id.'" />';
1459         $str .= '<input type="hidden" name="seekey" value="'.sesskey().'" />';
1460         $str .= '<label>'.get_string('keyword', 'repository').': </label><br/><input name="s" value="" /><br/>';
1461         return $str;
1462     }
1464     /**
1465      * For oauth like external authentication, when external repository direct user back to moodle,
1466      * this funciton will be called to set up token and token_secret
1467      */
1468     public function callback() {
1469     }
1471     /**
1472      * is it possible to do glboal search?
1473      * @return boolean
1474      */
1475     public function global_search() {
1476         return false;
1477     }
1479     /**
1480      * Defines operations that happen occasionally on cron
1481      * @return boolean
1482      */
1483     public function cron() {
1484         return true;
1485     }
1487     /**
1488      * function which is run when the type is created (moodle administrator add the plugin)
1489      * @return boolean success or fail?
1490      */
1491     public static function plugin_init() {
1492         return true;
1493     }
1495     /**
1496      * Edit/Create Admin Settings Moodle form
1497      * @param object $mform Moodle form (passed by reference)
1498      * @param string $classname repository class name
1499      */
1500     public function type_config_form($mform, $classname = 'repository') {
1501         $instnaceoptions = call_user_func(array($classname, 'get_instance_option_names'), $mform, $classname);
1502         if (empty($instnaceoptions)) {
1503             // this plugin has only one instance
1504             // so we need to give it a name
1505             // it can be empty, then moodle will look for instance name from language string
1506             $mform->addElement('text', 'pluginname', get_string('pluginname', 'repository'), array('size' => '40'));
1507             $mform->addElement('static', 'pluginnamehelp', '', get_string('pluginnamehelp', 'repository'));
1508         }
1509     }
1511     /**
1512      * Edit/Create Instance Settings Moodle form
1513      * @param object $mform Moodle form (passed by reference)
1514      */
1515     public function instance_config_form($mform) {
1516     }
1518     /**
1519      * Return names of the general options
1520      * By default: no general option name
1521      * @return array
1522      */
1523     public static function get_type_option_names() {
1524         return array('pluginname');
1525     }
1527     /**
1528      * Return names of the instance options
1529      * By default: no instance option name
1530      * @return array
1531      */
1532     public static function get_instance_option_names() {
1533         return array();
1534     }
1536     public static function instance_form_validation($mform, $data, $errors) {
1537         return $errors;
1538     }
1540     public function get_short_filename($str, $maxlength) {
1541         if (strlen($str) >= $maxlength) {
1542             return trim(substr($str, 0, $maxlength)).'...';
1543         } else {
1544             return $str;
1545         }
1546     }
1549 /**
1550  * Exception class for repository api
1551  *
1552  * @since 2.0
1553  * @package moodlecore
1554  * @subpackage repository
1555  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
1556  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1557  */
1558 class repository_exception extends moodle_exception {
1561 /**
1562  * This is a class used to define a repository instance form
1563  *
1564  * @since 2.0
1565  * @package moodlecore
1566  * @subpackage repository
1567  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
1568  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1569  */
1570 final class repository_instance_form extends moodleform {
1571     protected $instance;
1572     protected $plugin;
1573     protected function add_defaults() {
1574         $mform =& $this->_form;
1575         $strrequired = get_string('required');
1577         $mform->addElement('hidden', 'edit',  ($this->instance) ? $this->instance->id : 0);
1578         $mform->setType('edit', PARAM_INT);
1579         $mform->addElement('hidden', 'new',   $this->plugin);
1580         $mform->setType('new', PARAM_FORMAT);
1581         $mform->addElement('hidden', 'plugin', $this->plugin);
1582         $mform->setType('plugin', PARAM_SAFEDIR);
1583         $mform->addElement('hidden', 'typeid', $this->typeid);
1584         $mform->setType('typeid', PARAM_INT);
1585         $mform->addElement('hidden', 'contextid', $this->contextid);
1586         $mform->setType('contextid', PARAM_INT);
1588         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
1589         $mform->addRule('name', $strrequired, 'required', null, 'client');
1590     }
1592     public function definition() {
1593         global $CFG;
1594         // type of plugin, string
1595         $this->plugin = $this->_customdata['plugin'];
1596         $this->typeid = $this->_customdata['typeid'];
1597         $this->contextid = $this->_customdata['contextid'];
1598         $this->instance = (isset($this->_customdata['instance'])
1599                 && is_subclass_of($this->_customdata['instance'], 'repository'))
1600             ? $this->_customdata['instance'] : null;
1602         $mform =& $this->_form;
1604         $this->add_defaults();
1605         //add fields
1606         if (!$this->instance) {
1607             $result = repository::static_function($this->plugin, 'instance_config_form', $mform);
1608             if ($result === false) {
1609                 $mform->removeElement('name');
1610             }
1611         } else {
1612             $data = array();
1613             $data['name'] = $this->instance->name;
1614             if (!$this->instance->readonly) {
1615                 $result = $this->instance->instance_config_form($mform);
1616                 if ($result === false) {
1617                     $mform->removeElement('name');
1618                 }
1619                 // and set the data if we have some.
1620                 foreach ($this->instance->get_instance_option_names() as $config) {
1621                     if (!empty($this->instance->options[$config])) {
1622                         $data[$config] = $this->instance->options[$config];
1623                      } else {
1624                         $data[$config] = '';
1625                      }
1626                 }
1627             }
1628             $this->set_data($data);
1629         }
1631         if ($result === false) {
1632             $mform->addElement('cancel');
1633         } else {
1634             $this->add_action_buttons(true, get_string('save','repository'));
1635         }
1636     }
1638     public function validation($data) {
1639         global $DB;
1640         $errors = array();
1641         $plugin = $this->_customdata['plugin'];
1642         $instance = (isset($this->_customdata['instance'])
1643                 && is_subclass_of($this->_customdata['instance'], 'repository'))
1644             ? $this->_customdata['instance'] : null;
1645         if (!$instance) {
1646             $errors = repository::static_function($plugin, 'instance_form_validation', $this, $data, $errors);
1647         } else {
1648             $errors = $instance->instance_form_validation($this, $data, $errors);
1649         }
1651         $sql = "SELECT count('x')
1652                   FROM {repository_instances} i, {repository} r
1653                  WHERE r.type=:plugin AND r.id=i.typeid AND i.name=:name";
1654         if ($DB->count_records_sql($sql, array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
1655             $errors['name'] = get_string('erroruniquename', 'repository');
1656         }
1658         return $errors;
1659     }
1662 /**
1663  * This is a class used to define a repository type setting form
1664  *
1665  * @since 2.0
1666  * @package moodlecore
1667  * @subpackage repository
1668  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
1669  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1670  */
1671 final class repository_type_form extends moodleform {
1672     protected $instance;
1673     protected $plugin;
1674     protected $action;
1676     /**
1677      * Definition of the moodleform
1678      * @global object $CFG
1679      */
1680     public function definition() {
1681         global $CFG;
1682         // type of plugin, string
1683         $this->plugin = $this->_customdata['plugin'];
1684         $this->instance = (isset($this->_customdata['instance'])
1685                 && is_a($this->_customdata['instance'], 'repository_type'))
1686             ? $this->_customdata['instance'] : null;
1688         $this->action = $this->_customdata['action'];
1689         $this->pluginname = $this->_customdata['pluginname'];
1690         $mform =& $this->_form;
1691         $strrequired = get_string('required');
1693         $mform->addElement('hidden', 'action', $this->action);
1694         $mform->setType('action', PARAM_TEXT);
1695         $mform->addElement('hidden', 'repos', $this->plugin);
1696         $mform->setType('repos', PARAM_SAFEDIR);
1698         // let the plugin add its specific fields
1699         $classname = 'repository_' . $this->plugin;
1700         require_once($CFG->dirroot . '/repository/' . $this->plugin . '/lib.php');
1701         //add "enable course/user instances" checkboxes if multiple instances are allowed
1702         $instanceoptionnames = repository::static_function($this->plugin, 'get_instance_option_names');
1704         $result = call_user_func(array($classname, 'type_config_form'), $mform, $classname);
1706         if (!empty($instanceoptionnames)) {
1707             $sm = get_string_manager();
1708             $component = 'repository';
1709             if ($sm->string_exists('enablecourseinstances', 'repository_' . $this->plugin)) {
1710                 $component .= ('_' . $this->plugin);
1711             }
1712             $mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', $component));
1714             $component = 'repository';
1715             if ($sm->string_exists('enableuserinstances', 'repository_' . $this->plugin)) {
1716                 $component .= ('_' . $this->plugin);
1717             }
1718             $mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', $component));
1719         }
1721         // set the data if we have some.
1722         if ($this->instance) {
1723             $data = array();
1724             $option_names = call_user_func(array($classname,'get_type_option_names'));
1725             if (!empty($instanceoptionnames)){
1726                 $option_names[] = 'enablecourseinstances';
1727                 $option_names[] = 'enableuserinstances';
1728             }
1730             $instanceoptions = $this->instance->get_options();
1731             foreach ($option_names as $config) {
1732                 if (!empty($instanceoptions[$config])) {
1733                     $data[$config] = $instanceoptions[$config];
1734                 } else {
1735                     $data[$config] = '';
1736                 }
1737             }
1738             // XXX: set plugin name for plugins which doesn't have muliti instances
1739             if (empty($instanceoptionnames)){
1740                 $data['pluginname'] = $this->pluginname;
1741             }
1742             $this->set_data($data);
1743         }
1745         $this->add_action_buttons(true, get_string('save','repository'));
1746     }
1749 /**
1750  * Generate all options needed by filepicker
1751  *
1752  * @param array $args, including following keys
1753  *          context
1754  *          accepted_types
1755  *          return_types
1756  *
1757  * @return array the list of repository instances, including meta infomation, containing the following keys
1758  *          externallink
1759  *          repositories
1760  *          accepted_types
1761  */
1762 function initialise_filepicker($args) {
1763     global $CFG, $USER, $PAGE, $OUTPUT;
1764     require_once($CFG->libdir . '/licenselib.php');
1766     $return = new stdclass;
1767     $licenses = array();
1768     if (!empty($CFG->licenses)) {
1769         $array = explode(',', $CFG->licenses);
1770         foreach ($array as $license) {
1771             $l = new stdclass;
1772             $l->shortname = $license;
1773             $l->fullname = get_string($license, 'license');
1774             $licenses[] = $l;
1775         }
1776     }
1777     if (!empty($CFG->sitedefaultlicense)) {
1778         $return->defaultlicense = $CFG->sitedefaultlicense;
1779     }
1781     $return->licenses = $licenses;
1783     $return->author = fullname($USER);
1785     $ft = new filetype_parser();
1786     if (empty($args->context)) {
1787         $context = $PAGE->context;
1788     } else {
1789         $context = $args->context;
1790     }
1791     $disable_types = array();
1792     if (!empty($args->disable_types)) {
1793         $disable_types = $args->disable_types;
1794     }
1796     $user_context = get_context_instance(CONTEXT_USER, $USER->id);
1798     $externallink = (int)get_config(null, 'repositoryallowexternallinks');
1799     $repositories = repository::get_instances(array(
1800         'context'=>array($user_context, get_system_context()),
1801         'currentcontext'=> $context,
1802         'accepted_types'=>$args->accepted_types,
1803         'return_types'=>$args->return_types,
1804         'disable_types'=>$disable_types
1805     ));
1807     $return->repositories = array();
1809     if (empty($externallink)) {
1810         $return->externallink = false;
1811     } else {
1812         $return->externallink = true;
1813     }
1815     // provided by form element
1816     $return->accepted_types = $ft->get_extensions($args->accepted_types);
1817     $return->return_types = $args->return_types;
1818     foreach ($repositories as $repository) {
1819         $meta = $repository->get_meta();
1820         $return->repositories[$repository->id] = $meta;
1821     }
1822     return $return;