[4.2] Convert joomla action log plugin to services

administrator/components/com_actionlogs/src/Helper/ActionlogsHelper.php

@@ -158,19 +158,13 @@ public static function loadTranslationFiles($extension)
 	 * @return  mixed  An object contains content type parameters, or null if not found
 	 *
 	 * @since   3.9.0
+	 *
+	 * @deprecated  5.0 Use the action log config model instead
 	 */
 	public static function getLogContentTypeParams($context)
 	{
-		$db = Factory::getDbo();
-		$query = $db->getQuery(true)
-			->select('a.*')
-			->from($db->quoteName('#__action_log_config', 'a'))
-			->where($db->quoteName('a.type_alias') . ' = :context')
-			->bind(':context', $context);
-
-		$db->setQuery($query);
-
-		return $db->loadObject();
+		return Factory::getApplication()->bootComponent('actionlogs')->getMVCFactory()
+			->createModel('ActionlogConfig', 'Administrator')->getLogContentTypeParams($context);
 	}
 
 	/**

administrator/components/com_actionlogs/src/Model/ActionlogConfigModel.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_actionlogs
+ *
+ * @copyright   (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Actionlogs\Administrator\Model;
+
+\defined('_JEXEC') or die;
+
+use Joomla\CMS\MVC\Model\BaseDatabaseModel;
+use stdClass;
+
+/**
+ * Model to interact with the action log configuration.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class ActionlogConfigModel extends BaseDatabaseModel
+{
+	/**
+	 * Returns the action logs config for the given context.
+	 *
+	 * @param   string    $context  The context of the content
+	 *
+	 * @return  stdClass|null  An object contains content type parameters, or null if not found
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function getLogContentTypeParams(string $context): ?stdClass
+	{
+		$db    = $this->getDatabase();
+		$query = $db->getQuery(true)
+			->select('a.*')
+			->from($db->quoteName('#__action_log_config', 'a'))
+			->where($db->quoteName('a.type_alias') . ' = :context')
+			->bind(':context', $context);
+
+		$db->setQuery($query);
+
+		return $db->loadObject();
+	}
+}

plugins/actionlog/joomla/joomla.xml

@@ -9,8 +9,10 @@
 	<authorUrl>www.joomla.org</authorUrl>
 	<version>3.9.0</version>
 	<description>PLG_ACTIONLOG_JOOMLA_XML_DESCRIPTION</description>
+	<namespace path="src">Joomla\Plugin\Actionlog\Joomla</namespace>
 	<files>
-		<filename plugin="joomla">joomla.php</filename>
+		<folder plugin="joomla">services</folder>
+		<folder>src</folder>
 	</files>
 	<languages>
 		<language tag="en-GB">language/en-GB/plg_actionlog_joomla.ini</language>

plugins/actionlog/joomla/services/provider.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * @package     Joomla.Plugin
+ * @subpackage  System.Actionlog
+ *
+ * @copyright   (C) 2022 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\Plugin\PluginHelper;
+use Joomla\Database\DatabaseInterface;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+use Joomla\Event\DispatcherInterface;
+use Joomla\Plugin\Actionlog\Joomla\Extension\Joomla;
+
+return new class implements ServiceProviderInterface {
+	/**
+	 * Registers the service provider with a DI container.
+	 *
+	 * @param   Container  $container  The DI container.
+	 *
+	 * @return  void
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function register(Container $container)
+	{
+		$container->set(
+			PluginInterface::class,
+			function (Container $container)
+			{
+				$plugin = new Joomla(
+					$container->get(DispatcherInterface::class),
+					(array) PluginHelper::getPlugin('system', 'cache'),
+				);
+				$plugin->setDatabase($container->get(DatabaseInterface::class));
+
+				return $plugin;
+			}
+		);
+	}
+};

plugins/actionlog/joomla/joomla.php → plugins/actionlog/joomla/src/Extension/Joomla.php

@@ -1,30 +1,49 @@
 <?php
 /**
  * @package     Joomla.Plugin
- * @subpackage  System.actionlogs
+ * @subpackage  System.actionlog
  *
  * @copyright   (C) 2018 Open Source Matters, Inc. <https://www.joomla.org>
  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  */
 
