Completed
Push — fix/slideshow-dependencies ( a328c8...25d99e )
by
unknown
12:50 queued 06:11
created

Publicize_Base::get_publicize_conns_test_results()   C

Complexity

Conditions 11
Paths 74

Size

Total Lines 66

Duplication

Lines 4
Ratio 6.06 %

Importance

Changes 0
Metric Value
cc 11
nc 74
nop 0
dl 4
loc 66
rs 6.5951
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
abstract class Publicize_Base {
4
5
	/**
6
	* Services that are currently connected to the given user
7
	* through publicize.
8
	*/
9
	public $connected_services = array();
10
11
	/**
12
	* Services that are supported by publicize. They don't
13
	* necessarily need to be connected to the current user.
14
	*/
15
	public $services;
16
17
	/**
18
	* key names for post meta
19
	*/
20
	public $ADMIN_PAGE        = 'wpas';
21
	public $POST_MESS         = '_wpas_mess';
22
	public $POST_SKIP         = '_wpas_skip_'; // connection id appended to indicate that a connection should NOT be publicized to
23
	public $POST_DONE         = '_wpas_done_'; // connection id appended to indicate a connection has already been publicized to
24
	public $USER_AUTH         = 'wpas_authorize';
25
	public $USER_OPT          = 'wpas_';
26
	public $PENDING           = '_publicize_pending'; // ready for Publicize to do its thing
27
	public $POST_SERVICE_DONE = '_publicize_done_external'; // array of external ids where we've Publicized
28
29
	/**
30
	* default pieces of the message used in constructing the
31
	* content pushed out to other social networks
32
	*/
33
34
	public $default_prefix  = '';
35
	public $default_message = '%title%';
36
	public $default_suffix  = ' ';
37
38
	/**
39
	 * What WP capability is require to create/delete global connections?
40
	 * All users with this cap can un-globalize all other global connections, and globalize any of their own
41
	 * Globalized connections cannot be unselected by users without this capability when publishing
42
	 */
43
	public $GLOBAL_CAP = 'publish_posts';
44
45
	/**
46
	* Sets up the basics of Publicize
47
	*/
48
	function __construct() {
49
		$this->default_message = self::build_sprintf( array(
50
			/**
51
			 * Filter the default Publicize message.
52
			 *
53
			 * @module publicize
54
			 *
55
			 * @since 2.0.0
56
			 *
57
			 * @param string $this->default_message Publicize's default message. Default is the post title.
58
			 */
59
			apply_filters( 'wpas_default_message', $this->default_message ),
60
			'title',
61
			'url',
62
		) );
63
64
		$this->default_prefix = self::build_sprintf( array(
65
			/**
66
			 * Filter the message prepended to the Publicize custom message.
67
			 *
68
			 * @module publicize
69
			 *
70
			 * @since 2.0.0
71
			 *
72
			 * @param string $this->default_prefix String prepended to the Publicize custom message.
73
			 */
74
			apply_filters( 'wpas_default_prefix', $this->default_prefix ),
75
			'url',
76
		) );
77
78
		$this->default_suffix = self::build_sprintf( array(
79
			/**
80
			 * Filter the message appended to the Publicize custom message.
81
			 *
82
			 * @module publicize
83
			 *
84
			 * @since 2.0.0
85
			 *
86
			 * @param string $this->default_suffix String appended to the Publicize custom message.
87
			 */
88
			apply_filters( 'wpas_default_suffix', $this->default_suffix ),
89
			'url',
90
		) );
91
92
		/**
93
		 * Filter the capability to change global Publicize connection options.
94
		 *
95
		 * All users with this cap can un-globalize all other global connections, and globalize any of their own
96
		 * Globalized connections cannot be unselected by users without this capability when publishing.
97
		 *
98
		 * @module publicize
99
		 *
100
		 * @since 2.2.1
101
		 *
102
		 * @param string $this->GLOBAL_CAP default capability in control of global Publicize connection options. Default to edit_others_posts.
103
		 */
104
		$this->GLOBAL_CAP = apply_filters( 'jetpack_publicize_global_connections_cap', $this->GLOBAL_CAP );
105
106
		// stage 1 and 2 of 3-stage Publicize. Flag for Publicize on creation, save meta,
107
		// then check meta and publicize based on that. stage 3 implemented on wpcom
108
		add_action( 'transition_post_status', array( $this, 'flag_post_for_publicize' ), 10, 3 );
109
		add_action( 'save_post', array( &$this, 'save_meta' ), 20, 2 );
110
111
		// Default checkbox state for each Connection
112
		add_filter( 'publicize_checkbox_default', array( $this, 'publicize_checkbox_default' ), 10, 4 );
113
114
		// Alter the "Post Publish" admin notice to mention the Connections we Publicized to.
115
		add_filter( 'post_updated_messages', array( $this, 'update_published_message' ), 20, 1 );
116
117
		// Connection test callback
118
		add_action( 'wp_ajax_test_publicize_conns', array( $this, 'test_publicize_conns' ) );
119
120
		add_action( 'init', array( $this, 'add_post_type_support' ) );
121
		add_action( 'init', array( $this, 'register_post_meta' ), 20 );
122
		add_action( 'jetpack_register_gutenberg_extensions', array( $this, 'register_gutenberg_extension' ) );
123
	}
124
125
/*
126
 * Services: Facebook, Twitter, etc.
127
 */
128
129
	/**
130
	 * Get services for the given blog and user.
131
	 *
132
	 * Can return all available services or just the ones with an active connection.
133
	 *
134
	 * @param string $filter
135
	 *        'all' (default) - Get all services available for connecting
136
	 *        'connected'     - Get all services currently connected
137
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
138
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
139
	 * @return array
140
	 */
141
	abstract function get_services( $filter = 'all', $_blog_id = false, $_user_id = false );
142
143
	function can_connect_service( $service_name ) {
144
		return 'google_plus' !== $service_name;
145
	}
146
147
	/**
148
	 * Does the given user have a connection to the service on the given blog?
149
	 *
150
	 * @param string $service_name 'facebook', 'twitter', etc.
151
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
152
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
153
	 * @return bool
154
	 */
155
	function is_enabled( $service_name, $_blog_id = false, $_user_id = false ) {
156
		if ( !$_blog_id )
0 ignored issues
show
Bug Best Practice introduced by
The expression $_blog_id of type false|integer is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
157
			$_blog_id = $this->blog_id();
158
159
		if ( !$_user_id )
0 ignored issues
show
Bug Best Practice introduced by
The expression $_user_id of type false|integer is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
160
			$_user_id = $this->user_id();
161
162
		$connections = $this->get_connections( $service_name, $_blog_id, $_user_id );
163
		return ( is_array( $connections ) && count( $connections ) > 0 ? true : false );
164
	}
165
166
	/**
167
	 * Generates a connection URL.
168
	 *
169
	 * This is the URL, which, when visited by the user, starts the authentication
170
	 * process required to forge a connection.
171
	 *
172
	 * @param string $service_name 'facebook', 'twitter', etc.
173
	 * @return string
174
	 */
175
	abstract function connect_url( $service_name );
176
177
	/**
178
	 * Generates a Connection refresh URL.
179
	 *
180
	 * This is the URL, which, when visited by the user, re-authenticates their
181
	 * connection to the service.
182
	 *
183
	 * @param string $service_name 'facebook', 'twitter', etc.
184
	 * @return string
185
	 */
186
	abstract function refresh_url( $service_name );
187
188
	/**
189
	 * Generates a disconnection URL.
190
	 *
191
	 * This is the URL, which, when visited by the user, breaks their connection
192
	 * with the service.
193
	 *
194
	 * @param string $service_name 'facebook', 'twitter', etc.
195
	 * @param string $connection_id Connection ID
196
	 * @return string
197
	 */
198
	abstract function disconnect_url( $service_name, $connection_id );
199
200
	/**
201
	 * Returns a display name for the Service
202
	 *
203
	 * @param string $service_name 'facebook', 'twitter', etc.
204
	 * @return string
205
	 */
206
	public static function get_service_label( $service_name ) {
207
		switch ( $service_name ) {
208
			case 'linkedin':
209
				return 'LinkedIn';
210
				break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
211
			case 'google_plus':
212
				return  'Google+';
213
				break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
214
			case 'twitter':
215
			case 'facebook':
216
			case 'tumblr':
217
			default:
218
				return ucfirst( $service_name );
219
				break;
0 ignored issues
show
Unused Code introduced by
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
220
		}
221
	}
222
223
/*
224
 * Connections: For each Service, there can be multiple connections
225
 * for a given user. For example, one user could be connected to Twitter
226
 * as both @jetpack and as @wordpressdotcom
227
 *
228
 * For historical reasons, Connections are represented as an object
229
 * on WordPress.com and as an array in Jetpack.
230
 */
231
232
	/**
233
	 * Get the active Connections of a Service
234
	 *
235
	 * @param string $service_name 'facebook', 'twitter', etc.
236
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
237
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
238
	 * @return false|object[]|array[] false if no connections exist
239
	 */
240
	abstract function get_connections( $service_name, $_blog_id = false, $_user_id = false );
241
242
	/**
243
	 * Get a single Connection of a Service
244
	 *
245
	 * @param string $service_name 'facebook', 'twitter', etc.
246
	 * @param string $connection_id Connection ID
247
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
248
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
249
	 * @return false|object[]|array[] false if no connections exist
250
	 */
251
	abstract function get_connection( $service_name, $connection_id, $_blog_id = false, $_user_id = false );
252
253
	/**
254
	 * Get the Connection ID.
255
	 *
256
	 * Note that this is different than the Connection's uniqueid.
257
	 *
258
	 * Via a quirk of history, ID is globally unique and unique_id
259
	 * is only unique per site.
260
	 *
261
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
262
	 * @return string
263
	 */
264
	abstract function get_connection_id( $connection );
265
266
	/**
267
	 * Get the Connection unique_id
268
	 *
269
	 * Note that this is different than the Connections ID.
270
	 *
271
	 * Via a quirk of history, ID is globally unique and unique_id
272
	 * is only unique per site.
273
	 *
274
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
275
	 * @return string
276
	 */
277
	abstract function get_connection_unique_id( $connection );
278
279
	/**
280
	 * Get the Connection's Meta data
281
	 *
282
	 * @param object|array Connection
283
	 * @return array Connection Meta
284
	 */
285
	abstract function get_connection_meta( $connection );
286
287
	/**
288
	 * Disconnect a Connection
289
	 *
290
	 * @param string $service_name 'facebook', 'twitter', etc.
291
	 * @param string $connection_id Connection ID
292
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
293
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
294
	 * @param bool $force_delete Whether to skip permissions checks
295
	 * @return false|void False on failure. Void on success.
296
	 */
297
	abstract function disconnect( $service_name, $connection_id, $_blog_id = false, $_user_id = false, $force_delete = false );
298
299
	/**
300
	 * Globalizes a Connection
301
	 *
302
	 * @param string $connection_id Connection ID
303
	 * @return bool Falsey on failure. Truthy on success.
304
	 */
305
	abstract function globalize_connection( $connection_id );
306
307
	/**
308
	 * Unglobalizes a Connection
309
	 *
310
	 * @param string $connection_id Connection ID
311
	 * @return bool Falsey on failure. Truthy on success.
312
	 */
313
	abstract function unglobalize_connection( $connection_id );
314
315
	/**
316
	 * Returns an external URL to the Connection's profile
317
	 *
318
	 * @param string $service_name 'facebook', 'twitter', etc.
319
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
320
	 * @return false|string False on failure. URL on success.
321
	 */
322
	function get_profile_link( $service_name, $connection ) {
323
		$cmeta = $this->get_connection_meta( $connection );
324
325
		if ( isset( $cmeta['connection_data']['meta']['link'] ) ) {
326
			if ( 'facebook' == $service_name && 0 === strpos( parse_url( $cmeta['connection_data']['meta']['link'], PHP_URL_PATH ), '/app_scoped_user_id/' ) ) {
327
				// App-scoped Facebook user IDs are not usable profile links
328
				return false;
329
			}
330
331
			return $cmeta['connection_data']['meta']['link'];
332 View Code Duplication
		} elseif ( 'facebook' == $service_name && isset( $cmeta['connection_data']['meta']['facebook_page'] ) ) {
333
			return 'https://facebook.com/' . $cmeta['connection_data']['meta']['facebook_page'];
334
		} elseif ( 'tumblr' == $service_name && isset( $cmeta['connection_data']['meta']['tumblr_base_hostname'] ) ) {
335
			 return 'http://' . $cmeta['connection_data']['meta']['tumblr_base_hostname'];
336
		} elseif ( 'twitter' == $service_name ) {
337
			return 'https://twitter.com/' . substr( $cmeta['external_display'], 1 ); // Has a leading '@'
338 View Code Duplication
		} elseif ( 'google_plus' == $service_name && isset( $cmeta['connection_data']['meta']['google_plus_page'] ) ) {
339
			return 'https://plus.google.com/' . $cmeta['connection_data']['meta']['google_plus_page'];
340
		} elseif ( 'google_plus' == $service_name ) {
341
			return 'https://plus.google.com/' . $cmeta['external_id'];
342
		} else if ( 'linkedin' == $service_name ) {
343
			if ( !isset( $cmeta['connection_data']['meta']['profile_url'] ) ) {
344
				return false;
345
			}
346
347
			$profile_url_query = parse_url( $cmeta['connection_data']['meta']['profile_url'], PHP_URL_QUERY );
348
			wp_parse_str( $profile_url_query, $profile_url_query_args );
0 ignored issues
show
Bug introduced by
The variable $profile_url_query_args does not exist. Did you mean $profile_url_query?

This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name.

The variable may have been renamed without also renaming all references.

Loading history...
349
			if ( isset( $profile_url_query_args['key'] ) ) {
0 ignored issues
show
Bug introduced by
The variable $profile_url_query_args does not exist. Did you mean $profile_url_query?

This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name.

The variable may have been renamed without also renaming all references.

Loading history...
350
				$id = $profile_url_query_args['key'];
351
			} elseif ( isset( $profile_url_query_args['id'] ) ) {
0 ignored issues
show
Bug introduced by
The variable $profile_url_query_args does not exist. Did you mean $profile_url_query?

This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name.

The variable may have been renamed without also renaming all references.

Loading history...
352
				$id = $profile_url_query_args['id'];
353
			} else {
354
				return false;
355
			}
356
357
			return esc_url_raw( add_query_arg( 'id', urlencode( $id ), 'http://www.linkedin.com/profile/view' ) );
358
		} else {
359
			return false; // no fallback. we just won't link it
360
		}
361
	}
362
363
	/**
364
	 * Returns a display name for the Connection
365
	 *
366
	 * @param string $service_name 'facebook', 'twitter', etc.
367
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
368
	 * @return string
369
	 */
370
	function get_display_name( $service_name, $connection ) {
371
		$cmeta = $this->get_connection_meta( $connection );
372
373
		if ( isset( $cmeta['connection_data']['meta']['display_name'] ) ) {
374
			return $cmeta['connection_data']['meta']['display_name'];
375 View Code Duplication
		} elseif ( $service_name == 'tumblr' && isset( $cmeta['connection_data']['meta']['tumblr_base_hostname'] ) ) {
376
			 return $cmeta['connection_data']['meta']['tumblr_base_hostname'];
377
		} elseif ( $service_name == 'twitter' ) {
378
			return $cmeta['external_display'];
379
		} else {
380
			$connection_display = $cmeta['external_display'];
381
			if ( empty( $connection_display ) )
382
				$connection_display = $cmeta['external_name'];
383
			return $connection_display;
384
		}
385
	}
386
387
	/**
388
	 * Whether the user needs to select additional options after connecting
389
	 *
390
	 * @param string $service_name 'facebook', 'twitter', etc.
391
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
392
	 * @return bool
393
	 */
394
	function show_options_popup( $service_name, $connection ) {
395
		$cmeta = $this->get_connection_meta( $connection );
396
397
		// always show if no selection has been made for facebook
398
		if ( 'facebook' == $service_name && empty( $cmeta['connection_data']['meta']['facebook_profile'] ) && empty( $cmeta['connection_data']['meta']['facebook_page'] ) )
399
			return true;
400
401
		// always show if no selection has been made for tumblr
402
		if ( 'tumblr' == $service_name && empty ( $cmeta['connection_data']['meta']['tumblr_base_hostname'] ) )
403
			return true;
404
405
		// if we have the specific connection info..
406
		if ( isset( $_GET['id'] ) ) {
407
			if ( $cmeta['connection_data']['id'] == $_GET['id'] )
408
				return true;
409
		} else {
410
			// otherwise, just show if this is the completed step / first load
411
			if ( !empty( $_GET['action'] ) && 'completed' == $_GET['action'] && !empty( $_GET['service'] ) && $service_name == $_GET['service'] && ! in_array( $_GET['service'], array( 'facebook', 'tumblr' ) ) )
412
				return true;
413
		}
414
415
		return false;
416
	}
417
418
	/**
419
	 * Whether the Connection is "valid" wrt Facebook's requirements.
420
	 *
421
	 * Must be connected to a Page (not a Profile).
422
	 * (Also returns true if we're in the middle of the connection process)
423
	 *
424
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
425
	 * @return bool
426
	 */
427
	function is_valid_facebook_connection( $connection ) {
428
		if ( $this->is_connecting_connection( $connection ) ) {
429
			return true;
430
		}
431
		$connection_meta = $this->get_connection_meta( $connection );
432
		$connection_data = $connection_meta['connection_data'];
433
		return isset( $connection_data[ 'meta' ][ 'facebook_page' ] );
434
	}
435
436
	/**
437
	 * LinkedIn needs to be reauthenticated to use v2 of their API.
438
	 * If it's using LinkedIn old API, it's an 'invalid' connection
439
	 *
440
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
441
	 * @return bool
442
	 */
443
	function is_invalid_linkedin_connection( $connection ) {
444
		// LinkedIn API v1 included the profile link in the connection data.
445
		$connection_meta = $this->get_connection_meta( $connection );
446
		return isset( $connection_meta['connection_data']['meta']['profile_url'] );
447
	}
448
449
	/**
450
	 * Whether the Connection currently being connected
451
	 *
452
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
453
	 * @return bool
454
	 */
455
	function is_connecting_connection( $connection ) {
456
		$connection_meta = $this->get_connection_meta( $connection );
457
		$connection_data = $connection_meta['connection_data'];
458
		return isset( $connection_data[ 'meta' ]['options_responses'] );
459
	}
460
461
	/**
462
	 * AJAX Handler to run connection tests on all Connections
463
	 * @return void
464
	 */
465
	function test_publicize_conns() {
466
		wp_send_json_success( $this->get_publicize_conns_test_results() );
467
	}
468
469
	/**
470
	 * Run connection tests on all Connections
471
	 *
472
	 * @return array {
473
	 *     Array of connection test results.
474
	 *
475
	 *     @type string 'connectionID'          Connection identifier string that is unique for each connection
476
	 *     @type string 'serviceName'           Slug of the connection's service (facebook, twitter, ...)
477
	 *     @type bool   'connectionTestPassed'  Whether the connection test was successful
478
	 *     @type string 'connectionTestMessage' Test success or error message
479
	 *     @type bool   'userCanRefresh'        Whether the user can re-authenticate their connection to the service
480
	 *     @type string 'refreshText'           Message instructing user to re-authenticate their connection to the service
481
	 *     @type string 'refreshURL'            URL, which, when visited by the user, re-authenticates their connection to the service.
482
	 *     @type string 'unique_id'             ID string representing connection
483
	 * }
484
	 */
485
	function get_publicize_conns_test_results() {
486
		$test_results = array();
487
488
		foreach ( (array) $this->get_services( 'connected' ) as $service_name => $connections ) {
489
			foreach ( $connections as $connection ) {
490
491
				$id = $this->get_connection_id( $connection );
492
493
				$connection_test_passed = true;
494
				$connection_test_message = __( 'This connection is working correctly.' , 'jetpack' );
495
				$user_can_refresh = false;
496
				$refresh_text = '';
497
				$refresh_url = '';
498
499
				$connection_test_result = true;
500
				if ( method_exists( $this, 'test_connection' ) ) {
501
					$connection_test_result = $this->test_connection( $service_name, $connection );
502
				}
503
504
				if ( is_wp_error( $connection_test_result ) ) {
505
					$connection_test_passed = false;
506
					$connection_test_message = $connection_test_result->get_error_message();
507
					$error_data = $connection_test_result->get_error_data();
508
509
					$user_can_refresh = $error_data['user_can_refresh'];
510
					$refresh_text = $error_data['refresh_text'];
511
					$refresh_url = $error_data['refresh_url'];
512
				}
513
				// Mark facebook profiles as deprecated
514
				if ( 'facebook' === $service_name ) {
515
					if ( ! $this->is_valid_facebook_connection( $connection ) ) {
516
						$connection_test_passed = false;
517
						$user_can_refresh = false;
518
						$connection_test_message = __( 'Please select a Facebook Page to publish updates.', 'jetpack' );
519
					}
520
				}
521
522
				// LinkedIn needs reauthentication to be compatible with v2 of their API
523
				if ( 'linkedin' === $service_name && $this->is_invalid_linkedin_connection( $connection ) ) {
524
					$connection_test_passed = 'must_reauth';
525
					$user_can_refresh = false;
526
					$connection_test_message = esc_html__( 'Your LinkedIn connection needs to be reauthenticated to continue working – head to Sharing to take care of it.', 'jetpack' );
527
				}
528
529
				$unique_id = null;
530 View Code Duplication
				if ( ! empty( $connection->unique_id ) ) {
531
					$unique_id = $connection->unique_id;
532
				} else if ( ! empty( $connection['connection_data']['token_id'] ) ) {
533
					$unique_id = $connection['connection_data']['token_id'];
534
				}
535
536
				$test_results[] = array(
537
					'connectionID'          => $id,
538
					'serviceName'           => $service_name,
539
					'connectionTestPassed'  => $connection_test_passed,
540
					'connectionTestMessage' => esc_attr( $connection_test_message ),
541
					'userCanRefresh'        => $user_can_refresh,
542
					'refreshText'           => esc_attr( $refresh_text ),
543
					'refreshURL'            => $refresh_url,
544
					'unique_id'             => $unique_id,
545
				);
546
			}
547
		}
548
549
		return $test_results;
550
	}
551
552
	/**
553
	 * Run the connection test for the Connection
554
	 *
555
	 * @param string $service_name 'facebook', 'twitter', etc.
556
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
557
	 * @return WP_Error|true WP_Error on failure. True on success
558
	 */
559
	abstract function test_connection( $service_name, $connection );
560
561
	/**
562
	 * Retrieves current list of connections and applies filters.
563
	 *
564
	 * Retrieves current available connections and checks if the connections
565
	 * have already been used to share current post. Finally, the checkbox
566
	 * form UI fields are calculated. This function exposes connection form
567
	 * data directly as array so it can be retrieved for static HTML generation
568
	 * or JSON consumption.
569
	 *
570
	 * @since 6.7.0
571
	 *
572
	 * @param integer $selected_post_id Optional. Post ID to query connection status for.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $selected_post_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
573
	 *
574
	 * @return array {
575
	 *     Array of UI setup data for connection list form.
576
	 *
577
	 *     @type string 'unique_id'     ID string representing connection
578
	 *     @type string 'service_name'  Slug of the connection's service (facebook, twitter, ...)
579
	 *     @type string 'service_label' Service Label (Facebook, Twitter, ...)
580
	 *     @type string 'display_name'  Connection's human-readable Username: "@jetpack"
581
	 *     @type bool   'enabled'       Default value for the connection (e.g., for a checkbox).
582
	 *     @type bool   'done'          Has this connection already been publicized to?
583
	 *     @type bool   'toggleable'    Is the user allowed to change the value for the connection?
584
	 *     @type bool   'global'        Is this connection a global one?
585
	 * }
586
	 */
587
	public function get_filtered_connection_data( $selected_post_id = null ) {
588
		$connection_list = array();
589
590
		$post = get_post( $selected_post_id ); // Defaults to current post if $post_id is null.
591
		// Handle case where there is no current post.
592
		if ( ! empty( $post ) ) {
593
			$post_id = $post->ID;
594
		} else {
595
			$post_id = null;
596
		}
597
598
		$services = $this->get_services( 'connected' );
599
		$all_done = $this->post_is_done_sharing( $post_id );
600
601
		// We don't allow Publicizing to the same external id twice, to prevent spam.
602
		$service_id_done = (array) get_post_meta( $post_id, $this->POST_SERVICE_DONE, true );
603
604
		foreach ( $services as $service_name => $connections ) {
605
			foreach ( $connections as $connection ) {
606
				$connection_meta = $this->get_connection_meta( $connection );
607
				$connection_data = $connection_meta['connection_data'];
608
609
				$unique_id = $this->get_connection_unique_id( $connection );
610
611
612
				// Was this connection (OR, old-format service) already Publicized to?
613
				$done = ! empty( $post ) && (
614
					// New flags
615
					1 == get_post_meta( $post->ID, $this->POST_DONE . $unique_id, true )
616
					||
617
					// old flags
618
					1 == get_post_meta( $post->ID, $this->POST_DONE . $service_name, true )
619
				);
620
621
				/**
622
				 * Filter whether a post should be publicized to a given service.
623
				 *
624
				 * @module publicize
625
				 *
626
				 * @since 2.0.0
627
				 *
628
				 * @param bool true Should the post be publicized to a given service? Default to true.
629
				 * @param int $post_id Post ID.
630
				 * @param string $service_name Service name.
631
				 * @param array $connection_data Array of information about all Publicize details for the site.
632
				 */
633
				if ( ! apply_filters( 'wpas_submit_post?', true, $post_id, $service_name, $connection_data ) ) {
634
					continue;
635
				}
636
637
				// Should we be skipping this one?
638
				$skip = (
639
					(
640
						! empty( $post )
641
						&&
642
						in_array( $post->post_status, array( 'publish', 'draft', 'future' ) )
643
						&&
644
						(
645
							// New flags
646
							get_post_meta( $post->ID, $this->POST_SKIP . $unique_id, true )
647
							||
648
							// Old flags
649
							get_post_meta( $post->ID, $this->POST_SKIP . $service_name )
650
						)
651
					)
652
					||
653
					(
654
						is_array( $connection )
655
						&&
656
						isset( $connection_meta['external_id'] ) && ! empty( $service_id_done[ $service_name ][ $connection_meta['external_id'] ] )
657
					)
658
				);
659
660
				// If this one has already been publicized to, don't let it happen again.
661
				$toggleable = ! $done && ! $all_done;
662
663
				// Determine the state of the checkbox (on/off) and allow filtering.
664
				$enabled = $done || ! $skip;
665
				/**
666
				 * Filter the checkbox state of each Publicize connection appearing in the post editor.
667
				 *
668
				 * @module publicize
669
				 *
670
				 * @since 2.0.1
671
				 *
672
				 * @param bool $enabled Should the Publicize checkbox be enabled for a given service.
673
				 * @param int $post_id Post ID.
674
				 * @param string $service_name Service name.
675
				 * @param array $connection Array of connection details.
676
				 */
677
				$enabled = apply_filters( 'publicize_checkbox_default', $enabled, $post_id, $service_name, $connection );
678
679
				/**
680
				 * If this is a global connection and this user doesn't have enough permissions to modify
681
				 * those connections, don't let them change it.
682
				 */
683
				if ( ! $done && ( 0 == $connection_data['user_id'] && ! current_user_can( $this->GLOBAL_CAP ) ) ) {
684
					$toggleable = false;
685
686
					/**
687
					 * Filters the checkboxes for global connections with non-prilvedged users.
688
					 *
689
					 * @module publicize
690
					 *
691
					 * @since 3.7.0
692
					 *
693
					 * @param bool   $enabled Indicates if this connection should be enabled. Default true.
694
					 * @param int    $post_id ID of the current post
695
					 * @param string $service_name Name of the connection (Facebook, Twitter, etc)
696
					 * @param array  $connection Array of data about the connection.
697
					 */
698
					$enabled = apply_filters( 'publicize_checkbox_global_default', $enabled, $post_id, $service_name, $connection );
699
				}
700
701
				// Force the checkbox to be checked if the post was DONE, regardless of what the filter does.
702
				if ( $done ) {
703
					$enabled = true;
704
				}
705
706
				$connection_list[] = array(
707
					'unique_id'     => $unique_id,
708
					'service_name'  => $service_name,
709
					'service_label' => $this->get_service_label( $service_name ),
710
					'display_name'  => $this->get_display_name( $service_name, $connection ),
711
712
					'enabled'      => $enabled,
713
					'done'         => $done,
714
					'toggleable'   => $toggleable,
715
					'global'       => 0 == $connection_data['user_id'],
716
				);
717
			}
718
		}
719
720
		return $connection_list;
721
	}
722
723
	/**
724
	 * Checks if post has already been shared by Publicize in the past.
725
	 *
726
	 * @since 6.7.0
727
	 *
728
	 * @param integer $post_id Optional. Post ID to query connection status for: will use current post if missing.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $post_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
729
	 *
730
	 * @return bool True if post has already been shared by Publicize, false otherwise.
731
	 */
732
	abstract public function post_is_done_sharing( $post_id = null );
733
734
	/**
735
	 * Retrieves full list of available Publicize connection services.
736
	 *
737
	 * Retrieves current available publicize service connections
738
	 * with associated labels and URLs.
739
	 *
740
	 * @since 6.7.0
741
	 *
742
	 * @return array {
743
	 *     Array of UI service connection data for all services
744
	 *
745
	 *     @type string 'name'  Name of service.
746
	 *     @type string 'label' Display label for service.
747
	 *     @type string 'url'   URL for adding connection to service.
748
	 * }
749
	 */
750
	function get_available_service_data() {
751
		$available_services     = $this->get_services( 'all' );
752
		$available_service_data = array();
753
754
		foreach ( $available_services as $service_name => $service ) {
755
			$available_service_data[] = array(
756
				'name'  => $service_name,
757
				'label' => $this->get_service_label( $service_name ),
758
				'url'   => $this->connect_url( $service_name ),
759
			);
760
		}
761
762
		return $available_service_data;
763
	}
764
765
/*
766
 * Site Data
767
 */
768
769
	function user_id() {
770
		return get_current_user_id();
771
	}
772
773
	function blog_id() {
774
		return get_current_blog_id();
775
	}
776
777
/*
778
 * Posts
779
 */
780
781
	/**
782
	 * Checks old and new status to see if the post should be flagged as
783
	 * ready to Publicize.
784
	 *
785
	 * Attached to the `transition_post_status` filter.
786
	 *
787
	 * @param string $new_status
788
	 * @param string $old_status
789
	 * @param WP_Post $post
790
	 * @return void
791
	 */
792
	abstract function flag_post_for_publicize( $new_status, $old_status, $post );
793
794
	/**
795
	 * Ensures the Post internal post-type supports `publicize`
796
	 *
797
	 * This feature support flag is used by the REST API.
798
	 */
799
	function add_post_type_support() {
800
		add_post_type_support( 'post', 'publicize' );
801
	}
802
803
	/**
804
	 * Register the Publicize Gutenberg extension
805
	 */
806
	function register_gutenberg_extension() {
807
		// TODO: The `gutenberg/available-extensions` endpoint currently doesn't accept a post ID,
808
		// so we cannot pass one to `$this->current_user_can_access_publicize_data()`.
809
810
		if ( $this->current_user_can_access_publicize_data() ) {
811
			Jetpack_Gutenberg::set_extension_available( 'jetpack/publicize' );
812
		} else {
813
			Jetpack_Gutenberg::set_extension_unavailable( 'jetpack/publicize', 'unauthorized' );
814
815
		}
816
	}
817
818
	/**
819
	 * Can the current user access Publicize Data.
820
	 *
821
	 * @param int $post_id. 0 for general access. Post_ID for specific access.
0 ignored issues
show
Documentation introduced by
There is no parameter named $post_id.. Did you maybe mean $post_id?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

Consider the following example. The parameter $ireland is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was changed, but the annotation was not.

Loading history...
822
	 * @return bool
823
	 */
824
	function current_user_can_access_publicize_data( $post_id = 0 ) {
825
		/**
826
		 * Filter what user capability is required to use the publicize form on the edit post page. Useful if publish post capability has been removed from role.
827
		 *
828
		 * @module publicize
829
		 *
830
		 * @since 4.1.0
831
		 *
832
		 * @param string $capability User capability needed to use publicize
833
		 */
834
		$capability = apply_filters( 'jetpack_publicize_capability', 'publish_posts' );
835
836
		if ( 'publish_posts' === $capability && $post_id ) {
837
			return current_user_can( 'publish_post', $post_id );
838
		}
839
840
		return current_user_can( $capability );
841
	}
842
843
	/**
844
	 * Auth callback for the protected ->POST_MESS post_meta
845
	 *
846
	 * @param bool $allowed
847
	 * @param string $meta_key
848
	 * @param int $object_id Post ID
849
	 * @return bool
850
	 */
851
	function message_meta_auth_callback( $allowed, $meta_key, $object_id ) {
852
		return $this->current_user_can_access_publicize_data( $object_id );
853
	}
854
855
	/**
856
	 * Registers the ->POST_MESS post_meta for use in the REST API.
857
	 *
858
	 * Registers for each post type that with `publicize` feature support.
859
	 */
860
	function register_post_meta() {
861
		$args = array(
862
			'type' => 'string',
863
			'description' => __( 'The message to use instead of the title when sharing to Publicize Services', 'jetpack' ),
864
			'single' => true,
865
			'default' => '',
866
			'show_in_rest' => array(
867
				'name' => 'jetpack_publicize_message'
868
			),
869
			'auth_callback' => array( $this, 'message_meta_auth_callback' ),
870
		);
871
872
		foreach ( get_post_types() as $post_type ) {
873
			if ( ! $this->post_type_is_publicizeable( $post_type ) ) {
874
				continue;
875
			}
876
877
			$args['object_subtype'] = $post_type;
878
879
			register_meta( 'post', $this->POST_MESS, $args );
880
		}
881
	}
882
883
	/**
884
	 * Fires when a post is saved, checks conditions and saves state in postmeta so that it
885
	 * can be picked up later by @see ::publicize_post() on WordPress.com codebase.
886
	 *
887
	 * Attached to the `save_post` action.
888
	 *
889
	 * @param int $post_id
890
	 * @param WP_Post $post
891
	 * @return void
892
	 */
893
	function save_meta( $post_id, $post ) {
894
		$cron_user = null;
895
		$submit_post = true;
896
897
		if ( ! $this->post_type_is_publicizeable( $post->post_type ) )
898
			return;
899
900
		// Don't Publicize during certain contexts:
901
902
		// - import
903
		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING  ) {
904
			$submit_post = false;
905
		}
906
907
		// - on quick edit, autosave, etc but do fire on p2, quickpress, and instapost ajax
908
		if (
909
			defined( 'DOING_AJAX' )
910
		&&
911
			DOING_AJAX
912
		&&
913
			!did_action( 'p2_ajax' )
914
		&&
915
			!did_action( 'wp_ajax_json_quickpress_post' )
916
		&&
917
			!did_action( 'wp_ajax_instapost_publish' )
918
		&&
919
			!did_action( 'wp_ajax_post_reblog' )
920
		&&
921
			!did_action( 'wp_ajax_press-this-save-post' )
922
		) {
923
			$submit_post = false;
924
		}
925
926
		// - bulk edit
927
		if ( isset( $_GET['bulk_edit'] ) ) {
928
			$submit_post = false;
929
		}
930
931
		// - API/XML-RPC Test Posts
932
		if (
933
			(
934
				defined( 'XMLRPC_REQUEST' )
935
			&&
936
				XMLRPC_REQUEST
937
			||
938
				defined( 'APP_REQUEST' )
939
			&&
940
				APP_REQUEST
941
			)
942
		&&
943
			0 === strpos( $post->post_title, 'Temporary Post Used For Theme Detection' )
944
		) {
945
			$submit_post = false;
946
		}
947
948
		// only work with certain statuses (avoids inherits, auto drafts etc)
949
		if ( !in_array( $post->post_status, array( 'publish', 'draft', 'future' ) ) ) {
950
			$submit_post = false;
951
		}
952
953
		// don't publish password protected posts
954
		if ( '' !== $post->post_password ) {
955
			$submit_post = false;
956
		}
957
958
		// Did this request happen via wp-admin?
959
		$from_web = isset( $_SERVER['REQUEST_METHOD'] )
960
			&&
961
			'post' == strtolower( $_SERVER['REQUEST_METHOD'] )
962
			&&
963
			isset( $_POST[$this->ADMIN_PAGE] );
964
965
		if ( ( $from_web || defined( 'POST_BY_EMAIL' ) ) && isset( $_POST['wpas_title'] ) ) {
966
			if ( empty( $_POST['wpas_title'] ) ) {
967
				delete_post_meta( $post_id, $this->POST_MESS );
968
			} else {
969
				update_post_meta( $post_id, $this->POST_MESS, trim( stripslashes( $_POST['wpas_title'] ) ) );
970
			}
971
		}
972
973
		// change current user to provide context for get_services() if we're running during cron
974
		if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
975
			$cron_user = (int) $GLOBALS['user_ID'];
976
			wp_set_current_user( $post->post_author );
977
		}
