[4.1] [SOC 21] Add a Scheduled Tasks Infrastructure to Joomla

administrator/components/com_actionlogs/config.xml

@@ -28,7 +28,7 @@
 			type="logtype"
 			label="COM_ACTIONLOGS_LOG_EXTENSIONS_LABEL"
 			multiple="true"
-			default="com_banners,com_cache,com_categories,com_checkin,com_config,com_contact,com_content,com_installer,com_media,com_menus,com_messages,com_modules,com_newsfeeds,com_plugins,com_redirect,com_tags,com_templates,com_users"
+			default="com_banners,com_cache,com_categories,com_checkin,com_config,com_contact,com_content,com_installer,com_media,com_menus,com_messages,com_modules,com_newsfeeds,com_plugins,com_redirect,com_scheduler,com_tags,com_templates,com_users"
 		/>
 		<field
 			name="loggable_api"

administrator/components/com_admin/sql/updates/mysql/4.1.0-2021-08-04.sql

@@ -0,0 +1,9 @@
+-- Add `com_scheduler` to `#__extensions`
+INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`,
+							 `protected`, `locked`, `manifest_cache`, `params`, `custom_data`)
+VALUES (0, 'com_scheduler', 'component', 'com_scheduler', '', 1, 1, 1, 0, 1, '', '', '');
+
+-- Add `plg_task_demotasks` to `#__extensions`
+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_task_demotasks', 'plugin', 'demotasks', 'task', 0, 1, 1, 0, 0, '', '{}', '', 15, 0);

administrator/components/com_admin/sql/updates/mysql/4.1.0-2021-08-08.sql

@@ -0,0 +1,35 @@
+--
+-- Table structure for table `#__scheduler_tasks`
+--
+
+CREATE TABLE IF NOT EXISTS `#__scheduler_tasks` (
+    `id` int unsigned NOT NULL AUTO_INCREMENT,
+    `asset_id` int NOT NULL UNIQUE DEFAULT '0',
+    `title` varchar(255) NOT NULL DEFAULT '',
+    `type` varchar(1024) NOT NULL COMMENT 'unique identifier for job defined by plugin',
+    `execution_rules` text COMMENT 'Execution Rules, Unprocessed',
+    `cron_rules` text COMMENT 'Processed execution rules, crontab-like JSON form',
+    `state` tinyint NOT NULL DEFAULT FALSE,
+    `last_exit_code` int NOT NULL DEFAULT '0' COMMENT 'Exit code when job was last run',
+    `last_execution` datetime COMMENT 'Timestamp of last run',
+    `next_execution` datetime COMMENT 'Timestamp of next (planned) run, referred for execution on trigger',
+    `times_executed` int DEFAULT '0' COMMENT 'Count of successful triggers',
+    `times_failed` int DEFAULT '0' COMMENT 'Count of failures',
+    `locked` datetime,
+    `priority` smallint NOT NULL DEFAULT '0',
+    `ordering` int NOT NULL DEFAULT 0 COMMENT 'Configurable list ordering',
+    `params` text NOT NULL,
+    `note` text,
+    `created` datetime NOT NULL,
+    `created_by` int UNSIGNED NOT NULL DEFAULT '0',
+    `checked_out` int unsigned,
+    `checked_out_time` datetime,
+    PRIMARY KEY (id),
+    KEY `idx_type` (`type`),
+    KEY `idx_state` (`state`),
+    KEY `idx_last_exit` (`last_exit_code`),
+    KEY `idx_next_exec` (`next_execution`),
+    KEY `idx_locked` (`locked`),
+    KEY `idx_priority` (`priority`),
+    KEY `idx_checked_out` (`checked_out`)
+) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 DEFAULT COLLATE = utf8mb4_unicode_ci;

administrator/components/com_admin/sql/updates/mysql/4.1.0-2021-09-12.sql

@@ -0,0 +1,5 @@
+INSERT INTO `#__mail_templates` (`template_id`, `extension`, `language`, `subject`, `body`, `htmlbody`, `attachments`, `params`) VALUES
+('plg_system_tasknotification.failure_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_FAILURE_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_FAILURE_MAIL_BODY', '', '', '{"tags": ["task_id", "task_title", "exit_code", "exec_data_time", "task_output"]}'),
+('plg_system_tasknotification.fatal_recovery_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_FATAL_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_FATAL_MAIL_BODY', '', '', '{"tags": ["task_id", "task_title"]}'),
+('plg_system_tasknotification.orphan_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_ORPHAN_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_ORPHAN_MAIL_BODY', '', '', '{"tags": ["task_id", "task_title", ""]}'),
+('plg_system_tasknotification.success_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_SUCCESS_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_SUCCESS_MAIL_BODY', '', '', '{"tags":["task_id", "task_title", "exec_data_time", "task_output"]}');

