Merge pull request #3272 from owncloud/legacy-autoloader

Move autoloader to it's own class

3 files changed, 198 insertions, 62 deletions

diff --git a/lib/autoloader.php b/lib/autoloader.php
new file mode 100644
index 00000000000..9615838a9a2
--- /dev/null
+++ b/lib/autoloader.php
@@ -0,0 +1,126 @@
+<?php
+/**
+ * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OC;
+
+class Autoloader {
+	private $useGlobalClassPath = true;
+
+	private $prefixPaths = array();
+
+	private $classPaths = array();
+
+	/**
+	 * Add a custom prefix to the autoloader
+	 *
+	 * @param string $prefix
+	 * @param string $path
+	 */
+	public function registerPrefix($prefix, $path) {
+		$this->prefixPaths[$prefix] = $path;
+	}
+
+	/**
+	 * Add a custom classpath to the autoloader
+	 *
+	 * @param string $class
+	 * @param string $path
+	 */
+	public function registerClass($class, $path) {
+		$this->classPaths[$class] = $path;
+	}
+
+	/**
+	 * 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|bool an array of possible paths or false if the class is not part of ownCloud
+	 */
+	public function findClass($class) {
+		$class = trim($class, '\\');
+
+		$paths = array();
+		if (array_key_exists($class, $this->classPaths)) {
+			$paths[] = $this->classPaths[$class];
+		} else if ($this->useGlobalClassPath and array_key_exists($class, \OC::$CLASSPATH)) {
+			$paths[] = \OC::$CLASSPATH[$class];
+			/**
+			 * @TODO: Remove this when necessary
+			 * Remove "apps/" from inclusion path for smooth migration to mutli app dir
+			 */
+			if (strpos(\OC::$CLASSPATH[$class], 'apps/') === 0) {
+				\OC_Log::write('core', 'include path for class "' . $class . '" starts with "apps/"', \OC_Log::DEBUG);
+				$paths[] = str_replace('apps/', '', \OC::$CLASSPATH[$class]);
+			}
+		} elseif (strpos($class, 'OC_') === 0) {
+			// first check for legacy classes if underscores are used
+			$paths[] = 'legacy/' . strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
+			$paths[] = strtolower(str_replace('_', '/', substr($class, 3)) . '.php');
+		} elseif (strpos($class, 'OC\\') === 0) {
+			$paths[] = strtolower(str_replace('\\', '/', substr($class, 3)) . '.php');
+		} elseif (strpos($class, 'OCP\\') === 0) {
+			$paths[] = 'public/' . strtolower(str_replace('\\', '/', substr($class, 4)) . '.php');
+		} elseif (strpos($class, 'OCA\\') === 0) {
+			list(, $app, $rest) = explode('\\', $class, 3);
+			$app = strtolower($app);
+			foreach (\OC::$APPSROOTS as $appDir) {
+				if (stream_resolve_include_path($appDir['path'] . '/' . $app)) {
+					$paths[] = $appDir['path'] . '/' . $app . '/' . strtolower(str_replace('\\', '/', $rest) . '.php');
+					// If not found in the root of the app directory, insert '/lib' after app id and try again.
+					$paths[] = $appDir['path'] . '/' . $app . '/lib/' . strtolower(str_replace('\\', '/', $rest) . '.php');
+				}
+			}
+		} elseif (strpos($class, 'Test_') === 0) {
+			$paths[] = 'tests/lib/' . strtolower(str_replace('_', '/', substr($class, 5)) . '.php');
+		} elseif (strpos($class, 'Test\\') === 0) {
+			$paths[] = 'tests/lib/' . strtolower(str_replace('\\', '/', substr($class, 5)) . '.php');
+		} else {
+			foreach ($this->prefixPaths as $prefix => $dir) {
+				if (0 === strpos($class, $prefix)) {
+					$path = str_replace('\\', DIRECTORY_SEPARATOR, $class) . '.php';
+					$path = str_replace('_', DIRECTORY_SEPARATOR, $path);
+					$paths[] = $dir . '/' . $path;
+				}
+			}
+		}
+		return $paths;
+	}
+
+	/**
+	 * Load the specified class
+	 *
+	 * @param string $class
+	 * @return bool
+	 */
+	public function load($class) {
+		$paths = $this->findClass($class);
+
+		if (is_array($paths)) {
+			foreach ($paths as $path) {
+				if ($fullPath = stream_resolve_include_path($path)) {
+					require_once $fullPath;
+				}
+			}
+		}
+		return false;
+	}
+}
diff --git a/lib/base.php b/lib/base.php
index 8633ae9b637..667202d3aef 100644
--- a/lib/base.php
+++ b/lib/base.php
@@ -75,61 +75,9 @@ class OC {
 	protected static $router = null;
 
 	/**
-	 * SPL autoload
+	 * @var \OC\Autoloader $loader
 	 */
-	public static function autoload($className) {
-		$className = trim($className, '\\');
-		
-		if (array_key_exists($className, OC::$CLASSPATH)) {
-			$path = OC::$CLASSPATH[$className];
-			/** @TODO: Remove this when necessary
-			Remove "apps/" from inclusion path for smooth migration to mutli app dir
-			 */
-			if (strpos($path, 'apps/') === 0) {
-				OC_Log::write('core', 'include path for class "' . $className . '" starts with "apps/"', OC_Log::DEBUG);
-				$path = str_replace('apps/', '', $path);
-			}
-		} elseif (strpos($className, 'OC_') === 0) {
-			$path = strtolower(str_replace('_', '/', substr($className, 3)) . '.php');
-		} elseif (strpos($className, 'OC\\') === 0) {
-			$path = strtolower(str_replace('\\', '/', substr($className, 3)) . '.php');
-		} elseif (strpos($className, 'OCP\\') === 0) {
-			$path = 'public/' . strtolower(str_replace('\\', '/', substr($className, 3)) . '.php');
-		} elseif (strpos($className, 'OCA\\') === 0) {
-			foreach (self::$APPSROOTS as $appDir) {
-				$path = strtolower(str_replace('\\', '/', substr($className, 4)) . '.php');
-				$fullPath = stream_resolve_include_path($appDir['path'] . '/' . $path);
-				if (file_exists($fullPath)) {
-					require_once $fullPath;
-					return false;
-				}
-				// If not found in the root of the app directory, insert '/lib' after app id and try again.
-				$libpath = substr($path, 0, strpos($path, '/')) . '/lib' . substr($path, strpos($path, '/'));
-				$fullPath = stream_resolve_include_path($appDir['path'] . '/' . $libpath);
-				if (file_exists($fullPath)) {
-					require_once $fullPath;
-					return false;
-				}
-			}
-		} elseif (strpos($className, 'Sabre_') === 0) {
-			$path = str_replace('_', '/', $className) . '.php';
-		} elseif (strpos($className, 'Symfony\\Component\\Routing\\') === 0) {
-			$path = 'symfony/routing/' . str_replace('\\', '/', $className) . '.php';
-		} elseif (strpos($className, 'Sabre\\VObject') === 0) {
-			$path = str_replace('\\', '/', $className) . '.php';
-		} elseif (strpos($className, 'Test_') === 0) {
-			$path = 'tests/lib/' . strtolower(str_replace('_', '/', substr($className, 5)) . '.php');
-		} elseif (strpos($className, 'Test\\') === 0) {
-			$path = 'tests/lib/' . strtolower(str_replace('\\', '/', substr($className, 5)) . '.php');
-		} else {
-			return false;
-		}
-
-		if ($fullPath = stream_resolve_include_path($path)) {
-			require_once $fullPath;
-		}
-		return false;
-	}
+	public static $loader = null;
 
 	public static function initPaths() {
 		// calculate the root directories
@@ -396,8 +344,14 @@ class OC {
 
 	public static function init() {
 		// register autoloader
-		spl_autoload_register(array('OC', 'autoload'));
-		OC_Util::issetlocaleworking();
+		require_once __DIR__ . '/autoloader.php';
+		self::$loader=new \OC\Autoloader();
+		self::$loader->registerPrefix('Doctrine\\Common', 'doctrine/common/lib');
+		self::$loader->registerPrefix('Doctrine\\DBAL', 'doctrine/dbal/lib');
+		self::$loader->registerPrefix('Symfony\\Component\\Routing', 'symfony/routing');
+		self::$loader->registerPrefix('Sabre\\VObject', '3rdparty');
+		self::$loader->registerPrefix('Sabre_', '3rdparty');
+		spl_autoload_register(array(self::$loader, 'load'));
 
 		// set some stuff
 		//ob_start();
@@ -454,6 +408,7 @@ class OC {
 		}
 
 		self::initPaths();
+		OC_Util::issetlocaleworking();
 
 		// set debug mode if an xdebug session is active
 		if (!defined('DEBUG') || !DEBUG) {
@@ -643,7 +598,7 @@ class OC {
 			
 			// Deny the redirect if the URL contains a @
 			// This prevents unvalidated redirects like ?redirect_url=:user@domain.com
-			if (strpos($location, '@') === FALSE) {
+			if (strpos($location, '@') === false) {
 				header('Location: ' . $location);
 				return;
 			}
diff --git a/tests/lib/autoloader.php b/tests/lib/autoloader.php
index e769bf3bcf6..0e7d606ccf6 100644
--- a/tests/lib/autoloader.php
+++ b/tests/lib/autoloader.php
@@ -6,14 +6,69 @@
  * See the COPYING-README file.
  */
 
-class Test_AutoLoader extends PHPUnit_Framework_TestCase {
+namespace Test;
 
-	public function testLeadingSlashOnClassName(){
-		$this->assertTrue(class_exists('\OC\Files\Storage\Local'));
+class AutoLoader extends \PHPUnit_Framework_TestCase {
+	/**
+	 * @var \OC\Autoloader $loader
+	 */
+	private $loader;
+
+	public function setUp() {
+		$this->loader = new \OC\AutoLoader();
+	}
+
+	public function testLeadingSlashOnClassName() {
+		$this->assertEquals(array('files/storage/local.php'), $this->loader->findClass('\OC\Files\Storage\Local'));
+	}
+
+	public function testNoLeadingSlashOnClassName() {
+		$this->assertEquals(array('files/storage/local.php'), $this->loader->findClass('OC\Files\Storage\Local'));
+	}
+
+	public function testLegacyPath() {
+		$this->assertEquals(array('legacy/files.php', 'files.php'), $this->loader->findClass('OC_Files'));
+	}
+
+	public function testClassPath() {
+		$this->loader->registerClass('Foo\Bar', 'foobar.php');
+		$this->assertEquals(array('foobar.php'), $this->loader->findClass('Foo\Bar'));
+	}
+
+	public function testPrefixNamespace() {
+		$this->loader->registerPrefix('Foo', 'foo');
+		$this->assertEquals(array('foo/Foo/Bar.php'), $this->loader->findClass('Foo\Bar'));
 	}
 
-	public function testNoLeadingSlashOnClassName(){
-		$this->assertTrue(class_exists('OC\Files\Storage\Local'));
+	public function testPrefix() {
+		$this->loader->registerPrefix('Foo_', 'foo');
+		$this->assertEquals(array('foo/Foo/Bar.php'), $this->loader->findClass('Foo_Bar'));
 	}
 
+	public function testLoadTestNamespace() {
+		$this->assertEquals(array('tests/lib/foo/bar.php'), $this->loader->findClass('Test\Foo\Bar'));
+	}
+
+	public function testLoadTest() {
+		$this->assertEquals(array('tests/lib/foo/bar.php'), $this->loader->findClass('Test_Foo_Bar'));
+	}
+
+	public function testLoadCoreNamespace() {
+		$this->assertEquals(array('foo/bar.php'), $this->loader->findClass('OC\Foo\Bar'));
+	}
+
+	public function testLoadCore() {
+		$this->assertEquals(array('legacy/foo/bar.php', 'foo/bar.php'), $this->loader->findClass('OC_Foo_Bar'));
+	}
+
+	public function testLoadPublicNamespace() {
+		$this->assertEquals(array('public/foo/bar.php'), $this->loader->findClass('OCP\Foo\Bar'));
+	}
+
+	public function testLoadAppNamespace() {
+		$result = $this->loader->findClass('OCA\Files\Foobar');
+		$this->assertEquals(2, count($result));
+		$this->assertStringEndsWith('apps/files/foobar.php', $result[0]);
+		$this->assertStringEndsWith('apps/files/lib/foobar.php', $result[1]);
+	}
 }