File Source for Pxxo.php

<?php
// vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 fdm=marker encoding=utf8 :
/**
* Pxxo - build self-supported and interoperable Web graphical components
*
* Copyright (c) 2008, Nicolas Thouvenin
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the author nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* @package Pxxo
* @copyright Copyright (c) 2008 Nicolas Thouvenin
* @license http://opensource.org/licenses/bsd-license.php
* @version $Id$
*/
if (!defined('PXXO_ZEND_PATH')) {
define('PXXO_ZEND_PATH', realpath(rtrim(dirname(__FILE__),DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.'..'.DIRECTORY_SEPARATOR.'ZendFramework'));
$include_path = ini_get('include_path');
if ((PXXO_ZEND_PATH !== false) && (strpos($include_path, PXXO_ZEND_PATH) === false))
ini_set('include_path', $include_path.PATH_SEPARATOR.PXXO_ZEND_PATH);
}
require_once 'Zend/Cache.php';
/**
* Caclul le md5 d'un tableau de chaines
*
* @package Pxxo
* @param array
* @return array
*/
if (!function_exists('array_md5')) {
function array_md5($array) {
return md5(implode('', $array));
}
}
define('P_C_BASIC', 4);
define('P_C_TEMPLATE', 8);
define('P_C_RESOURCE', 16);
define('P_C_XSLT', 32);
define('P_C_WIDGET', 64);
define('P_C_USER', 128);
define('P_C_WIDGET2', 256);
define('P_C_HTTP', 512);
/**
* Classe principale :
* Elle donne à tous les objets la notion de cache, de trace et de bench.
*
* @package Pxxo
* @copyright Copyright (c) 2008 Nicolas Thouvenin
* @license http://opensource.org/licenses/bsd-license.php
*/
class Pxxo
{
// {{{ Variables
/**
* Cache actif ou non
* @var boolean
*/
private $_caching = null;
/**
* Niveau de cache
* @var integer
*/
private $_levelcache;
/**
* Identifiant interne pour gérer le cache
* @var integer
*/
private $_idcache = 0;
/**
* @var array tableau permettant de calculer un identifiant unique pour chaque action
*/
private $_ids = array();
/**
* Objet cache
* @var Zend_Cache
*/
private $_cache = null;
/**
* Options du cache
* @var array
*/
private $_cache_options = array();
/**
* Options du cache par défaut
* @var array
*/
private $_cache_options_default = array(
// Pxxo
'convertStringType' => 'strval',
'convertNumericType' => 'strval',
'convertArrayType' => 'array_md5',
'stats' => false,
'hits' => 'cache.hits',
'misses' => 'cache.misses',
'entries' => 'cache.entries',
'mode' => 'normal', // (normal | refresh | force | ignore)
'backend' => 'auto', // auto | File | APC
'frontendCore' => array(
'lifeTime' => 3600,
'logging' => false,
'write_control' => false,
'automatic_serialization' => false,
'automatic_cleaning_factor' => 100,
),
'backendFile' => array(
'cache_dir' => '/tmp',
'file_locking' => false,
'read_control' => true,
'read_control_type' => 'strlen',
'hashed_directory_level' => 2,
'file_name_prefix' => 'pxxo_cache',
),
'backendAPC' => array(),
);
/**
* Objet bench
* @var Benchmark_Timer
*/
protected $_bench = array('timer'=>null, 'profiler'=>null);
/**
* mode debug actif ou non
* @var string
*/
private $_debugging = false;
/**
* Options pour le mode debug
* @var array
*/
private $_debug_options = array();
/**
* Options du cache par défaut
* @var array
*/
private $_debug_options_default = array(
'filter' => 'cpnt', // Permet d'obtenir une regex prédéfinie : all, cpnt, none
'regex' => '', // Expression régulière permettant de filtrer les messages de trace
'show' => 'tree', // type d'affichage : tree, plain
'output' => 'html', // type de sortie : html, text, firebug
);
// }}}
// {{{ Constructeur
/**
* Constructeur
*/
function __construct()
{
if (strcasecmp($this->getCacheOption('backend'), 'auto') == 0) {
if (extension_loaded('apc')) $backend = 'APC';
else $backend = 'File';
$this->setCacheOption('backend', $backend);
}
}
// }}}
// {{{ enableDebug
/**
* active le mode debug
*/
public function enableDebug()
{
$this->_debugging = true;
}
// }}}
// {{{ disableDebug
/**
* désactive le mode debug
*/
public function disableDebug()
{
$this->_debugging = false;
}
// }}}
// {{{ traceDebug
/**
* Affichage d'un message de trace de Debug
*
* @param string un message
*/
public function traceDebug($msg)
{
if ($this->isDebugging()) {
$p = '';
$l = $this->getDebugOption('level');
$s = '';
for($i = 0; $i < $l; $i++) {
if ($i > 0) $s .= '| ';
}
if ($l > 0) $p = $s.'|_ '.$p;
$msg .= sprintf("\tcache(State:%d, Level:%d, Id:%s)", $this->isCaching(), $this->getCacheLevel(), $this->getCacheID());
if ($this->getDebugOption('filter') == 'all') $this->setDebugOption('regex', ',.*,');
if ($this->getDebugOption('filter') == 'cpnt') $this->setDebugOption('regex', ',COMPONENT,');
if ($this->getDebugOption('filter') == 'none') $this->setDebugOption('regex', '');
if ( (strpos(PHP_SAPI, 'cli') !== false)) $this->setDebugOption('output', 'text');
$regex = $this->getDebugOption('regex');
if (empty($regex) or is_null($regex)) return;
if (!preg_match($regex, $msg)) return;
$output = $this->getDebugOption('output');
$show = $this->getDebugOption('show');
if ($output == 'html') {
if ($show == 'tree') $msg = $p.$msg;
echo str_replace(' ', ' ', '<pre style="display:inline">'.$msg."</pre><br/>\n");
}
elseif ($output == 'firebug') {
$charlist = "'\\";
$msgtab = explode("\t", preg_replace('/,\s/', ',', $msg));
if (is_array($msgtab) and count($msgtab) > 2) {
printf("<script type=\"text/javascript\">\n");
printf("var l = $l;\nvar lll = ll-l;\n if (ll >= l) {\nfor(i=0; i <= lll; i++) {\nconsole.groupEnd();\n}\n}\n");
$groupname = array_shift($msgtab)."\t".array_shift($msgtab);
printf("console.group('%s');\n", addcslashes($groupname, $charlist));
foreach($msgtab as $item) {
if (preg_match(',(\w+)$(.*)$,', $item, $match)) {
if (!isset($match[1]) or !isset($match[2])) continue;
$section = $match[1];
$values = explode(',', $match[2]);
if ($section == 'mode' and preg_match('/[^:]+:(.*),[^:]+:(.*)/', $match[2], $match)) {
if (isset($match[1]) and !isset($match[2])) continue;
printf("console.log('%s\t%s');\n", addcslashes($match[1], $charlist),addcslashes($match[2], $charlist));
}
else {
printf("a = new Array();\n");
printf("a['%s'] = new Array();\n", addcslashes($section, $charlist));
foreach($values as $value) {
$pos = strpos($value, ':');
if ($pos === false) continue;
$n = substr($value, 0, $pos);
$v = substr($value, $pos+1);
printf("a['%s']['%s'] = '%s';\n", addcslashes($section, $charlist), addcslashes($n, $charlist), addcslashes($v, $charlist));
}
printf("console.dir(a);\n");
}
}
}
// printf("console.groupEnd();\n");
printf("var ll=%s;", addcslashes($l, $charlist));
printf("</script>\n");
}
}
else {
if ($show == 'tree') $msg = $p.$msg;
echo preg_replace(',\s+,', ' ', $msg). "\n";
}
}
}
// }}}
// {{{ enableCache
/**
* mise en route du cache
*
* @uses Zend_Cache
*/
public function enableCache()
{
$this->_caching = true;
}
// }}}
// {{{ disableCache
/**
* désactive la mise en cache
*/
public function disableCache()
{
$this->_caching = false;
unset($this->_cache);
$this->_cache = null;
}
// }}}
// {{{ isCaching
/**
* Le cache est-il actif
*
* true : le cache a été activé
* false : le cache a été désactivé
* null : le cache n' apas été réglé
*
* @return boolean true / false / null
*/
public function isCaching()
{
return $this->_caching;
}
// }}}
// {{{ isDebugging
/**
* Le mode debug est-il actif
*
* @return boolean
*/
public function isDebugging()
{
return $this->_debugging;
}
// }}}
// {{{ setCacheLevel
/**
* Changer le niveau du cache
*
* @param integer
*/
public function setCacheLevel($level)
{
if ($level === 0) { $this->setCacheLevel(P_C_BASIC | P_C_RESOURCE | P_C_TEMPLATE | P_C_USER);return;}
if ($level === 1) { $this->setCacheLevel(P_C_BASIC | P_C_RESOURCE | P_C_TEMPLATE | P_C_USER | P_C_WIDGET); return;}
$this->_levelcache = $level;
}
// }}}
// {{{ setCacheLevel
/**
* ajout un niveau du cache
*
* @param integer
*/
public function addCacheLevel($level)
{
if ( ! $this->testCacheLevel($level))
$this->setCacheLevel($this->getCacheLevel() | $level);
}
// }}}
// {{{ getCacheLevel
/**
* retourne le niveau du cache
*
* @param integer
*/
public function getCacheLevel()
{
return $this->_levelcache;
}
// }}}
// {{{ testCacheLevel
/**
* permet de savoir si un niveau de cache est actif
*
* @param string
*/
function testCacheLevel($level)
{
return (($this->_levelcache & $level) == $level);
}
// }}}
// {{{ setCacheID
/**
* Choisir un identifiant de cache
*
* @param mixed
*/
public function setCacheID($i)
{
$this->_idcache = $i;
}
// }}}
// {{{ resetCacheID
/**
* RAZ de l'identifiant de cache
*/
public function resetCacheID()
{
$this->_idcache = 0;
}
// }}}
// {{{ initCache
/**
* Création de l'objet de getsion du cache
*/
protected function initCache()
{
$frontend = 'Core';
$backend = $this->getCacheOption('backend');
$frontendOptions = $this->getCacheOption('frontend'.$frontend);
$backendOptions = $this->getCacheOption('backend'.$backend);
$this->_cache = Zend_Cache::factory($frontend, $backend, $frontendOptions, $backendOptions);
if ($backend == 'File' && isset($this->_cache_options['backendFile']['cache_dir'])) {
$p = rtrim($this->_cache_options['backendFile']['cache_dir'], DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
if (!isset($this->_cache_options['hits'])) $this->_cache_options['hits'] = $p.'pxxo_cache.hits';
if (!isset($this->_cache_options['misses'])) $this->_cache_options['misses'] = $p.'pxxo_cache.misses';
if (!isset($this->_cache_options['entries'])) $this->_cache_options['entries'] = $p.'pxxo_cache.entries';
}
}
// }}}
// {{{ resetCache
/**
* Réinitilaise le cache (utile quand on a modifié en cours de route le paramètrage)
*
*/
public function resetCache()
{
unset($this->_cache);
$this->_cache = null;
}
// {{{ cleanCache
/**
* Supprime le cache courant
*/
public function cleanCache()
{
if ($this->isCaching()) {
if (is_null($this->_cache)) $this->initCache();
return $this->_cache->clean();
}
else
return false;
}
// }}}
// {{{ getCacheID
/**
* Retroune l'identifiant de cache courant
* Au passage on le calcul
*
* @return string
*/
public function getCacheID()
{
$func = $this->getCacheOption('convertArrayType');
if ($this->_idcache === 0) {
$this->_idcache = $func($this->_ids);
if (is_int($this->_idcache) and $this->_idcache < 0) $this->_idcache = strtr($this->_idcache, '-', '3');
}
if (isset($this->_idcache[0]) and $this->_idcache[0] == '-') $this->_idcache[0] = 'z';
return $this->_idcache;
}
// }}}
// {{{ getinCache
/**
* recupere les données stockés dans le cache
*
* @param string ID
* @param string LEVEL niveau de cache
* @return mixed DATA
*/
public function getinCache($id, $level = P_C_USER)
{
if ($this->isCaching() && $this->testCacheLevel($level)) {
if (is_null($this->_cache)) $this->initCache();
if (is_null($id)) $id = $this->getCacheID();
$id = md5($id);
if ($this->getCacheOption('stats')) {
if ($this->_cache->test($id) !== false) {
if ($this->getCacheOption('backend') == 'File') file_put_contents($this->getCacheOption('hits'), '.', FILE_APPEND | LOCK_EX);
elseif ($this->getCacheOption('backend') == 'APC') apc_store($this->getCacheOption('hits'),apc_fetch($this->getCacheOption('hits')) + 1);
}
else {
if ($this->getCacheOption('backend') == 'File') file_put_contents($this->getCacheOption('misses'), '.', FILE_APPEND | LOCK_EX);
elseif ($this->getCacheOption('backend') == 'APC') apc_store($this->getCacheOption('misses'),apc_fetch($this->getCacheOption('misses')) + 1);
}
}
return $this->_cache->get($id);

Source for file Pxxo.php