Completed
Push — fix_deploy_and_tests ( a99aca...9a9946 )
by Armando
01:58
created

WP_To_Diaspora::_version_check()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 10
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 10
rs 9.4285
c 0
b 0
f 0
cc 3
eloc 6
nc 2
nop 0
1
<?php
2
/**
3
 * Plugin Name: WP to diaspora*
4
 * Plugin URI:  https://github.com/gutobenn/wp-to-diaspora
5
 * Description: Automatically shares WordPress posts on diaspora*
6
 * Version:     1.7.2
7
 * Author:      Augusto Bennemann
8
 * Author URI:  https://github.com/gutobenn
9
 * Text Domain: wp-to-diaspora
10
 * Domain Path: /languages
11
 *
12
 * Copyright 2014-2015 Augusto Bennemann (email: gutobenn at gmail.com)
13
 *
14
 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
15
 * General Public License as published by the Free Software Foundation; either version 2 of the License,
16
 * or (at your option) any later version.
17
 *
18
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
19
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20
 *
21
 * You should have received a copy of the GNU General Public License along with this program; if not, write
22
 * to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23
 *
24
 * @package   WP_To_Diaspora
25
 * @version   1.7.2
26
 * @author    Augusto Bennemann <[email protected]>
27
 * @copyright Copyright (c) 2015, Augusto Bennemann
28
 * @link      https://github.com/gutobenn/wp-to-diaspora
29
 * @license   https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
30
 */
31
32
// Exit if accessed directly.
33
defined( 'ABSPATH' ) || exit;
34
35
// Set the current version.
36
define( 'WP2D_VERSION', '1.7.2' );
37
38
/**
39
 * WP to diaspora* main plugin class.
40
 */
41
class WP_To_Diaspora {
42
43
	/**
44
	 * Only instance of this class.
45
	 *
46
	 * @var WP_To_Diaspora
47
	 */
48
	private static $_instance = null;
49
50
	/**
51
	 * The minimum required WordPress version.
52
	 *
53
	 * @since 1.5.4
54
	 *
55
	 * @var string
56
	 */
57
	private $_min_wp = '3.9.2-src';
58
59
	/**
60
	 * The minimum required PHP version.
61
	 *
62
	 * @since 1.5.4
63
	 *
64
	 * @var string
65
	 */
66
	private $_min_php = '5.3';
67
68
	/**
69
	 * Instance of the API class.
70
	 *
71
	 * @var WP2D_API
72
	 */
73
	private $_api = null;
74
75
	/**
76
	 * Create / Get the instance of this class.
77
	 *
78
	 * @return WP_To_Diaspora Instance of this class.
79
	 */
80
	public static function instance() {
81
		if ( ! isset( self::$_instance ) ) {
82
			self::$_instance = new self();
83
			if ( self::$_instance->_version_check() ) {
84
				self::$_instance->_constants();
85
				self::$_instance->_includes();
86
				self::$_instance->_setup();
87
			} else {
88
				self::$_instance = null;
89
			}
90
		}
91
92
		return self::$_instance;
93
	}
94
95
	/**
96
	 * Define all the required constants.
97
	 *
98
	 * @since 1.5.0
99
	 */
100
	private function _constants() {
101
		// Are we in debugging mode?
102
		if ( isset( $_GET['debugging'] ) ) {
103
			define( 'WP2D_DEBUGGING', true );
104
		}
105
106
		define( 'WP2D_DIR', dirname( __FILE__ ) );
107
		define( 'WP2D_LIB_DIR', WP2D_DIR . '/lib' );
108
		define( 'WP2D_VENDOR_DIR', WP2D_DIR . '/vendor' );
109
	}
110
111
	/**
112
	 * Check the minimum WordPress and PHP requirements.
113
	 *
114
	 * @since 1.5.4
115
	 *
116
	 * @return bool If version requirements are met.
117
	 */
118
	private function _version_check() {
0 ignored issues
show
Coding Style introduced by
_version_check uses the super-global variable $GLOBALS which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
119
		// Check for version requirements.
120
		if ( version_compare( $GLOBALS['wp_version'], $this->_min_wp, '<' )
121
			|| version_compare( PHP_VERSION, $this->_min_php, '<' ) ) {
122
			add_action( 'admin_notices', array( $this, 'deactivate' ) );
123
			return false;
124
		}
125
126
		return true;
127
	}
128
129
	/**
130
	 * Callback to deactivate plugin and display admin notice.
131
	 *
132
	 * @since 1.5.4
133
	 */
134
	public function deactivate() {
0 ignored issues
show
Coding Style introduced by
deactivate uses the super-global variable $GLOBALS which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
135
		// First of all, deactivate the plugin.
136
		deactivate_plugins( plugin_basename( __FILE__ ) );
137
138
		// Get rid of the "Plugin activated" message.
139
		unset( $_GET['activate'] );
140
141
		// Then display the admin notice.
142
		?>
143
		<div class="error">
144
			<p><?php echo esc_html( sprintf( 'WP to diaspora* requires at least WordPress %1$s (you have %2$s) and PHP %3$s (you have %4$s)!', $this->_min_wp, $GLOBALS['wp_version'], $this->_min_php, PHP_VERSION ) ); ?></p>
145
		</div>
146
		<?php
147
	}
148
149
	/**
150
	 * Include all the required files.
151
	 *
152
	 * @since 1.5.0
153
	 */
154
	private function _includes() {
155
		require_once WP2D_VENDOR_DIR . '/autoload.php';
156
		require_once WP2D_LIB_DIR . '/class-api.php';
157
		require_once WP2D_LIB_DIR . '/class-contextual-help.php';
158
		require_once WP2D_LIB_DIR . '/class-helpers.php';
159
		require_once WP2D_LIB_DIR . '/class-options.php';
160
		require_once WP2D_LIB_DIR . '/class-post.php';
161
	}
162
163
	/**
164
	 * Set up the plugin.
165
	 */
166
	private function _setup() {
167
168
		// Load languages.
169
		add_action( 'plugins_loaded', array( $this, 'l10n' ) );
170
171
		// Add "Settings" link to plugin page.
172
		add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'settings_link' ) );
