OS-94 adding os2forms_webform_list back

Author: stankut

CHANGELOG.md

@@ -15,7 +15,6 @@ before starting to add changes. Use example [placed in the end of the page](#exa
 
 - Obsolete module removing - os2forms_consent
 - Obsolete module removing - webform_embed
-- Obsolete module removing - os2forms_webform_list
 - Obsolete module removing - field_color
 - Obsolete patch removing - dynamic_entity_reference
 - Obsolete patch removing - user_default_page

modules/os2forms_webform_list/os2forms_webform_list.info.yml

@@ -0,0 +1,9 @@
+name: OS2forms webform list
+type: module
+description: Alters display of webform list and maestro template list
+package: OS2Web
+core: 8.x
+core_version_requirement: ^8 || ^9 || ^10
+dependencies:
+  - 'drupal:webform'
+  - 'drupal:maestro'

modules/os2forms_webform_list/os2forms_webform_list.module

@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * @file
+ * Contains hooks related to OS2Forms webform list module.
+ */
+
+/**
+ * Implements hook_entity_type_alter().
+ *
+ * Change entitytypes.
+ */
+function os2forms_webform_list_entity_type_alter(array &$entity_types) {
+  /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
+  // Define a new list builder classes.
+  $entity_types['webform']->setListBuilderClass('Drupal\os2forms_webform_list\CustomWebformEntityListBuilder');
+  $entity_types['maestro_template']->setListBuilderClass('Drupal\os2forms_webform_list\CustomMaestroTemplateEntityListBuilder');
+}

modules/os2forms_webform_list/src/CustomMaestroTemplateEntityListBuilder.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Drupal\os2forms_webform_list;
+
+use Drupal\maestro\Controller\MaestroTemplateListBuilder;
+
+/**
+ * Defines a class to build a listing of maestro template entities.
+ *
+ * @see \Drupal\maestro\Entity\MaestroTemplate
+ */
+class CustomMaestroTemplateEntityListBuilder extends MaestroTemplateListBuilder {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function load() {
+    $entity_ids = $this->getEntityIds();
+    // @phpstan-ignore-next-line
+    $entities = $this->storage->loadMultipleOverrideFree($entity_ids);
+
+    uasort($entities, [$this->entityType->getClass(), 'sort']);
+    foreach ($entities as $entity_name => $entity) {
+      $access = $entity->access('update');
+      if (!$access) {
+        unset($entities[$entity_name]);
+      }
+    }
+    return $entities;
+  }
+
+}

modules/os2forms_webform_list/src/CustomWebformEntityListBuilder.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Drupal\os2forms_webform_list;
+
+use Drupal\Core\Entity\Query\QueryInterface;
+use Drupal\webform\WebformEntityListBuilder;
+
+/**
+ * Defines a class to build a listing of webform entities.
+ *
+ * @see \Drupal\webform\Entity\Webform
+ */
+class CustomWebformEntityListBuilder extends WebformEntityListBuilder {
+
+  /**
+   * Alter the webform entity list builder query method.
+   *
+   * Force the list builder query to respect webform access and properly hide
+   * inaccessible webforms from the list.
+   *
+   * @param string $keys
+   *   (optional) Search key.
+   * @param string $category
+   *   (optional) Category.
+   * @param string $state
+   *   (optional) Webform state. Can be 'open' or 'closed'.
+   *
+   * @return \Drupal\Core\Entity\Query\QueryInterface
+   *   An entity query.
+   */
+  protected function getQuery($keys = '', $category = '', $state = ''): QueryInterface {
+    $query = parent::getQuery($keys, $category, $state);
+
+    // Setup a required condition for the list builder to respect webform update
+    // access.
+    $allowedForms = [];
+    /** @var \Drupal\webform\WebformInterface[] $webforms */
+    $webforms = $this->getStorage()->loadMultiple();
+    foreach ($webforms as $webform) {
+      $access = $webform->access('update');
+      if ($access) {
+        $allowedForms[] = $webform->id();
+      }
+    }
+
+    $query->condition('id', $allowedForms, 'IN');
+
+    return $query;
+  }
+
+}