Jetpack_Sync_Module_Users::get_where_sql() - Code Metrics - Inspection of "Add support for backfilling users" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/get-object-api-for-sync ( 408c06...06de26 )

unknown

created 2016-08-26 23:42 UTC

Jetpack_Sync_Module_Users::get_where_sql() A

↳ Parent: Jetpack_Sync_Module_Users

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	12
Ratio	100 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	1
dl	12
loc	12
rs	9.4285
c	0
b	0
f	0

<?php

class Jetpack_Sync_Module_Users extends Jetpack_Sync_Module {
	const MAX_INITIAL_SYNC_USERS = 100;
	
	function name() {
		return 'users';
	}

	// this is here to support the backfill API
	public function get_object_by_id( $object_type, $id ) {
		if ( $object_type === 'user' && $user = get_user_by( 'id', intval( $id ) ) ) {
			return $this->sanitize_user_and_expand( $user );
		}

		return false;
	}

	public function init_listeners( $callable ) {
		// users
		add_action( 'user_register', array( $this, 'save_user_handler' ) );
		add_action( 'profile_update', array( $this, 'save_user_handler' ), 10, 2 );
		add_action( 'add_user_to_blog', array( $this, 'save_user_handler' ) );
		add_action( 'jetpack_sync_save_user', $callable, 10, 2 );

		add_action( 'deleted_user', $callable, 10, 2 );
		add_action( 'remove_user_from_blog', $callable, 10, 2 );

		// user roles
		add_action( 'add_user_role', array( $this, 'save_user_role_handler' ), 10, 2 );
		add_action( 'set_user_role', array( $this, 'save_user_role_handler' ), 10, 3 );
		add_action( 'remove_user_role', array( $this, 'save_user_role_handler' ), 10, 2 );

		// user capabilities
		add_action( 'added_user_meta', array( $this, 'save_user_cap_handler' ), 10, 4 );
		add_action( 'updated_user_meta', array( $this, 'save_user_cap_handler' ), 10, 4 );
		add_action( 'deleted_user_meta', array( $this, 'save_user_cap_handler' ), 10, 4 );

		// user authentication
		add_action( 'wp_login', $callable, 10, 2 );
		add_action( 'wp_login_failed', $callable, 10, 2 );
		add_action( 'wp_logout', $callable, 10, 0 );
	}

	public function init_full_sync_listeners( $callable ) {
		add_action( 'jetpack_full_sync_users', $callable );
	}

	public function init_before_send() {
		add_filter( 'jetpack_sync_before_send_jetpack_sync_save_user', array( $this, 'expand_user' ) );
		add_filter( 'jetpack_sync_before_send_wp_login', array( $this, 'expand_login_username' ), 10, 1 );
		add_filter( 'jetpack_sync_before_send_wp_logout', array( $this, 'expand_logout_username' ), 10, 2 );

		// full sync
		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_users', array( $this, 'expand_users' ) );
	}

	public function sanitize_user_and_expand( $user ) {
		$user = $this->sanitize_user( $user );

		return $this->add_to_user( $user );
	}

	public function sanitize_user( $user ) {
		// this create a new user object and stops the passing of the object by reference.
		$user = unserialize( serialize( $user ) );
		unset( $user->data->user_pass );

		return $user;
	}

	public function add_to_user( $user ) {
		$user->allowed_mime_types = get_allowed_mime_types( $user );

		return $user;
	}

	public function expand_user( $args ) {
		list( $user ) = $args;

		if ( $user ) {
			return array( $this->add_to_user( $user ) );	
		}

		return false;
	}

	public function expand_login_username( $args ) {
		list( $login, $user ) = $args;
		$user = $this->sanitize_user( $user );

		return array( $login, $user );
	}

	public function expand_logout_username( $args, $user_id ) {
		$user  = get_userdata( $user_id );
		$user  = $this->sanitize_user( $user );
		$login = $user->data->user_login;

		return array( $login, $user );
	}