978
979
		/**
980
		 * In this phase, we mark connections that we want to SKIP. When Publicize is actually triggered,
981
		 * it will Publicize to everything *except* those marked for skipping.
982
		 */
983
		foreach ( (array) $this->get_services( 'connected' ) as $service_name => $connections ) {
984
			foreach ( $connections as $connection ) {
985
				$connection_data = '';
986
				if ( method_exists( $connection, 'get_meta' ) )
987
					$connection_data = $connection->get_meta( 'connection_data' );
988
				elseif ( ! empty( $connection['connection_data'] ) )
989
					$connection_data = $connection['connection_data'];
990
991
				/** This action is documented in modules/publicize/ui.php */
992
				if ( false == apply_filters( 'wpas_submit_post?', $submit_post, $post_id, $service_name, $connection_data ) ) {
993
					delete_post_meta( $post_id, $this->PENDING );
994
					continue;
995
				}
996
997 View Code Duplication
				if ( !empty( $connection->unique_id ) )
998
					$unique_id = $connection->unique_id;
999
				else if ( !empty( $connection['connection_data']['token_id'] ) )
1000
					$unique_id = $connection['connection_data']['token_id'];
1001
1002
				// This was a wp-admin request, so we need to check the state of checkboxes
1003
				if ( $from_web ) {
1004
					// delete stray service-based post meta
1005
					delete_post_meta( $post_id, $this->POST_SKIP . $service_name );
1006
1007
					// We *unchecked* this stream from the admin page, or it's set to readonly, or it's a new addition
1008
					if ( empty( $_POST[$this->ADMIN_PAGE]['submit'][$unique_id] ) ) {
1009
						// Also make sure that the service-specific input isn't there.
1010
						// If the user connected to a new service 'in-page' then a hidden field with the service
1011
						// name is added, so we just assume they wanted to Publicize to that service.
1012
						if ( empty( $_POST[$this->ADMIN_PAGE]['submit'][$service_name] ) ) {
1013
							// Nothing seems to be checked, so we're going to mark this one to be skipped
1014
							update_post_meta( $post_id, $this->POST_SKIP . $unique_id, 1 );
0 ignored issues
show
Bug introduced by
The variable $unique_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

  1. 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;
        }
    }
    
  2. 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;
    }
    
  3. 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...
1015
							continue;
1016
						} else {
1017
							// clean up any stray post meta
1018
							delete_post_meta( $post_id, $this->POST_SKIP . $unique_id );
1019
						}
1020
					} else {
1021
						// The checkbox for this connection is explicitly checked -- make sure we DON'T skip it
1022
						delete_post_meta( $post_id, $this->POST_SKIP . $unique_id );
1023
					}
