PostDownload Hook benutzen

[feG3]

Hey,

ich versuche einen eigenen Download-Tracker zu basteln, allerdings scheitert es gerade schon daran, den PostDownload Hook richtig zu benutzen.

Ich habe die Ordner/Datei "src/EventListener/PostDownloadListener.php" erstellt und darin den Code aus der Doku eingesetzt.
Allerdings passiert da gar nichts wenn ich da versuche was zu loggen. Hab auch mal ein "dump();die();" versucht, um zu schauen ob da überhaupt irgendwas passiert, aber ohne Erfolg.

Hab auch zusätzlich mal noch in der composer.json den autoload hinzugefügt:

"autoload": {
      "psr-4": {
            "App\\": "src/"
       }
}

Hat jemand eine Idee wie ich das zum Laufen bekomme bzw. richtig debuggen/testen kann?

Kann leider die Konsole nicht benutzen, weil das Projekt lokal über MAMP läuft und ich das da irgendwie nicht hinbekomme.

Schon mal vielen Dank im Vorraus.

[fiedsch]

Hab auch zusätzlich mal noch in der composer.json den autoload hinzugefügt:

Hast Du danach auch composer dump-autoload ausgeführt?

In der vendor/composer/autoload_psr4.php sollte dann ein Eintrag für App zu finden sein:

'App\\' => array($baseDir . '/src'), 

[Spooky]

Der Hook an sich existiert zwar noch, allerdings ist dieser Teil des Legacy Frameworks welches nicht mehr in allen Stellen von Contao benutzt wird. Die neuen Download(s) Inhaltselemente in Contao 5 nutzen nicht mehr die Funktion, die diesen Hook auslösen würde.

Um alle (von der Applikation gesendeten) Downloads abzufangen, müsstest eher einen kernel.response Event Listener implementieren.

[feG3]

Hast Du danach auch composer dump-autoload ausgeführt?

In der vendor/composer/autoload_psr4.php sollte dann ein Eintrag für App zu finden sein:

'App\\' => array($baseDir . '/src'), 

Jep, der ist ganz am Schluss drin.

[feG3]

Der Hook an sich existiert zwar noch, allerdings ist dieser Teil des Legacy Frameworks welches nicht mehr in allen Stellen von Contao benutzt wird. Die neuen Download(s) Inhaltselemente in Contao 5 nutzen nicht mehr die Funktion, die diesen Hook auslösen würde.

Um alle (von Contao gesendeten) Downloads abzufangen, müsstest eher einen kernel.resonse Event Listener implementieren.

Ah okay, weißt du zufälligerweise wie ich das umsetzen kann?

Einfach den Code in die PostDownloadListener.php einfügen?

use Symfony\Component\HttpKernel\Event\ResponseEvent;

public function onKernelResponse(ResponseEvent $event): void
{
    $response = $event->getResponse();

    // ... modify the response object
}

[Spooky]

So zB.:

// src/EventListner/DownloadResponseListener.php
namespace App\EventListener;

use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpKernel\Event\ResponseEvent;

#[AsEventListener]
class DownloadResponseListener
{
    public function __invoke(ResponseEvent $event): void
    {
        if (!$event->isMainRequest() || !($response = $event->getResponse()) instanceof BinaryFileResponse) {
            return;
        }

        $file = $response->getFile();

        // Do something …
    }
} 

[feG3]

So zB.:

// src/EventListner/DownloadResponseListener.php
namespace App\EventListener;

use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpKernel\Event\ResponseEvent;

#[AsEventListener]
class DownloadResponseListener
{
    public function __invoke(ResponseEvent $event): void
    {
        if (!$event->isMainRequest() || !($response = $event->getResponse()) instanceof BinaryFileResponse) {
            return;
        }

        $file = $response->getFile();

        // Do something …
    }
} 

Vielen Dank!

