[6.1] [GSoC 21] Feature - Implement Workflows for com_modules

administrator/components/com_admin/sql/updates/mysql/4.1.0-2021-07-30.sql

@@ -0,0 +1,37 @@
+--
+-- Insert a new workflow for com_modules
+--
+INSERT INTO `#__workflows` (`id`, `asset_id`, `published`, `title`, `description`, `extension`, `default`, `ordering`, `created`, `created_by`, `modified`, `modified_by`, `checked_out_time`, `checked_out`) VALUES
+(NULL, 0, 1, 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES', '', 'com_modules.module', 1, 1, CURRENT_TIMESTAMP(), 0, CURRENT_TIMESTAMP(), 0, NULL, 0);
+
+--
+-- Inserting the default stage for the new workflow
+--
+INSERT INTO `#__workflow_stages` (`id`, `asset_id`, `ordering`, `workflow_id`, `published`, `title`, `description`, `default`, `checked_out_time`, `checked_out`)
+SELECT NULL, 0, 1, `id`, 1, 'COM_WORKFLOW_BASIC_STAGE', '', 1, NULL, 0 FROM `#__workflows` WHERE `title` = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES';
+
+--
+-- Inserting the transitions for the new workflow
+--
+INSERT INTO `#__workflow_transitions` (`id`, `asset_id`, `published`, `ordering`, `workflow_id`, `title`, `description`, `from_stage_id`, `to_stage_id`, `options`)
+SELECT NULL, 0, 1, NULL, `w`.`id`, 'Unpublish', '', -1, `s`.`id`, '{"publishing":"0"}' FROM `#__workflows` as `w` INNER JOIN `#__workflow_stages` as `s` ON `w`.`title` = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES' AND `s`.`title` = 'COM_WORKFLOW_BASIC_STAGE' AND `s`.`extension` = 'com_modules.module';
+
+INSERT INTO `#__workflow_transitions` (`id`, `asset_id`, `published`, `ordering`, `workflow_id`, `title`, `description`, `from_stage_id`, `to_stage_id`, `options`)
+SELECT NULL, 0, 1, NULL, `w`.`id`, 'Publish', '', -1, `s`.`id`, '{"publishing":"1"}' FROM `#__workflows` as `w` INNER JOIN `#__workflow_stages` as `s` ON `w`.`title` = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES' AND `s`.`title` = 'COM_WORKFLOW_BASIC_STAGE' AND `s`.`extension` = 'com_modules.module';
+
+INSERT INTO `#__workflow_transitions` (`id`, `asset_id`, `published`, `ordering`, `workflow_id`, `title`, `description`, `from_stage_id`, `to_stage_id`, `options`)
+SELECT NULL, 0, 1, NULL, `w`.`id`, 'Trash', '', -1, `s`.`id`, '{"publishing":"-2"}' FROM `#__workflows` as `w` INNER JOIN `#__workflow_stages` as `s` ON `w`.`title` = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES' AND `s`.`title` = 'COM_WORKFLOW_BASIC_STAGE' AND `s`.`workflow_id` = `w`.`id`;
+
+--
+-- Creating Associations for existing modules
+--
+INSERT INTO `#__workflow_associations` (`item_id`, `stage_id`, `extension`)
+SELECT `m`.`id`, `s`.`id`, 'com_modules.module'
+FROM `#__modules` as `m` ,
+(
+   `#__workflow_stages` as `s`
+   INNER JOIN `#__workflows` as `w`
+   ON `w`.`title` = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES'
+   AND `s`.`title` = 'COM_WORKFLOW_BASIC_STAGE'
+   AND `s`.`workflow_id` = `w`.`id`
+);

administrator/components/com_admin/sql/updates/postgresql/4.1.0-2021-07-30.sql

@@ -0,0 +1,37 @@
+--
+-- Insert a new workflow for com_modules
+--
+INSERT INTO "#__workflows" ("id", "asset_id", "published", "title", "description", "extension", "default", "ordering", "created", "created_by", "modified", "modified_by", "checked_out_time", "checked_out") VALUES
+(NULL, 0, 1, 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES', '', 'com_modules.module', 1, 1, CURRENT_TIMESTAMP(), 0, CURRENT_TIMESTAMP(), 0, NULL, 0);
+
+--
+-- Inserting the default stage for the new workflow
+--
+INSERT INTO "#__workflow_stages" ("id", "asset_id", "ordering", "workflow_id", "published", "title", "description", "default", "checked_out_time", "checked_out")
+SELECT NULL, 0, 1, "id", 1, 'COM_WORKFLOW_BASIC_STAGE', '', 1, NULL, 0 FROM "#__workflows" WHERE "title" = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES';
+
+--
+-- Inserting the transitions for the new workflow
+--
+INSERT INTO "#__workflow_transitions" ("id", "asset_id", "published", "ordering", "workflow_id", "title", "description", "from_stage_id", "to_stage_id", "options")
+SELECT NULL, 0, 1, NULL, "w"."id", 'Unpublish', '', -1, "s"."id", '{"publishing":"0"}' FROM "#__workflows" as "w" INNER JOIN "#__workflow_stages" as "s" ON "w"."title" = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES' AND "s"."title" = 'COM_WORKFLOW_BASIC_STAGE' AND "s"."extension" = 'com_modules.module';
+
+INSERT INTO "#__workflow_transitions" ("id", "asset_id", "published", "ordering", "workflow_id", "title", "description", "from_stage_id", "to_stage_id", "options")
+SELECT NULL, 0, 1, NULL, "w"."id", 'Publish', '', -1, "s"."id", '{"publishing":"1"}' FROM "#__workflows" as "w" INNER JOIN "#__workflow_stages" as "s" ON "w"."title" = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES' AND "s"."title" = 'COM_WORKFLOW_BASIC_STAGE' AND "s"."extension" = 'com_modules.module';
+
+INSERT INTO "#__workflow_transitions" ("id", "asset_id", "published", "ordering", "workflow_id", "title", "description", "from_stage_id", "to_stage_id", "options")
+SELECT NULL, 0, 1, NULL, "w"."id", 'Trash', '', -1, "s"."id", '{"publishing":"-2"}' FROM "#__workflows" as "w" INNER JOIN "#__workflow_stages" as "s" ON "w"."title" = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES' AND "s"."title" = 'COM_WORKFLOW_BASIC_STAGE' AND "s"."workflow_id" = "w"."id";
+
+--
+-- Creating Associations for existing modules
+--
+INSERT INTO "#__workflow_associations" ("item_id", "stage_id", "extension") 
+SELECT "m"."id", "s"."id", 'com_modules.module'
+FROM "#__modules" as "m",
+(
+   "#__workflow_stages" as "s"
+   INNER JOIN "#__workflows" as "w"
+   ON "w"."title" = 'COM_WORKFLOW_BASIC_WORKFLOW_MODULES'
+   AND "s"."title" = 'COM_WORKFLOW_BASIC_STAGE'
+   AND "s"."workflow_id" = "w"."id"
+);

administrator/components/com_content/src/Model/ArticlesModel.php

@@ -294,7 +294,8 @@ protected function getListQuery()
             ->join('LEFT', $db->quoteName('#__users', 'ua'), $db->quoteName('ua.id') . ' = ' . $db->quoteName('a.created_by'))
             ->join('INNER', $db->quoteName('#__workflow_associations', 'wa'), $db->quoteName('wa.item_id') . ' = ' . $db->quoteName('a.id'))
             ->join('INNER', $db->quoteName('#__workflow_stages', 'ws'), $db->quoteName('ws.id') . ' = ' . $db->quoteName('wa.stage_id'))
-            ->join('INNER', $db->quoteName('#__workflows', 'w'), $db->quoteName('w.id') . ' = ' . $db->quoteName('ws.workflow_id'));
+            ->join('INNER', $db->quoteName('#__workflows', 'w'), $db->quoteName('w.id') . ' = ' . $db->quoteName('ws.workflow_id'))
+            ->where($db->quoteName('wa.extension') . ' = ' . $db->quote('com_content.article'));
 
         if (PluginHelper::isEnabled('content', 'vote')) {
             $query->select(

administrator/components/com_content/tmpl/featured/default.php

@@ -216,7 +216,7 @@
                                     'title' => Text::_($item->stage_title),
                                     'tip_content' => Text::sprintf('JWORKFLOW', Text::_($item->workflow_title)),
                                     'id' => 'workflow-' . $item->id,
-                                    'task' => 'articles.runTransitions'
+                                    'task' => 'articles.runTransition'
                                     ];
 
                                     echo (new TransitionButton($options))

administrator/components/com_menus/presets/default.xml

@@ -99,6 +99,14 @@
 			link="index.php?option=com_modules&view=modules&client_id=1"
 			quicktask="index.php?option=com_modules&view=select&client_id=1"
 		/>
+
+		<menuitem
+			title="MOD_MENU_EXTENSIONS_MODULE_WORKFLOWS"
+			type="component"
+			element="com_workflow"
+			link="index.php?option=com_workflow&amp;view=workflows&amp;extension=com_modules.module"
+			permission="core.manage.workflow;com_modules"
+		/>
 	</menuitem>
 
 	<menuitem

administrator/components/com_menus/presets/system.xml

@@ -187,6 +187,14 @@
 			link="index.php?option=com_modules&view=modules&client_id=1"
 			permission="core.manage;com_modules"
 		/>
+
+		<menuitem
+			title="MOD_MENU_EXTENSIONS_MODULE_WORKFLOWS"
+			type="component"
+			element="com_workflow"
+			link="index.php?option=com_workflow&amp;view=workflows&amp;extension=com_modules.module"
+			permission="core.manage.workflow;com_modules"
+		/>
 	</menuitem>
 
 	<menuitem

administrator/components/com_modules/access.xml

@@ -7,6 +7,8 @@
 		<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.manage.workflow" title="JACTION_MANAGEWORKFLOW" />
+		<action name="core.execute.transition" title="JACTION_EXECUTETRANSITION" />
 		<action name="module.edit.frontend" title="COM_MODULES_ACTION_EDITFRONTEND" />
 	</section>
 	<section name="module">
@@ -15,4 +17,23 @@
 		<action name="core.edit.state" title="JACTION_EDITSTATE" />
 		<action name="module.edit.frontend" title="COM_MODULES_ACTION_EDITFRONTEND" />
 	</section>
+	<section name="workflow">
+		<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.edit.own" title="JACTION_EDITOWN" />
+		<action name="core.execute.transition" title="JACTION_EXECUTETRANSITION" />
+	</section>
+	<section name="transition">
+		<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.execute.transition" title="JACTION_EXECUTETRANSITION" />
+	</section>
+	<section name="stage">
+		<action name="core.delete" title="JACTION_DELETE" />
+		<action name="core.edit" title="JACTION_EDIT" />
+		<action name="core.edit.state" title="JACTION_EDITSTATE" />
+	</section>
 </access>

administrator/components/com_modules/config.xml

@@ -54,4 +54,26 @@
 			section="component"
 		/>
 	</fieldset>
+
+	<fieldset
+		name="integration"
+		label="JGLOBAL_INTEGRATION_LABEL"
+		description="COM_MODULES_CONFIG_INTEGRATION_SETTINGS_DESC"
+		>
+		<fieldset
+			name="integration_workflows"
+			label="JWORKFLOW_TITLE"
+		>
+			<field
+				name="workflow_enabled"
+				type="radio"
+				label="JWORKFLOW_ENABLED_LABEL"
+				layout="joomla.form.field.radio.switcher"
+				default="0"
+				>
+				<option value="0">JNO</option>
+				<option value="1">JYES</option>
+			</field>
+		</fieldset>
+	</fieldset>
 </config>

administrator/components/com_modules/forms/filter_modules.xml

@@ -58,6 +58,16 @@
 			<option	value="">COM_MODULES_OPTION_SELECT_MENU_ITEM</option>
 			<option	value="-1">COM_MODULES_NONE</option>
 		</field>
+		<field
+			name="stage"
+			type="workflowstage"
+			label="JOPTION_SELECT_STAGE"
+			onchange="this.form.submit();"
+			activeonly="true"
+			extension="com_modules.module"
+			>
+			<option value="">JOPTION_SELECT_STAGE</option>
+		</field>
 		<field
 			name="access"
 			type="accesslevel"

administrator/components/com_modules/forms/filter_modulesadmin.xml

@@ -50,6 +50,16 @@
 			>
 			<option value="">COM_MODULES_OPTION_SELECT_MODULE</option>
 		</field>
+		<field
+			name="stage"
+			type="workflowstage"
+			label="JOPTION_SELECT_STAGE"
+			onchange="this.form.submit();"
+			activeonly="true"
+			extension="com_modules.module"
+			>
+			<option value="">JOPTION_SELECT_STAGE</option>
+		</field>
 		<field
 			name="access"
 			type="accesslevel"

administrator/components/com_modules/forms/module.xml

@@ -151,4 +151,22 @@
 			validate="rules"
 		/>
 	</fieldset>
+
+	<fieldset name="workflow" label="COM_MODULES_WORKFLOW">
+		<field
+			name="workflow_id"
+			type="sql"
+			label="COM_MODULES_WORKFLOW"
+			class="form-select"
+			size="1"
+			sql_select="id, title"
+			sql_from="#__workflows"
+			sql_where="published = 1 AND extension = 'com_modules.module'"
+			sql_order="ordering"
+			key_field="id"
+			value_field="title"
+			default="use_default"
+			translate="true"
+		/>
+	</fieldset>
 </form>

administrator/components/com_modules/forms/moduleadmin.xml

@@ -145,4 +145,22 @@
 			validate="rules"
 		/>
 	</fieldset>
+
+	<fieldset name="workflow" label="COM_MODULES_WORKFLOW">
+		<field
+			name="workflow_id"
+			type="sql"
+			label="COM_MODULES_WORKFLOW"
+			class="form-select"
+			size="1"
+			sql_select="id, title"
+			sql_from="#__workflows"
+			sql_where="published = 1 AND extension = 'com_modules.module'"
+			sql_order="ordering"
+			key_field="id"
+			value_field="title"
+			default="use_default"
+			translate="true"
+		/>
+	</fieldset>
 </form>