CRM/Mailing/MailStore.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 class CRM_Mailing_MailStore {
  36   // flag to decide whether to print debug messages
  37   var $_debug = FALSE;
  38
  39   /**
  40    * Return the proper mail store implementation, based on config settings
  41    *
  42    * @param string $name
  43    *   Name of the settings set from civimail_mail_settings to use (null for default).
  44    *
  45    * @throws Exception
  46    * @return object        mail store implementation for processing CiviMail-bound emails
  47    */
  48   public static function getStore($name = NULL) {
  49     $dao               = new CRM_Core_DAO_MailSettings;
  50     $dao->domain_id    = CRM_Core_Config::domainID();
  51     $name ? $dao->name = $name : $dao->is_default = 1;
  52     if (!$dao->find(TRUE)) {
  53       throw new Exception("Could not find entry named $name in civicrm_mail_settings");
  54     }
  55
  56     $protocols = CRM_Core_PseudoConstant::get('CRM_Core_DAO_MailSettings', 'protocol');
  57     if (empty($protocols[$dao->protocol])) {
  58       throw new Exception("Empty mail protocol");
  59     }
  60
  61     switch ($protocols[$dao->protocol]) {
  62       case 'IMAP':
  63         return new CRM_Mailing_MailStore_Imap($dao->server, $dao->username, $dao->password, (bool) $dao->is_ssl, $dao->source);
  64
  65       case 'POP3':
  66         return new CRM_Mailing_MailStore_Pop3($dao->server, $dao->username, $dao->password, (bool) $dao->is_ssl);
  67
  68       case 'Maildir':
  69         return new CRM_Mailing_MailStore_Maildir($dao->source);
  70
  71       case 'Localdir':
  72         return new CRM_Mailing_MailStore_Localdir($dao->source);
  73
  74       // DO NOT USE the mbox transport for anything other than testing
  75       // in particular, it does not clear the mbox afterwards
  76
  77       case 'mbox':
  78         return new CRM_Mailing_MailStore_Mbox($dao->source);
  79
  80       default:
  81         throw new Exception("Unknown protocol {$dao->protocol}");
  82     }
  83   }
  84
  85   /**
  86    * Return all emails in the mail store
  87    *
  88    * @return array  array of ezcMail objects
  89    */
  90   public function allMails() {
  91     return $this->fetchNext(0);
  92   }
  93
  94   /**
  95    * Expunge the messages marked for deletion; stub function to be redefined by IMAP store
  96    */
  97   public function expunge() {
  98   }
  99
 100   /**
 101    * Return the next X messages from the mail store
 102    *
 103    * @param int $count
 104    *   Number of messages to fetch (0 to fetch all).
 105    *
 106    * @return array      array of ezcMail objects
 107    */
 108   public function fetchNext($count = 1) {
 109     if (isset($this->_transport->options->uidReferencing) and $this->_transport->options->uidReferencing) {
 110       $offset = array_shift($this->_transport->listUniqueIdentifiers());
 111     }
 112     else {
 113       $offset = 1;
 114     }
 115     try {
 116       $set = $this->_transport->fetchFromOffset($offset, $count);
 117       if ($this->_debug) {
 118         print "fetching $count messages\n";
 119       }
 120     }
 121     catch(ezcMailOffsetOutOfRangeException$e) {
 122       if ($this->_debug) {
 123         print "got to the end of the mailbox\n";
 124       }
 125       return array();
 126     }
 127     $mails = array();
 128     $parser = new ezcMailParser;
 129     //set property text attachment as file CRM-5408
 130     $parser->options->parseTextAttachmentsAsFiles = TRUE;
 131
 132     foreach ($set->getMessageNumbers() as $nr) {
 133       if ($this->_debug) {
 134         print "retrieving message $nr\n";
 135       }
 136       $single = $parser->parseMail($this->_transport->fetchByMessageNr($nr));
 137       $mails[$nr] = $single[0];
 138     }
 139     return $mails;
 140   }
 141
 142   /**
 143    * Point to (and create if needed) a local Maildir for storing retrieved mail
 144    *
 145    * @param string $name
 146    *   Name of the Maildir.
 147    *
 148    * @throws Exception
 149    * @return string       path to the Maildir's cur directory
 150    */
 151   public function maildir($name) {
 152     $config = CRM_Core_Config::singleton();
 153     $dir = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $name;
 154     foreach (array(
 155       'cur', 'new', 'tmp') as $sub) {
 156       if (!file_exists($dir . DIRECTORY_SEPARATOR . $sub)) {
 157         if ($this->_debug) {
 158           print "creating $dir/$sub\n";
 159         }
 160         if (!mkdir($dir . DIRECTORY_SEPARATOR . $sub, 0700, TRUE)) {
 161           throw new Exception('Could not create ' . $dir . DIRECTORY_SEPARATOR . $sub);
 162         }
 163       }
 164     }
 165     return $dir . DIRECTORY_SEPARATOR . 'cur';
 166   }
 167 }