first commit

lib/editor/atto/classes/plugininfo/atto.php

@@ -0,0 +1,87 @@
+<?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/>.
+
+/**
+ * Subplugin info class.
+ *
+ * @package   editor_atto
+ * @copyright 2013 Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace editor_atto\plugininfo;
+
+use core\plugininfo\base;
+
+defined('MOODLE_INTERNAL') || die();
+
+
+class atto extends base {
+
+    /**
+     * Yes you can uninstall these plugins if you want.
+     * @return \moodle_url
+     */
+    public function is_uninstall_allowed() {
+        return true;
+    }
+
+    /**
+     * Return URL used for management of plugins of this type.
+     * @return \moodle_url
+     */
+    public static function get_manage_url() {
+        return new \moodle_url('/admin/settings.php', array('section'=>'editorsettingsatto'));
+    }
+
+    /**
+     * Include the settings.php file from sub plugins if they provide it.
+     * This is a copy of very similar implementations from various other subplugin areas.
+     *
+     * @return \moodle_url
+     */
+    public function load_settings(\part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
+        global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
+        /** @var \admin_root $ADMIN */
+        $ADMIN = $adminroot; // May be used in settings.php.
+        $plugininfo = $this; // Also can be used inside settings.php.
+
+        if (!$this->is_installed_and_upgraded()) {
+            return;
+        }
+
+        if (!$hassiteconfig or !file_exists($this->full_path('settings.php'))) {
+            return;
+        }
+
+        $section = $this->get_settings_section_name();
+        $settings = new \admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false);
+        include($this->full_path('settings.php')); // This may also set $settings to null.
+
+        if ($settings) {
+            $ADMIN->add($parentnodename, $settings);
+        }
+    }
+
+    /**
+     * Get the settings section name.
+     * It's used to get the setting links in the Atto sub-plugins table.
+     *
+     * @return null|string the settings section name.
+     */
+    public function get_settings_section_name() {
+        return 'atto_' . $this->name . '_settings';
+    }
+}

lib/editor/atto/classes/privacy/provider.php

