X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Floader%2Fclass_ClassLoader.php;h=cef7d66eb9a4f6ee50afdb5ebb2531400b493696;hp=eea558055fee071088fdac0eefd59d9f53e3e2a2;hb=c62a0884fc9334024a771f706ee89cd6321868c4;hpb=2b85c64a9fedc1f93ce3495a852113c3c5b651b2

diff --git a/inc/loader/class_ClassLoader.php b/inc/loader/class_ClassLoader.php
index eea55805..cef7d66e 100644
--- a/inc/loader/class_ClassLoader.php
+++ b/inc/loader/class_ClassLoader.php
@@ -1,10 +1,21 @@
 <?php
+// Own namespace
+namespace CoreFramework\Loader;
+
+// Import framework stuff
+use CoreFramework\Configuration\FrameworkConfiguration;
+use CoreFramework\Object\BaseFrameworkSystem;
+
+// Import SPL stuff
+use \RecursiveDirectoryIterator;
+use \RecursiveIteratorIterator;
+
 /**
  * This class loads class include files with a specific prefix and suffix
  *
  * @author		Roland Haeder <webmaster@shipsimu.org>
- * @version		0.0.0
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
+ * @version		1.5.0
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  * @license		GNU GPL 3.0 or any newer version
  * @link		http://www.shipsimu.org
  *
@@ -22,6 +33,10 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  * ----------------------------------
+ * 1.5
+ *  - Namespace scheme Project\Package[\SubPackage...] is fully supported and
+ *    throws an E_USER_WARNING if not present. The last part will be always the
+ *    class' name.
  * 1.4
  *  - Some comments improved, other minor improvements
  * 1.3
@@ -104,7 +119,7 @@ class ClassLoader {
 	private static $frameworkPaths = array(
 		'exceptions', // Exceptions
 		'interfaces', // Interfaces
-		'main',       // General main classes
+		'classes',    // Classes
 		'middleware'  // The middleware
 	);
 
@@ -133,7 +148,7 @@ class ClassLoader {
 		// Skip here if already cached
 		if ($this->listCached === FALSE) {
 			// Writes the cache file of our list away
-			$cacheContent = serialize($this->classes);
+			$cacheContent = json_encode($this->classes);
 			file_put_contents($this->listCacheFQFN, $cacheContent);
 		} // END - if
 
@@ -178,9 +193,9 @@ class ClassLoader {
 		$loaderInstance = self::getSelfInstance();
 
 		// Load all classes
-		foreach (self::$frameworkPaths as $className) {
+		foreach (self::$frameworkPaths as $pathName) {
 			// Try to load the framework classes
-			$loaderInstance->scanClassPath('inc/classes/' . $className . '/');
+			$loaderInstance->scanClassPath('inc/main/' . $pathName . '/');
 		} // END - foreach
 	}
 
@@ -235,19 +250,19 @@ class ClassLoader {
 		} // END - if
 
 		// IS the cache there?
-		if (file_exists($this->listCacheFQFN)) {
+		if (BaseFrameworkSystem::isReadableFile($this->listCacheFQFN)) {
 			// Get content
 			$cacheContent = file_get_contents($this->listCacheFQFN);
 
 			// And convert it
-			$this->classes = unserialize($cacheContent);
+			$this->classes = json_decode($cacheContent);
 
 			// List has been restored from cache!
 			$this->listCached = TRUE;
 		} // END - if
 
 		// Does the class cache exist?
-		if (file_exists($this->classCacheFQFN)) {
+		if (BaseFrameworkSystem::isReadableFile($this->listCacheFQFN)) {
 			// Then include it
 			require($this->classCacheFQFN);
 
@@ -297,54 +312,71 @@ class ClassLoader {
 			return;
 		} // END - if
 
+		// Keep it in class for later usage
+		$this->ignoreList = $ignoreList;
+
 		/*
-		 * Directories which this class loader ignores by default while
-		 * scanning the whole directory structure starting from given base
-		 * path.
+		 * Ignore .htaccess by default as it is for protection of directories
+		 * on Apache servers.
 		 */
-		array_push($ignoreList, '.');
-		array_push($ignoreList, '..');
 		array_push($ignoreList, '.htaccess');
-		array_push($ignoreList, '.svn');
-
-		// Keep it in class for later usage
-		$this->ignoreList = $ignoreList;
 
 		/*
-		 * Set base directory which holds all our classes, we should use an
-		 * absolute path here so is_dir(), is_file() and so on will always
+		 * Set base directory which holds all our classes, an absolute path
+		 * should be used here so is_dir(), is_file() and so on will always
 		 * find the correct files and dirs.
 		 */
 		$basePath2 = realpath($basePath);
 
 		// If the basePath is FALSE it is invalid
 		if ($basePath2 === FALSE) {
-			/* @todo: Do not die here. */
-			exit(__METHOD__ . ':Cannot read ' . $basePath . ' !');
+			/* @TODO: Do not exit here. */
+			exit(__METHOD__ . ': Cannot read ' . $basePath . ' !' . PHP_EOL);
 		} else {
 			// Set base path
 			$basePath = $basePath2;
 		}
 
 		// Get a new iterator
