class-common-methods.php — Admin and Site Enhancements (ASE) 7.0.2

admin-site-enhancements / classes / class-common-methods.php

admin-site-enhancements / classes Last commit date

class-common-methods.php

488 lines

1	<?php
2
3	namespace ASENHA\Classes;
4
5	use WP_Query;
6	/**
7	* Class that provides common methods used throughout the plugin
8	*
9	* @since 2.5.0
10	*/
11	class Common_Methods {
12	/**
13	* Get IP of the current visitor/user. In use by at least the Limit Login Attempts feature.
14	* This takes a best guess of the visitor's actual IP address.
15	* Takes into account numerous HTTP proxy headers due to variations
16	* in how different ISPs handle IP addresses in headers between hops.
17	*
18	* @link https://stackoverflow.com/q/1634782
19	* @since 2.5.0
20	*/
21	public function get_user_ip_address( $return_type = 'ip', $for_which_module = 'limit-login-attempts' ) {
22	// Check for shared internet/ISP IP
23	if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) && $this->is_ip_valid( $_SERVER['HTTP_CLIENT_IP'] ) ) {
24	switch ( $return_type ) {
25	case 'ip':
26	return sanitize_text_field( $_SERVER['HTTP_CLIENT_IP'] );
27	break;
28	case 'header':
29	return 'HTTP_CLIENT_IP';
30	break;
31	}
32	}
33	// Check if Cloudflare is used as a proxy
34	// Ref: https://developers.cloudflare.com/fundamentals/reference/http-request-headers/#x-forwarded-for
35	if ( !empty( $_SERVER['CF_CONNECTING_IP'] ) && $this->is_ip_valid( $_SERVER['CF_CONNECTING_IP'] ) ) {
36	switch ( $return_type ) {
37	case 'ip':
38	return sanitize_text_field( $_SERVER['CF_CONNECTING_IP'] );
39	break;
40	case 'header':
41	return 'CF_CONNECTING_IP';
42	break;
43	}
44	}
45	if ( !empty( $_SERVER['HTTP_CF_CONNECTING_IP'] ) && $this->is_ip_valid( $_SERVER['HTTP_CF_CONNECTING_IP'] ) ) {
46	switch ( $return_type ) {
47	case 'ip':
48	return sanitize_text_field( $_SERVER['HTTP_CF_CONNECTING_IP'] );
49	break;
50	case 'header':
51	return 'HTTP_CF_CONNECTING_IP';
52	break;
53	}
54	}
55	if ( !empty( $_SERVER['TRUE_CLIENT_IP'] ) && $this->is_ip_valid( $_SERVER['TRUE_CLIENT_IP'] ) ) {
56	switch ( $return_type ) {
57	case 'ip':
58	return sanitize_text_field( $_SERVER['TRUE_CLIENT_IP'] );
59	break;
60	case 'header':
61	return 'TRUE_CLIENT_IP';
62	break;
63	}
64	}
65	if ( !empty( $_SERVER['HTTP_TRUE_CLIENT_IP'] ) && $this->is_ip_valid( $_SERVER['HTTP_TRUE_CLIENT_IP'] ) ) {
66	switch ( $return_type ) {
67	case 'ip':
68	return sanitize_text_field( $_SERVER['HTTP_TRUE_CLIENT_IP'] );
69	break;
70	case 'header':
71	return 'HTTP_TRUE_CLIENT_IP';
72	break;
73	}
74	}
75	// Check for IPs passing through proxies
76	if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
77	// Check if multiple IP addresses exist in var
78	$ip_list = explode( ',', $_SERVER['HTTP_X_FORWARDED_FOR'] );
79	if ( is_array( $ip_list ) && count( $ip_list ) > 1 ) {
80	foreach ( $ip_list as $ip ) {
81	if ( $this->is_ip_valid( trim( $ip ) ) ) {
82	switch ( $return_type ) {
83	case 'ip':
84	return sanitize_text_field( trim( $ip ) );
85	break;
86	case 'header':
87	return 'HTTP_X_FORWARDED_FOR (multiple IPs)';
88	break;
89	}
90	}
91	}
92	} else {
93	switch ( $return_type ) {
94	case 'ip':
95	return sanitize_text_field( $_SERVER['HTTP_X_FORWARDED_FOR'] );
96	break;
97	case 'header':
98	return 'HTTP_X_FORWARDED_FOR';
99	break;
100	}
101	}
102	}
103	if ( !empty( $_SERVER['HTTP_X_FORWARDED'] ) && $this->is_ip_valid( $_SERVER['HTTP_X_FORWARDED'] ) ) {
104	switch ( $return_type ) {
105	case 'ip':
106	return sanitize_text_field( $_SERVER['HTTP_X_FORWARDED'] );
107	break;
108	case 'header':
109	return 'HTTP_X_FORWARDED';
110	break;
111	}
112	}
113	if ( !empty( $_SERVER['HTTP_X_CLUSTER_CLIENT_IP'] ) && $this->is_ip_valid( $_SERVER['HTTP_X_CLUSTER_CLIENT_IP'] ) ) {
114	switch ( $return_type ) {
115	case 'ip':
116	return sanitize_text_field( $_SERVER['HTTP_X_CLUSTER_CLIENT_IP'] );
117	break;
118	case 'header':
119	return 'HTTP_X_CLUSTER_CLIENT_IP';
120	break;
121	}
122	}
123	if ( !empty( $_SERVER['HTTP_FORWARDED_FOR'] ) && $this->is_ip_valid( $_SERVER['HTTP_FORWARDED_FOR'] ) ) {
124	switch ( $return_type ) {
125	case 'ip':
126	return sanitize_text_field( $_SERVER['HTTP_FORWARDED_FOR'] );
127	break;
128	case 'header':
129	return 'HTTP_FORWARDED_FOR';
130	break;
131	}
132	}
133	if ( !empty( $_SERVER['HTTP_FORWARDED'] ) && $this->is_ip_valid( $_SERVER['HTTP_FORWARDED'] ) ) {
134	switch ( $return_type ) {
135	case 'ip':
136	return sanitize_text_field( $_SERVER['HTTP_FORWARDED'] );
137	break;
138	case 'header':
139	return 'HTTP_FORWARDED';
140	break;
141	}
142	}
143	// Return unreliable IP address since all else failed
144	switch ( $return_type ) {
145	case 'ip':
146	return sanitize_text_field( $_SERVER['REMOTE_ADDR'] );
147	break;
148	case 'header':
149	return 'REMOTE_ADDR';
150	break;
151	}
152	}
153
154	/**
155	* Check if the supplied IP address is valid or not
156	*
157	* @param string $ip an IP address
158	* @link https://stackoverflow.com/q/1634782
159	* @return boolean true if supplied address is valid IP, and false otherwise
160	*/
161	public function is_ip_valid( $ip ) {
162	if ( empty( $ip ) ) {
163	return false;
164	}
165	// Ref: https://www.php.net/manual/en/filter.filters.validate.php
166	if ( false == filter_var( $ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 ) ) {
167	return false;
168	} else {
169	return true;
170	}
171	}
172
173	/**
174	* Convert number of seconds into hours, minutes, seconds. In use by at least the Limit Login Attempts feature.
175	*
176	* @since 2.5.0
177	*/
178	public function seconds_to_period( $seconds, $conversion_type ) {
179	$period_start = new \DateTime('@0');
180	$period_end = new \DateTime("@{$seconds}");
181	if ( $conversion_type == 'to-days-hours-minutes-seconds' ) {
182	return $period_start->diff( $period_end )->format( '%a days, %h hours, %i minutes and %s seconds' );
183	} elseif ( $conversion_type == 'to-hours-minutes-seconds' ) {
184	return $period_start->diff( $period_end )->format( '%h hours, %i minutes and %s seconds' );
185	} elseif ( $conversion_type == 'to-minutes-seconds' ) {
186	return $period_start->diff( $period_end )->format( '%i minutes and %s seconds' );
187	} else {
188	return $period_start->diff( $period_end )->format( '%a days, %h hours, %i minutes and %s seconds' );
189	}
190	}
191
192	/**
193	* Remove html tags and content inside the tags from a string
194	*
195	* @since 3.0.3
196	*/
197	public function strip_html_tags_and_content( $string ) {
198	// Strip HTML tags and content inside them. Ref: https://stackoverflow.com/a/39320168
199	if ( !is_null( $string ) ) {
200	$string = preg_replace( '@<(\\w+)\\b.?>.?</\\1>@si', '', $string );
201	// Strip any remaining HTML or PHP tags
202	$string = strip_tags( $string );
203	}
204	return $string;
205	}
206
207	/**
208	* Get menu hidden by toggle
209	*
210	* @since 5.1.0
211	*/
212	public function get_menu_hidden_by_toggle() {
213	$menu_hidden_by_toggle = array();
214	$options = get_option( ASENHA_SLUG_U, array() );
215	if ( array_key_exists( 'custom_menu_hidden', $options ) ) {
216	$menu_hidden = $options['custom_menu_hidden'];
217	$menu_hidden = explode( ',', $menu_hidden );
218	$menu_hidden_by_toggle = array();
219	foreach ( $menu_hidden as $menu_id ) {
220	$menu_hidden_by_toggle[] = $this->restore_menu_item_id( $menu_id );
221	}
222	}
223	return $menu_hidden_by_toggle;
224	}
225
226	/**
227	* Get user capabilities for which the "Show All/Less" menu toggle should be shown for
228	*
229	* @since 5.1.0
230	*/
231	public function get_user_capabilities_to_show_menu_toggle_for() {
232	global $menu, $submenu;
233	$menu_always_hidden = array();
234	$user_capabilities_menus_are_hidden_for = array();
235	$menu_hidden_by_toggle = $this->get_menu_hidden_by_toggle();
236	// indexed array
237	foreach ( $menu as $menu_key => $menu_info ) {
238	foreach ( $menu_hidden_by_toggle as $hidden_menu_id ) {
239	if ( false !== strpos( $menu_info[4], 'wp-menu-separator' ) ) {
240	$menu_item_id = $menu_info[2];
241	} else {
242	$menu_item_id = $menu_info[5];
243	}
244	if ( $menu_item_id == $hidden_menu_id ) {
245	$user_capabilities_menus_are_hidden_for[] = $menu_info[1];
246	}
247	}
248	}
249	$user_capabilities_menus_are_hidden_for = array_unique( $user_capabilities_menus_are_hidden_for );
250	return $user_capabilities_menus_are_hidden_for;
251	// indexed array
252	}
253
254	/**
255	* Transform menu item's ID
256	*
257	* @since 5.1.0
258	*/
259	public function transform_menu_item_id( $menu_item_id ) {
260	// Transform e.g. edit.php?post_type=page ==> edit__php___post_type____page
261	$menu_item_id_transformed = str_replace( array(
262	".",
263	"?",
264	"=/",
265	"=",
266	"&",
267	"/"
268	), array(
269	"__",
270	"___",
271	"_______",
272	"____",
273	"_____",
274	"______"
275	), $menu_item_id );
276	return $menu_item_id_transformed;
277	}
278
279	/**
280	* Transform menu item's ID
281	*
282	* @since 5.1.0
283	*/
284	public function restore_menu_item_id( $menu_item_id_transformed ) {
285	// Transform e.g. edit__php___post_type____page ==> edit.php?post_type=page
286	$menu_item_id = str_replace( array(
287	"_______",
288	"______",
289	"_____",
290	"____",
291	"___",
292	"__"
293	), array(
294	"=/",
295	"/",
296	"&",
297	"=",
298	"?",
299	"."
300	), $menu_item_id_transformed );
301	return $menu_item_id;
302	}
303
304	/**
305	* Sanitize hexedecimal numbers used for colors
306	*
307	* @link https://plugins.trac.wordpress.org/browser/bm-custom-login/trunk/bm-custom-login.php
308	* @param string $color Hex number to sanitize.
309	* @return string
310	*/
311	public function sanitize_hex_color( $color ) {
312	if ( '' === $color ) {
313	return '';
314	}
315	// Make sure the color starts with a hash.
316	$color = '#' . ltrim( $color, '#' );
317	// 3 or 6 hex digits, or the empty string.
318	if ( preg_match( '\|^#([A-Fa-f0-9]{3}){1,2}$\|', $color ) ) {
319	return $color;
320	}
321	return null;
322	}
323
324	/**
325	* Get the post ID of the most recent post in a custom post type
326	*
327	* @since 6.4.1
328	*/
329	public function get_most_recent_post_id( $post_type ) {
330	$args = array(
331	'post_type' => $post_type,
332	'posts_per_page' => 1,
333	'orderby' => 'date',
334	'order' => 'DESC',
335	);
336	$query = new WP_Query($args);
337	if ( $query->have_posts() ) {
338	$query->the_post();
339	$post_id = get_the_ID();
340	wp_reset_postdata();
341	return $post_id;
342	}
343	return 0;
344	// Return 0 if no posts found
345	}
346
347	/**
348	* Extended ruleset for wp_kses() that includes SVG tag and it's children
349	*
350	* @since 6.8.3
351	*/
352	// public function get_kses_extended_ruleset() {
353	// $kses_defaults = wp_kses_allowed_html( 'post' );
354	// // For SVG icons
355	// $svg_args = array(
356	// 'svg' => array(
357	// 'class' => true,
358	// 'aria-hidden' => true,
359	// 'aria-labelledby' => true,
360	// 'role' => true,
361	// 'xmlns' => true,
362	// 'width' => true,
363	// 'height' => true,
364	// 'viewbox' => true,
365	// 'viewBox' => true,
366	// ),
367	// 'g' => array(
368	// 'fill' => true,
369	// 'fill-rule' => true,
370	// 'stroke' => true,
371	// 'stroke-linejoin' => true,
372	// 'stroke-width' => true,
373	// 'stroke-linecap' => true,
374	// ),
375	// 'title' => array( 'title' => true ),
376	// 'path' => array(
377	// 'd' => true,
378	// 'fill' => true,
379	// 'stroke' => true,
380	// 'stroke-linejoin' => true,
381	// 'stroke-width' => true,
382	// 'stroke-linecap' => true,
383	// ),
384	// 'rect' => array(
385	// 'width' => true,
386	// 'height' => true,
387	// 'x' => true,
388	// 'y' => true,
389	// 'rx' => true,
390	// 'ry' => true,
391	// ),
392	// 'circle' => array(
393	// 'cx' => true,
394	// 'cy' => true,
395	// 'r' => true,
396	// ),
397	// );
398	// $kses_with_extras = array_merge( $kses_defaults, $svg_args );
399	// // For embedded PDF viewer
400	// $style_script_args = array(
401	// 'style' => true,
402	// 'script' => array(
403	// 'src' => true,
404	// ),
405	// );
406	// return array_merge( $kses_with_extras, $style_script_args );
407	// }
408	/**
409	* Get the singular label from a $post object
410	*
411	* @since 6.9.3
412	*/
413	function get_post_type_singular_label( $post ) {
414	$post_type_singular_label = '';
415	if ( property_exists( $post, 'post_type' ) ) {
416	$post_type_object = get_post_type_object( $post->post_type );
417	if ( is_object( $post_type_object ) && property_exists( $post_type_object, 'label' ) ) {
418	$post_type_singular_label = $post_type_object->labels->singular_name;
419	}
420	}
421	return $post_type_singular_label;
422	}
423
424	function is_in_block_editor() {
425	$current_screen = get_current_screen();
426	if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
427	return true;
428	} else {
429	return false;
430	}
431	}
432
433	/**
434	* Check if WooCommerce is active
435	*
436	* @since 6.9.9
437	*/
438	public function is_woocommerce_active() {
439	if ( function_exists( 'is_plugin_active' ) && is_plugin_active( 'woocommerce/woocommerce.php' ) ) {
440	return true;
441	} else {
442	return false;
443	}
444	}
445
446	/**
447	* Convert HEX color to RGBA
448	*
449	* @link https://stackoverflow.com/a/31934345
450	* @since 7.0.0
451	*/
452	public function hex_to_rgba( $hex, $alpha = false ) {
453	$hex = str_replace( '#', '', trim( $hex ) );
454	$length = strlen( $hex );
455	$rgb['r'] = hexdec( ( $length == 6 ? substr( $hex, 0, 2 ) : (( $length == 3 ? str_repeat( substr( $hex, 0, 1 ), 2 ) : 0 )) ) );
456	$rgb['g'] = hexdec( ( $length == 6 ? substr( $hex, 2, 2 ) : (( $length == 3 ? str_repeat( substr( $hex, 1, 1 ), 2 ) : 0 )) ) );
457	$rgb['b'] = hexdec( ( $length == 6 ? substr( $hex, 4, 2 ) : (( $length == 3 ? str_repeat( substr( $hex, 2, 1 ), 2 ) : 0 )) ) );
458	if ( false !== $alpha ) {
459	$rgb['a'] = $alpha;
460	}
461	// Return array of r, g, b and a
462	// return $rgb;
463	// Return rgb(255,255,255) or rgba(255,255,255,.5)
464	return implode( array_keys( $rgb ) ) . '(' . implode( ', ', $rgb ) . ')';
465	}
466
467	/**
468	* Detect if a color is light or dark
469	*
470	* @link https://stackoverflow.com/a/12228730
471	* @since 7.0.0
472	*/
473	public function is_color_dark( $hex ) {
474	$hex = str_replace( '#', '', trim( $hex ) );
475	$r = hexdec( $hex[0] . $hex[1] );
476	$g = hexdec( $hex[2] . $hex[3] );
477	$b = hexdec( $hex[4] . $hex[5] );
478	$lightness = (max( $r, $g, $b ) + min( $r, $g, $b )) / 510.0;
479	// HSL algorithm
480	if ( $lightness > 0.8 ) {
481	return false;
482	} else {
483	return true;
484	}
485	}
486
487	}
488