Completed
Push — branch-3.8 ( b1dba8...1c78dd )
by
unknown
66:30 queued 50:48
created

class.jetpack-debugger.php (1 issue)

Labels
Severity

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