Skip to content

Commit

Permalink
MDL-31863 Web service : added modified to parameters and modifiedtime…
Browse files Browse the repository at this point in the history 
… to description
  • Loading branch information
@doraemonyoung @mouneyrac
doraemonyoung authored and mouneyrac committed Jun 11, 2012
1 parent 4db0616 commit 8f30395
Showing 1 changed file with 50 additions and 33 deletions.
83 changes: 50 additions & 33 deletions files/externallib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ public static function get_files_parameters() {
'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')
'filename' => new external_value(PARAM_FILE, 'file name'),
'modified' => new external_value(PARAM_INT, 'timestamp, return files which the last ' .
'timemodified time is the same or later than the specified time', VALUE_DEFAULT, null)
)
);
}
Expand All @@ -66,12 +68,16 @@ public static function get_files_parameters() {
* @param int $itemid item id
* @param string $filepath file path
* @param string $filename file name
* @param int $modified, timestamp, timestamp,
* return files which the last timemodified time is the same or later than the specified time
* @return array
* @since Moodle 2.2
*/
public static function get_files($contextid, $component, $filearea, $itemid, $filepath, $filename) {
public static function get_files($contextid, $component, $filearea, $itemid, $filepath, $filename, $modified = null) {
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));
$fileinfo = self::validate_parameters(self::get_files_parameters(), array(
'contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea,
'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename, 'modified'=>$modified));

$browser = get_file_browser();

Expand Down Expand Up @@ -99,7 +105,9 @@ public static function get_files($contextid, $component, $filearea, $itemid, $fi
$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'])) {
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();
Expand All @@ -112,31 +120,38 @@ public static function get_files($contextid, $component, $filearea, $itemid, $fi
foreach ($children as $child) {

$params = $child->get_params();
$timemodified = $child->get_timemodified();

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;
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
);
$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;
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
);
$list[] = $node;
}
}
}
}
Expand Down Expand Up @@ -176,6 +191,7 @@ public static function get_files_returns() {
'filename' => new external_value(PARAM_FILE, ''),
'isdir' => new external_value(PARAM_BOOL, ''),
'url' => new external_value(PARAM_TEXT, ''),
'timemodified' => new external_value(PARAM_INT, ''),
)
)
)
Expand Down Expand Up @@ -219,12 +235,14 @@ public static function upload_parameters() {
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));
$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
// Saving file.
$dir = make_temp_directory('wsupload');

if (empty($fileinfo['filename'])) {
Expand All @@ -239,7 +257,6 @@ public static function upload($contextid, $component, $filearea, $itemid, $filep
$savedfilepath = $dir.$filename;
}


file_put_contents($savedfilepath, base64_decode($fileinfo['filecontent']));
unset($fileinfo['filecontent']);

Expand All @@ -250,7 +267,7 @@ public static function upload($contextid, $component, $filearea, $itemid, $filep
}

if (isset($fileinfo['itemid'])) {
// TODO MDL-31116 in user private area, itemid is always 0
// TODO MDL-31116 in user private area, itemid is always 0.
$itemid = 0;
} else {
throw new coding_exception('itemid cannot be empty');
Expand All @@ -265,19 +282,19 @@ public static function upload($contextid, $component, $filearea, $itemid, $filep
if (!($fileinfo['component'] == 'user' and $fileinfo['filearea'] == 'private')) {
throw new coding_exception('File can be uploaded to user private area only');
} else {
// TODO MDL-31116 hard-coded to use user_private area
// TODO MDL-31116 hard-coded to use user_private area.
$component = 'user';
$filearea = 'private';
}

$browser = get_file_browser();

// check existing file
// Check existing file.
if ($file = $browser->get_file_info($context, $component, $filearea, $itemid, $filepath, $filename)) {
throw new moodle_exception('fileexist');
}

// move file to filepool
// 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();
Expand Down

0 comments on commit 8f30395

Please sign in to comment.