[4.0] Workflow prevent trashing of used stages/workflows

administrator/components/com_content/Extension/ContentComponent.php

@@ -177,6 +177,20 @@ protected function getTableNameForSection(string $section = null)
 		return '#__content';
 	}
 
+	/**
+	 * Returns a table name for the state association
+	 *
+	 * @param   string  $section  An optional section to differ different areas in the component
+	 *
+	 * @return  string
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function getWorkflowTableBySection(string $section = null)
+	{
+		return '#__content';
+	}
+
 	/**
 	 * Method to filter transitions by given id of state.
 	 *

administrator/language/en-GB/en-GB.com_workflow.ini

@@ -48,9 +48,11 @@ COM_WORKFLOW_MODIFIED_AT_DESC="Date Modified descending"
 COM_WORKFLOW_MODIFIED_DESC="Date Modified"
 COM_WORKFLOW_MODIFIED_LABEL="Date Modified"
 COM_WORKFLOW_MSG_DELETE_DEFAULT="You are trying to delete the default item."
-COM_WORKFLOW_MSG_FROM_TO_STAGE="From Stage and To Stage must have different names."
 COM_WORKFLOW_MSG_DELETE_IS_ASSIGNED="This item is in use by the component."
+COM_WORKFLOW_MSG_DELETE_IS_DEFAULT="You can't delete the default item."
+COM_WORKFLOW_MSG_FROM_TO_STAGE="From Stage and To Stage must have different names."
 COM_WORKFLOW_MSG_WORKFLOWS_DELETE_ERROR="There was a problem while deleting the item: "
+COM_WORKFLOW_MSG_WORKFLOW_IS_NOT_SUPPORTED="This item is in use by the component."
 COM_WORKFLOW_NA="N/A"
 COM_WORKFLOW_NAME="Name"
 COM_WORKFLOW_NEW="New"

administrator/language/en-GB/en-GB.plg_content_joomla.ini

@@ -6,8 +6,6 @@
 PLG_CONTENT_JOOMLA="Content - Joomla"
 PLG_CONTENT_JOOMLA_FIELD_CHECK_CATEGORIES_DESC="Check that categories are fully empty before they are deleted."
 PLG_CONTENT_JOOMLA_FIELD_CHECK_CATEGORIES_LABEL="Check Category Deletion"
-PLG_CONTENT_JOOMLA_FIELD_CHECK_STAGES_DESC="Check that stages are not assigned to an item before they are deleted."
-PLG_CONTENT_JOOMLA_FIELD_CHECK_STAGES_LABEL="Check Stages Deletion"
 PLG_CONTENT_JOOMLA_FIELD_EMAIL_NEW_FE_DESC="Email users if 'Send email' is on when there is a new article submitted via the Frontend."
 PLG_CONTENT_JOOMLA_FIELD_EMAIL_NEW_FE_LABEL="Email on New Site Article"
 PLG_CONTENT_JOOMLA_FIELD_EMAIL_NEW_STAGE_DESC="Email users if 'Send email' is on when there is a status change of an article."

libraries/src/MVC/Model/AdminModel.php

@@ -78,6 +78,14 @@ abstract class AdminModel extends FormModel
 	 */
 	protected $event_before_save = null;
 
