ArchiverManager.php

<?php

namespace Drupal\Core\Archiver;

use Drupal\Component\Plugin\Factory\DefaultFactory;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Plugin\DefaultPluginManager;

/**
 * Provides an Archiver plugin manager.
 *
 * @see \Drupal\Core\Archiver\Annotation\Archiver
 * @see \Drupal\Core\Archiver\ArchiverInterface
 * @see plugin_api
 */
class ArchiverManager extends DefaultPluginManager {
    
    /**
     * The file system service.
     *
     * @var \Drupal\Core\File\FileSystemInterface
     */
    protected $fileSystem;
    
    /**
     * Constructs a ArchiverManager object.
     *
     * @param \Traversable $namespaces
     *   An object that implements \Traversable which contains the root paths
     *   keyed by the corresponding namespace to look for plugin implementations.
     * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
     *   Cache backend instance to use.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler to invoke the alter hook with.
     * @param \Drupal\Core\File\FileSystemInterface $file_system
     *   The file handler.
     */
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, FileSystemInterface $file_system = NULL) {
        parent::__construct('Plugin/Archiver', $namespaces, $module_handler, 'Drupal\\Core\\Archiver\\ArchiverInterface', 'Drupal\\Core\\Archiver\\Annotation\\Archiver');
        $this->alterInfo('archiver_info');
        $this->setCacheBackend($cache_backend, 'archiver_info_plugins');
        if (!isset($file_system)) {
            @trigger_error('Not defining the final $file_system argument to ' . __METHOD__ . ' is deprecated in drupal:8.8.3 and will throw an error in drupal:10.0.0.', E_USER_DEPRECATED);
            $file_system = \Drupal::service('file_system');
        }
        $this->fileSystem = $file_system;
    }
    
    /**
     * {@inheritdoc}
     */
    public function createInstance($plugin_id, array $configuration = []) {
        $plugin_definition = $this->getDefinition($plugin_id);
        $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition, 'Drupal\\Core\\Archiver\\ArchiverInterface');
        return new $plugin_class($this->fileSystem
            ->realpath($configuration['filepath']));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getInstance(array $options) {
        $filepath = $options['filepath'];
        foreach ($this->getDefinitions() as $plugin_id => $definition) {
            foreach ($definition['extensions'] as $extension) {
                // Because extensions may be multi-part, such as .tar.gz,
                // we cannot use simpler approaches like substr() or pathinfo().
                // This method isn't quite as clean but gets the job done.
                // Also note that the file may not yet exist, so we cannot rely
                // on fileinfo() or other disk-level utilities.
                if (strrpos($filepath, '.' . $extension) === strlen($filepath) - strlen('.' . $extension)) {
                    return $this->createInstance($plugin_id, $options);
                }
            }
        }
    }
    
    /**
     * Returns a string of supported archive extensions.
     *
     * @return string
     *   A space-separated string of extensions suitable for use by the file
     *   validation system.
     */
    public function getExtensions() {
        $valid_extensions = [];
        foreach ($this->getDefinitions() as $archive) {
            foreach ($archive['extensions'] as $extension) {
                foreach (explode('.', $extension) as $part) {
                    if (!in_array($part, $valid_extensions)) {
                        $valid_extensions[] = $part;
                    }
                }
            }
        }
        return implode(' ', $valid_extensions);
    }

}