Jetpack_Sync_Module_Full_Sync::get_action_totals() - Code Metrics - Inspection of "Add more context to method docs" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/api-site-endpoint-v1-3 ( 55dbfd...927a28 )

by Kirk

created 2019-04-25 18:05 UTC

Jetpack_Sync_Module_Full_Sync::get_action_totals() A

↳ Parent: Jetpack_Sync_Module_Full_Sync

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	3
nop	1
dl	0
loc	11
rs	9.9
c	0
b	0
f	0

<?php

/**
 * This class does a full resync of the database by
 * enqueuing an outbound action for every single object
 * that we care about.
 *
 * This class, and its related class Jetpack_Sync_Module, contain a few non-obvious optimisations that should be explained:
 * - we fire an action called jetpack_full_sync_start so that WPCOM can erase the contents of the cached database
 * - for each object type, we page through the object IDs and enqueue them by firing some monitored actions
 * - we load the full objects for those IDs in chunks of Jetpack_Sync_Module::ARRAY_CHUNK_SIZE (to reduce the number of MySQL calls)
 * - we fire a trigger for the entire array which the Jetpack_Sync_Listener then serializes and queues.
 */

class Jetpack_Sync_Module_Full_Sync extends Jetpack_Sync_Module {
	const STATUS_OPTION_PREFIX = 'jetpack_sync_full_';
	const FULL_SYNC_TIMEOUT    = 3600;

	public function name() {
		return 'full-sync';
	}

	function init_full_sync_listeners( $callable ) {
		// synthetic actions for full sync
		add_action( 'jetpack_full_sync_start', $callable, 10, 2 );
		add_action( 'jetpack_full_sync_end', $callable, 10, 2 );
		add_action( 'jetpack_full_sync_cancelled', $callable );
	}

	function init_before_send() {
		// this is triggered after actions have been processed on the server
		add_action( 'jetpack_sync_processed_actions', array( $this, 'update_sent_progress_action' ) );
	}

	function start( $module_configs = null ) {
		$was_already_running = $this->is_started() && ! $this->is_finished();

		// remove all evidence of previous full sync items and status
		$this->reset_data();

		if ( $was_already_running ) {
			/**
			 * Fires when a full sync is cancelled.
			 *
			 * @since 4.2.0
			 */
			do_action( 'jetpack_full_sync_cancelled' );
		}

		$this->update_status_option( 'started', time() );
		$this->update_status_option( 'params', $module_configs );

		$enqueue_status   = array();
		$full_sync_config = array();

		// default value is full sync
		if ( ! is_array( $module_configs ) ) {
			$module_configs = array();
			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
				$module_configs[ $module->name() ] = true;
			}
		}

		// set default configuration, calculate totals, and save configuration if totals > 0
		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module_name   = $module->name();
			$module_config = isset( $module_configs[ $module_name ] ) ? $module_configs[ $module_name ] : false;

			if ( ! $module_config ) {
				continue;
			}

			if ( 'users' === $module_name && 'initial' === $module_config ) {
				$module_config = $module->get_initial_sync_user_config();
			}

			$enqueue_status[ $module_name ] = false;

			$total_items = $module->estimate_full_sync_actions( $module_config );

