mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-17 21:49:15 +01:00
Code Issues Projects Releases Wiki Activity

MDL-62208 core_fileconverter: Implement privacy API

Browse Source
This commit is contained in:
Frédéric Massart 2018-04-26 12:54:01 +08:00
parent 641d113c88
commit 790c89b34d
5 changed files with 194 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
files/classes/conversion.php
View File

@ -199,6 +199,32 @@ class conversion extends \core\persistent {
]);
}
/**
* Remove orphan records.
*
* Records are considered orphans when their source file not longer exists.
* In this scenario we do not want to keep the converted file any longer,
* in particular to be compliant with privacy laws.
*/
public static function remove_orphan_records() {
global $DB;
$sql = "
SELECT c.id
FROM {" . self::TABLE . "} c
LEFT JOIN {files} f
ON f.id = c.sourcefileid
WHERE f.id IS NULL";
$ids = $DB->get_fieldset_sql($sql, []);
if (empty($ids)) {
return;
}
list($insql, $inparams) = $DB->get_in_or_equal($ids, SQL_PARAMS_NAMED);
$DB->delete_records_select(self::TABLE, "id $insql", $inparams);
}
/**
* Set the source file id for the conversion.
*

1
files/classes/task/conversion_cleanup_task.php
View File

@ -48,6 +48,7 @@ class conversion_cleanup_task extends \core\task\scheduled_task {
*/
public function execute() {
\core_files\conversion::remove_old_conversion_records();
\core_files\conversion::remove_orphan_records();
}
}

96
files/converter/classes/privacy/provider.php Normal file
View File

@ -0,0 +1,96 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Data provider.
*
* @package core_fileconverter
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_fileconverter\privacy;
defined('MOODLE_INTERNAL') || die();
use context;
use core_privacy\local\metadata\collection;
use core_privacy\local\request\approved_contextlist;
/**
* Data provider class.
*
* @package core_fileconverter
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider implements
\core_privacy\local\metadata\provider,
\core_privacy\local\request\subsystem\provider {
/**
* Returns metadata.
*
* @param collection $collection The initialised collection to add items to.
* @return collection A listing of user data stored through this system.
*/
public static function get_metadata(collection $collection) : collection {
$collection->add_plugintype_link('fileconverter', [], 'privacy:metadata:plugintypefileconverter');
return $collection;
}
/**
* Get the list of contexts that contain user information for the specified user.
*
* @param int $userid The user to search.
* @return \contextlist $contextlist The contextlist containing the list of contexts used in this plugin.
*/
public static function get_contexts_for_userid(int $userid) : \core_privacy\local\request\contextlist {
// We cannot associate files with a particular user as it would require to know all the details about
// the source file, which only the component owning it knows about. And, the 'usermodified' attribute
// of the conversion class is not an identifier of data ownership, merely that this user was logged in
// when the conversion was requested. As such, as the owning component should declare the source file,
// and we can't make sense of 'usermodified', we will not be reporting anything here. Also note that
// the clean up task will ensure that whenever a source file is delete, its conversions also are.
return new \core_privacy\local\request\contextlist();
}
/**
* Export all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts to export information for.
*/
public static function export_user_data(approved_contextlist $contextlist) {
}
/**
* Delete all data for all users in the specified context.
*
* @param context $context The specific context to delete data for.
*/
public static function delete_data_for_all_users_in_context(context $context) {
}
/**
* Delete all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
*/
public static function delete_data_for_user(approved_contextlist $contextlist) {
}
}

43
files/tests/conversion_test.php
View File

@ -412,4 +412,47 @@ class core_files_conversion_testcase extends advanced_testcase {
$this->assertEquals(1, $DB->count_records(conversion::TABLE));
}
/**
* Test orphan records are removed.
*/
public function test_remove_orphan_records() {
global $DB;
$this->resetAfterTest();
$sf1 = $this->create_stored_file('1', '1');
$sf2 = $this->create_stored_file('2', '2');
$sf3 = $this->create_stored_file('3', '3');
$c1 = new conversion(0, (object) ['sourcefileid' => $sf1->get_id(), 'targetformat' => 'pdf']);
$c1->create();
$c2 = new conversion(0, (object) ['sourcefileid' => $sf2->get_id(), 'targetformat' => 'pdf']);
$c2->create();
$c3 = new conversion(0, (object) ['sourcefileid' => $sf3->get_id(), 'targetformat' => 'pdf']);
$c3->create();
$this->assertTrue(conversion::record_exists($c1->get('id')));
$this->assertTrue(conversion::record_exists($c2->get('id')));
$this->assertTrue(conversion::record_exists($c3->get('id')));
// Nothing should happen here.
conversion::remove_orphan_records();
$this->assertTrue(conversion::record_exists($c1->get('id')));
$this->assertTrue(conversion::record_exists($c2->get('id')));
$this->assertTrue(conversion::record_exists($c3->get('id')));
// Delete file #2.
$sf2->delete();
conversion::remove_orphan_records();
$this->assertTrue(conversion::record_exists($c1->get('id')));
$this->assertFalse(conversion::record_exists($c2->get('id')));
$this->assertTrue(conversion::record_exists($c3->get('id')));
// Delete file #1, #3.
$sf1->delete();
$sf3->delete();
conversion::remove_orphan_records();
$this->assertFalse(conversion::record_exists($c1->get('id')));
$this->assertFalse(conversion::record_exists($c2->get('id')));
$this->assertFalse(conversion::record_exists($c3->get('id')));
}
}

28
lang/en/fileconverter.php Normal file
View File

@ -0,0 +1,28 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Language file.
*
* @package core_fileconverter
* @copyright 2018 Frédéric Massart
* @author Frédéric Massart <fred@branchup.tech>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
$string['privacy:metadata:plugintypefileconverter'] = 'The fileconverter subsystem acts as a channel, passing requests from plugins to the various fileconverter plugins.';