ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / fengshp / www / wp-content / plugins / google-site-kit / includes / Core / User_Surveys

<?php
/**
 * Class Google\Site_Kit\Core\User_Surveys\REST_User_Surveys_Controller
 *
 * @package   Google\Site_Kit\Core\User_Surveys
 * @copyright 2021 Google LLC
 * @license   https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
 * @link      https://sitekit.withgoogle.com
 */

namespace Google\Site_Kit\Core\User_Surveys;

use Google\Site_Kit\Core\Authentication\Authentication;
use Google\Site_Kit\Core\REST_API\REST_Route;
use Google\Site_Kit\Core\REST_API\REST_Routes;
use WP_Error;
use WP_REST_Request;
use WP_REST_Response;
use WP_REST_Server;

/**
 * Class for handling user survey rest routes.
 *
 * @since 1.35.0
 * @access private
 * @ignore
 */
class REST_User_Surveys_Controller {

/**
	 * Authentication instance.
	 *
	 * @since 1.35.0
	 * @var Authentication
	 */
	protected $authentication;

/**
	 * Survey_Timeouts instance.
	 *
	 * @since 1.73.0
	 * @var Survey_Timeouts
	 */
	protected $timeouts;

/**
	 * Survey_Queue instance.
	 *
	 * @since 1.98.0
	 * @var Survey_Queue
	 */
	protected $queue;

/**
	 * Constructor.
	 *
	 * @since 1.35.0
	 *
	 * @param Authentication  $authentication Authentication instance.
	 * @param Survey_Timeouts $timeouts       User timeouts setting.
	 * @param Survey_Queue    $queue          Surveys queue.
	 */
	public function __construct( Authentication $authentication, Survey_Timeouts $timeouts, Survey_Queue $queue ) {
		$this->authentication = $authentication;
		$this->timeouts       = $timeouts;
		$this->queue          = $queue;
	}

/**
	 * Registers functionality through WordPress hooks.
	 *
	 * @since 1.35.0
	 */
	public function register() {
		add_filter(
			'googlesitekit_rest_routes',
			function ( $routes ) {
				return array_merge( $routes, $this->get_rest_routes() );
			}
		);

add_filter(
			'googlesitekit_apifetch_preload_paths',
			function ( $paths ) {
				return array_merge(
					$paths,
					array(
						'/' . REST_Routes::REST_ROOT . '/core/user/data/survey-timeouts',
					)
				);
			}
		);
	}

/**
	 * Gets REST route instances.
	 *
	 * @since 1.35.0
	 *
	 * @return REST_Route[] List of REST_Route objects.
	 */
	protected function get_rest_routes() {
		$can_authenticate = function () {
			return $this->authentication->is_authenticated()
				&& $this->authentication->credentials()->using_proxy();
		};

return array(
			'survey-trigger'  => new REST_Route(
				'core/user/data/survey-trigger',
				array(
					'methods'             => WP_REST_Server::CREATABLE,
					'callback'            => function ( WP_REST_Request $request ) {
						$proxy        = $this->authentication->get_google_proxy();
						$creds        = $this->authentication->credentials();
						$access_token = (string) $this->authentication->get_oauth_client()->get_access_token();
						$data         = $request->get_param( 'data' );

$response = $proxy->send_survey_trigger( $creds, $access_token, $data['triggerID'] );

if ( ! is_wp_error( $response ) && ! empty( $response['survey_id'] ) ) {
							$this->queue->enqueue( $response );
						}

if ( ! is_wp_error( $response ) && ! empty( $data['ttl'] ) ) {
							$ttl = intval( $data['ttl'] );

if ( $ttl > 0 ) {
								$this->timeouts->add( $data['triggerID'], $ttl );
							}
						}

return new WP_REST_Response( array( 'success' => true ) );
					},
					'permission_callback' => $can_authenticate,
					'args'                => array(
						'data' => array(
							'type'       => 'object',
							'required'   => true,
							'properties' => array(
								'triggerID' => array(
									'type'     => 'string',
									'required' => true,
								),
								'ttl'       => array(
									'type'    => 'integer',
									'minimum' => 0,
								),
							),
						),
					),
				)
			),
			'survey-event'    => new REST_Route(
				'core/user/data/survey-event',
				array(
					'methods'             => WP_REST_Server::CREATABLE,
					'callback'            => function ( WP_REST_Request $request ) {
						$proxy        = $this->authentication->get_google_proxy();
						$creds        = $this->authentication->credentials();
						$access_token = (string) $this->authentication->get_oauth_client()->get_access_token();

$data = $request->get_param( 'data' );
						if ( isset( $data['event']['survey_shown'] ) ) {
							$this->timeouts->set_global_timeout();
						}

$response = $proxy->send_survey_event( $creds, $access_token, $data['session'], $data['event'] );
						if ( ! is_wp_error( $response ) ) {
							$is_survey_closed    = isset( $data['event']['survey_closed'] );
							$is_completion_shown = isset( $data['event']['completion_shown'] );
							if ( $is_completion_shown || $is_survey_closed ) {
								$survey = $this->queue->find_by_session( $data['session'] );
								if ( ! empty( $survey ) ) {
									$this->queue->dequeue( $survey['survey_id'] );
								}
							}
						}

return new WP_REST_Response( $response );
					},
					'permission_callback' => $can_authenticate,
					'args'                => array(
						'data' => array(
							'type'       => 'object',
							'required'   => true,
							'properties' => array(
								'session' => array(
									'type'       => 'object',
									'required'   => true,
									'properties' => array(
										'session_id'    => array(
											'type'     => 'string',
											'required' => true,
										),
										'session_token' => array(
											'type'     => 'string',
											'required' => true,
										),
									),
								),
								'event'   => array(
									'type'       => 'object',
									'required'   => true,
									'properties' => array(
										'survey_shown'     => array(
											'type' => 'object',
										),
										'survey_closed'    => array(
											'type' => 'object',
										),
										'question_answered' => array(
											'type' => 'object',
										),
										'completion_shown' => array(
											'type' => 'object',
										),
										'follow_up_link_clicked' => array(
											'type' => 'object',
										),
									),
								),
							),
						),
					),
				)
			),
			'survey-timeouts' => new REST_Route(
				'core/user/data/survey-timeouts',
				array(
					'methods'             => WP_REST_Server::READABLE,
					'permission_callback' => $can_authenticate,
					'callback'            => function () {
						return new WP_REST_Response( $this->timeouts->get_survey_timeouts() );
					},
				)
			),
			'survey'          => new REST_Route(
				'core/user/data/survey',
				array(
					'methods'             => WP_REST_Server::READABLE,
					'permission_callback' => $can_authenticate,
					'callback'            => function () {
						return new WP_REST_Response(
							array(
								'survey' => $this->queue->front(),
							)
						);
					},
				)
			),
		);
	}
}

[+] ..
[-] User_Surveys.php [edit]
[-] REST_User_Surveys_Controller.php [edit]
[-] Survey_Queue.php [edit]
[-] Survey_Timeouts.php [edit]