Location: PHPKode > projects > Eventum > eventum-2.2/include/class.draft.php
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 encoding=utf-8: */
// +----------------------------------------------------------------------+
// | Eventum - Issue Tracking System                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2003 - 2008 MySQL AB                                   |
// | Copyright (c) 2008 - 2009 Sun Microsystem Inc.                       |
// |                                                                      |
// | This program is free software; you can redistribute it and/or modify |
// | it under the terms of the GNU General Public License as published by |
// | the Free Software Foundation; either version 2 of the License, or    |
// | (at your option) any later version.                                  |
// |                                                                      |
// | This program is distributed in the hope that it will be useful,      |
// | but WITHOUT ANY WARRANTY; without even the implied warranty of       |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        |
// | GNU General Public License for more details.                         |
// |                                                                      |
// | You should have received a copy of the GNU General Public License    |
// | along with this program; if not, write to:                           |
// |                                                                      |
// | Free Software Foundation, Inc.                                       |
// | 59 Temple Place - Suite 330                                          |
// | Boston, MA 02111-1307, USA.                                          |
// +----------------------------------------------------------------------+
// | Authors: João Prado Maia <hide@address.com>                             |
// +----------------------------------------------------------------------+
//

require_once(APP_INC_PATH . "class.email_account.php");

class Draft
{
    /**
     * Method used to save the routed draft into a backup directory.
     *
     * @access  public
     * @param   string $message The full body of the draft
     */
    function saveRoutedMessage($message)
    {
        list($usec,) = explode(" ", microtime());
        $filename = date('Y-m-d_H-i-s_') . $usec . '.draft.txt';
        $path = APP_ROUTED_MAILS_SAVEDIR . 'routed_drafts/' . $filename;
        $fp = @fopen($file, 'w');
        @fwrite($fp, $message);
        @fclose($fp);
        @chmod($file, 0644);
    }


