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

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

admin-site-enhancements / classes Last commit date

class-common-methods.php

317 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	/**
14	* Get IP of the current visitor/user. In use by at least the Limit Login Attempts feature.
15	* This takes a best guess of the visitor's actual IP address.
16	* Takes into account numerous HTTP proxy headers due to variations
17	* in how different ISPs handle IP addresses in headers between hops.
18	*
19	* @link https://stackoverflow.com/q/1634782
20	* @since 2.5.0
21	*/
22	public function get_user_ip_address()
23	{
24	// Check for shared internet/ISP IP
25	if ( !empty($_SERVER['HTTP_CLIENT_IP']) && $this->is_ip_valid( $_SERVER['HTTP_CLIENT_IP'] ) ) {
26	return sanitize_text_field( $_SERVER['HTTP_CLIENT_IP'] );
27	}
28	// Check for IPs passing through proxies
29
30	if ( !empty($_SERVER['HTTP_X_FORWARDED_FOR']) ) {
31	// Check if multiple IP addresses exist in var
32	$ip_list = explode( ',', $_SERVER['HTTP_X_FORWARDED_FOR'] );
33
34	if ( is_array( $ip_list ) ) {
35	foreach ( $ip_list as $ip ) {
36	if ( $this->is_ip_valid( trim( $ip ) ) ) {
37	return sanitize_text_field( trim( $ip ) );
38	}
39	}
40	} else {
41	return sanitize_text_field( $_SERVER['HTTP_X_FORWARDED_FOR'] );
42	}
43
44	}
45
46	if ( !empty($_SERVER['HTTP_X_FORWARDED']) && $this->is_ip_valid( $_SERVER['HTTP_X_FORWARDED'] ) ) {
47	return sanitize_text_field( $_SERVER['HTTP_X_FORWARDED'] );
48	}
49	if ( !empty($_SERVER['HTTP_X_CLUSTER_CLIENT_IP']) && $this->is_ip_valid( $_SERVER['HTTP_X_CLUSTER_CLIENT_IP'] ) ) {
50	return sanitize_text_field( $_SERVER['HTTP_X_CLUSTER_CLIENT_IP'] );
51	}
52	if ( !empty($_SERVER['HTTP_FORWARDED_FOR']) && $this->is_ip_valid( $_SERVER['HTTP_FORWARDED_FOR'] ) ) {
53	return sanitize_text_field( $_SERVER['HTTP_FORWARDED_FOR'] );
54	}
55	if ( !empty($_SERVER['HTTP_FORWARDED']) && $this->is_ip_valid( $_SERVER['HTTP_FORWARDED'] ) ) {
56	return sanitize_text_field( $_SERVER['HTTP_FORWARDED'] );
57	}
58	// Return unreliable IP address since all else failed
59	return sanitize_text_field( $_SERVER['REMOTE_ADDR'] );
60	}
61
62	/**
63	* Check if the supplied IP address is valid or not
64	*
65	* @param string $ip an IP address
66	* @link https://stackoverflow.com/q/1634782
67	* @return boolean true if supplied address is valid IP, and false otherwise
68	*/
69	public function is_ip_valid( $ip )
70	{
71	if ( empty($ipt) ) {
72	return false;
73	}
74
75	if ( false == filter_var( $ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 \| FILTER_FLAG_IPV6 \| FILTER_FLAG_NO_PRIV_RANGE \| FILTER_FLAG_NO_RES_RANGE ) ) {
76	return false;
77	} else {
78	return true;
79	}
80
81	}
82
83	/**
84	* Convert number of seconds into hours, minutes, seconds. In use by at least the Limit Login Attempts feature.
85	*
86	* @since 2.5.0
87	*/
88	public function seconds_to_period( $seconds, $conversion_type )
89	{
90	$period_start = new \DateTime( '@0' );
91	$period_end = new \DateTime( "@{$seconds}" );
92
93	if ( $conversion_type == 'to-days-hours-minutes-seconds' ) {
94	return $period_start->diff( $period_end )->format( '%a days, %h hours, %i minutes and %s seconds' );
95	} elseif ( $conversion_type == 'to-hours-minutes-seconds' ) {
96	return $period_start->diff( $period_end )->format( '%h hours, %i minutes and %s seconds' );
97	} elseif ( $conversion_type == 'to-minutes-seconds' ) {
98	return $period_start->diff( $period_end )->format( '%i minutes and %s seconds' );
99	} else {
100	return $period_start->diff( $period_end )->format( '%a days, %h hours, %i minutes and %s seconds' );
101	}
102
103	}
104
105	/**
106	* Remove html tags and content inside the tags from a string
107	*
108	* @since 3.0.3
109	*/
110	public function strip_html_tags_and_content( $string )
111	{
112	// Strip HTML tags and content inside them. Ref: https://stackoverflow.com/a/39320168
113
114	if ( !is_null( $string ) ) {
115	$string = preg_replace( '@<(\\w+)\\b.?>.?</\\1>@si', '', $string );
116	// Strip any remaining HTML or PHP tags
117	$string = strip_tags( $string );
118	}
119
120	return $string;
121	}
122
123	/**
124	* Get menu hidden by toggle
125	*
126	* @since 5.1.0
127	*/
128	public function get_menu_hidden_by_toggle()
129	{
130	$menu_hidden_by_toggle = array();
131	$options = get_option( ASENHA_SLUG_U, array() );
132
133	if ( array_key_exists( 'custom_menu_hidden', $options ) ) {
134	$menu_hidden = $options['custom_menu_hidden'];
135	$menu_hidden = explode( ',', $menu_hidden );
136	$menu_hidden_by_toggle = array();
137	foreach ( $menu_hidden as $menu_id ) {
138	$menu_hidden_by_toggle[] = $this->restore_menu_item_id( $menu_id );
139	}
140	}
141
142	return $menu_hidden_by_toggle;
143	}
144
145	/**
146	* Get user capabilities for which the "Show All/Less" menu toggle should be shown for
147	*
148	* @since 5.1.0
149	*/
150	public function get_user_capabilities_to_show_menu_toggle_for()
151	{
152	global $menu ;
153	$menu_always_hidden = array();
154	$user_capabilities_menus_are_hidden_for = array();
155	$menu_hidden_by_toggle = $this->get_menu_hidden_by_toggle();
156	// indexed array
157	foreach ( $menu as $menu_key => $menu_info ) {
158	foreach ( $menu_hidden_by_toggle as $hidden_menu_id ) {
159
160	if ( false !== strpos( $menu_info[4], 'wp-menu-separator' ) ) {
161	$menu_item_id = $menu_info[2];
162	} else {
163	$menu_item_id = $menu_info[5];
164	}
165
166	if ( $menu_item_id == $hidden_menu_id ) {
167	$user_capabilities_menus_are_hidden_for[] = $menu_info[1];
168	}
169	}
170	}
171	$user_capabilities_menus_are_hidden_for = array_unique( $user_capabilities_menus_are_hidden_for );
172	return $user_capabilities_menus_are_hidden_for;
173	// indexed array
174	}
175
176	/**
177	* Transform menu item's ID
178	*
179	* @since 5.1.0
180	*/
181	public function transform_menu_item_id( $menu_item_id )
182	{
183	// Transform e.g. edit.php?post_type=page ==> edit__php___post_type____page
184	$menu_item_id_transformed = str_replace( array(
185	".",
186	"?",
187	"=/",
188	"=",
189	"&",
190	"/"
191	), array(
192	"__",
193	"___",
194	"_______",
195	"____",
196	"_____",
197	"______"
198	), $menu_item_id );
199	return $menu_item_id_transformed;
200	}
201
202	/**
203	* Transform menu item's ID
204	*
205	* @since 5.1.0
206	*/
207	public function restore_menu_item_id( $menu_item_id_transformed )
208	{
209	// Transform e.g. edit__php___post_type____page ==> edit.php?post_type=page
210	$menu_item_id = str_replace( array(
211	"_______",
212	"______",
213	"_____",
214	"____",
215	"___",
216	"__"
217	), array(
218	"=/",
219	"/",
220	"&",
221	"=",
222	"?",
223	"."
224	), $menu_item_id_transformed );
225	return $menu_item_id;
226	}
227
228	/**
229	* Sanitize hexedecimal numbers used for colors
230	*
231	* @link https://plugins.trac.wordpress.org/browser/bm-custom-login/trunk/bm-custom-login.php
232	* @param string $color Hex number to sanitize.
233	* @return string
234	*/
235	public function sanitize_hex_color( $color )
236	{
237	if ( '' === $color ) {
238	return '';
239	}
240	// Make sure the color starts with a hash.
241	$color = '#' . ltrim( $color, '#' );
242	// 3 or 6 hex digits, or the empty string.
243	if ( preg_match( '\|^#([A-Fa-f0-9]{3}){1,2}$\|', $color ) ) {
244	return $color;
245	}
246	return null;
247	}
248
249	/**
250	* Get the post ID of the most recent post in a custom post type
251	*
252	* @since 6.4.1
253	*/
254	public function get_most_recent_post_id( $post_type )
255	{
256	$args = array(
257	'post_type' => $post_type,
258	'posts_per_page' => 1,
259	'orderby' => 'date',
260	'order' => 'DESC',
261	);
262	$query = new WP_Query( $args );
263
264	if ( $query->have_posts() ) {
265	$query->the_post();
266	$post_id = get_the_ID();
267	wp_reset_postdata();
268	return $post_id;
269	}
270
271	return 0;
272	// Return 0 if no posts found
273	}
274
275	/**
276	* Extended ruleset for wp_kses() that includes SVG tag and it's children
277	*
278	* @since 6.8.3
279	*/
280	public function get_kses_extended_ruleset()
281	{
282	$kses_defaults = wp_kses_allowed_html( 'post' );
283	// For SVG icons
284	$svg_args = array(
285	'svg' => array(
286	'class' => true,
287	'aria-hidden' => true,
288	'aria-labelledby' => true,
289	'role' => true,
290	'xmlns' => true,
291	'width' => true,
292	'height' => true,
293	'viewbox' => true,
294	),
295	'g' => array(
296	'fill' => true,
297	),
298	'title' => array(
299	'title' => true,
300	),
301	'path' => array(
302	'd' => true,
303	'fill' => true,
304	),
305	);
306	$kses_with_extras = array_merge( $kses_defaults, $svg_args );
307	// For embedded PDF viewer
308	$style_script_args = array(
309	'style' => true,
310	'script' => array(
311	'src' => true,
312	),
313	);
314	return array_merge( $kses_with_extras, $style_script_args );
315	}
316
317	}