git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

Commit ee96a087 authored by mmn's avatar mmn
parent 4526c3f7
2009-11-27 Danilo Šegan <danilo@gnome.org>
* Makefile: discontinue use of ChangeLog with 1.0.8.
2006-02-28 Danilo Šegan <danilo@gnome.org>
* gettext.php: Added some comments about these workarounds for
......@@ -6,7 +10,7 @@
2006-02-28 Danilo Šegan <danilo@gnome.org>
Fixes bug #15923.
* gettext.php (gettext_reader): make magic check work on 64-bit
platforms as well (by Steffen Pingel).
......@@ -27,7 +31,7 @@
2006-02-03 Danilo Šegan <danilo@gnome.org>
Added setlocale() emulation as well.
* examples/pigs_dropin.php: Use T_setlocale() and locale_emulation().
* examples/pigs_fallback.php: Use T_setlocale() and locale_emulation().
......
PHP-gettext 1.0
PHP-gettext 1.0 (https://launchpad.net/php-gettext)
Copyright 2003, 2006 -- Danilo "angry with PHP[1]" Segan
Copyright 2003, 2006, 2009 -- Danilo "angry with PHP[1]" Segan
Licensed under GPLv2 (or any later version, see COPYING)
[1] PHP is actually cyrillic, and translates roughly to
[1] PHP is actually cyrillic, and translates roughly to
"works-doesn't-work" (UTF-8: Ради-Не-Ради)
......@@ -50,36 +50,16 @@ Features
file data, I used imaginary abstract class StreamReader to do all
the input (check streams.php). For your convenience, I've already
provided two classes for reading files: FileReader and
StringReader (CachedFileReader is a combination of the two: it
loads entire file contents into a string, and then works on that).
See example below for usage. You can for instance use StringReader
when you read in data from a database, or you can create your own
derivative of StreamReader for anything you like.
StringReader (CachedFileReader is a combination of the two: it
loads entire file contents into a string, and then works on that).
See example below for usage. You can for instance use StringReader
when you read in data from a database, or you can create your own
derivative of StreamReader for anything you like.
Bugs
Plural-forms field in MO header (translation for empty string,
i.e. "") is treated according to PHP syntactic rules (it's
eval()ed). Since these should actually follow C syntax, there are
some problems.
For instance, I'm used to using this:
Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : \
n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;
but it fails with PHP (it sets $plural=2 instead of 0 for $n==1).
The fix is usually simple, but I'm lazy to go into the details of
PHP operator precedence, and maybe try to fix it. In here, I had
to put everything after the first ':' in parenthesis:
Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : \
(n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);
That works, and I'm satisfied.
Bugs
Besides this one, there are probably a bunch of other bugs, since
I hate PHP (did I mention it already? no? strange), and don't
know it very well. So, feel free to fix any of those and report
them back to me at <danilo@kvota.net>.
Report them on https://bugs.launchpad.net/php-gettext
Usage
......@@ -94,19 +74,19 @@ Usage
Then, use that as a parameter to gettext_reader constructor:
$wohoo = new gettext_reader($streamer);
If you want to disable pre-loading of entire message catalog in
memory (if, for example, you have a multi-thousand message catalog
which you'll use only occasionally), use "false" for second
If you want to disable pre-loading of entire message catalog in
memory (if, for example, you have a multi-thousand message catalog
which you'll use only occasionally), use "false" for second
parameter to gettext_reader constructor:
$wohoo = new gettext_reader($streamer, false);
From now on, you have all the benefits of gettext data at your
disposal, so may run:
disposal, so may run:
print $wohoo->translate("This is a test");
print $wohoo->ngettext("%d bird", "%d birds", $birds);
You might need to pass parameter "-k" to xgettext to make it
extract all the strings. In above example, try with
extract all the strings. In above example, try with
xgettext -ktranslate -kngettext:1,2 file.php
what should create messages.po which contains two messages for
translation.
......@@ -118,8 +98,8 @@ Usage
Usage with gettext.inc (standard gettext interfaces emulation)
Check example in examples/pig_dropin.php, basically you include
gettext.inc and use all the standard gettext interfaces as
Check example in examples/pig_dropin.php, basically you include
gettext.inc and use all the standard gettext interfaces as
documented on:
http://www.php.net/gettext
......@@ -137,20 +117,12 @@ Example
There is also simple "update" script that can be used to generate
POT file and to update the translation using msgmerge.
Interesting TODO:
TODO:
o Try to parse "plural-forms" header field, and to follow C syntax
rules. This won't be easy.
o Improve speed to be even more comparable to the native gettext
implementation.
Boring TODO:
o Learn PHP and fix bugs, slowness and other stuff resulting from
my lack of knowledge (but *maybe*, it's not my knowledge that is
bad, but PHP itself ;-).
(This is mostly done thanks to Nico Kaiser.)
o Try to use hash tables in MO files: with pre-loading, would it
o Try to use hash tables in MO files: with pre-loading, would it
be useful at all?
Never-asked-questions:
......@@ -160,7 +132,7 @@ Never-asked-questions:
Well, it's quite simple. I consider that the first released thing
should be labeled "version 1" (first, right?). Zero is there to
indicate that there's zero improvement and/or change compared to
indicate that there's zero improvement and/or change compared to
"version 1".
I plan to use version numbers 1.0.* for small bugfixes, and to
......@@ -173,7 +145,7 @@ Never-asked-questions:
Mozart's 40th Symphony (there is one like that, right?).
o Can I...?
Yes, you can. This is free software (as in freedom, free speech),
and you might do whatever you wish with it, provided you do not
limit freedom of others (GPL).
......
This diff is collapsed.
<?php
/*
Copyright (c) 2003 Danilo Segan <danilo@kvota.net>.
Copyright (c) 2003, 2009 Danilo Segan <danilo@kvota.net>.
Copyright (c) 2005 Nico Kaiser <nico@siriux.net>
This file is part of PHP-gettext.
PHP-gettext is free software; you can redistribute it and/or modify
......@@ -20,13 +20,13 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* Provides a simple gettext replacement that works independently from
* the system's gettext abilities.
* It can read MO files and use them for translating strings.
* The files are passed to gettext_reader as a Stream (see streams.php)
*
*
* This version has the ability to cache all strings and translations to
* speed up the string lookup.
* While the cache is enabled by default, it can be switched off with the
......@@ -36,7 +36,7 @@
class gettext_reader {
//public:
var $error = 0; // public variable that holds error code (0 if no error)
//private:
var $BYTEORDER = 0; // 0: low endian, 1: big endian
var $STREAM = NULL;
......@@ -52,27 +52,33 @@ class gettext_reader {
/* Methods */
/**
* Reads a 32bit Integer from the Stream
*
*
* @access private
* @return Integer from the Stream
*/
function readint() {
if ($this->BYTEORDER == 0) {
// low endian
return array_shift(unpack('V', $this->STREAM->read(4)));
$input=unpack('V', $this->STREAM->read(4));
return array_shift($input);
} else {
// big endian
return array_shift(unpack('N', $this->STREAM->read(4)));
$input=unpack('N', $this->STREAM->read(4));
return array_shift($input);
}
}
function read($bytes) {
return $this->STREAM->read($bytes);
}
/**
* Reads an array of Integers from the Stream
*
*
* @param int count How many elements should be read
* @return Array of Integers
*/
......@@ -85,10 +91,10 @@ class gettext_reader {
return unpack('N'.$count, $this->STREAM->read(4 * $count));
}
}
/**
* Constructor
*
*
* @param object Reader the StreamReader object
* @param boolean enable_cache Enable or disable caching of strings (default on)
*/
......@@ -98,39 +104,37 @@ class gettext_reader {
$this->short_circuit = true;
return;
}
// Caching can be turned off
$this->enable_cache = $enable_cache;
// $MAGIC1 = (int)0x950412de; //bug in PHP 5.0.2, see https://savannah.nongnu.org/bugs/?func=detailitem&item_id=10565
$MAGIC1 = (int) - 1794895138;
// $MAGIC2 = (int)0xde120495; //bug
$MAGIC2 = (int) - 569244523;
$MAGIC1 = "\x95\x04\x12\xde";
$MAGIC2 = "\xde\x12\x04\x95";
$this->STREAM = $Reader;
$magic = $this->readint();
if ($magic == ($MAGIC1 & 0xFFFFFFFF)) { // to make sure it works for 64-bit platforms
$this->BYTEORDER = 0;
} elseif ($magic == ($MAGIC2 & 0xFFFFFFFF)) {
$magic = $this->read(4);
if ($magic == $MAGIC1) {
$this->BYTEORDER = 1;
} elseif ($magic == $MAGIC2) {
$this->BYTEORDER = 0;
} else {
$this->error = 1; // not MO file
return false;
}
// FIXME: Do we care about revision? We should.
$revision = $this->readint();
$this->total = $this->readint();
$this->originals = $this->readint();
$this->translations = $this->readint();
}
/**
* Loads the translation tables from the MO file into the cache
* If caching is enabled, also loads all strings into a cache
* to speed up translation lookups
*
*
* @access private
*/
function load_tables() {
......@@ -138,13 +142,17 @@ class gettext_reader {
is_array($this->table_originals) &&
is_array($this->table_translations))
return;
/* get original and translations tables */
$this->STREAM->seekto($this->originals);
$this->table_originals = $this->readintarray($this->total * 2);
$this->STREAM->seekto($this->translations);
$this->table_translations = $this->readintarray($this->total * 2);
if (!is_array($this->table_originals)) {
$this->STREAM->seekto($this->originals);
$this->table_originals = $this->readintarray($this->total * 2);
}
if (!is_array($this->table_translations)) {
$this->STREAM->seekto($this->translations);
$this->table_translations = $this->readintarray($this->total * 2);
}
if ($this->enable_cache) {
$this->cache_translations = array ();
/* read all strings in the cache */
......@@ -157,10 +165,10 @@ class gettext_reader {
}
}
}
/**
* Returns a string from the "originals" table
*
*
* @access private
* @param int num Offset number of original string
* @return string Requested string if found, otherwise ''
......@@ -174,10 +182,10 @@ class gettext_reader {
$data = $this->STREAM->read($length);
return (string)$data;
}
/**
* Returns a string from the "translations" table
*
*
* @access private
* @param int num Offset number of original string
* @return string Requested string if found, otherwise ''
......@@ -191,10 +199,10 @@ class gettext_reader {
$data = $this->STREAM->read($length);
return (string)$data;
}
/**
* Binary search for string
*
*
* @access private
* @param string string
* @param int start (internally used in recursive function)
......@@ -232,10 +240,10 @@ class gettext_reader {
return $this->find_string($string, $half, $end);
}
}
/**
* Translates a string
*
*
* @access public
* @param string string to be translated
* @return string translated string (or original, if not found)
......@@ -243,8 +251,8 @@ class gettext_reader {
function translate($string) {
if ($this->short_circuit)
return $string;
$this->load_tables();
$this->load_tables();
if ($this->enable_cache) {
// Caching enabled, get translated string from cache
if (array_key_exists($string, $this->cache_translations))
......@@ -261,17 +269,66 @@ class gettext_reader {
}
}
/**
* Sanitize plural form expression for use in PHP eval call.
*
* @access private
* @return string sanitized plural form expression
*/
function sanitize_plural_expression($expr) {
// Get rid of disallowed characters.
$expr = preg_replace('@[^a-zA-Z0-9_:;\(\)\?\|\&=!<>+*/\%-]@', '', $expr);
// Add parenthesis for tertiary '?' operator.
$expr .= ';';
$res = '';
$p = 0;
for ($i = 0; $i < strlen($expr); $i++) {
$ch = $expr[$i];
switch ($ch) {
case '?':
$res .= ' ? (';
$p++;
break;
case ':':
$res .= ') : (';
break;
case ';':
$res .= str_repeat( ')', $p) . ';';
$p = 0;
break;
default:
$res .= $ch;
}
}
return $res;
}
/**
* Parse full PO header and extract only plural forms line.
*
* @access private
* @return string verbatim plural form header field
*/
function extract_plural_forms_header_from_po_header($header) {
if (preg_match("/(^|\n)plural-forms: ([^\n]*)\n/i", $header, $regs))
$expr = $regs[2];
else
$expr = "nplurals=2; plural=n == 1 ? 0 : 1;";
return $expr;
}
/**
* Get possible plural forms from MO header
*
*
* @access private
* @return string plural form header
*/
function get_plural_forms() {
// lets assume message number 0 is header
// lets assume message number 0 is header
// this is true, right?
$this->load_tables();
// cache header field for plural forms
if (! is_string($this->pluralheader)) {
if ($this->enable_cache) {
......@@ -279,18 +336,15 @@ class gettext_reader {
} else {
$header = $this->get_translation_string(0);
}
if (eregi("plural-forms: ([^\n]*)\n", $header, $regs))
$expr = $regs[1];
else
$expr = "nplurals=2; plural=n == 1 ? 0 : 1;";
$this->pluralheader = $expr;
$expr = $this->extract_plural_forms_header_from_po_header($header);
$this->pluralheader = $this->sanitize_plural_expression($expr);
}
return $this->pluralheader;
}
/**
* Detects which plural form to take
*
*
* @access private
* @param n count
* @return int array index of the right plural form
......@@ -300,7 +354,7 @@ class gettext_reader {
$string = str_replace('nplurals',"\$total",$string);
$string = str_replace("n",$n,$string);
$string = str_replace('plural',"\$plural",$string);
$total = 0;
$plural = 0;
......@@ -311,7 +365,7 @@ class gettext_reader {
/**
* Plural version of gettext
*
*
* @access public
* @param string single
* @param string plural
......@@ -327,12 +381,12 @@ class gettext_reader {
}
// find out the appropriate form
$select = $this->select_string($number);
$select = $this->select_string($number);
// this should contains all strings separated by NULLs
$key = $single.chr(0).$plural;
$key = $single . chr(0) . $plural;
if ($this->enable_cache) {
if (! array_key_exists($key, $this->cache_translations)) {
return ($number != 1) ? $plural : $single;
......@@ -353,6 +407,26 @@ class gettext_reader {
}
}
function pgettext($context, $msgid) {
$key = $context . chr(4) . $msgid;
$ret = $this->translate($key);
if (strpos($ret, "\004") !== FALSE) {
return $msgid;
} else {
return $ret;
}
}
function npgettext($context, $singular, $plural, $number) {
$key = $context . chr(4) . $singular;
$ret = $this->ngettext($key, $plural, $number);
if (strpos($ret, "\004") !== FALSE) {
return $singular;
} else {
return $ret;
}
}
}
?>
<?php
/*
Copyright (c) 2003, 2005 Danilo Segan <danilo@kvota.net>.
Copyright (c) 2003, 2005, 2006, 2009 Danilo Segan <danilo@kvota.net>.
This file is part of PHP-gettext.
......@@ -21,29 +21,29 @@
*/
// Simple class to wrap file streams, string streams, etc.
// seek is essential, and it should be byte stream
// Simple class to wrap file streams, string streams, etc.
// seek is essential, and it should be byte stream
class StreamReader {
// should return a string [FIXME: perhaps return array of bytes?]
function read($bytes) {
return false;
}
// should return new position
function seekto($position) {
return false;
}
// returns current position
function currentpos() {
return false;
}
// returns length of entire stream (limit for seekto()s)
function length() {
return false;
}
}
};
class StringReader {
var $_pos;
......@@ -78,7 +78,7 @@ class StringReader {
return strlen($this->_str);
}
}
};
class FileReader {
......@@ -93,8 +93,8 @@ class FileReader {
$this->_pos = 0;
$this->_fd = fopen($filename,'rb');
if (!$this->_fd) {
$this->error = 3; // Cannot read file, probably permissions
return false;
$this->error = 3; // Cannot read file, probably permissions
return false;
}
} else {
$this->error = 2; // File doesn't exist
......@@ -115,7 +115,7 @@ class FileReader {
$bytes -= strlen($chunk);
}
$this->_pos = ftell($this->_fd);
return $data;
} else return '';
}
......@@ -138,9 +138,9 @@ class FileReader {
fclose($this->_fd);
}
}
};
// Preloads entire file in memory first, then creates a StringReader
// Preloads entire file in memory first, then creates a StringReader
// over it (it assumes knowledge of StringReader internals)
class CachedFileReader extends StringReader {
function CachedFileReader($filename) {
......@@ -150,8 +150,8 @@ class CachedFileReader extends StringReader {
$fd = fopen($filename,'rb');
if (!$fd) {
$this->error = 3; // Cannot read file, probably permissions
return false;
$this->error = 3; // Cannot read file, probably permissions
return false;
}
$this->_str = fread($fd, $length);
fclose($fd);
......@@ -161,7 +161,7 @@ class CachedFileReader extends StringReader {
return false;
}
}
}
};
?>
\ No newline at end of file
?>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment