UsersModule::query_users() - Code Metrics - Inspection of "Merge pull request #509 from sudar/analysis-8mLmZK" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev/6.0.0 ( bb8154...8141b4 )

by Sudar

created 2018-09-10 03:30 UTC

UsersModule::query_users() A

↳ Parent: UsersModule

Complexity

Conditions	3
Paths	3

Size

Total Lines	39
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3.1105

Importance

Changes

Metric	Value
cc	3
eloc	14
nc	3
nop	1
dl	0
loc	39
ccs	10
cts	13
cp	0.7692
crap	3.1105
rs	9.7998
c	0
b	0
f	0

<?php

namespace BulkWP\BulkDelete\Core\Users;

use BulkWP\BulkDelete\Core\Base\BaseModule;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Encapsulates the Bulk Delete User Meta box Module Logic.
 * All Bulk Delete User Meta box Modules should extend this class.
 *
 * @see BaseModule
 * @since 5.5.2
 * @since 6.0.0 Renamed to UsersModule.
 */
abstract class UsersModule extends BaseModule {
	/**
	 * Build query params for WP_User_Query by using delete options.
	 *
	 * Return an empty query array to short-circuit deletion.
	 *
	 * @since 6.0.0
	 *
	 * @param array $options Delete options.
	 *
	 * @return array Query.
	 */
	abstract protected function build_query( $options );

	/**
	 * Handle common filters.
	 *
	 * @param array $request Request array.
	 *
	 * @return array User options.
	 */
	protected function parse_common_filters( $request ) {
		$options = array();

		$options['login_restrict'] = bd_array_get_bool( $request, "smbd_{$this->field_slug}_login_restrict", false );
		$options['login_days']     = absint( bd_array_get( $request, "smbd_{$this->field_slug}_login_days", 0 ) );

		$options['registered_restrict'] = bd_array_get_bool( $request, "smbd_{$this->field_slug}_registered_restrict", false );
		$options['registered_days']     = absint( bd_array_get( $request, "smbd_{$this->field_slug}_registered_days", 0 ) );

		$options['no_posts']            = bd_array_get_bool( $request, "smbd_{$this->field_slug}_no_posts", false );
		$options['no_posts_post_types'] = bd_array_get( $request, "smbd_{$this->field_slug}_no_post_post_types", array() );

		$options['limit_to'] = absint( bd_array_get( $request, "smbd_{$this->field_slug}_limit_to", 0 ) );

		return $options;
	}

	protected function do_delete( $options ) {
		$query = $this->build_query( $options );

		if ( empty( $query ) ) {
			// Short circuit deletion, if nothing needs to be deleted.
			return 0;
		}

		return $this->delete_users_from_query( $query, $options );
	}

	/**
	 * Query and Delete users.
	 *
	 * @since  5.5.2
	 * @access protected
	 *
	 * @param array $query   Options to query users.
	 * @param array $options Delete options.
	 *
	 * @return int Number of users who were deleted.
	 */
	protected function delete_users_from_query( $query, $options ) {
		$count = 0;
		$users = $this->query_users( $query );

		if ( ! function_exists( 'wp_delete_user' ) ) {
			require_once ABSPATH . 'wp-admin/includes/user.php';
		}

		foreach ( $users as $user ) {
			if ( ! $this->can_delete_by_registered_date( $options, $user ) ) {
				continue;
			}

			if ( ! $this->can_delete_by_logged_date( $options, $user ) ) {
				continue;
			}

			if ( ! $this->can_delete_by_post_count( $options, $user ) ) {
				continue;
			}

			$deleted = wp_delete_user( $user->ID );
			if ( $deleted ) {
				$count ++;
			}
		}

		return $count;
	}

