Completed
Push — renovate/major-react-monorepo ( 5a9765...516ec4 )
by Jeremy
20:32 queued 13:15
created

Publicize_Base::get_extension_availability()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 4
nop 0
dl 0
loc 9
rs 9.9666
c 0
b 0
f 0
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( 'init', array( $this, 'register_gutenberg_extension' ), 30 );
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
	/**
144
	 * Does the given user have a connection to the service on the given blog?
145
	 *
146
	 * @param string $service_name 'facebook', 'twitter', etc.
147
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
148
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
149
	 * @return bool
150
	 */
151
	function is_enabled( $service_name, $_blog_id = false, $_user_id = false ) {
152
		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...
153
			$_blog_id = $this->blog_id();
154
155
		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...
156
			$_user_id = $this->user_id();
157
158
		$connections = $this->get_connections( $service_name, $_blog_id, $_user_id );
159
		return ( is_array( $connections ) && count( $connections ) > 0 ? true : false );
160
	}
161
162
	/**
163
	 * Generates a connection URL.
164
	 *
165
	 * This is the URL, which, when visited by the user, starts the authentication
166
	 * process required to forge a connection.
167
	 *
168
	 * @param string $service_name 'facebook', 'twitter', etc.
169
	 * @return string
170
	 */
171
	abstract function connect_url( $service_name );
172
173
	/**
174
	 * Generates a Connection refresh URL.
175
	 *
176
	 * This is the URL, which, when visited by the user, re-authenticates their
177
	 * connection to the service.
178
	 *
179
	 * @param string $service_name 'facebook', 'twitter', etc.
180
	 * @return string
181
	 */
182
	abstract function refresh_url( $service_name );
183
184
	/**
185
	 * Generates a disconnection URL.
186
	 *
187
	 * This is the URL, which, when visited by the user, breaks their connection
188
	 * with the service.
189
	 *
190
	 * @param string $service_name 'facebook', 'twitter', etc.
191
	 * @param string $connection_id Connection ID
192
	 * @return string
193
	 */
194
	abstract function disconnect_url( $service_name, $connection_id );
195
196
	/**
197
	 * Returns a display name for the Service
198
	 *
199
	 * @param string $service_name 'facebook', 'twitter', etc.
200
	 * @return string
201
	 */
202
	public static function get_service_label( $service_name ) {
203
		switch ( $service_name ) {
204
			case 'linkedin':
205
				return 'LinkedIn';
206
				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...
207
			case 'google_plus':
208
				return  'Google+';
209
				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...
210
			case 'twitter':
211
			case 'facebook':
212
			case 'tumblr':
213
			default:
214
				return ucfirst( $service_name );
215
				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...
216
		}
217
	}
218
219
/*
220
 * Connections: For each Service, there can be multiple connections
221
 * for a given user. For example, one user could be connected to Twitter
222
 * as both @jetpack and as @wordpressdotcom
223
 *
224
 * For historical reasons, Connections are represented as an object
225
 * on WordPress.com and as an array in Jetpack.
226
 */
227
228
	/**
229
	 * Get the active Connections of a Service
230
	 *
231
	 * @param string $service_name 'facebook', 'twitter', etc.
232
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
233
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
234
	 * @return false|object[]|array[] false if no connections exist
235
	 */
236
	abstract function get_connections( $service_name, $_blog_id = false, $_user_id = false );
237
238
	/**
239
	 * Get a single Connection of a Service
240
	 *
241
	 * @param string $service_name 'facebook', 'twitter', etc.
242
	 * @param string $connection_id Connection ID
243
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
244
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
245
	 * @return false|object[]|array[] false if no connections exist
246
	 */
247
	abstract function get_connection( $service_name, $connection_id, $_blog_id = false, $_user_id = false );
248
249
	/**
250
	 * Get the Connection ID.
251
	 *
252
	 * Note that this is different than the Connection's uniqueid.
253
	 *
254
	 * Via a quirk of history, ID is globally unique and unique_id
255
	 * is only unique per site.
256
	 *
257
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
258
	 * @return string
259
	 */
260
	abstract function get_connection_id( $connection );
261
262
	/**
263
	 * Get the Connection unique_id
264
	 *
265
	 * Note that this is different than the Connections ID.
266
	 *
267
	 * Via a quirk of history, ID is globally unique and unique_id
268
	 * is only unique per site.
269
	 *
270
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
271
	 * @return string
272
	 */
273
	abstract function get_connection_unique_id( $connection );
274
275
	/**
276
	 * Get the Connection's Meta data
277
	 *
278
	 * @param object|array Connection
279
	 * @return array Connection Meta
280
	 */
281
	abstract function get_connection_meta( $connection );
282
283
	/**
284
	 * Disconnect a Connection
285
	 *
286
	 * @param string $service_name 'facebook', 'twitter', etc.
287
	 * @param string $connection_id Connection ID
288
	 * @param false|int $_blog_id The blog ID. Use false (default) for the current blog
289
	 * @param false|int $_user_id The user ID. Use false (default) for the current user
290
	 * @param bool $force_delete Whether to skip permissions checks
291
	 * @return false|void False on failure. Void on success.
292
	 */
293
	abstract function disconnect( $service_name, $connection_id, $_blog_id = false, $_user_id = false, $force_delete = false );