1024
				}
1025
1026
				/**
1027
				 * Fires right before the post is processed for Publicize.
1028
				 * Users may hook in here and do anything else they need to after meta is written,
1029
				 * and before the post is processed for Publicize.
1030
				 *
1031
				 * @since 2.1.2
1032
				 *
1033
				 * @param bool $submit_post Should the post be publicized.
1034
				 * @param int $post->ID Post ID.
1035
				 * @param string $service_name Service name.
1036
				 * @param array $connection Array of connection details.
1037
				 */
1038
				do_action( 'publicize_save_meta', $submit_post, $post_id, $service_name, $connection );
1039
			}
1040
		}
1041
1042
		if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
1043
			wp_set_current_user( $cron_user );
1044
		}
1045
1046
		// Next up will be ::publicize_post()
1047
	}
1048
1049
	/**
1050
	 * Alters the "Post Published" message to include information about where the post
1051
	 * was Publicized to.
1052
	 *
1053
	 * Attached to the `post_updated_messages` filter
1054
	 *
1055
	 * @param string[] $messages
1056
	 * @return string[]
1057
	 */
1058
	public function update_published_message( $messages ) {
1059
		global $post_type, $post_type_object, $post;
1060
		if ( ! $this->post_type_is_publicizeable( $post_type ) ) {
1061
			return $messages;
1062
		}
1063
		$view_post_link_html = '';
1064
		$viewable = is_post_type_viewable( $post_type_object );
1065
		if ( $viewable ) {
1066
			$view_text = esc_html__( 'View post' ); // intentionally omitted domain
1067
1068
			if ( 'jetpack-portfolio' == $post_type ) {
1069
				$view_text = esc_html__( 'View project', 'jetpack' );
1070
			}
1071
1072
			$view_post_link_html = sprintf( ' <a href="%1$s">%2$s</a>',
1073
				esc_url( get_permalink( $post ) ),
1074
				$view_text
1075
			);
1076
		}
1077
1078
		$services = $this->get_publicizing_services( $post->ID );
1079
		if ( empty( $services ) ) {
1080
			return $messages;
1081
		}
1082
1083
		$labels = array();
1084
		foreach ( $services as $service_name => $display_names ) {
1085
			$labels[] = sprintf(
1086
				/* translators: Service name is %1$s, and account name is %2$s. */
1087
				esc_html__( '%1$s (%2$s)', 'jetpack' ),
1088
				esc_html( $service_name ),
1089
				esc_html( implode( ', ', $display_names ) )
1090
			);
1091
		}
1092
1093
		$messages['post'][6] = sprintf(
1094
			/* translators: %1$s is a comma-separated list of services and accounts. Ex. Facebook (@jetpack), Twitter (@jetpack) */
1095
			esc_html__( 'Post published and sharing on %1$s.', 'jetpack' ),
1096
			implode( ', ', $labels )
1097
		) . $view_post_link_html;
1098
1099
		if ( $post_type == 'post' && class_exists('Jetpack_Subscriptions' ) ) {
1100
			$subscription = Jetpack_Subscriptions::init();
1101
			if ( $subscription->should_email_post_to_subscribers( $post ) ) {
1102
				$messages['post'][6] = sprintf(
1103
					/* translators: %1$s is a comma-separated list of services and accounts. Ex. Facebook (@jetpack), Twitter (@jetpack) */
1104
					esc_html__( 'Post published, sending emails to subscribers and sharing post on %1$s.', 'jetpack' ),
1105
					implode( ', ', $labels )
1106
				) . $view_post_link_html;
1107
			}
1108
		}
1109
1110
		$messages['jetpack-portfolio'][6] = sprintf(
1111
			/* translators: %1$s is a comma-separated list of services and accounts. Ex. Facebook (@jetpack), Twitter (@jetpack) */
1112
			esc_html__( 'Project published and sharing project on %1$s.', 'jetpack' ),
1113
			implode( ', ', $labels )
1114
		) . $view_post_link_html;
1115
1116
		return $messages;
1117
	}
