Merge pull request #51 from localgovdrupal/fix/1.x/41-import-pipeline-permission

Fix/1.x/41 import pipeline permission

Author: rupertj

config/install/localgov_publications_importer.import_pipeline.standard.yml

@@ -0,0 +1,17 @@
+status: true
+dependencies: {  }
+id: standard
+label: Standard
+extract_plugin: smalot_pdfparser
+extract_plugin_configuration: {  }
+transform_plugins:
+  - transform_images
+  - transform_line_breaks
+  - transform_ai_aio
+transform_plugin_configurations:
+  - {  }
+  - {  }
+  -
+    prompt: "You are a website content editor. Format the provided text and HTML into valid JSON only.\r\n\r\nRequirements:\r\n- Return ONLY a JSON array of page objects, no other text\r\n- Each page object has: \"title\" (string), \"content\" (string)\r\n- Split the content into MULTIPLE pages\r\n- Each page should contain 200-500 words of content when possible\r\n- Break pages at natural stopping points: section boundaries, topic changes, or major headings\r\n- Content value contains HTML using only the tags: h1, h2, h3, h4, h5, h6, p, ul, ol, li, img\r\n- Use the first line as h1 if it's a complete sentence\r\n- Preserve original text and HTML tags exactly, only add HTML tags\r\n- Generate descriptive titles that reflect each page's main topic\r\n- Pay special attention to img tags - they must be preserved with all original attributes\r\n- Properly escape all double quotes in JSON strings\r\n- Ensure any JSON you create is valid. This is really important.\r\n\r\nSplit strategy:\r\n- Look for major headings, topic shifts, or natural content breaks\r\n- Each page should feel complete but part of a larger whole\r\n- Distribute content evenly across pages\r\n- Don't create pages that are too short (under 100 words) unless necessary\r\n\r\nExample format:\r\n[\r\n  {\"title\":\"Introduction and Overview\",\"content\":\"<h1>Main Title</h1><img src=\"/example-image.jpg\"><p>Intro content...</p>\"},\r\n  {\"title\":\"Key Concepts\",\"content\":\"<h2>Section Title</h2><p>More content...</p>\"},\r\n  {\"title\":\"Advanced Topics\",\"content\":\"<h2>Another Section</h2><p>Final content...</p>\"}\r\n]\r\n"
+save_plugin: save_publication
+save_plugin_configuration: {  }

config/install/views.view.imports.yml

@@ -3,6 +3,7 @@ status: true
 dependencies:
   module:
     - localgov_publications_importer
+    - user
 id: imports
 label: Imports
 module: views
@@ -429,8 +430,9 @@ display:
           sort_asc_label: Asc
           sort_desc_label: Desc
       access:
-        type: none
-        options: {  }
+        type: perm
+        options:
+          perm: 'view imports'
       cache:
         type: tag
         options: {  }
@@ -504,6 +506,7 @@ display:
         - 'languages:language_content'
         - 'languages:language_interface'
         - url.query_args
+        - user.permissions
       tags: {  }
   page_1:
     id: page_1
@@ -527,4 +530,5 @@ display:
         - 'languages:language_content'
         - 'languages:language_interface'
         - url.query_args
+        - user.permissions
       tags: {  }

…ocalgov_publications_importer.schema.yml …ions_importer.import_pipeline.schema.ymlconfig/schema/localgov_publications_importer.schema.yml renamed to config/schema/localgov_publications_importer.import_pipeline.schema.yml config/schema/localgov_publications_importer.schema.yml renamed to config/schema/localgov_publications_importer.import_pipeline.schema.yml

@@ -1,4 +1,4 @@
-drupal\localgov_publications_importer\Entity\ImportPipeline:
+localgov_publications_importer.import_pipeline.*:
   type: config_entity
   label: 'Import Pipeline'
   mapping:
@@ -12,25 +12,19 @@ drupal\localgov_publications_importer\Entity\ImportPipeline:
       type: string
       label: 'Extract Plugin'
     extract_plugin_configuration:
-      type: sequence
+      type: ignore
       label: 'Extract Plugin Configuration'
-      sequence:
-        - type: any
     transform_plugins:
       type: sequence
       label: 'Transform Plugins'
       sequence:
