[4.0] Workflow prevent trashing of used stages/workflows

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

@@ -50,6 +50,7 @@ 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_WORKFLOWS_DELETE_ERROR="There was a problem while deleting the item: "
 COM_WORKFLOW_NA="N/A"
 COM_WORKFLOW_NAME="Name"

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

@@ -6,8 +6,8 @@
 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_STATES_DESC="Check that states are not assigned to an item before they are deleted."
-PLG_CONTENT_JOOMLA_FIELD_CHECK_STATES_LABEL="Check States Deletion"
+PLG_CONTENT_JOOMLA_FIELD_CHECK_STATES_WORKFLOW_DESC="Check that stages/workflows are not assigned to an item before they are deleted."
+PLG_CONTENT_JOOMLA_FIELD_CHECK_STATES_WORKFLOW_LABEL="Check Stages/Workflow 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));
 

plugins/content/joomla/joomla.php

@@ -20,6 +20,8 @@
 use Joomla\Component\Content\Administrator\Table\ArticleTable;
 use Joomla\CMS\Workflow\Workflow;
 use Joomla\Utilities\ArrayHelper;
+use Joomla\Component\Workflow\Administrator\Table\StageTable;
+use Joomla\Component\Workflow\Administrator\Table\WorkflowTable;
 
 /**
  * Example Content Plugin
@@ -137,10 +139,35 @@ public function onContentBeforeDelete($context, $data)
 				return $this->_canDeleteCategories($data);
 
 			case 'com_workflow.stage':
-				return $this->_canDeleteStages($data->id);
+				return $this->_canDeleteStage($data->id);
 		}
 	}
 
+	public function onContentBeforeChangeState($context, $pks, $value)
+	{
+		if ($value != -2 || !in_array($context, ['com_workflow.workflow', 'com_workflow.stage']))
+		{
+			return true;
+		}
+
+		$result = true;
+
+		foreach ($pks as $id)
+		{
+			switch ($context)
+			{
+				case 'com_workflow.workflow':
+					return $result && $this->_canDeleteWorkflow($id);
+
+				case 'com_workflow.stage':
+					$result = $result && $this->_canDeleteStage($id);
+			}
+		}
+
+		return $result;
+
+	}
+
 	/**
 	 * Checks if a given category can be deleted
 	 *
@@ -218,18 +245,18 @@ private function _canDeleteCategories($data)
 	}
 
 	/**
-	 * Checks if a given stage can be deleted
+	 * Checks if a given workflow can be deleted
 	 *
 	 * @param   int  $pk  The stage ID
 	 *
 	 * @return  boolean
 	 *
 	 * @since  __DEPLOY_VERSION__
 	 */
