AbstractSegmentsListingEndpoint.php
1 month ago
DynamicSegmentsBulkActionEndpoint.php
3 months ago
DynamicSegmentsListingEndpoint.php
1 month ago
SegmentRequestValidationTrait.php
3 months ago
SegmentsBulkActionEndpoint.php
3 months ago
SegmentsEndpoint.php
3 months ago
SegmentsListingEndpoint.php
1 month ago
index.php
3 months ago
SegmentsBulkActionEndpoint.php
321 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Segments\RestApi\Endpoints; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\API\REST\ApiException; |
| 9 | use MailPoet\API\REST\Request; |
| 10 | use MailPoet\API\REST\Response; |
| 11 | use MailPoet\Entities\SegmentEntity; |
| 12 | use MailPoet\Form\FormsRepository; |
| 13 | use MailPoet\Listing\Handler as ListingHandler; |
| 14 | use MailPoet\Newsletter\Segment\NewsletterSegmentRepository; |
| 15 | use MailPoet\Segments\SegmentListingRepository; |
| 16 | use MailPoet\Segments\SegmentsRepository; |
| 17 | use MailPoet\Subscribers\SubscribersRepository; |
| 18 | use MailPoet\Validator\Builder; |
| 19 | |
| 20 | class SegmentsBulkActionEndpoint extends SegmentsEndpoint { |
| 21 | private const ACTION_TRASH = 'trash'; |
| 22 | private const ACTION_RESTORE = 'restore'; |
| 23 | private const ACTION_DELETE = 'delete'; |
| 24 | private const ACTION_EMPTY_TRASH = 'empty_trash'; |
| 25 | |
| 26 | private const SUPPORTED_ACTIONS = [ |
| 27 | self::ACTION_TRASH, |
| 28 | self::ACTION_RESTORE, |
| 29 | self::ACTION_DELETE, |
| 30 | self::ACTION_EMPTY_TRASH, |
| 31 | ]; |
| 32 | |
| 33 | /** @var ListingHandler */ |
| 34 | private $listingHandler; |
| 35 | |
| 36 | /** @var SegmentListingRepository */ |
| 37 | private $segmentListingRepository; |
| 38 | |
| 39 | /** @var SegmentsRepository */ |
| 40 | private $segmentsRepository; |
| 41 | |
| 42 | /** @var NewsletterSegmentRepository */ |
| 43 | private $newsletterSegmentRepository; |
| 44 | |
| 45 | /** @var FormsRepository */ |
| 46 | private $formsRepository; |
| 47 | |
| 48 | /** @var SubscribersRepository */ |
| 49 | private $subscribersRepository; |
| 50 | |
| 51 | public function __construct( |
| 52 | ListingHandler $listingHandler, |
| 53 | SegmentListingRepository $segmentListingRepository, |
| 54 | SegmentsRepository $segmentsRepository, |
| 55 | NewsletterSegmentRepository $newsletterSegmentRepository, |
| 56 | FormsRepository $formsRepository, |
| 57 | SubscribersRepository $subscribersRepository |
| 58 | ) { |
| 59 | $this->listingHandler = $listingHandler; |
| 60 | $this->segmentListingRepository = $segmentListingRepository; |
| 61 | $this->segmentsRepository = $segmentsRepository; |
| 62 | $this->newsletterSegmentRepository = $newsletterSegmentRepository; |
| 63 | $this->formsRepository = $formsRepository; |
| 64 | $this->subscribersRepository = $subscribersRepository; |
| 65 | } |
| 66 | |
| 67 | public function handle(Request $request): Response { |
| 68 | $action = $this->validateAction($request); |
| 69 | $this->validateListingParams($request); |
| 70 | $ids = $this->getSelectedIds($request, $action); |
| 71 | $this->validateTypeBoundaries($ids); |
| 72 | if ($action === self::ACTION_DELETE) { |
| 73 | $this->validateDeletionSelection($ids); |
| 74 | } |
| 75 | |
| 76 | $result = [ |
| 77 | 'updated' => 0, |
| 78 | 'deleted' => 0, |
| 79 | 'skipped' => 0, |
| 80 | 'errors' => [], |
| 81 | ]; |
| 82 | |
| 83 | if ($action === self::ACTION_TRASH) { |
| 84 | $this->trashSegments($ids, $result); |
| 85 | } elseif ($action === self::ACTION_RESTORE) { |
| 86 | $this->restoreSegments($ids, $result); |
| 87 | } else { |
| 88 | $this->deleteSegments($ids, $result); |
| 89 | } |
| 90 | |
| 91 | return new Response($result); |
| 92 | } |
| 93 | |
| 94 | public static function getRequestSchema(): array { |
| 95 | return [ |
| 96 | 'action' => Builder::string()->required(), |
| 97 | 'ids' => Builder::array(Builder::integer()), |
| 98 | 'select_all' => Builder::boolean(), |
| 99 | 'group' => Builder::string(), |
| 100 | 'page' => Builder::integer(), |
| 101 | 'per_page' => Builder::integer(), |
| 102 | 'orderby' => Builder::string(), |
| 103 | 'order' => Builder::string(), |
| 104 | 'sort_by' => Builder::string(), |
| 105 | 'sort_order' => Builder::string(), |
| 106 | ]; |
| 107 | } |
| 108 | |
| 109 | private function validateAction(Request $request): string { |
| 110 | $action = is_string($request->getParam('action')) ? (string)$request->getParam('action') : ''; |
| 111 | if (!in_array($action, self::SUPPORTED_ACTIONS, true)) { |
| 112 | throw new ApiException( |
| 113 | sprintf( |
| 114 | // translators: %s is the list of supported bulk actions. |
| 115 | __('Unsupported bulk action. Allowed values are: %s.', 'mailpoet'), |
| 116 | implode(', ', self::SUPPORTED_ACTIONS) |
| 117 | ), |
| 118 | 400, |
| 119 | 'mailpoet_segments_invalid_bulk_action' |
| 120 | ); |
| 121 | } |
| 122 | return $action; |
| 123 | } |
| 124 | |
| 125 | private function validateListingParams(Request $request): void { |
| 126 | $this->validateGroup(is_string($request->getParam('group')) ? (string)$request->getParam('group') : null); |
| 127 | $orderParam = $request->getParam('order') ?? $request->getParam('sort_order'); |
| 128 | $this->validateOrder(is_string($orderParam) ? (string)$orderParam : null, 'asc'); |
| 129 | $this->validatePage($request->getParam('page')); |
| 130 | $this->validatePerPage($request->getParam('per_page'), 20); |
| 131 | |
| 132 | $orderbyParam = $request->getParam('orderby') ?? $request->getParam('sort_by'); |
| 133 | $orderby = is_string($orderbyParam) && $orderbyParam !== '' |
| 134 | ? (string)$orderbyParam |
| 135 | : 'name'; |
| 136 | $allowedSortFields = ['name', 'created_at', 'updated_at', 'average_engagement_score']; |
| 137 | if (!in_array($orderby, $allowedSortFields, true)) { |
| 138 | throw new ApiException( |
| 139 | sprintf( |
| 140 | // translators: %s is the list of supported sort fields. |
| 141 | __('Unsupported sort field. Allowed values are: %s.', 'mailpoet'), |
| 142 | implode(', ', $allowedSortFields) |
| 143 | ), |
| 144 | 400, |
| 145 | 'mailpoet_segments_invalid_orderby' |
| 146 | ); |
| 147 | } |
| 148 | } |
| 149 | |
| 150 | /** |
| 151 | * @return int[] |
| 152 | */ |
| 153 | private function getSelectedIds(Request $request, string $action): array { |
| 154 | if ($action === self::ACTION_EMPTY_TRASH) { |
| 155 | return $this->getAllMatchingIds('trash'); |
| 156 | } |
| 157 | |
| 158 | if ($request->getParam('select_all') === true) { |
| 159 | $group = $this->validateGroup(is_string($request->getParam('group')) ? (string)$request->getParam('group') : null); |
| 160 | return $this->getAllMatchingIds($group); |
| 161 | } |
| 162 | |
| 163 | return $this->validateIds($request->getParam('ids')); |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * @return int[] |
| 168 | */ |
| 169 | private function getAllMatchingIds(string $group): array { |
| 170 | $definition = $this->listingHandler->getListingDefinition([ |
| 171 | 'group' => $group, |
| 172 | 'sort_by' => 'name', |
| 173 | 'sort_order' => 'asc', |
| 174 | 'params' => ['lists'], |
| 175 | ]); |
| 176 | $ids = $this->segmentListingRepository->getActionableIds($definition); |
| 177 | return array_map('intval', $ids); |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * @param int[] $ids |
| 182 | * @param array{updated:int,deleted:int,skipped:int,errors:array<int, array{id:int|null,message:string}>} $result |
| 183 | */ |
| 184 | private function trashSegments(array $ids, array &$result): void { |
| 185 | $newsletterBlockers = $this->newsletterSegmentRepository->getSubjectsOfActivelyUsedEmailsForSegments($ids); |
| 186 | $formBlockers = $this->formsRepository->getNamesOfFormsForSegments(); |
| 187 | |
| 188 | foreach ($ids as $id) { |
| 189 | $segment = $this->segmentsRepository->findOneById($id); |
| 190 | if (!$segment instanceof SegmentEntity) { |
| 191 | $this->skip($result, $id, __('This list does not exist.', 'mailpoet')); |
| 192 | continue; |
| 193 | } |
| 194 | if (!in_array($segment->getType(), [SegmentEntity::TYPE_DEFAULT, SegmentEntity::TYPE_WP_USERS], true)) { |
| 195 | $this->skip($result, $id, __('This list cannot be moved to trash.', 'mailpoet')); |
| 196 | continue; |
| 197 | } |
| 198 | if (isset($newsletterBlockers[$id])) { |
| 199 | $this->skip($result, $id, str_replace( |
| 200 | '%1$s', |
| 201 | "'" . join("', '", $newsletterBlockers[$id]) . "'", |
| 202 | // translators: %1$s is a comma-separated list of emails for which the segment is used. |
| 203 | _x('List cannot be deleted because it’s used for %1$s email', 'Alert shown when trying to delete segment, which is assigned to any automatic emails.', 'mailpoet') |
| 204 | )); |
| 205 | continue; |
| 206 | } |
| 207 | if (isset($formBlockers[$id])) { |
| 208 | $this->skip($result, $id, str_replace( |
| 209 | '%1$s', |
| 210 | "'" . join("', '", $formBlockers[$id]) . "'", |
| 211 | // translators: %1$s is a comma-separated list of forms for which the segment is used. |
| 212 | _nx( |
| 213 | 'List cannot be deleted because it’s used for %1$s form', |
| 214 | 'List cannot be deleted because it’s used for %1$s forms', |
| 215 | count($formBlockers[$id]), |
| 216 | 'Alert shown when trying to delete segment, when it is assigned to a form.', |
| 217 | 'mailpoet' |
| 218 | ) |
| 219 | )); |
| 220 | continue; |
| 221 | } |
| 222 | if ($segment->getType() === SegmentEntity::TYPE_WP_USERS) { |
| 223 | $subscribers = $this->subscribersRepository->findExclusiveSubscribersBySegment((int)$segment->getId()); |
| 224 | $subscriberIds = array_map(static function ($subscriber): int { |
| 225 | return (int)$subscriber->getId(); |
| 226 | }, $subscribers); |
| 227 | $this->subscribersRepository->bulkTrash($subscriberIds); |
| 228 | } |
| 229 | $result['updated'] += $this->segmentsRepository->doTrash([$id], $segment->getType()); |
| 230 | } |
| 231 | } |
| 232 | |
| 233 | /** |
| 234 | * @param int[] $ids |
| 235 | * @param array{updated:int,deleted:int,skipped:int,errors:array<int, array{id:int|null,message:string}>} $result |
| 236 | */ |
| 237 | private function restoreSegments(array $ids, array &$result): void { |
| 238 | foreach ($ids as $id) { |
| 239 | $segment = $this->segmentsRepository->findOneById($id); |
| 240 | if (!$segment instanceof SegmentEntity) { |
| 241 | $this->skip($result, $id, __('This list does not exist.', 'mailpoet')); |
| 242 | continue; |
| 243 | } |
| 244 | if (!in_array($segment->getType(), [SegmentEntity::TYPE_DEFAULT, SegmentEntity::TYPE_WP_USERS], true)) { |
| 245 | $this->skip($result, $id, __('This list cannot be restored.', 'mailpoet')); |
| 246 | continue; |
| 247 | } |
| 248 | if ($segment->getType() === SegmentEntity::TYPE_WP_USERS) { |
| 249 | $subscribers = $this->subscribersRepository->findBySegment((int)$segment->getId()); |
| 250 | $subscriberIds = array_map(static function ($subscriber): int { |
| 251 | return (int)$subscriber->getId(); |
| 252 | }, $subscribers); |
| 253 | $this->subscribersRepository->bulkRestore($subscriberIds); |
| 254 | } |
| 255 | $result['updated'] += $this->segmentsRepository->bulkRestore([$id], $segment->getType()); |
| 256 | } |
| 257 | } |
| 258 | |
| 259 | /** |
| 260 | * @param int[] $ids |
| 261 | * @param array{updated:int,deleted:int,skipped:int,errors:array<int, array{id:int|null,message:string}>} $result |
| 262 | */ |
| 263 | private function deleteSegments(array $ids, array &$result): void { |
| 264 | foreach ($ids as $id) { |
| 265 | $segment = $this->segmentsRepository->findOneById($id); |
| 266 | if (!$segment instanceof SegmentEntity) { |
| 267 | $this->skip($result, $id, __('This list does not exist.', 'mailpoet')); |
| 268 | continue; |
| 269 | } |
| 270 | if ($segment->getType() !== SegmentEntity::TYPE_DEFAULT) { |
| 271 | $this->skip($result, $id, __('This list cannot be deleted.', 'mailpoet')); |
| 272 | continue; |
| 273 | } |
| 274 | $result['deleted'] += $this->segmentsRepository->bulkDelete([$id]); |
| 275 | } |
| 276 | } |
| 277 | |
| 278 | /** |
| 279 | * @param int[] $ids |
| 280 | */ |
| 281 | private function validateTypeBoundaries(array $ids): void { |
| 282 | foreach ($ids as $id) { |
| 283 | $segment = $this->segmentsRepository->findOneById($id); |
| 284 | if ($segment instanceof SegmentEntity && $segment->getType() === SegmentEntity::TYPE_DYNAMIC) { |
| 285 | throw new ApiException( |
| 286 | __('This endpoint only supports lists.', 'mailpoet'), |
| 287 | 400, |
| 288 | 'mailpoet_segments_invalid_type' |
| 289 | ); |
| 290 | } |
| 291 | } |
| 292 | } |
| 293 | |
| 294 | /** |
| 295 | * @param int[] $ids |
| 296 | */ |
| 297 | private function validateDeletionSelection(array $ids): void { |
| 298 | foreach ($ids as $id) { |
| 299 | $segment = $this->segmentsRepository->findOneById($id); |
| 300 | if ($segment instanceof SegmentEntity && $segment->getDeletedAt() === null) { |
| 301 | throw new ApiException( |
| 302 | __('Only lists in the trash can be permanently deleted.', 'mailpoet'), |
| 303 | 400, |
| 304 | 'mailpoet_segments_delete_requires_trash' |
| 305 | ); |
| 306 | } |
| 307 | } |
| 308 | } |
| 309 | |
| 310 | /** |
| 311 | * @param array{updated:int,deleted:int,skipped:int,errors:array<int, array{id:int|null,message:string}>} $result |
| 312 | */ |
| 313 | private function skip(array &$result, ?int $id, string $message): void { |
| 314 | $result['skipped']++; |
| 315 | $result['errors'][] = [ |
| 316 | 'id' => $id, |
| 317 | 'message' => $message, |
| 318 | ]; |
| 319 | } |
| 320 | } |
| 321 |