/
Configuration.php
301 lines (275 loc) · 13 KB
/
Configuration.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<?php
/*
* This file is part of the `liip/LiipImagineBundle` project.
*
* (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
*
* For the full copyright and license information, please view the LICENSE.md
* file that was distributed with this source code.
*/
namespace Liip\ImagineBundle\DependencyInjection;
use Liip\ImagineBundle\Config\Controller\ControllerConfig;
use Liip\ImagineBundle\Controller\ImagineController;
use Liip\ImagineBundle\DependencyInjection\Factory\FactoryInterface;
use Liip\ImagineBundle\DependencyInjection\Factory\Loader\LoaderFactoryInterface;
use Liip\ImagineBundle\DependencyInjection\Factory\Resolver\ResolverFactoryInterface;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
class Configuration implements ConfigurationInterface
{
/**
* @var ResolverFactoryInterface[]
*/
protected $resolversFactories;
/**
* @var LoaderFactoryInterface[]
*/
protected $loadersFactories;
/**
* @param ResolverFactoryInterface[] $resolversFactories
* @param LoaderFactoryInterface[] $loadersFactories
*/
public function __construct(array $resolversFactories, array $loadersFactories)
{
$this->resolversFactories = $resolversFactories;
$this->loadersFactories = $loadersFactories;
}
public function getConfigTreeBuilder(): TreeBuilder
{
$treeBuilder = new TreeBuilder('liip_imagine');
$rootNode = method_exists(TreeBuilder::class, 'getRootNode')
? $treeBuilder->getRootNode()
: $treeBuilder->root('liip_imagine');
$resolversPrototypeNode = $rootNode
->children()
->arrayNode('resolvers')
->useAttributeAsKey('name')
->prototype('array')
->performNoDeepMerging();
$this->addResolversSections($resolversPrototypeNode);
$loadersPrototypeNode = $rootNode
->children()
->arrayNode('loaders')
->useAttributeAsKey('name')
->prototype('array');
$this->addLoadersSections($loadersPrototypeNode);
$rootNode
->beforeNormalization()
->ifTrue(function ($v) {
return
empty($v['loaders'])
|| empty($v['loaders']['default'])
|| empty($v['resolvers'])
|| empty($v['resolvers']['default']);
})
->then(function ($v) {
if (empty($v['loaders'])) {
$v['loaders'] = [];
}
if (false === \is_array($v['loaders'])) {
throw new \LogicException('Loaders has to be array');
}
if (false === \array_key_exists('default', $v['loaders'])) {
$v['loaders']['default'] = ['filesystem' => null];
}
if (empty($v['resolvers'])) {
$v['resolvers'] = [];
}
if (false === \is_array($v['resolvers'])) {
throw new \LogicException('Resolvers has to be array');
}
if (false === \array_key_exists('default', $v['resolvers'])) {
$v['resolvers']['default'] = ['web_path' => null];
}
return $v;
})
->end();
$rootNode
->fixXmlConfig('filter_set', 'filter_sets')
->children()
->scalarNode('driver')->defaultValue('gd')
->validate()
->ifTrue(function ($v) {
return !\in_array($v, ['gd', 'imagick', 'gmagick', 'vips'], true);
})
->thenInvalid('Invalid imagine driver specified: %s')
->end()
->end()
->scalarNode('cache')->defaultValue('default')->end()
->scalarNode('cache_base_path')->defaultValue('')->end()
->scalarNode('data_loader')->defaultValue('default')->end()
->scalarNode('default_image')->defaultNull()->end()
->arrayNode('default_filter_set_settings')
->addDefaultsIfNotSet()
->children()
->scalarNode('quality')->defaultValue(100)->end()
->scalarNode('jpeg_quality')->defaultNull()->end()
->scalarNode('png_compression_level')->defaultNull()->end()
->scalarNode('png_compression_filter')->defaultNull()->end()
->scalarNode('format')->defaultNull()->end()
->booleanNode('animated')->defaultFalse()->end()
->scalarNode('cache')->defaultNull()->end()
->scalarNode('data_loader')->defaultNull()->end()
->scalarNode('default_image')->defaultNull()->end()
->arrayNode('filters')
->useAttributeAsKey('name')
->prototype('array')
->useAttributeAsKey('name')
->ignoreExtraKeys(false)
->prototype('variable')->end()
->end()
->end()
->arrayNode('post_processors')
->defaultValue([])
->useAttributeAsKey('name')
->prototype('array')
->useAttributeAsKey('name')
->ignoreExtraKeys(false)
->prototype('variable')->end()
->end()
->end()
->end()
->end()
->arrayNode('controller')
->addDefaultsIfNotSet()
->children()
->scalarNode('filter_action')->defaultValue(sprintf('%s::filterAction', ImagineController::class))->end()
->scalarNode('filter_runtime_action')->defaultValue(sprintf('%s::filterRuntimeAction', ImagineController::class))->end()
->integerNode('redirect_response_code')->defaultValue(302)
->validate()
->ifTrue(function ($redirectResponseCode) {
return !\in_array($redirectResponseCode, ControllerConfig::REDIRECT_RESPONSE_CODES, true);
})
->thenInvalid('Invalid redirect response code "%s" (must be 201, 301, 302, 303, 307, or 308).')
->end()
->end()
->end()
->end()
->arrayNode('filter_sets')
->useAttributeAsKey('name')
->prototype('array')
->fixXmlConfig('filter', 'filters')
->children()
->scalarNode('quality')->end()
->scalarNode('jpeg_quality')->end()
->scalarNode('png_compression_level')->end()
->scalarNode('png_compression_filter')->end()
->scalarNode('format')->end()
->booleanNode('animated')->end()
->scalarNode('cache')->end()
->scalarNode('data_loader')->end()
->scalarNode('default_image')->end()
->arrayNode('filters')
->useAttributeAsKey('name')
->prototype('array')
->useAttributeAsKey('name')
->ignoreExtraKeys(false)
->prototype('variable')->end()
->end()
->end()
->arrayNode('post_processors')
->defaultValue([])
->useAttributeAsKey('name')
->prototype('array')
->useAttributeAsKey('name')
->ignoreExtraKeys(false)
->prototype('variable')->end()
->end()
->end()
->end()
->end()
->end()
->arrayNode('twig')
->addDefaultsIfNotSet()
->children()
->enumNode('mode')
->defaultValue('legacy')
->info('Twig mode: none/lazy/legacy (default)')
->values(['none', 'lazy', 'legacy'])
->validate()
->ifTrue(function ($v) {
return 'legacy' === $v;
})
->then(function ($v) {
@trigger_error('Twig "legacy" mode has been deprecated and will be removed in 3.0. Use "none" or "lazy".', E_USER_DEPRECATED);
return $v;
})
->end()
->end()
->scalarNode('assets_version')->defaultNull()->end()
->end()
->end()
->booleanNode('enqueue')
->defaultFalse()
->info('Enables integration with enqueue if set true. Allows resolve image caches in background by sending messages to MQ.')
->end()
->arrayNode('messenger')
->canBeEnabled()
->info('Enables integration with symfony/messenger if set true. Warmup image caches in background by sending messages to MQ.')
->end()
->booleanNode('templating')
->defaultTrue()
->info('Enables integration with symfony/templating component')
->validate()
->ifTrue()
->then(function ($v) {
@trigger_error('Symfony templating integration has been deprecated since LiipImagineBundle 2.2 and will be removed in 3.0. Use Twig and use "false" as "liip_imagine.templating" value instead.', E_USER_DEPRECATED);
return $v;
})
->end()
->end()
->end();
$rootNode
->children()
->arrayNode('webp')
->addDefaultsIfNotSet()
->children()
->booleanNode('generate')->defaultFalse()->end()
->integerNode('quality')->defaultValue(100)->end()
->scalarNode('cache')->defaultNull()->end()
->scalarNode('data_loader')->defaultNull()->end()
->arrayNode('post_processors')
->defaultValue([])
->useAttributeAsKey('name')
->prototype('array')
->useAttributeAsKey('name')
->ignoreExtraKeys(false)
->prototype('variable')->end()
->end()
->end()
->end()
->end();
return $treeBuilder;
}
private function addResolversSections(ArrayNodeDefinition $resolversPrototypeNode)
{
$this->addConfigurationSections($this->resolversFactories, $resolversPrototypeNode, 'resolver');
}
private function addLoadersSections(ArrayNodeDefinition $resolversPrototypeNode)
{
$this->addConfigurationSections($this->loadersFactories, $resolversPrototypeNode, 'loader');
}
/**
* @param FactoryInterface[] $factories
*/
private function addConfigurationSections(array $factories, ArrayNodeDefinition $definition, $type)
{
foreach ($factories as $f) {
$f->addConfiguration($definition->children()->arrayNode($f->getName()));
}
$definition->end()
->validate()
->ifTrue(function ($array) use ($type) {
foreach ($array as $name => $element) {
if (!$element) {
throw new InvalidConfigurationException(ucfirst($type).' "'.$name.'" must have a factory configured');
}
}
return false;
})
->thenInvalid('Each '.$type.' must have a factory configured')
->end();
}
}