course/import/groups: MDL-20876 Fix split() call and remove redundant escaping.
[moodle.git] / repository / repository_ajax.php
CommitLineData
aa6c1ced 1<?php
5bce5972 2
6f2cd52a
DC
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/>.
17
18
19/**
20 * The Web service script that is called from the filepicker front end
21 *
22 * @since 2.0
23 * @package moodlecore
24 * @subpackage repository
25 * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 */
455860ce 28
e35194be
DC
29define('AJAX_SCRIPT', true);
30
14469892
DC
31require_once(dirname(dirname(__FILE__)).'/config.php');
32require_once(dirname(dirname(__FILE__)).'/lib/filelib.php');
33require_once(dirname(__FILE__).'/lib.php');
99eaca9d 34
dd0566eb
DC
35$err = new stdclass;
36
37if (!isloggedin()) {
38 $err->error = get_string('loggedinnot');
39 die(json_encode($err));
40}
41
9d4ef80f 42require_login();
cf493e89 43
d0f8585d 44/// Parameters
9d4ef80f 45$action = optional_param('action', '', PARAM_ALPHA);
3e123368 46$repo_id = optional_param('repo_id', 0, PARAM_INT); // Pepository ID
3e123368
DC
47$contextid = optional_param('ctx_id', SYSCONTEXTID, PARAM_INT); // Context ID
48$env = optional_param('env', 'filepicker', PARAM_ALPHA); // Opened in editor or moodleform
1dce6261 49$license = optional_param('license', $CFG->sitedefaultlicense, PARAM_TEXT);
3e123368
DC
50$author = optional_param('author', '', PARAM_TEXT); // File author
51$source = optional_param('source', '', PARAM_RAW); // File to download
52$itemid = optional_param('itemid', 0, PARAM_INT); // Itemid
53$page = optional_param('page', '', PARAM_RAW); // Page
54$maxbytes = optional_param('maxbytes', 0, PARAM_INT); // Maxbytes
55$req_path = optional_param('p', '', PARAM_RAW); // Path
e35194be 56$accepted_types = optional_param('accepted_types', '*', PARAM_RAW);
3e123368
DC
57$saveas_filename = optional_param('title', '', PARAM_FILE); // save as file name
58$saveas_path = optional_param('savepath', '/', PARAM_PATH); // save as file path
9d4ef80f
DC
59$search_text = optional_param('s', '', PARAM_CLEANHTML);
60$linkexternal = optional_param('linkexternal', '', PARAM_ALPHA);
455860ce 61
577aab9b 62/// Headers to make it not cacheable
9d4ef80f
DC
63header('Cache-Control: no-cache, must-revalidate');
64header('Expires: Sat, 26 Jul 1997 05:00:00 GMT');
65
6127179b
DC
66if (!confirm_sesskey()) {
67 $err->error = get_string('invalidsesskey');
68 die(json_encode($err));
69}
70
be85f7ab
DC
71if (!isloggedin()) {
72 $err->error = get_string('loggedinnot', 'moodle');
9d4ef80f
DC
73 die(json_encode($err));
74}
0eb58cf4 75
be85f7ab
DC
76/// Get repository instance information
77$sql = 'SELECT i.name, i.typeid, r.type FROM {repository} r, {repository_instances} i WHERE i.id=? AND i.typeid=r.id';
78
79if (!$repository = $DB->get_record_sql($sql, array($repo_id))) {
80 $err->error = get_string('invalidrepositoryid', 'repository');
81 die(json_encode($err));
82} else {
83 $type = $repository->type;
84}
85
86/// Check permissions
87repository::check_capability($contextid, $repository);
88
3e123368
DC
89$moodle_maxbytes = get_max_upload_file_size();
90// to prevent maxbytes greater than moodle maxbytes setting
91if ($maxbytes == 0 || $maxbytes>=$moodle_maxbytes) {
92 $maxbytes = $moodle_maxbytes;
93}
94
577aab9b 95/// Wait as long as it takes for this script to finish
9d4ef80f 96set_time_limit(0);
577aab9b 97
9d4ef80f
DC
98// Early actions which need to be done before repository instaces initialised
99switch ($action) {
100 // global search
101 case 'gsearch':
102 $params = array();
103 $params['context'] = array(get_context_instance_by_id($contextid), get_system_context());
104 $params['currentcontext'] = get_context_instance_by_id($contextid);
105 $repos = repository::get_instances($params);
106 $list = array();
107 foreach($repos as $repo){
108 if ($repo->global_search()) {
e35194be
DC
109 $ret = $repo->search($search_text);
110 array_walk($ret['list'], 'repository_attach_id', $repo->id); // See function below
111 $tmp = array_merge($list, $ret['list']);
112 $list = $tmp;
d0f8585d 113 }
9d4ef80f
DC
114 }
115 $listing = array('list'=>$list);
116 $listing['gsearch'] = true;
9d4ef80f
DC
117 die(json_encode($listing));
118 break;
d0f8585d 119
9d4ef80f
DC
120 // remove the cache files & logout
121 case 'ccache':
122 $cache = new curl_cache;
123 $cache->refresh();
124 $action = 'list';
125 break;
126}
d0f8585d 127
e35194be
DC
128if (file_exists($CFG->dirroot.'/repository/'.$type.'/lib.php')) {
129 require_once($CFG->dirroot.'/repository/'.$type.'/lib.php');
9d4ef80f 130 $classname = 'repository_' . $type;
e35194be 131 $repo = new $classname($repo_id, $contextid, array('ajax'=>true, 'name'=>$repository->name, 'type'=>$type));
a06878d3 132} else {
e35194be 133 $err->error = get_string('invalidplugin', 'repository', $type);
9d4ef80f 134 die(json_encode($err));
a06878d3 135}
9d4ef80f 136
d0f8585d 137/// These actions all occur on the currently active repository instance
9d4ef80f
DC
138switch ($action) {
139 case 'sign':
140 case 'signin':
141 case 'list':
142 if ($repo->check_login()) {
e35194be
DC
143 $listing = $repo->get_listing($req_path, $page);
144 $listing['repo_id'] = $repo_id;
145 echo json_encode($listing);
d0f8585d 146 break;
9d4ef80f
DC
147 } else {
148 $action = 'login';
149 }
150 case 'login':
e35194be
DC
151 $listing = $repo->print_login();
152 $listing['repo_id'] = $repo_id;
153 echo json_encode($listing);
9d4ef80f
DC
154 break;
155 case 'logout':
156 $logout = $repo->logout();
9d4ef80f
DC
157 $logout['repo_id'] = $repo_id;
158 echo json_encode($logout);
159 break;
160 case 'searchform':
e35194be 161 $search_form['form'] = $repo->print_search();
9d4ef80f
DC
162 echo json_encode($search_form);
163 break;
164 case 'search':
e35194be
DC
165 $search_result = $repo->search($search_text, (int)$page);
166 $search_result['repo_id'] = $repo_id;
167 $search_result['search_result'] = true;
168 echo json_encode($search_result);
9d4ef80f
DC
169 break;
170 case 'download':
e35194be
DC
171 // validate mimetype
172 $mimetypes = array();
2385e6de 173 if ((is_array($accepted_types) and in_array('*', $accepted_types)) or $accepted_types == '*') {
e35194be
DC
174 $mimetypes = '*';
175 } else {
176 foreach ($accepted_types as $type) {
16f61c70 177 $mimetypes[] = mimeinfo('type', $type);
e35194be
DC
178 }
179 if (!in_array(mimeinfo('type', $saveas_filename), $mimetypes)) {
033aad78 180 throw new moodle_exception('invalidfiletype', 'repository', '', get_string(mimeinfo('type', $saveas_filename), 'mimetypes'));
e35194be
DC
181 }
182 }
183
184 // We have two special repoisitory type need to deal with
185 // local and recent plugins don't added new files to moodle, just add new records to database
186 // so we don't check user quota and maxbytes here
187 if (in_array($repo->options['type'], array('local', 'recent', 'user'))) {
188 $fileinfo = $repo->copy_to_area($source, 'draft', $itemid, $saveas_path, $saveas_filename);
189 $info = array();
190 $info['file'] = $fileinfo['title'];
191 $info['id'] = $itemid;
16f61c70 192 $info['url'] = $CFG->httpswwwroot.'/draftfile.php/'.$fileinfo['contextid'].'/user/draft/'.$itemid.'/'.$fileinfo['title'];
e35194be
DC
193 $filesize = $fileinfo['filesize'];
194 if (($maxbytes!==-1) && ($filesize>$maxbytes)) {
195 throw new file_exception('maxbytes');
196 }
197 echo json_encode($info);
198 die; // ends here!!
199 } else {
200 $allowexternallink = (int)get_config(null, 'repositoryallowexternallinks');
201 if (!empty($allowexternallink)) {
202 $allowexternallink = true;
203 } else {
204 $allowexternallink = false;
205 }
206 // allow external links in url element all the time
207 $allowexternallink = ($allowexternallink || ($env == 'url'));
208
209 // Use link of the files
210 if ($allowexternallink and $linkexternal === 'yes' and ($repo->supported_returntypes() & FILE_EXTERNAL)) {
211 // use external link
212 $link = $repo->get_link($source);
9d4ef80f 213 $info = array();
e35194be
DC
214 $info['filename'] = $saveas_filename;
215 $info['type'] = 'link';
216 $info['url'] = $link;
acb70a9b 217 echo json_encode($info);
e35194be 218 die;
9d4ef80f 219 } else {
e35194be
DC
220 // Download file to moodle
221 $file = $repo->get_file($source, $saveas_filename);
222 if ($file['path'] === false) {
223 $err->error = get_string('cannotdownload', 'repository');
224 die(json_encode($err));
99d52655 225 }
ea1780ad 226
e35194be
DC
227 // check if exceed maxbytes
228 if (($maxbytes!==-1) && (filesize($file['path']) > $maxbytes)) {
229 throw new file_exception('maxbytes');
230 }
14469892 231
e35194be
DC
232 // check if exceed user quota
233 $userquota = file_get_user_used_space();
234 if (filesize($file['path'])+$userquota>=(int)$CFG->userquota) {
235 throw new file_exception('userquotalimit');
236 }
ea1780ad 237
e35194be
DC
238 $record = new stdclass;
239 $record->filepath = $saveas_path;
240 $record->filename = $saveas_filename;
241 $record->component = 'user';
242 $record->filearea = 'draft';
243 $record->itemid = $itemid;
14469892 244
e35194be
DC
245 if (!empty($file['license'])) {
246 $record->license = $file['license'];
247 } else {
248 $record->license = $license;
249 }
250 if (!empty($file['author'])) {
251 $record->author = $file['author'];
252 } else {
253 $record->author = $author;
254 }
255 $record->source = !empty($file['url']) ? $file['url'] : '';
1dce6261 256
e35194be
DC
257 $info = repository::move_to_filepool($file['path'], $record);
258 if (empty($info)) {
259 $info['e'] = get_string('error', 'moodle');
acb70a9b 260 }
e35194be
DC
261 echo json_encode($info);
262 die;
9d4ef80f 263 }
9d4ef80f
DC
264 }
265 break;
266 case 'upload':
f728d49b 267 // TODO: add file scanning MDL-19380 into each plugin
e35194be
DC
268 $result = $repo->upload();
269 echo json_encode($result);
9d4ef80f
DC
270 break;
271}
d0f8585d 272
273/**
274 * Small function to walk an array to attach repository ID
9d4ef80f
DC
275 * @param array $value
276 * @param string $key
277 * @param int $id
d0f8585d 278 */
279function repository_attach_id(&$value, $key, $id){
280 $value['repo_id'] = $id;
0eb58cf4 281}