class.BadgeOS_Plugin_Updater.php
9.92 KB
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
<?php
/**
* Add-on Updater Class
*
* @package BadgeOS
* @subpackage Classes
* @author LearningTimes, LLC
* @license http://www.gnu.org/licenses/agpl.txt GNU AGPL v3.0
* @link https://credly.com
*/
// Uncomment this line for testing
// set_site_transient( 'update_plugins', null );
/**
* Our add-on updater class.
*
* Original codebase by Pippin Williamson
*/
class BadgeOS_Plugin_Updater {
private $api_url = '';
private $api_data = array();
private $name = '';
private $slug = '';
private $version = '';
private $item_name = '';
/**
* Class constructor.
*
* @since 1.2.0
*
* @param string $_api_url The URL pointing to the custom API endpoint.
* @param string $_plugin_file Path to the plugin file.
* @param array $_api_data Optional data to send with API calls.
* @return void
*/
function __construct( $_api_data = null ) {
// Setup our add-on data
$this->api_data = urlencode_deep( $_api_data );
$this->api_url = 'https://badgeos.org/';
$this->name = plugin_basename( $_api_data['plugin_file'] );
$this->slug = basename( $_api_data['plugin_file'], '.php' );
$this->version = $_api_data['version'];
$this->item_name = $_api_data['item_name'];
// Setup the license
$this->api_data['license'] = trim( badgeos_utilities::get_option( $this->slug . '-license_key' ) );
$this->api_data['license_status'] = trim( badgeos_utilities::get_option( $this->slug . '-license_status' ) );
// Set up hooks.
$this->hook();
}
/**
* Set up WordPress filters to hook into WP's update process.
*
* @since 1.2.0
*/
private function hook() {
add_filter( 'badgeos_licensed_addons', array( $this, 'register_licensed_addon' ) );
add_action( 'badgeos_settings_validate', array( $this, 'validate_license' ) );
add_filter( 'plugins_api', array( $this, 'plugins_api_filter' ), 10, 3 );
add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'pre_set_site_transient_update_plugins_filter' ) );
}
/**
* Activate a new license or deactivate a deleted license
*
* @since 1.2.0
*
* @param array $input Input data sent via $POST
*/
public function validate_license( $input ) {
$original_settings = badgeos_utilities::get_option( 'badgeos_settings' );
$original_settings['licenses'][ $this->slug ] = isset( $input['licenses'][ $this->slug ] ) ? sanitize_text_field( $input['licenses'][ $this->slug ] ) : $original_settings['licenses'][ $this->slug ];
// Activate our license if we have license data
if ( isset( $original_settings['licenses'][ $this->slug ] ) && ! empty( $original_settings['licenses'][ $this->slug ] ) ) {
$this->activate_license( $original_settings['licenses'][ $this->slug ] );
}
// Otherwise, deactivate the previous license
else {
$this->deactivate_license();
}
}
/**
* Add this add-on to the list of registered licesned add-ons
*
* @since 1.2.0
*
* @param array $licensed_addons The current licensed addons
* @return array The updated list of licensed add-ons
*/
public function register_licensed_addon( $licensed_addons ) {
// Add our add-on to the array
$licensed_addons[ $this->slug ] = $this->api_data;
// Return all licensed add-ons
return $licensed_addons;
}
/**
* Check for Updates at the defined API endpoint and modify the update array.
*
* This function dives into the update api just when WordPress creates its update array,
* then adds a custom API call and injects the custom plugin data retrieved from the API.
* It is reassembled from parts of the native WordPress plugin update code.
* See wp-includes/update.php line 121 for the original wp_update_plugins() function.
*
* @since 1.2.0
*
* @param array $_transient_data Update array build by WordPress.
* @return array Modified update array with custom plugin data.
*/
function pre_set_site_transient_update_plugins_filter( $_transient_data ) {
if ( empty( $_transient_data ) ) {
return $_transient_data;
}
$to_send = array( 'slug' => $this->slug );
$api_response = $this->api_request( 'plugin_latest_version', $to_send );
if ( false !== $api_response && is_object( $api_response ) && isset( $api_response->new_version ) ) {
if ( version_compare( $this->version, $api_response->new_version, '<' ) ) {
$_transient_data->response[ $this->name ] = $api_response;
}
}
return $_transient_data;
}
/**
* Updates information on the "View version x.x details" page with custom data.
*
* @since 1.2.0
*
* @param mixed $_data
* @param string $_action
* @param object $_args
* @return object $_data
*/
function plugins_api_filter( $_data, $_action = '', $_args = null ) {
if ( ( $_action != 'plugin_information' ) || ! isset( $_args->slug ) || ( $_args->slug != $this->slug ) ) {
return $_data;
}
$to_send = array( 'slug' => $this->slug );
$api_response = $this->api_request( 'plugin_information', $to_send );
if ( false !== $api_response ) {
$_data = $api_response;
}
return $_data;
}
/**
* Calls the API and, if successfull, returns the object delivered by the API.
*
* @since 1.2.0
*
* @param string $_action The requested action.
* @param array $_data Parameters for the API action.
* @return false|object
*/
private function api_request( $_action, $_data ) {
$data = array_merge( $this->api_data, $_data );
if ( $data['slug'] != $this->slug ) {
return;
}
if ( empty( $data['license'] ) ) {
return;
}
$api_params = array(
'edd_action' => 'get_version',
'license' => $data['license'],
'name' => $data['item_name'],
'slug' => $this->slug,
'author' => $data['author'],
);
$request = wp_remote_post(
$this->api_url,
array(
'timeout' => 15,
'sslverify' => false,
'body' => $api_params,
)
);
if ( ! is_wp_error( $request ) ) {
$request = json_decode( wp_remote_retrieve_body( $request ) );
if ( $request && isset( $request->sections ) ) {
$request->sections = maybe_unserialize( $request->sections );
}
return $request;
} else {
return false;
}
}
/**
* Handle license key activation
*
* This returns true on a successful server response,
* even if the server responds with 'invalid' for the
* license status.
*
* @since 1.2.0
*
* @param string $license The license key to activate
* @return bool False on failure, true on success
*/
public function activate_license( $license = '' ) {
// Run a quick security check
if ( ! check_admin_referer( 'badgeos_settings_nonce', 'badgeos_settings_nonce' ) ) {
return; // get out if we didn't click the Activate button
}
// If the license hasn't changed, bail here
if ( $license === $this->api_data['license'] && 'valid' === $this->api_data['license_status'] ) {
return false;
}
// Setup our API Request data
$api_params = array(
'edd_action' => 'activate_license',
'license' => trim( $license ),
'item_name' => urlencode( $this->item_name ),
'url' => home_url(),
);
// Call the remote API
$response = wp_remote_get(
add_query_arg( $api_params, $this->api_url ),
array(
'timeout' => 15,
'sslverify' => false,
)
);
// Make sure the response came back okay
if ( is_wp_error( $response ) ) {
return false;
}
// Decode the license data
// $license_data->license will be "active", "inactive" or "invalid"
$license_data = json_decode( wp_remote_retrieve_body( $response ) );
// Store the data in the options table
badgeos_utilities::update_option( $this->slug . '-license_key', $license );
badgeos_utilities::update_option( $this->slug . '-license_status', $license_data->license );
return true;
}
/**
* Handle license key deactivation
*
* @since 1.2.0
*/
public function deactivate_license() {
// Run a quick security check
if ( ! check_admin_referer( 'badgeos_settings_nonce', 'badgeos_settings_nonce' ) ) {
return false; // get out if we didn't click the Activate button
}
// Retrieve the license from the database
$license = trim( badgeos_utilities::get_option( $this->slug . '-license_key' ) );
// If there isn't one, bail here
if ( empty( $license ) ) {
return false;
}
// Setup our API Request data
$api_params = array(
'edd_action' => 'deactivate_license',
'license' => $license,
'item_name' => urlencode( $this->item_name ), // the name of our product in EDD
'url' => home_url(),
);
// Call the custom API.
$response = wp_remote_get(
add_query_arg( $api_params, $this->api_url ),
array(
'timeout' => 15,
'sslverify' => false,
)
);
// Make sure the response came back okay
if ( is_wp_error( $response ) ) {
return false;
}
// Decode the license data
// $license_data->license will be either "deactivated" or "failed"
$license_data = json_decode( wp_remote_retrieve_body( $response ) );
// Clear our stored license options
badgeos_utilities::delete_option( $this->slug . '-license_key' );
badgeos_utilities::update_option( $this->slug . '-license_status', 'inactive' );
return true;
}
/**
* Check a license for validity
*
* @since 1.2.0
*
* @return string 'valid' if license is valid, 'invalid' otherwise
*/
public function check_license() {
$license = trim( badgeos_utilities::get_option( $this->slug . '-license_key' ) );
$api_params = array(
'edd_action' => 'check_license',
'license' => $license,
'item_name' => urlencode( $this->item_name ),
'url' => home_url(),
);
// Call the custom API.
$response = wp_remote_get(
add_query_arg( $api_params, $this->api_url ),
array(
'timeout' => 15,
'sslverify' => false,
)
);
if ( is_wp_error( $response ) ) {
return false;
}
$license_data = json_decode( wp_remote_retrieve_body( $response ) );
if ( 'valid' === $license_data->license ) {
echo 'valid';
exit;
// this license is still valid
} else {
echo 'invalid';
exit;
// this license is no longer valid
}
}
}