jetpack / json-endpoints / class.wpcom-json-api-get-comments-tree-endpoint.php

class.wpcom-json-api-get-comments-tree-endpoint.php in Jetpack – WP Security, Backup, Speed, & Growth 16.3-a.7, at json-endpoints/class.wpcom-json-api-get-comments-tree-endpoint.php

202 lines 6.4 KB

Raw Download Zip

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	if ( ! defined( 'ABSPATH' ) ) {
4	exit( 0 );
5	}
6
7	new WPCOM_JSON_API_Get_Comments_Tree_Endpoint(
8	array(
9	'description' => 'Get a comments tree for site.',
10	'max_version' => '1',
11	'new_version' => '1.1',
12	'group' => 'comments-tree',
13	'stat' => 'comments-tree:1',
14
15	'method' => 'GET',
16	'path' => '/sites/%s/comments-tree',
17	'path_labels' => array(
18	'$site' => '(int\|string) Site ID or domain',
19	),
20	'query_parameters' => array(
21	'status' => '(string) Filter returned comments based on this value (allowed values: all, approved, unapproved, pending, trash, spam).',
22	),
23	'response_format' => array(
24	'comments_count' => '(int) Total number of comments on the site',
25	'comments_tree' => '(array) Array of arrays representing the comments tree for given site (max 50000)',
26	'trackbacks_count' => '(int) Total number of trackbacks on the site',
27	'trackbacks_tree' => '(array) Array of arrays representing the trackbacks tree for given site (max 50000)',
28	'pingbacks_count' => '(int) Total number of pingbacks on the site',
29	'pingbacks_tree' => '(array) Array of arrays representing the pingbacks tree for given site (max 50000)',
30	),
31
32	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/comments-tree?status=approved',
33	)
34	);
35	/**
36	* GET comments tree endpoint class.
37	*
38	* @phan-constructor-used-for-side-effects
39	*/
40	class WPCOM_JSON_API_Get_Comments_Tree_Endpoint extends WPCOM_JSON_API_Endpoint {
41	/**
42	* Retrieves a list of comment data for a given site.
43	*
44	* @param string $status Filter by status: all, approved, pending, spam or trash.
45	* @param int $start_at first comment to search from going back in time.
46	*
47	* @return array
48	*/
49	public function get_site_tree( $status, $start_at = PHP_INT_MAX ) {
50	global $wpdb;
51	$max_comment_count = 50000;
52	$db_status = $this->get_comment_db_status( $status );
53
54	$db_comment_rows = $wpdb->get_results(
55	$wpdb->prepare(
56	'SELECT comment_ID, comment_post_ID, comment_parent, comment_type ' .
57	"FROM $wpdb->comments AS comments " .
58	"INNER JOIN $wpdb->posts AS posts ON comments.comment_post_ID = posts.ID " .
59	"WHERE comment_ID <= %d AND ( %s = 'all' OR comment_approved = %s ) " .
60	'ORDER BY comment_ID DESC ' .
61	'LIMIT %d',
62	(int) $start_at,
63	$db_status,
64	$db_status,
65	$max_comment_count
66	),
67	ARRAY_N
68	);
69
70	$comments = array();
71	$trackbacks = array();
72	$pingbacks = array();
73	foreach ( $db_comment_rows as $row ) {
74	list( $comment_id, $comment_post_id, $comment_parent, $comment_type ) = $row;
75	switch ( $comment_type ) {
76	case 'trackback':
77	$trackbacks[] = array( $comment_id, $comment_post_id, $comment_parent );
78	break;
79	case 'pingback':
80	$pingbacks[] = array( $comment_id, $comment_post_id, $comment_parent );
81	break;
82	default:
83	$comments[] = array( $comment_id, $comment_post_id, $comment_parent );
84	}
85	}
86
87	return array(
88	'comments_count' => $this->get_site_tree_total_count( $status, 'comment' ),
89	'comments_tree' => array_map( array( $this, 'array_map_all_as_ints' ), $comments ),
90	'trackbacks_count' => $this->get_site_tree_total_count( $status, 'trackback' ),
91	'trackbacks_tree' => array_map( array( $this, 'array_map_all_as_ints' ), $trackbacks ),
92	'pingbacks_count' => $this->get_site_tree_total_count( $status, 'pingback' ),
93	'pingbacks_tree' => array_map( array( $this, 'array_map_all_as_ints' ), $pingbacks ),
94	);
95	}
96
97	/**
98	* Ensure all values are integers.
99	*
100	* @param array $comments Collection of comments.
101	*
102	* @return array Comments with values as integers.
103	*/
104	public function array_map_all_as_ints( $comments ) {
105	return array_map( 'intval', $comments );
106	}
107
108	/**
109	* Retrieves a total count of comments by type for the given site.
110	*
111	* @param string $status Filter by status: all, approved, pending, spam or trash.
112	* @param string $type Comment type: 'trackback', 'pingback', or 'comment'.
113	*
114	* @return int Total count of comments for a site.
115	*/
116	public function get_site_tree_total_count( $status, $type ) {
117	global $wpdb;
118
119	$db_status = $this->get_comment_db_status( $status );
120	$type = $this->get_sanitized_comment_type( $type );
121
122	$result = $wpdb->get_var(
123	$wpdb->prepare(
124	'SELECT COUNT(1) ' .
125	"FROM $wpdb->comments AS comments " .
126	"INNER JOIN $wpdb->posts AS posts ON comments.comment_post_ID = posts.ID " .
127	"WHERE comment_type = %s AND ( %s = 'all' OR comment_approved = %s )",
128	$type,
129	$db_status,
130	$db_status
131	)
132	);
133	return (int) $result;
134	}
135
136	/**
137	* Ensure a valid status is converted to a database-supported value if necessary.
138	*
139	* @param string $status Should be one of: all, approved, pending, spam or trash.
140	*
141	* @return string Corresponding value that exists in database.
142	*/
143	public function get_comment_db_status( $status ) {
144	if ( 'approved' === $status ) {
145	return '1';
146	}
147	if ( 'pending' === $status \|\| 'unapproved' === $status ) {
148	return '0';
149	}
150	return $status;
151	}
152
153	/**
154	* Determine if the passed comment status is valid or not.
155	*
156	* @param string $status - comment status.
157	*
158	* @return boolean
159	*/
160	public function validate_status_param( $status ) {
161	return in_array( $status, array( 'all', 'approved', 'unapproved', 'pending', 'spam', 'trash' ), true );
162	}
163
164	/**
165	* Sanitize a given comment type.
166	*
167	* @param string $type Comment type: can be 'trackback', 'pingback', or 'comment'.
168	*
169	* @return string Sanitized comment type.
170	*/
171	public function get_sanitized_comment_type( $type = 'comment' ) {
172	if ( in_array( $type, array( 'trackback', 'pingback', 'comment' ), true ) ) {
173	return $type;
174	}
175	return 'comment';
176	}
177
178	/**
179	* Endpoint callback for /sites/%s/comments-tree
180	*
181	* @param string $path - the api path.
182	* @param int $blog_id - the blog id.
183	*
184	* @return array Site tree results by status.
185	*/
186	public function callback( $path = '', $blog_id = 0 ) {
187	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
188	if ( is_wp_error( $blog_id ) ) {
189	return $blog_id;
190	}
191
192	$args = $this->query_args();
193	$comment_status = empty( $args['status'] ) ? 'all' : $args['status'];
194
195	if ( ! $this->validate_status_param( $comment_status ) ) {
196	return new WP_Error( 'invalid_status', "Invalid comment status value provided: '$comment_status'.", 400 );
197	}
198
199	return $this->get_site_tree( $comment_status );
200	}
201	}
202