LogsListingEndpoint.php
106 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Logging\RestApi\Endpoints; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\API\REST\AbstractListingEndpoint; |
| 9 | use MailPoet\API\REST\ListingRequestValidationTrait; |
| 10 | use MailPoet\API\REST\Request; |
| 11 | use MailPoet\API\REST\Response; |
| 12 | use MailPoet\Config\AccessControl; |
| 13 | use MailPoet\Entities\LogEntity; |
| 14 | use MailPoet\Listing\Handler as ListingHandler; |
| 15 | use MailPoet\Listing\ListingDefinition; |
| 16 | use MailPoet\Listing\ListingRepository; |
| 17 | use MailPoet\Logging\LogListingRepository; |
| 18 | use MailPoet\Logging\RestApi\LogsFilterTrait; |
| 19 | use MailPoet\Validator\Builder; |
| 20 | use MailPoet\WP\Functions as WPFunctions; |
| 21 | |
| 22 | class LogsListingEndpoint extends AbstractListingEndpoint { |
| 23 | use ListingRequestValidationTrait; |
| 24 | use LogsFilterTrait; |
| 25 | |
| 26 | private const ALLOWED_SORT_FIELDS = ['created_at', 'name']; |
| 27 | private const DEFAULT_SORT_FIELD = 'created_at'; |
| 28 | private const DEFAULT_SORT_ORDER = 'desc'; |
| 29 | |
| 30 | /** @var LogListingRepository */ |
| 31 | private $logListingRepository; |
| 32 | |
| 33 | public function __construct( |
| 34 | ListingHandler $listingHandler, |
| 35 | LogListingRepository $logListingRepository |
| 36 | ) { |
| 37 | parent::__construct($listingHandler); |
| 38 | $this->logListingRepository = $logListingRepository; |
| 39 | } |
| 40 | |
| 41 | public function handle(Request $request): Response { |
| 42 | $this->validateRequest($request); |
| 43 | return parent::handle($request); |
| 44 | } |
| 45 | |
| 46 | public function checkPermissions(): bool { |
| 47 | return WPFunctions::get()->currentUserCan(AccessControl::PERMISSION_ACCESS_PLUGIN_ADMIN); |
| 48 | } |
| 49 | |
| 50 | public static function getRequestSchema(): array { |
| 51 | $schema = parent::getRequestSchema(); |
| 52 | $schema['limit'] = Builder::integer(); |
| 53 | $schema['offset'] = Builder::integer(); |
| 54 | $schema['filter'] = Builder::object(); |
| 55 | return $schema; |
| 56 | } |
| 57 | |
| 58 | protected function getListingRepository(): ListingRepository { |
| 59 | return $this->logListingRepository; |
| 60 | } |
| 61 | |
| 62 | protected function buildItems(array $rows, ListingDefinition $definition): array { |
| 63 | $items = []; |
| 64 | foreach ($rows as $row) { |
| 65 | if (!$row instanceof LogEntity) { |
| 66 | continue; |
| 67 | } |
| 68 | $items[] = $this->buildItem($row); |
| 69 | } |
| 70 | return $items; |
| 71 | } |
| 72 | |
| 73 | private function buildItem(LogEntity $log): array { |
| 74 | $createdAt = $log->getCreatedAt(); |
| 75 | return [ |
| 76 | 'id' => (int)$log->getId(), |
| 77 | 'name' => $log->getName() ?? '', |
| 78 | 'level' => $log->getLevel(), |
| 79 | 'message' => $log->getMessage() ?? '', |
| 80 | 'created_at' => $createdAt ? $createdAt->format('Y-m-d H:i:s') : null, |
| 81 | ]; |
| 82 | } |
| 83 | |
| 84 | protected function getDefaultSortBy(): string { |
| 85 | return self::DEFAULT_SORT_FIELD; |
| 86 | } |
| 87 | |
| 88 | protected function getDefaultSortOrder(): string { |
| 89 | return self::DEFAULT_SORT_ORDER; |
| 90 | } |
| 91 | |
| 92 | protected function getListingValidationErrorPrefix(): string { |
| 93 | return 'logs'; |
| 94 | } |
| 95 | |
| 96 | private function validateRequest(Request $request): void { |
| 97 | $this->validateSortField($request->getParam('orderby'), self::ALLOWED_SORT_FIELDS); |
| 98 | $this->validateSortField($request->getParam('sort_by'), self::ALLOWED_SORT_FIELDS); |
| 99 | $this->validateSortOrder($request->getParam('order')); |
| 100 | $this->validateSortOrder($request->getParam('sort_order')); |
| 101 | $this->validatePagination($request); |
| 102 | // Keep the range check in sync with getDateRangeError() in logs/url-state.ts. |
| 103 | $this->validateAndNormalizeLogsFilter($request->getParam('filter')); |
| 104 | } |
| 105 | } |
| 106 |