CRM/Utils/Verp.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  * Class to handle encoding and decoding Variable Enveleope Return Path (VERP)
  30  * headers.
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2014
  34  * $Id: $
  35  *
  36  */
  37 class CRM_Utils_Verp {
  38   /* Mapping of reserved characters to hex codes */
  39
  40   static $encodeMap = array(
  41     '+' => '2B',
  42     '@' => '40',
  43     ':' => '3A',
  44     '%' => '25',
  45     '!' => '21',
  46     '-' => '2D',
  47     '[' => '5B',
  48     ']' => '5D',
  49   );
  50
  51   /* Mapping of hex codes to reserved characters */
  52
  53   static $decodeMap = array(
  54     '40' => '@',
  55     '3A' => ':',
  56     '25' => '%',
  57     '21' => '!',
  58     '2D' => '-',
  59     '5B' => '[',
  60     '5D' => ']',
  61     '2B' => '+',
  62   );
  63
  64   /**
  65    * Encode the sender's address with the VERPed recipient.
  66    *
  67    * @param string $sender    The address of the sender
  68    * @param string $recipient The address of the recipient
  69    *
  70    * @return string           The VERP encoded address
  71    * @static
  72    */
  73   public static function encode($sender, $recipient) {
  74     preg_match('/(.+)\@([^\@]+)$/', $sender, $match);
  75     $slocal = $match[1];
  76     $sdomain = $match[2];
  77
  78     preg_match('/(.+)\@([^\@]+)$/', $recipient, $match);
  79     $rlocal = CRM_Utils_Array::value(1, $match);
  80     $rdomain = CRM_Utils_Array::value(2, $match);
  81
  82     foreach (self::$encodeMap as $char => $code) {
  83       $rlocal = preg_replace('/' . preg_quote($char) . '/i', "+$code", $rlocal);
  84       $rdomain = preg_replace('/' . preg_quote($char) . '/i', "+$code", $rdomain);
  85     }
  86
  87     return "$slocal-$rlocal=$rdomain@$sdomain";
  88   }
  89
  90   /**
  91    * Decode the address and return the sender and recipient as an array
  92    *
  93    * @param string $address   The address to be decoded
  94    *
  95    * @return array            The tuple ($sender, $recipient)
  96    * @static
  97    */
  98   public static function &verpdecode($address) {
  99     preg_match('/^(.+)-([^=]+)=([^\@]+)\@(.+)/', $address, $match);
 100
 101     $slocal  = $match[1];
 102     $rlocal  = $match[2];
 103     $rdomain = $match[3];
 104     $sdomain = $match[4];
 105
 106     foreach (self::$decodeMap as $code => $char) {
 107       $rlocal = preg_replace("/+$code/i", $char, $rlocal);
 108       $rdomain = preg_replace("/+$code/i", $char, $rdomain);
 109     }
 110
 111     return array("$slocal@$sdomain", "$rlocal@$rdomain");
 112   }
 113 }