@@ -29,82 +29,82 @@ |
||
| 29 | 29 | |
| 30 | 30 | class TReCaptcha2Validator extends TBaseValidator |
| 31 | 31 | { |
| 32 | - protected $_isvalid = null; |
|
| 32 | + protected $_isvalid = null; |
|
| 33 | 33 | |
| 34 | - protected function getClientClassName() |
|
| 35 | - { |
|
| 36 | - return 'Prado.WebUI.TReCaptcha2Validator'; |
|
| 37 | - } |
|
| 38 | - public function getEnableClientScript() |
|
| 39 | - { |
|
| 40 | - return true; |
|
| 41 | - } |
|
| 42 | - protected function getCaptchaControl() |
|
| 43 | - { |
|
| 44 | - $control = $this->getValidationTarget(); |
|
| 45 | - if (!$control) |
|
| 46 | - throw new Exception('No target control specified for TReCaptcha2Validator'); |
|
| 47 | - if (!($control instanceof TReCaptcha2)) |
|
| 48 | - throw new Exception('TReCaptcha2Validator only works with TReCaptcha2 controls'); |
|
| 49 | - return $control; |
|
| 50 | - } |
|
| 51 | - public function getClientScriptOptions() |
|
| 52 | - { |
|
| 53 | - $options = parent::getClientScriptOptions(); |
|
| 54 | - $options['ResponseFieldName'] = $this->getCaptchaControl()->getResponseFieldName(); |
|
| 55 | - return $options; |
|
| 56 | - } |
|
| 57 | - /** |
|
| 58 | - * This method overrides the parent's implementation. |
|
| 59 | - * The validation succeeds if the input control has the same value |
|
| 60 | - * as the one displayed in the corresponding RECAPTCHA control. |
|
| 61 | - * |
|
| 62 | - * @return boolean whether the validation succeeds |
|
| 63 | - */ |
|
| 64 | - protected function evaluateIsValid() |
|
| 65 | - { |
|
| 66 | - // check validity only once (if trying to evaulate multiple times, all redundant checks would fail) |
|
| 67 | - if (is_null($this->_isvalid)) |
|
| 68 | - { |
|
| 69 | - $control = $this->getCaptchaControl(); |
|
| 70 | - $this->_isvalid = $control->validate(); |
|
| 71 | - } |
|
| 72 | - return ($this->_isvalid==true); |
|
| 73 | - } |
|
| 74 | - public function onPreRender($param) |
|
| 75 | - { |
|
| 76 | - parent::onPreRender($param); |
|
| 34 | + protected function getClientClassName() |
|
| 35 | + { |
|
| 36 | + return 'Prado.WebUI.TReCaptcha2Validator'; |
|
| 37 | + } |
|
| 38 | + public function getEnableClientScript() |
|
| 39 | + { |
|
| 40 | + return true; |
|
| 41 | + } |
|
| 42 | + protected function getCaptchaControl() |
|
| 43 | + { |
|
| 44 | + $control = $this->getValidationTarget(); |
|
| 45 | + if (!$control) |
|
| 46 | + throw new Exception('No target control specified for TReCaptcha2Validator'); |
|
| 47 | + if (!($control instanceof TReCaptcha2)) |
|
| 48 | + throw new Exception('TReCaptcha2Validator only works with TReCaptcha2 controls'); |
|
| 49 | + return $control; |
|
| 50 | + } |
|
| 51 | + public function getClientScriptOptions() |
|
| 52 | + { |
|
| 53 | + $options = parent::getClientScriptOptions(); |
|
| 54 | + $options['ResponseFieldName'] = $this->getCaptchaControl()->getResponseFieldName(); |
|
| 55 | + return $options; |
|
| 56 | + } |
|
| 57 | + /** |
|
| 58 | + * This method overrides the parent's implementation. |
|
| 59 | + * The validation succeeds if the input control has the same value |
|
| 60 | + * as the one displayed in the corresponding RECAPTCHA control. |
|
| 61 | + * |
|
| 62 | + * @return boolean whether the validation succeeds |
|
| 63 | + */ |
|
| 64 | + protected function evaluateIsValid() |
|
| 65 | + { |
|
| 66 | + // check validity only once (if trying to evaulate multiple times, all redundant checks would fail) |
|
| 67 | + if (is_null($this->_isvalid)) |
|
| 68 | + { |
|
| 69 | + $control = $this->getCaptchaControl(); |
|
| 70 | + $this->_isvalid = $control->validate(); |
|
| 71 | + } |
|
| 72 | + return ($this->_isvalid==true); |
|
| 73 | + } |
|
| 74 | + public function onPreRender($param) |
|
| 75 | + { |
|
| 76 | + parent::onPreRender($param); |
|
| 77 | 77 | |
| 78 | - $cs = $this->Page->getClientScript(); |
|
| 79 | - $cs->registerPradoScript('validator'); |
|
| 78 | + $cs = $this->Page->getClientScript(); |
|
| 79 | + $cs->registerPradoScript('validator'); |
|
| 80 | 80 | |
| 81 | - // communicate validation status to the client side |
|
| 82 | - $value = $this->_isvalid===false ? '0' : '1'; |
|
| 83 | - $cs->registerHiddenField($this->getClientID().'_1',$value); |
|
| 81 | + // communicate validation status to the client side |
|
| 82 | + $value = $this->_isvalid===false ? '0' : '1'; |
|
| 83 | + $cs->registerHiddenField($this->getClientID().'_1',$value); |
|
| 84 | 84 | |
| 85 | - // update validator display |
|
| 86 | - if ($control = $this->getValidationTarget()) |
|
| 87 | - { |
|
| 88 | - $fn = 'captchaUpdateValidatorStatus_'.$this->getClientID(); |
|
| 85 | + // update validator display |
|
| 86 | + if ($control = $this->getValidationTarget()) |
|
| 87 | + { |
|
| 88 | + $fn = 'captchaUpdateValidatorStatus_'.$this->getClientID(); |
|
| 89 | 89 | |
| 90 | - $cs->registerEndScript($this->getClientID().'::validate', implode(' ',array( |
|
| 91 | - // this function will be used to update the validator |
|
| 92 | - 'function '.$fn.'(valid)', |
|
| 93 | - '{', |
|
| 94 | - ' jQuery('.TJavaScript::quoteString('#'.$this->getClientID().'_1').').val(valid);', |
|
| 95 | - ' Prado.Validation.validateControl('.TJavaScript::quoteString($control->ClientID).'); ', |
|
| 96 | - '}', |
|
| 97 | - '', |
|
| 98 | - // update the validator to the result if we're in a callback |
|
| 99 | - // (if we're in initial rendering or a postback then the result will be rendered directly to the page html anyway) |
|
| 100 | - $this->Page->IsCallback ? $fn.'('.$value.');' : '', |
|
| 101 | - '', |
|
| 102 | - // install event handler that clears the validation error when user changes the captcha response field |
|
| 103 | - 'jQuery("#'.$control->getClientID().'").on("change", '.TJavaScript::quoteString('#'.$control->getResponseFieldName()).', function() { ', |
|
| 104 | - $fn.'("1");', |
|
| 105 | - '});', |
|
| 106 | - ))); |
|
| 107 | - } |
|
| 108 | - } |
|
| 90 | + $cs->registerEndScript($this->getClientID().'::validate', implode(' ',array( |
|
| 91 | + // this function will be used to update the validator |
|
| 92 | + 'function '.$fn.'(valid)', |
|
| 93 | + '{', |
|
| 94 | + ' jQuery('.TJavaScript::quoteString('#'.$this->getClientID().'_1').').val(valid);', |
|
| 95 | + ' Prado.Validation.validateControl('.TJavaScript::quoteString($control->ClientID).'); ', |
|
| 96 | + '}', |
|
| 97 | + '', |
|
| 98 | + // update the validator to the result if we're in a callback |
|
| 99 | + // (if we're in initial rendering or a postback then the result will be rendered directly to the page html anyway) |
|
| 100 | + $this->Page->IsCallback ? $fn.'('.$value.');' : '', |
|
| 101 | + '', |
|
| 102 | + // install event handler that clears the validation error when user changes the captcha response field |
|
| 103 | + 'jQuery("#'.$control->getClientID().'").on("change", '.TJavaScript::quoteString('#'.$control->getResponseFieldName()).', function() { ', |
|
| 104 | + $fn.'("1");', |
|
| 105 | + '});', |
|
| 106 | + ))); |
|
| 107 | + } |
|
| 108 | + } |
|
| 109 | 109 | } |
| 110 | 110 | |
@@ -46,575 +46,575 @@ |
||
| 46 | 46 | class TCache_Lite |
| 47 | 47 | { |
| 48 | 48 | |
| 49 | - // --- Private properties --- |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Directory where to put the cache files |
|
| 53 | - * (make sure to add a trailing slash) |
|
| 54 | - * |
|
| 55 | - * @var string $_cacheDir |
|
| 56 | - */ |
|
| 57 | - protected $_cacheDir = '/tmp/'; |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Enable / disable caching |
|
| 61 | - * |
|
| 62 | - * (can be very usefull for the debug of cached scripts) |
|
| 63 | - * |
|
| 64 | - * @var boolean $_caching |
|
| 65 | - */ |
|
| 66 | - protected $_caching = true; |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Cache lifetime (in seconds) |
|
| 70 | - * |
|
| 71 | - * @var int $_lifeTime |
|
| 72 | - */ |
|
| 73 | - protected $_lifeTime = 3600; |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * Enable / disable fileLocking |
|
| 77 | - * |
|
| 78 | - * (can avoid cache corruption under bad circumstances) |
|
| 79 | - * |
|
| 80 | - * @var boolean $_fileLocking |
|
| 81 | - */ |
|
| 82 | - protected $_fileLocking = true; |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Timestamp of the last valid cache |
|
| 86 | - * |
|
| 87 | - * @var int $_refreshTime |
|
| 88 | - */ |
|
| 89 | - protected $_refreshTime; |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * File name (with path) |
|
| 93 | - * |
|
| 94 | - * @var string $_file |
|
| 95 | - */ |
|
| 96 | - protected $_file; |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Enable / disable write control (the cache is read just after writing |
|
| 100 | - * to detect corrupt entries) |
|
| 101 | - * |
|
| 102 | - * Enable write control will lightly slow the cache writing but not the |
|
| 103 | - * cache reading. Write control can detect some corrupt cache files but |
|
| 104 | - * maybe it's not a perfect control |
|
| 105 | - * |
|
| 106 | - * @var boolean $_writeControl |
|
| 107 | - */ |
|
| 108 | - protected $_writeControl = true; |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Enable / disable read control |
|
| 112 | - * |
|
| 113 | - * If enabled, a control key is embeded in cache file and this key is |
|
| 114 | - * compared with the one calculated after the reading. |
|
| 115 | - * |
|
| 116 | - * @var boolean $_writeControl |
|
| 117 | - */ |
|
| 118 | - protected $_readControl = true; |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Type of read control (only if read control is enabled) |
|
| 122 | - * |
|
| 123 | - * Available values are : |
|
| 124 | - * 'md5' for a md5 hash control (best but slowest) |
|
| 125 | - * 'crc32' for a crc32 hash control (lightly less safe but faster, |
|
| 126 | - * better choice) |
|
| 127 | - * 'strlen' for a length only test (fastest) |
|
| 128 | - * |
|
| 129 | - * @var boolean $_readControlType |
|
| 130 | - */ |
|
| 131 | - protected $_readControlType = 'crc32'; |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Current cache id |
|
| 135 | - * |
|
| 136 | - * @var string $_id |
|
| 137 | - */ |
|
| 138 | - protected $_id; |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * Current cache group |
|
| 142 | - * |
|
| 143 | - * @var string $_group |
|
| 144 | - */ |
|
| 145 | - protected $_group; |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * Enable / Disable "Memory Caching" |
|
| 149 | - * |
|
| 150 | - * NB : There is no lifetime for memory caching ! |
|
| 151 | - * |
|
| 152 | - * @var boolean $_memoryCaching |
|
| 153 | - */ |
|
| 154 | - protected $_memoryCaching = false; |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Enable / Disable "Only Memory Caching" |
|
| 158 | - * (be carefull, memory caching is "beta quality") |
|
| 159 | - * |
|
| 160 | - * @var boolean $_onlyMemoryCaching |
|
| 161 | - */ |
|
| 162 | - protected $_onlyMemoryCaching = false; |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Memory caching array |
|
| 166 | - * |
|
| 167 | - * @var array $_memoryCachingArray |
|
| 168 | - */ |
|
| 169 | - protected $_memoryCachingArray = array(); |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * Memory caching counter |
|
| 173 | - * |
|
| 174 | - * @var int $memoryCachingCounter |
|
| 175 | - */ |
|
| 176 | - protected $_memoryCachingCounter = 0; |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * Memory caching limit |
|
| 180 | - * |
|
| 181 | - * @var int $memoryCachingLimit |
|
| 182 | - */ |
|
| 183 | - protected $_memoryCachingLimit = 1000; |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * File Name protection |
|
| 187 | - * |
|
| 188 | - * if set to true, you can use any cache id or group name |
|
| 189 | - * if set to false, it can be faster but cache ids and group names |
|
| 190 | - * will be used directly in cache file names so be carefull with |
|
| 191 | - * special characters... |
|
| 192 | - * |
|
| 193 | - * @var boolean $fileNameProtection |
|
| 194 | - */ |
|
| 195 | - protected $_fileNameProtection = true; |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * Enable / disable automatic serialization |
|
| 199 | - * |
|
| 200 | - * it can be used to save directly datas which aren't strings |
|
| 201 | - * (but it's slower) |
|
| 202 | - * |
|
| 203 | - * @var boolean $_serialize |
|
| 204 | - */ |
|
| 205 | - protected $_automaticSerialization = false; |
|
| 206 | - |
|
| 207 | - // --- Public methods --- |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * Constructor |
|
| 211 | - * |
|
| 212 | - * $options is an assoc. Available options are : |
|
| 213 | - * $options = array( |
|
| 214 | - * 'cacheDir' => directory where to put the cache files (string), |
|
| 215 | - * 'caching' => enable / disable caching (boolean), |
|
| 216 | - * 'lifeTime' => cache lifetime in seconds (int), |
|
| 217 | - * 'fileLocking' => enable / disable fileLocking (boolean), |
|
| 218 | - * 'writeControl' => enable / disable write control (boolean), |
|
| 219 | - * 'readControl' => enable / disable read control (boolean), |
|
| 220 | - * 'readControlType' => type of read control 'crc32', 'md5', 'strlen', |
|
| 221 | - * 'memoryCaching' => enable / disable memory caching (boolean), |
|
| 222 | - * 'onlyMemoryCaching' => enable / disable only memory caching (boolean), |
|
| 223 | - * 'memoryCachingLimit' => max nbr of records in memory caching (int), |
|
| 224 | - * 'fileNameProtection' => enable / disable file name protection (boolean), |
|
| 225 | - * 'automaticSerialization' => enable / disable serialization (boolean) |
|
| 226 | - * ); |
|
| 227 | - * |
|
| 228 | - * @param array $options options |
|
| 229 | - * @access public |
|
| 230 | - */ |
|
| 231 | - function __construct($options = array(null)) |
|
| 232 | - { |
|
| 233 | - $availableOptions = array( 'automaticSerialization', |
|
| 234 | - 'fileNameProtection', |
|
| 235 | - 'memoryCaching', |
|
| 236 | - 'onlyMemoryCaching', |
|
| 237 | - 'memoryCachingLimit', |
|
| 238 | - 'cacheDir', |
|
| 239 | - 'caching', |
|
| 240 | - 'lifeTime', |
|
| 241 | - 'fileLocking', |
|
| 242 | - 'writeControl', |
|
| 243 | - 'readControl', |
|
| 244 | - 'readControlType'); |
|
| 245 | - foreach($options as $key => $value) { |
|
| 246 | - if(in_array($key, $availableOptions)) { |
|
| 247 | - $property = '_'.$key; |
|
| 248 | - $this->$property = $value; |
|
| 249 | - } |
|
| 250 | - } |
|
| 251 | - $this->_refreshTime = time() - $this->_lifeTime; |
|
| 49 | + // --- Private properties --- |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Directory where to put the cache files |
|
| 53 | + * (make sure to add a trailing slash) |
|
| 54 | + * |
|
| 55 | + * @var string $_cacheDir |
|
| 56 | + */ |
|
| 57 | + protected $_cacheDir = '/tmp/'; |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Enable / disable caching |
|
| 61 | + * |
|
| 62 | + * (can be very usefull for the debug of cached scripts) |
|
| 63 | + * |
|
| 64 | + * @var boolean $_caching |
|
| 65 | + */ |
|
| 66 | + protected $_caching = true; |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * Cache lifetime (in seconds) |
|
| 70 | + * |
|
| 71 | + * @var int $_lifeTime |
|
| 72 | + */ |
|
| 73 | + protected $_lifeTime = 3600; |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * Enable / disable fileLocking |
|
| 77 | + * |
|
| 78 | + * (can avoid cache corruption under bad circumstances) |
|
| 79 | + * |
|
| 80 | + * @var boolean $_fileLocking |
|
| 81 | + */ |
|
| 82 | + protected $_fileLocking = true; |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Timestamp of the last valid cache |
|
| 86 | + * |
|
| 87 | + * @var int $_refreshTime |
|
| 88 | + */ |
|
| 89 | + protected $_refreshTime; |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * File name (with path) |
|
| 93 | + * |
|
| 94 | + * @var string $_file |
|
| 95 | + */ |
|
| 96 | + protected $_file; |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Enable / disable write control (the cache is read just after writing |
|
| 100 | + * to detect corrupt entries) |
|
| 101 | + * |
|
| 102 | + * Enable write control will lightly slow the cache writing but not the |
|
| 103 | + * cache reading. Write control can detect some corrupt cache files but |
|
| 104 | + * maybe it's not a perfect control |
|
| 105 | + * |
|
| 106 | + * @var boolean $_writeControl |
|
| 107 | + */ |
|
| 108 | + protected $_writeControl = true; |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Enable / disable read control |
|
| 112 | + * |
|
| 113 | + * If enabled, a control key is embeded in cache file and this key is |
|
| 114 | + * compared with the one calculated after the reading. |
|
| 115 | + * |
|
| 116 | + * @var boolean $_writeControl |
|
| 117 | + */ |
|
| 118 | + protected $_readControl = true; |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Type of read control (only if read control is enabled) |
|
| 122 | + * |
|
| 123 | + * Available values are : |
|
| 124 | + * 'md5' for a md5 hash control (best but slowest) |
|
| 125 | + * 'crc32' for a crc32 hash control (lightly less safe but faster, |
|
| 126 | + * better choice) |
|
| 127 | + * 'strlen' for a length only test (fastest) |
|
| 128 | + * |
|
| 129 | + * @var boolean $_readControlType |
|
| 130 | + */ |
|
| 131 | + protected $_readControlType = 'crc32'; |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Current cache id |
|
| 135 | + * |
|
| 136 | + * @var string $_id |
|
| 137 | + */ |
|
| 138 | + protected $_id; |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * Current cache group |
|
| 142 | + * |
|
| 143 | + * @var string $_group |
|
| 144 | + */ |
|
| 145 | + protected $_group; |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * Enable / Disable "Memory Caching" |
|
| 149 | + * |
|
| 150 | + * NB : There is no lifetime for memory caching ! |
|
| 151 | + * |
|
| 152 | + * @var boolean $_memoryCaching |
|
| 153 | + */ |
|
| 154 | + protected $_memoryCaching = false; |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Enable / Disable "Only Memory Caching" |
|
| 158 | + * (be carefull, memory caching is "beta quality") |
|
| 159 | + * |
|
| 160 | + * @var boolean $_onlyMemoryCaching |
|
| 161 | + */ |
|
| 162 | + protected $_onlyMemoryCaching = false; |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Memory caching array |
|
| 166 | + * |
|
| 167 | + * @var array $_memoryCachingArray |
|
| 168 | + */ |
|
| 169 | + protected $_memoryCachingArray = array(); |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * Memory caching counter |
|
| 173 | + * |
|
| 174 | + * @var int $memoryCachingCounter |
|
| 175 | + */ |
|
| 176 | + protected $_memoryCachingCounter = 0; |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * Memory caching limit |
|
| 180 | + * |
|
| 181 | + * @var int $memoryCachingLimit |
|
| 182 | + */ |
|
| 183 | + protected $_memoryCachingLimit = 1000; |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * File Name protection |
|
| 187 | + * |
|
| 188 | + * if set to true, you can use any cache id or group name |
|
| 189 | + * if set to false, it can be faster but cache ids and group names |
|
| 190 | + * will be used directly in cache file names so be carefull with |
|
| 191 | + * special characters... |
|
| 192 | + * |
|
| 193 | + * @var boolean $fileNameProtection |
|
| 194 | + */ |
|
| 195 | + protected $_fileNameProtection = true; |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * Enable / disable automatic serialization |
|
| 199 | + * |
|
| 200 | + * it can be used to save directly datas which aren't strings |
|
| 201 | + * (but it's slower) |
|
| 202 | + * |
|
| 203 | + * @var boolean $_serialize |
|
| 204 | + */ |
|
| 205 | + protected $_automaticSerialization = false; |
|
| 206 | + |
|
| 207 | + // --- Public methods --- |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * Constructor |
|
| 211 | + * |
|
| 212 | + * $options is an assoc. Available options are : |
|
| 213 | + * $options = array( |
|
| 214 | + * 'cacheDir' => directory where to put the cache files (string), |
|
| 215 | + * 'caching' => enable / disable caching (boolean), |
|
| 216 | + * 'lifeTime' => cache lifetime in seconds (int), |
|
| 217 | + * 'fileLocking' => enable / disable fileLocking (boolean), |
|
| 218 | + * 'writeControl' => enable / disable write control (boolean), |
|
| 219 | + * 'readControl' => enable / disable read control (boolean), |
|
| 220 | + * 'readControlType' => type of read control 'crc32', 'md5', 'strlen', |
|
| 221 | + * 'memoryCaching' => enable / disable memory caching (boolean), |
|
| 222 | + * 'onlyMemoryCaching' => enable / disable only memory caching (boolean), |
|
| 223 | + * 'memoryCachingLimit' => max nbr of records in memory caching (int), |
|
| 224 | + * 'fileNameProtection' => enable / disable file name protection (boolean), |
|
| 225 | + * 'automaticSerialization' => enable / disable serialization (boolean) |
|
| 226 | + * ); |
|
| 227 | + * |
|
| 228 | + * @param array $options options |
|
| 229 | + * @access public |
|
| 230 | + */ |
|
| 231 | + function __construct($options = array(null)) |
|
| 232 | + { |
|
| 233 | + $availableOptions = array( 'automaticSerialization', |
|
| 234 | + 'fileNameProtection', |
|
| 235 | + 'memoryCaching', |
|
| 236 | + 'onlyMemoryCaching', |
|
| 237 | + 'memoryCachingLimit', |
|
| 238 | + 'cacheDir', |
|
| 239 | + 'caching', |
|
| 240 | + 'lifeTime', |
|
| 241 | + 'fileLocking', |
|
| 242 | + 'writeControl', |
|
| 243 | + 'readControl', |
|
| 244 | + 'readControlType'); |
|
| 245 | + foreach($options as $key => $value) { |
|
| 246 | + if(in_array($key, $availableOptions)) { |
|
| 247 | + $property = '_'.$key; |
|
| 248 | + $this->$property = $value; |
|
| 249 | + } |
|
| 250 | + } |
|
| 251 | + $this->_refreshTime = time() - $this->_lifeTime; |
|
| 252 | 252 | } |
| 253 | 253 | |
| 254 | - /** |
|
| 255 | - * Test if a cache is available and (if yes) return it |
|
| 256 | - * |
|
| 257 | - * @param string $id cache id |
|
| 258 | - * @param string $group name of the cache group |
|
| 259 | - * @param boolean $doNotTestCacheValidity if set to true, the cache |
|
| 260 | - * validity won't be tested |
|
| 261 | - * @return string data of the cache (or false if no cache available) |
|
| 262 | - * @access public |
|
| 263 | - */ |
|
| 264 | - function get($id, $group = 'default', $doNotTestCacheValidity = false) |
|
| 265 | - { |
|
| 266 | - $this->_id = $id; |
|
| 267 | - $this->_group = $group; |
|
| 268 | - $data = false; |
|
| 269 | - if ($this->_caching) { |
|
| 270 | - $this->_setFileName($id, $group); |
|
| 271 | - if ($this->_memoryCaching) { |
|
| 272 | - if (isset($this->_memoryCachingArray[$this->_file])) { |
|
| 273 | - if ($this->_automaticSerialization) { |
|
| 274 | - return unserialize( |
|
| 275 | - $this->_memoryCachingArray[$this->_file]); |
|
| 276 | - } else { |
|
| 277 | - return $this->_memoryCachingArray[$this->_file]; |
|
| 278 | - } |
|
| 279 | - } else { |
|
| 280 | - if ($this->_onlyMemoryCaching) { |
|
| 281 | - return false; |
|
| 282 | - } |
|
| 283 | - } |
|
| 284 | - } |
|
| 285 | - if ($doNotTestCacheValidity) { |
|
| 286 | - if (file_exists($this->_file)) { |
|
| 287 | - $data = $this->_read(); |
|
| 288 | - } |
|
| 289 | - } else { |
|
| 290 | - if (@filemtime($this->_file) > $this->_refreshTime) { |
|
| 291 | - $data = $this->_read(); |
|
| 292 | - } |
|
| 293 | - } |
|
| 294 | - if (($data) and ($this->_memoryCaching)) { |
|
| 295 | - $this->_memoryCacheAdd($this->_file, $data); |
|
| 296 | - } |
|
| 297 | - if ($this->_automaticSerialization && is_string($data)) { |
|
| 298 | - $data = unserialize($data); |
|
| 299 | - } |
|
| 300 | - return $data; |
|
| 301 | - } |
|
| 302 | - return false; |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * Save some data in a cache file |
|
| 307 | - * |
|
| 308 | - * @param string $data data to put in cache (can be another type than strings |
|
| 309 | - * if automaticSerialization is on) |
|
| 310 | - * @param string $id cache id |
|
| 311 | - * @param string $group name of the cache group |
|
| 312 | - * @return boolean true if no problem |
|
| 313 | - * @access public |
|
| 314 | - */ |
|
| 315 | - function save($data, $id = null, $group = 'default') |
|
| 316 | - { |
|
| 317 | - if ($this->_caching) { |
|
| 318 | - if ($this->_automaticSerialization) { |
|
| 319 | - $data = serialize($data); |
|
| 320 | - } |
|
| 321 | - if (isset($id)) { |
|
| 322 | - $this->_setFileName($id, $group); |
|
| 323 | - } |
|
| 324 | - if ($this->_memoryCaching) { |
|
| 325 | - $this->_memoryCacheAdd($this->_file, $data); |
|
| 326 | - if ($this->_onlyMemoryCaching) { |
|
| 327 | - return true; |
|
| 328 | - } |
|
| 329 | - } |
|
| 330 | - if ($this->_writeControl) { |
|
| 331 | - if (!$this->_writeAndControl($data)) { |
|
| 332 | - @touch($this->_file, time() - 2*abs($this->_lifeTime)); |
|
| 333 | - return false; |
|
| 334 | - } else { |
|
| 335 | - return true; |
|
| 336 | - } |
|
| 337 | - } else { |
|
| 338 | - return $this->_write($data); |
|
| 339 | - } |
|
| 340 | - } |
|
| 341 | - return false; |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * Remove a cache file |
|
| 346 | - * |
|
| 347 | - * @param string $id cache id |
|
| 348 | - * @param string $group name of the cache group |
|
| 349 | - * @return boolean true if no problem |
|
| 350 | - * @access public |
|
| 351 | - */ |
|
| 352 | - function remove($id, $group = 'default') |
|
| 353 | - { |
|
| 354 | - $this->_setFileName($id, $group); |
|
| 355 | - if (!@unlink($this->_file)) { |
|
| 356 | - $this->raiseError('TCache_Lite : Unable to remove cache !', -3); |
|
| 357 | - return false; |
|
| 358 | - } |
|
| 359 | - return true; |
|
| 360 | - } |
|
| 361 | - |
|
| 362 | - /** |
|
| 363 | - * Clean the cache |
|
| 364 | - * |
|
| 365 | - * if no group is specified all cache files will be destroyed |
|
| 366 | - * else only cache files of the specified group will be destroyed |
|
| 367 | - * |
|
| 368 | - * @param string $group name of the cache group |
|
| 369 | - * @return boolean true if no problem |
|
| 370 | - * @access public |
|
| 371 | - */ |
|
| 372 | - function clean($group = false) |
|
| 373 | - { |
|
| 374 | - if ($this->_fileNameProtection) { |
|
| 375 | - $motif = ($group) ? 'cache_'.md5($group).'_' : 'cache_'; |
|
| 376 | - } else { |
|
| 377 | - $motif = ($group) ? 'cache_'.$group.'_' : 'cache_'; |
|
| 378 | - } |
|
| 379 | - if ($this->_memoryCaching) { |
|
| 380 | - while (list($key, $value) = each($this->_memoryCaching)) { |
|
| 381 | - if (strpos($key, $motif, 0)) { |
|
| 382 | - unset($this->_memoryCaching[$key]); |
|
| 383 | - $this->_memoryCachingCounter = |
|
| 384 | - $this->_memoryCachingCounter - 1; |
|
| 385 | - } |
|
| 386 | - } |
|
| 387 | - if ($this->_onlyMemoryCaching) { |
|
| 388 | - return true; |
|
| 389 | - } |
|
| 390 | - } |
|
| 391 | - if (!($dh = opendir($this->_cacheDir))) { |
|
| 392 | - $this->raiseError('TCache_Lite : Unable to open cache directory !'); |
|
| 393 | - return false; |
|
| 394 | - } |
|
| 395 | - while ($file = readdir($dh)) { |
|
| 396 | - if (($file != '.') && ($file != '..')) { |
|
| 397 | - $file = $this->_cacheDir . $file; |
|
| 398 | - if (is_file($file)) { |
|
| 399 | - if (strpos($file, $motif, 0)) { |
|
| 400 | - if (!@unlink($file)) { |
|
| 401 | - $this->raiseError('Cache_Lite : Unable to remove cache !', -3); |
|
| 402 | - return false; |
|
| 403 | - } |
|
| 404 | - } |
|
| 405 | - } |
|
| 406 | - } |
|
| 407 | - } |
|
| 408 | - return true; |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - /** |
|
| 412 | - * Set a new life time |
|
| 413 | - * |
|
| 414 | - * @param int $newLifeTime new life time (in seconds) |
|
| 415 | - * @access public |
|
| 416 | - */ |
|
| 417 | - function setLifeTime($newLifeTime) |
|
| 418 | - { |
|
| 419 | - $this->_lifeTime = $newLifeTime; |
|
| 420 | - $this->_refreshTime = time() - $newLifeTime; |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * |
|
| 425 | - * @access public |
|
| 426 | - */ |
|
| 427 | - function saveMemoryCachingState($id, $group = 'default') |
|
| 428 | - { |
|
| 429 | - if ($this->_caching) { |
|
| 430 | - $array = array( |
|
| 431 | - 'counter' => $this->_memoryCachingCounter, |
|
| 432 | - 'array' => $this->_memoryCachingState |
|
| 433 | - ); |
|
| 434 | - $data = serialize($array); |
|
| 435 | - $this->save($data, $id, $group); |
|
| 436 | - } |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - /** |
|
| 440 | - * |
|
| 441 | - * @access public |
|
| 442 | - */ |
|
| 443 | - function getMemoryCachingState($id, $group = 'default', |
|
| 444 | - $doNotTestCacheValidity = false) |
|
| 445 | - { |
|
| 446 | - if ($this->_caching) { |
|
| 447 | - if ($data = $this->get($id, $group, $doNotTestCacheValidity)) |
|
| 448 | - { |
|
| 449 | - $array = unserialize($data); |
|
| 450 | - $this->_memoryCachingCounter = $array['counter']; |
|
| 451 | - $this->_memoryCachingArray = $array['array']; |
|
| 452 | - } |
|
| 453 | - } |
|
| 454 | - } |
|
| 455 | - |
|
| 456 | - /** |
|
| 457 | - * Return the cache last modification time |
|
| 458 | - * |
|
| 459 | - * BE CAREFUL : THIS METHOD IS FOR HACKING ONLY ! |
|
| 460 | - * |
|
| 461 | - * @return int last modification time |
|
| 462 | - */ |
|
| 463 | - function lastModified() { |
|
| 464 | - return filemtime($this->cache->_file); |
|
| 465 | - } |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * Trigger a PEAR error |
|
| 469 | - * |
|
| 470 | - * To improve performances, the PEAR.php file is included dynamically. |
|
| 471 | - * The file is so included only when an error is triggered. So, in most |
|
| 472 | - * cases, the file isn't included and perfs are much better. |
|
| 473 | - * |
|
| 474 | - * @param string $msg error message |
|
| 475 | - * @param int $code error code |
|
| 476 | - * @access public |
|
| 477 | - */ |
|
| 478 | - function raiseError($msg, $code) |
|
| 479 | - { |
|
| 480 | - throw new Exception($msg); |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - // --- Private methods --- |
|
| 484 | - |
|
| 485 | - /** |
|
| 486 | - * |
|
| 487 | - * @access private |
|
| 488 | - */ |
|
| 489 | - function _memoryCacheAdd($id, $data) |
|
| 490 | - { |
|
| 491 | - $this->_memoryCachingArray[$this->_file] = $data; |
|
| 492 | - if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) { |
|
| 493 | - list($key, $value) = each($this->_memoryCachingArray); |
|
| 494 | - unset($this->_memoryCachingArray[$key]); |
|
| 495 | - } else { |
|
| 496 | - $this->_memoryCachingCounter = $this->_memoryCachingCounter + 1; |
|
| 497 | - } |
|
| 498 | - } |
|
| 499 | - |
|
| 500 | - /** |
|
| 501 | - * Make a file name (with path) |
|
| 502 | - * |
|
| 503 | - * @param string $id cache id |
|
| 504 | - * @param string $group name of the group |
|
| 505 | - * @access private |
|
| 506 | - */ |
|
| 507 | - function _setFileName($id, $group) |
|
| 508 | - { |
|
| 509 | - if ($this->_fileNameProtection) { |
|
| 510 | - $this->_file = ($this->_cacheDir.'cache_'.md5($group).'_' |
|
| 511 | - .md5($id)); |
|
| 512 | - } else { |
|
| 513 | - $this->_file = $this->_cacheDir.'cache_'.$group.'_'.$id; |
|
| 514 | - } |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - function getCacheFile() |
|
| 518 | - { |
|
| 519 | - return $this->_file; |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - /** |
|
| 523 | - * Read the cache file and return the content |
|
| 524 | - * |
|
| 525 | - * @return string content of the cache file |
|
| 526 | - * @access private |
|
| 527 | - */ |
|
| 528 | - function _read() |
|
| 529 | - { |
|
| 530 | - $fp = @fopen($this->_file, "rb"); |
|
| 531 | - if ($this->_fileLocking) @flock($fp, LOCK_SH); |
|
| 532 | - if ($fp) { |
|
| 533 | - // because the filesize can be cached by PHP itself... |
|
| 534 | - clearstatcache(); |
|
| 535 | - $length = @filesize($this->_file); |
|
| 536 | - if ($this->_readControl) { |
|
| 537 | - $hashControl = @fread($fp, 32); |
|
| 538 | - $length = $length - 32; |
|
| 539 | - } |
|
| 540 | - $data = @fread($fp, $length); |
|
| 541 | - if ($this->_fileLocking) @flock($fp, LOCK_UN); |
|
| 542 | - @fclose($fp); |
|
| 543 | - if ($this->_readControl) { |
|
| 544 | - $hashData = $this->_hash($data, $this->_readControlType); |
|
| 545 | - if ($hashData != $hashControl) { |
|
| 546 | - @touch($this->_file, time() - 2*abs($this->_lifeTime)); |
|
| 547 | - return false; |
|
| 548 | - } |
|
| 549 | - } |
|
| 550 | - return $data; |
|
| 551 | - } |
|
| 552 | - $this->raiseError('Cache_Lite : Unable to read cache !', -2); |
|
| 553 | - return false; |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - /** |
|
| 557 | - * Write the given data in the cache file |
|
| 558 | - * |
|
| 559 | - * @param string $data data to put in cache |
|
| 560 | - * @return boolean true if ok |
|
| 561 | - * @access private |
|
| 562 | - */ |
|
| 563 | - function _write($data) |
|
| 564 | - { |
|
| 565 | - $fp = @fopen($this->_file, "wb"); |
|
| 566 | - if ($fp) { |
|
| 567 | - if ($this->_fileLocking) @flock($fp, LOCK_EX); |
|
| 568 | - if ($this->_readControl) { |
|
| 569 | - @fwrite($fp, $this->_hash($data, $this->_readControlType), 32); |
|
| 570 | - } |
|
| 571 | - $len = strlen($data); |
|
| 572 | - @fwrite($fp, $data, $len); |
|
| 573 | - if ($this->_fileLocking) @flock($fp, LOCK_UN); |
|
| 574 | - @fclose($fp); |
|
| 575 | - return true; |
|
| 576 | - } |
|
| 577 | - $this->raiseError('Cache_Lite : Unable to write cache !', -1); |
|
| 578 | - return false; |
|
| 579 | - } |
|
| 580 | - |
|
| 581 | - /** |
|
| 582 | - * Write the given data in the cache file and control it just after to avoid |
|
| 583 | - * corrupted cache entries |
|
| 584 | - * |
|
| 585 | - * @param string $data data to put in cache |
|
| 586 | - * @return boolean true if the test is ok |
|
| 587 | - * @access private |
|
| 588 | - */ |
|
| 589 | - function _writeAndControl($data) |
|
| 590 | - { |
|
| 591 | - $this->_write($data); |
|
| 592 | - $dataRead = $this->_read($data); |
|
| 593 | - return ($dataRead==$data); |
|
| 594 | - } |
|
| 595 | - |
|
| 596 | - /** |
|
| 597 | - * Make a control key with the string containing datas |
|
| 598 | - * |
|
| 599 | - * @param string $data data |
|
| 600 | - * @param string $controlType type of control 'md5', 'crc32' or 'strlen' |
|
| 601 | - * @return string control key |
|
| 602 | - * @access private |
|
| 603 | - */ |
|
| 604 | - function _hash($data, $controlType) |
|
| 605 | - { |
|
| 606 | - switch ($controlType) { |
|
| 607 | - case 'md5': |
|
| 608 | - return md5($data); |
|
| 609 | - case 'crc32': |
|
| 610 | - return sprintf('% 32d', crc32($data)); |
|
| 611 | - case 'strlen': |
|
| 612 | - return sprintf('% 32d', strlen($data)); |
|
| 613 | - default: |
|
| 614 | - $this->raiseError('Unknown controlType ! '. |
|
| 615 | - '(available values are only \'md5\', \'crc32\', \'strlen\')', -5); |
|
| 616 | - } |
|
| 617 | - } |
|
| 254 | + /** |
|
| 255 | + * Test if a cache is available and (if yes) return it |
|
| 256 | + * |
|
| 257 | + * @param string $id cache id |
|
| 258 | + * @param string $group name of the cache group |
|
| 259 | + * @param boolean $doNotTestCacheValidity if set to true, the cache |
|
| 260 | + * validity won't be tested |
|
| 261 | + * @return string data of the cache (or false if no cache available) |
|
| 262 | + * @access public |
|
| 263 | + */ |
|
| 264 | + function get($id, $group = 'default', $doNotTestCacheValidity = false) |
|
| 265 | + { |
|
| 266 | + $this->_id = $id; |
|
| 267 | + $this->_group = $group; |
|
| 268 | + $data = false; |
|
| 269 | + if ($this->_caching) { |
|
| 270 | + $this->_setFileName($id, $group); |
|
| 271 | + if ($this->_memoryCaching) { |
|
| 272 | + if (isset($this->_memoryCachingArray[$this->_file])) { |
|
| 273 | + if ($this->_automaticSerialization) { |
|
| 274 | + return unserialize( |
|
| 275 | + $this->_memoryCachingArray[$this->_file]); |
|
| 276 | + } else { |
|
| 277 | + return $this->_memoryCachingArray[$this->_file]; |
|
| 278 | + } |
|
| 279 | + } else { |
|
| 280 | + if ($this->_onlyMemoryCaching) { |
|
| 281 | + return false; |
|
| 282 | + } |
|
| 283 | + } |
|
| 284 | + } |
|
| 285 | + if ($doNotTestCacheValidity) { |
|
| 286 | + if (file_exists($this->_file)) { |
|
| 287 | + $data = $this->_read(); |
|
| 288 | + } |
|
| 289 | + } else { |
|
| 290 | + if (@filemtime($this->_file) > $this->_refreshTime) { |
|
| 291 | + $data = $this->_read(); |
|
| 292 | + } |
|
| 293 | + } |
|
| 294 | + if (($data) and ($this->_memoryCaching)) { |
|
| 295 | + $this->_memoryCacheAdd($this->_file, $data); |
|
| 296 | + } |
|
| 297 | + if ($this->_automaticSerialization && is_string($data)) { |
|
| 298 | + $data = unserialize($data); |
|
| 299 | + } |
|
| 300 | + return $data; |
|
| 301 | + } |
|
| 302 | + return false; |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * Save some data in a cache file |
|
| 307 | + * |
|
| 308 | + * @param string $data data to put in cache (can be another type than strings |
|
| 309 | + * if automaticSerialization is on) |
|
| 310 | + * @param string $id cache id |
|
| 311 | + * @param string $group name of the cache group |
|
| 312 | + * @return boolean true if no problem |
|
| 313 | + * @access public |
|
| 314 | + */ |
|
| 315 | + function save($data, $id = null, $group = 'default') |
|
| 316 | + { |
|
| 317 | + if ($this->_caching) { |
|
| 318 | + if ($this->_automaticSerialization) { |
|
| 319 | + $data = serialize($data); |
|
| 320 | + } |
|
| 321 | + if (isset($id)) { |
|
| 322 | + $this->_setFileName($id, $group); |
|
| 323 | + } |
|
| 324 | + if ($this->_memoryCaching) { |
|
| 325 | + $this->_memoryCacheAdd($this->_file, $data); |
|
| 326 | + if ($this->_onlyMemoryCaching) { |
|
| 327 | + return true; |
|
| 328 | + } |
|
| 329 | + } |
|
| 330 | + if ($this->_writeControl) { |
|
| 331 | + if (!$this->_writeAndControl($data)) { |
|
| 332 | + @touch($this->_file, time() - 2*abs($this->_lifeTime)); |
|
| 333 | + return false; |
|
| 334 | + } else { |
|
| 335 | + return true; |
|
| 336 | + } |
|
| 337 | + } else { |
|
| 338 | + return $this->_write($data); |
|
| 339 | + } |
|
| 340 | + } |
|
| 341 | + return false; |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * Remove a cache file |
|
| 346 | + * |
|
| 347 | + * @param string $id cache id |
|
| 348 | + * @param string $group name of the cache group |
|
| 349 | + * @return boolean true if no problem |
|
| 350 | + * @access public |
|
| 351 | + */ |
|
| 352 | + function remove($id, $group = 'default') |
|
| 353 | + { |
|
| 354 | + $this->_setFileName($id, $group); |
|
| 355 | + if (!@unlink($this->_file)) { |
|
| 356 | + $this->raiseError('TCache_Lite : Unable to remove cache !', -3); |
|
| 357 | + return false; |
|
| 358 | + } |
|
| 359 | + return true; |
|
| 360 | + } |
|
| 361 | + |
|
| 362 | + /** |
|
| 363 | + * Clean the cache |
|
| 364 | + * |
|
| 365 | + * if no group is specified all cache files will be destroyed |
|
| 366 | + * else only cache files of the specified group will be destroyed |
|
| 367 | + * |
|
| 368 | + * @param string $group name of the cache group |
|
| 369 | + * @return boolean true if no problem |
|
| 370 | + * @access public |
|
| 371 | + */ |
|
| 372 | + function clean($group = false) |
|
| 373 | + { |
|
| 374 | + if ($this->_fileNameProtection) { |
|
| 375 | + $motif = ($group) ? 'cache_'.md5($group).'_' : 'cache_'; |
|
| 376 | + } else { |
|
| 377 | + $motif = ($group) ? 'cache_'.$group.'_' : 'cache_'; |
|
| 378 | + } |
|
| 379 | + if ($this->_memoryCaching) { |
|
| 380 | + while (list($key, $value) = each($this->_memoryCaching)) { |
|
| 381 | + if (strpos($key, $motif, 0)) { |
|
| 382 | + unset($this->_memoryCaching[$key]); |
|
| 383 | + $this->_memoryCachingCounter = |
|
| 384 | + $this->_memoryCachingCounter - 1; |
|
| 385 | + } |
|
| 386 | + } |
|
| 387 | + if ($this->_onlyMemoryCaching) { |
|
| 388 | + return true; |
|
| 389 | + } |
|
| 390 | + } |
|
| 391 | + if (!($dh = opendir($this->_cacheDir))) { |
|
| 392 | + $this->raiseError('TCache_Lite : Unable to open cache directory !'); |
|
| 393 | + return false; |
|
| 394 | + } |
|
| 395 | + while ($file = readdir($dh)) { |
|
| 396 | + if (($file != '.') && ($file != '..')) { |
|
| 397 | + $file = $this->_cacheDir . $file; |
|
| 398 | + if (is_file($file)) { |
|
| 399 | + if (strpos($file, $motif, 0)) { |
|
| 400 | + if (!@unlink($file)) { |
|
| 401 | + $this->raiseError('Cache_Lite : Unable to remove cache !', -3); |
|
| 402 | + return false; |
|
| 403 | + } |
|
| 404 | + } |
|
| 405 | + } |
|
| 406 | + } |
|
| 407 | + } |
|
| 408 | + return true; |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + /** |
|
| 412 | + * Set a new life time |
|
| 413 | + * |
|
| 414 | + * @param int $newLifeTime new life time (in seconds) |
|
| 415 | + * @access public |
|
| 416 | + */ |
|
| 417 | + function setLifeTime($newLifeTime) |
|
| 418 | + { |
|
| 419 | + $this->_lifeTime = $newLifeTime; |
|
| 420 | + $this->_refreshTime = time() - $newLifeTime; |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * |
|
| 425 | + * @access public |
|
| 426 | + */ |
|
| 427 | + function saveMemoryCachingState($id, $group = 'default') |
|
| 428 | + { |
|
| 429 | + if ($this->_caching) { |
|
| 430 | + $array = array( |
|
| 431 | + 'counter' => $this->_memoryCachingCounter, |
|
| 432 | + 'array' => $this->_memoryCachingState |
|
| 433 | + ); |
|
| 434 | + $data = serialize($array); |
|
| 435 | + $this->save($data, $id, $group); |
|
| 436 | + } |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + /** |
|
| 440 | + * |
|
| 441 | + * @access public |
|
| 442 | + */ |
|
| 443 | + function getMemoryCachingState($id, $group = 'default', |
|
| 444 | + $doNotTestCacheValidity = false) |
|
| 445 | + { |
|
| 446 | + if ($this->_caching) { |
|
| 447 | + if ($data = $this->get($id, $group, $doNotTestCacheValidity)) |
|
| 448 | + { |
|
| 449 | + $array = unserialize($data); |
|
| 450 | + $this->_memoryCachingCounter = $array['counter']; |
|
| 451 | + $this->_memoryCachingArray = $array['array']; |
|
| 452 | + } |
|
| 453 | + } |
|
| 454 | + } |
|
| 455 | + |
|
| 456 | + /** |
|
| 457 | + * Return the cache last modification time |
|
| 458 | + * |
|
| 459 | + * BE CAREFUL : THIS METHOD IS FOR HACKING ONLY ! |
|
| 460 | + * |
|
| 461 | + * @return int last modification time |
|
| 462 | + */ |
|
| 463 | + function lastModified() { |
|
| 464 | + return filemtime($this->cache->_file); |
|
| 465 | + } |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * Trigger a PEAR error |
|
| 469 | + * |
|
| 470 | + * To improve performances, the PEAR.php file is included dynamically. |
|
| 471 | + * The file is so included only when an error is triggered. So, in most |
|
| 472 | + * cases, the file isn't included and perfs are much better. |
|
| 473 | + * |
|
| 474 | + * @param string $msg error message |
|
| 475 | + * @param int $code error code |
|
| 476 | + * @access public |
|
| 477 | + */ |
|
| 478 | + function raiseError($msg, $code) |
|
| 479 | + { |
|
| 480 | + throw new Exception($msg); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + // --- Private methods --- |
|
| 484 | + |
|
| 485 | + /** |
|
| 486 | + * |
|
| 487 | + * @access private |
|
| 488 | + */ |
|
| 489 | + function _memoryCacheAdd($id, $data) |
|
| 490 | + { |
|
| 491 | + $this->_memoryCachingArray[$this->_file] = $data; |
|
| 492 | + if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) { |
|
| 493 | + list($key, $value) = each($this->_memoryCachingArray); |
|
| 494 | + unset($this->_memoryCachingArray[$key]); |
|
| 495 | + } else { |
|
| 496 | + $this->_memoryCachingCounter = $this->_memoryCachingCounter + 1; |
|
| 497 | + } |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + /** |
|
| 501 | + * Make a file name (with path) |
|
| 502 | + * |
|
| 503 | + * @param string $id cache id |
|
| 504 | + * @param string $group name of the group |
|
| 505 | + * @access private |
|
| 506 | + */ |
|
| 507 | + function _setFileName($id, $group) |
|
| 508 | + { |
|
| 509 | + if ($this->_fileNameProtection) { |
|
| 510 | + $this->_file = ($this->_cacheDir.'cache_'.md5($group).'_' |
|
| 511 | + .md5($id)); |
|
| 512 | + } else { |
|
| 513 | + $this->_file = $this->_cacheDir.'cache_'.$group.'_'.$id; |
|
| 514 | + } |
|
| 515 | + } |
|
| 516 | + |
|
| 517 | + function getCacheFile() |
|
| 518 | + { |
|
| 519 | + return $this->_file; |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + /** |
|
| 523 | + * Read the cache file and return the content |
|
| 524 | + * |
|
| 525 | + * @return string content of the cache file |
|
| 526 | + * @access private |
|
| 527 | + */ |
|
| 528 | + function _read() |
|
| 529 | + { |
|
| 530 | + $fp = @fopen($this->_file, "rb"); |
|
| 531 | + if ($this->_fileLocking) @flock($fp, LOCK_SH); |
|
| 532 | + if ($fp) { |
|
| 533 | + // because the filesize can be cached by PHP itself... |
|
| 534 | + clearstatcache(); |
|
| 535 | + $length = @filesize($this->_file); |
|
| 536 | + if ($this->_readControl) { |
|
| 537 | + $hashControl = @fread($fp, 32); |
|
| 538 | + $length = $length - 32; |
|
| 539 | + } |
|
| 540 | + $data = @fread($fp, $length); |
|
| 541 | + if ($this->_fileLocking) @flock($fp, LOCK_UN); |
|
| 542 | + @fclose($fp); |
|
| 543 | + if ($this->_readControl) { |
|
| 544 | + $hashData = $this->_hash($data, $this->_readControlType); |
|
| 545 | + if ($hashData != $hashControl) { |
|
| 546 | + @touch($this->_file, time() - 2*abs($this->_lifeTime)); |
|
| 547 | + return false; |
|
| 548 | + } |
|
| 549 | + } |
|
| 550 | + return $data; |
|
| 551 | + } |
|
| 552 | + $this->raiseError('Cache_Lite : Unable to read cache !', -2); |
|
| 553 | + return false; |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + /** |
|
| 557 | + * Write the given data in the cache file |
|
| 558 | + * |
|
| 559 | + * @param string $data data to put in cache |
|
| 560 | + * @return boolean true if ok |
|
| 561 | + * @access private |
|
| 562 | + */ |
|
| 563 | + function _write($data) |
|
| 564 | + { |
|
| 565 | + $fp = @fopen($this->_file, "wb"); |
|
| 566 | + if ($fp) { |
|
| 567 | + if ($this->_fileLocking) @flock($fp, LOCK_EX); |
|
| 568 | + if ($this->_readControl) { |
|
| 569 | + @fwrite($fp, $this->_hash($data, $this->_readControlType), 32); |
|
| 570 | + } |
|
| 571 | + $len = strlen($data); |
|
| 572 | + @fwrite($fp, $data, $len); |
|
| 573 | + if ($this->_fileLocking) @flock($fp, LOCK_UN); |
|
| 574 | + @fclose($fp); |
|
| 575 | + return true; |
|
| 576 | + } |
|
| 577 | + $this->raiseError('Cache_Lite : Unable to write cache !', -1); |
|
| 578 | + return false; |
|
| 579 | + } |
|
| 580 | + |
|
| 581 | + /** |
|
| 582 | + * Write the given data in the cache file and control it just after to avoid |
|
| 583 | + * corrupted cache entries |
|
| 584 | + * |
|
| 585 | + * @param string $data data to put in cache |
|
| 586 | + * @return boolean true if the test is ok |
|
| 587 | + * @access private |
|
| 588 | + */ |
|
| 589 | + function _writeAndControl($data) |
|
| 590 | + { |
|
| 591 | + $this->_write($data); |
|
| 592 | + $dataRead = $this->_read($data); |
|
| 593 | + return ($dataRead==$data); |
|
| 594 | + } |
|
| 595 | + |
|
| 596 | + /** |
|
| 597 | + * Make a control key with the string containing datas |
|
| 598 | + * |
|
| 599 | + * @param string $data data |
|
| 600 | + * @param string $controlType type of control 'md5', 'crc32' or 'strlen' |
|
| 601 | + * @return string control key |
|
| 602 | + * @access private |
|
| 603 | + */ |
|
| 604 | + function _hash($data, $controlType) |
|
| 605 | + { |
|
| 606 | + switch ($controlType) { |
|
| 607 | + case 'md5': |
|
| 608 | + return md5($data); |
|
| 609 | + case 'crc32': |
|
| 610 | + return sprintf('% 32d', crc32($data)); |
|
| 611 | + case 'strlen': |
|
| 612 | + return sprintf('% 32d', strlen($data)); |
|
| 613 | + default: |
|
| 614 | + $this->raiseError('Unknown controlType ! '. |
|
| 615 | + '(available values are only \'md5\', \'crc32\', \'strlen\')', -5); |
|
| 616 | + } |
|
| 617 | + } |
|
| 618 | 618 | |
| 619 | 619 | } |
| 620 | 620 | |
@@ -73,7 +73,7 @@ |
||
| 73 | 73 | */ |
| 74 | 74 | public function __construct($style=null) |
| 75 | 75 | { |
| 76 | - parent::__construct(); |
|
| 76 | + parent::__construct(); |
|
| 77 | 77 | if($style!==null) |
| 78 | 78 | $this->copyFrom($style); |
| 79 | 79 | } |
@@ -52,7 +52,7 @@ |
||
| 52 | 52 | * Parameters property of TActiveRecordCriteria. |
| 53 | 53 | * |
| 54 | 54 | * @author Wei Zhuo <weizho[at]gmail[dot]com> |
| 55 | - * @package Prado\Data\ActiveRecord\Scaffold |
|
| 55 | + * @package Prado\Data\ActiveRecord\Scaffold |
|
| 56 | 56 | * @since 3.1 |
| 57 | 57 | */ |
| 58 | 58 | class TScaffoldListView extends TScaffoldBase |
@@ -34,7 +34,7 @@ |
||
| 34 | 34 | * the Active Record class to be displayed/edited/added. |
| 35 | 35 | * |
| 36 | 36 | * @author Wei Zhuo <weizhuo[at]gmail[dot]com> |
| 37 | - * @package Prado\Data\ActiveRecord\Scaffold |
|
| 37 | + * @package Prado\Data\ActiveRecord\Scaffold |
|
| 38 | 38 | * @since 3.0 |
| 39 | 39 | */ |
| 40 | 40 | class TScaffoldView extends TScaffoldBase |
@@ -49,7 +49,7 @@ |
||
| 49 | 49 | * xxx is the property name). |
| 50 | 50 | * |
| 51 | 51 | * @author Wei Zhuo <weizho[at]gmail[dot]com> |
| 52 | - * @package Prado\Data\ActiveRecord\Scaffold |
|
| 52 | + * @package Prado\Data\ActiveRecord\Scaffold |
|
| 53 | 53 | * @since 3.1 |
| 54 | 54 | */ |
| 55 | 55 | class TScaffoldEditView extends TScaffoldBase |
@@ -1032,26 +1032,26 @@ |
||
| 1032 | 1032 | return isset(self::$_relations[get_class($this)][strtolower($property)]); |
| 1033 | 1033 | } |
| 1034 | 1034 | |
| 1035 | - /** |
|
| 1036 | - * Return record data as array |
|
| 1037 | - * @return array of column name and column values |
|
| 1038 | - * @since 3.2.4 |
|
| 1039 | - */ |
|
| 1040 | - public function toArray(){ |
|
| 1041 | - $result=array(); |
|
| 1042 | - foreach($this->getRecordTableInfo()->getLowerCaseColumnNames() as $columnName){ |
|
| 1043 | - $result[$columnName]=$this->getColumnValue($columnName); |
|
| 1044 | - } |
|
| 1035 | + /** |
|
| 1036 | + * Return record data as array |
|
| 1037 | + * @return array of column name and column values |
|
| 1038 | + * @since 3.2.4 |
|
| 1039 | + */ |
|
| 1040 | + public function toArray(){ |
|
| 1041 | + $result=array(); |
|
| 1042 | + foreach($this->getRecordTableInfo()->getLowerCaseColumnNames() as $columnName){ |
|
| 1043 | + $result[$columnName]=$this->getColumnValue($columnName); |
|
| 1044 | + } |
|
| 1045 | 1045 | |
| 1046 | - return $result; |
|
| 1047 | - } |
|
| 1046 | + return $result; |
|
| 1047 | + } |
|
| 1048 | 1048 | |
| 1049 | - /** |
|
| 1050 | - * Return record data as JSON |
|
| 1051 | - * @return JSON |
|
| 1052 | - * @since 3.2.4 |
|
| 1053 | - */ |
|
| 1054 | - public function toJSON(){ |
|
| 1055 | - return json_encode($this->toArray()); |
|
| 1056 | - } |
|
| 1049 | + /** |
|
| 1050 | + * Return record data as JSON |
|
| 1051 | + * @return JSON |
|
| 1052 | + * @since 3.2.4 |
|
| 1053 | + */ |
|
| 1054 | + public function toJSON(){ |
|
| 1055 | + return json_encode($this->toArray()); |
|
| 1056 | + } |
|
| 1057 | 1057 | } |
| 1058 | 1058 | \ No newline at end of file |
@@ -24,48 +24,48 @@ |
||
| 24 | 24 | */ |
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * To format numbers in locale sensitive manner use |
|
| 28 | - * <code> |
|
| 29 | - * <com:TNumberFormat Pattern="0.##" value="2.0" /> |
|
| 30 | - * </code> |
|
| 31 | - * |
|
| 32 | - * Numbers can be formatted as currency, percentage, decimal or scientific |
|
| 33 | - * numbers by specifying the Type attribute. The known types are |
|
| 34 | - * "currency", "percentage", "decimal" and "scientific". |
|
| 35 | - * |
|
| 36 | - * If someone from US want to see sales figures from a store in |
|
| 37 | - * Germany (say using the EURO currency), formatted using the german |
|
| 38 | - * currency, you would need to use the attribute Culture="de_DE" to get |
|
| 39 | - * the currency right, e.g. 100,00. The decimal and grouping separator is |
|
| 40 | - * then also from the de_DE locale. This may lead to some confusion because |
|
| 41 | - * people from US know the "," as thousand separator. Therefore a "Currency" |
|
| 42 | - * attribute is available, so that the output from the following example |
|
| 43 | - * results in 100.00. |
|
| 44 | - * <code> |
|
| 45 | - * <com:TNumberFormat Type="currency" Culture="en_US" Currency="EUR" Value="100" /> |
|
| 46 | - * </code> |
|
| 47 | - * |
|
| 48 | - * Namespace: System.I18N |
|
| 49 | - * |
|
| 50 | - * Properties |
|
| 51 | - * - <b>Value</b>, number, |
|
| 52 | - * <br>Gets or sets the number to format. The tag content is used as Value |
|
| 53 | - * if the Value property is not specified. |
|
| 54 | - * - <b>Type</b>, string, |
|
| 55 | - * <br>Gets or sets the formatting type. The valid types are |
|
| 56 | - * 'decimal', 'currency', 'percentage' and 'scientific'. |
|
| 57 | - * - <b>Currency</b>, string, |
|
| 58 | - * <br>Gets or sets the currency symbol for the currency format. |
|
| 59 | - * The default is 'USD' if the Currency property is not specified. |
|
| 60 | - * - <b>Pattern</b>, string, |
|
| 61 | - * <br>Gets or sets the custom number formatting pattern. |
|
| 62 | - * - <b>DefaultText</b>, string, |
|
| 63 | - * <br>Gets or sets the default text. If Value is not set, DefaultText will be |
|
| 64 | - * shown instead of the default currency Value/Pattern. |
|
| 65 | - * |
|
| 66 | - * @author Xiang Wei Zhuo <weizhuo[at]gmail[dot]com> |
|
| 67 | - * @package Prado\I18N |
|
| 68 | - */ |
|
| 27 | + * To format numbers in locale sensitive manner use |
|
| 28 | + * <code> |
|
| 29 | + * <com:TNumberFormat Pattern="0.##" value="2.0" /> |
|
| 30 | + * </code> |
|
| 31 | + * |
|
| 32 | + * Numbers can be formatted as currency, percentage, decimal or scientific |
|
| 33 | + * numbers by specifying the Type attribute. The known types are |
|
| 34 | + * "currency", "percentage", "decimal" and "scientific". |
|
| 35 | + * |
|
| 36 | + * If someone from US want to see sales figures from a store in |
|
| 37 | + * Germany (say using the EURO currency), formatted using the german |
|
| 38 | + * currency, you would need to use the attribute Culture="de_DE" to get |
|
| 39 | + * the currency right, e.g. 100,00. The decimal and grouping separator is |
|
| 40 | + * then also from the de_DE locale. This may lead to some confusion because |
|
| 41 | + * people from US know the "," as thousand separator. Therefore a "Currency" |
|
| 42 | + * attribute is available, so that the output from the following example |
|
| 43 | + * results in 100.00. |
|
| 44 | + * <code> |
|
| 45 | + * <com:TNumberFormat Type="currency" Culture="en_US" Currency="EUR" Value="100" /> |
|
| 46 | + * </code> |
|
| 47 | + * |
|
| 48 | + * Namespace: System.I18N |
|
| 49 | + * |
|
| 50 | + * Properties |
|
| 51 | + * - <b>Value</b>, number, |
|
| 52 | + * <br>Gets or sets the number to format. The tag content is used as Value |
|
| 53 | + * if the Value property is not specified. |
|
| 54 | + * - <b>Type</b>, string, |
|
| 55 | + * <br>Gets or sets the formatting type. The valid types are |
|
| 56 | + * 'decimal', 'currency', 'percentage' and 'scientific'. |
|
| 57 | + * - <b>Currency</b>, string, |
|
| 58 | + * <br>Gets or sets the currency symbol for the currency format. |
|
| 59 | + * The default is 'USD' if the Currency property is not specified. |
|
| 60 | + * - <b>Pattern</b>, string, |
|
| 61 | + * <br>Gets or sets the custom number formatting pattern. |
|
| 62 | + * - <b>DefaultText</b>, string, |
|
| 63 | + * <br>Gets or sets the default text. If Value is not set, DefaultText will be |
|
| 64 | + * shown instead of the default currency Value/Pattern. |
|
| 65 | + * |
|
| 66 | + * @author Xiang Wei Zhuo <weizhuo[at]gmail[dot]com> |
|
| 67 | + * @package Prado\I18N |
|
| 68 | + */ |
|
| 69 | 69 | class TNumberFormat extends TI18NControl implements \Prado\IDataRenderer |
| 70 | 70 | { |
| 71 | 71 | /** |
@@ -52,304 +52,304 @@ |
||
| 52 | 52 | */ |
| 53 | 53 | class TGettext_MO extends TGettext |
| 54 | 54 | { |
| 55 | - /** |
|
| 56 | - * file handle |
|
| 57 | - * |
|
| 58 | - * @access private |
|
| 59 | - * @var resource |
|
| 60 | - */ |
|
| 61 | - protected $_handle = null; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * big endianess |
|
| 65 | - * |
|
| 66 | - * Whether to write with big endian byte order. |
|
| 67 | - * |
|
| 68 | - * @access public |
|
| 69 | - * @var bool |
|
| 70 | - */ |
|
| 71 | - protected $writeBigEndian = false; |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * Constructor |
|
| 75 | - * |
|
| 76 | - * @access public |
|
| 77 | - * @return object File_Gettext_MO |
|
| 78 | - * @param string $file path to GNU MO file |
|
| 79 | - */ |
|
| 80 | - function __construct($file = '') |
|
| 81 | - { |
|
| 82 | - $this->file = $file; |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * _read |
|
| 87 | - * |
|
| 88 | - * @access private |
|
| 89 | - * @return mixed |
|
| 90 | - * @param int $bytes |
|
| 91 | - */ |
|
| 92 | - function _read($bytes = 1) |
|
| 93 | - { |
|
| 94 | - if (0 < $bytes = abs($bytes)) { |
|
| 95 | - return fread($this->_handle, $bytes); |
|
| 96 | - } |
|
| 97 | - return null; |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * _readInt |
|
| 102 | - * |
|
| 103 | - * @access private |
|
| 104 | - * @return int |
|
| 105 | - * @param bool $bigendian |
|
| 106 | - */ |
|
| 107 | - function _readInt($bigendian = false) |
|
| 108 | - { |
|
| 55 | + /** |
|
| 56 | + * file handle |
|
| 57 | + * |
|
| 58 | + * @access private |
|
| 59 | + * @var resource |
|
| 60 | + */ |
|
| 61 | + protected $_handle = null; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * big endianess |
|
| 65 | + * |
|
| 66 | + * Whether to write with big endian byte order. |
|
| 67 | + * |
|
| 68 | + * @access public |
|
| 69 | + * @var bool |
|
| 70 | + */ |
|
| 71 | + protected $writeBigEndian = false; |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * Constructor |
|
| 75 | + * |
|
| 76 | + * @access public |
|
| 77 | + * @return object File_Gettext_MO |
|
| 78 | + * @param string $file path to GNU MO file |
|
| 79 | + */ |
|
| 80 | + function __construct($file = '') |
|
| 81 | + { |
|
| 82 | + $this->file = $file; |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * _read |
|
| 87 | + * |
|
| 88 | + * @access private |
|
| 89 | + * @return mixed |
|
| 90 | + * @param int $bytes |
|
| 91 | + */ |
|
| 92 | + function _read($bytes = 1) |
|
| 93 | + { |
|
| 94 | + if (0 < $bytes = abs($bytes)) { |
|
| 95 | + return fread($this->_handle, $bytes); |
|
| 96 | + } |
|
| 97 | + return null; |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * _readInt |
|
| 102 | + * |
|
| 103 | + * @access private |
|
| 104 | + * @return int |
|
| 105 | + * @param bool $bigendian |
|
| 106 | + */ |
|
| 107 | + function _readInt($bigendian = false) |
|
| 108 | + { |
|
| 109 | 109 | //unpack returns a reference???? |
| 110 | 110 | $unpacked = unpack($bigendian ? 'N' : 'V', $this->_read(4)); |
| 111 | - return array_shift($unpacked); |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * _writeInt |
|
| 116 | - * |
|
| 117 | - * @access private |
|
| 118 | - * @return int |
|
| 119 | - * @param int $int |
|
| 120 | - */ |
|
| 121 | - function _writeInt($int) |
|
| 122 | - { |
|
| 123 | - return $this->_write(pack($this->writeBigEndian ? 'N' : 'V', (int) $int)); |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * _write |
|
| 128 | - * |
|
| 129 | - * @access private |
|
| 130 | - * @return int |
|
| 131 | - * @param string $data |
|
| 132 | - */ |
|
| 133 | - function _write($data) |
|
| 134 | - { |
|
| 135 | - return fwrite($this->_handle, $data); |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * _writeStr |
|
| 140 | - * |
|
| 141 | - * @access private |
|
| 142 | - * @return int |
|
| 143 | - * @param string $string |
|
| 144 | - */ |
|
| 145 | - function _writeStr($string) |
|
| 146 | - { |
|
| 147 | - return $this->_write($string . "\0"); |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * _readStr |
|
| 152 | - * |
|
| 153 | - * @access private |
|
| 154 | - * @return string |
|
| 155 | - * @param array $params associative array with offset and length |
|
| 156 | - * of the string |
|
| 157 | - */ |
|
| 158 | - function _readStr($params) |
|
| 159 | - { |
|
| 160 | - fseek($this->_handle, $params['offset']); |
|
| 161 | - return $this->_read($params['length']); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Load MO file |
|
| 166 | - * |
|
| 167 | - * @access public |
|
| 168 | - * @return mixed Returns true on success or PEAR_Error on failure. |
|
| 169 | - * @param string $file |
|
| 170 | - */ |
|
| 171 | - function load($file = null) |
|
| 172 | - { |
|
| 173 | - if (!isset($file)) { |
|
| 174 | - $file = $this->file; |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - // open MO file |
|
| 178 | - if (!is_resource($this->_handle = @fopen($file, 'rb'))) { |
|
| 179 | - return false; |
|
| 180 | - } |
|
| 181 | - // lock MO file shared |
|
| 182 | - if (!@flock($this->_handle, LOCK_SH)) { |
|
| 183 | - @fclose($this->_handle); |
|
| 184 | - return false; |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - // read (part of) magic number from MO file header and define endianess |
|
| 111 | + return array_shift($unpacked); |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * _writeInt |
|
| 116 | + * |
|
| 117 | + * @access private |
|
| 118 | + * @return int |
|
| 119 | + * @param int $int |
|
| 120 | + */ |
|
| 121 | + function _writeInt($int) |
|
| 122 | + { |
|
| 123 | + return $this->_write(pack($this->writeBigEndian ? 'N' : 'V', (int) $int)); |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * _write |
|
| 128 | + * |
|
| 129 | + * @access private |
|
| 130 | + * @return int |
|
| 131 | + * @param string $data |
|
| 132 | + */ |
|
| 133 | + function _write($data) |
|
| 134 | + { |
|
| 135 | + return fwrite($this->_handle, $data); |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * _writeStr |
|
| 140 | + * |
|
| 141 | + * @access private |
|
| 142 | + * @return int |
|
| 143 | + * @param string $string |
|
| 144 | + */ |
|
| 145 | + function _writeStr($string) |
|
| 146 | + { |
|
| 147 | + return $this->_write($string . "\0"); |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * _readStr |
|
| 152 | + * |
|
| 153 | + * @access private |
|
| 154 | + * @return string |
|
| 155 | + * @param array $params associative array with offset and length |
|
| 156 | + * of the string |
|
| 157 | + */ |
|
| 158 | + function _readStr($params) |
|
| 159 | + { |
|
| 160 | + fseek($this->_handle, $params['offset']); |
|
| 161 | + return $this->_read($params['length']); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Load MO file |
|
| 166 | + * |
|
| 167 | + * @access public |
|
| 168 | + * @return mixed Returns true on success or PEAR_Error on failure. |
|
| 169 | + * @param string $file |
|
| 170 | + */ |
|
| 171 | + function load($file = null) |
|
| 172 | + { |
|
| 173 | + if (!isset($file)) { |
|
| 174 | + $file = $this->file; |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + // open MO file |
|
| 178 | + if (!is_resource($this->_handle = @fopen($file, 'rb'))) { |
|
| 179 | + return false; |
|
| 180 | + } |
|
| 181 | + // lock MO file shared |
|
| 182 | + if (!@flock($this->_handle, LOCK_SH)) { |
|
| 183 | + @fclose($this->_handle); |
|
| 184 | + return false; |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + // read (part of) magic number from MO file header and define endianess |
|
| 188 | 188 | |
| 189 | 189 | //unpack returns a reference???? |
| 190 | 190 | $unpacked = unpack('c', $this->_read(4)); |
| 191 | - switch ($magic = array_shift($unpacked)) |
|
| 192 | - { |
|
| 193 | - case -34: |
|
| 194 | - $be = false; |
|
| 195 | - break; |
|
| 196 | - |
|
| 197 | - case -107: |
|
| 198 | - $be = true; |
|
| 199 | - break; |
|
| 200 | - |
|
| 201 | - default: |
|
| 202 | - return false; |
|
| 203 | - } |
|
| 204 | - |
|
| 205 | - // check file format revision - we currently only support 0 |
|
| 206 | - if (0 !== ($_rev = $this->_readInt($be))) { |
|
| 207 | - return false; |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - // count of strings in this file |
|
| 211 | - $count = $this->_readInt($be); |
|
| 212 | - |
|
| 213 | - // offset of hashing table of the msgids |
|
| 214 | - $offset_original = $this->_readInt($be); |
|
| 215 | - // offset of hashing table of the msgstrs |
|
| 216 | - $offset_translat = $this->_readInt($be); |
|
| 217 | - |
|
| 218 | - // move to msgid hash table |
|
| 219 | - fseek($this->_handle, $offset_original); |
|
| 220 | - // read lengths and offsets of msgids |
|
| 221 | - $original = array(); |
|
| 222 | - for ($i = 0; $i < $count; $i++) { |
|
| 223 | - $original[$i] = array( |
|
| 224 | - 'length' => $this->_readInt($be), |
|
| 225 | - 'offset' => $this->_readInt($be) |
|
| 226 | - ); |
|
| 227 | - } |
|
| 228 | - |
|
| 229 | - // move to msgstr hash table |
|
| 230 | - fseek($this->_handle, $offset_translat); |
|
| 231 | - // read lengths and offsets of msgstrs |
|
| 232 | - $translat = array(); |
|
| 233 | - for ($i = 0; $i < $count; $i++) { |
|
| 234 | - $translat[$i] = array( |
|
| 235 | - 'length' => $this->_readInt($be), |
|
| 236 | - 'offset' => $this->_readInt($be) |
|
| 237 | - ); |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - // read all |
|
| 241 | - for ($i = 0; $i < $count; $i++) { |
|
| 242 | - $this->strings[$this->_readStr($original[$i])] = |
|
| 243 | - $this->_readStr($translat[$i]); |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - // done |
|
| 247 | - @flock($this->_handle, LOCK_UN); |
|
| 248 | - @fclose($this->_handle); |
|
| 249 | - $this->_handle = null; |
|
| 250 | - |
|
| 251 | - // check for meta info |
|
| 252 | - if (isset($this->strings[''])) { |
|
| 253 | - $this->meta = parent::meta2array($this->strings['']); |
|
| 254 | - unset($this->strings['']); |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - return true; |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - /** |
|
| 261 | - * Save MO file |
|
| 262 | - * |
|
| 263 | - * @access public |
|
| 264 | - * @return mixed Returns true on success or PEAR_Error on failure. |
|
| 265 | - * @param string $file |
|
| 266 | - */ |
|
| 267 | - function save($file = null) |
|
| 268 | - { |
|
| 269 | - if (!isset($file)) { |
|
| 270 | - $file = $this->file; |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - // open MO file |
|
| 274 | - if (!is_resource($this->_handle = @fopen($file, 'wb'))) { |
|
| 275 | - return false; |
|
| 276 | - } |
|
| 277 | - // lock MO file exclusively |
|
| 278 | - if (!@flock($this->_handle, LOCK_EX)) { |
|
| 279 | - @fclose($this->_handle); |
|
| 280 | - return false; |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - // write magic number |
|
| 284 | - if ($this->writeBigEndian) { |
|
| 285 | - $this->_write(pack('c*', 0x95, 0x04, 0x12, 0xde)); |
|
| 286 | - } else { |
|
| 287 | - $this->_write(pack('c*', 0xde, 0x12, 0x04, 0x95)); |
|
| 288 | - } |
|
| 289 | - |
|
| 290 | - // write file format revision |
|
| 291 | - $this->_writeInt(0); |
|
| 292 | - |
|
| 293 | - $count = count($this->strings) + ($meta = (count($this->meta) ? 1 : 0)); |
|
| 294 | - // write count of strings |
|
| 295 | - $this->_writeInt($count); |
|
| 296 | - |
|
| 297 | - $offset = 28; |
|
| 298 | - // write offset of orig. strings hash table |
|
| 299 | - $this->_writeInt($offset); |
|
| 300 | - |
|
| 301 | - $offset += ($count * 8); |
|
| 302 | - // write offset transl. strings hash table |
|
| 303 | - $this->_writeInt($offset); |
|
| 304 | - |
|
| 305 | - // write size of hash table (we currently ommit the hash table) |
|
| 306 | - $this->_writeInt(0); |
|
| 307 | - |
|
| 308 | - $offset += ($count * 8); |
|
| 309 | - // write offset of hash table |
|
| 310 | - $this->_writeInt($offset); |
|
| 311 | - |
|
| 312 | - // unshift meta info |
|
| 313 | - if ($this->meta) { |
|
| 314 | - $meta = ''; |
|
| 315 | - foreach ($this->meta as $key => $val) { |
|
| 316 | - $meta .= $key . ': ' . $val . "\n"; |
|
| 317 | - } |
|
| 318 | - $strings = array('' => $meta) + $this->strings; |
|
| 319 | - } else { |
|
| 320 | - $strings = $this->strings; |
|
| 321 | - } |
|
| 322 | - |
|
| 323 | - // write offsets for original strings |
|
| 324 | - foreach (array_keys($strings) as $o) { |
|
| 325 | - $len = strlen($o); |
|
| 326 | - $this->_writeInt($len); |
|
| 327 | - $this->_writeInt($offset); |
|
| 328 | - $offset += $len + 1; |
|
| 329 | - } |
|
| 330 | - |
|
| 331 | - // write offsets for translated strings |
|
| 332 | - foreach ($strings as $t) { |
|
| 333 | - $len = strlen($t); |
|
| 334 | - $this->_writeInt($len); |
|
| 335 | - $this->_writeInt($offset); |
|
| 336 | - $offset += $len + 1; |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - // write original strings |
|
| 340 | - foreach (array_keys($strings) as $o) { |
|
| 341 | - $this->_writeStr($o); |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - // write translated strings |
|
| 345 | - foreach ($strings as $t) { |
|
| 346 | - $this->_writeStr($t); |
|
| 347 | - } |
|
| 348 | - |
|
| 349 | - // done |
|
| 350 | - @flock($this->_handle, LOCK_UN); |
|
| 351 | - @fclose($this->_handle); |
|
| 352 | - chmod($file,PRADO_CHMOD); |
|
| 353 | - return true; |
|
| 354 | - } |
|
| 191 | + switch ($magic = array_shift($unpacked)) |
|
| 192 | + { |
|
| 193 | + case -34: |
|
| 194 | + $be = false; |
|
| 195 | + break; |
|
| 196 | + |
|
| 197 | + case -107: |
|
| 198 | + $be = true; |
|
| 199 | + break; |
|
| 200 | + |
|
| 201 | + default: |
|
| 202 | + return false; |
|
| 203 | + } |
|
| 204 | + |
|
| 205 | + // check file format revision - we currently only support 0 |
|
| 206 | + if (0 !== ($_rev = $this->_readInt($be))) { |
|
| 207 | + return false; |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + // count of strings in this file |
|
| 211 | + $count = $this->_readInt($be); |
|
| 212 | + |
|
| 213 | + // offset of hashing table of the msgids |
|
| 214 | + $offset_original = $this->_readInt($be); |
|
| 215 | + // offset of hashing table of the msgstrs |
|
| 216 | + $offset_translat = $this->_readInt($be); |
|
| 217 | + |
|
| 218 | + // move to msgid hash table |
|
| 219 | + fseek($this->_handle, $offset_original); |
|
| 220 | + // read lengths and offsets of msgids |
|
| 221 | + $original = array(); |
|
| 222 | + for ($i = 0; $i < $count; $i++) { |
|
| 223 | + $original[$i] = array( |
|
| 224 | + 'length' => $this->_readInt($be), |
|
| 225 | + 'offset' => $this->_readInt($be) |
|
| 226 | + ); |
|
| 227 | + } |
|
| 228 | + |
|
| 229 | + // move to msgstr hash table |
|
| 230 | + fseek($this->_handle, $offset_translat); |
|
| 231 | + // read lengths and offsets of msgstrs |
|
| 232 | + $translat = array(); |
|
| 233 | + for ($i = 0; $i < $count; $i++) { |
|
| 234 | + $translat[$i] = array( |
|
| 235 | + 'length' => $this->_readInt($be), |
|
| 236 | + 'offset' => $this->_readInt($be) |
|
| 237 | + ); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + // read all |
|
| 241 | + for ($i = 0; $i < $count; $i++) { |
|
| 242 | + $this->strings[$this->_readStr($original[$i])] = |
|
| 243 | + $this->_readStr($translat[$i]); |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + // done |
|
| 247 | + @flock($this->_handle, LOCK_UN); |
|
| 248 | + @fclose($this->_handle); |
|
| 249 | + $this->_handle = null; |
|
| 250 | + |
|
| 251 | + // check for meta info |
|
| 252 | + if (isset($this->strings[''])) { |
|
| 253 | + $this->meta = parent::meta2array($this->strings['']); |
|
| 254 | + unset($this->strings['']); |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + return true; |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + /** |
|
| 261 | + * Save MO file |
|
| 262 | + * |
|
| 263 | + * @access public |
|
| 264 | + * @return mixed Returns true on success or PEAR_Error on failure. |
|
| 265 | + * @param string $file |
|
| 266 | + */ |
|
| 267 | + function save($file = null) |
|
| 268 | + { |
|
| 269 | + if (!isset($file)) { |
|
| 270 | + $file = $this->file; |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + // open MO file |
|
| 274 | + if (!is_resource($this->_handle = @fopen($file, 'wb'))) { |
|
| 275 | + return false; |
|
| 276 | + } |
|
| 277 | + // lock MO file exclusively |
|
| 278 | + if (!@flock($this->_handle, LOCK_EX)) { |
|
| 279 | + @fclose($this->_handle); |
|
| 280 | + return false; |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + // write magic number |
|
| 284 | + if ($this->writeBigEndian) { |
|
| 285 | + $this->_write(pack('c*', 0x95, 0x04, 0x12, 0xde)); |
|
| 286 | + } else { |
|
| 287 | + $this->_write(pack('c*', 0xde, 0x12, 0x04, 0x95)); |
|
| 288 | + } |
|
| 289 | + |
|
| 290 | + // write file format revision |
|
| 291 | + $this->_writeInt(0); |
|
| 292 | + |
|
| 293 | + $count = count($this->strings) + ($meta = (count($this->meta) ? 1 : 0)); |
|
| 294 | + // write count of strings |
|
| 295 | + $this->_writeInt($count); |
|
| 296 | + |
|
| 297 | + $offset = 28; |
|
| 298 | + // write offset of orig. strings hash table |
|
| 299 | + $this->_writeInt($offset); |
|
| 300 | + |
|
| 301 | + $offset += ($count * 8); |
|
| 302 | + // write offset transl. strings hash table |
|
| 303 | + $this->_writeInt($offset); |
|
| 304 | + |
|
| 305 | + // write size of hash table (we currently ommit the hash table) |
|
| 306 | + $this->_writeInt(0); |
|
| 307 | + |
|
| 308 | + $offset += ($count * 8); |
|
| 309 | + // write offset of hash table |
|
| 310 | + $this->_writeInt($offset); |
|
| 311 | + |
|
| 312 | + // unshift meta info |
|
| 313 | + if ($this->meta) { |
|
| 314 | + $meta = ''; |
|
| 315 | + foreach ($this->meta as $key => $val) { |
|
| 316 | + $meta .= $key . ': ' . $val . "\n"; |
|
| 317 | + } |
|
| 318 | + $strings = array('' => $meta) + $this->strings; |
|
| 319 | + } else { |
|
| 320 | + $strings = $this->strings; |
|
| 321 | + } |
|
| 322 | + |
|
| 323 | + // write offsets for original strings |
|
| 324 | + foreach (array_keys($strings) as $o) { |
|
| 325 | + $len = strlen($o); |
|
| 326 | + $this->_writeInt($len); |
|
| 327 | + $this->_writeInt($offset); |
|
| 328 | + $offset += $len + 1; |
|
| 329 | + } |
|
| 330 | + |
|
| 331 | + // write offsets for translated strings |
|
| 332 | + foreach ($strings as $t) { |
|
| 333 | + $len = strlen($t); |
|
| 334 | + $this->_writeInt($len); |
|
| 335 | + $this->_writeInt($offset); |
|
| 336 | + $offset += $len + 1; |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + // write original strings |
|
| 340 | + foreach (array_keys($strings) as $o) { |
|
| 341 | + $this->_writeStr($o); |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + // write translated strings |
|
| 345 | + foreach ($strings as $t) { |
|
| 346 | + $this->_writeStr($t); |
|
| 347 | + } |
|
| 348 | + |
|
| 349 | + // done |
|
| 350 | + @flock($this->_handle, LOCK_UN); |
|
| 351 | + @fclose($this->_handle); |
|
| 352 | + chmod($file,PRADO_CHMOD); |
|
| 353 | + return true; |
|
| 354 | + } |
|
| 355 | 355 | } |