	/**
	 * Query users using options.
	 *
	 * @param array $options Query options.
	 *
	 * @return \WP_User[] List of users.
	 */
	protected function query_users( $options ) {
		$defaults = array(
			'count_total' => false,
		);

		$current_user_id = get_current_user_id();
		if ( $current_user_id > 0 ) {
			if ( isset( $options['exclude'] ) ) {
				$options['exclude'] = array_merge( $options['exclude'], array( $current_user_id ) );
			} else {
				$options['exclude'] = array( $current_user_id );
			}
		}

		$options = wp_parse_args( $options, $defaults );

		$wp_user_query = new \WP_User_Query( $options );

		/**
		 * This action before the query happens.
		 *
		 * @since 6.0.0
		 *
		 * @param \WP_User_Query $wp_user_query Query object.
		 */
		do_action( 'bd_before_query', $wp_user_query );

		$users = (array) $wp_user_query->get_results();

		/**
		 * This action runs after the query happens.
		 *
		 * @since 6.0.0
		 *
		 * @param \WP_User_Query $wp_user_query Query object.
		 */
		do_action( 'bd_after_query', $wp_user_query );

		return $users;
	}

	/**
	 * Can the user be deleted based on the 'post count' option?
	 *
	 * @since  5.5.2
	 * @access protected
	 *
	 * @param array    $delete_options Delete Options.
	 * @param \WP_User $user           User object that needs to be deleted.
	 *
	 * @return bool True if the user can be deleted, false otherwise.
	 */
	protected function can_delete_by_post_count( $delete_options, $user ) {
		return ! (
			$delete_options['no_posts'] &&
			count_user_posts( $user->ID, $delete_options['no_posts_post_types'] ) > 0
		);
	}

	/**
	 * Can the user be deleted based on the 'registered date' option?
	 *
	 * @since  5.5.3
	 * @access protected
	 *
	 * @param array    $delete_options Delete Options.
	 * @param \WP_User $user           User object that needs to be deleted.
	 *
	 * @return bool True if the user can be deleted, false otherwise.
	 */
	protected function can_delete_by_registered_date( $delete_options, $user ) {
		if ( $delete_options['registered_restrict'] ) {
			$registered_days = $delete_options['registered_days'];

			if ( $registered_days > 0 ) {
				$user_meta = get_userdata( $user->ID );
				if ( strtotime( $user_meta->user_registered ) > strtotime( '-' . $registered_days . 'days' ) ) {
					return false;
				}
			}
		}

		return true;
	}

	/**
	 * Can the user be deleted based on the 'logged in date' option?
	 *
	 * @since  5.5.2
	 * @access protected
	 *
	 * @param array    $delete_options Delete Options.
	 * @param \WP_User $user           User object that needs to be deleted.
	 *
	 * @return bool True if the user can be deleted, false otherwise.
	 */
	protected function can_delete_by_logged_date( $delete_options, $user ) {
		if ( $delete_options['login_restrict'] ) {
			$login_days = $delete_options['login_days'];
			$last_login = bd_get_last_login( $user->ID );

			if ( null !== $last_login ) {

				// we have a logged-in entry for the user in simple login log plugin.
				if ( strtotime( $last_login ) > strtotime( '-' . $login_days . 'days' ) ) {
					return false;
				}
			} else {
				// we don't have a logged-in entry for the user in simple login log plugin.
				if ( $login_days > 0 ) {
					// non-zero value for login date. So don't delete this user.
					return false;
				}
			}
		}

		return true;
	}

	/**
	 * Render User Login restrict settings.
	 *
	 * @since 5.5
	 */
	protected function render_user_login_restrict_settings() {
?>
		<tr>
			<td scope="row" colspan="2">
			<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_restrict" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_restrict" value="true" type="checkbox">
				<?php _e( 'Restrict to users who are registered in the site for at least ', 'bulk-delete' );?>
				<input type="number" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_days" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_days" class="screen-per-page" value="0" min="0" disabled> <?php _e( 'days.', 'bulk-delete' );?>
			</td>
		</tr>

		<?php
		if ( bd_is_simple_login_log_present() ) {
			$disabled = '';
		} else {
			$disabled = 'disabled';
		}
?>
		<tr>
			<td scope="row" colspan="2">
			<input name="smbd_<?php echo $this->field_slug; ?>_login_restrict" id="smbd_<?php echo $this->field_slug; ?>_login_restrict" value="true" type="checkbox" <?php echo $disabled; ?>>
				<?php _e( 'Restrict to users who have not logged in the last ', 'bulk-delete' );?>
				<input type="number" name="smbd_<?php echo $this->field_slug; ?>_login_days" id="smbd_<?php echo $this->field_slug; ?>_login_days" class="screen-per-page" value="0" min="0" disabled> <?php _e( 'days', 'bulk-delete' );?>.
		<?php if ( 'disabled' == $disabled ) { ?>
				<span style = "color:red">
					<?php _e( 'Need the free "Simple Login Log" Plugin', 'bulk-delete' ); ?> <a href = "http://wordpress.org/plugins/simple-login-log/">Install now</a>
				</span>
		<?php } ?>
			</td>
		</tr>

		<?php if ( bd_is_simple_login_log_present() ) : ?>
			<tr>
				<td scope="row" colspan="2">
					<?php _e( 'Enter "0 days" to delete users who have never logged in after the "Simple Login Log" plugin has been installed.', 'bulk-delete' ); ?>
			</tr>
		<?php endif; ?>
<?php
	}

