3 namespace PhpXmlRpc\Helper;
5 use PhpXmlRpc\PhpXmlRpc;
8 * @todo implement an interface
12 // tables used for transcoding different charsets into us-ascii xml
13 protected $xml_iso88591_Entities = array("in" => array(), "out" => array());
15 //protected $xml_cp1252_Entities = array('in' => array(), out' => array());
17 protected $charset_supersets = array(
18 'US-ASCII' => array('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
19 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',
20 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',
21 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',
22 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN',),
25 /** @var Charset $instance */
26 protected static $instance = null;
29 * This class is singleton for performance reasons.
30 * @todo should we just make $xml_iso88591_Entities a static variable instead ?
34 public static function instance()
36 if (self::$instance === null) {
37 self::$instance = new static();
40 return self::$instance;
44 * Force usage as singleton
46 protected function __construct()
51 * @param string $tableName
52 * @throws \Exception for unsupported $tableName
53 * @todo add support for cp1252 as well as latin-2 .. latin-10
54 * @todo should we add to the latin-1 table the characters from cp_1252 range, i.e. 128 to 159 ?
55 * Those will NOT be present in true ISO-8859-1, but will save the unwary windows user from sending junk
56 * (though no luck when receiving them...)
57 * Note also that, apparently, while 'ISO/IEC 8859-1' has no characters defined for bytes 128 to 159,
58 * IANA ISO-8859-1 does have well-defined 'C1' control codes for those - wikipedia's page on latin-1 says:
59 * "ISO-8859-1 is the IANA preferred name for this standard when supplemented with the C0 and C1 control codes from ISO/IEC 6429."
60 * Check what mbstring/iconv do by default with those?
62 protected function buildConversionTable($tableName)
65 case 'xml_iso88591_Entities':
66 if (count($this->xml_iso88591_Entities['in'])) {
69 for ($i = 0; $i < 32; $i++) {
70 $this->xml_iso88591_Entities["in"][] = chr($i);
71 $this->xml_iso88591_Entities["out"][] = "&#{$i};";
74 /// @todo to be 'print safe', should we encode as well character 127 (DEL) ?
76 for ($i = 160; $i < 256; $i++) {
77 $this->xml_iso88591_Entities["in"][] = chr($i);
78 $this->xml_iso88591_Entities["out"][] = "&#{$i};";
82 /*case 'xml_cp1252_Entities':
83 if (count($this->xml_cp1252_Entities['in'])) {
86 for ($i = 128; $i < 160; $i++)
88 $this->xml_cp1252_Entities['in'][] = chr($i);
90 $this->xml_cp1252_Entities['out'] = array(
91 '€', '?', '‚', 'ƒ',
92 '„', '…', '†', '‡',
93 'ˆ', '‰', 'Š', '‹',
94 'Œ', '?', 'Ž', '?',
95 '?', '‘', '’', '“',
96 '”', '•', '–', '—',
97 '˜', '™', 'š', '›',
98 'œ', '?', 'ž', 'Ÿ'
100 $this->buildConversionTable('xml_iso88591_Entities');
104 throw new \Exception('Unsupported table: ' . $tableName);
109 * Convert a string to the correct XML representation in a target charset.
111 * - character transformation for all characters which have a different representation in source and dest charsets
112 * - using 'charset entity' representation for all characters which are outside of the target charset
114 * To help correct communication of non-ascii chars inside strings, regardless of the charset used when sending
115 * requests, parsing them, sending responses and parsing responses, an option is to convert all non-ascii chars
116 * present in the message into their equivalent 'charset entity'. Charset entities enumerated this way are
117 * independent of the charset encoding used to transmit them, and all XML parsers are bound to understand them.
119 * Note that when not sending a charset encoding mime type along with http headers, we are bound by RFC 3023 to emit
120 * strict us-ascii for 'text/xml' payloads (but we should review RFC 7303, which seems to have changed the rules...)
122 * @todo do a bit of basic benchmarking (strtr vs. str_replace)
123 * @todo make usage of iconv() or mb_string() where available
124 * @todo support aliases for charset names, eg ASCII, LATIN1, ISO-88591 (see f.e. polyfill-iconv for a list),
125 * but then take those into account as well in other methods, ie.isValidCharset)
126 * @todo when converting to ASCII, allow to choose whether to escape the range 0-31,127 (non-print chars) or not
127 * @todo allow picking different strategies to deal w. invalid chars? eg. source in latin-1 and chars 128-159
129 * @param string $data
130 * @param string $srcEncoding
131 * @param string $destEncoding
135 public function encodeEntities($data, $srcEncoding = '', $destEncoding = '')
137 if ($srcEncoding == '') {
138 // lame, but we know no better...
139 $srcEncoding = PhpXmlRpc::$xmlrpc_internalencoding;
142 if ($destEncoding == '') {
143 $destEncoding = 'US-ASCII';
146 $conversion = strtoupper($srcEncoding . '_' . $destEncoding);
148 // list ordered with (expected) most common scenarios first
149 switch ($conversion) {
151 case 'ISO-8859-1_ISO-8859-1':
152 case 'US-ASCII_UTF-8':
153 case 'US-ASCII_US-ASCII':
154 case 'US-ASCII_ISO-8859-1':
155 //case 'CP1252_CP1252':
156 $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
159 case 'UTF-8_US-ASCII':
160 case 'UTF-8_ISO-8859-1':
161 // NB: this will choke on invalid UTF-8, going most likely beyond EOF
163 // be kind to users creating string xmlrpc values out of different php types
164 $data = (string)$data;
166 for ($nn = 0; $nn < $ns; $nn++) {
169 // 7 bits in 1 byte: 0bbbbbbb (127)
171 if ($conversion == 'UTF-8_US-ASCII') {
172 $escapedData .= sprintf('&#%d;', $ii);
177 else if ($ii < 128) {
178 /// @todo shall we replace this with a (supposedly) faster str_replace?
181 $escapedData .= '"';
184 $escapedData .= '&';
187 $escapedData .= ''';
190 $escapedData .= '<';
193 $escapedData .= '>';
198 } // 11 bits in 2 bytes: 110bbbbb 10bbbbbb (2047)
199 elseif ($ii >> 5 == 6) {
201 $b2 = (ord($data[$nn + 1]) & 63);
202 $ii = ($b1 * 64) + $b2;
203 $escapedData .= sprintf('&#%d;', $ii);
205 } // 16 bits in 3 bytes: 1110bbbb 10bbbbbb 10bbbbbb
206 elseif ($ii >> 4 == 14) {
208 $b2 = (ord($data[$nn + 1]) & 63);
209 $b3 = (ord($data[$nn + 2]) & 63);
210 $ii = ((($b1 * 64) + $b2) * 64) + $b3;
211 $escapedData .= sprintf('&#%d;', $ii);
213 } // 21 bits in 4 bytes: 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
214 elseif ($ii >> 3 == 30) {
216 $b2 = (ord($data[$nn + 1]) & 63);
217 $b3 = (ord($data[$nn + 2]) & 63);
218 $b4 = (ord($data[$nn + 3]) & 63);
219 $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;
220 $escapedData .= sprintf('&#%d;', $ii);
225 // when converting to latin-1, do not be so eager with using entities for characters 160-255
226 if ($conversion == 'UTF-8_ISO-8859-1') {
227 $this->buildConversionTable('xml_iso88591_Entities');
228 $escapedData = str_replace(array_slice($this->xml_iso88591_Entities['out'], 32), array_slice($this->xml_iso88591_Entities['in'], 32), $escapedData);
232 case 'ISO-8859-1_UTF-8':
233 $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
234 $escapedData = utf8_encode($escapedData);
237 case 'ISO-8859-1_US-ASCII':
238 $this->buildConversionTable('xml_iso88591_Entities');
239 $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
240 $escapedData = str_replace($this->xml_iso88591_Entities['in'], $this->xml_iso88591_Entities['out'], $escapedData);
244 case 'CP1252_US-ASCII':
245 $this->buildConversionTable('xml_cp1252_Entities');
246 $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
247 $escapedData = str_replace($this->xml_iso88591_Entities']['in'], $this->xml_iso88591_Entities['out'], $escapedData);
248 $escapedData = str_replace($this->xml_cp1252_Entities['in'], $this->xml_cp1252_Entities['out'], $escapedData);
251 $this->buildConversionTable('xml_cp1252_Entities');
252 $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
253 /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all alone will NOT convert them)
254 $escapedData = str_replace($this->xml_cp1252_Entities['in'], $this->xml_cp1252_Entities['out'], $escapedData);
255 $escapedData = utf8_encode($escapedData);
257 case 'CP1252_ISO-8859-1':
258 $this->buildConversionTable('xml_cp1252_Entities');
259 $escapedData = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
260 // 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...
261 $escapedData = str_replace($this->xml_cp1252_Entities['in'], $this->xml_cp1252_Entities['out'], $escapedData);
267 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ": Converting from $srcEncoding to $destEncoding: not supported...");
274 * Checks if a given charset encoding is present in a list of encodings or if it is a valid subset of any encoding
277 * @param string $encoding charset to be tested
278 * @param string|array $validList comma separated list of valid charsets (or array of charsets)
282 public function isValidCharset($encoding, $validList)
284 if (is_string($validList)) {
285 $validList = explode(',', $validList);
287 if (@in_array(strtoupper($encoding), $validList)) {
290 if (array_key_exists($encoding, $this->charset_supersets)) {
291 foreach ($validList as $allowed) {
292 if (in_array($allowed, $this->charset_supersets[$encoding])) {
303 * Used only for backwards compatibility
306 * @param string $charset
310 * @throws \Exception for unknown/unsupported charsets
312 public function getEntities($charset)
314 //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
319 return $this->xml_iso88591_Entities;
321 throw new \Exception('Unsupported charset: ' . $charset);