Skip to content

Commit

Permalink
EZP-32214: Refactored config/packages/overrides/* to load from Extens…
Browse files Browse the repository at this point in the history 
…ion (#27)

* EZP-32214: Refactored config/packages/overrides/* to load from Extension

* EZP-32214: Fixed paths

* EZP-32214: Moved setup configuration to prepend method

* EZP-32214: Moved parameters setup to compiler passes

* EZP-32214: Fixed loading DFS config

* EZP-32214: Added automatically setting server when purge type is
set to fastly

* EZP-32214: Moved parameters setup to prepend
  • Loading branch information
@webhdx
webhdx authored Dec 21, 2020
1 parent b2c3045 commit d72861d
Showing 1 changed file with 299 additions and 5 deletions.
304 changes: 299 additions & 5 deletions src/EzPlatformCoreBundle/bundle/DependencyInjection/EzPlatformCoreExtension.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
namespace EzSystems\EzPlatformCoreBundle\DependencyInjection;

use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
use Symfony\Component\DependencyInjection\Loader;

final class EzPlatformCoreExtension extends Extension implements PrependExtensionInterface
{
Expand All @@ -33,18 +35,310 @@ public function getAlias(): string
return self::EXTENSION_ALIAS;
}

/**
* Prepend "ezplatform" configuration to "ezpublish" configuration.
*
* @todo remove once we replace EzPublishCoreBundle with EzPlatformCoreBundle
*/
public function prepend(ContainerBuilder $container): void
{
$this->configureGenericSetup($container);
$this->configurePlatformShSetup($container);

// inject "ezplatform" extension settings into "ezpublish" extension
// configuration here is zero-based array of configurations from multiple sources
// to be merged by "ezpublish" extension
// @todo remove once we replace EzPublishCoreBundle with EzPlatformCoreBundle
foreach ($container->getExtensionConfig('ezplatform') as $eZPlatformConfig) {
$container->prependExtensionConfig('ezpublish', $eZPlatformConfig);
}
}

private function configureGenericSetup(ContainerBuilder $container): void
{
$projectDir = $container->getParameter('kernel.project_dir');

// One of `legacy` (default) or `solr`
$container->setParameter('search_engine', '%env(SEARCH_ENGINE)%');

// Session save path as used by symfony session handlers (eg. used for dsn with redis)
$container->setParameter('ezplatform.session.save_path', '%kernel.project_dir%/var/sessions/%kernel.environment%');

// Predefined pools are located in config/packages/cache_pool/
// You can add your own cache pool to the folder mentioned above.
// In order to change the default cache_pool use environmental variable export.
// The line below must not be altered as required cache service files are resolved based on environmental config.
$container->setParameter('cache_pool', '%env(CACHE_POOL)%');

// By default cache ttl is set to 24h, when using Varnish you can set a much higher value. High values depends on
// using EzSystemsPlatformHttpCacheBundle (default as of v1.12) which by design expires affected cache on changes
$container->setParameter('httpcache_default_ttl', '%env(HTTPCACHE_DEFAULT_TTL)%');

// Settings for HttpCache
$container->setParameter('purge_server', '%env(HTTPCACHE_PURGE_SERVER)%');

// Identifier used to generate the CSRF token. Commenting this line will result in authentication
// issues both in AdminUI and REST calls
$container->setParameter('ezpublish_rest.csrf_token_intention', 'authenticate');

// Varnish invalidation/purge token (for use on platform.sh, eZ Platform Cloud and other places you can't use IP for ACL)
$container->setParameter('varnish_invalidate_token', '%env(resolve:default::HTTPCACHE_VARNISH_INVALIDATE_TOKEN)%');

// Compile time handlers
// These are defined at compile time, and hence can't be set at runtime using env()
// config/env/generic.php takes care about letting you set them by env variables

// Session handler, by default set to file based (instead of ~) in order to be able to use %ezplatform.session.save_path%
$container->setParameter('ezplatform.session.handler_id', 'session.handler.native_file');

// Purge type used by HttpCache system ("local", "varnish"/"http", and on ee also "fastly")
$container->setParameter('purge_type', '%env(HTTPCACHE_PURGE_TYPE)%');

$container->setParameter('solr_dsn', '%env(SOLR_DSN)%');
$container->setParameter('solr_core', '%env(SOLR_CORE)%');

$projectDir = $container->getParameter('kernel.project_dir');

if ($dfsNfsPath = $_SERVER['DFS_NFS_PATH'] ?? false) {
$container->setParameter('dfs_nfs_path', $dfsNfsPath);

$parameterMap = [
'dfs_database_charset' => 'database_charset',
'dfs_database_driver' => 'database_driver',
'dfs_database_collation' => 'database_collation',
];

foreach ($parameterMap as $dfsParameter => $platformParameter) {
$container->setParameter(
$dfsParameter,
$_SERVER[strtoupper($dfsParameter)] ?? $container->getParameter($platformParameter)
);
}

$loader = new Loader\YamlFileLoader($container, new FileLocator($projectDir . '/config/packages/dfs'));
$loader->load('dfs.yaml');
}

// Cache settings
// If CACHE_POOL env variable is set, check if there is a yml file that needs to be loaded for it
if (($pool = $_SERVER['CACHE_POOL'] ?? false) && file_exists($projectDir . "/config/packages/cache_pool/${pool}.yaml")) {
$loader = new Loader\YamlFileLoader($container, new FileLocator($projectDir . '/config/packages/cache_pool'));
$loader->load($pool . '.yaml');
}

if ($purgeType = $_SERVER['HTTPCACHE_PURGE_TYPE'] ?? false) {
$container->setParameter('purge_type', $purgeType);
$container->setParameter('ezpublish.http_cache.purge_type', $purgeType);
}

if ($value = $_SERVER['MAILER_TRANSPORT'] ?? false) {
$container->setParameter('mailer_transport', $value);
}

if ($value = $_SERVER['LOG_TYPE'] ?? false) {
$container->setParameter('log_type', $value);
}

if ($value = $_SERVER['SESSION_HANDLER_ID'] ?? false) {
$container->setParameter('ezplatform.session.handler_id', $value);
}

if ($value = $_SERVER['SESSION_SAVE_PATH'] ?? false) {
$container->setParameter('ezplatform.session.save_path', $value);
}
}

