';
Index: lib/adminlib.php
===================================================================
RCS file: /cvsroot/moodle/moodle/lib/adminlib.php,v
retrieving revision 1.285
diff -u -a -r1.285 adminlib.php
--- lib/adminlib.php 13 Nov 2008 08:41:00 -0000 1.285
+++ lib/adminlib.php 13 Nov 2008 10:34:01 -0000
@@ -6012,7 +6012,7 @@
return true;
}
}
- foreach (repository_get_types() as $instance) {
+ foreach (repository::get_types() as $instance) {
$title = $instance->get_typename();
if (strpos($textlib->strtolower($title), $query) !== false) {
return true;
@@ -6030,7 +6030,7 @@
$hiddenstr = get_string('hiddenshow', 'repository');
$deletestr = get_string('delete');
$plugins = get_list_of_plugins('repository');
- $instances = repository_get_types();
+ $instances = repository::get_types();
$instancesnumber = count($instances);
$alreadyplugins = array();
$table = new StdClass;
@@ -6041,8 +6041,8 @@
foreach ($instances as $i) {
$settings = '';
//display edit link only if you can config the type or if it has multiple instances (e.g. has instance config)
- $typeoptionnames = repository_static_function($i->get_typename(), 'get_type_option_names');
- $instanceoptionnames = repository_static_function($i->get_typename(), 'get_instance_option_names');
+ $typeoptionnames = repository::static_function($i->get_typename(), 'get_type_option_names');
+ $instanceoptionnames = repository::static_function($i->get_typename(), 'get_instance_option_names');
if ( !empty($typeoptionnames) || !empty($instanceoptionnames)) {
$settings .= ''
. $settingsstr .'' . "\n";
Index: repository/javascript.php
===================================================================
RCS file: /cvsroot/moodle/moodle/repository/javascript.php,v
retrieving revision 1.24
diff -u -a -r1.24 javascript.php
--- repository/javascript.php 3 Nov 2008 04:44:53 -0000 1.24
+++ repository/javascript.php 13 Nov 2008 10:36:37 -0000
@@ -956,7 +965,7 @@
EOD;
$user_context = get_context_instance(CONTEXT_USER, $USER->id);
-$repos = repository_get_instances(array($user_context, $context, get_system_context()));
+$repos = repository::get_instances(array($user_context, $context, get_system_context()));
foreach ($repos as $repo) {
$js .= "\r\n";
$js .= 'repository_client_'.$suffix.'.repos.push('.json_encode($repo->ajax_info()).');'."\n";
Index: repository/lib.php
===================================================================
RCS file: /cvsroot/moodle/moodle/repository/lib.php,v
retrieving revision 1.141
diff -u -a -r1.141 lib.php
--- repository/lib.php 3 Nov 2008 04:44:53 -0000 1.141
+++ repository/lib.php 13 Nov 2008 10:36:37 -0000
@@ -103,7 +103,7 @@
* @return boolean
*/
public function get_contextvisibility($contextlevel) {
-
+
if ($contextlevel == CONTEXT_COURSE) {
return $this->_options['enablecourseinstances'];
}
@@ -115,7 +115,7 @@
//the context is SITE
return true;
}
-
+
/**
@@ -136,7 +136,7 @@
//set options attribut
$this->_options = array();
- $options = repository_static_function($typename,'get_type_option_names');
+ $options = repository::static_function($typename,'get_type_option_names');
//check that the type can be setup
if (!empty($options)) {
//set the type options
@@ -153,13 +153,13 @@
} else {
$this->_options['enablecourseinstances'] = 0;
}
-
+
if (array_key_exists('enableuserinstances',$typeoptions)) {
$this->_options['enableuserinstances'] = $typeoptions['enableuserinstances'];
} else {
$this->_options['enableuserinstances'] = 0;
}
-
+
}
/**
@@ -238,15 +238,15 @@
//if the plugin type has no multiple instance (e.g. has no instance option name) so it wont
//be possible for the administrator to create a instance
//in this case we need to create an instance
- $instanceoptionnames = repository_static_function($this->_typename, 'get_instance_option_names');
+ $instanceoptionnames = repository::static_function($this->_typename, 'get_instance_option_names');
if (empty($instanceoptionnames)) {
$instanceoptions = array();
$instanceoptions['name'] = $this->_typename;
- repository_static_function($this->_typename, 'create', $this->_typename, 0, get_system_context(), $instanceoptions);
+ repository::static_function($this->_typename, 'create', $this->_typename, 0, get_system_context(), $instanceoptions);
}
//run init function
- if (!repository_static_function($this->_typename, 'plugin_init')) {
+ if (!repository::static_function($this->_typename, 'plugin_init')) {
throw new repository_exception('cannotcreatetype', 'repository');
}
@@ -332,7 +332,7 @@
public function move_order($move) {
global $DB;
- $types = repository_get_types(); // retrieve all types
+ $types = repository::get_types(); // retrieve all types
/// retrieve this type into the returned array
$i = 0;
@@ -386,7 +386,7 @@
global $DB;
//delete all instances of this type
- $instances = repository_get_instances(array(),null,false,$this->_typename);
+ $instances = repository::get_instances(array(),null,false,$this->_typename);
foreach ($instances as $instance) {
$instance->delete();
}
@@ -401,94 +401,642 @@
}
/**
- * Return a type for a given type name.
- * @global object $DB
- * @param string $typename the type name
- * @return integer
+ * This is the base class of the repository class
+ *
+ * To use repository plugin, see:
+ * http://docs.moodle.org/en/Development:Repository_How_to_Create_Plugin
+ *
+ * class repository is an abstract class, some functions must be implemented in subclass.
+ *
+ * See an example: repository/boxnet/repository.class.php
+ *
+ * A few notes:
+ * // for ajax file picker, this will print a json string to tell file picker
+ * // how to build a login form
+ * $repo->print_login();
+ * // for ajax file picker, this will return a files list.
+ * $repo->get_listing();
+ * // this function will be used for non-javascript version.
+ * $repo->print_listing();
+ * // print a search box
+ * $repo->print_search();
+ *
+ * @package repository
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/
-function repository_get_type_by_typename($typename) {
- global $DB;
+abstract class repository {
+ // $disabled can be set to true to disable a plugin by force
+ // example: self::$disabled = true
+ public $disabled = false;
+ public $id;
+ public $context;
+ public $options;
+ public $readonly;
- if (!$record = $DB->get_record('repository',array('type' => $typename))) {
- return false;
+ /**
+ * Return a type for a given type name.
+ * @global object $DB
+ * @param string $typename the type name
+ * @return integer
+ */
+ public static function get_type_by_typename($typename) {
+ global $DB;
+
+ if (!$record = $DB->get_record('repository',array('type' => $typename))) {
+ return false;
+ }
+
+ return new repository_type($typename, (array)get_config($typename), $record->visible, $record->sortorder);
}
- return new repository_type($typename, (array)get_config($typename), $record->visible, $record->sortorder);
-}
+ /**
+ * Return a type for a given type id.
+ * @global object $DB
+ * @param string $typename the type name
+ * @return integer
+ */
+ public static function get_type_by_id($id) {
+ global $DB;
-/**
- * Return a type for a given type id.
- * @global object $DB
- * @param string $typename the type name
- * @return integer
- */
-function repository_get_type_by_id($id) {
- global $DB;
+ if (!$record = $DB->get_record('repository',array('id' => $id))) {
+ return false;
+ }
+
+ return new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
+ }
+
+ /**
+ * Return all repository types ordered by sortorder
+ * first type in returnedarray[0], second type in returnedarray[1], ...
+ * @global object $DB
+ * @param boolean $visible can return types by visiblity, return all types if null
+ * @return array Repository types
+ */
+ public static function get_types($visible=null) {
+ global $DB;
+
+ $types = array();
+ $params = null;
+ if (!empty($visible)) {
+ $params = array('visible' => $visible);
+ }
+ if ($records = $DB->get_records('repository',$params,'sortorder')) {
+ foreach($records as $type) {
+ $types[] = new repository_type($type->type, (array)get_config($type->type), $type->visible, $type->sortorder);
+ }
+ }
+
+ return $types;
+ }
+
+ /**
+ * Check context
+ * @param int $ctx_id
+ * @return boolean
+ */
+ public static function check_context($ctx_id) {
+ global $USER;
+
+ $context = get_context_instance_by_id($ctx_id);
+ $level = $context->contextlevel;
- if (!$record = $DB->get_record('repository',array('id' => $id))) {
+ if ($level == CONTEXT_COURSE) {
+ if (!has_capability('moodle/course:view', $context)) {
+ return false;
+ } else {
+ return true;
+ }
+ } else if ($level == CONTEXT_USER) {
+ $c = get_context_instance(CONTEXT_USER, $USER->id);
+ if ($c->id == $ctx_id) {
+ return true;
+ } else {
+ return false;
+ }
+ } else if ($level == CONTEXT_SYSTEM) {
+ // it is always ok in system level
+ return true;
+ }
return false;
}
- return new repository_type($record->type, (array)get_config($record->type), $record->visible, $record->sortorder);
-}
+ /**
+ * Return all types that you a user can create/edit and which are also visible
+ * Note: Mostly used in order to know if at least one editable type can be set
+ * @param object $context the context for which we want the editable types
+ * @return array types
+ */
+ public static function get_editable_types($context = null) {
-/**
- * Return all repository types ordered by sortorder
- * first type in returnedarray[0], second type in returnedarray[1], ...
- * @global object $DB
- * @param boolean $visible can return types by visiblity, return all types if null
- * @return array Repository types
- */
-function repository_get_types($visible=null) {
- global $DB;
+ if (empty($context)) {
+ $context = get_system_context();
+ }
+
+ $types= repository::get_types(true);
+ $editabletypes = array();
+ foreach ($types as $type) {
+ $instanceoptionnames = repository::static_function($type->get_typename(), 'get_instance_option_names');
+ if (!empty($instanceoptionnames)) {
+ if ($type->get_contextvisibility($context->contextlevel)) {
+ $editabletypes[]=$type;
+ }
+ }
+ }
+ return $editabletypes;
+ }
+
+ /**
+ * Return repository instances
+ * @global object $DB
+ * @global object $CFG
+ * @global object $USER
+ * @param object $contexts contexts for which the instances are set
+ * @param integer $userid
+ * @param boolean $onlyvisible if visible == true, return visible instances only,
+ * otherwise, return all instances
+ * @param string $type a type name to retrieve
+ * @return array repository instances
+ */
+ public static function get_instances($contexts=array(), $userid = null, $onlyvisible = true, $type=null) {
+ global $DB, $CFG, $USER;
+
+ $params = array();
+ $sql = 'SELECT i.*, r.type AS repositorytype, r.sortorder, r.visible FROM {repository} r, {repository_instances} i WHERE ';
+ $sql .= 'i.typeid = r.id ';
+
+ if (!empty($userid) && is_numeric($userid)) {
+ $sql .= ' AND (i.userid = 0 or i.userid = ?)';
+ $params[] = $userid;
+ }
+
+ foreach ($contexts as $context) {
+ if (empty($firstcontext)) {
+ $firstcontext = true;
+ $sql .= ' AND ((i.contextid = ?)';
+ } else {
+ $sql .= ' OR (i.contextid = ?)';
+ }
+ $params[] = $context->id;
+ }
+
+ if (!empty($firstcontext)) {
+ $sql .=')';
+ }
+
+ if ($onlyvisible == true) {
+ $sql .= ' AND (r.visible = 1)';
+ }
+
+ if (isset($type)) {
+ $sql .= ' AND (r.type = ?)';
+ $params[] = $type;
+ }
+ $sql .= ' order by r.sortorder, i.name';
+
+ if (!$repos = $DB->get_records_sql($sql, $params)) {
+ $repos = array();
+ }
+
+ $ret = array();
+ foreach ($repos as $repo) {
+ require_once($CFG->dirroot . '/repository/'. $repo->repositorytype.'/repository.class.php');
+ $options['visible'] = $repo->visible;
+ $options['name'] = $repo->name;
+ $options['type'] = $repo->repositorytype;
+ $options['typeid'] = $repo->typeid;
+ $classname = 'repository_' . $repo->repositorytype;//
+
+ $repository = new $classname($repo->id, $repo->contextid, $options, $repo->readonly);
+ if (!$onlyvisible || ($repository->is_visible() && !$repository->disabled)) {
+ $ret[] = $repository;
+ }
+ }
+ return $ret;
+ }
+
+ /**
+ * Get single repository instance
+ * @global object $DB
+ * @global object $CFG
+ * @param integer $id repository id
+ * @return object repository instance
+ */
+ public static function get_instance($id) {
+ global $DB, $CFG;
+ $sql = 'SELECT i.*, r.type AS repositorytype, r.visible FROM {repository} r, {repository_instances} i WHERE ';
+ $sql .= 'i.typeid = r.id AND ';
+ $sql .= 'i.id = '.$id;
+
+ if(!$instance = $DB->get_record_sql($sql)) {
+ return false;
+ }
+ require_once($CFG->dirroot . '/repository/'. $instance->repositorytype
+ . '/repository.class.php');
+ $classname = 'repository_' . $instance->repositorytype;
+ $options['typeid'] = $instance->typeid;
+ $options['type'] = $instance->repositorytype;
+ $options['name'] = $instance->name;
+ return new $classname($instance->id, $instance->contextid, $options, $instance->readonly);
+ }
+
+ /**
+ * call a static function
+ * @global