|
1 <?php |
|
2 |
|
3 /* |
|
4 * This file is part of SwiftMailer. |
|
5 * (c) 2004-2009 Chris Corbyn |
|
6 * |
|
7 * For the full copyright and license information, please view the LICENSE |
|
8 * file that was distributed with this source code. |
|
9 */ |
|
10 |
|
11 |
|
12 /** |
|
13 * Handles Quoted Printable (QP) Encoding in Swift Mailer. |
|
14 * Possibly the most accurate RFC 2045 QP implementation found in PHP. |
|
15 * @package Swift |
|
16 * @subpackage Encoder |
|
17 * @author Chris Corbyn |
|
18 */ |
|
19 class Swift_Encoder_QpEncoder implements Swift_Encoder |
|
20 { |
|
21 |
|
22 /** |
|
23 * The CharacterStream used for reading characters (as opposed to bytes). |
|
24 * @var Swift_CharacterStream |
|
25 * @access protected |
|
26 */ |
|
27 protected $_charStream; |
|
28 |
|
29 /** |
|
30 * A filter used if input should be canonicalized. |
|
31 * @var Swift_StreamFilter |
|
32 * @access protected |
|
33 */ |
|
34 protected $_filter; |
|
35 |
|
36 /** |
|
37 * Pre-computed QP for HUGE optmization. |
|
38 * @var string[] |
|
39 * @access protected |
|
40 */ |
|
41 protected $_qpMap = array( |
|
42 0 => '=00', 1 => '=01', 2 => '=02', 3 => '=03', 4 => '=04', |
|
43 5 => '=05', 6 => '=06', 7 => '=07', 8 => '=08', 9 => '=09', |
|
44 10 => '=0A', 11 => '=0B', 12 => '=0C', 13 => '=0D', 14 => '=0E', |
|
45 15 => '=0F', 16 => '=10', 17 => '=11', 18 => '=12', 19 => '=13', |
|
46 20 => '=14', 21 => '=15', 22 => '=16', 23 => '=17', 24 => '=18', |
|
47 25 => '=19', 26 => '=1A', 27 => '=1B', 28 => '=1C', 29 => '=1D', |
|
48 30 => '=1E', 31 => '=1F', 32 => '=20', 33 => '=21', 34 => '=22', |
|
49 35 => '=23', 36 => '=24', 37 => '=25', 38 => '=26', 39 => '=27', |
|
50 40 => '=28', 41 => '=29', 42 => '=2A', 43 => '=2B', 44 => '=2C', |
|
51 45 => '=2D', 46 => '=2E', 47 => '=2F', 48 => '=30', 49 => '=31', |
|
52 50 => '=32', 51 => '=33', 52 => '=34', 53 => '=35', 54 => '=36', |
|
53 55 => '=37', 56 => '=38', 57 => '=39', 58 => '=3A', 59 => '=3B', |
|
54 60 => '=3C', 61 => '=3D', 62 => '=3E', 63 => '=3F', 64 => '=40', |
|
55 65 => '=41', 66 => '=42', 67 => '=43', 68 => '=44', 69 => '=45', |
|
56 70 => '=46', 71 => '=47', 72 => '=48', 73 => '=49', 74 => '=4A', |
|
57 75 => '=4B', 76 => '=4C', 77 => '=4D', 78 => '=4E', 79 => '=4F', |
|
58 80 => '=50', 81 => '=51', 82 => '=52', 83 => '=53', 84 => '=54', |
|
59 85 => '=55', 86 => '=56', 87 => '=57', 88 => '=58', 89 => '=59', |
|
60 90 => '=5A', 91 => '=5B', 92 => '=5C', 93 => '=5D', 94 => '=5E', |
|
61 95 => '=5F', 96 => '=60', 97 => '=61', 98 => '=62', 99 => '=63', |
|
62 100 => '=64', 101 => '=65', 102 => '=66', 103 => '=67', 104 => '=68', |
|
63 105 => '=69', 106 => '=6A', 107 => '=6B', 108 => '=6C', 109 => '=6D', |
|
64 110 => '=6E', 111 => '=6F', 112 => '=70', 113 => '=71', 114 => '=72', |
|
65 115 => '=73', 116 => '=74', 117 => '=75', 118 => '=76', 119 => '=77', |
|
66 120 => '=78', 121 => '=79', 122 => '=7A', 123 => '=7B', 124 => '=7C', |
|
67 125 => '=7D', 126 => '=7E', 127 => '=7F', 128 => '=80', 129 => '=81', |
|
68 130 => '=82', 131 => '=83', 132 => '=84', 133 => '=85', 134 => '=86', |
|
69 135 => '=87', 136 => '=88', 137 => '=89', 138 => '=8A', 139 => '=8B', |
|
70 140 => '=8C', 141 => '=8D', 142 => '=8E', 143 => '=8F', 144 => '=90', |
|
71 145 => '=91', 146 => '=92', 147 => '=93', 148 => '=94', 149 => '=95', |
|
72 150 => '=96', 151 => '=97', 152 => '=98', 153 => '=99', 154 => '=9A', |
|
73 155 => '=9B', 156 => '=9C', 157 => '=9D', 158 => '=9E', 159 => '=9F', |
|
74 160 => '=A0', 161 => '=A1', 162 => '=A2', 163 => '=A3', 164 => '=A4', |
|
75 165 => '=A5', 166 => '=A6', 167 => '=A7', 168 => '=A8', 169 => '=A9', |
|
76 170 => '=AA', 171 => '=AB', 172 => '=AC', 173 => '=AD', 174 => '=AE', |
|
77 175 => '=AF', 176 => '=B0', 177 => '=B1', 178 => '=B2', 179 => '=B3', |
|
78 180 => '=B4', 181 => '=B5', 182 => '=B6', 183 => '=B7', 184 => '=B8', |
|
79 185 => '=B9', 186 => '=BA', 187 => '=BB', 188 => '=BC', 189 => '=BD', |
|
80 190 => '=BE', 191 => '=BF', 192 => '=C0', 193 => '=C1', 194 => '=C2', |
|
81 195 => '=C3', 196 => '=C4', 197 => '=C5', 198 => '=C6', 199 => '=C7', |
|
82 200 => '=C8', 201 => '=C9', 202 => '=CA', 203 => '=CB', 204 => '=CC', |
|
83 205 => '=CD', 206 => '=CE', 207 => '=CF', 208 => '=D0', 209 => '=D1', |
|
84 210 => '=D2', 211 => '=D3', 212 => '=D4', 213 => '=D5', 214 => '=D6', |
|
85 215 => '=D7', 216 => '=D8', 217 => '=D9', 218 => '=DA', 219 => '=DB', |
|
86 220 => '=DC', 221 => '=DD', 222 => '=DE', 223 => '=DF', 224 => '=E0', |
|
87 225 => '=E1', 226 => '=E2', 227 => '=E3', 228 => '=E4', 229 => '=E5', |
|
88 230 => '=E6', 231 => '=E7', 232 => '=E8', 233 => '=E9', 234 => '=EA', |
|
89 235 => '=EB', 236 => '=EC', 237 => '=ED', 238 => '=EE', 239 => '=EF', |
|
90 240 => '=F0', 241 => '=F1', 242 => '=F2', 243 => '=F3', 244 => '=F4', |
|
91 245 => '=F5', 246 => '=F6', 247 => '=F7', 248 => '=F8', 249 => '=F9', |
|
92 250 => '=FA', 251 => '=FB', 252 => '=FC', 253 => '=FD', 254 => '=FE', |
|
93 255 => '=FF' |
|
94 ); |
|
95 |
|
96 /** |
|
97 * A map of non-encoded ascii characters. |
|
98 * @var string[] |
|
99 * @access protected |
|
100 */ |
|
101 protected $_safeMap = array(); |
|
102 |
|
103 /** |
|
104 * Creates a new QpEncoder for the given CharacterStream. |
|
105 * @param Swift_CharacterStream $charStream to use for reading characters |
|
106 * @param Swift_StreamFilter $filter if input should be canonicalized |
|
107 */ |
|
108 public function __construct(Swift_CharacterStream $charStream, |
|
109 Swift_StreamFilter $filter = null) |
|
110 { |
|
111 $this->_charStream = $charStream; |
|
112 foreach (array_merge( |
|
113 array(0x09, 0x20), range(0x21, 0x3C), range(0x3E, 0x7E)) as $byte) |
|
114 { |
|
115 $this->_safeMap[$byte] = chr($byte); |
|
116 } |
|
117 $this->_filter = $filter; |
|
118 } |
|
119 |
|
120 /** |
|
121 * Takes an unencoded string and produces a QP encoded string from it. |
|
122 * QP encoded strings have a maximum line length of 76 characters. |
|
123 * If the first line needs to be shorter, indicate the difference with |
|
124 * $firstLineOffset. |
|
125 * @param string $string to encode |
|
126 * @param int $firstLineOffset, optional |
|
127 * @param int $maxLineLength, optional, 0 indicates the default of 76 chars |
|
128 * @return string |
|
129 */ |
|
130 public function encodeString($string, $firstLineOffset = 0, |
|
131 $maxLineLength = 0) |
|
132 { |
|
133 if ($maxLineLength > 76 || $maxLineLength <= 0) |
|
134 { |
|
135 $maxLineLength = 76; |
|
136 } |
|
137 |
|
138 $thisLineLength = $maxLineLength - $firstLineOffset; |
|
139 |
|
140 $lines = array(); |
|
141 $lNo = 0; |
|
142 $lines[$lNo] = ''; |
|
143 $currentLine =& $lines[$lNo++]; |
|
144 $size=$lineLen=0; |
|
145 |
|
146 $this->_charStream->flushContents(); |
|
147 $this->_charStream->importString($string); |
|
148 |
|
149 //Fetching more than 4 chars at one is slower, as is fetching fewer bytes |
|
150 // Conveniently 4 chars is the UTF-8 safe number since UTF-8 has up to 6 |
|
151 // bytes per char and (6 * 4 * 3 = 72 chars per line) * =NN is 3 bytes |
|
152 while (false !== $bytes = $this->_nextSequence()) |
|
153 { |
|
154 //If we're filtering the input |
|
155 if (isset($this->_filter)) |
|
156 { |
|
157 //If we can't filter because we need more bytes |
|
158 while ($this->_filter->shouldBuffer($bytes)) |
|
159 { |
|
160 //Then collect bytes into the buffer |
|
161 if (false === $moreBytes = $this->_nextSequence(1)) |
|
162 { |
|
163 break; |
|
164 } |
|
165 |
|
166 foreach ($moreBytes as $b) |
|
167 { |
|
168 $bytes[] = $b; |
|
169 } |
|
170 } |
|
171 //And filter them |
|
172 $bytes = $this->_filter->filter($bytes); |
|
173 } |
|
174 |
|
175 $enc = $this->_encodeByteSequence($bytes, $size); |
|
176 if ($currentLine && $lineLen+$size >= $thisLineLength) |
|
177 { |
|
178 $lines[$lNo] = ''; |
|
179 $currentLine =& $lines[$lNo++]; |
|
180 $thisLineLength = $maxLineLength; |
|
181 $lineLen=0; |
|
182 } |
|
183 $lineLen+=$size; |
|
184 $currentLine .= $enc; |
|
185 } |
|
186 |
|
187 return $this->_standardize(implode("=\r\n", $lines)); |
|
188 } |
|
189 |
|
190 /** |
|
191 * Updates the charset used. |
|
192 * @param string $charset |
|
193 */ |
|
194 public function charsetChanged($charset) |
|
195 { |
|
196 $this->_charStream->setCharacterSet($charset); |
|
197 } |
|
198 |
|
199 // -- Protected methods |
|
200 |
|
201 /** |
|
202 * Encode the given byte array into a verbatim QP form. |
|
203 * @param int[] $bytes |
|
204 * @return string |
|
205 * @access protected |
|
206 */ |
|
207 protected function _encodeByteSequence(array $bytes, &$size) |
|
208 { |
|
209 $ret = ''; |
|
210 $size=0; |
|
211 foreach ($bytes as $b) |
|
212 { |
|
213 if (isset($this->_safeMap[$b])) |
|
214 { |
|
215 $ret .= $this->_safeMap[$b]; |
|
216 ++$size; |
|
217 } |
|
218 else |
|
219 { |
|
220 $ret .= $this->_qpMap[$b]; |
|
221 $size+=3; |
|
222 } |
|
223 } |
|
224 return $ret; |
|
225 } |
|
226 |
|
227 /** |
|
228 * Get the next sequence of bytes to read from the char stream. |
|
229 * @param int $size number of bytes to read |
|
230 * @return int[] |
|
231 * @access protected |
|
232 */ |
|
233 protected function _nextSequence($size = 4) |
|
234 { |
|
235 return $this->_charStream->readBytes($size); |
|
236 } |
|
237 |
|
238 /** |
|
239 * Make sure CRLF is correct and HT/SPACE are in valid places. |
|
240 * @param string $string |
|
241 * @return string |
|
242 * @access protected |
|
243 */ |
|
244 protected function _standardize($string) |
|
245 { |
|
246 $string = str_replace(array("\t=0D=0A", " =0D=0A", "=0D=0A"), |
|
247 array("=09\r\n", "=20\r\n", "\r\n"), $string |
|
248 ); |
|
249 switch ($end = ord(substr($string, -1))) |
|
250 { |
|
251 case 0x09: |
|
252 case 0x20: |
|
253 $string = substr_replace($string, $this->_qpMap[$end], -1); |
|
254 } |
|
255 return $string; |
|
256 } |
|
257 |
|
258 } |