WebServiceApiDocs.php

Go to the documentation of this file.

<?php
 
namespace Drupal\dkan_metastore;
 
use Drupal\dkan_common\DataModifierPluginTrait;
use Drupal\dkan_common\Plugin\DataModifierManager;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\dkan_common\JsonResponseTrait;
use Drupal\dkan_data\Reference\Dereferencer;
use Drupal\dkan_api\Controller\Docs;
 
class WebServiceApiDocs implements ContainerInjectionInterface {
  use JsonResponseTrait;
  use DataModifierPluginTrait;
 
  private $endpointsToKeep = [
    'metastore/schemas/dataset/items/{identifier}' => ['get'],
    'datastore/sql' => ['get'],
  ];
 
  private $docsController;
 
  private $metastoreService;
 
  public static function create(ContainerInterface $container) {
    return new WebServiceApiDocs(
      $container->get("dkan_api.docs"),
      $container->get("dkan_metastore.service"),
      $container->get('plugin.manager.dkan_common.data_modifier')
    );
  }
 
  public function __construct(Docs $docsController, Service $metastoreService, DataModifierManager $pluginManager) {
    $this->docsController = $docsController;
    $this->metastoreService = $metastoreService;
    $this->pluginManager = $pluginManager;
 
    $this->plugins = $this->discover();
  }
 
  public function getDatasetSpecific(string $identifier) {
    $fullSpec = $this->docsController->getJsonFromYmlFile();
 
    // Remove the security schemes.
    unset($fullSpec['components']['securitySchemes']);
 
    // Tags can be added later when needed, remove them for now.
    $fullSpec['tags'] = [];
 
    $pathsAndOperations = $fullSpec['paths'];
    $pathsAndOperations = $this->keepDatasetSpecificEndpoints($pathsAndOperations);
    $pathsAndOperations = $this->modifyDatasetEndpoints($pathsAndOperations, $identifier);
    $pathsAndOperations = $this->modifySqlEndpoints($pathsAndOperations, $identifier, $fullSpec['components']['parameters']);
 
    $fullSpec['paths'] = $pathsAndOperations;
    return $this->getResponse($fullSpec);
  }
 
  private function keepDatasetSpecificEndpoints(array $pathsAndOperations) {
    $keepPaths = array_keys($this->endpointsToKeep);
 
    $paths = array_keys($pathsAndOperations);
 
    $pathsToKeepPaths = array_combine($paths, array_map(function ($path) use ($keepPaths) {
      foreach ($keepPaths as $keepPath) {
        if (substr_count($path, $keepPath) > 0 && substr_count($path, $keepPath . "/") == 0) {
          return $keepPath;
        }
      }
      return NULL;
    }, $paths));
 
    foreach ($pathsAndOperations as $path => $operations) {
      if (is_null($pathsToKeepPaths[$path])) {
        unset($pathsAndOperations[$path]);
      }
      else {
        $pathsAndOperations[$path] = array_filter($operations, function ($operation) use ($path, $pathsToKeepPaths) {
          return in_array($operation, $this->endpointsToKeep[$pathsToKeepPaths[$path]]);
        }, ARRAY_FILTER_USE_KEY);
      }
    }
 
    return $pathsAndOperations;
  }
 
  private function modifyDatasetEndpoints(array $pathsAndOperations, string $identifier) {
 
    foreach ($pathsAndOperations as $path => $operations) {
      $newPath = $path;
      $newOperations = $operations;
      unset($pathsAndOperations[$path]);
      [$newPath, $newOperations] = $this->modifyDatasetEndpoint($newPath, $newOperations, $identifier);
      $pathsAndOperations[$newPath] = $newOperations;
    }
 
    return $pathsAndOperations;
  }
 
  private function modifyDatasetEndpoint($path, $operations, $identifier) {
    $newOperations = $this->getModifyDatasetEndpointNewOperations($operations, $identifier);
 
    if (!isset($newOperations)) {
      return [$path, $operations];
    }
 
    $newPath = str_replace("{identifier}", $identifier, $path);;
 
    return [$newPath, $newOperations];
  }
 
  private function getModifyDatasetEndpointNewOperations($operations, $identifier) {
    $modified = FALSE;
    foreach ($operations as $operation => $info) {
      $newParameters = $this->getModifyDatasetEndpointNewParameters($info['parameters'], $identifier);
      if ($newParameters) {
        $operations[$operation]['parameters'] = $newParameters;
        $modified = TRUE;
      }
    }
 
    return ($modified) ? $operations : NULL;
  }
 
  private function getModifyDatasetEndpointNewParameters(array $parameters, $identifier): ?array {
    $modified = FALSE;
    foreach ($parameters as $key => $parameter) {
      if (isset($parameter['name']) && $parameter['name'] == "identifier" && isset($parameter['example'])) {
        $parameters[$key]['example'] = $identifier;
        $modified = TRUE;
      }
    }
    return ($modified) ? $parameters : NULL;
  }
 
  private function modifySqlEndpoints(array $pathsAndOperations, string $identifier, array $parameters) {
    if ($this->modifyData($identifier)) {
      return $this->removeSqlEndpointPaths($pathsAndOperations);
    }
 
    $query = $parameters['query'];
 
    foreach ($this->getSqlPathsAndOperations($pathsAndOperations) as $path => $operations) {
 
      foreach ($this->getDistributions($identifier) as $dist) {
        list($newPath, $newOperations) = $this->modifySqlEndpoint($path, $operations, $dist, $query);
        $pathsAndOperations[$newPath] = $newOperations;
      }
 
      unset($pathsAndOperations[$path]);
    }
 
    return $pathsAndOperations;
  }
 
  private function getSqlPathsAndOperations($pathsAndOperations) {
    foreach ($pathsAndOperations as $path => $operations) {
      if (substr_count($path, 'sql') == 0) {
        unset($pathsAndOperations[$path]);
      }
    }
    return $pathsAndOperations;
  }
 
  private function removeSqlEndpointPaths($pathsAndOperations) {
    foreach ($pathsAndOperations as $path => $operations) {
      if (substr_count($path, 'sql') > 0) {
 
        unset($pathsAndOperations[$path]);
      }
    }
    return $pathsAndOperations;
  }
 
  private function modifySqlEndpoint($path, $operations, $distribution, $query) {
    $newPath = "{$path}?query=[SELECT * FROM {$distribution->identifier}];";
 
    $query['example'] = "[SELECT * FROM {$distribution->identifier}];";
    $operations['get']['parameters'] = [$query];
 
    return [$newPath, $operations];
  }
 
  private function modifyData(string $identifier) {
    foreach ($this->plugins as $plugin) {
      if ($plugin->requiresModification('distribution', $identifier)) {
        return TRUE;
      }
    }
    return FALSE;
  }
 
  private function getDistributions(string $identifier) {
    // Load this dataset's metadata with both data and identifiers.
    if (function_exists('drupal_static')) {
      drupal_static('dkan_data_dereference_method', Dereferencer::DEREFERENCE_OUTPUT_REFERENCE_IDS);
    }
 
    $data = json_decode($this->metastoreService->get("dataset", $identifier));
 
    // Create and customize a path for each dataset distribution/resource.
    if (isset($data->distribution)) {
      return $data->distribution;
    }
    return [];
  }
 
}