1118
1119
	/**
1120
	 * Get the Connections the Post was just Publicized to.
1121
	 *
1122
	 * Only reliable just after the Post was published.
1123
	 *
1124
	 * @param int $post_id
1125
	 * @return string[] Array of Service display name => Connection display name
1126
	 */
1127
	function get_publicizing_services( $post_id ) {
1128
		$services = array();
1129
1130
		foreach ( (array) $this->get_services( 'connected' ) as $service_name => $connections ) {
1131
			// services have multiple connections.
1132
			foreach ( $connections as $connection ) {
1133
				$unique_id = '';
1134 View Code Duplication
				if ( ! empty( $connection->unique_id ) )
1135
					$unique_id = $connection->unique_id;
1136
				else if ( ! empty( $connection['connection_data']['token_id'] ) )
1137
					$unique_id = $connection['connection_data']['token_id'];
1138
1139
				// Did we skip this connection?
1140
				if ( get_post_meta( $post_id, $this->POST_SKIP . $unique_id,  true ) ) {
1141
					continue;
1142
				}
1143
				$services[ $this->get_service_label( $service_name ) ][] = $this->get_display_name( $service_name, $connection );
1144
			}
1145
		}
1146
1147
		return $services;
1148
	}
1149
1150
	/**
1151
	 * Is the post Publicize-able?
1152
	 *
1153
	 * Only valid prior to Publicizing a Post.
1154
	 *
1155
	 * @param WP_Post $post
1156
	 * @return bool
1157
	 */
