ConfirmationEmailTemplate
2 months ago
ImportExport
1 month ago
RestApi
1 month ago
Statistics
2 months ago
BulkActionController.php
1 month ago
BulkActionException.php
3 months ago
BulkConfirmationEmailResender.php
3 months ago
ConfirmationEmailCustomizer.php
3 months ago
ConfirmationEmailMailer.php
3 months ago
ConfirmationEmailResolver.php
3 months ago
EngagementDataBackfiller.php
3 months ago
InactiveSubscribersController.php
1 month ago
LinkTokens.php
3 months ago
NewSubscriberNotificationMailer.php
3 months ago
RequiredCustomFieldValidator.php
3 months ago
SegmentsCountRecalculator.php
1 month ago
Source.php
3 months ago
SubscriberActions.php
3 months ago
SubscriberCustomFieldRepository.php
3 years ago
SubscriberIPsRepository.php
2 years ago
SubscriberLimitNotificationEvaluator.php
3 months ago
SubscriberLimitNotificationMailer.php
3 months ago
SubscriberLimitNotificationScheduler.php
3 months ago
SubscriberListingRepository.php
1 month ago
SubscriberPersonalDataEraser.php
3 months ago
SubscriberSaveController.php
1 month ago
SubscriberSegmentRepository.php
1 month ago
SubscriberSubscribeController.php
1 month ago
SubscriberTagRepository.php
4 years ago
SubscribersCountsController.php
1 month ago
SubscribersEmailCountsController.php
1 month ago
SubscribersRepository.php
1 month ago
TrackingConsentController.php
1 month ago
index.php
3 years ago
BulkActionController.php
262 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Subscribers; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\SegmentEntity; |
| 9 | use MailPoet\Entities\StatisticsUnsubscribeEntity; |
| 10 | use MailPoet\Entities\SubscriberEntity; |
| 11 | use MailPoet\Entities\TagEntity; |
| 12 | use MailPoet\Listing\ListingDefinition; |
| 13 | use MailPoet\Segments\SegmentsRepository; |
| 14 | use MailPoet\Statistics\Track\Unsubscribes; |
| 15 | use MailPoet\Tags\TagRepository; |
| 16 | |
| 17 | /** |
| 18 | * Centralized bulk-action dispatcher used by the REST endpoint at |
| 19 | * `mailpoet/v1/subscribers/bulk-action`. Keeping the per-action branch + |
| 20 | * reference-data resolution in one place keeps the REST endpoint a thin |
| 21 | * HTTP adapter. |
| 22 | */ |
| 23 | class BulkActionController { |
| 24 | public const ACTION_TRASH = 'trash'; |
| 25 | public const ACTION_RESTORE = 'restore'; |
| 26 | public const ACTION_DELETE = 'delete'; |
| 27 | public const ACTION_UNSUBSCRIBE = 'unsubscribe'; |
| 28 | public const ACTION_MOVE_TO_LIST = 'moveToList'; |
| 29 | public const ACTION_ADD_TO_LIST = 'addToList'; |
| 30 | public const ACTION_REMOVE_FROM_LIST = 'removeFromList'; |
| 31 | public const ACTION_REMOVE_FROM_ALL_LISTS = 'removeFromAllLists'; |
| 32 | public const ACTION_ADD_TAG = 'addTag'; |
| 33 | public const ACTION_REMOVE_TAG = 'removeTag'; |
| 34 | |
| 35 | public const SUPPORTED_ACTIONS = [ |
| 36 | self::ACTION_TRASH, |
| 37 | self::ACTION_RESTORE, |
| 38 | self::ACTION_DELETE, |
| 39 | self::ACTION_UNSUBSCRIBE, |
| 40 | self::ACTION_MOVE_TO_LIST, |
| 41 | self::ACTION_ADD_TO_LIST, |
| 42 | self::ACTION_REMOVE_FROM_LIST, |
| 43 | self::ACTION_REMOVE_FROM_ALL_LISTS, |
| 44 | self::ACTION_ADD_TAG, |
| 45 | self::ACTION_REMOVE_TAG, |
| 46 | ]; |
| 47 | |
| 48 | private const ACTIONS_REQUIRING_SEGMENT = [ |
| 49 | self::ACTION_MOVE_TO_LIST, |
| 50 | self::ACTION_ADD_TO_LIST, |
| 51 | self::ACTION_REMOVE_FROM_LIST, |
| 52 | ]; |
| 53 | |
| 54 | private const ACTIONS_REQUIRING_TAG = [ |
| 55 | self::ACTION_ADD_TAG, |
| 56 | self::ACTION_REMOVE_TAG, |
| 57 | ]; |
| 58 | |
| 59 | /** @var SubscriberListingRepository */ |
| 60 | private $subscriberListingRepository; |
| 61 | |
| 62 | /** @var SubscribersRepository */ |
| 63 | private $subscribersRepository; |
| 64 | |
| 65 | /** @var SegmentsRepository */ |
| 66 | private $segmentsRepository; |
| 67 | |
| 68 | /** @var TagRepository */ |
| 69 | private $tagRepository; |
| 70 | |
| 71 | /** @var Unsubscribes */ |
| 72 | private $unsubscribesTracker; |
| 73 | |
| 74 | public function __construct( |
| 75 | SubscriberListingRepository $subscriberListingRepository, |
| 76 | SubscribersRepository $subscribersRepository, |
| 77 | SegmentsRepository $segmentsRepository, |
| 78 | TagRepository $tagRepository, |
| 79 | Unsubscribes $unsubscribesTracker |
| 80 | ) { |
| 81 | $this->subscriberListingRepository = $subscriberListingRepository; |
| 82 | $this->subscribersRepository = $subscribersRepository; |
| 83 | $this->segmentsRepository = $segmentsRepository; |
| 84 | $this->tagRepository = $tagRepository; |
| 85 | $this->unsubscribesTracker = $unsubscribesTracker; |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * @param array{segment_id?: int|string, tag_id?: int|string, trigger_automations?: bool} $data |
| 90 | * @return array{count: int, segment?: array{id: int, name: string}, tag?: array{id: int, name: string}} |
| 91 | * @throws BulkActionException |
| 92 | */ |
| 93 | public function execute(string $action, ListingDefinition $definition, array $data = []): array { |
| 94 | if (!in_array($action, self::SUPPORTED_ACTIONS, true)) { |
| 95 | throw new BulkActionException( |
| 96 | // translators: %s is the offending bulk-action name. |
| 97 | sprintf(__("Invalid bulk action '%s' provided.", 'mailpoet'), $action), |
| 98 | 'mailpoet_subscribers_invalid_bulk_action', |
| 99 | 400 |
| 100 | ); |
| 101 | } |
| 102 | |
| 103 | $segment = in_array($action, self::ACTIONS_REQUIRING_SEGMENT, true) || isset($data['segment_id']) |
| 104 | ? $this->resolveSegment($data) |
| 105 | : null; |
| 106 | $tag = in_array($action, self::ACTIONS_REQUIRING_TAG, true) || isset($data['tag_id']) |
| 107 | ? $this->resolveTag($data) |
| 108 | : null; |
| 109 | $skipHooks = !($data['trigger_automations'] ?? false); |
| 110 | |
| 111 | $ids = $this->subscriberListingRepository->getActionableIds($definition); |
| 112 | $count = $this->dispatch($action, $ids, $segment, $tag, $skipHooks); |
| 113 | |
| 114 | $result = ['count' => $count]; |
| 115 | if ($segment instanceof SegmentEntity) { |
| 116 | $result['segment'] = ['id' => (int)$segment->getId(), 'name' => (string)$segment->getName()]; |
| 117 | } |
| 118 | if ($tag instanceof TagEntity) { |
| 119 | $result['tag'] = ['id' => (int)$tag->getId(), 'name' => (string)$tag->getName()]; |
| 120 | } |
| 121 | return $result; |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * @param int[] $ids |
| 126 | */ |
| 127 | private function dispatch( |
| 128 | string $action, |
| 129 | array $ids, |
| 130 | ?SegmentEntity $segment, |
| 131 | ?TagEntity $tag, |
| 132 | bool $skipHooks |
| 133 | ): int { |
| 134 | switch ($action) { |
| 135 | case self::ACTION_TRASH: |
| 136 | return $this->subscribersRepository->bulkTrash($ids); |
| 137 | case self::ACTION_RESTORE: |
| 138 | return $this->subscribersRepository->bulkRestore($ids); |
| 139 | case self::ACTION_DELETE: |
| 140 | return $this->subscribersRepository->bulkDelete($ids); |
| 141 | case self::ACTION_REMOVE_FROM_ALL_LISTS: |
| 142 | return $this->subscribersRepository->bulkRemoveFromAllSegments($ids); |
| 143 | case self::ACTION_UNSUBSCRIBE: |
| 144 | $this->trackBulkUnsubscribe($ids); |
| 145 | return $this->subscribersRepository->bulkUnsubscribe($ids); |
| 146 | case self::ACTION_MOVE_TO_LIST: |
| 147 | return $this->subscribersRepository->bulkMoveToSegment( |
| 148 | $this->requireSegment($segment, $action), |
| 149 | $ids, |
| 150 | $skipHooks |
| 151 | ); |
| 152 | case self::ACTION_ADD_TO_LIST: |
| 153 | return $this->subscribersRepository->bulkAddToSegment( |
| 154 | $this->requireSegment($segment, $action), |
| 155 | $ids, |
| 156 | $skipHooks |
| 157 | ); |
| 158 | case self::ACTION_REMOVE_FROM_LIST: |
| 159 | return $this->subscribersRepository->bulkRemoveFromSegment($this->requireSegment($segment, $action), $ids); |
| 160 | case self::ACTION_ADD_TAG: |
| 161 | return $this->subscribersRepository->bulkAddTag($this->requireTag($tag, $action), $ids, $skipHooks); |
| 162 | case self::ACTION_REMOVE_TAG: |
| 163 | return $this->subscribersRepository->bulkRemoveTag($this->requireTag($tag, $action), $ids, $skipHooks); |
| 164 | default: |
| 165 | // Reachable only if SUPPORTED_ACTIONS and this switch drift out of sync. |
| 166 | throw new BulkActionException( |
| 167 | // translators: %s is the offending bulk-action name. |
| 168 | sprintf(__("Invalid bulk action '%s' provided.", 'mailpoet'), $action), |
| 169 | 'mailpoet_subscribers_invalid_bulk_action', |
| 170 | 400 |
| 171 | ); |
| 172 | } |
| 173 | } |
| 174 | |
| 175 | /** |
| 176 | * @param array{segment_id?: int|string} $data |
| 177 | */ |
| 178 | private function resolveSegment(array $data): SegmentEntity { |
| 179 | if (!isset($data['segment_id'])) { |
| 180 | throw new BulkActionException( |
| 181 | __('A list is required for this bulk action.', 'mailpoet'), |
| 182 | 'mailpoet_subscribers_missing_segment', |
| 183 | 400 |
| 184 | ); |
| 185 | } |
| 186 | $segment = $this->segmentsRepository->findOneById((int)$data['segment_id']); |
| 187 | if (!$segment instanceof SegmentEntity) { |
| 188 | throw new BulkActionException( |
| 189 | __('This list does not exist.', 'mailpoet'), |
| 190 | 'mailpoet_subscribers_segment_not_found', |
| 191 | 404 |
| 192 | ); |
| 193 | } |
| 194 | return $segment; |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * @param array{tag_id?: int|string} $data |
| 199 | */ |
| 200 | private function resolveTag(array $data): TagEntity { |
| 201 | if (!isset($data['tag_id'])) { |
| 202 | throw new BulkActionException( |
| 203 | __('A tag is required for this bulk action.', 'mailpoet'), |
| 204 | 'mailpoet_subscribers_missing_tag', |
| 205 | 400 |
| 206 | ); |
| 207 | } |
| 208 | $tag = $this->tagRepository->findOneById((int)$data['tag_id']); |
| 209 | if (!$tag instanceof TagEntity) { |
| 210 | throw new BulkActionException( |
| 211 | __('This tag does not exist.', 'mailpoet'), |
| 212 | 'mailpoet_subscribers_tag_not_found', |
| 213 | 404 |
| 214 | ); |
| 215 | } |
| 216 | return $tag; |
| 217 | } |
| 218 | |
| 219 | private function requireSegment(?SegmentEntity $segment, string $action): SegmentEntity { |
| 220 | if (!$segment instanceof SegmentEntity) { |
| 221 | throw new BulkActionException( |
| 222 | // translators: %s is the action name. |
| 223 | sprintf(__("The '%s' bulk action requires a list.", 'mailpoet'), $action), |
| 224 | 'mailpoet_subscribers_missing_segment', |
| 225 | 400 |
| 226 | ); |
| 227 | } |
| 228 | return $segment; |
| 229 | } |
| 230 | |
| 231 | private function requireTag(?TagEntity $tag, string $action): TagEntity { |
| 232 | if (!$tag instanceof TagEntity) { |
| 233 | throw new BulkActionException( |
| 234 | // translators: %s is the action name. |
| 235 | sprintf(__("The '%s' bulk action requires a tag.", 'mailpoet'), $action), |
| 236 | 'mailpoet_subscribers_missing_tag', |
| 237 | 400 |
| 238 | ); |
| 239 | } |
| 240 | return $tag; |
| 241 | } |
| 242 | |
| 243 | /** |
| 244 | * @param int[] $ids |
| 245 | */ |
| 246 | private function trackBulkUnsubscribe(array $ids): void { |
| 247 | if ($ids === []) return; |
| 248 | $subscribers = $this->subscribersRepository->findBy(['id' => $ids]); |
| 249 | foreach ($subscribers as $subscriber) { |
| 250 | if ( |
| 251 | $subscriber instanceof SubscriberEntity |
| 252 | && $subscriber->getStatus() !== SubscriberEntity::STATUS_UNSUBSCRIBED |
| 253 | ) { |
| 254 | $this->unsubscribesTracker->track( |
| 255 | (int)$subscriber->getId(), |
| 256 | StatisticsUnsubscribeEntity::SOURCE_ADMINISTRATOR |
| 257 | ); |
| 258 | } |
| 259 | } |
| 260 | } |
| 261 | } |
| 262 |