administrator/components/com_admin/sql/updates/postgresql/4.1.0-2021-08-04.sql

@@ -0,0 +1,9 @@
+-- Add "com_scheduler" to "#__extensions"
+INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder", "client_id", "enabled", "access",
+							 "protected", "locked", "manifest_cache", "params", "custom_data", "ordering", "state")
+VALUES (0, 'com_scheduler', 'component', 'com_scheduler', '', 1, 1, 1, 0, 1, '', '{}', '', 0, 0);
+
+-- Add "plg_task_demotasks" to "#__extensions"
+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_task_demotasks', 'plugin', 'demotasks', 'task', 0, 1, 1, 0, 0, '', '{}', '', 15, 0);

administrator/components/com_admin/sql/updates/postgresql/4.1.0-2021-08-08.sql

@@ -0,0 +1,37 @@
+--
+-- Table structure for table "#__scheduler_tasks"
+--
+
+CREATE TABLE IF NOT EXISTS "#__scheduler_tasks"
+(
+    "id" serial NOT NULL,
+    "asset_id" bigint NOT NULL DEFAULT '0',
+    "title" varchar(255) NOT NULL,
+    "type" varchar(1024) NOT NULL,
+    "execution_rules" text,
+    "cron_rules" text,
+    "state" smallint NOT NULL DEFAULT '0',
+    "last_exit_code" int NOT NULL DEFAULT '0',
+    "last_execution" timestamp without time zone,
+    "next_execution" timestamp without time zone,
+    "times_executed" int NOT NULL DEFAULT '0',
+    "times_failed" int DEFAULT '0',
+    "locked" timestamp without time zone,
+    "priority" smallint NOT NULL DEFAULT '0',
+    "ordering" bigint DEFAULT 0 NOT NULL,
+    "params" text NOT NULL,
+    "note" text DEFAULT '',
+    "created" timestamp without time zone NOT NULL,
+    "created_by" bigint NOT NULL DEFAULT '0',
+    "checked_out" integer,
+    "checked_out_time" timestamp without time zone,
+    PRIMARY KEY ("id")
+);
+
+CREATE INDEX "#__scheduler_tasks_idx_type" ON "#__scheduler_tasks" ("type");
+CREATE INDEX "#__scheduler_tasks_idx_state" ON "#__scheduler_tasks" ("state");
+CREATE INDEX "#__scheduler_tasks_idx_last_exit" ON "#__scheduler_tasks" ("last_exit_code");
+CREATE INDEX "#__scheduler_tasks_idx_next_exec" ON "#__scheduler_tasks" ("next_execution");
+CREATE INDEX "#__scheduler_tasks_idx_locked" ON "#__scheduler_tasks" ("locked");
+CREATE INDEX "#__scheduler_tasks_idx_priority" ON "#__scheduler_tasks" ("priority");
+CREATE INDEX "#__scheduler_tasks_idx_checked_out" ON "#__scheduler_tasks" ("checked_out");

administrator/components/com_admin/sql/updates/postgresql/4.1.0-2021-09-12.sql

@@ -0,0 +1,5 @@
+INSERT INTO "#__mail_templates" ("template_id", "extension", "language", "subject", "body", "htmlbody", "attachments", "params") VALUES
+('plg_system_tasknotification.failure_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_FAILURE_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_FAILURE_MAIL_BODY', '', '', '{"tags": ["task_id", "task_title", "exit_code", "exec_data_time", "task_output"]}'),
+('plg_system_tasknotification.fatal_recovery_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_FATAL_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_FATAL_MAIL_BODY', '', '', '{"tags": ["task_id", "task_title"]}'),
+('plg_system_tasknotification.orphan_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_ORPHAN_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_ORPHAN_MAIL_BODY', '', '', '{"tags": ["task_id", "task_title", ""]}'),
+('plg_system_tasknotification.success_mail', 'plg_system_tasknotification', '', 'PLG_SYSTEM_TASK_NOTIFICATION_SUCCESS_MAIL_SUBJECT', 'PLG_SYSTEM_TASK_NOTIFICATION_SUCCESS_MAIL_BODY', '', '', '{"tags":["task_id", "task_title", "exec_data_time", "task_output"]}');

administrator/components/com_menus/presets/system.xml

