Completed
Push — add/sync-action ( 3fb8dd...a8e01b )
by
unknown
08:54
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
4
class Jetpack_Debugger {
5
6
	private static function is_jetpack_support_open() {
7
		try {
8
			$response = wp_remote_request( "http://jetpack.com/is-support-open" );
9
			$body = wp_remote_retrieve_body( $response );
10
			$json = json_decode( $body );
11
			return ( ( bool ) $json->is_support_open );
12
		}
13
		catch ( Exception $e ) {
14
			return true;
15
		}
16
	}
17
18
	public static function jetpack_increase_timeout() {
19
		return 30; // seconds
20
	}
21
22
	public static function jetpack_debug_display_handler() {
23
		if ( ! current_user_can( 'manage_options' ) )
24
			wp_die( esc_html__('You do not have sufficient permissions to access this page.', 'jetpack' ) );
25
26
		$current_user = wp_get_current_user();
27
28
		$user_id = get_current_user_id();
29
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
30
		if ( is_array( $user_tokens ) && array_key_exists( $user_id, $user_tokens ) ) {
31
			$user_token = $user_tokens[$user_id];
32
		} else {
33
			$user_token = '[this user has no token]';
34
		}
35
		unset( $user_tokens );
36
37
		$debug_info = "\r\n";
38
		foreach ( array(
39
			'CLIENT_ID'   => 'id',
40
			'BLOG_TOKEN'  => 'blog_token',
41
			'MASTER_USER' => 'master_user',
42
			'CERT'        => 'fallback_no_verify_ssl_certs',
43
			'TIME_DIFF'   => 'time_diff',
44
			'VERSION'     => 'version',
45
			'OLD_VERSION' => 'old_version',
46
			'PUBLIC'      => 'public',
47
		) as $label => $option_name ) {
48
			$debug_info .= "\r\n" . esc_html( $label . ": " . Jetpack_Options::get_option( $option_name ) );
49
		}
50
51
		$debug_info .= "\r\n" . esc_html( "USER_ID: " . $user_id );
52
		$debug_info .= "\r\n" . esc_html( "USER_TOKEN: " . $user_token );
53
		$debug_info .= "\r\n" . esc_html( "PHP_VERSION: " . PHP_VERSION );
54
		$debug_info .= "\r\n" . esc_html( "WORDPRESS_VERSION: " . $GLOBALS['wp_version'] );
55
		$debug_info .= "\r\n" . esc_html( "JETPACK__VERSION: " . JETPACK__VERSION );
56
		$debug_info .= "\r\n" . esc_html( "JETPACK__PLUGIN_DIR: " . JETPACK__PLUGIN_DIR );
57
		$debug_info .= "\r\n" . esc_html( "SITE_URL: " . site_url() );
58
		$debug_info .= "\r\n" . esc_html( "HOME_URL: " . home_url() );
59
		$debug_info .= "\r\n" . esc_html( "SERVER_PORT: " . $_SERVER['SERVER_PORT'] );
60
61
62
		foreach ( array (
63
					  'GD_PHP_HANDLER',
64
					  'HTTP_AKAMAI_ORIGIN_HOP',
65
					  'HTTP_CF_CONNECTING_IP',
66
					  'HTTP_CLIENT_IP',
67
					  'HTTP_FASTLY_CLIENT_IP',
68
					  'HTTP_FORWARDED',
69
					  'HTTP_FORWARDED_FOR',
70
					  'HTTP_INCAP_CLIENT_IP',
71
					  'HTTP_TRUE_CLIENT_IP',
72
					  'HTTP_X_CLIENTIP',
73
					  'HTTP_X_CLUSTER_CLIENT_IP',
74
					  'HTTP_X_FORWARDED',
75
					  'HTTP_X_FORWARDED_FOR',
76
					  'HTTP_X_IP_TRAIL',
77
					  'HTTP_X_REAL_IP',
78
					  'HTTP_X_VARNISH',
79
					  'REMOTE_ADDR'
80
				  ) as $header ) {
81
			if( isset( $_SERVER[$header] ) ) {
82
				$debug_info .= "\r\n" . esc_html( 'IP HEADER: '.$header . ": " . $_SERVER[$header] );
83
			} else {
84
				$debug_info .= "\r\n" . esc_html( 'IP HEADER: '.$header . ": Not Set" );
85
			}
86
		}
87
88
89
		$debug_info .= "\r\n" . esc_html( "PROTECT_TRUSTED_HEADER: " . json_encode(get_site_option( 'trusted_ip_header' )));
90
91
		$debug_info .= "\r\n\r\nTEST RESULTS:\r\n\r\n";
92
		$debug_raw_info = '';
93
94
95
		$tests = array();
96
97
		$tests['HTTP']['result'] = wp_remote_get( preg_replace( '/^https:/', 'http:', JETPACK__API_BASE ) . 'test/1/' );
98
		$tests['HTTP']['fail_message'] = esc_html__( 'Your site isn’t reaching the Jetpack servers.', 'jetpack' );
99
100
		$tests['HTTPS']['result'] = wp_remote_get( preg_replace( '/^http:/', 'https:', JETPACK__API_BASE ) . 'test/1/' );
101
		$tests['HTTPS']['fail_message'] = esc_html__( 'Your site isn’t securely reaching the Jetpack servers.', 'jetpack' );
102
103
		$identity_crisis_message = '';
104
		if ( $identity_crisis = Jetpack::check_identity_crisis( true ) ) {
105
			foreach( $identity_crisis as $key => $value ) {
106
				$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";
107
			}
108
			$identity_crisis = new WP_Error( 'identity-crisis', $identity_crisis_message, $identity_crisis );
109
		} else {
110
			$identity_crisis = 'PASS';
111
		}
112
		$tests['IDENTITY_CRISIS']['result'] = $identity_crisis;
113
		$tests['IDENTITY_CRISIS']['fail_message'] = esc_html__( 'Something has gotten mixed up in your Jetpack Connection!', 'jetpack' );
114
115
		$self_xml_rpc_url = home_url( 'xmlrpc.php' );
116
117
		$testsite_url = Jetpack::fix_url_for_bad_hosts( JETPACK__API_BASE . 'testsite/1/?url=' );
118
119
		add_filter( 'http_request_timeout', array( 'Jetpack_Debugger', 'jetpack_increase_timeout' ) );
120
121
		$tests['SELF']['result'] = wp_remote_get( $testsite_url . $self_xml_rpc_url );
122
		$tests['SELF']['fail_message'] = esc_html__( 'It looks like your site can not communicate properly with Jetpack.', 'jetpack' );
123
124
		remove_filter( 'http_request_timeout', array( 'Jetpack_Debugger', 'jetpack_increase_timeout' ) );
125
126
		?>
127
		<div class="wrap">
128
			<h2><?php esc_html_e( 'Jetpack Debugging Center', 'jetpack' ); ?></h2>
129
			<h3><?php _e( "Testing your site's compatibility with Jetpack...", 'jetpack' ); ?></h3>
130
			<div class="jetpack-debug-test-container">
131
			<?php
132
			ob_start();
133
			foreach ( $tests as $test_name => $test_info ) :
134
				if ( 'PASS' !== $test_info['result'] && ( is_wp_error( $test_info['result'] ) ||
135
					false == ( $response_code = wp_remote_retrieve_response_code( $test_info['result'] ) )  ||
136
					'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...
137
					$debug_info .= $test_name . ": FAIL\r\n";
138
					?>
139
					<div class="jetpack-test-error">
140
						<p>
141
							<a class="jetpack-test-heading" href="#"><?php echo $test_info['fail_message']; ?>
142
							<span class="noticon noticon-collapse"></span>
143
							</a>
144
						</p>
145
						<pre class="jetpack-test-details"><?php echo esc_html( $test_name ); ?>:
146
	<?php echo esc_html( is_wp_error( $test_info['result'] ) ? $test_info['result']->get_error_message() : print_r( $test_info['result'], 1 ) ); ?></pre>
147
					</div><?php
148
				} else {
149
					$debug_info .= $test_name . ": PASS\r\n";
150
				}
151
				$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 ) );
152
				?>
153
			<?php endforeach;
154
			$html = ob_get_clean();
155
156
			if ( '' == trim( $html ) ) {
157
				echo '<div class="jetpack-tests-succed">' . esc_html__( 'Your Jetpack setup looks a-okay!', 'jetpack' ) . '</div>';
158
			}
159
			else {
160
				echo '<h3>' . esc_html__( 'There seems to be a problem with your site’s ability to communicate with Jetpack!', 'jetpack' ) . '</h3>';
161
				echo $html;
162
			}
163
			$debug_info .= "\r\n\r\nRAW TEST RESULTS:" . $debug_raw_info ."\r\n";
164
			?>
165
			</div>
166
			<div class="entry-content">
167
				<h3><?php esc_html_e( 'Trouble with Jetpack?', 'jetpack' ); ?></h3>
168
				<h4><?php esc_html_e( 'It may be caused by one of these issues, which you can diagnose yourself:', 'jetpack' ); ?></h4>
169
				<ol>
170
					<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>
171
					<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>
172
					<li>
173
						<b><em><?php esc_html_e( 'A theme conflict.', 'jetpack' ); ?></em></b>
174
						<?php
175
							$default_theme = wp_get_theme( WP_DEFAULT_THEME );
176
177
							if ( $default_theme->exists() ) {
178
								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' ) ) );
179
							} else {
180
								esc_html_e( "If your problem isn't known or caused by a plugin, try activating the default WordPress theme.", 'jetpack' );
181
							}
182
						?>
183
						<?php esc_html_e( "If this solves the problem, something in your theme is probably broken – let the theme's author know.", 'jetpack' ); ?>
184
					</li>
185
					<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' ) ); ?>
186
						<ul>
187
							<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>
188
							<li>- <?php esc_html_e( "If you get a 404 message, contact your web host. Their security may block XMLRPC.", 'jetpack' ); ?></li>
189
						</ul>
190
					</li>
191
				</ol>
192
				<?php if ( self::is_jetpack_support_open() ): ?>
193
				<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 ) ) ); ?>
