CRM/Mailing/MailStore/Mbox.php

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