294
295
	/**
296
	 * Globalizes a Connection
297
	 *
298
	 * @param string $connection_id Connection ID
299
	 * @return bool Falsey on failure. Truthy on success.
300
	 */
301
	abstract function globalize_connection( $connection_id );
302
303
	/**
304
	 * Unglobalizes a Connection
305
	 *
306
	 * @param string $connection_id Connection ID
307
	 * @return bool Falsey on failure. Truthy on success.
308
	 */
309
	abstract function unglobalize_connection( $connection_id );
310
311
	/**
312
	 * Returns an external URL to the Connection's profile
313
	 *
314
	 * @param string $service_name 'facebook', 'twitter', etc.
315
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
316
	 * @return false|string False on failure. URL on success.
317
	 */
318
	function get_profile_link( $service_name, $connection ) {
319
		$cmeta = $this->get_connection_meta( $connection );
320
321
		if ( isset( $cmeta['connection_data']['meta']['link'] ) ) {
322
			if ( 'facebook' == $service_name && 0 === strpos( parse_url( $cmeta['connection_data']['meta']['link'], PHP_URL_PATH ), '/app_scoped_user_id/' ) ) {
323
				// App-scoped Facebook user IDs are not usable profile links
324
				return false;
325
			}
326
327
			return $cmeta['connection_data']['meta']['link'];
328 View Code Duplication
		} elseif ( 'facebook' == $service_name && isset( $cmeta['connection_data']['meta']['facebook_page'] ) ) {
329
			return 'https://facebook.com/' . $cmeta['connection_data']['meta']['facebook_page'];
330
		} elseif ( 'tumblr' == $service_name && isset( $cmeta['connection_data']['meta']['tumblr_base_hostname'] ) ) {
331
			 return 'http://' . $cmeta['connection_data']['meta']['tumblr_base_hostname'];
332
		} elseif ( 'twitter' == $service_name ) {
333
			return 'https://twitter.com/' . substr( $cmeta['external_display'], 1 ); // Has a leading '@'
334 View Code Duplication
		} elseif ( 'google_plus' == $service_name && isset( $cmeta['connection_data']['meta']['google_plus_page'] ) ) {
335
			return 'https://plus.google.com/' . $cmeta['connection_data']['meta']['google_plus_page'];
336
		} elseif ( 'google_plus' == $service_name ) {
337
			return 'https://plus.google.com/' . $cmeta['external_id'];
338
		} else if ( 'linkedin' == $service_name ) {
339
			if ( !isset( $cmeta['connection_data']['meta']['profile_url'] ) ) {
340
				return false;
341
			}
342
343
			$profile_url_query = parse_url( $cmeta['connection_data']['meta']['profile_url'], PHP_URL_QUERY );
344
			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...
345
			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...
346
				$id = $profile_url_query_args['key'];
347
			} 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...
348
				$id = $profile_url_query_args['id'];
349
			} else {
350
				return false;
351
			}
352
353
			return esc_url_raw( add_query_arg( 'id', urlencode( $id ), 'http://www.linkedin.com/profile/view' ) );
354
		} else {
355
			return false; // no fallback. we just won't link it
356
		}
357
	}
358
359
	/**
360
	 * Returns a display name for the Connection
361
	 *
362
	 * @param string $service_name 'facebook', 'twitter', etc.
363
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
364
	 * @return string
365
	 */
366
	function get_display_name( $service_name, $connection ) {
367
		$cmeta = $this->get_connection_meta( $connection );
368
369
		if ( isset( $cmeta['connection_data']['meta']['display_name'] ) ) {
370
			return $cmeta['connection_data']['meta']['display_name'];
371 View Code Duplication
		} elseif ( $service_name == 'tumblr' && isset( $cmeta['connection_data']['meta']['tumblr_base_hostname'] ) ) {
372
			 return $cmeta['connection_data']['meta']['tumblr_base_hostname'];
373
		} elseif ( $service_name == 'twitter' ) {
374
			return $cmeta['external_display'];
375
		} else {
376
			$connection_display = $cmeta['external_display'];
377
			if ( empty( $connection_display ) )
378
				$connection_display = $cmeta['external_name'];
379
			return $connection_display;
380
		}
381
	}
382
383
	/**
384
	 * Whether the user needs to select additional options after connecting
385
	 *
386
	 * @param string $service_name 'facebook', 'twitter', etc.
387
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
388
	 * @return bool
389
	 */
390
	function show_options_popup( $service_name, $connection ) {
391
		$cmeta = $this->get_connection_meta( $connection );
392
393
		// always show if no selection has been made for facebook
394
		if ( 'facebook' == $service_name && empty( $cmeta['connection_data']['meta']['facebook_profile'] ) && empty( $cmeta['connection_data']['meta']['facebook_page'] ) )
395
			return true;
396
397
		// always show if no selection has been made for tumblr
398
		if ( 'tumblr' == $service_name && empty ( $cmeta['connection_data']['meta']['tumblr_base_hostname'] ) )
399
			return true;
400
401
		// if we have the specific connection info..
402
		if ( isset( $_GET['id'] ) ) {
403
			if ( $cmeta['connection_data']['id'] == $_GET['id'] )
404
				return true;
405
		} else {
406
			// otherwise, just show if this is the completed step / first load
407
			if ( !empty( $_GET['action'] ) && 'completed' == $_GET['action'] && !empty( $_GET['service'] ) && $service_name == $_GET['service'] && ! in_array( $_GET['service'], array( 'facebook', 'tumblr' ) ) )
408
				return true;
409
		}
410
411
		return false;
412
	}
