Completed
Push — fix_deploy_and_tests ( 9dcc80...ce15f8 )
by Armando
02:09
created

WP_To_Diaspora::_constants()   B

Complexity

Conditions 6
Paths 24

Size

Total Lines 10
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 10
rs 8.8571
c 0
b 0
f 0
cc 6
eloc 6
nc 24
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';
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
	private function __construct() {
76
	}
77
78
	/**
79
	 * Create / Get the instance of this class.
80
	 *
81
	 * @return WP_To_Diaspora Instance of this class.
82
	 */
83
	public static function instance() {
84
		echo 'before: '; var_dump(self::$_instance);
0 ignored issues
show
Security Debugging Code introduced by
var_dump(self::$_instance); looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data.
Loading history...
85
		if ( ! isset( self::$_instance ) ) {
86
			self::$_instance = new self();
87
			self::$_instance->_constants();
88
			if ( self::$_instance->_version_check() ) {
89
				self::$_instance->_includes();
90
				self::$_instance->_setup();
91
			} else {
92
				self::$_instance = null;
93
			}
94
		}
95
		echo 'after: '; var_dump(self::$_instance);
96
		return self::$_instance;
97
	}
98
99
	/**
100
	 * Define all the required constants.
101
	 *
102
	 * @since 1.5.0
103
	 */
104
	private function _constants() {
105
		// Are we in debugging mode?
106
		if ( isset( $_GET['debugging'] ) ) {
107
			defined( 'WP2D_DEBUGGING' ) || define( 'WP2D_DEBUGGING', true );
108
		}
109
110
		defined( 'WP2D_DIR' ) || define( 'WP2D_DIR', dirname( __FILE__ ) );
111
		defined( 'WP2D_LIB_DIR' ) || define( 'WP2D_LIB_DIR', WP2D_DIR . '/lib' );
112
		defined( 'WP2D_VENDOR_DIR' ) || define( 'WP2D_VENDOR_DIR', WP2D_DIR . '/vendor' );
113
	}
114
115
	/**
116
	 * Check the minimum WordPress and PHP requirements.
117
	 *
118
	 * @since 1.5.4
119
	 *
120
	 * @return bool If version requirements are met.
121
	 */
122
	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...
123
		// Check for version requirements.
124
		if ( version_compare( $GLOBALS['wp_version'], $this->_min_wp, '<' )
125
			|| version_compare( PHP_VERSION, $this->_min_php, '<' ) ) {
126
			add_action( 'admin_notices', array( $this, 'deactivate' ) );
127
			return false;
128
		}
129
130
		return true;
131
	}
132
133
	/**
134
	 * Callback to deactivate plugin and display admin notice.
135
	 *
136
	 * @since 1.5.4
137
	 */
138
	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...
139
		// First of all, deactivate the plugin.
140
		deactivate_plugins( plugin_basename( __FILE__ ) );
141
142
		// Get rid of the "Plugin activated" message.
143
		unset( $_GET['activate'] );
144
145
		// Then display the admin notice.
146
		?>
147
		<div class="error">
148
			<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>
149
		</div>
150
		<?php
151
	}
152
153
	/**
154
	 * Include all the required files.
155
	 *
156
	 * @since 1.5.0
157
	 */
158
	private function _includes() {
159
		require_once WP2D_VENDOR_DIR . '/autoload.php';
160
		require_once WP2D_LIB_DIR . '/class-api.php';
161
		require_once WP2D_LIB_DIR . '/class-contextual-help.php';
162
		require_once WP2D_LIB_DIR . '/class-helpers.php';
163
		require_once WP2D_LIB_DIR . '/class-options.php';
164
		require_once WP2D_LIB_DIR . '/class-post.php';
165
	}
166
167
	/**
168
	 * Set up the plugin.
169
	 */
170
	private function _setup() {
171
172
		// Load languages.
173
		add_action( 'plugins_loaded', array( $this, 'l10n' ) );
174
175
		// Add "Settings" link to plugin page.
176
		add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'settings_link' ) );
177
178
		// Perform any necessary data upgrades.
179
		add_action( 'admin_init', array( $this, 'upgrade' ) );
180
181
		// Enqueue CSS and JS scripts.
182
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_load_scripts' ) );
183
184
		// Set up the options.
185
		add_action( 'init', array( 'WP2D_Options', 'instance' ) );
186
187
		// WP2D Post.
188
		add_action( 'init', array( 'WP2D_Post', 'setup' ) );
189
190
		// AJAX actions for loading pods, aspects and services.
191
		add_action( 'wp_ajax_wp_to_diaspora_update_pod_list', array( $this, 'update_pod_list_callback' ) );
192
		add_action( 'wp_ajax_wp_to_diaspora_update_aspects_list', array( $this, 'update_aspects_list_callback' ) );
193
		add_action( 'wp_ajax_wp_to_diaspora_update_services_list', array( $this, 'update_services_list_callback' ) );
194
195
		// Check the pod connection status on the options page.
196
		add_action( 'wp_ajax_wp_to_diaspora_check_pod_connection_status', array( $this, 'check_pod_connection_status_callback' ) );
