cache the hooked url value
[civicrm-core.git] / CRM / Mailing / BAO / TrackableURL.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_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 = [];
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
77 $tracker = new CRM_Mailing_BAO_TrackableURL();
78 if (preg_match('/^href/i', $url)) {
79 $url = preg_replace('/^href[ ]*=[ ]*[\'"](.*?)[\'"]$/i', '$1', $url);
80 $hrefExists = TRUE;
81 }
82
83 $tracker->url = $url;
84 $tracker->mailing_id = $mailing_id;
85
86 if (!$tracker->find(TRUE)) {
87 $tracker->save();
88 }
89 $id = $tracker->id;
90
91 $redirect = CRM_Utils_System::externUrl('extern/url', "u=$id");
92 $urlCache[$mailing_id . $url] = $redirect;
93 }
94
95 $returnUrl = CRM_Utils_System::externUrl('extern/url', "u=$id&qid=$queue_id");
96
97 if ($hrefExists) {
98 $returnUrl = "href='{$returnUrl}' rel='nofollow'";
99 }
100
101 return $returnUrl;
102 }
103
104 /**
105 * @param $url
106 * @param $mailing_id
107 *
108 * @return int
109 * Url id of the given url and mail
110 */
111 public static function getTrackerURLId($url, $mailing_id) {
112 $tracker = new CRM_Mailing_BAO_TrackableURL();
113 $tracker->url = $url;
114 $tracker->mailing_id = $mailing_id;
115 if ($tracker->find(TRUE)) {
116 return $tracker->id;
117 }
118
119 return NULL;
120 }
121
122 }