413
414
	/**
415
	 * Whether the Connection is "valid" wrt Facebook's requirements.
416
	 *
417
	 * Must be connected to a Page (not a Profile).
418
	 * (Also returns true if we're in the middle of the connection process)
419
	 *
420
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
421
	 * @return bool
422
	 */
423
	function is_valid_facebook_connection( $connection ) {
424
		if ( $this->is_connecting_connection( $connection ) ) {
425
			return true;
426
		}
427
		$connection_meta = $this->get_connection_meta( $connection );
428
		$connection_data = $connection_meta['connection_data'];
429
		return isset( $connection_data[ 'meta' ][ 'facebook_page' ] );
430
	}
431
432
	/**
433
	 * Whether the Connection currently being connected
434
	 *
435
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
436
	 * @return bool
437
	 */
438
	function is_connecting_connection( $connection ) {
439
		$connection_meta = $this->get_connection_meta( $connection );
440
		$connection_data = $connection_meta['connection_data'];
441
		return isset( $connection_data[ 'meta' ]['options_responses'] );
442
	}
443
444
	/**
445
	 * AJAX Handler to run connection tests on all Connections
446
	 * @return void
447
	 */
448
	function test_publicize_conns() {
449
		wp_send_json_success( $this->get_publicize_conns_test_results() );
450
	}
451
452
	/**
453
	 * Run connection tests on all Connections
454
	 *
455
	 * @return array {
456
	 *     Array of connection test results.
457
	 *
458
	 *     @type string 'connectionID'          Connection identifier string that is unique for each connection
459
	 *     @type string 'serviceName'           Slug of the connection's service (facebook, twitter, ...)
460
	 *     @type bool   'connectionTestPassed'  Whether the connection test was successful
461
	 *     @type string 'connectionTestMessage' Test success or error message
462
	 *     @type bool   'userCanRefresh'        Whether the user can re-authenticate their connection to the service
463
	 *     @type string 'refreshText'           Message instructing user to re-authenticate their connection to the service
464
	 *     @type string 'refreshURL'            URL, which, when visited by the user, re-authenticates their connection to the service.
465
	 *     @type string 'unique_id'             ID string representing connection
466
	 * }
467
	 */
468
	function get_publicize_conns_test_results() {
469
		$test_results = array();
470
471
		foreach ( (array) $this->get_services( 'connected' ) as $service_name => $connections ) {
472
			foreach ( $connections as $connection ) {
473
474
				$id = $this->get_connection_id( $connection );
475
476
				$connection_test_passed = true;
477
				$connection_test_message = __( 'This connection is working correctly.' , 'jetpack' );
478
				$user_can_refresh = false;
479
				$refresh_text = '';
480
				$refresh_url = '';
481
482
				$connection_test_result = true;
483
				if ( method_exists( $this, 'test_connection' ) ) {
484
					$connection_test_result = $this->test_connection( $service_name, $connection );
485
				}
486
487
				if ( is_wp_error( $connection_test_result ) ) {
488
					$connection_test_passed = false;
489
					$connection_test_message = $connection_test_result->get_error_message();
490
					$error_data = $connection_test_result->get_error_data();
491
492
					$user_can_refresh = $error_data['user_can_refresh'];
493
					$refresh_text = $error_data['refresh_text'];
494
					$refresh_url = $error_data['refresh_url'];
495
				}
496
				// Mark facebook profiles as deprecated
497
				if ( 'facebook' === $service_name ) {
498
					if ( ! $this->is_valid_facebook_connection( $connection ) ) {
499
						$connection_test_passed = false;
500
						$user_can_refresh = false;
501
						$connection_test_message = __( 'Facebook no longer supports Publicize connections to Facebook Profiles, but you can still connect Facebook Pages. Please select a Facebook Page to publish updates to.' );
502
					}
503
				}
504
505
				$unique_id = null;
506 View Code Duplication
				if ( ! empty( $connection->unique_id ) ) {
507
					$unique_id = $connection->unique_id;
508
				} else if ( ! empty( $connection['connection_data']['token_id'] ) ) {
509
					$unique_id = $connection['connection_data']['token_id'];
510
				}
511
512
				$test_results[] = array(
513
					'connectionID'          => $id,
514
					'serviceName'           => $service_name,
515
					'connectionTestPassed'  => $connection_test_passed,
516
					'connectionTestMessage' => esc_attr( $connection_test_message ),
517
					'userCanRefresh'        => $user_can_refresh,
518
					'refreshText'           => esc_attr( $refresh_text ),
519
					'refreshURL'            => $refresh_url,
520
					'unique_id'             => $unique_id,
521
				);
522
			}
523
		}
524
525
		return $test_results;
526
	}
527
528
	/**
529
	 * Run the connection test for the Connection
530
	 *
531
	 * @param string $service_name 'facebook', 'twitter', etc.
532
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
533
	 * @return WP_Error|true WP_Error on failure. True on success
534
	 */
535
	abstract function test_connection( $service_name, $connection );
