datastore_data_preview.module

<?php

/**
 * @file
 * Hook implementations for the Datastore Data Preview module.
 */

use Drupal\common\DataResource;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Drupal\Core\Url;
use Drupal\node\NodeInterface;

/**
 * Implements hook_theme().
 */
function datastore_data_preview_theme() {
  return [
    'datastore_data_preview' => [
      'variables' => [
        'table' => NULL,
        'pager' => NULL,
        'page_size_form' => NULL,
        'result_summary' => NULL,
      ],
      'template' => 'datastore-data-preview',
    ],
  ];
}

/**
 * Implements hook_form_node_data_edit_form_alter().
 *
 * Adds inline data preview links to tabular distributions in the edit form.
 */
function datastore_data_preview_form_node_data_edit_form_alter(&$form, FormStateInterface $form_state) {
  $node = $form_state->getFormObject()->getEntity();
  if (($node->get('field_data_type')->value ?? '') !== 'dataset') {
    return;
  }

  /** @var \Drupal\common\DatasetInfo $datasetInfo */
  $datasetInfo = \Drupal::service('dkan.common.dataset_info');
  $info = $datasetInfo->gather($node->uuid());

  $revision = $info['published_revision'] ?? $info['latest_revision'] ?? NULL;
  if (!$revision || empty($revision['distributions'])) {
    return;
  }

  $distItems = &$form['field_json_metadata']['widget'][0]['value']['distribution']['distribution'] ?? NULL;
  if (!is_array($distItems)) {
    return;
  }

  foreach ($revision['distributions'] as $i => $dist) {
    if (!is_array($dist) || empty($dist['resource_id']) || empty($dist['resource_version'])) {
      continue;
    }
    // Only show preview for tabular/importable file types.
    if (!in_array($dist['mime_type'] ?? '', DataResource::IMPORTABLE_FILE_TYPES)) {
      continue;
    }
    if (!isset($distItems[$i]['distribution'])) {
      continue;
    }
    $resourceId = $dist['resource_id'] . '__' . $dist['resource_version'];
    $url = Url::fromRoute('datastore_data_preview.preview', ['resource_id' => $resourceId]);
    $previewLink = [
      '#type' => 'container',
      '#attributes' => ['class' => ['data-preview-link']],
      '#attached' => ['library' => ['datastore_data_preview/data_preview']],
      'link' => Link::fromTextAndUrl(t('Preview data'), $url)->toRenderable(),
    ];
    // Insert preview link right after downloadURL in the distribution fieldset.
    $distElement = &$distItems[$i]['distribution'];
    $inserted = [];
    foreach ($distElement as $key => $value) {
      $inserted[$key] = $value;
      if ($key === 'downloadURL') {
        $inserted['data_preview_link'] = $previewLink;
      }
    }
    $distElement = $inserted;
  }
}

/**
 * Implements hook_theme_registry_alter().
 *
 * Overrides DKAN's node--data template to include data preview output.
 */
function datastore_data_preview_theme_registry_alter(&$theme_registry) {
  if (isset($theme_registry['node__data'])) {
    $module_path = \Drupal::service('extension.list.module')->getPath('datastore_data_preview');
    $theme_registry['node__data']['path'] = $module_path . '/templates';
  }
}

/**
 * Implements hook_entity_extra_field_info().
 */
function datastore_data_preview_entity_extra_field_info() {
  $extra = [];
  if (\Drupal::entityTypeManager()->getStorage('node_type')->load('data')) {
    $extra['node']['data']['display']['data_preview'] = [
      'label' => t('Data Preview'),
      'description' => t('Paginated preview tables for tabular distributions.'),
      'weight' => 100,
      'visible' => TRUE,
    ];
  }
  return $extra;
}

/**
 * Implements hook_ENTITY_TYPE_view() for node entities.
 *
 * Adds data preview tables for each tabular distribution on dataset nodes.
 */
function datastore_data_preview_node_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode) {
  if (!$entity instanceof NodeInterface) {
    return;
  }
  if ($entity->bundle() !== 'data') {
    return;
  }
  if (($entity->get('field_data_type')->value ?? '') !== 'dataset') {
    return;
  }
  if (!$display->getComponent('data_preview')) {
    return;
  }

  // During node preview of a new (unsaved) node, datastore tables don't exist.
  if (!empty($entity->in_preview) && $entity->isNew()) {
    $build['data_preview'] = [
      '#markup' => '<p>' . t('Data preview is available after the dataset is saved and data is imported.') . '</p>',
    ];
    return;
  }

  /** @var \Drupal\common\DatasetInfo $datasetInfo */
  $datasetInfo = \Drupal::service('dkan.common.dataset_info');
  $info = $datasetInfo->gather($entity->uuid());

  $revision = $info['published_revision'] ?? $info['latest_revision'] ?? NULL;
  if (!$revision || empty($revision['distributions'])) {
    return;
  }

  $previews = [];
  foreach ($revision['distributions'] as $dist) {
    if (!is_array($dist) || empty($dist['resource_id']) || empty($dist['resource_version'])) {
      continue;
    }
    if (!in_array($dist['mime_type'] ?? '', DataResource::IMPORTABLE_FILE_TYPES)) {
      continue;
    }

    $resourceId = $dist['resource_id'] . '__' . $dist['resource_version'];

    // Derive a label from the source path filename.
    $label = '';
    if (!empty($dist['source_path'])) {
      $label = basename(parse_url($dist['source_path'], PHP_URL_PATH) ?: $dist['source_path']);
    }

    $preview = [
      '#type' => 'container',
      '#attributes' => ['class' => ['data-preview-distribution']],
    ];
    if ($label) {
      $preview['heading'] = [
        '#type' => 'html_tag',
        '#tag' => 'h3',
        '#value' => t('Preview: @label', ['@label' => $label]),
      ];
    }
    $preview['table'] = [
      '#type' => 'data_preview',
      '#resource_id' => $resourceId,
    ];
    $previews[] = $preview;
  }

  if ($previews) {
    $build['data_preview'] = $previews;
  }
}