archivesspace-8.x-1.x-dev/src/Plugin/migrate/source/ArchivesSpaceSource.php

src/Plugin/migrate/source/ArchivesSpaceSource.php
archivesspace
<?php

namespace Drupal\archivesspace\Plugin\migrate\source;

use Drupal\archivesspace\ArchivesSpaceIterator;
use Drupal\archivesspace\ArchivesSpaceSession;
use Drupal\Core\Site\Settings;
use Drupal\migrate\Plugin\migrate\source\SourcePluginBase;
use Drupal\migrate\Plugin\MigrationInterface;

/**
 * Source plugin for retrieving data from ArchivesSpace.
 *
 * @MigrateSource(
 *   id = "archivesspace"
 * )
 */
class ArchivesSpaceSource extends SourcePluginBase {

  /**
   * ArchivesSpace Session object.
   *
   * @var Drupal\archivesspace\ArchivesSpaceSession
   */
  protected $session;

  /**
   * Object type we are currently migrating.
   *
   * @var string
   */
  protected $objectType;

  /**
   * Last updated timestamp (ISO 8601).
   *
   * @var string
   */
  protected $lastUpdate;

  /**
   * ArchivesSpace object types available.
   *
   * @var array
   */
  protected $objectTypes = [
    'repositories',
    'resources',
    'archival_objects',
    'digital_objects',
    'agents/people',
    'agents/corporate_entities',
    'agents/families',
    'subjects',
    'classifications',
  ];

  /**
   * The fields for this source.
   *
   * @var array
   */
  protected $fields = [];

