AdminUserSubscription.php
3 months ago
Blacklist.php
1 year ago
Comment.php
3 months ago
Form.php
1 month ago
Manage.php
1 month ago
ManageSubscriptionFormRenderer.php
3 months ago
Pages.php
1 month ago
Registration.php
3 months ago
SubscriptionUrlFactory.php
3 months ago
Throttling.php
3 months ago
index.php
3 years ago
Manage.php
494 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Subscription; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\CustomFields\CustomFieldsRepository; |
| 9 | use MailPoet\Entities\SegmentEntity; |
| 10 | use MailPoet\Entities\StatisticsUnsubscribeEntity; |
| 11 | use MailPoet\Entities\SubscriberEntity; |
| 12 | use MailPoet\Entities\SubscriberSegmentEntity; |
| 13 | use MailPoet\Form\Util\FieldNameObfuscator; |
| 14 | use MailPoet\Newsletter\Scheduler\WelcomeScheduler; |
| 15 | use MailPoet\Segments\SegmentsRepository; |
| 16 | use MailPoet\Statistics\Track\Unsubscribes; |
| 17 | use MailPoet\Subscribers\LinkTokens; |
| 18 | use MailPoet\Subscribers\NewSubscriberNotificationMailer; |
| 19 | use MailPoet\Subscribers\SubscriberSaveController; |
| 20 | use MailPoet\Subscribers\SubscriberSegmentRepository; |
| 21 | use MailPoet\Subscribers\SubscribersRepository; |
| 22 | use MailPoet\Util\Url as UrlHelper; |
| 23 | use MailPoetVendor\Doctrine\DBAL\ArrayParameterType; |
| 24 | |
| 25 | class Manage { |
| 26 | |
| 27 | /** @var UrlHelper */ |
| 28 | private $urlHelper; |
| 29 | |
| 30 | /** @var FieldNameObfuscator */ |
| 31 | private $fieldNameObfuscator; |
| 32 | |
| 33 | /** @var LinkTokens */ |
| 34 | private $linkTokens; |
| 35 | |
| 36 | /** @var Unsubscribes */ |
| 37 | private $unsubscribesTracker; |
| 38 | |
| 39 | /** @var NewSubscriberNotificationMailer */ |
| 40 | private $newSubscriberNotificationMailer; |
| 41 | |
| 42 | /** @var WelcomeScheduler */ |
| 43 | private $welcomeScheduler; |
| 44 | |
| 45 | /** @var CustomFieldsRepository */ |
| 46 | private $customFieldsRepository; |
| 47 | |
| 48 | /** @var SegmentsRepository */ |
| 49 | private $segmentsRepository; |
| 50 | |
| 51 | /** @var SubscribersRepository */ |
| 52 | private $subscribersRepository; |
| 53 | |
| 54 | /** @var SubscriberSegmentRepository */ |
| 55 | private $subscriberSegmentRepository; |
| 56 | |
| 57 | /** @var SubscriberSaveController */ |
| 58 | private $subscriberSaveController; |
| 59 | |
| 60 | public function __construct( |
| 61 | UrlHelper $urlHelper, |
| 62 | FieldNameObfuscator $fieldNameObfuscator, |
| 63 | LinkTokens $linkTokens, |
| 64 | Unsubscribes $unsubscribesTracker, |
| 65 | NewSubscriberNotificationMailer $newSubscriberNotificationMailer, |
| 66 | WelcomeScheduler $welcomeScheduler, |
| 67 | CustomFieldsRepository $customFieldsRepository, |
| 68 | SegmentsRepository $segmentsRepository, |
| 69 | SubscribersRepository $subscribersRepository, |
| 70 | SubscriberSegmentRepository $subscriberSegmentRepository, |
| 71 | SubscriberSaveController $subscriberSaveController |
| 72 | ) { |
| 73 | $this->urlHelper = $urlHelper; |
| 74 | $this->fieldNameObfuscator = $fieldNameObfuscator; |
| 75 | $this->unsubscribesTracker = $unsubscribesTracker; |
| 76 | $this->linkTokens = $linkTokens; |
| 77 | $this->newSubscriberNotificationMailer = $newSubscriberNotificationMailer; |
| 78 | $this->welcomeScheduler = $welcomeScheduler; |
| 79 | $this->segmentsRepository = $segmentsRepository; |
| 80 | $this->subscribersRepository = $subscribersRepository; |
| 81 | $this->subscriberSegmentRepository = $subscriberSegmentRepository; |
| 82 | $this->customFieldsRepository = $customFieldsRepository; |
| 83 | $this->subscriberSaveController = $subscriberSaveController; |
| 84 | } |
| 85 | |
| 86 | public function onSave() { |
| 87 | $action = (isset($_POST['action']) && is_string($_POST['action']) ? sanitize_text_field(wp_unslash($_POST['action'])) : ''); |
| 88 | $token = (isset($_POST['token']) && is_string($_POST['token']) ? sanitize_text_field(wp_unslash($_POST['token'])) : ''); |
| 89 | |
| 90 | if ($action !== 'mailpoet_subscription_update' || empty($_POST['data'])) { |
| 91 | $this->urlHelper->redirectBack(); |
| 92 | return; |
| 93 | } |
| 94 | |
| 95 | //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized |
| 96 | $subscriberData = $this->fieldNameObfuscator->deobfuscateFormPayload(wp_unslash((array)$_POST['data'])); |
| 97 | $subscriberData = $this->sanitizeFormValue($subscriberData); |
| 98 | if (!is_array($subscriberData)) { |
| 99 | $subscriberData = []; |
| 100 | } |
| 101 | if ($this->hasInvalidStatus($subscriberData) || $this->hasMalformedLegacySegmentIds($subscriberData)) { |
| 102 | $this->urlHelper->redirectBack(['error' => true]); |
| 103 | return; |
| 104 | } |
| 105 | |
| 106 | $result = ['error' => true]; |
| 107 | if (!empty($subscriberData['email'])) { |
| 108 | $subscriber = $this->subscribersRepository->findOneBy(['email' => $subscriberData['email']]); |
| 109 | |
| 110 | if ($subscriber && $this->linkTokens->verifyToken($subscriber, $token)) { |
| 111 | if ($subscriberData['email'] !== Pages::DEMO_EMAIL) { |
| 112 | $previousStatus = $subscriber->getStatus(); |
| 113 | $shouldTrackUnsubscribe = ( |
| 114 | ($subscriberData['status'] ?? '') === SubscriberEntity::STATUS_UNSUBSCRIBED |
| 115 | && $subscriber instanceof SubscriberEntity |
| 116 | && $subscriber->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED |
| 117 | ); |
| 118 | $subscriber = $this->subscriberSaveController->createOrUpdate($this->filterToEditableFields($subscriberData), $subscriber); |
| 119 | if ($shouldTrackUnsubscribe) { |
| 120 | $this->unsubscribesTracker->track( |
| 121 | (int)$subscriber->getId(), |
| 122 | StatisticsUnsubscribeEntity::SOURCE_MANAGE |
| 123 | ); |
| 124 | } |
| 125 | $this->subscriberSaveController->updateCustomFields($this->filterOutEmptyMandatoryFields($subscriberData), $subscriber); |
| 126 | $this->updateSubscriptions( |
| 127 | $subscriber, |
| 128 | $subscriberData, |
| 129 | $previousStatus !== SubscriberEntity::STATUS_SUBSCRIBED |
| 130 | && $subscriber->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED |
| 131 | ); |
| 132 | } |
| 133 | $result = ['success' => true]; |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | $this->urlHelper->redirectBack($result); |
| 138 | } |
| 139 | |
| 140 | private function updateSubscriptions( |
| 141 | SubscriberEntity $subscriber, |
| 142 | array $subscriberData, |
| 143 | bool $isGlobalResubscribe |
| 144 | ): void { |
| 145 | if ($subscriber->getStatus() !== SubscriberEntity::STATUS_SUBSCRIBED) { |
| 146 | return; |
| 147 | } |
| 148 | |
| 149 | if (array_key_exists('segment_choices', $subscriberData)) { |
| 150 | $this->updateSubscriptionsFromSegmentChoices( |
| 151 | $subscriber, |
| 152 | $subscriberData['segment_choices'], |
| 153 | $isGlobalResubscribe |
| 154 | ); |
| 155 | return; |
| 156 | } |
| 157 | |
| 158 | $segmentsIds = $this->getLegacySegmentIds($subscriberData); |
| 159 | $legacySegmentIds = $segmentsIds; |
| 160 | $segments = $this->getVisibleDefaultManageSegmentsByIds($legacySegmentIds); |
| 161 | $segmentsIds = array_map('intval', array_keys($segments)); |
| 162 | if ($legacySegmentIds && !$segmentsIds) { |
| 163 | return; |
| 164 | } |
| 165 | |
| 166 | // Unsubscribe from all other segments already subscribed to |
| 167 | // but don't change disallowed segments |
| 168 | foreach ($subscriber->getSubscriberSegments() as $subscriberSegment) { |
| 169 | $segment = $subscriberSegment->getSegment(); |
| 170 | if (!$segment) { |
| 171 | continue; |
| 172 | } |
| 173 | |
| 174 | if (!$this->isVisibleDefaultManageSegment($segment)) { |
| 175 | continue; |
| 176 | } |
| 177 | if (!in_array((int)$segment->getId(), $segmentsIds, true)) { |
| 178 | $this->subscriberSegmentRepository->createOrUpdate( |
| 179 | $subscriber, |
| 180 | $segment, |
| 181 | SubscriberEntity::STATUS_UNSUBSCRIBED, |
| 182 | false, |
| 183 | true |
| 184 | ); |
| 185 | } |
| 186 | } |
| 187 | |
| 188 | $currentSegmentIds = $this->getCurrentSubscribedSegmentIds($subscriber); |
| 189 | $newSegmentIds = array_diff($segmentsIds, $currentSegmentIds); |
| 190 | |
| 191 | foreach ($segmentsIds as $segmentId) { |
| 192 | $this->subscriberSegmentRepository->createOrUpdate( |
| 193 | $subscriber, |
| 194 | $segments[$segmentId], |
| 195 | SubscriberEntity::STATUS_SUBSCRIBED, |
| 196 | false, |
| 197 | true |
| 198 | ); |
| 199 | } |
| 200 | |
| 201 | $this->subscribersRepository->recalculateSegmentsCount([(int)$subscriber->getId()]); |
| 202 | |
| 203 | $this->sendNotificationsForNewSegments( |
| 204 | $subscriber, |
| 205 | $isGlobalResubscribe ? $this->getCurrentSubscribedSegmentIds($subscriber) : $newSegmentIds |
| 206 | ); |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * @param mixed $segmentChoices |
| 211 | */ |
| 212 | private function updateSubscriptionsFromSegmentChoices( |
| 213 | SubscriberEntity $subscriber, |
| 214 | $segmentChoices, |
| 215 | bool $isGlobalResubscribe |
| 216 | ): void { |
| 217 | $choices = $this->getSegmentChoices($segmentChoices); |
| 218 | $segments = $this->getVisibleDefaultManageSegmentsByIds(array_keys($choices)); |
| 219 | $subscribeIds = []; |
| 220 | $unsubscribeIds = []; |
| 221 | |
| 222 | foreach ($choices as $segmentId => $choice) { |
| 223 | if (!isset($segments[$segmentId])) { |
| 224 | continue; |
| 225 | } |
| 226 | if ($choice === 'subscribed') { |
| 227 | $subscribeIds[] = $segmentId; |
| 228 | } elseif ($choice === 'unsubscribed') { |
| 229 | $unsubscribeIds[] = $segmentId; |
| 230 | } |
| 231 | } |
| 232 | |
| 233 | $currentSegmentIds = $this->getCurrentSubscribedSegmentIds($subscriber); |
| 234 | |
| 235 | foreach ($unsubscribeIds as $segmentId) { |
| 236 | $this->subscriberSegmentRepository->createOrUpdate( |
| 237 | $subscriber, |
| 238 | $segments[$segmentId], |
| 239 | SubscriberEntity::STATUS_UNSUBSCRIBED, |
| 240 | false, |
| 241 | true |
| 242 | ); |
| 243 | } |
| 244 | |
| 245 | foreach ($subscribeIds as $segmentId) { |
| 246 | $this->subscriberSegmentRepository->createOrUpdate( |
| 247 | $subscriber, |
| 248 | $segments[$segmentId], |
| 249 | SubscriberEntity::STATUS_SUBSCRIBED, |
| 250 | false, |
| 251 | true |
| 252 | ); |
| 253 | } |
| 254 | |
| 255 | $this->subscribersRepository->recalculateSegmentsCount([(int)$subscriber->getId()]); |
| 256 | |
| 257 | $this->sendNotificationsForNewSegments( |
| 258 | $subscriber, |
| 259 | $isGlobalResubscribe |
| 260 | ? $this->getCurrentSubscribedSegmentIds($subscriber) |
| 261 | : array_diff($subscribeIds, $currentSegmentIds) |
| 262 | ); |
| 263 | } |
| 264 | |
| 265 | /** |
| 266 | * The manage-subscription form only edits the subscriber's name, email and |
| 267 | * global status. Subscription choices and custom fields are handled |
| 268 | * separately. Keep only those fields when saving the subscriber so any other |
| 269 | * submitted key is ignored. `status` is already validated by |
| 270 | * hasInvalidStatus(). |
| 271 | */ |
| 272 | private function filterToEditableFields(array $subscriberData): array { |
| 273 | return array_intersect_key( |
| 274 | $subscriberData, |
| 275 | array_flip(['email', 'first_name', 'last_name', 'status']) |
| 276 | ); |
| 277 | } |
| 278 | |
| 279 | private function hasInvalidStatus(array $subscriberData): bool { |
| 280 | if (!isset($subscriberData['status'])) { |
| 281 | return false; |
| 282 | } |
| 283 | return !in_array($subscriberData['status'], [ |
| 284 | SubscriberEntity::STATUS_SUBSCRIBED, |
| 285 | SubscriberEntity::STATUS_UNSUBSCRIBED, |
| 286 | ], true); |
| 287 | } |
| 288 | |
| 289 | /** |
| 290 | * @param mixed $value |
| 291 | * @return mixed |
| 292 | */ |
| 293 | private function sanitizeFormValue($value, ?string $parentKey = null) { |
| 294 | if (is_array($value)) { |
| 295 | $sanitized = []; |
| 296 | foreach ($value as $key => $item) { |
| 297 | $sanitizedKey = $parentKey === 'segment_choices' ? $key : sanitize_text_field((string)$key); |
| 298 | $childParentKey = $parentKey === 'segments' ? 'segments' : (string)$sanitizedKey; |
| 299 | $sanitized[$sanitizedKey] = $this->sanitizeFormValue($item, $childParentKey); |
| 300 | } |
| 301 | return $sanitized; |
| 302 | } |
| 303 | if ($parentKey === 'segments') { |
| 304 | return is_scalar($value) ? (string)$value : ''; |
| 305 | } |
| 306 | return sanitize_text_field(is_scalar($value) ? (string)$value : ''); |
| 307 | } |
| 308 | |
| 309 | /** |
| 310 | * @return int[] |
| 311 | */ |
| 312 | private function getLegacySegmentIds(array $subscriberData): array { |
| 313 | if (!isset($subscriberData['segments']) || !is_array($subscriberData['segments'])) { |
| 314 | return []; |
| 315 | } |
| 316 | |
| 317 | $segmentIds = []; |
| 318 | foreach ($subscriberData['segments'] as $segmentId) { |
| 319 | $segmentId = $this->normalizePositiveIntegerId($segmentId); |
| 320 | if ($segmentId === null) { |
| 321 | continue; |
| 322 | } |
| 323 | $segmentIds[] = $segmentId; |
| 324 | } |
| 325 | return array_values(array_unique($segmentIds)); |
| 326 | } |
| 327 | |
| 328 | private function hasMalformedLegacySegmentIds(array $subscriberData): bool { |
| 329 | if (!isset($subscriberData['segments'])) { |
| 330 | return false; |
| 331 | } |
| 332 | if ($subscriberData['segments'] === '') { |
| 333 | return false; |
| 334 | } |
| 335 | if (!is_array($subscriberData['segments'])) { |
| 336 | return true; |
| 337 | } |
| 338 | |
| 339 | foreach ($subscriberData['segments'] as $segmentId) { |
| 340 | if ($segmentId === '') { |
| 341 | continue; |
| 342 | } |
| 343 | if ($this->normalizePositiveIntegerId($segmentId) === null) { |
| 344 | return true; |
| 345 | } |
| 346 | } |
| 347 | return false; |
| 348 | } |
| 349 | |
| 350 | /** |
| 351 | * @param mixed $segmentChoices |
| 352 | * @return array<int, string> |
| 353 | */ |
| 354 | private function getSegmentChoices($segmentChoices): array { |
| 355 | if (!is_array($segmentChoices)) { |
| 356 | return []; |
| 357 | } |
| 358 | |
| 359 | $choices = []; |
| 360 | foreach ($segmentChoices as $segmentId => $choice) { |
| 361 | $segmentId = $this->normalizePositiveIntegerId($segmentId); |
| 362 | if ($segmentId === null || !is_string($choice)) { |
| 363 | continue; |
| 364 | } |
| 365 | if (!in_array($choice, ['subscribed', 'unsubscribed'], true)) { |
| 366 | continue; |
| 367 | } |
| 368 | $choices[$segmentId] = $choice; |
| 369 | } |
| 370 | return $choices; |
| 371 | } |
| 372 | |
| 373 | /** |
| 374 | * @param mixed $segmentId |
| 375 | */ |
| 376 | private function normalizePositiveIntegerId($segmentId): ?int { |
| 377 | if (is_int($segmentId)) { |
| 378 | return $segmentId > 0 ? $segmentId : null; |
| 379 | } |
| 380 | if (!is_string($segmentId) || $segmentId === '' || $segmentId[0] === '0' || !ctype_digit($segmentId)) { |
| 381 | return null; |
| 382 | } |
| 383 | $normalized = (int)$segmentId; |
| 384 | if ((string)$normalized !== $segmentId || $normalized <= 0) { |
| 385 | return null; |
| 386 | } |
| 387 | return $normalized; |
| 388 | } |
| 389 | |
| 390 | /** |
| 391 | * @param int[] $segmentIds |
| 392 | * @return array<int, SegmentEntity> |
| 393 | */ |
| 394 | private function getVisibleDefaultManageSegmentsByIds(array $segmentIds): array { |
| 395 | $segmentIds = array_values(array_unique(array_filter(array_map('intval', $segmentIds)))); |
| 396 | if (!$segmentIds) { |
| 397 | return []; |
| 398 | } |
| 399 | |
| 400 | $segments = $this->segmentsRepository->createQueryBuilder('s') |
| 401 | ->where('s.id IN (:ids)') |
| 402 | ->andWhere('s.type = :type') |
| 403 | ->andWhere('s.deletedAt IS NULL') |
| 404 | ->andWhere('s.displayInManageSubscriptionPage = :displayInManageSubscriptionPage') |
| 405 | ->setParameter('ids', $segmentIds, ArrayParameterType::INTEGER) |
| 406 | ->setParameter('type', SegmentEntity::TYPE_DEFAULT) |
| 407 | ->setParameter('displayInManageSubscriptionPage', true) |
| 408 | ->getQuery() |
| 409 | ->getResult(); |
| 410 | |
| 411 | $segmentsMap = []; |
| 412 | foreach ($segments as $segment) { |
| 413 | if ($segment instanceof SegmentEntity && $segment->getId()) { |
| 414 | $segmentsMap[(int)$segment->getId()] = $segment; |
| 415 | } |
| 416 | } |
| 417 | return $segmentsMap; |
| 418 | } |
| 419 | |
| 420 | private function isVisibleDefaultManageSegment(SegmentEntity $segment): bool { |
| 421 | return ( |
| 422 | $segment->getType() === SegmentEntity::TYPE_DEFAULT |
| 423 | && $segment->getDeletedAt() === null |
| 424 | && $segment->getDisplayInManageSubscriptionPage() |
| 425 | ); |
| 426 | } |
| 427 | |
| 428 | /** |
| 429 | * @return int[] |
| 430 | */ |
| 431 | private function getCurrentSubscribedSegmentIds(SubscriberEntity $subscriber): array { |
| 432 | $subscriberSegments = $this->subscriberSegmentRepository->findBy([ |
| 433 | 'status' => SubscriberEntity::STATUS_SUBSCRIBED, |
| 434 | 'subscriber' => $subscriber, |
| 435 | ]); |
| 436 | return array_values(array_filter(array_map(function (SubscriberSegmentEntity $subscriberSegment): ?int { |
| 437 | $segment = $subscriberSegment->getSegment(); |
| 438 | return $segment ? (int)$segment->getId() : null; |
| 439 | }, $subscriberSegments))); |
| 440 | } |
| 441 | |
| 442 | /** |
| 443 | * @param int[] $newSegmentIds |
| 444 | */ |
| 445 | private function sendNotificationsForNewSegments(SubscriberEntity $subscriber, array $newSegmentIds): void { |
| 446 | $newSegmentIds = array_values(array_unique(array_map('intval', $newSegmentIds))); |
| 447 | if ($subscriber->getStatus() !== SubscriberEntity::STATUS_SUBSCRIBED || !$newSegmentIds) { |
| 448 | return; |
| 449 | } |
| 450 | |
| 451 | $newSegments = $this->segmentsRepository->findByIds($newSegmentIds); |
| 452 | $this->newSubscriberNotificationMailer->send($subscriber, $newSegments); |
| 453 | $this->welcomeScheduler->scheduleSubscriberWelcomeNotification( |
| 454 | $subscriber->getId(), |
| 455 | $newSegmentIds |
| 456 | ); |
| 457 | } |
| 458 | |
| 459 | private function filterOutEmptyMandatoryFields(array $subscriberData): array { |
| 460 | $mandatory = $this->getMandatory(); |
| 461 | foreach ($mandatory as $name) { |
| 462 | if (!isset($subscriberData[$name])) { |
| 463 | continue; |
| 464 | } |
| 465 | if (is_array($subscriberData[$name]) && count(array_filter($subscriberData[$name])) === 0) { |
| 466 | unset($subscriberData[$name]); |
| 467 | } |
| 468 | if (is_string($subscriberData[$name]) && strlen(trim($subscriberData[$name])) === 0) { |
| 469 | unset($subscriberData[$name]); |
| 470 | } |
| 471 | } |
| 472 | return $subscriberData; |
| 473 | } |
| 474 | |
| 475 | /** |
| 476 | * @return string[] |
| 477 | */ |
| 478 | private function getMandatory(): array { |
| 479 | $mandatory = []; |
| 480 | $requiredCustomFields = $this->customFieldsRepository->findAllActive(); |
| 481 | foreach ($requiredCustomFields as $customField) { |
| 482 | $params = $customField->getParams(); |
| 483 | if ( |
| 484 | is_array($params) |
| 485 | && isset($params['required']) |
| 486 | && $params['required'] |
| 487 | ) { |
| 488 | $mandatory[] = 'cf_' . $customField->getId(); |
| 489 | } |
| 490 | } |
| 491 | return $mandatory; |
| 492 | } |
| 493 | } |
| 494 |