2013-05-07 20:16:02 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
|
|
|
* @author Georg Ehrke <georg@owncloud.com>
|
2015-10-26 12:54:55 +00:00
|
|
|
* @author Lukas Reschke <lukas@owncloud.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Markus Goetz <markus@woboq.com>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
2015-10-06 07:52:19 +00:00
|
|
|
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
|
|
|
|
*
|
|
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
|
|
* @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/>
|
|
|
|
*
|
2013-05-07 20:16:02 +00:00
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2013-05-07 20:16:02 +00:00
|
|
|
namespace OC;
|
|
|
|
|
2015-09-05 15:50:02 +00:00
|
|
|
use \OCP\AutoloadNotAllowedException;
|
|
|
|
|
2013-05-07 20:16:02 +00:00
|
|
|
class Autoloader {
|
2015-10-25 22:45:07 +00:00
|
|
|
/** @var bool */
|
2013-05-07 20:24:47 +00:00
|
|
|
private $useGlobalClassPath = true;
|
2015-10-25 22:45:07 +00:00
|
|
|
/** @var array */
|
2015-08-18 13:35:02 +00:00
|
|
|
private $validRoots = [];
|
|
|
|
|
2013-10-21 12:04:07 +00:00
|
|
|
/**
|
|
|
|
* Optional low-latency memory cache for class to path mapping.
|
2015-08-18 13:35:02 +00:00
|
|
|
*
|
2013-10-21 12:04:07 +00:00
|
|
|
* @var \OC\Memcache\Cache
|
|
|
|
*/
|
|
|
|
protected $memoryCache;
|
|
|
|
|
2015-08-18 13:35:02 +00:00
|
|
|
/**
|
|
|
|
* Autoloader constructor.
|
|
|
|
*
|
|
|
|
* @param string[] $validRoots
|
|
|
|
*/
|
|
|
|
public function __construct(array $validRoots) {
|
2015-09-16 09:47:46 +00:00
|
|
|
foreach ($validRoots as $root) {
|
|
|
|
$this->validRoots[$root] = true;
|
|
|
|
}
|
2015-08-18 13:35:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a path to the list of valid php roots for auto loading
|
|
|
|
*
|
|
|
|
* @param string $root
|
|
|
|
*/
|
|
|
|
public function addValidRoot($root) {
|
2015-09-16 09:47:46 +00:00
|
|
|
$root = stream_resolve_include_path($root);
|
|
|
|
$this->validRoots[$root] = true;
|
2015-08-18 13:35:02 +00:00
|
|
|
}
|
|
|
|
|
2013-05-07 20:24:47 +00: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-07 20:19:00 +00:00
|
|
|
/**
|
2013-05-07 20:26:55 +00:00
|
|
|
* get the possible paths for a class
|
2013-05-07 20:19:00 +00:00
|
|
|
*
|
|
|
|
* @param string $class
|
2013-05-07 20:26:55 +00:00
|
|
|
* @return array|bool an array of possible paths or false if the class is not part of ownCloud
|
2013-05-07 20:19:00 +00:00
|
|
|
*/
|
2013-05-07 20:26:55 +00:00
|
|
|
public function findClass($class) {
|
2013-05-07 20:16:02 +00:00
|
|
|
$class = trim($class, '\\');
|
|
|
|
|
2013-05-07 20:21:59 +00:00
|
|
|
$paths = array();
|
2015-10-25 22:45:07 +00:00
|
|
|
if ($this->useGlobalClassPath && array_key_exists($class, \OC::$CLASSPATH)) {
|
2013-05-07 20:21:59 +00:00
|
|
|
$paths[] = \OC::$CLASSPATH[$class];
|
2013-05-07 20:19:00 +00:00
|
|
|
/**
|
|
|
|
* @TODO: Remove this when necessary
|
|
|
|
* Remove "apps/" from inclusion path for smooth migration to mutli app dir
|
2013-05-07 20:16:02 +00:00
|
|
|
*/
|
2013-05-07 20:24:47 +00:00
|
|
|
if (strpos(\OC::$CLASSPATH[$class], 'apps/') === 0) {
|
2015-07-03 12:06:40 +00:00
|
|
|
\OCP\Util::writeLog('core', 'include path for class "' . $class . '" starts with "apps/"', \OCP\Util::DEBUG);
|
2013-05-07 20:26:55 +00:00
|
|
|
$paths[] = str_replace('apps/', '', \OC::$CLASSPATH[$class]);
|
2013-05-07 20:16:02 +00:00
|
|
|
}
|
|
|
|
} elseif (strpos($class, 'OC_') === 0) {
|
2015-11-06 12:36:19 +00:00
|
|
|
$paths[] = \OC::$SERVERROOT . '/lib/private/legacy/' . strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
|
|
|
|
$paths[] = \OC::$SERVERROOT . '/lib/private/' . strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
|
2013-05-07 20:16:02 +00:00
|
|
|
} elseif (strpos($class, 'OC\\') === 0) {
|
2015-11-06 12:36:19 +00:00
|
|
|
$split = explode('\\', $class, 3);
|
|
|
|
|
|
|
|
if (count($split) === 3) {
|
|
|
|
$split[1] = strtolower($split[1]);
|
|
|
|
|
|
|
|
if ($split[1] === 'core') {
|
|
|
|
$paths[] = \OC::$SERVERROOT . '/core/' . strtolower(str_replace('\\', '/', $split[2])) . '.php';
|
|
|
|
} else if ($split[1] === 'settings') {
|
|
|
|
$paths[] = \OC::$SERVERROOT . '/settings/' . strtolower(str_replace('\\', '/', $split[2])) . '.php';
|
|
|
|
} else {
|
|
|
|
$paths[] = \OC::$SERVERROOT . '/lib/private/' . $split[1] . '/' . strtolower(str_replace('\\', '/', $split[2])) . '.php';
|
|
|
|
}
|
|
|
|
|
|
|
|
} else {
|
|
|
|
$paths[] = \OC::$SERVERROOT . '/lib/private/' . strtolower(str_replace('\\', '/', $split[1])) . '.php';
|
|
|
|
}
|
2013-05-07 20:16:02 +00:00
|
|
|
} elseif (strpos($class, 'OCP\\') === 0) {
|
2015-11-06 12:36:19 +00:00
|
|
|
$paths[] = \OC::$SERVERROOT . '/lib/public/' . strtolower(str_replace('\\', '/', substr($class, 4)) . '.php');
|
2013-05-07 20:16:02 +00:00
|
|
|
} elseif (strpos($class, 'OCA\\') === 0) {
|
2013-05-07 22:50:33 +00:00
|
|
|
list(, $app, $rest) = explode('\\', $class, 3);
|
|
|
|
$app = strtolower($app);
|
2014-06-04 09:34:09 +00:00
|
|
|
$appPath = \OC_App::getAppPath($app);
|
2014-06-06 07:33:34 +00:00
|
|
|
if ($appPath && stream_resolve_include_path($appPath)) {
|
2014-06-04 09:34:09 +00: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-07 20:16:02 +00:00
|
|
|
}
|
|
|
|
} elseif (strpos($class, 'Test_') === 0) {
|
2015-11-06 12:36:19 +00:00
|
|
|
$paths[] = \OC::$SERVERROOT . '/tests/lib/' . strtolower(str_replace('_', '/', substr($class, 5)) . '.php');
|
2013-05-07 20:16:02 +00:00
|
|
|
} elseif (strpos($class, 'Test\\') === 0) {
|
2015-11-06 12:36:19 +00:00
|
|
|
$paths[] = \OC::$SERVERROOT . '/tests/lib/' . strtolower(str_replace('\\', '/', substr($class, 5)) . '.php');
|
2013-05-07 20:16:02 +00:00
|
|
|
}
|
2013-05-07 20:26:55 +00:00
|
|
|
return $paths;
|
|
|
|
}
|
|
|
|
|
2015-10-25 22:45:07 +00:00
|
|
|
/**
|
|
|
|
* @param string $fullPath
|
|
|
|
* @return bool
|
|
|
|
*/
|
2015-08-18 13:35:02 +00:00
|
|
|
protected function isValidPath($fullPath) {
|
2015-09-16 09:47:46 +00:00
|
|
|
foreach ($this->validRoots as $root => $true) {
|
2015-08-18 13:35:02 +00:00
|
|
|
if (substr($fullPath, 0, strlen($root) + 1) === $root . '/') {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
2015-09-05 15:50:02 +00:00
|
|
|
throw new AutoloadNotAllowedException($fullPath);
|
2015-08-18 13:35:02 +00:00
|
|
|
}
|
|
|
|
|
2013-05-07 20:26:55 +00:00
|
|
|
/**
|
|
|
|
* Load the specified class
|
|
|
|
*
|
|
|
|
* @param string $class
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function load($class) {
|
2013-10-21 12:04:07 +00:00
|
|
|
$pathsToRequire = null;
|
2013-08-17 14:01:37 +00:00
|
|
|
if ($this->memoryCache) {
|
|
|
|
$pathsToRequire = $this->memoryCache->get($class);
|
|
|
|
}
|
2013-05-07 20:16:02 +00:00
|
|
|
|
2013-10-21 12:04:07 +00:00
|
|
|
if (!is_array($pathsToRequire)) {
|
|
|
|
// No cache or cache miss
|
2013-08-17 14:01:37 +00:00
|
|
|
$pathsToRequire = array();
|
2013-10-21 12:04:07 +00:00
|
|
|
foreach ($this->findClass($class) as $path) {
|
2015-11-29 09:54:29 +00:00
|
|
|
$fullPath = stream_resolve_include_path($path);
|
2015-08-18 13:35:02 +00:00
|
|
|
if ($fullPath && $this->isValidPath($fullPath)) {
|
2013-08-17 14:01:37 +00:00
|
|
|
$pathsToRequire[] = $fullPath;
|
2013-05-07 20:26:55 +00:00
|
|
|
}
|
2013-05-07 20:21:59 +00:00
|
|
|
}
|
2013-08-17 14:01:37 +00:00
|
|
|
|
2013-10-21 13:35:52 +00:00
|
|
|
if ($this->memoryCache) {
|
|
|
|
$this->memoryCache->set($class, $pathsToRequire, 60); // cache 60 sec
|
|
|
|
}
|
2013-10-21 12:04:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($pathsToRequire as $fullPath) {
|
|
|
|
require_once $fullPath;
|
2013-05-07 20:16:02 +00:00
|
|
|
}
|
2013-10-21 12:04:07 +00:00
|
|
|
|
2013-05-07 20:16:02 +00:00
|
|
|
return false;
|
|
|
|
}
|
2013-10-21 12:04:07 +00:00
|
|
|
|
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* Sets the optional low-latency cache for class to path mapping.
|
2015-08-18 13:35:02 +00:00
|
|
|
*
|
2013-10-21 12:04:07 +00:00
|
|
|
* @param \OC\Memcache\Cache $memoryCache Instance of memory cache.
|
|
|
|
*/
|
2013-10-22 09:16:08 +00:00
|
|
|
public function setMemoryCache(\OC\Memcache\Cache $memoryCache = null) {
|
2013-10-21 12:04:07 +00:00
|
|
|
$this->memoryCache = $memoryCache;
|
|
|
|
}
|
2013-05-07 20:16:02 +00:00
|
|
|
}
|