You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
190 lines
5.4 KiB
190 lines
5.4 KiB
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Georg Ehrke <oc.list@georgehrke.com>
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
|
* @author Markus Goetz <markus@woboq.com>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Robin Appelman <robin@icewind.nl>
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
|
*
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
namespace OC;
|
|
|
|
use \OCP\AutoloadNotAllowedException;
|
|
use OCP\ILogger;
|
|
|
|
class Autoloader {
|
|
/** @var bool */
|
|
private $useGlobalClassPath = true;
|
|
/** @var array */
|
|
private $validRoots = [];
|
|
|
|
/**
|
|
* Optional low-latency memory cache for class to path mapping.
|
|
*
|
|
* @var \OC\Memcache\Cache
|
|
*/
|
|
protected $memoryCache;
|
|
|
|
/**
|
|
* Autoloader constructor.
|
|
*
|
|
* @param string[] $validRoots
|
|
*/
|
|
public function __construct(array $validRoots) {
|
|
foreach ($validRoots as $root) {
|
|
$this->validRoots[$root] = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a path to the list of valid php roots for auto loading
|
|
*
|
|
* @param string $root
|
|
*/
|
|
public function addValidRoot(string $root) {
|
|
$root = stream_resolve_include_path($root);
|
|
$this->validRoots[$root] = true;
|
|
}
|
|
|
|
/**
|
|
* disable the usage of the global classpath \OC::$CLASSPATH
|
|
*/
|
|
public function disableGlobalClassPath() {
|
|
$this->useGlobalClassPath = false;
|
|
}
|
|
|
|
/**
|
|
* enable the usage of the global classpath \OC::$CLASSPATH
|
|
*/
|
|
public function enableGlobalClassPath() {
|
|
$this->useGlobalClassPath = true;
|
|
}
|
|
|
|
/**
|
|
* get the possible paths for a class
|
|
*
|
|
* @param string $class
|
|
* @return array an array of possible paths
|
|
*/
|
|
public function findClass(string $class): array {
|
|
$class = trim($class, '\\');
|
|
|
|
$paths = [];
|
|
if ($this->useGlobalClassPath && array_key_exists($class, \OC::$CLASSPATH)) {
|
|
$paths[] = \OC::$CLASSPATH[$class];
|
|
/**
|
|
* @TODO: Remove this when necessary
|
|
* Remove "apps/" from inclusion path for smooth migration to multi app dir
|
|
*/
|
|
if (strpos(\OC::$CLASSPATH[$class], 'apps/') === 0) {
|
|
\OCP\Util::writeLog('core', 'include path for class "' . $class . '" starts with "apps/"', ILogger::DEBUG);
|
|
$paths[] = str_replace('apps/', '', \OC::$CLASSPATH[$class]);
|
|
}
|
|
} elseif (strpos($class, 'OC_') === 0) {
|
|
$paths[] = \OC::$SERVERROOT . '/lib/private/legacy/' . strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
|
|
} elseif (strpos($class, 'OCA\\') === 0) {
|
|
list(, $app, $rest) = explode('\\', $class, 3);
|
|
$app = strtolower($app);
|
|
$appPath = \OC_App::getAppPath($app);
|
|
if ($appPath && stream_resolve_include_path($appPath)) {
|
|
$paths[] = $appPath . '/' . strtolower(str_replace('\\', '/', $rest) . '.php');
|
|
// If not found in the root of the app directory, insert '/lib' after app id and try again.
|
|
$paths[] = $appPath . '/lib/' . strtolower(str_replace('\\', '/', $rest) . '.php');
|
|
}
|
|
} elseif ($class === 'Test\\TestCase') {
|
|
// This File is considered public API, so we make sure that the class
|
|
// can still be loaded, although the PSR-4 paths have not been loaded.
|
|
$paths[] = \OC::$SERVERROOT . '/tests/lib/TestCase.php';
|
|
}
|
|
return $paths;
|
|
}
|
|
|
|
/**
|
|
* @param string $fullPath
|
|
* @return bool
|
|
* @throws AutoloadNotAllowedException
|
|
*/
|
|
protected function isValidPath(string $fullPath): bool {
|
|
foreach ($this->validRoots as $root => $true) {
|
|
if (substr($fullPath, 0, strlen($root) + 1) === $root . '/') {
|
|
return true;
|
|
}
|
|
}
|
|
throw new AutoloadNotAllowedException($fullPath);
|
|
}
|
|
|
|
/**
|
|
* Load the specified class
|
|
*
|
|
* @param string $class
|
|
* @return bool
|
|
* @throws AutoloadNotAllowedException
|
|
*/
|
|
public function load(string $class): bool {
|
|
$pathsToRequire = null;
|
|
if ($this->memoryCache) {
|
|
$pathsToRequire = $this->memoryCache->get($class);
|
|
}
|
|
|
|
if (class_exists($class, false)) {
|
|
return false;
|
|
}
|
|
|
|
if (!is_array($pathsToRequire)) {
|
|
// No cache or cache miss
|
|
$pathsToRequire = [];
|
|
foreach ($this->findClass($class) as $path) {
|
|
$fullPath = stream_resolve_include_path($path);
|
|
if ($fullPath && $this->isValidPath($fullPath)) {
|
|
$pathsToRequire[] = $fullPath;
|
|
}
|
|
}
|
|
|
|
if ($this->memoryCache) {
|
|
$this->memoryCache->set($class, $pathsToRequire, 60); // cache 60 sec
|
|
}
|
|
}
|
|
|
|
foreach ($pathsToRequire as $fullPath) {
|
|
require_once $fullPath;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Sets the optional low-latency cache for class to path mapping.
|
|
*
|
|
* @param \OC\Memcache\Cache $memoryCache Instance of memory cache.
|
|
*/
|
|
public function setMemoryCache(\OC\Memcache\Cache $memoryCache = null) {
|
|
$this->memoryCache = $memoryCache;
|
|
}
|
|
}
|