Skip to content

Commit

Permalink
MDL-54869 files: Create new required functions
Browse files Browse the repository at this point in the history 
This was a complex change requiring three new functions:
file_merge_files_from_draft_area_into_filearea - To just add files from a draft area into a real one (just adding or updating, not deleting)
file_merge_draft_area_into_draft_area - To merge files from two draft areas, used by the latest for creating a draft area with all the original files plus the new ones.
file_overwrite_existing_draftfile - Required to update existing files not losing metadata or references.

The whole process is the following:

    User uploads a file (upload.php)
    Client gets a new draftid A containing the file only (return of upload.php)
    Client requests to merge that draftid in the user's private files (core_user_add_user_private_files)
    Server prepares a new UNUSED draftid B from existing area
    Server merges A into B
    Server saves the draft B into the final area
  • Loading branch information
@jleyva
jleyva committed Jul 5, 2016
1 parent d089e49 commit 4608970
Show file tree
Hide file tree
Showing 3 changed files with 356 additions and 2 deletions.
141 changes: 140 additions & 1 deletion lib/filelib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,7 @@ function file_restore_source_field_from_draft_file($storedfile) {
return $storedfile;
}
/**
* Saves files from a draft file area to a real one (replacing and removing files in the real file area).
* Saves files from a draft file area to a real one (merging the list of files).
* Can rewrite URLs in some content at the same time if desired.
*
* @category files
Expand Down Expand Up @@ -2688,6 +2688,145 @@ function file_is_executable($filename) {
}
}

/**
* Overwrite an existing file in a draft area.
*
* @param stored_file $newfile the new file with the new content and meta-data
* @param stored_file $existingfile the file that will be overwritten
* @throws moodle_exception
* @since Moodle 3.2
*/
function file_overwrite_existing_draftfile(stored_file $newfile, stored_file $existingfile) {
if ($existingfile->get_component() != 'user' or $existingfile->get_filearea() != 'draft') {
throw new coding_exception('The file to overwrite is not in a draft area.');
}

$fs = get_file_storage();
// Remember original file source field.
$source = @unserialize($existingfile->get_source());
// Remember the original sortorder.
$sortorder = $existingfile->get_sortorder();
if ($newfile->is_external_file()) {
// New file is a reference. Check that existing file does not have any other files referencing to it
if (isset($source->original) && $fs->search_references_count($source->original)) {
throw new moodle_exception('errordoublereference', 'repository');
}
}

// Delete existing file to release filename.
$newfilerecord = array(
'contextid' => $existingfile->get_contextid(),
'component' => 'user',
'filearea' => 'draft',
'itemid' => $existingfile->get_itemid(),
'timemodified' => time()
);
$existingfile->delete();

// Create new file.
$newfile = $fs->create_file_from_storedfile($newfilerecord, $newfile);
// Preserve original file location (stored in source field) for handling references.
if (isset($source->original)) {
if (!($newfilesource = @unserialize($newfile->get_source()))) {
$newfilesource = new stdClass();
}
$newfilesource->original = $source->original;
$newfile->set_source(serialize($newfilesource));
}
$newfile->set_sortorder($sortorder);
}