197
	}
198
199
	/**
200
	 * Load the diaspora* API for ease of use.
201
	 *
202
	 * @return WP2D_API|boolean The API object, or false.
203
	 */
204
	private function _load_api() {
205
		if ( ! isset( $this->_api ) ) {
206
			$this->_api = WP2D_Helpers::api_quick_connect();
207
		}
208
		return $this->_api;
209
	}
210
211
	/**
212
	 * Initialise upgrade sequence.
213
	 */
214
	public function upgrade() {
215
		// Get the current options, or assign defaults.
216
		$options = WP2D_Options::instance();
217
		$version = $options->get_option( 'version' );
218
219
		// If the versions differ, this is probably an update. Need to save updated options.
220
		if ( WP2D_VERSION !== $version ) {
221
222
			// Password is stored encrypted since version 1.2.7.
223
			// When upgrading to it, the plain text password is encrypted and saved again.
224
			if ( version_compare( $version, '1.2.7', '<' ) ) {
225
				$options->set_option( 'password', WP2D_Helpers::encrypt( (string) $options->get_option( 'password' ) ) );
226
			}
227
228
			if ( version_compare( $version, '1.3.0', '<' ) ) {
229
				// The 'user' setting is renamed to 'username'.
230
				$options->set_option( 'username', $options->get_option( 'user' ) );
231
				$options->set_option( 'user', null );
232
233
				// Save tags as arrays instead of comma seperated values.
234
				$global_tags = $options->get_option( 'global_tags' );
235
				$options->set_option( 'global_tags', $options->validate_tags( $global_tags ) );
236
			}
237
238
			if ( version_compare( $version, '1.4.0', '<' ) ) {
239
				// Turn tags_to_post string into an array.
240
				$tags_to_post_old = $options->get_option( 'tags_to_post' );
241
				$tags_to_post = array_filter( array(
242
					( ( false !== strpos( $tags_to_post_old, 'g' ) ) ? 'global' : null ),
243
					( ( false !== strpos( $tags_to_post_old, 'c' ) ) ? 'custom' : null ),
244
					( ( false !== strpos( $tags_to_post_old, 'p' ) ) ? 'post'   : null ),
245
				) );
246
				$options->set_option( 'tags_to_post', $tags_to_post );
247
			}
248
249
			// Update version.
250
			$options->set_option( 'version', WP2D_VERSION );
251
			$options->save();
252
		}
253
	}
254
255
	/**
256
	 * Set up i18n.
257
	 */
258
	public function l10n() {
259
		load_plugin_textdomain( 'wp-to-diaspora', false, 'wp-to-diaspora/languages' );
260
	}
261
262
	/**
263
	 * Load scripts and styles for Settings and Post pages of allowed post types.
264
	 */
265
	public function admin_load_scripts() {
266
		// Get the enabled post types to load the script for.
267
		$enabled_post_types = WP2D_Options::instance()->get_option( 'enabled_post_types', array() );
268
269
		// Get the screen to find out where we are.
270
		$screen = get_current_screen();
271
272
		// Only load the styles and scripts on the settings page and the allowed post types.
273
		if ( 'settings_page_wp_to_diaspora' === $screen->id || ( in_array( $screen->post_type, $enabled_post_types ) && 'post' === $screen->base ) ) {
274
			wp_enqueue_style( 'tag-it', plugins_url( '/css/jquery.tagit.css', __FILE__ ) );
275
			wp_enqueue_style( 'chosen', plugins_url( '/css/chosen.min.css', __FILE__ ) );
276
			wp_enqueue_style( 'wp-to-diaspora-admin', plugins_url( '/css/wp-to-diaspora.css', __FILE__ ) );
277
			wp_enqueue_script( 'chosen', plugins_url( '/js/chosen.jquery.min.js', __FILE__ ), array( 'jquery' ), false, true );
278
			wp_enqueue_script( 'tag-it', plugins_url( '/js/tag-it.min.js', __FILE__ ), array( 'jquery', 'jquery-ui-autocomplete' ), false, true );
279
			wp_enqueue_script( 'wp-to-diaspora-admin', plugins_url( '/js/wp-to-diaspora.js', __FILE__ ), array( 'jquery' ), false, true );
280
			// Javascript-specific l10n.
281
			wp_localize_script( 'wp-to-diaspora-admin', 'WP2DL10n', array(
282
				'no_services_connected' => __( 'No services connected yet.', 'wp-to-diaspora' ),
283
				'sure_reset_defaults'   => __( 'Are you sure you want to reset to default values?', 'wp-to-diaspora' ),
284
				'conn_testing'          => __( 'Testing connection...', 'wp-to-diaspora' ),
285
				'conn_successful'       => __( 'Connection successful.', 'wp-to-diaspora' ),
286
				'conn_failed'           => __( 'Connection failed.', 'wp-to-diaspora' ),
287
			) );
288
		}
289
	}
290
291
	/**
292
	 * Add the "Settings" link to the plugins page.
293
	 *
294
	 * @param array $links Links to display for plugin on plugins page.
295
	 * @return array Links to display for plugin on plugins page.
296
	 */
