Coding standards, database standards, and performance pass

README.md

@@ -1,8 +1,41 @@
 # Embargoes
-Drupal 8 module for managing embargo policies with access restrictions on content
+
+Adds the ability to manage embargo policies with access restrictions on content.
 
 ## Requirements
-Embargoes requires no other Drupal modules to work.
+
+This module requires the following modules/libraries:
+
+* [Menu UI](https://www.drupal.org/docs/core-modules-and-themes/core-modules/menu-ui-module)
+
+## Installation
+
+Install as
+[usual](https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules).
+
+## Configuration
+
+Configuration options can be set at `admin/config/content/embargoes/settings`,
+including notification options and IP range settings that can apply to
+embargoes.
+
+To add an IP range for use on embargoes, navigate to
+`admin/config/content/embargoes/settings/ips` and click 'Add IP range'. Ranges
+created via this method can then be used as IP address whitelists when creating
+embargoes.
+
+## Usage
+
+### Applying an embargo
+
+An embargo can be applied to an existing node by navigating to
+`node/{node_id}/embargoes`. From here, an embargo can be applied if it doesn't
+already exist, and existing embargoes can be modified or removed.
+
+## Maintainers/Sponsors
+
+* [FSU Library](https://github.com/fsulib/embargoes)
+* [discoverygarden](http://support.discoverygarden.ca)
 
 ## License
 [GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt)

composer.json

@@ -5,6 +5,9 @@
   "keywords": ["Drupal"],
   "homepage": "https://github.com/fsulib/embargoes",
   "license": "GPL-2.0+",
+  "replace": {
+    "drupal/embargoes":"*"
+  },
   "authors": [
     {
       "name": "Bryan J. Brown",

config/install/embargoes.settings.yml

@@ -0,0 +1,4 @@
+---
+embargo_contact_email: null
+add_contact_to_notifications: true
+show_embargo_message: true

config/schema/embargoes.schema.yml

@@ -4,3 +4,83 @@ condition.plugin.embargoes_embargoed_condition:
     filter:
       type: text
       label: 'Embargo Filter'
+
+embargoes.settings:
+  type: config_object
+  mapping:
+    embargo_contact_email:
+      type: email
+      label: 'Contact email for embargo notifications'
+    add_contact_to_notifications:
+      type: boolean
+      label: 'Whether to add contact information to embargo notifications'
+    show_embargo_message:
+      type: boolean
+      label: 'Whether to display an embargo warning on embargoed nodes'
+
+embargoes.embargoes_embargo_entity.*:
+  type: config_entity
+  label: 'Embargo config'
+  mapping:
+    id:
+      type: string
+      label: 'ID'
+    embargo_type:
+      type: boolean
+      label: 'Embargo Type'
+    expiration_type:
+      type: boolean
+      label: 'Expiration Type'
+    expiration_date:
+      type: string
+      label: 'Expiration Date'
+    exempt_ips:
+      type: string
+      label: 'Exempt IP Ranges'
+      nullable: true
+    exempt_users:
+      type: sequence
+      label: 'Exempt Users'
+      sequence:
+        type: mapping
+        mapping:
+          target_id:
+            type: integer
+    additional_emails:
+      type: sequence
+      label: 'Additional Emails'
+      sequence:
+        type: mapping
+        mapping:
+          additional_email:
+            type: string
+    embargoed_node:
+      type: integer
+      label: 'Embargoed Node'
+    notification_status:
+      type: integer
+      label: 'Notification Status'
+
+embargoes.embargoes_ip_range_entity.*:
+  type: config_entity
+  label: 'IP Range config'
+  mapping:
+    id:
+      type: string
+      label: 'ID'
+    label:
+      type: label
+      label: 'Label'
+    ranges:
+      type: sequence
+      label: 'Ranges'
+      sequence:
+        type: mapping
+        mapping:
+          range:
+            type: string
+    proxy_url:
+      type: string
+      label: 'Proxy URL'
+    uuid:
+      type: string

embargoes.install

@@ -1,13 +1,15 @@
 <?php
 
 /**
-* @file
-* Install, update and uninstall functions for the embargoes module.
-*/
+ * @file
+ * Install, update and uninstall functions for the embargoes module.
+ */
+
+use Drupal\Core\Database\Database;
 
 /**
-* Implements hook_schema().
-*/
+ * Implements hook_schema().
+ */
 function embargoes_schema() {
   $schema['embargoes_log'] = [
     'description' => 'Embargo log table.',
@@ -22,15 +24,14 @@ function embargoes_schema() {
         'not null' => TRUE,
       ],
       'action' => [
-        'type' => 'varchar',
-        'length' => 255,
+        'type' => 'int',
         'not null' => TRUE,
       ],
       'node' => [
         'type' => 'int',
         'not null' => TRUE,
       ],
-      'user' => [
+      'uid' => [
         'type' => 'int',
         'not null' => TRUE,
       ],
@@ -41,6 +42,32 @@ function embargoes_schema() {
       ],
     ],
     'primary key' => ['id'],
+    'indexes' => [
+      'action' => ['action'],
+      'uid' => ['uid'],
+      'node' => ['node'],
+    ],
   ];
   return $schema;
 }
+
+/**
+ * Update the 'user' column to be called 'uid'.
+ */
+function embargoes_update_8001(&$sandbox) {
+  Database::getConnection()->schema()->changeField('embargoes_log', 'user', 'uid', [
+    'not null' => TRUE,
+    'type' => 'int',
+  ]);
+}
+
+/**
+ * Add indices.
+ */
+function embargoes_update_8002(&$sandbox) {
+  $schema = Database::getConnection()->schema();
+  $embargoes_schema = embargoes_schema();
+  $schema->addIndex('embargoes_log', 'action', ['action'], $embargoes_schema['embargoes_log']);
+  $schema->addIndex('embargoes_log', 'uid', ['uid'], $embargoes_schema['embargoes_log']);
+  $schema->addIndex('embargoes_log', 'node', ['node'], $embargoes_schema['embargoes_log']);
+}

embargoes.links.task.yml

@@ -22,12 +22,6 @@ entity.embargoes_embargo_entity.collection:
   base_route: embargoes.settings
   weight: 3
 
-embargoes.settings.log:
-  route_name: embargoes.settings.log
-  title: 'Log'
-  base_route: embargoes.settings
-  weight: 4
-
 embargoes.node.embargoes:
   route_name: embargoes.node.embargoes
   title: 'Embargoes'