Protect Module: refactor ip whitelist

improving data handling so that schema is uniform between the endpoints
and the configuration screen.

Author: roccotripaldi

json-endpoints/jetpack/json-api-jetpack-endpoints.php

@@ -574,7 +574,7 @@
 		'$site' => '(int|string) The site ID, The site domain'
 	),
 	'response_format' => array(
-		'whitelist' => '(array) An array of formatted whitelists',
+		'whitelist' => '(array) An array of formatted ip addresses',
 	),
 	'example_request_data' => array(
 		'headers' => array(
@@ -593,11 +593,11 @@
 		'$site' => '(int|string) The site ID, The site domain'
 	),
 	'request_format' => array(
-		'whitelist'       => '(string) A list of IP addresses',
+		'whitelist'       => '(array) A list of IP addresses',
 		'global'          => '(bool) Does this apply to this site only, or all connected Jetpack sites',
 	),
 	'response_format' => array(
-		'whitelist' => '(array) An array of formatted whitelists',
+		'whitelist' => '(array) An array of formatted ip addresses',
 	),
 	'example_request_data' => array(
 		'headers' => array(

modules/protect.php

@@ -359,8 +359,10 @@ public function check_use_math() {
 	public function configuration_load() {
 
 		if ( isset( $_POST['action'] ) && $_POST['action'] == 'jetpack_protect_save_whitelist' && wp_verify_nonce( $_POST['_wpnonce'], 'jetpack-protect' ) ) {
-			$this->whitelist_saved = jetpack_protect_save_whitelist( $_POST['whitelist'], $global = false );
-			$this->whitelist_error = ! $this->whitelist_saved;
+			$whitelist              = str_replace( ' ', '', $_POST['whitelist'] );
+			$whitelist              = explode( PHP_EOL, $whitelist);
+			$this->whitelist_saved  = jetpack_protect_save_whitelist( $whitelist, $global = false );
+			$this->whitelist_error  = ! $this->whitelist_saved;
 		}
 
 		// TODO: REMOVE THIS, IT'S FOR BETA TESTING ONLY

modules/protect/config-ui.php

@@ -43,12 +43,10 @@
 
 	<?php
 	global $current_user;
-	$editable_whitelist = jetpack_protect_format_whitelist( $this->whitelist );
-	$current_user_global_whitelist = wp_list_filter( $this->whitelist, array( 'user_id' => $current_user->ID, 'global'=> true) );
-	$other_user_whtielist = wp_list_filter( $this->whitelist, array( 'user_id' => $current_user->ID ), 'NOT' );
+	$whitelist = jetpack_protect_format_whitelist( $this->whitelist );
 	?>
 
-		<?php if ( ! empty( $current_user_global_whitelist ) || ! empty( $other_user_whtielist ) ) : // maybe show user's non-editable whitelists ?>
+		<?php if ( ! empty( $whitelist['global'] ) || ! empty( $whitelist['other_user'] ) ) : // maybe show user's non-editable whitelists ?>
 
 			<table id="non-editable-whitelist" class="whitelist-table" cellpadding="0" cellspacing="0">
 				<tr>
@@ -63,40 +61,32 @@
 					</td>
 				</tr>
 				<tbody>
-				<?php if ( ! empty( $current_user_global_whitelist ) ) : // show global whitelist ( only editable via wordpress.com ) ?>
+				<?php if ( ! empty( $whitelist['global'] ) ) : // show global whitelist ( only editable via wordpress.com ) ?>
 					<tr>
 						<th class="heading">
 							<?php _e( 'IP addresses on your global whitelist', 'jetpack'); ?>
 						</th>
 					</tr>
 
-					<?php foreach( $current_user_global_whitelist as $item ) : ?>
+					<?php foreach( $whitelist['global'] as $item ) : ?>
 						<tr>
 							<td>
-								<?php if( $item->range ) : ?>
-									<?php echo $item->range_low; ?> &ndash; <?php echo $item->range_high; ?>
-								<?php else: ?>
-									<?php echo $item->ip_address; ?>
-								<?php endif; ?>
+								<?php echo $item; ?>
 							</td>
 						</tr>
 					<?php endforeach; ?>
 				<?php endif; // end global whitelist ?>
 
-				<?php if( ! empty( $other_user_whtielist ) ) : ?>
+				<?php if( ! empty( $whitelist['other_user'] ) ) : ?>
 					<tr>
 						<th class="heading">
 							<?php _e( 'IP addresses added by other users', 'jetpack' ); ?>
 						</th>
 					</tr>
-					<?php foreach( $other_user_whtielist as $item ) : ?>
+					<?php foreach( $whitelist['other_user'] as $item ) : ?>
 						<tr>
 							<td>
-								<?php if( $item->range ) : ?>
-									<?php echo $item->range_low; ?> &ndash; <?php echo $item->range_high; ?>
-								<?php else: ?>
-									<?php echo $item->ip_address; ?>
-								<?php endif; ?>
+								<?php echo $item; ?>
 							</td>
 						</tr>
 					<?php endforeach; ?>
@@ -123,7 +113,7 @@
 			</p>
 			<?php wp_nonce_field( 'jetpack-protect' ); ?>
 			<input type='hidden' name='action' value='jetpack_protect_save_whitelist' />
-			<textarea name="whitelist"><?php esc_attr_e($editable_whitelist['local'], 'jetpack'); ?></textarea>
+			<textarea name="whitelist"><?php echo implode( PHP_EOL, $whitelist['local'] ); ?></textarea>
 			<p>
 				<em><?php _e('IPv4 and IPv6 are acceptable. <br />To specify a range, enter the low value and high value separated by a dash. Example: 12.12.12.1-12.12.12.100', 'jetpack' ); ?></em>
 			</p>

modules/protect/shared-functions.php

@@ -43,10 +43,6 @@ function jetpack_protect_format_whitelist( $whitelist = null ) {
 			}
 		}
 
-		$formatted['local']         = implode( PHP_EOL, $formatted['local'] );
-		$formatted['global']        = implode( PHP_EOL, $formatted['global'] );
-		$formatted['other_user']    = implode( PHP_EOL, $formatted['other_user'] );
-
 		return $formatted;
 	}
 }
@@ -55,8 +51,6 @@ function jetpack_protect_format_whitelist( $whitelist = null ) {
 	function jetpack_protect_save_whitelist( $whitelist, $global ) {
 		global $current_user;
 		$whitelist_error    = false;
-		$whitelist          = str_replace( ' ', '', $whitelist );
-		$whitelist          = explode( PHP_EOL, $whitelist);
 		$new_items          = array();
 		$global             = (bool) $global;