1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik;
/**
* Methods related to changing the context Matomo code is running in.
*/
class Context
{
/**
* Temporarily overwrites the idSite parameter so all code executed by `$callback()`
* will use that idSite.
*
* Useful when you need to change the idSite context for a chunk of code. For example,
* if we are archiving for more than one site in sequence, we don't want to use
* the same caches for both archiving executions.
*
* @param string|int $idSite
* @param callable $callback
* @return mixed returns result of $callback
*/
public static function changeIdSite($idSite, $callback)
{
// temporarily set the idSite query parameter so archiving will end up using
// the correct site aware caches
$originalGetIdSite = isset($_GET['idSite']) ? $_GET['idSite'] : null;
$originalPostIdSite = isset($_POST['idSite']) ? $_POST['idSite'] : null;
$originalGetIdSites = isset($_GET['idSites']) ? $_GET['idSites'] : null;
$originalPostIdSites = isset($_POST['idSites']) ? $_POST['idSites'] : null;
$originalTrackerGetIdSite = isset($_GET['idsite']) ? $_GET['idsite'] : null;
$originalTrackerPostIdSite = isset($_POST['idsite']) ? $_POST['idsite'] : null;
try {
$_GET['idSite'] = $_POST['idSite'] = $idSite;
if (Tracker::$initTrackerMode) {
$_GET['idsite'] = $_POST['idsite'] = $idSite;
}
// idSites is a deprecated query param that is still in use. since it is deprecated and new
// supported code shouldn't rely on it, we can (more) safely unset it here, since we are just
// calling downstream matomo code. we unset it because we don't want it interfering w/
// code in $callback().
unset($_GET['idSites']);
unset($_POST['idSites']);
return $callback();
} finally {
self::resetIdSiteParam($_GET, 'idSite', $originalGetIdSite);
self::resetIdSiteParam($_POST, 'idSite', $originalPostIdSite);
self::resetIdSiteParam($_GET, 'idSites', $originalGetIdSites);
self::resetIdSiteParam($_POST, 'idSites', $originalPostIdSites);
self::resetIdSiteParam($_GET, 'idsite', $originalTrackerGetIdSite);
self::resetIdSiteParam($_POST, 'idsite', $originalTrackerPostIdSite);
}
}
private static function resetIdSiteParam(&$superGlobal, $paramName, $originalValue)
{
if ($originalValue !== null) {
$superGlobal[$paramName] = $originalValue;
} else {
unset($superGlobal[$paramName]);
}
}
}
|
