class.wpcom-json-api-get-comments-tree-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 11.1.1

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

jetpack / json-endpoints Last commit date

class.wpcom-json-api-get-comments-tree-endpoint.php

196 lines

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