	/**
	 * Render delete user with no posts settings.
	 *
	 * @since 5.5
	 */
	protected function render_user_with_no_posts_settings() {
	?>
		<tr>
			<td scope="row" colspan="2">
				<input type="checkbox" value="true"
				       name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_no_posts"
				       id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_no_posts" class="user_restrict_to_no_posts_filter">

				<?php _e( "Restrict to users who don't have any posts.", 'bulk-delete' ); ?>
			</td>
		</tr>

		<tr class="user_restrict_to_no_posts_filter_items visually-hidden">
			<td scope="row" colspan="2">
				<table class="filter-items">
					<tr>
						<td scope="row">
							<?php _e( 'Select the post types. By default all post types are considered.', 'bulk-delete' ); ?>
						</td>
					</tr>

					<?php $this->render_post_type_checkboxes( "smbd_{$this->field_slug}_no_post_post_types" ); ?>
				</table>
			</td>
		</tr>

	<?php
	}
}


1		<?php
2
3		namespace BulkWP\BulkDelete\Core\Users;
4
5		use BulkWP\BulkDelete\Core\Base\BaseModule;
6
7	1	defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
8
9		/**
10		* Encapsulates the Bulk Delete User Meta box Module Logic.
11		* All Bulk Delete User Meta box Modules should extend this class.
12		*
13		* @see BaseModule
14		* @since 5.5.2
15		* @since 6.0.0 Renamed to UsersModule.
16		*/
17		abstract class UsersModule extends BaseModule {
18		/**
19		* Build query params for WP_User_Query by using delete options.
20		*
21		* Return an empty query array to short-circuit deletion.
22		*
23		* @since 6.0.0
24		*
25		* @param array $options Delete options.
26		*
27		* @return array Query.
28		*/
29		abstract protected function build_query( $options );
30
31		/**
32		* Handle common filters.
33		*
34		* @param array $request Request array.
35		*
36		* @return array User options.
37		*/
38		protected function parse_common_filters( $request ) {
39		$options = array();
40
41		$options['login_restrict'] = bd_array_get_bool( $request, "smbd_{$this->field_slug}_login_restrict", false );
42		$options['login_days'] = absint( bd_array_get( $request, "smbd_{$this->field_slug}_login_days", 0 ) );
43
44		$options['registered_restrict'] = bd_array_get_bool( $request, "smbd_{$this->field_slug}_registered_restrict", false );
45		$options['registered_days'] = absint( bd_array_get( $request, "smbd_{$this->field_slug}_registered_days", 0 ) );
46
47		$options['no_posts'] = bd_array_get_bool( $request, "smbd_{$this->field_slug}_no_posts", false );
48		$options['no_posts_post_types'] = bd_array_get( $request, "smbd_{$this->field_slug}_no_post_post_types", array() );
49
50		$options['limit_to'] = absint( bd_array_get( $request, "smbd_{$this->field_slug}_limit_to", 0 ) );
51
52		return $options;
53		}
54
55	44	protected function do_delete( $options ) {
56	44	$query = $this->build_query( $options );
57
58	44	if ( empty( $query ) ) {
59		// Short circuit deletion, if nothing needs to be deleted.
60		return 0;
61		}
62
63	44	return $this->delete_users_from_query( $query, $options );
64		}
65
66		/**
67		* Query and Delete users.
68		*
69		* @since 5.5.2
70		* @access protected
71		*
72		* @param array $query Options to query users.
73		* @param array $options Delete options.
74		*
75		* @return int Number of users who were deleted.
76		*/
77	44	protected function delete_users_from_query( $query, $options ) {
78	44	$count = 0;
79	44	$users = $this->query_users( $query );
80
81	44	if ( ! function_exists( 'wp_delete_user' ) ) {
82		require_once ABSPATH . 'wp-admin/includes/user.php';
83		}
84
85	44	foreach ( $users as $user ) {
86	44	if ( ! $this->can_delete_by_registered_date( $options, $user ) ) {
87	10	continue;
88		}
89
90	40	if ( ! $this->can_delete_by_logged_date( $options, $user ) ) {
91		continue;
92		}
93
94	40	if ( ! $this->can_delete_by_post_count( $options, $user ) ) {
95	9	continue;
96		}
97
98	39	$deleted = wp_delete_user( $user->ID );
99	39	if ( $deleted ) {
100	39	$count ++;
101		}
102		}
103
104	44	return $count;
105		}
106
107		/**
108		* Query users using options.
109		*
110		* @param array $options Query options.
111		*
112		* @return \WP_User[] List of users.
113		*/
114	44	protected function query_users( $options ) {
115		$defaults = array(
116	44	'count_total' => false,
117		);
118
119	44	$current_user_id = get_current_user_id();
120	44	if ( $current_user_id > 0 ) {
121		if ( isset( $options['exclude'] ) ) {
122		$options['exclude'] = array_merge( $options['exclude'], array( $current_user_id ) );
123		} else {
124		$options['exclude'] = array( $current_user_id );
125		}
126		}
127
128	44	$options = wp_parse_args( $options, $defaults );
129
130	44	$wp_user_query = new \WP_User_Query( $options );
131
132		/**
133		* This action before the query happens.
134		*
135		* @since 6.0.0
136		*
137		* @param \WP_User_Query $wp_user_query Query object.
138		*/
139	44	do_action( 'bd_before_query', $wp_user_query );
140
141	44	$users = (array) $wp_user_query->get_results();
142
143		/**
144		* This action runs after the query happens.
145		*
146		* @since 6.0.0
147		*
148		* @param \WP_User_Query $wp_user_query Query object.
149		*/
150	44	do_action( 'bd_after_query', $wp_user_query );
151
152	44	return $users;
153		}
154
155		/**
156		* Can the user be deleted based on the 'post count' option?
157		*
158		* @since 5.5.2
159		* @access protected
160		*
161		* @param array $delete_options Delete Options.
162		* @param \WP_User $user User object that needs to be deleted.
163		*
164		* @return bool True if the user can be deleted, false otherwise.
165		*/
166	40	protected function can_delete_by_post_count( $delete_options, $user ) {
167		return ! (
168	40	$delete_options['no_posts'] &&
169	40	count_user_posts( $user->ID, $delete_options['no_posts_post_types'] ) > 0
170		);
171		}
172
173		/**
174		* Can the user be deleted based on the 'registered date' option?
175		*
176		* @since 5.5.3
177		* @access protected
178		*
179		* @param array $delete_options Delete Options.
180		* @param \WP_User $user User object that needs to be deleted.
181		*
182		* @return bool True if the user can be deleted, false otherwise.
183		*/
184	44	protected function can_delete_by_registered_date( $delete_options, $user ) {
185	44	if ( $delete_options['registered_restrict'] ) {
186	12	$registered_days = $delete_options['registered_days'];
187
188	12	if ( $registered_days > 0 ) {
189	11	$user_meta = get_userdata( $user->ID );
190	11	if ( strtotime( $user_meta->user_registered ) > strtotime( '-' . $registered_days . 'days' ) ) {
191	10	return false;
192		}
193		}
194		}
195
196	40	return true;
197		}
198
199		/**
200		* Can the user be deleted based on the 'logged in date' option?
201		*
202		* @since 5.5.2
203		* @access protected
204		*
205		* @param array $delete_options Delete Options.
206		* @param \WP_User $user User object that needs to be deleted.
207		*
208		* @return bool True if the user can be deleted, false otherwise.
209		*/
210	40	protected function can_delete_by_logged_date( $delete_options, $user ) {
211	40	if ( $delete_options['login_restrict'] ) {
212		$login_days = $delete_options['login_days'];
213		$last_login = bd_get_last_login( $user->ID );
214
215		if ( null !== $last_login ) {
		0 ignored issues – show introduced 2018-03-10 18:27 UTC by Report Bug Copy Issue Report The condition `null !== $last_login` is always `true`. Loading history...
216		// we have a logged-in entry for the user in simple login log plugin.
217		if ( strtotime( $last_login ) > strtotime( '-' . $login_days . 'days' ) ) {
218		return false;
219		}
220		} else {
221		// we don't have a logged-in entry for the user in simple login log plugin.
222		if ( $login_days > 0 ) {
223		// non-zero value for login date. So don't delete this user.
224		return false;
225		}
226		}
227		}
228
229	40	return true;
230		}
231
232		/**
233		* Render User Login restrict settings.
234		*
235		* @since 5.5
236		*/
237		protected function render_user_login_restrict_settings() {
238		?>
239		<tr>
240		<td scope="row" colspan="2">
241		<input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_restrict" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_restrict" value="true" type="checkbox">
242		<?php _e( 'Restrict to users who are registered in the site for at least ', 'bulk-delete' );?>
243		<input type="number" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_days" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_registered_days" class="screen-per-page" value="0" min="0" disabled> <?php _e( 'days.', 'bulk-delete' );?>
244		</td>
245		</tr>
246
247		<?php
248		if ( bd_is_simple_login_log_present() ) {
249		$disabled = '';
250		} else {
251		$disabled = 'disabled';
252		}
253		?>
254		<tr>
255		<td scope="row" colspan="2">
256		<input name="smbd_<?php echo $this->field_slug; ?>_login_restrict" id="smbd_<?php echo $this->field_slug; ?>_login_restrict" value="true" type="checkbox" <?php echo $disabled; ?>>
257		<?php _e( 'Restrict to users who have not logged in the last ', 'bulk-delete' );?>
258		<input type="number" name="smbd_<?php echo $this->field_slug; ?>_login_days" id="smbd_<?php echo $this->field_slug; ?>_login_days" class="screen-per-page" value="0" min="0" disabled> <?php _e( 'days', 'bulk-delete' );?>.
259		<?php if ( 'disabled' == $disabled ) { ?>
260		<span style = "color:red">
261		<?php _e( 'Need the free "Simple Login Log" Plugin', 'bulk-delete' ); ?> <a href = "http://wordpress.org/plugins/simple-login-log/">Install now</a>
262		</span>
263		<?php } ?>
264		</td>
265		</tr>
266
267		<?php if ( bd_is_simple_login_log_present() ) : ?>
268		<tr>
269		<td scope="row" colspan="2">
270		<?php _e( 'Enter "0 days" to delete users who have never logged in after the "Simple Login Log" plugin has been installed.', 'bulk-delete' ); ?>
271		</tr>
272		<?php endif; ?>
273		<?php
274		}
275
276		/**
277		* Render delete user with no posts settings.
278		*
279		* @since 5.5
280		*/
281		protected function render_user_with_no_posts_settings() {
282		?>
283		<tr>
284		<td scope="row" colspan="2">
285		<input type="checkbox" value="true"
286		name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_no_posts"
287		id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_no_posts" class="user_restrict_to_no_posts_filter">
288
289		<?php _e( "Restrict to users who don't have any posts.", 'bulk-delete' ); ?>
290		</td>
291		</tr>
292
293		<tr class="user_restrict_to_no_posts_filter_items visually-hidden">
294		<td scope="row" colspan="2">
295		<table class="filter-items">
296		<tr>
297		<td scope="row">
298		<?php _e( 'Select the post types. By default all post types are considered.', 'bulk-delete' ); ?>
299		</td>
300		</tr>
301
302		<?php $this->render_post_type_checkboxes( "smbd_{$this->field_slug}_no_post_post_types" ); ?>
303		</table>
304		</td>
305		</tr>
306
307		<?php
308		}
309		}
310

sudar / bulk-delete

Push — dev/6.0.0 ( bb8154...8141b4 )

UsersModule::query_users() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like