Move shared module directory code to a shared file and support autoloading module interfaces

auth/admin/classes/common/Utility.php

@@ -68,7 +68,9 @@ public function getCORALPath(){
 	//returns page URL up to /coral/
 	public function getCORALURL(){
 		$pageURL = 'http';
-		if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
+    if (isset($_SERVER["HTTPS"]) && $_SERVER["HTTPS"] == "on") {
+      $pageURL .= "s";
+    }
 		$pageURL .= "://";
 		if ($_SERVER["SERVER_PORT"] != "80") {
 		  $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"];

auth/directory.php

@@ -1,5 +1,4 @@
 <?php
-
 /*
 **************************************************************************************************************************
 ** CORAL Usage Statistics Reporting Module v. 1.0
@@ -17,64 +16,9 @@
 **************************************************************************************************************************
 */
 
-
-// Useful directory constants, ending with |/|.
-define('ADMIN_DIR', dirname(__FILE__) . '/admin/');
+// Define the MODULE base directory, ending with |/|.
 define('BASE_DIR', dirname(__FILE__) . '/');
-define('CLASSES_DIR', ADMIN_DIR . 'classes/');
-
-// Automatically load undefined classes from subdirectories of |CLASSES_DIR|.
-function __autoload( $className ) {
-	if (file_exists(CLASSES_DIR) && is_readable(CLASSES_DIR) && is_dir(CLASSES_DIR)) {
-		$directory = dir(CLASSES_DIR);
-
-		// Iterate over the files and directories in |CLASSES_DIR|.
-		while (false !== ($entry = $directory->read())) {
-			$path = CLASSES_DIR . $entry;
-
-			// Look only at subdirectories
-			if (is_dir($path)) {
-				$filename = $path . '/' . $className . '.php';
-				if (file_exists($filename) && is_readable($filename) && is_file($filename)) {
-					// Could probably safely use |require()| here, since |__autoload()| is only called when a class isn't loaded.
-					require_once($filename);
-				}
-			}
-		}
-		$directory->close();
-	}
-}
-
-// Add lcfirst() for PHP < 5.3.0
-if (false === function_exists('lcfirst')) {
-	function lcfirst($string) {
-		return strtolower(substr($string, 0, 1)) . substr($string, 1);
-	}
-}
-
-
-
-//fix default timezone for PHP > 5.3
-if(function_exists("date_default_timezone_set") and function_exists("date_default_timezone_get")){
-	@date_default_timezone_set(@date_default_timezone_get());
-}
 
-// Include file of language codes
-include_once 'LangCodes.php';
-$lang_name = new LangCodes();
+require_once "../common/common_directory.php";
 
-// Verify the language of the browser
-    global $http_lang;
-    if(isset($_COOKIE["lang"])){
-        $http_lang = $_COOKIE["lang"];
-    }else{
-	    $codeL = str_replace("-","_",substr($_SERVER["HTTP_ACCEPT_LANGUAGE"],0,5));
-	    $http_lang = $lang_name->getLanguage($codeL);
-	    if($http_lang == "")
-	      $http_lang = "en_US";
-    }
-    putenv("LC_ALL=$http_lang");
-	setlocale(LC_ALL, $http_lang.".utf8");
-	bindtextdomain("messages", dirname(__FILE__) . "/locale");
-	textdomain("messages");
 ?>

common/common_directory.php

@@ -0,0 +1,111 @@
+<?php
+
+/*
+**************************************************************************************************************************
+** CORAL Common Directory
+**
+** Copyright (c) 2010 University of Notre Dame
+**
+** This file is part of CORAL.
+**
+** CORAL is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+**
+** CORAL 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 General Public License for more details.
+**
+** You should have received a copy of the GNU General Public License along with CORAL.  If not, see <http://www.gnu.org/licenses/>.
+**
+**************************************************************************************************************************
+*/
+
+// Increase memory due to large sized reports
+ini_set('max_execution_time', 1000);
+ini_set("default_socket_timeout", 1000);
+ini_set('memory_limit', '256M');
+
+define('ADMIN_DIR', BASE_DIR . 'admin/');
+define('CLASSES_DIR', ADMIN_DIR . 'classes/');
+define('INTERFACES_DIR', ADMIN_DIR . 'interfaces/');
+
+// Automatically load undefined classes from subdirectories of |CLASSES_DIR|.
+spl_autoload_register( function ($className) {
+	$directories = array(CLASSES_DIR,INTERFACES_DIR);
+	foreach ($directories as $currentDirectory) {
+		if (file_exists($currentDirectory) && is_readable($currentDirectory) && is_dir($currentDirectory)) {
+			$directory = dir($currentDirectory);
+			// Iterate over the files and directories in |CLASSES_DIR|.
+			while (false !== ($entry = $directory->read())) {
+				$path = $currentDirectory . $entry;
+				// Look only at subdirectories
+				if (is_dir($path)) {
+					$filename = $path . '/' . $className . '.php';
+					if (file_exists($filename) && is_readable($filename) && is_file($filename)) {
+						// Could probably safely use |require()| here, since |__autoload()| is only called when a class isn't loaded.
+						require_once($filename);
+						break;
+					}
+				}
+			}
+			$directory->close();
+		}
+	}
+});
+
+
+// Add lcfirst() for PHP < 5.3.0
+if (false === function_exists('lcfirst')) {
+	function lcfirst($string) {
+		return strtolower(substr($string, 0, 1)) . substr($string, 1);
+	}
+}
+
+//fix default timezone for PHP > 5.3
+if(function_exists("date_default_timezone_set") and function_exists("date_default_timezone_get")){
+	@date_default_timezone_set(@date_default_timezone_get());
+}
+
+
+function format_date($mysqlDate) {
+
+	//see http://php.net/manual/en/function.date.php for options
+
+	//there is a dependence on strtotime recognizing date format for date inputs
+	//thus, european format (d-m-Y) must use dashes rather than slashes
+
+	//upper case Y = four digit year
+	//lower case y = two digit year
+	//make sure digit years matches for both directory.php and common.js
+
+	//SUGGESTED: "m/d/Y" or "d-m-Y"
+
+	return date("m/d/Y", strtotime($mysqlDate));
+
+}
+
+function debug($value) {
+  echo '<pre>'.print_r($value, true).'</pre>';
+}
+
+// Include file of language codes
+include_once BASE_DIR . '/../LangCodes.php';
+$lang_name = new LangCodes();
+
+// Verify the language of the browser
+$GLOBALS['http_lang'];
+
+if(isset($_COOKIE["lang"])) {
+	$GLOBALS['http_lang'] = $_COOKIE["lang"];
+} else {
+	$codeL = str_replace("-","_",substr($_SERVER["HTTP_ACCEPT_LANGUAGE"],0,5));
+	$GLOBALS['http_lang'] = $lang_name->getLanguage($codeL);
+
+	if($GLOBALS['http_lang'] == "") {
+		$GLOBALS['http_lang'] = "en_US";
+	}
+}
+
+putenv("LC_ALL={$GLOBALS['http_lang']}");
+setlocale(LC_ALL, "{$GLOBALS['http_lang']}.utf8");
+bindtextdomain("messages", BASE_DIR."locale");
+textdomain("messages");
+
+?>

licensing/directory.php

@@ -16,80 +16,9 @@
 **************************************************************************************************************************
 */
 
-// Useful directory constants, ending with |/|.
-define('ADMIN_DIR', dirname(__FILE__) . '/admin/');
+// Define the MODULE base directory, ending with |/|.
 define('BASE_DIR', dirname(__FILE__) . '/');
-define('CLASSES_DIR', ADMIN_DIR . 'classes/');
 
-// Automatically load undefined classes from subdirectories of |CLASSES_DIR|.
-function __autoload( $className ) {
-	if (file_exists(CLASSES_DIR) && is_readable(CLASSES_DIR) && is_dir(CLASSES_DIR)) {
-		$directory = dir(CLASSES_DIR);
+require_once "../common/common_directory.php";
 
-		// Iterate over the files and directories in |CLASSES_DIR|.
-		while (false !== ($entry = $directory->read())) {
-			$path = CLASSES_DIR . $entry;
-
-			// Look only at subdirectories
-			if (is_dir($path)) {
-				$filename = $path . '/' . $className . '.php';
-				if (file_exists($filename) && is_readable($filename) && is_file($filename)) {
-					// Could probably safely use |require()| here, since |__autoload()| is only called when a class isn't loaded.
-					require_once($filename);
-				}
-			}
-		}
-		$directory->close();
-	}
-}
-
-// Add lcfirst() for PHP < 5.3.0
-if (false === function_exists('lcfirst')) {
-	function lcfirst($string) {
-		return strtolower(substr($string, 0, 1)) . substr($string, 1);
-	}
-}
-
-
-//fix default timezone for PHP > 5.3
-if(function_exists("date_default_timezone_set") and function_exists("date_default_timezone_get")){
-	@date_default_timezone_set(@date_default_timezone_get());
-}
-
-
-function format_date($mysqlDate) {
-
-	//see http://php.net/manual/en/function.date.php for options
-
-	//there is a dependence on strtotime recognizing date format for date inputs
-	//thus, european format (d-m-Y) must use dashes rather than slashes
-
-	//upper case Y = four digit year
-	//lower case y = two digit year
-	//make sure digit years matches for both directory.php and common.js
-
-	//SUGGESTED: "m/d/Y" or "d-m-Y"
-
-	return date("m/d/Y", strtotime($mysqlDate));
-
-}
-
-// Include file of language codes
-include_once 'LangCodes.php';
-$lang_name = new LangCodes();
-
-// Verify the language of the browser
-global $http_lang;
-if(isset($_COOKIE["lang"])){
-    $http_lang = $_COOKIE["lang"];
-}else{
-    $codeL = str_replace("-","_",substr($_SERVER["HTTP_ACCEPT_LANGUAGE"],0,5));
-    $http_lang = $lang_name->getLanguage($codeL);
-    if($http_lang == "")
-      $http_lang = "en_US";
-}
-putenv("LC_ALL=$http_lang");
-setlocale(LC_ALL, $http_lang.".utf8");
-bindtextdomain("messages", dirname(__FILE__) . "/locale");
-textdomain("messages");
 ?>