MDL-36538 repository_webdav - save files directly to local filesystem, rather than...
[moodle.git] / repository / webdav / 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/>.
18 /**
19  * This plugin is used to access webdav files
20  *
21  * @since 2.0
22  * @package    repository_webdav
23  * @copyright  2010 Dongsheng Cai {@link http://dongsheng.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
26 require_once($CFG->dirroot . '/repository/lib.php');
27 require_once($CFG->libdir.'/webdavlib.php');
29 /**
30  * repository_webdav class
31  *
32  * @since 2.0
33  * @package    repository_webdav
34  * @copyright  2009 Dongsheng Cai {@link http://dongsheng.org}
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class repository_webdav extends repository {
38     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
39         parent::__construct($repositoryid, $context, $options);
40         // set up webdav client
41         if (empty($this->options['webdav_server'])) {
42             return;
43         }
44         if ($this->options['webdav_auth'] == 'none') {
45             $this->options['webdav_auth'] = false;
46         }
47         if (empty($this->options['webdav_type'])) {
48             $this->webdav_type = '';
49         } else {
50             $this->webdav_type = 'ssl://';
51         }
52         if (empty($this->options['webdav_port'])) {
53             $port = '';
54             if (empty($this->webdav_type)) {
55                 $this->webdav_port = 80;
56             } else {
57                 $this->webdav_port = 443;
58                 $port = ':443';
59             }
60         } else {
61             $this->webdav_port = $this->options['webdav_port'];
62             $port = ':' . $this->webdav_port;
63         }
64         $this->webdav_host = $this->webdav_type.$this->options['webdav_server'].$port;
65         $this->dav = new webdav_client($this->options['webdav_server'], $this->options['webdav_user'],
66                 $this->options['webdav_password'], $this->options['webdav_auth'], $this->webdav_type);
67         $this->dav->port = $this->webdav_port;
68         $this->dav->debug = false;
69     }
70     public function check_login() {
71         return true;
72     }
73     public function get_file($url, $title = '') {
74         $url = urldecode($url);
75         $path = $this->prepare_file($title);
76         if (!$this->dav->open()) {
77             return false;
78         }
79         $webdavpath = rtrim('/'.ltrim($this->options['webdav_path'], '/ '), '/ '); // without slash in the end
80         $this->dav->get_file($webdavpath. $url, $path);
81         return array('path'=>$path);
82     }
83     public function global_search() {
84         return false;
85     }
86     public function get_listing($path='', $page = '') {
87         global $CFG, $OUTPUT;
88         $list = array();
89         $ret  = array();
90         $ret['dynload'] = true;
91         $ret['nosearch'] = true;
92         $ret['nologin'] = true;
93         $ret['path'] = array(array('name'=>get_string('webdav', 'repository_webdav'), 'path'=>''));
94         $ret['list'] = array();
95         if (!$this->dav->open()) {
96             return $ret;
97         }
98         $webdavpath = rtrim('/'.ltrim($this->options['webdav_path'], '/ '), '/ '); // without slash in the end
99         if (empty($path) || $path =='/') {
100             $path = '/';
101         } else {
102             $chunks = preg_split('|/|', trim($path, '/'));
103             for ($i = 0; $i < count($chunks); $i++) {
104                 $ret['path'][] = array(
105                     'name' => urldecode($chunks[$i]),
106                     'path' => '/'. join('/', array_slice($chunks, 0, $i+1)). '/'
107                 );
108             }
109         }
110         $dir = $this->dav->ls($webdavpath. urldecode($path));
111         if (!is_array($dir)) {
112             return $ret;
113         }
114         $folders = array();
115         $files = array();
116         foreach ($dir as $v) {
117             if (!empty($v['lastmodified'])) {
118                 $v['lastmodified'] = strtotime($v['lastmodified']);
119             } else {
120                 $v['lastmodified'] = null;
121             }
123             // Extracting object title from absolute path
124             $v['href'] = substr(urldecode($v['href']), strlen($webdavpath));
125             $title = substr($v['href'], strlen($path));
127             if (!empty($v['resourcetype']) && $v['resourcetype'] == 'collection') {
128                 // a folder
129                 if ($path != $v['href']) {
130                     $folders[strtoupper($title)] = array(
131                         'title'=>rtrim($title, '/'),
132                         'thumbnail'=>$OUTPUT->pix_url(file_folder_icon(90))->out(false),
133                         'children'=>array(),
134                         'datemodified'=>$v['lastmodified'],
135                         'path'=>$v['href']
136                     );
137                 }
138             }else{
139                 // a file
140                 $size = !empty($v['getcontentlength'])? $v['getcontentlength']:'';
141                 $files[strtoupper($title)] = array(
142                     'title'=>$title,
143                     'thumbnail' => $OUTPUT->pix_url(file_extension_icon($title, 90))->out(false),
144                     'size'=>$size,
145                     'datemodified'=>$v['lastmodified'],
146                     'source'=>$v['href']
147                 );
148             }
149         }
150         ksort($files);
151         ksort($folders);
152         $ret['list'] = array_merge($folders, $files);
153         return $ret;
154     }
155     public static function get_instance_option_names() {
156         return array('webdav_type', 'webdav_server', 'webdav_port', 'webdav_path', 'webdav_user', 'webdav_password', 'webdav_auth');
157     }
159     public static function instance_config_form($mform) {
160         $choices = array(0 => get_string('http', 'repository_webdav'), 1 => get_string('https', 'repository_webdav'));
161         $mform->addElement('select', 'webdav_type', get_string('webdav_type', 'repository_webdav'), $choices);
162         $mform->addRule('webdav_type', get_string('required'), 'required', null, 'client');
164         $mform->addElement('text', 'webdav_server', get_string('webdav_server', 'repository_webdav'), array('size' => '40'));
165         $mform->addRule('webdav_server', get_string('required'), 'required', null, 'client');
167         $mform->addElement('text', 'webdav_path', get_string('webdav_path', 'repository_webdav'), array('size' => '40'));
168         $mform->addRule('webdav_path', get_string('required'), 'required', null, 'client');
170         $choices = array();
171         $choices['none'] = get_string('none');
172         $choices['basic'] = get_string('webdavbasicauth', 'repository_webdav');
173         $choices['digest'] = get_string('webdavdigestauth', 'repository_webdav');
174         $mform->addElement('select', 'webdav_auth', get_string('authentication', 'admin'), $choices);
175         $mform->addRule('webdav_auth', get_string('required'), 'required', null, 'client');
178         $mform->addElement('text', 'webdav_port', get_string('webdav_port', 'repository_webdav'), array('size' => '40'));
179         $mform->addElement('text', 'webdav_user', get_string('webdav_user', 'repository_webdav'), array('size' => '40'));
180         $mform->addElement('text', 'webdav_password', get_string('webdav_password', 'repository_webdav'), array('size' => '40'));
181     }
182     public function supported_returntypes() {
183         return (FILE_INTERNAL | FILE_EXTERNAL);
184     }