Chris@17: <?php
Chris@17: namespace TYPO3\PharStreamWrapper;
Chris@17: 
Chris@17: /*
Chris@17:  * This file is part of the TYPO3 project.
Chris@17:  *
Chris@17:  * It is free software; you can redistribute it and/or modify it under the terms
Chris@17:  * of the MIT License (MIT). For the full copyright and license information,
Chris@17:  * please read the LICENSE file that was distributed with this source code.
Chris@17:  *
Chris@17:  * The TYPO3 project - inspiring people to share!
Chris@17:  */
Chris@17: 
Chris@18: /**
Chris@18:  * Helper provides low-level tools on file name resolving. However it does not
Chris@18:  * (and should not) maintain any runtime state information. In order to resolve
Chris@18:  * Phar archive paths according resolvers have to be used.
Chris@18:  *
Chris@18:  * @see \TYPO3\PharStreamWrapper\Resolvable::resolve()
Chris@18:  */
Chris@17: class Helper
Chris@17: {
Chris@17:     /*
Chris@17:      * Resets PHP's OPcache if enabled as work-around for issues in `include()`
Chris@17:      * or `require()` calls and OPcache delivering wrong results.
Chris@17:      *
Chris@17:      * @see https://bugs.php.net/bug.php?id=66569
Chris@17:      */
Chris@17:     public static function resetOpCache()
Chris@17:     {
Chris@17:         if (function_exists('opcache_reset')
Chris@17:             && function_exists('opcache_get_status')
Chris@17:         ) {
Chris@17:             $status = opcache_get_status();
Chris@17:             if (!empty($status['opcache_enabled'])) {
Chris@17:                 opcache_reset();
Chris@17:             }
Chris@17:         }
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * Determines base file that can be accessed using the regular file system.
Chris@17:      * For e.g. "phar:///home/user/bundle.phar/content.txt" that would result
Chris@17:      * into "/home/user/bundle.phar".
Chris@17:      *
Chris@17:      * @param string $path
Chris@17:      * @return string|null
Chris@17:      */
Chris@17:     public static function determineBaseFile($path)
Chris@17:     {
Chris@17:         $parts = explode('/', static::normalizePath($path));
Chris@17: 
Chris@17:         while (count($parts)) {
Chris@17:             $currentPath = implode('/', $parts);
Chris@17:             if (@is_file($currentPath)) {
Chris@17:                 return $currentPath;
Chris@17:             }
Chris@17:             array_pop($parts);
Chris@17:         }
Chris@17: 
Chris@17:         return null;
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * @param string $path
Chris@18:      * @return bool
Chris@18:      */
Chris@18:     public static function hasPharPrefix($path)
Chris@18:     {
Chris@18:         return stripos($path, 'phar://') === 0;
Chris@18:     }
Chris@18: 
Chris@18:     /**
Chris@18:      * @param string $path
Chris@17:      * @return string
Chris@17:      */
Chris@17:     public static function removePharPrefix($path)
Chris@17:     {
Chris@17:         $path = trim($path);
Chris@18:         if (!static::hasPharPrefix($path)) {
Chris@17:             return $path;
Chris@17:         }
Chris@17:         return substr($path, 7);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * Normalizes a path, removes phar:// prefix, fixes Windows directory
Chris@17:      * separators. Result is without trailing slash.
Chris@17:      *
Chris@17:      * @param string $path
Chris@17:      * @return string
Chris@17:      */
Chris@17:     public static function normalizePath($path)
Chris@17:     {
Chris@17:         return rtrim(
Chris@18:             static::normalizeWindowsPath(
Chris@17:                 static::removePharPrefix($path)
Chris@17:             ),
Chris@17:             '/'
Chris@17:         );
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
Chris@17:      *
Chris@17:      * @param string $path File path to process
Chris@17:      * @return string
Chris@17:      */
Chris@17:     private static function normalizeWindowsPath($path)
Chris@17:     {
Chris@17:         return str_replace('\\', '/', $path);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * Resolves all dots, slashes and removes spaces after or before a path...
Chris@17:      *
Chris@17:      * @param string $path Input string
Chris@17:      * @return string Canonical path, always without trailing slash
Chris@17:      */
Chris@17:     private static function getCanonicalPath($path)
Chris@17:     {
Chris@17:         $path = static::normalizeWindowsPath($path);
Chris@17: 
Chris@17:         $absolutePathPrefix = '';
Chris@17:         if (static::isAbsolutePath($path)) {
Chris@17:             if (static::isWindows() && strpos($path, ':/') === 1) {
Chris@17:                 $absolutePathPrefix = substr($path, 0, 3);
Chris@17:                 $path = substr($path, 3);
Chris@17:             } else {
Chris@17:                 $path = ltrim($path, '/');
Chris@17:                 $absolutePathPrefix = '/';
Chris@17:             }
Chris@17:         }
Chris@17: 
Chris@17:         $pathParts = explode('/', $path);
Chris@17:         $pathPartsLength = count($pathParts);
Chris@17:         for ($partCount = 0; $partCount < $pathPartsLength; $partCount++) {
Chris@17:             // double-slashes in path: remove element
Chris@17:             if ($pathParts[$partCount] === '') {
Chris@17:                 array_splice($pathParts, $partCount, 1);
Chris@17:                 $partCount--;
Chris@17:                 $pathPartsLength--;
Chris@17:             }
Chris@17:             // "." in path: remove element
Chris@17:             if ((isset($pathParts[$partCount]) ? $pathParts[$partCount] : '') === '.') {
Chris@17:                 array_splice($pathParts, $partCount, 1);
Chris@17:                 $partCount--;
Chris@17:                 $pathPartsLength--;
Chris@17:             }
Chris@17:             // ".." in path:
Chris@17:             if ((isset($pathParts[$partCount]) ? $pathParts[$partCount] : '') === '..') {
Chris@17:                 if ($partCount === 0) {
Chris@17:                     array_splice($pathParts, $partCount, 1);
Chris@17:                     $partCount--;
Chris@17:                     $pathPartsLength--;
Chris@17:                 } elseif ($partCount >= 1) {
Chris@17:                     // Rremove this and previous element
Chris@17:                     array_splice($pathParts, $partCount - 1, 2);
Chris@17:                     $partCount -= 2;
Chris@17:                     $pathPartsLength -= 2;
Chris@17:                 } elseif ($absolutePathPrefix) {
Chris@17:                     // can't go higher than root dir
Chris@17:                     // simply remove this part and continue
Chris@17:                     array_splice($pathParts, $partCount, 1);
Chris@17:                     $partCount--;
Chris@17:                     $pathPartsLength--;
Chris@17:                 }
Chris@17:             }
Chris@17:         }
Chris@17: 
Chris@17:         return $absolutePathPrefix . implode('/', $pathParts);
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * Checks if the $path is absolute or relative (detecting either '/' or
Chris@17:      * 'x:/' as first part of string) and returns TRUE if so.
Chris@17:      *
Chris@17:      * @param string $path File path to evaluate
Chris@17:      * @return bool
Chris@17:      */
Chris@17:     private static function isAbsolutePath($path)
Chris@17:     {
Chris@17:         // Path starting with a / is always absolute, on every system
Chris@17:         // On Windows also a path starting with a drive letter is absolute: X:/
Chris@17:         return (isset($path[0]) ? $path[0] : null) === '/'
Chris@17:             || static::isWindows() && (
Chris@17:                 strpos($path, ':/') === 1
Chris@17:                 || strpos($path, ':\\') === 1
Chris@17:             );
Chris@17:     }
Chris@17: 
Chris@17:     /**
Chris@17:      * @return bool
Chris@17:      */
Chris@17:     private static function isWindows()
Chris@17:     {
Chris@17:         return stripos(PHP_OS, 'WIN') === 0;
Chris@17:     }
Chris@17: }