diff --git a/islandora.module b/islandora.module index 3d415094..434f77fb 100644 --- a/islandora.module +++ b/islandora.module @@ -106,7 +106,6 @@ function islandora_node_delete(NodeInterface $node) { */ function islandora_media_insert(MediaInterface $media) { $utils = \Drupal::service('islandora.utils'); - // Execute index reactions. $utils->executeMediaReactions('\Drupal\islandora\Plugin\ContextReaction\IndexReaction', $media); @@ -136,7 +135,6 @@ function islandora_media_update(MediaInterface $media) { // Execute index reactions. $utils->executeMediaReactions('\Drupal\islandora\Plugin\ContextReaction\IndexReaction', $media); - // Does it have a source field? $source_field = $media_source_service->getSourceFieldName($media->bundle()); if (empty($source_field)) { @@ -147,7 +145,6 @@ function islandora_media_update(MediaInterface $media) { if ($media->get($source_field)->equals($media->original->get($source_field))) { return; } - // If it has a parent node... $node = $utils->getParentNode($media); if ($node) { @@ -157,6 +154,7 @@ function islandora_media_update(MediaInterface $media) { $node, $media ); + $utils->executeMediaReactions('\Drupal\islandora\Plugin\ContextReaction\DerivativeFileReaction', $media); } } @@ -170,6 +168,19 @@ function islandora_media_delete(MediaInterface $media) { $utils->executeMediaReactions('\Drupal\islandora\Plugin\ContextReaction\DeleteReaction', $media); } +/** + * Implements hook_ENTITYTYPE_postsave(). + */ +function islandora_media_postsave(EntityInterface $media, $op) { + + $utils = \Drupal::service('islandora.utils'); + // Add derived file to the media. + if ($op == 'insert') { + $utils->executeMediaReactions('\Drupal\islandora\Plugin\ContextReaction\DerivativeFileReaction', $media); + } + +} + /** * Implements hook_file_insert(). */ @@ -273,10 +284,11 @@ function islandora_jsonld_alter_normalized_array(EntityInterface $entity, array function islandora_entity_view_mode_alter(&$view_mode, EntityInterface $entity) { // Change the view mode based on user input from a 'view_mode_alter' // ContextReaction. + $entity_type = $entity->getEntityType()->id(); $storage = \Drupal::service('entity_type.manager')->getStorage('entity_view_mode'); $context_manager = \Drupal::service('context.manager'); - $current_entity = \Drupal::routeMatch()->getParameter('node'); - $current_id = ($current_entity instanceof NodeInterface) ? $current_entity->id() : NULL; + $current_entity = \Drupal::routeMatch()->getParameter($entity_type); + $current_id = ($current_entity instanceof NodeInterface || $current_entity instanceof MediaInterface) ? $current_entity->id() : NULL; if (isset($current_id) && $current_id == $entity->id()) { foreach ($context_manager->getActiveReactions('\Drupal\islandora\Plugin\ContextReaction\ViewModeAlterReaction') as $reaction) { // Construct the new view mode's machine name. @@ -300,6 +312,8 @@ function islandora_entity_view_mode_alter(&$view_mode, EntityInterface $entity) } } + + /** * Implements hook_preprocess_node(). */ diff --git a/islandora.routing.yml b/islandora.routing.yml index 58dea1a2..ddfd93f1 100644 --- a/islandora.routing.yml +++ b/islandora.routing.yml @@ -57,3 +57,17 @@ islandora.media_source_put_to_node: _custom_access: '\Drupal\islandora\Controller\MediaSourceController::putToNodeAccess' options: _auth: ['basic_auth', 'cookie', 'jwt_auth'] + +islandora.attach_file_to_media: + path: '/media/add_derivative/{media}/{destination_field}' + defaults: + _controller: '\Drupal\islandora\Controller\MediaSourceController::attachToMedia' + methods: [GET, PUT] + requirements: + _custom_access: '\Drupal\islandora\Controller\MediaSourceController::attachToMediaAccess' + options: + _auth: ['basic_auth', 'cookie', 'jwt_auth'] + no_cache: 'TRUE' + parameters: + media: + type: entity:media diff --git a/modules/islandora_image/src/Plugin/Action/GenerateImageDerivativeFile.php b/modules/islandora_image/src/Plugin/Action/GenerateImageDerivativeFile.php new file mode 100644 index 00000000..b73e163e --- /dev/null +++ b/modules/islandora_image/src/Plugin/Action/GenerateImageDerivativeFile.php @@ -0,0 +1,43 @@ +getSettings(); + $extensions = $fieldSettings['file_extensions']; + if (!strpos($extensions, 'txt')) { + $fieldSettings['file_extensions'] .= ' txt'; + $field->set('settings', $fieldSettings); + $field->save(); + } +} diff --git a/modules/islandora_text_extraction/islandora_text_extraction.routing.yml b/modules/islandora_text_extraction/islandora_text_extraction.routing.yml new file mode 100644 index 00000000..e28a056b --- /dev/null +++ b/modules/islandora_text_extraction/islandora_text_extraction.routing.yml @@ -0,0 +1,13 @@ +islandora_text_extraction.attach_file_to_media: + path: '/media/add_ocr/{media}/{destination_field}/{destination_text_field}' + defaults: + _controller: '\Drupal\islandora_text_extraction\Controller\MediaSourceController::attachToMedia' + methods: [GET, PUT] + requirements: + _custom_access: '\Drupal\islandora\Controller\MediaSourceController::attachToMediaAccess' + options: + _auth: ['basic_auth', 'cookie', 'jwt_auth'] + no_cache: 'TRUE' + parameters: + media: + type: entity:media diff --git a/modules/islandora_text_extraction/src/Controller/MediaSourceController.php b/modules/islandora_text_extraction/src/Controller/MediaSourceController.php new file mode 100644 index 00000000..5c16e4f5 --- /dev/null +++ b/modules/islandora_text_extraction/src/Controller/MediaSourceController.php @@ -0,0 +1,63 @@ +headers->get('Content-Location', ""); + $contents = $request->getContent(); + + if ($contents) { + $file = file_save_data($contents, $content_location, FILE_EXISTS_REPLACE); + if ($media->hasField($destination_field)) { + $media->{$destination_field}->setValue([ + 'target_id' => $file->id(), + ]); + } + else { + $this->getLogger('islandora')->warning("Field $destination_field is not defined in Media Type {$media->bundle()}"); + } + if ($media->hasField($destination_text_field)) { + $media->{$destination_text_field}->setValue(nl2br($contents)); + } + else{ + $this->getLogger('islandora')->warning("Field $destination_text_field is not defined in Media Type {$media->bundle()}"); + } + $media->save(); + } + // We'd only ever get here if testing the function with GET. + return new Response("

Complete

"); + } + +} diff --git a/modules/islandora_text_extraction/src/Plugin/Action/GenerateOCRDerivativeFile.php b/modules/islandora_text_extraction/src/Plugin/Action/GenerateOCRDerivativeFile.php new file mode 100644 index 00000000..2c5cbcce --- /dev/null +++ b/modules/islandora_text_extraction/src/Plugin/Action/GenerateOCRDerivativeFile.php @@ -0,0 +1,103 @@ +entityFieldManager->getFieldMapByFieldType('text_long'); + $file_fields = $map['media']; + $field_options = array_combine(array_keys($file_fields), array_keys($file_fields)); + $form = parent::buildConfigurationForm($form, $form_state); + $form['mimetype']['#description'] = t('Mimetype to convert to (e.g. application/xml, etc...)'); + $form['mimetype']['#value'] = 'text/plain'; + $form['mimetype']['#type'] = 'hidden'; + $position = array_search('destination_field_name', array_keys($form)); + $first = array_slice($form, 0, $position); + $last = array_slice($form, count($form) - $position + 1); + + $middle['destination_text_field_name'] = [ + '#required' => TRUE, + '#type' => 'select', + '#options' => $field_options, + '#title' => $this->t('Destination Text field Name'), + '#default_value' => $this->configuration['destination_text_field_name'], + '#description' => $this->t('Text field on Media Type to hold extracted text.'), + ]; + $form = array_merge($first, $middle, $last); + + unset($form['args']); + return $form; + } + + /** + * {@inheritdoc} + */ + public function validateConfigurationForm(array &$form, FormStateInterface $form_state) { + parent::validateConfigurationForm($form, $form_state); + $exploded_mime = explode('/', $form_state->getValue('mimetype')); + if ($exploded_mime[0] != 'text') { + $form_state->setErrorByName( + 'mimetype', + t('Please enter file mimetype (e.g. application/xml.)') + ); + } + } + + /** + * {@inheritdoc} + */ + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { + parent::submitConfigurationForm($form, $form_state); + $this->configuration['destination_text_field_name'] = $form_state->getValue('destination_text_field_name'); + } + + /** + * Override this to return arbitrary data as an array to be json encoded. + */ + protected function generateData(EntityInterface $entity) { + $data = parent::generateData($entity); + $route_params = [ + 'media' => $entity->id(), + 'destination_field' => $this->configuration['destination_field_name'], + 'destination_text_field' => $this->configuration['destination_text_field_name'], + ]; + $data['destination_uri'] = Url::fromRoute('islandora_text_extraction.attach_file_to_media', $route_params) + ->setAbsolute() + ->toString(); + + return $data; + } + +} diff --git a/src/Controller/MediaSourceController.php b/src/Controller/MediaSourceController.php index 2e5b4b26..ff6e9821 100644 --- a/src/Controller/MediaSourceController.php +++ b/src/Controller/MediaSourceController.php @@ -7,6 +7,7 @@ use Drupal\Core\Controller\ControllerBase; use Drupal\Core\Database\Connection; use Drupal\Core\Routing\RouteMatch; use Drupal\Core\Session\AccountInterface; +use Drupal\media\Entity\Media; use Drupal\media\MediaInterface; use Drupal\media\MediaTypeInterface; use Drupal\node\NodeInterface; @@ -210,4 +211,59 @@ class MediaSourceController extends ControllerBase { return AccessResult::allowedIf($node->access('update', $account) && $account->hasPermission('create media')); } + /** + * Adds file to existing media. + * + * @param Drupal\media\Entity\Media\Media $media + * The media to which file is added. + * @param string $destination_field + * The name of the media field to add file reference. + * @param \Symfony\Component\HttpFoundation\Request $request + * The request object. + * + * @return \Symfony\Component\HttpFoundation\Response + * 201 on success with a Location link header. + * + * @throws \Drupal\Core\Entity\EntityStorageException + * @throws \Drupal\Core\TypedData\Exception\ReadOnlyException + */ + public function attachToMedia( + Media $media, + string $destination_field, + Request $request) { + $content_location = $request->headers->get('Content-Location', ""); + $contents = $request->getContent(); + if ($contents) { + $file = file_save_data($contents, $content_location, FILE_EXISTS_REPLACE); + if ($media->hasField($destination_field)) { + $media->{$destination_field}->setValue([ + 'target_id' => $file->id(), + ]); + $media->save(); + } + else{ + $this->getLogger('islandora')->warning("Field $destination_field is not defined in Media Type {$media->bundle()}"); + } + } + // Should only see this with a GET request for testing. + return new Response("

Complete

"); + } + + /** + * Checks for permissions to update a node and update media. + * + * @param \Drupal\Core\Session\AccountInterface $account + * Account for user making the request. + * @param \Drupal\Core\Routing\RouteMatch $route_match + * Route match to get Node from url params. + * + * @return \Drupal\Core\Access\AccessResultInterface + * Access result. + */ + public function attachToMediaAccess(AccountInterface $account, RouteMatch $route_match) { + $media = $route_match->getParameter('media'); + $node = $this->utils->getParentNode($media); + return AccessResult::allowedIf($node->access('update', $account) && $account->hasPermission('create media')); + } + } diff --git a/src/Plugin/Action/AbstractGenerateDerivativeMediaFile.php b/src/Plugin/Action/AbstractGenerateDerivativeMediaFile.php new file mode 100644 index 00000000..9b20eb1e --- /dev/null +++ b/src/Plugin/Action/AbstractGenerateDerivativeMediaFile.php @@ -0,0 +1,318 @@ +utils = $utils; + $this->mediaSource = $media_source; + $this->token = $token; + $this->entityFieldManager = $entity_field_manager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { + return new static( + $configuration, + $plugin_id, + $plugin_definition, + $container->get('current_user'), + $container->get('entity_type.manager'), + $container->get('islandora.eventgenerator'), + $container->get('islandora.stomp'), + $container->get('jwt.authentication.jwt'), + $container->get('islandora.utils'), + $container->get('islandora.media_source_service'), + $container->get('token'), + $container->get('entity_field.manager') + ); + } + + /** + * {@inheritdoc} + */ + public function defaultConfiguration() { + $uri = 'http://pcdm.org/use#OriginalFile'; + return [ + 'queue' => 'islandora-connector-houdini', + 'event' => 'Generate Derivative', + 'source_term_uri' => $uri, + 'mimetype' => '', + 'args' => '', + 'scheme' => file_default_scheme(), + 'path' => '[date:custom:Y]-[date:custom:m]/[media:mid].bin', + 'source_field_name' => 'field_media_file', + 'destination_field_name' => '', + ]; + } + + /** + * Override this to return arbitrary data as an array to be json encoded. + */ + protected function generateData(EntityInterface $entity) { + $data = parent::generateData($entity); + if (get_class($entity) != 'Drupal\media\Entity\Media') { + return; + } + $source_file = $this->mediaSource->getSourceFile($entity); + if (!$source_file) { + throw new \RuntimeException("Could not locate source file for media {$entity->id()}", 500); + } + $data['source_uri'] = $this->utils->getDownloadUrl($source_file); + + $route_params = [ + 'media' => $entity->id(), + 'destination_field' => $this->configuration['destination_field_name'], + ]; + $data['destination_uri'] = Url::fromRoute('islandora.attach_file_to_media', $route_params) + ->setAbsolute() + ->toString(); + + $token_data = [ + 'media' => $entity, + ]; + $path = $this->token->replace($data['path'], $token_data); + $data['file_upload_uri'] = $data['scheme'] . '://' . $path; + $allowed = ['queue', + 'event', + 'args', + 'source_uri', + 'destination_uri', + 'file_upload_uri', + 'mimetype', + ]; + foreach ($data as $key => $value) { + if (!in_array($key, $allowed)) { + unset($data[$key]); + } + } + return $data; + } + + /** + * {@inheritdoc} + */ + public function buildConfigurationForm(array $form, FormStateInterface $form_state) { + $schemes = $this->utils->getFilesystemSchemes(); + $scheme_options = array_combine($schemes, $schemes); + $form = parent::buildConfigurationForm($form, $form_state); + $map = $this->entityFieldManager->getFieldMapByFieldType('file'); + $file_fields = $map['media']; + $file_options = array_combine(array_keys($file_fields), array_keys($file_fields)); + $file_options = array_merge(['' => ''], $file_options); + $form['event']['#disabled'] = 'disabled'; + + $form['destination_field_name'] = [ + '#required' => TRUE, + '#type' => 'select', + '#options' => $file_options, + '#title' => $this->t('Destination File field Name'), + '#default_value' => $this->configuration['destination_field_name'], + '#description' => $this->t('File field on Media Type to hold derivative. Cannot be the same as source'), + ]; + $form['mimetype'] = [ + '#type' => 'textfield', + '#title' => t('Mimetype'), + '#default_value' => $this->configuration['mimetype'], + '#required' => TRUE, + '#rows' => '8', + '#description' => t('Mimetype to convert to (e.g. image/jpeg, video/mp4, etc...)'), + ]; + $form['args'] = [ + '#type' => 'textfield', + '#title' => t('Additional arguments'), + '#default_value' => $this->configuration['args'], + '#rows' => '8', + '#description' => t('Additional command line arguments'), + ]; + $form['scheme'] = [ + '#type' => 'select', + '#title' => t('File system'), + '#options' => $scheme_options, + '#default_value' => $this->configuration['scheme'], + '#required' => TRUE, + ]; + $form['path'] = [ + '#type' => 'textfield', + '#title' => t('File path'), + '#default_value' => $this->configuration['path'], + '#description' => t('Path within the upload destination where files will be stored. Includes the filename and optional extension.'), + ]; + $form['queue'] = [ + '#type' => 'textfield', + '#title' => t('Queue name'), + '#default_value' => $this->configuration['queue'], + '#description' => t('Queue name to send along to help routing events, CHANGE WITH CARE. Defaults to :queue', [ + ':queue' => $this->defaultConfiguration()['queue'], + ]), + ]; + return $form; + } + + /** + * {@inheritdoc} + */ + public function validateConfigurationForm(array &$form, FormStateInterface $form_state) { + parent::validateConfigurationForm($form, $form_state); + + $exploded_mime = explode('/', $form_state->getValue('mimetype')); + + if (count($exploded_mime) != 2) { + $form_state->setErrorByName( + 'mimetype', + t('Please enter a mimetype (e.g. image/jpeg, video/mp4, audio/mp3, etc...)') + ); + } + + if (empty($exploded_mime[1])) { + $form_state->setErrorByName( + 'mimetype', + t('Please enter a mimetype (e.g. image/jpeg, video/mp4, audio/mp3, etc...)') + ); + } + } + + /** + * {@inheritdoc} + */ + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { + parent::submitConfigurationForm($form, $form_state); + $this->configuration['mimetype'] = $form_state->getValue('mimetype'); + $this->configuration['args'] = $form_state->getValue('args'); + $this->configuration['scheme'] = $form_state->getValue('scheme'); + $this->configuration['path'] = trim($form_state->getValue('path'), '\\/'); + $this->configuration['destination_field_name'] = $form_state->getValue('destination_field_name'); + } + + /** + * Find a media_type by id and return it or nothing. + * + * @param string $entity_id + * The media type. + * + * @return \Drupal\Core\Entity\EntityInterface|string + * Return the loaded entity or nothing. + * + * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException + * Thrown by getStorage() if the entity type doesn't exist. + * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException + * Thrown by getStorage() if the storage handler couldn't be loaded. + */ + protected function getEntityById($entity_id) { + $entity_ids = $this->entityTypeManager->getStorage('media_type') + ->getQuery()->condition('id', $entity_id)->execute(); + + $id = reset($entity_ids); + if ($id !== FALSE) { + return $this->entityTypeManager->getStorage('media_type')->load($id); + } + return ''; + } + +} diff --git a/src/Plugin/Condition/MediaSourceHasMimetype.php b/src/Plugin/Condition/MediaSourceHasMimetype.php new file mode 100644 index 00000000..53e20200 --- /dev/null +++ b/src/Plugin/Condition/MediaSourceHasMimetype.php @@ -0,0 +1,91 @@ + $this->t('Source Media Mimetype'), + '#type' => 'textfield', + '#default_value' => $this->configuration['mimetype'], + ]; + + return parent::buildConfigurationForm($form, $form_state);; + } + + /** + * {@inheritdoc} + */ + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { + $this->configuration['mimetype'] = $form_state->getValue('mimetype'); + parent::submitConfigurationForm($form, $form_state); + } + + /** + * {@inheritdoc} + */ + public function evaluate() { + foreach ($this->getContexts() as $context) { + if ($context->hasContextValue()) { + $entity = $context->getContextValue(); + $mid = $entity->id(); + if ($mid && !empty($this->configuration['mimetype'])) { + $source = $entity->getSource(); + $source_file = File::load($source->getSourceFieldValue($entity)); + if ($this->configuration['mimetype'] == $source_file->getMimeType()) { + return !$this->isNegated(); + } + } + } + } + return $this->isNegated(); + } + + /** + * {@inheritdoc} + */ + public function summary() { + if (empty($this->configuration['mimetype'])) { + return $this->t('No mimetype are selected.'); + } + + return $this->t( + 'Entity bundle in the list: @mimetype', + [ + '@mimetype' => implode(', ', $this->configuration['field']), + ] + ); + } + + /** + * {@inheritdoc} + */ + public function defaultConfiguration() { + return array_merge( + ['mimetype' => []], + parent::defaultConfiguration() + ); + } + +} diff --git a/src/Plugin/ContextReaction/DerivativeFileReaction.php b/src/Plugin/ContextReaction/DerivativeFileReaction.php new file mode 100644 index 00000000..c0562fa6 --- /dev/null +++ b/src/Plugin/ContextReaction/DerivativeFileReaction.php @@ -0,0 +1,58 @@ +actionStorage->loadByProperties(['type' => 'media']); + + foreach ($actions as $action) { + $plugin = $action->getPlugin(); + if ($plugin instanceof AbstractGenerateDerivativeMediaFile) { + $options[ucfirst($action->getType())][$action->id()] = $action->label(); + } + } + $config = $this->getConfiguration(); + $form['actions'] = [ + '#title' => $this->t('Actions'), + '#description' => $this->t('Pre-configured actions to execute. Multiple actions may be selected by shift or ctrl clicking.'), + '#type' => 'select', + '#multiple' => TRUE, + '#options' => $options, + '#default_value' => isset($config['actions']) ? $config['actions'] : '', + '#size' => 15, + ]; + + return $form; + } + + /** + * {@inheritdoc} + */ + public function execute(EntityInterface $entity = NULL) { + $config = $this->getConfiguration(); + $action_ids = $config['actions']; + foreach ($action_ids as $action_id) { + $action = $this->actionStorage->load($action_id); + $action->execute([$entity]); + } + } + +}