vendor/vich/uploader-bundle/src/DependencyInjection/VichUploaderExtension.php line 53

Open in your IDE?
  1. <?php
  3. namespace Vich\UploaderBundle\DependencyInjection;
  5. use Doctrine\Common\Annotations\AnnotationReader;
  6. use Symfony\Component\Config\FileLocator;
  7. use Symfony\Component\DependencyInjection\Alias;
  8. use Symfony\Component\DependencyInjection\ChildDefinition;
  9. use Symfony\Component\DependencyInjection\ContainerBuilder;
  10. use Symfony\Component\DependencyInjection\Definition;
  11. use Symfony\Component\DependencyInjection\Extension\Extension;
  12. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  13. use Symfony\Component\DependencyInjection\Reference;
  14. use Vich\UploaderBundle\Metadata\CacheWarmer;
  15. use Vich\UploaderBundle\Storage\StorageInterface;
  17. /**
  18.  * @author Dustin Dobervich <[email protected]>
  19.  *
  20.  * @internal
  21.  */
  22. final class VichUploaderExtension extends Extension
  23. {
  24.     /**
  25.      * @var array
  26.      */
  27.     protected $tagMap = [
  28.         'orm' => 'doctrine.event_subscriber',
  29.         'mongodb' => 'doctrine_mongodb.odm.event_subscriber',
  30.         'phpcr' => 'doctrine_phpcr.event_subscriber',
  31.     ];
  33.     public function load(array $configs, ContainerBuilder $container): void
  34.     {
  35.         $configuration = new Configuration();
  36.         $config = $this->processConfiguration($configuration, $configs);
  38.         $config = $this->fixDbDriverConfig($config);
  39.         $config = $this->createNamerServices($container, $config);
  41.         // define a few parameters
  42.         $container->setParameter('vich_uploader.default_filename_attribute_suffix', $config['default_filename_attribute_suffix']);
  43.         $container->setParameter('vich_uploader.mappings', $config['mappings']);
  45.         if (0 === \strpos($config['storage'], '@')) {
  46.             $container->setAlias('vich_uploader.storage', \substr($config['storage'], 1));
  47.         } else {
  48.             $container->setAlias('vich_uploader.storage', 'vich_uploader.storage.'.$config['storage']);
  49.         }
  50.         $container->setAlias(StorageInterface::class, new Alias('vich_uploader.storage', false));
  52.         $this->loadServicesFiles($container, $config);
  53.         $this->registerMetadataDirectories($container, $config);
  54.         $this->registerAnnotationStrategy($container, $config);
  55.         $this->registerCacheStrategy($container, $config);
  57.         $this->registerListeners($container, $config);
  59.         $this->registerFormTheme($container);
  60.     }
  62.     protected function loadServicesFiles(ContainerBuilder $container, array $config): void
  63.     {
  64.         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../config'));
  66.         $toLoad = [
  67.             'adapter.xml', 'listener.xml', 'storage.xml', 'injector.xml',
  68.             'mapping.xml', 'factory.xml', 'namer.xml', 'handler.xml', 'command.xml', 'collector.xml',
  69.         ];
  70.         foreach ($toLoad as $file) {
  71.             $loader->load($file);
  72.         }
  74.         if (\in_array($config['storage'], ['gaufrette', 'flysystem'], true)) {
  75.             $loader->load($config['storage'].'.xml');
  76.         }
  78.         if ($config['form']) {
  79.             $loader->load('form.xml');
  80.         }
  82.         if ($config['twig']) {
  83.             $loader->load('twig.xml');
  84.         }
  85.     }
  87.     protected function registerMetadataDirectories(ContainerBuilder $container, array $config): void
  88.     {
  89.         $bundles = $container->getParameter('kernel.bundles');
  91.         // directories
  92.         $directories = [];
  93.         if ($config['metadata']['auto_detection']) {
  94.             $projectDir = $container->getParameter('kernel.project_dir');
  95.             if (\is_string($projectDir)) {
  96.                 $appConfigDirectory = $projectDir.'/config/vich_uploader';
  97.                 if (\is_dir($appConfigDirectory)) {
  98.                     $directories['App'] = $appConfigDirectory;
  99.                 }
  100.             }
  102.             foreach ($bundles as $class) {
  103.                 $ref = new \ReflectionClass($class);
  104.                 $directory = \dirname($ref->getFileName()).'/../config/vich_uploader';
  106.                 if (!\is_dir($directory)) {
  107.                     $directory = \dirname($ref->getFileName()).'/Resources/config/vich_uploader';
  108.                     if (\is_dir($directory)) {
  109.                         @\trigger_error('Using Resources/config/vich_uploader for auto config discovery is deprecated use ../config/vich_uploader, relative to the Bundle class, instead', \E_USER_DEPRECATED);
  110.                     }
  111.                 }
  113.                 if (!\is_dir($directory)) {
  114.                     continue;
  115.                 }
  117.                 $directories[$ref->getNamespaceName()] = $directory;
  118.             }
  119.         }
  121.         foreach ($config['metadata']['directories'] as $directory) {
  122.             $directory['path'] = \rtrim(\str_replace('\\', '/', $directory['path']), '/');
  124.             if ('@' === $directory['path'][0]) {
  125.                 $bundleName = \substr($directory['path'], 1, \strpos($directory['path'], '/') - 1);
  127.                 if (!isset($bundles[$bundleName])) {
  128.                     throw new \RuntimeException(\sprintf('The bundle "%s" has not been registered with Kernel. Available bundles: %s', $bundleName, \implode(', ', \array_keys($bundles))));
  129.                 }
  131.                 $ref = new \ReflectionClass($bundles[$bundleName]);
  132.                 $directory['path'] = \dirname($ref->getFileName()).\substr($directory['path'], \strlen('@'.$bundleName));
  133.             }
  135.             $directories[\rtrim($directory['namespace_prefix'], '\\')] = \rtrim($directory['path'], '\\/');
  136.         }
  138.         $container
  139.             ->getDefinition('vich_uploader.metadata.file_locator')
  140.             ->replaceArgument(0, $directories)
  141.         ;
  142.     }
  144.     protected function registerAnnotationStrategy(ContainerBuilder $container, array $config): void
  145.     {
  146.         if (!$container->has('vich_uploader.metadata_driver.annotation')) {
  147.             return;
  148.         }
  150.         switch ($config['metadata']['type']) {
  151.             case 'attribute':
  152.                 $container->setDefinition(
  153.                     'vich_uploader.metadata.reader',
  154.                     $container->getDefinition('vich_uploader.metadata.attribute_reader')
  155.                 );
  156.                 break;
  157.             default:
  158.                 $container->setDefinition(
  159.                     'vich_uploader.metadata.reader',
  160.                     new Definition(AnnotationReader::class)
  161.                 );
  162.         }
  163.     }
  165.     protected function registerCacheStrategy(ContainerBuilder $container, array $config): void
  166.     {
  167.         if ('none' === $config['metadata']['cache']) {
  168.             $container->removeAlias('vich_uploader.metadata.cache');
  169.         } elseif ('file' === $config['metadata']['cache']) {
  170.             $container
  171.                 ->getDefinition('vich_uploader.metadata.cache.file_cache')
  172.                 ->replaceArgument(0, $config['metadata']['file_cache']['dir'])
  173.             ;
  174.             $container
  175.                 ->getDefinition(CacheWarmer::class)
  176.                 ->replaceArgument(0, $config['metadata']['file_cache']['dir'])
  177.             ;
  179.             $dir = $container->getParameterBag()->resolveValue($config['metadata']['file_cache']['dir']);
  180.             if (!\file_exists($dir) && !@\mkdir($dir, 0777, true)) {
  181.                 throw new \RuntimeException(\sprintf('Could not create cache directory "%s".', $dir));
  182.             }
  183.         } else {
  184.             $container->setAlias('vich_uploader.metadata.cache', new Alias($config['metadata']['cache'], false));
  185.         }
  186.     }
  188.     protected function fixDbDriverConfig(array $config): array
  189.     {
  190.         // mapping with no declared db_driver use the top-level one
  191.         foreach ($config['mappings'] as &$mapping) {
  192.             $mapping['db_driver'] = $mapping['db_driver'] ?: $config['db_driver'];
  193.         }
  195.         return $config;
  196.     }
  198.     protected function registerListeners(ContainerBuilder $container, array $config): void
  199.     {
  200.         $servicesMap = [
  201.             'inject_on_load' => ['name' => 'inject', 'priority' => 0],
  202.             'delete_on_update' => ['name' => 'clean', 'priority' => 50],
  203.             'delete_on_remove' => ['name' => 'remove', 'priority' => 0],
  204.         ];
  206.         foreach ($config['mappings'] as $name => $mapping) {
  207.             $driver = $mapping['db_driver'];
  209.             // create optional listeners
  210.             foreach ($servicesMap as $configOption => $service) {
  211.                 if (!$mapping[$configOption]) {
  212.                     continue;
  213.                 }
  215.                 $this->createListener($container, $name, $service['name'], $driver, $service['priority']);
  216.             }
  218.             // the upload listener is mandatory
  219.             $this->createListener($container, $name, 'upload', $driver);
  220.         }
  221.     }
  223.     protected function createNamerServices(ContainerBuilder $container, array $config): array
  224.     {
  225.         foreach ($config['mappings'] as $name => $mapping) {
  226.             if (!empty($mapping['namer']['service'])) {
  227.                 $config['mappings'][$name] = $this->createNamerService($container, $name, $mapping);
  228.             }
  229.         }
  231.         return $config;
  232.     }
  234.     protected function createNamerService(ContainerBuilder $container, string $mappingName, array $mapping): array
  235.     {
  236.         $serviceId = \sprintf('%s.%s', $mapping['namer']['service'], $mappingName);
  237.         $container->setDefinition($serviceId, new ChildDefinition($mapping['namer']['service']));
  239.         $mapping['namer']['service'] = $serviceId;
  241.         return $mapping;
  242.     }
  244.     protected function createListener(
  245.         ContainerBuilder $container,
  246.         string $name,
  247.         string $type,
  248.         string $driver,
  249.         int $priority = 0
  250.     ): void {
  251.         $definition = $container
  252.             ->setDefinition(\sprintf('vich_uploader.listener.%s.%s', $type, $name), new ChildDefinition(\sprintf('vich_uploader.listener.%s.%s', $type, $driver)))
  253.             ->replaceArgument(0, $name)
  254.             ->replaceArgument(1, new Reference('vich_uploader.adapter.'.$driver));
  256.         if (isset($this->tagMap[$driver])) {
  257.             $definition->addTag($this->tagMap[$driver], ['priority' => $priority]);
  258.         }
  259.     }
  261.     private function registerFormTheme(ContainerBuilder $container): void
  262.     {
  263.         $resources = $container->hasParameter('twig.form.resources') ?
  264.             $container->getParameter('twig.form.resources') : [];
  266.         \array_unshift($resources, '@VichUploader/Form/fields.html.twig');
  267.         $container->setParameter('twig.form.resources', $resources);
  268.     }
  269. }