	function save_user_handler( $user_id, $old_user_data = null ) {

		// ensure we only sync users who are members of the current blog
		if ( ! is_user_member_of_blog( $user_id, get_current_blog_id() ) ) {
			return;
		}

		$user = $this->sanitize_user( get_user_by( 'id', $user_id ) );

		// Older versions of WP don't pass the old_user_data in ->data
		if ( isset( $old_user_data->data ) ) {
			$old_user = $old_user_data->data;
		} else {
			$old_user = $old_user_data;
		}

		if ( $old_user !== null ) {
			unset( $old_user->user_pass );
			if ( serialize( $old_user ) === serialize( $user->data ) ) {
				return;
			}
		}
		/**
		 * Fires when the client needs to sync an updated user
		 *
		 * @since 4.2.0
		 *
		 * @param object The WP_User object
		 */
		do_action( 'jetpack_sync_save_user', $user );
	}

	function save_user_role_handler( $user_id, $role, $old_roles = null ) {

		$user = $this->sanitize_user( get_user_by( 'id', $user_id ) );

		/**
		 * Fires when the client needs to sync an updated user
		 *
		 * @since 4.2.0
		 *
		 * @param object The WP_User object
		 */
		do_action( 'jetpack_sync_save_user', $user );
	}

	function save_user_cap_handler( $meta_id, $user_id, $meta_key, $capabilities ) {


		// if a user is currently being removed as a member of this blog, we don't fire the event
		if ( current_filter() === 'deleted_user_meta'
		     &&
		     preg_match( '/capabilities|user_level/', $meta_key )
		     &&
		     ! is_user_member_of_blog( $user_id, get_current_blog_id() )
		) {
			return;
		}

		$user =  get_user_by( 'id', $user_id );
		if ( $meta_key === $user->cap_key ) {
			/**
			 * Fires when the client needs to sync an updated user
			 *
			 * @since 4.2.0
			 *
			 * @param object The Sanitized WP_User object
			 */
			do_action( 'jetpack_sync_save_user', $this->sanitize_user( $user ) );
		}
	}

	public function enqueue_full_sync_actions( $config ) {
		global $wpdb;
		return $this->enqueue_all_ids_as_action( 'jetpack_full_sync_users', $wpdb->usermeta, 'user_id', $this->get_where_sql( $config ) );
	}

	public function estimate_full_sync_actions( $config ) {
		global $wpdb;

		$query = "SELECT count(*) FROM $wpdb->usermeta";
		
		if ( $where_sql = $this->get_where_sql( $config ) ) {
			$query .= ' WHERE ' . $where_sql;
		}

		$count = $wpdb->get_var( $query );

		return (int) ceil( $count / self::ARRAY_CHUNK_SIZE );
	}

	private function get_where_sql( $config ) {
		global $wpdb;

		$query = "meta_key = '{$wpdb->prefix}capabilities'";
		
		// config is a list of user IDs to sync
		if ( is_array( $config ) ) {
			$query .= ' AND user_id IN (' . implode( ',', array_map( 'intval', $config ) ) . ')';
		}

		return $query;
	}

	function get_full_sync_actions() {
		return array( 'jetpack_full_sync_users' );
	}

	function get_initial_sync_user_config() {
		global $wpdb;

		$user_ids = $wpdb->get_col( "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}user_level' AND meta_value > 0 LIMIT " . ( self::MAX_INITIAL_SYNC_USERS + 1 ) );

		if ( count( $user_ids ) <= self::MAX_INITIAL_SYNC_USERS ) {
			return $user_ids;
		} else {
			return false;
		}
	}

	public function expand_users( $args ) {
		$user_ids = $args[0];

		return array_map( array( $this, 'sanitize_user_and_expand' ), get_users( array( 'include' => $user_ids ) ) );
	}
}