173
174
		// Perform any necessary data upgrades.
175
		add_action( 'admin_init', array( $this, 'upgrade' ) );
176
177
		// Enqueue CSS and JS scripts.
178
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_load_scripts' ) );
179
180
		// Set up the options.
181
		add_action( 'init', array( 'WP2D_Options', 'instance' ) );
182
183
		// WP2D Post.
184
		add_action( 'init', array( 'WP2D_Post', 'setup' ) );
185
186
		// AJAX actions for loading pods, aspects and services.
187
		add_action( 'wp_ajax_wp_to_diaspora_update_pod_list', array( $this, 'update_pod_list_callback' ) );
188
		add_action( 'wp_ajax_wp_to_diaspora_update_aspects_list', array( $this, 'update_aspects_list_callback' ) );
189
		add_action( 'wp_ajax_wp_to_diaspora_update_services_list', array( $this, 'update_services_list_callback' ) );
190
191
		// Check the pod connection status on the options page.
192
		add_action( 'wp_ajax_wp_to_diaspora_check_pod_connection_status', array( $this, 'check_pod_connection_status_callback' ) );
193
	}
194
195
	/**
196
	 * Load the diaspora* API for ease of use.
197
	 *
198
	 * @return WP2D_API|boolean The API object, or false.
199
	 */
200
	private function _load_api() {
201
		if ( ! isset( $this->_api ) ) {
202
			$this->_api = WP2D_Helpers::api_quick_connect();
203
		}
204
		return $this->_api;
205
	}
206
207
	/**
208
	 * Initialise upgrade sequence.
209
	 */
210
	public function upgrade() {
211
		// Get the current options, or assign defaults.
212
		$options = WP2D_Options::instance();
213
		$version = $options->get_option( 'version' );
214
215
		// If the versions differ, this is probably an update. Need to save updated options.
216
		if ( WP2D_VERSION !== $version ) {
217
218
			// Password is stored encrypted since version 1.2.7.
219
			// When upgrading to it, the plain text password is encrypted and saved again.
220
			if ( version_compare( $version, '1.2.7', '<' ) ) {
221
				$options->set_option( 'password', WP2D_Helpers::encrypt( (string) $options->get_option( 'password' ) ) );
222
			}
223
224
			if ( version_compare( $version, '1.3.0', '<' ) ) {
225
				// The 'user' setting is renamed to 'username'.
226
				$options->set_option( 'username', $options->get_option( 'user' ) );
227
				$options->set_option( 'user', null );
228
229
				// Save tags as arrays instead of comma seperated values.
230
				$global_tags = $options->get_option( 'global_tags' );
231
				$options->set_option( 'global_tags', $options->validate_tags( $global_tags ) );
232
			}
233
234
			if ( version_compare( $version, '1.4.0', '<' ) ) {
235
				// Turn tags_to_post string into an array.
236
				$tags_to_post_old = $options->get_option( 'tags_to_post' );
237
				$tags_to_post = array_filter( array(
238
					( ( false !== strpos( $tags_to_post_old, 'g' ) ) ? 'global' : null ),
239
					( ( false !== strpos( $tags_to_post_old, 'c' ) ) ? 'custom' : null ),
240
					( ( false !== strpos( $tags_to_post_old, 'p' ) ) ? 'post'   : null ),
241
				) );
242
				$options->set_option( 'tags_to_post', $tags_to_post );
243
			}
244
245
			// Update version.
246
			$options->set_option( 'version', WP2D_VERSION );
247
			$options->save();
248
		}
249
	}
