class.wpcom-json-api-get-post-counts-v1-1-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.9.2

jetpack / json-endpoints / class.wpcom-json-api-get-post-counts-v1-1-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-get-post-counts-v1-1-endpoint.php

172 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	new WPCOM_JSON_API_GET_Post_Counts_V1_1_Endpoint(
4	array(
5	'description' => 'Get number of posts in the post type groups by post status',
6	'group' => 'sites',
7	'stat' => 'sites:X:post-counts:X',
8	'force' => 'wpcom',
9	'method' => 'GET',
10	'min_version' => '1.1',
11	'max_version' => '1.2',
12	'path' => '/sites/%s/post-counts/%s',
13	'path_labels' => array(
14	'$site' => '(int\|string) Site ID or domain',
15	'$post_type' => '(string) Post Type',
16	),
17
18	'query_parameters' => array(
19	'context' => false,
20	'author' => '(int) author ID',
21	),
22
23	'example_request' => 'https://public-api.wordpress.com/rest/v1.2/sites/en.blog.wordpress.com/post-counts/page',
24
25	'response_format' => array(
26	'counts' => array(
27	'all' => '(array) Number of posts by any author in the post type grouped by post status',
28	'mine' => '(array) Number of posts by the current user in the post type grouped by post status',
29	),
30	),
31	)
32	);
33
34	/**
35	* GET Post Counts v1_1 endpoint class.
36	*/
37	class WPCOM_JSON_API_GET_Post_Counts_V1_1_Endpoint extends WPCOM_JSON_API_Endpoint {
38
39	/**
40	* Whitelist array.
41	*
42	* @var string[]
43	*/
44	private $allowlist = array( 'publish' );
45
46	/**
47	* Build SQL query
48	*
49	* This function must `$wpdb->prepare` the query. The return is expected to be prepared by consuming functions.
50	*
51	* @param string $post_type - post type.
52	* @param int $user_id - the user ID.
53	* @return string SQL query
54	*/
55	private function buildCountsQuery( $post_type = 'post', $user_id = null ) {
56	global $wpdb;
57
58	$query = 'SELECT post_status as status, count(*) as count ';
59	$query .= "FROM {$wpdb->posts} ";
60	$query .= 'WHERE post_type = %s ';
61	if ( isset( $user_id ) ) {
62	$query .= 'AND post_author = %d ';
63	}
64
65	$query .= 'GROUP BY status';
66
67	// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- This is properly prepared, except the query is constructed in the variable, throwing the PHPCS error.
68	return $wpdb->prepare( $query, $post_type, $user_id );
69	}
70
71	/**
72	* Retrive counts using wp_cache
73	*
74	* @param string $post_type - thge post type.
75	* @param int $id - the ID.
76	*/
77	private function retrieveCounts( $post_type, $id = null ) {
78	if ( ! isset( $id ) ) {
79	$counts = array();
80	foreach ( (array) wp_count_posts( $post_type ) as $status => $count ) {
81	if ( in_array( $status, $this->allowlist, true ) && $count > 0 ) {
82	$counts[ $status ] = (int) $count;
83	}
84	}
85
86	return $counts;
87	}
88
89	global $wpdb;
90	$key = 'rest-api-' . $id . '-' . _count_posts_cache_key( $post_type );
91	$counts = wp_cache_get( $key, 'counts' );
92
93	if ( false === $counts ) {
94	// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- buildCountsQuery prepares the query.
95	$results = $wpdb->get_results( $this->buildCountsQuery( $post_type, $id ) );
96	$counts = $this->filterStatusesByWhiteslist( $results );
97	wp_cache_set( $key, $counts, 'counts' );
98	}
99
100	return $counts;
101	}
102
103	/**
104	* Filter statuses by whiteslist.
105	*
106	* @param array $in - the post we're checking.
107	*/
108	private function filterStatusesByWhiteslist( $in ) {
109	$return = array();
110	foreach ( $in as $result ) {
111	if ( in_array( $result->status, $this->allowlist, true ) ) {
112	$return[ $result->status ] = (int) $result->count;
113	}
114	}
115	return $return;
116	}
117
118	/**
119	*
120	* API callback.
121	*
122	* /sites/%s/post-counts/%s
123	*
124	* @param string $path - the path.
125	* @param int $blog_id - the blog ID.
126	* @param string $post_type - the post type.
127	*/
128	public function callback( $path = '', $blog_id = 0, $post_type = 'post' ) {
129	if ( ! get_current_user_id() ) {
130	return new WP_Error( 'authorization_required', __( 'An active access token must be used to retrieve post counts.', 'jetpack' ), 403 );
131	}
132
133	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ), false );
134
135	if ( is_wp_error( $blog_id ) ) {
136	return $blog_id;
137	}
138
139	// @todo see if we can use a strict comparison here.
140	// phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
141	if ( ! in_array( $post_type, array( 'post', 'revision', 'page', 'any' ), true ) && defined( 'IS_WPCOM' ) && IS_WPCOM ) {
142	$this->load_theme_functions();
143	}
144
145	if ( ! post_type_exists( $post_type ) ) {
146	return new WP_Error( 'unknown_post_type', __( 'Unknown post type requested.', 'jetpack' ), 404 );
147	}
148
149	$args = $this->query_args();
150	$mine_ID = get_current_user_id(); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
151
152	if ( current_user_can( 'edit_posts' ) ) {
153	array_push( $this->allowlist, 'draft', 'future', 'pending', 'private', 'trash' );
154	}
155
156	$return = array(
157	'counts' => (array) array(
158	'all' => (object) $this->retrieveCounts( $post_type ),
159	'mine' => (object) $this->retrieveCounts( $post_type, $mine_ID ), // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
160	),
161	);
162
163	// Author.
164	if ( isset( $args['author'] ) ) {
165	$author_ID = $args['author']; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
166	$return['counts']['author'] = (object) $this->retrieveCounts( $post_type, $author_ID ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
167	}
168
169	return (object) $return;
170	}
171	}
172