CRM/Mailing/BAO/BouncePattern.php

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