250
251
	/**
252
	 * Set up i18n.
253
	 */
254
	public function l10n() {
255
		load_plugin_textdomain( 'wp-to-diaspora', false, 'wp-to-diaspora/languages' );
256
	}
257
258
	/**
259
	 * Load scripts and styles for Settings and Post pages of allowed post types.
260
	 */
261
	public function admin_load_scripts() {
262
		// Get the enabled post types to load the script for.
263
		$enabled_post_types = WP2D_Options::instance()->get_option( 'enabled_post_types', array() );
264
265
		// Get the screen to find out where we are.
266
		$screen = get_current_screen();
267
268
		// Only load the styles and scripts on the settings page and the allowed post types.
269
		if ( 'settings_page_wp_to_diaspora' === $screen->id || ( in_array( $screen->post_type, $enabled_post_types ) && 'post' === $screen->base ) ) {
270
			wp_enqueue_style( 'tag-it', plugins_url( '/css/jquery.tagit.css', __FILE__ ) );
271
			wp_enqueue_style( 'chosen', plugins_url( '/css/chosen.min.css', __FILE__ ) );
272
			wp_enqueue_style( 'wp-to-diaspora-admin', plugins_url( '/css/wp-to-diaspora.css', __FILE__ ) );
273
			wp_enqueue_script( 'chosen', plugins_url( '/js/chosen.jquery.min.js', __FILE__ ), array( 'jquery' ), false, true );
274
			wp_enqueue_script( 'tag-it', plugins_url( '/js/tag-it.min.js', __FILE__ ), array( 'jquery', 'jquery-ui-autocomplete' ), false, true );
275
			wp_enqueue_script( 'wp-to-diaspora-admin', plugins_url( '/js/wp-to-diaspora.js', __FILE__ ), array( 'jquery' ), false, true );
276
			// Javascript-specific l10n.
277
			wp_localize_script( 'wp-to-diaspora-admin', 'WP2DL10n', array(
278
				'no_services_connected' => __( 'No services connected yet.', 'wp-to-diaspora' ),
279
				'sure_reset_defaults'   => __( 'Are you sure you want to reset to default values?', 'wp-to-diaspora' ),
280
				'conn_testing'          => __( 'Testing connection...', 'wp-to-diaspora' ),
281
				'conn_successful'       => __( 'Connection successful.', 'wp-to-diaspora' ),
282
				'conn_failed'           => __( 'Connection failed.', 'wp-to-diaspora' ),
283
			) );
284
		}
285
	}
286
287
	/**
288
	 * Add the "Settings" link to the plugins page.
289
	 *
290
	 * @param array $links Links to display for plugin on plugins page.
291
	 * @return array Links to display for plugin on plugins page.
292
	 */
293
	public function settings_link( $links ) {
294
		$links[] = '<a href="' . admin_url( 'options-general.php?page=wp_to_diaspora' ) . '">' . __( 'Settings' ) . '</a>';
295
		return $links;
296
	}
297
298
	/**
299
	 * Fetch the updated list of pods from podupti.me and save it to the settings.
300
	 *
301
	 * @return array The list of pods.
302
	 */
303
	private function _update_pod_list() {
304
		// API url to fetch pods list from podupti.me.
305
		$pod_list_url = 'http://podupti.me/api.php?format=json&key=4r45tg';
306
		$pods = array();
307
308
		// Get the response from the WP_HTTP request.
309
		$response = wp_safe_remote_get( $pod_list_url );
310
311
		if ( $json = wp_remote_retrieve_body( $response ) ) {
312
			$pod_list = json_decode( $json );
313
314
			if ( isset( $pod_list->pods ) ) {
315
				foreach ( $pod_list->pods as $pod ) {
316
					if ( 'no' === $pod->hidden ) {
317
						$pods[] = array(
318
							'secure' => $pod->secure,
319
							'domain' => $pod->domain,
320
						);
321
					}
322
				}
323
324
				$options = WP2D_Options::instance();
325
				$options->set_option( 'pod_list', $pods );
326
				$options->save();
327
			}
328
		}
329
330
		return $pods;
331
	}
