Exception
11 months ago
Configuration.php
11 months ago
ConfigurationInterface.php
11 months ago
ConfigurationProvider.php
11 months ago
ConfigurationProvider.php
176 lines
| 1 | <?php |
| 2 | namespace Aws\S3\UseArnRegion; |
| 3 | |
| 4 | use Aws\AbstractConfigurationProvider; |
| 5 | use Aws\CacheInterface; |
| 6 | use Aws\ConfigurationProviderInterface; |
| 7 | use Aws\S3\UseArnRegion\Exception\ConfigurationException; |
| 8 | use GuzzleHttp\Promise; |
| 9 | |
| 10 | /** |
| 11 | * A configuration provider is a function that returns a promise that is |
| 12 | * fulfilled with a {@see \Aws\S3\UseArnRegion\ConfigurationInterface} |
| 13 | * or rejected with an {@see \Aws\S3\UseArnRegion\Exception\ConfigurationException}. |
| 14 | * |
| 15 | * <code> |
| 16 | * use Aws\S3\UseArnRegion\ConfigurationProvider; |
| 17 | * $provider = ConfigurationProvider::defaultProvider(); |
| 18 | * // Returns a ConfigurationInterface or throws. |
| 19 | * $config = $provider()->wait(); |
| 20 | * </code> |
| 21 | * |
| 22 | * Configuration providers can be composed to create configuration using |
| 23 | * conditional logic that can create different configurations in different |
| 24 | * environments. You can compose multiple providers into a single provider using |
| 25 | * {@see Aws\S3\UseArnRegion\ConfigurationProvider::chain}. This function |
| 26 | * accepts providers as variadic arguments and returns a new function that will |
| 27 | * invoke each provider until a successful configuration is returned. |
| 28 | * |
| 29 | * <code> |
| 30 | * // First try an INI file at this location. |
| 31 | * $a = ConfigurationProvider::ini(null, '/path/to/file.ini'); |
| 32 | * // Then try an INI file at this location. |
| 33 | * $b = ConfigurationProvider::ini(null, '/path/to/other-file.ini'); |
| 34 | * // Then try loading from environment variables. |
| 35 | * $c = ConfigurationProvider::env(); |
| 36 | * // Combine the three providers together. |
| 37 | * $composed = ConfigurationProvider::chain($a, $b, $c); |
| 38 | * // Returns a promise that is fulfilled with a configuration or throws. |
| 39 | * $promise = $composed(); |
| 40 | * // Wait on the configuration to resolve. |
| 41 | * $config = $promise->wait(); |
| 42 | * </code> |
| 43 | */ |
| 44 | class ConfigurationProvider extends AbstractConfigurationProvider |
| 45 | implements ConfigurationProviderInterface |
| 46 | { |
| 47 | const ENV_USE_ARN_REGION = 'AWS_S3_USE_ARN_REGION'; |
| 48 | const INI_USE_ARN_REGION = 's3_use_arn_region'; |
| 49 | const DEFAULT_USE_ARN_REGION = true; |
| 50 | |
| 51 | public static $cacheKey = 'aws_s3_use_arn_region_config'; |
| 52 | |
| 53 | protected static $interfaceClass = ConfigurationInterface::class; |
| 54 | protected static $exceptionClass = ConfigurationException::class; |
| 55 | |
| 56 | /** |
| 57 | * Create a default config provider that first checks for environment |
| 58 | * variables, then checks for a specified profile in the environment-defined |
| 59 | * config file location (env variable is 'AWS_CONFIG_FILE', file location |
| 60 | * defaults to ~/.aws/config), then checks for the "default" profile in the |
| 61 | * environment-defined config file location, and failing those uses a default |
| 62 | * fallback set of configuration options. |
| 63 | * |
| 64 | * This provider is automatically wrapped in a memoize function that caches |
| 65 | * previously provided config options. |
| 66 | * |
| 67 | * @param array $config |
| 68 | * |
| 69 | * @return callable |
| 70 | */ |
| 71 | public static function defaultProvider(array $config = []) |
| 72 | { |
| 73 | $configProviders = [self::env()]; |
| 74 | if ( |
| 75 | !isset($config['use_aws_shared_config_files']) |
| 76 | || $config['use_aws_shared_config_files'] != false |
| 77 | ) { |
| 78 | $configProviders[] = self::ini(); |
| 79 | } |
| 80 | $configProviders[] = self::fallback(); |
| 81 | |
| 82 | $memo = self::memoize( |
| 83 | call_user_func_array([ConfigurationProvider::class, 'chain'], $configProviders) |
| 84 | ); |
| 85 | |
| 86 | if (isset($config['use_arn_region']) |
| 87 | && $config['use_arn_region'] instanceof CacheInterface |
| 88 | ) { |
| 89 | return self::cache($memo, $config['use_arn_region'], self::$cacheKey); |
| 90 | } |
| 91 | |
| 92 | return $memo; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Provider that creates config from environment variables. |
| 97 | * |
| 98 | * @return callable |
| 99 | */ |
| 100 | public static function env() |
| 101 | { |
| 102 | return function () { |
| 103 | // Use config from environment variables, if available |
| 104 | $useArnRegion = getenv(self::ENV_USE_ARN_REGION); |
| 105 | if (!empty($useArnRegion)) { |
| 106 | return Promise\Create::promiseFor( |
| 107 | new Configuration($useArnRegion) |
| 108 | ); |
| 109 | } |
| 110 | |
| 111 | return self::reject('Could not find environment variable config' |
| 112 | . ' in ' . self::ENV_USE_ARN_REGION); |
| 113 | }; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Config provider that creates config using a config file whose location |
| 118 | * is specified by an environment variable 'AWS_CONFIG_FILE', defaulting to |
| 119 | * ~/.aws/config if not specified |
| 120 | * |
| 121 | * @param string|null $profile Profile to use. If not specified will use |
| 122 | * the "default" profile. |
| 123 | * @param string|null $filename If provided, uses a custom filename rather |
| 124 | * than looking in the default directory. |
| 125 | * |
| 126 | * @return callable |
| 127 | */ |
| 128 | public static function ini($profile = null, $filename = null) |
| 129 | { |
| 130 | $filename = $filename ?: (self::getDefaultConfigFilename()); |
| 131 | $profile = $profile ?: (getenv(self::ENV_PROFILE) ?: 'default'); |
| 132 | |
| 133 | return function () use ($profile, $filename) { |
| 134 | if (!@is_readable($filename)) { |
| 135 | return self::reject("Cannot read configuration from $filename"); |
| 136 | } |
| 137 | |
| 138 | // Use INI_SCANNER_NORMAL instead of INI_SCANNER_TYPED for PHP 5.5 compatibility |
| 139 | $data = \Aws\parse_ini_file($filename, true, INI_SCANNER_NORMAL); |
| 140 | if ($data === false) { |
| 141 | return self::reject("Invalid config file: $filename"); |
| 142 | } |
| 143 | if (!isset($data[$profile])) { |
| 144 | return self::reject("'$profile' not found in config file"); |
| 145 | } |
| 146 | if (!isset($data[$profile][self::INI_USE_ARN_REGION])) { |
| 147 | return self::reject("Required S3 Use Arn Region config values |
| 148 | not present in INI profile '{$profile}' ({$filename})"); |
| 149 | } |
| 150 | |
| 151 | // INI_SCANNER_NORMAL parses false-y values as an empty string |
| 152 | if ($data[$profile][self::INI_USE_ARN_REGION] === "") { |
| 153 | $data[$profile][self::INI_USE_ARN_REGION] = false; |
| 154 | } |
| 155 | |
| 156 | return Promise\Create::promiseFor( |
| 157 | new Configuration($data[$profile][self::INI_USE_ARN_REGION]) |
| 158 | ); |
| 159 | }; |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Fallback config options when other sources are not set. |
| 164 | * |
| 165 | * @return callable |
| 166 | */ |
| 167 | public static function fallback() |
| 168 | { |
| 169 | return function () { |
| 170 | return Promise\Create::promiseFor( |
| 171 | new Configuration(self::DEFAULT_USE_ARN_REGION) |
| 172 | ); |
| 173 | }; |
| 174 | } |
| 175 | } |
| 176 |