AcquiaDrupalEnvironmentDetector.php

<?php

namespace Acquia\DrupalEnvironmentDetector;

/**
 * Detect various properties of the current Acquia environment.
 */
class AcquiaDrupalEnvironmentDetector {

  /**
   * Is AH env.
   */
  public static function isAhEnv(): bool {
    return (bool) self::getAhEnv();
  }

  /**
   * Check if this is an ACSF env.
   *
   * Roughly duplicates the detection logic implemented by the ACSF module.
   *
   * @param string|null $ah_group
   *   The Acquia Hosting site / group name (e.g. my_subscription).
   * @param string|null $ah_env
   *   The Acquia Hosting environment name (e.g. 01dev).
   *
   * @return bool
   *   TRUE if this is an ACSF environment, FALSE otherwise.
   *
   * @see https://git.drupalcode.org/project/acsf/blob/8.x-2.62/acsf_init/lib/sites/default/acsf.settings.php#L14
   */
  public static function isAcsfEnv(string $ah_group = NULL, string $ah_env = NULL): bool {
    if (is_null($ah_group)) {
      $ah_group = self::getAhGroup();
    }

    if (is_null($ah_env)) {
      $ah_env = self::getAhEnv();
    }

    if (empty($ah_group) || empty($ah_env)) {
      return FALSE;
    }

    return file_exists(FilePaths::acsfSitesJson($ah_group, $ah_env));
  }

  /**
   * Is this a prod environment on Acquia hosting.
   *
   * @param string|null $ah_env
   *   Environment machine name.
   *
   * @return bool
   *   TRUE if prod, FALSE otherwise.
   */
  public static function isAhProdEnv(string $ah_env = NULL): bool {
    if (is_null($ah_env)) {
      $ah_env = self::getAhEnv();
    }
    return EnvironmentNames::isAhProdEnv($ah_env);
  }

  /**
   * Is this a stage environment on Acquia hosting.
   *
   * @param string|null $ah_env
   *   Environment machine name.
   *
   * @return bool
   *   TRUE if 'stage', FALSE otherwise.
   */
  public static function isAhStageEnv(string $ah_env = NULL): bool {
    if (is_null($ah_env)) {
      $ah_env = self::getAhEnv();
    }
    return EnvironmentNames::isAhStageEnv($ah_env);
  }

  /**
   * Is this a dev environment on Acquia hosting.
   *
   * @param string|null $ah_env
   *   Environment machine name.
   *
   * @return bool
   *   TRUE if dev, FALSE otherwise.
   */
  public static function isAhDevEnv(string $ah_env = NULL): bool {
    if (is_null($ah_env)) {
      $ah_env = self::getAhEnv();
    }
    return EnvironmentNames::isAhDevEnv($ah_env);
  }

  /**
   * Is AH ODE.
   *
   * @param string|null $ah_env
   *   Environment machine name.
   *
   * @return bool
   *   TRUE if ODE, FALSE otherwise.
   */
  public static function isAhOdeEnv(string $ah_env = NULL): bool {
    if (is_null($ah_env)) {
      $ah_env = self::getAhEnv();
    }
    return EnvironmentNames::isAhOdeEnv($ah_env);
  }

  /**
   * Is AH IDE.
   *
   * @param string|null $ah_env
   *   Environment machine name.
   *
   * @return bool
   *   TRUE if IDE, FALSE otherwise.
   */
  public static function isAhIdeEnv(string $ah_env = NULL): bool {
    if (is_null($ah_env)) {
      $ah_env = self::getAhEnv();
    }
    return EnvironmentNames::isAhIdeEnv($ah_env);
  }

  /**
   * Is AH devcloud.
   *
   * The devcloud realm includes Acquia Cloud Professional (ACP).
   */
  public static function isAhDevCloud(): bool {
    return self::getAhRealm() === 'devcloud';
  }

  /**
   * Get Acquia hosting site group.
   *
   * @return string
   *   Site group (usually a customer name).
   */
  public static function getAhGroup(): string {
    return getenv('AH_SITE_GROUP');
  }

  /**
   * Get Acquia hosting environment.
   *
   * @return string
   *   Environment name (typically dev, test, or prod).
   *
   * @see https://docs.acquia.com/cloud-platform/develop/env-variable/#available-environment-variables
   */
  public static function getAhEnv(): string {
    return getenv('AH_SITE_ENVIRONMENT');
  }

  /**
   * Get Acquia hosting realm.
   *
   * @return string
   *   Realm name (e.g. prod, gardens).
   *
   * @see https://docs.acquia.com/cloud-platform/develop/env-variable/#available-environment-variables
   */
  public static function getAhRealm(): string {
    return getenv('AH_REALM');
  }

  /**
   * Get AH non production.
   */
  public static function getAhNonProduction(): string {
    return getenv('AH_NON_PRODUCTION');
  }

  /**
   * Get AH application UUID.
   */
  public static function getAhApplicationUuid(): string {
    return getenv('AH_APPLICATION_UUID');
  }

  /**
   * The path to the persistent file storage mount.
   *
   * It is used to store Drupal public and private files, but is only a common
   * base path and not tied to any particular site or type of file.
   *
   * @see https://docs.acquia.com/acquia-cloud/manage/files/about/
   */
  public static function getAhFilesRoot(): string {
    return FilePaths::ahFilesRoot(self::getAhGroup(), self::getAhEnv());
  }

  /**
   * Get ACSF db.
   *
   * @return string|null
   *   ACSF db name.
   */
  public static function getAcsfDbName(): ?string {
    // phpcs:disable
    // note that ACSF uses $GLOBALS and despite coding standards we must maintain this logic.
    return isset($GLOBALS['gardens_site_settings']) && self::isAcsfEnv() ? $GLOBALS['gardens_site_settings']['conf']['acsf_db_name'] : NULL;
    // phpcs:enable
  }

  /**
   * Get a standardized site / db name.
   *
   * On ACE or simple multisite installs, this is the site directory under
   * 'docroot/sites'.
   *
   * On ACSF, this is the ACSF db name.
   *
   * @param string $site_path
   *   Directory site path.
   *
   * @return string|null
   *   Site name.
   */
  public static function getSiteName(string $site_path): ?string {
    if (self::isAcsfEnv()) {
      return self::getAcsfDbName();
    }

    return str_replace('sites/', '', $site_path);
  }

  /**
   * Is this a Lando environment using the Acquia recipe.
   */
  public static function isAcquiaLandoEnv(): bool {
    return getenv('AH_SITE_ENVIRONMENT') === 'LANDO';
  }

  /**
   * Is this a Lando environment.
   */
  public static function isLandoEnv(): bool {
    return getenv('LANDO') === 'ON';
  }

  /**
   * Get Lando info.
   */
  public static function getLandoInfo(): string {
    return getenv('LANDO_INFO');
  }

  /**
   * If this isn't a Cloud environment, assume it's local.
   */
  public static function isLocalEnv(): bool {
    return !self::isAhEnv() || self::isAcquiaLandoEnv();
  }

  /**
   * Is this a Code Studio environment.
   */
  public static function isCodeStudioEnv(): bool {
    $gitlab_job_id = getenv('CI_JOB_ID');
    $gitlab_token = getenv('ACQUIA_GLAB_TOKEN_NAME');
    return (bool) (!empty($gitlab_job_id) && !empty($gitlab_token));
  }

}