Completed
Push — add/sync-action ( 775957...b7b7fe )
by
unknown
08:28
created

class.jetpack-debugger.php (2 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
require_once( dirname( __FILE__ ) . '/sync/class.jetpack-sync-dashboard.php' );
3
require_once( dirname( __FILE__ ) . '/sync/class.jetpack-sync-reindex.php' );
4
5
class Jetpack_Debugger {
6
7
	private static function is_jetpack_support_open() {
8
		try {
9
			$response = wp_remote_request( "http://jetpack.com/is-support-open" );
10
			$body = wp_remote_retrieve_body( $response );
11
			$json = json_decode( $body );
12
			return ( ( bool ) $json->is_support_open );
13
		}
14
		catch ( Exception $e ) {
15
			return true;
16
		}
17
	}
18
19
	public static function jetpack_increase_timeout() {
20
		return 30; // seconds
21
	}
22
23
	public static function jetpack_debug_display_handler() {
24
		if ( ! current_user_can( 'manage_options' ) )
25
			wp_die( esc_html__('You do not have sufficient permissions to access this page.', 'jetpack' ) );
26
27
		$current_user = wp_get_current_user();
28
29
		$user_id = get_current_user_id();
30
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
31
		if ( is_array( $user_tokens ) && array_key_exists( $user_id, $user_tokens ) ) {
32
			$user_token = $user_tokens[$user_id];
33
		} else {
34
			$user_token = '[this user has no token]';
35
		}
36
		unset( $user_tokens );
37
38
		$debug_info = "\r\n";
39
		foreach ( array(
40
			'CLIENT_ID'   => 'id',
41
			'BLOG_TOKEN'  => 'blog_token',
42
			'MASTER_USER' => 'master_user',
43
			'CERT'        => 'fallback_no_verify_ssl_certs',
44
			'TIME_DIFF'   => 'time_diff',
45
			'VERSION'     => 'version',
46
			'OLD_VERSION' => 'old_version',
47
			'PUBLIC'      => 'public',
48
		) as $label => $option_name ) {
49
			$debug_info .= "\r\n" . esc_html( $label . ": " . Jetpack_Options::get_option( $option_name ) );
50
		}
51
52
		$debug_info .= "\r\n" . esc_html( "USER_ID: " . $user_id );
53
		$debug_info .= "\r\n" . esc_html( "USER_TOKEN: " . $user_token );
54
		$debug_info .= "\r\n" . esc_html( "PHP_VERSION: " . PHP_VERSION );
55
		$debug_info .= "\r\n" . esc_html( "WORDPRESS_VERSION: " . $GLOBALS['wp_version'] );
56
		$debug_info .= "\r\n" . esc_html( "JETPACK__VERSION: " . JETPACK__VERSION );
57
		$debug_info .= "\r\n" . esc_html( "JETPACK__PLUGIN_DIR: " . JETPACK__PLUGIN_DIR );
58
		$debug_info .= "\r\n" . esc_html( "SITE_URL: " . site_url() );
59
		$debug_info .= "\r\n" . esc_html( "HOME_URL: " . home_url() );
60
		$debug_info .= "\r\n" . esc_html( "SERVER_PORT: " . $_SERVER['SERVER_PORT'] );
61
62
63
		foreach ( array (
64
					  'GD_PHP_HANDLER',
65
					  'HTTP_AKAMAI_ORIGIN_HOP',
66
					  'HTTP_CF_CONNECTING_IP',
67
					  'HTTP_CLIENT_IP',
68
					  'HTTP_FASTLY_CLIENT_IP',
69
					  'HTTP_FORWARDED',
70
					  'HTTP_FORWARDED_FOR',
71
					  'HTTP_INCAP_CLIENT_IP',
72
					  'HTTP_TRUE_CLIENT_IP',
73
					  'HTTP_X_CLIENTIP',
74
					  'HTTP_X_CLUSTER_CLIENT_IP',
75
					  'HTTP_X_FORWARDED',
76
					  'HTTP_X_FORWARDED_FOR',
77
					  'HTTP_X_IP_TRAIL',
78
					  'HTTP_X_REAL_IP',
79
					  'HTTP_X_VARNISH',
80
					  'REMOTE_ADDR'
81
				  ) as $header ) {
82
			if( isset( $_SERVER[$header] ) ) {
83
				$debug_info .= "\r\n" . esc_html( 'IP HEADER: '.$header . ": " . $_SERVER[$header] );
84
			} else {
85
				$debug_info .= "\r\n" . esc_html( 'IP HEADER: '.$header . ": Not Set" );
86
			}
87
		}
88
89
90
		$debug_info .= "\r\n" . esc_html( "PROTECT_TRUSTED_HEADER: " . json_encode(get_site_option( 'trusted_ip_header' )));
91
92
		$debug_info .= "\r\n\r\nTEST RESULTS:\r\n\r\n";
93
		$debug_raw_info = '';
94
95
96
		$tests = array();
97
98
		$tests['HTTP']['result'] = wp_remote_get( preg_replace( '/^https:/', 'http:', JETPACK__API_BASE ) . 'test/1/' );
99
		$tests['HTTP']['fail_message'] = esc_html__( 'Your site isn’t reaching the Jetpack servers.', 'jetpack' );
100
101
		$tests['HTTPS']['result'] = wp_remote_get( preg_replace( '/^http:/', 'https:', JETPACK__API_BASE ) . 'test/1/' );
102
		$tests['HTTPS']['fail_message'] = esc_html__( 'Your site isn’t securely reaching the Jetpack servers.', 'jetpack' );
103
104
		$identity_crisis_message = '';
105
		if ( $identity_crisis = Jetpack::check_identity_crisis( true ) ) {
106
			foreach( $identity_crisis as $key => $value ) {
107
				$identity_crisis_message .= sprintf( __( 'Your `%1$s` option is set up as `%2$s`, but your WordPress.com connection lists it as `%3$s`!', 'jetpack' ), $key, (string) get_option( $key ), $value ) . "\r\n";
108
			}
109
			$identity_crisis = new WP_Error( 'identity-crisis', $identity_crisis_message, $identity_crisis );
110
		} else {
111
			$identity_crisis = 'PASS';
112
		}
113
		$tests['IDENTITY_CRISIS']['result'] = $identity_crisis;
114
		$tests['IDENTITY_CRISIS']['fail_message'] = esc_html__( 'Something has gotten mixed up in your Jetpack Connection!', 'jetpack' );
115
116
		$self_xml_rpc_url = home_url( 'xmlrpc.php' );
117
118
		$testsite_url = Jetpack::fix_url_for_bad_hosts( JETPACK__API_BASE . 'testsite/1/?url=' );
119
120
		add_filter( 'http_request_timeout', array( 'Jetpack_Debugger', 'jetpack_increase_timeout' ) );
121
122
		$tests['SELF']['result'] = wp_remote_get( $testsite_url . $self_xml_rpc_url );
123
		$tests['SELF']['fail_message'] = esc_html__( 'It looks like your site can not communicate properly with Jetpack.', 'jetpack' );
124
125
		remove_filter( 'http_request_timeout', array( 'Jetpack_Debugger', 'jetpack_increase_timeout' ) );
126
127
		?>
128
		<div class="wrap">
129
			<h2><?php esc_html_e( 'Jetpack Debugging Center', 'jetpack' ); ?></h2>
130
			<h3><?php _e( "Testing your site's compatibility with Jetpack...", 'jetpack' ); ?></h3>
131
			<div class="jetpack-debug-test-container">
132
			<?php
133
			ob_start();
134
			foreach ( $tests as $test_name => $test_info ) :
135
				if ( 'PASS' !== $test_info['result'] && ( is_wp_error( $test_info['result'] ) ||
136
					false == ( $response_code = wp_remote_retrieve_response_code( $test_info['result'] ) )  ||
137
					'200' != $response_code ) ) {
0 ignored issues
show
The variable $response_code 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...
138
					$debug_info .= $test_name . ": FAIL\r\n";
139
					?>
140
					<div class="jetpack-test-error">
141
						<p>
142
							<a class="jetpack-test-heading" href="#"><?php echo $test_info['fail_message']; ?>
143
							<span class="noticon noticon-collapse"></span>
144
							</a>
145
						</p>
146
						<pre class="jetpack-test-details"><?php echo esc_html( $test_name ); ?>:
147
	<?php echo esc_html( is_wp_error( $test_info['result'] ) ? $test_info['result']->get_error_message() : print_r( $test_info['result'], 1 ) ); ?></pre>
148
					</div><?php
149
				} else {
150
					$debug_info .= $test_name . ": PASS\r\n";
151
				}
152
				$debug_raw_info .= "\r\n\r\n" . $test_name . "\r\n" . esc_html( is_wp_error( $test_info['result'] ) ? $test_info['result']->get_error_message() : print_r( $test_info['result'], 1 ) );
153
				?>
154
			<?php endforeach;
155
			$html = ob_get_clean();
156
157
			if ( '' == trim( $html ) ) {
158
				echo '<div class="jetpack-tests-succed">' . esc_html__( 'Your Jetpack setup looks a-okay!', 'jetpack' ) . '</div>';
159
			}
160
			else {
161
				echo '<h3>' . esc_html__( 'There seems to be a problem with your site’s ability to communicate with Jetpack!', 'jetpack' ) . '</h3>';
162
				echo $html;
163
			}
164
			$debug_info .= "\r\n\r\nRAW TEST RESULTS:" . $debug_raw_info ."\r\n";
165
			?>
166
			</div>
167
			<div class="entry-content">
168
				<h3><?php esc_html_e( 'Trouble with Jetpack?', 'jetpack' ); ?></h3>
169
				<h4><?php esc_html_e( 'It may be caused by one of these issues, which you can diagnose yourself:', 'jetpack' ); ?></h4>
170
				<ol>
171
					<li><b><em><?php esc_html_e( 'A known issue.', 'jetpack' ); ?></em></b>  <?php echo sprintf( __( 'Some themes and plugins have <a href="%1$s" target="_blank">known conflicts</a> with Jetpack – check the <a href="%2$s" target="_blank">list</a>. (You can also browse the <a href="%3$s" target="_blank">Jetpack support pages</a> or <a href="%4$s" target="_blank">Jetpack support forum</a> to see if others have experienced and solved the problem.)', 'jetpack' ), 'http://jetpack.com/support/getting-started-with-jetpack/known-issues/', 'http://jetpack.com/support/getting-started-with-jetpack/known-issues/', 'http://jetpack.com/support/', 'http://wordpress.org/support/plugin/jetpack' ); ?></li>
172
					<li><b><em><?php esc_html_e( 'An incompatible plugin.', 'jetpack' ); ?></em></b>  <?php esc_html_e( "Find out by disabling all plugins except Jetpack. If the problem persists, it's not a plugin issue. If the problem is solved, turn your plugins on one by one until the problem pops up again – there's the culprit! Let us know, and we'll try to help.", 'jetpack' ); ?></li>
173
					<li>
174
						<b><em><?php esc_html_e( 'A theme conflict.', 'jetpack' ); ?></em></b>
175
						<?php
176
							$default_theme = wp_get_theme( WP_DEFAULT_THEME );
177
178
							if ( $default_theme->exists() ) {
179
								echo esc_html( sprintf( __( "If your problem isn't known or caused by a plugin, try activating %s (the default WordPress theme).", 'jetpack' ), $default_theme->get( 'Name' ) ) );
180
							} else {
181
								esc_html_e( "If your problem isn't known or caused by a plugin, try activating the default WordPress theme.", 'jetpack' );
182
							}
183
						?>
184
						<?php esc_html_e( "If this solves the problem, something in your theme is probably broken – let the theme's author know.", 'jetpack' ); ?>
185
					</li>
186
					<li><b><em><?php esc_html_e( 'A problem with your XMLRPC file.', 'jetpack' ); ?></em></b>  <?php echo sprintf( __( 'Load your <a href="%s">XMLRPC file</a>. It should say “XML-RPC server accepts POST requests only.” on a line by itself.', 'jetpack' ), site_url( 'xmlrpc.php' ) ); ?>
187
						<ul>
188
							<li>- <?php esc_html_e( "If it's not by itself, a theme or plugin is displaying extra characters. Try steps 2 and 3.", 'jetpack' ); ?></li>
189
							<li>- <?php esc_html_e( "If you get a 404 message, contact your web host. Their security may block XMLRPC.", 'jetpack' ); ?></li>
190
						</ul>
191
					</li>
192
				</ol>
193
				<?php if ( self::is_jetpack_support_open() ): ?>
194
				<p class="jetpack-show-contact-form"><?php echo sprintf( __( 'If none of these help you find a solution, <a href="%s">click here to contact Jetpack support</a>. Tell us as much as you can about the issue and what steps you\'ve tried to resolve it, and one of our Happiness Engineers will be in touch to help.', 'jetpack' ), Jetpack::admin_url( array( 'page' => 'jetpack-debugger', 'contact' => true ) ) ); ?>
195
				</p>
196
				<?php endif; ?>
197
				<?php if ( Jetpack::is_active() ) : ?>
198
					<hr />
199
					<div id="connected-user-details">
200
						<p><?php printf( __( 'The primary connection is owned by <strong>%s</strong>\'s WordPress.com account.', 'jetpack' ), esc_html( Jetpack::get_master_user_email() ) ); ?></p>
201
					</div>
202
					<hr />
203
					<div id="sync-related-posts">
204
						<p><?php echo esc_html__( 'Some features of Jetpack uses the WordPress.com infrastructure and requires that your public content be mirrored there. If you see intermittent issues only affecting certain posts, please try requesting a reindex of your posts.', 'jetpack' ); ?></p>
205
206
						<?php echo Jetpack_Sync_Reindex::reindex_ui(); ?>
207
					</div>
208
				<?php endif; ?>
209
			</div>
210
			<div id="contact-message" <?php if( ! isset( $_GET['contact'] ) ) {?>  style="display:none" <?php } ?>>
211
			<?php if ( self::is_jetpack_support_open() ): ?>
212
				<form id="contactme" method="post" action="http://jetpack.com/contact-support/">
213
					<input type="hidden" name="action" value="submit">
214
					<input type="hidden" name="jetpack" value="needs-service">
215
216
					<input type="hidden" name="contact_form" id="contact_form" value="1">
217
					<input type="hidden" name="blog_url" id="blog_url" value="<?php echo esc_attr( site_url() ); ?>">
218
					<?php
219
						$subject_line = sprintf(
220
							/* translators: %s is the URL of the site */
221
							_x( 'from: %s Jetpack contact form', 'Support request email subject line', 'jetpack' ),
222
							esc_attr( site_url() )
223
						);
224
225
						if ( Jetpack::is_development_version() ) {
226
							$subject_line = 'BETA ' . $subject_line;
227
						}
228
229
						$subject_line_input = printf(
0 ignored issues
show
$subject_line_input is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
230
							'<input type="hidden" name="subject" id="subject" value="%s"">',
231
							$subject_line
232
						);
233
					?>
234
					<div class="formbox">
235
						<label for="message" class="h"><?php esc_html_e( 'Please describe the problem you are having.', 'jetpack' ); ?></label>
236
						<textarea name="message" cols="40" rows="7" id="did"></textarea>
237
					</div>
238
239
					<div id="name_div" class="formbox">
240
						<label class="h" for="your_name"><?php esc_html_e( 'Name', 'jetpack' ); ?></label>
241
			  			<span class="errormsg"><?php esc_html_e( 'Let us know your name.', 'jetpack' ); ?></span>
242
						<input name="your_name" type="text" id="your_name" value="<?php esc_html_e( $current_user->display_name, 'jetpack'); ?>" size="40">
243
					</div>
244
245
					<div id="email_div" class="formbox">
246
						<label class="h" for="your_email"><?php esc_html_e( 'E-mail', 'jetpack' ); ?></label>
247
			  			<span class="errormsg"><?php esc_html_e( 'Use a valid email address.', 'jetpack' ); ?></span>
248
						<input name="your_email" type="text" id="your_email" value="<?php esc_html_e( $current_user->user_email, 'jetpack'); ?>" size="40">
249
					</div>
250
251
					<div id="toggle_debug_info" class="formbox">
252
						<p><?php _e( 'The test results and some other useful debug information will be sent to the support team. Please feel free to <a href="#">review/modify</a> this information.', 'jetpack' ); ?></p>
253
					</div>
254
255
					<div id="debug_info_div" class="formbox" style="display:none">
256
						<label class="h" for="debug_info"><?php esc_html_e( 'Debug Info', 'jetpack' ); ?></label>
257
			  			<textarea name="debug_info" cols="40" rows="7" id="debug_info"><?php echo esc_attr( $debug_info ); ?></textarea>
258
					</div>
259
260
					<div style="clear: both;"></div>
261
262
					<div id="blog_div" class="formbox">
263
						<div id="submit_div" class="contact-support">
264
						<input type="submit" name="submit" value="<?php esc_html_e( 'Submit &#187;', 'jetpack' ); ?>">
265
						</div>
266
					</div>
267
					<div style="clear: both;"></div>
268
				</form>
269
			<?php endif; ?>
270
			</div>
271
		</div>
272
	<?php
273
	}
274
275
	public static function jetpack_debug_admin_head() {
276
		?>
277
		<style type="text/css">
278
279
			.jetpack-debug-test-container {
280
				margin-top: 20px;
281
				margin-bottom: 30px;
282
			}
283
284
			.jetpack-tests-succed {
285
				font-size: large;
286
				color: #8BAB3E;
287
			}
288
289
			.jetpack-test-details {
290
				margin: 4px 6px;
291
				padding: 10px;
292
				overflow: auto;
293
				display: none;
294
			}
295
296
			.jetpack-test-error {
297
				margin-bottom: 10px;
298
				background: #FFEBE8;
299
				border: solid 1px #C00;
300
				border-radius: 3px;
301
			}
302
303
			.jetpack-test-error p {
304
				margin: 0;
305
				padding: 0;
306
			}
307
308
			.jetpack-test-error a.jetpack-test-heading {
309
				padding: 4px 6px;
310
				display: block;
311
				text-decoration: none;
312
				color: inherit;
313
			}
314
315
			.jetpack-test-error .noticon {
316
				float: right;
317
			}
318
319
			form#contactme {
320
				border: 1px solid #dfdfdf;
321
				background: #eaf3fa;
322
				padding: 20px;
323
				margin: 10px;
324
				background-color: #eaf3fa;
325
				border-radius: 5px;
326
				font-size: 15px;
327
				font-family: "Open Sans", "Helvetica Neue", sans-serif;
328
			}
329
330
			form#contactme label.h {
331
				color: #444;
332
				display: block;
333
				font-weight: bold;
334
				margin: 0 0 7px 10px;
335
				text-shadow: 1px 1px 0 #fff;
336
			}
337
338
			.formbox {
339
				margin: 0 0 25px 0;
340
			}
341
342
			.formbox input[type="text"], .formbox input[type="email"], .formbox input[type="url"], .formbox textarea {
343
				border: 1px solid #e5e5e5;
344
				border-radius: 11px;
345
				box-shadow: inset 0 1px 1px rgba(0,0,0,0.1);
346
				color: #666;
347
				font-size: 14px;
348
				padding: 10px;
349
				width: 97%;
350
			}
351
			.formbox .contact-support input[type="submit"] {
352
				float: right;
353
				margin: 0 !important;
354
				border-radius: 20px !important;
355
				cursor: pointer;
356
				font-size: 13pt !important;
357
				height: auto !important;
358
				margin: 0 0 2em 10px !important;
359
				padding: 8px 16px !important;
360
				background-color: #ddd;
361
				border: 1px solid rgba(0,0,0,0.05);
362
				border-top-color: rgba(255,255,255,0.1);
363
				border-bottom-color: rgba(0,0,0,0.15);
364
				color: #333;
365
				font-weight: 400;
366
				display: inline-block;
367
				text-align: center;
368
				text-decoration: none;
369
			}
370
371
			.formbox span.errormsg {
372
				margin: 0 0 10px 10px;
373
				color: #d00;
374
				display: none;
375
			}
376
377
			.formbox.error span.errormsg {
378
				display: block;
379
			}
380
381
			#contact-message ul {
382
				margin: 0 0 20px 10px;
383
			}
