File Source for OCSP_MOD

<?php
/**
* openCSP class OCSP_MOD_CONF.phpclass
*
* @project Open CSP-Management
* @package default
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-17.03.2008
* @version $Id: OCSP_MOD_CONF.phpclass,v 1.2 2008/10/30 07:35:28 pitlinz Exp $
*
* @deprecated since pk-08-10-28
***/
// ---------------------------------------------------------
// requirements
// ---------------------------------------------------------
pcf_require_class('DBMS_TABLEOBJ',__OCSP_PHPINCPATH__ . "db" . _OCSP_DIRSEP_ . "DBMS_TABLEOBJ.phpclass");
if (!function_exists('pcf_checkDir'))
{
require __OCSP_PHPINCPATH__ . "common" . _OCSP_DIRSEP_ . "pcf_directory.phpinc";
}
// ---------------------------------------------------------
// constants
// ---------------------------------------------------------
if (!defined('_OCSP_EXCEP_MOD_NOTREGISTERED_')) define('_OCSP_EXCEP_MOD_NOTREGISTERED_','OCSP MODULE NOT REGISTERED');
if (!defined('_OCSP_EXCEP_MODULE_NOT_FOUND_')) define('_OCSP_EXCEP_MODULE_NOT_FOUND_',"MODULE NOT FOUND");
/**
* openCSP class OCSP_MOD_CONF
*
* @project Open CSP-Management
* @package default
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-17.03.2008
* @version $Id: OCSP_MOD_CONF.phpclass,v 1.2 2008/10/30 07:35:28 pitlinz Exp $
*
* @deprecated since pk-08-10-28
***/
class OCSP_MOD_CONF extends DBMS_TABLEOBJ
{
/*** class constants --------------------------------------------- */
/**
* @constant string CLASS_SRC_FILE
*
* @abstract
*/
const CLASS_SRC_FILE = __FILE__;
/*** class variables --------------------------------------------- */
/**
* array of configured modules
*
* @var array $modules
*/
private static $modules = array();
/**
* name of the table the settings are stored
*
* @staticvar string $settingTbl
*/
private static $settingTbl = "T_MOD_SETTINGS";
/*** compostion ------------------------------------------------- */
/*** attributes ------------------------------------------------ */
/**
* table name
*
* @var string
*/
protected $myTable="T_MOD_MODULES";
/**
* array of conf settings
*
* @var array $mySettings
*/
protected $mySettings = array();
/*** static functions ------------------------------------------- */
/**
* returns the modul cache path
*
* @return string
*/
public static function getCachePath()
{
return OCSP_OBJ::getConf('CACHEPATH') . _OCSP_DIRSEP_ . "modules" . _OCSP_DIRSEP_;
}
public static function loadModule($modName,$debug=false)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_MOD_CONF::loadModule($modName)");
if (isset(self::$modules[$modName]) && is_object(self::$modules[$modName]))
{
return true;
} else if (file_exists(self::getCachePath() . "config" . _OCSP_DIRSEP_ . $modName . ".xml")) {
self::$modules[$modName] = new OCSP_MOD_CONF($modName);
return true;
} else if (file_exists(self::getConf('MODULEPATH') . "mod_" . $modName . "/config/config.phpinc")) {
require_once self::getConf('MODULEPATH') . "mod_" . $modName . "/config/config.phpinc";
} else if (pcf_fileExists(dirname(__OCSP_PHPINCPATH__) . _OCSP_DIRSEP_ . "mod_" . $modName . "/config/config.phpinc")) {
require_once dirname(__OCSP_PHPINCPATH__) . _OCSP_DIRSEP_ . "mod_" . $modName . "/config/config.phpinc";
} else if (pcf_fileExists(__OCSP_PROJECTPATH__ . "mod_" . $modName . "/config/config.phpinc" )) {
require_once __OCSP_PROJECTPATH__ . "mod_" . $modName . "/config/config.phpinc";
} else {
$obj_mod = new OCSP_MOD_CONF($modName);
if ($obj_mod->dbPopulate($debug))
{
self::$modules[$modName]=$obj_mod;
return true;
} else {
throw new Exception(_OCSP_EXCEP_MODULE_NOT_FOUND_ . ":" . $modName);
}
}
if ($debug) echoDebugLine(__FILE__,__LINE__,'no config found');
}
public static function installModule($modName,$debug=false)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_MOD_CONF::installModule()");
$str_instPath = "mod_" . $modName . _OCSP_DIRSEP_ . "setup" . _OCSP_DIRSEP_ . "install.phpinc";
if (file_exists(self::getConf('MODULEPATH') . $str_instPath))
{
include self::getConf('MODULEPATH') . $str_instPath;
} else if (file_exists(__OCSP_PROJECTPATH__ . $str_instPath)) {
include __OCSP_PROJECTPATH__ . $str_instPath;
} else if (file_exists(dirname(__OCSP_PHPINCPATH__) . _OCSP_DIRSEP_ . $str_instPath )) {
include dirname(__OCSP_PHPINCPATH__) . _OCSP_DIRSEP_ . $str_instPath;
} else {
$str_debug = "MODULEPATH: " . self::getConf('MODULEPATH') . " ";
$str_debug .= "PROJECTPATH: " . __OCSP_PROJECTPATH__ . " ";
$str_debug .= "SYSTEMPATH: " . __OCSP_PHPINCPATH__ . " ";
echoDebugLine(__FILE__,__LINE__,"" . $str_debug . "");
throw new Exception(_OCSP_EXCEP_MODULE_NOT_FOUND_ . ": install " . $str_instPath);
}
}
/**
* register all modules cached in self::getCachePath()
*
* @param boolean $debug
*/
public static function registerCachedModules($debug=false)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_MOD_CONF::registerCachedModules();");
if ($arr_files = pcf_getDirList(self::getCachePath()."config",'!D'))
{
foreach($arr_files as $str_fileName)
{
if (substr($str_fileName,-4) == ".xml")
{
self::registerModule(substr($str_fileName,0,-4));
}
}
}
}
/**
* register a module
*
* @param string $modName
* @param boolean $debug
*
* @return OCSP_MOD_CONF
*/
public static function registerModule($modName,$debug=false)
{
if (!isset(self::$modules[$modName]))
{
self::$modules[$modName] = new OCSP_MOD_CONF($modName);
}
return self::$modules[$modName];
}
/**
* returns a module configuration
*
* @param string $modName
* @param boolean $debug
* @return mixed
*/
public static function getConfObj($modName,$debug=false)
{
if (!isset(self::$modules[$modName]))
{
//throw new Exception(_OCSP_EXCEP_MOD_NOTREGISTERED_ . ":" . $modName);
if (!self::$modules[$modName] = self::loadModule($modName))
{
unset(self::$modules[$modName]);
return Null;
}
}
return self::$modules[$modName];
}
/*** constructor ----------------------------------------------- */
protected function __construct($modName)
{
$this->init($debug);
if (!empty($modName))
{
$this->setDBField('MOD_NAME',$modName);
}
/*
if (!empty($modName))
{
$str_cacheFile = self::getCachePath() . "config" . _OCSP_DIRSEP_ . $modName . ".xml";
if (file_exists($str_cacheFile))
{
$this->mySettings = OCSP_XMLARRAY::getArray($str_cacheFile);
} else {
if (!$this->isConnected(true,$debug))
{
throw new Exception(_OCSP_EXCEP_NODBCONN_);
}
if (!($this->dbPopulate($debug)))
{
// module is not installed
}
}
}
*/
}
/**
* cache the module
*
* @todo write to cache
*/
public function __destruct()
{
/*
$str_path = self::getCachePath()."config";
if (pcf_checkDir($str_path,true))
{
OCSP_XMLARRAY::saveXML($this->mySettings,$str_path . _OCSP_DIRSEP_ . $this->getModuleName() . ".xml");
}
*/
}
/*** getter / setter ------------------------------------------ */
public function getId()
{
return intval($this->getDBField('MOD_ID'));
}
/**
* returns the module name
*
* @param boolean $debug
*
* @return string
*
* @since pk-08-03-20
*/
public function getModuleName($debug=false)
{
return $this->getDBField('MOD_NAME',$debug,false);
}
/**
* returns the module cache path
*
* @return string
*/
public function getMyCachePath()
{
return self::getCachePath() . $this->getModuleName() . _OCSP_DIRSEP_;
}
/**
* returns the root path of the module
*
* @param boolean $debug
*
* @return string
*
* @since pk-08-03-20
*/
public function getModulePath($debug=false)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::getModulePath()");
if (!($this->getModuleName()))
{
throw new Exception(_OCSP_EXCEP_NOID_);
}
if ($str_path = $this->getDBField('MOD_PATH'))
{
$str_ret = str_replace('$@PROJECTPATH$',OCSP_OBJ::getConf('PROJECTPATH'),$str_path);
$str_ret = str_replace('$@MODULEPATH$',self::getConf('MODULEPATH'),$str_path);
$str_ret = trim($str_ret);
if (substr($str_ret,-1) != _OCSP_DIRSEP_)
{
$str_ret .= _OCSP_DIRSEP_;
$this->setDBField('MOD_PATH',$str_ret);
}
return $str_ret;
}
if (is_dir(self::getConf('MODULEPATH') . "mod_" . $this->getModuleName()))
{
$this->setDBField('MOD_PATH','$@MODULEPATH$' . "mod_" . $this->getModuleName() . _OCSP_DIRSEP_ );
return self::getConf('MODULEPATH') . "mod_" . $this->getModuleName() . _OCSP_DIRSEP_;
}
if (is_dir(self::getConf('PROJECTPATH') . "mod_" . $this->getModuleName()))
{
$this->setDBField('MOD_PATH','$@PROJECTPATH$' . "mod_" . $this->getModuleName() . _OCSP_DIRSEP_ );
return self::getConf('PROJECTPATH') . "mod_" . $this->getModuleName() . _OCSP_DIRSEP_;
}
throw new Exception(_OCSP_EXCEP_MODULE_NOT_FOUND_ . ":" . $this->getModuleName());
}
/**
* returns the template path for the module
*
* @param boolean $debug
*
* @return string
*/
public function getTemplatePath($debug=false)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),'OCSP_MOD_CONF::getTemplatePath()');
return $this->getModulePath($debug) . "templates" . _OCSP_DIRSEP_;
}
/*** DB key / filter ------------------------------------------ */
/**
* generates a where clause to select the object identfied by DBMS_TBLOBJ::myKeys
*
* @param boolean $debug
*
* @return string
*
* @version pk-08-03-20
*/
function getWhere($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),'OCSP_MOD_CONF::getWhere()');
if (!intval($this->getDBField('MOD_ID')))
{
return "WHERE MOD_NAME=" . $this->myDBObj->qs_getSlashedValue($this->getModuleName($debug));
} else {
return parent::getWhere($debug);
}
}
/**
* populates the module configuration, settings and hooks
*
* @param debug $debug
*
* @returns boolean
*
*/
function dbPopulate($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::dbPopulate();");
if ($this->getId())
{
$arr_filter=array('MOD_ID' => $this->getId());
} else if ($this->getModuleName($debug)) {
$arr_filter=array('MOD_NAME' => $this->getModuleName($debug));
} else {
return false;
}
if (!$this->isConnected(true))
{
throw new Exception(_OCSP_EXCEP_NODBCONN_);
}
if ($arr_row = $this->myDBObj->getArray($this->myTable,$arr_filter,0,0,"",$debug))
{
$this->setDBRow($arr_row[0],true,$debug);
try {
$this->populateSettings($debug);
$this->populateHooks($debug);
} catch(Exception $e) {
if ($debug) echoDebugLine(__FILE__,__LINE__,"Exception: <pre>" . print_r($e,true) . "</pre>");
}
return true;
} else {
return false;
}
}
/**
* inserts the module with settings and hooks
*
* @param boolean $debug
*
* @return int
*
*/
function dbInsert($debug=false)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::dbInsert();");
if ($int_ret = parent::dbInsert($debug))
{
$this->saveMySettings($debug);
return $int_ret;
}
return false;
}
/**
* replaces (update) a module configuration
*
*
* @param boolean $debug
* @param boolean $ignorPopulated
*
* @return boolean
*/
function dbReplace($debug=FALSE,$ignorPopulated=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::dbReplace()");
if (parent::dbReplace($debug,$ignorPopulated))
{
$this->saveMySettings($debug);
}
}
/*** settings ------------------------------------------------- */
/**
* populates the module settings
*
* @param boolean $debug
*/
protected function populateSettings($debug)
{
if ($this->getId())
{
$arr_filter=array('MOD_ID' => $this->getId());
if (!$this->isConnected(true))
{
throw new Exception(_OCSP_EXCEP_NODBCONN_);
}
if ($arr_settings=$this->myDBObj->getArray(self::$settingTbl,$arr_filter))
{
if (!is_array($this->mySettings))
{
$this->mySettings = array();
}
foreach($arr_settings as $arr_row)
{
$this->mySettings[$arr_row['MOS_NAME']] = $arr_row;
}
}
}
}
/**
* stores the settings to the database
*
* @param boolean $debug
*/
protected function saveMySettings($debug)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::saveMySettings()");
if (!$this->isConnected(true))
{
throw new Exception(_OCSP_EXCEP_NODBCONN_);
}
foreach($this->mySettings as $str_name => $arr_mos)
{
$arr_mos['MOS_NAME'] = $str_name;
$arr_mos['MOD_ID'] = $this->getId();
$this->myDBObj->replaceArray(self::$settingTbl,$arr_mos);
}
}
/**
* returns a module setting
*
* @param string $optName
* @param boolean $debug
*
* @return mixed
*/
public function getMySetting($optName,$debug=false)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::getMySetting(" . $optName . ")");
if ($optName=="[ALL]")
{
return $this->mySettings;
}
if (isset($this->mySettings[$optName]['MOS_VALUE']))
{
if (!empty($this->mySettings[$optName]['MOS_VALUE']))
{
return unserialize($this->mySettings[$optName]['MOS_VALUE']);
}
} else {
return OCSP_OBJ::getConf($optName);
}
}
public function setMySetting($optName,$value)
{
$this->mySettings[$optName]=array('MOS_VALUE' => serialize($value));
}
/*** hooks ---------------------------------------------------- */
/**
* populates the hooks
*
* @param boolean $debug
*/
protected function populateHooks($debug)
{
throw new Exception(_OCSP_EXCEP_TODO_ . ": " . basename(__FILE__) . " " . __LINE__ . "OCSP_MOD_CONF::populateHooks()");
}
public function addHook($system,$part,$cmd,$className)
{
$arr_hook=array(
'MOD_ID' => $this->getId(),
'HOO_SYSTEM' => $system,
'HOO_PART' => $part,
'HOO_CMD' => $cmd,
'HOO_CLASS' => $className
);
if (!$this->isConnected(true,$debug))
{
throw new Exception(_OCSP_EXCEP_NODBCONN_);
}
return $this->myDBObj->insertArray('T_MOD_HOOKS',$arr_hook,$debug,'HOO_ID');
}
/*** modul Object ----------------------------------------- */
/**
* returns the name of the main class
*
* which has to implement INFA_MODULE
*
* @return string
*/
public function getModuleClassName()
{
return strtoupper($this->getModuleName());
}
/**
* returns the main object of the modul
*
* @param boolean $debug
*
* @return INFA_MODULE class
*/
public function includeModuleObject($debug=false)
{
if ($debub) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::getModuleObject()");
$str_class = $this->getModuleClassName();
if (!class_exists($str_class))
{
$str_incFile = $this->getModulePath($debug) . "php" . _OCSP_DIRSEP_ . $str_class . ".phpclass";
if (!file_exists($str_incFile))
{
throw new Exception(_OCSP_EXCEP_FILENOTFOUND_ . ":" . $str_incFile);
}
require_once $str_incFile;
return true;
} else {
return true;
}
}
/**
* returns the module main object
*
* @param boolean $debug
*
* @return INFA_MODULE object
*/
public function factoryModuleObject($debug=false)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_MOD_CONF::factoryModuleObject();");
$this->includeModuleObject($debug);
$str_cmd = "\$obj_ret = " . $this->getModuleClassName() . "::factoryFromEnv();";
if ($debug) echoDebugLine(__FILE__,__LINE__,"ObjectCmd: " . $str_cmd);
eval($str_cmd);
$obj_ret->setMyModConf($this);
return $obj_ret;
}
}
?>

Source for file OCSP_MOD_CONF.phpclass