class-api.php
13.2 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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
<?php
namespace um\core\rest;
if ( ! defined( 'ABSPATH' ) ) exit;
if ( ! class_exists( 'um\core\rest\API' ) ) {
/**
* Class API
*
* @package um\core\rest
*/
class API {
/**
* @var bool|int|null
*/
protected $pretty_print = false;
/**
* @var bool|mixed|void
*/
public $log_requests = true;
/**
* @var bool
*/
protected $is_valid_request = false;
/**
* @var int
*/
protected $user_id = 0;
/**
* @var
*/
protected $stats;
/**
* @var array
*/
protected $data = array();
/**
* @var bool
*/
protected $override = true;
/**
* @var array
*/
protected $vars = array();
/**
* REST_API constructor.
*/
public function __construct() {
add_action( 'init', array( $this, 'add_endpoint' ) );
add_action( 'template_redirect', array( $this, 'process_query' ), -1 );
// Determine if JSON_PRETTY_PRINT is available
$this->pretty_print = defined( 'JSON_PRETTY_PRINT' ) ? JSON_PRETTY_PRINT : null;
/**
* UM hook
*
* @type filter
* @title um_api_log_requests
* @description Allow API request logging to be turned off
* @input_vars
* [{"var":"$allow_log","type":"bool","desc":"Enable api logs"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_log_requests', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_log_requests', 'my_api_log_requests', 10, 1 );
* function my_api_log_requests( $allow_log ) {
* // your code here
* return $allow_log;
* }
* ?>
*/
$this->log_requests = apply_filters( 'um_api_log_requests', $this->log_requests );
}
/**
* Registers a new rewrite endpoint for accessing the API
*
* @param $rewrite_rules
*/
public function add_endpoint( $rewrite_rules ) {
add_rewrite_endpoint( 'um-api', EP_ALL );
}
/**
* Listens for the API and then processes the API requests
*/
public function process_query() {
global $wp_query;
// Check for um-api var. Get out if not present
if ( ! isset( $wp_query->query_vars['um-api'] ) ) {
return;
}
// Check for a valid user and set errors if necessary
$this->validate_request();
// Only proceed if no errors have been noted
if ( ! $this->is_valid_request ) {
return;
}
if ( ! defined( 'UM_DOING_API' ) ) {
define( 'UM_DOING_API', true );
}
// Determine the kind of query
$args = array();
$query_mode = $this->get_query_mode();
foreach ( $this->vars as $k ) {
$args[ $k ] = isset( $wp_query->query_vars[ $k ] ) ? $wp_query->query_vars[ $k ] : null;
}
$data = array();
switch ( $query_mode ) {
case 'get.stats':
$data = $this->get_stats( $args );
break;
case 'get.users':
$data = $this->get_users( $args );
break;
case 'get.user':
$data = $this->get_auser( $args );
break;
case 'update.user':
$data = $this->update_user( $args );
break;
case 'delete.user':
$data = $this->delete_user( $args );
break;
default:
/**
* UM hook
*
* @type filter
* @title um_rest_query_mode
* @description Change query attributes
* @input_vars
* [{"var":"$data","type":"array","desc":"Query Data"},
* {"var":"$query_mode","type":"string","desc":"Query Mode"},
* {"var":"$args","type":"array","desc":"Query Arguments"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_query_mode', 'function_name', 10, 3 ); ?>
* @example
* <?php
* add_filter( 'um_rest_query_mode', 'my_rest_query_mode', 10, 3 );
* function um_rest_query_mode( $data, $query_mode, $args ) {
* // your code here
* return $data;
* }
* ?>
*/
$data = apply_filters( 'um_rest_query_mode', $data, $query_mode, $args );
break;
}
/**
* UM hook
*
* @type filter
* @title um_api_output_data
* @description Change output data for Rest API call
* @input_vars
* [{"var":"$data","type":"array","desc":"Output Data"},
* {"var":"$query_mode","type":"string","desc":"Query Mode"},
* {"var":"$api_class","type":"REST_API","desc":"REST_API instance"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_output_data', 'function_name', 10, 3 ); ?>
* @example
* <?php
* add_filter( 'um_api_output_data', 'my_api_output_data', 10, 3 );
* function my_api_output_data( $data, $query_mode, $api_class ) {
* // your code here
* return $data;
* }
* ?>
*/
$this->data = apply_filters( 'um_api_output_data', $data, $query_mode, $this );
// Log this API request, if enabled. We log it here because we have access to errors.
$this->log_request( $this->data );
// Send out data to the output function
$this->output();
}
/**
* Validate the API request
*/
protected function validate_request() {
}
/**
* Retrieve the user ID based on the public key provided
*
* @param string $key
*
* @return bool
*/
public function get_user( $key = '' ) {
return false;
}
/**
* Displays a missing authentication error if all the parameters aren't
* provided
*/
protected function missing_auth() {
$error = array();
$error['error'] = __( 'You must specify both a token and API key!', 'ultimate-member' );
$this->data = $error;
$this->output( 401 );
}
/**
* Displays an authentication failed error if the user failed to provide valid credentials
*/
protected function invalid_auth() {
$error = array();
$error['error'] = __( 'Your request could not be authenticated', 'ultimate-member' );
$this->data = $error;
$this->output( 401 );
}
/**
* Displays an invalid API key error if the API key provided couldn't be validated
*/
protected function invalid_key() {
$error = array();
$error['error'] = __( 'Invalid API key', 'ultimate-member' );
$this->data = $error;
$this->output( 401 );
}
/**
* Get some stats
*
* @param $args
*
* @return array
*/
public function get_stats( $args ) {
global $wpdb;
$response = array();
$count = absint( $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}users" ) );
$response['stats']['total_users'] = $count;
$pending = UM()->query()->get_pending_users_count();
$response['stats']['pending_users'] = absint( $pending );
/**
* UM hook
*
* @type filter
* @title um_rest_api_get_stats
* @description Change output data for Rest API get stats call
* @input_vars
* [{"var":"$response","type":"array","desc":"Output Data"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_rest_api_get_stats', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_rest_api_get_stats', 'my_rest_api_get_stats', 10, 1 );
* function my_rest_api_get_stats( $response ) {
* // your code here
* return $response;
* }
* ?>
*/
$response = apply_filters( 'um_rest_api_get_stats', $response );
return $response;
}
/**
* Process Get users API Request
*
* @param $args
*
* @return array
*/
public function get_users( $args ) {
return array();
}
/**
* Update user API query
*
* @param $args
*
* @return array
*/
public function update_user( $args ) {
return array();
}
/**
* Process delete user via API
*
* @param $args
*
* @return array
*/
public function delete_user( $args ) {
return array();
}
/**
* Process Get user API Request
*
* @param $args
*
* @return array
*/
public function get_auser( $args ) {
return array();
}
/**
* Get source
*
* @param $image
*
* @return string
*/
protected function getsrc( $image ) {
if ( preg_match( '/<img.+?src(?: )*=(?: )*[\'"](.*?)[\'"]/si', $image, $arrResult ) ) {
return $arrResult[1];
}
return '';
}
/**
* Determines the kind of query requested and also ensure it is a valid query
*
* @return null
*/
public function get_query_mode() {
global $wp_query;
/**
* UM hook
*
* @type filter
* @title um_api_valid_query_modes
* @description Whitelist UM query options
* @input_vars
* [{"var":"$list","type":"array","desc":"Whitelist"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_valid_query_modes', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_valid_query_modes', 'my_api_valid_query_modes', 10, 1 );
* function my_api_valid_query_modes( $list ) {
* // your code here
* return $list;
* }
* ?>
*/
$accepted = apply_filters( 'um_api_valid_query_modes', array(
'get.users',
'get.user',
'update.user',
'delete.user',
'get.following',
'get.followers',
'get.stats',
) );
$query = isset( $wp_query->query_vars['um-api'] ) ? $wp_query->query_vars['um-api'] : null;
$error = array();
// Make sure our query is valid
if ( ! in_array( $query, $accepted ) ) {
$error['error'] = __( 'Invalid query!', 'ultimate-member' );
$this->data = $error;
$this->output();
}
return $query;
}
/**
* Get page number
*/
public function get_paged() {
global $wp_query;
return isset( $wp_query->query_vars['page'] ) ? $wp_query->query_vars['page'] : 1;
}
/**
* Retrieve the output format
*/
public function get_output_format() {
/**
* UM hook
*
* @type filter
* @title um_api_output_format
* @description UM Rest API output format
* @input_vars
* [{"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_api_output_format', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_api_output_format', 'my_api_output_format', 10, 1 );
* function my_api_output_format( $format ) {
* // your code here
* return $format;
* }
* ?>
*/
return apply_filters( 'um_api_output_format', 'json' );
}
/**
* Log each API request, if enabled
*
* @param array $data
*/
protected function log_request( $data = array() ) {
if ( ! $this->log_requests ) {
return;
}
}
/**
* Retrieve the output data
*/
public function get_output() {
return $this->data;
}
/**
* Output Query in either JSON/XML. The query data is outputted as JSON
* by default
*
* @param int $status_code
*/
public function output( $status_code = 200 ) {
$format = $this->get_output_format();
status_header( $status_code );
/**
* UM hook
*
* @type action
* @title um_api_output_before
* @description Action before API output
* @input_vars
* [{"var":"$data","type":"array","desc":"API data"},
* {"var":"$rest_api","type":"object","desc":"REST API class"},
* {"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_api_output_before', 'function_name', 10, 3 );
* @example
* <?php
* add_action( 'um_api_output_before', 'my_api_output_before', 10, 3 );
* function my_api_output_before( $data, $rest_api, $format ) {
* // your code here
* }
* ?>
*/
do_action( 'um_api_output_before', $this->data, $this, $format );
switch ( $format ) {
case 'xml' :
require_once um_path . 'includes/lib/array2xml.php';
$xml = \Array2XML::createXML( 'um', $this->data );
echo $xml->saveXML();
break;
case 'json' :
case '' :
header( 'Content-Type: application/json' );
if ( ! empty( $this->pretty_print ) ) {
echo json_encode( $this->data, $this->pretty_print );
} else {
echo json_encode( $this->data );
}
break;
default :
// Allow other formats to be added via extensions
/**
* UM hook
*
* @type action
* @title um_api_output_{$format}
* @description Action before API output
* @input_vars
* [{"var":"$data","type":"array","desc":"API data"},
* {"var":"$rest_api","type":"object","desc":"REST API class"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_api_output_{$format}', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_api_output_{$format}', 'my_api_output', 10, 2 );
* function my_api_output( $data, $rest_api ) {
* // your code here
* }
* ?>
*/
do_action( 'um_api_output_' . $format, $this->data, $this );
break;
}
/**
* UM hook
*
* @type action
* @title um_api_output_after
* @description Action after API output
* @input_vars
* [{"var":"$data","type":"array","desc":"API data"},
* {"var":"$rest_api","type":"object","desc":"REST API class"},
* {"var":"$format","type":"string","desc":"Format"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_api_output_after', 'function_name', 10, 3 );
* @example
* <?php
* add_action( 'um_api_output_after', 'my_api_output_after', 10, 3 );
* function my_api_output_after( $data, $rest_api, $format ) {
* // your code here
* }
* ?>
*/
do_action( 'um_api_output_after', $this->data, $this, $format );
die();
}
}
}