Merge pull request #126 from wshafer/master

Added AliasPathStackResolver for name spacing paths to assets

Author: RWOverdijk

config/module.config.php

@@ -10,24 +10,18 @@
             'AssetManager\Resolver\PathStackResolver'           => 'AssetManager\Service\PathStackResolverServiceFactory',
             'AssetManager\Resolver\PrioritizedPathsResolver'    => 'AssetManager\Service\PrioritizedPathsResolverServiceFactory',
             'AssetManager\Resolver\CollectionResolver'          => 'AssetManager\Service\CollectionResolverServiceFactory',
-            'AssetManager\Resolver\ConcatResolver'              => 'AssetManager\Service\ConcatResolverServiceFactory',
         ),
-
         'invokables' => array(
-            'AssetManager\Service\MimeResolver'                 => 'AssetManager\Service\MimeResolver',
+            'mime_resolver' => 'AssetManager\Service\MimeResolver',
         ),
-
-        'aliases' => array(
-            //Alias left here for BC
-            'mime_resolver'                                     => 'AssetManager\Service\MimeResolver',
-        )
     ),
     'asset_manager' => array(
         'resolvers' => array(
-            'AssetManager\Resolver\MapResolver'                 => 2000,
-            'AssetManager\Resolver\ConcatResolver'              => 1750,
-            'AssetManager\Resolver\CollectionResolver'          => 1500,
-            'AssetManager\Resolver\PrioritizedPathsResolver'    => 1000,
+            'AssetManager\Resolver\MapResolver'                 => 3000,
+            'AssetManager\Resolver\ConcatResolver'              => 2500,
+            'AssetManager\Resolver\CollectionResolver'          => 2000,
+            'AssetManager\Resolver\PrioritizedPathsResolver'    => 1500,
+            'AssetManager\Resolver\AliasPathStackResolver'      => 1000,
             'AssetManager\Resolver\PathStackResolver'           => 500,
         ),
     ),

src/AssetManager/Resolver/AliasPathStackResolver.php

@@ -0,0 +1,160 @@
+<?php
+
+namespace AssetManager\Resolver;
+
+use SplFileInfo;
+use Traversable;
+use Zend\Stdlib\SplStack;
+use Assetic\Asset\FileAsset;
+use AssetManager\Exception;
+use AssetManager\Service\MimeResolver;
+
+/**
+ * This resolver allows you to resolve from a stack of aliases to a path.
+ */
+class AliasPathStackResolver implements ResolverInterface, MimeResolverAwareInterface
+{
+    /**
+     * @var Array
+     */
+    protected $aliases = array();
+
+    /**
+     * Flag indicating whether or not LFI protection for rendering view scripts is enabled
+     *
+     * @var bool
+     */
+    protected $lfiProtectionOn = true;
+
+    /**
+     * The mime resolver.
+     *
+     * @var MimeResolver
+     */
+    protected $mimeResolver;
+
+    /**
+     * Constructor
+     *
+     * Populate the array stack with a list of aliases and their corresponding paths
+     *
+     * @param  array                              $aliases
+     * @throws Exception\InvalidArgumentException
+     */
+    public function __construct(Array $aliases)
+    {
+        foreach ($aliases as $alias => $path) {
+            $this->addAlias($alias, $path);
+        }
+    }
+
+    /**
+     * Add a single alias to the stack
+     *
+     * @param  string                             $alias
+     * @param  string                             $path
+     * @throws Exception\InvalidArgumentException
+     */
+    private function addAlias($alias, $path)
+    {
+        if (!is_string($path)) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Invalid path provided; must be a string, received %s',
+                gettype($path)
+            ));
+        }
+
+        if (!is_string($alias)) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Invalid alias provided; must be a string, received %s',
+                gettype($alias)
+            ));
+        }
+
+        $this->aliases[$alias] = $this->normalizePath($path);
+    }
+
+    /**
+     * Normalize a path for insertion in the stack
+     *
+     * @param  string $path
+     * @return string
+     */
+    private function normalizePath($path)
+    {
+        return rtrim($path, '/\\') . DIRECTORY_SEPARATOR;
+    }
+
+    /**
+     * Set the mime resolver
+     *
+     * @param MimeResolver $resolver
+     */
+    public function setMimeResolver(MimeResolver $resolver)
+    {
+        $this->mimeResolver = $resolver;
+    }
+
+    /**
+     * Get the mime resolver
+     *
+     * @return MimeResolver
+     */
+    public function getMimeResolver()
+    {
+        return $this->mimeResolver;
+    }
+
+    /**
+     * Set LFI protection flag
+     *
+     * @param  bool $flag
+     * @return self
+     */
+    public function setLfiProtection($flag)
+    {
+        $this->lfiProtectionOn = (bool) $flag;
+    }
+
+    /**
+     * Return status of LFI protection flag
+     *
+     * @return bool
+     */
+    public function isLfiProtectionOn()
+    {
+        return $this->lfiProtectionOn;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function resolve($name)
+    {
+        if ($this->isLfiProtectionOn() && preg_match('#\.\.[\\\/]#', $name)) {
+            return null;
+        }
+
+        foreach ($this->aliases as $alias => $path) {
+            if (strpos($name, $alias) === false) {
+                continue;
+            }
+
+            $name = str_replace($alias, '', $name);
+
+            $file = new SplFileInfo($path . $name);
+
+            if ($file->isReadable() && !$file->isDir()) {
+                $filePath = $file->getRealPath();
+                $mimeType = $this->getMimeResolver()->getMimeType($filePath);
+                $asset    = new FileAsset($filePath);
+
+                $asset->mimetype = $mimeType;
+
+                return $asset;
+            }
+        }
+
+        return null;
+    }
+}

src/AssetManager/Service/AliasPathStackResolverServiceFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace AssetManager\Service;
+
+use AssetManager\Resolver\AliasPathStackResolver;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use AssetManager\Resolver\PathStackResolver;
+
+class AliasPathStackResolverServiceFactory implements FactoryInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @return PathStackResolver
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $config  = $serviceLocator->get('config');
+        $aliases = array();
+
+        if (isset($config['asset_manager']['resolver_configs']['aliases'])) {
+            $aliases = $config['asset_manager']['resolver_configs']['aliases'];
+        }
+
+        return new AliasPathStackResolver($aliases);
+    }
+}