* $Author:: $ *
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team *
- * For more information visit: http://www.mxchange.org *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team *
+ * For more information visit: http://mxchange.org *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
var $fqfn = '';
// Resource to cache file
- var $pointer = false;
+ var $pointer = FALSE;
// Data array from cache
var $data = array();
var $rebuilt = array();
// File extension
- var $extension = '.cache';
+ var $extension = '';
var $status = array();
var $readable = array();
var $fullPath = '';
// Constructor
function CacheSystem () {
+ // Set extension
+ $this->extension = getCacheExtension();
+
// Construct full path
$this->fullPath = getPath() . getCachePath();
// Create file
if ($this->isCacheReadable()) changeMode($this->fqfn, 0666);
- $this->pointer = fopen($this->fqfn, 'w') or debug_report_bug(__METHOD__, __LINE__, 'Cannot write to cache ' . $this->fqfn . ' !');
+ $this->pointer = fopen($this->fqfn, 'w') or reportBug(__METHOD__, __LINE__, 'Cannot write to cache ' . $this->fqfn . ' !');
// Add open PHP tag
$this->writeLine('<?php');
} else {
// Cannot create file
- addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_PROBLEMS_DETECTED');
+ reportBug(__METHOD__, __LINE__, 'Problems with cache directory detected, getStatusCode()=' . $this->getStatusCode());
}
}
// Is the pointer a valid resource?
if (is_resource($this->pointer)) {
// Write the line
- fwrite($this->pointer, $line . "\n");
+ fwrite($this->pointer, $line . PHP_EOL);
} else {
// Something bad happened
- debug_report_bug(__METHOD__, __LINE__, 'Pointer type is ' . gettype($this->pointer) . ', expected is resource.');
+ reportBug(__METHOD__, __LINE__, 'Pointer type is ' . gettype($this->pointer) . ', expected is resource.');
}
}
unset($this->status[$this->name]);
}
+ // Adds a data row (array) to cache file and global cache array
function addRow ($data) {
// Is the pointe rvalid?
if (is_resource($this->pointer)) {
$GLOBALS['cache_array']['config'][$data['config']][$k] = $v;
} elseif ($this->name == 'filter') {
// Filter
- $GLOBALS['cache_array']['filter']['chains'][$data['filter_name']][$data['filter_function']] = $data['filter_active'];
+ $GLOBALS['cache_array']['filter']['chains'][$data['filter_name']][$data['filter_function']] = $data['filter_active'];
$GLOBALS['cache_array']['filter']['counter'][$data['filter_name']][$data['filter_function']] = $data['filter_counter'];
- $GLOBALS['cache_array']['filter']['loaded'][$data['filter_name']][$data['filter_function']] = true;
+ $GLOBALS['cache_array']['filter']['loaded'][$data['filter_name']][$data['filter_function']] = TRUE;
} elseif ($this->name == 'modules') {
// Modules
$GLOBALS['cache_array']['modules'][$k][$data['module']] = $v;
}
} elseif ($this->name == 'admin_acls') {
// Access control lines
- $GLOBALS['cache_array']['admin_acls'][$k][$data['admin_id']][] = $v;
+ array_push($GLOBALS['cache_array']['admin_acls'][$k][$data['admin_id']], $v);
} elseif ($this->name == 'refdepths') {
- // Referal levels
+ // Referral levels
$GLOBALS['cache_array']['refdepths'][$k][$data['id']] = $v;
} elseif ($this->name == 'refsystem') {
- // Referal system
+ // Referral system
$GLOBALS['cache_array']['refsystem'][$k][$data['id']] = $v;
} elseif ($this->name == 'revision') {
// Revision data
} elseif ($this->name == 'imprint') {
// Imprint
$GLOBALS['cache_array']['imprint'][$k][$data['imprint_id']] = $v;
+ } elseif ($this->name == 'points_data') {
+ // Table 'points_data'
+ $GLOBALS['cache_array']['points_data'][$k][$data['id']] = $v;
+ } elseif ($this->name == 'earning') {
+ // Table 'earning'
+ $GLOBALS['cache_array']['earning'][$k][$data['earning_id']] = $v;
+ } elseif ($this->name == 'payments') {
+ // Table 'payments'
+ $GLOBALS['cache_array']['payments'][$k][$data['id']] = $v;
} elseif (is_array($v)) {
// Serialize and BASE64-encode the array
$v = base64_encode(serialize($v));
$this->finalize();
// Remove cache
- $this->removeCacheFile(true);
+ $this->removeCacheFile(TRUE);
// Unsupported/unhandled cache detected
- debug_report_bug(__METHOD__, __LINE__, 'Unsupported cache ' . $this->name . ' detected.');
+ reportBug(__METHOD__, __LINE__, 'Unsupported cache ' . $this->name . ' detected, data=' . print_r($data, TRUE) . ',k=' . $k . ',v=' . $v);
}
// Write cache line to file
} // END - foreach
} else {
// Cannot create file
- addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_PROBLEMS_DETECTED');
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected, no resource! pointer[]=' . gettype($this->pointer));
}
}
+ // Closes cache file with closing PHP tag
function finalize () {
// Quit function when no pointer is set
if (is_resource($this->pointer)) {
// Remove pointer and status
unset($this->status[$this->name]);
- $this->pointer = false;
- //* DEBUG: */ debugOutput(__METHOD__ . '(<font color="#0000aa">' . __LINE__.'</font>): '.$this->name.' - FINALIZED!');
+ $this->pointer = FALSE;
+ //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, 'name=' . $this->name . ' - FINALIZED!');
} // END - if
}
+ // Loads cache file and returns an array of the cached data
function getArrayFromCache () {
// Is the cache already loaded?
if (isset($this->data[$this->name])) {
} // END - if
} else {
// Cache file not found or not readable
- debug_report_bug(__METHOD__, __LINE__, '{%message,CACHE_CANNOT_LOAD=' . $this->name . '%}');
+ reportBug(__METHOD__, __LINE__, '{%message,CACHE_CANNOT_LOAD=' . $this->name . '%}');
// Try to remove it
$this->removeCacheFile();
}
// Destroy an existing cache file
- function removeCacheFile ($force = false) {
+ function removeCacheFile ($force = FALSE) {
// Reset read status
$this->resetCacheReadStatus();
// Debug message
- //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, sprintf("%s should be removed.", $this->name));
+ //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, sprintf('%s should be removed.', $this->name));
// Is the cache file not yet rebuilt?
if ((!isset($this->rebuilt[$this->name])) && ($this->isCacheReadable())) {
// Only run in regular output mode
- if ((!isHtmlOutputMode()) && ($force === false)) {
+ if ((!isHtmlOutputMode()) && ($force === FALSE)) {
// Debug message if allowed
if (isDebugModeEnabled()) {
// Debug message
} // END - if
// Remove cache file from system
- //* DEBUG: */ debug_report_bug(__METHOD__, __LINE__, 'About to remove ' . basename($this->fqfn) . '!');
+ //* DEBUG: */ reportBug(__METHOD__, __LINE__, 'About to remove ' . basename($this->fqfn) . '!');
removeFile($this->fqfn);
// Reset read status
// The cache does no longer exist so kill the content
unset($this->data[$this->name]);
unset($this->version[$this->name]);
- $this->rebuilt[$this->name] = true;
+ $this->rebuilt[$this->name] = TRUE;
} else {
// Not removed!
- debug_report_bug(__METHOD__, __LINE__, '{%message,CACHE_CANNOT_UNLINK=' . $this->name . '%}');
+ reportBug(__METHOD__, __LINE__, '{%message,CACHE_CANNOT_UNLINK=' . $this->name . '%}');
}
} // END - if
}
} // END - if
} else {
// Cannot write to cache!
- addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_PROBLEMS_DETECTED');
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: Unexpected status ' . $this->status[$this->name]);
}
}
} // END - foreach
} else {
// Cannot write array!
- addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_PROBLEMS_DETECTED');
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: pointer is not resource! pointer[]=' . gettype($this->pointer));
}
}
if ((is_array($dummy)) && (isset($dummy[$search])) && (is_array($dummy[$search]))) {
// Search for key in array
$key_found = array_key_exists($search_key, $dummy[$search]);
- if ($key_found == true) {
+ if ($key_found == TRUE) {
$key = $search_key;
// Key (hopefully) found?
foreach ($dummy as $a => $v) {
} // END - if
} else {
// Cannot write to cache!
- addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_PROBLEMS_DETECTED');
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: Unexpected status ' . $this->status[$this->name]);
}
}
$this->version[$this->name][$ext_name] = $ext_ver;
// Write cache line to file
- $this->writeLine($this->rewriteEntry($ext_name, $ext_ver, 'version', true));
+ $this->writeLine($this->rewriteEntry($ext_name, $ext_ver, 'version', TRUE));
} // END - if
- //* DEBUG: */ debugOutput(__METHOD__ . '(<font color="#0000aa">' . __LINE__ . '</font>): '.$this->name.' - '.$ext_name.'='.$ext_ver);
+ //* DEBUG: */ logDebugMessage(__METHOD__, __LINE__, 'name=' . $this->name . ',ext_name=' . $ext_name . ',ext_ver=' . $ext_ver);
} else {
// Cannot create file
- addFatalMessage(__METHOD__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_PROBLEMS_DETECTED');
+ reportBug(__METHOD__, __LINE__, 'Problem with cache detected: pointer is not resource! pointer[]=' . gettype($this->pointer));
}
}
- // Checks wether versions from cache and extension matches
+ // Checks whether versions from cache and extension matches
function extensionVersionMatches ($ext_name) {
// Check cache
if (!isset($GLOBALS[__METHOD__][$ext_name])) {
// Does never match by default
- $GLOBALS[__METHOD__][$ext_name] = false;
+ $GLOBALS[__METHOD__][$ext_name] = FALSE;
// Compare only if installed
if (isExtensionInstalled($ext_name)) {
// Debug messages
if (isset($this->version[$this->name][$ext_name])) {
// Does it match?
- $GLOBALS[__METHOD__][$ext_name] = ((isset($this->version[$this->name][$ext_name])) && ($this->version[$this->name][$ext_name] == $ext_ver));
+ $GLOBALS[__METHOD__][$ext_name] = ($this->version[$this->name][$ext_name] == $ext_ver);
} elseif ($this->isCacheReadable()) {
// No cache version found
- logDebugMessage(__METHOD__, __LINE__, 'Cache ' . $this->name . ' has missing version entry for extension ' . $ext_name . '! Purging cache...');
+ logDebugMessage(__METHOD__, __LINE__, 'Cache ' . $this->name . ' has missing version entry for extension ext-' . $ext_name . '! Purging cache...');
// Remove the cache file
- $this->removeCacheFile(true);
+ $this->removeCacheFile(TRUE);
}
} else {
// Not installed, does always match
- $GLOBALS[__METHOD__][$ext_name] = true;
+ $GLOBALS[__METHOD__][$ext_name] = TRUE;
}
} else {
// Cache entry found, log debug message
// Rewrit the entry so it can be stored in cache file
// @TODO Add support for more types which break in last else-block
- function rewriteEntry ($key, $value, $prefix = 'data', $single = false) {
+ function rewriteEntry ($key, $value, $prefix = 'data', $single = FALSE) {
// Default is not single entry
$extender = '[]';
// Add only for single array entry?
- if ($single === true) {
+ if ($single === TRUE) {
$extender = '';
} // END - if
$line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . " = '" . escapeQuotes($value) . "';";
} elseif (is_null($value)) {
// Null
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = null;';
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = NULL;';
} elseif (is_bool($value)) {
// Boolean value
- if ($value === true) {
+ if ($value === TRUE) {
// True
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = true;';
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = TRUE;';
} else {
// False
- $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = false;';
+ $line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = FALSE;';
}
} elseif (isset($value[0])) {
// These lines needs fixing
- debug_report_bug(__METHOD__, __LINE__, 'Invalid entry with [0] found. key=' . $key);
+ reportBug(__METHOD__, __LINE__, 'Invalid entry with [0] found. key=' . $key);
} else {
// Non-string
$line = '$this->' . $prefix . "['" . $this->name . "']['" . $key . "']" . $extender . ' = ' . $value . ';';
$this->statusCode = $status;
}
- // Checks wether the current cache file is readable
+ // Checks whether the current cache file is readable
function isCacheReadable () {
// Array entry found?
if (!isset($this->readable[$this->name])) {
// Cloning not allowed
function __clone () {
// Please do not clone this class
- debug_report_bug(__METHOD__, __LINE__, 'Cloning of this class is not allowed.');
+ reportBug(__METHOD__, __LINE__, 'Cloning of this class is not allowed.');
}
} // END - class
projects / mailer.git / blobdiff