536
537
	/**
538
	 * Retrieves current list of connections and applies filters.
539
	 *
540
	 * Retrieves current available connections and checks if the connections
541
	 * have already been used to share current post. Finally, the checkbox
542
	 * form UI fields are calculated. This function exposes connection form
543
	 * data directly as array so it can be retrieved for static HTML generation
544
	 * or JSON consumption.
545
	 *
546
	 * @since 6.7.0
547
	 *
548
	 * @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...
549
	 *
550
	 * @return array {
551
	 *     Array of UI setup data for connection list form.
552
	 *
553
	 *     @type string 'unique_id'     ID string representing connection
554
	 *     @type string 'service_name'  Slug of the connection's service (facebook, twitter, ...)
555
	 *     @type string 'service_label' Service Label (Facebook, Twitter, ...)
556
	 *     @type string 'display_name'  Connection's human-readable Username: "@jetpack"
557
	 *     @type bool   'enabled'       Default value for the connection (e.g., for a checkbox).
558
	 *     @type bool   'done'          Has this connection already been publicized to?
559
	 *     @type bool   'toggleable'    Is the user allowed to change the value for the connection?
560
	 *     @type bool   'global'        Is this connection a global one?
561
	 * }
562
	 */
563
	public function get_filtered_connection_data( $selected_post_id = null ) {
564
		$connection_list = array();
565
566
		$post = get_post( $selected_post_id ); // Defaults to current post if $post_id is null.
567
		// Handle case where there is no current post.
568
		if ( ! empty( $post ) ) {
569
			$post_id = $post->ID;
570
		} else {
571
			$post_id = null;
572
		}
573
574
		$services = $this->get_services( 'connected' );
575
		$all_done = $this->post_is_done_sharing( $post_id );
576
577
		// We don't allow Publicizing to the same external id twice, to prevent spam.
578
		$service_id_done = (array) get_post_meta( $post_id, $this->POST_SERVICE_DONE, true );
579
580
		foreach ( $services as $service_name => $connections ) {
581
			foreach ( $connections as $connection ) {
582
				$connection_meta = $this->get_connection_meta( $connection );
583
				$connection_data = $connection_meta['connection_data'];
584
585
				$unique_id = $this->get_connection_unique_id( $connection );
586
587
588
				// Was this connection (OR, old-format service) already Publicized to?
589
				$done = ! empty( $post ) && (
590
					// New flags
591
					1 == get_post_meta( $post->ID, $this->POST_DONE . $unique_id, true )
592
					||
593
					// old flags
594
					1 == get_post_meta( $post->ID, $this->POST_DONE . $service_name, true )
595
				);
596
597
				/**
598
				 * Filter whether a post should be publicized to a given service.
599
				 *
600
				 * @module publicize
601
				 *
602
				 * @since 2.0.0
603
				 *
604
				 * @param bool true Should the post be publicized to a given service? Default to true.
605
				 * @param int $post_id Post ID.
606
				 * @param string $service_name Service name.
607
				 * @param array $connection_data Array of information about all Publicize details for the site.
608
				 */
609
				if ( ! apply_filters( 'wpas_submit_post?', true, $post_id, $service_name, $connection_data ) ) {
610
					continue;
611
				}
612
613
				// Should we be skipping this one?
614
				$skip = (
615
					(
616
						! empty( $post )
617
						&&
618
						in_array( $post->post_status, array( 'publish', 'draft', 'future' ) )
619
						&&
620
						(
621
							// New flags
622
							get_post_meta( $post->ID, $this->POST_SKIP . $unique_id, true )
623
							||
624
							// Old flags
625
							get_post_meta( $post->ID, $this->POST_SKIP . $service_name )
626
						)
627
					)
628
					||
629
					(
630
						is_array( $connection )
631
						&&
632
						isset( $connection_meta['external_id'] ) && ! empty( $service_id_done[ $service_name ][ $connection_meta['external_id'] ] )
633
					)
634
				);
635
636
				// If this one has already been publicized to, don't let it happen again.
637
				$toggleable = ! $done && ! $all_done;
638
639
				// Determine the state of the checkbox (on/off) and allow filtering.
640
				$enabled = $done || ! $skip;
641
				/**
642
				 * Filter the checkbox state of each Publicize connection appearing in the post editor.
643
				 *
644
				 * @module publicize
645
				 *
646
				 * @since 2.0.1
647
				 *
648
				 * @param bool $enabled Should the Publicize checkbox be enabled for a given service.
649
				 * @param int $post_id Post ID.
650
				 * @param string $service_name Service name.
651
				 * @param array $connection Array of connection details.
652
				 */
653
				$enabled = apply_filters( 'publicize_checkbox_default', $enabled, $post_id, $service_name, $connection );
654
655
				/**
656
				 * If this is a global connection and this user doesn't have enough permissions to modify
657
				 * those connections, don't let them change it.
658
				 */
659
				if ( ! $done && ( 0 == $connection_data['user_id'] && ! current_user_can( $this->GLOBAL_CAP ) ) ) {
660
					$toggleable = false;
661
662
					/**
663
					 * Filters the checkboxes for global connections with non-prilvedged users.
664
					 *
665
					 * @module publicize
666
					 *
667
					 * @since 3.7.0
668
					 *
669
					 * @param bool   $enabled Indicates if this connection should be enabled. Default true.
670
					 * @param int    $post_id ID of the current post
671
					 * @param string $service_name Name of the connection (Facebook, Twitter, etc)
672
					 * @param array  $connection Array of data about the connection.
673
					 */
674
					$enabled = apply_filters( 'publicize_checkbox_global_default', $enabled, $post_id, $service_name, $connection );
675
				}
676
677
				// Force the checkbox to be checked if the post was DONE, regardless of what the filter does.
678
				if ( $done ) {
679
					$enabled = true;
680
				}
681
682
				$connection_list[] = array(
683
					'unique_id'     => $unique_id,
684
					'service_name'  => $service_name,
685
					'service_label' => $this->get_service_label( $service_name ),
686
					'display_name'  => $this->get_display_name( $service_name, $connection ),
687
688
					'enabled'      => $enabled,
689
					'done'         => $done,
690
					'toggleable'   => $toggleable,
691
					'global'       => 0 == $connection_data['user_id'],
692
				);
693
			}
694
		}
695
696
		return $connection_list;
697
	}