332
333
	/**
334
	 * Update the list of pods and return them for use with AJAX.
335
	 */
336
	public function update_pod_list_callback() {
337
		wp_send_json( $this->_update_pod_list() );
338
	}
339
340
	/**
341
	 * Fetch the list of aspects or services and save them to the settings.
342
	 *
343
	 * NOTE: When updating the lists, always force a fresh fetch.
344
	 *
345
	 * @param string $type Type of list to update.
346
	 * @return array|boolean The list of aspects or services, false if an illegal parameter is passed.
347
	 */
348
	private function _update_aspects_services_list( $type ) {
349
		// Check for correct argument value.
350
		if ( ! in_array( $type, array( 'aspects', 'services' ) ) ) {
351
			return false;
352
		}
353
354
		$options = WP2D_Options::instance();
355
		$list    = $options->get_option( $type . '_list' );
356
357
		// Make sure that we have at least the 'Public' aspect.
358
		if ( 'aspects' === $type && empty( $list ) ) {
359
			$list = array( 'public' => __( 'Public' ) );
0 ignored issues
show
Unused Code introduced by
$list 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...
360
		}
361
362
		// Set up the connection to diaspora*.
363
		$api = $this->_load_api();
364
365
		// If there was a problem loading the API, return false.
366
		if ( $api->has_last_error() ) {
367
			return false;
368
		}
369
370
		if ( 'aspects' === $type ) {
371
			$list_new = $api->get_aspects( true );
372
		} elseif ( 'services' === $type ) {
373
			$list_new = $api->get_services( true );
374
		}
375
		// If the new list couldn't be fetched successfully, return false.
376
		if ( $api->has_last_error() ) {
377
			return false;
378
		}
379
380
		// We have a new list to save and return!
381
		$options->set_option( $type . '_list', $list_new );
0 ignored issues
show
Bug introduced by
The variable $list_new 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...
382
		$options->save();
383
384
		return $list_new;
385
	}
386
387
	/**
388
	 * Update the list of aspects and return them for use with AJAX.
389
	 */
390
	public function update_aspects_list_callback() {
391
		wp_send_json( $this->_update_aspects_services_list( 'aspects' ) );
392
	}
393
394
	/**
395
	 * Update the list of services and return them for use with AJAX.
396
	 */
397
	public function update_services_list_callback() {
398
		wp_send_json( $this->_update_aspects_services_list( 'services' ) );
399
	}
400
401
	/**
402
	 * Check the pod connection status.
403
	 *
404
	 * @return string The status of the connection.
405
	 */
406
	private function _check_pod_connection_status() {
407
		$options = WP2D_Options::instance();
408
409
		$status = null;
410
411
		if ( $options->is_pod_set_up() ) {
412
			$status = ! $this->_load_api()->has_last_error();
413
		}
414
415
		return $status;
416
	}
417
418
	/**
419
	 * Check the connection to the pod and return the status for use with AJAX.
420
	 *
421
	 * @todo esc_html
422
	 */
423
	public function check_pod_connection_status_callback() {
0 ignored issues
show
Coding Style introduced by
check_pod_connection_status_callback uses the super-global variable $_REQUEST which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
424
		if ( isset( $_REQUEST['debugging'] ) && ! defined( 'WP2D_DEBUGGING' ) ) {
425
			define( 'WP2D_DEBUGGING', true );
426
		}
427
428
		$status = $this->_check_pod_connection_status();
429
430
		$data = array(
431
			'debug'   => esc_textarea( WP2D_Helpers::get_debugging() ),
432
			'message' => __( 'Connection successful.', 'wp-to-diaspora' ),
433
		);
434
435
		if ( true === $status ) {
436
			wp_send_json_success( $data );
437
		} elseif ( false === $status && $this->_load_api()->has_last_error() ) {
438
			$data['message'] = $this->_load_api()->get_last_error() . ' ' . WP2D_Contextual_Help::get_help_tab_quick_link( $this->_load_api()->get_last_error_object() );
439
			wp_send_json_error( $data );
440
		}
441
		// If $status === null, do nothing.
0 ignored issues
show
Unused Code Comprehensibility introduced by
36% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
442
	}
443
}
444
445
// Get the party started!
446
WP_To_Diaspora::instance();
447