*/ private $capability_source; /** * @param callable():array|null $capability_source Testable local API observer. */ public function __construct( FindingFactory $findings, ?callable $capability_source = null ) { $this->findings = $findings; $this->capability_source = $capability_source ?? array( $this, 'wordpress_capabilities' ); } public function id(): string { return 'environment.loopback_rest'; } /** * @return array */ public function execute( string $timestamp ): array { try { $capabilities = call_user_func( $this->capability_source ); } catch ( Throwable $exception ) { return $this->error_finding( $timestamp ); } if ( ! is_array( $capabilities ) ) { return $this->error_finding( $timestamp ); } $observations = array(); $failures = 0; foreach ( self::BOOLEAN_CAPABILITIES as $capability ) { if ( ! isset( $capabilities[ $capability ] ) || ! is_bool( $capabilities[ $capability ] ) ) { continue; } $observations[] = array( 'capability' => $capability, 'available' => $capabilities[ $capability ], ); if ( ! $capabilities[ $capability ] ) { ++$failures; } } $basic_auth_warning = false; if ( isset( $capabilities['basic_auth_state'] ) && is_string( $capabilities['basic_auth_state'] ) && in_array( $capabilities['basic_auth_state'], array( 'not_detected', 'protected' ), true ) ) { $basic_auth_warning = 'protected' === $capabilities['basic_auth_state']; $observations[] = array( 'capability' => 'basic_auth_visibility', 'state' => $capabilities['basic_auth_state'], ); } $observed = count( $observations ); $total = count( self::BOOLEAN_CAPABILITIES ) + 1; if ( 0 === $observed ) { $status = 'not_tested'; $coverage = 'none'; } elseif ( $failures > 0 ) { $status = 'fail'; $coverage = $observed === $total ? 'complete' : 'partial'; } elseif ( $basic_auth_warning ) { $status = 'warning'; $coverage = $observed === $total ? 'complete' : 'partial'; } elseif ( $observed < $total ) { $status = 'not_tested'; $coverage = 'partial'; } else { $status = 'pass'; $coverage = 'complete'; } return $this->findings->build( $this->id(), $status, array( 'observations' => $observations, 'method' => 'local_wordpress_api_prerequisites', 'limitations' => array( 'Only local API prerequisites and Basic Auth visibility were observed. No REST or loopback request was made, so reachability, routing, DNS, TLS and response status were not tested.' ), ), $observed, $total, $coverage, $timestamp ); } /** * @return array{rest_route_api:bool,rest_dispatch_api:bool,http_client_api:bool,url_validation_api:bool,basic_auth_state:string} */ private function wordpress_capabilities(): array { $basic_auth_state = 'unknown'; if ( function_exists( 'wp_is_site_protected_by_basic_auth' ) ) { $basic_auth_state = wp_is_site_protected_by_basic_auth() ? 'protected' : 'not_detected'; } return array( 'rest_route_api' => function_exists( 'register_rest_route' ) && function_exists( 'rest_url' ), 'rest_dispatch_api' => function_exists( 'rest_do_request' ) && class_exists( 'WP_REST_Request' ), 'http_client_api' => function_exists( 'wp_remote_get' ), 'url_validation_api' => function_exists( 'wp_http_validate_url' ), 'basic_auth_state' => $basic_auth_state, ); } /** * @return array */ private function error_finding( string $timestamp ): array { return $this->findings->build( $this->id(), 'error', array( 'observations' => array(), 'method' => 'local_wordpress_api_prerequisites', 'limitations' => array( 'The local prerequisite adapter failed; no exception, URL, header or server value was stored.' ), ), 0, count( self::BOOLEAN_CAPABILITIES ) + 1, 'error', $timestamp ); } }