1: <?php
  2: 
  3: /**
  4:  * This file contains the path resolve cache collection and item class and its helper.
  5:  *
  6:  * @package          Core
  7:  * @subpackage       GenericDB_Model
  8:  * @author           Murat Purc <murat@purc.de>
  9:  * @copyright        four for business AG <www.4fb.de>
 10:  * @license          http://www.contenido.org/license/LIZENZ.txt
 11:  * @link             http://www.4fb.de
 12:  * @link             http://www.contenido.org
 13:  */
 14: 
 15: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
 16: 
 17: /**
 18:  * Pathresolve cache static helper class
 19:  *
 20:  * @package Core
 21:  * @subpackage Util
 22:  */
 23: class cApiPathresolveCacheHelper {
 24: 
 25:     /**
 26:      * Flag to state state about created heap table.
 27:      *
 28:      * @var bool
 29:      */
 30:     protected static $_tableCreated = false;
 31: 
 32:     /**
 33:      * Checks configuration of heap table creation, it's existance and creates
 34:      * it if needed.
 35:      *
 36:      * @param array $cfg
 37:      *         Global CONTENIDO config array
 38:      */
 39:     public static function setup($cfg) {
 40:         if (true === $cfg['pathresolve_heapcache'] && false === self::$_tableCreated) {
 41:             $db = cRegistry::getDb();
 42:             $tableName = $cfg['sql']['sqlprefix'] . '_pathresolve_cache';
 43: 
 44:             $sql = "SHOW TABLES LIKE '" . $db->escape($tableName) . "'";
 45:             $db->query($sql);
 46: 
 47:             if (!$db->nextRecord()) {
 48:                 // Important: This is really a hack! Don't use
 49:                 // pathresolve_heapcache if you are
 50:                 // not sure what it does.
 51:                 // @TODO: pls insert to this create table statetment MAX_ROWS.
 52:                 $sql = 'CREATE TABLE `' . $db->escape($tableName) . '` (
 53:                            `idpathresolvecache` INT(10) NOT NULL AUTO_INCREMENT,
 54:                            `path` VARCHAR(255) NOT NULL,
 55:                            `idcat` INT(10) NOT NULL,
 56:                            `idlang` INT(10) NOT NULL,
 57:                            `lastcached` INT(10) NOT NULL,
 58:                             PRIMARY KEY (`idpathresolvecache`)
 59:                         ) ENGINE = HEAP;';
 60:                 $db->query($sql);
 61:             }
 62:             self::$_tableCreated = true;
 63:         }
 64:     }
 65: 
 66: }
 67: 
 68: /**
 69:  * Pathresolve cache collection
 70:  *
 71:  * @package Core
 72:  * @subpackage GenericDB_Model
 73:  */
 74: class cApiPathresolveCacheCollection extends ItemCollection {
 75: 
 76:     /**
 77:      * Constructor
 78:      */
 79:     public function __construct() {
 80:         global $cfg;
 81:         cApiPathresolveCacheHelper::setup($cfg['sql']['sqlprefix'] . '_pathresolve_cache');
 82:         parent::__construct($cfg['sql']['sqlprefix'] . '_pathresolve_cache', 'idpathresolvecache');
 83:         $this->_setItemClass('cApiPathresolveCache');
 84:     }
 85: 
 86:     /**
 87:      * Creates a pathresolve cache entry.
 88:      *
 89:      * @param string $path
 90:      * @param int $idcat
 91:      * @param int $idlang
 92:      * @param string $lastcached [optional]
 93:      * @return cApiPathresolveCache
 94:      */
 95:     public function create($path, $idcat, $idlang, $lastcached = '') {
 96:         $oItem = $this->createNewItem();
 97: 
 98:         if (empty($lastcached)) {
 99:             $lastcached = time();
100:         }
101: 
102:         $oItem->set('path', $path, false);
103:         $oItem->set('idcat', $idcat, false);
104:         $oItem->set('idlang', $idlang, false);
105:         $oItem->set('lastcached', $lastcached, false);
106:         $oItem->store();
107: 
108:         return $oItem;
109:     }
110: 
111:     /**
112:      * Returns a last cached entry by path and language.
113:      *
114:      * @param string $path
115:      * @param int $idlang
116:      * @return cApiPathresolveCache|NULL
117:      */
118:     public function fetchLatestByPathAndLanguage($path, $idlang) {
119:         $this->select("path LIKE '" . $this->db->escape($path) . "' AND idlang=" . (int) $idlang, '', 'lastcached DESC', '1');
120:         return $this->next();
121:     }
122: 
123:     /**
124:      * Deletes entry by category and language.
125:      *
126:      * @param int $idcat
127:      * @param int $idlang
128:      */
129:     public function deleteByCategoryAndLanguage($idcat, $idlang) {
130:         $this->select('idcat=' . (int) $idcat . ' AND idlang=' . (int) $idlang);
131:         while (($oCode = $this->next()) !== false) {
132:             $this->delete($oCode->get('idpathresolvecache'));
133:         }
134:     }
135: 
136: }
137: 
138: /**
139:  * Pathresolve cache item
140:  *
141:  * @package Core
142:  * @subpackage GenericDB_Model
143:  */
144: class cApiPathresolveCache extends Item {
145: 
146:     /**
147:      * Constructor Function
148:      *
149:      * @param mixed $mId [optional]
150:      *         Specifies the ID of item to load
151:      */
152:     public function __construct($mId = false) {
153:         global $cfg;
154:         cApiPathresolveCacheHelper::setup($cfg['sql']['sqlprefix'] . '_pathresolve_cache');
155:         parent::__construct($cfg['sql']['sqlprefix'] . '_pathresolve_cache', 'idpathresolvecache');
156:         $this->setFilters(array(), array());
157:         if ($mId !== false) {
158:             $this->loadByPrimaryKey($mId);
159:         }
160:     }
161: 
162:     /**
163:      * Checks if item's cache time has expired.
164:      *
165:      * @throws cException If item has not been loaded before
166:      * @return bool
167:      */
168:     public function isCacheTimeExpired() {
169:         global $cfg;
170:         if (!$this->isLoaded()) {
171:             throw new cException('Item not loaded!');
172:         }
173:         $cacheTime = (isset($cfg['pathresolve_heapcache_time'])) ? $cfg['pathresolve_heapcache_time'] : 60 * 60 * 24;
174:         return $this->get('lastcached') + $cacheTime < time();
175:     }
176: 
177:     /**
178:      * Userdefined setter for pathresolve cache fields.
179:      *
180:      * @todo should return return value of overloaded method
181:      * @param string $name
182:      * @param mixed $value
183:      * @param bool $bSafe [optional]
184:      *         Flag to run defined inFilter on passed value
185:      */
186:     public function setField($name, $value, $bSafe = true) {
187:         switch ($name) {
188:             case 'idcat':
189:             case 'idlang':
190:                 $value = (int) $value;
191:                 break;
192:         }
193: 
194:         parent::setField($name, $value, $bSafe);
195:     }
196: 
197: }
198: