moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-04 16:36:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-40039 webservices: Add support for alternate to contextid parameter to core_files_external::upload()

Browse source
This commit is contained in:
Ankit Agarwal 2013-06-21 11:51:02 +08:00
parent f0d37f4ac5
commit 57d16acd74
2 changed files with 55 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

44
files/externallib.php
View file

@ -63,7 +63,7 @@ class core_files_external extends external_api {
* *
* @param int $contextid context id * @param int $contextid context id
* @param int $component component * @param int $component component
* @param int $filearea file aera * @param int $filearea file area
* @param int $itemid item id * @param int $itemid item id
* @param string $filepath file path * @param string $filepath file path
* @param string $filename file name * @param string $filename file name
@ -206,13 +206,17 @@ class core_files_external extends external_api {
public static function upload_parameters() { public static function upload_parameters() {
return new external_function_parameters( return new external_function_parameters(
array( array(
'contextid' => new external_value(PARAM_INT, 'context id'), 'contextid' => new external_value(PARAM_INT, 'context id', VALUE_DEFAULT, null),
'component' => new external_value(PARAM_COMPONENT, 'component'), 'component' => new external_value(PARAM_COMPONENT, 'component'),
'filearea' => new external_value(PARAM_AREA, 'file area'), 'filearea' => new external_value(PARAM_AREA, 'file area'),
'itemid' => new external_value(PARAM_INT, 'associated id'), 'itemid' => new external_value(PARAM_INT, 'associated id'),
'filepath' => new external_value(PARAM_PATH, 'file path'), 'filepath' => new external_value(PARAM_PATH, 'file path'),
'filename' => new external_value(PARAM_FILE, 'file name'), 'filename' => new external_value(PARAM_FILE, 'file name'),
'filecontent' => new external_value(PARAM_TEXT, 'file content') '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)
) )
); );
} }
@ -220,22 +224,25 @@ class core_files_external extends external_api {
/** /**
* Uploading a file to moodle * Uploading a file to moodle
* *
* @param int $contextid context id * @param int $contextid context id
* @param string $component component * @param string $component component
* @param string $filearea file aera * @param string $filearea file area
* @param int $itemid item id * @param int $itemid item id
* @param string $filepath file path * @param string $filepath file path
* @param string $filename file name * @param string $filename file name
* @param string $filecontent file content * @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 * @return array
* @since Moodle 2.2 * @since Moodle 2.2
*/ */
public static function upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent) { public static function upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent, $contextlevel, $instanceid) {
global $USER, $CFG; global $USER, $CFG;
$fileinfo = self::validate_parameters(self::upload_parameters(), array( $fileinfo = self::validate_parameters(self::upload_parameters(), array(
'contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'contextid' => $contextid, 'component' => $component, 'filearea' => $filearea, 'itemid' => $itemid,
'filepath'=>$filepath, 'filename'=>$filename, 'filecontent'=>$filecontent)); 'filepath' => $filepath, 'filename' => $filename, 'filecontent' => $filecontent, 'contextlevel' => $contextlevel,
'instanceid' => $instanceid));
if (!isset($fileinfo['filecontent'])) { if (!isset($fileinfo['filecontent'])) {
throw new moodle_exception('nofile'); throw new moodle_exception('nofile');
@ -271,12 +278,15 @@ class core_files_external extends external_api {
throw new coding_exception('itemid cannot be empty'); throw new coding_exception('itemid cannot be empty');
} }
if (!empty($fileinfo['contextid'])) { // We need to preserve backword compatibility. Context id is no more a required.
$context = context::instance_by_id($fileinfo['contextid']); if (empty($fileinfo['contextid'])) {
} else { unset($fileinfo['contextid']);
$context = get_system_context();
} }
// Get and validate context.
$context = self::get_context_from_params($fileinfo);
self::validate_context($context);
if (!($fileinfo['component'] == 'user' and $fileinfo['filearea'] == 'private')) { if (!($fileinfo['component'] == 'user' and $fileinfo['filearea'] == 'private')) {
throw new coding_exception('File can be uploaded to user private area only'); throw new coding_exception('File can be uploaded to user private area only');
} else { } else {

33
files/tests/externallib_test.php
View file

@ -50,6 +50,8 @@ class test_external_files extends advanced_testcase {
$filepath = "/"; $filepath = "/";
$filename = "Simple.txt"; $filename = "Simple.txt";
$filecontent = base64_encode("Let us create a nice simple file"); $filecontent = base64_encode("Let us create a nice simple file");
$contextlevel = null;
$instanceid = null;
$browser = get_file_browser(); $browser = get_file_browser();
// Make sure no file exists. // Make sure no file exists.
@ -57,7 +59,8 @@ class test_external_files extends advanced_testcase {
$this->assertEmpty($file); $this->assertEmpty($file);
// Call the api to create a file. // Call the api to create a file.
core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent); core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath,
$filename, $filecontent, $contextlevel, $instanceid);
// Make sure the file was created. // Make sure the file was created.
$file = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename); $file = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename);
@ -70,14 +73,28 @@ class test_external_files extends advanced_testcase {
$this->assertEmpty($file); $this->assertEmpty($file);
// Call the api to create a file. // Call the api to create a file.
$fileinfo = core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent); $fileinfo = core_files_external::upload($contextid, $component, $filearea, $itemid,
$filepath, $filename, $filecontent, $contextlevel, $instanceid);
// Make sure itemid is always set to 0. // Make sure itemid is always set to 0.
$this->assertEquals(0, $fileinfo['itemid']); $this->assertEquals(0, $fileinfo['itemid']);
// Let us try creating a file using contextlevel and instance id.
$itemid = 0;
$filename = "Simple5.txt";
$contextid = 0;
$contextlevel = "user";
$instanceid = $USER->id;
$file = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename);
$this->assertEmpty($file);
$fileinfo = core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath,
$filename, $filecontent, $contextlevel, $instanceid);
$this->assertEmpty($file);
// Make sure the same file cannot be created again. // Make sure the same file cannot be created again.
$this->setExpectedException("moodle_exception"); $this->setExpectedException("moodle_exception");
core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent); core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath,
$filename, $filecontent, $contextlevel, $instanceid);
} }
/* /*
@ -96,10 +113,13 @@ class test_external_files extends advanced_testcase {
$filepath = "/"; $filepath = "/";
$filename = "Simple3.txt"; $filename = "Simple3.txt";
$filecontent = base64_encode("Let us create a nice simple file"); $filecontent = base64_encode("Let us create a nice simple file");
$contextlevel = null;
$instanceid = null;
// Make sure exception is thrown. // Make sure exception is thrown.
$this->setExpectedException("coding_exception"); $this->setExpectedException("coding_exception");
core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent); core_files_external::upload($contextid, $component, $filearea, $itemid,
$filepath, $filename, $filecontent, $contextlevel, $instanceid);
} }
/* /*
@ -118,10 +138,13 @@ class test_external_files extends advanced_testcase {
$filepath = "/"; $filepath = "/";
$filename = "Simple4.txt"; $filename = "Simple4.txt";
$filecontent = base64_encode("Let us create a nice simple file"); $filecontent = base64_encode("Let us create a nice simple file");
$contextlevel = null;
$instanceid = null;
// Make sure exception is thrown. // Make sure exception is thrown.
$this->setExpectedException("coding_exception"); $this->setExpectedException("coding_exception");
core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath, $filename, $filecontent); core_files_external::upload($contextid, $component, $filearea, $itemid, $filepath,
$filename, $filecontent, $contextlevel, $instanceid);
} }
} }