End of Support Plugin for Joomla 4.4 (#40565)

mfleeson · heelc29 · laoneo · web-flow · commit 52d9fcc0f25e · 2023-05-24T14:20:51.000+02:00
* End of Support Plugin for Joomla 4.4 * Update mysql/base.sql - missing , * Update plugins/quickicon/eos/src/Extension/Eos.php Co-authored-by: heelc29 <66922325+heelc29@users.noreply.github.com> * Update plugins/quickicon/eos/src/Extension/Eos.php Co-authored-by: heelc29 <66922325+heelc29@users.noreply.github.com> * Update plugins/quickicon/eos/src/Extension/Eos.php Co-authored-by: heelc29 <66922325+heelc29@users.noreply.github.com> * Update plugins/quickicon/eos/src/Extension/Eos.php Co-authored-by: heelc29 <66922325+heelc29@users.noreply.github.com> * Update plugins/quickicon/eos/src/Extension/Eos.php Co-authored-by: heelc29 <66922325+heelc29@users.noreply.github.com> * Update plugins/quickicon/eos/services/provider.php Co-authored-by: Allon Moritz <allon.moritz@digital-peak.com> * Update plugins/quickicon/eos/services/provider.php Co-authored-by: Allon Moritz <allon.moritz@digital-peak.com> * All requested changes made. Lets see what happens! * Removed __construct, followed Dimitris and JSanders suggestions * PHPCs fix again * Update Eos.php * Update provider.php * Update plugins/quickicon/eos/src/Extension/Eos.php Co-authored-by: Dimitris Grammatikogiannis <dg@dgrammatiko.dev> * Update plugins/quickicon/eos/services/provider.php Co-authored-by: jsanders <j53.sanders@gmail.com> * Update provider.php * Update plugins/quickicon/eos/src/Extension/Eos.php Co-authored-by: jsanders <j53.sanders@gmail.com> * Update to all files to get almost clean PR. Do not Review this one, wait for next please. Some files are showing in git some are not so this is all 10 files updated to the correct code. The next release will remove the extra spaces in this release which I've added to make sure all 10 files upload. Please do not review this PR but wait for the next one in about 10 mins. * Ready for checking. Here's the files ready for checking. * Updating GetMessageInfo in Eos to correctly just return an array * Changing Const from Public to Private * Updates to set language to only load when needed. Fix to allow building Fix from #40565 (comment) * Update stats-message.es6.js * Update stats-message.es6.js * Update Eos.php - set hardcoded date to 2025-10-25 * Update stats-message.es6.js - revert changes --------- Co-authored-by: heelc29 <66922325+heelc29@users.noreply.github.com> Co-authored-by: Allon Moritz <allon.moritz@digital-peak.com> Co-authored-by: Dimitris Grammatikogiannis <dg@dgrammatiko.dev> Co-authored-by: jsanders <j53.sanders@gmail.com> Co-authored-by: Richard Fath <richard67@users.noreply.github.com> Co-authored-by: Martin Carl Kopp <6154099+MacJoom@users.noreply.github.com>
diff --git a/administrator/components/com_admin/sql/updates/mysql/4.4.0-2023-05-08.sql b/administrator/components/com_admin/sql/updates/mysql/4.4.0-2023-05-08.sql
@@ -0,0 +1,2 @@
+INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`, `protected`, `locked`, `manifest_cache`, `params`, `custom_data`, `ordering`, `state`) VALUES
+	(0, 'plg_quickicon_eos', 'plugin', 'eos', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 7, 0);
diff --git a/administrator/components/com_admin/sql/updates/postgresql/4.4.0-2023-05-08.sql b/administrator/components/com_admin/sql/updates/postgresql/4.4.0-2023-05-08.sql
@@ -0,0 +1,2 @@
+INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder", "client_id", "enabled", "access", "protected", "locked", "manifest_cache", "params", "custom_data", "ordering", "state") VALUES
+	(0, 'plg_quickicon_eos', 'plugin', 'eos', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 7, 0);
diff --git a/administrator/language/en-GB/plg_quickicon_eos.ini b/administrator/language/en-GB/plg_quickicon_eos.ini
@@ -0,0 +1,39 @@
+; Joomla! Project
+; (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+; License GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_QUICKICON_EOS="Quick Icon - Joomla! End Of Support Notification"
+PLG_QUICKICON_EOS_GROUPNAME_EOS="End Of Support"
+PLG_QUICKICON_EOS_GROUPNAME_INFO="Upgrade Information"
+PLG_QUICKICON_EOS_GROUPNAME_WARNING="Support Status"
+PLG_QUICKICON_EOS_MESSAGE_ERROR_SUPPORT_ENDED="<p>Support has ended for your version of Joomla. <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">Migrate to the next version</a> as soon as possible.</p>"
+PLG_QUICKICON_EOS_MESSAGE_ERROR_SUPPORT_ENDED_SHORT="Support has ended for your version of Joomla <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS_MESSAGE_INFO_01="<p>The latest version of Joomla has arrived! Find out all that it has to offer you. Check the landing page for <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">its features</a> and improvements.</p>"
+PLG_QUICKICON_EOS_MESSAGE_INFO_01_SHORT="The latest version of Joomla has arrived! <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS_MESSAGE_INFO_02="<p>When is the time to migrate to the next version? Once the extensions your site needs are compatible. Learn <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">how to use the Pre-Update Checker</a>. </p>"
+PLG_QUICKICON_EOS_MESSAGE_INFO_02_SHORT="Use Pre-Update Check for extension compatibility <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS_MESSAGE_WARNING_SECURITY_ONLY="<p>This version of Joomla has entered security only mode. Support ends %1$s. Start <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">planning to migrate</a> to the next version of Joomla today.</p>"
+PLG_QUICKICON_EOS_MESSAGE_WARNING_SECURITY_ONLY_SHORT="This version of Joomla ends support on %1$s. <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS_MESSAGE_WARNING_SUPPORT_ENDING="<p>Support ends on %1$s for this version of Joomla. <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">Migrate to the latest version of Joomla</a> as soon as possible.</p>"
+PLG_QUICKICON_EOS_MESSAGE_WARNING_SUPPORT_ENDING_SHORT="End of support for this version of Joomla on %1$s. <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS_SNOOZE_BUTTON="Snooze this message for all users"
+PLG_QUICKICON_EOS_XML_DESCRIPTION="Checks for the end of support status of Joomla and notifies you when visiting the Control Panel page."
+; Below is a copy of the 3.10 text definitions for reference.
+PLG_QUICKICON_EOS310="Quick Icon - Joomla 3.10 End Of Support Notification"
+PLG_QUICKICON_EOS310_GROUPNAME_EOS="End Of Support"
+PLG_QUICKICON_EOS310_GROUPNAME_INFO="Upgrade Information"
+PLG_QUICKICON_EOS310_GROUPNAME_WARNING="Support Status"
+PLG_QUICKICON_EOS310_MESSAGE_ERROR_SUPPORT_ENDED="<p>Support has ended for your version of Joomla 3.10. <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">Migrate to Joomla 4</a> <span class=\"icon-new-tab\"></span>as soon as possible.</p>"
+PLG_QUICKICON_EOS310_MESSAGE_ERROR_SUPPORT_ENDED_SHORT="Support has ended for Joomla 3.10 <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS310_MESSAGE_INFO_01="<p>Joomla 4 has arrived! Find out all that Joomla 4 has to offer you. Check the landing page for <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">Joomla 4 features</a> <span class=\"icon-new-tab\"></span>and improvements.</p>"
+PLG_QUICKICON_EOS310_MESSAGE_INFO_01_SHORT="Joomla 4 has arrived! <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS310_MESSAGE_INFO_02="<p>When is the time to migrate to Joomla 4? Once the extensions your site needs are compatible. Learn <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">how to use the Pre-Update Checker</a>. <span class=\"icon-new-tab\"></span></p>"
+PLG_QUICKICON_EOS310_MESSAGE_INFO_02_SHORT="Use Pre-Update Check for extension compatibility <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS310_MESSAGE_WARNING_SECURITY_ONLY="<p>Joomla 3.10 has entered security only mode. Support ends %1$s. Start <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">planning to migrate</a> <span class=\"icon-new-tab\"></span>to Joomla 4 today.</p>"
+PLG_QUICKICON_EOS310_MESSAGE_WARNING_SECURITY_ONLY_SHORT="Joomla 3.10 to end support on %1$s. <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS310_MESSAGE_WARNING_SUPPORT_ENDING="<p>Support ends on %1$s for Joomla 3.10. <a href=\"%2$s\" target=\"_blank\" rel=\"noopener noreferrer\">Migrate to Joomla 4</a> <span class=\"icon-new-tab\"></span>as soon as possible.</p>"
+PLG_QUICKICON_EOS310_MESSAGE_WARNING_SUPPORT_ENDING_SHORT="End of support for Joomla 3.10 on %1$s. <span class=\"icon-new-tab\"></span>"
+PLG_QUICKICON_EOS310_SNOOZE_BUTTON="Snooze this message for all users"
+PLG_QUICKICON_EOS310_XML_DESCRIPTION="Checks for the end of support status of Joomla 3.10 and notifies you when visiting the Control Panel page."
+;All of this text is currently being written for Joomla 5 by Phil Watson and Jenn Gress. TODO
diff --git a/administrator/language/en-GB/plg_quickicon_eos.sys.ini b/administrator/language/en-GB/plg_quickicon_eos.sys.ini
@@ -0,0 +1,7 @@
+; Joomla! Project
+; (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+; License GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_QUICKICON_EOS="Quick Icon - Joomla! End Of Support Notification"
+PLG_QUICKICON_EOS_XML_DESCRIPTION="Checks for the end of support status of Joomla and places a notification on the Control Panel page."
diff --git a/build/media_source/plg_quickicon_eos/js/snooze.es6.js b/build/media_source/plg_quickicon_eos/js/snooze.es6.js
@@ -0,0 +1,37 @@
+/**
+ * @package     Joomla.Plugin
+ * @subpackage  Quickicon.eos
+ * @copyright  (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+if (!Joomla) {
+  throw new Error('Joomla API is not properly initialised');
+}
+
+const url = new URL(`${Joomla.getOptions('system.paths').baseFull}index.php?option=com_ajax&group=quickicon&plugin=eos&format=json`);
+
+async function onMutatedMessagesContainer(mutationList, observer) {
+  // eslint-disable-next-line no-restricted-syntax
+  for (const mutation of mutationList) {
+    const nodes = Array.from(mutation.addedNodes);
+    if (!nodes.length) {
+      return;
+    }
+
+    const alerts = nodes.filter((node) => node.querySelector('.eosnotify-snooze-btn'));
+    if (!alerts.length) {
+      return;
+    }
+
+    observer.disconnect();
+    alerts[0].querySelector('.eosnotify-snooze-btn').addEventListener('click', () => fetch(url, { headers: { 'X-CSRF-Token': Joomla.getOptions('csrf.token') || '' } })
+      .then((response) => {
+        if (response.ok) {
+          alerts[0].closest('joomla-alert').close();
+        }
+      }));
+  }
+}
+
+const observer = new MutationObserver(onMutatedMessagesContainer);
+observer.observe(document.querySelector('#system-message-container'), { attributes: false, childList: true, subtree: true });
diff --git a/installation/sql/mysql/base.sql b/installation/sql/mysql/base.sql
@@ -328,6 +328,7 @@ INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`,
 (0, 'plg_quickicon_downloadkey', 'plugin', 'downloadkey', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 4, 0),
 (0, 'plg_quickicon_privacycheck', 'plugin', 'privacycheck', 'quickicon', 0, 1, 1, 0, 1, '', '{}', '', 5, 0),
 (0, 'plg_quickicon_phpversioncheck', 'plugin', 'phpversioncheck', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 6, 0),
+(0, 'plg_quickicon_eos', 'plugin', 'eos', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 7, 0),
 (0, 'plg_sampledata_blog', 'plugin', 'blog', 'sampledata', 0, 1, 1, 0, 1, '', '', '', 1, 0),
 (0, 'plg_sampledata_multilang', 'plugin', 'multilang', 'sampledata', 0, 1, 1, 0, 1, '', '', '', 2, 0),
 (0, 'plg_system_accessibility', 'plugin', 'accessibility', 'system', 0, 0, 1, 0, 1, '', '{}', '', 1, 0),
diff --git a/installation/sql/postgresql/base.sql b/installation/sql/postgresql/base.sql
@@ -334,6 +334,7 @@ INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder",
 (0, 'plg_quickicon_downloadkey', 'plugin', 'downloadkey', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 4, 0),
 (0, 'plg_quickicon_privacycheck', 'plugin', 'privacycheck', 'quickicon', 0, 1, 1, 0, 1, '', '{}', '', 5, 0),
 (0, 'plg_quickicon_phpversioncheck', 'plugin', 'phpversioncheck', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 6, 0),
+(0, 'plg_quickicon_eos', 'plugin', 'eos', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 7, 0),
 (0, 'plg_sampledata_blog', 'plugin', 'blog', 'sampledata', 0, 1, 1, 0, 1, '', '', '', 1, 0),
 (0, 'plg_sampledata_multilang', 'plugin', 'multilang', 'sampledata', 0, 1, 1, 0, 1, '', '', '', 2, 0),
 (0, 'plg_system_accessibility', 'plugin', 'accessibility', 'system', 0, 0, 1, 0, 1, '', '{}', '', 1, 0),
diff --git a/libraries/src/Extension/ExtensionHelper.php b/libraries/src/Extension/ExtensionHelper.php
@@ -273,6 +273,7 @@ class ExtensionHelper
         ['plugin', 'overridecheck', 'quickicon', 0],
         ['plugin', 'phpversioncheck', 'quickicon', 0],
         ['plugin', 'privacycheck', 'quickicon', 0],
+        ['plugin', 'eos', 'quickicon', 0],
 
         // Core plugin extensions - sample data
         ['plugin', 'blog', 'sampledata', 0],
diff --git a/plugins/quickicon/eos/eos.xml b/plugins/quickicon/eos/eos.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<extension type="plugin" group="quickicon" method="upgrade">
+	<name>plg_quickicon_eos</name>
+	<author>Joomla! Project</author>
+	<creationDate>2023-05</creationDate>
+	<copyright>(C) 2023 Open Source Matters, Inc.</copyright>
+	<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
+	<authorEmail>admin@joomla.org</authorEmail>
+	<authorUrl>www.joomla.org</authorUrl>
+	<version>4.4.0</version>
+	<description>PLG_QUICKICON_EOS_XML_DESCRIPTION</description>
+	<namespace path="src">Joomla\Plugin\Quickicon\Eos</namespace>
+	<files>
+		<folder plugin="eos">services</folder>
+		<folder>src</folder>
+	</files>
+	<languages>
+		<language tag="en-GB">language/en-GB/plg_quickicon_eos.ini</language>
+		<language tag="en-GB">language/en-GB/plg_quickicon_eos.sys.ini</language>
+	</languages>
+	<config>
+		<fields name="params">
+			<fieldset name="basic">
+				<field
+					name="last_snoozed_id"
+					type="hidden"
+				/>
+			</fieldset>
+		</fields>
+	</config>
+</extension>
diff --git a/plugins/quickicon/eos/services/provider.php b/plugins/quickicon/eos/services/provider.php
@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * @package     Joomla.Plugin
+ * @subpackage  Quickicon.eos
+ *
+ * @copyright   (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\Extension\PluginInterface;
+use Joomla\CMS\Factory;
+use Joomla\CMS\Plugin\PluginHelper;
+use Joomla\Database\DatabaseInterface;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+use Joomla\Event\DispatcherInterface;
+use Joomla\Plugin\Quickicon\Eos\Extension\Eos;
+
+return new class () implements ServiceProviderInterface {
+    /**
+     * Registers the service provider with a DI container.
+     *
+     * @param   Container  $container  The DI container.
+     *
+     * @return  void
+     *
+     * @since  __DEPLOY_VERSION__
+     *
+     * @throws Exception
+     */
+    public function register(Container $container): void
+    {
+        $container->set(
+            PluginInterface::class,
+            function (Container $container) {
+                $dispatcher = $container->get(DispatcherInterface::class);
+                $plugin     = new Eos(
+                    $dispatcher,
+                    (array) PluginHelper::getPlugin('quickicon', 'eos')
+                );
+                $plugin->setApplication(Factory::getApplication());
+                $plugin->setDatabase($container->get(DatabaseInterface::class));
+
+                return $plugin;
+            }
+        );
+    }
+};
diff --git a/plugins/quickicon/eos/src/Extension/Eos.php b/plugins/quickicon/eos/src/Extension/Eos.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`, `protected`, `locked`, `manifest_cache`, `params`, `custom_data`, `ordering`, `state`) VALUES
	`2`	`+ (0, 'plg_quickicon_eos', 'plugin', 'eos', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 7, 0);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder", "client_id", "enabled", "access", "protected", "locked", "manifest_cache", "params", "custom_data", "ordering", "state") VALUES`
	`2`	`+ (0, 'plg_quickicon_eos', 'plugin', 'eos', 'quickicon', 0, 1, 1, 0, 1, '', '', '', 7, 0);`