384
385
			#contact-message li {
386
				margin: 0 0 10px 10px;
387
				list-style: disc;
388
				display: list-item;
389
			}
390
391
		</style>
392
		<script type="text/javascript">
393
		jQuery( document ).ready( function($) {
394
395
			$('#debug_info').prepend('jQuery version: ' + jQuery.fn.jquery + "\r\n");
396
397
			$( '.jetpack-test-error .jetpack-test-heading' ).on( 'click', function() {
398
				$( this ).parents( '.jetpack-test-error' ).find( '.jetpack-test-details' ).slideToggle();
399
				return false;
400
			} );
401
402
			$( '.jetpack-show-contact-form a' ).on( 'click', function() {
403
				$('#contact-message').slideToggle();
404
				return false;
405
			} );
406
407
			$( '#toggle_debug_info a' ).on( 'click', function() {
408
				$('#debug_info_div').slideToggle();
409
				return false;
410
			} );
411
412
			$('form#contactme').on("submit", function(e){
413
				var form = $(this);
414
				var message = form.find('#did');
415
				var name = form.find('#your_name');
416
				var email = form.find('#your_email')
417
				var validation_error = false;
418
				if( !name.val() ) {
419
					name.parents('.formbox').addClass('error');
420
					validation_error = true;
421
				}
422
				if( !email.val() ) {
423
					email.parents('.formbox').addClass('error');
424
					validation_error = true;
425
				}
426
				if ( validation_error ) {
427
					return false;
428
				}
429
				message.val(message.val() + "\r\n\r\n----------------------------------------------\r\n\r\nDEBUG INFO:\r\n" + $('#debug_info').val()  );
430
				return true;
431
	    	});
432
433
		} );
434
		</script>
435
		<?php
436
	}
437
}
438