FrmUsage::actions() - Code Metrics - Inspection of "Fix user tracking" - Strategy11/formidable-forms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 660841...0e90b8 )

by Stephanie

created 2019-04-03 18:53 UTC

FrmUsage::actions() A

↳ Parent: FrmUsage

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	20
rs	9.6
c	0
b	0
f	0

<?php
if ( ! defined( 'ABSPATH' ) ) {
	die( 'You are not allowed to call this page directly.' );
}

/**
 * @since 3.06.04
 */
class FrmUsage {

	/**
	 * @since 3.06.04
	 */
	public function send_snapshot() {
		if ( ! $this->tracking_allowed() ) {
			return;
		}

		$ep   = 'aHR0cHM6Ly9mcm0tdXNlci10cmFja2luZy5oZXJva3VhcHAuY29tL3NuYXBzaG90';
		$body = json_encode( $this->snapshot() );

		// Setup variable for wp_remote_request.
		$post = array(
			'method'    => 'POST',
			'headers'   => array(
				'Accept'         => 'application/json',
				'Content-Type'   => 'application/json',
				'Content-Length' => strlen( $body ),
			),
			'body'      => $body,
		);

		wp_remote_request( base64_decode( $ep ), $post );
	}

	/**
	 * @since 3.06.04
	 * @return string
	 */
	public function uuid( $regenerate = false ) {
		$uuid_key = 'frm-usage-uuid';
		$uuid     = get_option( $uuid_key );

		if ( $regenerate || empty( $uuid ) ) {
			// Definitely not cryptographically secure but
			// close enough to provide an unique id
			$uuid = md5( uniqid() . site_url() );
			update_option( $uuid_key, $uuid, 'no' );
		}

		return $uuid;
	}

	/**
	 * @since 3.06.04
	 * @return array
	 */
	public function snapshot() {
		global $wpdb, $wp_version;

		$theme_data  = wp_get_theme();
		$form_counts = FrmForm::get_count();

		$snap = array(
			'uuid'           => $this->uuid(),
			'admin_email'    => get_option( 'admin_email' ),
			'wp_version'     => $wp_version,
			'php_version'    => phpversion(),
			'mysql_version'  => $wpdb->db_version(),
			'os'             => php_uname( 's' ),
			'locale'         => get_locale(),

			'active_license' => FrmAppHelper::pro_is_installed(),
			'form_count'     => $form_counts->published,
			'entry_count'    => FrmEntry::getRecordCount(),
			'timestamp'      => gmdate( 'c' ),

			'theme_name'     => $theme_data->Name, // phpcs:ignore WordPress.NamingConventions
			'plugins'        => $this->plugins(),
			'settings'       => array(
				$this->settings(),
			),
			'forms'          => $this->forms(),
			'fields'         => $this->fields(),
			'actions'        => $this->actions(),
		);

		return apply_filters( 'frm_usage_snapshot', $snap );
	}

	/**
	 * @since 3.06.04
	 * @return array
	 */
	private function plugins() {
		$plugin_list = get_plugins();

		$plugins = array();
		foreach ( $plugin_list as $slug => $info ) {
			$plugins[] = array(
				'name'        => $info['Name'],
				'slug'        => $slug,
				'version'     => $info['Version'],
				'active'      => is_plugin_active( $slug ),
			);
		}

		return $plugins;
	}

	/**
	 * Add global settings to tracking data.
	 *
	 * @since 3.06.04
	 * @return array
	 */
	private function settings() {
		$settings_list  = FrmAppHelper::get_settings();
		$settings       = array(
			'messages'    => $this->messages( $settings_list ),
			'permissions' => $this->permissions( $settings_list ),
		);
		$pass_settings = array(
			'load_style',
			'use_html',
			'old_css',
			'fade_form',
			'jquery_css',
			're_type',
			're_lang',
			're_multi',
			'menu',
			'mu_menu',
			'no_ips',
			'btsp_css',
			'btsp_errors',
		);

		foreach ( $pass_settings as $setting ) {
			if ( isset( $settings_list->$setting ) ) {
				$settings[ $setting ] = $this->maybe_json( $settings_list->$setting );
			}
		}

		$settings = apply_filters( 'frm_usage_settings', $settings );

		$settings['messages']    = $this->maybe_json( $settings['messages'] );
		$settings['permissions'] = $this->maybe_json( $settings['permissions'] );

		return $settings;
	}

