Chris@18: <?php
Chris@18: namespace TYPO3\PharStreamWrapper\Resolver;
Chris@18: 
Chris@18: /*
Chris@18:  * This file is part of the TYPO3 project.
Chris@18:  *
Chris@18:  * It is free software; you can redistribute it and/or modify it under the terms
Chris@18:  * of the MIT License (MIT). For the full copyright and license information,
Chris@18:  * please read the LICENSE file that was distributed with this source code.
Chris@18:  *
Chris@18:  * The TYPO3 project - inspiring people to share!
Chris@18:  */
Chris@18: 
Chris@18: use TYPO3\PharStreamWrapper\Helper;
Chris@18: use TYPO3\PharStreamWrapper\Manager;
Chris@18: use TYPO3\PharStreamWrapper\Phar\Reader;
Chris@18: use TYPO3\PharStreamWrapper\Resolvable;
Chris@18: 
Chris@18: class PharInvocationResolver implements Resolvable
Chris@18: {
Chris@18:     const RESOLVE_REALPATH = 1;
Chris@18:     const RESOLVE_ALIAS = 2;
Chris@18:     const ASSERT_INTERNAL_INVOCATION = 32;
Chris@18: 
Chris@18:     /**
Chris@18:      * @var string[]
Chris@18:      */
Chris@18:     private $invocationFunctionNames = array(
Chris@18:         'include',
Chris@18:         'include_once',
Chris@18:         'require',
Chris@18:         'require_once'
Chris@18:     );
Chris@18: 
Chris@18:     /**
Chris@18:      * Contains resolved base names in order to reduce file IO.
Chris@18:      *
Chris@18:      * @var string[]
Chris@18:      */
Chris@18:     private $baseNames = array();
Chris@18: 
Chris@18:     /**
Chris@18:      * Resolves PharInvocation value object (baseName and optional alias).
Chris@18:      *
Chris@18:      * Phar aliases are intended to be used only inside Phar archives, however
Chris@18:      * PharStreamWrapper needs this information exposed outside of Phar as well
Chris@18:      * It is possible that same alias is used for different $baseName values.
Chris@18:      * That's why PharInvocationCollection behaves like a stack when resolving
Chris@18:      * base-name for a given alias. On the other hand it is not possible that
Chris@18:      * one $baseName is referring to multiple aliases.
Chris@18:      * @see https://secure.php.net/manual/en/phar.setalias.php
Chris@18:      * @see https://secure.php.net/manual/en/phar.mapphar.php
Chris@18:      *
Chris@18:      * @param string $path
Chris@18:      * @param int|null $flags
Chris@18:      * @return null|PharInvocation
Chris@18:      */
Chris@18:     public function resolve($path, $flags = null)
Chris@18:     {
Chris@18:         $hasPharPrefix = Helper::hasPharPrefix($path);
Chris@18:         if ($flags === null) {
Chris@18:             $flags = static::RESOLVE_REALPATH | static::RESOLVE_ALIAS | static::ASSERT_INTERNAL_INVOCATION;
Chris@18:         }
Chris@18: 
Chris@18:         if ($hasPharPrefix && $flags & static::RESOLVE_ALIAS) {
Chris@18:             $invocation = $this->findByAlias($path);
Chris@18:             if ($invocation !== null) {
Chris@18:                 return $invocation;
Chris@18:             }
Chris@18:         }
Chris@18: 
Chris@18:         $baseName = $this->resolveBaseName($path, $flags);
Chris@18:         if ($baseName === null) {
Chris@18:             return null;
Chris@18:         }
Chris@18: 
Chris@18:         if ($flags & static::RESOLVE_REALPATH) {
Chris@18:             $baseName = $this->baseNames[$baseName];
Chris@18:         }
Chris@18: 
Chris@18:         return $this->retrieveInvocation($baseName, $flags);
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * Retrieves PharInvocation, either existing in collection or created on demand
Chris@18:      * with resolving a potential alias name used in the according Phar archive.
Chris@18:      *
Chris@18:      * @param string $baseName
Chris@18:      * @param int $flags
Chris@18:      * @return PharInvocation
Chris@18:      */
Chris@18:     private function retrieveInvocation($baseName, $flags)
Chris@18:     {
Chris@18:         $invocation = $this->findByBaseName($baseName);
Chris@18:         if ($invocation !== null) {
Chris@18:             return $invocation;
Chris@18:         }
Chris@18: 
Chris@18:         if ($flags & static::RESOLVE_ALIAS) {
Chris@18:             $reader = new Reader($baseName);
Chris@18:             $alias = $reader->resolveContainer()->getAlias();
Chris@18:         } else {
Chris@18:             $alias = '';
Chris@18:         }
Chris@18:         // add unconfirmed(!) new invocation to collection
Chris@18:         $invocation = new PharInvocation($baseName, $alias);
Chris@18:         Manager::instance()->getCollection()->collect($invocation);
Chris@18:         return $invocation;
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * @param string $path
Chris@18:      * @param int $flags
Chris@18:      * @return null|string
Chris@18:      */
Chris@18:     private function resolveBaseName($path, $flags)
Chris@18:     {
Chris@18:         $baseName = $this->findInBaseNames($path);
Chris@18:         if ($baseName !== null) {
Chris@18:             return $baseName;
Chris@18:         }
Chris@18: 
Chris@18:         $baseName = Helper::determineBaseFile($path);
Chris@18:         if ($baseName !== null) {
Chris@18:             $this->addBaseName($baseName);
Chris@18:             return $baseName;
Chris@18:         }
Chris@18: 
Chris@18:         $possibleAlias = $this->resolvePossibleAlias($path);
Chris@18:         if (!($flags & static::RESOLVE_ALIAS) || $possibleAlias === null) {
Chris@18:             return null;
Chris@18:         }
Chris@18: 
Chris@18:         $trace = debug_backtrace();
Chris@18:         foreach ($trace as $item) {
Chris@18:             if (!isset($item['function']) || !isset($item['args'][0])
Chris@18:                 || !in_array($item['function'], $this->invocationFunctionNames, true)) {
Chris@18:                 continue;
Chris@18:             }
Chris@18:             $currentPath = $item['args'][0];
Chris@18:             if (Helper::hasPharPrefix($currentPath)) {
Chris@18:                 continue;
Chris@18:             }
Chris@18:             $currentBaseName = Helper::determineBaseFile($currentPath);
Chris@18:             if ($currentBaseName === null) {
Chris@18:                 continue;
Chris@18:             }
Chris@18:             // ensure the possible alias name (how we have been called initially) matches
Chris@18:             // the resolved alias name that was retrieved by the current possible base name
Chris@18:             $reader = new Reader($currentBaseName);
Chris@18:             $currentAlias = $reader->resolveContainer()->getAlias();
Chris@18:             if ($currentAlias !== $possibleAlias) {
Chris@18:                 continue;
Chris@18:             }
Chris@18:             $this->addBaseName($currentBaseName);
Chris@18:             return $currentBaseName;
Chris@18:         }
Chris@18: 
Chris@18:         return null;
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * @param string $path
Chris@18:      * @return null|string
Chris@18:      */
Chris@18:     private function resolvePossibleAlias($path)
Chris@18:     {
Chris@18:         $normalizedPath = Helper::normalizePath($path);
Chris@18:         return strstr($normalizedPath, '/', true) ?: null;
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * @param string $baseName
Chris@18:      * @return null|PharInvocation
Chris@18:      */
Chris@18:     private function findByBaseName($baseName)
Chris@18:     {
Chris@18:         return Manager::instance()->getCollection()->findByCallback(
Chris@18:             function (PharInvocation $candidate) use ($baseName) {
Chris@18:                 return $candidate->getBaseName() === $baseName;
Chris@18:             },
Chris@18:             true
Chris@18:         );
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * @param string $path
Chris@18:      * @return null|string
Chris@18:      */
Chris@18:     private function findInBaseNames($path)
Chris@18:     {
Chris@18:         // return directly if the resolved base name was submitted
Chris@18:         if (in_array($path, $this->baseNames, true)) {
Chris@18:             return $path;
Chris@18:         }
Chris@18: 
Chris@18:         $parts = explode('/', Helper::normalizePath($path));
Chris@18: 
Chris@18:         while (count($parts)) {
Chris@18:             $currentPath = implode('/', $parts);
Chris@18:             if (isset($this->baseNames[$currentPath])) {
Chris@18:                 return $currentPath;
Chris@18:             }
Chris@18:             array_pop($parts);
Chris@18:         }
Chris@18: 
Chris@18:         return null;
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * @param string $baseName
Chris@18:      */
Chris@18:     private function addBaseName($baseName)
Chris@18:     {
Chris@18:         if (isset($this->baseNames[$baseName])) {
Chris@18:             return;
Chris@18:         }
Chris@18:         $this->baseNames[$baseName] = realpath($baseName);
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * Finds confirmed(!) invocations by alias.
Chris@18:      *
Chris@18:      * @param string $path
Chris@18:      * @return null|PharInvocation
Chris@18:      * @see \TYPO3\PharStreamWrapper\PharStreamWrapper::collectInvocation()
Chris@18:      */
Chris@18:     private function findByAlias($path)
Chris@18:     {
Chris@18:         $possibleAlias = $this->resolvePossibleAlias($path);
Chris@18:         if ($possibleAlias === null) {
Chris@18:             return null;
Chris@18:         }
Chris@18:         return Manager::instance()->getCollection()->findByCallback(
Chris@18:             function (PharInvocation $candidate) use ($possibleAlias) {
Chris@18:                 return $candidate->isConfirmed() && $candidate->getAlias() === $possibleAlias;
Chris@18:             },
Chris@18:             true
Chris@18:         );
Chris@18:     }
Chris@18: }