give / src / Tracking / AdminActionHandler.php

AdminActionHandler.php in GiveWP – Donation Plugin and Fundraising Platform 2.33.5, at src/Tracking/AdminActionHandler.php

181 lines 4.9 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Tracking;
4
5	use Give\Tracking\Events\ActiveDonationFormsFirstTimeTracking;
6	use Give\Tracking\Events\DonationMetricsTracking;
7	use Give\Tracking\Events\GivePluginSettingsTracking;
8	use Give\Tracking\Events\PluginsTracking;
9	use Give\Tracking\Events\ThemeTracking;
10	use Give\Tracking\Repositories\Settings;
11	use Give\Tracking\Repositories\TelemetryAccessDetails;
12	use Give_Admin_Settings;
13
14	/**
15	* Class AdminActionHandler
16	* @package Give\Tracking
17	*
18	* This class uses to handle actions in WP Backed.
19	*
20	* @since 2.10.0
21	*/
22	class AdminActionHandler
23	{
24	/**
25	* @var UsageTrackingOnBoarding
26	*/
27	private $usageTrackingOnBoarding;
28
29	/**
30	* @var Settings
31	*/
32	private $settings;
33
34	/**
35	* @var TelemetryAccessDetails
36	*/
37	private $telemetryAccessDetails;
38
39	/**
40	* @var AccessToken
41	*/
42	private $accessToken;
43
44	/**
45	* @param UsageTrackingOnBoarding $usageTrackingOnBoarding
46	* @param Settings $settings
47	* @param TelemetryAccessDetails $telemetryAccessDetails
48	* @param AccessToken $accessToken
49	*/
50	public function __construct(
51	UsageTrackingOnBoarding $usageTrackingOnBoarding,
52	Settings $settings,
53	TelemetryAccessDetails $telemetryAccessDetails,
54	AccessToken $accessToken
55	) {
56	$this->usageTrackingOnBoarding = $usageTrackingOnBoarding;
57	$this->settings = $settings;
58	$this->telemetryAccessDetails = $telemetryAccessDetails;
59	$this->accessToken = $accessToken;
60	}
61
62	/**
63	* Handle opt_out_into_tracking give action.
64	*
65	* @since 2.10.0
66	*/
67	public function optOutFromUsageTracking()
68	{
69	if ( ! current_user_can('manage_give_settings')) {
70	return;
71	}
72
73	$timestamp = '0'; // zero value disable notice permanently.
74	if ('hide_opt_in_notice_shortly' === $_GET['give_action']) {
75	$timestamp = DAY_IN_SECONDS * 2 + time();
76	}
77
78	$this->usageTrackingOnBoarding->disableNotice($timestamp);
79
80	wp_safe_redirect(esc_url_raw(remove_query_arg('give_action')));
81	exit();
82	}
83
84	/**
85	* Handle opt_in_into_tracking give action.
86	*
87	* @since 2.10.0
88	*/
89	public function optInToUsageTracking()
90	{
91	if ( ! current_user_can('manage_give_settings')) {
92	return;
93	}
94
95	$this->settings->saveUsageTrackingOptionValue('enabled');
96	$this->usageTrackingOnBoarding->disableNotice(0);
97
98	if ($this->accessToken->store()) {
99	$this->recordTracks();
100	} else {
101	$this->settings->saveUsageTrackingOptionValue('disabled');
102	}
103
104	wp_safe_redirect(esc_url_raw(remove_query_arg('give_action')));
105	exit();
106	}
107
108	/**
109	* OptIn website to telemetry server when admin grant by changing setting.
110	*
111	* @since 2.10.0
112	*
113	* @param array $oldValue
114	* @param array $newValue
115	*
116	* @return false
117	*/
118	public function optInToUsageTrackingAdminGrantManually($oldValue, $newValue)
119	{
120	$class = __CLASS__;
121	add_filter(
122	"give_disable_hook-update_option_give_settings:{$class}@optInToUsageTrackingAdminGrantManually",
123	'__return_true'
124	);
125
126	$section = isset($_GET['section']) ? 'advanced-options' : '';
127	if ( ! Give_Admin_Settings::is_setting_page('advanced', $section)) {
128	return false;
129	}
130
131	$usageTracking = $newValue[Settings::USAGE_TRACKING_OPTION_KEY] ?: 'disabled';
132	$usageTracking = give_is_setting_enabled($usageTracking);
133	$hasAccessToken = $this->telemetryAccessDetails->hasAccessTokenOptionValue();
134
135	// Send plugin information immediately when edit tracking setting.
136	if ($hasAccessToken) {
137	/* @var TrackJob $trackJob */
138	$trackJob = give(TrackJob::class);
139	$trackJob->sendNow([GivePluginSettingsTracking::class]);
140	}
141
142	// Exit if already has access token.
143	if ( ! $usageTracking \|\| $hasAccessToken) {
144	return false;
145	}
146
147	if ($this->accessToken->store()) {
148	$this->recordTracks();
149	} else {
150	$this->settings->saveUsageTrackingOptionValue('disabled');
151	}
152
153	remove_filter(
154	"give_disable_hook-update_option_give_settings:{$class}@optInToUsageTrackingAdminGrantManually",
155	'__return_false'
156	);
157
158	return true;
159	}
160
161	/**
162	* Schedule first set of tracking information.
163	*
164	* @since 2.10.0
165	*/
166	private function recordTracks()
167	{
168	/* @var TrackJob $trackJob */
169	$trackJob = give(TrackJob::class);
170	$trackJob->sendNow(
171	[
172	ActiveDonationFormsFirstTimeTracking::class,
173	DonationMetricsTracking::class,
174	ThemeTracking::class,
175	GivePluginSettingsTracking::class,
176	PluginsTracking::class,
177	]
178	);
179	}
180	}
181