  /**
   * The ArchivesSpace repository we are migrating.
   *
   * @var string
   */
  protected $repository = '';

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration) {

    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);

    $this->objectType = $configuration['object_type'];

    switch ($this->objectType) {
      case 'resources':
        $this->fields = [
          'uri' => $this->t('URI'),
          'title' => $this->t('Title'),
          'repository' => $this->t('Repository'),
          'dates' => $this->t('Dates'),
          'classifications' => $this->t('Classifications'),
          'deaccessions' => $this->t('Deaccessions'),
          'ead_id' => $this->t('EAD ID'),
          'ead_location' => $this->t('EAD Location'),
          'extents' => $this->t('Extents'),
          'external_documents' => $this->t('External Documents'),
          'finding_aid_author' => $this->t('Finding Aid Author'),
          'finding_aid_date' => $this->t('Finding Aid Date'),
          'finding_aid_description_rules' => $this->t('Description Rules'),
          'finding_aid_filing_title' => $this->t('Filing Title'),
          'finding_aid_language' => $this->t('Finding Aid Language'),
          'finding_aid_status' => $this->t('Finding Aid Status'),
          'finding_aid_title' => $this->t('Finding Aid Title'),
          'id_0' => $this->t('ID Position 0'),
          'id_1' => $this->t('ID Position 1'),
          'id_2' => $this->t('ID Position 2'),
          'id_3' => $this->t('ID Position 3'),
          'language' => $this->t('Language Code'),
          'level' => $this->t('Level'),
          'linked_agents' => $this->t('Linked Agents'),
          'notes' => $this->t('Notes'),
          'publish' => $this->t('Publish'),
          'resource_type' => $this->t('Resource Type'),
          'restrictions' => $this->t('Restrictions'),
          'subjects' => $this->t('Subjects'),
          'suppressed' => $this->t('Suppressed'),
          'user_mtime' => $this->t('User Modified Time'),
        ];
        break;

      case 'archival_objects':
        $this->fields = [
          'ancestors' => $this->t('Ancestors'),
          'component_id' => $this->t('Component Unique Identifier'),
          'dates' => $this->t('Dates'),
          'display_string' => $this->t('Display String'),
          'extents' => $this->t('Extents'),
          'external_documents' => $this->t('External Documents'),
          'has_unpublished_ancestor' => $this->t('Has Unpublished Ancestor'),
          'instances' => $this->t('Instances'),
          'level' => $this->t('Level'),
          'linked_agents' => $this->t('Linked Agents'),
          'parent' => $this->t('Parent Object'),
          'position' => $this->t('Position (weight)'),
          'publish' => $this->t('Publish'),
          'ref_id' => $this->t('Reference Identifier'),
          'repository' => $this->t('Repository URI'),
          'resource' => $this->t('Resource URI'),
          'restrictions_apply' => $this->t('Restrictions Apply'),
          'rights_statements' => $this->t('Rights Statements'),
          'subjects' => $this->t('Subjects'),
          'suppressed' => $this->t('Suppressed'),
          'title' => $this->t('Title'),
          'uri' => $this->t('URI'),
          'user_mtime' => $this->t('User Modified Time'),
        ];
        break;

      case 'agents/people':
      case 'agents/families':
        // The only field person and family has that corp doesn't is publish,
        // but we don't use it anyway, so all agent cases use the same fieldset.
      case 'agents/corporate_entities':
        $this->fields = [
          'dates_of_existence' => $this->t('Dates of Existence'),
          'display_name' => $this->t('Display Name'),
          'is_linked_to_published_record' => $this->t('Is Linked to a Published Record'),
          'linked_agent_roles' => $this->t('Linked Agent Roles'),
          'names' => $this->t('Names'),
          'notes' => $this->t('Notes'),
          'related_agents' => $this->t('Related Agents'),
          'title' => $this->t('Title'),
          'agent_type' => $this->t('Agent Type'),
          'uri' => $this->t('URI'),
        ];
        break;

      case 'subject':
        $this->fields = [
          'uri' => $this->t('URI'),
          'authority_id' => $this->t('Authority ID'),
          'source' => $this->t('Authority Source'),
          'title' => $this->t('Title'),
          'external_ids' => $this->t('External IDs'),
          'terms' => $this->t('Terms'),
          'is_linked_to_published_record' => $this->t('Is Linked to a Published Record'),
        ];
        break;

      case 'repositories':
        $this->fields = [
          'uri' => $this->t('URI'),
          'name' => $this->t('Name'),
          'repo_code' => $this->t('Repository Code'),
          'publish' => $this->t('Publish?'),
          'agent_representation' => $this->t('Agent Representation'),
        ];
        break;

      case 'top_containers':
        $this->fields = [
          'indicator' => $this->t('Indicator'),
          'type' => $this->t('Type'),
          'collection' => $this->t('Collection'),
          'uri' => $this->t('URI'),
          'restricted' => $this->t('Restricted'),
          'is_linked_to_published_record' => $this->t('Is Linked to a Published Record'),
          'display_string' => $this->t('Display String'),
          'long_display_string' => $this->t('Long Display String'),
          'repository' => $this->t('Repository'),
        ];

      case 'digital_objects':
        $this->fields = [
          'dates' => $this->t('Dates'),
          'digital_object_id' => $this->t('Component Unique Identifier'),
          'extents' => $this->t('Extents'),
          'external_ids' => $this->t('External IDs'),
          'file_versions' => $this->t('File Versions'),
          'linked_agents' => $this->t('Linked Agents'),
          'linked_events' => $this->t('Linked Events'),
          'linked_instances' => $this->t('Linked Events'),
          'notes' => $this->t('Notes'),
          'publish' => $this->t('Publish'),
          'repository' => $this->t('Repository URI'),
          'restrictions' => $this->t('Restrictions'),
          'rights_statements' => $this->t('Rights Statements'),
          'subjects' => $this->t('Subjects'),
          'suppressed' => $this->t('Suppressed'),
          'title' => $this->t('Title'),
          'uri' => $this->t('URI'),
        ];
        break;

      case 'classifications':
        $this->fields = [
          'uri' => $this->t('URI'),
          'identifier' => $this->t('Identifier'),
          'description' => $this->t('Description'),
          'title' => $this->t('Title'),
          'creator' => $this->t('Creator'),
          'publish' => $this->t('Publish'),
          'repository' => $this->t('Repository URI'),
        ];
        break;

      case 'classification_terms':
        $this->fields = [
          'uri' => $this->t('URI'),
          'identifier' => $this->t('Identifier'),
          'description' => $this->t('Description'),
          'title' => $this->t('Title'),
          'creator' => $this->t('Creator'),
          'classification' => $this->t('Classification'),
          'parent' => $this->t('Parent'),
          'publish' => $this->t('Publish'),
          'repository' => $this->t('Repository URI'),
          'position' => $this->t('Position'),
        ];
        break;

      default:
        break;
    }

    if (isset($configuration['last_updated'])) {
      $this->lastUpdate = \DateTime::createFromFormat('Y-m-d\TH:i:s\Z', $configuration['last_updated']);
    }
    else {
      $this->lastUpdate = new \DateTime();
      $this->lastUpdate->setTimestamp(0);
    }

    if (isset($configuration['repository'])) {
      if (is_int($configuration['repository'])) {
        $this->repository = '/repositories/' . $configuration['repository'];
      }
      elseif (preg_match('#^/repositories/[0-9]+$#', $configuration['repository'])) {
        $this->repository = $configuration['repository'];
      }
    }

    // Create the session
    // Send migration config auth options to the Session object.
    if (isset($configuration['base_uri']) ||
        isset($configuration['api_path']) ||
        isset($configuration['username']) ||
        isset($configuration['password'])) {
      // Get Config Settings.
      $base_uri = ($configuration['base_uri'] ?? '');
      $api_path = ($configuration['api_path'] ?? '');
      $username = ($configuration['username'] ?? '');
      $password = ($configuration['password'] ?? '');

      // If the base_uri or api_path are set in Drupal Settings, use that.
      if (Settings::get('archivespace.base_uri')) {
        $base_uri = Settings::get('archivespace.base_uri');
      }
      if (Settings::get('archivespace.api_path')) {
        $api_path = Settings::get('archivespace.api_path');
      }

      $this->session = ArchivesSpaceSession::withConnectionInfo(
          $base_uri, $api_path, $username, $password
        );

      // No login info provided by the migration config.
    }
    else {
      $this->session = new ArchivesSpaceSession();
    }

  }

  /**
   * Initializes the iterator with the source data.
   *
   * @return \Iterator
   *   An iterator containing the data for this source.
   */
  protected function initializeIterator() {

    return new ArchivesSpaceIterator($this->objectType, $this->session, $this->repository);

  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids = [
      'uri' => [
        'type' => 'string',
      ],
    ];
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return $this->fields;
  }

  /**
   * {@inheritdoc}
   */
  public function __toString() {
    return "ArchivesSpace data";
  }

}

Главная | Обратная связь

drupal hosting | друпал хостинг | it patrol .inc