194
				</p>
195
				<?php endif; ?>
196
				<?php if ( Jetpack::is_active() ) : ?>
197
					<hr />
198
					<div id="connected-user-details">
199
						<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>
200
					</div>
201
					<hr />
202
					<div id="sync-related-posts">
203
						<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>
204
205
						<?php echo Jetpack_Sync_Reindex::reindex_ui(); ?>
206
					</div>
207
				<?php endif; ?>
208
			</div>
209
			<div id="contact-message" <?php if( ! isset( $_GET['contact'] ) ) {?>  style="display:none" <?php } ?>>
210
			<?php if ( self::is_jetpack_support_open() ): ?>
211
				<form id="contactme" method="post" action="http://jetpack.com/contact-support/">
212
					<input type="hidden" name="action" value="submit">
213
					<input type="hidden" name="jetpack" value="needs-service">
214
215
					<input type="hidden" name="contact_form" id="contact_form" value="1">
216
					<input type="hidden" name="blog_url" id="blog_url" value="<?php echo esc_attr( site_url() ); ?>">
217
					<?php
218
						$subject_line = sprintf(
219
							/* translators: %s is the URL of the site */
220
							_x( 'from: %s Jetpack contact form', 'Support request email subject line', 'jetpack' ),
221
							esc_attr( site_url() )
222
						);
