MDL-77406 core: Logs to record user file uploaded in draft area

lang/en/files.php

@@ -25,6 +25,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
+$string['eventfileaddedtodraftarea'] = 'File added to 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';

lib/classes/event/draft_file_added.php

@@ -0,0 +1,81 @@
+<?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;
+
+/**
+ * draft_file_added
+ *
+ * Event fired when a file is added to the draft area.
+ *
+ * @property-read array $other {
+ *      Extra information about the event.
+ *
+ *      - string itemid: itemid of the file
+ *      - string filename: Name of the file added to 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_added extends base {
+
+    protected function init() {
+        $this->data['objecttable'] = 'files';
+        $this->data['crud'] = 'c';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    public static function get_name() {
+        return get_string('eventfileaddedtodraftarea', 'files');
+    }
+
+    public function get_description() {
+        $humansize = display_size($this->other['filesize']);
+        return "The user with id '{$this->userid}' has uploaded file '{$this->other['filepath']}{$this->other['filename']}' " .
+            "to 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.');
+        }
+    }
+}

lib/tests/behat/behat_navigation.php

@@ -725,6 +725,12 @@ protected function resolve_core_page_url(string $name): moodle_url {
             case 'Admin notifications':
                 return new moodle_url('/admin/');
 
+            case 'My private files':
+                return new moodle_url('/user/files.php');
+
+            case 'System logs report':
+                return new moodle_url('/report/log/index.php');
+
             default:
                 throw new Exception('Unrecognised core page type "' . $name . '."');
         }

lib/tests/event/draft_file_added_test.php

@@ -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 added to 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 added 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_added
+ */
+class draft_file_added_test extends \advanced_testcase {
+    /**
+     * Test draft file added 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_added::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 uploaded file '/test.txt' to the draft file area with item id 0. ".
+            "Size: 12{$nbsp}bytes. Content hash: {$originalfile->get_contenthash()}.";
+        $this->assertSame($expected, $event->get_description());
+    }
+}

repository/upload/lib.php

@@ -23,6 +23,8 @@
  * @copyright  2010 Dongsheng Cai {@link http://dongsheng.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+
+defined('MOODLE_INTERNAL') || die();
 require_once($CFG->dirroot . '/repository/lib.php');
 
 /**
@@ -190,13 +192,14 @@ public function process_upload($saveas_filename, $maxbytes, $types = '*', $savep
             $record->itemid = 0;
         }
 
-        if (($maxbytes!==-1) && (filesize($_FILES[$elname]['tmp_name']) > $maxbytes)) {
+        $filesize = filesize($_FILES[$elname]['tmp_name']);
+        if (($maxbytes !== -1) && ($filesize > $maxbytes)) {
             $maxbytesdisplay = display_size($maxbytes, 0);
             throw new file_exception('maxbytesfile', (object) array('file' => $record->filename,
                                                                     'size' => $maxbytesdisplay));
         }
 
-        if (file_is_draft_area_limit_reached($record->itemid, $areamaxbytes, filesize($_FILES[$elname]['tmp_name']))) {
+        if (file_is_draft_area_limit_reached($record->itemid, $areamaxbytes, $filesize)) {
             throw new file_exception('maxareabytes');
         }
         // Ensure the user does not upload too many draft files in a short period.
@@ -233,6 +236,19 @@ public function process_upload($saveas_filename, $maxbytes, $types = '*', $savep
             $stored_file = $fs->create_file_from_pathname($record, $_FILES[$elname]['tmp_name']);
         }
 
+        $logevent = \core\event\draft_file_added::create([
+                'objectid' => $stored_file->get_id(),
+                'context' => $context,
+                'other' => [
+                        'itemid' => $record->itemid,
+                        'filename' => $record->filename,
+                        'filesize' => $filesize,
+                        'filepath' => $record->filepath,
+                        'contenthash' => $stored_file->get_contenthash(),
+                ],
+        ]);
+        $logevent->trigger();
+
         return array(
             'url'=>moodle_url::make_draftfile_url($record->itemid, $record->filepath, $record->filename)->out(false),
             'id'=>$record->itemid,

repository/upload/tests/behat/upload_file.feature

@@ -21,3 +21,13 @@ Feature: Upload files
     Then I should see "2" elements in "Files" filemanager
     And I should see "empty.txt"
     And I should see "empty_copy.txt"
+
+  @javascript
+  Scenario: Verify logs for file upload
+    Given I am on the "My private files" page logged in as "admin"
+    And I upload "lib/tests/fixtures/empty.txt" file to "Files" filemanager
+    And I click on "Save changes" "button"
+    And I am on the "System logs report" page
+    And I click on "Get these logs" "button"
+    Then I should see "The user with id '2' has uploaded file '/empty.txt' to the draft file area with item id" in the "File added to draft area" "table_row"
+    And I should see "Size: 32 bytes. Content hash: " in the "File added to draft area" "table_row"

webservice/upload.php

@@ -112,6 +112,8 @@
         $file->filepath = $_FILES[$fieldname]['tmp_name'];
         // calculate total size of upload
         $totalsize += $_FILES[$fieldname]['size'];
+        // Size of individual file.
+        $file->size = $_FILES[$fieldname]['size'];
     }
     $files[] = $file;
 }
@@ -148,6 +150,7 @@
     $file_record->license   = $CFG->sitedefaultlicense;
     $file_record->author    = fullname($authenticationinfo['user']);
     $file_record->source    = serialize((object)array('source' => $file->filename));
+    $file_record->filesize = $file->size;
 
     //Check if the file already exist
     $existingfile = $fs->file_exists($file_record->contextid, $file_record->component, $file_record->filearea,
@@ -159,6 +162,20 @@
     } else {
         $stored_file = $fs->create_file_from_pathname($file_record, $file->filepath);
         $results[] = $file_record;
+
+        // Log the event when a file is uploaded to the draft area.
+        $logevent = \core\event\draft_file_added::create([
+                'objectid' => $stored_file->get_id(),
+                'context' => $context,
+                'other' => [
+                        'itemid' => $file_record->itemid,
+                        'filename' => $file_record->filename,
+                        'filesize' => $file_record->filesize,
+                        'filepath' => $file_record->filepath,
+                        'contenthash' => $stored_file->get_contenthash(),
+                ],
+        ]);
+        $logevent->trigger();
     }
 }
 echo json_encode($results);