-        - type: string
+        type: ignore
     transform_plugin_configurations:
-      type: sequence
+      type: ignore
       label: 'Transform Plugin Configurations'
-      sequence:
-        - type: any
     save_plugin:
       type: string
       label: 'Save Plugin'
     save_plugin_configuration:
-      type: sequence
+      type: ignore
       label: 'Save Plugin Configuration'
-      sequence:
-        - type: any

localgov_publications_importer.permissions.yml

@@ -1,15 +1,27 @@
-import localgov publications from PDF:
-  title: 'Import localgov publications from PDF'
-  description: 'Allows users to upload PDF files, which will be turned into publications.'
+create imports:
+  title: 'Create imports'
+  description: 'Allows users to create imports.'
 administer imports:
   title: 'Administer imports'
   description: 'Allows full control over imports.'
-access imports:
-  title: 'Access imports'
+view imports:
+  title: 'View imports'
   description: 'Allows viewing of imports.'
 delete own imports:
   title: 'Delete own imports'
   description: 'Allows users to delete imports that they started.'
-delete any imports:
-  title: 'Delete any imports'
-  description: 'Allows users to delete imports that anyone started.'
+administer import pipelines:
+  title: 'Administer import pipelines'
+  description: 'Allows full control over import pipelines.'
+create import pipelines:
+  title: 'Create import pipelines'
+  description: 'Allows users to create new import pipelines.'
+view import pipelines:
+  title: 'View import pipelines'
+  description: 'Allows users to view import pipelines.'
+update import pipelines:
+  title: 'Update import pipelines'
+  description: 'Allows users to update import pipelines.'
+delete import pipelines:
+  title: 'Delete import pipelines'
+  description: 'Allows users to delete import pipelines.'

localgov_publications_importer.routing.yml

@@ -1,7 +1,7 @@
 localgov_publications_importer.import:
-  path: '/admin/content/imports/import-publication'
+  path: '/admin/content/imports/create'
   defaults:
     _form: 'Drupal\localgov_publications_importer\Form\PublicationImportForm'
     _title: 'Import Publication'
   requirements:
-    _permission : 'import localgov publications from PDF'
+    _entity_create_access : 'import'

src/Entity/Import.php

@@ -4,6 +4,7 @@
 
 use Drupal\Core\Entity\ContentEntityBase;
 use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Url;
 use Drupal\user\UserInterface;
 use Drupal\Core\Field\BaseFieldDefinition;
 use Drupal\Core\Field\FieldStorageDefinitionInterface;
@@ -32,6 +33,7 @@
  *       "delete" = "Drupal\Core\Entity\ContentEntityDeleteForm"
  *     },
  *   },
+ *   admin_permission = "administer imports",
  *   base_table = "import",
  *   entity_keys = {
  *     "id" = "id",
@@ -365,4 +367,14 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
     return $fields;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function toUrl($rel = NULL, array $options = []) {
+    // Use the listing view for the canonical URL for this entity until we get
+    // round to needing actual pages for them. Right now we just need something
+    // to let the 'Cancel' button on the delete form work.
+    return Url::fromUri('internal:/admin/content/imports');
+  }
+
 }

src/Entity/ImportPipeline.php

@@ -19,9 +19,11 @@
  *     "route_provider" = {
  *       "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
  *     },
+ *     "access" = "Drupal\localgov_publications_importer\ImportPipelineAccessControlHandler",
  *   },
  *   config_prefix = "import_pipeline",