    /**
     * Method used to save the draft response in the database for
     * further use.
     *
     * @access  public
     * @param   integer $issue_id The issue ID
     * @param   string $to The primary recipient of the draft
     * @param   string $cc The secondary recipients of the draft
     * @param   string $subject The subject of the draft
     * @param   string $message The draft body
     * @param   integer $parent_id The ID of the email that this draft is replying to, if any
     * @param   string $unknown_user The sender of the draft, if not a real user
     * @param   boolean $add_history_entry Whether to add a history entry automatically or not
     * @return  integer 1 if the update worked, -1 otherwise
     */
    function saveEmail($issue_id, $to, $cc, $subject, $message, $parent_id = FALSE, $unknown_user = FALSE, $add_history_entry = TRUE)
    {
        $issue_id = Misc::escapeInteger($issue_id);
        $parent_id = Misc::escapeInteger($parent_id);
        if (empty($parent_id)) {
            $parent_id = 'NULL';
        }
        // if unknown_user is not empty, set the usr_id to be the system user.
        if (!empty($unknown_user)) {
            $usr_id = APP_SYSTEM_USER_ID;
        } else {
            $usr_id = Auth::getUserID();
        }
        $stmt = "INSERT INTO
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft
                 (
                    emd_updated_date,
                    emd_usr_id,
                    emd_iss_id,
                    emd_sup_id,
                    emd_subject,
                    emd_body";
        if (!empty($unknown_user)) {
            $stmt .= ", emd_unknown_user";
        }
        $stmt .= ") VALUES (
                    '" . Date_API::getCurrentDateGMT() . "',
                    $usr_id,
                    $issue_id,
                    $parent_id,
                    '" . Misc::escapeString($subject) . "',
                    '" . Misc::escapeString($message) . "'";
        if (!empty($unknown_user)) {
            $stmt .= ", '" . Misc::escapeString($unknown_user) . "'";
        }
        $stmt .= ")";
        $res = $GLOBALS["db_api"]->dbh->query($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return -1;
        } else {
            $new_emd_id = $GLOBALS['db_api']->get_last_insert_id();
            Draft::addEmailRecipient($new_emd_id, $to, false);
            $cc = str_replace(',', ';', $cc);
            $ccs = explode(';', $cc);
            foreach ($ccs as $cc) {
                Draft::addEmailRecipient($new_emd_id, $cc, true);
            }
            Issue::markAsUpdated($issue_id, "draft saved");
            if ($add_history_entry) {
                History::add($issue_id, $usr_id, History::getTypeID('draft_added'), ev_gettext('Email message saved as a draft by %1$s', User::getFullName($usr_id)));
            }
            return 1;
        }
    }


    /**
     * Method used to update an existing draft response.
     *
     * @access  public
     * @param   integer $issue_id The issue ID
     * @param   integer $emd_id The email draft ID
     * @param   string $to The primary recipient of the draft
     * @param   string $cc The secondary recipients of the draft
     * @param   string $subject The subject of the draft
     * @param   string $message The draft body
     * @param   integer $parent_id The ID of the email that this draft is replying to, if any
     * @return  integer 1 if the update worked, -1 otherwise
     */
    function update($issue_id, $emd_id, $to, $cc, $subject, $message, $parent_id = FALSE)
    {
        $issue_id = Misc::escapeInteger($issue_id);
        $emd_id = Misc::escapeInteger($emd_id);
        $parent_id = Misc::escapeInteger($parent_id);
        if (empty($parent_id)) {
            $parent_id = 'NULL';
        }
        $usr_id = Auth::getUserID();

        // update previous draft and insert new record
        $stmt = "UPDATE
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft
                 SET
                    emd_updated_date='" . Date_API::getCurrentDateGMT() . "',
                    emd_status = 'edited'
                 WHERE
                    emd_id=$emd_id";
        $res = $GLOBALS["db_api"]->dbh->query($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return -1;
        } else {
            Issue::markAsUpdated($issue_id, "draft saved");
            History::add($issue_id, $usr_id, History::getTypeID('draft_updated'), ev_gettext('Email message draft updated by %1$s', User::getFullName($usr_id)));
            Draft::saveEmail($issue_id, $to, $cc, $subject, $message, $parent_id, false, false);
            return 1;
        }
    }


    /**
     * Method used to remove a draft response.
     *
     * @access  public
     * @param   integer $emd_id The email draft ID
     * @return  boolean
     */
    function remove($emd_id)
    {
        $emd_id = Misc::escapeInteger($emd_id);
        $stmt = "UPDATE
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft
                 SET
                    emd_status = 'sent'
                 WHERE
                    emd_id=$emd_id";
        $res = $GLOBALS["db_api"]->dbh->query($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return false;
        } else {
            return true;
        }
    }


    /**
     * Method used to remove the recipients associated with the given
     * email draft response.
     *
     * @access  public
     * @param   integer $emd_id The email draft ID
     * @return  boolean
     */
    function removeRecipients($emd_id)
    {
        $emd_id = Misc::escapeInteger($emd_id);
        $stmt = "DELETE FROM
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft_recipient
                 WHERE
                    edr_emd_id=$emd_id";
        $res = $GLOBALS["db_api"]->dbh->query($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return false;
        } else {
            return true;
        }
    }


    /**
     * Method used to associate a recipient with a given email
     * draft response.
     *
     * @access  public
     * @param   integer $emd_id The email draft ID
     * @param   string $email The recipient's email address
     * @param   boolean $is_cc Whether this recipient is in the Cc list for the given draft
     * @return  boolean
     */
    function addEmailRecipient($emd_id, $email, $is_cc)
    {
        $emd_id = Misc::escapeInteger($emd_id);
        if (!$is_cc) {
            $is_cc = 0;
        } else {
            $is_cc = 1;
        }
        $email = trim($email);
        $stmt = "INSERT INTO
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft_recipient
                 (
                    edr_emd_id,
                    edr_is_cc,
                    edr_email
                 ) VALUES (
                    $emd_id,
                    $is_cc,
                    '" . Misc::escapeString($email) . "'
                 )";
        $res = $GLOBALS["db_api"]->dbh->query($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return false;
        } else {
            return true;
        }
    }


    /**
     * Method used to get the details on a given email draft response.
     *
     * @access  public
     * @param   integer $emd_id The email draft ID
     * @return  array The email draft details
     */
    function getDetails($emd_id)
    {
        $emd_id = Misc::escapeInteger($emd_id);
        $stmt = "SELECT
                    *
                 FROM
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft
                 WHERE
                    emd_id=$emd_id";
        $res = $GLOBALS["db_api"]->dbh->getRow($stmt, DB_FETCHMODE_ASSOC);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return '';
        } else {
            $res["emd_updated_date"] = Date_API::getFormattedDate($res["emd_updated_date"]);
            if (!empty($res['emd_unknown_user'])) {
                $res['from'] = $res["emd_unknown_user"];
            } else {
                $res['from'] = User::getFromHeader($res['emd_usr_id']);
            }
            list($res['to'], $res['cc']) = Draft::getEmailRecipients($emd_id);
            return $res;
        }
    }


