AnalyticsConsent.php — WP STAGING – WordPress Backups, Restore, Migration & Clone 4.11.0

wp-staging / Framework / Analytics / AnalyticsConsent.php

wp-staging / Framework / Analytics Last commit date

Actions 1 day ago AnalyticsCleanup.php 1 day ago AnalyticsConsent.php 1 day ago AnalyticsEventDto.php 1 day ago AnalyticsEventWithTimeDto.php 1 day ago AnalyticsGenericEventHandler.php 1 day ago AnalyticsSender.php 1 day ago ErrorCode.php 1 day ago WithAnalyticsAPI.php 1 day ago WithAnalyticsSiteInfo.php 1 day ago

AnalyticsConsent.php

199 lines

1	<?php
2
3	namespace WPStaging\Framework\Analytics;
4
5	use WPStaging\Framework\Notices\Notices;
6	use WPStaging\Core\WPStaging;
7
8	use function WPStaging\functions\debug_log;
9
10	class AnalyticsConsent
11	{
12	use WithAnalyticsAPI;
13
14	const OPTION_NAME_ANALYTICS_HAS_CONSENT = 'wpstg_analytics_has_consent';
15	const OPTION_NAME_ANALYTICS_NOTICE_DISMISSED = 'wpstg_analytics_notice_dismissed';
16	const OPTION_NAME_ANALYTICS_MODAL_DISMISSED = 'wpstg_analytics_modal_dismissed';
17	const OPTION_NAME_ANALYTICS_REMIND_ME = 'wpstg_analytics_consent_remind_me';
18
19
20
21
22
23	public function maybeShowConsentFailureNotice()
24	{
25
26	if (!WPStaging::make(Notices::class)->isWPStagingAdminPage()) {
27	return;
28	}
29
30
31	if (!isset($_GET['wpstgConsentFailed'])) {
32	return;
33	}
34
35	$notice = WPSTG_VIEWS_DIR . 'notices/analytics-consent-failed.php';
36
37	if (!file_exists($notice)) {
38	return;
39	}
40
41	include_once $notice;
42	}
43
44
45
46
47
48	public function listenForConsent()
49	{
50
51	if (!isset($_GET['wpstgConsent'])) {
52	return;
53	}
54
55
56	if (!current_user_can('manage_options')) {
57	return;
58	}
59
60
61	check_ajax_referer('wpstg_consent_nonce', 'wpstgConsentNonce');
62
63	if ($_GET['wpstgConsent'] == 'later') {
64	update_option(self::OPTION_NAME_ANALYTICS_MODAL_DISMISSED, '1', false);
65	update_option(self::OPTION_NAME_ANALYTICS_REMIND_ME, strtotime('+7 days'), false);
66
67	return;
68	}
69
70
71	if ($_GET['wpstgConsent'] == 'no') {
72	update_option(self::OPTION_NAME_ANALYTICS_NOTICE_DISMISSED, '1', false);
73	update_option(self::OPTION_NAME_ANALYTICS_MODAL_DISMISSED, '1', false);
74	update_option(self::OPTION_NAME_ANALYTICS_HAS_CONSENT, '0', false);
75	delete_option(self::OPTION_NAME_ANALYTICS_REMIND_ME);
76
77	add_action(Notices::ACTION_ADMIN_NOTICES, [$this, 'showNoticeConsentRefused']);
78
79	return;
80	}
81
82	if ($_GET['wpstgConsent'] == 'yes') {
83	try {
84	$this->giveConsent();
85	} catch (\Exception $e) {
86
87	wp_redirect(add_query_arg([
88	'wpstgConsentFailed' => true,
89	], $this->getReturnUrl()));
90	exit;
91	}
92
93	update_option(self::OPTION_NAME_ANALYTICS_NOTICE_DISMISSED, '1', false);
94	update_option(self::OPTION_NAME_ANALYTICS_MODAL_DISMISSED, '1', false);
95	update_option(self::OPTION_NAME_ANALYTICS_HAS_CONSENT, '1', false);
96	delete_option(self::OPTION_NAME_ANALYTICS_REMIND_ME);
97	}
98	}
99
100	public function showNoticeConsentRefused()
101	{
102	$notice = WPSTG_VIEWS_DIR . 'notices/analytics-consent-refused.php';
103
104	if (!file_exists($notice)) {
105	return;
106	}
107
108	include_once $notice;
109	}
110
111
112
113
114
115
116	public function giveConsent()
117	{
118	$url = $this->getApiUrl('consent');
119
120	$response = wp_remote_post($url, [
121	'method' => 'POST',
122	'headers' => ['Content-Type' => 'application/json; charset=utf-8'],
123	'body' => json_encode([
124	'site_hash' => $this->getSiteHash(),
125	'site_url' => get_home_url(),
126	]),
127	'data_format' => 'body',
128	'timeout' => 10,
129	'redirection' => 5,
130	'httpversion' => '1.0',
131	'blocking' => true,
132	'sslverify' => false,
133	]);
134
135
136	if (is_wp_error($response) \|\| !in_array(wp_remote_retrieve_response_code($response), [201, 409])) {
137	$errorMessage = is_wp_error($response) ? $response->get_error_message() : wp_remote_retrieve_body($response);
138	debug_log('WP STAGING Analytics Send Error: ' . $errorMessage, 'debug');
139
140
141	update_option(self::OPTION_NAME_ANALYTICS_NOTICE_DISMISSED, '1', false);
142
143
144	update_option(self::OPTION_NAME_ANALYTICS_MODAL_DISMISSED, '1', false);
145
146
147	update_option(self::OPTION_NAME_ANALYTICS_HAS_CONSENT, '1', false);
148
149	throw new \Exception();
150	}
151	}
152
153
154
155
156	public function hasUserConsent()
157	{
158	return get_option(self::OPTION_NAME_ANALYTICS_HAS_CONSENT, null);
159	}
160
161
162
163
164
165	public function invalidateConsent()
166	{
167	delete_option(self::OPTION_NAME_ANALYTICS_NOTICE_DISMISSED);
168	delete_option(self::OPTION_NAME_ANALYTICS_HAS_CONSENT);
169	}
170
171	protected function getReturnUrl(): string
172	{
173	global $pagenow, $plugin_page;
174
175	return add_query_arg('page', $plugin_page, admin_url($pagenow));
176	}
177
178
179
180
181
182
183	public function getConsentLink(bool $agreeOrDecline): string
184	{
185	return add_query_arg([
186	'wpstgConsent' => $agreeOrDecline ? 'yes' : 'no',
187	'wpstgConsentNonce' => wp_create_nonce('wpstg_consent_nonce'),
188	], $this->getReturnUrl());
189	}
190
191	public function getRemindMeLaterConsentLink(): string
192	{
193	return add_query_arg([
194	'wpstgConsent' => 'later',
195	'wpstgConsentNonce' => wp_create_nonce('wpstg_consent_nonce'),
196	], $this->getReturnUrl());
197	}
198	}
199