1158
	function post_is_publicizeable( $post ) {
1159
		if ( ! $this->post_type_is_publicizeable( $post->post_type ) )
1160
			return false;
1161
1162
		// This is more a precaution. To only publicize posts that are published. (Mostly relevant for Jetpack sites)
1163
		if ( 'publish' !== $post->post_status ) {
1164
			return false;
1165
		}
1166
1167
		// If it's not flagged as ready, then abort. @see ::flag_post_for_publicize()
1168
		if ( ! get_post_meta( $post->ID, $this->PENDING, true ) )
1169
			return false;
1170
1171
		return true;
1172
	}
1173
1174
	/**
1175
	 * Is a given post type Publicize-able?
1176
	 *
1177
	 * Not every CPT lends itself to Publicize-ation.  Allow CPTs to register by adding their CPT via
1178
	 * the publicize_post_types array filter.
1179
	 *
1180
	 * @param string $post_type The post type to check.
1181
	 * @return bool True if the post type can be Publicized.
1182
	 */
1183
	function post_type_is_publicizeable( $post_type ) {
1184
		if ( 'post' == $post_type )
1185
			return true;
1186
1187
		return post_type_supports( $post_type, 'publicize' );
1188
	}
1189
1190
	/**
1191
	 * Already-published posts should not be Publicized by default. This filter sets checked to
1192
	 * false if a post has already been published.
1193
	 *
1194
	 * Attached to the `publicize_checkbox_default` filter
1195
	 *
1196
	 * @param bool $checked
1197
	 * @param int $post_id
1198
	 * @param string $service_name 'facebook', 'twitter', etc
1199
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
1200
	 * @return bool
1201
	 */