	/**
	 * Include the permissions settings for each capability.
	 *
	 * @since 3.06.04
	 * @return array
	 */
	private function messages( $settings_list ) {
		$messages = array(
			'success_msg',
			'blank_msg',
			'unique_msg',
			'invalid_msg',
			'failed_msg',
			'submit_value',
			'login_msg',
			'admin_permission',
		);

		$message_settings = array();
		foreach ( $messages as $message ) {
			$message_settings[ $message ] = $settings_list->$message;
		}

		return $message_settings;
	}

	/**
	 * Include the permissions settings for each capability.
	 *
	 * @since 3.06.04
	 * @return array
	 */
	private function permissions( $settings_list ) {
		$permissions = array();
		$frm_roles   = FrmAppHelper::frm_capabilities();

		foreach ( $frm_roles as $frm_role => $frm_role_description ) {
			if ( isset( $settings_list->$frm_role ) ) {
				$permissions[ $frm_role ] = $settings_list->$frm_role;
			}
		}

		return $permissions;
	}

	/**
	 * @since 3.06.04
	 * @return array
	 */
	private function forms() {
		$s_query = array(
			array(
				'or' => 1,
				'parent_form_id' => null,
				'parent_form_id <' => 1,
			),
		);

		$saved_forms = FrmForm::getAll( $s_query );
		$forms       = array();
		$settings    = array(
			'form_class',
			'akismet',
			'custom_style',
			'success_action',
			'show_form',
			'no_save',
			'ajax_load',
			'ajax_submit',
			'js_validate',
			'logged_in_role',
			'single_entry',
			'single_entry_type',
			'editable_role',
			'open_editable_role',
			'edit_action',
			'edit_value',
			'edit_msg',
			'save_draft',
			'draft_msg',
			'submit_align',
			'protect_files',
			'max_entries',
			'open_status',
			'closed_msg',
			'open_date',
			'close_date',
			'copy',
			'prev_value',
			'submit_conditions',
		);

		foreach ( $saved_forms as $form ) {
			$forms[ $form->id ] = array(
				'form_id'     => $form->id,
				'description' => $form->description,
				'logged_in'   => $form->logged_in,
				'editable'    => $form->editable,
				'is_template' => $form->is_template,
				'entry_count' => FrmEntry::getRecordCount( $form->id ),
				'field_count' => $this->form_field_count( $form->id ),
				'form_action_count' => $this->form_action_count( $form->id ),
			);

			foreach ( $settings as $setting ) {
				if ( isset( $form->options[ $setting ] ) ) {
					$forms[ $form->id ][ $setting ] = $this->maybe_json( $form->options[ $setting ] );
				}
			}
		}

		$forms = apply_filters( 'frm_usage_forms', $forms, compact( 'saved_forms' ) );

		// If the array uses numeric keys, reset them.
		return array_values( $forms );
	}

	/**
	 * @since 3.06.04
	 * @return int
	 */
	private function form_field_count( $form_id ) {
		global $wpdb;

		$join = $wpdb->prefix . 'frm_fields fi LEFT OUTER JOIN ' . $wpdb->prefix . 'frm_forms fo ON (fi.form_id=fo.id)';

		$field_query = array(
			'or'             => 1,
			'form_id'        => $form_id,
			'parent_form_id' => $form_id,
		);

		return FrmDb::get_count( $join, $field_query );
	}

