CRM/Mailing/MailStore/Mbox.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33
  34 require_once 'ezc/Base/src/ezc_bootstrap.php';
  35 require_once 'ezc/autoload/mail_autoload.php';
  36
  37 /**
  38  * Class CRM_Mailing_MailStore_Mbox
  39  */
  40 class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore {
  41
  42   /**
  43    * Connect to and lock the supplied file and make sure the two mail dirs exist.
  44    *
  45    * @param string $file
  46    *   Mbox to operate upon.
  47    *
  48    * @return \CRM_Mailing_MailStore_Mbox
  49    */
  50   public function __construct($file) {
  51     $this->_transport = new ezcMailMboxTransport($file);
  52     flock($this->_transport->fh, LOCK_EX);
  53
  54     $this->_leftToProcess = count($this->_transport->listMessages());
  55
  56     $this->_ignored = $this->maildir(implode(DIRECTORY_SEPARATOR, array(
  57           'CiviMail.ignored',
  58           date('Y'),
  59           date('m'),
  60           date('d'),
  61         )));
  62     $this->_processed = $this->maildir(implode(DIRECTORY_SEPARATOR, array(
  63           'CiviMail.processed',
  64           date('Y'),
  65           date('m'),
  66           date('d'),
  67         )));
  68   }
  69
  70   /**
  71    * Empty the mail source (if it was processed fully) and unlock the file.
  72    */
  73   public function __destruct() {
  74     if ($this->_leftToProcess === 0) {
  75       // FIXME: the ftruncate() call does not work for some reason
  76       if ($this->_debug) {
  77         print "trying to delete the mailbox\n";
  78       }
  79       ftruncate($this->_transport->fh, 0);
  80     }
  81     flock($this->_transport->fh, LOCK_UN);
  82   }
  83
  84   /**
  85    * Fetch the specified message to the local ignore folder.
  86    *
  87    * @param int $nr
  88    *   Number of the message to fetch.
  89    */
  90   public function markIgnored($nr) {
  91     if ($this->_debug) {
  92       print "copying message $nr to ignored folder\n";
  93     }
  94     $set = new ezcMailStorageSet($this->_transport->fetchByMessageNr($nr), $this->_ignored);
  95     $parser = new ezcMailParser();
  96     $parser->parseMail($set);
  97     $this->_leftToProcess--;
  98   }
  99
 100   /**
 101    * Fetch the specified message to the local processed folder.
 102    *
 103    * @param int $nr
 104    *   Number of the message to fetch.
 105    */
 106   public function markProcessed($nr) {
 107     if ($this->_debug) {
 108       print "copying message $nr to processed folder\n";
 109     }
 110     $set = new ezcMailStorageSet($this->_transport->fetchByMessageNr($nr), $this->_processed);
 111     $parser = new ezcMailParser();
 112     $parser->parseMail($set);
 113     $this->_leftToProcess--;
 114   }
 115
 116 }