137eb8894SGreg Roach<?php 23976b470SGreg Roach 337eb8894SGreg Roach/** 437eb8894SGreg Roach * webtrees: online genealogy 5*d11be702SGreg Roach * Copyright (C) 2023 webtrees development team 637eb8894SGreg Roach * This program is free software: you can redistribute it and/or modify 737eb8894SGreg Roach * it under the terms of the GNU General Public License as published by 837eb8894SGreg Roach * the Free Software Foundation, either version 3 of the License, or 937eb8894SGreg Roach * (at your option) any later version. 1037eb8894SGreg Roach * This program is distributed in the hope that it will be useful, 1137eb8894SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of 1237eb8894SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1337eb8894SGreg Roach * GNU General Public License for more details. 1437eb8894SGreg Roach * You should have received a copy of the GNU General Public License 1589f7189bSGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>. 1637eb8894SGreg Roach */ 17fcfa147eSGreg Roach 1837eb8894SGreg Roachdeclare(strict_types=1); 1937eb8894SGreg Roach 2037eb8894SGreg Roachnamespace Fisharebest\Webtrees\Module; 2137eb8894SGreg Roach 2276fa3e53SGreg Roachuse Fisharebest\Webtrees\Auth; 230ad7d82dSGreg Roachuse Fisharebest\Webtrees\I18N; 2476fa3e53SGreg Roach 25cba4b1ecSGreg Roachuse function str_ends_with; 26cba4b1ecSGreg Roach 2737eb8894SGreg Roach/** 2837eb8894SGreg Roach * Class MatomoAnalyticsModule - add support for Matomo analytics. 2937eb8894SGreg Roach */ 30abafa13cSGreg Roachclass MatomoAnalyticsModule extends AbstractModule implements ModuleAnalyticsInterface, ModuleConfigInterface, ModuleExternalUrlInterface, ModuleGlobalInterface 3137eb8894SGreg Roach{ 3237eb8894SGreg Roach use ModuleAnalyticsTrait; 338e5c5efeSGreg Roach use ModuleConfigTrait; 348e5c5efeSGreg Roach use ModuleExternalUrlTrait; 35abafa13cSGreg Roach use ModuleGlobalTrait; 3637eb8894SGreg Roach 3737eb8894SGreg Roach /** 380cfd6963SGreg Roach * How should this module be identified in the control panel, etc.? 3937eb8894SGreg Roach * 4037eb8894SGreg Roach * @return string 4137eb8894SGreg Roach */ 4237eb8894SGreg Roach public function title(): string 4337eb8894SGreg Roach { 440ad7d82dSGreg Roach return I18N::translate('Matomo™ / Piwik™ analytics'); 4537eb8894SGreg Roach } 4637eb8894SGreg Roach 4737eb8894SGreg Roach /** 48abafa13cSGreg Roach * Should this module be enabled when it is first installed? 49abafa13cSGreg Roach * 50abafa13cSGreg Roach * @return bool 51abafa13cSGreg Roach */ 52abafa13cSGreg Roach public function isEnabledByDefault(): bool 53abafa13cSGreg Roach { 54abafa13cSGreg Roach return false; 55abafa13cSGreg Roach } 56abafa13cSGreg Roach 57abafa13cSGreg Roach /** 5837eb8894SGreg Roach * Form fields to edit the parameters. 5937eb8894SGreg Roach * 6037eb8894SGreg Roach * @return string 6137eb8894SGreg Roach */ 6237eb8894SGreg Roach public function analyticsFormFields(): string 6337eb8894SGreg Roach { 648e5c5efeSGreg Roach return view('modules/matomo-analytics/form', $this->analyticsParameters()); 6537eb8894SGreg Roach } 6637eb8894SGreg Roach 6737eb8894SGreg Roach /** 6837eb8894SGreg Roach * Home page for the service. 6937eb8894SGreg Roach * 7037eb8894SGreg Roach * @return string 7137eb8894SGreg Roach */ 728e5c5efeSGreg Roach public function externalUrl(): string 7337eb8894SGreg Roach { 7437eb8894SGreg Roach return 'https://matomo.org'; 7537eb8894SGreg Roach } 7637eb8894SGreg Roach 7737eb8894SGreg Roach /** 7837eb8894SGreg Roach * The parameters that need to be embedded in the snippet. 7937eb8894SGreg Roach * 8024f2a3afSGreg Roach * @return array<string> 8137eb8894SGreg Roach */ 8237eb8894SGreg Roach public function analyticsParameters(): array 8337eb8894SGreg Roach { 84cba4b1ecSGreg Roach $matomo_site_id = $this->getPreference('MATOMO_SITE_ID'); 85cba4b1ecSGreg Roach $matomo_url = $this->getPreference('MATOMO_URL'); 86cba4b1ecSGreg Roach 87cba4b1ecSGreg Roach if (!str_ends_with($matomo_url, '/')) { 88cba4b1ecSGreg Roach $matomo_url .= '/'; 89cba4b1ecSGreg Roach } 90cba4b1ecSGreg Roach 9137eb8894SGreg Roach return [ 92cba4b1ecSGreg Roach 'MATOMO_SITE_ID' => $matomo_site_id, 93cba4b1ecSGreg Roach 'MATOMO_URL' => $matomo_url, 9437eb8894SGreg Roach ]; 9537eb8894SGreg Roach } 9637eb8894SGreg Roach 9737eb8894SGreg Roach /** 9837eb8894SGreg Roach * Embed placeholders in the snippet. 9937eb8894SGreg Roach * 10009482a55SGreg Roach * @param array<string> $parameters 10137eb8894SGreg Roach * 10237eb8894SGreg Roach * @return string 10337eb8894SGreg Roach */ 10437eb8894SGreg Roach public function analyticsSnippet(array $parameters): string 10537eb8894SGreg Roach { 10676fa3e53SGreg Roach $parameters['user'] = Auth::user(); 10776fa3e53SGreg Roach 1088e5c5efeSGreg Roach return view('modules/matomo-analytics/snippet', $parameters); 10937eb8894SGreg Roach } 110abafa13cSGreg Roach 111abafa13cSGreg Roach /** 112abafa13cSGreg Roach * Raw content, to be added at the end of the <head> element. 113abafa13cSGreg Roach * Typically, this will be <link> and <meta> elements. 114abafa13cSGreg Roach * 115abafa13cSGreg Roach * @return string 116abafa13cSGreg Roach */ 117abafa13cSGreg Roach public function headContent(): string 118abafa13cSGreg Roach { 119abafa13cSGreg Roach if ($this->analyticsCanShow()) { 120abafa13cSGreg Roach return $this->analyticsSnippet($this->analyticsParameters()); 121abafa13cSGreg Roach } 122abafa13cSGreg Roach 123abafa13cSGreg Roach return ''; 124abafa13cSGreg Roach } 12537eb8894SGreg Roach} 126