summaryrefslogtreecommitdiff
path: root/framework/I18N/core/MessageCache.php
blob: 3bd21704bbc22ee7d6ea1adc3428d0007e93b650 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<?php
/**
 * Translation table cache.
 * @author $Author: weizhuo $
 * @version $Id: MessageCache.php 3188 2012-07-12 12:13:23Z ctrlaltca $
 * @package System.I18N.core
 */

/**
 * Load the cache lite library.
 */
require_once(dirname(__FILE__).'/TCache_Lite.php');

/**
 * Cache the translation table into the file system.
 * It can cache each cataloug+variant or just the whole section.
 * @package System.I18N.core
 * @author $Author: weizhuo $
 * @version $Id: MessageCache.php 3188 2012-07-12 12:13:23Z ctrlaltca $
 */
class MessageCache 
{

	/**
	 * Cache Lite instance.
	 * @var TCache_Lite
	 */
	protected $cache;

	/**
	 * Caceh life time, default is 1 year.
	 */
	protected $lifetime = 3153600;
	

	/**
	 * Create a new Translation cache.
	 * @param string $cacheDir Directory to store the cache files.
	 */
	public function __construct($cacheDir)
	{		
		$cacheDir = $cacheDir.'/';
		
		if(!is_dir($cacheDir))
			throw new Exception(
				'The cache directory '.$cacheDir.' does not exists.'.
				'The cache directory must be writable by the server.');
		if(!is_writable($cacheDir))
			throw new Exception(
				'The cache directory '.$cacheDir.' must be writable '.
				'by the server.');
		
		$options = array(
			'cacheDir' => $cacheDir,
			'lifeTime' => $this->getLifeTime(),
			'automaticSerialization' => true
		);

		$this->cache = new TCache_Lite($options);
	}

	/**
	 * Get the cache life time.
	 * @return int Cache life time.
	 */
	public function getLifeTime()
	{
		return $this->lifetime;
	}

	/**
	 * Set the cache life time.
	 * @param int $time Cache life time.
	 */
	public function setLifeTime($time)
	{
		$this->lifetime = (int)$time;
	}

	/**
	 * Get the cache file ID based section and locale.
	 * @param string $catalogue The translation section.
	 * @param string $culture The translation locale, e.g. "en_AU".
	 */
	protected function getID($catalogue, $culture)
	{
		return $catalogue.':'.$culture;
	}

	/**
	 * Get the cache file GROUP based section and locale.
	 * @param string $catalogue The translation section.
	 * @param string $culture The translation locale, e.g. "en_AU".
	 */
	protected function getGroup($catalogue, $culture)
	{
		return $catalogue.':'.get_class($this);
	}

	/**
	 * Get the data from the cache.
	 * @param string $catalogue The translation section.
	 * @param string $culture The translation locale, e.g. "en_AU".
	 * @param string $filename If the source is a file, this file's modified
	 * time is newer than the cache's modified time, no cache hit. 
	 * @return mixed Boolean FALSE if no cache hit. Otherwise, translation
	 * table data for the specified section and locale.
	 */
	public function get($catalogue, $culture, $lastmodified=0) 
	{
		$ID = $this->getID($catalogue, $culture);
		$group = $this->getGroup($catalogue, $culture); 

		$this->cache->_setFileName($ID, $group);

		$cache = $this->cache->getCacheFile();
		
		if(is_file($cache) == false) 
			return false;


		$lastmodified = (int)$lastmodified;
		
		if($lastmodified <= 0 || $lastmodified > filemtime($cache))
			return false;		
		
		//echo '@@ Cache hit: "'.$ID.'" : "'.$group.'"';
		//echo "<br>\n";
			
		return $this->cache->get($ID, $group);
	}

	/**
	 * Save the data to cache for the specified section and locale.
	 * @param array $data The data to save.
	 * @param string $catalogue The translation section.
	 * @param string $culture The translation locale, e.g. "en_AU".
	 */
	public function save($data, $catalogue, $culture) 
	{		
		$ID = $this->getID($catalogue, $culture);
		$group = $this->getGroup($catalogue, $culture); 
		
		//echo '## Cache save: "'.$ID.'" : "'.$group.'"';
		//echo "<br>\n";
		
		return $this->cache->save($data, $ID, $group);
	}
	
	/**
	 * Clean up the cache for the specified section and locale.
	 * @param string $catalogue The translation section.
	 * @param string $culture The translation locale, e.g. "en_AU".
	 */
	public function clean($catalogue, $culture) 
	{
		$group = $this->getGroup($catalogue, $culture); 
		$this->cache->clean($group);
	}
	
	/**
	 * Flush the cache. Deletes all the cache files.
	 */
	public function clear()
	{
		$this->cache->clean();
	}

}