ISSUE-87: CSL-citations as a twig extension & a field formatter: a tale of two converging paths

composer.json

@@ -15,7 +15,7 @@
  "require": {
  "ml/json-ld": "^1.2",
  "mtdowling/jmespath.php":"^2.5",
- "strawberryfield/strawberryfield":"1.0.0.x-dev",
+ "strawberryfield/strawberryfield":"dev-1.0.0",
  "league/html-to-markdown":"^5.0.0",
  "erusev/parsedown": "^1.7",
  "drupal/webform": "^5.23 || ^6.0",

config/schema/format_strawberryfield.schema.yml

@@ -570,3 +570,37 @@ format_strawberryfield.jmespath_config.mapping:
  jmespath_alternative_filter:
  type: string
  label: 'An alternative JMESPath filter expression'
+
+field.formatter.settings.strawberry_citation_formatter:
+ type: mapping
+ label: 'Specific Config for strawberry_metadata_formatter using Twig'
+ mapping:
+ iiif_base_url:
+ type: string
+ label: 'Custom Public IIIF Server URL'
+ iiif_base_url_internal:
+ type: string
+ label: 'Custom internal IIIF Server URL'
+ json_key_source:
+ type: string
+ label: 'Strawberryfield/JSON key containing file URIs to display'
+ max_width:
+ type: integer
+ max_height:
+ type: integer
+ use_iiif_globals:
+ type: string
+ label: 'Whether to use global IIIF settings or not.'
+ label:
+ type: string
+ metadatadisplayentity_uuid:
+ type: string
+ metadatadisplayentity_uselabel:
+ type: string
+ citationstyle:
+ type: mapping
+ mapping:
+ type: string
+ label: 'style'
+ localekey:
+ type: string

drush.services.yml

@@ -0,0 +1,10 @@
+services:
+ format_strawberryfield.commands:
+ class: Drupal\format_strawberryfield\Commands\LibrariesDrushCommands
+ arguments:
+ - '@http_client'
+ - '@state'
+ - '@datetime.time'
+ - '@file_system'
+ tags:
+ - { name: drush.command }

format_strawberryfield.install

@@ -213,4 +213,4 @@ function format_strawberryfield_update_8702() {
  }
  $message = "All Metadata Display Entities in Configurations updated to use UUIDs";
  return $message;
-}
+}

format_strawberryfield.libraries.yml

@@ -309,3 +309,13 @@ lazyload_strawberry:
  - format_strawberryfield/lozad
  - core/jquery
  - core/drupal
+
+citations_strawberry:
+ version: 1.0
+ js:
+ js/citations_strawberry.js: {minified: false}
+ dependencies:
+ - core/jquery
+ - core/drupal
+ - core/jquery.once
+ - core/drupalSettings

format_strawberryfield.services.yml

@@ -18,4 +18,4 @@ services:
  arguments: ['@strawberryfield.utility', '@config.factory']
  format_strawberryfield.embargo_resolver:
  class: Drupal\format_strawberryfield\EmbargoResolver
- arguments: ['@config.factory', '@current_user', '@request_stack']
+ arguments: ['@config.factory', '@current_user', '@request_stack']

js/citations_strawberry.js

@@ -0,0 +1,25 @@
+(function ($, Drupal, drupalSettings) {
+ 'use strict';
+ Drupal.behaviors.format_strawberryfield_citations = {
+ attach: function (context, settings) {
+ $('.bibliography').once('attach_citations')
+ .each(function (index, value) {
+ var theid = '#' + $(this).attr("id");
+ var bibliographyContainer = document.querySelector(theid);
+ var citationStyleSelector = bibliographyContainer.querySelector('.citation-style-selector');
+ var styledBibs = bibliographyContainer.querySelectorAll(".csl-bib-body-container");
+ citationStyleSelector.addEventListener("change", function() {
+ var selectedStyle = this.value;
+ styledBibs.forEach(function (el, i) {
+ var elClassList = el.classList;
+ if (elClassList.contains("hidden") && elClassList.contains(selectedStyle)) {
+ elClassList.remove("hidden");
+ } else if (!elClassList.contains("hidden") && !elClassList.contains(selectedStyle)) {
+ elClassList.add("hidden");
+ }
+ });
+ });
+ });
+ }
+ };
+})(jQuery, Drupal, drupalSettings);

