mail tracker

app/Providers/AppServiceProvider.php

@@ -2,6 +2,9 @@
 
 namespace App\Providers;
 
+use App\Support\EnsureMailTrackerHtml;
+use Illuminate\Mail\Events\MessageSending;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Facades\Vite;
 use jdavidbakr\MailTracker\MailTracker;
@@ -35,6 +38,10 @@ class AppServiceProvider extends ServiceProvider
     \App\Models\Segnalazione::observe(\App\Observers\SegnalazioneObserver::class);
     MailTracker::useSentEmailModel(\App\Models\SentEmail::class);
 
+    // Dopo il listener del package: il package salva l'HTML *prima* dei tracker
+    // e con MIME nested / HTML enormi può non iniettare pixel e link.
+    Event::listen(MessageSending::class, EnsureMailTrackerHtml::class);
+
     // InviaNotificaSegnalazione è registrato da Laravel tramite event discovery (app/Listeners).
     // Non usare qui Event::listen(...): verrebbe eseguito due handle() per ogni NuovaSegnalazione.
   }

app/Support/EnsureMailTrackerHtml.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace App\Support;
+
+use Illuminate\Mail\Events\MessageSending;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\URL;
+use jdavidbakr\MailTracker\MailTracker;
+use Symfony\Component\Mime\Email;
+
+/**
+ * Dopo Mail Tracker: assicura pixel/link nel MIME inviato e salva
+ * quell'HTML nel log (il package memorizza il body *prima* dei tracker).
+ */
+final class EnsureMailTrackerHtml
+{
+    public function handle(MessageSending $event): void
+    {
+        $message = $event->message;
+        if (! $message instanceof Email) {
+            return;
+        }
+
+        $hash = $message->getHeaders()->get('X-Mailer-Hash')?->getBody();
+        if (! is_string($hash) || $hash === '') {
+            return;
+        }
+
+        try {
+            $this->process($message, $hash);
+        } catch (\Throwable $e) {
+            Log::warning('EnsureMailTrackerHtml: '.$e->getMessage(), [
+                'exception' => $e,
+            ]);
+        }
+    }
+
+    private function process(Email $message, string $hash): void
+    {
+        $body = $message->getBody();
+        $html = MailTrackerHtml::extractHtml($body);
+        if (! is_string($html) || $html === '') {
+            return;
+        }
+
+        $updated = $html;
+
+        if (config('mail-tracker.inject-pixel') && ! MailTrackerHtml::hasUsablePixel($updated)) {
+            $updated = MailTrackerHtml::injectPixel($updated, $this->pixelTag($hash));
+        }
+
+        if (config('mail-tracker.track-links')) {
+            $updated = MailTrackerHtml::rewriteLinks($updated, function (string $url) use ($hash) {
+                return URL::signedRoute('mailTracker_n', [
+                    'l' => $url,
+                    'h' => $hash,
+                ]);
+            });
+        }
+
+        if ($updated !== $html && $body !== null) {
+            $replaced = MailTrackerHtml::replaceHtml($body, $updated, $message->getHtmlCharset());
+            if ($replaced !== null) {
+                $message->setBody($replaced);
+            }
+        }
+
+        $toStore = MailTrackerHtml::extractHtml($message->getBody()) ?? $updated;
+        $sent = MailTracker::sentEmailModel()->newQuery()->where('hash', $hash)->first();
+        if ($sent) {
+            $sent->fillContent($toStore, $hash);
+            $sent->save();
+        }
+    }
+
+    private function pixelTag(string $hash): string
+    {
+        $src = e(route('mailTracker_t', [$hash]));
+
+        return '<img src="'.$src.'" width="1" height="1" alt="" style="display:none;border:0;width:1px;height:1px;" />';
+    }
+}

app/Support/MailTrackerHtml.php

