Data.php

Go to the documentation of this file.

<?php
 
namespace Drupal\dkan_data\Storage;
 
use Contracts\BulkRetrieverInterface;
use Contracts\RemoverInterface;
use Contracts\RetrieverInterface;
use Contracts\StorerInterface;
use DateTime;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use HTMLPurifier;
 
class Data implements StorerInterface, RetrieverInterface, BulkRetrieverInterface, RemoverInterface {
 
  private $entityTypeManager;
 
  private $schemaId;
 
  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
    $this->entityTypeManager = $entityTypeManager;
  }
 
  public function setSchema($schema_id) {
    $this->schemaId = $schema_id;
  }
 
  public function retrieveAll(): array {
 
    if (!isset($this->schemaId)) {
      throw new \Exception("Data schemaId not set in retrieveAll().");
    }
 
    $nodeStorage = $this->getNodeStorage();
 
    $node_ids = $nodeStorage->getQuery()
      ->condition('type', $this->getType())
      ->condition('field_data_type', $this->schemaId)
      ->execute();
 
    $all = [];
    foreach ($node_ids as $nid) {
      /* @var $node \Drupal\node\NodeInterface */
      $node = $nodeStorage->load($nid);
      $fieldList = $node->get('field_json_metadata');
      $field = $fieldList->get(0);
      $data = $field->getValue();
      $all[] = $data['value'];
    }
    return $all;
  }
 
  public function retrieve(string $id): ?string {
 
    if (!isset($this->schemaId)) {
      throw new \Exception("Data schemaId not set in retrieve().");
    }
 
    if (FALSE !== ($node = $this->getNodeByUuid($id))) {
      $value = $node->get('field_json_metadata')->get(0)->getValue();
      return $value['value'];
    }
 
    throw new \Exception("No data with the identifier {$id} was found.");
  }
 
  public function remove(string $id) {
 
    if (FALSE !== ($node = $this->getNodeByUuid($id))) {
      return $node->delete();
    }
  }
 
  public function store($data, string $id = NULL): string {
 
    if (!isset($this->schemaId)) {
      throw new \Exception("Data schemaId not set in store().");
    }
 
    $data = json_decode($data);
    $data = $this->filterHtml($data);
 
    $id = (!$id && isset($data->identifier)) ? $data->identifier : $id;
 
    if ($id) {
      $node = $this->getNodeByUuid($id);
    }
 
    /* @var $node \Drupal\node\NodeInterface */
    if ($node) {
      return $this->updateExistingNode($node, $data);
    }
    // Create new node.
    else {
      return $this->createNewNode($id, $data);
    }
  }
 
  private function updateExistingNode($node, $data) {
    $node->field_data_type = $this->schemaId;
    $new_data = json_encode($data);
    $node->field_json_metadata = $new_data;
    // Create a new revision.
    $node->setNewRevision(TRUE);
    $node->isDefaultRevision(TRUE);
    $node->setRevisionLogMessage("Updated on " . $this->formattedTimestamp());
 
    $node->save();
    return $node->uuid();
  }
 
  private function createNewNode($id, $data) {
    $title = isset($data->title) ? $data->title : $data->name;
    $node = $this->getNodeStorage()
      ->create(
        [
          'title' => $title,
          'type' => 'data',
          'uuid' => $id,
          'field_data_type' => $this->schemaId,
          'field_json_metadata' => json_encode($data),
        ]
      );
    $node->setRevisionLogMessage("Created on " . $this->formattedTimestamp());
 
    $node->save();
    return $node->uuid();
  }
 
  private function getNodeStorage() {
    return $this->entityTypeManager
      ->getStorage('node');
  }
 
  private function getType() {
    return 'data';
  }
 
  private function getNodeByUuid($uuid) {
 
    $nodes = $this->getNodeStorage()->loadByProperties(
      [
        'type' => $this->getType(),
        'uuid' => $uuid,
      ]
    );
    // Uuid should be universally unique and always return
    // a single node.
    return current($nodes);
  }
 
  private function filterHtml($input) {
    switch (gettype($input)) {
      case "string":
        return $this->htmlPurifier($input);
 
      case "array":
      case "object":
        foreach ($input as &$value) {
          $value = $this->filterHtml($value);
        }
        return $input;
 
      default:
        // Leave integers, floats or boolean unchanged.
        return $input;
    }
  }
 
  private function htmlPurifier(string $input) {
    $filter = new HTMLPurifier();
    return $filter->purify($input);
  }
 
  private function formattedTimestamp() : string {
    $now = new \DateTime('now');
    return $now->format(DateTime::ATOM);
  }
 
}