mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 05:58:34 +01:00
250 lines
8.7 KiB
PHP
250 lines
8.7 KiB
PHP
<?php // $Id$
|
|
|
|
///////////////////////////////////////////////////////////////////////////
|
|
// //
|
|
// NOTICE OF COPYRIGHT //
|
|
// //
|
|
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
|
|
// http://moodle.com //
|
|
// //
|
|
// Copyright (C) 2008 onwards Moodle Pty Ltd http://moodle.com //
|
|
// //
|
|
// This program is free software; you can redistribute it and/or modify //
|
|
// it under the terms of the GNU General Public License as published by //
|
|
// the Free Software Foundation; either version 2 of the License, or //
|
|
// (at your option) any later version. //
|
|
// //
|
|
// This program is distributed in the hope that it will be useful, //
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
|
|
// GNU General Public License for more details: //
|
|
// //
|
|
// http://www.gnu.org/copyleft/gpl.html //
|
|
// //
|
|
///////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
* This is the base class of the repository class
|
|
*
|
|
* To use repository plugin, you need to create a new folder under repository/, named as the remote
|
|
* repository, the subclass must be defined in the name
|
|
|
|
*
|
|
* class repository is an abstract class, some functions must be implemented in subclass.
|
|
*
|
|
* See an example of use of this library in repository/box/repository.class.php
|
|
*
|
|
* A few notes :
|
|
* // options are stored as serialized format in database
|
|
* $options = array('api_key'=>'dmls97d8j3i9tn7av8y71m9eb55vrtj4',
|
|
* 'auth_token'=>'', 'path_root'=>'/');
|
|
* $repo = new repository_xxx($options);
|
|
* // print login page or a link to redirect to another page
|
|
* $repo->print_login();
|
|
* // call get_listing, and print result
|
|
* $repo->print_listing();
|
|
* // print a search box
|
|
* $repo->print_search();
|
|
*
|
|
* @version 1.0 dev
|
|
* @package repository_api
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
|
|
*/
|
|
require_once('../config.php');
|
|
|
|
abstract class repository {
|
|
protected $options;
|
|
public $name;
|
|
public $context;
|
|
public $repositoryid;
|
|
|
|
/**
|
|
* Take an array as a parameter, which contains necessary information
|
|
* of repository.
|
|
*
|
|
* @param string $parent The parent path, this parameter must
|
|
* not be the folder name, it may be a identification of folder
|
|
* @param string $search The text will be searched.
|
|
* @return array the list of files, including meta infomation
|
|
*/
|
|
public function __construct($repositoryid, $context = SITEID, $options = array()){
|
|
$this->name = 'repository_base';
|
|
$this->context = $context;
|
|
$this->repositoryid = $repositoryid;
|
|
$this->options = array();
|
|
if (is_array($options)) {
|
|
foreach ($options as $n => $v) {
|
|
$this->options[$n] = $v;
|
|
}
|
|
}
|
|
}
|
|
|
|
public function __set($name, $value) {
|
|
$this->options[$name] = $value;
|
|
}
|
|
|
|
public function __get($name) {
|
|
if (array_key_exists($name, $this->options)){
|
|
return $this->options[$name];
|
|
}
|
|
trigger_error('Undefined property: '.$name, E_USER_NOTICE);
|
|
return null;
|
|
}
|
|
|
|
public function __isset($name) {
|
|
return isset($this->options[$name]);
|
|
}
|
|
|
|
public function __toString() {
|
|
return 'Repository class: '.__CLASS__;
|
|
}
|
|
// Given a URL, get a file from there.
|
|
public function get_file($url) {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Given a path, and perhaps a search, get a list of files.
|
|
*
|
|
* @param string $parent The parent path, this parameter can
|
|
* a folder name, or a identification of folder
|
|
* @param string $search The text will be searched.
|
|
* @return array the list of files, including meta infomation
|
|
*/
|
|
abstract public function get_listing($parent = '/', $search = '');
|
|
|
|
/**
|
|
* Print a list or return string
|
|
*
|
|
* @param string $list
|
|
* $list = array(
|
|
* array('name'=>'moodle.txt', 'size'=>12, 'path'=>'', 'date'=>''),
|
|
* array('name'=>'repository.txt', 'size'=>32, 'path'=>'', 'date'=>''),
|
|
* array('name'=>'forum.txt', 'size'=>82, 'path'=>'', 'date'=>''),
|
|
* );
|
|
*
|
|
* @param boolean $print if printing the listing directly
|
|
*
|
|
*/
|
|
public function print_listing($listing = array(), $print=true) {
|
|
if (empty($listing)) {
|
|
$str = '';
|
|
} else {
|
|
$count = 0;
|
|
$str = '<table>';
|
|
foreach ($listing as $v){
|
|
$str .= '<tr id="entry_'.$count.'">';
|
|
$str .= '<td><input type="checkbox" /></td>';
|
|
$str .= '<td>'.$v['name'].'</td>';
|
|
$str .= '<td>'.$v['size'].'</td>';
|
|
$str .= '<td>'.$v['date'].'</td>';
|
|
$str .= '</tr>';
|
|
$count++;
|
|
}
|
|
$str .= '</table>';
|
|
}
|
|
if ($print){
|
|
echo $str;
|
|
return null;
|
|
} else {
|
|
return $str;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Show the login screen, if required
|
|
* This is an abstract function, it must be overriden.
|
|
* The specific plug-in need to specify authentication types in database
|
|
* options field
|
|
* Imagine following cases:
|
|
* 1. no need of authentication
|
|
* 2. Use username and password to authenticate
|
|
* 3. Redirect to authentication page, in this case, the repository
|
|
* will callback moodle with following common parameters:
|
|
* (1) boolean callback To tell moodle this is a callback
|
|
* (2) int id Specify repository ID
|
|
* The callback page need to use these parameters to init
|
|
* the repository plug-ins correctly. Also, auth_token or ticket may
|
|
* attach in the callback url, these must be taken into account too.
|
|
*
|
|
*/
|
|
abstract public function print_login();
|
|
|
|
/**
|
|
* Show the search screen, if required
|
|
*
|
|
* @return null
|
|
*/
|
|
abstract public function print_search();
|
|
|
|
/**
|
|
* Cache login details for repositories
|
|
*
|
|
* @param string $username
|
|
* @param string $password
|
|
* @param string $userid The id of specific user
|
|
* @return array the list of files, including meta infomation
|
|
*/
|
|
public function store_login($username = '', $password = '', $userid = -1, $contextid = SITEID) {
|
|
global $DB;
|
|
|
|
$repository = new stdclass;
|
|
$repository->userid = $userid;
|
|
$repository->repositorytype = $this->name;
|
|
$repository->contextid = $contextid;
|
|
if ($entry = $DB->get_record('repository', $repository)) {
|
|
$repository->id = $entry->id;
|
|
$repository->username = $username;
|
|
$repository->password = $password;
|
|
return $DB->update_record('repository', $repository);
|
|
} else {
|
|
$repository->username = $username;
|
|
$repository->password = $password;
|
|
return $DB->insert_record('repository', $repository);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Defines operations that happen occasionally on cron
|
|
*
|
|
*/
|
|
public function cron() {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Listing object describing a listing of files and directories
|
|
*/
|
|
|
|
abstract class repository_listing {
|
|
}
|
|
|
|
function repository_set_option($id, $position, $config = array()){
|
|
global $DB;
|
|
$repository = new stdclass;
|
|
$position = (int)$position;
|
|
$config = serialize($config);
|
|
if( $position < 1 || $position > 5){
|
|
print_error('invalidoption', 'repository', '', $position);
|
|
}
|
|
if ($entry = $DB->get_record('repository', array('id'=>$id))) {
|
|
$option = 'option'.$position;
|
|
$repository->id = $entry->id;
|
|
$repository->$option = $config;
|
|
return $DB->update_record('repository', $repository);
|
|
}
|
|
return false;
|
|
}
|
|
function repository_get_option($id, $position){
|
|
global $DB;
|
|
$entry = $DB->get_record('repository', array('id'=>$id));
|
|
$option = 'option'.$position;
|
|
$ret = (array)unserialize($entry->$option);
|
|
return $ret;
|
|
}
|
|
|
|
?>
|