Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\workflows;
Chris@18: 
Chris@18: use Drupal\Core\Access\AccessResult;
Chris@18: use Drupal\Core\Routing\Access\AccessInterface;
Chris@18: use Drupal\Core\Routing\RouteMatchInterface;
Chris@18: use Drupal\Core\Session\AccountInterface;
Chris@18: 
Chris@18: /**
Chris@18:  * Provides an access check for state and transition operations.
Chris@18:  */
Chris@18: class WorkflowStateTransitionOperationsAccessCheck implements AccessInterface {
Chris@18: 
Chris@18:   /**
Chris@18:    * Checks access for operations of workflow states and transitions.
Chris@18:    *
Chris@18:    * The value of '_workflow_access' is used to check to kind of access that
Chris@18:    * should be applied to a route in the context of a workflow and a state or
Chris@18:    * transition. States and transitions can individually have access control
Chris@18:    * applied to them for 'add', 'update' and 'delete'. By default workflows will
Chris@18:    * use the admin permission 'administer workflows' for all of these
Chris@18:    * operations, except for delete-state which checks there is at least one
Chris@18:    * state, a state does not have data and it's not a required state.
Chris@18:    *
Chris@18:    * For the update and delete operations, a workflow and a state or transition
Chris@18:    * is required in the route for the access check to be applied. For the "add"
Chris@18:    * operation, only a workflow is required. The '_workflow_access' requirement
Chris@18:    * translates into access checks on the workflow entity type in the formats:
Chris@18:    *   - @code"$operation-state:$state_id"@endcode
Chris@18:    *   - @code"$operation-transition:$transition_id"@endcode
Chris@18:    *
Chris@18:    * For example the following route definition with the path
Chris@18:    * "/test-workflow/foo-state/delete" the 'delete-state:foo-state' operation
Chris@18:    * will be checked:
Chris@18:    * @code
Chris@18:    * pattern: '/{workflow}/{workflow_state}/delete'
Chris@18:    * requirements:
Chris@18:    *   _workflow_access: 'delete-state'
Chris@18:    * @endcode
Chris@18:    *
Chris@18:    * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
Chris@18:    *   The parametrized route
Chris@18:    * @param \Drupal\Core\Session\AccountInterface $account
Chris@18:    *   The currently logged in account.
Chris@18:    *
Chris@18:    * @return \Drupal\Core\Access\AccessResultInterface
Chris@18:    *   An access result.
Chris@18:    *
Chris@18:    * @throws \Exception
Chris@18:    *   Throws an exception when a route is defined with an invalid operation.
Chris@18:    */
Chris@18:   public function access(RouteMatchInterface $route_match, AccountInterface $account) {
Chris@18:     $workflow_operation = $this->getOperation($route_match);
Chris@18:     if (!preg_match('/^(?<operation>add|update|delete)-(?<type>state|transition)$/', $workflow_operation, $matches)) {
Chris@18:       throw new \Exception("Invalid _workflow_access operation '$workflow_operation' specified for route '{$route_match->getRouteName()}'.");
Chris@18:     }
Chris@18: 
Chris@18:     $parameters = $route_match->getParameters();
Chris@18:     $workflow = $parameters->get('workflow');
Chris@18:     if ($workflow && $matches['operation'] === 'add') {
Chris@18:       return $workflow->access($workflow_operation, $account, TRUE);
Chris@18:     }
Chris@18:     if ($workflow && $type = $parameters->get(sprintf('workflow_%s', $matches['type']))) {
Chris@18:       return $workflow->access(sprintf('%s:%s', $workflow_operation, $type), $account, TRUE);
Chris@18:     }
Chris@18: 
Chris@18:     return AccessResult::neutral();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Get the operation that will be used for the access check
Chris@18:    *
Chris@18:    * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
Chris@18:    *   The parametrized route
Chris@18:    *
Chris@18:    * @return string
Chris@18:    *   The access operation.
Chris@18:    */
Chris@18:   protected function getOperation(RouteMatchInterface $route_match) {
Chris@18:     return $route_match->getRouteObject()->getRequirement('_workflow_access');
Chris@18:   }
Chris@18: 
Chris@18: }