private function configurePlatformShSetup(ContainerBuilder $container): void
{
$projectDir = $container->getParameter('kernel.project_dir');

// Run for all hooks, incl build step
if ($_SERVER['PLATFORM_PROJECT_ENTROPY'] ?? false) {
// Disable PHPStormPass as we don't have write access & it's not localhost
$container->setParameter('ezdesign.phpstorm.enabled', false);
}

// Will not be executed on build step
$relationships = $_SERVER['PLATFORM_RELATIONSHIPS'] ?? false;
if (!$relationships) {
return;
}
$routes = $_SERVER['PLATFORM_ROUTES'];

$relationships = json_decode(base64_decode($relationships), true);
$routes = json_decode(base64_decode($routes), true);

// PLATFORMSH_DFS_NFS_PATH is different compared to DFS_NFS_PATH in the sense that it is relative to ezplatform dir
// DFS_NFS_PATH is an absolute path
if ($dfsNfsPath = $_SERVER['PLATFORMSH_DFS_NFS_PATH'] ?? false) {
$container->setParameter('dfs_nfs_path', sprintf('%s/%s', $projectDir, $dfsNfsPath));

// Map common parameters
$container->setParameter('dfs_database_charset', $container->getParameter('database_charset'));
$container->setParameter(
'dfs_database_collation',
$container->getParameter('database_collation')
);
if (\array_key_exists('dfs_database', $relationships)) {
// process dedicated P.sh dedicated config
foreach ($relationships['dfs_database'] as $endpoint) {
if (empty($endpoint['query']['is_master'])) {
continue;
}
$container->setParameter('dfs_database_driver', 'pdo_' . $endpoint['scheme']);
$container->setParameter(
'dfs_database_url',
sprintf(
'%s://%s:%s:%d@%s/%s',
$endpoint['scheme'],
$endpoint['username'],
$endpoint['password'],
$endpoint['port'],
$endpoint['host'],
$endpoint['path']
)
);
}
} else {
// or set fallback from the Repository database, if not configured
$container->setParameter('dfs_database_driver', $container->getParameter('database_driver'));
}

$loader = new Loader\YamlFileLoader($container, new FileLocator($projectDir . '/config/packages/dfs'));
$loader->load('dfs.yaml');
}

// Use Redis-based caching if possible.
if (isset($relationships['rediscache'])) {
foreach ($relationships['rediscache'] as $endpoint) {
if ($endpoint['scheme'] !== 'redis') {
continue;
}

$loader = new Loader\YamlFileLoader($container, new FileLocator($projectDir . '/config/packages/cache_pool'));
$loader->load('cache.redis.yaml');

$container->setParameter('cache_pool', 'cache.redis');
$container->setParameter('cache_dsn', sprintf('%s:%d', $endpoint['host'], $endpoint['port']) . '?retry_interval=3');
}
} elseif (isset($relationships['cache'])) {
// Fallback to memcached if here (deprecated, we will only handle redis here in the future)
foreach ($relationships['cache'] as $endpoint) {
if ($endpoint['scheme'] !== 'memcached') {
continue;
}

@trigger_error('Usage of Memcached is deprecated, redis is recommended', E_USER_DEPRECATED);

$container->setParameter('cache_pool', 'cache.memcached');
$container->setParameter('cache_dsn', sprintf('%s:%d', $endpoint['host'], $endpoint['port']));

$loader = new Loader\YamlFileLoader($container, new FileLocator($projectDir . '/config/packages/cache_pool'));
$loader->load('cache.memcached.yaml');
}
}

// Use Redis-based sessions if possible. If a separate Redis instance
// is available, use that. If not, share a Redis instance with the
// Cache. (That should be safe to do except on especially high-traffic sites.)
if (isset($relationships['redissession'])) {
foreach ($relationships['redissession'] as $endpoint) {
if ($endpoint['scheme'] !== 'redis') {
continue;
}

$container->setParameter('ezplatform.session.handler_id', 'ezplatform.core.session.handler.native_redis');
$container->setParameter('ezplatform.session.save_path', sprintf('%s:%d', $endpoint['host'], $endpoint['port']));
}
} elseif (isset($relationships['rediscache'])) {
foreach ($relationships['rediscache'] as $endpoint) {
if ($endpoint['scheme'] !== 'redis') {
continue;
}

$container->setParameter('ezplatform.session.handler_id', 'ezplatform.core.session.handler.native_redis');
$container->setParameter('ezplatform.session.save_path', sprintf('%s:%d', $endpoint['host'], $endpoint['port']));
}
}

if (isset($relationships['solr'])) {
foreach ($relationships['solr'] as $endpoint) {
if ($endpoint['scheme'] !== 'solr') {
continue;
}

$container->setParameter('search_engine', 'solr');

$container->setParameter('solr_dsn', sprintf('http://%s:%d/%s', $endpoint['host'], $endpoint['port'], 'solr'));
// To set solr_core parameter we assume path is in form like: "solr/collection1"
$container->setParameter('solr_core', substr($endpoint['path'], 5));

// Ibexa DXP Commerce needs special treatment due to Solarium use
// @todo Remove this once Commerce is fully rewritten
$bundles = $container->getParameter('kernel.bundles');

if (isset($bundles['SisoSearchBundle'])) {
$container->setParameter('solr_dsn', sprintf('http://%s:%d', $endpoint['host'], $endpoint['port']));
// To set solr_core parameter we assume path is in form like: "solr/collection1"
$container->setParameter('solr_core', substr($endpoint['path'], 5));

$container->setParameter('siso_search.solr.host', $endpoint['host']);
$container->setParameter('siso_search.solr.port', $endpoint['port']);
$container->setParameter('siso_search.solr.core', $endpoint['rel']);
}
}
}

if (isset($relationships['elasticsearch'])) {
foreach ($relationships['elasticsearch'] as $endpoint) {
$dsn = sprintf('%s:%d', $endpoint['host'], $endpoint['port']);

if ($endpoint['username'] !== null && $endpoint['password'] !== null) {
$dsn = $endpoint['username'] . ':' . $endpoint['password'] . '@' . $dsn;
}

if ($endpoint['path'] !== null) {
$dsn .= '/' . $endpoint['path'];
}

$dsn = $endpoint['scheme'] . '://' . $dsn;

$container->setParameter('search_engine', 'elasticsearch');
$container->setParameter('elasticsearch_dsn', $dsn);
}
}

// We will pick a varnish route by the following prioritization:
// - The first route found that has upstream: varnish
// - if primary route has upstream: varnish, that route will be prioritised
// If no route is found with upstream: varnish, then purge_server will not be set
$route = null;
foreach ($routes as $host => $info) {
if ($route === null && $info['type'] === 'upstream' && $info['upstream'] === 'varnish') {
$route = $host;
}
if ($info['type'] === 'upstream' && $info['upstream'] === 'varnish' && $info['primary'] === true) {
$route = $host;
break;
}
}

if ($route !== null) {
$purgeServer = rtrim($route, '/');
if (($_SERVER['HTTPCACHE_USERNAME'] ?? false) && ($_SERVER['HTTPCACHE_PASSWORD'] ?? false)) {
$domain = parse_url($purgeServer, PHP_URL_HOST);
$credentials = urlencode($_SERVER['HTTPCACHE_USERNAME']) . ':' . urlencode($_SERVER['HTTPCACHE_PASSWORD']);
$purgeServer = str_replace($domain, $credentials . '@' . $domain, $purgeServer);
}

$container->setParameter('ezpublish.http_cache.purge_type', 'varnish');
$container->setParameter('purge_type', 'varnish');
$container->setParameter('purge_server', $purgeServer);
}
// Setting default value for HTTPCACHE_VARNISH_INVALIDATE_TOKEN if it is not explicitly set
if (!($_SERVER['HTTPCACHE_VARNISH_INVALIDATE_TOKEN'] ?? false)) {
$container->setParameter('varnish_invalidate_token', $_SERVER['PLATFORM_PROJECT_ENTROPY']);
}

// Adapt config based on enabled PHP extensions
// Get imagine to use imagick if enabled, to avoid using php memory for image conversions
if (\extension_loaded('imagick')) {
$container->setParameter('liip_imagine_driver', 'imagick');
}
}
}

0 comments on commit d72861d

Please sign in to comment.