Harvester.php

Go to the documentation of this file.

<?php
 
namespace Drupal\dkan_harvest;
 
use Harvest\Harvester as DkanHarvester;
use Contracts\BulkRetrieverInterface;
use Contracts\FactoryInterface;
use Contracts\StorerInterface;
use Harvest\ETL\Factory;
 
class Harvester {
 
  private $storeFactory;
 
  public function __construct(FactoryInterface $storeFactory) {
    $this->storeFactory = $storeFactory;
  }
 
  public function getAllHarvestIds() {
    $store = $this->storeFactory->getInstance("harvest_plans");
 
    if ($store instanceof BulkRetrieverInterface) {
      return $store->retrieveAll();
    }
    throw new \Exception("The store created by {get_class($this->storeFactory)} does not implement {BulkRetrieverInterface::class}");
  }
 
  public function getHarvestPlan($plan_id) {
    $store = $this->storeFactory->getInstance("harvest_plans");
 
    if ($store instanceof BulkRetrieverInterface) {
      return $store->retrieve($plan_id);
    }
    throw new \Exception("The store created by {get_class($this->storeFactory)} does not implement {RetrieverInterface::class}");
  }
 
  public function registerHarvest($plan) {
 
    $this->validateHarvestPlan($plan);
 
    $store = $this->storeFactory->getInstance("harvest_plans");
 
    if ($store instanceof StorerInterface) {
      return $store->store(json_encode($plan), $plan->identifier);
    }
    throw new \Exception("The store created by {get_class($this->storeFactory)} does not implement {StorerInterface::class}");
  }
 
  public function deregisterHarvest(string $id) {
    $this->revertHarvest($id);
 
    $plan_store = $this->storeFactory->getInstance("harvest_plans");
 
    return $plan_store->remove($id);
  }
 
  public function revertHarvest($id) {
    $run_store = $this->storeFactory->getInstance("harvest_{$id}_runs");
    if (!method_exists($run_store, "destroy")) {
      throw new \Exception("Storage of class " . get_class($run_store) . " does not implement destroy method.");
    }
    $run_store->destroy();
    $harvester = $this->getHarvester($id);
    return $harvester->revert();
  }
 
  public function runHarvest($id) {
    $harvester = $this->getHarvester($id);
 
    $result = $harvester->harvest();
 
    $run_store = $this->storeFactory->getInstance("harvest_{$id}_runs");
    $current_time = time();
    $run_store->store(json_encode($result), "{$current_time}");
 
    return $result;
  }
 
  public function getHarvestRunInfo($id, $runId) {
    $allRuns = $this->getAllHarvestRunInfo($id);
    $found = array_search($runId, $allRuns);
 
    if ($found !== FALSE) {
      $run_store = $this->storeFactory->getInstance("harvest_{$id}_runs");
      return $run_store->retrieve($runId);
    }
 
    return FALSE;
  }
 
  public function getAllHarvestRunInfo($id) {
    $run_store = $this->storeFactory->getInstance("harvest_{$id}_runs");
    $runs = $run_store->retrieveAll();
    return $runs;
  }
 
  public function validateHarvestPlan($plan) {
    return Factory::validateHarvestPlan($plan);
  }
 
  private function getHarvester($id) {
    $plan_store = $this->storeFactory->getInstance("harvest_plans");
    $harvestPlan = json_decode($plan_store->retrieve($id));
    $item_store = $this->storeFactory->getInstance("harvest_{$id}_items");
    $hash_store = $this->storeFactory->getInstance("harvest_{$id}_hashes");
    return $this->getDkanHarvesterInstance($harvestPlan, $item_store, $hash_store);
  }
 
  protected function getDkanHarvesterInstance($harvestPlan, $item_store, $hash_store) {
    return new DkanHarvester(new Factory($harvestPlan, $item_store, $hash_store));
  }
 
}