<?php
/**
* This file is part of the 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;
/**
* CodeIgniter Autoloader
*
* 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.
*
* @param Autoload $config
* @param Modules $modules
*
* @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); // @phpstan-ignore-line
// Now prepend another loader for the files in our class map.
spl_autoload_register([$this, 'loadClassmap'], true, true); // @phpstan-ignore-line
// 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
* @param string $path
*
* @return $this
*/
public function addNamespace($namespace, string $path = null)
{
if (is_array($namespace))
{
foreach ($namespace as $prefix => $path)
{
$prefix = trim($prefix, '\\');
if (is_array($path))
{
foreach ($path as $dir)
{
$this->prefixes[$prefix][] = rtrim($dir, '\\/') . DIRECTORY_SEPARATOR;
}
continue;
}
$this->prefixes[$prefix][] = rtrim($path, '\\/') . 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.
*
* @param string|null $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.
*
* @param string $namespace
*
* @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.
*
* @param string $class
*
* @return string|false
*/
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 string|false 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 string|false The mapped file name on success, or boolean false on fail
*/
protected function loadInNamespace(string $class)
{
if (strpos($class, '\\') === false)
{
$class = 'Config\\' . $class;
$filePath = APPPATH . str_replace('\\', DIRECTORY_SEPARATOR, $class) . '.php';
$filename = $this->includeFile($filePath);
if ($filename)
{
return $filename;
}
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.
*
* @param string $file
*
* @return string|false 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.
*
* @param string $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.
$filename = trim($filename, '.-_');
return $filename;
}
/**
* Locates autoload information from Composer, if available.
*
* @return void
*/
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);
}
}
MGatner