sync.install

<?php

/**
 * @file
 * Contains install and update functions for sync.
 */

use Drupal\Core\Database\Database;

/**
 * Implements hook_schema().
 *
 * Defines the database tables used by this module.
 *
 * @see hook_schema()
 *
 * @ingroup sync
 */
function sync_schema() {
  $schema['sync'] = [
    'description' => 'Stores synced entities.',
    'fields' => [
      'id' => [
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => 0,
        'description' => "The sync id.",
      ],
      'entity_type' => [
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The entity type.',
      ],
      'entity_id' => [
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => "The entity id.",
      ],
      'locked' => [
        'description' => 'Boolean indicating whether the entity is locked and should not be synced.',
        'type' => 'int',
        'not null' => FALSE,
        'default' => 0,
        'size' => 'tiny',
      ],
    ],
    'primary key' => ['id', 'entity_type'],
    'indexes' => [
      'entity_type' => ['entity_type'],
      'entity_id' => ['entity_id'],
    ],
  ];
  $schema['sync_data'] = [
    'description' => 'Stores sync data.',
    'fields' => [
      'id' => [
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => 0,
        'description' => "The sync id.",
      ],
      'segment' => [
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The sync group',
      ],
      'changed' => [
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Unix timestamp of when the entity was last updated',
      ],
      'hash' => [
        'type' => 'varchar_ascii',
        'length' => 64,
        'not null' => FALSE,
        'default' => NULL,
        'description' => 'Fingerprint of the source record at the last successful sync. NULL means unknown, which always processes the record.',
      ],
    ],
    'primary key' => ['id', 'segment'],
  ];
  return $schema;
}

/**
 * Convert entity_id column to varchar to support config entity ids.
 */
function sync_update_8001() {
  $schema = Database::getConnection()->schema();
  $schema->changeField('sync', 'entity_id', 'entity_id', [
    'type' => 'varchar_ascii',
    'length' => 255,
    'not null' => TRUE,
    'default' => '',
    'description' => "The entity id.",
  ]);
}

/**
 * Rename group field to segment if necessary.
 */
function sync_update_8002() {
  $database = Database::getConnection();
  $sql = "SHOW COLUMNS FROM `sync_data` LIKE 'group';";
  if ($database->query($sql)->fetchAssoc()) {
    $database->schema()->changeField('sync_data', 'group', 'segment', [
      'type' => 'varchar_ascii',
      'length' => 255,
      'not null' => TRUE,
      'default' => '',
      'description' => 'The sync group',
    ], []);
  }
}

/**
 * Set the default queue cron time on existing sites.
 */
function sync_update_8003() {
  // Do nothing. The default value for queue_cron_time is now hardcoded to 30
  // seconds, so there is no need to set it on existing sites.
}

/**
 * Remove the queue_cron_time setting now that the value is hardcoded.
 */
function sync_update_8004() {
  \Drupal::configFactory()->getEditable('sync.settings')
    ->clear('queue_cron_time')
    ->save();
}

/**
 * Add the change-detection hash column to sync_data.
 */
function sync_update_8005() {
  $schema = Database::getConnection()->schema();
  if (!$schema->fieldExists('sync_data', 'hash')) {
    $schema->addField('sync_data', 'hash', [
      'type' => 'varchar_ascii',
      'length' => 64,
      'not null' => FALSE,
      'default' => NULL,
      'description' => 'Fingerprint of the source record at the last successful sync. NULL means unknown, which always processes the record.',
    ]);
  }
}

/**
 * Add the settings that control what cron does with syncs.
 */
function sync_update_8006() {
  $config = \Drupal::configFactory()->getEditable('sync.settings');
  // Seed with the values that reproduce the previously hardcoded behavior.
  foreach (['cron_build' => TRUE, 'cron_queue' => TRUE, 'cron_queue_time' => 30] as $key => $value) {
    if ($config->get($key) === NULL) {
      $config->set($key, $value);
    }
  }
  // An earlier iteration of this update used queue_cron/queue_cron_time. Carry
  // those values over and drop them so both namings cannot drift apart.
  foreach (['queue_cron' => 'cron_queue', 'queue_cron_time' => 'cron_queue_time'] as $old => $new) {
    if ($config->get($old) !== NULL) {
      $config->set($new, $config->get($old))->clear($old);
    }
  }
  $config->save();
  \Drupal::service('plugin.manager.queue_worker')->clearCachedDefinitions();
}

/**
 * Add the setting that switches entity locking.
 */
function sync_update_8007() {
  $config = \Drupal::configFactory()->getEditable('sync.settings');
  if ($config->get('lock_enabled') === NULL) {
    // Off by default. Existing sites see no new UI until they opt in.
    $config->set('lock_enabled', FALSE)->save();
  }
}