class-give-api.php
2140 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Give API |
| 4 | * |
| 5 | * A front-facing JSON/XML API that makes it possible to query donation data. |
| 6 | * |
| 7 | * @package Give |
| 8 | * @subpackage Classes/API |
| 9 | * @copyright Copyright (c) 2016, WordImpress |
| 10 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 11 | * @since 1.1 |
| 12 | */ |
| 13 | |
| 14 | // Exit if accessed directly. |
| 15 | if ( ! defined( 'ABSPATH' ) ) { |
| 16 | exit; |
| 17 | } |
| 18 | |
| 19 | /** |
| 20 | * Give_API Class |
| 21 | * |
| 22 | * Renders API returns as a JSON/XML array |
| 23 | * |
| 24 | * @since 1.1 |
| 25 | */ |
| 26 | class Give_API { |
| 27 | |
| 28 | /** |
| 29 | * Latest API Version |
| 30 | */ |
| 31 | const VERSION = 1; |
| 32 | |
| 33 | /** |
| 34 | * Pretty Print? |
| 35 | * |
| 36 | * @var bool |
| 37 | * @access private |
| 38 | * @since 1.1 |
| 39 | */ |
| 40 | private $pretty_print = false; |
| 41 | |
| 42 | /** |
| 43 | * Log API requests? |
| 44 | * |
| 45 | * @var bool |
| 46 | * @access public |
| 47 | * @since 1.1 |
| 48 | */ |
| 49 | public $log_requests = true; |
| 50 | |
| 51 | /** |
| 52 | * Is this a valid request? |
| 53 | * |
| 54 | * @var bool |
| 55 | * @access private |
| 56 | * @since 1.1 |
| 57 | */ |
| 58 | private $is_valid_request = false; |
| 59 | |
| 60 | /** |
| 61 | * User ID Performing the API Request |
| 62 | * |
| 63 | * @var int |
| 64 | * @access public |
| 65 | * @since 1.1 |
| 66 | */ |
| 67 | public $user_id = 0; |
| 68 | |
| 69 | /** |
| 70 | * Instance of Give Stats class |
| 71 | * |
| 72 | * @var object |
| 73 | * @access private |
| 74 | * @since 1.1 |
| 75 | */ |
| 76 | private $stats; |
| 77 | |
| 78 | /** |
| 79 | * Response data to return |
| 80 | * |
| 81 | * @var array |
| 82 | * @access private |
| 83 | * @since 1.1 |
| 84 | */ |
| 85 | private $data = array(); |
| 86 | |
| 87 | /** |
| 88 | * Whether or not to override api key validation. |
| 89 | * |
| 90 | * @var bool |
| 91 | * @access public |
| 92 | * @since 1.1 |
| 93 | */ |
| 94 | public $override = true; |
| 95 | |
| 96 | /** |
| 97 | * Version of the API queried |
| 98 | * |
| 99 | * @var string |
| 100 | * @access public |
| 101 | * @since 1.1 |
| 102 | */ |
| 103 | private $queried_version; |
| 104 | |
| 105 | /** |
| 106 | * All versions of the API |
| 107 | * |
| 108 | * @var array |
| 109 | * @access protected |
| 110 | * @since 1.1 |
| 111 | */ |
| 112 | protected $versions = array(); |
| 113 | |
| 114 | /** |
| 115 | * Queried endpoint |
| 116 | * |
| 117 | * @var string |
| 118 | * @access private |
| 119 | * @since 1.1 |
| 120 | */ |
| 121 | private $endpoint; |
| 122 | |
| 123 | /** |
| 124 | * Endpoints routes |
| 125 | * |
| 126 | * @var object |
| 127 | * @access private |
| 128 | * @since 1.1 |
| 129 | */ |
| 130 | private $routes; |
| 131 | |
| 132 | /** |
| 133 | * Setup the Give API |
| 134 | * |
| 135 | * @since 1.1 |
| 136 | * @access public |
| 137 | */ |
| 138 | public function __construct() { |
| 139 | |
| 140 | $this->versions = array( |
| 141 | 'v1' => 'GIVE_API_V1', |
| 142 | ); |
| 143 | |
| 144 | foreach ( $this->get_versions() as $version => $class ) { |
| 145 | require_once GIVE_PLUGIN_DIR . 'includes/api/class-give-api-' . $version . '.php'; |
| 146 | } |
| 147 | |
| 148 | add_action( 'init', array( $this, 'add_endpoint' ) ); |
| 149 | add_action( 'wp', array( $this, 'process_query' ), - 1 ); |
| 150 | add_filter( 'query_vars', array( $this, 'query_vars' ) ); |
| 151 | add_action( 'show_user_profile', array( $this, 'user_key_field' ) ); |
| 152 | add_action( 'edit_user_profile', array( $this, 'user_key_field' ) ); |
| 153 | add_action( 'personal_options_update', array( $this, 'generate_api_key' ) ); |
| 154 | add_action( 'edit_user_profile_update', array( $this, 'generate_api_key' ) ); |
| 155 | add_action( 'give_process_api_key', array( $this, 'process_api_key' ) ); |
| 156 | |
| 157 | // Setup a backwards compatibility check for user API Keys |
| 158 | add_filter( 'get_user_metadata', array( $this, 'api_key_backwards_compat' ), 10, 4 ); |
| 159 | |
| 160 | // Determine if JSON_PRETTY_PRINT is available |
| 161 | $this->pretty_print = defined( 'JSON_PRETTY_PRINT' ) ? JSON_PRETTY_PRINT : null; |
| 162 | |
| 163 | // Allow API request logging to be turned off |
| 164 | $this->log_requests = apply_filters( 'give_api_log_requests', $this->log_requests ); |
| 165 | |
| 166 | // Setup Give_Payment_Stats instance |
| 167 | $this->stats = new Give_Payment_Stats(); |
| 168 | |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * There are certain responsibility of this function: |
| 173 | * 1. handle backward compatibility for deprecated functions |
| 174 | * |
| 175 | * @since 2.0 |
| 176 | * |
| 177 | * @param $name |
| 178 | * @param $arguments |
| 179 | * |
| 180 | * @return mixed |
| 181 | */ |
| 182 | public function __call( $name, $arguments ) { |
| 183 | $deprecated_function_arr = array( |
| 184 | 'get_customers', |
| 185 | ); |
| 186 | |
| 187 | if ( in_array( $name, $deprecated_function_arr, true ) ) { |
| 188 | switch ( $name ) { |
| 189 | case 'get_customers': |
| 190 | $args = ! empty( $arguments[0] ) ? $arguments[0] : array(); |
| 191 | |
| 192 | return $this->get_donors( $args ); |
| 193 | } |
| 194 | } |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * Registers a new rewrite endpoint for accessing the API |
| 199 | * |
| 200 | * @access public |
| 201 | * |
| 202 | * @since 1.1 |
| 203 | */ |
| 204 | public function add_endpoint() { |
| 205 | add_rewrite_endpoint( 'give-api', EP_ALL ); |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Registers query vars for API access |
| 210 | * |
| 211 | * @access public |
| 212 | * @since 1.1 |
| 213 | * |
| 214 | * @param array $vars Query vars |
| 215 | * |
| 216 | * @return string[] $vars New query vars |
| 217 | */ |
| 218 | public function query_vars( $vars ) { |
| 219 | |
| 220 | $vars[] = 'token'; |
| 221 | $vars[] = 'key'; |
| 222 | $vars[] = 'query'; |
| 223 | $vars[] = 'type'; |
| 224 | $vars[] = 'form'; |
| 225 | $vars[] = 'number'; |
| 226 | $vars[] = 'date'; |
| 227 | $vars[] = 'startdate'; |
| 228 | $vars[] = 'enddate'; |
| 229 | $vars[] = 'donor'; |
| 230 | $vars[] = 'format'; |
| 231 | $vars[] = 'id'; |
| 232 | $vars[] = 'purchasekey'; |
| 233 | $vars[] = 'email'; |
| 234 | |
| 235 | return $vars; |
| 236 | } |
| 237 | |
| 238 | /** |
| 239 | * Retrieve the API versions |
| 240 | * |
| 241 | * @access public |
| 242 | * @since 1.1 |
| 243 | * @return array |
| 244 | */ |
| 245 | public function get_versions() { |
| 246 | return $this->versions; |
| 247 | } |
| 248 | |
| 249 | /** |
| 250 | * Retrieve the API version that was queried |
| 251 | * |
| 252 | * @access public |
| 253 | * @since 1.1 |
| 254 | * @return string |
| 255 | */ |
| 256 | public function get_queried_version() { |
| 257 | return $this->queried_version; |
| 258 | } |
| 259 | |
| 260 | /** |
| 261 | * Retrieves the default version of the API to use |
| 262 | * |
| 263 | * @access public |
| 264 | * @since 1.1 |
| 265 | * @return string |
| 266 | */ |
| 267 | public function get_default_version() { |
| 268 | |
| 269 | $version = get_option( 'give_default_api_version' ); |
| 270 | |
| 271 | if ( defined( 'GIVE_API_VERSION' ) ) { |
| 272 | $version = GIVE_API_VERSION; |
| 273 | } elseif ( ! $version ) { |
| 274 | $version = 'v1'; |
| 275 | } |
| 276 | |
| 277 | return $version; |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | * Sets the version of the API that was queried. |
| 282 | * |
| 283 | * Falls back to the default version if no version is specified |
| 284 | * |
| 285 | * @access private |
| 286 | * @since 1.1 |
| 287 | */ |
| 288 | private function set_queried_version() { |
| 289 | |
| 290 | global $wp_query; |
| 291 | |
| 292 | $version = $wp_query->query_vars['give-api']; |
| 293 | |
| 294 | if ( strpos( $version, '/' ) ) { |
| 295 | |
| 296 | $version = explode( '/', $version ); |
| 297 | $version = strtolower( $version[0] ); |
| 298 | |
| 299 | $wp_query->query_vars['give-api'] = str_replace( $version . '/', '', $wp_query->query_vars['give-api'] ); |
| 300 | |
| 301 | if ( array_key_exists( $version, $this->versions ) ) { |
| 302 | |
| 303 | $this->queried_version = $version; |
| 304 | |
| 305 | } else { |
| 306 | |
| 307 | $this->is_valid_request = false; |
| 308 | $this->invalid_version(); |
| 309 | } |
| 310 | } else { |
| 311 | |
| 312 | $this->queried_version = $this->get_default_version(); |
| 313 | |
| 314 | } |
| 315 | |
| 316 | } |
| 317 | |
| 318 | /** |
| 319 | * Validate the API request |
| 320 | * |
| 321 | * Checks for the user's public key and token against the secret key. |
| 322 | * |
| 323 | * @access private |
| 324 | * @global object $wp_query WordPress Query |
| 325 | * @uses Give_API::get_user() |
| 326 | * @uses Give_API::invalid_key() |
| 327 | * @uses Give_API::invalid_auth() |
| 328 | * @since 1.1 |
| 329 | * @return bool |
| 330 | */ |
| 331 | private function validate_request() { |
| 332 | global $wp_query; |
| 333 | |
| 334 | $this->override = false; |
| 335 | |
| 336 | // Make sure we have both user and api key |
| 337 | if ( ! empty( $wp_query->query_vars['give-api'] ) && ( $wp_query->query_vars['give-api'] !== 'forms' || ! empty( $wp_query->query_vars['token'] ) ) ) { |
| 338 | |
| 339 | if ( empty( $wp_query->query_vars['token'] ) || empty( $wp_query->query_vars['key'] ) ) { |
| 340 | $this->missing_auth(); |
| 341 | |
| 342 | return false; |
| 343 | } |
| 344 | |
| 345 | // Retrieve the user by public API key and ensure they exist |
| 346 | if ( ! ( $user = $this->get_user( $wp_query->query_vars['key'] ) ) ) { |
| 347 | |
| 348 | $this->invalid_key(); |
| 349 | |
| 350 | return false; |
| 351 | |
| 352 | } else { |
| 353 | |
| 354 | $token = urldecode( $wp_query->query_vars['token'] ); |
| 355 | $secret = $this->get_user_secret_key( $user ); |
| 356 | $public = urldecode( $wp_query->query_vars['key'] ); |
| 357 | |
| 358 | if ( hash_equals( md5( $secret . $public ), $token ) ) { |
| 359 | $this->is_valid_request = true; |
| 360 | } else { |
| 361 | $this->invalid_auth(); |
| 362 | |
| 363 | return false; |
| 364 | } |
| 365 | |
| 366 | } |
| 367 | } elseif ( ! empty( $wp_query->query_vars['give-api'] ) && $wp_query->query_vars['give-api'] === 'forms' ) { |
| 368 | $this->is_valid_request = true; |
| 369 | $wp_query->set( 'key', 'public' ); |
| 370 | } |
| 371 | } |
| 372 | |
| 373 | /** |
| 374 | * Retrieve the user ID based on the public key provided |
| 375 | * |
| 376 | * @access public |
| 377 | * @since 1.1 |
| 378 | * @global WPDB $wpdb Used to query the database using the WordPress |
| 379 | * Database API |
| 380 | * |
| 381 | * @param string $key Public Key |
| 382 | * |
| 383 | * @return bool if user ID is found, false otherwise |
| 384 | */ |
| 385 | public function get_user( $key = '' ) { |
| 386 | global $wpdb, $wp_query; |
| 387 | |
| 388 | if ( empty( $key ) ) { |
| 389 | $key = urldecode( $wp_query->query_vars['key'] ); |
| 390 | } |
| 391 | |
| 392 | if ( empty( $key ) ) { |
| 393 | return false; |
| 394 | } |
| 395 | |
| 396 | $user = Give_Cache::get( md5( 'give_api_user_' . $key ), true ); |
| 397 | |
| 398 | if ( false === $user ) { |
| 399 | $user = $wpdb->get_var( $wpdb->prepare( "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s LIMIT 1", $key ) ); |
| 400 | Give_Cache::set( md5( 'give_api_user_' . $key ), $user, DAY_IN_SECONDS, true ); |
| 401 | } |
| 402 | |
| 403 | if ( $user != null ) { |
| 404 | $this->user_id = $user; |
| 405 | |
| 406 | return $user; |
| 407 | } |
| 408 | |
| 409 | return false; |
| 410 | } |
| 411 | |
| 412 | /** |
| 413 | * Get user public key. |
| 414 | * |
| 415 | * @param int $user_id |
| 416 | * |
| 417 | * @return mixed|null|string |
| 418 | */ |
| 419 | public function get_user_public_key( $user_id = 0 ) { |
| 420 | global $wpdb; |
| 421 | |
| 422 | if ( empty( $user_id ) ) { |
| 423 | return ''; |
| 424 | } |
| 425 | |
| 426 | $cache_key = md5( 'give_api_user_public_key' . $user_id ); |
| 427 | $user_public_key = Give_Cache::get( $cache_key, true ); |
| 428 | |
| 429 | if ( empty( $user_public_key ) ) { |
| 430 | $user_public_key = $wpdb->get_var( $wpdb->prepare( "SELECT meta_key FROM $wpdb->usermeta WHERE meta_value = 'give_user_public_key' AND user_id = %d", $user_id ) ); |
| 431 | Give_Cache::set( $cache_key, $user_public_key, HOUR_IN_SECONDS, true ); |
| 432 | } |
| 433 | |
| 434 | return $user_public_key; |
| 435 | } |
| 436 | |
| 437 | /** |
| 438 | * Get user secret key. |
| 439 | * |
| 440 | * @param int $user_id |
| 441 | * |
| 442 | * @return mixed|null|string |
| 443 | */ |
| 444 | public function get_user_secret_key( $user_id = 0 ) { |
| 445 | global $wpdb; |
| 446 | |
| 447 | if ( empty( $user_id ) ) { |
| 448 | return ''; |
| 449 | } |
| 450 | |
| 451 | $cache_key = md5( 'give_api_user_secret_key' . $user_id ); |
| 452 | $user_secret_key = Give_Cache::get( $cache_key, true ); |
| 453 | |
| 454 | if ( empty( $user_secret_key ) ) { |
| 455 | $user_secret_key = $wpdb->get_var( $wpdb->prepare( "SELECT meta_key FROM $wpdb->usermeta WHERE meta_value = 'give_user_secret_key' AND user_id = %d", $user_id ) ); |
| 456 | Give_Cache::set( $cache_key, $user_secret_key, HOUR_IN_SECONDS, true ); |
| 457 | } |
| 458 | |
| 459 | return $user_secret_key; |
| 460 | } |
| 461 | |
| 462 | /** |
| 463 | * Displays a missing authentication error if all the parameters are not met. |
| 464 | * provided |
| 465 | * |
| 466 | * @access private |
| 467 | * @uses Give_API::output() |
| 468 | * @since 1.1 |
| 469 | */ |
| 470 | private function missing_auth() { |
| 471 | $error = array(); |
| 472 | $error['error'] = __( 'You must specify both a token and API key.', 'give' ); |
| 473 | |
| 474 | $this->data = $error; |
| 475 | $this->output( 401 ); |
| 476 | } |
| 477 | |
| 478 | /** |
| 479 | * Displays an authentication failed error if the user failed to provide valid |
| 480 | * credentials |
| 481 | * |
| 482 | * @access private |
| 483 | * @since 1.1 |
| 484 | * @uses Give_API::output() |
| 485 | * @return void |
| 486 | */ |
| 487 | private function invalid_auth() { |
| 488 | $error = array(); |
| 489 | $error['error'] = __( 'Your request could not be authenticated.', 'give' ); |
| 490 | |
| 491 | $this->data = $error; |
| 492 | $this->output( 403 ); |
| 493 | } |
| 494 | |
| 495 | /** |
| 496 | * Displays an invalid API key error if the API key provided couldn't be |
| 497 | * validated |
| 498 | * |
| 499 | * @access private |
| 500 | * @since 1.1 |
| 501 | * @uses Give_API::output() |
| 502 | * @return void |
| 503 | */ |
| 504 | private function invalid_key() { |
| 505 | $error = array(); |
| 506 | $error['error'] = __( 'Invalid API key.', 'give' ); |
| 507 | |
| 508 | $this->data = $error; |
| 509 | $this->output( 403 ); |
| 510 | } |
| 511 | |
| 512 | /** |
| 513 | * Displays an invalid version error if the version number passed isn't valid |
| 514 | * |
| 515 | * @access private |
| 516 | * @since 1.1 |
| 517 | * @uses Give_API::output() |
| 518 | * @return void |
| 519 | */ |
| 520 | private function invalid_version() { |
| 521 | $error = array(); |
| 522 | $error['error'] = __( 'Invalid API version.', 'give' ); |
| 523 | |
| 524 | $this->data = $error; |
| 525 | $this->output( 404 ); |
| 526 | } |
| 527 | |
| 528 | /** |
| 529 | * Listens for the API and then processes the API requests |
| 530 | * |
| 531 | * @access public |
| 532 | * @global $wp_query |
| 533 | * @since 1.1 |
| 534 | * @return void |
| 535 | */ |
| 536 | public function process_query() { |
| 537 | |
| 538 | global $wp_query; |
| 539 | |
| 540 | // Start logging how long the request takes for logging |
| 541 | $before = microtime( true ); |
| 542 | |
| 543 | // Check for give-api var. Get out if not present |
| 544 | if ( empty( $wp_query->query_vars['give-api'] ) ) { |
| 545 | return; |
| 546 | } |
| 547 | |
| 548 | // Determine which version was queried |
| 549 | $this->set_queried_version(); |
| 550 | |
| 551 | // Determine the kind of query |
| 552 | $this->set_query_mode(); |
| 553 | |
| 554 | // Check for a valid user and set errors if necessary |
| 555 | $this->validate_request(); |
| 556 | |
| 557 | // Only proceed if no errors have been noted |
| 558 | if ( ! $this->is_valid_request ) { |
| 559 | return; |
| 560 | } |
| 561 | |
| 562 | if ( ! defined( 'GIVE_DOING_API' ) ) { |
| 563 | define( 'GIVE_DOING_API', true ); |
| 564 | } |
| 565 | |
| 566 | $data = array(); |
| 567 | $this->routes = new $this->versions[$this->get_queried_version()]; |
| 568 | $this->routes->validate_request(); |
| 569 | |
| 570 | switch ( $this->endpoint ) : |
| 571 | |
| 572 | case 'stats' : |
| 573 | |
| 574 | $data = $this->routes->get_stats( array( |
| 575 | 'type' => isset( $wp_query->query_vars['type'] ) ? $wp_query->query_vars['type'] : null, |
| 576 | 'form' => isset( $wp_query->query_vars['form'] ) ? $wp_query->query_vars['form'] : null, |
| 577 | 'date' => isset( $wp_query->query_vars['date'] ) ? $wp_query->query_vars['date'] : null, |
| 578 | 'startdate' => isset( $wp_query->query_vars['startdate'] ) ? $wp_query->query_vars['startdate'] : null, |
| 579 | 'enddate' => isset( $wp_query->query_vars['enddate'] ) ? $wp_query->query_vars['enddate'] : null, |
| 580 | ) ); |
| 581 | |
| 582 | break; |
| 583 | |
| 584 | case 'forms' : |
| 585 | |
| 586 | $form = isset( $wp_query->query_vars['form'] ) ? $wp_query->query_vars['form'] : null; |
| 587 | |
| 588 | $data = $this->routes->get_forms( $form ); |
| 589 | |
| 590 | break; |
| 591 | |
| 592 | case 'donors' : |
| 593 | |
| 594 | $donor = isset( $wp_query->query_vars['donor'] ) ? $wp_query->query_vars['donor'] : null; |
| 595 | |
| 596 | $data = $this->routes->get_donors( $donor ); |
| 597 | |
| 598 | break; |
| 599 | |
| 600 | case 'donations' : |
| 601 | |
| 602 | /** |
| 603 | * Call to get recent donations |
| 604 | * |
| 605 | * @params text date | today, yesterday or range |
| 606 | * @params date startdate | required when date = range and format to be YYYYMMDD (i.e. 20170524) |
| 607 | * @params date enddate | required when date = range and format to be YYYYMMDD (i.e. 20170524) |
| 608 | */ |
| 609 | $data = $this->routes->get_recent_donations( array( |
| 610 | 'id' => isset( $wp_query->query_vars['id'] ) ? $wp_query->query_vars['id'] : null, |
| 611 | 'date' => isset( $wp_query->query_vars['date'] ) ? $wp_query->query_vars['date'] : null, |
| 612 | 'startdate' => isset( $wp_query->query_vars['startdate'] ) ? $wp_query->query_vars['startdate'] : null, |
| 613 | 'enddate' => isset( $wp_query->query_vars['enddate'] ) ? $wp_query->query_vars['enddate'] : null, |
| 614 | ) ); |
| 615 | |
| 616 | break; |
| 617 | |
| 618 | endswitch; |
| 619 | |
| 620 | // Allow extensions to setup their own return data |
| 621 | $this->data = apply_filters( 'give_api_output_data', $data, $this->endpoint, $this ); |
| 622 | |
| 623 | $after = microtime( true ); |
| 624 | $request_time = ( $after - $before ); |
| 625 | $this->data['request_speed'] = $request_time; |
| 626 | |
| 627 | // Log this API request, if enabled. We log it here because we have access to errors. |
| 628 | $this->log_request( $this->data ); |
| 629 | |
| 630 | // Send out data to the output function |
| 631 | $this->output(); |
| 632 | } |
| 633 | |
| 634 | /** |
| 635 | * Returns the API endpoint requested |
| 636 | * |
| 637 | * @access public |
| 638 | * @since 1.1 |
| 639 | * @return string $query Query mode |
| 640 | */ |
| 641 | public function get_query_mode() { |
| 642 | |
| 643 | return $this->endpoint; |
| 644 | } |
| 645 | |
| 646 | /** |
| 647 | * Determines the kind of query requested and also ensure it is a valid query |
| 648 | * |
| 649 | * @access public |
| 650 | * @since 1.1 |
| 651 | * @global $wp_query |
| 652 | */ |
| 653 | public function set_query_mode() { |
| 654 | |
| 655 | global $wp_query; |
| 656 | |
| 657 | // Whitelist our query options |
| 658 | $accepted = apply_filters( 'give_api_valid_query_modes', array( |
| 659 | 'stats', |
| 660 | 'forms', |
| 661 | 'donors', |
| 662 | 'donations', |
| 663 | ) ); |
| 664 | |
| 665 | $query = isset( $wp_query->query_vars['give-api'] ) ? $wp_query->query_vars['give-api'] : null; |
| 666 | $query = str_replace( $this->queried_version . '/', '', $query ); |
| 667 | |
| 668 | $error = array(); |
| 669 | |
| 670 | // Make sure our query is valid |
| 671 | if ( ! in_array( $query, $accepted ) ) { |
| 672 | $error['error'] = __( 'Invalid query.', 'give' ); |
| 673 | |
| 674 | $this->data = $error; |
| 675 | // 400 is Bad Request |
| 676 | $this->output( 400 ); |
| 677 | } |
| 678 | |
| 679 | $this->endpoint = $query; |
| 680 | } |
| 681 | |
| 682 | /** |
| 683 | * Get page number |
| 684 | * |
| 685 | * @access public |
| 686 | * @since 1.1 |
| 687 | * @global $wp_query |
| 688 | * @return int $wp_query->query_vars['page'] if page number returned (default: 1) |
| 689 | */ |
| 690 | public function get_paged() { |
| 691 | global $wp_query; |
| 692 | |
| 693 | return isset( $wp_query->query_vars['page'] ) ? $wp_query->query_vars['page'] : 1; |
| 694 | } |
| 695 | |
| 696 | |
| 697 | /** |
| 698 | * Number of results to display per page |
| 699 | * |
| 700 | * @access public |
| 701 | * @since 1.1 |
| 702 | * @global $wp_query |
| 703 | * @return int $per_page Results to display per page (default: 10) |
| 704 | */ |
| 705 | public function per_page() { |
| 706 | global $wp_query; |
| 707 | |
| 708 | $per_page = isset( $wp_query->query_vars['number'] ) ? $wp_query->query_vars['number'] : 10; |
| 709 | |
| 710 | if ( $per_page < 0 && $this->get_query_mode() == 'donors' ) { |
| 711 | $per_page = 99999999; |
| 712 | } // End if(). |
| 713 | |
| 714 | return apply_filters( 'give_api_results_per_page', $per_page ); |
| 715 | } |
| 716 | |
| 717 | /** |
| 718 | * Sets up the dates used to retrieve earnings/donations |
| 719 | * |
| 720 | * @access public |
| 721 | * @since 1.2 |
| 722 | * |
| 723 | * @param array $args Arguments to override defaults |
| 724 | * |
| 725 | * @return array $dates |
| 726 | */ |
| 727 | public function get_dates( $args = array() ) { |
| 728 | $dates = array(); |
| 729 | |
| 730 | $defaults = array( |
| 731 | 'type' => '', |
| 732 | 'form' => null, |
| 733 | 'date' => null, |
| 734 | 'startdate' => null, |
| 735 | 'enddate' => null, |
| 736 | ); |
| 737 | |
| 738 | $args = wp_parse_args( $args, $defaults ); |
| 739 | |
| 740 | $current_time = current_time( 'timestamp' ); |
| 741 | |
| 742 | if ( 'range' === $args['date'] ) { |
| 743 | $startdate = strtotime( $args['startdate'] ); |
| 744 | $enddate = strtotime( $args['enddate'] ); |
| 745 | $dates['day_start'] = date( 'd', $startdate ); |
| 746 | $dates['day_end'] = date( 'd', $enddate ); |
| 747 | $dates['m_start'] = date( 'n', $startdate ); |
| 748 | $dates['m_end'] = date( 'n', $enddate ); |
| 749 | $dates['year'] = date( 'Y', $startdate ); |
| 750 | $dates['year_end'] = date( 'Y', $enddate ); |
| 751 | } else { |
| 752 | // Modify dates based on predefined ranges |
| 753 | switch ( $args['date'] ) : |
| 754 | |
| 755 | case 'this_month' : |
| 756 | $dates['day'] = null; |
| 757 | $dates['m_start'] = date( 'n', $current_time ); |
| 758 | $dates['m_end'] = date( 'n', $current_time ); |
| 759 | $dates['year'] = date( 'Y', $current_time ); |
| 760 | break; |
| 761 | |
| 762 | case 'last_month' : |
| 763 | $dates['day'] = null; |
| 764 | $dates['m_start'] = date( 'n', $current_time ) == 1 ? 12 : date( 'n', $current_time ) - 1; |
| 765 | $dates['m_end'] = $dates['m_start']; |
| 766 | $dates['year'] = date( 'n', $current_time ) == 1 ? date( 'Y', $current_time ) - 1 : date( 'Y', $current_time ); |
| 767 | break; |
| 768 | |
| 769 | case 'today' : |
| 770 | $dates['day'] = date( 'd', $current_time ); |
| 771 | $dates['m_start'] = date( 'n', $current_time ); |
| 772 | $dates['m_end'] = date( 'n', $current_time ); |
| 773 | $dates['year'] = date( 'Y', $current_time ); |
| 774 | break; |
| 775 | |
| 776 | case 'yesterday' : |
| 777 | |
| 778 | $year = date( 'Y', $current_time ); |
| 779 | $month = date( 'n', $current_time ); |
| 780 | $day = date( 'd', $current_time ); |
| 781 | |
| 782 | if ( $month == 1 && $day == 1 ) { |
| 783 | |
| 784 | $year -= 1; |
| 785 | $month = 12; |
| 786 | $day = cal_days_in_month( CAL_GREGORIAN, $month, $year ); |
| 787 | |
| 788 | } elseif ( $month > 1 && $day == 1 ) { |
| 789 | |
| 790 | $month -= 1; |
| 791 | $day = cal_days_in_month( CAL_GREGORIAN, $month, $year ); |
| 792 | |
| 793 | } else { |
| 794 | |
| 795 | $day -= 1; |
| 796 | |
| 797 | } |
| 798 | |
| 799 | $dates['day'] = $day; |
| 800 | $dates['m_start'] = $month; |
| 801 | $dates['m_end'] = $month; |
| 802 | $dates['year'] = $year; |
| 803 | |
| 804 | break; |
| 805 | |
| 806 | case 'this_quarter' : |
| 807 | $month_now = date( 'n', $current_time ); |
| 808 | |
| 809 | $dates['day'] = null; |
| 810 | |
| 811 | if ( $month_now <= 3 ) { |
| 812 | |
| 813 | $dates['m_start'] = 1; |
| 814 | $dates['m_end'] = 3; |
| 815 | $dates['year'] = date( 'Y', $current_time ); |
| 816 | |
| 817 | } elseif ( $month_now <= 6 ) { |
| 818 | |
| 819 | $dates['m_start'] = 4; |
| 820 | $dates['m_end'] = 6; |
| 821 | $dates['year'] = date( 'Y', $current_time ); |
| 822 | |
| 823 | } elseif ( $month_now <= 9 ) { |
| 824 | |
| 825 | $dates['m_start'] = 7; |
| 826 | $dates['m_end'] = 9; |
| 827 | $dates['year'] = date( 'Y', $current_time ); |
| 828 | |
| 829 | } else { |
| 830 | |
| 831 | $dates['m_start'] = 10; |
| 832 | $dates['m_end'] = 12; |
| 833 | $dates['year'] = date( 'Y', $current_time ); |
| 834 | |
| 835 | } |
| 836 | break; |
| 837 | |
| 838 | case 'last_quarter' : |
| 839 | $month_now = date( 'n', $current_time ); |
| 840 | |
| 841 | $dates['day'] = null; |
| 842 | |
| 843 | if ( $month_now <= 3 ) { |
| 844 | |
| 845 | $dates['m_start'] = 10; |
| 846 | $dates['m_end'] = 12; |
| 847 | $dates['year'] = date( 'Y', $current_time ) - 1; // Previous year |
| 848 | |
| 849 | } elseif ( $month_now <= 6 ) { |
| 850 | |
| 851 | $dates['m_start'] = 1; |
| 852 | $dates['m_end'] = 3; |
| 853 | $dates['year'] = date( 'Y', $current_time ); |
| 854 | |
| 855 | } elseif ( $month_now <= 9 ) { |
| 856 | |
| 857 | $dates['m_start'] = 4; |
| 858 | $dates['m_end'] = 6; |
| 859 | $dates['year'] = date( 'Y', $current_time ); |
| 860 | |
| 861 | } else { |
| 862 | |
| 863 | $dates['m_start'] = 7; |
| 864 | $dates['m_end'] = 9; |
| 865 | $dates['year'] = date( 'Y', $current_time ); |
| 866 | |
| 867 | } |
| 868 | break; |
| 869 | |
| 870 | case 'this_year' : |
| 871 | $dates['day'] = null; |
| 872 | $dates['m_start'] = null; |
| 873 | $dates['m_end'] = null; |
| 874 | $dates['year'] = date( 'Y', $current_time ); |
| 875 | break; |
| 876 | |
| 877 | case 'last_year' : |
| 878 | $dates['day'] = null; |
| 879 | $dates['m_start'] = null; |
| 880 | $dates['m_end'] = null; |
| 881 | $dates['year'] = date( 'Y', $current_time ) - 1; |
| 882 | break; |
| 883 | |
| 884 | endswitch; |
| 885 | }// End if(). |
| 886 | |
| 887 | /** |
| 888 | * Returns the filters for the dates used to retrieve earnings. |
| 889 | * |
| 890 | * @since 1.2 |
| 891 | * |
| 892 | * @param array $dates The dates used for retrieving earnings. |
| 893 | */ |
| 894 | return apply_filters( 'give_api_stat_dates', $dates ); |
| 895 | } |
| 896 | |
| 897 | /** |
| 898 | * Process Get Donors API Request. |
| 899 | * |
| 900 | * @access public |
| 901 | * @since 1.1 |
| 902 | * @global WPDB $wpdb Used to query the database using the WordPress Database API. |
| 903 | * |
| 904 | * @param int $donor Donor ID |
| 905 | * |
| 906 | * @return array $donors Multidimensional array of the donors. |
| 907 | */ |
| 908 | public function get_donors( $donor = null ) { |
| 909 | |
| 910 | $donors = array(); |
| 911 | $error = array(); |
| 912 | if ( ! user_can( $this->user_id, 'view_give_sensitive_data' ) && ! $this->override ) { |
| 913 | return $donors; |
| 914 | } |
| 915 | |
| 916 | $paged = $this->get_paged(); |
| 917 | $per_page = $this->per_page(); |
| 918 | $offset = $per_page * ( $paged - 1 ); |
| 919 | |
| 920 | if ( is_numeric( $donor ) ) { |
| 921 | $field = 'id'; |
| 922 | } else { |
| 923 | $field = 'email'; |
| 924 | } |
| 925 | |
| 926 | $donor_query = Give()->donors->get_donors( array( |
| 927 | 'number' => $per_page, |
| 928 | 'offset' => $offset, |
| 929 | $field => $donor, |
| 930 | ) ); |
| 931 | $donor_count = 0; |
| 932 | |
| 933 | if ( $donor_query ) { |
| 934 | |
| 935 | foreach ( $donor_query as $donor_obj ) { |
| 936 | |
| 937 | $names = explode( ' ', $donor_obj->name ); |
| 938 | $first_name = ! empty( $names[0] ) ? $names[0] : ''; |
| 939 | $last_name = ''; |
| 940 | if ( ! empty( $names[1] ) ) { |
| 941 | unset( $names[0] ); |
| 942 | $last_name = implode( ' ', $names ); |
| 943 | } |
| 944 | |
| 945 | $donors['donors'][ $donor_count ]['info']['user_id'] = ''; |
| 946 | $donors['donors'][ $donor_count ]['info']['username'] = ''; |
| 947 | $donors['donors'][ $donor_count ]['info']['display_name'] = ''; |
| 948 | $donors['donors'][ $donor_count ]['info']['donor_id'] = $donor_obj->id; |
| 949 | $donors['donors'][ $donor_count ]['info']['first_name'] = $first_name; |
| 950 | $donors['donors'][ $donor_count ]['info']['last_name'] = $last_name; |
| 951 | $donors['donors'][ $donor_count ]['info']['email'] = $donor_obj->email; |
| 952 | |
| 953 | if ( ! empty( $donor_obj->user_id ) ) { |
| 954 | |
| 955 | $user_data = get_userdata( $donor_obj->user_id ); |
| 956 | |
| 957 | // Donor with registered account. |
| 958 | $donors['donors'][ $donor_count ]['info']['user_id'] = $donor_obj->user_id; |
| 959 | $donors['donors'][ $donor_count ]['info']['username'] = $user_data->user_login; |
| 960 | $donors['donors'][ $donor_count ]['info']['display_name'] = $user_data->display_name; |
| 961 | |
| 962 | } |
| 963 | |
| 964 | $donors['donors'][ $donor_count ]['stats']['total_donations'] = $donor_obj->purchase_count; |
| 965 | $donors['donors'][ $donor_count ]['stats']['total_spent'] = $donor_obj->purchase_value; |
| 966 | |
| 967 | /** @var $donor \Give_Donor */ |
| 968 | $donor = new Give_Donor( $donor_obj->id ); |
| 969 | |
| 970 | // Get donor's addresses. |
| 971 | $donors['donors'][ $donor_count ]['address'] = $donor->address; |
| 972 | |
| 973 | $donor_count ++; |
| 974 | |
| 975 | } |
| 976 | } elseif ( $donor ) { |
| 977 | |
| 978 | $error['error'] = sprintf( /* translators: %s: donor */ |
| 979 | __( 'Donor %s not found.', 'give' ), $donor ); |
| 980 | |
| 981 | return $error; |
| 982 | |
| 983 | } else { |
| 984 | |
| 985 | $error['error'] = __( 'No donors found.', 'give' ); |
| 986 | |
| 987 | return $error; |
| 988 | |
| 989 | }// End if(). |
| 990 | |
| 991 | return $donors; |
| 992 | } |
| 993 | |
| 994 | /** |
| 995 | * Process Get Donation Forms API Request |
| 996 | * |
| 997 | * @access public |
| 998 | * @since 1.1 |
| 999 | * |
| 1000 | * @param int $form Give Form ID. |
| 1001 | * |
| 1002 | * @return array $donors Multidimensional array of the forms. |
| 1003 | */ |
| 1004 | public function get_forms( $form = null ) { |
| 1005 | |
| 1006 | $forms = array(); |
| 1007 | $error = array(); |
| 1008 | |
| 1009 | if ( $form == null ) { |
| 1010 | $forms['forms'] = array(); |
| 1011 | |
| 1012 | $form_list = get_posts( array( |
| 1013 | 'post_type' => 'give_forms', |
| 1014 | 'posts_per_page' => $this->per_page(), |
| 1015 | 'suppress_filters' => true, |
| 1016 | 'paged' => $this->get_paged(), |
| 1017 | ) ); |
| 1018 | |
| 1019 | if ( $form_list ) { |
| 1020 | $i = 0; |
| 1021 | foreach ( $form_list as $form_info ) { |
| 1022 | $forms['forms'][ $i ] = $this->get_form_data( $form_info ); |
| 1023 | $i ++; |
| 1024 | } |
| 1025 | } |
| 1026 | } else { |
| 1027 | if ( get_post_type( $form ) == 'give_forms' ) { |
| 1028 | $form_info = get_post( $form ); |
| 1029 | |
| 1030 | $forms['forms'][0] = $this->get_form_data( $form_info ); |
| 1031 | |
| 1032 | } else { |
| 1033 | $error['error'] = sprintf( /* translators: %s: form */ |
| 1034 | __( 'Form %s not found.', 'give' ), $form ); |
| 1035 | |
| 1036 | return $error; |
| 1037 | } |
| 1038 | } |
| 1039 | |
| 1040 | return $forms; |
| 1041 | } |
| 1042 | |
| 1043 | /** |
| 1044 | * Given a give_forms post object, generate the data for the API output |
| 1045 | * |
| 1046 | * @since 1.1 |
| 1047 | * |
| 1048 | * @param object $form_info The Give Form's Post Object. |
| 1049 | * |
| 1050 | * @return array Array of post data to return back in the API. |
| 1051 | */ |
| 1052 | private function get_form_data( $form_info ) { |
| 1053 | |
| 1054 | $form = array(); |
| 1055 | |
| 1056 | $form['info']['id'] = $form_info->ID; |
| 1057 | $form['info']['slug'] = $form_info->post_name; |
| 1058 | $form['info']['title'] = $form_info->post_title; |
| 1059 | $form['info']['create_date'] = $form_info->post_date; |
| 1060 | $form['info']['modified_date'] = $form_info->post_modified; |
| 1061 | $form['info']['status'] = $form_info->post_status; |
| 1062 | $form['info']['link'] = html_entity_decode( $form_info->guid ); |
| 1063 | $form['info']['content'] = give_get_meta( $form_info->ID, '_give_form_content', true ); |
| 1064 | $form['info']['thumbnail'] = wp_get_attachment_url( get_post_thumbnail_id( $form_info->ID ) ); |
| 1065 | |
| 1066 | if ( give_is_setting_enabled( give_get_option( 'categories', 'disabled' ) ) ) { |
| 1067 | $form['info']['category'] = get_the_terms( $form_info, 'give_forms_category' ); |
| 1068 | $form['info']['tags'] = get_the_terms( $form_info, 'give_forms_tag' ); |
| 1069 | } |
| 1070 | if ( give_is_setting_enabled( give_get_option( 'tags', 'disabled' ) ) ) { |
| 1071 | $form['info']['tags'] = get_the_terms( $form_info, 'give_forms_tag' ); |
| 1072 | } |
| 1073 | |
| 1074 | // Check whether any goal is to be achieved for the donation form. |
| 1075 | $goal_option = give_get_meta( $form_info->ID, '_give_goal_option', true ); |
| 1076 | $goal_amount = give_get_meta( $form_info->ID, '_give_set_goal', true ); |
| 1077 | if ( give_is_setting_enabled( $goal_option ) && $goal_amount ) { |
| 1078 | $total_income = give_get_form_earnings_stats( $form_info->ID ); |
| 1079 | $goal_percentage_completed = ( $total_income < $goal_amount ) ? round( ( $total_income / $goal_amount ) * 100, 2 ) : 100; |
| 1080 | $form['goal']['amount'] = isset( $goal_amount ) ? $goal_amount : ''; |
| 1081 | $form['goal']['percentage_completed'] = isset( $goal_percentage_completed ) ? $goal_percentage_completed : ''; |
| 1082 | } |
| 1083 | |
| 1084 | if ( user_can( $this->user_id, 'view_give_reports' ) || $this->override ) { |
| 1085 | $form['stats']['total']['donations'] = give_get_form_sales_stats( $form_info->ID ); |
| 1086 | $form['stats']['total']['earnings'] = give_get_form_earnings_stats( $form_info->ID ); |
| 1087 | $form['stats']['monthly_average']['donations'] = give_get_average_monthly_form_sales( $form_info->ID ); |
| 1088 | $form['stats']['monthly_average']['earnings'] = give_get_average_monthly_form_earnings( $form_info->ID ); |
| 1089 | } |
| 1090 | |
| 1091 | $counter = 0; |
| 1092 | if ( give_has_variable_prices( $form_info->ID ) ) { |
| 1093 | foreach ( give_get_variable_prices( $form_info->ID ) as $price ) { |
| 1094 | $counter ++; |
| 1095 | // multi-level item |
| 1096 | $level = isset( $price['_give_text'] ) ? $price['_give_text'] : 'level-' . $counter; |
| 1097 | $form['pricing'][ sanitize_key( $level ) ] = $price['_give_amount']; |
| 1098 | |
| 1099 | } |
| 1100 | } else { |
| 1101 | $form['pricing']['amount'] = give_get_form_price( $form_info->ID ); |
| 1102 | } |
| 1103 | |
| 1104 | if ( user_can( $this->user_id, 'view_give_sensitive_data' ) || $this->override ) { |
| 1105 | |
| 1106 | /** |
| 1107 | * Fires when generating API sensitive data. |
| 1108 | * |
| 1109 | * @since 1.1 |
| 1110 | */ |
| 1111 | do_action( 'give_api_sensitive_data' ); |
| 1112 | |
| 1113 | } |
| 1114 | |
| 1115 | return apply_filters( 'give_api_forms_form', $form ); |
| 1116 | |
| 1117 | } |
| 1118 | |
| 1119 | /** |
| 1120 | * Process Get Stats API Request |
| 1121 | * |
| 1122 | * @since 1.1 |
| 1123 | * |
| 1124 | * @global WPDB $wpdb Used to query the database using the WordPress. |
| 1125 | * |
| 1126 | * @param array $args Arguments provided by API Request. |
| 1127 | * |
| 1128 | * @return array |
| 1129 | */ |
| 1130 | public function get_stats( $args = array() ) { |
| 1131 | $defaults = array( |
| 1132 | 'type' => null, |
| 1133 | 'form' => null, |
| 1134 | 'date' => null, |
| 1135 | 'startdate' => null, |
| 1136 | 'enddate' => null, |
| 1137 | ); |
| 1138 | |
| 1139 | $args = wp_parse_args( $args, $defaults ); |
| 1140 | |
| 1141 | $dates = $this->get_dates( $args ); |
| 1142 | |
| 1143 | $stats = array(); |
| 1144 | $earnings = array( |
| 1145 | 'earnings' => array(), |
| 1146 | ); |
| 1147 | $donations = array( |
| 1148 | 'donations' => array(), |
| 1149 | ); |
| 1150 | $error = array(); |
| 1151 | |
| 1152 | if ( ! user_can( $this->user_id, 'view_give_reports' ) && ! $this->override ) { |
| 1153 | return $stats; |
| 1154 | } |
| 1155 | |
| 1156 | if ( $args['type'] == 'donations' ) { |
| 1157 | |
| 1158 | if ( $args['form'] == null ) { |
| 1159 | if ( $args['date'] == null ) { |
| 1160 | $donations = $this->get_default_sales_stats(); |
| 1161 | } elseif ( $args['date'] === 'range' ) { |
| 1162 | // Return donations for a date range. |
| 1163 | // Ensure the end date is later than the start date. |
| 1164 | if ( $args['enddate'] < $args['startdate'] ) { |
| 1165 | $error['error'] = __( 'The end date must be later than the start date.', 'give' ); |
| 1166 | } |
| 1167 | |
| 1168 | // Ensure both the start and end date are specified |
| 1169 | if ( empty( $args['startdate'] ) || empty( $args['enddate'] ) ) { |
| 1170 | $error['error'] = __( 'Invalid or no date range specified.', 'give' ); |
| 1171 | } |
| 1172 | |
| 1173 | $total = 0; |
| 1174 | |
| 1175 | // Loop through the years |
| 1176 | $y = $dates['year']; |
| 1177 | while ( $y <= $dates['year_end'] ) : |
| 1178 | |
| 1179 | if ( $dates['year'] == $dates['year_end'] ) { |
| 1180 | $month_start = $dates['m_start']; |
| 1181 | $month_end = $dates['m_end']; |
| 1182 | } elseif ( $y == $dates['year'] && $dates['year_end'] > $dates['year'] ) { |
| 1183 | $month_start = $dates['m_start']; |
| 1184 | $month_end = 12; |
| 1185 | } elseif ( $y == $dates['year_end'] ) { |
| 1186 | $month_start = 1; |
| 1187 | $month_end = $dates['m_end']; |
| 1188 | } else { |
| 1189 | $month_start = 1; |
| 1190 | $month_end = 12; |
| 1191 | } |
| 1192 | |
| 1193 | $i = $month_start; |
| 1194 | while ( $i <= $month_end ) : |
| 1195 | |
| 1196 | if ( $i == $dates['m_start'] ) { |
| 1197 | $d = $dates['day_start']; |
| 1198 | } else { |
| 1199 | $d = 1; |
| 1200 | } |
| 1201 | |
| 1202 | if ( $i == $dates['m_end'] ) { |
| 1203 | $num_of_days = $dates['day_end']; |
| 1204 | } else { |
| 1205 | $num_of_days = cal_days_in_month( CAL_GREGORIAN, $i, $y ); |
| 1206 | } |
| 1207 | |
| 1208 | while ( $d <= $num_of_days ) : |
| 1209 | $sale_count = give_get_sales_by_date( $d, $i, $y ); |
| 1210 | $date_key = date( 'Ymd', strtotime( $y . '/' . $i . '/' . $d ) ); |
| 1211 | if ( ! isset( $donations['sales'][ $date_key ] ) ) { |
| 1212 | $donations['sales'][ $date_key ] = 0; |
| 1213 | } |
| 1214 | $donations['sales'][ $date_key ] += $sale_count; |
| 1215 | $total += $sale_count; |
| 1216 | $d ++; |
| 1217 | endwhile; |
| 1218 | $i ++; |
| 1219 | endwhile; |
| 1220 | |
| 1221 | $y ++; |
| 1222 | endwhile; |
| 1223 | |
| 1224 | $donations['totals'] = $total; |
| 1225 | } else { |
| 1226 | if ( $args['date'] == 'this_quarter' || $args['date'] == 'last_quarter' ) { |
| 1227 | $donations_count = 0; |
| 1228 | |
| 1229 | // Loop through the months |
| 1230 | $month = $dates['m_start']; |
| 1231 | |
| 1232 | while ( $month <= $dates['m_end'] ) : |
| 1233 | $donations_count += give_get_sales_by_date( null, $month, $dates['year'] ); |
| 1234 | $month ++; |
| 1235 | endwhile; |
| 1236 | |
| 1237 | $donations['donations'][ $args['date'] ] = $donations_count; |
| 1238 | } else { |
| 1239 | $donations['donations'][ $args['date'] ] = give_get_sales_by_date( $dates['day'], $dates['m_start'], $dates['year'] ); |
| 1240 | } |
| 1241 | }// End if(). |
| 1242 | } elseif ( $args['form'] == 'all' ) { |
| 1243 | $forms = get_posts( array( |
| 1244 | 'post_type' => 'give_forms', |
| 1245 | 'nopaging' => true, |
| 1246 | ) ); |
| 1247 | $i = 0; |
| 1248 | foreach ( $forms as $form_info ) { |
| 1249 | $donations['donations'][ $i ] = array( |
| 1250 | $form_info->post_name => $this->stats->get_sales( |
| 1251 | $form_info->ID, |
| 1252 | is_numeric( $args['startdate'] ) |
| 1253 | ? strtotime( $args['startdate'] ) |
| 1254 | : $args['startdate'], |
| 1255 | is_numeric( $args['enddate'] ) |
| 1256 | ? strtotime( $args['enddate'] ) |
| 1257 | : $args['enddate'] |
| 1258 | ), |
| 1259 | ); |
| 1260 | $i ++; |
| 1261 | } |
| 1262 | } else { |
| 1263 | if ( get_post_type( $args['form'] ) == 'give_forms' ) { |
| 1264 | $form_info = get_post( $args['form'] ); |
| 1265 | $donations['donations'][0] = array( |
| 1266 | $form_info->post_name => $this->stats->get_sales( |
| 1267 | $args['form'], |
| 1268 | is_numeric( $args['startdate'] ) |
| 1269 | ? strtotime( $args['startdate'] ) |
| 1270 | : $args['startdate'], |
| 1271 | is_numeric( $args['enddate'] ) |
| 1272 | ? strtotime( $args['enddate'] ) |
| 1273 | : $args['enddate'] |
| 1274 | ), |
| 1275 | ); |
| 1276 | } else { |
| 1277 | $error['error'] = sprintf( /* translators: %s: form */ |
| 1278 | __( 'Form %s not found.', 'give' ), $args['form'] ); |
| 1279 | } |
| 1280 | }// End if(). |
| 1281 | |
| 1282 | if ( ! empty( $error ) ) { |
| 1283 | return $error; |
| 1284 | } |
| 1285 | |
| 1286 | return $donations; |
| 1287 | |
| 1288 | } elseif ( $args['type'] == 'earnings' ) { |
| 1289 | if ( $args['form'] == null ) { |
| 1290 | if ( $args['date'] == null ) { |
| 1291 | $earnings = $this->get_default_earnings_stats(); |
| 1292 | } elseif ( $args['date'] === 'range' ) { |
| 1293 | // Return sales for a date range |
| 1294 | // Ensure the end date is later than the start date |
| 1295 | if ( $args['enddate'] < $args['startdate'] ) { |
| 1296 | $error['error'] = __( 'The end date must be later than the start date.', 'give' ); |
| 1297 | } |
| 1298 | |
| 1299 | // Ensure both the start and end date are specified |
| 1300 | if ( empty( $args['startdate'] ) || empty( $args['enddate'] ) ) { |
| 1301 | $error['error'] = __( 'Invalid or no date range specified.', 'give' ); |
| 1302 | } |
| 1303 | |
| 1304 | $total = (float) 0.00; |
| 1305 | |
| 1306 | // Loop through the years |
| 1307 | $y = $dates['year']; |
| 1308 | if ( ! isset( $earnings['earnings'] ) ) { |
| 1309 | $earnings['earnings'] = array(); |
| 1310 | } |
| 1311 | while ( $y <= $dates['year_end'] ) : |
| 1312 | |
| 1313 | if ( $dates['year'] == $dates['year_end'] ) { |
| 1314 | $month_start = $dates['m_start']; |
| 1315 | $month_end = $dates['m_end']; |
| 1316 | } elseif ( $y == $dates['year'] && $dates['year_end'] > $dates['year'] ) { |
| 1317 | $month_start = $dates['m_start']; |
| 1318 | $month_end = 12; |
| 1319 | } elseif ( $y == $dates['year_end'] ) { |
| 1320 | $month_start = 1; |
| 1321 | $month_end = $dates['m_end']; |
| 1322 | } else { |
| 1323 | $month_start = 1; |
| 1324 | $month_end = 12; |
| 1325 | } |
| 1326 | |
| 1327 | $i = $month_start; |
| 1328 | while ( $i <= $month_end ) : |
| 1329 | |
| 1330 | if ( $i == $dates['m_start'] ) { |
| 1331 | $d = $dates['day_start']; |
| 1332 | } else { |
| 1333 | $d = 1; |
| 1334 | } |
| 1335 | |
| 1336 | if ( $i == $dates['m_end'] ) { |
| 1337 | $num_of_days = $dates['day_end']; |
| 1338 | } else { |
| 1339 | $num_of_days = cal_days_in_month( CAL_GREGORIAN, $i, $y ); |
| 1340 | } |
| 1341 | |
| 1342 | while ( $d <= $num_of_days ) : |
| 1343 | $earnings_stat = give_get_earnings_by_date( $d, $i, $y ); |
| 1344 | $date_key = date( 'Ymd', strtotime( $y . '/' . $i . '/' . $d ) ); |
| 1345 | if ( ! isset( $earnings['earnings'][ $date_key ] ) ) { |
| 1346 | $earnings['earnings'][ $date_key ] = 0; |
| 1347 | } |
| 1348 | $earnings['earnings'][ $date_key ] += $earnings_stat; |
| 1349 | $total += $earnings_stat; |
| 1350 | $d ++; |
| 1351 | endwhile; |
| 1352 | |
| 1353 | $i ++; |
| 1354 | endwhile; |
| 1355 | |
| 1356 | $y ++; |
| 1357 | endwhile; |
| 1358 | |
| 1359 | $earnings['totals'] = $total; |
| 1360 | } else { |
| 1361 | if ( $args['date'] == 'this_quarter' || $args['date'] == 'last_quarter' ) { |
| 1362 | $earnings_count = (float) 0.00; |
| 1363 | |
| 1364 | // Loop through the months |
| 1365 | $month = $dates['m_start']; |
| 1366 | |
| 1367 | while ( $month <= $dates['m_end'] ) : |
| 1368 | $earnings_count += give_get_earnings_by_date( null, $month, $dates['year'] ); |
| 1369 | $month ++; |
| 1370 | endwhile; |
| 1371 | |
| 1372 | $earnings['earnings'][ $args['date'] ] = $earnings_count; |
| 1373 | } else { |
| 1374 | $earnings['earnings'][ $args['date'] ] = give_get_earnings_by_date( $dates['day'], $dates['m_start'], $dates['year'] ); |
| 1375 | } |
| 1376 | }// End if(). |
| 1377 | } elseif ( $args['form'] == 'all' ) { |
| 1378 | $forms = get_posts( array( |
| 1379 | 'post_type' => 'give_forms', |
| 1380 | 'nopaging' => true, |
| 1381 | ) ); |
| 1382 | |
| 1383 | $i = 0; |
| 1384 | foreach ( $forms as $form_info ) { |
| 1385 | $earnings['earnings'][ $i ] = array( |
| 1386 | $form_info->post_name => give_get_form_earnings_stats( $form_info->ID ), |
| 1387 | ); |
| 1388 | $i ++; |
| 1389 | } |
| 1390 | } else { |
| 1391 | if ( get_post_type( $args['form'] ) == 'give_forms' ) { |
| 1392 | $form_info = get_post( $args['form'] ); |
| 1393 | $earnings['earnings'][0] = array( |
| 1394 | $form_info->post_name => $this->stats->get_earnings( |
| 1395 | $args['form'], |
| 1396 | is_numeric( $args['startdate'] ) |
| 1397 | ? strtotime( $args['startdate'] ) |
| 1398 | : $args['startdate'], |
| 1399 | is_numeric( $args['enddate'] ) |
| 1400 | ? strtotime( $args['enddate'] ) |
| 1401 | : $args['enddate'] |
| 1402 | ), |
| 1403 | ); |
| 1404 | } else { |
| 1405 | $error['error'] = sprintf( /* translators: %s: form */ |
| 1406 | __( 'Form %s not found.', 'give' ), $args['form'] ); |
| 1407 | } |
| 1408 | }// End if(). |
| 1409 | |
| 1410 | if ( ! empty( $error ) ) { |
| 1411 | return $error; |
| 1412 | } |
| 1413 | |
| 1414 | return $earnings; |
| 1415 | } elseif ( $args['type'] == 'donors' ) { |
| 1416 | $donors = new Give_DB_Donors(); |
| 1417 | $stats['donations']['total_donors'] = $donors->count(); |
| 1418 | |
| 1419 | return $stats; |
| 1420 | |
| 1421 | } elseif ( empty( $args['type'] ) ) { |
| 1422 | $stats = array_merge( $stats, $this->get_default_sales_stats() ); |
| 1423 | $stats = array_merge( $stats, $this->get_default_earnings_stats() ); |
| 1424 | |
| 1425 | return array( |
| 1426 | 'stats' => $stats, |
| 1427 | ); |
| 1428 | }// End if(). |
| 1429 | } |
| 1430 | |
| 1431 | /** |
| 1432 | * Retrieves Recent Donations |
| 1433 | * |
| 1434 | * @access public |
| 1435 | * @since 1.1 |
| 1436 | * |
| 1437 | * @param $args array |
| 1438 | * |
| 1439 | * @return array |
| 1440 | */ |
| 1441 | public function get_recent_donations( $args = array() ) { |
| 1442 | global $wp_query; |
| 1443 | |
| 1444 | $defaults = array( |
| 1445 | 'id' => null, |
| 1446 | 'date' => null, |
| 1447 | 'startdate' => null, |
| 1448 | 'enddate' => null, |
| 1449 | ); |
| 1450 | |
| 1451 | $args = wp_parse_args( $args, $defaults ); |
| 1452 | |
| 1453 | $donations = array(); |
| 1454 | |
| 1455 | if ( ! user_can( $this->user_id, 'view_give_reports' ) && ! $this->override ) { |
| 1456 | return $donations; |
| 1457 | } |
| 1458 | |
| 1459 | if ( isset( $wp_query->query_vars['id'] ) ) { |
| 1460 | $query = array(); |
| 1461 | $query[] = new Give_Payment( $wp_query->query_vars['id'] ); |
| 1462 | } elseif ( isset( $wp_query->query_vars['purchasekey'] ) ) { |
| 1463 | $query = array(); |
| 1464 | $query[] = give_get_payment_by( 'key', $wp_query->query_vars['purchasekey'] ); |
| 1465 | } elseif ( isset( $wp_query->query_vars['email'] ) ) { |
| 1466 | $args = array( |
| 1467 | 'fields' => 'ids', |
| 1468 | 'meta_key' => '_give_payment_donor_email', |
| 1469 | 'meta_value' => $wp_query->query_vars['email'], |
| 1470 | 'number' => $this->per_page(), |
| 1471 | 'page' => $this->get_paged(), |
| 1472 | ); |
| 1473 | $query = give_get_payments( $args ); |
| 1474 | } elseif ( isset( $wp_query->query_vars['date'] ) ) { |
| 1475 | |
| 1476 | $current_time = current_time( 'timestamp' ); |
| 1477 | $dates = $this->get_dates( $args ); |
| 1478 | $start_date = ''; |
| 1479 | $end_date = ''; |
| 1480 | |
| 1481 | /** |
| 1482 | * Switch case for date query argument |
| 1483 | * |
| 1484 | * @since 1.8.8 |
| 1485 | * |
| 1486 | * @params text date | today, yesterday or range |
| 1487 | * @params date startdate | required when date = range and format to be YYYYMMDD (i.e. 20170524) |
| 1488 | * @params date enddate | required when date = range and format to be YYYYMMDD (i.e. 20170524) |
| 1489 | */ |
| 1490 | switch ( $wp_query->query_vars['date'] ) { |
| 1491 | |
| 1492 | case 'today': |
| 1493 | |
| 1494 | // Set and Format Start and End Date to be date of today. |
| 1495 | $start_date = $end_date = date( 'Y/m/d', $current_time ); |
| 1496 | |
| 1497 | break; |
| 1498 | |
| 1499 | case 'yesterday': |
| 1500 | |
| 1501 | // Set and Format Start and End Date to be date of yesterday. |
| 1502 | $start_date = $end_date = date( 'Y/m', $current_time ) . '/' . ( date( 'd', $current_time ) - 1 ); |
| 1503 | |
| 1504 | break; |
| 1505 | |
| 1506 | case 'range': |
| 1507 | |
| 1508 | // Format Start Date and End Date for filtering payment based on date range. |
| 1509 | $start_date = $dates['year'] . '/' . $dates['m_start'] . '/' . $dates['day_start']; |
| 1510 | $end_date = $dates['year_end'] . '/' . $dates['m_end'] . '/' . $dates['day_end']; |
| 1511 | |
| 1512 | break; |
| 1513 | |
| 1514 | } |
| 1515 | |
| 1516 | $args = array( |
| 1517 | 'fields' => 'ids', |
| 1518 | 'start_date' => $start_date, |
| 1519 | 'end_date' => $end_date, |
| 1520 | 'number' => $this->per_page(), |
| 1521 | 'page' => $this->get_paged(), |
| 1522 | ); |
| 1523 | |
| 1524 | $query = give_get_payments( $args ); |
| 1525 | } else { |
| 1526 | $args = array( |
| 1527 | 'fields' => 'ids', |
| 1528 | 'number' => $this->per_page(), |
| 1529 | 'page' => $this->get_paged(), |
| 1530 | ); |
| 1531 | $query = give_get_payments( $args ); |
| 1532 | }// End if(). |
| 1533 | |
| 1534 | if ( $query ) { |
| 1535 | $i = 0; |
| 1536 | foreach ( $query as $payment ) { |
| 1537 | |
| 1538 | if ( is_numeric( $payment ) ) { |
| 1539 | $payment = new Give_Payment( $payment ); |
| 1540 | $payment_meta = $payment->get_meta(); |
| 1541 | $user_info = $payment->user_info; |
| 1542 | } |
| 1543 | |
| 1544 | $payment_meta = $payment->get_meta(); |
| 1545 | $user_info = $payment->user_info; |
| 1546 | |
| 1547 | $first_name = isset( $user_info['first_name'] ) ? $user_info['first_name'] : ''; |
| 1548 | $last_name = isset( $user_info['last_name'] ) ? $user_info['last_name'] : ''; |
| 1549 | |
| 1550 | $donations['donations'][ $i ]['ID'] = $payment->ID; |
| 1551 | $donations['donations'][ $i ]['number'] = $payment->number; |
| 1552 | $donations['donations'][ $i ]['transaction_id'] = $payment->transaction_id; |
| 1553 | $donations['donations'][ $i ]['key'] = $payment->key; |
| 1554 | $donations['donations'][ $i ]['total'] = $payment->total; |
| 1555 | $donations['donations'][ $i ]['status'] = give_get_payment_status( $payment, true ); |
| 1556 | $donations['donations'][ $i ]['gateway'] = $payment->gateway; |
| 1557 | $donations['donations'][ $i ]['name'] = $first_name . ' ' . $last_name; |
| 1558 | $donations['donations'][ $i ]['fname'] = $first_name; |
| 1559 | $donations['donations'][ $i ]['lname'] = $last_name; |
| 1560 | $donations['donations'][ $i ]['email'] = $payment->email; |
| 1561 | $donations['donations'][ $i ]['date'] = $payment->date; |
| 1562 | $donations['donations'][ $i ]['payment_meta'] = array(); |
| 1563 | |
| 1564 | $form_id = isset( $payment_meta['form_id'] ) ? $payment_meta['form_id'] : $payment_meta; |
| 1565 | $price = isset( $payment_meta['form_id'] ) ? give_get_form_price( $payment_meta['form_id'] ) : false; |
| 1566 | $price_id = isset( $payment_meta['price_id'] ) ? $payment_meta['price_id'] : null; |
| 1567 | |
| 1568 | $donations['donations'][ $i ]['form']['id'] = $form_id; |
| 1569 | $donations['donations'][ $i ]['form']['name'] = get_the_title( $payment_meta['form_id'] ); |
| 1570 | $donations['donations'][ $i ]['form']['price'] = $price; |
| 1571 | |
| 1572 | if ( give_has_variable_prices( $form_id ) ) { |
| 1573 | if ( isset( $payment_meta['price_id'] ) ) { |
| 1574 | $price_name = give_get_price_option_name( $form_id, $payment_meta['price_id'], $payment->ID ); |
| 1575 | $donations['donations'][ $i ]['form']['price_name'] = $price_name; |
| 1576 | $donations['donations'][ $i ]['form']['price_id'] = $price_id; |
| 1577 | $donations['donations'][ $i ]['form']['price'] = give_get_price_option_amount( $form_id, $price_id ); |
| 1578 | |
| 1579 | } |
| 1580 | } |
| 1581 | |
| 1582 | if( ! empty( $payment_meta ) ) { |
| 1583 | // Add custom meta to API |
| 1584 | foreach ( $payment_meta as $meta_key => $meta_value ) { |
| 1585 | |
| 1586 | $exceptions = array( |
| 1587 | 'form_title', |
| 1588 | 'form_id', |
| 1589 | 'price_id', |
| 1590 | 'user_info', |
| 1591 | 'key', |
| 1592 | 'email', |
| 1593 | 'date', |
| 1594 | ); |
| 1595 | |
| 1596 | // Don't clutter up results with dupes |
| 1597 | if ( in_array( $meta_key, $exceptions ) ) { |
| 1598 | continue; |
| 1599 | } |
| 1600 | |
| 1601 | $donations['donations'][ $i ]['payment_meta'][ $meta_key ] = $meta_value; |
| 1602 | |
| 1603 | } |
| 1604 | } |
| 1605 | |
| 1606 | $i ++; |
| 1607 | }// End foreach(). |
| 1608 | }// End if(). |
| 1609 | |
| 1610 | return apply_filters( 'give_api_donations_endpoint', $donations ); |
| 1611 | } |
| 1612 | |
| 1613 | /** |
| 1614 | * Retrieve the output format. |
| 1615 | * |
| 1616 | * Determines whether results should be displayed in XML or JSON. |
| 1617 | * |
| 1618 | * @since 1.1 |
| 1619 | * @access public |
| 1620 | * |
| 1621 | * @return mixed |
| 1622 | */ |
| 1623 | public function get_output_format() { |
| 1624 | global $wp_query; |
| 1625 | |
| 1626 | $format = isset( $wp_query->query_vars['format'] ) ? $wp_query->query_vars['format'] : 'json'; |
| 1627 | |
| 1628 | return apply_filters( 'give_api_output_format', $format ); |
| 1629 | } |
| 1630 | |
| 1631 | |
| 1632 | /** |
| 1633 | * Log each API request, if enabled. |
| 1634 | * |
| 1635 | * @access private |
| 1636 | * @since 1.1 |
| 1637 | * |
| 1638 | * @global WP_Query $wp_query |
| 1639 | * |
| 1640 | * @param array $data |
| 1641 | * |
| 1642 | * @return void |
| 1643 | */ |
| 1644 | private function log_request( $data = array() ) { |
| 1645 | if ( ! $this->log_requests ) { |
| 1646 | return; |
| 1647 | } |
| 1648 | |
| 1649 | /** |
| 1650 | * @var WP_Query $wp_query |
| 1651 | */ |
| 1652 | global $wp_query; |
| 1653 | |
| 1654 | $query = array( |
| 1655 | 'give-api' => $wp_query->query_vars['give-api'], |
| 1656 | 'key' => isset( $wp_query->query_vars['key'] ) ? $wp_query->query_vars['key'] : null, |
| 1657 | 'token' => isset( $wp_query->query_vars['token'] ) ? $wp_query->query_vars['token'] : null, |
| 1658 | 'query' => isset( $wp_query->query_vars['query'] ) ? $wp_query->query_vars['query'] : null, |
| 1659 | 'type' => isset( $wp_query->query_vars['type'] ) ? $wp_query->query_vars['type'] : null, |
| 1660 | 'form' => isset( $wp_query->query_vars['form'] ) ? $wp_query->query_vars['form'] : null, |
| 1661 | 'donor' => isset( $wp_query->query_vars['donor'] ) ? $wp_query->query_vars['donor'] : null, |
| 1662 | 'date' => isset( $wp_query->query_vars['date'] ) ? $wp_query->query_vars['date'] : null, |
| 1663 | 'startdate' => isset( $wp_query->query_vars['startdate'] ) ? $wp_query->query_vars['startdate'] : null, |
| 1664 | 'enddate' => isset( $wp_query->query_vars['enddate'] ) ? $wp_query->query_vars['enddate'] : null, |
| 1665 | 'id' => isset( $wp_query->query_vars['id'] ) ? $wp_query->query_vars['id'] : null, |
| 1666 | 'purchasekey' => isset( $wp_query->query_vars['purchasekey'] ) ? $wp_query->query_vars['purchasekey'] : null, |
| 1667 | 'email' => isset( $wp_query->query_vars['email'] ) ? $wp_query->query_vars['email'] : null, |
| 1668 | ); |
| 1669 | |
| 1670 | $log_data = array( |
| 1671 | 'log_type' => 'api_request', |
| 1672 | 'post_excerpt' => http_build_query( $query ), |
| 1673 | 'post_content' => ! empty( $data['error'] ) ? $data['error'] : '', |
| 1674 | ); |
| 1675 | |
| 1676 | $log_meta = array( |
| 1677 | 'api_query' => http_build_query( $query ), |
| 1678 | 'request_ip' => give_get_ip(), |
| 1679 | 'user' => $this->user_id, |
| 1680 | 'key' => isset( $wp_query->query_vars['key'] ) ? $wp_query->query_vars['key'] : null, |
| 1681 | 'token' => isset( $wp_query->query_vars['token'] ) ? $wp_query->query_vars['token'] : null, |
| 1682 | 'time' => $data['request_speed'], |
| 1683 | 'version' => $this->get_queried_version(), |
| 1684 | ); |
| 1685 | |
| 1686 | Give()->logs->insert_log( $log_data, $log_meta ); |
| 1687 | } |
| 1688 | |
| 1689 | |
| 1690 | /** |
| 1691 | * Retrieve the output data. |
| 1692 | * |
| 1693 | * @access public |
| 1694 | * @since 1.1 |
| 1695 | * @return array |
| 1696 | */ |
| 1697 | public function get_output() { |
| 1698 | return $this->data; |
| 1699 | } |
| 1700 | |
| 1701 | /** |
| 1702 | * Output Query in either JSON/XML. |
| 1703 | * The query data is outputted as JSON by default. |
| 1704 | * |
| 1705 | * @since 1.1 |
| 1706 | * @global WP_Query $wp_query |
| 1707 | * |
| 1708 | * @param int $status_code |
| 1709 | */ |
| 1710 | public function output( $status_code = 200 ) { |
| 1711 | |
| 1712 | $format = $this->get_output_format(); |
| 1713 | |
| 1714 | status_header( $status_code ); |
| 1715 | |
| 1716 | /** |
| 1717 | * Fires before outputting the API. |
| 1718 | * |
| 1719 | * @since 1.1 |
| 1720 | * |
| 1721 | * @param array $data Response data to return. |
| 1722 | * @param Give_API $this The Give_API object. |
| 1723 | * @param string $format Output format, XML or JSON. Default is JSON. |
| 1724 | */ |
| 1725 | do_action( 'give_api_output_before', $this->data, $this, $format ); |
| 1726 | |
| 1727 | switch ( $format ) : |
| 1728 | |
| 1729 | case 'xml' : |
| 1730 | |
| 1731 | require_once GIVE_PLUGIN_DIR . 'includes/libraries/array2xml.php'; |
| 1732 | $xml = Array2XML::createXML( 'give', $this->data ); |
| 1733 | echo $xml->saveXML(); |
| 1734 | |
| 1735 | break; |
| 1736 | |
| 1737 | case 'json' : |
| 1738 | |
| 1739 | header( 'Content-Type: application/json' ); |
| 1740 | if ( ! empty( $this->pretty_print ) ) { |
| 1741 | echo json_encode( $this->data, $this->pretty_print ); |
| 1742 | } else { |
| 1743 | echo json_encode( $this->data ); |
| 1744 | } |
| 1745 | |
| 1746 | break; |
| 1747 | |
| 1748 | default : |
| 1749 | |
| 1750 | /** |
| 1751 | * Fires by the API while outputting other formats. |
| 1752 | * |
| 1753 | * @since 1.1 |
| 1754 | * |
| 1755 | * @param array $data Response data to return. |
| 1756 | * @param Give_API $this The Give_API object. |
| 1757 | */ |
| 1758 | do_action( "give_api_output_{$format}", $this->data, $this ); |
| 1759 | |
| 1760 | break; |
| 1761 | |
| 1762 | endswitch; |
| 1763 | |
| 1764 | /** |
| 1765 | * Fires after outputting the API. |
| 1766 | * |
| 1767 | * @since 1.1 |
| 1768 | * |
| 1769 | * @param array $data Response data to return. |
| 1770 | * @param Give_API $this The Give_API object. |
| 1771 | * @param string $format Output format, XML or JSON. Default is JSON. |
| 1772 | */ |
| 1773 | do_action( 'give_api_output_after', $this->data, $this, $format ); |
| 1774 | |
| 1775 | give_die(); |
| 1776 | } |
| 1777 | |
| 1778 | /** |
| 1779 | * Modify User Profile |
| 1780 | * |
| 1781 | * Modifies the output of profile.php to add key generation/revocation. |
| 1782 | * |
| 1783 | * @access public |
| 1784 | * @since 1.1 |
| 1785 | * |
| 1786 | * @param object $user Current user info |
| 1787 | * |
| 1788 | * @return void |
| 1789 | */ |
| 1790 | function user_key_field( $user ) { |
| 1791 | |
| 1792 | if ( ( give_get_option( 'api_allow_user_keys', false ) || current_user_can( 'manage_give_settings' ) ) && current_user_can( 'edit_user', $user->ID ) ) { |
| 1793 | |
| 1794 | $user = get_userdata( $user->ID ); |
| 1795 | ?> |
| 1796 | <table class="form-table"> |
| 1797 | <tbody> |
| 1798 | <tr> |
| 1799 | <th> |
| 1800 | <?php _e( 'Give API Keys', 'give' ); ?> |
| 1801 | </th> |
| 1802 | <td> |
| 1803 | <?php |
| 1804 | $public_key = $this->get_user_public_key( $user->ID ); |
| 1805 | $secret_key = $this->get_user_secret_key( $user->ID ); |
| 1806 | ?> |
| 1807 | <?php if ( empty( $user->give_user_public_key ) ) { ?> |
| 1808 | <input name="give_set_api_key" type="checkbox" id="give_set_api_key" /> |
| 1809 | <span class="description"><?php _e( 'Generate API Key', 'give' ); ?></span> |
| 1810 | <?php } else { ?> |
| 1811 | <strong style="display:inline-block; width: 125px;"><?php _e( 'Public key:', 'give' ); ?> |
| 1812 | </strong> |
| 1813 | <input type="text" disabled="disabled" class="regular-text" id="publickey" value="<?php echo esc_attr( $public_key ); ?>" /> |
| 1814 | <br /> |
| 1815 | <strong style="display:inline-block; width: 125px;"><?php _e( 'Secret key:', 'give' ); ?> |
| 1816 | </strong> |
| 1817 | <input type="text" disabled="disabled" class="regular-text" id="privatekey" value="<?php echo esc_attr( $secret_key ); ?>" /> |
| 1818 | <br /> |
| 1819 | <strong style="display:inline-block; width: 125px;"><?php _e( 'Token:', 'give' ); ?> |
| 1820 | </strong> |
| 1821 | <input type="text" disabled="disabled" class="regular-text" id="token" value="<?php echo esc_attr( $this->get_token( $user->ID ) ); ?>" /> |
| 1822 | <br /> |
| 1823 | <input name="give_revoke_api_key" type="checkbox" id="give_revoke_api_key" /> |
| 1824 | <span class="description"><label for="give_revoke_api_key"><?php _e( 'Revoke API Keys', 'give' ); ?></label></span> |
| 1825 | <?php } ?> |
| 1826 | </td> |
| 1827 | </tr> |
| 1828 | </tbody> |
| 1829 | </table> |
| 1830 | <?php }// End if(). |
| 1831 | } |
| 1832 | |
| 1833 | /** |
| 1834 | * Process an API key generation/revocation |
| 1835 | * |
| 1836 | * @access public |
| 1837 | * @since 1.1 |
| 1838 | * |
| 1839 | * @param array $args |
| 1840 | * |
| 1841 | * @return void |
| 1842 | */ |
| 1843 | public function process_api_key( $args ) { |
| 1844 | |
| 1845 | if ( ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'give-api-nonce' ) ) { |
| 1846 | wp_die( __( 'Nonce verification failed.', 'give' ), __( 'Error', 'give' ), array( |
| 1847 | 'response' => 403, |
| 1848 | ) ); |
| 1849 | } |
| 1850 | |
| 1851 | if ( empty( $args['user_id'] ) ) { |
| 1852 | wp_die( __( 'User ID Required.', 'give' ), __( 'Error', 'give' ), array( |
| 1853 | 'response' => 401, |
| 1854 | ) ); |
| 1855 | } |
| 1856 | |
| 1857 | if ( is_numeric( $args['user_id'] ) ) { |
| 1858 | $user_id = isset( $args['user_id'] ) ? absint( $args['user_id'] ) : get_current_user_id(); |
| 1859 | } else { |
| 1860 | $userdata = get_user_by( 'login', $args['user_id'] ); |
| 1861 | $user_id = $userdata->ID; |
| 1862 | } |
| 1863 | $process = isset( $args['give_api_process'] ) ? strtolower( $args['give_api_process'] ) : false; |
| 1864 | |
| 1865 | if ( $user_id == get_current_user_id() && ! give_get_option( 'allow_user_api_keys' ) && ! current_user_can( 'manage_give_settings' ) ) { |
| 1866 | wp_die( sprintf( /* translators: %s: process */ |
| 1867 | __( 'You do not have permission to %s API keys for this user.', 'give' ), $process ), __( 'Error', 'give' ), array( |
| 1868 | 'response' => 403, |
| 1869 | ) ); |
| 1870 | } elseif ( ! current_user_can( 'manage_give_settings' ) ) { |
| 1871 | wp_die( sprintf( /* translators: %s: process */ |
| 1872 | __( 'You do not have permission to %s API keys for this user.', 'give' ), $process ), __( 'Error', 'give' ), array( |
| 1873 | 'response' => 403, |
| 1874 | ) ); |
| 1875 | } |
| 1876 | |
| 1877 | switch ( $process ) { |
| 1878 | case 'generate': |
| 1879 | if ( $this->generate_api_key( $user_id ) ) { |
| 1880 | Give_Cache::delete( Give_Cache::get_key( 'give_total_api_keys' ) ); |
| 1881 | wp_redirect( add_query_arg( 'give-messages[]', 'api-key-generated', 'edit.php?post_type=give_forms&page=give-tools&tab=api' ) ); |
| 1882 | exit(); |
| 1883 | } else { |
| 1884 | wp_redirect( add_query_arg( 'give-messages[]', 'api-key-failed', 'edit.php?post_type=give_forms&page=give-tools&tab=api' ) ); |
| 1885 | exit(); |
| 1886 | } |
| 1887 | break; |
| 1888 | case 'regenerate': |
| 1889 | $this->generate_api_key( $user_id, true ); |
| 1890 | Give_Cache::delete( Give_Cache::get_key( 'give_total_api_keys' ) ); |
| 1891 | wp_redirect( add_query_arg( 'give-messages[]', 'api-key-regenerated', 'edit.php?post_type=give_forms&page=give-tools&tab=api' ) ); |
| 1892 | exit(); |
| 1893 | break; |
| 1894 | case 'revoke': |
| 1895 | $this->revoke_api_key( $user_id ); |
| 1896 | Give_Cache::delete( Give_Cache::get_key( 'give_total_api_keys' ) ); |
| 1897 | wp_redirect( add_query_arg( 'give-messages[]', 'api-key-revoked', 'edit.php?post_type=give_forms&page=give-tools&tab=api' ) ); |
| 1898 | exit(); |
| 1899 | break; |
| 1900 | default; |
| 1901 | break; |
| 1902 | } |
| 1903 | } |
| 1904 | |
| 1905 | /** |
| 1906 | * Generate new API keys for a user |
| 1907 | * |
| 1908 | * @param int $user_id User ID the key is being generated for. |
| 1909 | * @param boolean $regenerate Regenerate the key for the user. |
| 1910 | * |
| 1911 | * @access public |
| 1912 | * @since 1.1 |
| 1913 | * |
| 1914 | * @return boolean True if (re)generated successfully, false otherwise. |
| 1915 | */ |
| 1916 | public function generate_api_key( $user_id = 0, $regenerate = false ) { |
| 1917 | |
| 1918 | // Bail out, if user doesn't exists. |
| 1919 | if ( empty( $user_id ) ) { |
| 1920 | return false; |
| 1921 | } |
| 1922 | |
| 1923 | $user = get_userdata( $user_id ); |
| 1924 | |
| 1925 | // Bail Out, if user object doesn't exists. |
| 1926 | if ( ! $user ) { |
| 1927 | return false; |
| 1928 | } |
| 1929 | |
| 1930 | $new_public_key = ''; |
| 1931 | $new_secret_key = ''; |
| 1932 | |
| 1933 | if( ! empty( $_POST['from'] ) && 'profile' === $_POST['from'] ) { |
| 1934 | // For User Profile Page. |
| 1935 | if( ! empty( $_POST['give_set_api_key'] ) ) { |
| 1936 | // Generate API Key from User Profile page. |
| 1937 | $new_public_key = $this->generate_public_key( $user->user_email ); |
| 1938 | $new_secret_key = $this->generate_private_key( $user->ID ); |
| 1939 | } elseif ( ! empty( $_POST['give_revoke_api_key'] ) ) { |
| 1940 | // Revoke API Key from User Profile page. |
| 1941 | $this->revoke_api_key( $user->ID ); |
| 1942 | } else { |
| 1943 | return false; |
| 1944 | } |
| 1945 | } else { |
| 1946 | // For Tools > API page. |
| 1947 | $public_key = $this->get_user_public_key( $user_id ); |
| 1948 | |
| 1949 | if ( empty( $public_key ) && ! $regenerate ) { |
| 1950 | // Generating API for first time. |
| 1951 | $new_public_key = $this->generate_public_key( $user->user_email ); |
| 1952 | $new_secret_key = $this->generate_private_key( $user->ID ); |
| 1953 | } elseif ( $public_key && $regenerate ) { |
| 1954 | // API Key already exists and Regenerating API Key. |
| 1955 | $this->revoke_api_key( $user->ID ); |
| 1956 | $new_public_key = $this->generate_public_key( $user->user_email ); |
| 1957 | $new_secret_key = $this->generate_private_key( $user->ID ); |
| 1958 | } elseif ( ! empty( $public_key ) && ! $regenerate ) { |
| 1959 | // Doing nothing, when API Key exists but still try to generate again instead of regenerating. |
| 1960 | return false; |
| 1961 | } else { |
| 1962 | // Revoke API Key. |
| 1963 | $this->revoke_api_key( $user->ID ); |
| 1964 | } |
| 1965 | } |
| 1966 | |
| 1967 | update_user_meta( $user_id, $new_public_key, 'give_user_public_key' ); |
| 1968 | update_user_meta( $user_id, $new_secret_key, 'give_user_secret_key' ); |
| 1969 | |
| 1970 | return true; |
| 1971 | } |
| 1972 | |
| 1973 | /** |
| 1974 | * Revoke a users API keys |
| 1975 | * |
| 1976 | * @access public |
| 1977 | * @since 1.1 |
| 1978 | * |
| 1979 | * @param int $user_id User ID of user to revoke key for |
| 1980 | * |
| 1981 | * @return bool |
| 1982 | */ |
| 1983 | public function revoke_api_key( $user_id = 0 ) { |
| 1984 | |
| 1985 | if ( empty( $user_id ) ) { |
| 1986 | return false; |
| 1987 | } |
| 1988 | |
| 1989 | $user = get_userdata( $user_id ); |
| 1990 | |
| 1991 | if ( ! $user ) { |
| 1992 | return false; |
| 1993 | } |
| 1994 | |
| 1995 | $public_key = $this->get_user_public_key( $user_id ); |
| 1996 | $secret_key = $this->get_user_secret_key( $user_id ); |
| 1997 | if ( ! empty( $public_key ) ) { |
| 1998 | Give_Cache::delete( Give_Cache::get_key( md5( 'give_api_user_' . $public_key ) ) ); |
| 1999 | Give_Cache::delete( Give_Cache::get_key( md5( 'give_api_user_public_key' . $user_id ) ) ); |
| 2000 | Give_Cache::delete( Give_Cache::get_key( md5( 'give_api_user_secret_key' . $user_id ) ) ); |
| 2001 | delete_user_meta( $user_id, $public_key ); |
| 2002 | delete_user_meta( $user_id, $secret_key ); |
| 2003 | } else { |
| 2004 | return false; |
| 2005 | } |
| 2006 | |
| 2007 | return true; |
| 2008 | } |
| 2009 | |
| 2010 | public function get_version() { |
| 2011 | return self::VERSION; |
| 2012 | } |
| 2013 | |
| 2014 | /** |
| 2015 | * Generate the public key for a user |
| 2016 | * |
| 2017 | * @access private |
| 2018 | * @since 1.1 |
| 2019 | * |
| 2020 | * @param string $user_email |
| 2021 | * |
| 2022 | * @return string |
| 2023 | */ |
| 2024 | private function generate_public_key( $user_email = '' ) { |
| 2025 | $auth_key = defined( 'AUTH_KEY' ) ? AUTH_KEY : ''; |
| 2026 | $public = hash( 'md5', $user_email . $auth_key . date( 'U' ) ); |
| 2027 | |
| 2028 | return $public; |
| 2029 | } |
| 2030 | |
| 2031 | /** |
| 2032 | * Generate the secret key for a user |
| 2033 | * |
| 2034 | * @access private |
| 2035 | * @since 1.1 |
| 2036 | * |
| 2037 | * @param int $user_id |
| 2038 | * |
| 2039 | * @return string |
| 2040 | */ |
| 2041 | private function generate_private_key( $user_id = 0 ) { |
| 2042 | $auth_key = defined( 'AUTH_KEY' ) ? AUTH_KEY : ''; |
| 2043 | $secret = hash( 'md5', $user_id . $auth_key . date( 'U' ) ); |
| 2044 | |
| 2045 | return $secret; |
| 2046 | } |
| 2047 | |
| 2048 | /** |
| 2049 | * Retrieve the user's token |
| 2050 | * |
| 2051 | * @access private |
| 2052 | * @since 1.1 |
| 2053 | * |
| 2054 | * @param int $user_id |
| 2055 | * |
| 2056 | * @return string |
| 2057 | */ |
| 2058 | public function get_token( $user_id = 0 ) { |
| 2059 | return hash( 'md5', $this->get_user_secret_key( $user_id ) . $this->get_user_public_key( $user_id ) ); |
| 2060 | } |
| 2061 | |
| 2062 | /** |
| 2063 | * Generate the default donation stats returned by the 'stats' endpoint |
| 2064 | * |
| 2065 | * @access private |
| 2066 | * @since 1.1 |
| 2067 | * @return array default sales statistics |
| 2068 | */ |
| 2069 | private function get_default_sales_stats() { |
| 2070 | |
| 2071 | // Default sales return |
| 2072 | $donations = array(); |
| 2073 | $donations['donations']['today'] = $this->stats->get_sales( 0, 'today' ); |
| 2074 | $donations['donations']['current_month'] = $this->stats->get_sales( 0, 'this_month' ); |
| 2075 | $donations['donations']['last_month'] = $this->stats->get_sales( 0, 'last_month' ); |
| 2076 | $donations['donations']['totals'] = give_get_total_donations(); |
| 2077 | |
| 2078 | return $donations; |
| 2079 | } |
| 2080 | |
| 2081 | /** |
| 2082 | * Generate the default earnings stats returned by the 'stats' endpoint |
| 2083 | * |
| 2084 | * @access private |
| 2085 | * @since 1.1 |
| 2086 | * @return array default earnings statistics |
| 2087 | */ |
| 2088 | private function get_default_earnings_stats() { |
| 2089 | |
| 2090 | // Default earnings return |
| 2091 | $earnings = array(); |
| 2092 | $earnings['earnings']['today'] = $this->stats->get_earnings( 0, 'today' ); |
| 2093 | $earnings['earnings']['current_month'] = $this->stats->get_earnings( 0, 'this_month' ); |
| 2094 | $earnings['earnings']['last_month'] = $this->stats->get_earnings( 0, 'last_month' ); |
| 2095 | $earnings['earnings']['totals'] = give_get_total_earnings(); |
| 2096 | |
| 2097 | return $earnings; |
| 2098 | } |
| 2099 | |
| 2100 | /** |
| 2101 | * API Key Backwards Compatibility |
| 2102 | * |
| 2103 | * A Backwards Compatibility call for the change of meta_key/value for users API Keys. |
| 2104 | * |
| 2105 | * @since 1.3.6 |
| 2106 | * |
| 2107 | * @param string $check Whether to check the cache or not |
| 2108 | * @param int $object_id The User ID being passed |
| 2109 | * @param string $meta_key The user meta key |
| 2110 | * @param bool $single If it should return a single value or array |
| 2111 | * |
| 2112 | * @return string The API key/secret for the user supplied |
| 2113 | */ |
| 2114 | public function api_key_backwards_compat( $check, $object_id, $meta_key, $single ) { |
| 2115 | |
| 2116 | if ( $meta_key !== 'give_user_public_key' && $meta_key !== 'give_user_secret_key' ) { |
| 2117 | return $check; |
| 2118 | } |
| 2119 | |
| 2120 | $return = $check; |
| 2121 | |
| 2122 | switch ( $meta_key ) { |
| 2123 | case 'give_user_public_key': |
| 2124 | $return = Give()->api->get_user_public_key( $object_id ); |
| 2125 | break; |
| 2126 | case 'give_user_secret_key': |
| 2127 | $return = Give()->api->get_user_secret_key( $object_id ); |
| 2128 | break; |
| 2129 | } |
| 2130 | |
| 2131 | if ( ! $single ) { |
| 2132 | $return = array( $return ); |
| 2133 | } |
| 2134 | |
| 2135 | return $return; |
| 2136 | |
| 2137 | } |
| 2138 | |
| 2139 | } |
| 2140 |