mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-15 05:25:08 +02:00
Code Issues Projects Releases Wiki Activity

MDL-78019 core: Logs to record user file deleted from draft area

Browse Source
This commit is contained in:
Anupama Sarjoshi 2023-04-25 17:05:57 +01:00
parent 4ed782dd03
commit b4b9248b78
5 changed files with 215 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lang/en/files.php
View File

@ -26,6 +26,7 @@
defined('MOODLE_INTERNAL') || die();
$string['eventfileaddedtodraftarea'] = 'File added to draft area';
$string['eventfiledeletedfromdraftarea'] = 'File deleted from draft area';
$string['privacy:metadata:file_conversions'] = 'A record of the file conversions performed by a user.';
$string['privacy:metadata:file_conversion:usermodified'] = 'The user who started the file conversion.';
$string['privacy:metadata:files'] = 'A record of the files uploaded or shared by users';

83
lib/classes/event/draft_file_deleted.php Normal file
View File

@ -0,0 +1,83 @@
<?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/>.
namespace core\event;
/**
* Event fired when a file is deleted from the draft area.
*
* @property-read array $other {
* Extra information about the event.
*
* - string itemid: itemid of the file
* - string filename: Name of the file deleted from the draft area.
* - string filesize: The file size.
* - string filepath: The filepath.
* - string contenthash: The file contenthash.
* }
*
* @package core
* @since Moodle 4.2
* @copyright 2023 The Open University.
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class draft_file_deleted extends base {
protected function init() {
$this->data['objecttable'] = 'files';
$this->data['crud'] = 'd';
$this->data['edulevel'] = self::LEVEL_OTHER;
}
public static function get_name() {
return get_string('eventfiledeletedfromdraftarea', 'files');
}
public function get_description() {
$humansize = display_size($this->other['filesize']);
$filetype = 'file';
if ($this->other['filename'] == '.') {
$filetype = 'folder';
}
return "The user with id '{$this->userid}' has deleted {$filetype} '{$this->other['filepath']}" .
"{$this->other['filename']}' from the draft file area with item id {$this->other['itemid']}. Size: {$humansize}. ".
"Content hash: {$this->other['contenthash']}.";
}
protected function validate_data() {
parent::validate_data();
if (!isset($this->other['itemid'])) {
throw new \coding_exception('The \'itemid\' must be set in other.');
}
if (!isset($this->other['filename'])) {
throw new \coding_exception('The \'filename\' value must be set in other.');
}
if (!isset($this->other['filesize'])) {
throw new \coding_exception('The \'filesize\' value must be set in other.');
}
if (!isset($this->other['filepath'])) {
throw new \coding_exception('The \'filepath\' value must be set in other.');
}
if (!isset($this->other['contenthash'])) {
throw new \coding_exception('The \'contenthash\' value must be set in other.');
}
}
}

86
lib/tests/event/draft_file_deleted_test.php Normal file
View File

@ -0,0 +1,86 @@
<?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/>.
/**
* File deleted from draft area test events.
*
* @package core
* @category test
* @copyright 2023 The Open University.
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\event;
/**
* Test for draft file deleted event.
*
* @package core
* @category test
* @copyright 2023 The Open University.
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @covers \core\event\draft_file_deleted
*/
class draft_file_deleted_test extends \advanced_testcase {
/**
* Test draft file deleted event.
*/
public function test_event() {
$this->resetAfterTest();
$user = $this->getDataGenerator()->create_user();
$this->setUser($user);
$usercontext = \context_user::instance($user->id);
$sink = $this->redirectEvents();
$fs = get_file_storage();
$filerecord = [
'contextid' => $usercontext->id,
'component' => 'core',
'filearea' => 'unittest',
'itemid' => 0,
'filepath' => '/',
'filename' => 'test.txt',
'source' => 'Copyright stuff',
];
$originalfile = $fs->create_file_from_string($filerecord, 'Test content');
$nbsp = "\xc2\xa0";
// Event data for logging.
$eventdata = [
'objectid' => $originalfile->get_id(),
'context' => $usercontext,
'other' => [
'itemid' => $originalfile->get_itemid(),
'filename' => $originalfile->get_filename(),
'filesize' => $originalfile->get_filesize(),
'filepath' => $originalfile->get_filepath(),
'contenthash' => $originalfile->get_contenthash(),
]
];
$event = \core\event\draft_file_deleted::create($eventdata);
$event->trigger();
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = reset($events);
$this->assertEquals($usercontext, $event->get_context());
$expected = "The user with id '{$user->id}' has deleted file '/test.txt' from the draft file area with item id 0. ".
"Size: 12{$nbsp}bytes. Content hash: {$originalfile->get_contenthash()}.";
$this->assertSame($expected, $event->get_description());
}
}

25
repository/lib.php
View File

@ -3245,11 +3245,15 @@ function repository_delete_selected_files($context, string $component, string $f
$files = $fs->get_directory_files($context->id, $component, $filearea, $itemid, $filepath, true);
foreach ($files as $file) {
$file->delete();
// Log the event when a file is deleted from the draft area.
create_event_draft_file_deleted($context, $file);
}
$storedfile->delete();
create_event_draft_file_deleted($context, $storedfile);
$return[$parentpath] = "";
} else {
if ($result = $storedfile->delete()) {
create_event_draft_file_deleted($context, $storedfile);
$return[$parentpath] = "";
}
}
@ -3259,6 +3263,27 @@ function repository_delete_selected_files($context, string $component, string $f
return $return;
}
/**
* Convenience function to create draft_file_deleted log event.
*
* @param context $context The context where delete is called.
* @param stored_file $storedfile the file to be logged.
*/
function create_event_draft_file_deleted(context $context, stored_file $storedfile) :void {
$logevent = \core\event\draft_file_deleted::create([
'objectid' => $storedfile->get_id(),
'context' => $context,
'other' => [
'itemid' => $storedfile->get_itemid(),
'filename' => $storedfile->get_filename(),
'filesize' => $storedfile->get_filesize(),
'filepath' => $storedfile->get_filepath(),
'contenthash' => $storedfile->get_contenthash(),
],
]);
$logevent->trigger();
}
/**
* Convenience function to handle deletion of files.
*

20
repository/tests/behat/delete_files.feature
View File

@ -109,3 +109,23 @@ Feature: Delete files and folders from the file manager
Then I should not see "Delete me" in the "Private files" "block"
And I should not see "empty.txt" in the "Private files" "block"
And I should not see "Delete me too" in the "Private files" "block"
@javascript
Scenario: Verify system logs for deleted draft files
Given I log in as "admin"
And I follow "Manage private files..."
And I upload "lib/tests/fixtures/update_validator/zips/multidir.zip" file to "Files" filemanager
And I follow "multidir.zip"
And I click on "Unzip" "button"
And I click on "Display folder with file details" "link"
And I set the field "Select file 'one'" to "1"
And I click on "Delete" "link"
And I should see "Are you sure you want to delete the selected 1 file(s)?"
And I click on "OK" "button" in the "Confirm" "dialogue"
And I click on "Save changes" "button"
And I am on the "System logs report" page
And I click on "Get these logs" "button"
And I should see "The user with id '2' has deleted folder '/one/.' from the draft file area with item id" in the "has deleted folder '/one/.'" "table_row"
And I should see "Size: 0 bytes. Content hash:" in the "has deleted folder '/one/.'" "table_row"
Then I should see "The user with id '2' has deleted file '/one/version.php' from the draft file area with item id" in the "has deleted file '/one/version.php'" "table_row"
And I should see "Size: 40 bytes. Content hash:" in the "has deleted file '/one/version.php'" "table_row"