@ -6,22 +6,20 @@ use Drupal\Core\Config\ImmutableConfig;
use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Field\FieldItemInterface; use Drupal\Core\Field\FieldItemInterface;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface; use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Url; use Drupal\Core\Url;
use Drupal\media\Entity\Media;
use Drupal\islandora\IslandoraUtils; use Drupal\islandora\IslandoraUtils;
use Drupal\taxonomy\TermInterface ; use Drupal\islandora_iiif\IiifInfo ;
use Drupal\views\Plugin\views\style\StylePluginBase; use Drupal\views\Plugin\views\style\StylePluginBase;
use Drupal\views\ResultRow; use Drupal\views\ResultRow;
use GuzzleHttp\Client; use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\ConnectException;
use GuzzleHttp\Exception\ServerException;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Serializer\SerializerInterface;
/** /**
* Provide serializer format for IIIF Manifest. * Provide serializer format for IIIF Manifest.
@ -44,6 +42,7 @@ class IIIFManifest extends StylePluginBase {
*/ */
protected $utils; protected $utils;
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
@ -68,6 +67,13 @@ class IIIFManifest extends StylePluginBase {
*/ */
protected $serializer; protected $serializer;
/**
* The IIIF Info service.
*
* @var \Drupal\islandora_iiif\IiifInfo
*/
protected $iiifInfo;
/** /**
* The request service. * The request service.
* *
@ -96,13 +102,6 @@ class IIIFManifest extends StylePluginBase {
*/ */
protected $fileSystem; protected $fileSystem;
/**
* The Guzzle HTTP Client.
*
* @var \GuzzleHttp\Client
*/
protected $httpClient;
/** /**
* The messenger. * The messenger.
* *
@ -117,24 +116,10 @@ class IIIFManifest extends StylePluginBase {
*/ */
protected $moduleHandler; protected $moduleHandler;
/**
* Memoized structured text term.
*
* @var \Drupal\taxonomy\TermInterface|null
*/
protected ?TermInterface $structuredTextTerm;
/**
* Flag to track if we _have_ attempted a lookup, as the value is nullable.
*
* @var bool
*/
protected bool $structuredTextTermMemoized = FALSE;
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function __construct(array $configuration, $plugin_id, $plugin_definition, SerializerInterface $serializer, Request $request, ImmutableConfig $iiif_config, EntityTypeManagerInterface $entity_type_manager, FileSystemInterface $file_system, Client $http_client, MessengerInterface $messenger, ModuleHandlerInterface $moduleHandler, IslandoraUtils $utils) { public function __construct(array $configuration, $plugin_id, $plugin_definition, SerializerInterface $serializer, Request $request, ImmutableConfig $iiif_config, EntityTypeManagerInterface $entity_type_manager, FileSystemInterface $file_system, Client $http_client, MessengerInterface $messenger, ModuleHandlerInterface $moduleHandler, IslandoraUtils $utils, IiifInfo $iiif_info) {
parent::__construct($configuration, $plugin_id, $plugin_definition); parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->serializer = $serializer; $this->serializer = $serializer;
@ -144,8 +129,9 @@ class IIIFManifest extends StylePluginBase {
$this->fileSystem = $file_system; $this->fileSystem = $file_system;
$this->httpClient = $http_client; $this->httpClient = $http_client;
$this->messenger = $messenger; $this->messenger = $messenger;
$this->utils = $utils;
$this->moduleHandler = $moduleHandler; $this->moduleHandler = $moduleHandler;
$this->utils = $utils;
$this->iiifInfo = $iiif_info;
} }
/** /**
@ -164,7 +150,8 @@ class IIIFManifest extends StylePluginBase {
$container->get('http_client'), $container->get('http_client'),
$container->get('messenger'), $container->get('messenger'),
$container->get('module_handler'), $container->get('module_handler'),
$container->get('islandora.utils') $container->get('islandora.utils'),
$container->get('islandora_iiif')
); );
} }
@ -192,33 +179,20 @@ class IIIFManifest extends StylePluginBase {
// @todo assumming the view is a path like /node/1/manifest.json // @todo assumming the view is a path like /node/1/manifest.json
$url_components = explode('/', trim($request_url, '/')); $url_components = explode('/', trim($request_url, '/'));
array_pop($url_components); array_pop($url_components);
$content_path = '/' . implode('/', $url_components); $content_path = implode('/', $url_components);
$iiif_base_id = "{$request_host}{$content_path}"; $iiif_base_id = $request_host . '/' . $content_path;
$display = $this->iiifConfig->get('show_title');
switch ($display) {
case 'none':
$label = '';
break;
case 'view':
$label = $this->view->getTitle();
break;
case 'node':
$label = $this->getEntityTitle($content_path);
break;
default: /**
$label = $this->t("IIIF Manifest"); * @var \Drupal\taxonomy\TermInterface|null
} */
$structured_text_term = $this->utils->getTermForUri($this->options['structured_text_term_uri']);
// @see https://iiif.io/api/presentation/2.1/#manifest // @see https://iiif.io/api/presentation/2.1/#manifest
$json += [ $json += [
'@type' => 'sc:Manifest', '@type' => 'sc:Manifest',
'@id' => $request_url, '@id' => $request_url,
// If the View has a title, set the View title as the manifest label. // If the View has a title, set the View title as the manifest label.
'label' => $lab el, 'label' => $this->view->getTitle() ?: $this->getEntityTitle($content_path),
'@context' => 'http://iiif.io/api/presentation/2/context.json', '@context' => 'http://iiif.io/api/presentation/2/context.json',
// @see https://iiif.io/api/presentation/2.1/#sequence // @see https://iiif.io/api/presentation/2.1/#sequence
'sequences' => [ 'sequences' => [
@ -232,7 +206,7 @@ class IIIFManifest extends StylePluginBase {
// For each row in the View result. // For each row in the View result.
foreach ($this->view->result as $row) { foreach ($this->view->result as $row) {
// Add the IIIF URL to the image to print out as JSON. // Add the IIIF URL to the image to print out as JSON.
$canvases = $this->getTileSourceFromRow($row, $iiif_address, $iiif_base_id); $canvases = $this->getTileSourceFromRow($row, $iiif_address, $iiif_base_id, $structured_text_term );
foreach ($canvases as $tile_source) { foreach ($canvases as $tile_source) {
$json['sequences'][0]['canvases'][] = $tile_source; $json['sequences'][0]['canvases'][] = $tile_source;
} }
@ -242,7 +216,7 @@ class IIIFManifest extends StylePluginBase {
$content_type = 'json'; $content_type = 'json';
// Add a search endpoint if one is defined. // Add a search endpoint if one is defined
$this->addSearchEndpoint($json, $url_components); $this->addSearchEndpoint($json, $url_components);
// Give other modules a chance to alter the manifest. // Give other modules a chance to alter the manifest.
@ -261,11 +235,13 @@ class IIIFManifest extends StylePluginBase {
* @param string $iiif_base_id * @param string $iiif_base_id
* The URL for the request, minus the last part of the URL, * The URL for the request, minus the last part of the URL,
* which is likely "manifest". * which is likely "manifest".
* @param \Drupal\taxonomy\TermInterface|null $structured_text_term
* The term that structured text media references, if any.
* *
* @return array * @return array
* List of IIIF URLs to display in the Openseadragon viewer. * List of IIIF URLs to display in the Openseadragon viewer.
*/ */
protected function getTileSourceFromRow(ResultRow $row, $iiif_address, $iiif_base_id) { protected function getTileSourceFromRow(ResultRow $row, $iiif_address, $iiif_base_id, $structured_text_term ) {
$canvases = []; $canvases = [];
foreach (array_filter(array_values($this->options['iiif_tile_field'])) as $iiif_tile_field) { foreach (array_filter(array_values($this->options['iiif_tile_field'])) as $iiif_tile_field) {
$viewsField = $this->view->field[$iiif_tile_field]; $viewsField = $this->view->field[$iiif_tile_field];
@ -296,7 +272,10 @@ class IIIFManifest extends StylePluginBase {
$canvas_id = $iiif_base_id . '/canvas/' . $entity->id(); $canvas_id = $iiif_base_id . '/canvas/' . $entity->id();
$annotation_id = $iiif_base_id . '/annotation/' . $entity->id(); $annotation_id = $iiif_base_id . '/annotation/' . $entity->id();
[$width, $height] = $this->getCanvasDimensions($iiif_url, $image, $mime_type); [$width, $height] = $this->getCanvasDimensions($iiif_url, $entity, $image, $mime_type);
if ($width == 0) {
continue;
}
$tmp_canvas = [ $tmp_canvas = [
// @see https://iiif.io/api/presentation/2.1/#canvas // @see https://iiif.io/api/presentation/2.1/#canvas
@ -328,7 +307,7 @@ class IIIFManifest extends StylePluginBase {
], ],
]; ];
if ($ocr_url = $this->getOcrUrl($entity)) { if ($ocr_url = $this->getOcrUrl($entity, $structured_text_term )) {
$tmp_canvas['seeAlso'] = [ $tmp_canvas['seeAlso'] = [
'@id' => $ocr_url, '@id' => $ocr_url,
'format' => 'text/vnd.hocr+html', 'format' => 'text/vnd.hocr+html',
@ -365,42 +344,70 @@ class IIIFManifest extends StylePluginBase {
* @return [string] * @return [string]
* The width and height of the image. * The width and height of the image.
*/ */
protected function getCanvasDimensions(string $iiif_url, FieldItemInterface $image, string $mime_type) { protected function getCanvasDimensions(string $iiif_url, Media $media, FieldItemInterface $image, string $mime_type) {
// If the media has field_height and field_width, return those values.
if ($media->hasField('field_height')
& & !$media->get('field_height')->isEmpty()
& & $media->get('field_height')->value > 0
& & $media->hasField('field_width')
& & !$media->get('field_width')->isEmpty()
& & $media->get('field_width')->value > 0) {
return [intval($media->get('field_width')->value),
intval($media->get('field_height')->value),
];
}
// Otherwise start looking at the field/file level for the numbers.
if (isset($image->width) & & is_numeric($image->width) if (isset($image->width) & & is_numeric($image->width)
& & isset($image->height) & & is_numeric($image->height)) { & & isset($image->height) & & is_numeric($image->height)) {
return [intval($image->width), intval($image->height)]; return [intval($image->width),
intval($image->height),
];
} }
try { if ($properties = $image->getProperties()
$info_json = $this->httpClient->get($iiif_url)->getBody(); & & isset($properties['width']) & & is_numeric($properties['width'])
$resource = json_decode($info_json, TRUE); & & isset($properties['height']) & & is_numeric($properties['width'])) {
$width = $resource['width']; return [intval($properties['width']),
$height = $resource['height']; intval($properties['height']),
} ];
catch (ClientException | ServerException | ConnectException $e) { }
// If we couldn't get the info.json from IIIF
// try seeing if we can get it from Drupal. $entity = $image->entity;
if (empty($width) || empty($height)) { if ($entity->hasField('field_height') & & !$entity->get('field_height')->isEmpty()
// Get the image properties so we know the image width/height. & & $entity->get('field_height')->value > 0
$properties = $image->getProperties(); & & $entity->hasField('field_width')
$width = isset($properties['width']) ? $properties['width'] : 0; & & !$entity->get('field_width')->isEmpty()
$height = isset($properties['height']) ? $properties['height'] : 0; & & $entity->get('field_width')->value > 0) {
return [$entity->get('field_width')->value,
$entity->get('field_height')->value,
];
}
if ($mime_type === 'image/tiff') {
// If this is a TIFF AND we don't know the width/height // If this is a TIFF AND we don't know the width/height
// see if we can get the image size via PHP's core function. // see if we can get the image size via PHP's core function.
if ($mime_type === 'image/tiff' & & (!$width || !$height)) {
$uri = $image->entity->getFileUri(); $uri = $image->entity->getFileUri();
$path = $this->fileSystem->realpath($uri); $path = $this->fileSystem->realpath($uri);
if (!empty($path)) {
$image_size = getimagesize($path); $image_size = getimagesize($path);
if ($image_size) { if ($image_size) {
$width = $image_size[0]; return [intval($image_size[0]),
$height = $image_size[1]; intval($image_size[1]),
];
} }
} }
} }
// As a last resort, get it from the IIIF server.
// This can be very slow and will fail if there are too many pages.
$dimensions = $this->iiifInfo->getImageDimensions($image->entity);
if ($dimensions !== FALSE) {
return $dimensions;
} }
return [$width, $height];
return [0, 0];
} }
/** /**
@ -408,12 +415,14 @@ class IIIFManifest extends StylePluginBase {
* *
* @param \Drupal\Core\Entity\EntityInterface $entity * @param \Drupal\Core\Entity\EntityInterface $entity
* The entity at the current row. * The entity at the current row.
* @param \Drupal\taxonomy\TermInterface|null $structured_text_term
* The term that structured text media references, if any.
* *
* @return string|false * return String|FALSE
* The absolute URL of the current row's structured text, * The absolute URL of the current row's structured text,
* or FALSE if none. * or FALSE if none.
*/ */
protected function getOcrUrl(EntityInterface $entity) { protected function getOcrUrl(EntityInterface $entity, $structured_text_term ) {
$ocr_url = FALSE; $ocr_url = FALSE;
$iiif_ocr_file_field = !empty($this->options['iiif_ocr_file_field']) ? array_filter(array_values($this->options['iiif_ocr_file_field'])) : []; $iiif_ocr_file_field = !empty($this->options['iiif_ocr_file_field']) ? array_filter(array_values($this->options['iiif_ocr_file_field'])) : [];
$ocrField = count($iiif_ocr_file_field) > 0 ? $this->view->field[$iiif_ocr_file_field[0]] : NULL; $ocrField = count($iiif_ocr_file_field) > 0 ? $this->view->field[$iiif_ocr_file_field[0]] : NULL;
@ -423,12 +432,10 @@ class IIIFManifest extends StylePluginBase {
if (!is_null($ocr_field_name)) { if (!is_null($ocr_field_name)) {
$ocrs = $ocr_entity->{$ocr_field_name}; $ocrs = $ocr_entity->{$ocr_field_name};
$ocr = $ocrs[0] ?? FALSE; $ocr = $ocrs[0] ?? FALSE;
if ($ocr) {
$ocr_url = $ocr->entity->createFileUrl(FALSE); $ocr_url = $ocr->entity->createFileUrl(FALSE);
} }
} }
} elseif ($structured_text_term) {
elseif ($structured_text_term = $this->getStructuredTextTerm()) {
$parent_node = $this->utils->getParentNode($entity); $parent_node = $this->utils->getParentNode($entity);
$ocr_entity_array = $this->utils->getMediaReferencingNodeAndTerm($parent_node, $structured_text_term); $ocr_entity_array = $this->utils->getMediaReferencingNodeAndTerm($parent_node, $structured_text_term);
$ocr_entity_id = is_array($ocr_entity_array) ? array_shift($ocr_entity_array) : NULL; $ocr_entity_id = is_array($ocr_entity_array) ? array_shift($ocr_entity_array) : NULL;
@ -472,26 +479,6 @@ class IIIFManifest extends StylePluginBase {
return $entity_title; return $entity_title;
} }
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['iiif_tile_field'] = ['default' => ''];
$options['iiif_ocr_file_field'] = ['default' => ''];
return $options;
}
/**
* Add the configured search endpoint to the manifest.
*
* @param array $json
* The IIIF manifest.
* @param array $url_components
* The search endpoint URL as array.
*/
protected function addSearchEndpoint(array & $json, array $url_components) { protected function addSearchEndpoint(array & $json, array $url_components) {
$url_base = $this->getRequest()->getSchemeAndHttpHost(); $url_base = $this->getRequest()->getSchemeAndHttpHost();
$hocr_search_path = $this->options['search_endpoint']; $hocr_search_path = $this->options['search_endpoint'];
@ -505,6 +492,20 @@ class IIIFManifest extends StylePluginBase {
"profile" => "http://iiif.io/api/search/0/search", "profile" => "http://iiif.io/api/search/0/search",
"label" => t("Search inside this work"), "label" => t("Search inside this work"),
]; ];
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['iiif_tile_field'] = ['default' => ''];
$options['iiif_ocr_file_field'] = ['default' => ''];
return $options;
} }
/** /**
@ -563,16 +564,15 @@ class IIIFManifest extends StylePluginBase {
'#title' => $this->t('Structured OCR data file field'), '#title' => $this->t('Structured OCR data file field'),
'#type' => 'checkboxes', '#type' => 'checkboxes',
'#default_value' => $this->options['iiif_ocr_file_field'], '#default_value' => $this->options['iiif_ocr_file_field'],
'#description' => $this->t("If the hOCR is a field on the same entity as the image source field above, select it here. If it's found in a related entity via the term below, leave this blank." ), '#description' => $this->t('The source of structured OCR text for each entity. If the term setting below is left blank, it will be the same entity as the source image' ),
'#options' => $field_options, '#options' => $field_options,
'#required' => FALSE, '#required' => FALSE,
]; ];
$form['structured_text_term'] = [ $form['structured_text_term'] = [
'#type' => 'entity_autocomplete', '#type' => 'entity_autocomplete',
'#target_type' => 'taxonomy_term', '#target_type' => 'taxonomy_term',
'#title' => $this->t('Structured OCR text term'), '#title' => $this->t('Structured OCR text term'),
'#default_value' => $this->getStructuredTextTerm( ), '#default_value' => $this->utils->getTermForUri($this->options['structured_text_term_uri'] ),
'#required' => FALSE, '#required' => FALSE,
'#description' => $this->t('Term indicating the media that holds structured text, such as hOCR, for the given object. Use this if the text is on a separate media from the tile source.'), '#description' => $this->t('Term indicating the media that holds structured text, such as hOCR, for the given object. Use this if the text is on a separate media from the tile source.'),
]; ];
@ -580,7 +580,7 @@ class IIIFManifest extends StylePluginBase {
$form['search_endpoint'] = [ $form['search_endpoint'] = [
'#type' => 'textfield', '#type' => 'textfield',
'#title' => $this->t("Search endpoint path."), '#title' => $this->t("Search endpoint path."),
'#description' => $this->t("If there is a search endpoint to search within the book that returns IIIF annotations, put it here. Use %node substitution where needed .< br > E.g., paged-content-search/%node"), '#description' => $this->t("If there is a search endpoint to search within the book that returns IIIF annotations, put it here. Use substitutions %node and %keywords .< br > E.g., paged-content-search/%node?search-in-pages=%keywords "),
'#default_value' => $this->options['search_endpoint'], '#default_value' => $this->options['search_endpoint'],
'#required' => FALSE, '#required' => FALSE,
]; ];
@ -611,26 +611,10 @@ class IIIFManifest extends StylePluginBase {
// @codingStandardsIgnoreEnd // @codingStandardsIgnoreEnd
$style_options = $form_state->getValue('style_options'); $style_options = $form_state->getValue('style_options');
$tid = $style_options['structured_text_term']; $tid = $style_options['structured_text_term'];
unset($style_options['structured_text_term']);
$term = $this->entityTypeManager->getStorage('taxonomy_term')->load($tid); $term = $this->entityTypeManager->getStorage('taxonomy_term')->load($tid);
$style_options['structured_text_term_uri'] = $this->utils->getUriForTerm($term); $style_options['structured_text_term_uri'] = $this->utils->getUriForTerm($term);
$form_state->setValue('style_options', $style_options); $form_state->setValue('style_options', $style_options);
parent::submitOptionsForm($form, $form_state); parent::submitOptionsForm($form, $form_state);
} }
/**
* Get the structured text term.
*
* @return \Drupal\taxonomy\TermInterface|null
* The term if it could be found; otherwise, NULL.
*/
protected function getStructuredTextTerm() : ?TermInterface {
if (!$this->structuredTextTermMemoized) {
$this->structuredTextTermMemoized = TRUE;
$this->structuredTextTerm = $this->utils->getTermForUri($this->options['structured_text_term_uri']);
}
return $this->structuredTextTerm;
}
} }
Alexander O'Neill