223
224
						if ( Jetpack::is_development_version() ) {
225
							$subject_line = 'BETA ' . $subject_line;
226
						}
227
228
						$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...
229
							'<input type="hidden" name="subject" id="subject" value="%s"">',
230
							$subject_line
231
						);
232
					?>
233
					<div class="formbox">
234
						<label for="message" class="h"><?php esc_html_e( 'Please describe the problem you are having.', 'jetpack' ); ?></label>
235
						<textarea name="message" cols="40" rows="7" id="did"></textarea>
236
					</div>
237
238
					<div id="name_div" class="formbox">
239
						<label class="h" for="your_name"><?php esc_html_e( 'Name', 'jetpack' ); ?></label>
240
			  			<span class="errormsg"><?php esc_html_e( 'Let us know your name.', 'jetpack' ); ?></span>
241
						<input name="your_name" type="text" id="your_name" value="<?php esc_html_e( $current_user->display_name, 'jetpack'); ?>" size="40">
242
					</div>
243
244
					<div id="email_div" class="formbox">
245
						<label class="h" for="your_email"><?php esc_html_e( 'E-mail', 'jetpack' ); ?></label>
246
			  			<span class="errormsg"><?php esc_html_e( 'Use a valid email address.', 'jetpack' ); ?></span>
247
						<input name="your_email" type="text" id="your_email" value="<?php esc_html_e( $current_user->user_email, 'jetpack'); ?>" size="40">
248
					</div>
249
250
					<div id="toggle_debug_info" class="formbox">
251
						<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>
252
					</div>
253
254
					<div id="debug_info_div" class="formbox" style="display:none">
255
						<label class="h" for="debug_info"><?php esc_html_e( 'Debug Info', 'jetpack' ); ?></label>
256
			  			<textarea name="debug_info" cols="40" rows="7" id="debug_info"><?php echo esc_attr( $debug_info ); ?></textarea>
257
					</div>
258
259
					<div style="clear: both;"></div>
260
261
					<div id="blog_div" class="formbox">
262
						<div id="submit_div" class="contact-support">
263
						<input type="submit" name="submit" value="<?php esc_html_e( 'Submit &#187;', 'jetpack' ); ?>">
264
						</div>
265
					</div>
266
					<div style="clear: both;"></div>
267
				</form>
268
			<?php endif; ?>
269
			</div>
270
		</div>
271
	<?php
272
	}