@@ -164,6 +164,14 @@
 			permission="core.manage;com_redirect"
 		/>
 
+		<menuitem
+			title="MOD_MENU_MANAGE_SCHEDULED_TASKS"
+			type="component"
+			element="com_scheduler"
+			link="index.php?option=com_scheduler&amp;view=tasks"
+			permission="core.manage;com_scheduler"
+		/>
+
 		<menuitem
 			title="MOD_MENU_EXTENSIONS_MODULE_MANAGER_SITE"
 			type="component"

administrator/components/com_scheduler/access.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<access component="com_scheduler">
+	<section name="component">
+		<action name="core.admin" title="JACTION_ADMIN"/>
+		<action name="core.options" title="JACTION_OPTIONS"/>
+		<action name="core.manage" title="JACTION_MANAGE"/>
+		<action name="core.create" title="JACTION_CREATE"/>
+		<action name="core.delete" title="JACTION_DELETE"/>
+		<action name="core.edit" title="JACTION_EDIT"/>
+		<action name="core.edit.state" title="JACTION_EDITSTATE"/>
+		<action name="core.testrun" title="COM_SCHEDULER_PERMISSION_TESTRUN"/>
+	</section>
+	<section name="task">
+		<action name="core.delete" title="JACTION_DELETE"/>
+		<action name="core.edit" title="JACTION_EDIT"/>
+		<action name="core.edit.state" title="JACTION_EDITSTATE"/>
+		<action name="core.testrun" title="COM_SCHEDULER_PERMISSION_TESTRUN"/>
+	</section>
+</access>

administrator/components/com_scheduler/config.xml

@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="utf-8"?>
+<config>
+	<fieldset
+		name="task_config"
+		label="COM_SCHEDULER_CONFIG_TASKS_FIELDSET_LABEL"
+		>
+		<field
+			name="timeout"
+			type="number"
+			label="COM_SCHEDULER_CONFIG_TASK_TIMEOUT_LABEL"
+			default="300"
+			required="true"
+			min="10"
+			step="1"
+			validate="number"
+			filter="int"
+		/>
+	</fieldset>
+	<fieldset
+		name="lazy_scheduler_config"
+		label="COM_SCHEDULER_CONFIG_FIELDSET_LAZY_SCHEDULER_LABEL"
+		description="COM_SCHEDULER_CONFIG_FIELDSET_LAZY_SCHEDULER_DESC"
+		>
+		<fields name="lazy_scheduler">
+			<field
+				name="enabled"
+				type="radio"
+				label="COM_SCHEDULER_CONFIG_LAZY_SCHEDULER_ENABLED_LABEL"
+				description="COM_SCHEDULER_CONFIG_LAZY_SCHEDULER_ENABLED_DESC"
+				layout="joomla.form.field.radio.switcher"
+				default="1"
+				required="true"
+				filter="integer"
+				>
+				<option value="0">JDISABLED</option>
+				<option value="1">JENABLED</option>
+			</field>
+			<field
+				name="interval"
+				type="NumberField"
+				label="COM_SCHEDULER_CONFIG_LAZY_SCHEDULER_INTERVAL_LABEL"
+				description="COM_SCHEDULER_CONFIG_LAZY_SCHEDULER_INTERVAL_DESC"
+				showon="enabled:1"
+				min="60"
+				max="16383"
+				step="1"
+				default="300"
+			/>
+		</fields>
+	</fieldset>
+	<fieldset
+		name="webcron_config"
+		label="COM_SCHEDULER_CONFIG_WEBCRON_LABEL"
+		description="COM_SCHEDULER_CONFIG_WEBCRON_DESC"
+		>
+		<fields name="webcron"
+						addfieldprefix="Joomla\Component\Scheduler\Administrator\Field">
+			<field
+				name="enabled"
+				type="radio"
+				label="COM_SCHEDULER_CONFIG_WEBCRON_LABEL"
+				description="COM_SCHEDULER_CONFIG_HASH_PROTECTION_DESC"
+				layout="joomla.form.field.radio.switcher"
+				default="0"
+				required="true"
+				filter="integer"
+				>
+				<option value="0">JDISABLED</option>
+				<option value="1">JENABLED</option>
+			</field>
+			<field
+				name="generate_key_on_save"
+				type="note"
+				description="COM_SCHEDULER_CONFIG_GENERATE_WEBCRON_KEY_DESC"
+				class="alert alert-warning"
+				showon="enabled:1"
+			/>
+			<field
+				name="key"
+				type="hidden"
+				label="COM_SCHEDULER_CONFIG_GLOBAL_WEBCRON_KEY_LABEL"
+				readonly="true"
+				hidden="true"
+			/>
+			<field
+				name="base_link"
+				type="WebcronLink"
+				label="COM_SCHEDULER_CONFIG_GLOBAL_WEBCRON_LINK_LABEL"
+				description="COM_SCHEDULER_CONFIG_GLOBAL_WEBCRON_LINK_DESC"
+				showon="enabled:1"
+				readonly="true"
+				filter="unset"
+			/>
+			<field
+				name="reset_key"
+				type="radio"
+				label="COM_SCHEDULER_CONFIG_RESET_WEBCRON_KEY_LABEL"
+				layout="joomla.form.field.radio.switcher"
+				default="0"
+				showon="enabled:1"
+				required="true"
+				filter="integer"
+				>
+				<option value="0">JNO</option>
+				<option value="1">JYES</option>
+			</field>
+		</fields>
+	</fieldset>
+	<fieldset
+		name="permissions"
+		label="JCONFIG_PERMISSIONS_LABEL"
+		description="JCONFIG_PERMISSIONS_DESC"
+		>
+		<field
+			name="rules"
+			type="rules"
+			label="JCONFIG_PERMISSIONS_LABEL"
+			validate="rules"
+			filter="rules"
+			section="component"
+			component="com_scheduler"
+		/>
+	</fieldset>
+</config>

