Skip to content

Commit

Permalink
MDL-40039 webservices: Add support for alternate to contextid paramet…
Browse files Browse the repository at this point in the history 
…er to core_files_external::upload()
  • Loading branch information
@ankitagarwal
ankitagarwal committed Jun 28, 2013
1 parent f0d37f4 commit 57d16ac
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 22 deletions.
44 changes: 27 additions & 17 deletions files/externallib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public static function get_files_parameters() {
*
* @param int $contextid context id
* @param int $component component
* @param int $filearea file aera
* @param int $filearea file area
* @param int $itemid item id
* @param string $filepath file path
* @param string $filename file name
Expand Down Expand Up @@ -206,36 +206,43 @@ public static function get_files_returns() {
public static function upload_parameters() {
return new external_function_parameters(
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'),
'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')
'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 aera
* @param int $itemid item id
* @param string $filepath file path
* @param string $filename file name
* @param string $filecontent file content
* @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) {
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));
'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');
Expand Down Expand Up @@ -271,12 +278,15 @@ public static function upload($contextid, $component, $filearea, $itemid, $filep
throw new coding_exception('itemid cannot be empty');
}

if (!empty($fileinfo['contextid'])) {
$context = context::instance_by_id($fileinfo['contextid']);
} else {
$context = get_system_context();
// 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 coding_exception('File can be uploaded to user private area only');
} else {
Expand Down
33 changes: 28 additions & 5 deletions files/tests/externallib_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,17 @@ public function test_upload() {
$filepath = "/";
$filename = "Simple.txt";
$filecontent = base64_encode("Let us create a nice simple file");
$contextlevel = null;
$instanceid = null;
$browser = get_file_browser();

// Make sure no file exists.
$file = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename);
$this->assertEmpty($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.
$file = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename);
Expand All @@ -70,14 +73,28 @@ public function test_upload() {
$this->assertEmpty($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.
$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.
$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);
}

/*
Expand All @@ -96,10 +113,13 @@ public function test_upload_param_component() {
$filepath = "/";
$filename = "Simple3.txt";
$filecontent = base64_encode("Let us create a nice simple file");
$contextlevel = null;
$instanceid = null;

// Make sure exception is thrown.
$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);
}

/*
Expand All @@ -118,10 +138,13 @@ public function test_upload_param_area() {
$filepath = "/";
$filename = "Simple4.txt";
$filecontent = base64_encode("Let us create a nice simple file");
$contextlevel = null;
$instanceid = null;

// Make sure exception is thrown.
$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);
}

}

0 comments on commit 57d16ac

Please sign in to comment.