nextcloud/lib/autoloader.php

191 lines
5.4 KiB
PHP
Raw Normal View History

2013-05-08 00:16:02 +04:00
<?php
declare(strict_types=1);
2013-05-08 00:16:02 +04:00
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @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>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Markus Goetz <markus@woboq.com>
* @author Morris Jobke <hey@morrisjobke.de>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2016-07-21 18:07:57 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
2016-01-12 17:02:16 +03:00
* @author Vincent Petry <pvince81@owncloud.com>
2015-03-26 13:44:34 +03:00
*
* @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/>
2015-03-26 13:44:34 +03:00
*
2013-05-08 00:16:02 +04:00
*/
2013-05-08 00:16:02 +04:00
namespace OC;
use \OCP\AutoloadNotAllowedException;
use OCP\ILogger;
2013-05-08 00:16:02 +04:00
class Autoloader {
/** @var bool */
private $useGlobalClassPath = true;
/** @var array */
2015-08-18 16:35:02 +03:00
private $validRoots = [];
/**
* Optional low-latency memory cache for class to path mapping.
2015-08-18 16:35:02 +03:00
*
* @var \OC\Memcache\Cache
*/
protected $memoryCache;
2015-08-18 16:35:02 +03:00
/**
* Autoloader constructor.
*
* @param string[] $validRoots
*/
public function __construct(array $validRoots) {
foreach ($validRoots as $root) {
$this->validRoots[$root] = true;
}
2015-08-18 16:35:02 +03:00
}
/**
* 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;
2015-08-18 16:35:02 +03:00
}
/**
* 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;
}
2013-05-08 00:19:00 +04:00
/**
* get the possible paths for a class
2013-05-08 00:19:00 +04:00
*
* @param string $class
* @return array an array of possible paths
2013-05-08 00:19:00 +04:00
*/
public function findClass(string $class): array {
2013-05-08 00:16:02 +04:00
$class = trim($class, '\\');
$paths = [];
if ($this->useGlobalClassPath && array_key_exists($class, \OC::$CLASSPATH)) {
$paths[] = \OC::$CLASSPATH[$class];
2013-05-08 00:19:00 +04:00
/**
* @TODO: Remove this when necessary
* Remove "apps/" from inclusion path for smooth migration to multi app dir
2013-05-08 00:16:02 +04:00
*/
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]);
2013-05-08 00:16:02 +04:00
}
} elseif (strpos($class, 'OC_') === 0) {
$paths[] = \OC::$SERVERROOT . '/lib/private/legacy/' . strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
2013-05-08 00:16:02 +04:00
} elseif (strpos($class, 'OCA\\') === 0) {
list(, $app, $rest) = explode('\\', $class, 3);
$app = strtolower($app);
2014-06-04 13:34:09 +04:00
$appPath = \OC_App::getAppPath($app);
2014-06-06 11:33:34 +04:00
if ($appPath && stream_resolve_include_path($appPath)) {
2014-06-04 13:34:09 +04:00
$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');
2013-05-08 00:16:02 +04:00
}
} 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';
2013-05-08 00:16:02 +04:00
}
return $paths;
}
/**
* @param string $fullPath
* @return bool
* @throws AutoloadNotAllowedException
*/
protected function isValidPath(string $fullPath): bool {
foreach ($this->validRoots as $root => $true) {
2015-08-18 16:35:02 +03:00
if (substr($fullPath, 0, strlen($root) + 1) === $root . '/') {
return true;
}
}
throw new AutoloadNotAllowedException($fullPath);
2015-08-18 16:35:02 +03:00
}
/**
* 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);
}
2013-05-08 00:16:02 +04:00
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);
2015-08-18 16:35:02 +03:00
if ($fullPath && $this->isValidPath($fullPath)) {
$pathsToRequire[] = $fullPath;
}
}
2013-10-21 17:35:52 +04:00
if ($this->memoryCache) {
$this->memoryCache->set($class, $pathsToRequire, 60); // cache 60 sec
}
}
foreach ($pathsToRequire as $fullPath) {
require_once $fullPath;
2013-05-08 00:16:02 +04:00
}
2013-05-08 00:16:02 +04:00
return false;
}
/**
* Sets the optional low-latency cache for class to path mapping.
2015-08-18 16:35:02 +03:00
*
* @param \OC\Memcache\Cache $memoryCache Instance of memory cache.
*/
public function setMemoryCache(\OC\Memcache\Cache $memoryCache = null) {
$this->memoryCache = $memoryCache;
}
2013-05-08 00:16:02 +04:00
}