Classes List

Swift_KeyCache_DiskKeyCache

 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 
<?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. */


/** * A KeyCache which streams to and from disk. * * @author Chris Corbyn */
class Swift_KeyCache_DiskKeyCache implements Swift_KeyCache
{
    /** Signal to place pointer at start of file */
    const POSITION_START = 0;

    /** Signal to place pointer at end of file */
    const POSITION_END = 1;

    /** Signal to leave pointer in whatever position it currently is */
    const POSITION_CURRENT = 2;

    /** * An InputStream for cloning. * * @var Swift_KeyCache_KeyCacheInputStream */
    private $stream;

    /** * A path to write to. * * @var string */
    private $path;

    /** * Stored keys. * * @var array */
    private $keys = [];

    /** * Create a new DiskKeyCache with the given $stream for cloning to make * InputByteStreams, and the given $path to save to. * * @param string $path to save to */
    public function __construct(Swift_KeyCache_KeyCacheInputStream $stream$path)
    {
        $this->stream = $stream;
        $this->path = $path;
    }

    /** * Set a string into the cache under $itemKey for the namespace $nsKey. * * @see MODE_WRITE, MODE_APPEND * * @param string $nsKey * @param string $itemKey * @param string $string * @param int $mode * * @throws Swift_IoException */
    public function setString($nsKey$itemKey$string$mode)
    {
        $this->prepareCache($nsKey);
        switch ($mode) {
            case self::MODE_WRITE:
                $fp = $this->getHandle($nsKey$itemKeyself::POSITION_START);
                break;
            case self::MODE_APPEND:
                $fp = $this->getHandle($nsKey$itemKeyself::POSITION_END);
                break;
            default:
                throw new Swift_SwiftException('Invalid mode ['.$mode.'] used to set nsKey='.$nsKey.', itemKey='.$itemKey);
                break;
        }
        fwrite($fp$string);
        $this->freeHandle($nsKey$itemKey);
    }

    /** * Set a ByteStream into the cache under $itemKey for the namespace $nsKey. * * @see MODE_WRITE, MODE_APPEND * * @param string $nsKey * @param string $itemKey * @param int $mode * * @throws Swift_IoException */
    public function importFromByteStream($nsKey$itemKeySwift_OutputByteStream $os$mode)
    {
        $this->prepareCache($nsKey);
        switch ($mode) {
            case self::MODE_WRITE:
                $fp = $this->getHandle($nsKey$itemKeyself::POSITION_START);
                break;
            case self::MODE_APPEND:
                $fp = $this->getHandle($nsKey$itemKeyself::POSITION_END);
                break;
            default:
                throw new Swift_SwiftException('Invalid mode ['.$mode.'] used to set nsKey='.$nsKey.', itemKey='.$itemKey);
                break;
        }
        while (false !== $bytes = $os->read(8192)) {
            fwrite($fp$bytes);
        }
        $this->freeHandle($nsKey$itemKey);
    }

    /** * Provides a ByteStream which when written to, writes data to $itemKey. * * NOTE: The stream will always write in append mode. * * @param string $nsKey * @param string $itemKey * * @return Swift_InputByteStream */
    public function getInputByteStream($nsKey$itemKeySwift_InputByteStream $writeThrough = null)
    {
        $is = clone $this->stream;
        $is->setKeyCache($this);
        $is->setNsKey($nsKey);
        $is->setItemKey($itemKey);
        if (isset($writeThrough)) {
            $is->setWriteThroughStream($writeThrough);
        }

        return $is;
    }

    /** * Get data back out of the cache as a string. * * @param string $nsKey * @param string $itemKey * * @throws Swift_IoException * * @return string */
    public function getString($nsKey$itemKey)
    {
        $this->prepareCache($nsKey);
        if ($this->hasKey($nsKey$itemKey)) {
            $fp = $this->getHandle($nsKey$itemKeyself::POSITION_START);
            $str = '';
            while (!feof($fp&& false !== $bytes = fread($fp8192)) {
                $str .= $bytes;
            }
            $this->freeHandle($nsKey$itemKey);

            return $str;
        }
    }

    /** * Get data back out of the cache as a ByteStream. * * @param string $nsKey * @param string $itemKey * @param Swift_InputByteStream $is to write the data to */
    public function exportToByteStream($nsKey$itemKeySwift_InputByteStream $is)
    {
        if ($this->hasKey($nsKey$itemKey)) {
            $fp = $this->getHandle($nsKey$itemKeyself::POSITION_START);
            while (!feof($fp&& false !== $bytes = fread($fp8192)) {
                $is->write($bytes);
            }
            $this->freeHandle($nsKey$itemKey);
        }
    }

    /** * Check if the given $itemKey exists in the namespace $nsKey. * * @param string $nsKey * @param string $itemKey * * @return bool */
    public function hasKey($nsKey$itemKey)
    {
        return is_file($this->path.'/'.$nsKey.'/'.$itemKey);
    }

    /** * Clear data for $itemKey in the namespace $nsKey if it exists. * * @param string $nsKey * @param string $itemKey */
    public function clearKey($nsKey$itemKey)
    {
        if ($this->hasKey($nsKey$itemKey)) {
            $this->freeHandle($nsKey$itemKey);
            unlink($this->path.'/'.$nsKey.'/'.$itemKey);
        }
    }

    /** * Clear all data in the namespace $nsKey if it exists. * * @param string $nsKey */
    public function clearAll($nsKey)
    {
        if (array_key_exists($nsKey$this->keys)) {
            foreach ($this->keys[$nsKeyas $itemKey => $null) {
                $this->clearKey($nsKey$itemKey);
            }
            if (is_dir($this->path.'/'.$nsKey)) {
                rmdir($this->path.'/'.$nsKey);
            }
            unset($this->keys[$nsKey]);
        }
    }

    /** * Initialize the namespace of $nsKey if needed. * * @param string $nsKey */
    private function prepareCache($nsKey)
    {
        $cacheDir = $this->path.'/'.$nsKey;
        if (!is_dir($cacheDir)) {
            if (!mkdir($cacheDir)) {
                throw new Swift_IoException('Failed to create cache directory '.$cacheDir);
            }
            $this->keys[$nsKey] = [];
        }
    }

    /** * Get a file handle on the cache item. * * @param string $nsKey * @param string $itemKey * @param int $position * * @return resource */
    private function getHandle($nsKey$itemKey$position)
    {
        if (!isset($this->keys[$nsKey][$itemKey])) {
            $openMode = $this->hasKey($nsKey$itemKey) ? 'r+b' : 'w+b';
            $fp = fopen($this->path.'/'.$nsKey.'/'.$itemKey$openMode);
            $this->keys[$nsKey][$itemKey] = $fp;
        }
        if (self::POSITION_START == $position) {
            fseek($this->keys[$nsKey][$itemKey], 0SEEK_SET);
        } elseif (self::POSITION_END == $position) {
            fseek($this->keys[$nsKey][$itemKey], 0SEEK_END);
        }

        return $this->keys[$nsKey][$itemKey];
    }

    private function freeHandle($nsKey$itemKey)
    {
        $fp = $this->getHandle($nsKey$itemKeyself::POSITION_CURRENT);
        fclose($fp);
        $this->keys[$nsKey][$itemKey] = null;
    }

    /** * Destructor. */
    public function __destruct()
    {
        foreach ($this->keys as $nsKey => $null) {
            $this->clearAll($nsKey);
        }
    }
}