			// if there's information to process, configure this module
			if ( ! is_null( $total_items ) && $total_items > 0 ) {
				$full_sync_config[ $module_name ] = $module_config;
				$enqueue_status[ $module_name ]   = array(
					$total_items,   // total
					0,              // queued
					false,          // current state
				);
			}
		}

		$this->set_config( $full_sync_config );
		$this->set_enqueue_status( $enqueue_status );

		$range = $this->get_content_range( $full_sync_config );
		/**
		 * Fires when a full sync begins. This action is serialized
		 * and sent to the server so that it knows a full sync is coming.
		 *
		 * @since 4.2.0
		 * @since 7.3.0 Added $range arg.
		 *
		 * @param $full_sync_config - array
		 * @param $range array
		 */
		do_action( 'jetpack_full_sync_start', $full_sync_config, $range );

		$this->continue_enqueuing( $full_sync_config, $enqueue_status );

		return true;
	}

	function continue_enqueuing( $configs = null, $enqueue_status = null ) {
		if ( ! $this->is_started() || $this->get_status_option( 'queue_finished' ) ) {
			return;
		}

		// if full sync queue is full, don't enqueue more items
		$max_queue_size_full_sync = Jetpack_Sync_Settings::get_setting( 'max_queue_size_full_sync' );
		$full_sync_queue          = new Jetpack_Sync_Queue( 'full_sync' );

		$available_queue_slots = $max_queue_size_full_sync - $full_sync_queue->size();

		if ( $available_queue_slots <= 0 ) {
			return;
		} else {
			$remaining_items_to_enqueue = min( Jetpack_Sync_Settings::get_setting( 'max_enqueue_full_sync' ), $available_queue_slots );
		}

		if ( ! $configs ) {
			$configs = $this->get_config();
		}

		if ( ! $enqueue_status ) {
			$enqueue_status = $this->get_enqueue_status();
		}

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module_name = $module->name();

			// skip module if not configured for this sync or module is done
			if ( ! isset( $configs[ $module_name ] )
				|| // no module config
					! $configs[ $module_name ]
				|| // no enqueue status
					! $enqueue_status[ $module_name ]
				|| // finished enqueuing this module
					true === $enqueue_status[ $module_name ][2] ) {
				continue;
			}

			list( $items_enqueued, $next_enqueue_state ) = $module->enqueue_full_sync_actions( $configs[ $module_name ], $remaining_items_to_enqueue, $enqueue_status[ $module_name ][2] );

			$enqueue_status[ $module_name ][2] = $next_enqueue_state;

			// if items were processed, subtract them from the limit
			if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
				$enqueue_status[ $module_name ][1] += $items_enqueued;
				$remaining_items_to_enqueue        -= $items_enqueued;
			}

			// stop processing if we've reached our limit of items to enqueue
			if ( 0 >= $remaining_items_to_enqueue ) {
				$this->set_enqueue_status( $enqueue_status );
				return;
			}
		}

		$this->set_enqueue_status( $enqueue_status );

		// setting autoload to true means that it's faster to check whether we should continue enqueuing
		$this->update_status_option( 'queue_finished', time(), true );

		$range = $this->get_content_range( $configs );

		/**
		 * Fires when a full sync ends. This action is serialized
		 * and sent to the server.
		 *
		 * @since 4.2.0
		 * @since 7.3.0 Added $range arg.
		 *
		 * @param args ''
		 * @param $range array 
		 */
		do_action( 'jetpack_full_sync_end', '', $range );
	}

	function get_range( $type ) {
		global $wpdb;
		if ( ! in_array( $type, array( 'comments', 'posts' ) ) ) {
			return array();
		}

		switch ( $type ) {
			case 'posts':
				$table     = $wpdb->posts;
				$id        = 'ID';
				$where_sql = Jetpack_Sync_Settings::get_blacklisted_post_types_sql();

				break;
			case 'comments':
				$table     = $wpdb->comments;
				$id        = 'comment_ID';
				$where_sql = Jetpack_Sync_Settings::get_comments_filter_sql();
				break;
		}
		$results = $wpdb->get_results( "SELECT MAX({$id}) as max, MIN({$id}) as min, COUNT({$id}) as count FROM {$table} WHERE {$where_sql}" );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		if ( isset( $results[0] ) ) {
			return $results[0];
		}

		return array();
	}

	private function get_content_range( $config ) {
		$range = array();
		// Only when we are sending the whole range do we want to send also the range
		if ( isset( $config['posts'] ) && $config['posts'] === true ) {
			$range['posts'] = $this->get_range( 'posts' );
		}

		if ( isset( $config['comments'] ) && $config['comments'] === true ) {
			$range['comments'] = $this->get_range( 'comments' );
		}
		return $range;
	}

	function update_sent_progress_action( $actions ) {
		// quick way to map to first items with an array of arrays
		$actions_with_counts = array_count_values( array_filter( array_map( array( $this, 'get_action_name' ), $actions ) ) );

		// Total item counts for each action.
		$actions_with_total_counts = $this->get_actions_totals( $actions );

		if ( ! $this->is_started() || $this->is_finished() ) {
			return;
		}

		if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
			$this->update_status_option( 'send_started', time() );
		}

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module_actions     = $module->get_full_sync_actions();
			$status_option_name = "{$module->name()}_sent";
			$total_option_name  = "{$status_option_name}_total";
			$items_sent         = $this->get_status_option( $status_option_name, 0 );
			$items_sent_total   = $this->get_status_option( $total_option_name, 0 );

			foreach ( $module_actions as $module_action ) {
				if ( isset( $actions_with_counts[ $module_action ] ) ) {
					$items_sent += $actions_with_counts[ $module_action ];
				}

				if ( ! empty( $actions_with_total_counts[ $module_action ] ) ) {
					$items_sent_total += $actions_with_total_counts[ $module_action ];
				}
			}

			if ( $items_sent > 0 ) {
				$this->update_status_option( $status_option_name, $items_sent );
			}

			if ( 0 !== $items_sent_total ) {
				$this->update_status_option( $total_option_name, $items_sent_total );
			}
		}

		if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
			$this->update_status_option( 'finished', time() );
		}
	}

	public function get_action_name( $queue_item ) {
		if ( is_array( $queue_item ) && isset( $queue_item[0] ) ) {
			return $queue_item[0];
		}
		return false;
	}

	/**
	 * Retrieve the total number of items we're syncing in a particular queue item (action).
	 * `$queue_item[1]` is expected to contain chunks of items, and `$queue_item[1][0]`
	 * represents the first (and only) chunk of items to sync in that action.
	 *
	 * @param array $queue_item Item of the sync queue that corresponds to a particular action.
	 * @return int Total number of items in the action.
	 */
	public function get_action_totals( $queue_item ) {
		if ( is_array( $queue_item ) && isset( $queue_item[1][0] ) ) {
			if ( is_array( $queue_item[1][0] ) ) {
				// Let's count the items we sync in this action.
				return count( $queue_item[1][0] );
			}
			// -1 indicates that this action syncs all items by design.
			return -1;
		}
		return 0;
	}

	/**
	 * Retrieve the total number of items for a set of actions, grouped by action name.
	 *
	 * @param array $actions An array of actions.
	 * @return array An array, representing the total number of items, grouped per action.
	 */
	public function get_actions_totals( $actions ) {
		$totals = array();

		foreach ( $actions as $action ) {
			$name          = $this->get_action_name( $action );
			$action_totals = $this->get_action_totals( $action );
			if ( ! isset( $totals[ $name ] ) ) {
				$totals[ $name ] = 0;
			}
			$totals[ $name ] += $action_totals;
		}

		return $totals;
	}

	public function is_started() {
		return ! ! $this->get_status_option( 'started' );
	}

	public function is_finished() {
		return ! ! $this->get_status_option( 'finished' );
	}

	public function get_status() {
		$status = array(
			'started'        => $this->get_status_option( 'started' ),
			'queue_finished' => $this->get_status_option( 'queue_finished' ),
			'send_started'   => $this->get_status_option( 'send_started' ),
			'finished'       => $this->get_status_option( 'finished' ),
			'sent'           => array(),
			'sent_total'     => array(),
			'queue'          => array(),
			'config'         => $this->get_status_option( 'params' ),
			'total'          => array(),
		);

		$enqueue_status = $this->get_enqueue_status();

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$name = $module->name();

			if ( ! isset( $enqueue_status[ $name ] ) ) {
				continue;
			}

			list( $total, $queued, $state ) = $enqueue_status[ $name ];
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

			if ( $total ) {
				$status['total'][ $name ] = $total;
			}

			if ( $queued ) {
				$status['queue'][ $name ] = $queued;
			}

			if ( $sent = $this->get_status_option( "{$name}_sent" ) ) {
				$status['sent'][ $name ] = $sent;
			}

			$sent_total = $this->get_status_option( "{$name}_sent_total" );
			if ( $sent_total ) {
				$status['sent_total'][ $name ] = $sent_total;
			}
		}

		return $status;
	}

	public function clear_status() {
		$prefix = self::STATUS_OPTION_PREFIX;
		Jetpack_Options::delete_raw_option( "{$prefix}_started" );
		Jetpack_Options::delete_raw_option( "{$prefix}_params" );
		Jetpack_Options::delete_raw_option( "{$prefix}_queue_finished" );
		Jetpack_Options::delete_raw_option( "{$prefix}_send_started" );
		Jetpack_Options::delete_raw_option( "{$prefix}_finished" );

		$this->delete_enqueue_status();

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			Jetpack_Options::delete_raw_option( "{$prefix}_{$module->name()}_sent" );
			Jetpack_Options::delete_raw_option( "{$prefix}_{$module->name()}_sent_total" );
		}
	}

	public function reset_data() {
		$this->clear_status();
		$this->delete_config();
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
		$listener = Jetpack_Sync_Listener::get_instance();
		$listener->get_full_sync_queue()->reset();
	}

	private function get_status_option( $name, $default = null ) {
		$value = Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default );

		return is_numeric( $value ) ? intval( $value ) : $value;
	}

	private function update_status_option( $name, $value, $autoload = false ) {
		Jetpack_Options::update_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $value, $autoload );
	}

	private function set_enqueue_status( $new_status ) {
		Jetpack_Options::update_raw_option( 'jetpack_sync_full_enqueue_status', $new_status );
	}

	private function delete_enqueue_status() {
		return Jetpack_Options::delete_raw_option( 'jetpack_sync_full_enqueue_status' );
	}

	private function get_enqueue_status() {
		return Jetpack_Options::get_raw_option( 'jetpack_sync_full_enqueue_status' );
	}

	private function set_config( $config ) {
		Jetpack_Options::update_raw_option( 'jetpack_sync_full_config', $config );
	}

	private function delete_config() {
		return Jetpack_Options::delete_raw_option( 'jetpack_sync_full_config' );
	}

	private function get_config() {
		return Jetpack_Options::get_raw_option( 'jetpack_sync_full_config' );
	}

	private function write_option( $name, $value ) {
		// we write our own option updating code to bypass filters/caching/etc on set_option/get_option
		global $wpdb;
		$serialized_value = maybe_serialize( $value );
		// try updating, if no update then insert
		// TODO: try to deal with the fact that unchanged values can return updated_num = 0
		// below we used "insert ignore" to at least suppress the resulting error
		$updated_num = $wpdb->query(
			$wpdb->prepare(
				"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
				$serialized_value,
				$name
			)
		);

		if ( ! $updated_num ) {
			$updated_num = $wpdb->query(
				$wpdb->prepare(
					"INSERT IGNORE INTO $wpdb->options ( option_name, option_value, autoload ) VALUES ( %s, %s, 'no' )",
					$name,
					$serialized_value
				)
			);
		}
		return $updated_num;
	}

	private function read_option( $name, $default = null ) {
		global $wpdb;
		$value = $wpdb->get_var(
			$wpdb->prepare(
				"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
				$name
			)
		);
		$value = maybe_unserialize( $value );

		if ( $value === null && $default !== null ) {
			return $default;
		}

		return $value;
	}
}