/**
* Add files from a draft area into a final area.
*
* Most of the time you do not want to use this. It is intended to be used
* by asynchronous services which cannot direcly manipulate a final
* area through a draft area. Instead they add files to a new draft
* area and merge that new draft into the final area when ready.
*
* @param int $draftitemid the id of the draft area to use.
* @param int $contextid this parameter and the next two identify the file area to save to.
* @param string $component component name
* @param string $filearea indentifies the file area
* @param int $itemid identifies the item id or false for all items in the file area
* @param array $options area options (subdirs=false, maxfiles=-1, maxbytes=0, areamaxbytes=FILE_AREA_MAX_BYTES_UNLIMITED)
* @see file_save_draft_area_files
* @since Moodle 3.2
*/
function file_merge_files_from_draft_area_into_filearea($draftitemid, $contextid, $component, $filearea, $itemid,
array $options = null) {
// We use 0 here so file_prepare_draft_area creates a new one, finaldraftid will be updated with the new draft id.
$finaldraftid = 0;
file_prepare_draft_area($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
file_merge_draft_area_into_draft_area($draftitemid, $finaldraftid);
file_save_draft_area_files($finaldraftid, $contextid, $component, $filearea, $itemid, $options);
}

/**
* Merge files from two draftarea areas.
*
* This does not handle conflict resolution, files in the destination area which appear
* to be more recent will be kept disregarding the intended ones.
*
* @param int $getfromdraftid the id of the draft area where are the files to merge.
* @param int $mergeintodraftid the id of the draft area where new files will be merged.
* @throws coding_exception
* @since Moodle 3.2
*/
function file_merge_draft_area_into_draft_area($getfromdraftid, $mergeintodraftid) {
global $USER;

$fs = get_file_storage();
$contextid = context_user::instance($USER->id)->id;

if (!$filestomerge = $fs->get_area_files($contextid, 'user', 'draft', $getfromdraftid)) {
throw new coding_exception('Nothing to merge or area does not belong to current user');
}

$currentfiles = $fs->get_area_files($contextid, 'user', 'draft', $mergeintodraftid);

// Get hashes of the files to merge.
$newhashes = array();
foreach ($filestomerge as $filetomerge) {
$filepath = $filetomerge->get_filepath();
$filename = $filetomerge->get_filename();

$newhash = $fs->get_pathname_hash($contextid, 'user', 'draft', $mergeintodraftid, $filepath, $filename);
$newhashes[$newhash] = $filetomerge;
}

// Calculate wich files must be added.
foreach ($currentfiles as $file) {
$filehash = $file->get_pathnamehash();
// One file to be merged already exists.
if (isset($newhashes[$filehash])) {
$updatedfile = $newhashes[$filehash];

// Avoid race conditions.
if ($file->get_timemodified() > $updatedfile->get_timemodified()) {
// The existing file is more recent, do not copy the suposedly "new" one.
unset($newhashes[$filehash]);
continue;
}
// Update existing file (not only content, meta-data too).
file_overwrite_existing_draftfile($updatedfile, $file);
unset($newhashes[$filehash]);
}
}

foreach ($newhashes as $newfile) {
$newfilerecord = array(
'contextid' => $contextid,
'component' => 'user',
'filearea' => 'draft',
'itemid' => $mergeintodraftid,
'timemodified' => time()
);

$fs->create_file_from_storedfile($newfilerecord, $newfile);
}
}

/**
* RESTful cURL class
*
Expand Down
215 changes: 215 additions & 0 deletions lib/tests/filelib_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -971,6 +971,221 @@ public function test_file_rewrite_pluginfile_urls() {
// Compare the final text is the same that the original.
$this->assertEquals($originaltext, $finaltext);
}

/**
* Helpter function to create draft files
*
* @param array $filedata data for the file record (to not use defaults)
* @return stored_file the stored file instance
*/
public static function create_draft_file($filedata = array()) {
global $USER;

self::setAdminUser();
$fs = get_file_storage();

$filerecord = array(
'component' => 'user',
'filearea' => 'draft',
'itemid' => isset($filedata['itemid']) ? $filedata['itemid'] : file_get_unused_draft_itemid(),
'author' => isset($filedata['author']) ? $filedata['author'] : fullname($USER),
'filepath' => isset($filedata['filepath']) ? $filedata['filepath'] : '/',
'filename' => isset($filedata['filename']) ? $filedata['filename'] : 'file.txt',
);

if (isset($filedata['contextid'])) {
$filerecord['contextid'] = $filedata['contextid'];
} else {
$usercontext = context_user::instance($USER->id);
$filerecord['contextid'] = $usercontext->id;
}
$source = isset($filedata['source']) ? $filedata['source'] : serialize((object)array('source' => 'From string'));
$content = isset($filedata['content']) ? $filedata['content'] : 'some content here';

$file = $fs->create_file_from_string($filerecord, $content);
$file->set_source($source);

return $file;
}

/**
* Test file_merge_files_from_draft_area_into_filearea
*/
public function test_file_merge_files_from_draft_area_into_filearea() {
global $USER, $CFG;

$this->resetAfterTest(true);
$this->setAdminUser();
$fs = get_file_storage();
$usercontext = context_user::instance($USER->id);

// Create a draft file.
$filename = 'data.txt';
$filerecord = array(
'filename' => $filename,
);
$file = self::create_draft_file($filerecord);

$maxbytes = $CFG->userquota;
$maxareabytes = $CFG->userquota;
$options = array('subdirs' => 1,
'maxbytes' => $maxbytes,
'maxfiles' => -1,
'areamaxbytes' => $maxareabytes);

// Add new file.
file_merge_files_from_draft_area_into_filearea($file->get_itemid(), $usercontext->id, 'user', 'private', 0, $options);

$files = $fs->get_area_files($usercontext->id, 'user', 'private', 0);
// Directory and file.
$this->assertCount(2, $files);
$found = false;
foreach ($files as $file) {
if (!$file->is_directory()) {
$found = true;
$this->assertEquals($filename, $file->get_filename());
$this->assertEquals('some content here', $file->get_content());
}
}
$this->assertTrue($found);

// Add two more files.
$filerecord = array(
'itemid' => $file->get_itemid(),
'filename' => 'second.txt',
);
self::create_draft_file($filerecord);
$filerecord = array(
'itemid' => $file->get_itemid(),
'filename' => 'third.txt',
);
$file = self::create_draft_file($filerecord);

file_merge_files_from_draft_area_into_filearea($file->get_itemid(), $usercontext->id, 'user', 'private', 0, $options);

$files = $fs->get_area_files($usercontext->id, 'user', 'private', 0);
$this->assertCount(4, $files);

// Update contents of one file.
$filerecord = array(
'filename' => 'second.txt',
'content' => 'new content',
);
$file = self::create_draft_file($filerecord);
file_merge_files_from_draft_area_into_filearea($file->get_itemid(), $usercontext->id, 'user', 'private', 0, $options);

$files = $fs->get_area_files($usercontext->id, 'user', 'private', 0);
$this->assertCount(4, $files);
$found = false;
foreach ($files as $file) {
if ($file->get_filename() == 'second.txt') {
$found = true;
$this->assertEquals('new content', $file->get_content());
}
}
$this->assertTrue($found);

// Update author.
// Set different author in the current file.
foreach ($files as $file) {
if ($file->get_filename() == 'second.txt') {
$file->set_author('Nobody');
}
}
$filerecord = array(
'filename' => 'second.txt',
);
$file = self::create_draft_file($filerecord);

file_merge_files_from_draft_area_into_filearea($file->get_itemid(), $usercontext->id, 'user', 'private', 0, $options);

$files = $fs->get_area_files($usercontext->id, 'user', 'private', 0);
$this->assertCount(4, $files);
$found = false;
foreach ($files as $file) {
if ($file->get_filename() == 'second.txt') {
$found = true;
$this->assertEquals(fullname($USER), $file->get_author());
}
}
$this->assertTrue($found);

}

/**
* Test max area bytes for file_merge_files_from_draft_area_into_filearea
*/
public function test_file_merge_files_from_draft_area_into_filearea_max_area_bytes() {
global $USER;

$this->resetAfterTest(true);
$this->setAdminUser();
$fs = get_file_storage();

$file = self::create_draft_file();
$options = array('subdirs' => 1,
'maxbytes' => 5,
'maxfiles' => -1,
'areamaxbytes' => 10);

// Add new file.
file_merge_files_from_draft_area_into_filearea($file->get_itemid(), $file->get_contextid(), 'user', 'private', 0, $options);
$usercontext = context_user::instance($USER->id);
$files = $fs->get_area_files($usercontext->id, 'user', 'private', 0);
$this->assertCount(0, $files);
}

/**
* Test max file bytes for file_merge_files_from_draft_area_into_filearea
*/
public function test_file_merge_files_from_draft_area_into_filearea_max_file_bytes() {
global $USER;

$this->resetAfterTest(true);
$this->setAdminUser();
$fs = get_file_storage();

$file = self::create_draft_file();
$options = array('subdirs' => 1,
'maxbytes' => 1,
'maxfiles' => -1,
'areamaxbytes' => 100);

// Add new file.
file_merge_files_from_draft_area_into_filearea($file->get_itemid(), $file->get_contextid(), 'user', 'private', 0, $options);
$usercontext = context_user::instance($USER->id);
// Check we only get the base directory, not a new file.
$files = $fs->get_area_files($usercontext->id, 'user', 'private', 0);
$this->assertCount(1, $files);
$file = array_shift($files);
$this->assertTrue($file->is_directory());
}

/**
* Test max file number for file_merge_files_from_draft_area_into_filearea
*/
public function test_file_merge_files_from_draft_area_into_filearea_max_files() {
global $USER;

$this->resetAfterTest(true);
$this->setAdminUser();
$fs = get_file_storage();

$file = self::create_draft_file();
$options = array('subdirs' => 1,
'maxbytes' => 1000,
'maxfiles' => 0,
'areamaxbytes' => 1000);

// Add new file.
file_merge_files_from_draft_area_into_filearea($file->get_itemid(), $file->get_contextid(), 'user', 'private', 0, $options);
$usercontext = context_user::instance($USER->id);
// Check we only get the base directory, not a new file.
$files = $fs->get_area_files($usercontext->id, 'user', 'private', 0);
$this->assertCount(1, $files);
$file = array_shift($files);
$this->assertTrue($file->is_directory());
}
}

/**
Expand Down
2 changes: 1 addition & 1 deletion webservice/upload.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
$file_record->itemid = $itemid;
$file_record->license = $CFG->sitedefaultlicense;
$file_record->author = fullname($authenticationinfo['user']);
$file_record->source = '';
$file_record->source = serialize((object)array('source' => $file->filename));

//Check if the file already exist
$existingfile = $fs->file_exists($file_record->contextid, $file_record->component, $file_record->filearea,
Expand Down

0 comments on commit 4608970

Please sign in to comment.