<?php

/**

 * REST API: WP_REST_Terms_Controller class

 *

 * @package WordPress

 * @subpackage REST_API

 * @since 4.7.0

 */

/**

 * Core class used to managed terms associated with a taxonomy via the REST API.

 *

 * @since 4.7.0

 *

 * @see WP_REST_Controller

 */

class WP_REST_Terms_Controller extends WP_REST_Controller {

	/**

	 * Taxonomy key.

	 *

	 * @since 4.7.0

	 * @var string

	 */

	protected $taxonomy;

	/**

	 * Instance of a term meta fields object.

	 *

	 * @since 4.7.0

	 * @var WP_REST_Term_Meta_Fields

	 */

	protected $meta;

	/**

	 * Column to have the terms be sorted by.

	 *

	 * @since 4.7.0

	 * @var string

	 */

	protected $sort_column;

	/**

	 * Number of terms that were found.

	 *

	 * @since 4.7.0

	 * @var int

	 */

	protected $total_terms;

	/**

	 * Whether the controller supports batching.

	 *

	 * @since 5.9.0

	 * @var array

	 */

	protected $allow_batch = array( 'v1' => true );

	/**

	 * Constructor.

	 *

	 * @since 4.7.0

	 *

	 * @param string $taxonomy Taxonomy key.

	 */

	public function __construct( $taxonomy ) {

		$this->taxonomy  = $taxonomy;

		$tax_obj         = get_taxonomy( $taxonomy );

		$this->rest_base = ! empty( $tax_obj->rest_base ) ? $tax_obj->rest_base : $tax_obj->name;

		$this->namespace = ! empty( $tax_obj->rest_namespace ) ? $tax_obj->rest_namespace : 'wp/v2';

		$this->meta = new WP_REST_Term_Meta_Fields( $taxonomy );

	}

	/**

	 * Registers the routes for terms.

	 *

	 * @since 4.7.0

	 *

	 * @see register_rest_route()

	 */

	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 ),

				),

				'allow_batch' => $this->allow_batch,

				'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 term.' ),

						'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' ) ),

					),

				),

				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' => __( 'Required to be true, as terms do not support trashing.' ),

						),

					),

				),

				'allow_batch' => $this->allow_batch,

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

			)

		);

	}

	/**

	 * Checks if a request has access to read terms in the specified taxonomy.

	 *

	 * @since 4.7.0

	 *

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

	 */

	public function get_items_permissions_check( $request ) {

		$tax_obj = get_taxonomy( $this->taxonomy );

		if ( ! $tax_obj || ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {

			return false;

		}

		if ( 'edit' === $request['context'] && ! current_user_can( $tax_obj->cap->edit_terms ) ) {

			return new WP_Error(

				'rest_forbidden_context',

				__( 'Sorry, you are not allowed to edit terms in this taxonomy.' ),

				array( 'status' => rest_authorization_required_code() )

			);

		}

		return true;

	}

	/**

	 * Retrieves terms associated with a taxonomy.

	 *

	 * @since 4.7.0

	 *

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

	 * @return WP_REST_Response|WP_Error Response object on success, or WP_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(

			'exclude'    => 'exclude',

			'include'    => 'include',

			'order'      => 'order',

			'orderby'    => 'orderby',

			'post'       => 'post',

			'hide_empty' => 'hide_empty',

			'per_page'   => 'number',

			'search'     => 'search',

			'slug'       => 'slug',

		);

		$prepared_args = array( 'taxonomy' => $this->taxonomy );

		/*

		 * 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 ];

			}

		}

		if ( isset( $prepared_args['orderby'] ) && isset( $request['orderby'] ) ) {

			$orderby_mappings = array(

				'include_slugs' => 'slug__in',

			);

			if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {

				$prepared_args['orderby'] = $orderby_mappings[ $request['orderby'] ];

			}

		}

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

			$prepared_args['offset'] = $request['offset'];

		} else {

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

		}

		$taxonomy_obj = get_taxonomy( $this->taxonomy );

		if ( $taxonomy_obj->hierarchical && isset( $registered['parent'], $request['parent'] ) ) {

			if ( 0 === $request['parent'] ) {

				// Only query top-level terms.

				$prepared_args['parent'] = 0;

			} else {

				if ( $request['parent'] ) {

					$prepared_args['parent'] = $request['parent'];

				}

			}

		}

		/**

		 * Filters get_terms() arguments when querying terms via the REST API.

		 *

		 * The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.

		 *

		 * Possible hook names include:

		 *

		 *  - `rest_category_query`

		 *  - `rest_post_tag_query`

		 *

		 * Enables adding extra arguments or setting defaults for a terms

		 * collection request.

		 *

		 * @since 4.7.0

		 *

		 * @link https://developer.wordpress.org/reference/functions/get_terms/

		 *

		 * @param array           $prepared_args Array of arguments for get_terms().

		 * @param WP_REST_Request $request       The REST API request.

		 */

		$prepared_args = apply_filters( "rest_{$this->taxonomy}_query", $prepared_args, $request );

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

			$query_result = wp_get_object_terms( $prepared_args['post'], $this->taxonomy, $prepared_args );

			// Used when calling wp_count_terms() below.

			$prepared_args['object_ids'] = $prepared_args['post'];

		} else {

			$query_result = get_terms( $prepared_args );

		}

		$count_args = $prepared_args;

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

		$total_terms = wp_count_terms( $count_args );

		// wp_count_terms() can return a falsey value when the term has no children.

		if ( ! $total_terms ) {

			$total_terms = 0;

		}

		$response = array();

		foreach ( $query_result as $term ) {

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

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

		}

		$response = rest_ensure_response( $response );

		// Store pagination values for headers.

		$per_page = (int) $prepared_args['number'];

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

		if ( $page > 1 ) {

			$prev_page = $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 > $page ) {

			$next_page = $page + 1;

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

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

		}

		return $response;

	}

	/**

	 * Get the term, if the ID is valid.

	 *

	 * @since 4.7.2

	 *

	 * @param int $id Supplied ID.

	 * @return WP_Term|WP_Error Term object if ID is valid, WP_Error otherwise.

	 */

	protected function get_term( $id ) {

		$error = new WP_Error(

			'rest_term_invalid',

			__( 'Term does not exist.' ),

			array( 'status' => 404 )

		);

		if ( ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {

			return $error;

		}

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

			return $error;

		}

		$term = get_term( (int) $id, $this->taxonomy );

		if ( empty( $term ) || $term->taxonomy !== $this->taxonomy ) {

			return $error;

		}

		return $term;

	}

	/**

	 * Checks if a request has access to read or edit the specified term.

	 *

	 * @since 4.7.0

	 *

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

	 */