-		//* DEBUG: */ echo "<strong>Base path: {$basePath}</strong><br />\n";
-		$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($basePath));
+		/* NOISY-DEBUG: */ printf('[%s:%d] basePath=%s' . PHP_EOL, __METHOD__, __LINE__, $basePath);
+		$iteratorInstance = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($basePath), RecursiveIteratorIterator::CHILD_FIRST);
+
+		// Load all entries
+		while ($iteratorInstance->valid()) {
+			// Get current entry
+			$currentEntry = $iteratorInstance->current();
 
-		foreach ($iterator as $entry) {
 			// Get filename from iterator
-			$fileName = $entry->getFileName();
+			$fileName = $currentEntry->getFileName();
+
+			// Get the "FQFN" (path and file name)
+			$fqfn = $currentEntry->getRealPath();
+
+			// Current entry must be a file, not smaller than 100 bytes and not on ignore list 
+			if ((!$currentEntry->isFile()) || (in_array($fileName, $this->ignoreList)) || (filesize($fqfn) < 100)) {
+				// Advance to next entry
+				$iteratorInstance->next();
 
-			// Get the FQFN and add it to our class list
-			$fqfn = $entry->getRealPath();
+				// Skip non-file entries
+				/* NOISY-DEBUG: */ printf('[%s:%d] SKIP: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
+				continue;
+			} // END - if
 
 			// Is this file wanted?
-			//* DEBUG: */ echo "FOUND:{$fileName}<br />\n";
-			if ((!in_array($fileName, $this->ignoreList)) && (filesize($fqfn) > 100) && (substr($fileName, 0, strlen($this->prefix)) == $this->prefix) && (substr($fileName, -strlen($this->suffix), strlen($this->suffix)) == $this->suffix)) {
-				//* DEBUG: */ echo "ADD: {$fileName}<br />\n";
+			/* NOISY-DEBUG: */ printf('[%s:%d] FOUND: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
+			if ((substr($fileName, 0, strlen($this->prefix)) == $this->prefix) && (substr($fileName, -strlen($this->suffix), strlen($this->suffix)) == $this->suffix)) {
 				// Add it to the list
+				/* NOISY-DEBUG: */ printf('[%s:%d] ADD: %s,fqfn=%s' . PHP_EOL, __METHOD__, __LINE__, $fileName, $fqfn);
 				$this->classes[$fileName] = $fqfn;
-			} // END - if
-		} // END - foreach
+			} else {
+				// Not added
+				/* NOISY-DEBUG: */ printf('[%s:%d] NOT ADDED: %s,fqfn=%s' . PHP_EOL, __METHOD__, __LINE__, $fileName, $fqfn);
+			}
+
+			// Advance to next entry
+			/* NOISY-DEBUG: */ printf('[%s:%d] NEXT: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
+			$iteratorInstance->next();
+		} // END - while
 	}
 
 	/**
@@ -377,35 +409,53 @@ class ClassLoader {
 	 * missing classes or interfaces. So if you use class_exists() this method
 	 * does not interrupt your program.
 	 *
-	 * @param	$className	The class we shall load
+	 * @param	$className	The class that shall be loaded
 	 * @return	void
 	 */
 	public function includeClass ($className) {
+		// The class name should contain at least 2 back-slashes, so split at them
+		$classNameParts = explode("\\", $className);
+
+		// At least 3 parts should be there
+		if (count($classNameParts) < 3) {
+			// Namespace scheme is: Project\Package[\SubPackage...]
+			trigger_error(sprintf('Class name "%s" is not after naming-convention: Project\Package[\SubPackage...]', $className), E_USER_WARNING);
+		} // END - if
+
+		// Get last element
+		$shortClassName = array_pop($classNameParts);
+
 		// Create a name with prefix and suffix
-		$fileName = $this->prefix . $className . $this->suffix;
+		$fileName = $this->prefix . $shortClassName . $this->suffix;
 
 		// Now look it up in our index
+		/* NOISY-DEBUG: */ printf('[%s:%d] ISSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
 		if ((isset($this->classes[$fileName])) && (!in_array($this->classes[$fileName], $this->loadedClasses))) {
 			// File is found and not loaded so load it only once
-			//* DEBUG: */ echo "LOAD: ".$fileName." - Start<br />\n";
+			/* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - START' . PHP_EOL, __METHOD__, __LINE__, $fileName);
 			require($this->classes[$fileName]);
-			//* DEBUG: */ echo "LOAD: ".$fileName." - End<br />\n";
+			/* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - END' . PHP_EOL, __METHOD__, __LINE__, $fileName);
 
-			// Count this include
+			// Count this loaded class/interface/exception
 			$this->total++;
 
-			// Mark this class as loaded
+			// Mark this class as loaded for other purposes than loading it.
 			array_push($this->loadedClasses, $this->classes[$fileName]);
 
-			// Remove it from classes list
+			// Remove it from classes list so it won't be found twice.
+			/* NOISY-DEBUG: */ printf('[%s:%d] UNSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
 			unset($this->classes[$fileName]);
 
 			// Developer mode excludes caching (better debugging)
 			if (!defined('DEVELOPER')) {
 				// Reset cache
+				/* NOISY-DEBUG: */ printf('[%s:%d] classesCached=FALSE' . PHP_EOL, __METHOD__, __LINE__);
 				$this->classesCached = FALSE;
 			} // END - if
-		} // END - if
+		} else {
+			// Not found
+			/* NOISY-DEBUG: */ printf('[%s:%d] 404: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
+		}
 	}
 
 	/**
@@ -422,6 +472,7 @@ class ClassLoader {
 				require($fqfn);
 
 				// Remove it from the list
+				/* NOISY-DEBUG: */ printf('[%s:%d] UNSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
 				unset($this->classes[$fileName]);
 			} // END - if
 		} // END - foreach
@@ -437,7 +488,7 @@ class ClassLoader {
 	}
 
 	/**
-	 * Getter for a printable list of included classes/interfaces/exceptions
+	 * Getter for a printable list of included main/interfaces/exceptions
 	 *
 	 * @param	$includeList	A printable include list
 	 */
@@ -451,7 +502,5 @@ class ClassLoader {
 		// And return it
 		return $includeList;
 	}
-}
 
-// [EOF]
-?>
+}