administrator/components/com_scheduler/forms/filter_tasks.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<form addfieldprefix="Joomla\Component\Scheduler\Administrator\Field">
+	<fields name="filter">
+		<field
+			name="search"
+			type="text"
+			label="COM_SCHEDULER_FILTER_SEARCH_LABEL"
+			description="COM_SCHEDULER_FILTER_SEARCH_DESC"
+			inputmode="search"
+			hint="JSEARCH_FILTER"
+		/>
+		<field
+			name="state"
+			type="taskState"
+			label="JSTATUS"
+			onchange="this.form.submit();"
+			validate="options"
+			>
+			<option value="">JOPTION_SELECT_PUBLISHED</option>
+		</field>
+		<field
+			name="type"
+			type="taskType"
+			label="COM_SCHEDULER_HEADING_TASK_TYPE"
+			onchange="this.form.submit();"
+			>
+			<option value="">COM_SCHEDULER_SELECT_TYPE</option>
+		</field>
+		<field
+			name="orphaned"
+			type="list"
+			label="COM_SCHEDULER_FIELD_LABEL_SHOW_ORPHANED"
+			default="-1"
+			onchange="this.form.submit()"
+			>
+			<option value="-1">COM_SCHEDULER_OPTION_ORPHANED_HIDE</option>
+			<option value="0">COM_SCHEDULER_OPTION_ORPHANED_SHOW</option>
+			<option value="1">COM_SCHEDULER_OPTION_ORPHANED_ONLY</option>
+		</field>
+	</fields>
+
+	<fields name="list">
+		<!-- @todo: Add options for execution date(s) -->
+		<field
+			name="fullordering"
+			type="list"
+			label="JGLOBAL_SORT_BY"
+			onchange="this.form.submit();"
+			default="a.title DESC"
+			validate="options"
+			>
+			<option value="">JGLOBAL_SORT_BY</option>
+			<option value="a.id ASC">JGRID_HEADING_ID_ASC</option>
+			<option value="a.id DESC">JGRID_HEADING_ID_DESC</option>
+			<option value="a.title ASC">JGLOBAL_TITLE_ASC</option>
+			<option value="a.title DESC">JGLOBAL_TITLE_DESC</option>
+			<option value="j.type_title ASC">COM_SCHEDULER_TASK_TYPE_ASC</option>
+			<option value="j.type_title DESC">COM_SCHEDULER_TASK_TYPE_DESC</option>
+			<option value="a.state ASC">JSTATUS_ASC</option>
+			<option value="a.state DESC">JSTATUS_DESC</option>
+			<option value="a.ordering ASC">JGRID_HEADING_ORDERING_ASC</option>
+			<option value="a.ordering DESC">JGRID_HEADING_ORDERING_DESC</option>
+			<option value="a.priority ASC">COM_SCHEDULER_TASK_PRIORITY_ASC</option>
+			<option value="a.priority DESC">COM_SCHEDULER_TASK_PRIORITY_DESC</option>
+		</field>
+		<field
+			name="limit"
+			type="limitbox"
+			label="JGLOBAL_LIST_LIMIT"
+			default="25"
+			onchange="this.form.submit();"
+		/>
+	</fields>
+</form>