698
699
	/**
700
	 * Checks if post has already been shared by Publicize in the past.
701
	 *
702
	 * @since 6.7.0
703
	 *
704
	 * @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...
705
	 *
706
	 * @return bool True if post has already been shared by Publicize, false otherwise.
707
	 */
708
	abstract public function post_is_done_sharing( $post_id = null );
709
710
	/**
711
	 * Retrieves full list of available Publicize connection services.
712
	 *
713
	 * Retrieves current available publicize service connections
714
	 * with associated labels and URLs.
715
	 *
716
	 * @since 6.7.0
717
	 *
718
	 * @return array {
719
	 *     Array of UI service connection data for all services
720
	 *
721
	 *     @type string 'name'  Name of service.
722
	 *     @type string 'label' Display label for service.
723
	 *     @type string 'url'   URL for adding connection to service.
724
	 * }
725
	 */
726
	function get_available_service_data() {
727
		$available_services     = $this->get_services( 'all' );
728
		$available_service_data = array();
729
730
		foreach ( $available_services as $service_name => $service ) {
731
			$available_service_data[] = array(
732
				'name'  => $service_name,
733
				'label' => $this->get_service_label( $service_name ),
734
				'url'   => $this->connect_url( $service_name ),
735
			);
736
		}
737
738
		return $available_service_data;
739
	}
740
741
/*
742
 * Site Data
743
 */
744
745
	function user_id() {
746
		return get_current_user_id();
747
	}
748
749
	function blog_id() {
750
		return get_current_blog_id();
751
	}
752
753
/*
754
 * Posts
755
 */
756
757
	/**
758
	 * Checks old and new status to see if the post should be flagged as
759
	 * ready to Publicize.
760
	 *
761
	 * Attached to the `transition_post_status` filter.
762
	 *
763
	 * @param string $new_status
764
	 * @param string $old_status
765
	 * @param WP_Post $post
766
	 * @return void
767
	 */
768
	abstract function flag_post_for_publicize( $new_status, $old_status, $post );
769
770
	/**
771
	 * Ensures the Post internal post-type supports `publicize`
772
	 *
773
	 * This feature support flag is used by the REST API.
774
	 */
775
	function add_post_type_support() {
776
		add_post_type_support( 'post', 'publicize' );
777
	}
778
779
	/**
780
	 * Register the Publicize Gutenberg extension
781
	 */
782
	function register_gutenberg_extension() {
783
		// TODO: Not really a block. The underlying logic doesn't care, so we should rename to
784
		// `jetpack_register_gutenberg_extension()` (to account for both Gutenblocks and Gutenplugins).
785
		jetpack_register_block( 'publicize', array(), array( 'callback' => array( $this, 'get_extension_availability' ) ) );
786
	}
787
788
	function get_extension_availability() {
789
		$object_id = isset( $_GET['post'] ) ? absint( $_GET['post'] ) : 0;
790
791
		if ( ! $this->current_user_can_access_publicize_data( $object_id ) ) {
792
			return array( 'available' => false, 'unavailable_reason' => 'unauthorized' );
793
		}
794
795
		return array( 'available' => true );
796
	}
797
798
	/**
799
	 * Can the current user access Publicize Data.
800
	 *
801
	 * @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...
802
	 * @return bool
803
	 */
804
	function current_user_can_access_publicize_data( $post_id = 0 ) {
805
		/**
806
		 * 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.
807
		 *
808
		 * @module publicize
809
		 *
810
		 * @since 4.1.0
811
		 *
812
		 * @param string $capability User capability needed to use publicize
813
		 */
814
		$capability = apply_filters( 'jetpack_publicize_capability', 'publish_posts' );
815
816
		if ( 'publish_posts' === $capability && $post_id ) {
817
			return current_user_can( 'publish_post', $post_id );
818
		}
819
820
		return current_user_can( $capability );
821
	}
822
823
	/**
824
	 * Auth callback for the protected ->POST_MESS post_meta
825
	 *
826
	 * @param bool $allowed
827
	 * @param string $meta_key
828
	 * @param int $object_id Post ID
829
	 * @return bool
830
	 */
831
	function message_meta_auth_callback( $allowed, $meta_key, $object_id ) {
832
		return $this->current_user_can_access_publicize_data( $object_id );
833
	}
