Chris@17: <?php
Chris@17: 
Chris@17: namespace Drupal\workspaces;
Chris@17: 
Chris@17: use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
Chris@17: use Drupal\Core\Form\FormStateInterface;
Chris@17: use Drupal\Core\Render\Element;
Chris@17: use Drupal\Core\StringTranslation\TranslatableMarkup;
Chris@17: use Drupal\views\Form\ViewsExposedForm;
Chris@17: use Drupal\workspaces\Form\WorkspaceFormInterface;
Chris@17: use Symfony\Component\DependencyInjection\ContainerInterface;
Chris@17: 
Chris@17: /**
Chris@17:  * Defines a class for reacting to form operations.
Chris@17:  *
Chris@17:  * @internal
Chris@17:  */
Chris@17: class FormOperations implements ContainerInjectionInterface {
Chris@17: 
Chris@17:   /**
Chris@17:    * The workspace manager service.
Chris@17:    *
Chris@17:    * @var \Drupal\workspaces\WorkspaceManagerInterface
Chris@17:    */
Chris@17:   protected $workspaceManager;
Chris@17: 
Chris@17:   /**
Chris@17:    * Constructs a new FormOperations instance.
Chris@17:    *
Chris@17:    * @param \Drupal\workspaces\WorkspaceManagerInterface $workspace_manager
Chris@17:    *   The workspace manager service.
Chris@17:    */
Chris@17:   public function __construct(WorkspaceManagerInterface $workspace_manager) {
Chris@17:     $this->workspaceManager = $workspace_manager;
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * {@inheritdoc}
Chris@17:    */
Chris@17:   public static function create(ContainerInterface $container) {
Chris@17:     return new static(
Chris@17:       $container->get('workspaces.manager')
Chris@17:     );
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * Alters forms to disallow editing in non-default workspaces.
Chris@17:    *
Chris@17:    * @param array $form
Chris@17:    *   An associative array containing the structure of the form.
Chris@17:    * @param \Drupal\Core\Form\FormStateInterface $form_state
Chris@17:    *   The current state of the form.
Chris@17:    * @param string $form_id
Chris@17:    *   The form ID.
Chris@17:    *
Chris@17:    * @see hook_form_alter()
Chris@17:    */
Chris@17:   public function formAlter(array &$form, FormStateInterface $form_state, $form_id) {
Chris@17:     // No alterations are needed in the default workspace.
Chris@17:     if ($this->workspaceManager->getActiveWorkspace()->isDefaultWorkspace()) {
Chris@17:       return;
Chris@17:     }
Chris@17: 
Chris@17:     // Add an additional validation step for every form if we are in a
Chris@17:     // non-default workspace.
Chris@17:     $this->addWorkspaceValidation($form);
Chris@17: 
Chris@17:     // If a form has already been marked as safe or not to submit in a
Chris@17:     // non-default workspace, we don't have anything else to do.
Chris@17:     if ($form_state->has('workspace_safe')) {
Chris@17:       return;
Chris@17:     }
Chris@17: 
Chris@17:     // No forms are safe to submit in a non-default workspace by default, except
Chris@17:     // for the whitelisted ones defined below.
Chris@17:     $workspace_safe = FALSE;
Chris@17: 
Chris@17:     // Whitelist a few forms that we know are safe to submit.
Chris@17:     $form_object = $form_state->getFormObject();
Chris@17:     $is_workspace_form = $form_object instanceof WorkspaceFormInterface;
Chris@17:     $is_search_form = in_array($form_object->getFormId(), ['search_block_form', 'search_form'], TRUE);
Chris@17:     $is_views_exposed_form = $form_object instanceof ViewsExposedForm;
Chris@17:     if ($is_workspace_form || $is_search_form || $is_views_exposed_form) {
Chris@17:       $workspace_safe = TRUE;
Chris@17:     }
Chris@17: 
Chris@17:     $form_state->set('workspace_safe', $workspace_safe);
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * Adds our validation handler recursively on each element of a form.
Chris@17:    *
Chris@17:    * @param array &$element
Chris@17:    *   An associative array containing the structure of the form.
Chris@17:    */
Chris@17:   protected function addWorkspaceValidation(array &$element) {
Chris@17:     // Recurse through all children and add our validation handler if needed.
Chris@17:     foreach (Element::children($element) as $key) {
Chris@17:       if (isset($element[$key]) && $element[$key]) {
Chris@17:         $this->addWorkspaceValidation($element[$key]);
Chris@17:       }
Chris@17:     }
Chris@17: 
Chris@17:     if (isset($element['#validate'])) {
Chris@17:       $element['#validate'][] = [get_called_class(), 'validateDefaultWorkspace'];
Chris@17:     }
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * Validation handler which sets a validation error for all unsupported forms.
Chris@17:    */
Chris@17:   public static function validateDefaultWorkspace(array &$form, FormStateInterface $form_state) {
Chris@17:     if ($form_state->get('workspace_safe') !== TRUE) {
Chris@17:       $form_state->setError($form, new TranslatableMarkup('This form can only be submitted in the default workspace.'));
Chris@17:     }
Chris@17:   }
Chris@17: 
Chris@17: }