	/**
	 * @since 3.06.04
	 * @return int
	 */
	private function form_action_count( $form_id ) {
		$args = array(
			'post_type'  => FrmFormActionsController::$action_post_type,
			'menu_order' => $form_id,
			'fields'     => 'ids',
		);

		$actions = FrmDb::check_cache( serialize( $args ), 'frm_actions', $args, 'get_posts' );
		return count( $actions );
	}

	/**
	 * Get the last 100 fields created.
	 *
	 * @since 3.06.04
	 * @return array
	 */
	private function fields() {
		$args   = array(
			'limit'    => 100,
			'order_by' => 'id DESC',
		);

		return FrmDb::get_results( 'frm_fields', array(), 'form_id, name, type', $args );
	}

	/**
	 * @since 3.06.04
	 * @return array
	 */
	private function actions() {
		$args = array(
			'post_type'   => FrmFormActionsController::$action_post_type,
			'numberposts' => 100,

		);

		$actions = array();

		$saved_actions = FrmDb::check_cache( serialize( $args ), 'frm_actions', $args, 'get_posts' );
		foreach ( $saved_actions as $action ) {
			$actions[] = array(
				'form_id'  => $action->menu_order,
				'type'     => $action->post_excerpt,
				'status'   => $action->post_status,
				'settings' => $action->post_content,
			);
		}

		return $actions;
	}

	/**
	 * @since 3.06.04
	 * @return bool
	 */
	private function tracking_allowed() {
		$settings = FrmAppHelper::get_settings();
		return $settings->tracking;
	}

	/**
	 * @since 3.06.04
	 * @return string
	 */
	private function maybe_json( $value ) {
		return is_array( $value ) ? json_encode( $value ) : $value;
	}
}



