[4.1] poor man’s cron 3rd attempt

administrator/components/com_actionlogs/config.xml

@@ -56,5 +56,16 @@
 			<option value="PUT">COM_ACTIONLOGS_FIELD_VALUE_PUT</option>
 			<option value="PATCH">COM_ACTIONLOGS_FIELD_VALUE_PATCH</option>
 		</field>
+		<field
+			name="loggable_job"
+			type="radio"
+			label="COM_ACTIONLOGS_JOB_LOGGING_LABEL"
+			layout="joomla.form.field.radio.switcher"
+			default="0"
+			filter="integer"
+			>
+			<option value="0">JNO</option>
+			<option value="1">JYES</option>
+		</field>
 	</fieldset>
 </config>

administrator/components/com_admin/sql/updates/mysql/4.1.0-2020-09-29.sql

@@ -0,0 +1,9 @@
+
+CREATE TABLE IF NOT EXISTS `#__jobs` (
+  `element` varchar(100) NOT NULL,
+  `folder` varchar(100) NOT NULL,
+  PRIMARY KEY (`element`, `folder`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 DEFAULT COLLATE=utf8mb4_unicode_ci;
+
+INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`, `protected`, `locked`, `manifest_cache`, `params`, `ordering`, `state`, `custom_data`) VALUES
+(0, 'plg_system_scheduler', 'plugin', 'scheduler', 'system', 0, 1, 1, 0, 1, '', '{"timeout":"3","webcron":"0","webcronkey":"","lastrun":"0","unit":"60","taskid":"0"}', 0, 0, '');

administrator/components/com_admin/sql/updates/postgresql/4.1.0-2020-09-29.sql

@@ -0,0 +1,8 @@
+CREATE TABLE IF NOT EXISTS "#__jobs" (
+  "element" varchar(100) NOT NULL,
+  "folder" varchar(100) NOT NULL,
+  PRIMARY KEY ("element", "folder")
+);
+
+INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder", "client_id", "enabled", "access", "protected", "locked", "manifest_cache", "params", "ordering", "state", "custom_data") VALUES
+(0, 'plg_system_scheduler', 'plugin', 'scheduler', 'system', 0, 1, 1, 0, 1, '', '{"timeout":"3","webcron":"0","webcronkey":"","lastrun":"0","unit":"60","taskid":"0"}', 0, 0, '');

administrator/components/com_plugins/src/Jobs/JobsPlugin.php

@@ -0,0 +1,270 @@
+<?php
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_plugins
+ *
+ * @copyright   Copyright (C) 2005 - 2020 Open Source Matters, Inc. All rights reserved.
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Plugins\Administrator\Jobs;
+
+\defined('_JEXEC') or die;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Form\Form;
+use Joomla\CMS\Form\FormHelper;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Log\Log;
+use Joomla\CMS\Plugin\CMSPlugin;
+use Joomla\CMS\Plugin\PluginHelper;
+use Joomla\Registry\Registry;
+
+/**
+ * Abstract Jobs Plugin
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+abstract class JobsPlugin extends CMSPlugin
+{
+
+	/**
+	 * Exit Code For no time to run
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public const JOB_NO_TIME = 1;
+
+	/**
+	 * Exit Code For lock failure
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public const JOB_NO_LOCK = 2;
+
+	/**
+	 * Exit Code For execution failure
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public const JOB_KO_RUN = 3;
+
+	/**
+	 * Exit Code For execution success
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public const JOB_OK_RUN = 0;
+
+	/**
+	 * The status of the process
+	 *
+	 * @var    array
+	 * @since  __DEPLOY_VERSION__
+	 */
+	protected $snapshot = [];
+
+	/**
+	 * Database object.
+	 *
+	 * @var    DatabaseDriver
+	 * @since  __DEPLOY_VERSION__
+	 */
+	protected $db;
+
+	/**
+	 * The Application object
+	 *
+	 * @var    JApplicationSite
+	 * @since  __DEPLOY_VERSION__
+	 */
+	protected $app;
+
+	/**
+	 * Get a pseudo Lock to the row.
+	 *
+	 * @param   string   $name    The plugin name.
+	 * @param   string   $type    The plugin type, relates to the subdirectory in the plugins directory.
+	 * @param   string   $params  The plugin params.
+	 * @param   boolean  $force   Force execution.
+	 *
+	 * @return  boolean  True on success.
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function acquireLock($name, $type, $params, $force = false) : bool
+	{
+		$lastrun = $params->get('lastrun', 0);
+
+		// Get the timeout for Joomla! job plugin task
+		$now     = time();
+		$timeout = (int) $params->get('timeout', 1);
+		$unit    = (int) $params->get('unit', 86400);
+		$timeout = ($unit * $timeout);
+
+		$eid = PluginHelper::getPlugin($type, $name);
+
+		$this->snapshot['eid'] = $eid->id;
+		$this->snapshot['job'] = $name;
+		$this->snapshot['status'] = self::JOB_NO_TIME;
+		$this->snapshot['duration'] = 0;
+
+		if (((abs($now - $lastrun) < $timeout)) && (!$force))
+		{
+			// It's not time to run
+			return false;
+		}
+
+		if (!$this->setLocked($name, $type))
+		{
+			$this->snapshot['status'] = self::JOB_NO_LOCK;
+
+			return false;
+		}
+
+		$this->snapshot['status'] = self::JOB_OK_RUN;
+
+		return true;
+	}
+
+	/**
+	 * Pseudo Lock the row.
+	 *
+	 * @param   string  $name  The plugin name.
+	 * @param   string  $type  The plugin type, relates to the subdirectory in the plugins directory.
+	 *
+	 * @return  boolean  True on success.
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function setLocked($name, $type) : bool
+	{
+		$db = $this->db;
+
+		try
+		{
+			$query = $db->getQuery(true)
+				->insert($db->quoteName('#__jobs'))
+				->values(':element, :folder')
+				->bind(':element', $name)
+				->bind(':folder', $type);
+
+			$db->setQuery($query);
+			$db->execute();
+		}
+		catch (\RuntimeException $e)
+		{
+			// Ignore it
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Pseudo unLock the row.
+	 *
+	 * @param   string  $name    The plugin name.
+	 * @param   string  $type    The plugin type, relates to the subdirectory in the plugins directory.
+	 *
+	 * @return  boolean  True on success.
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function releaseLock($name, $type) : bool
+	{
+		$db = $this->db;
+
+		try
+		{
+			$query = $db->getQuery(true)
+				->delete($db->quoteName('#__jobs'))
+				->where($db->quoteName('element') . ' = :element')
+				->where($db->quoteName('folder') . ' = :folder')
+				->bind(':element', $name)
+				->bind(':folder', $type);
+
+			$db->setQuery($query);
+			$db->execute();
+		}
+		catch (\RuntimeException $e)
+		{
+			// Ignore it
+			$this->snapshot['status'] = self::JOB_KO_RUN;
+			$this->snapshot['duration'] = 0;
+
+			return false;
+		}
+
+		$taskid   = null;
+
+		$query = $db->getQuery(true);
+		$query->select($db->quoteName('params'))
+			->from($db->quoteName('#__extensions'))
+			->where($db->quoteName('element') . ' = :element')
+			->where($db->quoteName('folder') . ' = :folder')
+			->bind(':element', $name)
+			->bind(':folder', $type);
+
+		$db->setQuery($query);
+
+		$params = $db->loadColumn();
+		$query  = $db->getQuery(true);
+		$now    = Factory::getDate()->toSql();
+		$query->update($db->quoteName('#__extensions'));
+
+		// Update last run and taskid
+		$taskParams = json_decode($params[0], true);
+		$taskid = $taskParams['taskid'];
+
+		$taskid++;
+		$registry = new Registry($taskParams);
+		$registry->set('taskid', $taskid);
+		$registry->set('lastrun', time());
+		$jsonparam = $registry->toString('JSON');
+
+		$query->set($db->quoteName('params') . ' = :params')
+			->where($db->quoteName('element') . ' = :element')
+			->where($db->quoteName('folder') . ' = :folder')
+			->bind(':params', $jsonparam)
+			->bind(':element', $name)
+			->bind(':folder', $type);
+
+		try
+		{
+			// Update the plugin parameters
+			$result = $db->setQuery($query)->execute();
+		}
+		catch (RuntimeException $e)
+		{
+			// If we failed to execute
+			return false;
+		}
+
+		$result = (int) $db->getAffectedRows();
+
+		if ($result === 0)
+		{
+			return false;
+		}
+
+		if ($this->_name === 'scheduler')
+		{
+			return true;
+		}
+
+		$endTime    = microtime(true);
+		$this->snapshot['duration'] = sprintf('%0.2f', $endTime - $this->snapshot['startTime']);
+
+		Log::add(
+			Text::sprintf('PLG_JOB_' . strtoupper($this->_name) . '_END', $this->_name) .
+			Text::sprintf('PLG_JOB_' . strtoupper($this->_name) . '_TASK', $taskid) .
+			Text::sprintf('PLG_JOB_' . strtoupper($this->_name) . '_PROCESS_RESULT', $this->snapshot['status']) .
+			Text::sprintf('PLG_JOB_' . strtoupper($this->_name) . '_PROCESS_COMPLETE', $this->snapshot['duration']),
+			Log::INFO,
+			'scheduler'
+		);
+
+		return true;
+	}
+}

administrator/language/en-GB/com_actionlogs.ini

@@ -34,6 +34,7 @@ COM_ACTIONLOGS_IP_ADDRESS_ASC="IP Address ascending"
 COM_ACTIONLOGS_IP_ADDRESS_DESC="IP Address descending"
 COM_ACTIONLOGS_IP_INVALID="Invalid IP"
 COM_ACTIONLOGS_IP_LOGGING_LABEL="IP Logging"
+COM_ACTIONLOGS_JOB_LOGGING_LABEL="Job Logs"
 COM_ACTIONLOGS_LOG_EXTENSIONS_LABEL="Events To Log"
 COM_ACTIONLOGS_LOG_VERBS_LABEL="Verbs To Log"
 COM_ACTIONLOGS_MANAGER_USERLOGS="User Actions Log"

administrator/language/en-GB/plg_actionlog_joomla.ini

@@ -57,3 +57,4 @@ PLG_ACTIONLOG_JOOMLA_EXTENSION_INSTALLED="User <a href='{accountlink}'>{username
 PLG_ACTIONLOG_JOOMLA_EXTENSION_UNINSTALLED="User <a href='{accountlink}'>{username}</a> uninstalled the {type} {extension_name}"
 PLG_ACTIONLOG_JOOMLA_EXTENSION_UPDATED="User <a href='{accountlink}'>{username}</a> updated the {type} {extension_name}"
 PLG_ACTIONLOG_JOOMLA_PLUGIN_INSTALLED="User <a href='{accountlink}'>{username}</a> installed the plugin <a href='index.php?option=com_plugins&task=plugin.edit&extension_id={id}'>{extension_name}</a>"
+PLG_ACTIONLOG_JOOMLA_PLUGIN_JOB="Executed the <a href='index.php?option=com_plugins&task=plugin.edit&extension_id={eid}'> {job}</a> in {duration} with return code {status}"

administrator/language/en-GB/plg_system_scheduler.ini

@@ -0,0 +1,14 @@
+; Joomla! Project
+; Copyright (C) 2005 - 2020 Open Source Matters. All rights reserved.
+; License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php
+; Note : All ini files need to be saved as UTF-8
+
+PLG_SYSTEM_SCHEDULER="System - Job Scheduler"
+PLG_SYSTEM_SCHEDULER_END="Scheduler>stop>task#%s"
+PLG_SYSTEM_SCHEDULER_LOCKED="The scheduler is locked"
+PLG_SYSTEM_SCHEDULER_PROCESS_COMPLETE="Scheduler took %s seconds."
+PLG_SYSTEM_SCHEDULER_START="Starting Scheduler"
+PLG_SYSTEM_SCHEDULER_TIMEOUT_LABEL="Frequency (in minutes)"
+PLG_SYSTEM_SCHEDULER_WEBCRON_LABEL="Webcron"
+PLG_SYSTEM_SCHEDULER_WEBCRONKEY_LABEL="Activation Key"
+PLG_SYSTEM_SCHEDULER_XML_DESCRIPTION="This plugin looks for job plugin tasks to run."

administrator/language/en-GB/plg_system_scheduler.sys.ini

@@ -0,0 +1,7 @@
+; Joomla! Project
+; Copyright (C) 2005 - 2020 Open Source Matters. All rights reserved.
+; License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php
+; Note : All ini files need to be saved as UTF-8
+
+PLG_SYSTEM_SCHEDULER="System - Job Scheduler"
+PLG_SYSTEM_SCHEDULER_XML_DESCRIPTION="This plugin looks for job plugin tasks to run."

installation/sql/mysql/base.sql

@@ -363,7 +363,8 @@ INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`,
 (0, 'plg_workflow_publishing', 'plugin', 'publishing', 'workflow', 0, 1, 1, 0, 1, '', '{}', '', 0, 0),
 (0, 'plg_workflow_featuring', 'plugin', 'featuring', 'workflow', 0, 1, 1, 0, 1, '', '{}', '', 0, 0),
 (0, 'plg_workflow_notification', 'plugin', 'notification', 'workflow', 0, 1, 1, 0, 1, '', '{}', '', 0, 0),
-(0, 'plg_content_imagelazyload', 'plugin', 'imagelazyload', 'content', 0, 0, 1, 0, 1, '', '{}', '', 0, 0);
+(0, 'plg_content_imagelazyload', 'plugin', 'imagelazyload', 'content', 0, 0, 1, 0, 1, '', '{}', '', 0, 0),
+(0, 'plg_system_scheduler', 'plugin', 'scheduler', 'system', 0, 1, 1, 0, 1, '', '{"timeout":"3","webcron":"0","webcronkey":"","lastrun":"0","unit":"60","taskid":"0"}', '', 0, 0);
 
 -- Templates
 INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`, `protected`, `locked`, `manifest_cache`, `params`, `custom_data`, `ordering`, `state`) VALUES
@@ -1166,3 +1167,9 @@ INSERT INTO `#__workflow_transitions` (`id`, `asset_id`, `published`, `ordering`
 (5, 62, 1, 5, 1, 'Feature', '', -1, 1, '{"featuring":"1"}'),
 (6, 63, 1, 6, 1, 'Unfeature', '', -1, 1, '{"featuring":"0"}'),
 (7, 64, 1, 7, 1, 'Publish & Feature', '', -1, 1, '{"publishing":"1","featuring":"1"}');
+
+CREATE TABLE IF NOT EXISTS `#__jobs` (
+  `element` varchar(100) NOT NULL,
+  `folder` varchar(100) NOT NULL,
+  PRIMARY KEY (`element`, `folder`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 DEFAULT COLLATE=utf8mb4_unicode_ci;

installation/sql/postgresql/base.sql

@@ -369,7 +369,8 @@ INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder",
 (0, 'plg_workflow_publishing', 'plugin', 'publishing', 'workflow', 0, 1, 1, 0, 1, '', '{}', '', 0, 0),
 (0, 'plg_workflow_featuring', 'plugin', 'featuring', 'workflow', 0, 1, 1, 0, 1, '', '{}', '', 0, 0),
 (0, 'plg_workflow_notification', 'plugin', 'notification', 'workflow', 0, 1, 1, 0, 1, '', '{}', '', 0, 0),
-(0, 'plg_content_imagelazyload', 'plugin', 'imagelazyload', 'content', 0, 0, 1, 0, 1, '', '{}', '', 0, 0);
+(0, 'plg_content_imagelazyload', 'plugin', 'imagelazyload', 'content', 0, 0, 1, 0, 1, '', '{}', '', 0, 0),
+(0, 'plg_system_scheduler', 'plugin', 'scheduler', 'system', 0, 1, 1, 0, 1, '', '{"timeout":"3","webcron":"0","webcronkey":"","lastrun":"0","unit":"60","taskid":"0"}', '', 0, 0);
 
 -- Templates
 INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder", "client_id", "enabled", "access", "protected", "locked", "manifest_cache", "params", "custom_data", "ordering", "state") VALUES
@@ -1187,3 +1188,9 @@ INSERT INTO "#__workflow_transitions" ("id", "asset_id", "published", "ordering"
 (7, 64, 1, 7, 1, 'Publish & Feature', '', -1, 1, '{"publishing":"1","featuring":"1"}');
 
 SELECT setval('#__workflow_transitions_id_seq', 8, false);
+
+CREATE TABLE IF NOT EXISTS "#__jobs" (
+  "element" varchar(100) NOT NULL,
+  "folder" varchar(100) NOT NULL,
+  PRIMARY KEY ("element", "folder")
+);