flatfile.php

<?php
require_once 'Mail/Queue/Container.php';


class Mail_Queue_Container_flatfile extends Mail_Queue_Container
{

    var $dir;


    function Mail_Queue_Container_flatfile($options)
    {
        if (!is_array($options) || !isset($options['dir'])) {
            return new Mail_Queue_Error(MAILQUEUE_ERROR_NO_OPTIONS,
                $this->pearErrorMode, E_USER_ERROR, __FILE__, __LINE__,
                'No queue directory specified!');
        }
        $this->dir = $options['dir'];
        $this->setOption();
    }


    function _preload()
    {
        $this->_last_item = 0;
        $this->queue_data = array(); //reset buffer

        $queue_files = $this->list_files($this->dir);
        foreach ($queue_files as $index => $messageID) {
            if ($this->limit && ($index + 1 > $this->limit)) break;

            $mail_array = $this->loadFromQueue($messageID);
            $mail_body = new Mail_Queue_Body(
                                $mail_array['id'],
                                $mail_array['create_time'],
                                $mail_array['time_to_send'],
                                $mail_array['sent_time'],
                                $mail_array['id_user'],
                                $mail_array['ip'],
                                $mail_array['sender'],
                                $mail_array['recipient'],
                                unserialize($mail_array['headers']),
                                unserialize($mail_array['body']),
                                $mail_array['delete_after_send'],
                                $mail_array['try_sent']
                              );
            if (is_a($mail_body, 'Mail_Queue_Body')) {
                $this->queue_data[$this->_last_item] = $mail_body;
                $this->_last_item++;
            }
        }

        return true;

    }//end _preload()


    function list_files($dir)
    {
        if (!is_dir($dir)) return Array();

        $files = Array();
        if ($handle = opendir($dir)) {
            while (($file = readdir($handle)) !== false) {
                if ($file == '.' || $file == '..') {
                    continue;
                } else  if (is_file($dir.'/'.$file)) {
                    $files[] = $file;
                }
            }
            closedir($handle);
        }
        return $files;

    }//end list_files()


    function put($time_to_send, $id_user, $ip, $sender,
                $recipient, $headers, $body, $delete_after_send=true)
    {
        // accommodate changes made to PEAR Mail_Queue v 1.2.1
        $to = $recipient;
        if (method_exists($this, '_isSerialized')) {
            if ($this->_isSerialized($recipient)) {
                $to = unserialize($recipient);
            }
        }

        // uses user_id as the custom id of mail queue files
        $header_array = unserialize($headers);
        if (isset($header_array['custom_id'])) {
            $custom_id = substr($header_array['custom_id'], 0, 113);
            $id = md5(uniqid($custom_id));
            unset($header_array['custom_id']);
            $headers = serialize($header_array);
        } else {
            $id = md5(uniqid(''));
        }

        $array = Array(
                    'id'                => $id,
                    'time_to_send'      => $time_to_send,
                    'id_user'           => $id_user,
                    'ip'                => $ip,
                    'sender'            => $sender,
                    'recipient'         => $to,
                    'headers'           => $headers,
                    'body'              => $body,
                    'delete_after_send' => $delete_after_send,
                    'try_sent'          => 0,
                    'create_time'       => date("Y-m-d G:i:s", time()),
                    'sent_time'         => 0,
                 );

        $this->saveToQueue($id, $array);

        return $id;
    }

    function loadFromQueue($id) {
        if (is_file($this->dir.'/'.$id)) {
            require $this->dir.'/'.$id;
        }
        return isset($mail_entry) ? $mail_entry : Array();
    }

    function saveToQueue($id, $contents) {
        $output = '<?php $mail_entry = '.var_export($contents, true).'; ?>';
        $fp = fopen($this->dir.'/'.$id, 'w');
        $return_value = fwrite($fp, $output);
        fclose($fp);
        return $return_value;
    }


    function countSend($mail)
    {
        if (!is_object($mail) || !is_a($mail, 'mail_queue_body')) {
            return new Mail_Queue_Error('Expected: Mail_Queue_Body class',
                __FILE__, __LINE__);
        }
        $count = $mail->_try();

        $mail_array = $this->loadFromQueue($mail->getId());
        if (!empty($mail_array)) {
            $mail_array['try_sent'] = $count;
            $this->saveToQueue($mail->getId(), $mail_array);
        }

        return $count;
    }


    function setAsSent($mail)
    {
        if (!is_object($mail) || !is_a($mail, 'mail_queue_body')) {
            return new Mail_Queue_Error(MAILQUEUE_ERROR_UNEXPECTED,
                $this->pearErrorMode, E_USER_ERROR, __FILE__, __LINE__,
                'Expected: Mail_Queue_Body class');
        }

        $mail_array = $this->loadFromQueue($mail->getId());
        if (!empty($mail_array)) {
            $mail_array['sent_time'] = time();
            $this->saveToQueue($mail->getId(), $mail_array);
        }

        return true;
    }


    function deleteMail($id)
    {
        // move files to .queue/.sent folder instead of deleting them
        $success = rename($this->dir.'/'.$id, $this->dir.'/sent/'.$id);

        if ($success === false) {
            return new Mail_Queue_Error(MAILQUEUE_ERROR_QUERY_FAILED,
                $this->pearErrorMode, E_USER_ERROR, __FILE__, __LINE__,
                'Unable to delete mail from queue (MailID #'.$id.')');
        }

        return true;
    }

}
?>