CharacterStream.php 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Mime;
  11. /**
  12. * @author Fabien Potencier <fabien@symfony.com>
  13. * @author Xavier De Cock <xdecock@gmail.com>
  14. *
  15. * @internal
  16. */
  17. final class CharacterStream
  18. {
  19. /** Pre-computed for optimization */
  20. private const UTF8_LENGTH_MAP = [
  21. "\x00" => 1, "\x01" => 1, "\x02" => 1, "\x03" => 1, "\x04" => 1, "\x05" => 1, "\x06" => 1, "\x07" => 1,
  22. "\x08" => 1, "\x09" => 1, "\x0a" => 1, "\x0b" => 1, "\x0c" => 1, "\x0d" => 1, "\x0e" => 1, "\x0f" => 1,
  23. "\x10" => 1, "\x11" => 1, "\x12" => 1, "\x13" => 1, "\x14" => 1, "\x15" => 1, "\x16" => 1, "\x17" => 1,
  24. "\x18" => 1, "\x19" => 1, "\x1a" => 1, "\x1b" => 1, "\x1c" => 1, "\x1d" => 1, "\x1e" => 1, "\x1f" => 1,
  25. "\x20" => 1, "\x21" => 1, "\x22" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1,
  26. "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, "\x2f" => 1,
  27. "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1,
  28. "\x38" => 1, "\x39" => 1, "\x3a" => 1, "\x3b" => 1, "\x3c" => 1, "\x3d" => 1, "\x3e" => 1, "\x3f" => 1,
  29. "\x40" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, "\x47" => 1,
  30. "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, "\x4f" => 1,
  31. "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, "\x57" => 1,
  32. "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5b" => 1, "\x5c" => 1, "\x5d" => 1, "\x5e" => 1, "\x5f" => 1,
  33. "\x60" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1,
  34. "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1,
  35. "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1,
  36. "\x78" => 1, "\x79" => 1, "\x7a" => 1, "\x7b" => 1, "\x7c" => 1, "\x7d" => 1, "\x7e" => 1, "\x7f" => 1,
  37. "\x80" => 0, "\x81" => 0, "\x82" => 0, "\x83" => 0, "\x84" => 0, "\x85" => 0, "\x86" => 0, "\x87" => 0,
  38. "\x88" => 0, "\x89" => 0, "\x8a" => 0, "\x8b" => 0, "\x8c" => 0, "\x8d" => 0, "\x8e" => 0, "\x8f" => 0,
  39. "\x90" => 0, "\x91" => 0, "\x92" => 0, "\x93" => 0, "\x94" => 0, "\x95" => 0, "\x96" => 0, "\x97" => 0,
  40. "\x98" => 0, "\x99" => 0, "\x9a" => 0, "\x9b" => 0, "\x9c" => 0, "\x9d" => 0, "\x9e" => 0, "\x9f" => 0,
  41. "\xa0" => 0, "\xa1" => 0, "\xa2" => 0, "\xa3" => 0, "\xa4" => 0, "\xa5" => 0, "\xa6" => 0, "\xa7" => 0,
  42. "\xa8" => 0, "\xa9" => 0, "\xaa" => 0, "\xab" => 0, "\xac" => 0, "\xad" => 0, "\xae" => 0, "\xaf" => 0,
  43. "\xb0" => 0, "\xb1" => 0, "\xb2" => 0, "\xb3" => 0, "\xb4" => 0, "\xb5" => 0, "\xb6" => 0, "\xb7" => 0,
  44. "\xb8" => 0, "\xb9" => 0, "\xba" => 0, "\xbb" => 0, "\xbc" => 0, "\xbd" => 0, "\xbe" => 0, "\xbf" => 0,
  45. "\xc0" => 2, "\xc1" => 2, "\xc2" => 2, "\xc3" => 2, "\xc4" => 2, "\xc5" => 2, "\xc6" => 2, "\xc7" => 2,
  46. "\xc8" => 2, "\xc9" => 2, "\xca" => 2, "\xcb" => 2, "\xcc" => 2, "\xcd" => 2, "\xce" => 2, "\xcf" => 2,
  47. "\xd0" => 2, "\xd1" => 2, "\xd2" => 2, "\xd3" => 2, "\xd4" => 2, "\xd5" => 2, "\xd6" => 2, "\xd7" => 2,
  48. "\xd8" => 2, "\xd9" => 2, "\xda" => 2, "\xdb" => 2, "\xdc" => 2, "\xdd" => 2, "\xde" => 2, "\xdf" => 2,
  49. "\xe0" => 3, "\xe1" => 3, "\xe2" => 3, "\xe3" => 3, "\xe4" => 3, "\xe5" => 3, "\xe6" => 3, "\xe7" => 3,
  50. "\xe8" => 3, "\xe9" => 3, "\xea" => 3, "\xeb" => 3, "\xec" => 3, "\xed" => 3, "\xee" => 3, "\xef" => 3,
  51. "\xf0" => 4, "\xf1" => 4, "\xf2" => 4, "\xf3" => 4, "\xf4" => 4, "\xf5" => 4, "\xf6" => 4, "\xf7" => 4,
  52. "\xf8" => 5, "\xf9" => 5, "\xfa" => 5, "\xfb" => 5, "\xfc" => 6, "\xfd" => 6, "\xfe" => 0, "\xff" => 0,
  53. ];
  54. private $data = '';
  55. private $dataSize = 0;
  56. private $map = [];
  57. private $charCount = 0;
  58. private $currentPos = 0;
  59. private $fixedWidth = 0;
  60. /**
  61. * @param resource|string $input
  62. */
  63. public function __construct($input, ?string $charset = 'utf-8')
  64. {
  65. $charset = strtolower(trim($charset)) ?: 'utf-8';
  66. if ('utf-8' === $charset || 'utf8' === $charset) {
  67. $this->fixedWidth = 0;
  68. $this->map = ['p' => [], 'i' => []];
  69. } else {
  70. switch ($charset) {
  71. // 16 bits
  72. case 'ucs2':
  73. case 'ucs-2':
  74. case 'utf16':
  75. case 'utf-16':
  76. $this->fixedWidth = 2;
  77. break;
  78. // 32 bits
  79. case 'ucs4':
  80. case 'ucs-4':
  81. case 'utf32':
  82. case 'utf-32':
  83. $this->fixedWidth = 4;
  84. break;
  85. // 7-8 bit charsets: (us-)?ascii, (iso|iec)-?8859-?[0-9]+, windows-?125[0-9], cp-?[0-9]+, ansi, macintosh,
  86. // koi-?7, koi-?8-?.+, mik, (cork|t1), v?iscii
  87. // and fallback
  88. default:
  89. $this->fixedWidth = 1;
  90. }
  91. }
  92. if (\is_resource($input)) {
  93. $blocks = 512;
  94. if (stream_get_meta_data($input)['seekable'] ?? false) {
  95. rewind($input);
  96. }
  97. while (false !== $read = fread($input, $blocks)) {
  98. $this->write($read);
  99. }
  100. } else {
  101. $this->write($input);
  102. }
  103. }
  104. public function read(int $length): ?string
  105. {
  106. if ($this->currentPos >= $this->charCount) {
  107. return null;
  108. }
  109. $length = ($this->currentPos + $length > $this->charCount) ? $this->charCount - $this->currentPos : $length;
  110. if ($this->fixedWidth > 0) {
  111. $len = $length * $this->fixedWidth;
  112. $ret = substr($this->data, $this->currentPos * $this->fixedWidth, $len);
  113. $this->currentPos += $length;
  114. } else {
  115. $end = $this->currentPos + $length;
  116. $end = $end > $this->charCount ? $this->charCount : $end;
  117. $ret = '';
  118. $start = 0;
  119. if ($this->currentPos > 0) {
  120. $start = $this->map['p'][$this->currentPos - 1];
  121. }
  122. $to = $start;
  123. for (; $this->currentPos < $end; ++$this->currentPos) {
  124. if (isset($this->map['i'][$this->currentPos])) {
  125. $ret .= substr($this->data, $start, $to - $start).'?';
  126. $start = $this->map['p'][$this->currentPos];
  127. } else {
  128. $to = $this->map['p'][$this->currentPos];
  129. }
  130. }
  131. $ret .= substr($this->data, $start, $to - $start);
  132. }
  133. return $ret;
  134. }
  135. public function readBytes(int $length): ?array
  136. {
  137. if (null !== $read = $this->read($length)) {
  138. return array_map('ord', str_split($read, 1));
  139. }
  140. return null;
  141. }
  142. public function setPointer(int $charOffset): void
  143. {
  144. if ($this->charCount < $charOffset) {
  145. $charOffset = $this->charCount;
  146. }
  147. $this->currentPos = $charOffset;
  148. }
  149. public function write(string $chars): void
  150. {
  151. $ignored = '';
  152. $this->data .= $chars;
  153. if ($this->fixedWidth > 0) {
  154. $strlen = \strlen($chars);
  155. $ignoredL = $strlen % $this->fixedWidth;
  156. $ignored = $ignoredL ? substr($chars, -$ignoredL) : '';
  157. $this->charCount += ($strlen - $ignoredL) / $this->fixedWidth;
  158. } else {
  159. $this->charCount += $this->getUtf8CharPositions($chars, $this->dataSize, $ignored);
  160. }
  161. $this->dataSize = \strlen($this->data) - \strlen($ignored);
  162. }
  163. private function getUtf8CharPositions(string $string, int $startOffset, string &$ignoredChars): int
  164. {
  165. $strlen = \strlen($string);
  166. $charPos = \count($this->map['p']);
  167. $foundChars = 0;
  168. $invalid = false;
  169. for ($i = 0; $i < $strlen; ++$i) {
  170. $char = $string[$i];
  171. $size = self::UTF8_LENGTH_MAP[$char];
  172. if (0 == $size) {
  173. /* char is invalid, we must wait for a resync */
  174. $invalid = true;
  175. continue;
  176. }
  177. if ($invalid) {
  178. /* We mark the chars as invalid and start a new char */
  179. $this->map['p'][$charPos + $foundChars] = $startOffset + $i;
  180. $this->map['i'][$charPos + $foundChars] = true;
  181. ++$foundChars;
  182. $invalid = false;
  183. }
  184. if (($i + $size) > $strlen) {
  185. $ignoredChars = substr($string, $i);
  186. break;
  187. }
  188. for ($j = 1; $j < $size; ++$j) {
  189. $char = $string[$i + $j];
  190. if ($char > "\x7F" && $char < "\xC0") {
  191. // Valid - continue parsing
  192. } else {
  193. /* char is invalid, we must wait for a resync */
  194. $invalid = true;
  195. continue 2;
  196. }
  197. }
  198. /* Ok we got a complete char here */
  199. $this->map['p'][$charPos + $foundChars] = $startOffset + $i + $size;
  200. $i += $j - 1;
  201. ++$foundChars;
  202. }
  203. return $foundChars;
  204. }
  205. }