Completed
Push — core/custom-css-4.7 ( 7f4836...adaf63 )
by
unknown
09:28
created

Jetpack_Sync_Module   A

Complexity

Total Complexity 30

Size/Duplication

Total Lines 151
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 0
Metric Value
dl 0
loc 151
rs 10
c 0
b 0
f 0
wmc 30
lcom 0
cbo 2

18 Methods

Rating   Name   Duplication   Size   Complexity  
name() 0 1 ?
A init_listeners() 0 2 1
A init_full_sync_listeners() 0 2 1
A init_before_send() 0 2 1
A set_defaults() 0 2 1
A reset_data() 0 2 1
A estimate_full_sync_actions() 0 4 1
A get_full_sync_actions() 0 3 1
A count_actions() 0 3 1
A get_check_sum() 0 3 1
A still_valid_checksum() 0 7 3
A get_object_by_id() 0 3 1
A enqueue_full_sync_actions() 0 4 1
B enqueue_all_ids_as_action() 0 38 5
B get_metadata() 0 27 4
A get_term_relationships() 0 5 1
A unserialize_meta() 0 4 1
B get_objects_by_id() 0 17 5
1
<?php
2
3
/**
4
 * Basic methods implemented by Jetpack Sync extensions
5
 */
6
abstract class Jetpack_Sync_Module {
7
	const ARRAY_CHUNK_SIZE = 10;
8
9
	abstract public function name();
10
11
	public function get_object_by_id( $object_type, $id ) {
12
		return false;
13
	}
14
15
	// override these to set up listeners and set/reset data/defaults
16
	public function init_listeners( $callable ) {
17
	}
18
19
	public function init_full_sync_listeners( $callable ) {
20
	}
21
22
	public function init_before_send() {
23
	}
24
25
	public function set_defaults() {
26
	}
27
28
	public function reset_data() {
29
	}
30
31
	public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
32
		// in subclasses, return the number of actions enqueued, and next module state (true == done)
33
		return array( 0, true );
34
	}
35
36
	public function estimate_full_sync_actions( $config ) {
37
		// in subclasses, return the number of items yet to be enqueued
38
		return 0;
39
	}
40
41
	public function get_full_sync_actions() {
42
		return array();
43
	}
44
45
	protected function count_actions( $action_names, $actions_to_count ) {
46
		return count( array_intersect( $action_names, $actions_to_count ) );
47
	}
48
49
	protected function get_check_sum( $values ) {
50
		return crc32( json_encode( $values ) );
51
	}
52
53
	protected function still_valid_checksum( $sums_to_check, $name, $new_sum ) {
54
		if ( isset( $sums_to_check[ $name ] ) && $sums_to_check[ $name ] === $new_sum ) {
55
			return true;
56
		}
57
58
		return false;
59
	}
60
61
	protected function enqueue_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $max_items_to_enqueue, $state ) {
62
		global $wpdb;
63
64
		if ( ! $where_sql ) {
65
			$where_sql = '1 = 1';
66
		}
67
68
		$items_per_page   = 1000;
69
		$page             = 1;
70
		$chunk_count      = 0;
71
		$previous_max_id  = $state ? $state : '~0';
72
		$listener         = Jetpack_Sync_Listener::get_instance();
73
74
		// count down from max_id to min_id so we get newest posts/comments/etc first
75
		while ( $ids = $wpdb->get_col( "SELECT {$id_field} FROM {$table_name} WHERE {$where_sql} AND {$id_field} < {$previous_max_id} ORDER BY {$id_field} DESC LIMIT {$items_per_page}" ) ) {
76
			// Request posts in groups of N for efficiency
77
			$chunked_ids = array_chunk( $ids, self::ARRAY_CHUNK_SIZE );
78
79
			// if we hit our row limit, process and return
80
			if ( $chunk_count + count( $chunked_ids ) >= $max_items_to_enqueue ) {
81
				$remaining_items_count = $max_items_to_enqueue - $chunk_count;
82
				$remaining_items = array_slice( $chunked_ids, 0, $remaining_items_count );
83
84
				$listener->bulk_enqueue_full_sync_actions( $action_name, $remaining_items );
85
86
				$last_chunk = end( $remaining_items );
87
				return array( $remaining_items_count + $chunk_count, end( $last_chunk ) );
88
			}
89
90
			$listener->bulk_enqueue_full_sync_actions( $action_name, $chunked_ids );
91
92
			$chunk_count += count( $chunked_ids );
93
			$page += 1;
94
			$previous_max_id = end( $ids );
95
		}
96
97
		return array( $chunk_count, true );
98
	}
99
100
	protected function get_metadata( $ids, $meta_type ) {
101
		global $wpdb;
102
		$table = _get_meta_table( $meta_type );
103
		$id    = $meta_type . '_id';
104
		if ( ! $table ) {
105
			return array();
106
		}
107
		$private_meta_whitelist_sql = '';
108
		$meta_module = Jetpack_Sync_Modules::get_module( "meta" );
109
		
110
		switch( $meta_type ) {
111
			case 'post':
112
				$private_meta_whitelist_sql = "'" . implode( "','", array_map( 'esc_sql', $meta_module->get_post_meta_whitelist() ) ) . "'";
113
				break;
114
			case 'comment':
115
				$private_meta_whitelist_sql = "'" . implode( "','", array_map( 'esc_sql', $meta_module->get_comment_meta_whitelist() ) ) . "'";
116
				break;
117
		}
118
119
		return array_map( 
120
			array( $this, 'unserialize_meta' ), 
121
			$wpdb->get_results( 
122
				"SELECT $id, meta_key, meta_value, meta_id FROM $table WHERE $id IN ( " . implode( ',', wp_parse_id_list( $ids ) ) . ' )'.
123
				" AND meta_key IN ( $private_meta_whitelist_sql ) "
124
				, OBJECT )
125
		);
126
	}
127
128
	protected function get_term_relationships( $ids ) {
129
		global $wpdb;
130
131
		return $wpdb->get_results( "SELECT object_id, term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id IN ( " . implode( ',', wp_parse_id_list( $ids ) ) . ' )', OBJECT );
132
	}
133
134
	public function unserialize_meta( $meta ) {
135
		$meta->meta_value = maybe_unserialize( $meta->meta_value );
136
		return $meta;
137
	}
138
139
	public function get_objects_by_id( $object_type, $ids ) {
140
		if ( empty( $ids ) || empty( $object_type ) ) {
141
			return array();
142
		}
143
144
		$objects = array();
145
		foreach( (array) $ids as $id ) {
146
			$object = $this->get_object_by_id( $object_type, $id );
147
148
			// Only add object if we have the object.
149
			if ( $object ) {
150
				$objects[ $id ] = $object;
151
			}
152
		}
153
154
		return $objects;
155
	}
156
}
157