woocommerce / woocommerce-rest-api

src/Controllers/Version4/SystemStatusTools.php

<?php
/**
 * REST API WC System Status Tools Controller
 *
 * Handles requests to the /system_status/tools/* endpoints.
 *
 * @package Automattic/WooCommerce/RestApi
 */

namespace Automattic\WooCommerce\RestApi\Controllers\Version4;

defined( 'ABSPATH' ) || exit;

/**
 * REST API System Status Tools controller class.
 */
class SystemStatusTools extends AbstractController {

	/**
	 * Route base.
	 *
	 * @var string
	 */
	protected $rest_base = 'system_status/tools';

	/**
	 * Permission to check.
	 *
	 * @var string
	 */
	protected $resource_type = 'system_status';

	/**
	 * Register the routes for /system_status/tools/*.
	 */
	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(),
				),
				'schema' => array( $this, 'get_public_item_schema' ),
			),
			true
		);

		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base . '/(?P<id>[\w-]+)',
			array(
				'args'   => array(
					'id' => array(
						'description' => __( 'Unique identifier for the resource.', 'woocommerce-rest-api' ),
						'type'        => 'string',
					),
				),
				array(
					'methods'             => \WP_REST_Server::READABLE,
					'callback'            => array( $this, 'get_item' ),
					'permission_callback' => array( $this, 'get_item_permissions_check' ),
				),
				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 ),
				),
				'schema' => array( $this, 'get_public_item_schema' ),
			),
			true
		);
	}

	/**
	 * A list of available tools for use in the system status section.
	 * 'button' becomes 'action' in the API.
	 *
	 * @return array
	 */
	public function get_tools() {
		$tools = array(
			'clear_transients'                   => array(
				'name'   => __( 'WooCommerce transients', 'woocommerce-rest-api' ),
				'button' => __( 'Clear transients', 'woocommerce-rest-api' ),
				'desc'   => __( 'This tool will clear the product/shop transients cache.', 'woocommerce-rest-api' ),
			),
			'clear_expired_transients'           => array(
				'name'   => __( 'Expired transients', 'woocommerce-rest-api' ),
				'button' => __( 'Clear transients', 'woocommerce-rest-api' ),
				'desc'   => __( 'This tool will clear ALL expired transients from WordPress.', 'woocommerce-rest-api' ),
			),
			'delete_orphaned_variations'         => array(
				'name'   => __( 'Orphaned variations', 'woocommerce-rest-api' ),
				'button' => __( 'Delete orphaned variations', 'woocommerce-rest-api' ),
				'desc'   => __( 'This tool will delete all variations which have no parent.', 'woocommerce-rest-api' ),
			),
			'clear_expired_download_permissions' => array(
				'name'   => __( 'Used-up download permissions', 'woocommerce-rest-api' ),
				'button' => __( 'Clean up download permissions', 'woocommerce-rest-api' ),
				'desc'   => __( 'This tool will delete expired download permissions and permissions with 0 remaining downloads.', 'woocommerce-rest-api' ),
			),
			'regenerate_product_lookup_tables'   => array(
				'name'   => __( 'Product lookup tables', 'woocommerce-rest-api' ),
				'button' => __( 'Regenerate', 'woocommerce-rest-api' ),
				'desc'   => __( 'This tool will regenerate product lookup table data. This process may take a while.', 'woocommerce-rest-api' ),
			),
			'recount_terms'                      => array(
				'name'   => __( 'Term counts', 'woocommerce-rest-api' ),
				'button' => __( 'Recount terms', 'woocommerce-rest-api' ),
				'desc'   => __( 'This tool will recount product terms - useful when changing your settings in a way which hides products from the catalog.', 'woocommerce-rest-api' ),
			),
			'reset_roles'                        => array(
				'name'   => __( 'Capabilities', 'woocommerce-rest-api' ),
				'button' => __( 'Reset capabilities', 'woocommerce-rest-api' ),
				'desc'   => __( 'This tool will reset the admin, customer and shop_manager roles to default. Use this if your users cannot access all of the WooCommerce admin pages.', 'woocommerce-rest-api' ),
			),
			'clear_sessions'                     => array(
				'name'   => __( 'Clear customer sessions', 'woocommerce-rest-api' ),
				'button' => __( 'Clear', 'woocommerce-rest-api' ),
				'desc'   => sprintf(
					'<strong class="red">%1$s</strong> %2$s',
					__( 'Note:', 'woocommerce-rest-api' ),
					__( 'This tool will delete all customer session data from the database, including current carts and saved carts in the database.', 'woocommerce-rest-api' )
				),
			),
			'install_pages'                      => array(
				'name'   => __( 'Create default WooCommerce pages', 'woocommerce-rest-api' ),
				'button' => __( 'Create pages', 'woocommerce-rest-api' ),
				'desc'   => sprintf(
					'<strong class="red">%1$s</strong> %2$s',
					__( 'Note:', 'woocommerce-rest-api' ),
					__( 'This tool will install all the missing WooCommerce pages. Pages already defined and set up will not be replaced.', 'woocommerce-rest-api' )
				),
			),
			'delete_taxes'                       => array(
				'name'   => __( 'Delete WooCommerce tax rates', 'woocommerce-rest-api' ),
				'button' => __( 'Delete tax rates', 'woocommerce-rest-api' ),
				'desc'   => sprintf(
					'<strong class="red">%1$s</strong> %2$s',
					__( 'Note:', 'woocommerce-rest-api' ),
					__( 'This option will delete ALL of your tax rates, use with caution. This action cannot be reversed.', 'woocommerce-rest-api' )
				),
			),
			'regenerate_thumbnails'              => array(
				'name'   => __( 'Regenerate shop thumbnails', 'woocommerce-rest-api' ),
				'button' => __( 'Regenerate', 'woocommerce-rest-api' ),
				'desc'   => __( 'This will regenerate all shop thumbnails to match your theme and/or image settings.', 'woocommerce-rest-api' ),
			),
			'db_update_routine'                  => array(
				'name'   => __( 'Update database', 'woocommerce-rest-api' ),
				'button' => __( 'Update database', 'woocommerce-rest-api' ),
				'desc'   => sprintf(
					'<strong class="red">%1$s</strong> %2$s',
					__( 'Note:', 'woocommerce-rest-api' ),
					__( 'This tool will update your WooCommerce database to the latest version. Please ensure you make sufficient backups before proceeding.', 'woocommerce-rest-api' )
				),
			),
		);

		// Jetpack does the image resizing heavy lifting so you don't have to.
		if ( ( class_exists( 'Jetpack' ) && Jetpack::is_module_active( 'photon' ) ) || ! apply_filters( 'woocommerce_background_image_regeneration', true ) ) {

The type Automattic\WooCommerce\RestApi\Controllers\Version4\Jetpack was not found. Maybe you did not declare it correctly or list all dependencies?

			unset( $tools['regenerate_thumbnails'] );
		}

		return apply_filters( 'woocommerce_debug_tools', $tools );
	}

	/**
	 * Get a list of system status tools.
	 *
	 * @param \WP_REST_Request $request Full details about the request.
	 * @return \WP_Error|\WP_REST_Response
	 */
	public function get_items( $request ) {
		$tools = array();
		foreach ( $this->get_tools() as $id => $tool ) {
			$tools[] = $this->prepare_response_for_collection(
				$this->prepare_item_for_response(
					array(
						'id'          => $id,
						'name'        => $tool['name'],
						'action'      => $tool['button'],
						'description' => $tool['desc'],
					),
					$request
				)
			);
		}

		$response = rest_ensure_response( $tools );
		return $response;
	}

	/**
	 * Return a single tool.
	 *
	 * @param  \WP_REST_Request $request Request data.
	 * @return \WP_Error|\WP_REST_Response
	 */
	public function get_item( $request ) {
		$tools = $this->get_tools();
		if ( empty( $tools[ $request['id'] ] ) ) {
			return new \WP_Error( 'woocommerce_rest_system_status_tool_invalid_id', __( 'Invalid tool ID.', 'woocommerce-rest-api' ), array( 'status' => 404 ) );
		}
		$tool = $tools[ $request['id'] ];
		return rest_ensure_response(
			$this->prepare_item_for_response(
				array(
					'id'          => $request['id'],
					'name'        => $tool['name'],
					'action'      => $tool['button'],
					'description' => $tool['desc'],
				),
				$request
			)
		);
	}

	/**
	 * Update (execute) a tool.
	 *
	 * @param  \WP_REST_Request $request Request data.
	 * @return \WP_Error|\WP_REST_Response
	 */
	public function update_item( $request ) {
		$tools = $this->get_tools();
		if ( empty( $tools[ $request['id'] ] ) ) {
			return new \WP_Error( 'woocommerce_rest_system_status_tool_invalid_id', __( 'Invalid tool ID.', 'woocommerce-rest-api' ), array( 'status' => 404 ) );
		}

		$tool = $tools[ $request['id'] ];
		$tool = array(
			'id'          => $request['id'],
			'name'        => $tool['name'],
			'action'      => $tool['button'],
			'description' => $tool['desc'],
		);

		$execute_return = $this->execute_tool( $request['id'] );
		$tool           = array_merge( $tool, $execute_return );

		/**
		 * Fires after a WooCommerce REST system status tool has been executed.
		 *
		 * @param array           $tool    Details about the tool that has been executed.
		 * @param \WP_REST_Request $request The current \WP_REST_Request object.
		 */
		do_action( 'woocommerce_rest_insert_system_status_tool', $tool, $request );

		$request->set_param( 'context', 'edit' );
		$response = $this->prepare_item_for_response( $tool, $request );
		return rest_ensure_response( $response );
	}

	/**
	 * Get the system status tools schema, conforming to JSON Schema.
	 *
	 * @return array
	 */
	public function get_item_schema() {
		$schema = array(
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => 'system_status_tool',
			'type'       => 'object',
			'properties' => array(
				'id'          => array(
					'description' => __( 'A unique identifier for the tool.', 'woocommerce-rest-api' ),
					'type'        => 'string',
					'context'     => array( 'view', 'edit' ),
					'arg_options' => array(
						'sanitize_callback' => 'sanitize_title',
					),
				),
				'name'        => array(
					'description' => __( 'Tool name.', 'woocommerce-rest-api' ),
					'type'        => 'string',
					'context'     => array( 'view', 'edit' ),
					'arg_options' => array(
						'sanitize_callback' => 'sanitize_text_field',
					),
				),
				'action'      => array(
					'description' => __( 'What running the tool will do.', 'woocommerce-rest-api' ),
					'type'        => 'string',
					'context'     => array( 'view', 'edit' ),
					'arg_options' => array(
						'sanitize_callback' => 'sanitize_text_field',
					),
				),
				'description' => array(
					'description' => __( 'Tool description.', 'woocommerce-rest-api' ),
					'type'        => 'string',
					'context'     => array( 'view', 'edit' ),
					'arg_options' => array(
						'sanitize_callback' => 'sanitize_text_field',
					),
				),
				'success'     => array(
					'description' => __( 'Did the tool run successfully?', 'woocommerce-rest-api' ),
					'type'        => 'boolean',
					'context'     => array( 'edit' ),
				),
				'message'     => array(
					'description' => __( 'Tool return message.', 'woocommerce-rest-api' ),
					'type'        => 'string',
					'context'     => array( 'edit' ),
					'arg_options' => array(
						'sanitize_callback' => 'sanitize_text_field',
					),
				),
			),
		);

		return $this->add_additional_fields_schema( $schema );
	}

	/**
	 * Prepare links for the request.
	 *
	 * @param mixed            $item Object to prepare.
	 * @param \WP_REST_Request $request Request object.
	 * @return array
	 */
	protected function prepare_links( $item, $request ) {
		$base  = '/' . $this->namespace . '/' . $this->rest_base;
		$links = array(
			'item' => array(
				'href'       => rest_url( trailingslashit( $base ) . $item['id'] ),
				'embeddable' => true,
			),
		);

		return $links;
	}

	/**
	 * Get any query params needed.
	 *
	 * @return array
	 */
	public function get_collection_params() {
		return array(
			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
		);
	}

	/**
	 * Actually executes a tool.
	 *
	 * @throws Exception When the tool cannot run.
	 * @param  string $tool Tool.
	 * @return array
	 */
	public function execute_tool( $tool ) {
		$ran   = false;
		$tools = $this->get_tools();

		try {
			if ( ! isset( $tools[ $tool ] ) ) {
				throw new Exception( __( 'There was an error calling this tool. There is no callback present.', 'woocommerce-rest-api' ) );

The type Automattic\WooCommerce\RestApi\Controllers\Version4\Exception was not found. Did you mean Exception? If so, make sure to prefix the type with \.

			}

			$callback = isset( $tools[ $tool ]['callback'] ) ? $tools[ $tool ]['callback'] : array( $this, $tool );

			if ( ! is_callable( $callback ) ) {
				throw new Exception( __( 'There was an error calling this tool. Invalid callback.', 'woocommerce-rest-api' ) );
			}

			$message = call_user_func( $callback );

			if ( false === $message ) {
				throw new Exception( __( 'There was an error calling this tool. Invalid callback.', 'woocommerce-rest-api' ) );
			}

			if ( empty( $message ) || ! is_string( $message ) ) {
				$message = __( 'Tool ran.', 'woocommerce-rest-api' );
			}

			$ran = true;
		} catch ( Exception $e ) {
			$message = $e->getMessage();
			$ran     = false;
		}

		return array(
			'success' => $ran,
			'message' => $message,
		);
	}

	/**
	 * Tool: clear_transients.
	 *
	 * @return string Success message.
	 */
	protected function clear_transients() {
		wc_delete_product_transients();
		wc_delete_shop_order_transients();
		delete_transient( 'wc_count_comments' );

		$attribute_taxonomies = wc_get_attribute_taxonomies();

		if ( ! empty( $attribute_taxonomies ) ) {
			foreach ( $attribute_taxonomies as $attribute ) {
				delete_transient( 'wc_layered_nav_counts_pa_' . $attribute->attribute_name );
			}
		}

		\WC_Cache_Helper::get_transient_version( 'shipping', true );
		return __( 'Product transients cleared', 'woocommerce-rest-api' );
	}

	/**
	 * Tool: clear_expired_transients.
	 *
	 * @return string Success message.
	 */
	protected function clear_expired_transients() {
		/* translators: %d: amount of expired transients */
		return sprintf( __( '%d transients rows cleared', 'woocommerce-rest-api' ), wc_delete_expired_transients() );
	}

	/**
	 * Tool: delete_orphaned_variations.
	 *
	 * @return string Success message.
	 */
	protected function delete_orphaned_variations() {
		global $wpdb;

		$result = absint(
			$wpdb->query(
				"DELETE products
			FROM {$wpdb->posts} products
			LEFT JOIN {$wpdb->posts} wp ON wp.ID = products.post_parent
			WHERE wp.ID IS NULL AND products.post_type = 'product_variation';"
			)
		);
		/* translators: %d: amount of orphaned variations */
		return sprintf( __( '%d orphaned variations deleted', 'woocommerce-rest-api' ), $result );
	}

	/**
	 * Tool: clear_expired_download_permissions.
	 *
	 * @return string Success message.
	 */
	protected function clear_expired_download_permissions() {
		global $wpdb;

		$result = absint(
			$wpdb->query(
				$wpdb->prepare(
					"DELETE FROM {$wpdb->prefix}woocommerce_downloadable_product_permissions
					WHERE ( downloads_remaining != '' AND downloads_remaining = 0 ) OR ( access_expires IS NOT NULL AND access_expires < %s )",
					date( 'Y-m-d', current_time( 'timestamp' ) )
				)
			)
		);
		/* translators: %d: amount of permissions */
		return sprintf( __( '%d permissions deleted', 'woocommerce-rest-api' ), $result );
	}

	/**
	 * Tool: regenerate_product_lookup_tables.
	 *
	 * @return string Success message.
	 */
	protected function regenerate_product_lookup_tables() {
		if ( ! wc_update_product_lookup_tables_is_running() ) {
			wc_update_product_lookup_tables();
		}
		return __( 'Lookup tables are regenerating', 'woocommerce-rest-api' );
	}

	/**
	 * Tool: reset_roles.
	 *
	 * @return string Success message.
	 */
	protected function reset_roles() {
		\WC_Install::remove_roles();
		\WC_Install::create_roles();
		return __( 'Roles successfully reset', 'woocommerce-rest-api' );
	}

	/**
	 * Tool: recount_terms.
	 *
	 * @return string Success message.
	 */
	protected function recount_terms() {
		$product_cats = get_terms(
			'product_cat',
			array(
				'hide_empty' => false,
				'fields'     => 'id=>parent',
			)
		);
		_wc_term_recount( $product_cats, get_taxonomy( 'product_cat' ), true, false );
		$product_tags = get_terms(
			'product_tag',
			array(
				'hide_empty' => false,
				'fields'     => 'id=>parent',
			)
		);
		_wc_term_recount( $product_tags, get_taxonomy( 'product_tag' ), true, false );
		return __( 'Terms successfully recounted', 'woocommerce-rest-api' );
	}

	/**
	 * Tool: clear_sessions.
	 *
	 * @return string Success message.
	 */
	protected function clear_sessions() {
		global $wpdb;

		$wpdb->query( "TRUNCATE {$wpdb->prefix}woocommerce_sessions" );
		$result = absint( $wpdb->query( "DELETE FROM {$wpdb->usermeta} WHERE meta_key='_woocommerce_persistent_cart_" . get_current_blog_id() . "';" ) ); // WPCS: unprepared SQL ok.
		wp_cache_flush();
		/* translators: %d: amount of sessions */
		return sprintf( __( 'Deleted all active sessions, and %d saved carts.', 'woocommerce-rest-api' ), absint( $result ) );
	}

	/**
	 * Tool: install_pages.
	 *
	 * @return string Success message.
	 */
	protected function install_pages() {
		\WC_Install::create_pages();
		return __( 'All missing WooCommerce pages successfully installed', 'woocommerce-rest-api' );
	}

	/**
	 * Tool: delete_taxes.
	 *
	 * @return string Success message.
	 */
	protected function delete_taxes() {
		global $wpdb;
		$wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}woocommerce_tax_rates;" );
		$wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}woocommerce_tax_rate_locations;" );
		\WC_Cache_Helper::incr_cache_prefix( 'taxes' );
		return __( 'Tax rates successfully deleted', 'woocommerce-rest-api' );
	}

	/**
	 * Tool: regenerate_thumbnails.
	 *
	 * @return string Success message.
	 */
	protected function regenerate_thumbnails() {
		\WC_Regenerate_Images::queue_image_regeneration();
		return __( 'Thumbnail regeneration has been scheduled to run in the background.', 'woocommerce-rest-api' );
	}

	/**
	 * Tool: db_update_routine.
	 *
	 * @return string Success message.
	 */
	protected function db_update_routine() {
		$blog_id = get_current_blog_id();
		// Used to fire an action added in WP_Background_Process::_construct() that calls WP_Background_Process::handle_cron_healthcheck().
		// This method will make sure the database updates are executed even if cron is disabled. Nothing will happen if the updates are already running.
		do_action( 'wp_' . $blog_id . '_wc_updater_cron' );
		return __( 'Database upgrade routine has been scheduled to run in the background.', 'woocommerce-rest-api' );
	}
}