NewsletterDuplicateEndpoint.php
2 months ago
NewsletterStatusEndpoint.php
2 months ago
NewslettersBulkActionEndpoint.php
2 months ago
NewslettersListingEndpoint.php
2 months ago
SendingStatusListingEndpoint.php
1 month ago
SendingStatusResendEndpoint.php
2 months ago
index.php
2 months ago
NewslettersBulkActionEndpoint.php
227 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Newsletter\RestApi\Endpoints; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\API\REST\ApiException; |
| 9 | use MailPoet\API\REST\Endpoint; |
| 10 | use MailPoet\API\REST\Request; |
| 11 | use MailPoet\API\REST\Response; |
| 12 | use MailPoet\Config\AccessControl; |
| 13 | use MailPoet\Cron\Workers\StatisticsExport; |
| 14 | use MailPoet\Entities\ScheduledTaskEntity; |
| 15 | use MailPoet\Listing\Handler as ListingHandler; |
| 16 | use MailPoet\Listing\ListingDefinition; |
| 17 | use MailPoet\Newsletter\BulkActionController; |
| 18 | use MailPoet\Newsletter\BulkActionException; |
| 19 | use MailPoet\Newsletter\Listing\NewsletterListingRepository; |
| 20 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 21 | use MailPoet\Newsletter\Statistics\Export\StatisticsExporter; |
| 22 | use MailPoet\Util\License\Features\CapabilitiesManager; |
| 23 | use MailPoet\Validator\Builder; |
| 24 | use MailPoet\WP\Functions as WPFunctions; |
| 25 | use MailPoetVendor\Carbon\Carbon; |
| 26 | |
| 27 | /** |
| 28 | * `POST /mailpoet/v1/newsletters/bulk-action` |
| 29 | * |
| 30 | * Mirrors the legacy JSON endpoint: `trash`, `restore`, and `delete` flow |
| 31 | * through {@see BulkActionController}; `export_stats` is handled here because |
| 32 | * it is async (it queues a scheduled task) and gated behind a premium |
| 33 | * capability instead of the bulk dispatcher's plain list of supported actions. |
| 34 | */ |
| 35 | class NewslettersBulkActionEndpoint extends Endpoint { |
| 36 | public const ACTION_EXPORT_STATS = 'export_stats'; |
| 37 | |
| 38 | /** @var ListingHandler */ |
| 39 | private $listingHandler; |
| 40 | |
| 41 | /** @var NewsletterListingRepository */ |
| 42 | private $newsletterListingRepository; |
| 43 | |
| 44 | /** @var BulkActionController */ |
| 45 | private $bulkActionController; |
| 46 | |
| 47 | /** @var ScheduledTasksRepository */ |
| 48 | private $scheduledTasksRepository; |
| 49 | |
| 50 | /** @var CapabilitiesManager */ |
| 51 | private $capabilitiesManager; |
| 52 | |
| 53 | /** @var WPFunctions */ |
| 54 | private $wp; |
| 55 | |
| 56 | public function __construct( |
| 57 | ListingHandler $listingHandler, |
| 58 | NewsletterListingRepository $newsletterListingRepository, |
| 59 | BulkActionController $bulkActionController, |
| 60 | ScheduledTasksRepository $scheduledTasksRepository, |
| 61 | CapabilitiesManager $capabilitiesManager, |
| 62 | WPFunctions $wp |
| 63 | ) { |
| 64 | $this->listingHandler = $listingHandler; |
| 65 | $this->newsletterListingRepository = $newsletterListingRepository; |
| 66 | $this->bulkActionController = $bulkActionController; |
| 67 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 68 | $this->capabilitiesManager = $capabilitiesManager; |
| 69 | $this->wp = $wp; |
| 70 | } |
| 71 | |
| 72 | public function checkPermissions(): bool { |
| 73 | return $this->wp->currentUserCan(AccessControl::PERMISSION_MANAGE_EMAILS); |
| 74 | } |
| 75 | |
| 76 | public function handle(Request $request): Response { |
| 77 | $actionParam = $request->getParam('action'); |
| 78 | $action = is_string($actionParam) ? $actionParam : ''; |
| 79 | $selectAll = $request->getParam('select_all') === true; |
| 80 | $selection = $this->getSelection($request); |
| 81 | if ($selection === [] && !$selectAll) { |
| 82 | throw new ApiException( |
| 83 | __('No newsletters selected.', 'mailpoet'), |
| 84 | 400, |
| 85 | 'mailpoet_newsletters_missing_selection' |
| 86 | ); |
| 87 | } |
| 88 | $definition = $this->buildDefinition($request, $selection); |
| 89 | |
| 90 | if ($action === self::ACTION_EXPORT_STATS) { |
| 91 | return $this->handleExportStats($request, $definition); |
| 92 | } |
| 93 | |
| 94 | try { |
| 95 | $result = $this->bulkActionController->execute($action, $definition); |
| 96 | } catch (BulkActionException $exception) { |
| 97 | throw new ApiException( |
| 98 | $exception->getMessage(), |
| 99 | $exception->getStatusCode(), |
| 100 | $exception->getErrorCode() |
| 101 | ); |
| 102 | } |
| 103 | |
| 104 | return new Response([ |
| 105 | 'action' => $result['action'], |
| 106 | 'count' => $result['count'], |
| 107 | ]); |
| 108 | } |
| 109 | |
| 110 | public static function getRequestSchema(): array { |
| 111 | return [ |
| 112 | 'action' => Builder::string()->required(), |
| 113 | 'selection' => Builder::array(Builder::integer()), |
| 114 | 'type' => Builder::string(), |
| 115 | 'group' => Builder::string(), |
| 116 | 'search' => Builder::string(), |
| 117 | 'filter' => Builder::object(), |
| 118 | 'parent_id' => Builder::integer(), |
| 119 | 'select_all' => Builder::boolean(), |
| 120 | 'format' => Builder::string(), |
| 121 | ]; |
| 122 | } |
| 123 | |
| 124 | private function handleExportStats(Request $request, ListingDefinition $definition): Response { |
| 125 | $capability = $this->capabilitiesManager->getCapability('detailedAnalytics'); |
| 126 | if ($capability === null || $capability->isRestricted) { |
| 127 | throw new ApiException( |
| 128 | __('Bulk statistics export requires a MailPoet plan with detailed analytics.', 'mailpoet'), |
| 129 | 403, |
| 130 | 'mailpoet_newsletters_export_forbidden' |
| 131 | ); |
| 132 | } |
| 133 | |
| 134 | $ids = array_values(array_map('intval', $this->newsletterListingRepository->getActionableIds($definition))); |
| 135 | if ($ids === []) { |
| 136 | throw new ApiException( |
| 137 | __('No newsletters selected for export.', 'mailpoet'), |
| 138 | 400, |
| 139 | 'mailpoet_newsletters_export_empty' |
| 140 | ); |
| 141 | } |
| 142 | |
| 143 | $formatParam = $request->getParam('format'); |
| 144 | $format = is_string($formatParam) ? strtolower($formatParam) : StatisticsExporter::FORMAT_CSV; |
| 145 | if ($format !== StatisticsExporter::FORMAT_CSV && $format !== StatisticsExporter::FORMAT_XLSX) { |
| 146 | throw new ApiException( |
| 147 | __('Unsupported export format. Use csv or xlsx.', 'mailpoet'), |
| 148 | 400, |
| 149 | 'mailpoet_newsletters_export_invalid_format' |
| 150 | ); |
| 151 | } |
| 152 | |
| 153 | $task = new ScheduledTaskEntity(); |
| 154 | $task->setType(StatisticsExport::TASK_TYPE); |
| 155 | $task->setStatus(ScheduledTaskEntity::STATUS_SCHEDULED); |
| 156 | $task->setScheduledAt(Carbon::now()->millisecond(0)); |
| 157 | $task->setPriority(ScheduledTaskEntity::PRIORITY_HIGH); |
| 158 | $task->setMeta([ |
| 159 | 'job_type' => StatisticsExport::JOB_TYPE_BULK, |
| 160 | 'newsletter_ids' => $ids, |
| 161 | 'format' => $format, |
| 162 | 'requested_by' => (int)$this->wp->getCurrentUserId(), |
| 163 | ]); |
| 164 | $this->scheduledTasksRepository->persist($task); |
| 165 | $this->scheduledTasksRepository->flush(); |
| 166 | |
| 167 | return new Response([ |
| 168 | 'action' => self::ACTION_EXPORT_STATS, |
| 169 | 'task_id' => (int)$task->getId(), |
| 170 | 'count' => count($ids), |
| 171 | ]); |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * @return int[] |
| 176 | */ |
| 177 | private function getSelection(Request $request): array { |
| 178 | $selection = $request->getParam('selection'); |
| 179 | return is_array($selection) ? $this->toIntList($selection) : []; |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * @param int[] $selection |
| 184 | */ |
| 185 | private function buildDefinition(Request $request, array $selection): ListingDefinition { |
| 186 | $filter = $request->getParam('filter'); |
| 187 | $searchParam = $request->getParam('search'); |
| 188 | $groupParam = $request->getParam('group'); |
| 189 | $typeParam = $request->getParam('type'); |
| 190 | $parentIdParam = $request->getParam('parent_id'); |
| 191 | |
| 192 | $params = []; |
| 193 | if (is_string($typeParam) && in_array($typeParam, NewslettersListingEndpoint::SUPPORTED_TYPES, true)) { |
| 194 | $params['type'] = $typeParam; |
| 195 | } |
| 196 | if (is_numeric($parentIdParam)) { |
| 197 | $params['parentId'] = (int)$parentIdParam; |
| 198 | } |
| 199 | |
| 200 | return $this->listingHandler->getListingDefinition([ |
| 201 | 'offset' => 0, |
| 202 | 'limit' => 0, |
| 203 | 'sort_by' => 'id', |
| 204 | 'sort_order' => 'desc', |
| 205 | 'search' => is_string($searchParam) ? $searchParam : null, |
| 206 | 'group' => is_string($groupParam) ? $groupParam : null, |
| 207 | 'filter' => is_array($filter) ? $filter : [], |
| 208 | 'selection' => $selection, |
| 209 | 'params' => $params, |
| 210 | ]); |
| 211 | } |
| 212 | |
| 213 | /** |
| 214 | * @param array<mixed> $values |
| 215 | * @return int[] |
| 216 | */ |
| 217 | private function toIntList(array $values): array { |
| 218 | $ints = []; |
| 219 | foreach ($values as $value) { |
| 220 | if (is_scalar($value) && (int)$value > 0) { |
| 221 | $ints[] = (int)$value; |
| 222 | } |
| 223 | } |
| 224 | return array_values(array_unique($ints)); |
| 225 | } |
| 226 | } |
| 227 |