<?php

/**

 * REST API: WP_REST_Controller class

 *

 * @package WordPress

 * @subpackage REST_API

 * @since 4.7.0

 */

/**

 * Core base controller for managing and interacting with REST API items.

 *

 * @since 4.7.0

 */

abstract class WP_REST_Controller {

	/**

	 * The namespace of this controller's route.

	 *

	 * @since 4.7.0

	 * @var string

	 */

	protected $namespace;

	/**

	 * The base of this controller's route.

	 *

	 * @since 4.7.0

	 * @var string

	 */

	protected $rest_base;

	/**

	 * Registers the routes for the objects of the controller.

	 *

	 * @since 4.7.0

	 */

	public function register_routes() {

		/* translators: %s: register_routes() */

		_doing_it_wrong( 'WP_REST_Controller::register_routes', sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), '4.7' );

	}

	/**

	 * Checks if a given request has access to get items.

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function get_items_permissions_check( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Retrieves a collection of items.

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function get_items( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Checks if a given request has access to get a specific item.

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function get_item_permissions_check( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Retrieves one item from the collection.

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function get_item( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

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

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function create_item_permissions_check( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Creates one item from the collection.

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function create_item( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Checks if a given request has access to update a specific item.

	 *

	 * @since 4.7.0

	 *

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

	 * @return WP_Error|bool True if the request has access to update the item, WP_Error object otherwise.

	 */

	public function update_item_permissions_check( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Updates one item from the collection.

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function update_item( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Checks if a given request has access to delete a specific item.

	 *

	 * @since 4.7.0

	 *

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

	 * @return WP_Error|bool True if the request has access to delete the item, WP_Error object otherwise.

	 */

	public function delete_item_permissions_check( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Deletes one item from the collection.

	 *

	 * @since 4.7.0

	 *

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

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

	 */

	public function delete_item( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Prepares one item for create or update operation.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Request object.

	 * @return WP_Error|object The prepared item, or WP_Error object on failure.

	 */

	protected function prepare_item_for_database( $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Prepares the item for the REST response.

	 *

	 * @since 4.7.0

	 *

	 * @param mixed           $item    WordPress representation of the item.

	 * @param WP_REST_Request $request Request object.

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

	 */

	public function prepare_item_for_response( $item, $request ) {

		/* translators: %s: method name */

		return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );

	}

	/**

	 * Prepares a response for insertion into a collection.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Response $response Response object.

	 * @return array|mixed Response data, ready for insertion into collection data.

	 */

	public function prepare_response_for_collection( $response ) {

		if ( ! ( $response instanceof WP_REST_Response ) ) {

			return $response;

		}

		$data   = (array) $response->get_data();

		$server = rest_get_server();

		if ( method_exists( $server, 'get_compact_response_links' ) ) {

			$links = call_user_func( array( $server, 'get_compact_response_links' ), $response );

		} else {

			$links = call_user_func( array( $server, 'get_response_links' ), $response );

		}

		if ( ! empty( $links ) ) {

			$data['_links'] = $links;

		}

		return $data;

	}

	/**

	 * Filters a response based on the context defined in the schema.

	 *

	 * @since 4.7.0

	 *

	 * @param array  $data    Response data to fiter.

	 * @param string $context Context defined in the schema.

	 * @return array Filtered response.

	 */

	public function filter_response_by_context( $data, $context ) {

		$schema = $this->get_item_schema();

		foreach ( $data as $key => $value ) {

			if ( empty( $schema['properties'][ $key ] ) || empty( $schema['properties'][ $key ]['context'] ) ) {

				continue;

			}

			if ( ! in_array( $context, $schema['properties'][ $key ]['context'], true ) ) {

				unset( $data[ $key ] );

				continue;

			}

			if ( 'object' === $schema['properties'][ $key ]['type'] && ! empty( $schema['properties'][ $key ]['properties'] ) ) {

				foreach ( $schema['properties'][ $key ]['properties'] as $attribute => $details ) {

					if ( empty( $details['context'] ) ) {

						continue;

					}

					if ( ! in_array( $context, $details['context'], true ) ) {

						if ( isset( $data[ $key ][ $attribute ] ) ) {

							unset( $data[ $key ][ $attribute ] );

						}

					}

				}

			}

		}

		return $data;

	}

	/**

	 * Retrieves the item's schema, conforming to JSON Schema.

	 *

	 * @since 4.7.0

	 *

	 * @return array Item schema data.

	 */

	public function get_item_schema() {

		return $this->add_additional_fields_schema( array() );

	}

	/**

	 * Retrieves the item's schema for display / public consumption purposes.

	 *

	 * @since 4.7.0

	 *

	 * @return array Public item schema data.

	 */

	public function get_public_item_schema() {

		$schema = $this->get_item_schema();

		foreach ( $schema['properties'] as &$property ) {

			unset( $property['arg_options'] );

		}

		return $schema;

	}

	/**

	 * Retrieves the query params for the collections.

	 *

	 * @since 4.7.0

	 *

	 * @return array Query parameters for the collection.

	 */

	public function get_collection_params() {

		return array(

			'context'                => $this->get_context_param(),

			'page'                   => array(

				'description'        => __( 'Current page of the collection.' ),

				'type'               => 'integer',

				'default'            => 1,

				'sanitize_callback'  => 'absint',

				'validate_callback'  => 'rest_validate_request_arg',

				'minimum'            => 1,

			),

			'per_page'               => array(

				'description'        => __( 'Maximum number of items to be returned in result set.' ),

				'type'               => 'integer',

				'default'            => 10,

				'minimum'            => 1,

				'maximum'            => 100,

				'sanitize_callback'  => 'absint',

				'validate_callback'  => 'rest_validate_request_arg',

			),

			'search'                 => array(

				'description'        => __( 'Limit results to those matching a string.' ),

				'type'               => 'string',

				'sanitize_callback'  => 'sanitize_text_field',

				'validate_callback'  => 'rest_validate_request_arg',

			),

		);

	}

	/**

	 * Retrieves the magical context param.

	 *

	 * Ensures consistent descriptions between endpoints, and populates enum from schema.

	 *

	 * @since 4.7.0

	 *

	 * @param array $args Optional. Additional arguments for context parameter. Default empty array.

	 * @return array Context parameter details.

	 */

	public function get_context_param( $args = array() ) {

		$param_details = array(

			'description'        => __( 'Scope under which the request is made; determines fields present in response.' ),

			'type'               => 'string',

			'sanitize_callback'  => 'sanitize_key',

			'validate_callback'  => 'rest_validate_request_arg',

		);

		$schema = $this->get_item_schema();

		if ( empty( $schema['properties'] ) ) {

			return array_merge( $param_details, $args );

		}

		$contexts = array();

		foreach ( $schema['properties'] as $attributes ) {

			if ( ! empty( $attributes['context'] ) ) {

				$contexts = array_merge( $contexts, $attributes['context'] );

			}

		}

		if ( ! empty( $contexts ) ) {

			$param_details['enum'] = array_unique( $contexts );

			rsort( $param_details['enum'] );

		}

		return array_merge( $param_details, $args );

	}

	/**

	 * Adds the values from additional fields to a data object.

	 *

	 * @since 4.7.0

	 *

	 * @param array           $object  Data object.

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

	 * @return array Modified data object with additional fields.

	 */

	protected function add_additional_fields_to_object( $object, $request ) {

		$additional_fields = $this->get_additional_fields();

		foreach ( $additional_fields as $field_name => $field_options ) {

			if ( ! $field_options['get_callback'] ) {

				continue;

			}

			$object[ $field_name ] = call_user_func( $field_options['get_callback'], $object, $field_name, $request, $this->get_object_type() );

		}

		return $object;

	}

	/**

	 * Updates the values of additional fields added to a data object.

	 *

	 * @since 4.7.0

	 *

	 * @param array           $object  Data Object.

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

	 * @return bool|WP_Error True on success, WP_Error object if a field cannot be updated.

	 */

	protected function update_additional_fields_for_object( $object, $request ) {

		$additional_fields = $this->get_additional_fields();

		foreach ( $additional_fields as $field_name => $field_options ) {

			if ( ! $field_options['update_callback'] ) {

				continue;

			}

			// Don't run the update callbacks if the data wasn't passed in the request.

			if ( ! isset( $request[ $field_name ] ) ) {

				continue;

			}

			$result = call_user_func( $field_options['update_callback'], $request[ $field_name ], $object, $field_name, $request, $this->get_object_type() );

			if ( is_wp_error( $result ) ) {

				return $result;

			}

		}

		return true;

	}

	/**

	 * Adds the schema from additional fields to a schema array.

	 *

	 * The type of object is inferred from the passed schema.

	 *

	 * @since 4.7.0

	 *

	 * @param array $schema Schema array.

	 * @return array Modified Schema array.

	 */