1		<?php
2
3		class Jetpack_Sync_Module_Users extends Jetpack_Sync_Module {
4		const MAX_INITIAL_SYNC_USERS = 100;
5
6		function name() {
7		return 'users';
8		}
9
10		// this is here to support the backfill API
11		public function get_object_by_id( $object_type, $id ) {
12		if ( $object_type === 'user' && $user = get_user_by( 'id', intval( $id ) ) ) {
13		return $this->sanitize_user_and_expand( $user );
14		}
15
16		return false;
17		}
18
19		public function init_listeners( $callable ) {
20		// users
21		add_action( 'user_register', array( $this, 'save_user_handler' ) );
22		add_action( 'profile_update', array( $this, 'save_user_handler' ), 10, 2 );
23		add_action( 'add_user_to_blog', array( $this, 'save_user_handler' ) );
24		add_action( 'jetpack_sync_save_user', $callable, 10, 2 );
25
26		add_action( 'deleted_user', $callable, 10, 2 );
27		add_action( 'remove_user_from_blog', $callable, 10, 2 );
28
29		// user roles
30		add_action( 'add_user_role', array( $this, 'save_user_role_handler' ), 10, 2 );
31		add_action( 'set_user_role', array( $this, 'save_user_role_handler' ), 10, 3 );
32		add_action( 'remove_user_role', array( $this, 'save_user_role_handler' ), 10, 2 );
33
34		// user capabilities
35		add_action( 'added_user_meta', array( $this, 'save_user_cap_handler' ), 10, 4 );
36		add_action( 'updated_user_meta', array( $this, 'save_user_cap_handler' ), 10, 4 );
37		add_action( 'deleted_user_meta', array( $this, 'save_user_cap_handler' ), 10, 4 );
38
39		// user authentication
40		add_action( 'wp_login', $callable, 10, 2 );
41		add_action( 'wp_login_failed', $callable, 10, 2 );
42		add_action( 'wp_logout', $callable, 10, 0 );
43		}
44
45		public function init_full_sync_listeners( $callable ) {
46		add_action( 'jetpack_full_sync_users', $callable );
47		}
48
49		public function init_before_send() {
50		add_filter( 'jetpack_sync_before_send_jetpack_sync_save_user', array( $this, 'expand_user' ) );
51		add_filter( 'jetpack_sync_before_send_wp_login', array( $this, 'expand_login_username' ), 10, 1 );
52		add_filter( 'jetpack_sync_before_send_wp_logout', array( $this, 'expand_logout_username' ), 10, 2 );
53
54		// full sync
55		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_users', array( $this, 'expand_users' ) );
56		}
57
58		public function sanitize_user_and_expand( $user ) {
59		$user = $this->sanitize_user( $user );
60
61		return $this->add_to_user( $user );
62		}
63
64		public function sanitize_user( $user ) {
65		// this create a new user object and stops the passing of the object by reference.
66		$user = unserialize( serialize( $user ) );
67		unset( $user->data->user_pass );
68
69		return $user;
70		}
71
72		public function add_to_user( $user ) {
73		$user->allowed_mime_types = get_allowed_mime_types( $user );
74
75		return $user;
76		}
77
78		public function expand_user( $args ) {
79		list( $user ) = $args;
80
81		if ( $user ) {
82		return array( $this->add_to_user( $user ) );
83		}
84
85		return false;
86		}
87
88		public function expand_login_username( $args ) {
89		list( $login, $user ) = $args;
90		$user = $this->sanitize_user( $user );
91
92		return array( $login, $user );
93		}
94
95		public function expand_logout_username( $args, $user_id ) {
96		$user = get_userdata( $user_id );
97		$user = $this->sanitize_user( $user );
98		$login = $user->data->user_login;
99
100		return array( $login, $user );
101		}
102
103		function save_user_handler( $user_id, $old_user_data = null ) {
104
105		// ensure we only sync users who are members of the current blog
106		if ( ! is_user_member_of_blog( $user_id, get_current_blog_id() ) ) {
107		return;
108		}
109
110		$user = $this->sanitize_user( get_user_by( 'id', $user_id ) );
111
112		// Older versions of WP don't pass the old_user_data in ->data
113		if ( isset( $old_user_data->data ) ) {
114		$old_user = $old_user_data->data;
115		} else {
116		$old_user = $old_user_data;
117		}
118
119		if ( $old_user !== null ) {
120		unset( $old_user->user_pass );
121		if ( serialize( $old_user ) === serialize( $user->data ) ) {
122		return;
123		}
124		}
125		/**
126		* Fires when the client needs to sync an updated user
127		*
128		* @since 4.2.0
129		*
130		* @param object The WP_User object
131		*/
132		do_action( 'jetpack_sync_save_user', $user );
133		}
134
135		function save_user_role_handler( $user_id, $role, $old_roles = null ) {
		0 ignored issues – show Unused Code introduced 2016-06-29 22:35 UTC by Report Bug Copy Issue Report The parameter `$role` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-06-29 22:35 UTC by Report Bug Copy Issue Report The parameter `$old_roles` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
136		$user = $this->sanitize_user( get_user_by( 'id', $user_id ) );
137
138		/**
139		* Fires when the client needs to sync an updated user
140		*
141		* @since 4.2.0
142		*
143		* @param object The WP_User object
144		*/
145		do_action( 'jetpack_sync_save_user', $user );
146		}
147
148		function save_user_cap_handler( $meta_id, $user_id, $meta_key, $capabilities ) {
		0 ignored issues – show Unused Code introduced 2016-06-29 22:35 UTC by Report Bug Copy Issue Report The parameter `$capabilities` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
149
150		// if a user is currently being removed as a member of this blog, we don't fire the event
151		if ( current_filter() === 'deleted_user_meta'
152		&&
153		preg_match( '/capabilities\|user_level/', $meta_key )
154		&&
155		! is_user_member_of_blog( $user_id, get_current_blog_id() )
156		) {
157		return;
158		}
159
160		$user = get_user_by( 'id', $user_id );
161		if ( $meta_key === $user->cap_key ) {
162		/**
163		* Fires when the client needs to sync an updated user
164		*
165		* @since 4.2.0
166		*
167		* @param object The Sanitized WP_User object
168		*/
169		do_action( 'jetpack_sync_save_user', $this->sanitize_user( $user ) );
170		}
171		}
172
173		public function enqueue_full_sync_actions( $config ) {
174		global $wpdb;
175		return $this->enqueue_all_ids_as_action( 'jetpack_full_sync_users', $wpdb->usermeta, 'user_id', $this->get_where_sql( $config ) );
176		}
177
178	View Code Duplication	public function estimate_full_sync_actions( $config ) {
179		global $wpdb;
180
181		$query = "SELECT count(*) FROM $wpdb->usermeta";
182
183		if ( $where_sql = $this->get_where_sql( $config ) ) {
184		$query .= ' WHERE ' . $where_sql;
185		}
186
187		$count = $wpdb->get_var( $query );
188
189		return (int) ceil( $count / self::ARRAY_CHUNK_SIZE );
190		}
191
192	View Code Duplication	private function get_where_sql( $config ) {
193		global $wpdb;
194
195		$query = "meta_key = '{$wpdb->prefix}capabilities'";
196
197		// config is a list of user IDs to sync
198		if ( is_array( $config ) ) {
199		$query .= ' AND user_id IN (' . implode( ',', array_map( 'intval', $config ) ) . ')';
200		}
201
202		return $query;
203		}
204
205		function get_full_sync_actions() {
206		return array( 'jetpack_full_sync_users' );
207		}
208
209		function get_initial_sync_user_config() {
210		global $wpdb;
211
212		$user_ids = $wpdb->get_col( "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}user_level' AND meta_value > 0 LIMIT " . ( self::MAX_INITIAL_SYNC_USERS + 1 ) );
213
214		if ( count( $user_ids ) <= self::MAX_INITIAL_SYNC_USERS ) {
215		return $user_ids;
216		} else {
217		return false;
218		}
219		}
220
221		public function expand_users( $args ) {
222		$user_ids = $args[0];
223
224		return array_map( array( $this, 'sanitize_user_and_expand' ), get_users( array( 'include' => $user_ids ) ) );
225		}
226		}
227

Automattic / jetpack

Push — add/get-object-api-for-sync ( 408c06...06de26 )

Jetpack_Sync_Module_Users::get_where_sql() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like