Workflow v3

.github/CODEOWNERS

@@ -54,3 +54,18 @@ plugins/system/webauthn/*   @nikosdion
 media/plg_system_webauthn/*   @nikosdion
 language/administrator/en-GB/en-GB.plg_system_webauthn.ini   @nikosdion
 language/administrator/en-GB/en-GB.plg_system_webauthn.sys.ini   @nikosdion
+
+# Workflow
+administrator/components/com_workflow/*	@bembelimen @hleithner
+administrator/language/en-GB/com_workflow.ini	@bembelimen @hleithner
+administrator/language/en-GB/com_workflow.sys.ini	@bembelimen @hleithner
+administrator/language/en-GB/plg_workflow_publishing.ini	@bembelimen @hleithner
+administrator/language/en-GB/plg_workflow_publishing.sys.ini	@bembelimen @hleithner
+libraries/src/Form/Field/TransitionField.php	@bembelimen @hleithner
+libraries/src/Form/Field/Workflow*	@bembelimen @hleithner
+libraries/src/HTML/Helpers/Workflow*	@bembelimen @hleithner
+libraries/src/MVC/Model/Workflow*	@bembelimen @hleithner
+libraries/src/MVC/Model/Workflow*	@bembelimen @hleithner
+libraries/src/Workflow/*	@bembelimen @hleithner
+build/media_source/com_workflow/*	@bembelimen @hleithner
+plugins/workflow/*	@bembelimen @hleithner

administrator/components/com_admin/script.php

@@ -6560,7 +6560,7 @@ private function contactItems(Table $tableItem): array
 		}
 
 		$parentId    = $tableItem->id;
-		$componentId = ExtensionHelper::getExtensionRecord('com_fields')->extension_id;
+		$componentId = ExtensionHelper::getExtensionRecord('com_fields', 'component')->extension_id;
 
 		// Add Contact Fields Menu Items.
 		$menuItems = [
@@ -6576,7 +6576,7 @@ private function contactItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,
@@ -6601,7 +6601,7 @@ private function contactItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,
@@ -6626,7 +6626,7 @@ private function contactItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,
@@ -6670,7 +6670,7 @@ private function finderItems(Table $tableItem): array
 		}
 
 		$parentId    = $tableItem->id;
-		$componentId = ExtensionHelper::getExtensionRecord('com_finder')->extension_id;
+		$componentId = ExtensionHelper::getExtensionRecord('com_finder', 'component')->extension_id;
 
 		// Add Finder Fields Menu Items.
 		$menuItems = [
@@ -6686,7 +6686,7 @@ private function finderItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,
@@ -6711,7 +6711,7 @@ private function finderItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,
@@ -6736,7 +6736,7 @@ private function finderItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,
@@ -6761,7 +6761,7 @@ private function finderItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,
@@ -6786,7 +6786,7 @@ private function finderItems(Table $tableItem): array
 				'parent_id'         => $parentId,
 				'level'             => 2,
 				'component_id'      => $componentId,
-				'checked_out'       => 0,
+				'checked_out'       => null,
 				'checked_out_time'  => null,
 				'browserNav'        => 0,
 				'access'            => 0,

administrator/components/com_admin/sql/updates/mysql/4.0.0-2018-05-15.sql

@@ -10,7 +10,6 @@ CREATE TABLE IF NOT EXISTS `#__workflows` (
   `description` text NOT NULL,
   `extension` varchar(50) NOT NULL,
   `default` tinyint(1) NOT NULL  DEFAULT 0,
-  `core` tinyint(1) NOT NULL  DEFAULT 0,
   `ordering` int(11) NOT NULL DEFAULT 0,
   `created` datetime NOT NULL,
   `created_by` int(10) NOT NULL DEFAULT 0,
@@ -34,8 +33,8 @@ CREATE TABLE IF NOT EXISTS `#__workflows` (
 -- Dumping data for table `#__workflows`
 --
 
-INSERT INTO `#__workflows` (`id`, `asset_id`, `published`, `title`, `description`, `extension`, `default`, `core`,`ordering`, `created`, `created_by`, `modified`, `modified_by`, `checked_out_time`, `checked_out`) VALUES
-(1, 0, 1, 'COM_WORKFLOW_DEFAULT_WORKFLOW', '', 'com_content', 1, 1, 1, CURRENT_TIMESTAMP(), 0, CURRENT_TIMESTAMP(), 0, NULL, 0);
+INSERT INTO `#__workflows` (`id`, `asset_id`, `published`, `title`, `description`, `extension`, `default`, `ordering`, `created`, `created_by`, `modified`, `modified_by`, `checked_out_time`, `checked_out`) VALUES
+(1, 0, 1, 'COM_WORKFLOW_BASIC_WORKFLOW', '', 'com_content.article', 1, 1, CURRENT_TIMESTAMP(), 0, CURRENT_TIMESTAMP(), 0, NULL, 0);
 
 --
 -- Table structure for table `#__workflow_associations`
@@ -64,7 +63,6 @@ CREATE TABLE IF NOT EXISTS `#__workflow_stages` (
   `published` tinyint(1) NOT NULL DEFAULT 0,
   `title` varchar(255) NOT NULL,
   `description` text NOT NULL,
-  `condition` int(10) DEFAULT 0,
   `default` tinyint(1) NOT NULL DEFAULT 0,
   `checked_out_time` datetime,
   `checked_out` int(10) NOT NULL DEFAULT 0,
@@ -80,11 +78,8 @@ CREATE TABLE IF NOT EXISTS `#__workflow_stages` (
 -- Dumping data for table `#__workflow_stages`
 --
 
-INSERT INTO `#__workflow_stages` (`id`, `asset_id`, `ordering`, `workflow_id`, `published`, `title`, `description`, `condition`, `default`, `checked_out_time`, `checked_out`) VALUES
-(1, 0, 1, 1, 1, 'JUNPUBLISHED', '', 0, 1, NULL, 0),
-(2, 0, 2, 1, 1, 'JPUBLISHED', '', 1, 0, NULL, 0),
-(3, 0, 3, 1, 1, 'JTRASHED', '', -2, 0, NULL, 0),
-(4, 0, 4, 1, 1, 'JARCHIVED', '', 2, 0, NULL, 0);
+INSERT INTO `#__workflow_stages` (`id`, `asset_id`, `ordering`, `workflow_id`, `published`, `title`, `description`, `default`, `checked_out_time`, `checked_out`) VALUES
+(1, 0, 1, 1, 1, 'COM_WORKFLOW_BASIC_STAGE', '', 1, NULL, 0);
 
 --
 -- Table structure for table `#__workflow_transitions`
@@ -100,6 +95,7 @@ CREATE TABLE IF NOT EXISTS `#__workflow_transitions` (
   `description` text NOT NULL,
   `from_stage_id` int(10) NOT NULL,
   `to_stage_id` int(10) NOT NULL,
+  `options` text NOT NULL,
   `checked_out_time` datetime,
   `checked_out` int(10) NOT NULL DEFAULT 0,
   PRIMARY KEY (`id`),
@@ -115,21 +111,31 @@ CREATE TABLE IF NOT EXISTS `#__workflow_transitions` (
 -- Dumping data for table `#__workflow_transitions`
 --
 
-INSERT INTO `#__workflow_transitions` (`id`, `asset_id`, `published`, `ordering`, `workflow_id`, `title`, `description`, `from_stage_id`, `to_stage_id`, `checked_out_time`, `checked_out`) VALUES
-(1, 0, 1, 1, 1, 'Unpublish', '', -1, 1, NULL, 0),
-(2, 0, 1, 2, 1, 'Publish', '', -1, 2, NULL, 0),
-(3, 0, 1, 3, 1, 'Trash', '', -1, 3, NULL, 0),
-(4, 0, 1, 4, 1, 'Archive', '', -1, 4, NULL, 0);
+INSERT INTO `#__workflow_transitions` (`id`, `asset_id`, `published`, `ordering`, `workflow_id`, `title`, `description`, `from_stage_id`, `to_stage_id`, `options`, `checked_out_time`, `checked_out`) VALUES
+(1, 0, 1, 1, 1, 'Unpublish', '', -1, 1, '{"publishing":"0"}', NULL, 0),
+(2, 0, 1, 2, 1, 'Publish', '', -1, 1, '{"publishing":"1"}', NULL, 0),
+(3, 0, 1, 3, 1, 'Trash', '', -1, 1, '{"publishing":"-2"}', NULL, 0),
+(4, 0, 1, 4, 1, 'Archive', '', -1, 1, '{"publishing":"2"}', NULL, 0),
+(5, 0, 1, 5, 1, 'Feature', '', -1, 1, '{"featuring":"1"}', NULL, 0),
+(6, 0, 1, 6, 1, 'Unfeature', '', -1, 1, '{"featuring":"0"}', NULL, 0),
+(7, 0, 1, 7, 1, 'Publish & Feature', '', -1, 1, '{"publishing":"1","featuring":"1"}', NULL, 0);
 
 --
 -- Creating extension entry
 --
+-- Note that the old pseudo null dates have to be used for the `checked_out_time`
+-- column because the conversion to real null dates will be done with a later
+-- update SQL script.
+--
 
 INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`, `protected`, `manifest_cache`, `params`, `checked_out`, `checked_out_time`, `ordering`, `state`) VALUES
-(0, 'com_workflow', 'component', 'com_workflow', '', 1, 1, 0, 0, '', '{}', 0, '0000-00-00 00:00:00', 0, 0);
+(0, 'com_workflow', 'component', 'com_workflow', '', 1, 1, 0, 1, '', '{}', 0, '0000-00-00 00:00:00', 0, 0),
+(0, 'plg_workflow_publishing', 'plugin', 'publishing', 'workflow', 0, 1, 1, 0, '', '{}', 0, '0000-00-00 00:00:00', 0, 0),
+(0, 'plg_workflow_featuring', 'plugin', 'featuring', 'workflow', 0, 1, 1, 0, '', '{}', 0, '0000-00-00 00:00:00', 0, 0),
+(0, 'plg_workflow_notification', 'plugin', 'notification', 'workflow', 0, 1, 1, 0, '', '{}', 0, '0000-00-00 00:00:00', 0, 0);
 
 --
 -- Creating Associations for existing content
 --
 INSERT INTO `#__workflow_associations` (`item_id`, `stage_id`, `extension`)
-SELECT `id`, CASE WHEN `state` = -2 THEN 3 WHEN `state` = 0 THEN 1 WHEN `state` = 2 THEN 4 ELSE 2 END, 'com_content' FROM `#__content`;
+SELECT `id`, 1, 'com_content.article' FROM `#__content`;

administrator/components/com_admin/sql/updates/mysql/4.0.0-2020-05-29.sql

@@ -0,0 +1,39 @@
+ALTER TABLE `#__extensions` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__menu` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__modules` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__tags` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__update_sites` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__user_notes` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__workflows` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__workflow_stages` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__workflow_transitions` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__banners` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__banner_clients` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__contact_details` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__content` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__finder_filters` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__newsfeeds` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__categories` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__fields` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__fields_groups` MODIFY `checked_out` INT(10) UNSIGNED;
+ALTER TABLE `#__ucm_content` MODIFY `core_checked_out_user_id` INT(10) UNSIGNED;
+
+UPDATE `#__extensions` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__menu` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__modules` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__tags` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__update_sites` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__user_notes` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__workflows` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__workflow_stages` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__workflow_transitions` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__banners` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__banner_clients` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__contact_details` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__content` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__finder_filters` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__newsfeeds` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__categories` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__fields` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__fields_groups` SET `checked_out` = null WHERE `checked_out` = 0;
+UPDATE `#__ucm_content` SET `core_checked_out_user_id` = null WHERE `checked_out` = 0;

administrator/components/com_admin/sql/updates/postgresql/4.0.0-2018-05-15.sql

@@ -10,7 +10,6 @@ CREATE TABLE IF NOT EXISTS "#__workflows" (
   "description" text NOT NULL,
   "extension" varchar(50) NOT NULL,
   "default" smallint NOT NULL  DEFAULT 0,
-  "core" smallint NOT NULL  DEFAULT 0,
   "ordering" bigint NOT NULL DEFAULT 0,
   "created" timestamp without time zone NOT NULL,
   "created_by" bigint DEFAULT 0 NOT NULL,
@@ -31,8 +30,8 @@ CREATE INDEX "#__workflows_idx_modified" ON "#__workflows" ("modified");
 CREATE INDEX "#__workflows_idx_modified_by" ON "#__workflows" ("modified_by");
 CREATE INDEX "#__workflows_idx_checked_out" ON "#__workflows" ("checked_out");
 
-INSERT INTO "#__workflows" ("id", "asset_id", "published", "title", "description", "extension", "default", "core", "ordering", "created", "created_by", "modified", "modified_by", "checked_out_time", "checked_out") VALUES
-(1, 0, 1, 'COM_WORKFLOW_DEFAULT_WORKFLOW', '', 'com_content', 1, 1, 1, CURRENT_TIMESTAMP, 0, CURRENT_TIMESTAMP, 0, NULL, 0);
+INSERT INTO "#__workflows" ("id", "asset_id", "published", "title", "description", "extension", "default", "ordering", "created", "created_by", "modified", "modified_by", "checked_out_time", "checked_out") VALUES
+(1, 0, 1, 'COM_WORKFLOW_BASIC_WORKFLOW', '', 'com_content.article', 1, 1, CURRENT_TIMESTAMP, 0, CURRENT_TIMESTAMP, 0, NULL, 0);
 
 --
 -- Table structure for table "#__workflow_associations"
@@ -64,7 +63,6 @@ CREATE TABLE IF NOT EXISTS "#__workflow_stages" (
   "published" smallint NOT NULL  DEFAULT 0,
   "title" varchar(255) NOT NULL,
   "description" text NOT NULL,
-  "condition" bigint DEFAULT 0 NOT NULL,
   "default" smallint NOT NULL  DEFAULT 0,
   "checked_out_time" timestamp without time zone,
   "checked_out" bigint DEFAULT 0 NOT NULL,
@@ -80,11 +78,8 @@ CREATE INDEX "#__workflow_stages_idx_checked_out" ON "#__workflow_stages" ("chec
 -- Dumping data for table "#__workflow_stages"
 --
 
-INSERT INTO "#__workflow_stages" ("id", "asset_id", "ordering", "workflow_id", "published", "title", "description", "condition", "default", "checked_out_time", "checked_out") VALUES
-(1, 0, 1, 1, 1, 'JUNPUBLISHED', '', 0, 1, NULL, 0),
-(2, 0, 2, 1, 1, 'JPUBLISHED', '', 1, 0, NULL, 0),
-(3, 0, 3, 1, 1, 'JTRASHED', '', -2, 0, NULL, 0),
-(4, 0, 4, 1, 1, 'JARCHIVED', '', 2, 0, NULL, 0);
+INSERT INTO "#__workflow_stages" ("id", "asset_id", "ordering", "workflow_id", "published", "title", "description", "default", "checked_out_time", "checked_out") VALUES
+(1, 0, 1, 1, 1, 'COM_WORKFLOW_BASIC_STAGE', '', 1, NULL, 0);
 
 --
 -- Table structure for table "#__workflow_transitions"
@@ -100,6 +95,7 @@ CREATE TABLE IF NOT EXISTS "#__workflow_transitions" (
   "description" text NOT NULL,
   "from_stage_id" bigint DEFAULT 0 NOT NULL,
   "to_stage_id" bigint DEFAULT 0 NOT NULL,
+  "options" text NOT NULL,
   "checked_out_time" timestamp without time zone,
   "checked_out" bigint DEFAULT 0 NOT NULL,
   PRIMARY KEY ("id")
@@ -111,21 +107,31 @@ CREATE INDEX "#__workflow_transitions_idx_to_stage_id" ON "#__workflow_transitio
 CREATE INDEX "#__workflow_transitions_idx_workflow_id" ON "#__workflow_transitions" ("workflow_id");
 CREATE INDEX "#__workflow_transitions_idx_checked_out" ON "#__workflow_transitions" ("checked_out");
 
-INSERT INTO "#__workflow_transitions" ("id", "asset_id", "published", "ordering", "workflow_id", "title", "description", "from_stage_id", "to_stage_id", "checked_out_time", "checked_out") VALUES
-(1, 0, 1, 1, 1, 'Unpublish', '', -1, 1, NULL, 0),
-(2, 0, 1, 2, 1, 'Publish', '', -1, 2, NULL, 0),
-(3, 0, 1, 3, 1, 'Trash', '', -1, 3, NULL, 0),
-(4, 0, 1, 4, 1, 'Archive', '', -1, 4, NULL, 0);
+INSERT INTO "#__workflow_transitions" ("id", "asset_id", "published", "ordering", "workflow_id", "title", "description", "from_stage_id", "to_stage_id", "options", "checked_out_time", "checked_out") VALUES
+(1, 0, 1, 1, 1, 'Unpublish', '', -1, 1, '{"publishing":"0"}', NULL, 0),
+(2, 0, 1, 2, 1, 'Publish', '', -1, 1, '{"publishing":"1"}', NULL, 0),
+(3, 0, 1, 3, 1, 'Trash', '', -1, 1, '{"publishing":"-2"}', NULL, 0),
+(4, 0, 1, 4, 1, 'Archive', '', -1, 1, '{"publishing":"2"}', NULL, 0),
+(5, 0, 1, 5, 1, 'Feature', '', -1, 1, '{"featuring":"1"}', NULL, 0),
+(6, 0, 1, 6, 1, 'Unfeature', '', -1, 1, '{"featuring":"0"}', NULL, 0),
+(7, 0, 1, 7, 1, 'Publish & Feature', '', -1, 1, '{"publishing":"1","featuring":"1"}', NULL, 0);
 
 --
 -- Creating extension entry
 --
+-- Note that the old pseudo null dates have to be used for the "checked_out_time"
+-- column because the conversion to real null dates will be done with a later
+-- update SQL script.
+--
 
 INSERT INTO "#__extensions" ("package_id", "name", "type", "element", "folder", "client_id", "enabled", "access", "protected", "manifest_cache", "params", "checked_out", "checked_out_time", "ordering", "state") VALUES
-(0, 'com_workflow', 'component', 'com_workflow', '', 1, 1, 0, 0, '', '{}', 0, '1970-01-01 00:00:00', 0, 0);
+(0, 'com_workflow', 'component', 'com_workflow', '', 1, 1, 0, 1, '', '{}', 0, '1970-01-01 00:00:00', 0, 0),
+(0, 'plg_workflow_publishing', 'plugin', 'publishing', 'workflow', 0, 1, 1, 0, '', '{}', 0, '1970-01-01 00:00:00', 0, 0),
+(0, 'plg_workflow_featuring', 'plugin', 'featuring', 'workflow', 0, 1, 1, 0, '', '{}', 0, '1970-01-01 00:00:00', 0, 0),
+(0, 'plg_workflow_notification', 'plugin', 'notification', 'workflow', 0, 1, 1, 0, '', '{}', 0, '1970-01-01 00:00:00', 0, 0);
 
 --
 -- Creating Associations for existing content
 --
 INSERT INTO "#__workflow_associations" ("item_id", "stage_id", "extension")
-SELECT "id", CASE WHEN "state" = -2 THEN 3 WHEN "state" = 0 THEN 1 WHEN "state" = 2 THEN 4 ELSE 2 END, 'com_content' FROM "#__content";
+SELECT "id", 1, 'com_content.article' FROM "#__content";