formidable / classes / controllers / FrmUsageController.php

FrmUsageController.php in Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More 6.26, at classes/controllers/FrmUsageController.php

185 lines 3.8 KB

Raw Download Zip

1	<?php
2	if ( ! defined( 'ABSPATH' ) ) {
3	die( 'You are not allowed to call this page directly.' );
4	}
5
6	/**
7	* @todo Show opt-in popup after plugin activation.
8	*
9	* @since 3.06.04
10	*/
11	class FrmUsageController {
12
13	/**
14	* Option name of flows data.
15	*
16	* @since 6.16.1
17	*
18	* @var string
19	*/
20	const FLOWS_ACTION_NAME = 'frm_usage_tracking_flows';
21
22	/**
23	* Randomize the first send to prevent our servers from crashing.
24	*
25	* @since 3.06.04
26	*
27	* @return void
28	*/
29	public static function schedule_send() {
30	$timestamp = wp_next_scheduled( 'formidable_send_usage' );
31
32	if ( ! self::tracking_allowed() ) {
33	if ( $timestamp ) {
34	// Remove the scheduled event if it's not allowed and it's scheduled.
35	wp_unschedule_event( $timestamp, 'formidable_send_usage' );
36	}
37	return;
38	}
39
40	if ( $timestamp ) {
41	return;
42	}
43
44	$tracking = array(
45	'day' => random_int( 0, 6 ) * DAY_IN_SECONDS,
46	'hour' => random_int( 0, 23 ) * HOUR_IN_SECONDS,
47	'minute' => random_int( 0, 59 ) * MINUTE_IN_SECONDS,
48	'second' => random_int( 0, 59 ),
49	);
50
51	$offset = array_sum( $tracking );
52	$init_send = strtotime( 'next sunday' ) + $offset;
53
54	wp_schedule_event( $init_send, 'weekly', 'formidable_send_usage' );
55	}
56
57	/**
58	* Adds once weekly to the existing schedules.
59	*
60	* @since 3.06.04
61	*
62	* @param array $schedules Schedules.
63	*
64	* @return array
65	*/
66	public static function add_schedules( $schedules = array() ) {
67	$schedules['weekly'] = array(
68	'interval' => DAY_IN_SECONDS * 7,
69	'display' => __( 'Once Weekly', 'formidable' ),
70	);
71	return $schedules;
72	}
73
74	/**
75	* Checks if tracking is allowed.
76	*
77	* @since 6.16.3
78	*
79	* @return bool
80	*/
81	public static function tracking_allowed() {
82	$settings = FrmAppHelper::get_settings();
83	return $settings->tracking;
84	}
85
86	/**
87	* @since 3.06.04
88	*
89	* @return void
90	*/
91	public static function send_snapshot() {
92	$usage = new FrmUsage();
93	$usage->send_snapshot();
94	}
95
96	/**
97	* Loads scripts.
98	*
99	* @since 6.16.1
100	*
101	* @return void
102	*/
103	public static function load_scripts() {
104	if ( self::is_forms_list_page() \|\| FrmAppHelper::is_admin_page( 'formidable-form-templates' ) \|\| FrmAppHelper::is_admin_page() ) {
105	wp_enqueue_script( 'frm-usage-tracking', FrmAppHelper::plugin_url() . '/js/admin/usage-tracking.js', array( 'formidable_dom' ), FrmAppHelper::$plug_version, true );
106	}
107	}
108
109	/**
110	* Checks if is forms list page.
111	*
112	* @since 6.16.1
113	*
114	* @return bool
115	*/
116	private static function is_forms_list_page() {
117	if ( ! FrmAppHelper::on_form_listing_page() ) {
118	return false;
119	}
120
121	// Exclude Trash page.
122	$form_type = FrmAppHelper::simple_get( 'form_type' );
123	return $form_type && 'published' === $form_type;
124	}
125
126	/**
127	* AJAX handler to track flows.
128	*
129	* @since 6.16.1
130	*
131	* @return void
132	*/
133	public static function ajax_track_flows() {
134	FrmAppHelper::permission_check( 'frm_view_forms' );
135	check_ajax_referer( 'frm_ajax', 'nonce' );
136
137	$key = FrmAppHelper::get_post_param( 'key', '', 'sanitize_text_field' );
138	$value = FrmAppHelper::get_post_param( 'value', '', 'sanitize_text_field' );
139
140	self::update_flows_data( $key, $value );
141
142	wp_send_json_success();
143	}
144
145	/**
146	* Updates flows data.
147	*
148	* @since 6.16.1
149	*
150	* @param string $key Flow key.
151	* @param string $value Flow value.
152	*
153	* @return void
154	*/
155	public static function update_flows_data( $key, $value ) {
156	$flows_data = self::get_flows_data();
157
158	if ( '' === $key \|\| '' === $value ) {
159	return;
160	}
161
162	if ( ! isset( $flows_data[ $key ] ) ) {
163	$flows_data[ $key ] = array();
164	}
165
166	if ( ! isset( $flows_data[ $key ][ $value ] ) ) {
167	$flows_data[ $key ][ $value ] = 0;
168	}
169
170	$flows_data[ $key ][ $value ]++;
171	update_option( self::FLOWS_ACTION_NAME, $flows_data );
172	}
173
174	/**
175	* Get flows data.
176	*
177	* @since 6.16.1
178	*
179	* @return array
180	*/
181	public static function get_flows_data() {
182	return get_option( self::FLOWS_ACTION_NAME, array() );
183	}
184	}
185