1			<?php
2			if ( ! defined( 'ABSPATH' ) ) {
3			die( 'You are not allowed to call this page directly.' );
4			}
5
6			/**
7			* @since 3.06.04
8			*/
9			class FrmUsage {
10
11			/**
12			* @since 3.06.04
13			*/
14			public function send_snapshot() {
15			if ( ! $this->tracking_allowed() ) {
16			return;
17			}
18
19			$ep = 'aHR0cHM6Ly9mcm0tdXNlci10cmFja2luZy5oZXJva3VhcHAuY29tL3NuYXBzaG90';
20			$body = json_encode( $this->snapshot() );
21
22			// Setup variable for wp_remote_request.
23			$post = array(
24			'method' => 'POST',
25			'headers' => array(
26			'Accept' => 'application/json',
27			'Content-Type' => 'application/json',
28			'Content-Length' => strlen( $body ),
29			),
30			'body' => $body,
31			);
32
33			wp_remote_request( base64_decode( $ep ), $post );
34			}
35
36			/**
37			* @since 3.06.04
38			* @return string
39			*/
40			public function uuid( $regenerate = false ) {
41			$uuid_key = 'frm-usage-uuid';
42			$uuid = get_option( $uuid_key );
43
44			if ( $regenerate \|\| empty( $uuid ) ) {
45			// Definitely not cryptographically secure but
46			// close enough to provide an unique id
47			$uuid = md5( uniqid() . site_url() );
48			update_option( $uuid_key, $uuid, 'no' );
49			}
50
51			return $uuid;
52			}
53
54			/**
55			* @since 3.06.04
56			* @return array
57			*/
58			public function snapshot() {
59			global $wpdb, $wp_version;
60
61			$theme_data = wp_get_theme();
62			$form_counts = FrmForm::get_count();
63
64			$snap = array(
65			'uuid' => $this->uuid(),
66			'admin_email' => get_option( 'admin_email' ),
67			'wp_version' => $wp_version,
68			'php_version' => phpversion(),
69			'mysql_version' => $wpdb->db_version(),
70			'os' => php_uname( 's' ),
71			'locale' => get_locale(),
72
73			'active_license' => FrmAppHelper::pro_is_installed(),
74			'form_count' => $form_counts->published,
75			'entry_count' => FrmEntry::getRecordCount(),
76			'timestamp' => gmdate( 'c' ),
77
78			'theme_name' => $theme_data->Name, // phpcs:ignore WordPress.NamingConventions
79			'plugins' => $this->plugins(),
80			'settings' => array(
81			$this->settings(),
82			),
83			'forms' => $this->forms(),
84			'fields' => $this->fields(),
85			'actions' => $this->actions(),
86			);
87
88			return apply_filters( 'frm_usage_snapshot', $snap );
89			}
90
91			/**
92			* @since 3.06.04
93			* @return array
94			*/
95			private function plugins() {
96			$plugin_list = get_plugins();
97
98			$plugins = array();
99			foreach ( $plugin_list as $slug => $info ) {
100			$plugins[] = array(
101			'name' => $info['Name'],
102			'slug' => $slug,
103			'version' => $info['Version'],
104			'active' => is_plugin_active( $slug ),
105			);
106			}
107
108			return $plugins;
109			}
110
111			/**
112			* Add global settings to tracking data.
113			*
114			* @since 3.06.04
115			* @return array
116			*/
117			private function settings() {
118			$settings_list = FrmAppHelper::get_settings();
119			$settings = array(
120			'messages' => $this->messages( $settings_list ),
121			'permissions' => $this->permissions( $settings_list ),
122			);
123			$pass_settings = array(
124			'load_style',
125			'use_html',
126			'old_css',
127			'fade_form',
128			'jquery_css',
129			're_type',
130			're_lang',
131			're_multi',
132			'menu',
133			'mu_menu',
134			'no_ips',
135			'btsp_css',
136			'btsp_errors',
137			);
138
139			foreach ( $pass_settings as $setting ) {
140			if ( isset( $settings_list->$setting ) ) {
141			$settings[ $setting ] = $this->maybe_json( $settings_list->$setting );
142			}
143			}
144
145			$settings = apply_filters( 'frm_usage_settings', $settings );
146
147			$settings['messages'] = $this->maybe_json( $settings['messages'] );
148			$settings['permissions'] = $this->maybe_json( $settings['permissions'] );
149
150			return $settings;
151			}
152
153			/**
154			* Include the permissions settings for each capability.
155			*
156			* @since 3.06.04
157			* @return array
158			*/
159			private function messages( $settings_list ) {
160			$messages = array(
161			'success_msg',
162			'blank_msg',
163			'unique_msg',
164			'invalid_msg',
165			'failed_msg',
166			'submit_value',
167			'login_msg',
168			'admin_permission',
169			);
170
171			$message_settings = array();
172			foreach ( $messages as $message ) {
173			$message_settings[ $message ] = $settings_list->$message;
174			}
175
176			return $message_settings;
177			}
178
179			/**
180			* Include the permissions settings for each capability.
181			*
182			* @since 3.06.04
183			* @return array
184			*/
185			private function permissions( $settings_list ) {
186			$permissions = array();
187			$frm_roles = FrmAppHelper::frm_capabilities();
188
189			foreach ( $frm_roles as $frm_role => $frm_role_description ) {
190			if ( isset( $settings_list->$frm_role ) ) {
191			$permissions[ $frm_role ] = $settings_list->$frm_role;
192			}
193			}
194
195			return $permissions;
196			}
197
198			/**
199			* @since 3.06.04
200			* @return array
201			*/
202			private function forms() {
203			$s_query = array(
204			array(
205			'or' => 1,
206			'parent_form_id' => null,
207			'parent_form_id <' => 1,
208			),
209			);
210
211			$saved_forms = FrmForm::getAll( $s_query );
212			$forms = array();
213			$settings = array(
214			'form_class',
215			'akismet',
216			'custom_style',
217			'success_action',
218			'show_form',
219			'no_save',
220			'ajax_load',
221			'ajax_submit',
222			'js_validate',
223			'logged_in_role',
224			'single_entry',
225			'single_entry_type',
226			'editable_role',
227			'open_editable_role',
228			'edit_action',
229			'edit_value',
230			'edit_msg',
231			'save_draft',
232			'draft_msg',
233			'submit_align',
234			'protect_files',
235			'max_entries',
236			'open_status',
237			'closed_msg',
238			'open_date',
239			'close_date',
240			'copy',
241			'prev_value',
242			'submit_conditions',
243			);
244
245			foreach ( $saved_forms as $form ) {
246			$forms[ $form->id ] = array(
247			'form_id' => $form->id,
248			'description' => $form->description,
249			'logged_in' => $form->logged_in,
250			'editable' => $form->editable,
251			'is_template' => $form->is_template,
252			'entry_count' => FrmEntry::getRecordCount( $form->id ),
253			'field_count' => $this->form_field_count( $form->id ),
254			'form_action_count' => $this->form_action_count( $form->id ),
255			);
256
257			foreach ( $settings as $setting ) {
258			if ( isset( $form->options[ $setting ] ) ) {
259			$forms[ $form->id ][ $setting ] = $this->maybe_json( $form->options[ $setting ] );
260			}
261			}
262			}
263
264			$forms = apply_filters( 'frm_usage_forms', $forms, compact( 'saved_forms' ) );
265
266			// If the array uses numeric keys, reset them.
267			return array_values( $forms );
268			}
269
270			/**
271			* @since 3.06.04
272			* @return int
273			*/
274			private function form_field_count( $form_id ) {
275			global $wpdb;
276
277			$join = $wpdb->prefix . 'frm_fields fi LEFT OUTER JOIN ' . $wpdb->prefix . 'frm_forms fo ON (fi.form_id=fo.id)';
278
279			$field_query = array(
280			'or' => 1,
281			'form_id' => $form_id,
282			'parent_form_id' => $form_id,
283			);
284
285			return FrmDb::get_count( $join, $field_query );
286			}
287
288			/**
289			* @since 3.06.04
290			* @return int
291			*/
292			private function form_action_count( $form_id ) {
293			$args = array(
294			'post_type' => FrmFormActionsController::$action_post_type,
295			'menu_order' => $form_id,
296			'fields' => 'ids',
297			);
298
299			$actions = FrmDb::check_cache( serialize( $args ), 'frm_actions', $args, 'get_posts' );
300			return count( $actions );
301			}
302
303			/**
304			* Get the last 100 fields created.
305			*
306			* @since 3.06.04
307			* @return array
308			*/
309			private function fields() {
310			$args = array(
311			'limit' => 100,
312			'order_by' => 'id DESC',
313			);
314
315			return FrmDb::get_results( 'frm_fields', array(), 'form_id, name, type', $args );
316			}
317
318			/**
319			* @since 3.06.04
320			* @return array
321			*/
322			private function actions() {
323			$args = array(
324			'post_type' => FrmFormActionsController::$action_post_type,
325			'numberposts' => 100,
			0 ignored issues – show introduced 2019-03-21 22:00 UTC by Report Bug Copy Issue Report Detected high pagination limit, `numberposts` is set to `100` Loading history...
326			);
327
328			$actions = array();
329
330			$saved_actions = FrmDb::check_cache( serialize( $args ), 'frm_actions', $args, 'get_posts' );
331			foreach ( $saved_actions as $action ) {
332			$actions[] = array(
333			'form_id' => $action->menu_order,
334			'type' => $action->post_excerpt,
335			'status' => $action->post_status,
336			'settings' => $action->post_content,
337			);
338			}
339
340			return $actions;
341			}
342
343			/**
344			* @since 3.06.04
345			* @return bool
346			*/
347			private function tracking_allowed() {
348			$settings = FrmAppHelper::get_settings();
349			return $settings->tracking;
350			}
351
352			/**
353			* @since 3.06.04
354			* @return string
355			*/
356			private function maybe_json( $value ) {
357			return is_array( $value ) ? json_encode( $value ) : $value;
358			}
359			}
360
361

Strategy11 / formidable-forms

Push — master ( 660841...0e90b8 )

FrmUsage::actions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like