Lines: 82.84%
| Line | Hits | Source |
|---|---|---|
| 1 | <?php | |
| 2 | ||
| 3 | declare(strict_types=1); | |
| 4 | ||
| 5 | namespace Drupal\visitors\Service; | |
| 6 | ||
| 7 | use Drupal\visitors\VisitorsCampaignInterface; | |
| 8 | ||
| 9 | /** | |
| 10 | * Campaign service for parsing marketing campaign parameters. | |
| 11 | * | |
| 12 | * Accepts a query string or a landing URL. Campaign name and keyword follow | |
| 13 | * Matomo's parameter order. The name is taken from the query before the | |
| 14 | * fragment. | |
| 15 | */ | |
| 16 | class CampaignService implements VisitorsCampaignInterface { | |
| 17 | ||
| 18 | /** | |
| 19 | * Campaign name parameters, in Matomo's order. | |
| 20 | * | |
| 21 | * Source and medium count as the name when no earlier name is present. | |
| 22 | */ | |
| 23 | private const NAME_PARAMETERS = [ | |
| 24 | 'pk_cpn', | |
| 25 | 'pk_campaign', | |
| 26 | 'piwik_campaign', | |
| 27 | 'mtm_campaign', | |
| 28 | 'matomo_campaign', | |
| 29 | 'utm_campaign', | |
| 30 | 'utm_source', | |
| 31 | 'utm_medium', | |
| 32 | '_rcn', | |
| 33 | ]; | |
| 34 | ||
| 35 | /** | |
| 36 | * Campaign keyword parameters. | |
| 37 | * | |
| 38 | * The legacy mtm_keyword parameter stays ahead of mtm_kwd. | |
| 39 | */ | |
| 40 | private const KEYWORD_PARAMETERS = [ | |
| 41 | 'pk_kwd', | |
| 42 | 'pk_keyword', | |
| 43 | 'piwik_kwd', | |
| 44 | 'mtm_keyword', | |
| 45 | 'mtm_kwd', | |
| 46 | 'matomo_kwd', | |
| 47 | 'utm_term', | |
| 48 | '_rck', | |
| 49 | ]; | |
| 50 | ||
| 51 | /** | |
| 52 | * {@inheritdoc} | |
| 53 | */ | |
| 54 | public function parse(?string $query): ?array { | |
| 55 | 18 | if ($query === NULL || $query === '') { |
| 56 | 2 | return NULL; |
| 57 | } | |
| 58 | ||
| 59 | 16 | $params = $this->parameters($query); |
| 60 | 16 | if ($params === []) { |
| 61 | 9 | return NULL; |
| 62 | } | |
| 63 | ||
| 64 | 16 | $campaign_data = []; |
| 65 | 0 | $dimensions = [ |
| 66 | 0 | 'mtm_source' => 'source', |
| 67 | 0 | 'pk_source' => 'source', |
| 68 | 0 | 'utm_source' => 'source', |
| 69 | 0 | 'mtm_medium' => 'medium', |
| 70 | 0 | 'pk_medium' => 'medium', |
| 71 | 0 | 'utm_medium' => 'medium', |
| 72 | 0 | 'mtm_content' => 'content', |
| 73 | 0 | 'pk_content' => 'content', |
| 74 | 0 | 'utm_content' => 'content', |
| 75 | 0 | 'mtm_cid' => 'campaign_id', |
| 76 | 0 | 'pk_cid' => 'campaign_id', |
| 77 | 0 | 'utm_id' => 'campaign_id', |
| 78 | 0 | 'mtm_group' => 'group', |
| 79 | 0 | 'pk_group' => 'group', |
| 80 | 0 | 'mtm_placement' => 'placement', |
| 81 | 0 | 'pk_placement' => 'placement', |
| 82 | 0 | ]; |
| 83 | 16 | foreach ($dimensions as $param => $key) { |
| 84 | 16 | $value = $this->scalarValue($params, $param); |
| 85 | 16 | if ($value !== NULL && !isset($campaign_data[$key])) { |
| 86 | 10 | $campaign_data[$key] = $value; |
| 87 | } | |
| 88 | } | |
| 89 | ||
| 90 | 16 | $name = $this->firstValue($params, self::NAME_PARAMETERS); |
| 91 | 16 | if ($name !== NULL) { |
| 92 | 13 | $campaign_data['campaign'] = $name; |
| 93 | } | |
| 94 | 16 | $keyword = $this->firstValue($params, self::KEYWORD_PARAMETERS); |
| 95 | 16 | if ($keyword !== NULL) { |
| 96 | 7 | $campaign_data['keyword'] = $keyword; |
| 97 | } | |
| 98 | ||
| 99 | 16 | return $campaign_data === [] ? NULL : $campaign_data; |
| 100 | } | |
| 101 | ||
| 102 | /** | |
| 103 | * {@inheritdoc} | |
| 104 | */ | |
| 105 | public function build(string $url, array $parameters): string { | |
| 106 | 6 | $url = trim($url); |
| 107 | 6 | if (!str_starts_with($url, 'http')) { |
| 108 | 1 | $url = 'https://' . $url; |
| 109 | } | |
| 110 | ||
| 111 | 6 | $fragment = ''; |
| 112 | 6 | $hash_pos = strpos($url, '#'); |
| 113 | 6 | if ($hash_pos !== FALSE) { |
| 114 | 1 | $fragment = substr($url, $hash_pos); |
| 115 | 1 | $url = substr($url, 0, $hash_pos); |
| 116 | } | |
| 117 | ||
| 118 | // A host with no path gets a trailing slash, matching Matomo. | |
| 119 | 6 | if (strpos($url, '/', 10) === FALSE && strpos($url, '?') === FALSE) { |
| 120 | 1 | $url .= '/'; |
| 121 | } | |
| 122 | ||
| 123 | 6 | $campaign = trim((string) ($parameters['campaign'] ?? '')); |
| 124 | 6 | $query = 'mtm_campaign=' . rawurlencode($campaign); |
| 125 | ||
| 126 | 0 | $optional = [ |
| 127 | 0 | 'keyword' => 'mtm_kwd', |
| 128 | 0 | 'source' => 'mtm_source', |
| 129 | 0 | 'medium' => 'mtm_medium', |
| 130 | 0 | 'content' => 'mtm_content', |
| 131 | 0 | 'campaign_id' => 'mtm_cid', |
| 132 | 0 | 'group' => 'mtm_group', |
| 133 | 0 | 'placement' => 'mtm_placement', |
| 134 | 0 | ]; |
| 135 | 6 | foreach ($optional as $key => $param) { |
| 136 | 6 | $value = trim((string) ($parameters[$key] ?? '')); |
| 137 | 6 | if ($value !== '') { |
| 138 | 2 | $query .= '&' . $param . '=' . rawurlencode($value); |
| 139 | } | |
| 140 | } | |
| 141 | ||
| 142 | 6 | $separator = strpos($url, '?') !== FALSE ? '&' : '?'; |
| 143 | 6 | return $url . $separator . $query . $fragment; |
| 144 | } | |
| 145 | ||
| 146 | /** | |
| 147 | * {@inheritdoc} | |
| 148 | */ | |
| 149 | public function strip(string $url): string { | |
| 150 | 11 | if ($url === '' || (!str_contains($url, '?') && !str_contains($url, '#'))) { |
| 151 | 9 | return $url; |
| 152 | } | |
| 153 | ||
| 154 | 4 | $parts = parse_url($url); |
| 155 | 4 | if (!is_array($parts)) { |
| 156 | 0 | return $url; |
| 157 | } | |
| 158 | ||
| 159 | 4 | $remove = array_fill_keys($this->urlParameterNames(), TRUE); |
| 160 | 4 | $changed = FALSE; |
| 161 | 4 | if (isset($parts['query'])) { |
| 162 | 4 | $params = []; |
| 163 | 4 | parse_str($parts['query'], $params); |
| 164 | 4 | if ($this->hasCampaignParameter($params, $remove)) { |
| 165 | 1 | $changed = TRUE; |
| 166 | 1 | $query = $this->withoutCampaignParameters($params, $remove); |
| 167 | 1 | if ($query === '') { |
| 168 | 0 | unset($parts['query']); |
| 169 | } | |
| 170 | else { | |
| 171 | 1 | $parts['query'] = $query; |
| 172 | } | |
| 173 | } | |
| 174 | } | |
| 175 | 4 | if (isset($parts['fragment']) && str_contains($parts['fragment'], '=')) { |
| 176 | 2 | $params = []; |
| 177 | 2 | parse_str($parts['fragment'], $params); |
| 178 | 2 | if ($this->hasCampaignParameter($params, $remove)) { |
| 179 | 2 | $changed = TRUE; |
| 180 | 2 | $fragment = $this->withoutCampaignParameters($params, $remove); |
| 181 | 2 | if ($fragment === '') { |
| 182 | 1 | unset($parts['fragment']); |
| 183 | } | |
| 184 | else { | |
| 185 | 1 | $parts['fragment'] = $fragment; |
| 186 | } | |
| 187 | } | |
| 188 | } | |
| 189 | 4 | if (!$changed) { |
| 190 | 4 | return $url; |
| 191 | } | |
| 192 | ||
| 193 | 2 | return $this->assembleUrl($parts); |
| 194 | } | |
| 195 | ||
| 196 | /** | |
| 197 | * Reads query and fragment parameters from a query string or URL. | |
| 198 | * | |
| 199 | * @param string $value | |
| 200 | * A query string or an absolute URL. | |
| 201 | * | |
| 202 | * @return array | |
| 203 | * Decoded parameters. Query values win over the fragment. | |
| 204 | */ | |
| 205 | protected function parameters(string $value): array { | |
| 206 | 16 | $query = $value; |
| 207 | 16 | $fragment = ''; |
| 208 | 16 | if (str_contains($value, '://') || str_starts_with($value, '?')) { |
| 209 | 11 | $parts = parse_url($value); |
| 210 | 11 | if (is_array($parts)) { |
| 211 | 11 | $query = $parts['query'] ?? ''; |
| 212 | 11 | $fragment = $parts['fragment'] ?? ''; |
| 213 | } | |
| 214 | } | |
| 215 | ||
| 216 | 16 | $params = []; |
| 217 | 16 | if ($query !== '') { |
| 218 | 15 | parse_str($query, $params); |
| 219 | } | |
| 220 | 16 | if ($fragment !== '' && str_contains($fragment, '=')) { |
| 221 | 1 | $fragment_params = []; |
| 222 | 1 | parse_str($fragment, $fragment_params); |
| 223 | 1 | foreach ($fragment_params as $key => $item) { |
| 224 | 1 | if (!isset($params[$key]) || $params[$key] === '') { |
| 225 | 1 | $params[$key] = $item; |
| 226 | } | |
| 227 | } | |
| 228 | } | |
| 229 | ||
| 230 | 16 | return $params; |
| 231 | } | |
| 232 | ||
| 233 | /** | |
| 234 | * Returns the first non-empty parameter. | |
| 235 | * | |
| 236 | * @param array $params | |
| 237 | * Decoded parameters. | |
| 238 | * @param string[] $keys | |
| 239 | * Parameter names, highest priority first. | |
| 240 | * | |
| 241 | * @return string|null | |
| 242 | * The trimmed value, or NULL when every key is empty. | |
| 243 | */ | |
| 244 | protected function firstValue(array $params, array $keys): ?string { | |
| 245 | 16 | foreach ($keys as $key) { |
| 246 | 16 | $value = $this->scalarValue($params, $key); |
| 247 | 16 | if ($value !== NULL) { |
| 248 | 13 | return $value; |
| 249 | } | |
| 250 | } | |
| 251 | 9 | return NULL; |
| 252 | } | |
| 253 | ||
| 254 | /** | |
| 255 | * Returns a trimmed string parameter. | |
| 256 | * | |
| 257 | * @param array $params | |
| 258 | * Decoded parameters. | |
| 259 | * @param string $key | |
| 260 | * The parameter name. | |
| 261 | * | |
| 262 | * @return string|null | |
| 263 | * The trimmed value, or NULL when it is missing or not a string. | |
| 264 | */ | |
| 265 | protected function scalarValue(array $params, string $key): ?string { | |
| 266 | 16 | $value = $params[$key] ?? NULL; |
| 267 | 16 | if (!is_string($value)) { |
| 268 | 16 | return NULL; |
| 269 | } | |
| 270 | 15 | $value = trim($value); |
| 271 | 15 | return $value === '' ? NULL : $value; |
| 272 | } | |
| 273 | ||
| 274 | /** | |
| 275 | * Campaign parameters removed from a stored page URL. | |
| 276 | * | |
| 277 | * @return string[] | |
| 278 | * Parameter names, including name, keyword, and dimension aliases. | |
| 279 | */ | |
| 280 | protected function urlParameterNames(): array { | |
| 281 | 4 | return [ |
| 282 | 4 | 'pk_cpn', |
| 283 | 4 | 'pk_campaign', |
| 284 | 4 | 'piwik_campaign', |
| 285 | 4 | 'mtm_campaign', |
| 286 | 4 | 'mtm_cpn', |
| 287 | 4 | 'matomo_campaign', |
| 288 | 4 | 'utm_campaign', |
| 289 | 4 | 'utm_source', |
| 290 | 4 | 'utm_medium', |
| 291 | 4 | 'pk_kwd', |
| 292 | 4 | 'pk_keyword', |
| 293 | 4 | 'piwik_kwd', |
| 294 | 4 | 'mtm_keyword', |
| 295 | 4 | 'mtm_kwd', |
| 296 | 4 | 'matomo_kwd', |
| 297 | 4 | 'utm_term', |
| 298 | 4 | 'mtm_source', |
| 299 | 4 | 'pk_source', |
| 300 | 4 | 'mtm_content', |
| 301 | 4 | 'pk_content', |
| 302 | 4 | 'utm_content', |
| 303 | 4 | 'mtm_cid', |
| 304 | 4 | 'pk_cid', |
| 305 | 4 | 'utm_id', |
| 306 | 4 | 'mtm_clid', |
| 307 | 4 | 'mtm_group', |
| 308 | 4 | 'pk_group', |
| 309 | 4 | 'mtm_placement', |
| 310 | 4 | 'pk_placement', |
| 311 | 4 | 'pk_medium', |
| 312 | 4 | ]; |
| 313 | } | |
| 314 | ||
| 315 | /** | |
| 316 | * Whether the parameters include a campaign key. | |
| 317 | * | |
| 318 | * @param array $params | |
| 319 | * Decoded parameters. | |
| 320 | * @param array<string, bool> $remove | |
| 321 | * Parameter names that belong to a campaign. | |
| 322 | * | |
| 323 | * @return bool | |
| 324 | * TRUE when one of those names is present. | |
| 325 | */ | |
| 326 | protected function hasCampaignParameter(array $params, array $remove): bool { | |
| 327 | 4 | foreach (array_keys($params) as $key) { |
| 328 | 4 | if (isset($remove[$key])) { |
| 329 | 2 | return TRUE; |
| 330 | } | |
| 331 | } | |
| 332 | 4 | return FALSE; |
| 333 | } | |
| 334 | ||
| 335 | /** | |
| 336 | * Drops campaign parameters from a parsed query or fragment. | |
| 337 | * | |
| 338 | * @param array $params | |
| 339 | * Decoded parameters. | |
| 340 | * @param array<string, bool> $remove | |
| 341 | * Parameter names to drop. | |
| 342 | * | |
| 343 | * @return string | |
| 344 | * The remaining parameters as a query string, or an empty string. | |
| 345 | */ | |
| 346 | protected function withoutCampaignParameters(array $params, array $remove): string { | |
| 347 | 2 | foreach (array_keys($params) as $key) { |
| 348 | 2 | if (isset($remove[$key])) { |
| 349 | 2 | unset($params[$key]); |
| 350 | } | |
| 351 | } | |
| 352 | 2 | return $params === [] ? '' : http_build_query($params); |
| 353 | } | |
| 354 | ||
| 355 | /** | |
| 356 | * Rebuilds a URL from parse_url() parts. | |
| 357 | * | |
| 358 | * @param array $parts | |
| 359 | * Parts returned by parse_url(). | |
| 360 | * | |
| 361 | * @return string | |
| 362 | * The assembled URL. | |
| 363 | */ | |
| 364 | protected function assembleUrl(array $parts): string { | |
| 365 | 2 | $scheme = isset($parts['scheme']) ? $parts['scheme'] . '://' : ''; |
| 366 | 2 | $user = $parts['user'] ?? ''; |
| 367 | 2 | $pass = isset($parts['pass']) ? ':' . $parts['pass'] : ''; |
| 368 | 2 | $auth = $user !== '' ? $user . $pass . '@' : ''; |
| 369 | 2 | $host = $parts['host'] ?? ''; |
| 370 | 2 | $port = isset($parts['port']) ? ':' . $parts['port'] : ''; |
| 371 | 2 | $path = $parts['path'] ?? ''; |
| 372 | 2 | $query = isset($parts['query']) && $parts['query'] !== '' |
| 373 | 1 | ? '?' . $parts['query'] |
| 374 | 1 | : ''; |
| 375 | 2 | $fragment = isset($parts['fragment']) ? '#' . $parts['fragment'] : ''; |
| 376 | ||
| 377 | 2 | return $scheme . $auth . $host . $port . $path . $query . $fragment; |
| 378 | } | |
| 379 | ||
| 380 | } |