Push — add/api-site-endpoint-v1-3 ( 55dbfd...927a28 )

Jetpack_Sync_Module_Full_Sync::get_action_totals() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		/**
4		* This class does a full resync of the database by
5		* enqueuing an outbound action for every single object
6		* that we care about.
7		*
8		* This class, and its related class Jetpack_Sync_Module, contain a few non-obvious optimisations that should be explained:
9		* - we fire an action called jetpack_full_sync_start so that WPCOM can erase the contents of the cached database
10		* - for each object type, we page through the object IDs and enqueue them by firing some monitored actions
11		* - we load the full objects for those IDs in chunks of Jetpack_Sync_Module::ARRAY_CHUNK_SIZE (to reduce the number of MySQL calls)
12		* - we fire a trigger for the entire array which the Jetpack_Sync_Listener then serializes and queues.
13		*/
14
15		class Jetpack_Sync_Module_Full_Sync extends Jetpack_Sync_Module {
16		const STATUS_OPTION_PREFIX = 'jetpack_sync_full_';
17		const FULL_SYNC_TIMEOUT = 3600;
18
19		public function name() {
20		return 'full-sync';
21		}
22
23		function init_full_sync_listeners( $callable ) {
24		// synthetic actions for full sync
25		add_action( 'jetpack_full_sync_start', $callable, 10, 2 );
26		add_action( 'jetpack_full_sync_end', $callable, 10, 2 );
27		add_action( 'jetpack_full_sync_cancelled', $callable );
28		}
29
30		function init_before_send() {
31		// this is triggered after actions have been processed on the server
32		add_action( 'jetpack_sync_processed_actions', array( $this, 'update_sent_progress_action' ) );
33		}
34
35		function start( $module_configs = null ) {
36		$was_already_running = $this->is_started() && ! $this->is_finished();
37
38		// remove all evidence of previous full sync items and status
39		$this->reset_data();
40
41		if ( $was_already_running ) {
42		/**
43		* Fires when a full sync is cancelled.
44		*
45		* @since 4.2.0
46		*/
47		do_action( 'jetpack_full_sync_cancelled' );
48		}
49
50		$this->update_status_option( 'started', time() );
51		$this->update_status_option( 'params', $module_configs );
52
53		$enqueue_status = array();
54		$full_sync_config = array();
55
56		// default value is full sync
57		if ( ! is_array( $module_configs ) ) {
58		$module_configs = array();
59		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
60		$module_configs[ $module->name() ] = true;
61		}
62		}
63
64		// set default configuration, calculate totals, and save configuration if totals > 0
65		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
66		$module_name = $module->name();
67		$module_config = isset( $module_configs[ $module_name ] ) ? $module_configs[ $module_name ] : false;
68
69		if ( ! $module_config ) {
70		continue;
71		}
72
73		if ( 'users' === $module_name && 'initial' === $module_config ) {
74		$module_config = $module->get_initial_sync_user_config();
75		}
76
77		$enqueue_status[ $module_name ] = false;
78
79		$total_items = $module->estimate_full_sync_actions( $module_config );
80
81		// if there's information to process, configure this module
82		if ( ! is_null( $total_items ) && $total_items > 0 ) {
83		$full_sync_config[ $module_name ] = $module_config;
84		$enqueue_status[ $module_name ] = array(
85		$total_items, // total
86		0, // queued
87		false, // current state
88		);
89		}
90		}
91
92		$this->set_config( $full_sync_config );
93		$this->set_enqueue_status( $enqueue_status );
94
95		$range = $this->get_content_range( $full_sync_config );
96		/**
97		* Fires when a full sync begins. This action is serialized
98		* and sent to the server so that it knows a full sync is coming.
99		*
100		* @since 4.2.0
101		* @since 7.3.0 Added $range arg.
102		*
103		* @param $full_sync_config - array
104		* @param $range array
105		*/
106		do_action( 'jetpack_full_sync_start', $full_sync_config, $range );
107
108		$this->continue_enqueuing( $full_sync_config, $enqueue_status );
109
110		return true;
111		}
112
113		function continue_enqueuing( $configs = null, $enqueue_status = null ) {
114		if ( ! $this->is_started() \|\| $this->get_status_option( 'queue_finished' ) ) {
115		return;
116		}
117
118		// if full sync queue is full, don't enqueue more items
119		$max_queue_size_full_sync = Jetpack_Sync_Settings::get_setting( 'max_queue_size_full_sync' );
120		$full_sync_queue = new Jetpack_Sync_Queue( 'full_sync' );
121
122		$available_queue_slots = $max_queue_size_full_sync - $full_sync_queue->size();
123
124		if ( $available_queue_slots <= 0 ) {
125		return;
126		} else {
127		$remaining_items_to_enqueue = min( Jetpack_Sync_Settings::get_setting( 'max_enqueue_full_sync' ), $available_queue_slots );
128		}
129
130		if ( ! $configs ) {
131		$configs = $this->get_config();
132		}
133
134		if ( ! $enqueue_status ) {
135		$enqueue_status = $this->get_enqueue_status();
136		}
137
138		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
139		$module_name = $module->name();
140
141		// skip module if not configured for this sync or module is done
142		if ( ! isset( $configs[ $module_name ] )
143		\|\| // no module config
144		! $configs[ $module_name ]
145		\|\| // no enqueue status
146		! $enqueue_status[ $module_name ]
147		\|\| // finished enqueuing this module
148		true === $enqueue_status[ $module_name ][2] ) {
149		continue;
150		}
151
152		list( $items_enqueued, $next_enqueue_state ) = $module->enqueue_full_sync_actions( $configs[ $module_name ], $remaining_items_to_enqueue, $enqueue_status[ $module_name ][2] );
153
154		$enqueue_status[ $module_name ][2] = $next_enqueue_state;
155
156		// if items were processed, subtract them from the limit
157		if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
158		$enqueue_status[ $module_name ][1] += $items_enqueued;
159		$remaining_items_to_enqueue -= $items_enqueued;
160		}
161
162		// stop processing if we've reached our limit of items to enqueue
163		if ( 0 >= $remaining_items_to_enqueue ) {
164		$this->set_enqueue_status( $enqueue_status );
165		return;
166		}
167		}
168
169		$this->set_enqueue_status( $enqueue_status );
170
171		// setting autoload to true means that it's faster to check whether we should continue enqueuing
172		$this->update_status_option( 'queue_finished', time(), true );
173
174		$range = $this->get_content_range( $configs );
175
176		/**
177		* Fires when a full sync ends. This action is serialized
178		* and sent to the server.
179		*
180		* @since 4.2.0
181		* @since 7.3.0 Added $range arg.
182		*
183		* @param args ''
184		* @param $range array
185		*/
186		do_action( 'jetpack_full_sync_end', '', $range );
187		}
188
189		function get_range( $type ) {
190		global $wpdb;
191		if ( ! in_array( $type, array( 'comments', 'posts' ) ) ) {
192		return array();
193		}
194
195		switch ( $type ) {
196		case 'posts':
197		$table = $wpdb->posts;
198		$id = 'ID';
199		$where_sql = Jetpack_Sync_Settings::get_blacklisted_post_types_sql();
200
201		break;
202		case 'comments':
203		$table = $wpdb->comments;
204		$id = 'comment_ID';
205		$where_sql = Jetpack_Sync_Settings::get_comments_filter_sql();
206		break;
207		}
208		$results = $wpdb->get_results( "SELECT MAX({$id}) as max, MIN({$id}) as min, COUNT({$id}) as count FROM {$table} WHERE {$where_sql}" );
		0 ignored issues – show Bug introduced 2019-04-04 23:48 UTC by Report Bug Copy Issue Report The variable `$id` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Bug introduced 2019-04-04 23:48 UTC by Report Bug Copy Issue Report The variable `$table` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Bug introduced 2019-04-04 23:48 UTC by Report Bug Copy Issue Report The variable `$where_sql` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
209		if ( isset( $results[0] ) ) {
210		return $results[0];
211		}
212
213		return array();
214		}
215
216		private function get_content_range( $config ) {
217		$range = array();
218		// Only when we are sending the whole range do we want to send also the range
219	View Code Duplication	if ( isset( $config['posts'] ) && $config['posts'] === true ) {
220		$range['posts'] = $this->get_range( 'posts' );
221		}
222
223	View Code Duplication	if ( isset( $config['comments'] ) && $config['comments'] === true ) {
224		$range['comments'] = $this->get_range( 'comments' );
225		}
226		return $range;
227		}
228
229		function update_sent_progress_action( $actions ) {
230		// quick way to map to first items with an array of arrays
231		$actions_with_counts = array_count_values( array_filter( array_map( array( $this, 'get_action_name' ), $actions ) ) );
232
233		// Total item counts for each action.
234		$actions_with_total_counts = $this->get_actions_totals( $actions );
235
236		if ( ! $this->is_started() \|\| $this->is_finished() ) {
237		return;
238		}
239
240		if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
241		$this->update_status_option( 'send_started', time() );
242		}
243
244		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
245		$module_actions = $module->get_full_sync_actions();
246		$status_option_name = "{$module->name()}_sent";
247		$total_option_name = "{$status_option_name}_total";
248		$items_sent = $this->get_status_option( $status_option_name, 0 );
249		$items_sent_total = $this->get_status_option( $total_option_name, 0 );
250
251		foreach ( $module_actions as $module_action ) {
252		if ( isset( $actions_with_counts[ $module_action ] ) ) {
253		$items_sent += $actions_with_counts[ $module_action ];
254		}
255
256		if ( ! empty( $actions_with_total_counts[ $module_action ] ) ) {
257		$items_sent_total += $actions_with_total_counts[ $module_action ];
258		}
259		}
260
261		if ( $items_sent > 0 ) {
262		$this->update_status_option( $status_option_name, $items_sent );
263		}
264
265		if ( 0 !== $items_sent_total ) {
266		$this->update_status_option( $total_option_name, $items_sent_total );
267		}
268		}
269
270		if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
271		$this->update_status_option( 'finished', time() );
272		}
273		}
274
275		public function get_action_name( $queue_item ) {
276		if ( is_array( $queue_item ) && isset( $queue_item[0] ) ) {
277		return $queue_item[0];
278		}
279		return false;
280		}
281
282		/**
283		* Retrieve the total number of items we're syncing in a particular queue item (action).
284		* `$queue_item[1]` is expected to contain chunks of items, and `$queue_item[1][0]`
285		* represents the first (and only) chunk of items to sync in that action.
286		*
287		* @param array $queue_item Item of the sync queue that corresponds to a particular action.
288		* @return int Total number of items in the action.
289		*/
290		public function get_action_totals( $queue_item ) {
291		if ( is_array( $queue_item ) && isset( $queue_item[1][0] ) ) {
292		if ( is_array( $queue_item[1][0] ) ) {
293		// Let's count the items we sync in this action.
294		return count( $queue_item[1][0] );
295		}
296		// -1 indicates that this action syncs all items by design.
297		return -1;
298		}
299		return 0;
300		}
301
302		/**
303		* Retrieve the total number of items for a set of actions, grouped by action name.
304		*
305		* @param array $actions An array of actions.
306		* @return array An array, representing the total number of items, grouped per action.
307		*/
308		public function get_actions_totals( $actions ) {
309		$totals = array();
310
311		foreach ( $actions as $action ) {
312		$name = $this->get_action_name( $action );
313		$action_totals = $this->get_action_totals( $action );
314		if ( ! isset( $totals[ $name ] ) ) {
315		$totals[ $name ] = 0;
316		}
317		$totals[ $name ] += $action_totals;
318		}
319
320		return $totals;
321		}
322
323		public function is_started() {
324		return ! ! $this->get_status_option( 'started' );
325		}
326
327		public function is_finished() {
328		return ! ! $this->get_status_option( 'finished' );
329		}
330
331		public function get_status() {
332		$status = array(
333		'started' => $this->get_status_option( 'started' ),
334		'queue_finished' => $this->get_status_option( 'queue_finished' ),
335		'send_started' => $this->get_status_option( 'send_started' ),
336		'finished' => $this->get_status_option( 'finished' ),
337		'sent' => array(),
338		'sent_total' => array(),
339		'queue' => array(),
340		'config' => $this->get_status_option( 'params' ),
341		'total' => array(),
342		);
343
344		$enqueue_status = $this->get_enqueue_status();
345
346		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
347		$name = $module->name();
348
349		if ( ! isset( $enqueue_status[ $name ] ) ) {
350		continue;
351		}
352
353		list( $total, $queued, $state ) = $enqueue_status[ $name ];
		0 ignored issues – show Unused Code introduced 2016-10-17 23:38 UTC by Report Bug Copy Issue Report The assignment to `$state` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
354
355		if ( $total ) {
356		$status['total'][ $name ] = $total;
357		}
358
359		if ( $queued ) {
360		$status['queue'][ $name ] = $queued;
361		}
362
363		if ( $sent = $this->get_status_option( "{$name}_sent" ) ) {
364		$status['sent'][ $name ] = $sent;
365		}
366
367		$sent_total = $this->get_status_option( "{$name}_sent_total" );
368		if ( $sent_total ) {
369		$status['sent_total'][ $name ] = $sent_total;
370		}
371		}
372
373		return $status;
374		}
375
376		public function clear_status() {
377		$prefix = self::STATUS_OPTION_PREFIX;
378		Jetpack_Options::delete_raw_option( "{$prefix}_started" );
379		Jetpack_Options::delete_raw_option( "{$prefix}_params" );
380		Jetpack_Options::delete_raw_option( "{$prefix}_queue_finished" );
381		Jetpack_Options::delete_raw_option( "{$prefix}_send_started" );
382		Jetpack_Options::delete_raw_option( "{$prefix}_finished" );
383
384		$this->delete_enqueue_status();
385
386		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
387		Jetpack_Options::delete_raw_option( "{$prefix}_{$module->name()}_sent" );
388		Jetpack_Options::delete_raw_option( "{$prefix}_{$module->name()}_sent_total" );
389		}
390		}
391
392		public function reset_data() {
393		$this->clear_status();
394		$this->delete_config();
395		require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
396		$listener = Jetpack_Sync_Listener::get_instance();
397		$listener->get_full_sync_queue()->reset();
398		}
399
400		private function get_status_option( $name, $default = null ) {
401		$value = Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default );
402
403		return is_numeric( $value ) ? intval( $value ) : $value;
404		}
405
406		private function update_status_option( $name, $value, $autoload = false ) {
407		Jetpack_Options::update_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $value, $autoload );
408		}
409
410		private function set_enqueue_status( $new_status ) {
411		Jetpack_Options::update_raw_option( 'jetpack_sync_full_enqueue_status', $new_status );
412		}
413
414		private function delete_enqueue_status() {
415		return Jetpack_Options::delete_raw_option( 'jetpack_sync_full_enqueue_status' );
416		}
417
418		private function get_enqueue_status() {
419		return Jetpack_Options::get_raw_option( 'jetpack_sync_full_enqueue_status' );
420		}
421
422		private function set_config( $config ) {
423		Jetpack_Options::update_raw_option( 'jetpack_sync_full_config', $config );
424		}
425
426		private function delete_config() {
427		return Jetpack_Options::delete_raw_option( 'jetpack_sync_full_config' );
428		}
429
430		private function get_config() {
431		return Jetpack_Options::get_raw_option( 'jetpack_sync_full_config' );
432		}
433
434		private function write_option( $name, $value ) {
435		// we write our own option updating code to bypass filters/caching/etc on set_option/get_option
436		global $wpdb;
437		$serialized_value = maybe_serialize( $value );
438		// try updating, if no update then insert
439		// TODO: try to deal with the fact that unchanged values can return updated_num = 0
440		// below we used "insert ignore" to at least suppress the resulting error
441		$updated_num = $wpdb->query(
442		$wpdb->prepare(
443		"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
444		$serialized_value,
445		$name
446		)
447		);
448
449		if ( ! $updated_num ) {
450		$updated_num = $wpdb->query(
451		$wpdb->prepare(
452		"INSERT IGNORE INTO $wpdb->options ( option_name, option_value, autoload ) VALUES ( %s, %s, 'no' )",
453		$name,
454		$serialized_value
455		)
456		);
457		}
458		return $updated_num;
459		}
460
461		private function read_option( $name, $default = null ) {
462		global $wpdb;
463		$value = $wpdb->get_var(
464		$wpdb->prepare(
465		"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
466		$name
467		)
468		);
469		$value = maybe_unserialize( $value );
470
471		if ( $value === null && $default !== null ) {
472		return $default;
473		}
474
475		return $value;
476		}
477		}
478

Automattic / jetpack

Push — add/api-site-endpoint-v1-3 ( 55dbfd...927a28 )

Jetpack_Sync_Module_Full_Sync::get_action_totals() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like