CRM/Mailing/MailStore/Maildir.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * $Id$
  33  *
  34  */
  35
  36 require_once 'ezc/Base/src/ezc_bootstrap.php';
  37 require_once 'ezc/autoload/mail_autoload.php';
  38
  39 /**
  40  * Class CRM_Mailing_MailStore_Maildir
  41  */
  42 class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore {
  43
  44   /**
  45    * Connect to the supplied dir and make sure the two mail dirs exist.
  46    *
  47    * @param string $dir
  48    *   Dir to operate upon.
  49    *
  50    * @return \CRM_Mailing_MailStore_Maildir
  51    */
  52   public function __construct($dir) {
  53     $this->_dir = $dir;
  54
  55     $this->_ignored = $this->maildir(implode(DIRECTORY_SEPARATOR, array(
  56           'CiviMail.ignored',
  57           date('Y'),
  58           date('m'),
  59           date('d'),
  60         )));
  61     $this->_processed = $this->maildir(implode(DIRECTORY_SEPARATOR, array(
  62           'CiviMail.processed',
  63           date('Y'),
  64           date('m'),
  65           date('d'),
  66         )));
  67   }
  68
  69   /**
  70    * Return the next X messages from the mail store.
  71    * FIXME: in CiviCRM 2.2 this always returns all the emails
  72    *
  73    * @param int $count
  74    *   Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all).
  75    *
  76    * @return array
  77    *   array of ezcMail objects
  78    */
  79   public function fetchNext($count = 0) {
  80     $mails = array();
  81     $parser = new ezcMailParser();
  82     //set property text attachment as file CRM-5408
  83     $parser->options->parseTextAttachmentsAsFiles = TRUE;
  84
  85     foreach (array(
  86                'cur',
  87                'new',
  88              ) as $subdir) {
  89       $dir = $this->_dir . DIRECTORY_SEPARATOR . $subdir;
  90       foreach (scandir($dir) as $file) {
  91         if ($file == '.' or $file == '..') {
  92           continue;
  93         }
  94         $path = $dir . DIRECTORY_SEPARATOR . $file;
  95
  96         if ($this->_debug) {
  97
  98           print "retrieving message $path\n";
  99
 100         }
 101
 102         $set = new ezcMailFileSet(array($path));
 103         $single = $parser->parseMail($set);
 104         $mails[$path] = $single[0];
 105       }
 106     }
 107     return $mails;
 108   }
 109
 110   /**
 111    * Fetch the specified message to the local ignore folder.
 112    *
 113    * @param int $file
 114    *   File location of the message to fetch.
 115    *
 116    * @throws Exception
 117    * @return void
 118    */
 119   public function markIgnored($file) {
 120     if ($this->_debug) {
 121       print "moving $file to ignored folder\n";
 122     }
 123     $target = $this->_ignored . DIRECTORY_SEPARATOR . basename($file);
 124     if (!rename($file, $target)) {
 125       throw new Exception("Could not rename $file to $target");
 126     }
 127   }
 128
 129   /**
 130    * Fetch the specified message to the local processed folder.
 131    *
 132    * @param int $file
 133    *   File location of the message to fetch.
 134    *
 135    * @throws Exception
 136    * @return void
 137    */
 138   public function markProcessed($file) {
 139     if ($this->_debug) {
 140       print "moving $file to processed folder\n";
 141     }
 142     $target = $this->_processed . DIRECTORY_SEPARATOR . basename($file);
 143     if (!rename($file, $target)) {
 144       throw new Exception("Could not rename $file to $target");
 145     }
 146   }
 147
 148 }