mirror of
https://github.com/moodle/moodle.git
synced 2025-01-17 21:49:15 +01:00
308 lines
10 KiB
PHP
308 lines
10 KiB
PHP
<?php
|
|
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle 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 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle 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.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* repository_dropbox class
|
|
* This plugin is used to access user's dropbox files
|
|
*
|
|
* @since 2.0
|
|
* @package repository
|
|
* @subpackage dropbox
|
|
* @copyright 2010 Dongsheng Cai
|
|
* @author Dongsheng Cai <dongsheng@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
require_once(dirname(__FILE__).'/locallib.php');
|
|
|
|
class repository_dropbox extends repository {
|
|
private $dropbox;
|
|
public $files;
|
|
public $logged=false;
|
|
|
|
/**
|
|
* Constructor of dropbox plugin
|
|
* @param int $repositoryid
|
|
* @param object $context
|
|
* @param array $options
|
|
*/
|
|
public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
|
|
global $SESSION, $CFG;
|
|
$options['page'] = optional_param('p', 1, PARAM_INT);
|
|
parent::__construct($repositoryid, $context, $options);
|
|
|
|
$this->setting = 'dropbox_';
|
|
|
|
$this->dropbox_key = $this->get_option('dropbox_key');
|
|
$this->dropbox_secret = $this->get_option('dropbox_secret');
|
|
|
|
$this->access_key = get_user_preferences($this->setting.'_access_key', '');
|
|
$this->access_secret = get_user_preferences($this->setting.'_access_secret', '');
|
|
|
|
if (!empty($this->access_key) && !empty($this->access_secret)) {
|
|
$this->logged = true;
|
|
}
|
|
|
|
$this->callback = new moodle_url($CFG->wwwroot.'/repository/repository_callback.php', array(
|
|
'callback'=>'yes',
|
|
'repo_id'=>$repositoryid
|
|
));
|
|
|
|
$args = array(
|
|
'oauth_consumer_key'=>$this->dropbox_key,
|
|
'oauth_consumer_secret'=>$this->dropbox_secret,
|
|
'oauth_callback' => $this->callback->out(false),
|
|
'api_root' => 'http://www.dropbox.com/0/oauth',
|
|
);
|
|
|
|
$this->dropbox = new dropbox($args);
|
|
}
|
|
|
|
/**
|
|
* Check if moodle has got access token and secret
|
|
* @return bool
|
|
*/
|
|
public function check_login() {
|
|
return !empty($this->logged);
|
|
}
|
|
|
|
/**
|
|
* Generate dropbox login url
|
|
* @return array
|
|
*/
|
|
public function print_login() {
|
|
$result = $this->dropbox->request_token();
|
|
set_user_preference($this->setting.'_request_secret', $result['oauth_token_secret']);
|
|
$url = $result['authorize_url'];
|
|
if ($this->options['ajax']) {
|
|
$ret = array();
|
|
$popup_btn = new stdClass();
|
|
$popup_btn->type = 'popup';
|
|
$popup_btn->url = $url;
|
|
$ret['login'] = array($popup_btn);
|
|
return $ret;
|
|
} else {
|
|
echo '<a target="_blank" href="'.$this->flickr->auth().'">'.get_string('login', 'repository').'</a>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Request access token
|
|
* @return array
|
|
*/
|
|
public function callback() {
|
|
$token = optional_param('oauth_token', '', PARAM_TEXT);
|
|
$secret = get_user_preferences($this->setting.'_request_secret', '');
|
|
$access_token = $this->dropbox->get_access_token($token, $secret);
|
|
set_user_preference($this->setting.'_access_key', $access_token['oauth_token']);
|
|
set_user_preference($this->setting.'_access_secret', $access_token['oauth_token_secret']);
|
|
}
|
|
|
|
/**
|
|
* Get dropbox files
|
|
* @param string $path
|
|
* @param int $page
|
|
* @return array
|
|
*/
|
|
public function get_listing($path = '', $page = '1') {
|
|
global $OUTPUT;
|
|
if (empty($path) || $path=='/') {
|
|
$path = '/';
|
|
} else {
|
|
$path = file_correct_filepath($path);
|
|
}
|
|
$encoded_path = str_replace("%2F", "/", rawurlencode($path));
|
|
|
|
$list = array();
|
|
$list['list'] = array();
|
|
$list['manage'] = false;
|
|
$list['dynload'] = true;
|
|
$list['nosearch'] = true;
|
|
// process breadcrumb trail
|
|
$list['path'] = array(
|
|
array('name'=>get_string('dropbox', 'repository_dropbox'), 'path'=>'/')
|
|
);
|
|
|
|
$result = $this->dropbox->get_listing($encoded_path, $this->access_key, $this->access_secret);
|
|
|
|
if (!is_object($result) || empty($result)) {
|
|
return $list;
|
|
}
|
|
if (empty($result->path)) {
|
|
$current_path = '/';
|
|
} else {
|
|
$current_path = file_correct_filepath($result->path);
|
|
}
|
|
|
|
$trail = '';
|
|
if (!empty($path)) {
|
|
$parts = explode('/', $path);
|
|
if (count($parts) > 1) {
|
|
foreach ($parts as $part) {
|
|
if (!empty($part)) {
|
|
$trail .= ('/'.$part);
|
|
$list['path'][] = array('name'=>$part, 'path'=>$trail);
|
|
}
|
|
}
|
|
} else {
|
|
$list['path'][] = array('name'=>$path, 'path'=>$path);
|
|
}
|
|
}
|
|
|
|
if (!empty($result->error)) {
|
|
// reset access key
|
|
set_user_preference($this->setting.'_access_key', '');
|
|
set_user_preference($this->setting.'_access_secret', '');
|
|
throw new repository_exception('repositoryerror', 'repository', '', $result->error);
|
|
}
|
|
if (empty($result->contents) or !is_array($result->contents)) {
|
|
return $list;
|
|
}
|
|
$files = $result->contents;
|
|
foreach ($files as $file) {
|
|
if ($file->is_dir) {
|
|
$list['list'][] = array(
|
|
'title' => substr($file->path, strpos($file->path, $current_path)+strlen($current_path)),
|
|
'path' => file_correct_filepath($file->path),
|
|
'size' => $file->size,
|
|
'date' => $file->modified,
|
|
'thumbnail' => $OUTPUT->pix_url('f/folder-32')->out(false),
|
|
'children' => array(),
|
|
);
|
|
} else {
|
|
$list['list'][] = array(
|
|
'title' => substr($file->path, strpos($file->path, $current_path)+strlen($current_path)),
|
|
'source' => $file->path,
|
|
'size' => $file->size,
|
|
'date' => $file->modified,
|
|
'thumbnail' => $OUTPUT->pix_url(file_extension_icon($file->path, 32))->out(false)
|
|
);
|
|
}
|
|
}
|
|
return $list;
|
|
}
|
|
/**
|
|
* Logout from dropbox
|
|
* @return array
|
|
*/
|
|
public function logout() {
|
|
set_user_preference($this->setting.'_access_key', '');
|
|
set_user_preference($this->setting.'_access_secret', '');
|
|
$this->access_key = '';
|
|
$this->access_secret = '';
|
|
return $this->print_login();
|
|
}
|
|
|
|
/**
|
|
* Set dropbox option
|
|
* @param array $options
|
|
* @return mixed
|
|
*/
|
|
public function set_option($options = array()) {
|
|
if (!empty($options['dropbox_key'])) {
|
|
set_config('dropbox_key', trim($options['dropbox_key']), 'dropbox');
|
|
}
|
|
if (!empty($options['dropbox_secret'])) {
|
|
set_config('dropbox_secret', trim($options['dropbox_secret']), 'dropbox');
|
|
}
|
|
unset($options['dropbox_key']);
|
|
unset($options['dropbox_secret']);
|
|
$ret = parent::set_option($options);
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Get dropbox options
|
|
* @param string $config
|
|
* @return mixed
|
|
*/
|
|
public function get_option($config = '') {
|
|
if ($config==='dropbox_key') {
|
|
return trim(get_config('dropbox', 'dropbox_key'));
|
|
} elseif ($config==='dropbox_secret') {
|
|
return trim(get_config('dropbox', 'dropbox_secret'));
|
|
} else {
|
|
$options['dropbox_key'] = trim(get_config('dropbox', 'dropbox_key'));
|
|
$options['dropbox_secret'] = trim(get_config('dropbox', 'dropbox_secret'));
|
|
}
|
|
$options = parent::get_option($config);
|
|
return $options;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $photo_id
|
|
* @param string $file
|
|
* @return string
|
|
*/
|
|
public function get_file($filepath, $saveas = '') {
|
|
$this->dropbox->set_access_token($this->access_key, $this->access_secret);
|
|
return $this->dropbox->get_file($filepath, $saveas);
|
|
}
|
|
/**
|
|
* Add Plugin settings input to Moodle form
|
|
* @param object $mform
|
|
*/
|
|
public function type_config_form($mform) {
|
|
global $CFG;
|
|
parent::type_config_form($mform);
|
|
$key = get_config('dropbox', 'dropbox_key');
|
|
$secret = get_config('dropbox', 'dropbox_secret');
|
|
|
|
if (empty($key)) {
|
|
$key = '';
|
|
}
|
|
if (empty($secret)) {
|
|
$secret = '';
|
|
}
|
|
|
|
$strrequired = get_string('required');
|
|
|
|
$mform->addElement('text', 'dropbox_key', get_string('apikey', 'repository_dropbox'), array('value'=>$key,'size' => '40'));
|
|
$mform->addElement('text', 'dropbox_secret', get_string('secret', 'repository_dropbox'), array('value'=>$secret,'size' => '40'));
|
|
|
|
$mform->addRule('dropbox_key', $strrequired, 'required', null, 'client');
|
|
$mform->addRule('dropbox_secret', $strrequired, 'required', null, 'client');
|
|
$str_getkey = get_string('instruction', 'repository_dropbox');
|
|
$mform->addElement('static', null, '', $str_getkey);
|
|
}
|
|
|
|
/**
|
|
* Option names of dropbox plugin
|
|
* @return array
|
|
*/
|
|
public static function get_type_option_names() {
|
|
return array('dropbox_key', 'dropbox_secret', 'pluginname');
|
|
}
|
|
|
|
/**
|
|
* Dropbox plugin supports all kinds of files
|
|
* @return array
|
|
*/
|
|
public function supported_filetypes() {
|
|
return '*';
|
|
}
|
|
|
|
/**
|
|
* User cannot use the external link to dropbox
|
|
* @return int
|
|
*/
|
|
public function supported_returntypes() {
|
|
return FILE_INTERNAL;
|
|
}
|
|
}
|