297
	public function settings_link( $links ) {
298
		$links[] = '<a href="' . admin_url( 'options-general.php?page=wp_to_diaspora' ) . '">' . __( 'Settings' ) . '</a>';
299
		return $links;
300
	}
301
302
	/**
303
	 * Fetch the updated list of pods from podupti.me and save it to the settings.
304
	 *
305
	 * @return array The list of pods.
306
	 */
307
	private function _update_pod_list() {
308
		// API url to fetch pods list from podupti.me.
309
		$pod_list_url = 'http://podupti.me/api.php?format=json&key=4r45tg';
310
		$pods = array();
311
312
		// Get the response from the WP_HTTP request.
313
		$response = wp_safe_remote_get( $pod_list_url );
314
315
		if ( $json = wp_remote_retrieve_body( $response ) ) {
316
			$pod_list = json_decode( $json );
317
318
			if ( isset( $pod_list->pods ) ) {
319
				foreach ( $pod_list->pods as $pod ) {
320
					if ( 'no' === $pod->hidden ) {
321
						$pods[] = array(
322
							'secure' => $pod->secure,
323
							'domain' => $pod->domain,
324
						);
325
					}
326
				}
327
328
				$options = WP2D_Options::instance();
329
				$options->set_option( 'pod_list', $pods );
330
				$options->save();
331
			}
332
		}
333
334
		return $pods;
335
	}
336
337
	/**
338
	 * Update the list of pods and return them for use with AJAX.
339
	 */
340
	public function update_pod_list_callback() {
341
		wp_send_json( $this->_update_pod_list() );
342
	}
343
344
	/**
345
	 * Fetch the list of aspects or services and save them to the settings.
346
	 *
347
	 * NOTE: When updating the lists, always force a fresh fetch.
348
	 *
349
	 * @param string $type Type of list to update.
350
	 * @return array|boolean The list of aspects or services, false if an illegal parameter is passed.
351
	 */
352
	private function _update_aspects_services_list( $type ) {
353
		// Check for correct argument value.
354
		if ( ! in_array( $type, array( 'aspects', 'services' ) ) ) {
355
			return false;
356
		}
357
358
		$options = WP2D_Options::instance();
359
		$list    = $options->get_option( $type . '_list' );
360
361
		// Make sure that we have at least the 'Public' aspect.
362
		if ( 'aspects' === $type && empty( $list ) ) {
363
			$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...
364
		}
365
366
		// Set up the connection to diaspora*.
367
		$api = $this->_load_api();
368
369
		// If there was a problem loading the API, return false.
370
		if ( $api->has_last_error() ) {
371
			return false;
372
		}
373
374
		if ( 'aspects' === $type ) {
375
			$list_new = $api->get_aspects( true );
376
		} elseif ( 'services' === $type ) {
377
			$list_new = $api->get_services( true );
378
		}
379
		// If the new list couldn't be fetched successfully, return false.
380
		if ( $api->has_last_error() ) {
381
			return false;
382
		}
383
384
		// We have a new list to save and return!
385
		$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...
386
		$options->save();
387
388
		return $list_new;
389
	}
390
391
	/**
392
	 * Update the list of aspects and return them for use with AJAX.
393
	 */
394
	public function update_aspects_list_callback() {
395
		wp_send_json( $this->_update_aspects_services_list( 'aspects' ) );
396
	}
397
398
	/**
399
	 * Update the list of services and return them for use with AJAX.
400
	 */
401
	public function update_services_list_callback() {
402
		wp_send_json( $this->_update_aspects_services_list( 'services' ) );
403
	}
404
405
	/**
406
	 * Check the pod connection status.
407
	 *
408
	 * @return string The status of the connection.
409
	 */
410
	private function _check_pod_connection_status() {
411
		$options = WP2D_Options::instance();
412
413
		$status = null;
414
415
		if ( $options->is_pod_set_up() ) {
416
			$status = ! $this->_load_api()->has_last_error();
417
		}
418
419
		return $status;
420
	}
421
422
	/**
423
	 * Check the connection to the pod and return the status for use with AJAX.
424
	 *
425
	 * @todo esc_html
426
	 */
427
	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...
428
		if ( isset( $_REQUEST['debugging'] ) && ! defined( 'WP2D_DEBUGGING' ) ) {
429
			define( 'WP2D_DEBUGGING', true );
430
		}
431
432
		$status = $this->_check_pod_connection_status();
433
434
		$data = array(
435
			'debug'   => esc_textarea( WP2D_Helpers::get_debugging() ),
436
			'message' => __( 'Connection successful.', 'wp-to-diaspora' ),
437
		);
438
439
		if ( true === $status ) {
440
			wp_send_json_success( $data );
441
		} elseif ( false === $status && $this->_load_api()->has_last_error() ) {
442
			$data['message'] = $this->_load_api()->get_last_error() . ' ' . WP2D_Contextual_Help::get_help_tab_quick_link( $this->_load_api()->get_last_error_object() );
443
			wp_send_json_error( $data );
444
		}
445
		// 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...
446
	}
447
}
448
449
// Get the party started!
450
WP_To_Diaspora::instance();
451