CRM/Mailing/BAO/BouncePattern.php

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