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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
<?php
/*
* $Id: TranslateGettext.php,v 1.11 2005/12/08 15:59:56 hlellelid Exp $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://phing.info>.
*/
require_once 'phing/filters/BaseParamFilterReader.php';
include_once 'phing/filters/ChainableReader.php';
/**
* Replaces gettext("message id") and _("message id") with the translated string.
*
* Gettext is great for creating multi-lingual sites, but in some cases (e.g. for
* performance reasons) you may wish to replace the gettext calls with the translations
* of the strings; that's what this task is for. Note that this is similar to
* ReplaceTokens, but both the find and the replace aspect is more complicated -- hence
* this is a separate, stand-alone filter.
*
* <p>
* Example:<br>
* <pre>
* <translategettext locale="en_US" domain="messages" dir="${webroot}/local"/>
* </pre>
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 1.11 $ $Date: 2005/12/08 15:59:56 $
* @access public
* @see BaseFilterReader
* @package phing.filters
*/
class TranslateGettext extends BaseParamFilterReader implements ChainableReader {
// constants for specifying keys to expect
// when this is called using <filterreader ... />
const DOMAIN_KEY = "domain";
const DIR_KEY = "dir";
const LOCALE_KEY = "locale";
/** The domain to use */
private $domain = 'messages';
/** The dir containing LC_MESSAGES */
private $dir;
/** The locale to use */
private $locale;
/** The system locale before it was changed for this filter. */
private $storedLocale;
/**
* Set the text domain to use.
* The text domain must correspond to the name of the compiled .mo files.
* E.g. "messages" ==> $dir/LC_MESSAGES/messages.mo
* "mydomain" ==> $dir/LC_MESSAGES/mydomain.mo
* @param string $domain
*/
function setDomain($domain) {
$this->domain = $domain;
}
/**
* Get the current domain.
* @return string
*/
function getDomain() {
return $this->domain;
}
/**
* Sets the root locale directory.
* @param PhingFile $dir
*/
function setDir(PhingFile $dir) {
$this->dir = $dir;
}
/**
* Gets the root locale directory.
* @return PhingFile
*/
function getDir() {
return $this->dir;
}
/**
* Sets the locale to use for translation.
* Note that for gettext() to work, you have to make sure this locale
* is specific enough for your system (e.g. some systems may allow an 'en' locale,
* but others will require 'en_US', etc.).
* @param string $locale
*/
function setLocale($locale) {
$this->locale = $locale;
}
/**
* Gets the locale to use for translation.
* @return string
*/
function getLocale() {
return $this->locale;
}
/**
* Make sure that required attributes are set.
* @throws BuldException - if any required attribs aren't set.
*/
protected function checkAttributes() {
if (!$this->domain || !$this->locale || !$this->dir) {
throw new BuildException("You must specify values for domain, locale, and dir attributes.");
}
}
/**
* Initialize the gettext/locale environment.
* This method will change some env vars and locale settings; the
* restoreEnvironment should put them all back :)
*
* @return void
* @throws BuildException - if locale cannot be set.
* @see restoreEnvironment()
*/
protected function initEnvironment() {
$this->storedLocale = getenv("LANG");
$this->log("Setting locale to " . $this->locale, PROJECT_MSG_DEBUG);
putenv("LANG=".$this->locale);
$ret = setlocale(LC_ALL, $this->locale);
if ($ret === false) {
$msg = "Could not set locale to " . $this->locale
. ". You may need to use fully qualified name"
. " (e.g. en_US instead of en).";
throw new BuildException($msg);
}
$this->log("Binding domain '".$this->domain."' to " . $this->dir, PROJECT_MSG_DEBUG);
bindtextdomain($this->domain, $this->dir->getAbsolutePath());
textdomain($this->domain);
}
/**
* Restores environment settings and locale.
* This does _not_ restore any gettext-specific settings
* (e.g. textdomain()).
*
* @return void
*/
protected function restoreEnvironment() {
putenv("LANG=".$this->storedLocale);
setlocale(LC_ALL, $this->storedLocale);
}
/**
* Performs gettext translation of msgid and returns translated text.
*
* This function simply wraps gettext() call, but provides ability to log
* string replacements. (alternative would be using preg_replace with /e which
* would probably be faster, but no ability to debug/log.)
*
* @param array $matches Array of matches; we're interested in $matches[2].
* @return string Translated text
*/
private function xlateStringCallback($matches) {
$charbefore = $matches[1];
$msgid = $matches[2];
$translated = gettext($msgid);
$this->log("Translating \"$msgid\" => \"$translated\"", PROJECT_MSG_DEBUG);
return $charbefore . '"' . $translated . '"';
}
/**
* Returns the filtered stream.
* The original stream is first read in fully, and then translation is performed.
*
* @return mixed the filtered stream, or -1 if the end of the resulting stream has been reached.
*
* @throws IOException - if the underlying stream throws an IOException during reading
* @throws BuildException - if the correct params are not supplied
*/
function read($len = null) {
if ( !$this->getInitialized() ) {
$this->_initialize();
$this->setInitialized(true);
}
// Make sure correct params/attribs have been set
$this->checkAttributes();
$buffer = $this->in->read($len);
if($buffer === -1) {
return -1;
}
// Setup the locale/gettext environment
$this->initEnvironment();
// replace any occurrences of _("") or gettext("") with
// the translated value.
//
// ([^\w]|^)_\("((\\"|[^"])*)"\)
// --$1--- -----$2----
// ---$3-- [match escaped quotes or any char that's not a quote]
//
// also match gettext() -- same as above
$buffer = preg_replace_callback('/([^\w]|^)_\("((\\\"|[^"])*)"\)/', array($this, 'xlateStringCallback'), $buffer);
$buffer = preg_replace_callback('/([^\w]|^)gettext\("((\\\"|[^"])*)"\)/', array($this, 'xlateStringCallback'), $buffer);
// Check to see if there are any _('') calls and flag an error
// Check to see if there are any unmatched gettext() calls -- and flag an error
$matches = array();
if (preg_match('/([^\w]|^)(gettext\([^\)]+\))/', $buffer, $matches)) {
$this->log("Unable to perform translation on: " . $matches[2], PROJECT_MSG_WARN);
}
$this->restoreEnvironment();
return $buffer;
}
/**
* Creates a new TranslateGettext filter using the passed in
* Reader for instantiation.
*
* @param Reader $reader A Reader object providing the underlying stream.
* Must not be <code>null</code>.
*
* @return TranslateGettext A new filter based on this configuration, but filtering
* the specified reader
*/
function chain(Reader $reader) {
$newFilter = new TranslateGettext($reader);
$newFilter->setProject($this->getProject());
$newFilter->setDomain($this->getDomain());
$newFilter->setLocale($this->getLocale());
$newFilter->setDir($this->getDir());
return $newFilter;
}
/**
* Parses the parameters if this filter is being used in "generic" mode.
*/
private function _initialize() {
$params = $this->getParameters();
if ( $params !== null ) {
foreach($params as $param) {
switch($param->getType()) {
case self::DOMAIN_KEY:
$this->setDomain($param->getValue());
break;
case self::DIR_KEY:
$this->setDir($this->project->resolveFile($param->getValue()));
break;
case self::LOCALE_KEY:
$this->setLocale($param->getValue());
break;
} // switch
}
} // if params !== null
}
}
?>
|
