← All changes | backend/src/Services/Notification/NotificationService.php +257 -57 1.1 → 1.5 View file →

		@@ -4,8 +4,9 @@
4	4
5	5	use IvyForms\Common\Exceptions\InvalidArgumentException;
6	6	use IvyForms\Common\Exceptions\NotFoundException;
7	7	use IvyForms\Common\Exceptions\QueryExecutionException;
	8	+use IvyForms\Common\Sanitizer\HtmlSanitizer;
8	9	use IvyForms\Common\Sanitizer\Sanitizer;
9	10	use IvyForms\Entity\Notification\Notification;
10	11	use IvyForms\Factory\Notification\NotificationFactory;
11	12	use IvyForms\Repository\Notification\NotificationRepositoryInterface;
		@@ -13,8 +14,11 @@
13	14	use IvyForms\Services\Media\ImageService;
14	15	use IvyForms\Services\Translations\BackendStrings;
15	16	use IvyForms\Services\Mailer\MailerService;
16	17
	18	+/**
	19	+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
	20	+ */
17	21	class NotificationService
18	22	{
19	23	private NotificationRepositoryInterface $notificationRepository;
20	24	private ImageService $imageService;
		@@ -131,22 +135,12 @@
131	135	*
132	136	* @param int $formId
133	137	*
134	138	* @return array<Notification>
135		- *
136		- * @throws NotFoundException If no notifications are found
137	139	*/
138	140	public function getNotificationsByFormId(int $formId): array
139	141	{
140		- $notification = $this->notificationRepository->getAllById($formId);
141		-
142		- if (!$notification) {
143		- throw new NotFoundException(
144		- BackendStrings::getExceptionStrings()['notification_not_found']
145		- );
146		- }
147		-
148		- return $notification;
	142	+ return $this->notificationRepository->getAllById($formId);
149	143	}
150	144
151	145	/**
152	146	* Get active notifications by form ID.
		@@ -279,10 +273,10 @@
279	273	MailerService $mailerService,
280	274	array $fieldLabels = []
281	275	): bool {
282	276	$activeNotifications = $this->getActiveNotificationsByFormId($formId);
283		- $logicFormFields = $formFields;
284	277	$exceptionStrings = BackendStrings::getExceptionStrings();
	278	+
285	279	foreach ($activeNotifications as $notification) {
286	280	if (empty($notification->getNotificationContact()->getReceiver())) {
287	281	continue;
288	282	}
		@@ -291,9 +285,9 @@
291	285	'ivyforms/notification/should_send',
292	286	true,
293	287	$notification->getSmartLogic(),
294	288	$submissionData,
295		- $logicFormFields,
	289	+ $formFields,
296	290	$notification,
297	291	$formId
298	292	);
299	293
		@@ -300,73 +294,234 @@
300	294	if (!$shouldSend) {
301	295	continue;
302	296	}
303	297
304		- // Resolve sender and receiver
305		- $sender = $this->resolveAddress(
306		- $notification->getNotificationContact()->getSender(),
	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,
307	346	$fieldData,
308	347	$generalData,
309		- $fieldLabels
310		- );
	348	+ $fieldLabels,
	349	+ $exceptionStrings
	350	+ )
	351	+ ) {
	352	+ return false;
	353	+ }
311	354
312		- $receiver = $this->resolveAddress(
313		- $notification->getNotificationContact()->getReceiver(),
314		- $fieldData,
315		- $generalData,
316		- $fieldLabels
	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
317	391	);
	392	+ return false;
	393	+ }
318	394
319		- // Build subject and sanitized message
320		- $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(
321	408	$notification->getSubject(),
322	409	$fieldData,
323	410	$generalData,
324	411	$fieldLabels,
325	412	$notification
326		- );
327		-
328		- $safeMessage = $this->buildSafeMessage(
	413	+ )
	414	+ );
	415	+ $notification->setMessage(
	416	+ $this->buildSafeMessage(
329	417	$notification->getMessage(),
330	418	$fieldData,
331	419	$generalData,
332	420	$fieldLabels,
333	421	$notification
334		- );
	422	+ )
	423	+ );
335	424
336		- // Resolve replyTo and validate; fallback to sender if empty
337		- $replyTo = $this->resolveAddress(
338		- $notification->getNotificationContact()->getReplyTo(),
339		- $fieldData,
340		- $generalData,
341		- $fieldLabels
342		- );
343		- if (empty($replyTo) && !empty($sender)) {
344		- $replyTo = $sender;
345		- }
	425	+ return true;
	426	+ }
346	427
347		- if (empty($sender) || empty($receiver)) {
348		- error_log(
349		- $exceptionStrings['error_log_invalid_email'] . $sender . ' ' . $receiver
350		- );
351		- return false;
352		- }
	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	+ );
353	451
354		- // Apply resolved values back to the notification
355		- $notification->getNotificationContact()->setSender($sender);
356		- $notification->getNotificationContact()->setReceiver($receiver);
357		- $notification->getNotificationContact()->setReplyTo($replyTo);
358		- $notification->setSubject($subject);
359		- $notification->setMessage($safeMessage);
	452	+ if ($sent) {
	453	+ return;
	454	+ }
360	455
361		- // Send notification
362		- $sent = $mailerService->sendEmail($notification, $submissionData);
363		- if (!$sent) {
364		- 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;
365	519	}
	520	+ $paths[] = $path;
366	521	}
367	522
368		- return true;
	523	+ return $paths;
369	524	}
370	525
371	526	/**
372	527	* Resolve an email address template that may contain placeholders
		@@ -380,8 +535,12 @@
380	535	* @return string
381	536	*/
382	537	private function resolveAddress(string $template, array $fieldData, array $generalData, array $fieldLabels): string
383	538	{
	539	+ if (Sanitizer::containsEmailHeaderInjection($template)) {
	540	+ return '';
	541	+ }
	542	+
384	543	$rawReplaced = PlaceholderService::replacePlaceholders(
385	544	$template,
386	545	$fieldData,
387	546	$generalData,
		@@ -387,8 +546,12 @@
387	546	$generalData,
388	547	$fieldLabels
389	548	);
390	549
	550	+ if (Sanitizer::containsEmailHeaderInjection($rawReplaced)) {
	551	+ return '';
	552	+ }
	553	+
391	554	$emailCandidate = $rawReplaced;
392	555	if (preg_match('/<([^>]+)>/', $rawReplaced, $match)) {
393	556	$emailCandidate = trim($match[1]);
394	557	}
		@@ -396,8 +559,45 @@
396	559	return Sanitizer::isValidEmail($emailCandidate) ? $rawReplaced : '';
397	560	}
398	561
399	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	+ /**
400	600	* Build a sanitized HTML message from a template with placeholders.
401	601	*
402	602	* @param string $template
403	603	* @param array<string,mixed> $fieldData
		@@ -420,7 +620,7 @@
420	620	$fieldLabels,
421	621	$notification
422	622	);
423	623
424		- return Sanitizer::sanitizeHtmlContent($message);
	624	+ return HtmlSanitizer::sanitizeHtmlContent($message);
425	625	}
426	626	}