Initial

system/Autoloader/Autoloader.php

@@ -0,0 +1,328 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Autoloader;
+
+use Composer\Autoload\ClassLoader;
+use Config\Autoload;
+use Config\Modules;
+use InvalidArgumentException;
+
+/**
+ * An autoloader that uses both PSR4 autoloading, and traditional classmaps.
+ *
+ * Given a foo-bar package of classes in the file system at the following paths:
+ * ```
+ *      /path/to/packages/foo-bar/
+ *          /src
+ *              Baz.php         # Foo\Bar\Baz
+ *              Qux/
+ *                  Quux.php    # Foo\Bar\Qux\Quux
+ * ```
+ * you can add the path to the configuration array that is passed in the constructor.
+ * The Config array consists of 2 primary keys, both of which are associative arrays:
+ * 'psr4', and 'classmap'.
+ * ```
+ *      $Config = [
+ *          'psr4' => [
+ *              'Foo\Bar'   => '/path/to/packages/foo-bar'
+ *          ],
+ *          'classmap' => [
+ *              'MyClass'   => '/path/to/class/file.php'
+ *          ]
+ *      ];
+ * ```
+ * Example:
+ * ```
+ *      <?php
+ *      // our configuration array
+ *      $Config = [ ... ];
+ *      $loader = new \CodeIgniter\Autoloader\Autoloader($Config);
+ *
+ *      // register the autoloader
+ *      $loader->register();
+ * ```
+ */
+class Autoloader
+{
+    /**
+     * Stores namespaces as key, and path as values.
+     *
+     * @var array<string, array<string>>
+     */
+    protected $prefixes = [];
+
+    /**
+     * Stores class name as key, and path as values.
+     *
+     * @var array<string, string>
+     */
+    protected $classmap = [];
+
+    /**
+     * Stores files as a list.
+     *
+     * @var array<int, string>
+     */
+    protected $files = [];
+
+    /**
+     * Reads in the configuration array (described above) and stores
+     * the valid parts that we'll need.
+     *
+     * @return $this
+     */
+    public function initialize(Autoload $config, Modules $modules)
+    {
+        // We have to have one or the other, though we don't enforce the need
+        // to have both present in order to work.
+        if (empty($config->psr4) && empty($config->classmap)) {
+            throw new InvalidArgumentException('Config array must contain either the \'psr4\' key or the \'classmap\' key.');
+        }
+
+        if (isset($config->psr4)) {
+            $this->addNamespace($config->psr4);
+        }
+
+        if (isset($config->classmap)) {
+            $this->classmap = $config->classmap;
+        }
+
+        if (isset($config->files)) {
+            $this->files = $config->files;
+        }
+
+        // Should we load through Composer's namespaces, also?
+        if ($modules->discoverInComposer) {
+            $this->discoverComposerNamespaces();
+        }
+
+        return $this;
+    }
+
+    /**
+     * Register the loader with the SPL autoloader stack.
+     */
+    public function register()
+    {
+        // Prepend the PSR4  autoloader for maximum performance.
+        spl_autoload_register([$this, 'loadClass'], true, true);
+
+        // Now prepend another loader for the files in our class map.
+        spl_autoload_register([$this, 'loadClassmap'], true, true);
+
+        // Load our non-class files
+        foreach ($this->files as $file) {
+            if (is_string($file)) {
+                $this->includeFile($file);
+            }
+        }
+    }
+
+    /**
+     * Registers namespaces with the autoloader.
+     *
+     * @param array|string $namespace
+     *
+     * @return $this
+     */
+    public function addNamespace($namespace, ?string $path = null)
+    {
+        if (is_array($namespace)) {
+            foreach ($namespace as $prefix => $namespacedPath) {
+                $prefix = trim($prefix, '\\');
+
+                if (is_array($namespacedPath)) {
+                    foreach ($namespacedPath as $dir) {
+                        $this->prefixes[$prefix][] = rtrim($dir, '\\/') . DIRECTORY_SEPARATOR;
+                    }
+
+                    continue;
+                }
+
+                $this->prefixes[$prefix][] = rtrim($namespacedPath, '\\/') . DIRECTORY_SEPARATOR;
+            }
+        } else {
+            $this->prefixes[trim($namespace, '\\')][] = rtrim($path, '\\/') . DIRECTORY_SEPARATOR;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Get namespaces with prefixes as keys and paths as values.
+     *
+     * If a prefix param is set, returns only paths to the given prefix.
+     *
+     * @return array
+     */
+    public function getNamespace(?string $prefix = null)
+    {
+        if ($prefix === null) {
+            return $this->prefixes;
+        }
+
+        return $this->prefixes[trim($prefix, '\\')] ?? [];
+    }
+
+    /**
+     * Removes a single namespace from the psr4 settings.
+     *
+     * @return $this
+     */
+    public function removeNamespace(string $namespace)
+    {
+        if (isset($this->prefixes[trim($namespace, '\\')])) {
+            unset($this->prefixes[trim($namespace, '\\')]);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Load a class using available class mapping.
+     *
+     * @return false|string
+     */
+    public function loadClassmap(string $class)
+    {
+        $file = $this->classmap[$class] ?? '';
+
+        if (is_string($file) && $file !== '') {
+            return $this->includeFile($file);
+        }
+
+        return false;
+    }
+
+    /**
+     * Loads the class file for a given class name.
+     *
+     * @param string $class The fully qualified class name.
+     *
+     * @return false|string The mapped file on success, or boolean false
+     *                      on failure.
+     */
+    public function loadClass(string $class)
+    {
+        $class = trim($class, '\\');
+        $class = str_ireplace('.php', '', $class);
+
+        return $this->loadInNamespace($class);
+    }
+
+    /**
+     * Loads the class file for a given class name.
+     *
+     * @param string $class The fully-qualified class name
+     *
+     * @return false|string The mapped file name on success, or boolean false on fail
+     */
+    protected function loadInNamespace(string $class)
+    {
+        if (strpos($class, '\\') === false) {
+            return false;
+        }
+
+        foreach ($this->prefixes as $namespace => $directories) {
+            foreach ($directories as $directory) {
+                $directory = rtrim($directory, '\\/');
+
+                if (strpos($class, $namespace) === 0) {
+                    $filePath = $directory . str_replace('\\', DIRECTORY_SEPARATOR, substr($class, strlen($namespace))) . '.php';
+                    $filename = $this->includeFile($filePath);
+
+                    if ($filename) {
+                        return $filename;
+                    }
+                }
+            }
+        }
+
+        // never found a mapped file
+        return false;
+    }
+
+    /**
+     * A central way to include a file. Split out primarily for testing purposes.
+     *
+     * @return false|string The filename on success, false if the file is not loaded
+     */
+    protected function includeFile(string $file)
+    {
+        $file = $this->sanitizeFilename($file);
+
+        if (is_file($file)) {
+            include_once $file;
+
+            return $file;
+        }
+
+        return false;
+    }
+
+    /**
+     * Sanitizes a filename, replacing spaces with dashes.
+     *
+     * Removes special characters that are illegal in filenames on certain
+     * operating systems and special characters requiring special escaping
+     * to manipulate at the command line. Replaces spaces and consecutive
+     * dashes with a single dash. Trim period, dash and underscore from beginning
+     * and end of filename.
+     *
+     * @return string The sanitized filename
+     */
+    public function sanitizeFilename(string $filename): string
+    {
+        // Only allow characters deemed safe for POSIX portable filenames.
+        // Plus the forward slash for directory separators since this might be a path.
+        // http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278
+        // Modified to allow backslash and colons for on Windows machines.
+        $filename = preg_replace('/[^0-9\p{L}\s\/\-\_\.\:\\\\]/u', '', $filename);
+
+        // Clean up our filename edges.
+        return trim($filename, '.-_');
+    }
+
+    /**
+     * Locates autoload information from Composer, if available.
+     */
+    protected function discoverComposerNamespaces()
+    {
+        if (! is_file(COMPOSER_PATH)) {
+            return;
+        }
+
+        /**
+         * @var ClassLoader $composer
+         */
+        $composer = include COMPOSER_PATH;
+        $paths    = $composer->getPrefixesPsr4();
+        $classes  = $composer->getClassMap();
+
+        unset($composer);
+
+        // Get rid of CodeIgniter so we don't have duplicates
+        if (isset($paths['CodeIgniter\\'])) {
+            unset($paths['CodeIgniter\\']);
+        }
+
+        $newPaths = [];
+
+        foreach ($paths as $key => $value) {
+            // Composer stores namespaces with trailing slash. We don't.
+            $newPaths[rtrim($key, '\\ ')] = $value;
+        }
+
+        $this->prefixes = array_merge($this->prefixes, $newPaths);
+        $this->classmap = array_merge($this->classmap, $classes);
+    }
+}

system/Autoloader/FileLocator.php

@@ -0,0 +1,369 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Autoloader;
+
+/**
+ * Allows loading non-class files in a namespaced manner.
+ * Works with Helpers, Views, etc.
+ */
+class FileLocator
+{
+    /**
+     * The Autoloader to use.
+     *
+     * @var Autoloader
+     */
+    protected $autoloader;
+
+    public function __construct(Autoloader $autoloader)
+    {
+        $this->autoloader = $autoloader;
+    }
+
+    /**
+     * Attempts to locate a file by examining the name for a namespace
+     * and looking through the PSR-4 namespaced files that we know about.
+     *
+     * @param string      $file   The namespaced file to locate
+     * @param string|null $folder The folder within the namespace that we should look for the file.
+     * @param string      $ext    The file extension the file should have.
+     *
+     * @return false|string The path to the file, or false if not found.
+     */
+    public function locateFile(string $file, ?string $folder = null, string $ext = 'php')
+    {
+        $file = $this->ensureExt($file, $ext);
+
+        // Clears the folder name if it is at the beginning of the filename
+        if (! empty($folder) && strpos($file, $folder) === 0) {
+            $file = substr($file, strlen($folder . '/'));
+        }
+
+        // Is not namespaced? Try the application folder.
+        if (strpos($file, '\\') === false) {
+            return $this->legacyLocate($file, $folder);
+        }
+
+        // Standardize slashes to handle nested directories.
+        $file = strtr($file, '/', '\\');
+        $file = ltrim($file, '\\');
+
+        $segments = explode('\\', $file);
+
+        // The first segment will be empty if a slash started the filename.
+        if (empty($segments[0])) {
+            unset($segments[0]);
+        }
+
+        $paths    = [];
+        $filename = '';
+
+        // Namespaces always comes with arrays of paths
+        $namespaces = $this->autoloader->getNamespace();
+
+        foreach (array_keys($namespaces) as $namespace) {
+            if (substr($file, 0, strlen($namespace)) === $namespace) {
+                // There may be sub-namespaces of the same vendor,
+                // so overwrite them with namespaces found later.
+                $paths = $namespaces[$namespace];
+
+                $fileWithoutNamespace = substr($file, strlen($namespace));
+                $filename             = ltrim(str_replace('\\', '/', $fileWithoutNamespace), '/');
+            }
+        }
+
+        // if no namespaces matched then quit
+        if (empty($paths)) {
+            return false;
+        }
+
+        // Check each path in the namespace
+        foreach ($paths as $path) {
+            // Ensure trailing slash
+            $path = rtrim($path, '/') . '/';
+
+            // If we have a folder name, then the calling function
+            // expects this file to be within that folder, like 'Views',
+            // or 'libraries'.
+            if (! empty($folder) && strpos($path . $filename, '/' . $folder . '/') === false) {
+                $path .= trim($folder, '/') . '/';
+            }
+
+            $path .= $filename;
+            if (is_file($path)) {
+                return $path;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Examines a file and returns the fully qualified domain name.
+     */
+    public function getClassname(string $file): string
+    {
+        $php       = file_get_contents($file);
+        $tokens    = token_get_all($php);
+        $dlm       = false;
+        $namespace = '';
+        $className = '';
+
+        foreach ($tokens as $i => $token) {
+            if ($i < 2) {
+                continue;
+            }
+
+            if ((isset($tokens[$i - 2][1]) && ($tokens[$i - 2][1] === 'phpnamespace' || $tokens[$i - 2][1] === 'namespace')) || ($dlm && $tokens[$i - 1][0] === T_NS_SEPARATOR && $token[0] === T_STRING)) {
+                if (! $dlm) {
+                    $namespace = 0;
+                }
+                if (isset($token[1])) {
+                    $namespace = $namespace ? $namespace . '\\' . $token[1] : $token[1];
+                    $dlm       = true;
+                }
+            } elseif ($dlm && ($token[0] !== T_NS_SEPARATOR) && ($token[0] !== T_STRING)) {
+                $dlm = false;
+            }
+
+            if (($tokens[$i - 2][0] === T_CLASS || (isset($tokens[$i - 2][1]) && $tokens[$i - 2][1] === 'phpclass'))
+                && $tokens[$i - 1][0] === T_WHITESPACE
+                && $token[0] === T_STRING) {
+                $className = $token[1];
+                break;
+            }
+        }
+
+        if (empty($className)) {
+            return '';
+        }
+
+        return $namespace . '\\' . $className;
+    }
+
+    /**
+     * Searches through all of the defined namespaces looking for a file.
+     * Returns an array of all found locations for the defined file.
+     *
+     * Example:
+     *
+     *  $locator->search('Config/Routes.php');
+     *  // Assuming PSR4 namespaces include foo and bar, might return:
+     *  [
+     *      'app/Modules/foo/Config/Routes.php',
+     *      'app/Modules/bar/Config/Routes.php',
+     *  ]
+     */
+    public function search(string $path, string $ext = 'php', bool $prioritizeApp = true): array
+    {
+        $path = $this->ensureExt($path, $ext);
+
+        $foundPaths = [];
+        $appPaths   = [];
+
+        foreach ($this->getNamespaces() as $namespace) {
+            if (isset($namespace['path']) && is_file($namespace['path'] . $path)) {
+                $fullPath = $namespace['path'] . $path;
+                $fullPath = realpath($fullPath) ?: $fullPath;
+
+                if ($prioritizeApp) {
+                    $foundPaths[] = $fullPath;
+                } elseif (strpos($fullPath, APPPATH) === 0) {
+                    $appPaths[] = $fullPath;
+                } else {
+                    $foundPaths[] = $fullPath;
+                }
+            }
+        }
+
+        if (! $prioritizeApp && ! empty($appPaths)) {
+            $foundPaths = array_merge($foundPaths, $appPaths);
+        }
+
+        // Remove any duplicates
+        return array_unique($foundPaths);
+    }
+
+    /**
+     * Ensures a extension is at the end of a filename
+     */
+    protected function ensureExt(string $path, string $ext): string
+    {
+        if ($ext) {
+            $ext = '.' . $ext;
+
+            if (substr($path, -strlen($ext)) !== $ext) {
+                $path .= $ext;
+            }
+        }
+
+        return $path;
+    }
+
+    /**
+     * Return the namespace mappings we know about.
+     *
+     * @return array|string
+     */
+    protected function getNamespaces()
+    {
+        $namespaces = [];
+
+        // Save system for last
+        $system = [];
+
+        foreach ($this->autoloader->getNamespace() as $prefix => $paths) {
+            foreach ($paths as $path) {
+                if ($prefix === 'CodeIgniter') {
+                    $system = [
+                        'prefix' => $prefix,
+                        'path'   => rtrim($path, '\\/') . DIRECTORY_SEPARATOR,
+                    ];
+
+                    continue;
+                }
+
+                $namespaces[] = [
+                    'prefix' => $prefix,
+                    'path'   => rtrim($path, '\\/') . DIRECTORY_SEPARATOR,
+                ];
+            }
+        }
+
+        $namespaces[] = $system;
+
+        return $namespaces;
+    }
+
+    /**
+     * Find the qualified name of a file according to
+     * the namespace of the first matched namespace path.
+     *
+     * @return false|string The qualified name or false if the path is not found
+     */
+    public function findQualifiedNameFromPath(string $path)
+    {
+        $path = realpath($path) ?: $path;
+
+        if (! is_file($path)) {
+            return false;
+        }
+
+        foreach ($this->getNamespaces() as $namespace) {
+            $namespace['path'] = realpath($namespace['path']) ?: $namespace['path'];
+
+            if (empty($namespace['path'])) {
+                continue;
+            }
+
+            if (mb_strpos($path, $namespace['path']) === 0) {
+                $className = '\\' . $namespace['prefix'] . '\\' .
+                        ltrim(str_replace(
+                            '/',
+                            '\\',
+                            mb_substr($path, mb_strlen($namespace['path']))
+                        ), '\\');
+
+                // Remove the file extension (.php)
+                $className = mb_substr($className, 0, -4);
+
+                // Check if this exists
+                if (class_exists($className)) {
+                    return $className;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Scans the defined namespaces, returning a list of all files
+     * that are contained within the subpath specified by $path.
+     */
+    public function listFiles(string $path): array
+    {
+        if (empty($path)) {
+            return [];
+        }
+
+        $files = [];
+        helper('filesystem');
+
+        foreach ($this->getNamespaces() as $namespace) {
+            $fullPath = $namespace['path'] . $path;
+            $fullPath = realpath($fullPath) ?: $fullPath;
+
+            if (! is_dir($fullPath)) {
+                continue;
+            }
+
+            $tempFiles = get_filenames($fullPath, true);
+
+            if (! empty($tempFiles)) {
+                $files = array_merge($files, $tempFiles);
+            }
+        }
+
+        return $files;
+    }
+
+    /**
+     * Scans the provided namespace, returning a list of all files
+     * that are contained within the subpath specified by $path.
+     */
+    public function listNamespaceFiles(string $prefix, string $path): array
+    {
+        if (empty($path) || empty($prefix)) {
+            return [];
+        }
+
+        $files = [];
+        helper('filesystem');
+
+        // autoloader->getNamespace($prefix) returns an array of paths for that namespace
+        foreach ($this->autoloader->getNamespace($prefix) as $namespacePath) {
+            $fullPath = rtrim($namespacePath, '/') . '/' . $path;
+            $fullPath = realpath($fullPath) ?: $fullPath;
+
+            if (! is_dir($fullPath)) {
+                continue;
+            }
+
+            $tempFiles = get_filenames($fullPath, true);
+
+            if (! empty($tempFiles)) {
+                $files = array_merge($files, $tempFiles);
+            }
+        }
+
+        return $files;
+    }
+
+    /**
+     * Checks the app folder to see if the file can be found.
+     * Only for use with filenames that DO NOT include namespacing.
+     *
+     * @return false|string The path to the file, or false if not found.
+     */
+    protected function legacyLocate(string $file, ?string $folder = null)
+    {
+        $path = APPPATH . (empty($folder) ? $file : $folder . '/' . $file);
+        $path = realpath($path) ?: $path;
+
+        if (is_file($path)) {
+            return $path;
+        }
+
+        return false;
+    }
+}