834
835
	/**
836
	 * Registers the ->POST_MESS post_meta for use in the REST API.
837
	 *
838
	 * Registers for each post type that with `publicize` feature support.
839
	 */
840
	function register_post_meta() {
841
		$args = array(
842
			'type' => 'string',
843
			'description' => __( 'The message to use instead of the title when sharing to Publicize Services', 'jetpack' ),
844
			'single' => true,
845
			'default' => '',
846
			'show_in_rest' => array(
847
				'name' => 'jetpack_publicize_message'
848
			),
849
			'auth_callback' => array( $this, 'message_meta_auth_callback' ),
850
		);
851
852
		foreach ( get_post_types() as $post_type ) {
853
			if ( ! $this->post_type_is_publicizeable( $post_type ) ) {
854
				continue;
855
			}
856
857
			$args['object_subtype'] = $post_type;
858
859
			register_meta( 'post', $this->POST_MESS, $args );
860
		}
861
	}
862
863
	/**
864
	 * Fires when a post is saved, checks conditions and saves state in postmeta so that it
865
	 * can be picked up later by @see ::publicize_post() on WordPress.com codebase.
866
	 *
867
	 * Attached to the `save_post` action.
868
	 *
869
	 * @param int $post_id
870
	 * @param WP_Post $post
871
	 * @return void
872
	 */
873
	function save_meta( $post_id, $post ) {
874
		$cron_user = null;
875
		$submit_post = true;
876
877
		if ( ! $this->post_type_is_publicizeable( $post->post_type ) )
878
			return;
879
880
		// Don't Publicize during certain contexts:
881
882
		// - import
883
		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING  ) {
884
			$submit_post = false;
885
		}
886
887
		// - on quick edit, autosave, etc but do fire on p2, quickpress, and instapost ajax
888
		if (
889
			defined( 'DOING_AJAX' )
890
		&&
891
			DOING_AJAX
892
		&&
893
			!did_action( 'p2_ajax' )
894
		&&
895
			!did_action( 'wp_ajax_json_quickpress_post' )
896
		&&
897
			!did_action( 'wp_ajax_instapost_publish' )
898
		&&
899
			!did_action( 'wp_ajax_post_reblog' )
900
		&&
901
			!did_action( 'wp_ajax_press-this-save-post' )
902
		) {
903
			$submit_post = false;
904
		}
905
906
		// - bulk edit
907
		if ( isset( $_GET['bulk_edit'] ) ) {
908
			$submit_post = false;
909
		}
910
911
		// - API/XML-RPC Test Posts
912
		if (
913
			(
914
				defined( 'XMLRPC_REQUEST' )
915
			&&
916
				XMLRPC_REQUEST
917
			||
918
				defined( 'APP_REQUEST' )
919
			&&
920
				APP_REQUEST
921
			)
922
		&&
923
			0 === strpos( $post->post_title, 'Temporary Post Used For Theme Detection' )
924
		) {
925
			$submit_post = false;
926
		}
927
928
		// only work with certain statuses (avoids inherits, auto drafts etc)
929
		if ( !in_array( $post->post_status, array( 'publish', 'draft', 'future' ) ) ) {
930
			$submit_post = false;
931
		}
932
933
		// don't publish password protected posts
934
		if ( '' !== $post->post_password ) {
935
			$submit_post = false;
936
		}
937
938
		// Did this request happen via wp-admin?
939
		$from_web = isset( $_SERVER['REQUEST_METHOD'] )
940
			&&
941
			'post' == strtolower( $_SERVER['REQUEST_METHOD'] )
942
			&&
943
			isset( $_POST[$this->ADMIN_PAGE] );
944
945
		if ( ( $from_web || defined( 'POST_BY_EMAIL' ) ) && isset( $_POST['wpas_title'] ) ) {
946
			if ( empty( $_POST['wpas_title'] ) ) {
947
				delete_post_meta( $post_id, $this->POST_MESS );
948
			} else {
949
				update_post_meta( $post_id, $this->POST_MESS, trim( stripslashes( $_POST['wpas_title'] ) ) );
950
			}
951
		}
952
953
		// change current user to provide context for get_services() if we're running during cron
954
		if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
955
			$cron_user = (int) $GLOBALS['user_ID'];
956
			wp_set_current_user( $post->post_author );
957
		}
958
959
		/**
960
		 * In this phase, we mark connections that we want to SKIP. When Publicize is actually triggered,
961
		 * it will Publicize to everything *except* those marked for skipping.
962
		 */
