← All changes | src/controller/class-data-tracking.php +41 -64 6.1.0 → 6.3.0 View file →

		@@ -22,55 +22,24 @@
22	22
23	23	public const TRACKING_SLUG = 'wd_show_usage_data';
24	24
25	25	/**
26		- * Initializes the model and service, registers routes, and sets up scheduled events if the model is active.
	26	+ * Site option key that controls the dashboard share-usage bubble lifecycle.
	27	+ * Kept separate from TRACKING_SLUG so that skipping onboarding does not
	28	+ * suppress the bubble.
27	29	*/
28		- public function __construct() {
29		- $this->register_routes();
30		- }
	30	+ public const DASHBOARD_NOTICE_SLUG = 'wd_show_dashboard_usage_notice';
31	31
32	32	/**
33		- * Get the Tracking modal that is displayed on all plugin pages.
34		- *
35		- * @return array
	33	+ * Records whether the dashboard notice lifecycle has been initialized.
36	34	*/
37		- public function get_tracking_modal(): array {
38		- $title = esc_html__( 'Help Us Enhance Your Site\'s Security', 'defender-security' );
	35	+ public const DASHBOARD_NOTICE_INITIALIZED_SLUG = 'wd_dashboard_usage_notice_initialized';
39	36
40		- $current_user = wp_get_current_user();
41		-
42		- $desc = sprintf(
43		- /* translators: %s: user display name */
44		- esc_html__(
45		- 'Hey there! %s, Defender is dedicated to protecting your WordPress website from hackers and malware. However, our mission is more effective with your collaboration. By opting in to share anonymous usage data, you help us refine and enhance our plugin for everyone\'s benefit.',
46		- 'defender-security'
47		- ),
48		- '<strong>' . esc_html( $current_user->display_name ) . '</strong>'
49		- );
50		- $desc .= '<br/><br/>';
51		- $desc .= sprintf(
52		- /* translators: %s: Link. */
53		- esc_html__(
54		- 'Your privacy is important to us. We guarantee that your data stays anonymous and your identity stays secure. Learn more about our usage tracking %s.',
55		- 'defender-security'
56		- ),
57		- '<a href="' . Main_Setting::PRIVACY_LINK . '" target="_blank">' . esc_html__( 'here', 'defender-security' ) . '<a>'
58		- );
59		- $result = $this->dump_routes_and_nonces();
60		-
61		- return array(
62		- 'title' => $title,
63		- 'desc' => $desc,
64		- 'banner_1x' => defender_asset_url( '/assets/img/modal/tracking-modal.png' ),
65		- 'banner_2x' => defender_asset_url( '/assets/img/modal/[email protected]' ),
66		- 'banner_alt' => esc_html__( 'Help us improve Defender', 'defender-security' ),
67		- 'optin_button_title' => esc_html__( 'OPT IN', 'defender-security' ),
68		- 'skip_button_title' => esc_html__( 'Skip for now', 'defender-security' ),
69		- 'state_usage_tracking' => wd_di()->get( Main_Setting::class )->usage_tracking,
70		- 'routes' => $result['routes'],
71		- 'nonces' => $result['nonces'],
72		- );
	37	+ /**
	38	+ * Initializes the model and service, registers routes, and sets up scheduled events if the model is active.
	39	+ */
	40	+ public function __construct() {
	41	+ $this->register_routes();
73	42	}
74	43
75	44	/**
76	45	* Handles the closing of the tracking modal.
		@@ -85,9 +54,8 @@
85	54	$model_settings->toggle_tracking( false );
86	55	Config_Hub_Helper::set_clear_active_flag();
87	56	$this->track_opt_toggle( false, 'Tracking modal' );
88	57	}
89		-
90	58	// Track.
91	59	$this->track_feature( 'def_tracking_modal', array( 'Modal Action' => 'closed' ) );
92	60	self::dismiss_modal_key();
93	61
		@@ -134,31 +102,14 @@
134	102	delete_site_option( self::TRACKING_SLUG );
135	103	}
136	104
137	105	/**
138		- * Conditions of the Tracking modal:
139		- * 1)show on all Defender pages.
140		- * 2)show to users upgrading from older versions.
141		- * 3)should have higher priority than a Welcome modal on the Defender > Dashboard page.
142		- * 4)if user closes or clicks on the Save button on one plugin page, we don't itl on another plugin page.
143		- * 5)no display after the updated Onboarding with Opt-in.
144		- * 6)no display when Whitelabel > Documentation, Tutorials and What’s New Modal is set to “Hide”
145		- *
146		- * @return bool
147		- */
148		- public function show_tracking_modal() {
149		- $info = defender_white_label_status();
150		-
151		- $white_label_is_hide = isset( $info['hide_doc_link'] ) && $info['hide_doc_link'];
152		-
153		- return (bool) get_site_option( self::TRACKING_SLUG ) && ! $white_label_is_hide;
154		- }
155		-
156		- /**
157	106	* Delete all the data & the cache.
158	107	*/
159	108	public function remove_data() {
160	109	self::delete_modal_key();
	110	+ delete_site_option( self::DASHBOARD_NOTICE_SLUG );
	111	+ delete_site_option( self::DASHBOARD_NOTICE_INITIALIZED_SLUG );
161	112	}
162	113
163	114	/**
164	115	* Exports strings.
		@@ -192,8 +143,10 @@
192	143	* Removes settings for all submodules.
193	144	*/
194	145	public function remove_settings(): void {
195	146	self::delete_modal_key();
	147	+ delete_site_option( self::DASHBOARD_NOTICE_SLUG );
	148	+ delete_site_option( self::DASHBOARD_NOTICE_INITIALIZED_SLUG );
196	149	}
197	150
198	151	/**
199	152	* Provides data for the frontend.
		@@ -204,17 +157,40 @@
204	157	return array();
205	158	}
206	159
207	160	/**
	161	+ * Initializes the dashboard notice lifecycle once.
	162	+ *
	163	+ * A dedicated marker distinguishes an intentionally consumed false value
	164	+ * from an option that an older or interrupted upgrade failed to seed.
	165	+ *
	166	+ * @return void
	167	+ */
	168	+ public static function initialize_dashboard_notice(): void {
	169	+ if ( (bool) get_site_option( self::DASHBOARD_NOTICE_INITIALIZED_SLUG ) ) {
	170	+ return;
	171	+ }
	172	+
	173	+ $usage_tracking = wd_di()->get( Main_Setting::class )->usage_tracking;
	174	+ delete_site_option( self::DASHBOARD_NOTICE_SLUG );
	175	+ add_site_option( self::DASHBOARD_NOTICE_SLUG, ! $usage_tracking );
	176	+ update_site_option( self::DASHBOARD_NOTICE_INITIALIZED_SLUG, true );
	177	+ }
	178	+
	179	+ /**
208	180	* Returns whether the dashboard share usage notice should be displayed.
209	181	*
210	182	* @return bool
211	183	*/
212	184	public function should_show_dashboard_notice(): bool {
213		- if ( ! get_site_option( self::TRACKING_SLUG ) ) {
	185	+ $notice_option = (bool) get_site_option( self::DASHBOARD_NOTICE_SLUG );
	186	+
	187	+ // Falsey means not eligible or already displayed.
	188	+ if ( ! $notice_option ) {
214	189	return false;
215	190	}
216	191
	192	+ // Truthy means eligible; also guard against already opted-in.
217	193	return ! wd_di()->get( Main_Setting::class )->usage_tracking;
218	194	}
219	195
220	196	/**
		@@ -222,8 +198,9 @@
222	198	*
223	199	* @return array
224	200	*/
225	201	public function get_dashboard_notice_data(): array {
	202	+ self::initialize_dashboard_notice();
226	203	$result = $this->dump_routes_and_nonces();
227	204
228	205	return array(
229	206	'shareUsageNotice' => array(
		@@ -240,9 +217,9 @@
240	217	* @return Response
241	218	* @defender_route
242	219	*/
243	220	public function mark_track_notice_displayed(): Response {
244		- self::dismiss_modal_key();
	221	+ update_site_option( self::DASHBOARD_NOTICE_SLUG, false );
245	222
246	223	return new Response( true, array() );
247	224	}
248	225	}