Runtime.php in Acquia Search 3.x

Namespace

Drupal\acquia_search\Helper

File

src/Helper/Runtime.php

<?php

namespace Drupal\acquia_search\Helper;

use Drupal\acquia_search\AcquiaSearchApiClient;
use Drupal\acquia_search\PreferredSearchCore;
use Drupal\Core\Database\Database;
use Drupal\search_api\Entity\Server;

/**
 * Class Runtime.
 *
 * Contains various helpers.
 */
class Runtime {

  /**
   * Preferred search core service.
   *
   * @var \Drupal\acquia_search\PreferredSearchCore
   */
  protected static $preferredSearchCoreService;

  /**
   * Return the name of the Acquia "DB Role".
   *
   * Acquia "DB Role" is in use when running inside an Acquia environment.
   *
   * @param array $options
   *   Current connection options.
   * @param array $connection_info
   *   ALl databases list.
   *
   * @return string
   *   Database role.
   */
  public static function getAhDatabaseRole(array $options, array $connection_info) : string {
    $ah_db_name = $options['database'];

    // Scan all the available Databases and look for the currently-used DB name.
    foreach ($connection_info as $db_role => $db_array) {

      // Ignore the "default" connection, because even though it may match the
      // currently-used DB connection, this entry always exists and its key
      // won't match the AH "DB Role".
      if ($db_role == 'default') {
        continue;
      }
      if ($db_array['default']['database'] == $ah_db_name) {

        // In database role naming, we only accept alphanumeric chars.
        $pattern = '/[^a-zA-Z0-9_]+/';
        $db_role = preg_replace($pattern, '', $db_role);
        return $db_role;
      }
    }
    return '';
  }

  /**
   * Instantiates the PreferredSearchCore class.
   *
   * Helps to determines which search core should be used and whether it is
   * available within the subscription.
   *
   * @return \Drupal\acquia_search\PreferredSearchCore
   *   Preferred search core service.
   */
  public static function getPreferredSearchCoreService() : PreferredSearchCore {
    if (self::$preferredSearchCoreService) {
      return self::$preferredSearchCoreService;
    }
    $ah_env = $_ENV['AH_SITE_ENVIRONMENT'] ?? '';
    $ah_site_name = $_ENV['AH_SITE_NAME'] ?? '';
    $ah_site_group = $_ENV['AH_SITE_GROUP'] ?? '';
    $conf_path = \Drupal::service('site.path');
    $sites_folder_name = substr($conf_path, strrpos($conf_path, '/') + 1);
    $ah_db_role = '';
    if ($ah_env && $ah_site_name && $ah_site_group) {
      $options = Database::getConnection()
        ->getConnectionOptions();
      $connection_info = Database::getAllConnectionInfo();
      $ah_db_role = Runtime::getAhDatabaseRole($options, $connection_info);
    }
    if (!($available_cores = Runtime::getAcquiaSearchApiClient(Storage::getUuid())
      ->getSearchIndexes(Storage::getIdentifier()))) {
      $available_cores = [];
    }
    return new PreferredSearchCore(Storage::getIdentifier(), $ah_env, $sites_folder_name, $ah_db_role, $available_cores);
  }

  /**
   * Determine if we should enforce read-only mode.
   *
   * @return bool
   *   TRUE if we should enforce read-only mode.
   */
  public static function shouldEnforceReadOnlyMode() : bool {
    $read_only = FALSE;

    // Check if the read-only mode is forced in configuration.
    if (Storage::isReadOnly()) {
      $read_only = TRUE;
    }
    \Drupal::moduleHandler()
      ->alter('acquia_search_should_enforce_read_only', $read_only);
    return $read_only;
  }

  /**
   * Initializes and returns an instance of AcquiaSearchApiClient.
   *
   * @param string $application_uuid
   *   Acquia application UUID.
   *
   * @return \Drupal\acquia_search\AcquiaSearchApiClient
   *   Acquia Search API Client.
   */
  public static function getAcquiaSearchApiClient(string $application_uuid = NULL) : AcquiaSearchApiClient {
    if (!$application_uuid) {
      $application_uuid = Storage::getUuid();
    }
    $drupal_http_client = \Drupal::service('http_client');
    $cache = \Drupal::cache();
    $auth_info = [
      'host' => Storage::getApiHost(),
      'app_uuid' => $application_uuid,
      'key' => Storage::getApiKey(),
    ];
    return new AcquiaSearchApiClient($auth_info, $drupal_http_client, $cache);
  }

  /**
   * Determine whether given server belongs to an Acquia search server.
   *
   * @param \Drupal\search_api\Entity\Server $server
   *   A search server configuration entity.
   *
   * @return bool
   *   TRUE if given server config belongs to an Acquia search server.
   */
  public static function isAcquiaServer(Server $server) : bool {
    $backend_config = $server
      ->getBackendConfig();
    return !empty($backend_config['connector']) && $backend_config['connector'] === 'solr_acquia_connector';
  }

}

Classes

Name	Description
Runtime	Class Runtime.