    /**
     * Returns a list of drafts associated with an issue.
     *
     * @access  public
     * @param   integer $issue_id The ID of the issue.
     * @param   boolean $show_all If all draft statuses should be shown
     * @return  array An array of drafts.
     */
    function getList($issue_id, $show_all = false)
    {
        $issue_id = Misc::escapeInteger($issue_id);
        $stmt = "SELECT
                    emd_id,
                    emd_usr_id,
                    emd_subject,
                    emd_updated_date,
                    emd_unknown_user,
                    emd_status
                 FROM
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft
                 WHERE
                    emd_iss_id=$issue_id\n";
        if ($show_all == false) {
            $stmt .= "AND emd_status = 'pending'\n";
        }
        $stmt .= "ORDER BY
                    emd_id";
        $res = $GLOBALS["db_api"]->dbh->getAll($stmt, DB_FETCHMODE_ASSOC);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return '';
        } else {
            for ($i = 0; $i < count($res); $i++) {
                $res[$i]["emd_updated_date"] = Date_API::getFormattedDate($res[$i]["emd_updated_date"]);
                if (!empty($res[$i]['emd_unknown_user'])) {
                    $res[$i]['from'] = $res[$i]["emd_unknown_user"];
                } else {
                    $res[$i]['from'] = User::getFromHeader($res[$i]['emd_usr_id']);
                }
                list($res[$i]['to'], ) = Draft::getEmailRecipients($res[$i]['emd_id']);
                if (empty($res[$i]['to'])) {
                    $res[$i]['to'] = "Notification List";
                }
            }
            return $res;
        }
    }


    /**
     * Method used to get the list of email recipients for a
     * given draft response.
     *
     * @access  public
     * @param   integer $emd_id The email draft ID
     * @return  array The list of email recipients
     */
    function getEmailRecipients($emd_id)
    {
        $emd_id = Misc::escapeInteger($emd_id);
        $stmt = "SELECT
                    edr_email,
                    edr_is_cc
                 FROM
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft_recipient
                 WHERE
                    edr_emd_id=$emd_id";
        $res = $GLOBALS["db_api"]->dbh->getAssoc($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return array('', '');
        } else {
            $to = '';
            $ccs = array();
            foreach ($res as $email => $is_cc) {
                if ($is_cc) {
                    $ccs[] = $email;
                } else {
                    $to = $email;
                }
            }
            return array(
                $to,
                $ccs
            );
        }
    }


    /**
     * Returns the nth draft for the specific issue. Sequence starts at 1.
     *
     * @access  public
     * @param   integer $issue_id The id of the issue.
     * @param   integer $sequence The sequential number of the draft.
     * @return  array An array of data containing details about the draft.
     */
    function getDraftBySequence($issue_id, $sequence)
    {
        $issue_id = Misc::escapeInteger($issue_id);
        $sequence = Misc::escapeInteger($sequence);
        $stmt = "SELECT
                    emd_id
                FROM
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft
                WHERE
                    emd_iss_id = $issue_id AND
                    emd_status = 'pending'
                ORDER BY
                    emd_id ASC
                LIMIT " . ($sequence - 1) . ", 1";
        $res = $GLOBALS["db_api"]->dbh->getOne($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return array();
        } else {
            if (empty($res)) {
                return array();
            } else {
                return Draft::getDetails($res);
            }
        }
    }


    /**
     * Converts an email to a draft and sends it.
     *
     * @access  public
     * @param   integer $draft_id The id of the draft to send.
     */
    function send($draft_id)
    {
        $draft_id = Misc::escapeInteger($draft_id);
        $draft = Draft::getDetails($draft_id);
        $_POST["issue_id"] = $draft["emd_iss_id"];
        $_POST["subject"] = $draft["emd_subject"];
        $_POST["from"] = User::getFromHeader(Auth::getUserID());
        $_POST["to"] = $draft["to"];
        $_POST["cc"] = @join(";", $draft["cc"]);
        $_POST["message"] = $draft["emd_body"];
        $_POST["ema_id"] = Email_Account::getEmailAccount();
        $res = Support::sendEmail();
        if ($res == 1) {
           Draft::remove($draft_id);
        }
        return $res;
    }


    /**
     * Returns the number of drafts by a user in a time range.
     *
     * @access  public
     * @param   string $usr_id The ID of the user
     * @param   integer $start The timestamp of the start date
     * @param   integer $end The timestanp of the end date
     * @return  integer The number of note by the user.
     */
    function getCountByUser($usr_id, $start, $end)
    {
        $stmt = "SELECT
                    COUNT(emd_id)
                 FROM
                    " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "email_draft
                 WHERE
                    emd_updated_date BETWEEN '$start' AND '$end' AND
                    emd_usr_id = $usr_id";
        $res = $GLOBALS["db_api"]->dbh->getOne($stmt);
        if (PEAR::isError($res)) {
            Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
            return "";
        }
        return $res;
    }
}

// benchmarking the included file (aka setup time)
if (APP_BENCHMARK) {
    $GLOBALS['bench']->setMarker('Included Draft Class');
}
Return current item: Eventum