OwlCyberSecurity - MANAGER

Edit File: RestAudioPresetsController.php

<?php
/**
 * REST API Controller for Audio Presets.
 *
 * Handles requests to the audio presets endpoints.
 *
 * @package PrestoPlayer
 * @subpackage Services\API
 */

namespace PrestoPlayer\Services\API;

use PrestoPlayer\Models\AudioPreset;

/**
 * REST API Controller for managing Audio Presets.
 */
class RestAudioPresetsController extends \WP_REST_Controller {

/**
	 * The namespace for the REST API.
	 *
	 * @var string
	 */
	protected $namespace = 'presto-player';

/**
	 * The version of the REST API.
	 *
	 * @var string
	 */
	protected $version = 'v1';

/**
	 * The base for the REST API endpoints.
	 *
	 * @var string
	 */
	protected $base = 'audio-preset';

/**
	 * Register controller
	 *
	 * @return void
	 */
	public function register() {
		add_action( 'rest_api_init', array( $this, 'register_routes' ) );
	}

/**
	 * Register presets routes
	 *
	 * @return void
	 */
	public function register_routes() {
		register_rest_route(
			"{$this->namespace}/{$this->version}",
			'/' . $this->base,
			array(
				array(
					'methods'             => \WP_REST_Server::READABLE,
					'callback'            => array( $this, 'get_items' ),
					'permission_callback' => array( $this, 'get_items_permissions_check' ),
					'args'                => array(),
				),
				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( true ),
				),
				'schema' => array( $this, 'get_preset_schema' ),
			)
		);

register_rest_route(
			"{$this->namespace}/{$this->version}",
			'/' . $this->base . '/(?P<id>\d+)',
			array(
				array(
					'methods'             => \WP_REST_Server::READABLE,
					'callback'            => array( $this, 'get_item' ),
					'permission_callback' => array( $this, 'get_item_permissions_check' ),
					'args'                => array(
						'id'      => array(
							'validate_callback' => function ( $param ) {
								return is_numeric( $param );
							},
						),
						'context' => 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( false ),
				),
				array(
					'methods'             => \WP_REST_Server::DELETABLE,
					'callback'            => array( $this, 'delete_item' ),
					'permission_callback' => array( $this, 'delete_item_permissions_check' ),
					'args'                => array(
						'force' => array(
							'default' => false,
						),
					),
				),
				'schema' => array( $this, 'get_preset_schema' ),
			)
		);
	}

/**
	 * Get the schema for audio presets.
	 *
	 * @return array The audio preset schema.
	 */
	public function get_preset_schema() {
		return array(
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => 'preset',
			'type'       => 'object',
			'properties' => array(
				'id'                     => array(
					'description' => esc_html__( 'Unique identifier for the object.', 'presto-player' ),
					'type'        => 'integer',
					'context'     => array( 'view', 'edit', 'embed' ),
					'readonly'    => true,
				),
				'name'                   => array(
					'description'       => esc_html__( 'Name for the preset.', 'presto-player' ),
					'type'              => 'string',
					'required'          => true,
					'validate_callback' => 'is_string',
					'sanitize_callback' => 'sanitize_text_field',
				),
				'slug'                   => array(
					'description' => esc_html__( 'Preset url slug', 'presto-player' ),
					'type'        => 'string',
					'readonly'    => true,
				),
				'icon'                   => array(
					'description'       => esc_html__( 'Icon for the preset.', 'presto-player' ),
					'type'              => 'string',
					'required'          => true,
					'validate_callback' => 'is_string',
					'sanitize_callback' => 'sanitize_text_field',
				),
				'skin'                   => array(
					'description'       => esc_html__( 'Skin for the preset.', 'presto-player' ),
					'type'              => 'string',
					'validate_callback' => 'is_string',
					'sanitize_callback' => 'sanitize_text_field',
				),
				'background_color'       => array(
					'description'       => esc_html__( 'Caption backgrounds.', 'presto-player' ),
					'type'              => 'string',
					'validate_callback' => 'is_string',
					'sanitize_callback' => 'sanitize_hex_color',
				),
				'control_color'          => array(
					'description'       => esc_html__( 'Caption backgrounds.', 'presto-player' ),
					'type'              => 'string',
					'validate_callback' => 'is_string',
					'sanitize_callback' => 'sanitize_hex_color',
				),
				'created_by'             => array(
					'description' => esc_html__( 'The id of the user object, if author was a user.', 'presto-player' ),
					'type'        => 'integer',
					'readonly'    => true,
				),
				'play'                   => array(
					'type' => 'boolean',
				),
				'play-large'             => array(
					'type' => 'boolean',
				),
				'rewind'                 => array(
					'type' => 'boolean',
				),
				'fast-forward'           => array(
					'type' => 'boolean',
				),
				'current-time'           => array(
					'type' => 'boolean',
				),
				'progress'               => array(
					'type' => 'boolean',
				),
				'mute'                   => array(
					'type' => 'boolean',
				),
				'volume'                 => array(
					'type' => 'boolean',
				),
				'speed'                  => array(
					'type' => 'boolean',
				),
				'pip'                    => array(
					'type' => 'boolean',
				),
				'reset_on_end'           => array(
					'type' => 'boolean',
				),
				'sticky_scroll'          => array(
					'type' => 'boolean',
				),
				'sticky_scroll_position' => array(
					'type' => 'string',
				),
				'on_video_end'           => array(
					'type' => 'string',
				),
				'play_video_viewport'    => array(
					'type' => 'boolean',
				),
				'show_time_elapsed'      => array(
					'type' => 'boolean',
				),
				'save_player_position'   => array(
					'type' => 'boolean',
				),
				'border_radius'          => array(
					'type' => 'integer',
				),
				'cta'                    => array(
					'type'       => 'object',
					'properties' => array(
						'enabled'            => array(
							'type' => 'boolean',
						),
						'percentage'         => array(
							'type' => 'integer',
						),
						'show_rewatch'       => array(
							'type' => 'boolean',
						),
						'show_skip'          => array(
							'type' => 'boolean',
						),
						'headline'           => array(
							'type' => 'string',
						),
						'show_button'        => array(
							'type' => 'boolean',
						),
						'bottom_text'        => array(
							'type' => 'string',
						),
						'button_color'       => array(
							'type' => 'string',
						),
						'button_text_color'  => array(
							'type' => 'string',
						),
						'background_opacity' => array(
							'type' => 'integer',
						),
						'button_text'        => array(
							'type' => 'string',
						),
						'button_link'        => array(
							'type'     => 'object',
							'required' => true,
						),
						'border_radius'      => array(
							'type' => 'integer',
						),
					),
				),
				'email_collection'       => array(
					'type'       => 'object',
					'properties' => array(
						'id'                => array(
							'type' => 'integer',
						),
						'enabled'           => array(
							'type' => 'boolean',
						),
						'behavior'          => array(
							'type' => 'string',
						),
						'percentage'        => array(
							'type' => 'integer',
						),
						'allow_skip'        => array(
							'type' => 'boolean',
						),
						'provider'          => array(
							'type' => 'string',
						),
						'provider_list'     => array(
							'type' => 'string',
						),
						'provider_tag'      => array(
							'type' => 'string',
						),
						'button_radius'     => array(
							'type' => 'integer',
						),
						'headline'          => array(
							'type' => 'string',
						),
						'bottom_text'       => array(
							'type' => 'string',
						),
						'button_text'       => array(
							'type' => 'string',
						),
						'button_color'      => array(
							'type' => 'string',
						),
						'button_text_color' => array(
							'type' => 'string',
						),
					),
				),
				'action_bar'             => array(
					'type'       => 'object',
					'properties' => array(
						'enabled'           => array(
							'type' => 'boolean',
						),
						'percentage_start'  => array(
							'type' => 'integer',
						),
						'text'              => array(
							'type' => 'string',
						),
						'background_color'  => array(
							'type' => 'string',
						),
						'button_type'       => array(
							'type' => 'string',
						),
						'button_count'      => array(
							'type' => 'boolean',
						),
						'button_text'       => array(
							'type' => 'string',
						),
						'button_radius'     => array(
							'type' => 'integer',
						),
						'button_color'      => array(
							'type' => 'string',
						),
						'button_text_color' => array(
							'type' => 'string',
						),
						'button_link'       => array(
							'type' => 'object',
						),
					),
				),
				'is_locked'              => array(
					'type'     => 'boolean',
					'readonly' => true,
				),
				'created_at'             => array(
					'type'     => 'string',
					'readonly' => true,
				),
			),
		);
	}

/**
	 * Get a collection of items
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|WP_REST_Response
	 */
	public function get_items( $request ) {
		$preset = new AudioPreset();
		$items  = $preset->fetch(
			array(
				'per_page' => 10000,
				'order_by' => array(
					'is_locked'  => 'DESC',
					'created_at' => 'ASC',
				),
			)
		);

if ( is_wp_error( $items ) ) {
			return $items;
		}

if ( ! isset( $items->data ) ) {
			return new \WP_Error( 'error', 'Something went wrong' );
		}

foreach ( $items->data as $item ) {
			$itemdata = $this->prepare_item_for_response( $item, $request );
			$data[]   = $this->prepare_response_for_collection( $itemdata );
		}

return new \WP_REST_Response( $data, 200 );
	}

/**
	 * Get one item from the collection
	 *
	 * @param  \WP_REST_Request $request Full data about the request.
	 * @return \WP_Error|\WP_REST_Response
	 */
	public function get_item( $request ) {
		$item = new AudioPreset( $request['id'] );
		$data = $this->prepare_item_for_response( $item, $request );
		return new \WP_REST_Response( $data, 200 );
	}

/**
	 * Create one item from the collection
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|WP_REST_Response
	 */
	public function create_item( $request ) {
		$item = $this->prepare_item_for_database( $request );

$preset = new AudioPreset();
		$preset->create( $item );
		$preset->fresh();

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

if ( is_wp_error( $data ) ) {
			return $data;
		}

if ( ! empty( $data ) ) {
			return new \WP_REST_Response( $data, 200 );
		}

return new \WP_Error( 'cant-create', __( 'Cannot create preset.', 'presto-player' ), array( 'status' => 500 ) );
	}

/**
	 * Update one item from the collection
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|WP_REST_Response
	 */
	public function update_item( $request ) {
		$item = $this->prepare_item_for_database( $request );

$preset = new AudioPreset( $request['id'] );
		$preset->update( $item );

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

if ( is_wp_error( $data ) ) {
			return $data;
		}

if ( ! empty( $data ) ) {
			return new \WP_REST_Response( $data, 200 );
		}

return new \WP_Error( 'cant-update', __( 'Cannot update preset.', 'presto-player' ), array( 'status' => 500 ) );
	}

/**
	 * Delete one item from the collection
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|WP_REST_Response
	 */
	public function delete_item( $request ) {
		$preset  = new AudioPreset( $request['id'] );
		$trashed = $preset->trash();

if ( $trashed ) {
			return new \WP_REST_Response( true, 200 );
		}

if ( is_wp_error( $trashed ) ) {
			return $trashed;
		}

return new \WP_Error( 'cant-trash', __( 'This preset could not be trashed.', 'presto-player' ), array( 'status' => 500 ) );
	}

/**
	 * Check if a given request has access to get items
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|bool
	 */
	public function get_items_permissions_check( $request ) {
		return $this->get_item_permissions_check( $request );
	}

/**
	 * Check if a given request has access to get items
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|bool
	 */
	public function get_item_permissions_check( $request ) {
		return current_user_can( 'edit_posts' );
	}

/**
	 * Check if a given request has access to create items
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|bool
	 */
	public function create_item_permissions_check( $request ) {
		return current_user_can( 'publish_posts' );
	}

/**
	 * Check if a given request has access to update a specific item
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|bool
	 */
	public function update_item_permissions_check( $request ) {
		return current_user_can( 'edit_others_posts' );
	}

/**
	 * Check if a given request has access to delete a specific item
	 *
	 * @param  WP_REST_Request $request Full data about the request.
	 * @return WP_Error|bool
	 */
	public function delete_item_permissions_check( $request ) {
		return current_user_can( 'delete_others_posts' );
	}

/**
	 * Prepare the item for create or update operation
	 *
	 * @param  WP_REST_Request $request Request object.
	 * @return WP_Error|object $prepared_item.
	 */
	protected function prepare_item_for_database( $request ) {
		$email = wp_parse_args(
			$request['email_collection'],
			array(
				'enabled'           => false,
				'behavior'          => 'pause',
				'percentage'        => 0,
				'allow_skip'        => false,
				'provider'          => '',
				'provider_tag'      => '',
				'provider_list'     => '',
				'border-radius'     => 0,
				'headline'          => '',
				'bottom_text'       => '',
				'button_text'       => '',
				'button_color'      => '',
				'button_text_color' => '',
			)
		);

$watermark = wp_parse_args(
			$request['watermark'],
			array(
				'enabled'         => false,
				'text'            => '',
				'backgroundColor' => '',
				'color'           => '',
				'opacity'         => 0,
				'position'        => '',
			)
		);

$cta = wp_parse_args(
			$request['cta'],
			array(
				'enabled'            => false,
				'percentage'         => 100,
				'show_rewatch'       => true,
				'show_skip'          => true,
				'headline'           => '',
				'bottom_text'        => '',
				'show_button'        => true,
				'button_text'        => '',
				'button_color'       => '',
				'button_text_color'  => '',
				'background_opacity' => 0,
				'button_radius'      => 0,
				'button_link'        => array(
					'id'            => '',
					'url'           => '',
					'type'          => '',
					'opensInNewTab' => false,
				),
			)
		);

$action_bar = wp_parse_args(
			$request['action_bar'],
			array(
				'enabled'           => false,
				'percentage_start'  => 0,
				'text'              => '',
				'background_color'  => '',
				'button_type'       => 'none',
				'button_count'      => false,
				'button_text'       => '',
				'button_radius'     => 0,
				'button_color'      => '',
				'button_text_color' => '',
				'button_link'       => array(
					'id'            => '',
					'url'           => '',
					'type'          => '',
					'opensInNewTab' => false,
				),
			)
		);

$prepared = array(
			'name'                   => sanitize_text_field( $request['name'] ),
			'skin'                   => sanitize_text_field( $request['skin'] ),
			'play-large'             => (bool) $request['play-large'],
			'rewind'                 => (bool) $request['rewind'],
			'play'                   => (bool) $request['play'],
			'fast-forward'           => (bool) $request['fast-forward'],
			'progress'               => (bool) $request['progress'],
			'current-time'           => (bool) $request['current-time'],
			'mute'                   => (bool) $request['mute'],
			'volume'                 => (bool) $request['volume'],
			'speed'                  => (bool) $request['speed'],
			'pip'                    => (bool) $request['pip'],
			// behavior.
			'save_player_position'   => (bool) $request['save_player_position'],
			'reset_on_end'           => (bool) $request['reset_on_end'],
			'sticky_scroll'          => (bool) $request['sticky_scroll'],
			'sticky_scroll_position' => sanitize_text_field( $request['sticky_scroll_position'] ),
			'on_video_end'           => sanitize_text_field( $request['on_video_end'] ),
			'play_video_viewport'    => (bool) $request['play_video_viewport'],
			'show_time_elapsed'      => (bool) $request['show_time_elapsed'],
			// style.
			'background_color'       => sanitize_hex_color( $request['background_color'] ),
			'control_color'          => sanitize_hex_color( $request['control_color'] ),
			'border_radius'          => (int) $request['border_radius'],
			'cta'                    => array(
				'enabled'            => (bool) $cta['enabled'],
				'percentage'         => (int) $cta['percentage'],
				'show_rewatch'       => (bool) $cta['show_rewatch'],
				'show_skip'          => (bool) $cta['show_skip'],
				'headline'           => sanitize_text_field( $cta['headline'] ),
				'bottom_text'        => wp_kses_post( $cta['bottom_text'] ),
				'show_button'        => (bool) $cta['show_button'],
				'button_text'        => sanitize_text_field( $cta['button_text'] ),
				'button_color'       => sanitize_hex_color( $cta['button_color'] ),
				'button_text_color'  => sanitize_hex_color( $cta['button_text_color'] ),
				'background_opacity' => (int) $cta['background_opacity'],
				'button_link'        => array(
					'id'            => sanitize_text_field( wp_kses_post( $cta['button_link']['id'] ) ),
					'url'           => esc_url_raw( $cta['button_link']['url'] ),
					'type'          => sanitize_text_field( wp_kses_post( $cta['button_link']['type'] ) ),
					'opensInNewTab' => (bool) $cta['button_link']['opensInNewTab'],
				),
				'button_radius'      => (int) $cta['button_radius'],
			),
			'email_collection'       => array(
				'enabled'           => (bool) $email['enabled'],
				'behavior'          => sanitize_text_field( $email['behavior'] ),
				'percentage'        => (int) $email['percentage'],
				'allow_skip'        => (bool) $email['allow_skip'],
				'provider'          => sanitize_text_field( $email['provider'] ),
				'provider_list'     => sanitize_text_field( $email['provider_list'] ),
				'provider_tag'      => sanitize_text_field( $email['provider_tag'] ),
				'border_radius'     => (int) $email['border_radius'],
				'headline'          => sanitize_text_field( $email['headline'] ),
				'bottom_text'       => wp_kses_post( $email['bottom_text'] ),
				'button_text'       => sanitize_text_field( $email['button_text'] ),
				'button_color'      => sanitize_hex_color( $email['button_color'] ),
				'button_text_color' => sanitize_hex_color( $email['button_text_color'] ),
			),
			'action_bar'             => array(
				'enabled'           => (bool) $action_bar['enabled'],
				'percentage_start'  => (int) $action_bar['percentage_start'],
				'text'              => wp_kses_post( $action_bar['text'] ),
				'background_color'  => sanitize_hex_color( $action_bar['background_color'] ),
				'button_type'       => sanitize_text_field( wp_kses_post( $action_bar['button_type'] ) ),
				'button_count'      => (bool) $action_bar['button_count'],
				'button_text'       => sanitize_text_field( wp_kses_post( $action_bar['button_text'] ) ),
				'button_radius'     => (int) $action_bar['button_radius'],
				'button_color'      => sanitize_hex_color( $action_bar['button_color'] ),
				'button_text_color' => sanitize_hex_color( $action_bar['button_text_color'] ),
				'button_link'       => array(
					'id'            => sanitize_text_field( wp_kses_post( $action_bar['button_link']['id'] ) ),
					'url'           => esc_url_raw( $action_bar['button_link']['url'] ),
					'type'          => sanitize_text_field( wp_kses_post( $action_bar['button_link']['type'] ) ),
					'opensInNewTab' => (bool) $action_bar['button_link']['opensInNewTab'],
				),
			),
		);

return $prepared;
	}

/**
	 * Prepare the item for the REST response.
	 *
	 * @param  mixed           $item    WordPress representation of the item.
	 * @param  WP_REST_Request $request Request object.
	 * @return mixed The prepared item.
	 */
	public function prepare_item_for_response( $item, $request ) {
		$item     = $item->toArray();
		$schema   = $this->get_preset_schema();
		$prepared = array();
		foreach ( $item as $name => $value ) {
			if ( ! empty( $schema['properties'][ $name ] ) ) {
				$prepared[ $name ] = rest_sanitize_value_from_schema( $value, $schema['properties'][ $name ], $name );
			}
		}

return $prepared;
	}

/**
	 * Get the query params for collections.
	 *
	 * @return array The collection parameters.
	 */
	public function get_collection_params() {
		return array(
			'page'     => array(
				'description'       => 'Current page of the collection.',
				'type'              => 'integer',
				'default'           => 1,
				'sanitize_callback' => 'absint',
			),
			'per_page' => array(
				'description'       => 'Maximum number of items to be returned in result set.',
				'type'              => 'integer',
				'default'           => 10,
				'sanitize_callback' => 'absint',
			),
			'search'   => array(
				'description'       => 'Limit results to those matching a string.',
				'type'              => 'string',
				'sanitize_callback' => 'sanitize_text_field',
			),
		);
	}
}