@@ -0,0 +1,168 @@
+<?php
+
+namespace App\Support;
+
+use Symfony\Component\Mime\Part\AbstractPart;
+use Symfony\Component\Mime\Part\Multipart\AlternativePart;
+use Symfony\Component\Mime\Part\Multipart\MixedPart;
+use Symfony\Component\Mime\Part\Multipart\RelatedPart;
+use Symfony\Component\Mime\Part\TextPart;
+
+/**
+ * Iniezione tracker senza la regex greedy del package (che con HTML enormi
+ * può fallire o appendere il pixel dopo </html>, invisibile ai client).
+ */
+final class MailTrackerHtml
+{
+    public static function htmlBeforeClosingTag(string $html): string
+    {
+        $end = stripos($html, '</html>');
+
+        return $end === false ? $html : substr($html, 0, $end);
+    }
+
+    public static function hasUsablePixel(string $html): bool
+    {
+        return str_contains(self::htmlBeforeClosingTag($html), '/email/t/');
+    }
+
+    public static function injectPixel(string $html, string $pixelTag): string
+    {
+        if (self::hasUsablePixel($html)) {
+            return $html;
+        }
+
+        $pos = strripos($html, '</body>');
+        if ($pos !== false) {
+            return substr($html, 0, $pos).$pixelTag.substr($html, $pos);
+        }
+
+        $end = strripos($html, '</html>');
+        if ($end !== false) {
+            return substr($html, 0, $end).$pixelTag.substr($html, $end);
+        }
+
+        return $html.$pixelTag;
+    }
+
+    /**
+     * @param  callable(string $url): string  $rewriteUrl
+     */
+    public static function rewriteLinks(string $html, callable $rewriteUrl): string
+    {
+        $rewritten = preg_replace_callback(
+            '/(<a\b[^>]*\bhref\s*=\s*")([^"]*)(")/i',
+            function (array $m) use ($rewriteUrl) {
+                $url = html_entity_decode(str_replace('&amp;', '&', $m[2]), ENT_QUOTES | ENT_HTML5, 'UTF-8');
+                if (self::shouldSkipLink($url)) {
+                    return $m[0];
+                }
+
+                return $m[1].$rewriteUrl($url).$m[3];
+            },
+            $html
+        );
+
+        return is_string($rewritten) ? $rewritten : $html;
+    }
+
+    public static function shouldSkipLink(string $url): bool
+    {
+        if ($url === '' || str_starts_with($url, '#')) {
+            return true;
+        }
+
+        $lower = strtolower($url);
+        if (
+            str_starts_with($lower, 'mailto:')
+            || str_starts_with($lower, 'tel:')
+            || str_starts_with($lower, 'javascript:')
+        ) {
+            return true;
+        }
+
+        return str_contains($url, '/email/n');
+    }
+
+    public static function extractHtml(?AbstractPart $part): ?string
+    {
+        if ($part === null) {
+            return null;
+        }
+
+        if ($part instanceof TextPart && $part->getMediaSubtype() === 'html') {
+            return $part->getBody();
+        }
+
+        if ($part instanceof AlternativePart || $part instanceof MixedPart || $part instanceof RelatedPart) {
+            foreach ($part->getParts() as $child) {
+                $html = self::extractHtml($child);
+                if ($html !== null) {
+                    return $html;
+                }
+            }
+        }
+
+        return null;
+    }
+
+    public static function replaceHtml(?AbstractPart $part, string $html, ?string $charset): ?AbstractPart
+    {
+        if ($part === null) {
+            return null;
+        }
+
+        if ($part instanceof TextPart && $part->getMediaSubtype() === 'html') {
+            return new TextPart($html, $charset, 'html', null);
+        }
+
+        if ($part instanceof AlternativePart || $part instanceof MixedPart || $part instanceof RelatedPart) {
+            $replaced = false;
+            $newParts = [];
+            foreach ($part->getParts() as $child) {
+                if (! $replaced) {
+                    $mapped = self::replaceHtml($child, $html, $charset);
+                    if ($mapped !== $child) {
+                        $replaced = true;
+                    }
+                    $newParts[] = $mapped ?? $child;
+                } else {
+                    $newParts[] = $child;
+                }
+            }
+
+            return $replaced ? self::rebuildMultipart($part, $newParts) : $part;
+        }
+
+        return $part;
+    }
+
+    /**
+     * @param  list<AbstractPart>  $newParts
+     */
+    private static function rebuildMultipart(AbstractPart $part, array $newParts): AbstractPart
+    {
+        if ($newParts === []) {
+            return $part;
+        }
+
+        if ($part instanceof RelatedPart) {
+            $main = array_shift($newParts);
+            if ($newParts === []) {
+                return $main;
+            }
+
+            return new RelatedPart($main, $newParts[0], ...array_slice($newParts, 1));
+        }
+
+        if ($part instanceof AlternativePart) {
+            return new AlternativePart(...$newParts);
+        }
+
+        if ($part instanceof MixedPart) {
+            return new MixedPart(...$newParts);
+        }
+
+        return $part;
+    }
+}

