Merge pull request #5 from qadan/updates

update readme, fix issues

README.md

@@ -1,8 +1,62 @@
 # Embargoes
-Drupal 8 module for managing embargo policies with access restrictions on content
+
+# Introduction
+
+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.
+
+### Logging
+
+Embargo logs are kept at `admin/config/content/embargoes/settings/log`,
+including who created the embargo, or how it was changed.
+
+## Troubleshooting/Issues
+
+Having problems or solved one? Contact
+[discoverygarden](http://support.discoverygarden.ca).
+
+## Maintainers/Sponsors
+
+Current maintainers:
+
+* [discoverygarden](http://www.discoverygarden.ca)
+
+## Development
+
+If you would like to contribute to this module, please check out the helpful
+[Documentation](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers),
+[Developers](http://islandora.ca/developers) section on Islandora.ca and create
+an issue, pull request and or contact
+[discoverygarden](http://support.discoverygarden.ca).
 
 ## License
 [GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt)

embargoes.services.yml

@@ -4,7 +4,7 @@ services:
     arguments: ['embargoes']
   embargoes.log:
     class: Drupal\embargoes\EmbargoesLogService
-    arguments: []
+    arguments: ['@database']
   embargoes.embargoes:
     class: Drupal\embargoes\EmbargoesEmbargoesService
     arguments: []

src/Controller/EmbargoesLogController.php

@@ -12,7 +12,11 @@ class EmbargoesLogController extends ControllerBase {
 
   public function showRenderedLog() {
     $database = \Drupal::database();
-    $result = $database->query('SELECT * FROM {embargoes_log} ORDER BY time DESC;');
+    $result = $database->getConnection()
+      ->select('embargoes_log', 'el')
+      ->fields('el')
+      ->orderBy('el.time', 'DESC')
+      ->execute();
 
     $formatted_log = [];
     foreach ($result as $record) {

src/EmbargoesLogService.php

@@ -2,22 +2,30 @@
 
 namespace Drupal\embargoes;
 
+use Drupal\Core\Database\Connection;
+
 /**
  * Class EmbargoesLogService.
  */
 class EmbargoesLogService implements EmbargoesLogServiceInterface {
 
   /**
-   * Constructs a new EmbargoesLogService object.
+   * @var \Drupal\Core\Database\Connection $database
+   *
+   * Database connection.
    */
-  public function __construct() {
+  protected $database;
 
+  /**
+   * Constructs a new EmbargoesLogService object.
+   */
+  public function __construct(Connection $connection) {
+    $this->database = $connection;
   }
 
   public function logEmbargoEvent($values) {
-    $conn = \Drupal::database()->getConnection();
     $values['time'] = time();
-    return $conn->insert('embargoes_log')
+    return $this->database->insert('embargoes_log')
       ->fields($values)
       ->execute();
   }

src/Entity/EmbargoesEmbargoEntity.php

@@ -119,7 +119,10 @@ public function getExemptIps() {
     return $this->get('exempt_ips');
   }
 
-  public function setExemptIps($range){
+  public function setExemptIps($range) {
+    if (!$range) {
+      $range = [];
+    }
     $this->set('exempt_ips', $range);
     return $this;
   }
@@ -136,7 +139,10 @@ public function getExemptUsersEntities() {
     return $exempt_user_entities;
   }
 
-  public function setExemptUsers($users){
+  public function setExemptUsers($users) {
+    if (!$users) {
+      $users = [];
+    }
     $this->set('exempt_users', $users);
     return $this;
   }
@@ -145,7 +151,10 @@ public function getAdditionalEmails() {
     return $this->get('additional_emails');
   }
 
-  public function setAdditionalEmails($emails){
+  public function setAdditionalEmails($emails) {
+    if (!$emails) {
+      $emails = [];
+    }
     $this->set('additional_emails', $emails);
     return $this;
   }
@@ -154,7 +163,7 @@ public function getEmbargoedNode() {
     return $this->get('embargoed_node');
   }
 
-  public function setEmbargoedNode($node){
+  public function setEmbargoedNode($node) {
     $this->set('embargoed_node', $node);
     return $this;
   }
@@ -163,7 +172,7 @@ public function getNotificationStatus() {
     return $this->get('notification_status');
   }
 
-  public function setNotificationStatus($status){
+  public function setNotificationStatus($status) {
     $this->set('notification_status', $status);
     return $this;
   }

src/Form/EmbargoesEmbargoEntityForm.php

@@ -78,11 +78,13 @@ public function form(array $form, FormStateInterface $form_state) {
       '#default_value' => $embargo->getAdditionalEmails(),
     );
 
+    $embargoed_node = $embargo->getEmbargoedNode();
     $form['embargoed_node'] = array(
       '#type' => 'entity_autocomplete',
       '#target_type' => 'node',
       '#title' => $this->t('Embargoed node'),
-      '#default_value' => node_load($embargo->getEmbargoedNode()),
+      '#maxlength' => 255,
+      '#default_value' => $embargoed_node ? $embargoed_node : '',
       '#required' => TRUE,
     );
 
@@ -119,7 +121,7 @@ public function save(array $form, FormStateInterface $form_state) {
 
     $log_values['node'] = $embargo->getEmbargoedNode();
     $log_values['uid'] = \Drupal::currentUser()->id();
-    $log_values['embargo_id'] = $embargo->id();
+    $log_values['embargo'] = $embargo->id();
 
     if ($status == SAVED_NEW) {
         $log_values['action'] = 'created';

src/Form/EmbargoesIpRangeEntityForm.php

@@ -33,6 +33,7 @@ public function form(array $form, FormStateInterface $form_state) {
       '#default_value' => $range->label(),
       '#description' => $this->t("Label for the IP range."),
       '#required' => TRUE,
+      '#id' => 'ip-range-label',
     ];
 
     $form['range'] = [

src/Form/EmbargoesNodeEmbargoesForm.php

@@ -157,7 +157,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
 
     $log_values['node'] = $embargo->getEmbargoedNode();
     $log_values['uid'] = \Drupal::currentUser()->id();
-    $log_values['embargo_id'] = $embargo->id();
+    $log_values['embargo'] = $embargo->id();
 
     if ($embargo_id == 'add') {
       $log_values['action'] = 'created';