mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
externallib.php
298 lines (270 loc) · 11.4 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
<?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 moodlecore
* @subpackage webservice
* @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
* @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");
class moodle_file_external extends external_api {
/**
* Returns description of get_files parameters
* @return external_function_parameters
*/
public static function get_files_parameters() {
return new external_function_parameters(
array(
'contextid' => new external_value(PARAM_INT, 'context id'),
'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_FILE, 'file name')
)
);
}
/**
* Return moodle files listing
* @param int $contextid
* @param int $component
* @param int $filearea
* @param int $itemid
* @param string $filepath
* @param string $filename
* @return array
*/
public static function get_files($contextid, $component, $filearea, $itemid, $filepath, $filename) {
global $CFG, $USER, $OUTPUT;
$fileinfo = self::validate_parameters(self::get_files_parameters(), array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename));
$browser = get_file_browser();
if (empty($fileinfo['contextid'])) {
$context = get_system_context();
} else {
$context = get_context_instance_by_id($fileinfo['contextid']);
}
if (empty($fileinfo['component'])) {
$fileinfo['component'] = null;
}
if (empty($fileinfo['filearea'])) {
$fileinfo['filearea'] = null;
}
if (empty($fileinfo['itemid'])) {
$fileinfo['itemid'] = null;
}
if (empty($fileinfo['filename'])) {
$fileinfo['filename'] = null;
}
if (empty($fileinfo['filepath'])) {
$fileinfo['filepath'] = null;
}
$return = array();
$return['parents'] = array();
$return['files'] = 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();
}
$list = array();
$children = $file->get_children();
foreach ($children as $child) {
$params = $child->get_params();
if ($child->is_directory()) {
$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
);
$list[] = $node;
} else {
$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
);
$list[] = $node;
}
}
}
$return['files'] = $list;
return $return;
}
/**
* Returns description of get_files returns
* @return external_multiple_structure
*/
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_ALPHAEXT, ''),
'filearea' => new external_value(PARAM_ALPHAEXT, ''),
'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_ALPHAEXT, ''),
'filearea' => new external_value(PARAM_ALPHAEXT, ''),
'itemid' => new external_value(PARAM_INT, ''),
'filepath' => new external_value(PARAM_TEXT, ''),
'filename' => new external_value(PARAM_FILE, ''),
'isdir' => new external_value(PARAM_BOOL, ''),
'url' => new external_value(PARAM_TEXT, ''),
)
)
)
)
);
}
/**
* Returns description of upload parameters
* @return external_function_parameters
*/
public static function upload_parameters() {
return new external_function_parameters(
array(
'contextid' => new external_value(PARAM_INT, 'context id'),
'component' => new external_value(PARAM_ALPHAEXT, 'component'),
'filearea' => new external_value(PARAM_ALPHAEXT, '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')
)
);
}
/**
* Uploading a file to moodle
*
* @param int $contextid
* @param string $component
* @param string $filearea
* @param int $itemid
* @param string $filepath
* @param string $filename
* @param string $filecontent
* @return array
*/
public static function upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent) {
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));
if (!isset($fileinfo['filecontent'])) {
throw new moodle_exception('nofile');
}
// saving file
$dir = make_upload_directory('temp/wsupload');
if (empty($fileinfo['filename'])) {
$filename = uniqid('wsupload').'_'.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']));
unset($fileinfo['filecontent']);
if (!empty($fileinfo['filepath'])) {
$filepath = $fileinfo['filepath'];
} else {
$filepath = '/';
}
if (isset($fileinfo['itemid'])) {
// TODO: in user private area, itemid is always 0
$itemid = 0;
} else {
throw new coding_exception('itemid cannot be empty');
}
if (!empty($fileinfo['contextid'])) {
$context = get_context_instance_by_id($fileinfo['contextid']);
} else {
$context = get_system_context();
}
if (!($fileinfo['component'] == 'user' and $fileinfo['filearea'] == 'private')) {
throw new coding_exception('File can be uploaded to user private area only');
} else {
// TODO: hard-coded to use user_private area
$component = 'user';
$filearea = 'private';
}
$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_multiple_structure
*/
public static function upload_returns() {
return new external_single_structure(
array(
'contextid' => new external_value(PARAM_INT, ''),
'component' => new external_value(PARAM_ALPHAEXT, ''),
'filearea' => new external_value(PARAM_ALPHAEXT, ''),
'itemid' => new external_value(PARAM_INT, ''),
'filepath' => new external_value(PARAM_TEXT, ''),
'filename' => new external_value(PARAM_FILE, ''),
'url' => new external_value(PARAM_TEXT, ''),
)
);
}
}