137eb8894SGreg Roach<?php 23976b470SGreg Roach 337eb8894SGreg Roach/** 437eb8894SGreg Roach * webtrees: online genealogy 537eb8894SGreg Roach * Copyright (C) 2019 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 1537eb8894SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>. 1637eb8894SGreg Roach */ 17fcfa147eSGreg Roach 1837eb8894SGreg Roachdeclare(strict_types=1); 1937eb8894SGreg Roach 2037eb8894SGreg Roachnamespace Fisharebest\Webtrees\Module; 2137eb8894SGreg Roach 2237eb8894SGreg Roachuse Fisharebest\Webtrees\Auth; 2337eb8894SGreg Roachuse Fisharebest\Webtrees\Tree; 240c0910bfSGreg Roachuse Psr\Http\Message\ServerRequestInterface; 25f3874e19SGreg Roach 265229eadeSGreg Roachuse function assert; 2737eb8894SGreg Roach 2837eb8894SGreg Roach/** 2937eb8894SGreg Roach * Class GoogleAnalyticsModule - add support for Google analytics. 3037eb8894SGreg Roach */ 31abafa13cSGreg Roachclass GoogleAnalyticsModule extends AbstractModule implements ModuleAnalyticsInterface, ModuleConfigInterface, ModuleExternalUrlInterface, ModuleGlobalInterface 3237eb8894SGreg Roach{ 3337eb8894SGreg Roach use ModuleAnalyticsTrait; 348e5c5efeSGreg Roach use ModuleConfigTrait; 358e5c5efeSGreg Roach use ModuleExternalUrlTrait; 36abafa13cSGreg Roach use ModuleGlobalTrait; 3737eb8894SGreg Roach 3837eb8894SGreg Roach /** 390cfd6963SGreg Roach * How should this module be identified in the control panel, etc.? 4037eb8894SGreg Roach * 4137eb8894SGreg Roach * @return string 4237eb8894SGreg Roach */ 435699f0a8SGreg Roach public function title(): string 445699f0a8SGreg Roach { 4537eb8894SGreg Roach return 'Google™ analytics'; 4637eb8894SGreg Roach } 4737eb8894SGreg Roach 4837eb8894SGreg Roach /** 49abafa13cSGreg Roach * Should this module be enabled when it is first installed? 50abafa13cSGreg Roach * 51abafa13cSGreg Roach * @return bool 52abafa13cSGreg Roach */ 53abafa13cSGreg Roach public function isEnabledByDefault(): bool 54abafa13cSGreg Roach { 55abafa13cSGreg Roach return false; 56abafa13cSGreg Roach } 57abafa13cSGreg Roach 58abafa13cSGreg Roach /** 5937eb8894SGreg Roach * Form fields to edit the parameters. 6037eb8894SGreg Roach * 6137eb8894SGreg Roach * @return string 6237eb8894SGreg Roach */ 6337eb8894SGreg Roach public function analyticsFormFields(): string 6437eb8894SGreg Roach { 658e5c5efeSGreg Roach return view('modules/google-analytics/form', $this->analyticsParameters()); 6637eb8894SGreg Roach } 6737eb8894SGreg Roach 6837eb8894SGreg Roach /** 6937eb8894SGreg Roach * Home page for the service. 7037eb8894SGreg Roach * 7137eb8894SGreg Roach * @return string 7237eb8894SGreg Roach */ 738e5c5efeSGreg Roach public function externalUrl(): string 7437eb8894SGreg Roach { 7537eb8894SGreg Roach return 'https://www.google.com/analytics'; 7637eb8894SGreg Roach } 7737eb8894SGreg Roach 7837eb8894SGreg Roach /** 7937eb8894SGreg Roach * The parameters that need to be embedded in the snippet. 8037eb8894SGreg Roach * 8137eb8894SGreg Roach * @return string[] 8237eb8894SGreg Roach */ 8337eb8894SGreg Roach public function analyticsParameters(): array 8437eb8894SGreg Roach { 8537eb8894SGreg Roach return [ 86*afc4f177SGreg Roach 'GOOGLE_ANALYTICS_ID' => $this->getPreference('GOOGLE_ANALYTICS_ID'), 8737eb8894SGreg Roach ]; 8837eb8894SGreg Roach } 8937eb8894SGreg Roach 9037eb8894SGreg Roach /** 9137eb8894SGreg Roach * Embed placeholders in the snippet. 9237eb8894SGreg Roach * 9337eb8894SGreg Roach * @param string[] $parameters 9437eb8894SGreg Roach * 9537eb8894SGreg Roach * @return string 9637eb8894SGreg Roach */ 9737eb8894SGreg Roach public function analyticsSnippet(array $parameters): string 9837eb8894SGreg Roach { 990c0910bfSGreg Roach $request = app(ServerRequestInterface::class); 1000c0910bfSGreg Roach 10137eb8894SGreg Roach // Add extra dimensions (i.e. filtering categories) 1020c0910bfSGreg Roach $tree = $request->getAttribute('tree'); 1030c0910bfSGreg Roach $user = $request->getAttribute('user'); 10437eb8894SGreg Roach 10537eb8894SGreg Roach $parameters['dimensions'] = (object) [ 10637eb8894SGreg Roach 'dimension1' => $tree instanceof Tree ? $tree->name() : '-', 10737eb8894SGreg Roach 'dimension2' => $tree instanceof Tree ? Auth::accessLevel($tree, $user) : '-', 10837eb8894SGreg Roach ]; 10937eb8894SGreg Roach 1108e5c5efeSGreg Roach return view('modules/google-analytics/snippet', $parameters); 11137eb8894SGreg Roach } 112abafa13cSGreg Roach 113abafa13cSGreg Roach /** 114abafa13cSGreg Roach * Raw content, to be added at the end of the <head> element. 115abafa13cSGreg Roach * Typically, this will be <link> and <meta> elements. 116abafa13cSGreg Roach * 117abafa13cSGreg Roach * @return string 118abafa13cSGreg Roach */ 119abafa13cSGreg Roach public function headContent(): string 120abafa13cSGreg Roach { 121abafa13cSGreg Roach if ($this->analyticsCanShow()) { 122abafa13cSGreg Roach return $this->analyticsSnippet($this->analyticsParameters()); 123abafa13cSGreg Roach } 124abafa13cSGreg Roach 125abafa13cSGreg Roach return ''; 126abafa13cSGreg Roach } 12737eb8894SGreg Roach} 128