1202
	function publicize_checkbox_default( $checked, $post_id, $service_name, $connection ) {
1203
		if ( 'publish' == get_post_status( $post_id ) ) {
1204
			return false;
1205
		}
1206
1207
		return $checked;
1208
	}
1209
1210
/*
1211
 * Util
1212
 */
1213
1214
	/**
1215
	 * Converts a Publicize message template string into a sprintf format string
1216
	 *
1217
	 * @param string[] $args
1218
	 *               0 - The Publicize message template: 'Check out my post: %title% @ %url'
1219
	 *             ... - The template tags 'title', 'url', etc.
1220
	 * @return string
1221
	 */
1222
	protected static function build_sprintf( $args ) {
1223
		$search = array();
1224
		$replace = array();
1225
		foreach ( $args as $k => $arg ) {
1226
			if ( 0 == $k ) {
1227
				$string = $arg;
1228
				continue;
1229
			}
1230
			$search[] = "%$arg%";
1231
			$replace[] = "%$k\$s";
1232
		}
1233
		return str_replace( $search, $replace, $string );
0 ignored issues
show
Bug introduced by
The variable $string 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

  1. 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;
        }
    }
    
  2. 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;
    }
    
  3. 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...
1234
	}
1235
}
1236
1237
function publicize_calypso_url() {
1238
	$calypso_sharing_url = 'https://wordpress.com/sharing/';
1239 View Code Duplication
	if ( class_exists( 'Jetpack' ) && method_exists( 'Jetpack', 'build_raw_urls' ) ) {
1240
		$site_suffix = Jetpack::build_raw_urls( home_url() );
1241
	} elseif ( class_exists( 'WPCOM_Masterbar' ) && method_exists( 'WPCOM_Masterbar', 'get_calypso_site_slug' ) ) {
1242
		$site_suffix = WPCOM_Masterbar::get_calypso_site_slug( get_current_blog_id() );
1243
	}
1244
1245
	if ( $site_suffix ) {
1246
		return $calypso_sharing_url . $site_suffix;
0 ignored issues
show
Bug introduced by
The variable $site_suffix 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

  1. 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;
        }
    }
    
  2. 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;
    }
    
  3. 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...
1247
	} else {
1248
		return $calypso_sharing_url;
1249
	}
1250
}
1251