قرینه از
https://github.com/matomo-org/matomo.git
synced 2025-08-21 22:47:43 +00:00
9a3ef94df6
* [Coding Style] Enable rule PSR12.Files.FileHeader * Apply CS * Replace Piwik with Matomo in file headers * Unify file headers (position, no. of lines, https links) * Rebuild dist files * Apply CS * Fix system test that relies on line numbers in a file that had the file header updated --------- Co-authored-by: Stefan Giehl <stefan@matomo.org>
82 خطوط
3.1 KiB
PHP
82 خطوط
3.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Matomo - free/libre analytics platform
|
|
*
|
|
* @link https://matomo.org
|
|
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
|
*/
|
|
|
|
namespace Piwik\Plugins\JsTrackerInstallCheck;
|
|
|
|
use Piwik\Piwik;
|
|
use Piwik\Site;
|
|
use Piwik\UrlHelper;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class API extends \Piwik\Plugin\API
|
|
{
|
|
/**
|
|
* @var JsTrackerInstallCheck
|
|
*/
|
|
protected $jsTrackerInstallCheck;
|
|
|
|
// disables automatic sanitizing for all public API methods in this class
|
|
protected $autoSanitizeInputParams = false;
|
|
|
|
public function __construct(JsTrackerInstallCheck $jsTrackerInstallCheck)
|
|
{
|
|
$this->jsTrackerInstallCheck = $jsTrackerInstallCheck;
|
|
}
|
|
|
|
/**
|
|
* Check whether a test request has been recorded for the provided nonce. If no request has been recorded or the
|
|
* nonce isn't found, return false. This also returns the main URL for the specified site so that we can auto-
|
|
* populate an input with it.
|
|
*
|
|
* @param int $idSite
|
|
* @param string $nonce Optional nonce string. If provided, it validates whether the success response matches the
|
|
* provided nonce. If omitted, it simply returns the most recent result for the provided site.
|
|
* @return array Indicates whether the check was successful and provides the main URL for the specified site.
|
|
* E.g. ['isSuccess' => true, 'mainUrl' => 'https://some-test-site.com']
|
|
* @throws \Exception If the user doesn't have the right permissions
|
|
*/
|
|
public function wasJsTrackerInstallTestSuccessful(int $idSite, string $nonce = ''): array
|
|
{
|
|
Piwik::checkUserHasViewAccess($idSite);
|
|
|
|
if (!empty($nonce) && !\preg_match('/^[a-f0-9]{32}$/i', $nonce)) {
|
|
throw new \Exception('The provided nonce is invalid.');
|
|
}
|
|
|
|
return [
|
|
'isSuccess' => $this->jsTrackerInstallCheck->checkForJsTrackerInstallTestSuccess($idSite, $nonce),
|
|
'mainUrl' => Site::getMainUrlFor($idSite),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Initiate a test whether the JS tracking code has been successfully installed for a site. It generates a nonce and
|
|
* stores it in the option table so that it can be accessed later during the Tracker.isExcludedVisit event.
|
|
*
|
|
* @param int $idSite
|
|
* @param string $url Optional URL to append the nonce to. If not provided, it uses the main URL of the site
|
|
* @return array containing the URL constructed using the main URL for the site and the newly created nonce as a
|
|
* query parameter.
|
|
* E.g. ['url' => 'https://some-site.com?tracker_install_check=c3dfa1abbbab6381baca0793b8dd5d', 'nonce' => 'c3dfa1abbbab6381baca0793b8dd5d']
|
|
* @throws \Exception If the user doesn't have the right permissions
|
|
*/
|
|
public function initiateJsTrackerInstallTest(int $idSite, string $url = ''): array
|
|
{
|
|
Piwik::checkUserHasViewAccess($idSite);
|
|
|
|
if (!empty($url) && !UrlHelper::isLookLikeUrl($url)) {
|
|
throw new \Exception(Piwik::translate('SitesManager_ExceptionInvalidUrl', $url));
|
|
}
|
|
|
|
return $this->jsTrackerInstallCheck->initiateJsTrackerInstallTest($idSite, $url);
|
|
}
|
|
}
|