moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-07 09:56:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-45616 repositories: more clearly distinguish when we use source and when reference

Browse source 
Function repository::get_moodle_file() should always be called on packed reference and not on the source received from user.
Also added phpdocs to some other methods that were confusing source and reference
This commit is contained in:
Marina Glancy 2014-06-25 14:40:27 +08:00 • committed by Damyon Wiese
parent 7d6e6ffceb
commit 68170f0b01
3 changed files with 15 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

2
repository/filepicker.php
View file

@ -293,7 +293,7 @@ case 'download':
// note that in this case user may not have permission to access the source file directly
// so no file_browser/file_info can be used below
if ($repo->has_moodle_files()) {
$file = repository::get_moodle_file($fileurl);
$file = repository::get_moodle_file($reference);
if ($file && $file->is_external_file()) {
$sourcefield = $file->get_source(); // remember the original source
$record->source = $repo::build_source_field($sourcefield);

23
repository/lib.php
View file

@ -828,13 +828,14 @@ abstract class repository implements cacheable_object {
}
/**
* Parses the 'source' returned by moodle repositories and returns an instance of stored_file
* Parses the moodle file reference and returns an instance of stored_file
*
* @param string $source
* @param string $reference reference to the moodle internal file as retruned by
* {@link repository::get_file_reference()} or {@link file_storage::pack_reference()}
* @return stored_file|null
*/
public static function get_moodle_file($source) {
$params = file_storage::unpack_reference($source, true);
public static function get_moodle_file($reference) {
$params = file_storage::unpack_reference($reference, true);
$fs = get_file_storage();
return $fs->get_file($params['contextid'], $params['component'], $params['filearea'],
$params['itemid'], $params['filepath'], $params['filename']);
@ -846,13 +847,14 @@ abstract class repository implements cacheable_object {
* This is checked when user tries to pick the file from repository to deal with
* potential parameter substitutions is request
*
* @param string $source
* @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
* @return bool whether the file is accessible by current user
*/
public function file_is_accessible($source) {
if ($this->has_moodle_files()) {
$reference = $this->get_file_reference($source);
try {
$params = file_storage::unpack_reference($source, true);
$params = file_storage::unpack_reference($reference, true);
} catch (file_reference_exception $e) {
return false;
}
@ -1365,12 +1367,13 @@ abstract class repository implements cacheable_object {
* again to another file area (also as a copy or as a reference), the value of
* files.source is copied.
*
* @param string $source the value that repository returned in listing as 'source'
* @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
* @return string|null
*/
public function get_file_source_info($source) {
if ($this->has_moodle_files()) {
return $this->get_reference_details($source, 0);
$reference = $this->get_file_reference($source);
return $this->get_reference_details($reference, 0);
}
return $source;
}
@ -1651,11 +1654,11 @@ abstract class repository implements cacheable_object {
/**
* Prepare file reference information
*
* @param string $source
* @param string $source source of the file, returned by repository as 'source' and received back from user (not cleaned)
* @return string file referece
*/
public function get_file_reference($source) {
if ($this->has_moodle_files() && ($this->supported_returntypes() & FILE_REFERENCE)) {
if ($source && $this->has_moodle_files()) {
$params = file_storage::unpack_reference($source);
if (!is_array($params)) {
throw new repository_exception('invalidparams', 'repository');

2
repository/repository_ajax.php
View file

@ -208,7 +208,7 @@ switch ($action) {
// note that in this case user may not have permission to access the source file directly
// so no file_browser/file_info can be used below
if ($repo->has_moodle_files()) {
$file = repository::get_moodle_file($source);
$file = repository::get_moodle_file($reference);
if ($file && $file->is_external_file()) {
$sourcefield = $file->get_source(); // remember the original source
$record->source = $repo::build_source_field($sourcefield);