From 9164c896c4e0b5e5d0d68c8d7f0368287129ef5d Mon Sep 17 00:00:00 2001 From: Mihail Geshoski Date: Mon, 21 Mar 2022 23:07:19 +0800 Subject: [PATCH] MDL-74189 tool_moodlenet: Add upgrade step to remove irrelevant data Upgrade step to identify all existing cases where users have linked their MoodleNet profile on the site and remove the related data from the database. Due to some recent changes on the MoodleNet platform, this data is now irrelevant and can no longer be used to authenticate on the MoodleNet platform. --- ...net_profiles_data_removed_notification.php | 45 +++++++++++++++++++ admin/tool/moodlenet/db/upgrade.php | 19 ++++++++ .../tool/moodlenet/lang/en/tool_moodlenet.php | 3 ++ admin/tool/moodlenet/version.php | 2 +- 4 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 admin/tool/moodlenet/classes/task/send_mnet_profiles_data_removed_notification.php diff --git a/admin/tool/moodlenet/classes/task/send_mnet_profiles_data_removed_notification.php b/admin/tool/moodlenet/classes/task/send_mnet_profiles_data_removed_notification.php new file mode 100644 index 00000000000..59554542305 --- /dev/null +++ b/admin/tool/moodlenet/classes/task/send_mnet_profiles_data_removed_notification.php @@ -0,0 +1,45 @@ +. + +declare(strict_types=1); + +namespace tool_moodlenet\task; + +use core\message\message; + +/** + * Ad-hoc task to send a notification to admin stating that the user data related to the linked MoodleNet profiles has + * been removed. + * + * @package tool_moodlenet + * @copyright 2022 Mihail Geshoski + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class send_mnet_profiles_data_removed_notification extends \core\task\adhoc_task { + public function execute(): void { + $message = new message(); + $message->component = 'moodle'; + $message->name = 'notices'; + $message->userfrom = \core_user::get_noreply_user(); + $message->userto = get_admin(); + $message->notification = 1; + $message->subject = get_string('removedmnetprofilenotification_subject', 'tool_moodlenet'); + $message->fullmessageformat = FORMAT_HTML; + $message->fullmessagehtml = get_string('removedmnetprofilenotification', 'tool_moodlenet'); + $message->smallmessage = strip_tags($message->fullmessagehtml); + message_send($message); + } +} diff --git a/admin/tool/moodlenet/db/upgrade.php b/admin/tool/moodlenet/db/upgrade.php index f1ecf439dfb..df715583b68 100644 --- a/admin/tool/moodlenet/db/upgrade.php +++ b/admin/tool/moodlenet/db/upgrade.php @@ -123,5 +123,24 @@ function xmldb_tool_moodlenet_upgrade(int $oldversion) { upgrade_plugin_savepoint(true, 2020061503, 'tool', 'moodlenet'); } + if ($oldversion < 2020061504) { + + $selectsql = "moodlenetprofile IS NOT NULL AND moodlenetprofile != ''"; + + // If there are any users with MoodleNet profile set. + if ($DB->count_records_select('user', $selectsql)) { + // Remove the value set for the MoodleNet profile as this format can no longer be used to authenticate + // MoodleNet users. + $DB->set_field_select('user', 'moodlenetprofile', '', $selectsql); + + // Use an adhoc task to send a notification to admin stating that the user data related to the linked + // MoodleNet profiles has been removed. + $notificationtask = new tool_moodlenet\task\send_mnet_profiles_data_removed_notification(); + core\task\manager::queue_adhoc_task($notificationtask); + } + + upgrade_plugin_savepoint(true, 2020061504, 'tool', 'moodlenet'); + } + return true; } diff --git a/admin/tool/moodlenet/lang/en/tool_moodlenet.php b/admin/tool/moodlenet/lang/en/tool_moodlenet.php index d479ea7df49..e48343bef05 100644 --- a/admin/tool/moodlenet/lang/en/tool_moodlenet.php +++ b/admin/tool/moodlenet/lang/en/tool_moodlenet.php @@ -56,6 +56,9 @@ $string['mnetprofiledesc'] = '

Enter your MoodleNet profile details here to be $string['moodlenetsettings'] = 'MoodleNet settings'; $string['moodlenetnotenabled'] = 'The MoodleNet integration must be enabled in Site administration / MoodleNet before resource imports can be processed.'; $string['notification'] = 'You are about to import the content "{$a->name} ({$a->type})" into your site. Select the course in which it should be added, or cancel.'; +$string['removedmnetprofilenotification'] = '

Due to some recent changes on the MoodleNet platform, users that have previously saved their MoodleNet profile on the site can no longer use this data to authenticate on the MoodleNet platform. The related data has now been removed as it is no longer useful.

+

The users will need to reset this information on the site by linking their MoodleNet profile ID which can be found on their MoodleNet profile.

'; +$string['removedmnetprofilenotification_subject'] = 'Linked MoodleNet profiles removed.'; $string['searchcourses'] = "Search courses"; $string['selectpagetitle'] = 'Select page'; $string['pluginname'] = 'MoodleNet'; diff --git a/admin/tool/moodlenet/version.php b/admin/tool/moodlenet/version.php index a6b689d4f19..c489f01616c 100644 --- a/admin/tool/moodlenet/version.php +++ b/admin/tool/moodlenet/version.php @@ -25,6 +25,6 @@ defined('MOODLE_INTERNAL') || die(); $plugin->component = 'tool_moodlenet'; -$plugin->version = 2020061503; +$plugin->version = 2020061504; $plugin->requires = 2020060900; $plugin->maturity = MATURITY_ALPHA;