<?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/>.
/**
* This plugin is used to access webdav files
*
* @since Moodle 2.0
* @package repository_webdav
* @copyright 2010 Dongsheng Cai {@link http://dongsheng.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once($CFG->dirroot . '/repository/lib.php');
require_once($CFG->libdir.'/webdavlib.php');
/**
* repository_webdav class
*
* @since Moodle 2.0
* @package repository_webdav
* @copyright 2009 Dongsheng Cai {@link http://dongsheng.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class repository_webdav extends repository {
/** @var string webdav type. */
protected $webdav_type;
/** @var mixed webdav port. */
protected $webdav_port;
/** @var string webdav host. */
protected $webdav_host;
/** @var webdav_client webdav client. */
protected $dav;
public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
parent::__construct($repositoryid, $context, $options);
// set up webdav client
if (empty($this->options['webdav_server'])) {
return;
}
if ($this->options['webdav_auth'] == 'none') {
$this->options['webdav_auth'] = false;
}
if (empty($this->options['webdav_type'])) {
$this->webdav_type = '';
} else {
$this->webdav_type = 'ssl://';
}
if (empty($this->options['webdav_port'])) {
$port = '';
if (empty($this->webdav_type)) {
$this->webdav_port = 80;
} else {
$this->webdav_port = 443;
$port = ':443';
}
} else {
$this->webdav_port = $this->options['webdav_port'];
$port = ':' . $this->webdav_port;
}
$this->webdav_host = $this->webdav_type.$this->options['webdav_server'].$port;
$this->dav = new webdav_client($this->options['webdav_server'], $this->options['webdav_user'],
$this->options['webdav_password'], $this->options['webdav_auth'], $this->webdav_type);
$this->dav->port = $this->webdav_port;
$this->dav->debug = false;
}
public function check_login() {
return true;
}
public function get_file($url, $title = '') {
$url = urldecode($url);
// Prepare a file with an arbitrary name - cannot be $title because of special chars (cf. MDL-57002).
$path = $this->prepare_file(uniqid());
if (!$this->dav->open()) {
return false;
}
$webdavpath = rtrim('/'.ltrim($this->options['webdav_path'], '/ '), '/ '); // without slash in the end
$this->dav->get_file($webdavpath. $url, $path);
return array('path'=>$path);
}
public function global_search() {
return false;
}
public function get_listing($path='', $page = '') {
global $CFG, $OUTPUT;
$list = array();
$ret = array();
$ret['dynload'] = true;
$ret['nosearch'] = true;
$ret['nologin'] = true;
$ret['path'] = array(array('name'=>get_string('webdav', 'repository_webdav'), 'path'=>''));
$ret['list'] = array();
if (!$this->dav->open()) {
return $ret;
}
$webdavpath = rtrim('/'.ltrim($this->options['webdav_path'], '/ '), '/ '); // without slash in the end
if (empty($path) || $path =='/') {
$path = '/';
} else {
$chunks = preg_split('|/|', trim($path, '/'));
for ($i = 0; $i < count($chunks); $i++) {
$ret['path'][] = array(
'name' => urldecode($chunks[$i]),
'path' => '/'. join('/', array_slice($chunks, 0, $i+1)). '/'
);
}
}
$dir = $this->dav->ls($webdavpath. urldecode($path));
if (!is_array($dir)) {
return $ret;
}
$folders = array();
$files = array();
foreach ($dir as $v) {
if (!empty($v['lastmodified'])) {
$v['lastmodified'] = strtotime($v['lastmodified']);
} else {
$v['lastmodified'] = null;
}
// Remove the server URL from the path (if present), otherwise links will not work - MDL-37014
$server = preg_quote($this->options['webdav_server']);
$v['href'] = preg_replace("#https?://{$server}#", '', $v['href']);
// Extracting object title from absolute path
$v['href'] = substr(urldecode($v['href']), strlen($webdavpath));
$title = substr($v['href'], strlen($path));
if (!empty($v['resourcetype']) && $v['resourcetype'] == 'collection') {
< // a folder
> // A folder.
if ($path != $v['href']) {
$folders[strtoupper($title)] = array(
'title'=>rtrim($title, '/'),
< 'thumbnail'=>$OUTPUT->image_url(file_folder_icon(90))->out(false),
> 'thumbnail' => $OUTPUT->image_url(file_folder_icon())->out(false),
'children'=>array(),
'datemodified'=>$v['lastmodified'],
< 'path'=>$v['href']
> 'path' => $v['href'],
);
}
}else{
< // a file
> // A file.
$size = !empty($v['getcontentlength'])? $v['getcontentlength']:'';
$files[strtoupper($title)] = array(
'title'=>$title,
< 'thumbnail' => $OUTPUT->image_url(file_extension_icon($title, 90))->out(false),
> 'thumbnail' => $OUTPUT->image_url(file_extension_icon($title))->out(false),
'size'=>$size,
'datemodified'=>$v['lastmodified'],
< 'source'=>$v['href']
> 'source' => $v['href'],
);
}
}
ksort($files);
ksort($folders);
$ret['list'] = array_merge($folders, $files);
return $ret;
}
public static function get_instance_option_names() {
return array('webdav_type', 'webdav_server', 'webdav_port', 'webdav_path', 'webdav_user', 'webdav_password', 'webdav_auth');
}
public static function instance_config_form($mform) {
$choices = array(0 => get_string('http', 'repository_webdav'), 1 => get_string('https', 'repository_webdav'));
$mform->addElement('select', 'webdav_type', get_string('webdav_type', 'repository_webdav'), $choices);
$mform->addRule('webdav_type', get_string('required'), 'required', null, 'client');
$mform->addElement('text', 'webdav_server', get_string('webdav_server', 'repository_webdav'), array('size' => '40'));
$mform->addRule('webdav_server', get_string('required'), 'required', null, 'client');
$mform->setType('webdav_server', PARAM_HOST);
$mform->addElement('text', 'webdav_path', get_string('webdav_path', 'repository_webdav'), array('size' => '40'));
$mform->addRule('webdav_path', get_string('required'), 'required', null, 'client');
$mform->setType('webdav_path', PARAM_PATH);
$choices = array();
$choices['none'] = get_string('none');
$choices['basic'] = get_string('webdavbasicauth', 'repository_webdav');
$choices['digest'] = get_string('webdavdigestauth', 'repository_webdav');
$mform->addElement('select', 'webdav_auth', get_string('authentication', 'admin'), $choices);
$mform->addRule('webdav_auth', get_string('required'), 'required', null, 'client');
$mform->addElement('text', 'webdav_port', get_string('webdav_port', 'repository_webdav'), array('size' => '40'));
$mform->setType('webdav_port', PARAM_INT);
$mform->addElement('text', 'webdav_user', get_string('webdav_user', 'repository_webdav'), array('size' => '40'));
$mform->setType('webdav_user', PARAM_RAW_TRIMMED); // Not for us to clean.
$mform->addElement('passwordunmask', 'webdav_password', get_string('webdav_password', 'repository_webdav'),
array('size' => '40'));
}
public function supported_returntypes() {
return (FILE_INTERNAL | FILE_EXTERNAL);
}
/**
* Is this repository accessing private data?
*
* @return bool
*/
public function contains_private_data() {
return false;
}
}