- *   admin_permission = "administer site configuration",
+ *   admin_permission = "administer import pipelines",
+ *   collection_permission = "view import pipelines",
  *   entity_keys = {
  *     "id" = "id",
  *     "label" = "label"

src/ImportAccessControlHandler.php

@@ -3,6 +3,7 @@
 namespace Drupal\localgov_publications_importer;
 
 use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Access\AccessResultNeutral;
 use Drupal\Core\Entity\EntityAccessControlHandler;
 use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Session\AccountInterface;
@@ -15,34 +16,55 @@ class ImportAccessControlHandler extends EntityAccessControlHandler {
   /**
    * {@inheritdoc}
    */
-  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
-    if ($account->hasPermission('administer imports')) {
+  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
+    $result = parent::checkCreateAccess($account, $context, $entity_bundle);
+    if (!$result instanceof AccessResultNeutral) {
+      return $result;
+    }
+    if ($account->hasPermission('create imports')) {
       return AccessResult::allowed()->cachePerPermissions();
     }
+    return AccessResult::neutral()->setReason("The following permissions are required: 'create imports'.");
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
+
+    /** @var \Drupal\localgov_publications_importer\ImportInterface $entity */
+
+    // Parent checks admin perm and is new.
+    $result = parent::checkAccess($entity, $operation, $account);
+    if (!$result instanceof AccessResultNeutral) {
+      return $result;
+    }
 
     switch ($operation) {
       case 'view':
-        if ($account->hasPermission('access imports')) {
+      case 'view label':
+        if ($account->hasPermission('view imports')) {
           return AccessResult::allowed()->cachePerPermissions();
         }
-        return AccessResult::neutral()->setReason("The following permissions are required: 'access imports'.");
+        return AccessResult::neutral()->setReason("The following permissions are required: 'view imports'.");
 
-      case 'delete':
-
-        if ($account->hasPermission('delete any imports')) {
-          return AccessResult::allowed()->cachePerPermissions();
+      case 'update':
+        $owner = $entity->getCreator();
+        if ($owner instanceof AccountInterface && $owner->id() === $account->id()) {
+          if ($account->hasPermission('update own imports')) {
+            return AccessResult::allowed()->cachePerPermissions();
+          }
         }
+        return AccessResult::neutral()->setReason("The following permissions are required: 'update own imports'.");
 
+      case 'delete':
         $owner = $entity->getCreator();
-
-        // @todo Verify this.
         if ($owner instanceof AccountInterface && $owner->id() === $account->id()) {
           if ($account->hasPermission('delete own imports')) {
             return AccessResult::allowed()->cachePerPermissions();
           }
         }
-
-        return AccessResult::neutral()->setReason("The following permissions are required: 'delete terms in {$entity->bundle()}' OR 'administer taxonomy'.");
+        return AccessResult::neutral()->setReason("The following permissions are required: 'delete own imports'.");
 
       default:
         // No opinion.

src/ImportInterface.php

@@ -2,13 +2,14 @@
 
 namespace Drupal\localgov_publications_importer;
 
+use Drupal\Core\Entity\EntityInterface;
 use Drupal\file\Entity\File;
 use Drupal\user\UserInterface;
 
 /**
  * Interface for content being imported.
  */
-interface ImportInterface {
+interface ImportInterface extends EntityInterface {
 
   /**
    * Set the title of the import.

src/ImportPipelineAccessControlHandler.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Drupal\localgov_publications_importer;
+
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Access\AccessResultNeutral;
+use Drupal\Core\Entity\EntityAccessControlHandler;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Session\AccountInterface;
+
+/**
+ * Defines the access control handler for the import entity type.
+ */
+class ImportPipelineAccessControlHandler extends EntityAccessControlHandler {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
+    $result = parent::checkCreateAccess($account, $context, $entity_bundle);
+    if (!$result instanceof AccessResultNeutral) {
+      return $result;
+    }
+    if ($account->hasPermission('create import pipelines')) {
+      return AccessResult::allowed()->cachePerPermissions();
+    }
+    return AccessResult::neutral()->setReason("The following permissions are required: 'create import pipelines'.");
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
+
+    // Parent checks admin perm and is new.
+    $result = parent::checkAccess($entity, $operation, $account);
+    if (!$result instanceof AccessResultNeutral) {
+      return $result;
+    }
+
+    // Make 'view label' work like 'view'.
+    if ($operation === 'view label') {
+      $operation = 'view';
+    }
+
+    switch ($operation) {
+      case 'view':
+      case 'update':
+      case 'delete':
+        if ($account->hasPermission($operation . ' import pipelines')) {
+          return AccessResult::allowed()->cachePerPermissions();
+        }
+        return AccessResult::neutral()->setReason("The following permissions are required: '" . $operation . " import pipelines'.");
+
+      default:
+        // No opinion.
+        return AccessResult::neutral()->cachePerPermissions();
+    }
+  }
+
+}