CRM/Mailing/BAO/BouncePattern.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_BAO_BouncePattern extends CRM_Mailing_DAO_BouncePattern {
  36
  37   /**
  38    * Pseudo-constant pattern array
  39    */
  40   static $_patterns = NULL;
  41
  42   /**
  43    * Class constructor
  44    */
  45   public function __construct() {
  46     parent::__construct();
  47   }
  48
  49   /**
  50    * Build the static pattern array
  51    *
  52    * @return void
  53    * @static
  54    */
  55   public static function buildPatterns() {
  56     self::$_patterns = array();
  57     $bp = new CRM_Mailing_BAO_BouncePattern();
  58     $bp->find();
  59
  60     while ($bp->fetch()) {
  61       self::$_patterns[$bp->bounce_type_id][] = $bp->pattern;
  62     }
  63
  64     foreach (self::$_patterns as $type => $patterns) {
  65       if (count($patterns) == 1) {
  66         self::$_patterns[$type] = '{(' . $patterns[0] . ')}im';
  67       }
  68       else {
  69         self::$_patterns[$type] = '{(' . implode(')|(', $patterns) . ')}im';
  70       }
  71     }
  72   }
  73
  74   /**
  75    * Try to match the string to a bounce type.
  76    *
  77    * @param string $message       The message to be matched
  78    *
  79    * @return array                Tuple (bounce_type, bounce_reason)
  80    * @static
  81    */
  82   public static function &match(&$message) {
  83     // clean up $message and replace all white space by a single space, CRM-4767
  84     $message = preg_replace('/\s+/', ' ', $message);
  85
  86     if (self::$_patterns == NULL) {
  87       self::buildPatterns();
  88     }
  89
  90     foreach (self::$_patterns as $type => $re) {
  91       if (preg_match($re, $message, $matches)) {
  92         $bounce = array(
  93           'bounce_type_id' => $type,
  94           'bounce_reason' => $message,
  95         );
  96         return $bounce;
  97       }
  98     }
  99
 100     $bounce = array(
 101       'bounce_type_id' => NULL,
 102       'bounce_reason' => $message,
 103     );
 104
 105     return $bounce;
 106   }
 107 }