963
		foreach ( (array) $this->get_services( 'connected' ) as $service_name => $connections ) {
964
			foreach ( $connections as $connection ) {
965
				$connection_data = '';
966
				if ( method_exists( $connection, 'get_meta' ) )
967
					$connection_data = $connection->get_meta( 'connection_data' );
968
				elseif ( ! empty( $connection['connection_data'] ) )
969
					$connection_data = $connection['connection_data'];
970
971
				/** This action is documented in modules/publicize/ui.php */
972
				if ( false == apply_filters( 'wpas_submit_post?', $submit_post, $post_id, $service_name, $connection_data ) ) {
973
					delete_post_meta( $post_id, $this->PENDING );
974
					continue;
975
				}
976
977 View Code Duplication
				if ( !empty( $connection->unique_id ) )
978
					$unique_id = $connection->unique_id;
979
				else if ( !empty( $connection['connection_data']['token_id'] ) )
980
					$unique_id = $connection['connection_data']['token_id'];
981
982
				// This was a wp-admin request, so we need to check the state of checkboxes
983
				if ( $from_web ) {
984
					// delete stray service-based post meta
985
					delete_post_meta( $post_id, $this->POST_SKIP . $service_name );
986
987
					// We *unchecked* this stream from the admin page, or it's set to readonly, or it's a new addition
988
					if ( empty( $_POST[$this->ADMIN_PAGE]['submit'][$unique_id] ) ) {
989
						// Also make sure that the service-specific input isn't there.
990
						// If the user connected to a new service 'in-page' then a hidden field with the service
991
						// name is added, so we just assume they wanted to Publicize to that service.
992
						if ( empty( $_POST[$this->ADMIN_PAGE]['submit'][$service_name] ) ) {
993
							// Nothing seems to be checked, so we're going to mark this one to be skipped
994
							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...
995
							continue;
996
						} else {
997
							// clean up any stray post meta
998
							delete_post_meta( $post_id, $this->POST_SKIP . $unique_id );
999
						}
1000
					} else {
1001
						// The checkbox for this connection is explicitly checked -- make sure we DON'T skip it
1002
						delete_post_meta( $post_id, $this->POST_SKIP . $unique_id );
1003
					}
1004
				}
1005
1006
				/**
1007
				 * Fires right before the post is processed for Publicize.
1008
				 * Users may hook in here and do anything else they need to after meta is written,
1009
				 * and before the post is processed for Publicize.
1010
				 *
1011
				 * @since 2.1.2
1012
				 *
1013
				 * @param bool $submit_post Should the post be publicized.
1014
				 * @param int $post->ID Post ID.
1015
				 * @param string $service_name Service name.
1016
				 * @param array $connection Array of connection details.
1017
				 */
1018
				do_action( 'publicize_save_meta', $submit_post, $post_id, $service_name, $connection );
1019
			}
1020
		}
1021
1022
		if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
1023
			wp_set_current_user( $cron_user );
1024
		}
1025
1026
		// Next up will be ::publicize_post()
1027
	}
1028
1029
	/**
1030
	 * Alters the "Post Published" message to include information about where the post
1031
	 * was Publicized to.
1032
	 *
1033
	 * Attached to the `post_updated_messages` filter
1034
	 *
1035
	 * @param string[] $messages
1036
	 * @return string[]
1037
	 */
1038
	public function update_published_message( $messages ) {
1039
		global $post_type, $post_type_object, $post;
1040
		if ( ! $this->post_type_is_publicizeable( $post_type ) ) {
1041
			return $messages;
1042
		}
1043
		$view_post_link_html = '';
1044
		$viewable = is_post_type_viewable( $post_type_object );
1045
		if ( $viewable ) {
1046
			$view_text = esc_html__( 'View post' ); // intentionally omitted domain
1047
1048
			if ( 'jetpack-portfolio' == $post_type ) {
1049
				$view_text = esc_html__( 'View project', 'jetpack' );
1050
			}
1051
1052
			$view_post_link_html = sprintf( ' <a href="%1$s">%2$s</a>',
1053
				esc_url( get_permalink( $post ) ),
1054
				$view_text
1055
			);
1056
		}
1057
1058
		$services = $this->get_publicizing_services( $post->ID );
1059
		if ( empty( $services ) ) {
1060
			return $messages;
1061
		}
1062
1063
		$labels = array();
1064
		foreach ( $services as $service_name => $display_names ) {
1065
			$labels[] = sprintf(
1066
				/* translators: Service name is %1$s, and account name is %2$s. */
1067
				esc_html__( '%1$s (%2$s)', 'jetpack' ),
1068
				esc_html( $service_name ),
1069
				esc_html( implode( ', ', $display_names ) )
1070
			);
1071
		}
1072
1073
		$messages['post'][6] = sprintf(
1074
			/* translators: %1$s is a comma-separated list of services and accounts. Ex. Facebook (@jetpack), Twitter (@jetpack) */
1075
			esc_html__( 'Post published and sharing on %1$s.', 'jetpack' ),
1076
			implode( ', ', $labels )
1077
		) . $view_post_link_html;
1078
1079
		if ( $post_type == 'post' && class_exists('Jetpack_Subscriptions' ) ) {
1080
			$subscription = Jetpack_Subscriptions::init();
1081
			if ( $subscription->should_email_post_to_subscribers( $post ) ) {
1082
				$messages['post'][6] = sprintf(
1083
					/* translators: %1$s is a comma-separated list of services and accounts. Ex. Facebook (@jetpack), Twitter (@jetpack) */
1084
					esc_html__( 'Post published, sending emails to subscribers and sharing post on %1$s.', 'jetpack' ),
1085
					implode( ', ', $labels )
1086
				) . $view_post_link_html;
1087
			}
1088
		}
1089
1090
		$messages['jetpack-portfolio'][6] = sprintf(
1091
			/* translators: %1$s is a comma-separated list of services and accounts. Ex. Facebook (@jetpack), Twitter (@jetpack) */
1092
			esc_html__( 'Project published and sharing project on %1$s.', 'jetpack' ),
1093
			implode( ', ', $labels )
1094
		) . $view_post_link_html;
1095
1096
		return $messages;
1097
	}
