Source for file OCSP_CMS_PEARCACHE.phpclass

Documentation is available at OCSP_CMS_PEARCACHE.phpclass

  1. <?php
  2. /**
  3.   * Class file OCSP_CMS_PEARCACHE.phpclass
  4.   *
  5.   * @project    Open CSP-Management
  6.   * @package    cms
  7.   *
  8.   * @author     Peter Krebs <pitlinz@users.sourceforge.net>
  9.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  10.   *
  11.   * @since pk-07-06-07
  12.   *
  13.   * @requires Cache/Lite.php           [PEAR]
  14.   *
  15.   * @uses _OCSP_PEARPATH_
  16.   *
  17.   * @see http://pear.php.net/manual/en/package.caching.cache-lite.php
  18.   ***/
  19.  
  20. /**
  21.   * ---------------------------------------------------
  22.   *
  23.   * common settings and requirements
  24.   *
  25.   */
  26.  
  27.     if (!defined('_OCSP_PEARPATH_'))
  28.     {
  29.         define('_OCSP_PEARPATH_',''); // pear is in the include path
  30.     }
  31.  
  32.     require_once _OCSP_PEARPATH_."Cache/Lite.php";
  33.  
  34. /**
  35.   * Class OCSP_CMS_PEARCACHE.phpclass
  36.   *
  37.   * @project    Open CSP-Management
  38.   * @package    cms
  39.   *
  40.   * @author     Peter Krebs <pitlinz@users.sourceforge.net>
  41.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  42.   *
  43.   * @since pk-07-06-07
  44.   *
  45.   * @requires Cache/Lite.php           [PEAR]
  46.   *
  47.   * @uses $GLOBALS['OCSP']['OBJCACHEPATH']
  48.   *
  49.   * @see http://pear.php.net/manual/en/package.caching.cache-lite.php
  50.   *
  51.   *
  52.   */
  53. class OCSP_CMS_PEARCACHE {
  54.     /** -----------------------------------------------------
  55.       * Aggregations:
  56.       */
  57.  
  58.  
  59.     /** -----------------------------------------------------
  60.       * Compositions:
  61.       */
  62.  
  63.     /**
  64.       * @var array $projCachArr 
  65.       * @access protected
  66.       */
  67.     protected $projCachArr = array();
  68.  
  69.     /**
  70.       * @var Cache_Lite $myMenuCache 
  71.       * @access protected
  72.       */
  73.     protected $myMenuCache=NULL;
  74.  
  75.     /**
  76.       * @var Cache_Lite $myPageCache 
  77.       * @acces protected
  78.       */
  79.     protected $myPageCache=NULL;
  80.  
  81.     /** -----------------------------------------------------
  82.       * Attributes:
  83.       */
  84.  
  85.     /**
  86.       * @var string $rootPath 
  87.       * @access protected
  88.       */
  89.     protected $rootPath = "";
  90.  
  91.     /**
  92.       * @var int $ttl 
  93.       * @access protectd
  94.       */
  95.     protected $ttl = 604800; // one week
  96.  
  97.  
  98.  
  99.  
  100.     /**
  101.       * index of the menu tree in $GLOBALS['OCSP_VAL']['DBMS_TREE']
  102.       * @var string $menuTreeIndex 
  103.       * @access protected
  104.       */
  105.     protected $menuTreeIndex="";
  106.  
  107.     /**
  108.       * @var array $menNodeValsLoaded ([$menuTreeIndex]=TRUE/FALSE)
  109.       * @access protected
  110.       */
  111.     protected $menNodeValsLoaded=array();
  112.  
  113.     /**
  114.       *
  115.       * METHODS _____________________________________________
  116.       *
  117.       */
  118.  
  119.     /** -----------------------------------------------------
  120.       * Constructors
  121.       */
  122.     function OCSP_CMS_PEARCACHE()
  123.     {
  124.         $this->rootPath=$GLOBALS['OCSP']['CACHEPATH']."cms"._OCSP_DIRSEP_;
  125.         if (!isset($GLOBALS['OCSP_OBJ']['CMS_PEARCHACHE']))
  126.         {
  127.             $GLOBALS['OCSP_OBJ']['CMS_PEARCHACHE']=&$this;
  128.         }
  129.     }
  130.  
  131.     /** -----------------------------------------------------
  132.       * getter & setter methods
  133.       */
  134.  
  135.     /**
  136.       * @return string 
  137.       */
  138.     function getRootPath()
  139.     {
  140.         if (pcf_is_instance_of($this,'OCSP_CMS_PEARCACHE') && !empty($this->rootPath))
  141.         {
  142.             return $this->rootPath;
  143.         }
  144.  
  145.         return $GLOBALS['OCSP']['CACHEPATH']."cms"._OCSP_DIRSEP_;
  146.     }
  147.  
  148.     /**
  149.       *
  150.       * project cache methods
  151.       *
  152.       */
  153.  
  154.     /**
  155.       * @param int $projId 
  156.       * @param boolean $chkDir 
  157.       * @param boolean $debug 
  158.       *
  159.       * @return Cache_Lite 
  160.       * @access public
  161.       *
  162.       * @requires $GLOBALS['OCSP']['PHPINCPATH']."common/pcf_directory.phpinc";
  163.       *
  164.       */
  165.     function &getProjCacheObj($projId,$chkDir=FALSE,$debug=FALSE)
  166.     {
  167.         //if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getProjCacheObj($projId)");
  168.  
  169.         if (isset($this->projCachArr[$projId]) && pcf_is_instance_of($this->projCachArr[$projId],'Cache_Lite'))
  170.         {
  171.             return $this->projCachArr[$projId];
  172.         }
  173.  
  174.         $arr_option=array(
  175.             'cacheDir'                  => $this->getRootPath()."PROJ_".$projId."/",
  176.             'automaticSerialization'    => TRUE,
  177.             'lifeTime'                  => $this->ttl,
  178.             'fileNameProtection'        => FALSE
  179.         );
  180.         if ($chkDir)
  181.         {
  182.             require_once $GLOBALS['OCSP']['PHPINCPATH']."common/pcf_directory.phpinc";
  183.             if (!pcf_checkDir($arr_option['cacheDir'],TRUE,0700,$debug))
  184.             {
  185.                 $null_ret=NULL;
  186.                 return $null_ret;
  187.             }
  188.         }
  189.         $this->projCachArr[$projId]=new Cache_Lite($arr_option);
  190.         return $this->projCachArr[$projId];
  191.     }
  192.  
  193.     /**
  194.       * gets a projects database values from the cache
  195.       *
  196.       * @param int $projId 
  197.       * @param boolean $debug 
  198.       *
  199.       * @return array 
  200.       */
  201.     function getProjDBValues($projId,$debug=FALSE)
  202.     {
  203.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getProjDBValues($projId)");
  204.         $obj_cache=$this->getProjCacheObj($projId,TRUE,$debug);
  205.         return $obj_cache->get('PROJDBVAL');
  206.     }
  207.  
  208.     /**
  209.       * stores a projects database values to the cache
  210.       *
  211.       * @param CMS_PROJECT $aProj 
  212.       * @param boolean $debug 
  213.       */
  214.     function setProjDBValues($aProj,$debug=FALSE)
  215.     {
  216.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setProjDBValues(".$aProj->getId().")");
  217.         if ($obj_cache=$this->getProjCacheObj($aProj->getId(),TRUE,$debug))
  218.         {
  219.             $arr_projVals=$aProj->getDBVal();
  220.             $arr_projVals['PEARCACHE_TS']=time();
  221.             if (!$obj_cache->save($arr_projVals,'PROJDBVAL'))
  222.             {
  223.                 if ($debug) echoDebugLine(__FILE__,__LINE__,"<p>Error Saving Cache</p><pre>".print_r($obj_cache,TRUE)."</pre>");
  224.             }
  225.         }
  226.     }
  227.  
  228.     /**
  229.       * clears the cache by removing the cache directory
  230.       *
  231.       * @param CMS_PROJECT $aProject 
  232.       * @param boolean $debug 
  233.       * @access public
  234.       */
  235.     function cleanProject($aProject,$debug=FALSE)
  236.     {
  237.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::cleanProject(".$aProject->getId().")");
  238.         $obj_cache=$this->getProjCacheObj($aProject->getId(),FALSE,$debug);
  239.         $obj_cache->clean();
  240.     }
  241.  
  242.     /**
  243.       *
  244.       * menu cache methods
  245.       *
  246.       */
  247.  
  248.     /**
  249.       * @param boolean $chkDir (if true the existens of page cache dir is checked)
  250.       * @param boolean $debug 
  251.       *
  252.       * @return array 
  253.       */
  254.     function getMenuCacheOptions($chkDir=FALSE,$debug=FALSE)
  255.     {
  256.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getMenuCacheOptions()");
  257.  
  258.  
  259.         $arr_option=array(
  260.             'cacheDir'                  => $this->getRootPath()."menu"._OCSP_DIRSEP_,
  261.             'automaticSerialization'    => TRUE,
  262.             'lifeTime'                  => $this->ttl,
  263.             'fileNameProtection'        => FALSE
  264.         );
  265.  
  266.         if ($chkDir)
  267.         {
  268.             require_once $GLOBALS['OCSP']['PHPINCPATH']."common/pcf_directory.phpinc";
  269.             if (!pcf_checkDir($arr_option['cacheDir'],TRUE,0700,$debug))
  270.             {
  271.                 ocsp_logError(__FILE__,__LINE__,"check dir ".$arr_option['cacheDir']." failed");
  272.             }
  273.         }
  274.         return $arr_option;
  275.     }
  276.  
  277.     /**
  278.       * @param boolean $chkDir 
  279.       * @param boolean $debug 
  280.       */
  281.     function &getMenuCacheObj($chkDir=FALSE,$debug=FALSE)
  282.     {
  283.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getMenuCacheObj()");
  284.  
  285.         if (!pcf_is_instance_of($this->myMenuCache,'Cache_Lite'))
  286.         {
  287.             $this->myMenuCache=new Cache_Lite($this->getMenuCacheOptions($chkDir,$debug));
  288.         } else if ($chkDir) {
  289.             $this->getMenuCacheOptions($chkDir,$debug);
  290.         }
  291.         return $this->myMenuCache;
  292.     }
  293.  
  294.     /**
  295.       * returns an array with all data for a menu node
  296.       *
  297.       * <code>
  298.       * array(
  299.       *     'MENVAL' => CMS_MENU_NODE->getDBVal(),
  300.       *     'PROJVAL'=> CMS_PROJECT->getDBVal()
  301.       * )
  302.       * </code>
  303.       *
  304.       * @param int $pag_id 
  305.       * @param boolean $debug 
  306.       *
  307.       * @return mixed array or false if cache failed
  308.       */
  309.     function getMenuData($aId,$debug=FALSE)
  310.     {
  311.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getMenuData($aId)");
  312.  
  313.         if (!intval($aId)) {
  314.             if ($debug) echoDebugLine(__FILE__,__LINE__,"no id set");
  315.             return FALSE;
  316.         }
  317.  
  318.         $this->getMenuCacheObj(FALSE,$debug); // ensure $this->myPageCache is set
  319.         return $this->myMenuCache->get('MENU_'.intval($aId));
  320.     }
  321.  
  322.     /**
  323.       * returns an array with page values
  324.       *
  325.       * @param int $aId 
  326.       * @param boolean $debug 
  327.       *
  328.       * @return mixed array of false if cache failed
  329.       */
  330.     function getMenuVal($aId,$debug=FALSE)
  331.     {
  332.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getMenuVal($aId)");
  333.         if ($arr_cache=$this->getMenuData($aId,$debug))
  334.         {
  335.             if (isset($arr_cache['MENVAL']) && is_array($arr_cache['MENVAL']))
  336.             {
  337.                 return $arr_cache['MENVAL'];
  338.             } else {
  339.                 return FALSE;
  340.             }
  341.         } else {
  342.             return FALSE;
  343.         }
  344.     }
  345.  
  346.     /**
  347.       * sets page cache values
  348.       *
  349.       * @param CMS_PAGE_V2 $aPage 
  350.       * @param boolean $debug 
  351.       *
  352.       * @return boolean 
  353.       *
  354.       */
  355.     function setMenuData(&$aNode,$debug=FALSE)
  356.     {
  357.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setMenuData()");
  358.  
  359.         if (!pcf_is_instance_of($aNode,'CMS_MENU_NODE')) return FALSE;
  360.  
  361.         $this->getMenuCacheObj(TRUE,$debug); // ensure $this->myMenuCache is set and the directory exists
  362.  
  363.         $arr_cache['MENVAL']=$aNode->getDBVal();
  364.         $arr_cache['MENVAL']['PEARCACHE_TS']=$aNode->getPopulateTs();
  365.         $arr_cache['MENVAL']['CMS_MENU_TREE_KEY']=$aNode->getGlobalTreeKey();
  366.  
  367.         if ($obj_proj=$aNode->getMyProject($debug))
  368.         {
  369.             $arr_cache['PROJVAL']=$obj_proj->getDBVal();
  370.             $arr_cache['PROJVAL']['PEARCACHE_TS']=$obj_proj->getPopulateTs();
  371.         }
  372.  
  373.         if (!$this->myMenuCache->save($arr_cache,'MENU_'.$aNode->getId()))
  374.         {
  375.             ocsp_logError(__FILE__,__LINE__,"error cacheing page data");
  376.         } else {
  377.             return TRUE;
  378.         }
  379.     }
  380.  
  381.     /**
  382.       * @param mixed $aId (int) menu id or (string) PROJ_$*PROJ_ID$ for project root pages
  383.       * @param boolean $debug 
  384.       *
  385.       * @return array 
  386.       */
  387.     function getMenuPageListVal($aId,$debug=FALSE)
  388.     {
  389.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getMenuPageListVal($aId)");
  390.  
  391.         if (empty($aId)) {
  392.             if ($debug) echoDebugLine(__FILE__,__LINE__,"no id set");
  393.             return FALSE;
  394.         }
  395.  
  396.         $this->getMenuCacheObj(FALSE,$debug); // ensure $this->myMenuCache is set
  397.         return $this->myMenuCache->get('PAGLSTVAL_'.$aId);
  398.     }
  399.  
  400.     /**
  401.       * @param mixed $aId (int) menu id or (string) PROJ_$*PROJ_ID$ for project root pages
  402.       * @param boolean $debug 
  403.       *
  404.       * @return array 
  405.       */
  406.     function setMenuPageListVal($aId,$arr_cache,$debug=FALSE)
  407.     {
  408.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setMenuPageListVal($aId)");
  409.  
  410.         if (empty($aId)) {
  411.             ocsp_logError(__FILE__,__LINE__,"error cacheing page data",E_WARNING);
  412.             return FALSE;
  413.         }
  414.  
  415.         $this->getMenuCacheObj(TRUE,$debug); // ensure $this->myMenuCache is set
  416.  
  417.         $arr_cache['PEARCACHE_TS']=time();
  418.  
  419.         if (!$this->myMenuCache->save($arr_cache,'PAGLSTVAL_'.$aId))
  420.         {
  421.             ocsp_logError(__FILE__,__LINE__,"error cacheing page data",E_WARNING);
  422.             return FALSE;
  423.         } else {
  424.             return TRUE;
  425.         }
  426.     }
  427.  
  428.  
  429.     /**
  430.       *
  431.       * page cache methods
  432.       *
  433.       */
  434.  
  435.     /**
  436.       * @param boolean $chkDir (if true the existens of page cache dir is checked)
  437.       * @param boolean $debug 
  438.       *
  439.       * @return array 
  440.       */
  441.     function getPageCacheOptions($chkDir=FALSE,$debug=FALSE)
  442.     {
  443.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getPageCacheOptions()");
  444.  
  445.  
  446.         $arr_option=array(
  447.             'cacheDir'                  => $this->getRootPath()."page"._OCSP_DIRSEP_,
  448.             'automaticSerialization'    => TRUE,
  449.             'lifeTime'                  => $this->ttl,
  450.             'fileNameProtection'        => FALSE
  451.         );
  452.  
  453.         if ($chkDir)
  454.         {
  455.             require_once $GLOBALS['OCSP']['PHPINCPATH']."common/pcf_directory.phpinc";
  456.             if (!pcf_checkDir($arr_option['cacheDir'],TRUE,0700,$debug))
  457.             {
  458.                 ocsp_logError(__FILE__,__LINE__,"check dir ".$arr_option['cacheDir']." failed");
  459.             }
  460.         }
  461.         return $arr_option;
  462.     }
  463.  
  464.     /**
  465.       * @param boolean $chkDir 
  466.       * @param boolean $debug 
  467.       */
  468.     function &getPageCacheObj($chkDir=FALSE,$debug=FALSE)
  469.     {
  470.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getPageCacheObj()");
  471.  
  472.         if (!pcf_is_instance_of($this->myPageCache,'Cache_Lite'))
  473.         {
  474.             $this->myPageCache=new Cache_Lite($this->getPageCacheOptions($chkDir,$debug));
  475.         } else if ($chkDir) {
  476.             $this->getPageCacheOptions($chkDir,$debug);
  477.         }
  478.         return $this->myPageCache;
  479.     }
  480.  
  481.     /**
  482.       * returns an array with all data for a page
  483.       *
  484.       * <code>
  485.       * array(
  486.       *     'PAGVAL' => CMS_PAGE_V2->getDBVal(),
  487.       *     'MENVAL' => CMS_MENU_NODE->getDBVal(),
  488.       *     'PROJVAL'=> CMS_PROJECT->getDBVal()
  489.       * )
  490.       * </code>
  491.       *
  492.       * @param int $pag_id 
  493.       * @param boolean $debug 
  494.       *
  495.       * @return mixed array or false if cache failed
  496.       */
  497.     function getPageData($aId,$debug=FALSE)
  498.     {
  499.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getPageData($aId)");
  500.  
  501.         if (!intval($aId)) {
  502.             if ($debug) echoDebugLine(__FILE__,__LINE__,"no id set");
  503.             return FALSE;
  504.         }
  505.  
  506.         $this->getPageCacheObj(FALSE,$debug); // ensure $this->myPageCache is set
  507.         return $this->myPageCache->get('PAGE_'.intval($aId));
  508.     }
  509.  
  510.     /**
  511.       * returns an array with page values
  512.       *
  513.       * @param int $aId 
  514.       * @param boolean $debug 
  515.       *
  516.       * @return mixed array of false if cache failed
  517.       */
  518.     function getPageVal($aId,$debug=FALSE)
  519.     {
  520.         if ($debug) echoDebugMethod(__FILE__,__LINE__,get_class($this),"OCSP_CMS_PEARCACHE::getPageVal($aId)");
  521.         if ($arr_cache=$this->getPageData($aId,$debug))
  522.         {
  523.             if (isset($arr_cache['PAGVAL']) && is_array($arr_cache['PAGVAL']))
  524.             {
  525.                 return $arr_cache['PAGVAL'];
  526.             } else {
  527.                 return FALSE;
  528.             }
  529.         } else {
  530.             return FALSE;
  531.         }
  532.     }
  533.  
  534.     /**
  535.       * sets page cache values
  536.       *
  537.       * @param CMS_PAGE_V2 $aPage 
  538.       * @param boolean $debug 
  539.       *
  540.       * @return boolean 
  541.       *
  542.       */
  543.     function setPageData(&$aPage,$debug=FALSE)
  544.     {
  545.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setPageDate()");
  546.  
  547.         if (!pcf_is_instance_of($aPage,'CMS_PAGE_V2')) return FALSE;
  548.         if (!intval($aPage->getId())) return FALSE;
  549.  
  550.         $this->getPageCacheObj(TRUE,$debug); // ensure $this->myPageCache is set and the directory exists
  551.  
  552.         $arr_cache['PAGVAL']=$aPage->getDBVal();
  553.         $arr_cache['PAGVAL']['PEARCACHE_TS']=$aPage->getPopulateTs();
  554.         if ($obj_menu=$aPage->getMyMenuNode($debug))
  555.         {
  556.             $arr_cache['MENVAL']=$obj_menu->getDBVal();
  557.             $arr_cache['MENVAL']['PEARCACHE_TS']=$obj_menu->getPopulateTs();
  558.         }
  559.         if ($obj_proj=$aPage->getMyProject($debug))
  560.         {
  561.             $arr_cache['PROJVAL']=$obj_proj->getDBVal();
  562.             $arr_cache['PROJVAL']['PEARCACHE_TS']=$obj_proj->getPopulateTs();
  563.         }
  564.  
  565.         if (!$this->myPageCache->save($arr_cache,'PAGE_'.$aPage->getId()))
  566.         {
  567.             ocsp_logError(__FILE__,__LINE__,"error cacheing page data");
  568.         } else {
  569.             return TRUE;
  570.         }
  571.     }
  572.  
  573.  
  574.  
  575.  
  576.  
  577. // ----------------------------------------------------------------------------
  578. // ----------------------------------------------------------------------------
  579. // ----------------------------------------------------------------------------
  580. // ----------------------------------------------------------------------------
  581. // ----------------------------------------------------------------------------
  582. // ----------------------------------------------------------------------------
  583. // ----------------------------------------------------------------------------
  584. // ----------------------------------------------------------------------------
  585. // ----------------------------------------------------------------------------
  586. // ----------------------------------------------------------------------------
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.     /**
  597.       *
  598.       * project cache methods
  599.       *
  600.       */
  601.  
  602.     /** -----------------------------------------------------
  603.       * project object values
  604.       */
  605.  
  606.  
  607.  
  608.     /** -----------------------------------------------------
  609.       * ProjIdFromHTTP_HOST
  610.       */
  611.  
  612.     /**
  613.       * @param boolean $debug 
  614.       * @return int 
  615.       * @access public
  616.       */
  617.     function getProjIdFromHTTP_HOST($debug=FALSE)
  618.     {
  619.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getProjIdFromHTTP_HOST()",$_SERVER['HTTP_HOST']);
  620.         $arr_option=array(
  621.             'cacheDir'                  => $this->getRootPath(),
  622.             'automaticSerialization'    => TRUE,
  623.             'lifeTime'                  => $this->ttl,
  624.             'fileNameProtection'        => FALSE
  625.         );
  626.  
  627.         $obj_cache=new Cache_Lite($arr_option);
  628.         if ($arr_prjData=$obj_cache->get('PROJLST'))
  629.         {
  630.             if (isset($arr_prjData[strtoupper($_SERVER['HTTP_HOST'])]['PROJ_ID']))
  631.             {
  632.                 if ($debug) echoDebugLine(__FILE__,__LINE__,"CacheHit: ".intval($arr_prjData[$_SERVER['HTTP_HOST']]['PROJ_ID']));
  633.                 return intval($arr_prjData[$_SERVER['HTTP_HOST']]['PROJ_ID']);
  634.             }
  635.             if (is_array($arr_prjData))
  636.             {
  637.                 foreach($arr_prjData as $host => $arr_vals)
  638.                 {
  639.                     if (!empty($arr_vals['PROJ_URLREGEX']) && ($a_regExpNames=explode("\n",str_replace("\r","",$arr_vals['PROJ_URLREGEX']))))
  640.                     {
  641.                         if ($arr_vals['PROJ_URL']==strtoupper($_SERVER['SERVER_NAME']))
  642.                         {
  643.                             if ($debug) echoDebugLine(__FILE__,__LINE__,"CacheHit SERVER_NAME: ".intval($arr_vals['PROJ_ID']));
  644.                             return intval($arr_vals['PROJ_ID']);
  645.                         }
  646.                         // we have regular expressions to check
  647.                         foreach($a_regExpNames as $s_pattern)
  648.                         {
  649.                             $s_pattern=trim($s_pattern);
  650.                             if ((!empty($s_pattern)) && (@preg_match($s_pattern,$_SERVER['SERVER_NAME'])))
  651.                             {
  652.                                 if ($debug) echoDebugLine(__FILE__,__LINE__,"CacheHit Regex ".htmlspecialchars($s_pattern).": ".intval($arr_vals['PROJ_ID']));
  653.                                 return intval($arr_vals['PROJ_ID']);
  654.                             }
  655.                         }
  656.                     }
  657.                 } // foreach($arr_prjData as $host => $arr_vals)
  658.             } // (is_array($arr_prjData))
  659.             if ($debug) echoDebugLine(__FILE__,__LINE__,"no CacheHit");
  660.         } else {
  661.             if ($debug) echoDebugLine(__FILE__,__LINE__,"NO CACHE");
  662.             return 0;
  663.         }
  664.     }
  665.  
  666.     /**
  667.       * adds or replaces a host if $aId is 0 the host is removed from the cache
  668.       *
  669.       * @param int $aId (0 -> unset the cache object)
  670.       * @param string $aHost 
  671.       * @param string $urlRegex 
  672.       * @access public
  673.       *
  674.       */
  675.     function addProjIdFromHTTP_HOST($aId,$aHost="",$urlRegex="",$aServerName="")
  676.     {
  677.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::addProjIdFromHTTP_HOST()",$_SERVER['HTTP_HOST']);
  678.         $arr_option=array(
  679.             'cacheDir'                  => $this->getRootPath(),
  680.             'automaticSerialization'    => TRUE,
  681.             'lifeTime'                  => $this->ttl,
  682.             'fileNameProtection'        => FALSE
  683.         );
  684.         $obj_cache=new Cache_Lite($arr_option);
  685.  
  686.         $arr_prjData=$obj_cache->get('PROJLST');
  687.         if (!is_array($arr_prjData))
  688.         {
  689.             $arr_prjData=array();
  690.         }
  691.  
  692.         if (empty($aHost)) $aHost=$_SERVER['HTTP_HOST'];
  693.         $aHost=strtoupper($aHost);
  694.  
  695.         if (intval($aId)==0)
  696.         {
  697.             if (isset($arr_prjData[$aHost]))
  698.             {
  699.                 unset($arr_prjData[$aHost]);
  700.             }
  701.         } else {
  702.             $arr_prjData[$aHost]=array(
  703.                     'PROJ_ID'       =>intval($aId),
  704.                     'PROJ_URLREGEX' =>$urlRegex,
  705.                     'PROJ_URL'      =>strtoupper(!empty($aServerName) ? $aServerName : $_SERVER['SERVER_NAME'])
  706.                 );
  707.         }
  708.  
  709.         $arr_prjData['PEARCACHE_TS']=time();
  710.         $obj_cache->save($arr_prjData,'PROJLST');
  711.     }
  712.  
  713.     /**
  714.       * @param boolean $debug 
  715.       * @access public
  716.       */
  717.     function clearProjIdFromHTTP_HOST($debug=FALSE)
  718.     {
  719.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::clearProjIdFromHTTP_HOST()",$_SERVER['HTTP_HOST']);
  720.         $arr_option=array(
  721.             'cacheDir'                  => $this->getRootPath(),
  722.             'automaticSerialization'    => TRUE,
  723.             'lifeTime'                  => $this->ttl,
  724.             'fileNameProtection'        => FALSE
  725.         );
  726.         $obj_cache=new Cache_Lite($arr_option);
  727.         $obj_cache->clear();
  728.     }
  729.  
  730.     /**
  731.       * @param int $projId 
  732.       * @param boolean $debug 
  733.       *
  734.       * @return array 
  735.       * @access public
  736.       *
  737.       */
  738.     function getProjCssArray($projId,$debug=FALSE)
  739.     {
  740.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getProjCssArray()");
  741.         $obj_cache=$this->getProjCacheObj($projId,FALSE,$debug);
  742.         return $obj_cache->get('CSS_PROJ');
  743.     }
  744.  
  745.  
  746.     /**
  747.       * @param int $projId 
  748.       * @param boolean $debug 
  749.       *
  750.       * @return array 
  751.       * @access public
  752.       *
  753.       */
  754.     function setProjCssArray($projId,$cssArr,$debug=FALSE)
  755.     {
  756.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setProjCssArray($projId)");
  757.         if ($obj_cache=$this->getProjCacheObj($projId,TRUE,$debug))
  758.         {
  759.             $cssArr['PEARCACHE_TS']=time();
  760.             if (!$obj_cache->save($cssArr,'CSS_PROJ'))
  761.             {
  762.                 if ($debug) echoDebugLine(__FILE__,__LINE__,"<p>Error Saving Cache</p><pre>".print_r($obj_cache,TRUE)."</pre>");
  763.             }
  764.         }
  765.     }
  766.  
  767.  
  768.     /**
  769.       *
  770.       * page template cache methods
  771.       *
  772.       */
  773.     /**
  774.       * @param int $projId 
  775.       * @param int $pageId 
  776.       * @param boolean $debug 
  777.       *
  778.       * @return array 
  779.       * @access public
  780.       */
  781.     function getPageTmplRow($projId,$tmplId,$debug=FALSE)
  782.     {
  783.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getPageTmplRow($projId,$tmplId)");
  784.         $obj_cache=$this->getProjCacheObj($projId,FALSE,$debug);
  785.         return $obj_cache->get('PTMPLROW_'.$tmplId);
  786.     }
  787.  
  788.     /**
  789.       * @param int $projId 
  790.       * @param int $pageId 
  791.       * @param array $pageRow 
  792.       * @param boolean $debug 
  793.       *
  794.       * @return array 
  795.       * @access public
  796.       *
  797.       */
  798.     function setPageTmplRow($projId,$tmplId,$tmplRow,$debug=FALSE)
  799.     {
  800.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setPageTmplRow($projId,$tmplId)");
  801.         if ($obj_cache=$this->getProjCacheObj($projId,TRUE,$debug))
  802.         {
  803.             $tmplRow['PEARCACHE_TS']=time();
  804.             $obj_cache->save($tmplRow,'PTMPLROW_'.$tmplId);
  805.         }
  806.     }
  807.  
  808.     /**
  809.       *
  810.       * menu cache methods
  811.       *
  812.       */
  813.  
  814.     /**
  815.       * sets the menuTreeKey (index of $GLOBALS['OCSP_VAL']['DBMS_TREE'][$this->menuTreeIndex])
  816.       *
  817.       * @param string $treeName 
  818.       * @access public
  819.       */
  820.     function setMenuTreeIndex($treeName)
  821.     {
  822.         $this->menuTreeIndex=$treeName;
  823.     }
  824.  
  825.  
  826.     /**
  827.       * @param int $projId 
  828.       * @param string $treeKey 
  829.       *
  830.       * @return boolean 
  831.       */
  832.     function getMenuKeyTree($projId,$debug=FALSE)
  833.     {
  834.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getMenuKeyTree($projId)");
  835.         $obj_cache=$this->getProjCacheObj($projId,TRUE,$debug);
  836.         return $obj_cache->get('MENUKEYTREE');
  837.     }
  838.  
  839.     /**
  840.       * stores a projects database values to the cache
  841.       *
  842.       * @param CMS_PROJECT $aProj 
  843.       * @param boolean $debug 
  844.       */
  845.     function setMenuKeyTree($projId,$keyArr,$debug=FALSE)
  846.     {
  847.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setMenuKeyTree($projId)");
  848.         if ($obj_cache=$this->getProjCacheObj($projId,TRUE,$debug))
  849.         {
  850.             $keyArr['PEARCACHE_TS']=time();
  851.             if (!$obj_cache->save($keyArr,'MENUKEYTREE'))
  852.             {
  853.                 if ($debug) echoDebugLine(__FILE__,__LINE__,"<p>Error Saving Cache</p><pre>".print_r($obj_cache,TRUE)."</pre>");
  854.             }
  855.         }
  856.     }
  857.  
  858.     /**
  859.       * returns if the global menu nodeval array has been loaded
  860.       *
  861.       * @param int $projId 
  862.       * @param string $menuTreeIndex 
  863.       *
  864.       * @return boolean 
  865.       * @access public
  866.       */
  867.     function menuNodesValLoaded($projId,$menuTreeIndex='T_CMS_MENU')
  868.     {
  869.         if (isset($this->menNodeValsLoaded[$projId][$menuTreeIndex]))
  870.         {
  871.             return $this->menNodeValsLoaded[$projId][$menuTreeIndex];
  872.         }
  873.         return FALSE;
  874.     }
  875.  
  876.     /**
  877.       * sets the global environment of the tree from the cache
  878.       *
  879.       * @param int $projId 
  880.       * @param string $treeKey 
  881.       *
  882.       * @return boolean 
  883.       */
  884.     function getMenuNodesVal($projId,$debug=FALSE)
  885.     {
  886.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::getMenuNodesVal($projId)",$this->menuTreeIndex);
  887.         $obj_cache=$this->getProjCacheObj($projId,TRUE,$debug);
  888.  
  889.         if (empty($this->menuTreeIndex)) $this->menuTreeIndex='T_CMS_MENU'.$projId;
  890.  
  891.         $this->menNodeValsLoaded[$projId][$this->menuTreeIndex]=TRUE;
  892.         if (!$arr_cache=$obj_cache->get('MENUNODESVAL'.$this->menuTreeIndex))
  893.         {
  894.             if ($debug) echoDebugLine(__FILE__,__LINE__,"MENUNODESVAL is empty");
  895.             return FALSE;
  896.         }
  897.  
  898.         $GLOBALS['OCSP_VAL']['DBMS_TREE'][$this->menuTreeIndex]['NODEVAL']=$arr_cache;
  899.  
  900.         if ($debug) echoDebugLine(__FILE__,__LINE__,"cache values: <pre style=\"font-size: 60%\">".print_r($GLOBALS['OCSP_VAL']['DBMS_TREE'][$this->menuTreeIndex]['NODEVAL'],TRUE)."</pre>");
  901.  
  902.         return TRUE;
  903.  
  904.     }
  905.  
  906.     /* *
  907.       * stores a projects database values to the cache
  908.       *
  909.       * @param CMS_PROJECT $aProj
  910.       * @param boolean $debug
  911.       *
  912.     function setMenuNodesVal($projId,$debug=FALSE)
  913.     {
  914.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_PEARCACHE::setMenuNodesVal($projId)",$this->menuTreeIndex);
  915.  
  916.         if (empty($this->menuTreeIndex)) $this->menuTreeIndex='T_CMS_MENU'.$projId;
  917.  
  918.         if ($obj_cache=$this->getProjCacheObj($projId,TRUE,$debug))
  919.         {
  920.             $arr_Nodes = &$GLOBALS['OCSP_VAL']['DBMS_TREE'][$this->menuTreeIndex]['NODEVAL'];
  921.  
  922.             if (isset($GLOBALS['OCSP_VAL']['DBMS_TREE'][$this->menuTreeIndex]['NODES']))
  923.             {
  924.                 foreach($GLOBALS['OCSP_VAL']['DBMS_TREE'][$this->menuTreeIndex]['NODES'] as $idx => &$o_node)
  925.                 {
  926.                     if (pcf_is_instance_of($o_node,'DBMS_TREE_NODE'))
  927.                     {
  928.                         if ($debug) echoDebugLine(__FILE__,__LINE__,"adding Node ".$o_node->getId());
  929.                         $arr_Nodes[$o_node->getId()]['DATA']        =$o_node->getDBVal();
  930.                         $arr_Nodes[$o_node->getId()]['PEARCACHE_TS']=$o_node->getPopulateTs();
  931.                     } else {
  932.                         if ($debug) echoDebugLine(__FILE__,__LINE__,"not instance of DBMS_TREE_NODE <pre>".print_r($o_node,TRUE)."</pre>");
  933.                     }
  934.                 }
  935.             }
  936.  
  937.             if (!$obj_cache->save($arr_Nodes,'MENUNODESVAL'.$this->menuTreeIndex))
  938.             {
  939.                 if ($debug) echoDebugLine(__FILE__,__LINE__,"<p>Error Saving Cache</p><pre>".print_r($obj_cache,TRUE)."</pre>");
  940.             }
  941.             $this->menNodeValsLoaded[$projId][$this->menuTreeIndex]=TRUE;
  942.         }
  943.     }
  944.     */
  945.  
  946.  
  947.     /** -----------------------------------------------------
  948.       * pageRow
  949.       */
  950.  
  951.  
  952.  
  953.     /** -----------------------------------------------------
  954.       * pageHeader
  955.       */
  956.  
  957.     /**
  958.       * @param CMS_PAGE_V2 $pageObj 
  959.       * @param boolean $debug 
  960.       *
  961.       * @return string 
  962.       * @access public
  963.       */
  964.     function getPageHeader($pageObj,$debug=FALSE)
  965.     {
  966.         $obj_cache=$this->getProjCacheObj($projId,FALSE,$debug);
  967.         return $obj_cache->get('PAGHEADER_'.$pageObj->getId());
  968.     }
  969.  
  970.  
  971.  
  972. } // end class OCSP_CMS_PEARCACHE
  973. ?>

Documentation generated on Thu, 08 Jan 2009 17:45:19 +0100 by phpDocumentor 1.4.0a2