TranslateGettext::chain() - Code Metrics - Inspection of "update coding style (#1137)" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7082f0...55a2b2 )

by Siad

created 2019-10-06 13:42 UTC

TranslateGettext::chain() A

↳ Parent: TranslateGettext

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	1
dl	0
loc	9
ccs	0
cts	7
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
/**
 * 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>.
 */

/**
 * 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 <[email protected]>
 * @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
     */
    public function setDomain($domain)
    {
        $this->domain = $domain;
    }

    /**
     * Get the current domain.
     *
     * @return string
     */
    public function getDomain()
    {
        return $this->domain;
    }

    /**
     * Sets the root locale directory.
     *
     * @param PhingFile $dir
     */
    public function setDir(PhingFile $dir)
    {
        $this->dir = $dir;
    }

    /**
     * Gets the root locale directory.
     *
     * @return PhingFile
     */
    public 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
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;
    }

    /**
     * Gets the locale to use for translation.
     *
     * @return string
     */
    public 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.
     *
     * @param  int $len
     * @throws BuildException
     * @return mixed the filtered stream, or -1 if the end of the resulting stream has been reached.
     */
    public 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|^)_\("((\\\"|[^"])*)"\)/',
            [$this, 'xlateStringCallback'],
            $buffer
        );
        $buffer = preg_replace_callback(
            '/(\W|^)gettext\("((\\\"|[^"])*)"\)/',
            [$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 = [];
        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
     */
    public function chain(Reader $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
    }
}


1			<?php
2			/**
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the LGPL. For more information please see
17			* <http://phing.info>.
18			*/
19
20			/**
21			* Replaces gettext("message id") and _("message id") with the translated string.
22			*
23			* Gettext is great for creating multi-lingual sites, but in some cases (e.g. for
24			* performance reasons) you may wish to replace the gettext calls with the translations
25			* of the strings; that's what this task is for. Note that this is similar to
26			* ReplaceTokens, but both the find and the replace aspect is more complicated -- hence
27			* this is a separate, stand-alone filter.
28			*
29			* <p>
30			* Example:<br>
31			* <pre>
32			* <translategettext locale="en_US" domain="messages" dir="${webroot}/local"/>
33			* </pre>
34			*
35			* @author Hans Lellelid <[email protected]>
36			* @see BaseFilterReader
37			* @package phing.filters
38			*/
39			class TranslateGettext extends BaseParamFilterReader implements ChainableReader
40			{
41
42			// constants for specifying keys to expect
43			// when this is called using <filterreader ... />
44			const DOMAIN_KEY = "domain";
45			const DIR_KEY = "dir";
46			const LOCALE_KEY = "locale";
47
48			/**
49			* The domain to use
50			*/
51			private $domain = 'messages';
52
53			/**
54			* The dir containing LC_MESSAGES
55			*/
56			private $dir;
57
58			/**
59			* The locale to use
60			*/
61			private $locale;
62
63			/**
64			* The system locale before it was changed for this filter.
65			*/
66			private $storedLocale;
67
68			/**
69			* Set the text domain to use.
70			* The text domain must correspond to the name of the compiled .mo files.
71			* E.g. "messages" ==> $dir/LC_MESSAGES/messages.mo
72			* "mydomain" ==> $dir/LC_MESSAGES/mydomain.mo
73			*
74			* @param string $domain
75			*/
76			public function setDomain($domain)
77			{
78			$this->domain = $domain;
79			}
80
81			/**
82			* Get the current domain.
83			*
84			* @return string
85			*/
86			public function getDomain()
87			{
88			return $this->domain;
89			}
90
91			/**
92			* Sets the root locale directory.
93			*
94			* @param PhingFile $dir
95			*/
96			public function setDir(PhingFile $dir)
97			{
98			$this->dir = $dir;
99			}
100
101			/**
102			* Gets the root locale directory.
103			*
104			* @return PhingFile
105			*/
106			public function getDir()
107			{
108			return $this->dir;
109			}
110
111			/**
112			* Sets the locale to use for translation.
113			* Note that for gettext() to work, you have to make sure this locale
114			* is specific enough for your system (e.g. some systems may allow an 'en' locale,
115			* but others will require 'en_US', etc.).
116			*
117			* @param string $locale
118			*/
119			public function setLocale($locale)
120			{
121			$this->locale = $locale;
122			}
123
124			/**
125			* Gets the locale to use for translation.
126			*
127			* @return string
128			*/
129			public function getLocale()
130			{
131			return $this->locale;
132			}
133
134			/**
135			* Make sure that required attributes are set.
136			*
137			* @throws BuldException - if any required attribs aren't set.
138			*/
139			protected function checkAttributes()
140			{
141			if (!$this->domain \|\| !$this->locale \|\| !$this->dir) {
142			throw new BuildException("You must specify values for domain, locale, and dir attributes.");
143			}
144			}
145
146			/**
147			* Initialize the gettext/locale environment.
148			* This method will change some env vars and locale settings; the
149			* restoreEnvironment should put them all back :)
150			*
151			* @return void
152			* @throws BuildException - if locale cannot be set.
153			* @see restoreEnvironment()
154			*/
155			protected function initEnvironment()
156			{
157			$this->storedLocale = getenv("LANG");
158
159			$this->log("Setting locale to " . $this->locale, Project::MSG_DEBUG);
160			putenv("LANG=" . $this->locale);
161			$ret = setlocale(LC_ALL, $this->locale);
162			if ($ret === false) {
163			$msg = "Could not set locale to " . $this->locale
164			. ". You may need to use fully qualified name"
165			. " (e.g. en_US instead of en).";
166			throw new BuildException($msg);
167			}
168
169			$this->log("Binding domain '" . $this->domain . "' to " . $this->dir, Project::MSG_DEBUG);
170			bindtextdomain($this->domain, $this->dir->getAbsolutePath());
171			textdomain($this->domain);
172			}
173
174			/**
175			* Restores environment settings and locale.
176			* This does _not_ restore any gettext-specific settings
177			* (e.g. textdomain()).
178			*
179			* @return void
180			*/
181			protected function restoreEnvironment()
182			{
183			putenv("LANG=" . $this->storedLocale);
184			setlocale(LC_ALL, $this->storedLocale);
185			}
186
187			/**
188			* Performs gettext translation of msgid and returns translated text.
189			*
190			* This function simply wraps gettext() call, but provides ability to log
191			* string replacements. (alternative would be using preg_replace with /e which
192			* would probably be faster, but no ability to debug/log.)
193			*
194			* @param array $matches Array of matches; we're interested in $matches[2].
195			* @return string Translated text
196			*/
197			private function xlateStringCallback($matches)
198			{
199			$charbefore = $matches[1];
200			$msgid = $matches[2];
201			$translated = gettext($msgid);
202			$this->log("Translating \"$msgid\" => \"$translated\"", Project::MSG_DEBUG);
203
204			return $charbefore . '"' . $translated . '"';
205			}
206
207			/**
208			* Returns the filtered stream.
209			* The original stream is first read in fully, and then translation is performed.
210			*
211			* @param int $len
212			* @throws BuildException
213			* @return mixed the filtered stream, or -1 if the end of the resulting stream has been reached.
214			*/
215			public function read($len = null)
216			{
217			if (!$this->getInitialized()) {
218			$this->initialize();
219			$this->setInitialized(true);
220			}
221
222			// Make sure correct params/attribs have been set
223			$this->checkAttributes();
224
225			$buffer = $this->in->read($len);
226			if ($buffer === -1) {
227			return -1;
228			}
229
230			// Setup the locale/gettext environment
231			$this->initEnvironment();
232
233
234			// replace any occurrences of _("") or gettext("") with
235			// the translated value.
236			//
237			// ([^\w]\|^)_\("((\\"\|[^"])*)"\)
238			// --$1--- -----$2----
239			// ---$3-- [match escaped quotes or any char that's not a quote]
240			//
241			// also match gettext() -- same as above
242
243			$buffer = preg_replace_callback(
244			'/(\W\|^)_\("((\\\"\|[^"])*)"\)/',
245			[$this, 'xlateStringCallback'],
246			$buffer
247			);
248			$buffer = preg_replace_callback(
249			'/(\W\|^)gettext\("((\\\"\|[^"])*)"\)/',
250			[$this, 'xlateStringCallback'],
251			$buffer
252			);
253
254			// Check to see if there are any _('') calls and flag an error
255
256			// Check to see if there are any unmatched gettext() calls -- and flag an error
257
258			$matches = [];
259			if (preg_match('/(\W\|^)(gettext\([^\)]+\))/', $buffer, $matches)) {
260			$this->log("Unable to perform translation on: " . $matches[2], Project::MSG_WARN);
261			}
262
263			$this->restoreEnvironment();
264
265			return $buffer;
266			}
267
268			/**
269			* Creates a new TranslateGettext filter using the passed in
270			* Reader for instantiation.
271			*
272			* @param Reader $reader A Reader object providing the underlying stream.
273			* Must not be <code>null</code>.
274			*
275			* @return TranslateGettext A new filter based on this configuration, but filtering
276			* the specified reader
277			*/
278			public function chain(Reader $reader): Reader
279			{
280			$newFilter = new TranslateGettext($reader);
281			$newFilter->setProject($this->getProject());
282			$newFilter->setDomain($this->getDomain());
283			$newFilter->setLocale($this->getLocale());
284			$newFilter->setDir($this->getDir());
285
286			return $newFilter;
287			}
288
289			/**
290			* Parses the parameters if this filter is being used in "generic" mode.
291			*/
292			private function initialize()
293			{
294			$params = $this->getParameters();
295			if ($params !== null) {
			0 ignored issues – show introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The condition `$params !== null` is always `true`. Loading history...
296			foreach ($params as $param) {
297			switch ($param->getType()) {
298			case self::DOMAIN_KEY:
299			$this->setDomain($param->getValue());
300			break;
301			case self::DIR_KEY:
302			$this->setDir($this->project->resolveFile($param->getValue()));
303			break;
304
305			case self::LOCALE_KEY:
306			$this->setLocale($param->getValue());
307			break;
308			} // switch
309			}
310			} // if params !== null
311			}
312			}
313

phingofficial / phing

Push — master ( 7082f0...55a2b2 )

TranslateGettext::chain() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like