CRM/Mailing/BAO/TrackableURL.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33 class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL {
  34
  35   /**
  36    * Class constructor.
  37    */
  38   public function __construct() {
  39     parent::__construct();
  40   }
  41
  42   /**
  43    * Given a url, mailing id and queue event id, find or construct a
  44    * trackable url and redirect url.
  45    *
  46    * @param string $url
  47    *   The target url to track.
  48    * @param int $mailing_id
  49    *   The id of the mailing.
  50    * @param int $queue_id
  51    *   The queue event id (contact clicking through).
  52    *
  53    * @return string
  54    *   The redirect/tracking url
  55    */
  56   public static function getTrackerURL($url, $mailing_id, $queue_id) {
  57
  58     static $urlCache = array();
  59
  60     if (array_key_exists($mailing_id . $url, $urlCache)) {
  61       return $urlCache[$mailing_id . $url] . "&qid=$queue_id";
  62     }
  63
  64     // hack for basic CRM-1014 and CRM-1151 and CRM-3492 compliance:
  65     // let's not replace possible image URLs and CiviMail ones
  66     if (preg_match('/\.(png|jpg|jpeg|gif|css)[\'"]?$/i', $url)
  67       or substr_count($url, 'civicrm/extern/')
  68       or substr_count($url, 'civicrm/mailing/')
  69     ) {
  70       // let's not cache these, so they don't get &qid= appended to them
  71       return $url;
  72     }
  73     else {
  74
  75       $hrefExists = FALSE;
  76       $config = CRM_Core_Config::singleton();
  77
  78       $tracker = new CRM_Mailing_BAO_TrackableURL();
  79       if (preg_match('/^href/i', $url)) {
  80         $url = preg_replace('/^href[ ]*=[ ]*[\'"](.*?)[\'"]$/i', '$1', $url);
  81         $hrefExists = TRUE;
  82       }
  83
  84       $tracker->url = $url;
  85       $tracker->mailing_id = $mailing_id;
  86       if (strlen($tracker->url) > 254) {
  87         return $url;
  88       }
  89       if (!$tracker->find(TRUE)) {
  90         $tracker->save();
  91       }
  92       $id = $tracker->id;
  93       $tracker->free();
  94
  95       $redirect = $config->userFrameworkResourceURL . "extern/url.php?u=$id";
  96       $urlCache[$mailing_id . $url] = $redirect;
  97     }
  98
  99     $returnUrl = "{$urlCache[$mailing_id . $url]}&qid={$queue_id}";
 100
 101     if ($hrefExists) {
 102       $returnUrl = "href='{$returnUrl}'";
 103     }
 104
 105     return $returnUrl;
 106   }
 107
 108   /**
 109    * @param $url
 110    * @param $mailing_id
 111    *
 112    * @return int
 113    *   Url id of the given url and mail
 114    */
 115   public static function getTrackerURLId($url, $mailing_id) {
 116     $tracker = new CRM_Mailing_BAO_TrackableURL();
 117     $tracker->url = $url;
 118     $tracker->mailing_id = $mailing_id;
 119     if ($tracker->find(TRUE)) {
 120       return $tracker->id;
 121     }
 122
 123     return NULL;
 124   }
 125
 126   /**
 127    * @param $msg
 128    * @param int $mailing_id
 129    * @param int $queue_id
 130    * @param bool $onlyHrefs
 131    */
 132   public static function scan_and_replace(&$msg, $mailing_id, $queue_id, $onlyHrefs = FALSE) {
 133     if (!$mailing_id) {
 134       return;
 135     }
 136
 137     $protos = '(https?|ftp)';
 138     $letters = '\w';
 139     $gunk = '/#~:.?+=&%@!\-';
 140     $punc = '.:?\-';
 141     $any = "{$letters}{$gunk}{$punc}";
 142     if ($onlyHrefs) {
 143       $pattern = "{\\b(href=([\"'])?($protos:[$any]+?(?=[$punc]*[^$any]|$))([\"'])?)}im";
 144     }
 145     else {
 146       $pattern = "{\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))}eim";
 147     }
 148
 149     $trackURL = CRM_Mailing_BAO_TrackableURL::getTrackerURL('\\1', $mailing_id, $queue_id);
 150     $replacement = $onlyHrefs ? ("href=\"{$trackURL}\"") : ("\"{$trackURL}\"");
 151
 152     $msg = preg_replace($pattern, $replacement, $msg);
 153   }
 154
 155 }