/
wds-rest-connect-ui.php
384 lines (338 loc) · 9.51 KB
/
wds-rest-connect-ui.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<?php
/**
* Plugin Name: WDS WP REST API Connect UI
* Plugin URI: http://webdevstudios.com
* Description: Provides UI for connecting from one WordPress installation to another via the WP REST API over <a href="https://github.com/WP-API/OAuth1">OAuth1</a>
* Version: 0.2.5
* Author: WebDevStudios
* Author URI: http://webdevstudios.com
* Donate link: http://webdevstudios.com
* License: GPLv2
* Text Domain: wds-rest-connect-ui
* Domain Path: /languages
*/
/**
* Copyright (c) 2015 WebDevStudios (email : contact@webdevstudios.com)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2 or, at
* your discretion, any later version, as published by the Free
* Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* Built using generator-plugin-wp
*/
// include composer autoloader (make sure you run `composer install`!)
require_once WDS_REST_Connect_UI::dir( 'vendor/autoload.php' );
/**
* Main initiation class
*
* @since 0.1.0
* @var string $version Plugin version
* @var string $basename Plugin basename
* @var string $url Plugin URL
* @var string $path Plugin Path
*/
class WDS_REST_Connect_UI {
/**
* Current version
*
* @var string
* @since 0.1.0
*/
const VERSION = '0.2.5';
/**
* Plugin basename
*
* @var string
* @since 0.1.0
*/
protected $basename = '';
/**
* URL of plugin directory
*
* @var string
* @since 0.1.0
*/
protected $url = '';
/**
* Path of plugin directory
*
* @var string
* @since 0.1.0
*/
protected $path = '';
/**
* Error message if plugin cannot be activated.
*
* @var string
* @since 0.1.0
*/
protected $activation_error = '';
/**
* Whether plugin should operate on the network settings level.
* Enabled via the WDSRESTCUI_NETWORK_SETTINGS constant
*
* @var bool
* @since 0.1.0
*/
protected $is_network = false;
/**
* Singleton instance of plugin
*
* @var WDS_REST_Connect_UI
* @since 0.1.0
*/
protected static $single_instance = null;
/**
* Instance of WDSRESTCUI_Settings
*
* @var WDSRESTCUI_Settings
*/
protected $settings;
/**
* Instance of WDSRESTCUI_Compatibility, an abstraction layer for Connect
*
* @var WDSRESTCUI_Compatibility
*/
protected $api;
/**
* Creates or returns an instance of this class.
*
* @since 0.1.0
* @return WDS_REST_Connect_UI A single instance of this class.
*/
public static function get_instance() {
if ( null === self::$single_instance ) {
self::$single_instance = new self();
}
return self::$single_instance;
}
/**
* Sets up our plugin
*
* @since 0.1.0
*/
protected function __construct() {
$this->basename = plugin_basename( __FILE__ );
$this->url = plugin_dir_url( __FILE__ );
$this->path = plugin_dir_path( __FILE__ );
$this->is_network = apply_filters( 'wds_rest_connect_ui_is_network', defined( 'WDSRESTCUI_NETWORK_SETTINGS' ) );
$this->plugin_classes();
}
/**
* Attach other plugin classes to the base plugin class.
*
* @since 0.1.0
* @return void
*/
public function plugin_classes() {
$storage_classes = $this->is_network ? array(
'options_class' => 'WDSRESTCUI_Storage_Options',
'transients_class' => 'WDSRESTCUI_Storage_Transients',
) : array();
$this->api = new WDS_WP_REST_API\OAuth1\Connect( $storage_classes );
$class = $this->is_network ? 'WDSRESTCUI_Network_Settings' : 'WDSRESTCUI_Settings';
$this->settings = new $class( $this->basename, $this->api );
} // END OF PLUGIN CLASSES FUNCTION
/**
* Add hooks and filters
*
* @since 0.1.0
* @return void
*/
public function hooks() {
add_action( 'plugins_loaded', array( $this, 'init' ) );
$this->settings->hooks();
}
/**
* Init hooks
*
* @since 0.1.0
* @return void
*/
public function init() {
if ( $this->check_requirements() ) {
load_plugin_textdomain( 'wds-rest-connect-ui', false, dirname( $this->basename ) . '/languages/' );
}
}
/**
* Check that all plugin requirements are met
*
* @since 0.1.0
* @return boolean
*/
public function meets_requirements() {
// Plugin requires CMB2
if ( ! defined( 'CMB2_LOADED' ) ) {
$this->activation_error = sprintf( __( 'WDS WP REST API Connect UI requires the <a href="https://wordpress.org/plugins/cmb2/">CMB2 plugin</a>, so it has been <a href="%s">deactivated</a>.', 'wds-network-require-login' ), admin_url( 'plugins.php' ) );
return false;
}
// If network-level, but not network-activated, it fails
if ( $this->is_network && ! is_plugin_active_for_network( $this->basename ) ) {
$this->activation_error = sprintf( __( "WDS WP REST API Connect UI has been designated as a network-only plugin (via the <code>'wds_rest_connect_ui_is_network'</code> filter or the <code>'WDSRESTCUI_NETWORK_SETTINGS'</code> constant), so it has been <a href=\"%s\">deactivated</a>. Please try network-activating.", 'wds-network-require-login' ), admin_url( 'plugins.php' ) );
return false;
}
return true;
}
/**
* Check if the plugin meets requirements and
* disable it if they are not present.
*
* @since 0.1.0
* @return boolean result of meets_requirements
*/
public function check_requirements() {
if ( ! $this->meets_requirements() ) {
// Add a dashboard notice
add_action( 'all_admin_notices', array( $this, 'requirements_not_met_notice' ) );
return false;
}
return true;
}
/**
* Adds a notice to the dashboard if the plugin requirements are not met
*
* @since 0.1.0
* @return void
*/
public function requirements_not_met_notice() {
// Output our error
echo '<div id="message" class="error">';
echo '<p>' . $this->activation_error . '</p>';
echo '</div>';
// Deactivate our plugin
deactivate_plugins( $this->basename );
}
/**
* Magic getter for our object.
*
* @since 0.1.0
* @param string $field
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
public function __get( $field ) {
switch ( $field ) {
case 'version':
return self::VERSION;
case 'basename':
case 'url':
case 'path':
case 'settings':
case 'api':
return $this->$field;
default:
throw new Exception( 'Invalid '. __CLASS__ .' property: ' . $field );
}
}
/**
* Include a file from the includes directory
*
* @since 0.1.0
* @param string $filename Name of the file to be included
* @return bool Result of include call.
*/
public static function include_file( $filename ) {
$file = self::dir( 'includes/'. $filename .'.php' );
if ( file_exists( $file ) ) {
return include_once( $file );
}
return false;
}
/**
* This plugin's directory
*
* @since 0.1.0
* @param string $path (optional) appended path
* @return string Directory and path
*/
public static function dir( $path = '' ) {
static $dir;
$dir = $dir ? $dir : trailingslashit( dirname( __FILE__ ) );
return $dir . $path;
}
/**
* This plugin's url
*
* @since 0.1.0
* @param string $path (optional) appended path
* @return string URL and path
*/
public static function url( $path = '' ) {
static $url;
$url = $url ? $url : trailingslashit( plugin_dir_url( __FILE__ ) );
return $url . $path;
}
}
/**
* Grab the WDS_REST_Connect_UI object and return it.
* Wrapper for WDS_REST_Connect_UI::get_instance()
*
* @since 0.1.0
* @return WDS_REST_Connect_UI Singleton instance of plugin class.
*/
function wds_rest_connect_ui() {
return WDS_REST_Connect_UI::get_instance();
}
// Kick it off
add_action( 'plugins_loaded', array( wds_rest_connect_ui(), 'hooks' ) );
/**
* Wrapper function for WDSRESTCUI_Settings::get()
*
* Available options;
* 'url'
* 'endpoint'
* 'api_url'
* 'client_key'
* 'client_secret'
* 'header_key'
* 'header_token'
*
* @since 0.1.0
*
* @param string $field_id The setting field to retrieve.
* @param boolean $default Optional default value if no value exists.
*
* @return mixed Value for setting.
*/
function wds_rest_connect_ui_get_setting( $field_id = '', $default = false ) {
return wds_rest_connect_ui()->settings->get( $field_id, $default );
}
/**
* Wrapper function for WDSRESTCUI_Settings::api()
*
* @since 0.1.0
*
* @return WP_Error|Connect The API object or WP_Error.
*/
function wds_rest_connect_ui_api_object() {
$settings = wds_rest_connect_ui()->settings;
$api = $settings->api();
if ( '' === $api->key() ) {
$error = sprintf( __( 'API connection is not properly authenticated. Authenticate via the <a href="%s">settings page</a>.', 'wds-rest-connect-ui' ), $settings->settings_url() );
return new WP_Error( 'wds_rest_connect_ui_api_fail', $error );
}
return $api;
}
/**
*
* In your theme or plugin, Instead of checking if the
* 'wds_rest_connect_ui_api_object' function exists you can use:
*
* `$api = apply_filters( 'wds_rest_connect_ui_api_object', null );`
*
* Then check for Connect or WP_Error value before proceeding:
* `if ( is_a( $api, 'WDS_WP_REST_API\OAuth1\Connect' ) ) { $schema = $api->auth_get_request(); }`
*
*/
add_filter( 'wds_rest_connect_ui_api_object', 'wds_rest_connect_ui_api_object' );