forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
externallib.php
387 lines (355 loc) · 16.2 KB
/
externallib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<?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/>.
/**
* External files API
*
* @package core_files
* @category external
* @copyright 2010 Dongsheng Cai
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("$CFG->libdir/externallib.php");
require_once("$CFG->libdir/filelib.php");
/**
* Files external functions
*
* @package core_files
* @category external
* @copyright 2011 Jerome Mouneyrac
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.2
*/
class core_files_external extends external_api {
/**
* Returns description of get_files parameters
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function get_files_parameters() {
return new external_function_parameters(
array(
'contextid' => new external_value(PARAM_INT, 'context id Set to -1 to use contextlevel and instanceid.'),
'component' => new external_value(PARAM_TEXT, 'component'),
'filearea' => new external_value(PARAM_TEXT, 'file area'),
'itemid' => new external_value(PARAM_INT, 'associated id'),
'filepath' => new external_value(PARAM_PATH, 'file path'),
'filename' => new external_value(PARAM_TEXT, 'file name'),
'modified' => new external_value(PARAM_INT, 'timestamp to return files changed after this time.', VALUE_DEFAULT, null),
'contextlevel' => new external_value(PARAM_ALPHA, 'The context level for the file location.', VALUE_DEFAULT, null),
'instanceid' => new external_value(PARAM_INT, 'The instance id for where the file is located.', VALUE_DEFAULT, null)
)
);
}
/**
* Return moodle files listing
*
* @param int $contextid context id
* @param int $component component
* @param int $filearea file area
* @param int $itemid item id
* @param string $filepath file path
* @param string $filename file name
* @param int $modified timestamp to return files changed after this time.
* @param string $contextlevel The context level for the file location.
* @param int $instanceid The instance id for where the file is located.
* @return array
* @since Moodle 2.9 Returns additional fields (timecreated, filesize, author, license)
* @since Moodle 2.2
*/
public static function get_files($contextid, $component, $filearea, $itemid, $filepath, $filename, $modified = null,
$contextlevel = null, $instanceid = null) {
$parameters = array(
'contextid' => $contextid,
'component' => $component,
'filearea' => $filearea,
'itemid' => $itemid,
'filepath' => $filepath,
'filename' => $filename,
'modified' => $modified,
'contextlevel' => $contextlevel,
'instanceid' => $instanceid);
$fileinfo = self::validate_parameters(self::get_files_parameters(), $parameters);
$browser = get_file_browser();
// We need to preserve backwards compatibility. Zero will use the system context and minus one will
// use the addtional parameters to determine the context.
// TODO MDL-40489 get_context_from_params should handle this logic.
if ($fileinfo['contextid'] == 0) {
$context = context_system::instance();
} else {
if ($fileinfo['contextid'] == -1) {
$fileinfo['contextid'] = null;
}
$context = self::get_context_from_params($fileinfo);
}
self::validate_context($context);
if (empty($fileinfo['component'])) {
$fileinfo['component'] = null;
}
if (empty($fileinfo['filearea'])) {
$fileinfo['filearea'] = null;
}
if (empty($fileinfo['filename'])) {
$fileinfo['filename'] = null;
}
if (empty($fileinfo['filepath'])) {
$fileinfo['filepath'] = null;
}
$return = array();
$return['parents'] = array();
$return['files'] = array();
$list = array();
if ($file = $browser->get_file_info(
$context, $fileinfo['component'], $fileinfo['filearea'], $fileinfo['itemid'],
$fileinfo['filepath'], $fileinfo['filename'])) {
$level = $file->get_parent();
while ($level) {
$params = $level->get_params();
$params['filename'] = $level->get_visible_name();
array_unshift($return['parents'], $params);
$level = $level->get_parent();
}
$children = $file->get_children();
foreach ($children as $child) {
$params = $child->get_params();
$timemodified = $child->get_timemodified();
$timecreated = $child->get_timecreated();
if ($child->is_directory()) {
if ((is_null($modified)) or ($modified < $timemodified)) {
$node = array(
'contextid' => $params['contextid'],
'component' => $params['component'],
'filearea' => $params['filearea'],
'itemid' => $params['itemid'],
'filepath' => $params['filepath'],
'filename' => $child->get_visible_name(),
'url' => null,
'isdir' => true,
'timemodified' => $timemodified,
'timecreated' => $timecreated,
'filesize' => 0,
'author' => null,
'license' => null
);
$list[] = $node;
}
} else {
if ((is_null($modified)) or ($modified < $timemodified)) {
$node = array(
'contextid' => $params['contextid'],
'component' => $params['component'],
'filearea' => $params['filearea'],
'itemid' => $params['itemid'],
'filepath' => $params['filepath'],
'filename' => $child->get_visible_name(),
'url' => $child->get_url(),
'isdir' => false,
'timemodified' => $timemodified,
'timecreated' => $timecreated,
'filesize' => $child->get_filesize(),
'author' => $child->get_author(),
'license' => $child->get_license()
);
$list[] = $node;
}
}
}
}
$return['files'] = $list;
return $return;
}
/**
* Returns description of get_files returns
*
* @return external_single_structure
* @since Moodle 2.9 Returns additional fields for files (timecreated, filesize, author, license)
* @since Moodle 2.2
*/
public static function get_files_returns() {
return new external_single_structure(
array(
'parents' => new external_multiple_structure(
new external_single_structure(
array(
'contextid' => new external_value(PARAM_INT, ''),
'component' => new external_value(PARAM_COMPONENT, ''),
'filearea' => new external_value(PARAM_AREA, ''),
'itemid' => new external_value(PARAM_INT, ''),
'filepath' => new external_value(PARAM_TEXT, ''),
'filename' => new external_value(PARAM_TEXT, ''),
)
)
),
'files' => new external_multiple_structure(
new external_single_structure(
array(
'contextid' => new external_value(PARAM_INT, ''),
'component' => new external_value(PARAM_COMPONENT, ''),
'filearea' => new external_value(PARAM_AREA, ''),
'itemid' => new external_value(PARAM_INT, ''),
'filepath' => new external_value(PARAM_TEXT, ''),
'filename' => new external_value(PARAM_TEXT, ''),
'isdir' => new external_value(PARAM_BOOL, ''),
'url' => new external_value(PARAM_TEXT, ''),
'timemodified' => new external_value(PARAM_INT, ''),
'timecreated' => new external_value(PARAM_INT, 'Time created', VALUE_OPTIONAL),
'filesize' => new external_value(PARAM_INT, 'File size', VALUE_OPTIONAL),
'author' => new external_value(PARAM_TEXT, 'File owner', VALUE_OPTIONAL),
'license' => new external_value(PARAM_TEXT, 'File license', VALUE_OPTIONAL),
)
)
)
)
);
}
/**
* Returns description of upload parameters
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function upload_parameters() {
return new external_function_parameters(
array(
'contextid' => new external_value(PARAM_INT, 'context id', VALUE_DEFAULT, null),
'component' => new external_value(PARAM_COMPONENT, 'component'),
'filearea' => new external_value(PARAM_AREA, 'file area'),
'itemid' => new external_value(PARAM_INT, 'associated id'),
'filepath' => new external_value(PARAM_PATH, 'file path'),
'filename' => new external_value(PARAM_FILE, 'file name'),
'filecontent' => new external_value(PARAM_TEXT, 'file content'),
'contextlevel' => new external_value(PARAM_ALPHA, 'The context level to put the file in,
(block, course, coursecat, system, user, module)', VALUE_DEFAULT, null),
'instanceid' => new external_value(PARAM_INT, 'The Instance id of item associated
with the context level', VALUE_DEFAULT, null)
)
);
}
/**
* Uploading a file to moodle
*
* @param int $contextid context id
* @param string $component component
* @param string $filearea file area
* @param int $itemid item id
* @param string $filepath file path
* @param string $filename file name
* @param string $filecontent file content
* @param string $contextlevel Context level (block, course, coursecat, system, user or module)
* @param int $instanceid Instance id of the item associated with the context level
* @return array
* @since Moodle 2.2
*/
public static function upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent, $contextlevel, $instanceid) {
global $USER, $CFG;
$fileinfo = self::validate_parameters(self::upload_parameters(), array(
'contextid' => $contextid, 'component' => $component, 'filearea' => $filearea, 'itemid' => $itemid,
'filepath' => $filepath, 'filename' => $filename, 'filecontent' => $filecontent, 'contextlevel' => $contextlevel,
'instanceid' => $instanceid));
if (!isset($fileinfo['filecontent'])) {
throw new moodle_exception('nofile');
}
// Saving file.
$dir = make_temp_directory('wsupload');
if (empty($fileinfo['filename'])) {
$filename = uniqid('wsupload', true).'_'.time().'.tmp';
} else {
$filename = $fileinfo['filename'];
}
if (file_exists($dir.$filename)) {
$savedfilepath = $dir.uniqid('m').$filename;
} else {
$savedfilepath = $dir.$filename;
}
file_put_contents($savedfilepath, base64_decode($fileinfo['filecontent']));
@chmod($savedfilepath, $CFG->filepermissions);
unset($fileinfo['filecontent']);
if (!empty($fileinfo['filepath'])) {
$filepath = $fileinfo['filepath'];
} else {
$filepath = '/';
}
// Only allow uploads to draft area
if (!($fileinfo['component'] == 'user' and $fileinfo['filearea'] == 'draft')) {
throw new coding_exception('File can be uploaded to user draft area only');
} else {
$component = 'user';
$filearea = $fileinfo['filearea'];
}
$itemid = 0;
if (isset($fileinfo['itemid'])) {
$itemid = $fileinfo['itemid'];
}
if ($filearea == 'draft' && $itemid <= 0) {
// Generate a draft area for the files.
$itemid = file_get_unused_draft_itemid();
} else if ($filearea == 'private') {
// TODO MDL-31116 in user private area, itemid is always 0.
$itemid = 0;
}
// We need to preserve backword compatibility. Context id is no more a required.
if (empty($fileinfo['contextid'])) {
unset($fileinfo['contextid']);
}
// Get and validate context.
$context = self::get_context_from_params($fileinfo);
self::validate_context($context);
if (($fileinfo['component'] == 'user' and $fileinfo['filearea'] == 'private')) {
throw new moodle_exception('privatefilesupload');
}
$browser = get_file_browser();
// Check existing file.
if ($file = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename)) {
throw new moodle_exception('fileexist');
}
// Move file to filepool.
if ($dir = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, '.')) {
$info = $dir->create_file_from_pathname($filename, $savedfilepath);
$params = $info->get_params();
unlink($savedfilepath);
return array(
'contextid'=>$params['contextid'],
'component'=>$params['component'],
'filearea'=>$params['filearea'],
'itemid'=>$params['itemid'],
'filepath'=>$params['filepath'],
'filename'=>$params['filename'],
'url'=>$info->get_url()
);
} else {
throw new moodle_exception('nofile');
}
}
/**
* Returns description of upload returns
*
* @return external_single_structure
* @since Moodle 2.2
*/
public static function upload_returns() {
return new external_single_structure(
array(
'contextid' => new external_value(PARAM_INT, ''),
'component' => new external_value(PARAM_COMPONENT, ''),
'filearea' => new external_value(PARAM_AREA, ''),
'itemid' => new external_value(PARAM_INT, ''),
'filepath' => new external_value(PARAM_TEXT, ''),
'filename' => new external_value(PARAM_FILE, ''),
'url' => new external_value(PARAM_TEXT, ''),
)
);
}
}