ich hab das jetzt direkt mal so getestet.
Allerdings löst der Download das komischerweise nicht richtig aus. Also wenn ich innerhalb der if-Abfrage einen dump mache funktioniert das beim Laden der Seite. Außerhalb wird es aber nie ausgegeben. Also irgendiwie scheint das runterladen einer Datei im Downloads Element nicht das richtige Event auszulösen

[Spooky]

Also ich hab es getestet und bei mir funktoniert es. Sowohl mit den alten Download(s) Inhaltselementen als auch den neuen.

[feG3]

Also ich hab es getestet und bei mir funktoniert es. Sowohl mit den alten Download(s) Inhaltselementen als auch den neuen.

Komisch, ich hab jetzt einfach mal ein neues Downloads-Element auf der Seite hinzugefügt und jetzt geht es, allerdings nicht beim alten Element. Aber vielen Dank!


Da du hier ja der Profi bist
Ich habe der tl_files ein Feld DownloadCounter hinzugefügt, dieses würde ich jetzt gerne in diesem EventListener hochzählen.

Dafür hab ich die Klasse noch um

private $connection;

public function __construct(Connection $connection)
  {
    $this->connection = $connection;
  }

erweitert und dann in der invoke Funktion mal testweise ein

$dbResult = $this->connection->executeQuery('SELECT * FROM tl_files')->fetchAllAssociative();

hinzugefügt. Das funktioniert auch soweit.

Was ist da denn der beste Weg um nur den Datensatz der heruntergeladenen Datei zu laden und zu updaten?

[Spooky]

$response->getFile() gibt dir ein Symfony\Component\HttpFoundation\File\File Objekt zurück. Damit kommst du an den absoluten Pfad. Den musst du nun zu einem relativen Pfad umwandeln, damit du damit den entsprechenden Eintrag aus tl_files suchen kannst. Dazu musst du dir den kernel.project_dir Parameter injecten und dann mit Hilfe von \Symfony\Component\Filesystem\Path::makeRelative($file->getPathname(), $this->projectDir); den relativen Pfad erzeugen, welchen du dann in deinem Datenbank Query nutzen kannst.

[feG3]

$response->getFile() gibt dir ein Symfony\Component\HttpFoundation\File\File Objekt zurück. Damit kommst du an den absoluten Pfad. Den musst du nun zu einem relativen Pfad umwandeln, damit du damit den entsprechenden Eintrag aus tl_files suchen kannst. Dazu musst du dir den kernel.project_dir Parameter injecten und dann mit Hilfe von \Symfony\Component\Filesystem\Path::makeRelative($file->getPathname(), $this->projectDir); den relativen Pfad erzeugen, welchen du dann in deinem Datenbank Query nutzen kannst.

Nice, das funktioniert soweit.
Allerdings kapiere ich gerade nicht warum der EventListener nur manchmal ausgelöst wird. Jetzt grade passiert wieder einfach gar nichts wenn ich eine Datei runterlade. Das sollte doch eigentlich jedes Mal ausgelöst werden. Ich verstehe nicht wo der Unterschied liegen soll.

[Spooky]

Debugge einfach mal was du bei $event->getResponse() für eine Response bekommst.

[feG3]

Ich bekomme für die ganzen Inhaltselemente auf der Seite je ein dump, aber wenn ich beim Downloads-Element eins herunterlade kommt nichts neues dazu.

[Spooky]

Ich bekomme für die ganzen Inhaltselemente auf der Seite je ein dump, aber wenn ich beim Downloads-Element eins herunterlade kommt nichts neues dazu.

Wie lautet die Download URL und wo hast du den Dump genau eingefügt?

[feG3]

Wie lautet die Download URL und wo hast du den Dump genau eingefügt?

Ein Beispiel-Link: http://localhost/entdecken?_hash=%2F...%2F330x250.jpg


Und mein Listener sieht gerade so aus:

<?php
namespace App\EventListener;

use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
// use Symfony\Component\HttpFoundation\Request;
// use Symfony\Component\HttpFoundation\Response;
use Doctrine\DBAL\Connection;
use Symfony\Component\HttpKernel\KernelInterface;

#[AsEventListener]
class DownloadResponseListener
{
    private $connection;
    private $projectDir;

