Ticket/aotech 6694 data validation

composer.json

@@ -11,6 +11,9 @@
     ],
     "minimum-stability": "stable",
     "autoload": {
+        "psr-4": {
+            "Press_Sync\\api\\": "includes/api"
+        },
         "classmap": [
             "includes/"
         ]

includes/api/route/AbstractRoute.php

@@ -0,0 +1,129 @@
+<?php
+namespace Press_Sync\api\route;
+
+/**
+ * Class AbstractRoute
+ *
+ * @package Press_Sync\api\route
+ * @since   NEXT
+ */
+abstract class AbstractRoute extends \WP_REST_Controller {
+	/**
+	 * Namespace for this route.
+	 *
+	 * @var string
+	 * @since NEXT
+	 */
+	protected $namespace = 'press-sync/v1';
+
+	/**
+	 * Routes to register with the WP API.
+	 *
+	 * This should be an array where the keys are endpoints to be registered
+	 * under {$this->namspace}/{$this->rest_base}/{$endpoint}. If you don't
+	 * specify an endpoint, the route will point to the REST base.
+	 *
+	 * Example:
+	 * ```
+	 * $this->namespace      = 'filemanager/v1';
+	 * $this->rest_base      = 'files';
+	 * $this->routes[]       = [ 'callback'=> [ $this, 'get_info' ] ];
+	 * $this->routes['list'] = [ 'callback' => [ $this, 'list_items'] ];
+	 * ```
+	 * This registers two endpoints:
+	 * - /filemanager/v1/files/ - This uses the get_info callback.
+	 * - /filemanager/v1/files/list - This uses the list_items callback.
+	 *
+	 * Any configuration items that can be passed to the third parameter of `register_rest_route`
+	 * may be used in the configuration array for each endpoint.
+	 *
+	 * @since NEXT
+	 * @var array
+	 */
+	protected $routes = array();
+
+	/**
+	 * Concrete classes should implement methods that hook into WordPress's rest_api_init event, at minimum.
+	 *
+	 * @since NEXT
+	 * @return void
+	 */
+	abstract public function register_hooks();
+
+	/**
+	 * Validate the supplied press_sync_key by the sending site.
+	 * Target site can't receive data without a valid press_sync_key.
+	 *
+	 * @since 0.1.0
+	 * @return bool
+	 */
+	public function validate_sync_key() {
+		// @TODO Check for valid nonce.
+		$press_sync_key_from_remote = '';
+
+		if ( isset( $_REQUEST['press_sync_key'] ) ) {
+			$press_sync_key_from_remote = filter_var( $_REQUEST['press_sync_key'], FILTER_SANITIZE_STRING );
+		}
+
+		$press_sync_key = get_option( 'ps_key' );
+
+		return $press_sync_key && ( $press_sync_key === $press_sync_key_from_remote );
+	}
+
+	/**
+	 * Registers routes to the WP API.
+	 *
+	 * @since NEXT
+	 */
+	public function register_routes() {
+		$defaults = array(
+			'methods'             => array( 'GET' ),
+			'callback'            => '__return_false',
+			'permission_callback' => array( $this, 'validate_sync_key' ),
+			'args'                => array(
+				'press_sync_key' => array(
+					'required' => true,
+				),
+			),
+		);
+
+
+		foreach ( $this->routes as $endpoint => $route_config ) {
+			$config = wp_parse_args( $route_config, $defaults );
+
+			if ( is_numeric( $endpoint ) ) {
+				$endpoint = '';
+			}
+
+			register_rest_route(
+				$this->namespace,
+				"{$this->rest_base}/{$endpoint}",
+				$config
+			);
+		}
+	}
+
+	/**
+	 * Get remote data from an API request.
+	 *
+	 * @since NEXT
+	 *
+	 * @param  string $request The requested datapoint.
+	 *
+	 * @return array
+	 */
+	public function get_data( $request ) {
+		$request = ltrim( $request, '/' );
+		$url     = \Press_Sync\API::get_remote_url( '', "{$this->rest_base}/{$request}", [
+			'request' => $request,
+		] );
+
+		$response = \Press_Sync\API::get_remote_response( $url );
+
+		if ( empty( $response['body']['success'] ) ) {
+			return [];
+		}
+
+		return $response['body']['data'];
+	}
+}

includes/api/route/Status.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Press_Sync\api\route;
+
+
+class Status
+{
+
+}

includes/api/route/Sync.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Press_Sync\api\route;
+
+
+class Sync
+{
+
+}

includes/api/route/Validation.php

@@ -0,0 +1,57 @@
+<?php
+namespace Press_Sync\api\route;
+
+use Press_Sync\api\route\validation\Post;
+use Press_Sync\api\route\validation\User;
+use Press_Sync\api\route\validation\Taxonomy;
+
+/**
+ * Class Validation
+ *
+ * @package Press_Sync\api\route
+ */
+class Validation extends \WP_REST_Controller {
+	/**
+	 * The endpoint for the validator.
+	 *
+	 * This should be set in your extending class and will make the API
+	 * request route something like /press-sync/v1/{$route}/{$endpoint}.
+	 *
+	 * @since NEXT
+	 * @var string
+	 */
+	protected static $endpoint;
+
+	/**
+	 * @var
+	 */
+	protected $routes = array(
+		User::class,
+		Taxonomy::class,
+		Post::class,
+	);
+
+	/**
+	 * Validation constructor.
+	 */
+	public function __construct() {
+		$this->rest_base = 'validation';
+	}
+
+	/**
+	 * Registers API endpoints for the extending class.
+	 *
+	 * This registers an API endpoint at /namespace/route/endpoint/ based on the extending
+	 * class's properties. The class should implement a static public method called
+	 * get_api_response that can parse the request parameters and return the desired data.
+	 *
+	 * @since NEXT
+	 */
+	public function register_routes() {
+		foreach ( $this->routes as $route ) {
+			/* @var AbstractRoute $class */
+			$class = new $route();
+			$class->register_hooks();
+		}
+	}
+}

includes/api/route/validation/Post.php

@@ -0,0 +1,79 @@
+<?php
+namespace Press_Sync\api\route\validation;
+
+use Press_Sync\api\route\AbstractRoute;
+
+/**
+ * Class Post
+ *
+ * @package Press_Sync\api\route\validation
+ * @since NEXT
+ */
+class Post extends AbstractRoute {
+	/**
+	 * @var \Press_Sync\validation\Post
+	 *
+	 * @since NEXT
+	 */
+	protected $data_source;
+
+	/**
+	 * Post constructor.
+	 *
+	 * @since NEXT
+	 */
+	public function __construct() {
+		$this->rest_base   = 'validation/post';
+		$this->data_source = new \Press_Sync\validation\Post();
+		$this->routes      = array(
+			'count'  => array(
+				'callback' => array( $this->data_source, 'get_count' ),
+			),
+			'sample' => array(
+				'callback' => array( $this, 'get_sample' ),
+				'args'     => array(
+					'type'           => array( 'required' => true ),
+					'count'          => array( 'required' => false ),
+					'ids'            => array( 'required' => false ),
+					'press_sync_key' => array( 'required' => true ),
+				),
+			),
+		);
+	}
+
+	/**
+	 * Register hooks for Post validation.
+	 *
+	 * @since NEXT
+	 */
+	public function register_hooks() {
+		add_action( 'rest_api_init', array( $this, 'register_routes' ) );
+	}
+
+	/**
+	 * Get a sample of post data.
+	 *
+	 * @param \WP_REST_Request $request
+	 *
+	 * @return array
+	 */
+	public function get_sample( \WP_REST_Request $request ) {
+		$params = array(
+			'count' => $request->get_param( 'count' ),
+			'ids'   => $request->get_param( 'ids' ),
+			'type'  => $request->get_param( 'type' ),
+		);
+
+		if ( $params['count'] ) {
+			$callback = "get_sample_{$params['type']}_data";
+			return $this->data_source->{$callback}( $params['count'] );
+		}
+
+		if ( $params['ids'] ) {
+			$callback = "get_comparison_{$params['type']}";
+			return $this->data_source->{$callback}( $params['ids'] );
+		}
+
+		return [];
+	}
+}

includes/api/route/validation/Taxonomy.php

@@ -0,0 +1,70 @@
+<?php
+namespace Press_Sync\api\route\validation;
+
+use Press_Sync\api\route\AbstractRoute;
+
+/**
+ * Class Taxonomy
+ *
+ * @package Press_Sync\api\route\validation
+ * @since NEXT
+ */
+class Taxonomy extends AbstractRoute {
+	/**
+	 * Data source for the API.
+	 *
+	 * @var \Press_Sync\validation\Taxonomy
+	 * @since NEXT
+	 */
+	protected $data_source;
+
+	/**
+	 * Taxonomy validation constructor.
+	 *
+	 * @since NEXT
+	 */
+	public function __construct() {
+		$this->rest_base   = 'validation/taxonomy';
+		$this->data_source = new \Press_Sync\validation\Taxonomy();
+		$this->routes      = array(
+			'count'  => array(
+				'callback' => array( $this->data_source, 'get_count' ),
+			),
+			'post_terms' => array(
+				'callback' => array( $this->data_source, 'get_post_count_by_taxonomy_term' ),
+			),
+			'sample' => array(
+				'callback' => array( $this, 'get_sample' ),
+				'args'     => array(
+					'type'  => array( 'required' => true ),
+				),
+			),
+		);
+	}
+
+	/**
+	 * Register hooks for Taxonomy validation.
+	 *
+	 * @since NEXT
+	 */
+	public function register_hooks() {
+		add_action( 'rest_api_init', array( $this, 'register_routes' ) );
+	}
+
+	/**
+	 * Get sample taxonomy data.
+	 *
+	 * @param \WP_REST_Request $request The API request.
+	 *
+	 * @return array|\WP_Error
+	 */
+	public function get_sample( \WP_REST_Request $request ) {
+		$type = filter_var( $request->get_param( 'type' ), FILTER_SANITIZE_STRING );
+
+		if ( 'meta' === $type ) {
+			return $this->data_source->get_sample_meta();
+		}
+
+		return new \WP_Error( 'taxonomy_type_not_found', 'Invalid type parameter.', array( 'status' => 404 ) );
+	}
+}