+	/**
+	 * The event to trigger before changing the published state of the data.
+	 *
+	 * @var    string
+	 * @since  __DEPLOY_VERSION__
+	 */
+	protected $event_before_change_state = null;
+
 	/**
 	 * The event to trigger after changing the published state of the data.
 	 *
@@ -214,6 +222,15 @@ public function __construct($config = array(), MVCFactoryInterface $factory = nu
 			$this->event_before_save = 'onContentBeforeSave';
 		}
 
+		if (isset($config['event_before_change_state']))
+		{
+			$this->event_before_change_state = $config['event_before_change_state'];
+		}
+		elseif (empty($this->event_before_change_state))
+		{
+			$this->event_before_change_state = 'onContentBeforeChangeState';
+		}
+
 		if (isset($config['event_change_state']))
 		{
 			$this->event_change_state = $config['event_change_state'];
@@ -1004,6 +1021,8 @@ public function publish(&$pks, $value = 1)
 		$table = $this->getTable();
 		$pks = (array) $pks;
 
+		$context = $this->option . '.' . $this->name;
+
 		// Include the plugins for the change of state event.
 		\JPluginHelper::importPlugin($this->events_map['change_state']);
 
@@ -1037,6 +1056,16 @@ public function publish(&$pks, $value = 1)
 			}
 		}
 
+		// Trigger the change state event.
+		$result = Factory::getApplication()->triggerEvent($this->event_before_change_state, array($context, $pks, $value));
+
+		if (in_array(false, $result, true))
+		{
+			$this->setError($table->getError());
+
+			return false;
+		}
+
 		// Attempt to change the state of the records.
 		if (!$table->publish($pks, $value, $user->get('id')))
 		{
@@ -1045,8 +1074,6 @@ public function publish(&$pks, $value = 1)
 			return false;
 		}
 
-		$context = $this->option . '.' . $this->name;
-
 		// Trigger the change state event.
 		$result = Factory::getApplication()->triggerEvent($this->event_change_state, array($context, $pks, $value));
 

libraries/src/Workflow/WorkflowServiceInterface.php

@@ -51,4 +51,16 @@ public static function updateContentState($pks, $condition): bool;
 	 * @since   __DEPLOY_VERSION__
 	 */
 	public static function getConditions($extension): array;
+
+	/**
+	 * Returns the table for the count items functions for the given section.
+	 *
+	 * @param   array   $stage_ids  The stage ids to test for
+	 * @param   string  $section    The section
+	 *
+	 * @return  bool
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function canDeleteStages(array $stage_ids, string $section = '') : bool;
 }

libraries/src/Workflow/WorkflowServiceTrait.php

@@ -10,6 +10,9 @@
 
 defined('JPATH_PLATFORM') or die;
 
+use Joomla\CMS\Factory;
+use Joomla\Utilities\ArrayHelper;
+
 /**
  * Trait for component workflow service.
  *
@@ -30,4 +33,72 @@ public static function getConditions($extension): array
 	{
 		return defined('self::CONDITION_NAMES') ? self::CONDITION_NAMES : Workflow::CONDITION_NAMES;
 	}
+
+	/**
+	 * Returns the table for the count items functions for the given section.
+	 *
+	 * @param   array   $stage_ids  The stage ids to test for
+	 * @param   string  $section    The section
+	 *
+	 * @return  bool
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function canDeleteStages(array $stage_ids, string $section = '') : bool
+	{
+		$db = Factory::getDbo();
+
+		$parts = explode('.', $extension);
+
+		$stage_ids = ArrayHelper::toInteger($stage_ids);
+		$stage_ids = array_filter($stage_ids);
+
+		$section = '';
+
+		if (!empty($parts[1]))
+		{
+			$section = $parts[1];
+		}
+
+		$table = $this->getWorkflowTableBySection($section);
+
+		if (empty($stage_ids) || !$table)
+		{
+			return true;
+		}
+
+		$query = $db->getQuery(true);
+
+		$query	->select('COUNT(' . $db->quoteName('b.id') . ')')
+				->from($query->quoteName('#__workflow_associations', 'wa'))
+				->from($query->quoteName('#__workflow_stages', 's'))
+				->from($db->quoteName($table, 'b'))
+				->where($db->quoteName('wa.stage_id') . ' = ' . $db->quoteName('s.id'))
+				->where($db->quoteName('wa.item_id') . ' = ' . $db->quoteName('b.id'))
+				->whereIn($db->quoteName('s.id'), $stage_ids);
+
+		try {
+			return (int) $db->setQuery($query)->loadResult() === 0;
+		}
+		catch (Exception $ex)
+		{
+			Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
+		}
+
+		return false;
+	}
+
+	/**
+	 * Returns a table name for the state association
+	 *
+	 * @param   string  $section  An optional section to differ different areas in the component
+	 *
+	 * @return  string|null
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function getWorkflowTableBySection(string $section = null)
+	{
+		return null;
+	}
 }