<?php

/**

 * REST API: WP_REST_Comments_Controller class

 *

 * @package WordPress

 * @subpackage REST_API

 * @since 4.7.0

 */

/**

 * Core controller used to access comments via the REST API.

 *

 * @since 4.7.0

 *

 * @see WP_REST_Controller

 */

class WP_REST_Comments_Controller extends WP_REST_Controller {

	/**

	 * Instance of a comment meta fields object.

	 *

	 * @since 4.7.0

	 * @var WP_REST_Comment_Meta_Fields

	 */

	protected $meta;

	/**

	 * Constructor.

	 *

	 * @since 4.7.0

	 */

	public function __construct() {

		$this->namespace = 'wp/v2';

		$this->rest_base = 'comments';

		$this->meta = new WP_REST_Comment_Meta_Fields();

	}

	/**

	 * Registers the routes for the objects of the controller.

	 *

	 * @since 4.7.0

	 */

	public function register_routes() {

		register_rest_route( $this->namespace, '/' . $this->rest_base, array(

			array(

				'methods'   => WP_REST_Server::READABLE,

				'callback'  => array( $this, 'get_items' ),

				'permission_callback' => array( $this, 'get_items_permissions_check' ),

				'args'      => $this->get_collection_params(),

			),

			array(

				'methods'  => WP_REST_Server::CREATABLE,

				'callback' => array( $this, 'create_item' ),

				'permission_callback' => array( $this, 'create_item_permissions_check' ),

				'args'     => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),

			),

			'schema' => array( $this, 'get_public_item_schema' ),

		) );

		register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(

			'args' => array(

				'id' => array(

					'description' => __( 'Unique identifier for the object.' ),

					'type'        => 'integer',

				),

			),

			array(

				'methods'  => WP_REST_Server::READABLE,

				'callback' => array( $this, 'get_item' ),

				'permission_callback' => array( $this, 'get_item_permissions_check' ),

				'args'     => array(

					'context'          => $this->get_context_param( array( 'default' => 'view' ) ),

					'password' => array(

						'description' => __( 'The password for the parent post of the comment (if the post is password protected).' ),

						'type'        => 'string',

					),

				),

			),

			array(

				'methods'  => WP_REST_Server::EDITABLE,

				'callback' => array( $this, 'update_item' ),

				'permission_callback' => array( $this, 'update_item_permissions_check' ),

				'args'     => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),

			),

			array(

				'methods'  => WP_REST_Server::DELETABLE,

				'callback' => array( $this, 'delete_item' ),

				'permission_callback' => array( $this, 'delete_item_permissions_check' ),

				'args'     => array(

					'force'    => array(

						'type'        => 'boolean',

						'default'     => false,

						'description' => __( 'Whether to bypass trash and force deletion.' ),

					),

					'password' => array(

						'description' => __( 'The password for the parent post of the comment (if the post is password protected).' ),

						'type'        => 'string',

					),

				),

			),