@@ -0,0 +1,244 @@
+<?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/>.
+
+/**
+ * Privacy Subsystem implementation for editor_atto.
+ *
+ * @package    editor_atto
+ * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace editor_atto\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use \core_privacy\local\request\approved_contextlist;
+use \core_privacy\local\request\writer;
+use \core_privacy\local\request\helper;
+use \core_privacy\local\request\deletion_criteria;
+use \core_privacy\local\metadata\collection;
+use \core_privacy\local\request\userlist;
+use \core_privacy\local\request\approved_userlist;
+
+/**
+ * Privacy Subsystem implementation for editor_atto.
+ *
+ * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements
+        // The Atto editor stores user provided data.
+        \core_privacy\local\metadata\provider,
+        // The Atto editor provides data directly to core.
+        \core_privacy\local\request\plugin\provider,
+        // The Atto editor is capable of determining which users have data within it.
+        \core_privacy\local\request\core_userlist_provider {
+
+    /**
+     * Returns information about how editor_atto stores its data.
+     *
+     * @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 {
+        // There isn't much point giving details about the pageid, etc.
+        $collection->add_database_table('editor_atto_autosave', [
+                'userid' => 'privacy:metadata:database:atto_autosave:userid',
+                'drafttext' => 'privacy:metadata:database:atto_autosave:drafttext',
+                'timemodified' => 'privacy:metadata:database:atto_autosave:timemodified',
+            ], 'privacy:metadata:database:atto_autosave');
+
+        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 {
+        // This block doesn't know who information is stored against unless it
+        // is at the user context.
+        $contextlist = new \core_privacy\local\request\contextlist();
+
+        $sql = "SELECT
+                    c.id
+                  FROM {editor_atto_autosave} eas
+                  JOIN {context} c ON c.id = eas.contextid
+                 WHERE contextlevel = :contextuser AND c.instanceid = :userid";
+        $contextlist->add_from_sql($sql, ['contextuser' => CONTEXT_USER, 'userid' => $userid]);
+
+        $sql = "SELECT contextid FROM {editor_atto_autosave} WHERE userid = :userid";
+        $contextlist->add_from_sql($sql, ['userid' => $userid]);
+
+        return $contextlist;
+    }
+
+    /**
+     * Get the list of users within a specific context.
+     *
+     * @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
+     */
+    public static function get_users_in_context(userlist $userlist) {
+        $context = $userlist->get_context();
+
+        $params = [
+            'contextid' => $context->id
+        ];
+
+        $sql = "SELECT userid
+                  FROM {editor_atto_autosave}
+                 WHERE contextid = :contextid";
+
+        $userlist->add_from_sql('userid', $sql, $params);
+    }
+
+    /**
+     * 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) {
+        global $DB;
+
+        $user = $contextlist->get_user();
+
+        // Firstly export all autosave records from all contexts in the list owned by the given user.
+
+        list($contextsql, $contextparams) = $DB->get_in_or_equal($contextlist->get_contextids(), SQL_PARAMS_NAMED);
+        $contextparams['userid'] = $user->id;
+
+        $sql = "SELECT *
+                  FROM {editor_atto_autosave}
+                 WHERE userid = :userid AND contextid {$contextsql}";
+
+        $autosaves = $DB->get_recordset_sql($sql, $contextparams);
+        self::export_autosaves($user, $autosaves);
+
+        // Additionally export all eventual records in the given user's context regardless the actual owner.
+        // We still consider them to be the user's personal data even when edited by someone else.
+
+        list($contextsql, $contextparams) = $DB->get_in_or_equal($contextlist->get_contextids(), SQL_PARAMS_NAMED);
+        $contextparams['userid'] = $user->id;
+        $contextparams['contextuser'] = CONTEXT_USER;
+
+        $sql = "SELECT eas.*
+                  FROM {editor_atto_autosave} eas
+                  JOIN {context} c ON c.id = eas.contextid
+                 WHERE c.id {$contextsql} AND c.contextlevel = :contextuser AND c.instanceid = :userid";
+
+        $autosaves = $DB->get_recordset_sql($sql, $contextparams);
+        self::export_autosaves($user, $autosaves);
+    }
+
+    /**
+     * Export all autosave records in the recordset, and close the recordset when finished.
+     *
+     * @param   \stdClass   $user The user whose data is to be exported
+     * @param   \moodle_recordset $autosaves The recordset containing the data to export
+     */
+    protected static function export_autosaves(\stdClass $user, \moodle_recordset $autosaves) {
+        foreach ($autosaves as $autosave) {
+            $context = \context::instance_by_id($autosave->contextid);
+            $subcontext = [
+                get_string('autosaves', 'editor_atto'),
+                $autosave->id,
+            ];
+
+            $html = writer::with_context($context)
+                ->rewrite_pluginfile_urls($subcontext, 'user', 'draft', $autosave->draftid, $autosave->drafttext);
+
+            $data = (object) [
+                'drafttext' => format_text($html, FORMAT_HTML, static::get_filter_options()),
+                'timemodified' => \core_privacy\local\request\transform::datetime($autosave->timemodified),
+            ];
+
+            if ($autosave->userid != $user->id) {
+                $data->author = \core_privacy\local\request\transform::user($autosave->userid);
+            }
+
+            writer::with_context($context)
+                ->export_data($subcontext, $data)
+                ->export_area_files($subcontext, 'user', 'draft', $autosave->draftid);
+        }
+        $autosaves->close();
+    }
+
+    /**
+     * 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) {
+        global $DB;
+
+        $DB->delete_records('editor_atto_autosave', [
+                'contextid' => $context->id,
+            ]);
+    }
+
+    /**
+     * Delete multiple users within a single context.
+     *
+     * @param approved_userlist $userlist The approved context and user information to delete information for.
+     */
+    public static function delete_data_for_users(approved_userlist $userlist) {
+        global $DB;
+
+        $context = $userlist->get_context();
+        $userids = $userlist->get_userids();
+
+        list($useridsql, $useridsqlparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
+        $params = ['contextid' => $context->id] + $useridsqlparams;
+
+        $DB->delete_records_select('editor_atto_autosave', "contextid = :contextid AND userid {$useridsql}",
+            $params);
+    }
+
+    /**
+     * 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) {
+        global $DB;
+
+        $user = $contextlist->get_user();
+
+        list($contextsql, $contextparams) = $DB->get_in_or_equal($contextlist->get_contextids(), SQL_PARAMS_NAMED);
+        $contextparams['userid'] = $user->id;
+
+        $sql = "SELECT * FROM {editor_atto_autosave} WHERE contextid {$contextsql}";
+        $autosaves = $DB->delete_records_select('editor_atto_autosave', "userid = :userid AND contextid {$contextsql}",
+                $contextparams);
+    }
+
+    /**
+     * Get the filter options.
+     *
+     * This is shared to allow unit testing too.
+     *
+     * @return  \stdClass
+     */
+    public static function get_filter_options() {
+        return (object) [
+            'overflowdiv' => true,
+            'noclean' => true,
+        ];
+    }
+}

lib/editor/atto/classes/task/autosave_cleanup_task.php

@@ -0,0 +1,58 @@
+<?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/>.
+
+/**
+ * A scheduled task.
+ *
+ * @package    editor_atto
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace editor_atto\task;
+
+use \core\task\scheduled_task;
+
+/**
+ * Simple task to run the autosave cleanup task.
+ */
+class autosave_cleanup_task extends scheduled_task {
+
+    /**
+     * Get a descriptive name for this task (shown to admins).
+     *
+     * @return string
+     */
+    public function get_name() {
+        return get_string('taskautosavecleanup', 'editor_atto');
+    }
+
+    /**
+     * Do the job.
+     * Throw exceptions on errors (the job will be retried).
+     */
+    public function execute() {
+        global $DB;
+
+        $now = time();
+        // This is the oldest time any autosave text will be recovered from.
+        // This is so that there is a good chance the draft files will still exist (there are many variables so
+        // this is impossible to guarantee).
+        $before = $now - 60*60*24*4;
+
+        $DB->delete_records_select('editor_atto_autosave', 'timemodified < :before', array('before' => $before));
+    }
+
+}