MDL-37014 repository_webdav - strip the server URL from file & folder paths returned...
[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         global $CFG;
75         $url = urldecode($url);
76         $path = $this->prepare_file($title);
77         $buffer = '';
78         if (!$this->dav->open()) {
79             return false;
80         }
81         $webdavpath = rtrim('/'.ltrim($this->options['webdav_path'], '/ '), '/ '); // without slash in the end
82         $this->dav->get($webdavpath. $url, $buffer);
83         $fp = fopen($path, 'wb');
84         fwrite($fp, $buffer);
85         return array('path'=>$path);
86     }
87     public function global_search() {
88         return false;
89     }
90     public function get_listing($path='', $page = '') {
91         global $CFG, $OUTPUT;
92         $list = array();
93         $ret  = array();
94         $ret['dynload'] = true;
95         $ret['nosearch'] = true;
96         $ret['nologin'] = true;
97         $ret['path'] = array(array('name'=>get_string('webdav', 'repository_webdav'), 'path'=>''));
98         $ret['list'] = array();
99         if (!$this->dav->open()) {
100             return $ret;
101         }
102         $webdavpath = rtrim('/'.ltrim($this->options['webdav_path'], '/ '), '/ '); // without slash in the end
103         if (empty($path) || $path =='/') {
104             $path = '/';
105         } else {
106             $chunks = preg_split('|/|', trim($path, '/'));
107             for ($i = 0; $i < count($chunks); $i++) {
108                 $ret['path'][] = array(
109                     'name' => urldecode($chunks[$i]),
110                     'path' => '/'. join('/', array_slice($chunks, 0, $i+1)). '/'
111                 );
112             }
113         }
114         $dir = $this->dav->ls($webdavpath. urldecode($path));
115         if (!is_array($dir)) {
116             return $ret;
117         }
118         $folders = array();
119         $files = array();
120         foreach ($dir as $v) {
121             if (!empty($v['lastmodified'])) {
122                 $v['lastmodified'] = strtotime($v['lastmodified']);
123             } else {
124                 $v['lastmodified'] = null;
125             }
127             // Remove the server URL from the path (if present), otherwise links will not work - MDL-37014
128             $server = preg_quote($this->options['webdav_server']);
129             $v['href'] = preg_replace("#https?://{$server}#", '', $v['href']);
130             // Extracting object title from absolute path
131             $v['href'] = substr(urldecode($v['href']), strlen($webdavpath));
132             $title = substr($v['href'], strlen($path));
134             if (!empty($v['resourcetype']) && $v['resourcetype'] == 'collection') {
135                 // a folder
136                 if ($path != $v['href']) {
137                     $folders[strtoupper($title)] = array(
138                         'title'=>rtrim($title, '/'),
139                         'thumbnail'=>$OUTPUT->pix_url(file_folder_icon(90))->out(false),
140                         'children'=>array(),
141                         'datemodified'=>$v['lastmodified'],
142                         'path'=>$v['href']
143                     );
144                 }
145             }else{
146                 // a file
147                 $size = !empty($v['getcontentlength'])? $v['getcontentlength']:'';
148                 $files[strtoupper($title)] = array(
149                     'title'=>$title,
150                     'thumbnail' => $OUTPUT->pix_url(file_extension_icon($title, 90))->out(false),
151                     'size'=>$size,
152                     'datemodified'=>$v['lastmodified'],
153                     'source'=>$v['href']
154                 );
155             }
156         }
157         ksort($files);
158         ksort($folders);
159         $ret['list'] = array_merge($folders, $files);
160         return $ret;
161     }
162     public static function get_instance_option_names() {
163         return array('webdav_type', 'webdav_server', 'webdav_port', 'webdav_path', 'webdav_user', 'webdav_password', 'webdav_auth');
164     }
166     public static function instance_config_form($mform) {
167         $choices = array(0 => get_string('http', 'repository_webdav'), 1 => get_string('https', 'repository_webdav'));
168         $mform->addElement('select', 'webdav_type', get_string('webdav_type', 'repository_webdav'), $choices);
169         $mform->addRule('webdav_type', get_string('required'), 'required', null, 'client');
171         $mform->addElement('text', 'webdav_server', get_string('webdav_server', 'repository_webdav'), array('size' => '40'));
172         $mform->addRule('webdav_server', get_string('required'), 'required', null, 'client');
174         $mform->addElement('text', 'webdav_path', get_string('webdav_path', 'repository_webdav'), array('size' => '40'));
175         $mform->addRule('webdav_path', get_string('required'), 'required', null, 'client');
177         $choices = array();
178         $choices['none'] = get_string('none');
179         $choices['basic'] = get_string('webdavbasicauth', 'repository_webdav');
180         $choices['digest'] = get_string('webdavdigestauth', 'repository_webdav');
181         $mform->addElement('select', 'webdav_auth', get_string('authentication', 'admin'), $choices);
182         $mform->addRule('webdav_auth', get_string('required'), 'required', null, 'client');
185         $mform->addElement('text', 'webdav_port', get_string('webdav_port', 'repository_webdav'), array('size' => '40'));
186         $mform->addElement('text', 'webdav_user', get_string('webdav_user', 'repository_webdav'), array('size' => '40'));
187         $mform->addElement('text', 'webdav_password', get_string('webdav_password', 'repository_webdav'), array('size' => '40'));
188     }
189     public function supported_returntypes() {
190         return (FILE_INTERNAL | FILE_EXTERNAL);
191     }