Classes List

Swift_Encoder_QpEncoder

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
 277 
 278 
 279 
 280 
 281 
 282 
 283 
 284 
 285 
 286 
 287 
 288 
 289 
 290 
 291 
 292 
 293 
 294 
 295 
 296 
 297 
 298 
 299 
 300 
 301 
<?php

/* * This file is part of SwiftMailer. * (c) 2004-2009 Chris Corbyn * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * Handles Quoted Printable (QP) Encoding in Swift Mailer. * * Possibly the most accurate RFC 2045 QP implementation found in PHP. * * @author Chris Corbyn */
class Swift_Encoder_QpEncoder implements Swift_Encoder
{
    /** * The CharacterStream used for reading characters (as opposed to bytes). * * @var Swift_CharacterStream */
    protected $charStream;

    /** * A filter used if input should be canonicalized. * * @var Swift_StreamFilter */
    protected $filter;

    /** * Pre-computed QP for HUGE optimization. * * @var string[] */
    protected static $qpMap = [
        0 => '=00'1 => '=01'2 => '=02'3 => '=03'4 => '=04',
        5 => '=05'6 => '=06'7 => '=07'8 => '=08'9 => '=09',
        10 => '=0A'11 => '=0B'12 => '=0C'13 => '=0D'14 => '=0E',
        15 => '=0F'16 => '=10'17 => '=11'18 => '=12'19 => '=13',
        20 => '=14'21 => '=15'22 => '=16'23 => '=17'24 => '=18',
        25 => '=19'26 => '=1A'27 => '=1B'28 => '=1C'29 => '=1D',
        30 => '=1E'31 => '=1F'32 => '=20'33 => '=21'34 => '=22',
        35 => '=23'36 => '=24'37 => '=25'38 => '=26'39 => '=27',
        40 => '=28'41 => '=29'42 => '=2A'43 => '=2B'44 => '=2C',
        45 => '=2D'46 => '=2E'47 => '=2F'48 => '=30'49 => '=31',
        50 => '=32'51 => '=33'52 => '=34'53 => '=35'54 => '=36',
        55 => '=37'56 => '=38'57 => '=39'58 => '=3A'59 => '=3B',
        60 => '=3C'61 => '=3D'62 => '=3E'63 => '=3F'64 => '=40',
        65 => '=41'66 => '=42'67 => '=43'68 => '=44'69 => '=45',
        70 => '=46'71 => '=47'72 => '=48'73 => '=49'74 => '=4A',
        75 => '=4B'76 => '=4C'77 => '=4D'78 => '=4E'79 => '=4F',
        80 => '=50'81 => '=51'82 => '=52'83 => '=53'84 => '=54',
        85 => '=55'86 => '=56'87 => '=57'88 => '=58'89 => '=59',
        90 => '=5A'91 => '=5B'92 => '=5C'93 => '=5D'94 => '=5E',
        95 => '=5F'96 => '=60'97 => '=61'98 => '=62'99 => '=63',
        100 => '=64'101 => '=65'102 => '=66'103 => '=67'104 => '=68',
        105 => '=69'106 => '=6A'107 => '=6B'108 => '=6C'109 => '=6D',
        110 => '=6E'111 => '=6F'112 => '=70'113 => '=71'114 => '=72',
        115 => '=73'116 => '=74'117 => '=75'118 => '=76'119 => '=77',
        120 => '=78'121 => '=79'122 => '=7A'123 => '=7B'124 => '=7C',
        125 => '=7D'126 => '=7E'127 => '=7F'128 => '=80'129 => '=81',
        130 => '=82'131 => '=83'132 => '=84'133 => '=85'134 => '=86',
        135 => '=87'136 => '=88'137 => '=89'138 => '=8A'139 => '=8B',
        140 => '=8C'141 => '=8D'142 => '=8E'143 => '=8F'144 => '=90',
        145 => '=91'146 => '=92'147 => '=93'148 => '=94'149 => '=95',
        150 => '=96'151 => '=97'152 => '=98'153 => '=99'154 => '=9A',
        155 => '=9B'156 => '=9C'157 => '=9D'158 => '=9E'159 => '=9F',
        160 => '=A0'161 => '=A1'162 => '=A2'163 => '=A3'164 => '=A4',
        165 => '=A5'166 => '=A6'167 => '=A7'168 => '=A8'169 => '=A9',
        170 => '=AA'171 => '=AB'172 => '=AC'173 => '=AD'174 => '=AE',
        175 => '=AF'176 => '=B0'177 => '=B1'178 => '=B2'179 => '=B3',
        180 => '=B4'181 => '=B5'182 => '=B6'183 => '=B7'184 => '=B8',
        185 => '=B9'186 => '=BA'187 => '=BB'188 => '=BC'189 => '=BD',
        190 => '=BE'191 => '=BF'192 => '=C0'193 => '=C1'194 => '=C2',
        195 => '=C3'196 => '=C4'197 => '=C5'198 => '=C6'199 => '=C7',
        200 => '=C8'201 => '=C9'202 => '=CA'203 => '=CB'204 => '=CC',
        205 => '=CD'206 => '=CE'207 => '=CF'208 => '=D0'209 => '=D1',
        210 => '=D2'211 => '=D3'212 => '=D4'213 => '=D5'214 => '=D6',
        215 => '=D7'216 => '=D8'217 => '=D9'218 => '=DA'219 => '=DB',
        220 => '=DC'221 => '=DD'222 => '=DE'223 => '=DF'224 => '=E0',
        225 => '=E1'226 => '=E2'227 => '=E3'228 => '=E4'229 => '=E5',
        230 => '=E6'231 => '=E7'232 => '=E8'233 => '=E9'234 => '=EA',
        235 => '=EB'236 => '=EC'237 => '=ED'238 => '=EE'239 => '=EF',
        240 => '=F0'241 => '=F1'242 => '=F2'243 => '=F3'244 => '=F4',
        245 => '=F5'246 => '=F6'247 => '=F7'248 => '=F8'249 => '=F9',
        250 => '=FA'251 => '=FB'252 => '=FC'253 => '=FD'254 => '=FE',
        255 => '=FF',
        ];