-	private function _canDeleteStages($pk)
+	private function _canDeleteWorkflow($pk)
 	{
 		// Check if this function is enabled.
-		if (!$this->params->def('check_stages', 1))
+		if (!$this->params->def('check_states_workflow', 1))
 		{
 			return true;
 		}
@@ -239,15 +266,27 @@ private function _canDeleteStages($pk)
 		// Default to true if not a core extension
 		$result = true;
 
+		// Check if this workflow is the default stage
+		$table = new WorkflowTable($this->db);
+
+		$table->load($pk);
+
+		if ($table->default)
+		{
+			throw new Exception(Text::_('COM_WORKFLOW_MSG_DELETE_IS_DEFAULT'));
+		}
+
 		$tableInfo = [
 			'com_content' => array('table_name' => '#__content')
 		];
 
 		// Now check to see if this is a known core extension
 		if (isset($tableInfo[$extension]))
 		{
+			$table = $tableInfo[$extension]['table_name'];
+
 			// See if this category has any content items
-			$count = $this->_countItemsFromState($extension, $pk, $tableInfo[$extension]);
+			$count = $this->_countItemsFromWorkflow($extension, $pk, $table);
 
 			// Return false if db error
 			if ($count === false)
@@ -259,9 +298,69 @@ private function _canDeleteStages($pk)
 				// Show error if items are found assigned to the stage
 				if ($count > 0)
 				{
-					$msg = Text::_('COM_WORKFLOW_MSG_DELETE_IS_ASSIGNED');
-					Factory::getApplication()->enqueueMessage($msg, 'error');
-					$result = false;
+					throw new Exception(Text::_('COM_WORKFLOW_MSG_DELETE_IS_ASSIGNED'));
+				}
+			}
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Checks if a given stage can be deleted
+	 *
+	 * @param   int  $pk  The stage ID
+	 *
+	 * @return  boolean
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	private function _canDeleteStage($pk)
+	{
+		// Check if this function is enabled.
+		if (!$this->params->def('check_states_workflow', 1))
+		{
+			return true;
+		}
+
+		$extension = Factory::getApplication()->input->getString('extension');
+
+		// Default to true if not a core extension
+		$result = true;
+
+		// Check if this stage is the default stage
+		$table = new StageTable($this->db);
+
+		$table->load($pk);
+
+		if ($table->default)
+		{
+			throw new Exception(Text::_('COM_WORKFLOW_MSG_DELETE_IS_DEFAULT'));
+		}
+
+		$tableInfo = [
+			'com_content' => array('table_name' => '#__content')
+		];
+
+		// Now check to see if this is a known core extension
+		if (isset($tableInfo[$extension]))
+		{
+			$table = $tableInfo[$extension]['table_name'];
+
+			// See if this state has any content items
+			$count = $this->_countItemsFromState($extension, $pk, $table);
+
+			// Return false if db error
+			if ($count === false)
+			{
+				$result = false;
+			}
+			else
+			{
+				// Show error if items are found assigned to the stage
+				if ($count > 0)
+				{
+					throw new Exception(Text::_('COM_WORKFLOW_MSG_DELETE_IS_ASSIGNED'));
 				}
 			}
 		}
@@ -397,6 +496,44 @@ private function _countItemsFromState($extension, $stage_id, $table)
 		return $count;
 	}
 
+	/**
+	 * Get count of items assigned to a stage
+	 *
+	 * @param   string   $extension  The extension to search for
+	 * @param   integer  $stage_id   ID of the stage to check
+	 * @param   string   $table      The table to search for
+	 *
+	 * @return  mixed  count of items found or false if db error
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	private function _countItemsFromWorkflow($extension, $workflow_id, $table)
+	{
+		$query = $this->db->getQuery(true);
+
+		$query	->select('COUNT(' . $this->db->quoteName('wa.item_id') . ')')
+				->from($query->quoteName('#__workflow_associations', 'wa'))
+				->from($query->quoteName('#__workflow_stages', 's'))
+				->from($this->db->quoteName($table, 'b'))
+				->where($this->db->quoteName('wa.stage_id') . ' = ' . $this->db->quoteName('s.id'))
+				->where($this->db->quoteName('wa.item_id') . ' = ' . $this->db->quoteName('b.id'))
+				->where($this->db->quoteName('s.workflow_id') . ' = ' . (int) $workflow_id)
+				->where($this->db->quoteName('wa.extension') . ' = ' . $this->db->quote($extension));
+
+		try
+		{
+			$count = $this->db->setQuery($query)->loadResult();
+		}
+		catch (RuntimeException $e)
+		{
+			Factory::getApplication()->enqueueMessage($e->getMessage(), 'error');
+
+			return false;
+		}
+
+		return $count;
+	}
+
 	/**
 	 * Change the state in core_content if the stage in a table is changed
 	 *
@@ -416,7 +553,7 @@ public function onContentChangeState($context, $pks, $value)
 		{
 			foreach ($pks as $pk)
 			{
-				if (!$this->_canDeleteStates($pk))
+				if (!$this->_canDeleteStage($pk))
 				{
 					return false;
 				}

plugins/content/joomla/joomla.xml

@@ -31,11 +31,11 @@
 					<option value="1">JYES</option>
 				</field>
 				<field
-					name="check_states"
+					name="check_states_workflow"
 					type="radio"
 					class="switcher"
-					label="PLG_CONTENT_JOOMLA_FIELD_CHECK_STATES_LABEL"
-					description="PLG_CONTENT_JOOMLA_FIELD_CHECK_STATES_DESC"
+					label="PLG_CONTENT_JOOMLA_FIELD_CHECK_STATES_WORKFLOW_LABEL"
+					description="PLG_CONTENT_JOOMLA_FIELD_CHECK_STATES_WORKFLOW_DESC"
 					default="1"
 					>
 					<option value="0">JNO</option>