X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FHelper%2FCharset.php;h=eca3e461be05bf2a70082e693706962632c20e97;hb=b6681659a7cabd3599f6a7040aa06fa75e4be052;hp=4f1103bbb19ca188338eb7981fae3c3797682cd2;hpb=d8e180b0ca87bf675d5fda2099d49c9d0043cd42;p=plcapi.git diff --git a/src/Helper/Charset.php b/src/Helper/Charset.php index 4f1103b..eca3e46 100644 --- a/src/Helper/Charset.php +++ b/src/Helper/Charset.php @@ -4,27 +4,23 @@ namespace PhpXmlRpc\Helper; use PhpXmlRpc\PhpXmlRpc; +/** + * @todo implement an interface + */ class Charset { // tables used for transcoding different charsets into us-ascii xml protected $xml_iso88591_Entities = array("in" => array(), "out" => array()); - protected $xml_iso88591_utf8 = array("in" => array(), "out" => array()); - /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159? - /// These will NOT be present in true ISO-8859-1, but will save the unwary - /// windows user from sending junk (though no luck when receiving them...) - /* - protected $xml_cp1252_Entities = array('in' => array(), out' => array( - '€', '?', '‚', 'ƒ', - '„', '…', '†', '‡', - 'ˆ', '‰', 'Š', '‹', - 'Œ', '?', 'Ž', '?', - '?', '‘', '’', '“', - '”', '•', '–', '—', - '˜', '™', 'š', '›', - 'œ', '?', 'ž', 'Ÿ' - )); - */ + /// @todo should we add to the latin-1 table the characters from cp_1252 range, i.e. 128 to 159 ? + /// Those will NOT be present in true ISO-8859-1, but will save the unwary windows user from sending junk + /// (though no luck when receiving them...) + /// Note also that, apparently, while 'ISO/IEC 8859-1' has no characters defined for bytes 128 to 159, + /// IANA ISO-8859-1 does have well-defined 'C1' control codes for those - wikipedia's page on latin-1 says: + /// "ISO-8859-1 is the IANA preferred name for this standard when supplemented with the C0 and C1 control codes from ISO/IEC 6429." + /// Check what mbstring/iconv do by default with those? + // + //protected $xml_cp1252_Entities = array('in' => array(), out' => array()); protected $charset_supersets = array( 'US-ASCII' => array('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4', @@ -34,52 +30,94 @@ class Charset 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN',), ); + /** @var Charset $instance */ protected static $instance = null; /** * This class is singleton for performance reasons. + * @todo should we just make $xml_iso88591_Entities a static variable instead ? * * @return Charset */ public static function instance() { if (self::$instance === null) { - self::$instance = new self(); + self::$instance = new static(); } return self::$instance; } - private function __construct() + /** + * Force usage as singleton + */ + protected function __construct() { - for ($i = 0; $i < 32; $i++) { - $this->xml_iso88591_Entities["in"][] = chr($i); - $this->xml_iso88591_Entities["out"][] = "&#{$i};"; - } + } - for ($i = 160; $i < 256; $i++) { - $this->xml_iso88591_Entities["in"][] = chr($i); - $this->xml_iso88591_Entities["out"][] = "&#{$i};"; - } + /** + * @param string $tableName + * @throws \Exception for unsupported $tableName + */ + protected function buildConversionTable($tableName) + { + switch($tableName) { + case 'xml_iso88591_Entities': + if (count($this->xml_iso88591_Entities['in'])) { + return; + } + for ($i = 0; $i < 32; $i++) { + $this->xml_iso88591_Entities["in"][] = chr($i); + $this->xml_iso88591_Entities["out"][] = "&#{$i};"; + } - /*for ($i = 128; $i < 160; $i++) - { - $this->xml_cp1252_Entities['in'][] = chr($i); - }*/ + for ($i = 160; $i < 256; $i++) { + $this->xml_iso88591_Entities["in"][] = chr($i); + $this->xml_iso88591_Entities["out"][] = "&#{$i};"; + } + break; + /*case 'xml_cp1252_Entities': + if (count($this->xml_cp1252_Entities['in'])) { + return; + } + for ($i = 128; $i < 160; $i++) + { + $this->xml_cp1252_Entities['in'][] = chr($i); + } + $this->xml_cp1252_Entities['out'] = array( + '€', '?', '‚', 'ƒ', + '„', '…', '†', '‡', + 'ˆ', '‰', 'Š', '‹', + 'Œ', '?', 'Ž', '?', + '?', '‘', '’', '“', + '”', '•', '–', '—', + '˜', '™', 'š', '›', + 'œ', '?', 'ž', 'Ÿ' + ); + $this->buildConversionTable('xml_iso88591_Entities'); + break;*/ + default: + throw new \Exception('Unsupported table: ' . $tableName); + } } /** * Convert a string to the correct XML representation in a target charset. + * This involves: + * - character transformation for all characters which have a different representation in source and dest charsets + * - using 'charset entity' representation for all characters which are outside of the target charset * * To help correct communication of non-ascii chars inside strings, regardless of the charset used when sending * requests, parsing them, sending responses and parsing responses, an option is to convert all non-ascii chars * present in the message into their equivalent 'charset entity'. Charset entities enumerated this way are * independent of the charset encoding used to transmit them, and all XML parsers are bound to understand them. - * Note that in the std case we are not sending a charset encoding mime type along with http headers, so we are - * bound by RFC 3023 to emit strict us-ascii. + * + * Note that when not sending a charset encoding mime type along with http headers, we are bound by RFC 3023 to emit + * strict us-ascii for 'text/xml' payloads (but we should review RFC 7303, which seems to have changed the rules...) * * @todo do a bit of basic benchmarking (strtr vs. str_replace) - * @todo make usage of iconv() or recode_string() or mb_string() where available + * @todo make usage of iconv() or mb_string() where available + * @todo support aliases for charset names, eg ASCII, LATIN1, ISO-88591 (see f.e. polyfill-iconv for a list) * * @param string $data * @param string $srcEncoding @@ -98,6 +136,7 @@ class Charset switch ($conversion) { case 'ISO-8859-1_': case 'ISO-8859-1_US-ASCII': + $this->buildConversionTable('xml_iso88591_Entities'); $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); $escapedData = str_replace($this->xml_iso88591_Entities['in'], $this->xml_iso88591_Entities['out'], $escapedData); break; @@ -188,6 +227,7 @@ class Charset // when converting to latin-1, do not be so eager with using entities for characters 160-255 if ($conversion == 'UTF-8_ISO-8859-1') { + $this->buildConversionTable('xml_iso88591_Entities'); $escapedData = str_replace(array_slice($this->xml_iso88591_Entities['out'], 32), array_slice($this->xml_iso88591_Entities['in'], 32), $escapedData); } break; @@ -195,17 +235,20 @@ class Charset /* case 'CP1252_': case 'CP1252_US-ASCII': + $this->buildConversionTable('xml_cp1252_Entities'); $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); $escapedData = str_replace($this->xml_iso88591_Entities']['in'], $this->xml_iso88591_Entities['out'], $escapedData); $escapedData = str_replace($this->xml_cp1252_Entities['in'], $this->xml_cp1252_Entities['out'], $escapedData); break; case 'CP1252_UTF-8': + $this->buildConversionTable('xml_cp1252_Entities'); $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); - /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all allone will NOT convert them) + /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all alone will NOT convert them) $escapedData = str_replace($this->xml_cp1252_Entities['in'], $this->xml_cp1252_Entities['out'], $escapedData); $escapedData = utf8_encode($escapedData); break; case 'CP1252_ISO-8859-1': + $this->buildConversionTable('xml_cp1252_Entities'); $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); // we might as well replace all funky chars with a '?' here, but we are kind and leave it to the receiving application layer to decide what to do with these weird entities... $escapedData = str_replace($this->xml_cp1252_Entities['in'], $this->xml_cp1252_Entities['out'], $escapedData); @@ -214,15 +257,15 @@ class Charset default: $escapedData = ''; - error_log('XML-RPC: ' . __METHOD__ . ": Converting from $srcEncoding to $destEncoding: not supported..."); + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ": Converting from $srcEncoding to $destEncoding: not supported..."); } return $escapedData; } /** - * Checks if a given charset encoding is present in a list of encodings or - * if it is a valid subset of any encoding in the list. + * Checks if a given charset encoding is present in a list of encodings or if it is a valid subset of any encoding + * in the list. * * @param string $encoding charset to be tested * @param string|array $validList comma separated list of valid charsets (or array of charsets) @@ -261,6 +304,8 @@ class Charset */ public function getEntities($charset) { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + switch ($charset) { case 'iso88591': @@ -269,5 +314,4 @@ class Charset throw new \Exception('Unsupported charset: ' . $charset); } } - }