f521c11097
* 2.8: fixed undefined variable Fixed the phpDoc of UserInterface fixed APCu dep version make apc class loader testable against apcu without apc bc layer Added support for the `0.0.0.0/0` trusted proxy fixed CS [DoctrineBridge][Validator] >= 2.3 Pass association instead of ID as argument Limit the max height/width of icons in the profiler menu added missing constant Added 451 status code Remove unnecessary code Allow absolute URLs to be displayed in the debug toolbar [ClassLoader] Use symfony/polyfill-apcu update upgrade files with CSRF related option info [TranslationUpdateCommand] fixed undefined resultMessage var. [HttpKernel] Lookup the response even if the lock was released after 2 seconds
551 lines
22 KiB
PHP
551 lines
22 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Bundle\FrameworkBundle\DependencyInjection;
|
|
|
|
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
|
|
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
|
|
use Symfony\Component\Config\Definition\ConfigurationInterface;
|
|
|
|
/**
|
|
* FrameworkExtension configuration structure.
|
|
*
|
|
* @author Jeremy Mikola <jmikola@gmail.com>
|
|
*/
|
|
class Configuration implements ConfigurationInterface
|
|
{
|
|
private $debug;
|
|
|
|
/**
|
|
* @param bool $debug Whether debugging is enabled or not
|
|
*/
|
|
public function __construct($debug)
|
|
{
|
|
$this->debug = (bool) $debug;
|
|
}
|
|
|
|
/**
|
|
* Generates the configuration tree builder.
|
|
*
|
|
* @return TreeBuilder The tree builder
|
|
*/
|
|
public function getConfigTreeBuilder()
|
|
{
|
|
$treeBuilder = new TreeBuilder();
|
|
$rootNode = $treeBuilder->root('framework');
|
|
|
|
$rootNode
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return !isset($v['assets']) && isset($v['templating']); })
|
|
->then(function ($v) {
|
|
$v['assets'] = array();
|
|
|
|
return $v;
|
|
})
|
|
->end()
|
|
->children()
|
|
->scalarNode('secret')->end()
|
|
->scalarNode('http_method_override')
|
|
->info("Set true to enable support for the '_method' request parameter to determine the intended HTTP method on POST requests. Note: When using the HttpCache, you need to call the method in your front controller instead")
|
|
->defaultTrue()
|
|
->end()
|
|
->arrayNode('trusted_proxies')
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return !is_array($v) && null !== $v; })
|
|
->then(function ($v) { return is_bool($v) ? array() : preg_split('/\s*,\s*/', $v); })
|
|
->end()
|
|
->prototype('scalar')
|
|
->validate()
|
|
->ifTrue(function ($v) {
|
|
if (empty($v)) {
|
|
return false;
|
|
}
|
|
|
|
if (false !== strpos($v, '/')) {
|
|
if ('0.0.0.0/0' === $v) {
|
|
return false;
|
|
}
|
|
|
|
list($v, $mask) = explode('/', $v, 2);
|
|
|
|
if (strcmp($mask, (int) $mask) || $mask < 1 || $mask > (false !== strpos($v, ':') ? 128 : 32)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return !filter_var($v, FILTER_VALIDATE_IP);
|
|
})
|
|
->thenInvalid('Invalid proxy IP "%s"')
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->scalarNode('ide')->defaultNull()->end()
|
|
->booleanNode('test')->end()
|
|
->scalarNode('default_locale')->defaultValue('en')->end()
|
|
->arrayNode('trusted_hosts')
|
|
->beforeNormalization()->ifString()->then(function ($v) { return array($v); })->end()
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
|
|
$this->addCsrfSection($rootNode);
|
|
$this->addFormSection($rootNode);
|
|
$this->addEsiSection($rootNode);
|
|
$this->addSsiSection($rootNode);
|
|
$this->addFragmentsSection($rootNode);
|
|
$this->addProfilerSection($rootNode);
|
|
$this->addRouterSection($rootNode);
|
|
$this->addSessionSection($rootNode);
|
|
$this->addRequestSection($rootNode);
|
|
$this->addTemplatingSection($rootNode);
|
|
$this->addAssetsSection($rootNode);
|
|
$this->addTranslatorSection($rootNode);
|
|
$this->addValidationSection($rootNode);
|
|
$this->addAnnotationsSection($rootNode);
|
|
$this->addSerializerSection($rootNode);
|
|
$this->addPropertyAccessSection($rootNode);
|
|
$this->addPropertyInfoSection($rootNode);
|
|
|
|
return $treeBuilder;
|
|
}
|
|
|
|
private function addCsrfSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('csrf_protection')
|
|
->canBeEnabled()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addFormSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('form')
|
|
->info('form configuration')
|
|
->canBeEnabled()
|
|
->children()
|
|
->arrayNode('csrf_protection')
|
|
->treatFalseLike(array('enabled' => false))
|
|
->treatTrueLike(array('enabled' => true))
|
|
->treatNullLike(array('enabled' => true))
|
|
->addDefaultsIfNotSet()
|
|
->children()
|
|
->booleanNode('enabled')->defaultNull()->end() // defaults to framework.csrf_protection.enabled
|
|
->scalarNode('field_name')->defaultValue('_token')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addEsiSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('esi')
|
|
->info('esi configuration')
|
|
->canBeEnabled()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addSsiSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('ssi')
|
|
->info('ssi configuration')
|
|
->canBeEnabled()
|
|
->end()
|
|
->end();
|
|
}
|
|
|
|
private function addFragmentsSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('fragments')
|
|
->info('fragments configuration')
|
|
->canBeEnabled()
|
|
->children()
|
|
->scalarNode('path')->defaultValue('/_fragment')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addProfilerSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('profiler')
|
|
->info('profiler configuration')
|
|
->canBeEnabled()
|
|
->children()
|
|
->booleanNode('collect')->defaultTrue()->end()
|
|
->booleanNode('only_exceptions')->defaultFalse()->end()
|
|
->booleanNode('only_master_requests')->defaultFalse()->end()
|
|
->scalarNode('dsn')->defaultValue('file:%kernel.cache_dir%/profiler')->end()
|
|
->arrayNode('matcher')
|
|
->canBeUnset()
|
|
->performNoDeepMerging()
|
|
->fixXmlConfig('ip')
|
|
->children()
|
|
->scalarNode('path')
|
|
->info('use the urldecoded format')
|
|
->example('^/path to resource/')
|
|
->end()
|
|
->scalarNode('service')->end()
|
|
->arrayNode('ips')
|
|
->beforeNormalization()->ifString()->then(function ($v) { return array($v); })->end()
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addRouterSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('router')
|
|
->info('router configuration')
|
|
->canBeUnset()
|
|
->children()
|
|
->scalarNode('resource')->isRequired()->end()
|
|
->scalarNode('type')->end()
|
|
->scalarNode('http_port')->defaultValue(80)->end()
|
|
->scalarNode('https_port')->defaultValue(443)->end()
|
|
->scalarNode('strict_requirements')
|
|
->info(
|
|
"set to true to throw an exception when a parameter does not match the requirements\n".
|
|
"set to false to disable exceptions when a parameter does not match the requirements (and return null instead)\n".
|
|
"set to null to disable parameter checks against requirements\n".
|
|
"'true' is the preferred configuration in development mode, while 'false' or 'null' might be preferred in production"
|
|
)
|
|
->defaultTrue()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addSessionSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('session')
|
|
->info('session configuration')
|
|
->canBeUnset()
|
|
->children()
|
|
->scalarNode('storage_id')->defaultValue('session.storage.native')->end()
|
|
->scalarNode('handler_id')->defaultValue('session.handler.native_file')->end()
|
|
->scalarNode('name')->end()
|
|
->scalarNode('cookie_lifetime')->end()
|
|
->scalarNode('cookie_path')->end()
|
|
->scalarNode('cookie_domain')->end()
|
|
->booleanNode('cookie_secure')->end()
|
|
->booleanNode('cookie_httponly')->defaultTrue()->end()
|
|
->booleanNode('use_cookies')->end()
|
|
->scalarNode('gc_divisor')->end()
|
|
->scalarNode('gc_probability')->defaultValue(1)->end()
|
|
->scalarNode('gc_maxlifetime')->end()
|
|
->scalarNode('save_path')->defaultValue('%kernel.cache_dir%/sessions')->end()
|
|
->integerNode('metadata_update_threshold')
|
|
->defaultValue('0')
|
|
->info('seconds to wait between 2 session metadata updates, it will also prevent the session handler to write if the session has not changed')
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addRequestSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('request')
|
|
->info('request configuration')
|
|
->canBeUnset()
|
|
->fixXmlConfig('format')
|
|
->children()
|
|
->arrayNode('formats')
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return is_array($v) && isset($v['mime_type']); })
|
|
->then(function ($v) { return $v['mime_type']; })
|
|
->end()
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return !is_array($v); })
|
|
->then(function ($v) { return array($v); })
|
|
->end()
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addTemplatingSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('templating')
|
|
->info('templating configuration')
|
|
->canBeUnset()
|
|
->children()
|
|
->scalarNode('hinclude_default_template')->defaultNull()->end()
|
|
->scalarNode('cache')->end()
|
|
->arrayNode('form')
|
|
->addDefaultsIfNotSet()
|
|
->fixXmlConfig('resource')
|
|
->children()
|
|
->arrayNode('resources')
|
|
->addDefaultChildrenIfNoneSet()
|
|
->prototype('scalar')->defaultValue('FrameworkBundle:Form')->end()
|
|
->validate()
|
|
->ifTrue(function ($v) {return !in_array('FrameworkBundle:Form', $v); })
|
|
->then(function ($v) {
|
|
return array_merge(array('FrameworkBundle:Form'), $v);
|
|
})
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->fixXmlConfig('engine')
|
|
->children()
|
|
->arrayNode('engines')
|
|
->example(array('twig'))
|
|
->isRequired()
|
|
->requiresAtLeastOneElement()
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return !is_array($v); })
|
|
->then(function ($v) { return array($v); })
|
|
->end()
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->fixXmlConfig('loader')
|
|
->children()
|
|
->arrayNode('loaders')
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return !is_array($v); })
|
|
->then(function ($v) { return array($v); })
|
|
->end()
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addAssetsSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('assets')
|
|
->info('assets configuration')
|
|
->canBeUnset()
|
|
->fixXmlConfig('base_url')
|
|
->children()
|
|
->scalarNode('version')->defaultNull()->end()
|
|
->scalarNode('version_format')->defaultValue('%%s?%%s')->end()
|
|
->scalarNode('base_path')->defaultValue('')->end()
|
|
->arrayNode('base_urls')
|
|
->requiresAtLeastOneElement()
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return !is_array($v); })
|
|
->then(function ($v) { return array($v); })
|
|
->end()
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->fixXmlConfig('package')
|
|
->children()
|
|
->arrayNode('packages')
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
->fixXmlConfig('base_url')
|
|
->children()
|
|
->scalarNode('version')
|
|
->defaultNull()
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return '' === $v; })
|
|
->then(function ($v) { return; })
|
|
->end()
|
|
->end()
|
|
->scalarNode('version_format')->defaultNull()->end()
|
|
->scalarNode('base_path')->defaultValue('')->end()
|
|
->arrayNode('base_urls')
|
|
->requiresAtLeastOneElement()
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return !is_array($v); })
|
|
->then(function ($v) { return array($v); })
|
|
->end()
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addTranslatorSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('translator')
|
|
->info('translator configuration')
|
|
->canBeEnabled()
|
|
->fixXmlConfig('fallback')
|
|
->fixXmlConfig('path')
|
|
->children()
|
|
->arrayNode('fallbacks')
|
|
->beforeNormalization()->ifString()->then(function ($v) { return array($v); })->end()
|
|
->prototype('scalar')->end()
|
|
->defaultValue(array('en'))
|
|
->end()
|
|
->booleanNode('logging')->defaultValue($this->debug)->end()
|
|
->arrayNode('paths')
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addValidationSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('validation')
|
|
->info('validation configuration')
|
|
->canBeEnabled()
|
|
->children()
|
|
->scalarNode('cache')
|
|
->beforeNormalization()
|
|
// Can be removed in 3.0, once ApcCache support is dropped
|
|
->ifString()->then(function ($v) {
|
|
if ('apc' === $v) {
|
|
@trigger_error('The ability to pass "apc" as the framework.validation.cache configuration key value is deprecated since version 2.8 and will be removed in 3.0. Use the "validator.mapping.cache.doctrine.apc" service id instead.', E_USER_DEPRECATED);
|
|
|
|
return 'validator.mapping.cache.apc';
|
|
}
|
|
|
|
return $v;
|
|
})
|
|
->end()
|
|
->end()
|
|
->booleanNode('enable_annotations')->defaultFalse()->end()
|
|
->arrayNode('static_method')
|
|
->defaultValue(array('loadValidatorMetadata'))
|
|
->prototype('scalar')->end()
|
|
->treatFalseLike(array())
|
|
->validate()
|
|
->ifTrue(function ($v) { return !is_array($v); })
|
|
->then(function ($v) { return (array) $v; })
|
|
->end()
|
|
->end()
|
|
->scalarNode('translation_domain')->defaultValue('validators')->end()
|
|
->booleanNode('strict_email')->defaultFalse()->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addAnnotationsSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('annotations')
|
|
->info('annotation configuration')
|
|
->addDefaultsIfNotSet()
|
|
->children()
|
|
->scalarNode('cache')->defaultValue('file')->end()
|
|
->scalarNode('file_cache_dir')->defaultValue('%kernel.cache_dir%/annotations')->end()
|
|
->booleanNode('debug')->defaultValue('%kernel.debug%')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addSerializerSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('serializer')
|
|
->info('serializer configuration')
|
|
->canBeEnabled()
|
|
->children()
|
|
->booleanNode('enable_annotations')->defaultFalse()->end()
|
|
->scalarNode('cache')->end()
|
|
->scalarNode('name_converter')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addPropertyAccessSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('property_access')
|
|
->addDefaultsIfNotSet()
|
|
->info('Property access configuration')
|
|
->children()
|
|
->booleanNode('magic_call')->defaultFalse()->end()
|
|
->booleanNode('throw_exception_on_invalid_index')->defaultFalse()->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
private function addPropertyInfoSection(ArrayNodeDefinition $rootNode)
|
|
{
|
|
$rootNode
|
|
->children()
|
|
->arrayNode('property_info')
|
|
->info('Property info configuration')
|
|
->canBeEnabled()
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
}
|