    public function __construct(Connection $connection, KernelInterface $kernel)
    {
        $this->connection = $connection;
        $this->projectDir = $kernel->getProjectDir();
    }

    public function __invoke(ResponseEvent $event): void
    {
        dump($event->getResponse());
        if (!($response = $event->getResponse()) instanceof BinaryFileResponse) {
            return;
        }

        
        $file = $response->getFile();
        dump($file);
        $relativePath = \Symfony\Component\Filesystem\Path::makeRelative($file->getPathname(), $this->projectDir);
        dump($relativePath);
        $dbResult = $this->connection->executeQuery('SELECT * FROM tl_files WHERE path=$?')->fetchAllAssociative($relativePath);
        dump($dbResult);
        
        die();
        
    }
}

[Spooky]

Das die() ist zu spät. Ändere dein erstes dump() auf dd() um.

[feG3]

Das die() ist zu spät. Ändere dein erstes dump() auf dd() um.

Dann bekomm ich einfach das erste Inhaltselement der Seite gedumpt.

 Symfony\Component\HttpFoundation\Response {#1114 ?
  +headers: Symfony\Component\HttpFoundation\ResponseHeaderBag {#1115 ?
    #headers: array:3 [?
      "date" => array:1 [?
        0 => "Thu, 07 Dec 2023 14:21:59 GMT"
      ]
      "contao-merge-cache-control" => array:1 [?
        0 => "1"
      ]
      "x-powered-by" => array:1 [?
        0 => "PHP/8.2.0"
      ]
    ]
    #cacheControl: []
    #computedCacheControl: []
    #cookies: []
    #headerNames: array:3 [?
      "date" => "Date"
      "contao-merge-cache-control" => "Contao-Merge-Cache-Control"
      "x-powered-by" => "x-powered-by"
    ]
  }
  #content: """
        <div class="content-hub-filter">
      <ul>
        <!-- For filtering controls add -->
        <li data-filter="all"> Alle </li>
        <li data-filter="wirtschaft-unternehmen"> Wirtschaft & Unternehmen</li>
        <li data-filter="lage-infrastruktur"> Lage & Infrastruktur</li>
        <li data-filter="wohnen-leben"> Wohnen & Leben</li>
        <li data-filter="beruf-bildung"> Beruf & Bildung</li>
      </ul>
      
      <div class="dropdown-filter">
        <span class="filter-icon"></span>
        <select id="asset-type">
          <option value="all">Asset Typ</option>
          <option value="jpg">JPG</option>
          <option value="png">PNG</option>
          <option></option>
          <option></option>
        </select>
        <select id="topics">
          <option>Themen</option>
          <option></option>
          <option></option>
          <option></option>
          <option></option>
        </select>
         <select id="campain">
          <option>Kampagne</option>
          <option></option>
          <option></option>
          <option></option>
          <option></option>
        </select>
      </div>
    
    </div>
    """
  #version: "1.0"
  #statusCode: 200
  #statusText: "OK"
  #charset: null
}

[Spooky]

Dann bekomm ich einfach das erste Inhaltselement der Seite gedumpt.

Du musst zuerst die Seite im Frontend öffnen, dann das dd() einfügen und dann erst auf den Download Link klicken.

Alles Teil von Echo Debugging 101

Oder du nutzt xdebug bspw.

[feG3]

Also entweder bin ich zu blöd oder es geht nicht. Muss man nicht die Seite neu laden, damit das aktualisiert wird?

Wenn ich es nach dem laden der Seite einfüge, passiert einfach gar nichts.

[Spooky]

Muss man nicht die Seite neu laden, damit das aktualisiert wird?

Nein - du musst die Seite im Frontend aufrufen, dann dd() einfügen, dann auf den Download Link klicken.

[feG3]

Nein - du musst die Seite im Frontend aufrufen, dann dd() einfügen, dann auf den Download Link klicken.

Ja, das hab ich so versucht. Die Datei wird heruntergeladen und es passiert sonst gar nichts.

[Spooky]

Browser Cache vor dem Klick gelöscht? Debug-Modus aktiv?

[feG3]

Browser Cache vor dem Klick gelöscht? Debug-Modus aktiv?

Hab's jetzt nochmal mit Entwickler-Konsole auf versucht und es geht. Allerdings bekomm ich trotzdem wieder nur das erste Inhaltselement ausgegeben

[Spooky]

Ok - zum Verständnis jetzt mal genauer erklärt . Dieser Event Listener greift für alle Responses. Wenn du dort nun am Anfang ein dd() einfügst, dann gilt das natürlich auch für die Response, wenn du einfach nur die Seite im Frontend aufrufst. Du willst aber die Response des Download Requests debuggen. Daher darfst du das dd() erst einfügen, bevor du auf den Download Link klickst, nicht vorher.

Und wie gesagt kannst du auch xdebug mit breakpoints, statt echo debugging einsetzen.

[feG3]

Ok - zum Verständnis jetzt mal genauer erklärt . Dieser Event Listener greift für alle Responses. Wenn du dort nun am Anfang ein dd() einfügst, dann gilt das natürlich auch für die Response, wenn du einfach nur die Seite im Frontend aufrufst. Du willst aber die Response des Download Requests debuggen. Daher darfst du das dd() erst einfügen, bevor du auf den Download Link klickst, nicht vorher.

Das hab ich so schon verstanden.
Ich kommentiere das dd() aus -> Lade die Seite neu -> entferne den Kommentar -> Klicke auf den Link beim Downloads Element.

Allerdings kommt dann entweder einfach gar ncihts und die Datei wird einfach runtergeladen, oder wie vorhin einmal kurz wo ich dann auf die http://localhost/entdecken?_hash=%2F...%2F330x250.jpg Seite weitergeleitet werde und da trotzdem nur das Inhaltselement ausgegeben wird

[Spooky]

Allerdings kommt dann entweder einfach gar ncihts und die Datei wird einfach runtergeladen

Browser Cache gelöscht? Debug-Modus aktiv?

[feG3]

Browser Cache gelöscht? Debug-Modus aktiv?

Ja und ja. Und dann werde ich wie gesagt weitergeleitet und da kommt trotzdem nur das Inhalts-Element statt der Datei.

Bildschirmfoto 2023-12-07 um 16.08.22.jpg

[Spooky]

Ja und ja. Und dann werde ich wie gesagt weitergeleitet und da kommt trotzdem nur das Inhalts-Element statt der Datei.

Bildschirmfoto 2023-12-07 um 16.08.22.jpg

Du scheinst da noch ein anderes Fragment davor zu haben. Du könntest vor dem dd() noch ein

if (!$event->isMainRequest()) {
    return;
} 

einfügen.

[feG3]

Du scheinst da noch ein anderes Fragment davor zu haben. Du könntest vor dem dd() noch ein

if (!$event->isMainRequest()) {
    return;
} 

einfügen.

Jetzt kommt die Datei!!

Komischerweise, wenn ich dd($file) mache, wird es korrekt ausgegeben.
Wenn ich $dbResult ausgeben will (und das dd($file) davor natürlich rausnehme) kommt nix.

 $file = $response->getFile();
        dd($file);
        $relativePath = \Symfony\Component\Filesystem\Path::makeRelative($file->getPathname(), $this->projectDir);
        $dbResult = $this->connection->executeQuery('SELECT * FROM tl_files WHERE path=?')->fetchAllAssociative($relativePath);
        dd($dbResult);

[feG3]

Nvm, war wohl einfach ein Fehler drin. Hab den Datenbank Code angepasst und jetzt geht es. Hallelujah

[Spooky]

Unabhängig von deinem Problem würde ich eher folgenden Code nutzen:

$filesRecord = $this->connection->fetchAssociative("SELECT * FROM tl_files WHERE path = ?", [$relativePath]); 

Darüberhinaus solltest du noch ein early out einbauen für den Fall, dass der Dateipfad nicht mit dem Parameter contao.upload_path beginnt ("files"). Weil solche Responses kann es ja auch für Dateien außerhalb von files/ geben.

[feG3]

Unabhängig von deinem Problem würde ich eher folgenden Code nutzen:

$filesRecord = $this->connection->fetchAssociative("SELECT * FROM tl_files WHERE path = ?", [$relativePath]); 

Das ist wirklich besser. Ich hatte es zwischendurch auf

$sql = "SELECT * FROM tl_files WHERE path='" . $relativePath ."'";
$dbResult = $this->connection->executeQuery($sql)->fetchAllAssociative();

geändert, aber da ist deins deutlich einfacher.

Was würdest du dann für ein UPDATE benutzen?
Ich habe es gerade noch so umgesetzt:

$newsql = "UPDATE tl_files SET downloadCounter ='" .$newCounter. "'" ." WHERE path='" . $relativePath ."'";
$dbResult = $this->connection->executeQuery($newsql);

Darüberhinaus solltest du noch ein early out einbauen für den Fall, dass der Dateipfad nicht mit dem Parameter contao.upload_path beginnt ("files"). Weil solche Responses kann es ja auch für Dateien außerhalb von files/ geben.

Guter Hinweis, vielen Dank!! Wie kann ich den contao.upload_path denn abfragen?

[Spooky]

Was würdest du dann für ein UPDATE benutzen?

$this->connection->update(…) 

Wie kann ich den contao.upload_path denn abfragen?

Genau so injecten wie kernel.project_dir. Für die Prüfung kannst du dann Path::isBasePath nutzen.

[BugBuster]

So ein Zufall, hatte vor Kurzem die selben Probleme mit meiner dlstats (Download Statistik) Erweiterung die ich auf Contao 5 portieren wollte.
Werde mal den hier beschriebenen Weg benutzen, mal sehen ob das auch bei mir geht.

Sowohl mit den alten Download(s) Inhaltselementen als auch den neuen.

Hab ich da was verpasst? Gibts da was neues?

[Spooky]

Hab ich da was verpasst? Gibts da was neues?

Ja, in Contao 5 sind (fast) alle Inhaltselemente als Fragments umgesetzt, also im neuen Weg. Siehe https://github.com/contao/contao/blo...ntent-elements

[BugBuster]

Achso das, ja das habe ich schon gelesen.

[feG3]

Ja, in Contao 5 sind (fast) alle Inhaltselemente als Fragments umgesetzt, also im neuen Weg. Siehe https://github.com/contao/contao/blo...ntent-elements

Ist das auch der Grund warum man nicht mehr die html5 Templates anpassen kann sondern sich an den Twig Templates vergehen muss?

Edit: Wer lesen kann ist klar im Vorteil, steht ja in dem Link.

[feG3]

$this->connection->update(…) 

Genau so injecten wie kernel.project_dir. Für die Prüfung kannst du dann Path::isBasePath nutzen.

Das mit dem Update hat funktioniert.

Das injecten noch nicht so. Ich finde nirgends Informationen dazu welche Komponenten ich dafür wie einbinden muss.

[feG3]

Das injecten noch nicht so. Ich finde nirgends Informationen dazu welche Komponenten ich dafür wie einbinden muss.

Hab das jetzt so abgeändert:

public function __construct(Connection $connection)
    {
        $this->connection = $connection;
        $this->projectDir = \Contao\System::getContainer()->getParameter('kernel.project_dir');
        $this->uploadPath = \Contao\System::getContainer()->getParameter('contao.upload_path');
    }

Ist das so die beste Lösung oder gibt's da nen besseren Weg?

[Spooky]

class DownloadResponseListener
{
    public function __construct(
        private readonly string $projectDir,
        private readonly string $uploadPath,
    ) {
        
    }
} 

# config/services.yaml
services:
    _defaults:
        autowire: true
        autoconfigure: true
        bind:
            $projectDir: '%kernel.project_dir%'
            $uploadPath: '%contao.upload_path%'

    App\:
        resource: ../src