1d6ac46ba3
CI / No Debug Code (pull_request) Successful in 3s
CI / Tests (PHP 8.2) (pull_request) Successful in 48s
CI / Tests (PHP 8.3) (pull_request) Successful in 52s
CI / Coding Standards (pull_request) Successful in 57s
CI / Tests (PHP 8.1) (pull_request) Successful in 1m1s
CI / PHPStan (pull_request) Successful in 1m11s
CI / Build Plugin Zip (pull_request) Has been skipped
- Bump phpstan/phpstan ^2.0 and szepeviktor/phpstan-wordpress ^2.0 - Move the analysis level into phpstan.neon (single source) and raise it to 10 - Add Val, a runtime coercion helper that narrows untyped WordPress boundary values (wpdb rows, REST params, superglobals, options) with explicit checks instead of blind casts, plus unit tests - Type value-object fromRow() params as stdClass (what wpdb returns) and map columns through Val so unexpected shapes degrade safely - Use %i identifier placeholders for table names in all wpdb::prepare() calls so every query string is a literal and identifiers are escaped by WordPress; raises the minimum WordPress version to 6.2 where %i was introduced - Guard wpdb::prepare() null result before wpdb::query() in updateTax() - Fix nullable get_permalink()/strtotime() handling, list types at REST and capability call sites, dead null-coalescing on checked superglobals, and narrow get_users() results before mapping - Register Val method names with the ValidatedSanitizedInput sniff so it validates the real sanitizer around each superglobal read - Update repository unit tests for the %i placeholder arguments Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
229 lines
6.9 KiB
PHP
229 lines
6.9 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
namespace Unsupervised\Schedular\Policy;
|
|
|
|
use Unsupervised\Schedular\Auth\RoleManager;
|
|
use Unsupervised\Schedular\Val;
|
|
|
|
class PolicyEndpoint {
|
|
|
|
public function __construct(
|
|
private PolicyRepository $policies,
|
|
private PolicyVersionRepository $versions,
|
|
private PolicyService $service,
|
|
) {}
|
|
|
|
/**
|
|
* Registers this endpoint's REST routes.
|
|
*
|
|
* @param non-falsy-string $route_namespace REST namespace the routes are registered under (e.g. `us-scheduler/v1`).
|
|
*/
|
|
public function registerRoutes( string $route_namespace ): void {
|
|
register_rest_route(
|
|
$route_namespace,
|
|
'/policies',
|
|
[
|
|
[
|
|
'methods' => \WP_REST_Server::READABLE,
|
|
'callback' => [ $this, 'index' ],
|
|
'permission_callback' => [ $this, 'canBook' ],
|
|
],
|
|
[
|
|
'methods' => \WP_REST_Server::CREATABLE,
|
|
'callback' => [ $this, 'create' ],
|
|
'permission_callback' => [ $this, 'canManage' ],
|
|
],
|
|
]
|
|
);
|
|
|
|
register_rest_route(
|
|
$route_namespace,
|
|
'/policies/(?P<id>\d+)/versions',
|
|
[
|
|
[
|
|
'methods' => \WP_REST_Server::CREATABLE,
|
|
'callback' => [ $this, 'addVersion' ],
|
|
'permission_callback' => [ $this, 'canManage' ],
|
|
],
|
|
]
|
|
);
|
|
|
|
register_rest_route(
|
|
$route_namespace,
|
|
'/policies/(?P<id>\d+)/versions/(?P<vid>\d+)',
|
|
[
|
|
[
|
|
'methods' => \WP_REST_Server::EDITABLE,
|
|
'callback' => [ $this, 'updateVersion' ],
|
|
'permission_callback' => [ $this, 'canManage' ],
|
|
],
|
|
]
|
|
);
|
|
|
|
register_rest_route(
|
|
$route_namespace,
|
|
'/policies/(?P<id>\d+)/versions/(?P<vid>\d+)/publish',
|
|
[
|
|
[
|
|
'methods' => \WP_REST_Server::CREATABLE,
|
|
'callback' => [ $this, 'publish' ],
|
|
'permission_callback' => [ $this, 'canManage' ],
|
|
],
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Public: the current published version of every policy (the registration
|
|
* gate). Pass `?scope=signup|booking` to limit to that gate (includes
|
|
* `both`-scoped policies).
|
|
*/
|
|
public function index( \WP_REST_Request $request ): \WP_REST_Response {
|
|
$scope = Val::string( $request->get_param( 'scope' ) );
|
|
$policies = in_array( $scope, [ Policy::SCOPE_SIGNUP, Policy::SCOPE_BOOKING ], true )
|
|
? $this->policies->findForScope( $scope )
|
|
: $this->policies->findAll();
|
|
|
|
$out = [];
|
|
|
|
foreach ( $policies as $policy ) {
|
|
if ( null === $policy->currentVersionId ) {
|
|
continue;
|
|
}
|
|
|
|
$version = $this->versions->findById( $policy->currentVersionId );
|
|
if ( null === $version || ! $version->isPublished() ) {
|
|
continue;
|
|
}
|
|
|
|
$out[] = [
|
|
'id' => $policy->id,
|
|
'title' => $policy->title,
|
|
'slug' => $policy->slug,
|
|
'policy_version_id' => $version->id,
|
|
'version_number' => $version->versionNumber,
|
|
// Bodies are kses'd on every write path, but the booking JS renders
|
|
// this HTML raw — sanitise at output too so a missed write path can
|
|
// never become stored XSS.
|
|
'body' => wp_kses_post( (string) $version->body ),
|
|
];
|
|
}
|
|
|
|
return new \WP_REST_Response( $out, 200 );
|
|
}
|
|
|
|
public function create( \WP_REST_Request $request ): \WP_REST_Response|\WP_Error {
|
|
$title = sanitize_text_field( Val::string( $request->get_param( 'title' ) ) );
|
|
if ( '' === $title ) {
|
|
return $this->invalid( __( 'A policy title is required.', 'unsupervised-schedular' ) );
|
|
}
|
|
|
|
$slugParam = sanitize_text_field( Val::string( $request->get_param( 'slug' ) ) );
|
|
$slug = sanitize_title( '' !== $slugParam ? $slugParam : $title );
|
|
if ( '' === $slug ) {
|
|
return $this->invalid( __( 'A valid policy slug is required.', 'unsupervised-schedular' ) );
|
|
}
|
|
|
|
if ( null !== $this->policies->findBySlug( $slug ) ) {
|
|
return new \WP_Error( 'duplicate_slug', __( 'A policy with that slug already exists.', 'unsupervised-schedular' ), [ 'status' => 409 ] );
|
|
}
|
|
|
|
$scope = Val::string( $request->get_param( 'acceptance_scope' ) ?? Policy::SCOPE_BOOKING );
|
|
if ( ! in_array( $scope, Policy::VALID_SCOPES, true ) ) {
|
|
return $this->invalid( __( 'Invalid acceptance scope.', 'unsupervised-schedular' ) );
|
|
}
|
|
|
|
$id = $this->service->createPolicy( $title, $slug, $scope );
|
|
|
|
return new \WP_REST_Response( [ 'id' => $id ], 201 );
|
|
}
|
|
|
|
public function addVersion( \WP_REST_Request $request ): \WP_REST_Response|\WP_Error {
|
|
$policy = $this->policies->findById( absint( Val::int( $request->get_param( 'id' ) ) ) );
|
|
if ( null === $policy ) {
|
|
return $this->notFound();
|
|
}
|
|
|
|
$body = wp_kses_post( Val::string( $request->get_param( 'body' ) ) );
|
|
$id = $this->service->addDraftVersion( (int) $policy->id, $body );
|
|
|
|
return new \WP_REST_Response( [ 'id' => $id ], 201 );
|
|
}
|
|
|
|
public function updateVersion( \WP_REST_Request $request ): \WP_REST_Response|\WP_Error {
|
|
$version = $this->loadVersionForPolicy( $request );
|
|
if ( $version instanceof \WP_Error ) {
|
|
return $version;
|
|
}
|
|
|
|
if ( PolicyVersion::STATUS_DRAFT !== $version->status ) {
|
|
return $this->invalid( __( 'Only draft versions can be edited.', 'unsupervised-schedular' ) );
|
|
}
|
|
|
|
$body = wp_kses_post( Val::string( $request->get_param( 'body' ) ) );
|
|
$this->versions->updateBody( (int) $version->id, $body );
|
|
|
|
return new \WP_REST_Response(
|
|
[
|
|
'id' => $version->id,
|
|
'body' => $body,
|
|
],
|
|
200
|
|
);
|
|
}
|
|
|
|
public function publish( \WP_REST_Request $request ): \WP_REST_Response|\WP_Error {
|
|
$version = $this->loadVersionForPolicy( $request );
|
|
if ( $version instanceof \WP_Error ) {
|
|
return $version;
|
|
}
|
|
|
|
$this->service->publishVersion( Val::int( $request->get_param( 'id' ) ), (int) $version->id );
|
|
|
|
return new \WP_REST_Response(
|
|
[
|
|
'id' => $version->id,
|
|
'status' => PolicyVersion::STATUS_PUBLISHED,
|
|
],
|
|
200
|
|
);
|
|
}
|
|
|
|
public function canManage(): bool {
|
|
return is_user_logged_in() && current_user_can( RoleManager::CAP_MANAGE_POLICIES );
|
|
}
|
|
|
|
/**
|
|
* The published-policy listing is only read by the logged-in student
|
|
* booking/enrolment flow (the signup gate renders its policies server-side, not
|
|
* via this endpoint), so reading it requires the booking capability — there is
|
|
* no anonymous consumer.
|
|
*/
|
|
public function canBook(): bool {
|
|
return is_user_logged_in() && current_user_can( RoleManager::CAP_BOOK_LESSON );
|
|
}
|
|
|
|
/**
|
|
* Load the version named in the route and confirm it belongs to the policy.
|
|
*/
|
|
private function loadVersionForPolicy( \WP_REST_Request $request ): PolicyVersion|\WP_Error {
|
|
$policyId = absint( Val::int( $request->get_param( 'id' ) ) );
|
|
$version = $this->versions->findById( absint( Val::int( $request->get_param( 'vid' ) ) ) );
|
|
|
|
if ( null === $version || $version->policyId !== $policyId ) {
|
|
return $this->notFound();
|
|
}
|
|
|
|
return $version;
|
|
}
|
|
|
|
private function notFound(): \WP_Error {
|
|
return new \WP_Error( 'not_found', __( 'Policy or version not found.', 'unsupervised-schedular' ), [ 'status' => 404 ] );
|
|
}
|
|
|
|
private function invalid( string $message ): \WP_Error {
|
|
return new \WP_Error( 'invalid_policy', $message, [ 'status' => 400 ] );
|
|
}
|
|
}
|