Session abstraction (Pr68 on previous repo)

resources/admin.php

@@ -23,7 +23,7 @@
 include 'templates/header.php';
 
 //set referring page
-$_SESSION['ref_script']=$currentPage;
+CoralSession::set('ref_script', $currentPage);
 
 $config = new Configuration;
 

resources/admin/classes/common/CoralSession.php

@@ -0,0 +1,33 @@
+<?php
+
+class CoralSession
+{
+  private static $opened;
+
+  private static function open_for_read() {
+    if (!isset(self::$opened)) {
+       session_start();
+       session_write_close();
+       self::$opened = true;
+     }
+  }
+
+  public static function get($key) {
+    self::open_for_read();
+    if (isset($_SESSION[$key])) {
+      return $_SESSION[$key];
+    } else {
+      return null;
+    }
+  }
+
+  public static function set($key, $value) {
+    session_start();
+    $_SESSION[$key] = $value;
+    session_write_close();
+    self::$opened = true;
+  }
+
+}
+
+?>

resources/admin/classes/domain/Resource.php

@@ -996,18 +996,18 @@ public static function setSearch($search) {
     foreach ($search as $key => $value) {
     	$search[$key] = trim($value);
     }
-    $_SESSION['resourceSearch'] = $search;
+    CoralSession::set('resourceSearch', $search);
   }
 
   public static function resetSearch() {
     Resource::setSearch(array());
   }
 
   public static function getSearch() {
-    if (!isset($_SESSION['resourceSearch'])) {
+    if (!CoralSession::get('resourceSearch')) {
       Resource::resetSearch();
     }
-    return $_SESSION['resourceSearch'];
+    return CoralSession::get('resourceSearch');
   }
 
   public static function getSearchDetails() {

resources/admin/classes/domain/ResourceStep.php

@@ -32,8 +32,8 @@ public function completeStep(){
 
 		//mark this step complete
 		$this->stepEndDate = date( 'Y-m-d' );
-		$this->endLoginID = $_SESSION['loginID'];
-		$this->save();
+		$this->endLoginID = CoralSession::get('loginID');
+		$this->save;
 
         $this->startNextStepsOrComplete();
 

resources/ajax_htmldata.php

@@ -17,8 +17,6 @@
 **************************************************************************************************************************
 */
 
-session_start();
-
 include_once 'directory.php';
 include_once 'user.php';
 

resources/export.php

@@ -18,8 +18,6 @@
 */
 
 
-session_start();
-
 include_once 'directory.php';
 include_once 'util.php';
 

resources/import.php

@@ -10,7 +10,7 @@ function searchForShortName($shortName, $array)
 		}
 		return null;
 	}
-	session_start();
+
 	include_once 'directory.php';
 	$pageTitle=_('Resources import');
 	include 'templates/header.php';

resources/index.php

@@ -18,26 +18,23 @@
 */
 
 
-session_start();
 
 include_once 'directory.php';
 
-//print header
-$pageTitle=_('Home');
-include 'templates/header.php';
 
 //used for creating a "sticky form" for back buttons
 //except we don't want it to retain if they press the 'index' button
 //check what referring script is
 
-if ($_SESSION['ref_script'] != "resource.php"){
+if (CoralSession::get('ref_script') != "resource.php"){
 	Resource::resetSearch();
 }
-
+CoralSession::set('ref_script', $currentPage);
 $search = Resource::getSearch();
 
-$_SESSION['ref_script']=$currentPage;
-
+//print header
+$pageTitle=_('Home');
+include 'templates/header.php';
 
 
 ?>
@@ -614,24 +611,24 @@
 <script type="text/javascript" src="js/index.js"></script>
 <script type='text/javascript'>
 <?php
-	//used to default to previously selected values when back button is pressed
-	//if the startWith is defined set it so that it will default to the first letter picked
-	if ((isset($_SESSION['res_startWith'])) && ($reset != 'Y')){
-	  echo "startWith = '" . $_SESSION['res_startWith'] . "';";
-	  echo "$(\"#span_letter_" . $_SESSION['res_startWith'] . "\").removeClass('searchLetter').addClass('searchLetterSelected');";
-	}
-
-	if ((isset($_SESSION['res_pageStart'])) && ($reset != 'Y')){
-	  echo "pageStart = '" . $_SESSION['res_pageStart'] . "';";
-	}
-
-	if ((isset($_SESSION['res_recordsPerPage'])) && ($reset != 'Y')){
-	  echo "recordsPerPage = '" . $_SESSION['res_recordsPerPage'] . "';";
-	}
-
-	if ((isset($_SESSION['res_orderBy'])) && ($reset != 'Y')){
-	  echo "orderBy = \"" . $_SESSION['res_orderBy'] . "\";";
-	}
+  //used to default to previously selected values when back button is pressed
+  //if the startWith is defined set it so that it will default to the first letter picked
+  if ((CoralSession::get('res_startWith')) && ($reset != 'Y')){
+	  echo "startWith = '" . CoralSession::get('res_startWith') . "';";
+	  echo "$(\"#span_letter_" . CoralSession::get('res_startWith') . "\").removeClass('searchLetter').addClass('searchLetterSelected');";
+  }
+
+  if ((CoralSession::get('res_pageStart')) && ($reset != 'Y')){
+	  echo "pageStart = '" . CoralSession::get('res_pageStart') . "';";
+  }
+
+  if ((CoralSession::get('res_recordsPerPage')) && ($reset != 'Y')){
+	  echo "recordsPerPage = '" . CoralSession::get('res_recordsPerPage') . "';";
+  }
+
+  if ((CoralSession::get('res_orderBy')) && ($reset != 'Y')){
+	  echo "orderBy = \"" . CoralSession::get('res_orderBy') . "\";";
+  }
 
 	echo "</script>";
 

resources/install/CORALInstaller.php

@@ -1,5 +1,4 @@
 <?php
-session_start();
 require_once('../directory.php');
 
 if (!function_exists('debug')) {
@@ -9,6 +8,7 @@ function debug($value) {
 }
 
 class CORALInstaller {
+  session_start();
 
   public $db; // because CORALInstaller::query does unwanted things with result
   public $error;

resources/queue.php

@@ -19,12 +19,12 @@
 
 include_once 'directory.php';
 
-$pageTitle=_('My Queue');
-include 'templates/header.php';
 
 //set referring page
-$_SESSION['ref_script']=$currentPage;
+CoralSession::set('ref_script', $currentPage);
 
+$pageTitle=_('My Queue');
+include 'templates/header.php';
 
 
 

resources/resource.php

@@ -17,7 +17,6 @@
 **************************************************************************************************************************
 */
 
-session_start();
 include_once 'directory.php';
 
 $resourceID = $_GET['resourceID'];
@@ -27,18 +26,18 @@
 //used to get default email address for feedback link in the right side panel
 $config = new Configuration();
 
-//set this to turn off displaying the title header in header.php
-$pageTitle=$resource->titleText;;
-include 'templates/header.php';
-
 
 //set referring page
 if ((isset($_GET['ref'])) && ($_GET['ref'] == 'new')){
-	$_SESSION['ref_script']="new";
+  CoralSession::set('ref_script', 'new');
 }else{
-	$_SESSION['ref_script']=$currentPage;
+  CoralSession::set('ref_script', $currentPage);
 }
 
+//set this to turn off displaying the title header in header.php
+$pageTitle=$resource->titleText;;
+include 'templates/header.php';
+
 
 if ($resource->titleText){
 	?>

resources/resources/cataloging.php

@@ -17,8 +17,6 @@
 **************************************************************************************************************************
 */
 
-session_start();
-
 include_once '../directory.php';
 include_once '../user.php';
 

resources/resources/cataloging_update.php

@@ -1,5 +1,4 @@
 <?php
-session_start();
 
 include_once '../directory.php';
 include_once '../user.php';

resources/sendAlerts.php

@@ -17,7 +17,6 @@
 **************************************************************************************************************************
 */
 
-session_start();
 include_once 'directory.php';
 
 $util = new Utility();

resources/summary.php

@@ -17,7 +17,6 @@
 **************************************************************************************************************************
 */
 
-session_start();
 include_once 'directory.php';
 
 $util = new Utility();

resources/user.php

@@ -35,9 +35,7 @@
 
 	//if the user has an open session
 	if (($loginID) && ($user->hasOpenSession())){
-
-		session_start();
-		$_SESSION['loginID'] = $loginID;
+    CoralSession::set('loginID', $loginID);
 
 	//no open session
 	}else{
@@ -61,9 +59,7 @@
 }else{
 
 	//get login id from server
-	if (!isset($_SESSION['loginID']) || ($_SESSION['loginID'] == '')){
-
-
+	if (!CoralSession::get('loginID') || (CoralSession::get('loginID') == '')){
 		$varName = $config->settings->remoteAuthVariableName;
 
 		//the following code takes the remote auth variable name from the config settings and evaluates it to get the actual value from web server
@@ -77,15 +73,12 @@
 		//use the split in case the remote login is supplied as an email address
 		list ($loginID,$restofAddr) = explode("@", $remoteAuth);
 
-
-
-		session_start();
-		$_SESSION['loginID'] = $loginID;
+    CoralSession::set('loginID', $loginID); 
 
 
 	}else{
 
-		$loginID = $_SESSION['loginID'];
+		$loginID = CoralSession::get('loginID');
 
 	}