CRM/Mailing/MailStore/Mbox.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 require_once 'ezc/Base/src/ezc_bootstrap.php';
  37 require_once 'ezc/autoload/mail_autoload.php';
  38 class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore {
  39
  40   /**
  41    * Connect to and lock the supplied file and make sure the two mail dirs exist
  42    *
  43    * @param string $file  mbox to operate upon
  44    *
  45    * @return void
  46    */
  47   function __construct($file) {
  48     $this->_transport = new ezcMailMboxTransport($file);
  49     flock($this->_transport->fh, LOCK_EX);
  50
  51     $this->_leftToProcess = count($this->_transport->listMessages());
  52
  53     $this->_ignored = $this->maildir(implode(DIRECTORY_SEPARATOR, array('CiviMail.ignored', date('Y'), date('m'), date('d'))));
  54     $this->_processed = $this->maildir(implode(DIRECTORY_SEPARATOR, array('CiviMail.processed', date('Y'), date('m'), date('d'))));
  55   }
  56
  57   /**
  58    * Empty the mail source (if it was processed fully) and unlock the file
  59    *
  60    * @return void
  61    */
  62   function __destruct() {
  63     if ($this->_leftToProcess === 0) {
  64       // FIXME: the ftruncate() call does not work for some reason
  65       if ($this->_debug) {
  66         print "trying to delete the mailbox\n";
  67       }
  68       ftruncate($this->_transport->fh, 0);
  69     }
  70     flock($this->_transport->fh, LOCK_UN);
  71   }
  72
  73   /**
  74    * Fetch the specified message to the local ignore folder
  75    *
  76    * @param integer $nr  number of the message to fetch
  77    *
  78    * @return void
  79    */
  80   function markIgnored($nr) {
  81     if ($this->_debug) {
  82       print "copying message $nr to ignored folder\n";
  83     }
  84     $set = new ezcMailStorageSet($this->_transport->fetchByMessageNr($nr), $this->_ignored);
  85     $parser = new ezcMailParser;
  86     $parser->parseMail($set);
  87     $this->_leftToProcess--;
  88   }
  89
  90   /**
  91    * Fetch the specified message to the local processed folder
  92    *
  93    * @param integer $nr  number of the message to fetch
  94    *
  95    * @return void
  96    */
  97   function markProcessed($nr) {
  98     if ($this->_debug) {
  99       print "copying message $nr to processed folder\n";
 100     }
 101     $set = new ezcMailStorageSet($this->_transport->fetchByMessageNr($nr), $this->_processed);
 102     $parser = new ezcMailParser;
 103     $parser->parseMail($set);
 104     $this->_leftToProcess--;
 105   }
 106 }
 107