← All changes
|
backend/src/Services/Notification/NotificationService.php
+286
-65
0.9
→
1.5
View file →
| @@ -1,16 +1,12 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | namespace IvyForms\Services\Notification; |
| 4 | 4 | |
| 5 | -// phpcs:disable PSR1.Files.SideEffects | |
| 6 | -if (!defined('ABSPATH')) { | |
| 7 | - exit; // Exit if accessed directly | |
| 8 | -} | |
| 9 | - | |
| 10 | 5 | use IvyForms\Common\Exceptions\InvalidArgumentException; |
| 11 | 6 | use IvyForms\Common\Exceptions\NotFoundException; |
| 12 | 7 | use IvyForms\Common\Exceptions\QueryExecutionException; |
| 8 | +use IvyForms\Common\Sanitizer\HtmlSanitizer; | |
| 13 | 9 | use IvyForms\Common\Sanitizer\Sanitizer; |
| 14 | 10 | use IvyForms\Entity\Notification\Notification; |
| 15 | 11 | use IvyForms\Factory\Notification\NotificationFactory; |
| 16 | 12 | use IvyForms\Repository\Notification\NotificationRepositoryInterface; |
| @@ -18,8 +14,11 @@ | ||
| 18 | 14 | use IvyForms\Services\Media\ImageService; |
| 19 | 15 | use IvyForms\Services\Translations\BackendStrings; |
| 20 | 16 | use IvyForms\Services\Mailer\MailerService; |
| 21 | 17 | |
| 18 | +/** | |
| 19 | + * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) | |
| 20 | + */ | |
| 22 | 21 | class NotificationService |
| 23 | 22 | { |
| 24 | 23 | private NotificationRepositoryInterface $notificationRepository; |
| 25 | 24 | private ImageService $imageService; |
| @@ -136,22 +135,12 @@ | ||
| 136 | 135 | * |
| 137 | 136 | * @param int $formId |
| 138 | 137 | * |
| 139 | 138 | * @return array<Notification> |
| 140 | - * | |
| 141 | - * @throws NotFoundException If no notifications are found | |
| 142 | 139 | */ |
| 143 | 140 | public function getNotificationsByFormId(int $formId): array |
| 144 | 141 | { |
| 145 | - $notification = $this->notificationRepository->getAllById($formId); | |
| 146 | - | |
| 147 | - if (!$notification) { | |
| 148 | - throw new NotFoundException( | |
| 149 | - BackendStrings::getExceptionStrings()['notification_not_found'] | |
| 150 | - ); | |
| 151 | - } | |
| 152 | - | |
| 153 | - return $notification; | |
| 142 | + return $this->notificationRepository->getAllById($formId); | |
| 154 | 143 | } |
| 155 | 144 | |
| 156 | 145 | /** |
| 157 | 146 | * Get active notifications by form ID. |
| @@ -246,9 +235,13 @@ | ||
| 246 | 235 | 'receiver' => $adminEmail, |
| 247 | 236 | 'enabled' => 1, |
| 248 | 237 | 'subject' => $formName, |
| 249 | 238 | 'message' => '{{all_data}}', |
| 250 | - 'smartLogic' => 0, | |
| 239 | + 'smartLogic' => [ | |
| 240 | + 'enabled' => false, | |
| 241 | + 'match' => 'any', | |
| 242 | + 'rules' => [], | |
| 243 | + ], | |
| 251 | 244 | ]; |
| 252 | 245 | $notification = NotificationFactory::create($defaultNotification); |
| 253 | 246 | $notificationId = $this->createNotification($notification); |
| 254 | 247 | if (!$notificationId) { |
| @@ -263,8 +256,9 @@ | ||
| 263 | 256 | * Process notifications for the form. |
| 264 | 257 | * |
| 265 | 258 | * @param int $formId |
| 266 | 259 | * @param array<mixed> $submissionData |
| 260 | + * @param array<mixed> $formFields | |
| 267 | 261 | * @param array<string, mixed> $fieldData |
| 268 | 262 | * @param array<string, mixed> $generalData |
| 269 | 263 | * @param MailerService $mailerService |
| 270 | 264 | * @param array<string, string> $fieldLabels |
| @@ -272,8 +266,9 @@ | ||
| 272 | 266 | */ |
| 273 | 267 | public function processNotifications( |
| 274 | 268 | int $formId, |
| 275 | 269 | array $submissionData, |
| 270 | + array $formFields, | |
| 276 | 271 | array $fieldData, |
| 277 | 272 | array $generalData, |
| 278 | 273 | MailerService $mailerService, |
| 279 | 274 | array $fieldLabels = [] |
| @@ -279,76 +274,254 @@ | ||
| 279 | 274 | array $fieldLabels = [] |
| 280 | 275 | ): bool { |
| 281 | 276 | $activeNotifications = $this->getActiveNotificationsByFormId($formId); |
| 282 | 277 | $exceptionStrings = BackendStrings::getExceptionStrings(); |
| 278 | + | |
| 283 | 279 | foreach ($activeNotifications as $notification) { |
| 284 | - if (empty($notification->getReceiver())) { | |
| 280 | + if (empty($notification->getNotificationContact()->getReceiver())) { | |
| 285 | 281 | continue; |
| 286 | 282 | } |
| 287 | 283 | |
| 288 | - // Resolve sender and receiver | |
| 289 | - $sender = $this->resolveAddress( | |
| 290 | - $notification->getSender(), | |
| 291 | - $fieldData, | |
| 292 | - $generalData, | |
| 293 | - $fieldLabels | |
| 284 | + $shouldSend = apply_filters( | |
| 285 | + 'ivyforms/notification/should_send', | |
| 286 | + true, | |
| 287 | + $notification->getSmartLogic(), | |
| 288 | + $submissionData, | |
| 289 | + $formFields, | |
| 290 | + $notification, | |
| 291 | + $formId | |
| 294 | 292 | ); |
| 295 | 293 | |
| 296 | - $receiver = $this->resolveAddress( | |
| 297 | - $notification->getReceiver(), | |
| 294 | + if (!$shouldSend) { | |
| 295 | + continue; | |
| 296 | + } | |
| 297 | + | |
| 298 | + if ( | |
| 299 | + !$this->dispatchNotificationEmail( | |
| 300 | + $notification, | |
| 301 | + $formId, | |
| 302 | + $submissionData, | |
| 303 | + $formFields, | |
| 304 | + $fieldData, | |
| 305 | + $generalData, | |
| 306 | + $mailerService, | |
| 307 | + $fieldLabels, | |
| 308 | + $exceptionStrings | |
| 309 | + ) | |
| 310 | + ) { | |
| 311 | + return false; | |
| 312 | + } | |
| 313 | + } | |
| 314 | + | |
| 315 | + return true; | |
| 316 | + } | |
| 317 | + | |
| 318 | + /** | |
| 319 | + * Resolve placeholders, apply attachments, and send one notification email. | |
| 320 | + * | |
| 321 | + * @param Notification $notification | |
| 322 | + * @param int $formId | |
| 323 | + * @param array<mixed> $submissionData | |
| 324 | + * @param array<mixed> $formFields | |
| 325 | + * @param array<string, mixed> $fieldData | |
| 326 | + * @param array<string, mixed> $generalData | |
| 327 | + * @param MailerService $mailerService | |
| 328 | + * @param array<string, string> $fieldLabels | |
| 329 | + * @param array<string, string> $exceptionStrings | |
| 330 | + * @return bool False when sender/receiver are invalid; true otherwise (send failure is logged) | |
| 331 | + */ | |
| 332 | + private function dispatchNotificationEmail( | |
| 333 | + Notification $notification, | |
| 334 | + int $formId, | |
| 335 | + array $submissionData, | |
| 336 | + array $formFields, | |
| 337 | + array $fieldData, | |
| 338 | + array $generalData, | |
| 339 | + MailerService $mailerService, | |
| 340 | + array $fieldLabels, | |
| 341 | + array $exceptionStrings | |
| 342 | + ): bool { | |
| 343 | + if ( | |
| 344 | + !$this->hydrateNotificationForSend( | |
| 345 | + $notification, | |
| 298 | 346 | $fieldData, |
| 299 | 347 | $generalData, |
| 300 | - $fieldLabels | |
| 348 | + $fieldLabels, | |
| 349 | + $exceptionStrings | |
| 350 | + ) | |
| 351 | + ) { | |
| 352 | + return false; | |
| 353 | + } | |
| 354 | + | |
| 355 | + $this->sendHydratedNotificationEmail( | |
| 356 | + $notification, | |
| 357 | + $formId, | |
| 358 | + $submissionData, | |
| 359 | + $formFields, | |
| 360 | + $fieldData, | |
| 361 | + $mailerService, | |
| 362 | + $exceptionStrings | |
| 363 | + ); | |
| 364 | + | |
| 365 | + return true; | |
| 366 | + } | |
| 367 | + | |
| 368 | + /** | |
| 369 | + * Resolve and apply sender/receiver/replyTo/cc/bcc/subject/message onto the notification. | |
| 370 | + * | |
| 371 | + * @param Notification $notification | |
| 372 | + * @param array<string, mixed> $fieldData | |
| 373 | + * @param array<string, mixed> $generalData | |
| 374 | + * @param array<string, string> $fieldLabels | |
| 375 | + * @param array<string, string> $exceptionStrings | |
| 376 | + */ | |
| 377 | + private function hydrateNotificationForSend( | |
| 378 | + Notification $notification, | |
| 379 | + array $fieldData, | |
| 380 | + array $generalData, | |
| 381 | + array $fieldLabels, | |
| 382 | + array $exceptionStrings | |
| 383 | + ): bool { | |
| 384 | + $contact = $notification->getNotificationContact(); | |
| 385 | + $sender = $this->resolveAddress($contact->getSender(), $fieldData, $generalData, $fieldLabels); | |
| 386 | + $receiver = $this->resolveAddress($contact->getReceiver(), $fieldData, $generalData, $fieldLabels); | |
| 387 | + | |
| 388 | + if ($sender === '' || $receiver === '') { | |
| 389 | + error_log( | |
| 390 | + $exceptionStrings['error_log_invalid_email'] . $sender . ' ' . $receiver | |
| 301 | 391 | ); |
| 392 | + return false; | |
| 393 | + } | |
| 302 | 394 | |
| 303 | - // Build subject and sanitized message | |
| 304 | - $subject = PlaceholderService::replacePlaceholders( | |
| 395 | + $contact->setSender($sender); | |
| 396 | + $contact->setReceiver($receiver); | |
| 397 | + $contact->setReplyTo( | |
| 398 | + $this->resolveReplyTo($contact->getReplyTo(), $sender, $fieldData, $generalData, $fieldLabels) | |
| 399 | + ); | |
| 400 | + $contact->setCc( | |
| 401 | + $this->resolveAddressList($contact->getCc(), $fieldData, $generalData, $fieldLabels) | |
| 402 | + ); | |
| 403 | + $contact->setBcc( | |
| 404 | + $this->resolveAddressList($contact->getBcc(), $fieldData, $generalData, $fieldLabels) | |
| 405 | + ); | |
| 406 | + $notification->setSubject( | |
| 407 | + PlaceholderService::replacePlaceholders( | |
| 305 | 408 | $notification->getSubject(), |
| 306 | 409 | $fieldData, |
| 307 | 410 | $generalData, |
| 308 | - $fieldLabels | |
| 309 | - ); | |
| 310 | - | |
| 311 | - $safeMessage = $this->buildSafeMessage( | |
| 411 | + $fieldLabels, | |
| 412 | + $notification | |
| 413 | + ) | |
| 414 | + ); | |
| 415 | + $notification->setMessage( | |
| 416 | + $this->buildSafeMessage( | |
| 312 | 417 | $notification->getMessage(), |
| 313 | 418 | $fieldData, |
| 314 | 419 | $generalData, |
| 315 | - $fieldLabels | |
| 316 | - ); | |
| 420 | + $fieldLabels, | |
| 421 | + $notification | |
| 422 | + ) | |
| 423 | + ); | |
| 317 | 424 | |
| 318 | - // Resolve replyTo and validate; fallback to sender if empty | |
| 319 | - $replyTo = $this->resolveAddress( | |
| 320 | - $notification->getReplyTo(), | |
| 321 | - $fieldData, | |
| 322 | - $generalData, | |
| 323 | - $fieldLabels | |
| 324 | - ); | |
| 325 | - if (empty($replyTo) && !empty($sender)) { | |
| 326 | - $replyTo = $sender; | |
| 327 | - } | |
| 425 | + return true; | |
| 426 | + } | |
| 328 | 427 | |
| 329 | - if (empty($sender) || empty($receiver)) { | |
| 330 | - error_log( | |
| 331 | - $exceptionStrings['error_log_invalid_email'] . $sender . ' ' . $receiver | |
| 332 | - ); | |
| 333 | - return false; | |
| 334 | - } | |
| 428 | + /** | |
| 429 | + * @param Notification $notification | |
| 430 | + * @param int $formId | |
| 431 | + * @param array<mixed> $submissionData | |
| 432 | + * @param array<mixed> $formFields | |
| 433 | + * @param array<string, mixed> $fieldData | |
| 434 | + * @param MailerService $mailerService | |
| 435 | + * @param array<string, string> $exceptionStrings | |
| 436 | + */ | |
| 437 | + private function sendHydratedNotificationEmail( | |
| 438 | + Notification $notification, | |
| 439 | + int $formId, | |
| 440 | + array $submissionData, | |
| 441 | + array $formFields, | |
| 442 | + array $fieldData, | |
| 443 | + MailerService $mailerService, | |
| 444 | + array $exceptionStrings | |
| 445 | + ): void { | |
| 446 | + $sent = $mailerService->sendEmail( | |
| 447 | + $notification, | |
| 448 | + $submissionData, | |
| 449 | + $this->resolveEmailAttachments($notification, $submissionData, $formFields, $fieldData) | |
| 450 | + ); | |
| 335 | 451 | |
| 336 | - // Apply resolved values back to the notification | |
| 337 | - $notification->setSender($sender); | |
| 338 | - $notification->setReceiver($receiver); | |
| 339 | - $notification->setReplyTo($replyTo); | |
| 340 | - $notification->setSubject($subject); | |
| 341 | - $notification->setMessage($safeMessage); | |
| 452 | + if ($sent) { | |
| 453 | + return; | |
| 454 | + } | |
| 342 | 455 | |
| 343 | - // Send notification | |
| 344 | - $sent = $mailerService->sendEmail($notification, $submissionData); | |
| 345 | - if (!$sent) { | |
| 346 | - error_log($exceptionStrings['error_log_failed_send'] . ' ' . $formId); | |
| 456 | + error_log($exceptionStrings['error_log_failed_send'] . ' ' . $formId); | |
| 457 | + } | |
| 458 | + | |
| 459 | + /** | |
| 460 | + * @param string $template | |
| 461 | + * @param string $sender | |
| 462 | + * @param array<string, mixed> $fieldData | |
| 463 | + * @param array<string, mixed> $generalData | |
| 464 | + * @param array<string, string> $fieldLabels | |
| 465 | + */ | |
| 466 | + private function resolveReplyTo( | |
| 467 | + string $template, | |
| 468 | + string $sender, | |
| 469 | + array $fieldData, | |
| 470 | + array $generalData, | |
| 471 | + array $fieldLabels | |
| 472 | + ): string { | |
| 473 | + $replyTo = $this->resolveAddress($template, $fieldData, $generalData, $fieldLabels); | |
| 474 | + | |
| 475 | + return $replyTo !== '' ? $replyTo : $sender; | |
| 476 | + } | |
| 477 | + | |
| 478 | + /** | |
| 479 | + * @param Notification $notification | |
| 480 | + * @param array<mixed> $submissionData | |
| 481 | + * @param array<mixed> $formFields | |
| 482 | + * @param array<string, mixed> $fieldData | |
| 483 | + * @return string[] | |
| 484 | + */ | |
| 485 | + private function resolveEmailAttachments( | |
| 486 | + Notification $notification, | |
| 487 | + array $submissionData, | |
| 488 | + array $formFields, | |
| 489 | + array $fieldData | |
| 490 | + ): array { | |
| 491 | + /** | |
| 492 | + * Local file paths to attach to the notification email (Pro file attachments). | |
| 493 | + * | |
| 494 | + * @since 1.2.0 | |
| 495 | + * | |
| 496 | + * @param mixed $attachments | |
| 497 | + * @param \IvyForms\Entity\Notification\Notification $notification | |
| 498 | + * @param array<string, mixed> $submissionData | |
| 499 | + * @param array<int, mixed> $formFields | |
| 500 | + * @param array<string, mixed> $fieldData | |
| 501 | + */ | |
| 502 | + $attachments = apply_filters( | |
| 503 | + 'ivyforms/notification/email_attachments', | |
| 504 | + [], | |
| 505 | + $notification, | |
| 506 | + $submissionData, | |
| 507 | + $formFields, | |
| 508 | + $fieldData | |
| 509 | + ); | |
| 510 | + | |
| 511 | + if (!is_array($attachments)) { | |
| 512 | + return []; | |
| 513 | + } | |
| 514 | + | |
| 515 | + $paths = []; | |
| 516 | + foreach ($attachments as $path) { | |
| 517 | + if (!is_string($path) || $path === '') { | |
| 518 | + continue; | |
| 347 | 519 | } |
| 520 | + $paths[] = $path; | |
| 348 | 521 | } |
| 349 | 522 | |
| 350 | - return true; | |
| 523 | + return $paths; | |
| 351 | 524 | } |
| 352 | 525 | |
| 353 | 526 | /** |
| 354 | 527 | * Resolve an email address template that may contain placeholders |
| @@ -362,8 +535,12 @@ | ||
| 362 | 535 | * @return string |
| 363 | 536 | */ |
| 364 | 537 | private function resolveAddress(string $template, array $fieldData, array $generalData, array $fieldLabels): string |
| 365 | 538 | { |
| 539 | + if (Sanitizer::containsEmailHeaderInjection($template)) { | |
| 540 | + return ''; | |
| 541 | + } | |
| 542 | + | |
| 366 | 543 | $rawReplaced = PlaceholderService::replacePlaceholders( |
| 367 | 544 | $template, |
| 368 | 545 | $fieldData, |
| 369 | 546 | $generalData, |
| @@ -369,8 +546,12 @@ | ||
| 369 | 546 | $generalData, |
| 370 | 547 | $fieldLabels |
| 371 | 548 | ); |
| 372 | 549 | |
| 550 | + if (Sanitizer::containsEmailHeaderInjection($rawReplaced)) { | |
| 551 | + return ''; | |
| 552 | + } | |
| 553 | + | |
| 373 | 554 | $emailCandidate = $rawReplaced; |
| 374 | 555 | if (preg_match('/<([^>]+)>/', $rawReplaced, $match)) { |
| 375 | 556 | $emailCandidate = trim($match[1]); |
| 376 | 557 | } |
| @@ -378,8 +559,45 @@ | ||
| 378 | 559 | return Sanitizer::isValidEmail($emailCandidate) ? $rawReplaced : ''; |
| 379 | 560 | } |
| 380 | 561 | |
| 381 | 562 | /** |
| 563 | + * Resolve a comma-separated list of email address templates. | |
| 564 | + * | |
| 565 | + * @param string $template | |
| 566 | + * @param array<string,mixed> $fieldData | |
| 567 | + * @param array<string,mixed> $generalData | |
| 568 | + * @param array<string,string> $fieldLabels | |
| 569 | + * @return string | |
| 570 | + */ | |
| 571 | + private function resolveAddressList( | |
| 572 | + string $template, | |
| 573 | + array $fieldData, | |
| 574 | + array $generalData, | |
| 575 | + array $fieldLabels | |
| 576 | + ): string { | |
| 577 | + $template = trim($template); | |
| 578 | + if ($template === '') { | |
| 579 | + return ''; | |
| 580 | + } | |
| 581 | + | |
| 582 | + $parts = array_map('trim', explode(',', $template)); | |
| 583 | + $resolved = []; | |
| 584 | + | |
| 585 | + foreach ($parts as $part) { | |
| 586 | + if ($part === '' || Sanitizer::containsEmailHeaderInjection($part)) { | |
| 587 | + continue; | |
| 588 | + } | |
| 589 | + | |
| 590 | + $address = $this->resolveAddress($part, $fieldData, $generalData, $fieldLabels); | |
| 591 | + if ($address !== '') { | |
| 592 | + $resolved[] = $address; | |
| 593 | + } | |
| 594 | + } | |
| 595 | + | |
| 596 | + return implode(', ', $resolved); | |
| 597 | + } | |
| 598 | + | |
| 599 | + /** | |
| 382 | 600 | * Build a sanitized HTML message from a template with placeholders. |
| 383 | 601 | * |
| 384 | 602 | * @param string $template |
| 385 | 603 | * @param array<string,mixed> $fieldData |
| @@ -384,8 +602,9 @@ | ||
| 384 | 602 | * @param string $template |
| 385 | 603 | * @param array<string,mixed> $fieldData |
| 386 | 604 | * @param array<string,mixed> $generalData |
| 387 | 605 | * @param array<string,string> $fieldLabels |
| 606 | + * @param Notification $notification | |
| 388 | 607 | * @return string |
| 389 | 608 | */ |
| 390 | 609 | private function buildSafeMessage( |
| 391 | 610 | string $template, |
| @@ -390,16 +609,18 @@ | ||
| 390 | 609 | private function buildSafeMessage( |
| 391 | 610 | string $template, |
| 392 | 611 | array $fieldData, |
| 393 | 612 | array $generalData, |
| 394 | - array $fieldLabels | |
| 613 | + array $fieldLabels, | |
| 614 | + Notification $notification | |
| 395 | 615 | ): string { |
| 396 | 616 | $message = PlaceholderService::replacePlaceholders( |
| 397 | 617 | $template, |
| 398 | 618 | $fieldData, |
| 399 | 619 | $generalData, |
| 400 | - $fieldLabels | |
| 620 | + $fieldLabels, | |
| 621 | + $notification | |
| 401 | 622 | ); |
| 402 | 623 | |
| 403 | - return Sanitizer::sanitizeHtmlContent($message); | |
| 624 | + return HtmlSanitizer::sanitizeHtmlContent($message); | |
| 404 | 625 | } |
| 405 | 626 | } |