diff options
Diffstat (limited to 'plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php')
| -rw-r--r-- | plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php | 228 |
1 files changed, 217 insertions, 11 deletions
diff --git a/plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php b/plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php index 68327f51..c321f6ae 100644 --- a/plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php +++ b/plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php @@ -1,12 +1,21 @@ -<?php +<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName /** - * This is the endpoint class for `/site` endpoints. + * List of /site core REST API endpoints used in Jetpack's dashboard. * + * @package Jetpack + */ + +use Automattic\Jetpack\Connection\Client; + +/** + * This is the endpoint class for `/site` endpoints. */ class Jetpack_Core_API_Site_Endpoint { + /** * Returns the result of `/sites/%s/features` endpoint call. + * * @return object $features has 'active' and 'available' properties each of which contain feature slugs. * 'active' is a simple array of slugs that are active on the current plan. * 'available' is an object with keys that represent feature slugs and values are arrays @@ -14,11 +23,11 @@ class Jetpack_Core_API_Site_Endpoint { */ public static function get_features() { - // Make the API request - $request = sprintf( '/sites/%d/features', Jetpack_Options::get_option( 'id' ) ); - $response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' ); + // Make the API request. + $request = sprintf( '/sites/%d/features', Jetpack_Options::get_option( 'id' ) ); + $response = Client::wpcom_json_api_request_as_blog( $request, '1.1' ); - // Bail if there was an error or malformed response + // Bail if there was an error or malformed response. if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) { return new WP_Error( 'failed_to_fetch_data', @@ -27,10 +36,10 @@ class Jetpack_Core_API_Site_Endpoint { ); } - // Decode the results + // Decode the results. $results = json_decode( $response['body'], true ); - // Bail if there were no results or plan details returned + // Bail if there were no results or plan details returned. if ( ! is_array( $results ) ) { return new WP_Error( 'failed_to_fetch_data', @@ -39,10 +48,52 @@ class Jetpack_Core_API_Site_Endpoint { ); } - return rest_ensure_response( array( - 'code' => 'success', + return rest_ensure_response( + array( + 'code' => 'success', 'message' => esc_html__( 'Site features correctly received.', 'jetpack' ), - 'data' => wp_remote_retrieve_body( $response ), + 'data' => wp_remote_retrieve_body( $response ), + ) + ); + } + + + /** + * Returns the result of `/sites/%s/purchases` endpoint call. + * + * @return array of site purchases. + */ + public static function get_purchases() { + // Make the API request. + $request = sprintf( '/sites/%d/purchases', Jetpack_Options::get_option( 'id' ) ); + $response = Client::wpcom_json_api_request_as_blog( $request, '1.1' ); + + // Bail if there was an error or malformed response. + if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) { + return new WP_Error( + 'failed_to_fetch_data', + esc_html__( 'Unable to fetch the requested data.', 'jetpack' ), + array( 'status' => 500 ) + ); + } + + // Decode the results. + $results = json_decode( $response['body'], true ); + + // Bail if there were no results or purchase details returned. + if ( ! is_array( $results ) ) { + return new WP_Error( + 'failed_to_fetch_data', + esc_html__( 'Unable to fetch the requested data.', 'jetpack' ), + array( 'status' => 500 ) + ); + } + + return rest_ensure_response( + array( + 'code' => 'success', + 'message' => esc_html__( 'Site purchases correctly received.', 'jetpack' ), + 'data' => wp_remote_retrieve_body( $response ), ) ); } @@ -57,4 +108,159 @@ class Jetpack_Core_API_Site_Endpoint { public static function can_request() { return current_user_can( 'jetpack_manage_modules' ); } + + /** + * Gets an array of data that show how Jetpack is currently being used to benefit the site. + * + * @since 7.7 + * + * @return WP_REST_Response + */ + public static function get_benefits() { + $benefits = array(); + + /* + * We get different benefits from Stats: + * - this year's visitors + * - Followers (only if subs module is active) + * - Sharing counts (not currently supported in Jetpack -- https://github.com/Automattic/jetpack/issues/844 ) + */ + $stats = null; + if ( function_exists( 'stats_get_from_restapi' ) ) { + $stats = stats_get_from_restapi( array( 'fields' => 'stats' ) ); + } + + // Yearly visitors. + if ( null !== $stats && $stats->stats->visitors > 0 ) { + $benefits[] = array( + 'name' => 'jetpack-stats', + 'title' => esc_html__( 'Site Stats', 'jetpack' ), + 'description' => esc_html__( 'Visitors tracked by Jetpack', 'jetpack' ), + 'value' => absint( $stats->stats->visitors ), + ); + } + + // Protect blocked logins. + if ( Jetpack::is_module_active( 'protect' ) ) { + $protect = get_site_option( 'jetpack_protect_blocked_attempts' ); + if ( $protect > 0 ) { + $benefits[] = array( + 'name' => 'protect', + 'title' => esc_html__( 'Brute force protection', 'jetpack' ), + 'description' => esc_html__( 'The number of malicious login attempts blocked by Jetpack', 'jetpack' ), + 'value' => absint( $protect ), + ); + } + } + + // Number of followers. + if ( null !== $stats && $stats->stats->followers_blog > 0 && Jetpack::is_module_active( 'subscriptions' ) ) { + $benefits[] = array( + 'name' => 'subscribers', + 'title' => esc_html__( 'Subscribers', 'jetpack' ), + 'description' => esc_html__( 'People subscribed to your updates through Jetpack', 'jetpack' ), + 'value' => absint( $stats->stats->followers_blog ), + ); + } + + // VaultPress backups. + if ( Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) && class_exists( 'VaultPress' ) ) { + $vaultpress = new VaultPress(); + if ( $vaultpress->is_registered() ) { + $data = json_decode( base64_decode( $vaultpress->contact_service( 'plugin_data' ) ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode + if ( $data && $data->features->backups && ! empty( $data->backups->stats ) && $data->backups->stats->revisions > 0 ) { + $benefits[] = array( + 'name' => 'jetpack-backup', + 'title' => esc_html__( 'Jetpack Backup', 'jetpack' ), + 'description' => esc_html__( 'The number of times Jetpack has backed up your site and kept it safe', 'jetpack' ), + 'value' => absint( $data->backups->stats->revisions ), + ); + } + } + } + + // Number of forms sent via a Jetpack contact form. + if ( Jetpack::is_module_active( 'contact-form' ) ) { + $contact_form_count = array_sum( get_object_vars( wp_count_posts( 'feedback' ) ) ); + if ( $contact_form_count > 0 ) { + $benefits[] = array( + 'name' => 'contact-form-feedback', + 'title' => esc_html__( 'Contact Form Feedback', 'jetpack' ), + 'description' => esc_html__( 'Form submissions stored by Jetpack', 'jetpack' ), + 'value' => absint( $contact_form_count ), + ); + } + } + + // Number of images in the library if Photon is active. + if ( Jetpack::is_module_active( 'photon' ) ) { + $photon_count = array_reduce( + get_object_vars( wp_count_attachments( array( 'image/jpeg', 'image/png', 'image/gif', 'image/bmp' ) ) ), + function ( $i, $j ) { + return $i + $j; + } + ); + if ( $photon_count > 0 ) { + $benefits[] = array( + 'name' => 'image-hosting', + 'title' => esc_html__( 'Image Hosting', 'jetpack' ), + 'description' => esc_html__( 'Super-fast, mobile-ready images served by Jetpack', 'jetpack' ), + 'value' => absint( $photon_count ), + ); + } + } + + // Number of VideoPress videos on the site. + $videopress_attachments = wp_count_attachments( 'video/videopress' ); + if ( + isset( $videopress_attachments->{'video/videopress'} ) + && $videopress_attachments->{'video/videopress'} > 0 + ) { + $benefits[] = array( + 'name' => 'video-hosting', + 'title' => esc_html__( 'Video Hosting', 'jetpack' ), + 'description' => esc_html__( 'Ad-free, lightning-fast videos delivered by Jetpack', 'jetpack' ), + 'value' => absint( $videopress_attachments->{'video/videopress'} ), + ); + } + + // Number of active Publicize connections. + if ( Jetpack::is_module_active( 'publicize' ) && class_exists( 'Publicize' ) ) { + $publicize = new Publicize(); + $connections = $publicize->get_all_connections(); + + $number_of_connections = 0; + if ( is_array( $connections ) && ! empty( $connections ) ) { + $number_of_connections = count( $connections ); + } + + if ( $number_of_connections > 0 ) { + $benefits[] = array( + 'name' => 'publicize', + 'title' => esc_html__( 'Publicize', 'jetpack' ), + 'description' => esc_html__( 'Live social media site connections, powered by Jetpack', 'jetpack' ), + 'value' => absint( $number_of_connections ), + ); + } + } + + // Total number of shares. + if ( null !== $stats && $stats->stats->shares > 0 ) { + $benefits[] = array( + 'name' => 'sharing', + 'title' => esc_html__( 'Sharing', 'jetpack' ), + 'description' => esc_html__( 'The number of times visitors have shared your posts with the world using Jetpack', 'jetpack' ), + 'value' => absint( $stats->stats->shares ), + ); + } + + // Finally, return the whole list of benefits. + return rest_ensure_response( + array( + 'code' => 'success', + 'message' => esc_html__( 'Site benefits correctly received.', 'jetpack' ), + 'data' => wp_json_encode( $benefits ), + ) + ); + } } |