js/plugin.iiif-iabookreader_strawberry.js

@@ -125,13 +125,13 @@ BookReader.prototype.parseSequence = function (sequenceId) {
  if (item['id'] === sequenceId) {
  self.IIIFsequence.title = "Sequence";
  self.IIIFsequence.bookUrl = "http://iiif.io";
- self.IIIFsequence.imagesList = getImagesListApi3(self.jsonLd);
+ self.IIIFsequence.imagesList = getImagesListApi3(self.jsonLd.items);
  self.numLeafs = self.IIIFsequence.imagesList.length;
  }
  } else {
  self.IIIFsequence.title = "Sequence";
  self.IIIFsequence.bookUrl = "http://iiif.io";
- self.IIIFsequence.imagesList = getImagesListApi3(self.jsonLd);
+ self.IIIFsequence.imagesList = getImagesListApi3(self.jsonLd.items);
  self.numLeafs = self.IIIFsequence.imagesList.length;
  // return false;
  // Just take the first one if no default one set
@@ -150,7 +150,7 @@ BookReader.prototype.parseSequence = function (sequenceId) {
  } else {
  self.IIIFsequence.title = "Sequence";
  self.IIIFsequence.bookUrl = "http://iiif.io";
- self.IIIFsequence.imagesList = getImagesList(sequence);
+ self.IIIFsequence.imagesList = getImagesListApi3(self.jsonLd);
  self.numLeafs = self.IIIFsequence.imagesList.length;
  return false;
  // Just take the first one if no default one set
@@ -259,72 +259,40 @@ BookReader.prototype.parseSequence = function (sequenceId) {
  return imagesList;
  }
 
- // This expects individual pages to be provided as the root level `items` in the jsonLd.
- // If a structure range element exists, it is used to define the page order.
- // This works with "IIIF Presentation API 3 Creative Works Series Manifest" as provided by
- // https:/esmero/archipelago-deployment-live/blob/1.0.0-RC3/drupal/d8content/metadatadisplay_entity_14.json
- function getImagesListApi3(jsonLd) {
+ function getImagesListApi3(items) {
  var imagesList = [];
- let items = jsonLd.items;
- if(items.length > 0) {
- // Use the first structure range, if present, to reorder the items.
- if (jsonLd.structures[0].items.length > 0) {
- // Create associative array of the items so we can use the first structure range to order them.
- let itemsMap = {};
- jQuery.each(items, function (index, item) {
- itemsMap[item.id] = item;
- });
 
- // Zero out the items array, then push individual items back in in the order found in the structure range.
- newitems = [];
- jQuery.each(jsonLd.structures[0].items, function (index, structureItem) {
- if(itemsMap.hasOwnProperty(structureItem.id)) {
- newitems.push(itemsMap[structureItem.id]);
- }
- else {
- console.log("Could not find \"" + structureItem.id + "\" in the IIIF 3.0 presentation manifest's items array.");
+ jQuery.each(items, function (index, item) {
+ if (item['type'] === 'Canvas') {
+ let imageObj = {
+ canvasHeight: item.height || 0,
+ canvasWidth: item.width || 0,
+ };
+ let annotationpages = item.items;
+ jQuery.each(annotationpages, function (index, annotationpage) {
+ if ((annotationpage['type'] === 'AnnotationPage') && (annotationpage['items'][0]['type'] === 'Annotation') && (annotationpage['items'][0]['body'])) {
+ let annotation = annotationpage['items'][0];
+ imageObj.serviceUrl = null;
+ if (annotation.body.hasOwnProperty('service') && annotation.body.service[0]['id'] && isValidHttpUrl(annotation.body.service[0]['id'])) {
+ imageObj.serviceUrl = annotation.body.service[0]['id'].replace(/\/$/, '');
+ }
+ imageObj.imageUrl = annotation.body.id || "";
+ // imageObj.imageUrl = imageObj.imageUrl.replace(/\/full\/full\/0\/default.jpg/, '/full/'+ imageObj.canvasWidth + ',/0/default.jpg');
+ imageObj.width = annotation.body.width || 0;
+ imageObj.height = annotation.body.height || 0;
+ imageObj.aspectRatio = (imageObj.width / imageObj.height) || 1;
+ imageObj.imageGetArgument = getURLArgument(annotation.body.id);
+
+ // Add it to the images list
+ if (!(/#xywh/).test(annotation.target)) {
+ imagesList.push(imageObj);
+ }
  }
  });
- if(newitems.length == jsonLd.structures[0].items.length) {
- items = newitems;
- }
- else {
- console.log("Could not use structures to set page order because structure range item ids did not match item ids.");
- }
 
  }
 
- // Extract data from each item.
- jQuery.each(items, function (index, item) {
- if (item['type'] === 'Canvas') {
- let imageObj = {
- canvasHeight: item.height || 0,
- canvasWidth: item.width || 0,
- };
- let annotationpages = item.items;
- jQuery.each(annotationpages, function (index, annotationpage) {
- if ((annotationpage['type'] === 'AnnotationPage') && (annotationpage['items'][0]['type'] === 'Annotation') && (annotationpage['items'][0]['body'])) {
- let annotation = annotationpage['items'][0];
- imageObj.serviceUrl = null;
- if (annotation.body.hasOwnProperty('service') && annotation.body.service[0] && annotation.body.service[0]['id'] && isValidHttpUrl(annotation.body.service[0]['id'])) {
- imageObj.serviceUrl = annotation.body.service[0]['id'].replace(/\/$/, '');
- }
- imageObj.imageUrl = annotation.body.id || "";
- imageObj.width = annotation.body.width || 0;
- imageObj.height = annotation.body.height || 0;
- imageObj.aspectRatio = (imageObj.width / imageObj.height) || 1;
- imageObj.imageGetArgument = getURLArgument(annotation.body.id);
- // Add it to the images list
- if (!(/#xywh/).test(annotation.target)) {
- imagesList.push(imageObj);
- }
- }
- });
-
- }
- });
-
- }
+ });
 
  return imagesList;
  }

src/Commands/LibrariesDrushCommands.php

@@ -0,0 +1,153 @@
+<?php
+
+namespace Drupal\format_strawberryfield\Commands;
+
+use Drush\Commands\DrushCommands;
+use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\State\StateInterface;
+use GuzzleHttp\Client;
+use Symfony\Component\HttpFoundation\Response;
+use Drupal\Core\Archiver\Tar;
+use Drupal\Component\Datetime\TimeInterface;
+
+/**
+ * A Format Strawberryfield Drush commandfile.
+ *
+ */
+class LibrariesDrushCommands extends DrushCommands {
+
+ /**
+ * The HTTP client.
+ *
+ * @var \GuzzleHttp\Client
+ */
+ protected $httpClient;
+
+ /**
+ * The state key value store.
+ *
+ * @var \Drupal\Core\State\StateInterface
+ */
+ protected $state;
+
+ /**
+ * The time service.
+ *
+ * @var \Drupal\Component\Datetime\TimeInterface
+ */
+ protected $time;
+
+ /**
+ * The file system service.
+ *
+ * @var \Drupal\Core\File\FileSystemInterface
+ */
+ protected $fileSystem;
+
+ /**
+ * Constructs the object.
+ *
+ * @param \GuzzleHttp\Client $http_client
+ * The HTTP client.
+ * @param \Drupal\Core\State\StateInterface $state
+ * The state key value store.
+ * @param \Drupal\Component\Datetime\TimeInterface $time
+ * The time service.
+ * @param \Drupal\Core\File\FileSystemInterface $file_system
+ * The file handler.
+ */
+ public function __construct(
+ Client $http_client,
+ StateInterface $state,
+ TimeInterface $time,
+ FileSystemInterface $file_system
+ ) {
+ parent::__construct();
+ $this->httpClient = $http_client;
+ $this->state = $state;
+ $this->time = $time;
+ $this->fileSystem = $file_system;
+ }
+
+ /**
+ * Downloads files from requested source to requested destination.
+ *
+ * @command archipelago:download
+ * @aliases archipelago-download
+ */
+ public function downloadFiles($source, $destination) {
+ $io = $this->io();
+
+ $io->write("<info>$source</info>");
+
+ $directory = dirname($destination);
+ if (!$this->fileSystem->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY)) {
+ $io->error("Could not create directory $directory.");
+ return 1;
+ }
+
+ try {
+ $response = $this->httpClient->get($source, ['sink' => $destination]);
+ }
+ catch (\Exception $exception) {
+ $io->error($exception->getMessage());
+ return 1;
+ }
+
+ $status_code = $response->getStatusCode();
+ Response::$statusTexts[$status_code];
+ $io->writeln(' [' . $status_code . ' ' . Response::$statusTexts[$status_code] . ']');
+
+ $io->success("Files have been downloaded into $destination directory.");
+ return $destination;
+ }
+
+ /**
+ * Downloads citeproc-php and dependencies.
+ *
+ * @command archipelago:download-citeproc-dependencies
+ * @aliases archipelago-download-citeproc-dependencies
+ */
+ public function downloadCiteProcDependencies() {
+ $io = $this->io();
+ $file_system = $this->fileSystem;
+ $csl_root = DRUPAL_ROOT . '/libraries/citation-style-language';
+ if ($file_system->prepareDirectory($csl_root )) {
+ $io->note('Citeproc-php dependencies are present.');
+ return 1;
+ } else {
+ $io->note('Citeproc-php dependencies are not present.');
+ $csl_locales_path = $csl_root . '/locales';
+ $csl_styles_path = $csl_root . '/styles-distribution';
+ $csl_styles_url = 'https:/citation-style-language/styles-distribution/tarball/master';
+ $csl_locales_url = 'https:/citation-style-language/locales/tarball/master';
+ $tmp_dir = $file_system->getTempDirectory() ;
+ $csl_styles_destination = $this->downloadFiles($csl_styles_url, $tmp_dir . '/citeproc-styles.tar.gz');
+ $csl_locales_destination = $this->downloadFiles($csl_locales_url, $tmp_dir . '/citeproc-locales.tar.gz');
+ $csl_styles_tar = new TAR($csl_styles_destination);
+ $csl_locales_tar = new TAR($csl_locales_destination);
+
+ $csl_locales_files_all = $csl_locales_tar->listContents();
+ $csl_locales_files_extract = [];
+ $csl_locales_path_remove = explode('/', $csl_locales_files_all[0],0 )[0];
+ foreach ( $csl_locales_files_all as $csl_locales_file ) {
+ if (str_ends_with( $csl_locales_file, '.xml' ) || str_ends_with( $csl_locales_file, '.json' )) {
+ array_push( $csl_locales_files_extract, $csl_locales_file );
+ }
+ }
+ $csl_locales_tar->extract( $csl_root, $csl_locales_files_extract );
+ rename($csl_root . '/' . $csl_locales_path_remove, $csl_locales_path);
+
+ $csl_styles_files_all = $csl_styles_tar->listContents();
+ $csl_styles_files_extract = [];
+ $csl_styles_path_remove = explode('/', $csl_styles_files_all[0],0 )[0];
+ foreach ( $csl_styles_files_all as $csl_styles_file ) {
+ if (str_ends_with( $csl_styles_file, '.csl')) {
+ array_push( $csl_styles_files_extract, $csl_styles_file );
+ }
+ }
+ $csl_styles_tar->extract( $csl_root, $csl_styles_files_extract );
+ rename($csl_root . '/' . $csl_styles_path_remove, $csl_styles_path );
+ }
+ }
+}