273
274
	public static function jetpack_debug_admin_head() {
275
		?>
276
		<style type="text/css">
277
278
			.jetpack-debug-test-container {
279
				margin-top: 20px;
280
				margin-bottom: 30px;
281
			}
282
283
			.jetpack-tests-succed {
284
				font-size: large;
285
				color: #8BAB3E;
286
			}
287
288
			.jetpack-test-details {
289
				margin: 4px 6px;
290
				padding: 10px;
291
				overflow: auto;
292
				display: none;
293
			}
294
295
			.jetpack-test-error {
296
				margin-bottom: 10px;
297
				background: #FFEBE8;
298
				border: solid 1px #C00;
299
				border-radius: 3px;
300
			}
301
302
			.jetpack-test-error p {
303
				margin: 0;
304
				padding: 0;
305
			}
306
307
			.jetpack-test-error a.jetpack-test-heading {
308
				padding: 4px 6px;
309
				display: block;
310
				text-decoration: none;
311
				color: inherit;
312
			}
313
314
			.jetpack-test-error .noticon {
315
				float: right;
316
			}
317
318
			form#contactme {
319
				border: 1px solid #dfdfdf;
320
				background: #eaf3fa;
321
				padding: 20px;
322
				margin: 10px;
323
				background-color: #eaf3fa;
324
				border-radius: 5px;
325
				font-size: 15px;
326
				font-family: "Open Sans", "Helvetica Neue", sans-serif;
327
			}
328
329
			form#contactme label.h {
330
				color: #444;
331
				display: block;
332
				font-weight: bold;
333
				margin: 0 0 7px 10px;
334
				text-shadow: 1px 1px 0 #fff;
335
			}
336
337
			.formbox {
338
				margin: 0 0 25px 0;
339
			}
340
341
			.formbox input[type="text"], .formbox input[type="email"], .formbox input[type="url"], .formbox textarea {
342
				border: 1px solid #e5e5e5;
343
				border-radius: 11px;
344
				box-shadow: inset 0 1px 1px rgba(0,0,0,0.1);
345
				color: #666;
346
				font-size: 14px;
347
				padding: 10px;
348
				width: 97%;
349
			}
350
			.formbox .contact-support input[type="submit"] {
351
				float: right;
352
				margin: 0 !important;
353
				border-radius: 20px !important;
354
				cursor: pointer;
355
				font-size: 13pt !important;
356
				height: auto !important;
357
				margin: 0 0 2em 10px !important;
358
				padding: 8px 16px !important;
359
				background-color: #ddd;
360
				border: 1px solid rgba(0,0,0,0.05);
361
				border-top-color: rgba(255,255,255,0.1);
362
				border-bottom-color: rgba(0,0,0,0.15);
363
				color: #333;
364
				font-weight: 400;
365
				display: inline-block;
366
				text-align: center;
367
				text-decoration: none;
368
			}
369
370
			.formbox span.errormsg {
371
				margin: 0 0 10px 10px;
372
				color: #d00;
373
				display: none;
374
			}
375
376
			.formbox.error span.errormsg {
377
				display: block;
378
			}
379
380
			#contact-message ul {
381
				margin: 0 0 20px 10px;
382
			}
383
384
			#contact-message li {
385
				margin: 0 0 10px 10px;
386
				list-style: disc;
387
				display: list-item;
388
			}
389
390
		</style>
391
		<script type="text/javascript">
392
		jQuery( document ).ready( function($) {
393
394
			$('#debug_info').prepend('jQuery version: ' + jQuery.fn.jquery + "\r\n");
395
396
			$( '.jetpack-test-error .jetpack-test-heading' ).on( 'click', function() {
397
				$( this ).parents( '.jetpack-test-error' ).find( '.jetpack-test-details' ).slideToggle();
398
				return false;
399
			} );
400
401
			$( '.jetpack-show-contact-form a' ).on( 'click', function() {
402
				$('#contact-message').slideToggle();
403
				return false;
404
			} );
405
406
			$( '#toggle_debug_info a' ).on( 'click', function() {
407
				$('#debug_info_div').slideToggle();
408
				return false;
409
			} );
410
411
			$('form#contactme').on("submit", function(e){
412
				var form = $(this);
413
				var message = form.find('#did');
414
				var name = form.find('#your_name');
415
				var email = form.find('#your_email')
416
				var validation_error = false;
417
				if( !name.val() ) {
418
					name.parents('.formbox').addClass('error');
419
					validation_error = true;
420
				}
421
				if( !email.val() ) {
422
					email.parents('.formbox').addClass('error');
423
					validation_error = true;
424
				}
425
				if ( validation_error ) {
426
					return false;
427
				}
428
				message.val(message.val() + "\r\n\r\n----------------------------------------------\r\n\r\nDEBUG INFO:\r\n" + $('#debug_info').val()  );
429
				return true;
430
	    	});
431
432
		} );
433
		</script>
434
		<?php
435
	}
436
}
437