			'schema' => array( $this, 'get_public_item_schema' ),

		) );

	}

	/**

	 * Checks if a given request has access to read comments.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return WP_Error|bool True if the request has read access, error object otherwise.

	 */

	public function get_items_permissions_check( $request ) {

		if ( ! empty( $request['post'] ) ) {

			foreach ( (array) $request['post'] as $post_id ) {

				$post = get_post( $post_id );

				if ( ! empty( $post_id ) && $post && ! $this->check_read_post_permission( $post, $request ) ) {

					return new WP_Error( 'rest_cannot_read_post', __( 'Sorry, you are not allowed to read the post for this comment.' ), array( 'status' => rest_authorization_required_code() ) );

				} elseif ( 0 === $post_id && ! current_user_can( 'moderate_comments' ) ) {

					return new WP_Error( 'rest_cannot_read', __( 'Sorry, you are not allowed to read comments without a post.' ), array( 'status' => rest_authorization_required_code() ) );

				}

			}

		}

		if ( ! empty( $request['context'] ) && 'edit' === $request['context'] && ! current_user_can( 'moderate_comments' ) ) {

			return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit comments.' ), array( 'status' => rest_authorization_required_code() ) );

		}

		if ( ! current_user_can( 'edit_posts' ) ) {

			$protected_params = array( 'author', 'author_exclude', 'author_email', 'type', 'status' );

			$forbidden_params = array();

			foreach ( $protected_params as $param ) {

				if ( 'status' === $param ) {

					if ( 'approve' !== $request[ $param ] ) {

						$forbidden_params[] = $param;

					}

				} elseif ( 'type' === $param ) {

					if ( 'comment' !== $request[ $param ] ) {

						$forbidden_params[] = $param;

					}

				} elseif ( ! empty( $request[ $param ] ) ) {

					$forbidden_params[] = $param;

				}

			}

			if ( ! empty( $forbidden_params ) ) {

				return new WP_Error( 'rest_forbidden_param', sprintf( __( 'Query parameter not permitted: %s' ), implode( ', ', $forbidden_params ) ), array( 'status' => rest_authorization_required_code() ) );

			}

		}

		return true;

	}

	/**

	 * Retrieves a list of comment items.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return WP_Error|WP_REST_Response Response object on success, or error object on failure.

	 */

	public function get_items( $request ) {

		// Retrieve the list of registered collection query parameters.

		$registered = $this->get_collection_params();

		/*

		 * This array defines mappings between public API query parameters whose

		 * values are accepted as-passed, and their internal WP_Query parameter

		 * name equivalents (some are the same). Only values which are also

		 * present in $registered will be set.

		 */

		$parameter_mappings = array(

			'author'         => 'author__in',

			'author_email'   => 'author_email',

			'author_exclude' => 'author__not_in',

			'exclude'        => 'comment__not_in',

			'include'        => 'comment__in',

			'offset'         => 'offset',

			'order'          => 'order',

			'parent'         => 'parent__in',

			'parent_exclude' => 'parent__not_in',

			'per_page'       => 'number',

			'post'           => 'post__in',

			'search'         => 'search',

			'status'         => 'status',

			'type'           => 'type',

		);

		$prepared_args = array();

		/*

		 * For each known parameter which is both registered and present in the request,

		 * set the parameter's value on the query $prepared_args.

		 */

		foreach ( $parameter_mappings as $api_param => $wp_param ) {

			if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {

				$prepared_args[ $wp_param ] = $request[ $api_param ];

			}

		}

		// Ensure certain parameter values default to empty strings.

		foreach ( array( 'author_email', 'search' ) as $param ) {

			if ( ! isset( $prepared_args[ $param ] ) ) {

				$prepared_args[ $param ] = '';

			}

		}

		if ( isset( $registered['orderby'] ) ) {

			$prepared_args['orderby'] = $this->normalize_query_param( $request['orderby'] );

		}

		$prepared_args['no_found_rows'] = false;

		$prepared_args['date_query'] = array();

		// Set before into date query. Date query must be specified as an array of an array.

		if ( isset( $registered['before'], $request['before'] ) ) {

			$prepared_args['date_query'][0]['before'] = $request['before'];

		}

		// Set after into date query. Date query must be specified as an array of an array.

		if ( isset( $registered['after'], $request['after'] ) ) {

			$prepared_args['date_query'][0]['after'] = $request['after'];

		}

		if ( isset( $registered['page'] ) && empty( $request['offset'] ) ) {

			$prepared_args['offset'] = $prepared_args['number'] * ( absint( $request['page'] ) - 1 );

		}

		/**

		 * Filters arguments, before passing to WP_Comment_Query, when querying comments via the REST API.

		 *

		 * @since 4.7.0

		 *

		 * @link https://developer.wordpress.org/reference/classes/wp_comment_query/

		 *

		 * @param array           $prepared_args Array of arguments for WP_Comment_Query.

		 * @param WP_REST_Request $request       The current request.

		 */

		$prepared_args = apply_filters( 'rest_comment_query', $prepared_args, $request );

		$query = new WP_Comment_Query;

		$query_result = $query->query( $prepared_args );

		$comments = array();

		foreach ( $query_result as $comment ) {

			if ( ! $this->check_read_permission( $comment, $request ) ) {

				continue;

			}

			$data = $this->prepare_item_for_response( $comment, $request );

			$comments[] = $this->prepare_response_for_collection( $data );

		}

		$total_comments = (int) $query->found_comments;

		$max_pages      = (int) $query->max_num_pages;

		if ( $total_comments < 1 ) {

			// Out-of-bounds, run the query again without LIMIT for total count.

			unset( $prepared_args['number'], $prepared_args['offset'] );

			$query = new WP_Comment_Query;

			$prepared_args['count'] = true;

			$total_comments = $query->query( $prepared_args );

			$max_pages = ceil( $total_comments / $request['per_page'] );

		}

		$response = rest_ensure_response( $comments );

		$response->header( 'X-WP-Total', $total_comments );

		$response->header( 'X-WP-TotalPages', $max_pages );

		$base = add_query_arg( $request->get_query_params(), rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ) );

		if ( $request['page'] > 1 ) {

			$prev_page = $request['page'] - 1;

			if ( $prev_page > $max_pages ) {

				$prev_page = $max_pages;

			}

			$prev_link = add_query_arg( 'page', $prev_page, $base );

			$response->link_header( 'prev', $prev_link );

		}

		if ( $max_pages > $request['page'] ) {

			$next_page = $request['page'] + 1;

			$next_link = add_query_arg( 'page', $next_page, $base );

			$response->link_header( 'next', $next_link );

		}

		return $response;

	}

	/**

	 * Get the comment, if the ID is valid.

	 *

	 * @since 4.7.2

	 *

	 * @param int $id Supplied ID.

	 * @return WP_Comment|WP_Error Comment object if ID is valid, WP_Error otherwise.

	 */

	protected function get_comment( $id ) {

		$error = new WP_Error( 'rest_comment_invalid_id', __( 'Invalid comment ID.' ), array( 'status' => 404 ) );

		if ( (int) $id <= 0 ) {

			return $error;

		}

		$id = (int) $id;

		$comment = get_comment( $id );

		if ( empty( $comment ) ) {

			return $error;

		}

		if ( ! empty( $comment->comment_post_ID ) ) {

			$post = get_post( (int) $comment->comment_post_ID );

			if ( empty( $post ) ) {

				return new WP_Error( 'rest_post_invalid_id', __( 'Invalid post ID.' ), array( 'status' => 404 ) );

			}

		}

		return $comment;

	}

	/**

	 * Checks if a given request has access to read the comment.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return WP_Error|bool True if the request has read access for the item, error object otherwise.

	 */

	public function get_item_permissions_check( $request ) {

		$comment = $this->get_comment( $request['id'] );

		if ( is_wp_error( $comment ) ) {

			return $comment;

		}

		if ( ! empty( $request['context'] ) && 'edit' === $request['context'] && ! current_user_can( 'moderate_comments' ) ) {

			return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit comments.' ), array( 'status' => rest_authorization_required_code() ) );

		}

		$post = get_post( $comment->comment_post_ID );

		if ( ! $this->check_read_permission( $comment, $request ) ) {

			return new WP_Error( 'rest_cannot_read', __( 'Sorry, you are not allowed to read this comment.' ), array( 'status' => rest_authorization_required_code() ) );

		}

		if ( $post && ! $this->check_read_post_permission( $post, $request ) ) {

			return new WP_Error( 'rest_cannot_read_post', __( 'Sorry, you are not allowed to read the post for this comment.' ), array( 'status' => rest_authorization_required_code() ) );

		}

		return true;

	}

	/**

	 * Retrieves a comment.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return WP_Error|WP_REST_Response Response object on success, or error object on failure.

	 */

	public function get_item( $request ) {

		$comment = $this->get_comment( $request['id'] );

		if ( is_wp_error( $comment ) ) {

			return $comment;

		}

		$data = $this->prepare_item_for_response( $comment, $request );

		$response = rest_ensure_response( $data );

		return $response;

	}

	/**

	 * Checks if a given request has access to create a comment.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return WP_Error|bool True if the request has access to create items, error object otherwise.

	 */

	public function create_item_permissions_check( $request ) {

		if ( ! is_user_logged_in() ) {

			if ( get_option( 'comment_registration' ) ) {

				return new WP_Error( 'rest_comment_login_required', __( 'Sorry, you must be logged in to comment.' ), array( 'status' => 401 ) );

			}

			/**

			 * Filter whether comments can be created without authentication.

			 *

			 * Enables creating comments for anonymous users.

			 *

			 * @since 4.7.0

			 *

			 * @param bool $allow_anonymous Whether to allow anonymous comments to

			 *                              be created. Default `false`.

			 * @param WP_REST_Request $request Request used to generate the

			 *                                 response.

			 */

			$allow_anonymous = apply_filters( 'rest_allow_anonymous_comments', false, $request );

			if ( ! $allow_anonymous ) {

				return new WP_Error( 'rest_comment_login_required', __( 'Sorry, you must be logged in to comment.' ), array( 'status' => 401 ) );

			}

		}