    protected static $safeMapShare = [];

    /** * A map of non-encoded ascii characters. * * @var string[] */
    protected $safeMap = [];

    /** * Creates a new QpEncoder for the given CharacterStream. * * @param Swift_CharacterStream $charStream to use for reading characters * @param Swift_StreamFilter $filter if input should be canonicalized */
    public function __construct(Swift_CharacterStream $charStreamSwift_StreamFilter $filter = null)
    {
        $this->charStream = $charStream;
        if (!isset(self::$safeMapShare[$this->getSafeMapShareId()])) {
            $this->initSafeMap();
            self::$safeMapShare[$this->getSafeMapShareId()] = $this->safeMap;
        } else {
            $this->safeMap = self::$safeMapShare[$this->getSafeMapShareId()];
        }
        $this->filter = $filter;
    }

    public function __sleep()
    {
        return ['charStream''filter'];
    }

    public function __wakeup()
    {
        if (!isset(self::$safeMapShare[$this->getSafeMapShareId()])) {
            $this->initSafeMap();
            self::$safeMapShare[$this->getSafeMapShareId()] = $this->safeMap;
        } else {
            $this->safeMap = self::$safeMapShare[$this->getSafeMapShareId()];
        }
    }

    protected function getSafeMapShareId()
    {
        return static::class;
    }

    protected function initSafeMap()
    {
        foreach (array_merge(
            [0x090x20], range(0x210x3C), range(0x3E0x7E)) as $byte) {
            $this->safeMap[$byte] = chr($byte);
        }
    }

    /** * Takes an unencoded string and produces a QP encoded string from it. * * QP encoded strings have a maximum line length of 76 characters. * If the first line needs to be shorter, indicate the difference with * $firstLineOffset. * * @param string $string to encode * @param int $firstLineOffset optional * @param int $maxLineLength optional 0 indicates the default of 76 chars * * @return string */
    public function encodeString($string$firstLineOffset = 0$maxLineLength = 0)
    {
        if ($maxLineLength > 76 || $maxLineLength <= 0) {
            $maxLineLength = 76;
        }

        $thisLineLength = $maxLineLength - $firstLineOffset;

        $lines = [];
        $lNo = 0;
        $lines[$lNo] = '';
        $currentLine = &$lines[$lNo++];
        $size = $lineLen = 0;

        $this->charStream->flushContents();
        $this->charStream->importString($string);

        // Fetching more than 4 chars at one is slower, as is fetching fewer bytes
        // Conveniently 4 chars is the UTF-8 safe number since UTF-8 has up to 6
        // bytes per char and (6 * 4 * 3 = 72 chars per line) * =NN is 3 bytes
        while (false !== $bytes = $this->nextSequence()) {
            // If we're filtering the input
            if (isset($this->filter)) {
                // If we can't filter because we need more bytes
                while ($this->filter->shouldBuffer($bytes)) {
                    // Then collect bytes into the buffer
                    if (false === $moreBytes = $this->nextSequence(1)) {
                        break;
                    }

                    foreach ($moreBytes as $b) {
                        $bytes[] = $b;
                    }
                }
                // And filter them
                $bytes = $this->filter->filter($bytes);
            }

            $enc = $this->encodeByteSequence($bytes$size);

            $i = strpos($enc'=0D=0A');
            $newLineLength = $lineLen + (false === $i ? $size : $i);

            if ($currentLine && $newLineLength >= $thisLineLength) {
                $lines[$lNo] = '';
                $currentLine = &$lines[$lNo++];
                $thisLineLength = $maxLineLength;
                $lineLen = 0;
            }

            $currentLine .= $enc;

            if (false === $i) {
                $lineLen += $size;
            } else {
                // 6 is the length of '=0D=0A'.
                $lineLen = $size - strrpos($enc'=0D=0A') - 6;
            }
        }

        return $this->standardize(implode("=\r\n"$lines));
    }

    /** * Updates the charset used. * * @param string $charset */
    public function charsetChanged($charset)
    {
        $this->charStream->setCharacterSet($charset);
    }

    /** * Encode the given byte array into a verbatim QP form. * * @param int[] $bytes * @param int $size * * @return string */
    protected function encodeByteSequence(array $bytes, &$size)
    {
        $ret = '';
        $size = 0;
        foreach ($bytes as $b) {
            if (isset($this->safeMap[$b])) {
                $ret .= $this->safeMap[$b];
                ++$size;
            } else {
                $ret .= self::$qpMap[$b];
                $size += 3;
            }
        }

        return $ret;
    }

    /** * Get the next sequence of bytes to read from the char stream. * * @param int $size number of bytes to read * * @return int[] */
    protected function nextSequence($size = 4)
    {
        return $this->charStream->readBytes($size);
    }

    /** * Make sure CRLF is correct and HT/SPACE are in valid places. * * @param string $string * * @return string */
    protected function standardize($string)
    {
        $string = str_replace(["\t=0D=0A"' =0D=0A''=0D=0A'],
            ["=09\r\n""=20\r\n""\r\n"], $string
            );
        switch ($end = ord(substr($string, -1))) {
            case 0x09:
            case 0x20:
                $string = substr_replace($stringself::$qpMap[$end], -1);
        }

        return $string;
    }

    /** * Make a deep copy of object. */
    public function __clone()
    {
        $this->charStream = clone $this->charStream;
    }
}