Analytics.php
1 week ago
AutomatedLatestContent.php
2 months ago
AutomaticEmails.php
3 years ago
Captcha.php
1 year ago
Coupons.php
2 years ago
CustomFields.php
3 months ago
DynamicProducts.php
1 year ago
DynamicSegments.php
2 months ago
FeatureFlags.php
3 years ago
Forms.php
2 months ago
Help.php
1 year ago
ImportExport.php
3 months ago
Mailer.php
1 year ago
NewsletterLinks.php
2 months ago
NewsletterTemplates.php
3 months ago
Newsletters.php
2 months ago
Premium.php
11 months ago
RedirectResponse.php
1 year ago
Segments.php
1 week ago
SendingQueue.php
3 months ago
Services.php
6 months ago
Settings.php
3 months ago
Setup.php
1 year ago
StatisticsExport.php
3 months ago
SubscriberStats.php
2 months ago
Subscribers.php
2 months ago
Tags.php
3 years ago
UserFlags.php
2 years ago
WoocommerceProductVariations.php
2 months ago
WoocommerceSettings.php
3 years ago
index.php
3 years ago
Segments.php
307 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\API\JSON\v1; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use Exception; |
| 9 | use MailPoet\API\JSON\Endpoint as APIEndpoint; |
| 10 | use MailPoet\API\JSON\Error as APIError; |
| 11 | use MailPoet\API\JSON\Response; |
| 12 | use MailPoet\API\JSON\ResponseBuilders\SegmentsResponseBuilder; |
| 13 | use MailPoet\Config\AccessControl; |
| 14 | use MailPoet\ConflictException; |
| 15 | use MailPoet\Cron\CronWorkerScheduler; |
| 16 | use MailPoet\Cron\Workers\WooCommerceSync; |
| 17 | use MailPoet\Doctrine\Validator\ValidationException; |
| 18 | use MailPoet\Entities\SegmentEntity; |
| 19 | use MailPoet\Entities\SubscriberEntity; |
| 20 | use MailPoet\Form\FormsRepository; |
| 21 | use MailPoet\Newsletter\Segment\NewsletterSegmentRepository; |
| 22 | use MailPoet\Segments\SegmentSaveController; |
| 23 | use MailPoet\Segments\SegmentsRepository; |
| 24 | use MailPoet\Segments\SegmentSubscribersRepository; |
| 25 | use MailPoet\Segments\WP; |
| 26 | use MailPoet\Subscribers\SubscribersRepository; |
| 27 | use Throwable; |
| 28 | |
| 29 | class Segments extends APIEndpoint { |
| 30 | public $permissions = [ |
| 31 | 'global' => AccessControl::PERMISSION_MANAGE_SEGMENTS, |
| 32 | ]; |
| 33 | |
| 34 | /** @var SegmentsRepository */ |
| 35 | private $segmentsRepository; |
| 36 | |
| 37 | /** @var SegmentsResponseBuilder */ |
| 38 | private $segmentsResponseBuilder; |
| 39 | |
| 40 | /** @var SegmentSaveController */ |
| 41 | private $segmentSavecontroller; |
| 42 | |
| 43 | /** @var SubscribersRepository */ |
| 44 | private $subscribersRepository; |
| 45 | |
| 46 | /** @var WP */ |
| 47 | private $wpSegment; |
| 48 | |
| 49 | /** @var NewsletterSegmentRepository */ |
| 50 | private $newsletterSegmentRepository; |
| 51 | |
| 52 | /** @var CronWorkerScheduler */ |
| 53 | private $cronWorkerScheduler; |
| 54 | |
| 55 | /** @var FormsRepository */ |
| 56 | private $formsRepository; |
| 57 | |
| 58 | /** @var SegmentSubscribersRepository */ |
| 59 | private $segmentSubscribersRepository; |
| 60 | |
| 61 | public function __construct( |
| 62 | SegmentsRepository $segmentsRepository, |
| 63 | SegmentsResponseBuilder $segmentsResponseBuilder, |
| 64 | SegmentSaveController $segmentSavecontroller, |
| 65 | SegmentSubscribersRepository $segmentSubscribersRepository, |
| 66 | SubscribersRepository $subscribersRepository, |
| 67 | WP $wpSegment, |
| 68 | NewsletterSegmentRepository $newsletterSegmentRepository, |
| 69 | CronWorkerScheduler $cronWorkerScheduler, |
| 70 | FormsRepository $formsRepository |
| 71 | ) { |
| 72 | $this->segmentsRepository = $segmentsRepository; |
| 73 | $this->segmentsResponseBuilder = $segmentsResponseBuilder; |
| 74 | $this->segmentSavecontroller = $segmentSavecontroller; |
| 75 | $this->subscribersRepository = $subscribersRepository; |
| 76 | $this->wpSegment = $wpSegment; |
| 77 | $this->newsletterSegmentRepository = $newsletterSegmentRepository; |
| 78 | $this->cronWorkerScheduler = $cronWorkerScheduler; |
| 79 | $this->formsRepository = $formsRepository; |
| 80 | $this->segmentSubscribersRepository = $segmentSubscribersRepository; |
| 81 | } |
| 82 | |
| 83 | public function get($data = []) { |
| 84 | $id = (isset($data['id']) ? (int)$data['id'] : false); |
| 85 | $segment = $this->segmentsRepository->findOneById($id); |
| 86 | if ($segment instanceof SegmentEntity) { |
| 87 | return $this->successResponse($this->segmentsResponseBuilder->build($segment)); |
| 88 | } else { |
| 89 | return $this->errorResponse([ |
| 90 | APIError::NOT_FOUND => __('This list does not exist.', 'mailpoet'), |
| 91 | ]); |
| 92 | } |
| 93 | } |
| 94 | |
| 95 | public function save($data = []) { |
| 96 | try { |
| 97 | $data['name'] = isset($data['name']) ? sanitize_text_field($data['name']) : ''; |
| 98 | $data['description'] = isset($data['description']) ? sanitize_textarea_field($data['description']) : ''; |
| 99 | if (array_key_exists('public_description', $data)) { |
| 100 | $data['public_description'] = sanitize_textarea_field((string)$data['public_description']); |
| 101 | } |
| 102 | $segment = $this->segmentSavecontroller->save($data); |
| 103 | } catch (ValidationException $exception) { |
| 104 | return $this->badRequest([ |
| 105 | APIError::BAD_REQUEST => __('Please specify a name.', 'mailpoet'), |
| 106 | ]); |
| 107 | } catch (ConflictException $exception) { |
| 108 | return $this->badRequest([ |
| 109 | APIError::BAD_REQUEST => __('Another record already exists. Please specify a different "name".', 'mailpoet'), |
| 110 | ]); |
| 111 | } |
| 112 | $response = $this->segmentsResponseBuilder->build($segment); |
| 113 | return $this->successResponse($response); |
| 114 | } |
| 115 | |
| 116 | public function restore($data = []) { |
| 117 | $segment = $this->getSegment($data); |
| 118 | if ($segment instanceof SegmentEntity) { |
| 119 | if (!$this->isTrashOrRestoreAllowed($segment)) { |
| 120 | return $this->errorResponse([ |
| 121 | APIError::FORBIDDEN => __('This list cannot be moved to trash.', 'mailpoet'), |
| 122 | ]); |
| 123 | } |
| 124 | // When the segment is of type WP_USERS we want to restore all its subscribers |
| 125 | if ($segment->getType() === SegmentEntity::TYPE_WP_USERS) { |
| 126 | $subscribers = $this->subscribersRepository->findBySegment((int)$segment->getId()); |
| 127 | $subscriberIds = array_map(function (SubscriberEntity $subscriberEntity): int { |
| 128 | return (int)$subscriberEntity->getId(); |
| 129 | }, $subscribers); |
| 130 | $this->subscribersRepository->bulkRestore($subscriberIds); |
| 131 | } |
| 132 | |
| 133 | $this->segmentsRepository->bulkRestore([$segment->getId()], $segment->getType()); |
| 134 | $this->segmentsRepository->refresh($segment); |
| 135 | return $this->successResponse( |
| 136 | $this->segmentsResponseBuilder->build($segment), |
| 137 | ['count' => 1] |
| 138 | ); |
| 139 | } else { |
| 140 | return $this->errorResponse([ |
| 141 | APIError::NOT_FOUND => __('This list does not exist.', 'mailpoet'), |
| 142 | ]); |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | public function trash($data = []) { |
| 147 | $segment = $this->getSegment($data); |
| 148 | if (!$segment instanceof SegmentEntity) { |
| 149 | |
| 150 | return $this->errorResponse([ |
| 151 | APIError::NOT_FOUND => __('This list does not exist.', 'mailpoet'), |
| 152 | ]); |
| 153 | } |
| 154 | |
| 155 | if (!$this->isTrashOrRestoreAllowed($segment)) { |
| 156 | return $this->errorResponse([ |
| 157 | APIError::FORBIDDEN => __('This list cannot be moved to trash.', 'mailpoet'), |
| 158 | ]); |
| 159 | } |
| 160 | |
| 161 | $activelyUsedNewslettersSubjects = $this->newsletterSegmentRepository->getSubjectsOfActivelyUsedEmailsForSegments([$segment->getId()]); |
| 162 | if (isset($activelyUsedNewslettersSubjects[$segment->getId()])) { |
| 163 | return $this->badRequest([ |
| 164 | APIError::BAD_REQUEST => str_replace( |
| 165 | '%1$s', |
| 166 | "'" . join("', '", $activelyUsedNewslettersSubjects[$segment->getId()]) . "'", |
| 167 | // translators: %1$s is a comma-separated list of emails for which the segment is used. |
| 168 | _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') |
| 169 | ), |
| 170 | ]); |
| 171 | } |
| 172 | |
| 173 | $activelyUsedFormNames = $this->formsRepository->getNamesOfFormsForSegments(); |
| 174 | if (isset($activelyUsedFormNames[$segment->getId()])) { |
| 175 | return $this->badRequest([ |
| 176 | APIError::BAD_REQUEST => str_replace( |
| 177 | '%1$s', |
| 178 | "'" . join("', '", $activelyUsedFormNames[$segment->getId()]) . "'", |
| 179 | // translators: %1$s is a comma-separated list of forms for which the segment is used. |
| 180 | _nx( |
| 181 | 'List cannot be deleted because it’s used for %1$s form', |
| 182 | 'List cannot be deleted because it’s used for %1$s forms', |
| 183 | count($activelyUsedFormNames[$segment->getId()]), |
| 184 | 'Alert shown when trying to delete segment, when it is assigned to a form.', |
| 185 | 'mailpoet' |
| 186 | ) |
| 187 | ), |
| 188 | ]); |
| 189 | } |
| 190 | |
| 191 | // When the segment is of type WP_USERS we want to trash all subscribers who aren't subscribed in another list |
| 192 | if ($segment->getType() === SegmentEntity::TYPE_WP_USERS) { |
| 193 | $subscribers = $this->subscribersRepository->findExclusiveSubscribersBySegment((int)$segment->getId()); |
| 194 | $subscriberIds = array_map(function (SubscriberEntity $subscriberEntity): int { |
| 195 | return (int)$subscriberEntity->getId(); |
| 196 | }, $subscribers); |
| 197 | $this->subscribersRepository->bulkTrash($subscriberIds); |
| 198 | } |
| 199 | |
| 200 | $this->segmentsRepository->doTrash([$segment->getId()], $segment->getType()); |
| 201 | $this->segmentsRepository->refresh($segment); |
| 202 | return $this->successResponse( |
| 203 | $this->segmentsResponseBuilder->build($segment), |
| 204 | ['count' => 1] |
| 205 | ); |
| 206 | } |
| 207 | |
| 208 | public function delete($data = []) { |
| 209 | $segment = $this->getSegment($data); |
| 210 | if ($segment instanceof SegmentEntity) { |
| 211 | $this->segmentsRepository->bulkDelete([$segment->getId()]); |
| 212 | return $this->successResponse(null, ['count' => 1]); |
| 213 | } else { |
| 214 | return $this->errorResponse([ |
| 215 | APIError::NOT_FOUND => __('This list does not exist.', 'mailpoet'), |
| 216 | ]); |
| 217 | } |
| 218 | } |
| 219 | |
| 220 | public function duplicate($data = []) { |
| 221 | $segment = $this->getSegment($data); |
| 222 | |
| 223 | if ($segment instanceof SegmentEntity) { |
| 224 | try { |
| 225 | $duplicate = $this->segmentSavecontroller->duplicate($segment); |
| 226 | } catch (Exception $e) { |
| 227 | return $this->errorResponse([ |
| 228 | APIError::UNKNOWN => __('Duplicating of segment failed.', 'mailpoet'), |
| 229 | ], [], Response::STATUS_UNKNOWN); |
| 230 | } |
| 231 | return $this->successResponse( |
| 232 | $this->segmentsResponseBuilder->build($duplicate), |
| 233 | ['count' => 1] |
| 234 | ); |
| 235 | } else { |
| 236 | return $this->errorResponse([ |
| 237 | APIError::NOT_FOUND => __('This list does not exist.', 'mailpoet'), |
| 238 | ]); |
| 239 | } |
| 240 | } |
| 241 | |
| 242 | public function synchronize($data) { |
| 243 | try { |
| 244 | if ($data['type'] === SegmentEntity::TYPE_WC_USERS) { |
| 245 | $this->cronWorkerScheduler->scheduleImmediatelyIfNotRunning(WooCommerceSync::TASK_TYPE); |
| 246 | } else { |
| 247 | $this->wpSegment->synchronizeUsers(); |
| 248 | } |
| 249 | } catch (\Exception $e) { |
| 250 | return $this->errorResponse([ |
| 251 | $e->getCode() => $e->getMessage(), |
| 252 | ]); |
| 253 | } |
| 254 | |
| 255 | return $this->successResponse(null); |
| 256 | } |
| 257 | |
| 258 | public function subscriberCount($data = []) { |
| 259 | $segmentIds = $data['segmentIds'] ?? []; |
| 260 | if (empty($segmentIds)) { |
| 261 | return $this->errorResponse([ |
| 262 | APIError::BAD_REQUEST => __('No segment IDs provided.', 'mailpoet'), |
| 263 | ]); |
| 264 | } |
| 265 | // filterSegmentId arrives as a string (it can come straight from a URL query |
| 266 | // param). Empty and 0 mean "no filter segment"; anything else must be a valid |
| 267 | // positive segment id, otherwise the count would be silently wrong. |
| 268 | $filterSegmentId = null; |
| 269 | if (!empty($data['filterSegmentId'])) { |
| 270 | $filterSegmentId = filter_var($data['filterSegmentId'], FILTER_VALIDATE_INT, ['options' => ['min_range' => 1]]); |
| 271 | if ($filterSegmentId === false) { |
| 272 | return $this->badRequest([ |
| 273 | APIError::BAD_REQUEST => __('Invalid filter segment.', 'mailpoet'), |
| 274 | ]); |
| 275 | } |
| 276 | } |
| 277 | $status = $data['status'] ?? SubscriberEntity::STATUS_SUBSCRIBED; |
| 278 | try { |
| 279 | $response['count'] = $this->segmentSubscribersRepository->getSubscribersCountBySegmentIds($segmentIds, $status, $filterSegmentId); |
| 280 | } catch (Throwable $e) { |
| 281 | return $this->errorResponse([ |
| 282 | APIError::UNKNOWN => __('The recipient count could not be calculated.', 'mailpoet'), |
| 283 | ], [], Response::STATUS_UNKNOWN); |
| 284 | } |
| 285 | |
| 286 | return $this->successResponse($response); |
| 287 | } |
| 288 | |
| 289 | private function isTrashOrRestoreAllowed(SegmentEntity $segment): bool { |
| 290 | $allowedSegmentTypes = [ |
| 291 | SegmentEntity::TYPE_DEFAULT, |
| 292 | SegmentEntity::TYPE_WP_USERS, |
| 293 | ]; |
| 294 | if (in_array($segment->getType(), $allowedSegmentTypes, true)) { |
| 295 | return true; |
| 296 | } |
| 297 | |
| 298 | return false; |
| 299 | } |
| 300 | |
| 301 | private function getSegment(array $data): ?SegmentEntity { |
| 302 | return isset($data['id']) |
| 303 | ? $this->segmentsRepository->findOneById((int)$data['id']) |
| 304 | : null; |
| 305 | } |
| 306 | } |
| 307 |