+namespace Joomla\Plugin\Actionlog\Joomla\Extension;
+
 defined('_JEXEC') or die;
 
+use Joomla\CMS\Application\CMSApplicationInterface;
 use Joomla\CMS\Component\ComponentHelper;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Installer\Installer;
+use Joomla\CMS\MVC\Factory\MVCFactoryServiceInterface;
 use Joomla\CMS\Table\Table;
 use Joomla\CMS\User\User;
 use Joomla\Component\Actionlogs\Administrator\Helper\ActionlogsHelper;
 use Joomla\Component\Actionlogs\Administrator\Plugin\ActionLogPlugin;
+use Joomla\Database\DatabaseAwareTrait;
+use Joomla\Database\Exception\ExecutionFailureException;
+use Joomla\Event\DispatcherInterface;
 use Joomla\Utilities\ArrayHelper;
+use RuntimeException;
+use stdClass;
 
 /**
  * Joomla! Users Actions Logging Plugin.
  *
  * @since  3.9.0
  */
-class PlgActionlogJoomla extends ActionLogPlugin
+final class Joomla extends ActionLogPlugin
 {
+	use DatabaseAwareTrait;
+
+	/**
+	 * Application object.
+	 *
+	 * @var    CMSApplicationInterface
+	 * @since  __DEPLOY_VERSION__
+	 */
+	protected $app;
+
 	/**
 	 * Array of loggable extensions.
 	 *
@@ -60,14 +79,14 @@ class PlgActionlogJoomla extends ActionLogPlugin
 	/**
 	 * Constructor.
 	 *
-	 * @param   object  &$subject  The object to observe.
-	 * @param   array   $config    An optional associative array of configuration settings.
+	 * @param   DispatcherInterface  $dispatcher  The dispatcher
+	 * @param   array                $config      An optional associative array of configuration settings
 	 *
 	 * @since   3.9.0
 	 */
-	public function __construct(&$subject, $config)
+	public function __construct(DispatcherInterface $dispatcher, array $config)
 	{
-		parent::__construct($subject, $config);
+		parent::__construct($dispatcher, $config);
 
 		$params = ComponentHelper::getComponent('com_actionlogs')->getParams();
 
@@ -77,7 +96,6 @@ public function __construct(&$subject, $config)
 
 		$this->loggableVerbs      = $params->get('loggable_verbs', []);
 	}
-
 	/**
 	 * After save content logging method
 	 * This method adds a record to #__action_logs contains (message, date, context, user)
@@ -98,7 +116,7 @@ public function onContentAfterSave($context, $article, $isNew): void
 			$context = $this->contextAliases[$context];
 		}
 
-		$params = ActionlogsHelper::getLogContentTypeParams($context);
+		$params = $this->getActionLogParams($context);
 
 		// Not found a valid content type, don't process further
 		if ($params === null)
@@ -164,7 +182,7 @@ public function onContentAfterDelete($context, $article): void
 			return;
 		}
 
-		$params = ActionlogsHelper::getLogContentTypeParams($context);
+		$params = $this->getActionLogParams($context);
 
 		// Not found a valid content type, don't process further
 		if ($params === null)
@@ -216,7 +234,7 @@ public function onContentChangeState($context, $pks, $value)
 			return;
 		}
 
-		$params = ActionlogsHelper::getLogContentTypeParams($context);
+		$params = $this->getActionLogParams($context);
 
 		// Not found a valid content type, don't process further
 		if ($params === null)
@@ -261,7 +279,7 @@ public function onContentChangeState($context, $pks, $value)
 			$messageLanguageKey = $defaultLanguageKey;
 		}
 
-		$db    = $this->db;
+		$db    = $this->getDatabase();
 		$query = $db->getQuery(true)
 			->select($db->quoteName([$params->title_holder, $params->id_holder]))
 			->from($db->quoteName($params->table_name))
@@ -457,7 +475,7 @@ public function onExtensionAfterUpdate($installer, $eid)
 			return;
 		}
 
-		$manifest      = $installer->get('manifest');
+		$manifest = $installer->get('manifest');
 
 		if ($manifest === null)
 		{
@@ -513,7 +531,7 @@ public function onExtensionAfterSave($context, $table, $isNew): void
 			return;
 		}
 
-		$params = ActionlogsHelper::getLogContentTypeParams($context);
+		$params = $this->getActionLogParams($context);
 
 		// Not found a valid content type, don't process further
 		if ($params === null)
@@ -570,7 +588,7 @@ public function onExtensionAfterDelete($context, $table): void
 			return;
 		}
 
-		$params = ActionlogsHelper::getLogContentTypeParams($context);
+		$params = $this->getActionLogParams($context);
 
 		// Not found a valid content type, don't process further
 		if ($params === null)
@@ -839,17 +857,18 @@ public function onUserLoginFailure($response)
 		}
 
 		// Get the user id for the given username
-		$query = $this->db->getQuery(true)
-			->select($this->db->quoteName(array('id', 'username')))
-			->from($this->db->quoteName('#__users'))
-			->where($this->db->quoteName('username') . ' = ' . $this->db->quote($response['username']));
-		$this->db->setQuery($query);
+		$db    = $this->getDatabase();
+		$query = $db->getQuery(true)
+			->select($db->quoteName(array('id', 'username')))
+			->from($db->quoteName('#__users'))
+			->where($db->quoteName('username') . ' = ' . $db->quote($response['username']));
+		$db->setQuery($query);
 
 		try
 		{
-			$loggedInUser = $this->db->loadObject();
+			$loggedInUser = $db->loadObject();
 		}
-		catch (\Joomla\Database\Exception\ExecutionFailureException $e)
+		catch (ExecutionFailureException $e)
 		{
 			return;
 		}
@@ -992,7 +1011,7 @@ public function onAfterCheckin($table)
 			'userid'      => $user->id,
 			'username'    => $user->username,
 			'accountlink' => 'index.php?option=com_users&task=user.edit&id=' . $user->id,
-			'table'       => str_replace($this->db->getPrefix(), '#__', $table),
+			'table'       => str_replace($this->getDatabase()->getPrefix(), '#__', $table),
 		);
 
 		$this->addLog(array($message), 'PLG_ACTIONLOG_JOOMLA_USER_CHECKIN', $context, $user->id);
@@ -1153,7 +1172,7 @@ public function onJoomlaAfterUpdate($oldVersion = null)
 
 		if (empty($oldVersion))
 		{
-			$oldVersion = \Joomla\CMS\Language\Text::_('JLIB_UNKNOWN');
+			$oldVersion = $this->app->getLanguage()->_('JLIB_UNKNOWN');
 		}
 
 		$message = array(
@@ -1170,4 +1189,25 @@ public function onJoomlaAfterUpdate($oldVersion = null)
 		);
 		$this->addLog(array($message), 'PLG_ACTIONLOG_JOOMLA_USER_UPDATE', $context, $user->id);
 	}
+
+	/**
+	 * Returns the action log params for the given context.
+	 *
+	 * @param   string  $context  The context of the action log
+	 *
+	 * @return  stdClass  The params
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	private function getActionLogParams($context): ?stdClass
+	{
+		$component = $this->app->bootComponent('actionlogs');
+
+		if (!$component instanceof MVCFactoryServiceInterface)
+		{
+			return null;
+		}
+
+		return $component->getMVCFactory()->createModel('ActionlogConfig', 'Administrator')->getLogContentTypeParams($context);
+	}
 }