PageRenderTime 25ms CodeModel.GetById 2ms app.highlight 18ms RepoModel.GetById 1ms app.codeStats 0ms

/framework/vendor/swift/lib/classes/Swift/Encoder/QpEncoder.php

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