|
TYPO3 API
SVNRelease
|
00001 <?php 00002 00003 /* 00004 * This file is part of SwiftMailer. 00005 * (c) 2004-2009 Chris Corbyn 00006 * 00007 * For the full copyright and license information, please view the LICENSE 00008 * file that was distributed with this source code. 00009 */ 00010 00011 //@require 'Swift/Encoder.php'; 00012 //@require 'Swift/CharacterStream.php'; 00013 00014 /** 00015 * Handles Quoted Printable (QP) Encoding in Swift Mailer. 00016 * Possibly the most accurate RFC 2045 QP implementation found in PHP. 00017 * @package Swift 00018 * @subpackage Encoder 00019 * @author Chris Corbyn 00020 */ 00021 class Swift_Encoder_QpEncoder implements Swift_Encoder 00022 { 00023 00024 /** 00025 * The CharacterStream used for reading characters (as opposed to bytes). 00026 * @var Swift_CharacterStream 00027 * @access protected 00028 */ 00029 protected $_charStream; 00030 00031 /** 00032 * A filter used if input should be canonicalized. 00033 * @var Swift_StreamFilter 00034 * @access protected 00035 */ 00036 protected $_filter; 00037 00038 /** 00039 * Pre-computed QP for HUGE optmization. 00040 * @var string[] 00041 * @access protected 00042 */ 00043 protected static $_qpMap = array( 00044 0 => '=00', 1 => '=01', 2 => '=02', 3 => '=03', 4 => '=04', 00045 5 => '=05', 6 => '=06', 7 => '=07', 8 => '=08', 9 => '=09', 00046 10 => '=0A', 11 => '=0B', 12 => '=0C', 13 => '=0D', 14 => '=0E', 00047 15 => '=0F', 16 => '=10', 17 => '=11', 18 => '=12', 19 => '=13', 00048 20 => '=14', 21 => '=15', 22 => '=16', 23 => '=17', 24 => '=18', 00049 25 => '=19', 26 => '=1A', 27 => '=1B', 28 => '=1C', 29 => '=1D', 00050 30 => '=1E', 31 => '=1F', 32 => '=20', 33 => '=21', 34 => '=22', 00051 35 => '=23', 36 => '=24', 37 => '=25', 38 => '=26', 39 => '=27', 00052 40 => '=28', 41 => '=29', 42 => '=2A', 43 => '=2B', 44 => '=2C', 00053 45 => '=2D', 46 => '=2E', 47 => '=2F', 48 => '=30', 49 => '=31', 00054 50 => '=32', 51 => '=33', 52 => '=34', 53 => '=35', 54 => '=36', 00055 55 => '=37', 56 => '=38', 57 => '=39', 58 => '=3A', 59 => '=3B', 00056 60 => '=3C', 61 => '=3D', 62 => '=3E', 63 => '=3F', 64 => '=40', 00057 65 => '=41', 66 => '=42', 67 => '=43', 68 => '=44', 69 => '=45', 00058 70 => '=46', 71 => '=47', 72 => '=48', 73 => '=49', 74 => '=4A', 00059 75 => '=4B', 76 => '=4C', 77 => '=4D', 78 => '=4E', 79 => '=4F', 00060 80 => '=50', 81 => '=51', 82 => '=52', 83 => '=53', 84 => '=54', 00061 85 => '=55', 86 => '=56', 87 => '=57', 88 => '=58', 89 => '=59', 00062 90 => '=5A', 91 => '=5B', 92 => '=5C', 93 => '=5D', 94 => '=5E', 00063 95 => '=5F', 96 => '=60', 97 => '=61', 98 => '=62', 99 => '=63', 00064 100 => '=64', 101 => '=65', 102 => '=66', 103 => '=67', 104 => '=68', 00065 105 => '=69', 106 => '=6A', 107 => '=6B', 108 => '=6C', 109 => '=6D', 00066 110 => '=6E', 111 => '=6F', 112 => '=70', 113 => '=71', 114 => '=72', 00067 115 => '=73', 116 => '=74', 117 => '=75', 118 => '=76', 119 => '=77', 00068 120 => '=78', 121 => '=79', 122 => '=7A', 123 => '=7B', 124 => '=7C', 00069 125 => '=7D', 126 => '=7E', 127 => '=7F', 128 => '=80', 129 => '=81', 00070 130 => '=82', 131 => '=83', 132 => '=84', 133 => '=85', 134 => '=86', 00071 135 => '=87', 136 => '=88', 137 => '=89', 138 => '=8A', 139 => '=8B', 00072 140 => '=8C', 141 => '=8D', 142 => '=8E', 143 => '=8F', 144 => '=90', 00073 145 => '=91', 146 => '=92', 147 => '=93', 148 => '=94', 149 => '=95', 00074 150 => '=96', 151 => '=97', 152 => '=98', 153 => '=99', 154 => '=9A', 00075 155 => '=9B', 156 => '=9C', 157 => '=9D', 158 => '=9E', 159 => '=9F', 00076 160 => '=A0', 161 => '=A1', 162 => '=A2', 163 => '=A3', 164 => '=A4', 00077 165 => '=A5', 166 => '=A6', 167 => '=A7', 168 => '=A8', 169 => '=A9', 00078 170 => '=AA', 171 => '=AB', 172 => '=AC', 173 => '=AD', 174 => '=AE', 00079 175 => '=AF', 176 => '=B0', 177 => '=B1', 178 => '=B2', 179 => '=B3', 00080 180 => '=B4', 181 => '=B5', 182 => '=B6', 183 => '=B7', 184 => '=B8', 00081 185 => '=B9', 186 => '=BA', 187 => '=BB', 188 => '=BC', 189 => '=BD', 00082 190 => '=BE', 191 => '=BF', 192 => '=C0', 193 => '=C1', 194 => '=C2', 00083 195 => '=C3', 196 => '=C4', 197 => '=C5', 198 => '=C6', 199 => '=C7', 00084 200 => '=C8', 201 => '=C9', 202 => '=CA', 203 => '=CB', 204 => '=CC', 00085 205 => '=CD', 206 => '=CE', 207 => '=CF', 208 => '=D0', 209 => '=D1', 00086 210 => '=D2', 211 => '=D3', 212 => '=D4', 213 => '=D5', 214 => '=D6', 00087 215 => '=D7', 216 => '=D8', 217 => '=D9', 218 => '=DA', 219 => '=DB', 00088 220 => '=DC', 221 => '=DD', 222 => '=DE', 223 => '=DF', 224 => '=E0', 00089 225 => '=E1', 226 => '=E2', 227 => '=E3', 228 => '=E4', 229 => '=E5', 00090 230 => '=E6', 231 => '=E7', 232 => '=E8', 233 => '=E9', 234 => '=EA', 00091 235 => '=EB', 236 => '=EC', 237 => '=ED', 238 => '=EE', 239 => '=EF', 00092 240 => '=F0', 241 => '=F1', 242 => '=F2', 243 => '=F3', 244 => '=F4', 00093 245 => '=F5', 246 => '=F6', 247 => '=F7', 248 => '=F8', 249 => '=F9', 00094 250 => '=FA', 251 => '=FB', 252 => '=FC', 253 => '=FD', 254 => '=FE', 00095 255 => '=FF' 00096 ); 00097 00098 /** 00099 * A map of non-encoded ascii characters. 00100 * @var string[] 00101 * @access protected 00102 */ 00103 protected static $_safeMap = array(); 00104 00105 /** 00106 * Creates a new QpEncoder for the given CharacterStream. 00107 * @param Swift_CharacterStream $charStream to use for reading characters 00108 * @param Swift_StreamFilter $filter if input should be canonicalized 00109 */ 00110 public function __construct(Swift_CharacterStream $charStream, 00111 Swift_StreamFilter $filter = null) 00112 { 00113 $this->_charStream = $charStream; 00114 if (empty(self::$_safeMap)) 00115 { 00116 foreach (array_merge( 00117 array(0x09, 0x20), range(0x21, 0x3C), range(0x3E, 0x7E)) as $byte) 00118 { 00119 self::$_safeMap[$byte] = chr($byte); 00120 } 00121 } 00122 $this->_filter = $filter; 00123 } 00124 00125 /** 00126 * Takes an unencoded string and produces a QP encoded string from it. 00127 * QP encoded strings have a maximum line length of 76 characters. 00128 * If the first line needs to be shorter, indicate the difference with 00129 * $firstLineOffset. 00130 * @param string $string to encode 00131 * @param int $firstLineOffset, optional 00132 * @param int $maxLineLength, optional, 0 indicates the default of 76 chars 00133 * @return string 00134 */ 00135 public function encodeString($string, $firstLineOffset = 0, 00136 $maxLineLength = 0) 00137 { 00138 if ($maxLineLength > 76 || $maxLineLength <= 0) 00139 { 00140 $maxLineLength = 76; 00141 } 00142 00143 $thisLineLength = $maxLineLength - $firstLineOffset; 00144 00145 $lines = array(); 00146 $lNo = 0; 00147 $lines[$lNo] = ''; 00148 $currentLine =& $lines[$lNo++]; 00149 $size=$lineLen=0; 00150 00151 $this->_charStream->flushContents(); 00152 $this->_charStream->importString($string); 00153 00154 //Fetching more than 4 chars at one is slower, as is fetching fewer bytes 00155 // Conveniently 4 chars is the UTF-8 safe number since UTF-8 has up to 6 00156 // bytes per char and (6 * 4 * 3 = 72 chars per line) * =NN is 3 bytes 00157 while (false !== $bytes = $this->_nextSequence()) 00158 { 00159 //If we're filtering the input 00160 if (isset($this->_filter)) 00161 { 00162 //If we can't filter because we need more bytes 00163 while ($this->_filter->shouldBuffer($bytes)) 00164 { 00165 //Then collect bytes into the buffer 00166 if (false === $moreBytes = $this->_nextSequence(1)) 00167 { 00168 break; 00169 } 00170 00171 foreach ($moreBytes as $b) 00172 { 00173 $bytes[] = $b; 00174 } 00175 } 00176 //And filter them 00177 $bytes = $this->_filter->filter($bytes); 00178 } 00179 00180 $enc = $this->_encodeByteSequence($bytes, $size); 00181 if ($currentLine && $lineLen+$size >= $thisLineLength) 00182 { 00183 $lines[$lNo] = ''; 00184 $currentLine =& $lines[$lNo++]; 00185 $thisLineLength = $maxLineLength; 00186 $lineLen=0; 00187 } 00188 $lineLen+=$size; 00189 $currentLine .= $enc; 00190 } 00191 00192 return $this->_standardize(implode("=\r\n", $lines)); 00193 } 00194 00195 /** 00196 * Updates the charset used. 00197 * @param string $charset 00198 */ 00199 public function charsetChanged($charset) 00200 { 00201 $this->_charStream->setCharacterSet($charset); 00202 } 00203 00204 // -- Protected methods 00205 00206 /** 00207 * Encode the given byte array into a verbatim QP form. 00208 * @param int[] $bytes 00209 * @return string 00210 * @access protected 00211 */ 00212 protected function _encodeByteSequence(array $bytes, &$size) 00213 { 00214 $ret = ''; 00215 $size=0; 00216 foreach ($bytes as $b) 00217 { 00218 if (isset(self::$_safeMap[$b])) 00219 { 00220 $ret .= self::$_safeMap[$b]; 00221 ++$size; 00222 } 00223 else 00224 { 00225 $ret .= self::$_qpMap[$b]; 00226 $size+=3; 00227 } 00228 } 00229 return $ret; 00230 } 00231 00232 /** 00233 * Get the next sequence of bytes to read from the char stream. 00234 * @param int $size number of bytes to read 00235 * @return int[] 00236 * @access protected 00237 */ 00238 protected function _nextSequence($size = 4) 00239 { 00240 return $this->_charStream->readBytes($size); 00241 } 00242 00243 /** 00244 * Make sure CRLF is correct and HT/SPACE are in valid places. 00245 * @param string $string 00246 * @return string 00247 * @access protected 00248 */ 00249 protected function _standardize($string) 00250 { 00251 $string = str_replace(array("\t=0D=0A", " =0D=0A", "=0D=0A"), 00252 array("=09\r\n", "=20\r\n", "\r\n"), $string 00253 ); 00254 switch ($end = ord(substr($string, -1))) 00255 { 00256 case 0x09: 00257 case 0x20: 00258 $string = substr_replace($string, self::$_qpMap[$end], -1); 00259 } 00260 return $string; 00261 } 00262 00263 }
1.8.0