1098
1099
	/**
1100
	 * Get the Connections the Post was just Publicized to.
1101
	 *
1102
	 * Only reliable just after the Post was published.
1103
	 *
1104
	 * @param int $post_id
1105
	 * @return string[] Array of Service display name => Connection display name
1106
	 */
1107
	function get_publicizing_services( $post_id ) {
1108
		$services = array();
1109
1110
		foreach ( (array) $this->get_services( 'connected' ) as $service_name => $connections ) {
1111
			// services have multiple connections.
1112
			foreach ( $connections as $connection ) {
1113
				$unique_id = '';
1114 View Code Duplication
				if ( ! empty( $connection->unique_id ) )
1115
					$unique_id = $connection->unique_id;
1116
				else if ( ! empty( $connection['connection_data']['token_id'] ) )
1117
					$unique_id = $connection['connection_data']['token_id'];
1118
1119
				// Did we skip this connection?
1120
				if ( get_post_meta( $post_id, $this->POST_SKIP . $unique_id,  true ) ) {
1121
					continue;
1122
				}
1123
				$services[ $this->get_service_label( $service_name ) ][] = $this->get_display_name( $service_name, $connection );
1124
			}
1125
		}
1126
1127
		return $services;
1128
	}
1129
1130
	/**
1131
	 * Is the post Publicize-able?
1132
	 *
1133
	 * Only valid prior to Publicizing a Post.
1134
	 *
1135
	 * @param WP_Post $post
1136
	 * @return bool
1137
	 */
1138
	function post_is_publicizeable( $post ) {
1139
		if ( ! $this->post_type_is_publicizeable( $post->post_type ) )
1140
			return false;
1141
1142
		// This is more a precaution. To only publicize posts that are published. (Mostly relevant for Jetpack sites)
1143
		if ( 'publish' !== $post->post_status ) {
1144
			return false;
1145
		}
1146
1147
		// If it's not flagged as ready, then abort. @see ::flag_post_for_publicize()
1148
		if ( ! get_post_meta( $post->ID, $this->PENDING, true ) )
1149
			return false;
1150
1151
		return true;
1152
	}
1153
1154
	/**
1155
	 * Is a given post type Publicize-able?
1156
	 *
1157
	 * Not every CPT lends itself to Publicize-ation.  Allow CPTs to register by adding their CPT via
1158
	 * the publicize_post_types array filter.
1159
	 *
1160
	 * @param string $post_type The post type to check.
1161
	 * @return bool True if the post type can be Publicized.
1162
	 */
1163
	function post_type_is_publicizeable( $post_type ) {
1164
		if ( 'post' == $post_type )
1165
			return true;
1166
1167
		return post_type_supports( $post_type, 'publicize' );
1168
	}
1169
1170
	/**
1171
	 * Already-published posts should not be Publicized by default. This filter sets checked to
1172
	 * false if a post has already been published.
1173
	 *
1174
	 * Attached to the `publicize_checkbox_default` filter
1175
	 *
1176
	 * @param bool $checked
1177
	 * @param int $post_id
1178
	 * @param string $service_name 'facebook', 'twitter', etc
1179
	 * @param object|array The Connection object (WordPress.com) or array (Jetpack)
1180
	 * @return bool
1181
	 */
1182
	function publicize_checkbox_default( $checked, $post_id, $service_name, $connection ) {
1183
		if ( 'publish' == get_post_status( $post_id ) ) {
1184
			return false;
1185
		}
1186
1187
		return $checked;
1188
	}
1189
1190
/*
1191
 * Util
1192
 */
1193
1194
	/**
1195
	 * Converts a Publicize message template string into a sprintf format string
1196
	 *
1197
	 * @param string[] $args
1198
	 *               0 - The Publicize message template: 'Check out my post: %title% @ %url'
1199
	 *             ... - The template tags 'title', 'url', etc.
1200
	 * @return string
1201
	 */
1202
	protected static function build_sprintf( $args ) {
1203
		$search = array();
1204
		$replace = array();
1205
		foreach ( $args as $k => $arg ) {
1206
			if ( 0 == $k ) {
1207
				$string = $arg;
1208
				continue;
1209
			}
1210
			$search[] = "%$arg%";
1211
			$replace[] = "%$k\$s";
1212
		}
1213
		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...
1214
	}
1215
}
1216
1217
function publicize_calypso_url() {
1218
	$calypso_sharing_url = 'https://wordpress.com/sharing/';
1219
	if ( class_exists( 'Jetpack' ) && method_exists( 'Jetpack', 'build_raw_urls' ) ) {
1220
		$site_suffix = Jetpack::build_raw_urls( home_url() );
1221
	} elseif ( class_exists( 'WPCOM_Masterbar' ) && method_exists( 'WPCOM_Masterbar', 'get_calypso_site_slug' ) ) {
1222
		$site_suffix = WPCOM_Masterbar::get_calypso_site_slug( get_current_blog_id() );
1223
	}
1224
1225
	if ( $site_suffix ) {
1226
		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...
1227
	} else {
1228
		return $calypso_sharing_url;
1229
	}
1230
}
1231