CRM/Mailing/MailStore/Maildir.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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('CiviMail.ignored', date('Y'), date('m'), date('d'))));
  56     $this->_processed = $this->maildir(implode(DIRECTORY_SEPARATOR, array('CiviMail.processed', date('Y'), date('m'), date('d'))));
  57   }
  58
  59   /**
  60    * Return the next X messages from the mail store
  61    * FIXME: in CiviCRM 2.2 this always returns all the emails
  62    *
  63    * @param int $count
  64    *   Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all).
  65    *
  66    * @return array
  67    *   array of ezcMail objects
  68    */
  69   public function fetchNext($count = 0) {
  70     $mails = array();
  71     $parser = new ezcMailParser;
  72     //set property text attachment as file CRM-5408
  73     $parser->options->parseTextAttachmentsAsFiles = TRUE;
  74
  75     foreach (array(
  76       'cur', 'new') as $subdir) {
  77       $dir = $this->_dir . DIRECTORY_SEPARATOR . $subdir;
  78       foreach (scandir($dir) as $file) {
  79         if ($file == '.' or $file == '..') {
  80           continue;
  81         }
  82         $path = $dir . DIRECTORY_SEPARATOR . $file;
  83
  84         if ($this->_debug) {
  85
  86           print "retrieving message $path\n";
  87
  88         }
  89
  90         $set          = new ezcMailFileSet(array($path));
  91         $single       = $parser->parseMail($set);
  92         $mails[$path] = $single[0];
  93       }
  94     }
  95     return $mails;
  96   }
  97
  98   /**
  99    * Fetch the specified message to the local ignore folder
 100    *
 101    * @param int $file
 102    *   File location of the message to fetch.
 103    *
 104    * @throws Exception
 105    * @return void
 106    */
 107   public function markIgnored($file) {
 108     if ($this->_debug) {
 109       print "moving $file to ignored folder\n";
 110     }
 111     $target = $this->_ignored . DIRECTORY_SEPARATOR . basename($file);
 112     if (!rename($file, $target)) {
 113       throw new Exception("Could not rename $file to $target");
 114     }
 115   }
 116
 117   /**
 118    * Fetch the specified message to the local processed folder
 119    *
 120    * @param int $file
 121    *   File location of the message to fetch.
 122    *
 123    * @throws Exception
 124    * @return void
 125    */
 126   public function markProcessed($file) {
 127     if ($this->_debug) {
 128       print "moving $file to processed folder\n";
 129     }
 130     $target = $this->_processed . DIRECTORY_SEPARATOR . basename($file);
 131     if (!rename($file, $target)) {
 132       throw new Exception("Could not rename $file to $target");
 133     }
 134   }
 135 }