Swift_FileSpool

Complexity

Total Complexity

30

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	4
A	isStarted()	0	4	1
A	start()	0	3	1
A	stop()	0	3	1
A	setRetryLimit()	0	4	1
A	queueMessage()	0	21	4
A	recover()	0	13	4
C	flushQueue()	0	48	11
A	getRandomString()	0	16	3

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2009 Fabien Potencier <fabien.potencier@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * Stores Messages on the filesystem.
 *
 * @author Fabien Potencier
 * @author Xavier De Cock <xdecock@gmail.com>
 */
class Swift_FileSpool extends Swift_ConfigurableSpool

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /** The spool directory */
    private $_path;

    /**
     * File WriteRetry Limit.
     *
     * @var int
     */
    private $_retryLimit = 10;

    /**
     * Create a new FileSpool.
     *
     * @param string $path
     *
     * @throws Swift_IoException
     */
    public function __construct($path)
    {
        $this->_path = $path;

      /** @noinspection PhpUsageOfSilenceOperatorInspection */
      if (
            !file_exists($this->_path)
            &&
            !@mkdir($this->_path, 0777, true)
            &&
            !is_dir($this->_path)
        ) {
            throw new Swift_IoException(sprintf('Unable to create path "%s".', $this->_path));
        }
    }

    /**
     * Tests if this Spool mechanism has started.
     *
     * @return bool
     */
    public function isStarted()
    {
        return true;
    }

    /**
     * Starts this Spool mechanism.
     */
    public function start()
    {
    }

    /**
     * Stops this Spool mechanism.
     */
    public function stop()
    {
    }

    /**
     * Allow to manage the enqueuing retry limit.
     *
     * Default, is ten and allows over 64^20 different fileNames
     *
     * @param int $limit
     */
    public function setRetryLimit($limit)
    {
        $this->_retryLimit = $limit;
    }

    /**
     * Queues a message.
     *
     * @param Swift_Mime_Message $message The message to store
     *
     * @throws Swift_IoException
     *
     * @return bool
     */
    public function queueMessage(Swift_Mime_Message $message)
    {
        $ser = serialize($message);
        $fileName = $this->_path . '/' . $this->getRandomString();
        for ($i = 0; $i < $this->_retryLimit; ++$i) {
            /* We try an exclusive creation of the file. This is an atomic operation, it avoid locking mechanism */
            /** @noinspection PhpUsageOfSilenceOperatorInspection */
            $fp = @fopen($fileName . '.message', 'xb');
                if (false !== $fp) {
                    if (false === fwrite($fp, $ser)) {
                        return false;
                    }
                    return fclose($fp);
              }

            /* The file already exists, we try a longer fileName */
            $fileName .= $this->getRandomString(1);
        }

        throw new Swift_IoException(sprintf('Unable to create a file for enqueuing Message in "%s".', $this->_path));
    }

    /**
     * Execute a recovery if for any reason a process is sending for too long.
     *
     * @param int $timeout in second Defaults is for very slow smtp responses
     */
    public function recover($timeout = 900)
    {
        foreach (new DirectoryIterator($this->_path) as $file) {
            $file = $file->getRealPath();

            if (substr($file, -16) === '.message.sending') {
                $lockedtime = filectime($file);
                if ((time() - $lockedtime) > $timeout) {
                    rename($file, substr($file, 0, -8));
                }
            }
        }
    }

    /**
     * Sends messages using the given transport instance.
     *
     * @param Swift_Transport $transport        A transport instance
     * @param string[]        $failedRecipients An array of failures by-reference
     *
     * @return int The number of sent e-mail's
     */
    public function flushQueue(Swift_Transport $transport, &$failedRecipients = null)
    {
        $directoryIterator = new DirectoryIterator($this->_path);

        /* Start the transport only if there are queued files to send */
        if (!$transport->isStarted()) {
            foreach ($directoryIterator as $file) {
                if (substr($file->getRealPath(), -8) === '.message') {
                    $transport->start();
                    break;
                }
            }
        }

        $failedRecipients = (array)$failedRecipients;
        $count = 0;
        $time = time();
        foreach ($directoryIterator as $file) {
            $file = $file->getRealPath();

            if (substr($file, -8) !== '.message') {
                continue;
            }

            /* We try a rename, it's an atomic operation, and avoid locking the file */
            if (rename($file, $file . '.sending')) {
                // TODO: -> SECURITY | Perhaps it's possible to exploit the unserialize via: file_get_contents(...)
                $message = unserialize(file_get_contents($file . '.sending'));

                $count += $transport->send($message, $failedRecipients);

It seems like $failedRecipients defined by (array) $failedRecipients on line 160 can also be of type array; however, Swift_Transport::send() does only seem to accept array<integer,string>|null, maybe add an additional type check?

                unlink($file . '.sending');
            } else {
                /* This message has just been catched by another process */
                continue;
            }

            if ($this->getMessageLimit() && $count >= $this->getMessageLimit()) {
                break;
            }

            if ($this->getTimeLimit() && (time() - $time) >= $this->getTimeLimit()) {
                break;
            }
        }

        return $count;
    }

    /**
     * Returns a random string needed to generate a fileName for the queue.
     *
     * @param int|null $count <strong>null</strong> use only "uniqid()"<br />
     *                        <strong>int</strong> use "random_int()" with a fixed- / fs-safe string
     *
     * @return string
     */
    protected function getRandomString($count = null)
    {
        if ($count === null) {
            return uniqid('', true);
        }

        // This string MUST stay FS safe, avoid special chars.
        $base = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-';
        $ret = '';
        $strlen = strlen($base) - 1;
        for ($i = 0; $i < $count; ++$i) {
            $ret .= $base[\random_int(0, $strlen - 1)];
        }

        return $ret;
    }
}