forked from pkp/googleAnalytics
-
Notifications
You must be signed in to change notification settings - Fork 0
/
GoogleAnalyticsPlugin.inc.php
136 lines (119 loc) · 3.75 KB
/
GoogleAnalyticsPlugin.inc.php
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?php
/**
* @file plugins/generic/googleAnalytics/GoogleAnalyticsPlugin.inc.php
*
* Copyright (c) 2014-2018 Simon Fraser University
* Copyright (c) 2003-2018 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class GoogleAnalyticsPlugin
* @ingroup plugins_generic_googleAnalytics
*
* @brief Google Analytics plugin class
*/
import('lib.pkp.classes.plugins.GenericPlugin');
class GoogleAnalyticsPlugin extends GenericPlugin {
/**
* @copydoc Plugin::register()
*/
function register($category, $path, $mainContextId = null) {
$success = parent::register($category, $path, $mainContextId);
if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return true;
if ($success && $this->getEnabled($mainContextId)) {
// Insert Google Analytics page tag to footer
HookRegistry::register('TemplateManager::display', array($this, 'registerScript'));
}
return $success;
}
/**
* @copydoc Plugin::getDisplayName()
*/
function getDisplayName() {
return __('plugins.generic.googleAnalytics.displayName');
}
/**
* @copydoc Plugin::getDescription()
*/
function getDescription() {
return __('plugins.generic.googleAnalytics.description');
}
/**
* @copydoc Plugin::getActions()
*/
function getActions($request, $verb) {
$router = $request->getRouter();
import('lib.pkp.classes.linkAction.request.AjaxModal');
return array_merge(
$this->getEnabled()?array(
new LinkAction(
'settings',
new AjaxModal(
$router->url($request, null, null, 'manage', null, array('verb' => 'settings', 'plugin' => $this->getName(), 'category' => 'generic')),
$this->getDisplayName()
),
__('manager.plugins.settings'),
null
),
):array(),
parent::getActions($request, $verb)
);
}
/**
* @copydoc Plugin::manage()
*/
function manage($args, $request) {
switch ($request->getUserVar('verb')) {
case 'settings':
$context = $request->getContext();
AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON, LOCALE_COMPONENT_PKP_MANAGER);
$templateMgr = TemplateManager::getManager($request);
$templateMgr->register_function('plugin_url', array($this, 'smartyPluginUrl'));
$this->import('GoogleAnalyticsSettingsForm');
$form = new GoogleAnalyticsSettingsForm($this, $context->getId());
if ($request->getUserVar('save')) {
$form->readInputData();
if ($form->validate()) {
$form->execute();
return new JSONMessage(true);
}
} else {
$form->initData();
}
return new JSONMessage(true, $form->fetch($request));
}
return parent::manage($args, $request);
}
/**
* Register the Google Analytics script tag
* @param $hookName string
* @param $params array
*/
function registerScript($hookName, $params) {
$request = $this->getRequest();
$context = $request->getContext();
if (!$context) return false;
$router = $request->getRouter();
if (!is_a($router, 'PKPPageRouter')) return false;
$googleAnalyticsSiteId = $this->getSetting($context->getId(), 'googleAnalyticsSiteId');
if (empty($googleAnalyticsSiteId)) return false;
$googleAnalyticsCode = "
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', '$googleAnalyticsSiteId', 'auto');
ga('send', 'pageview');
";
$templateMgr = TemplateManager::getManager($request);
$templateMgr->addJavaScript(
'googleanalytics',
$googleAnalyticsCode,
array(
'priority' => STYLE_SEQUENCE_LAST,
'inline' => true,
)
);
return false;
}
}
?>