composer.json

@@ -11,6 +11,7 @@
   "require": {
     "php": "^8.2",
     "barryvdh/laravel-dompdf": "^3.1",
+    "cweagans/composer-patches": "^1.7",
     "elibyy/tcpdf-laravel": "^11.5",
     "imtigger/laravel-job-status": "^1.2",
     "jdavidbakr/mail-tracker": "^8.3",
@@ -78,13 +79,20 @@
   "extra": {
     "laravel": {
       "dont-discover": []
-    }
+    },
+    "patches": {
+      "jdavidbakr/mail-tracker": {
+        "Fix Response import in MailTrackerController (Laravel facade)": "patches/jdavidbakr-mail-tracker-response-facade.patch"
+      }
+    },
+    "composer-exit-on-patch-failure": true
   },
   "config": {
     "optimize-autoloader": true,
     "preferred-install": "dist",
     "sort-packages": true,
     "allow-plugins": {
+      "cweagans/composer-patches": true,
       "pestphp/pest-plugin": true,
       "php-http/discovery": true
     }

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "36ecee00ae097944ec3042aa231e6116",
+    "content-hash": "d4c6459f7ac996d75eb45ee96032efb8",
     "packages": [
         {
             "name": "aws/aws-crt-php",
@@ -556,6 +556,54 @@
             ],
             "time": "2024-11-12T16:29:46+00:00"
         },
+        {
+            "name": "cweagans/composer-patches",
+            "version": "1.7.3",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/cweagans/composer-patches.git",
+                "reference": "e190d4466fe2b103a55467dfa83fc2fecfcaf2db"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/cweagans/composer-patches/zipball/e190d4466fe2b103a55467dfa83fc2fecfcaf2db",
+                "reference": "e190d4466fe2b103a55467dfa83fc2fecfcaf2db",
+                "shasum": ""
+            },
+            "require": {
+                "composer-plugin-api": "^1.0 || ^2.0",
+                "php": ">=5.3.0"
+            },
+            "require-dev": {
+                "composer/composer": "~1.0 || ~2.0",
+                "phpunit/phpunit": "~4.6"
+            },
+            "type": "composer-plugin",
+            "extra": {
+                "class": "cweagans\\Composer\\Patches"
+            },
+            "autoload": {
+                "psr-4": {
+                    "cweagans\\Composer\\": "src"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "authors": [
+                {
+                    "name": "Cameron Eagans",
+                    "email": "me@cweagans.net"
+                }
+            ],
+            "description": "Provides a way to patch Composer packages.",
+            "support": {
+                "issues": "https://github.com/cweagans/composer-patches/issues",
+                "source": "https://github.com/cweagans/composer-patches/tree/1.7.3"
+            },
+            "time": "2022-12-20T22:53:13+00:00"
+        },
         {
             "name": "dasprid/enum",
             "version": "1.0.7",

patches/jdavidbakr-mail-tracker-response-facade.patch

@@ -0,0 +1,13 @@
+diff --git a/src/MailTrackerController.php b/src/MailTrackerController.php
+--- a/src/MailTrackerController.php
++++ b/src/MailTrackerController.php
+@@ -5,8 +5,8 @@
+ use Illuminate\Http\Request;
+ use Illuminate\Routing\Controller;
+ use Illuminate\Support\Facades\Event;
++use Illuminate\Support\Facades\Response;
+ use jdavidbakr\MailTracker\Events\ValidActionEvent;
+-use Response;
+ 
+ class MailTrackerController extends Controller
+ {

tests/Unit/MailTrackerHtmlTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Tests\Unit;
+
+use App\Support\MailTrackerHtml;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mime\Part\Multipart\AlternativePart;
+use Symfony\Component\Mime\Part\Multipart\MixedPart;
+use Symfony\Component\Mime\Part\Multipart\RelatedPart;
+use Symfony\Component\Mime\Part\TextPart;
+
+class MailTrackerHtmlTest extends TestCase
+{
+    public function test_injects_pixel_before_body_close_on_huge_html(): void
+    {
+        $huge = str_repeat('A', 2_000_000);
+        $html = '<html><body><p>ciao</p><img src="data:image/png;base64,'.$huge.'"></body></html>';
+        $pixel = '<img src="https://example.test/email/t/abc" />';
+
+        $out = MailTrackerHtml::injectPixel($html, $pixel);
+
+        $pixelPos = strpos($out, '/email/t/abc');
+        $this->assertNotFalse($pixelPos);
+        $this->assertLessThan(stripos($out, '</body>'), $pixelPos);
+        $this->assertTrue(MailTrackerHtml::hasUsablePixel($out));
+    }
+
+    public function test_pixel_after_html_is_not_usable(): void
+    {
+        $html = '<html><body>ciao</body></html><img src="https://x.test/email/t/abc" />';
+
+        $this->assertFalse(MailTrackerHtml::hasUsablePixel($html));
+    }
+
+    public function test_rewrites_http_links_and_skips_mailto(): void
+    {
+        $html = '<a href="https://my.elephantech.it/segnalazione/show/abc">Apri</a>'
+            .'<a href="mailto:alessandro.ratti@arratti.it">mail</a>';
+
+        $out = MailTrackerHtml::rewriteLinks($html, fn (string $url) => 'TRACKED:'.$url);
+
+        $this->assertStringContainsString('TRACKED:https://my.elephantech.it/segnalazione/show/abc', $out);
+        $this->assertStringContainsString('mailto:alessandro.ratti@arratti.it', $out);
+        $this->assertStringNotContainsString('TRACKED:mailto', $out);
+    }
+
+    public function test_replaces_html_inside_mixed_related_alternative(): void
+    {
+        $html = new TextPart('<html><body>orig</body></html>', 'utf-8', 'html');
+        $text = new TextPart('plain', 'utf-8', 'plain');
+        $alt = new AlternativePart($text, $html);
+        $related = new RelatedPart($alt, new TextPart('img', null, 'plain'));
+        $mixed = new MixedPart($related, new TextPart('pdf', 'utf-8', 'plain'));
+
+        $this->assertSame('<html><body>orig</body></html>', MailTrackerHtml::extractHtml($mixed));
+
+        $updated = MailTrackerHtml::replaceHtml(
+            $mixed,
+            '<html><body>orig<img src="https://x.test/email/t/h" /></body></html>',
+            'utf-8'
+        );
+
+        $this->assertNotNull($updated);
+        $extracted = MailTrackerHtml::extractHtml($updated);
+        $this->assertNotNull($extracted);
+        $this->assertStringContainsString('/email/t/h', $extracted);
+    }
+}