Neu Fehler in: JTL Exportformat Google Shopping v2.2.0, Bereich: Exportformat Google Review XML

[Marco Stark]

Hallo liebes Dev-Team, Hey Felix @FMoche

Bei der Einrichtung des Review Feeds im Google Merchant Center ist unser Feed mit mehreren Fehlern als "invalid" eingestuft, respektive abgelehnt worden. Bei der Überprüfung der ursächlichen "GoogleReviewXML.php" im Ordner "jtl_google_shopping/Exportformat/" ist mir ein Fehler aufgefallen. Weiterhin gibt es Verbesserungspotenzial im Bereich der XML-Knoten: title, content und product_name.

Fehler
Im Übergang/Zeilenumbruch von Zeile 22 zu 23 ist euch ein Leerzeichen zu viel rein gerutscht. Hinter dem = Zeichen in Zeile 22 sollte direkt der String aus Zeile 23 folgen. Aktuell befindet sich in Zeile 23 aber ein Leerzeichen am Anfang.
Original: https://gitlab.com/jtl-software/jtl...aster/Exportformat/GoogleReviewXML.php#L20-23

Lösung
Um den Code etwas lesbarer zu machen, war ich mal so frech und habe die Schema Namespace/Instance Namespace optimiert sowie den Leerzeichenfehler behoben:
Patch: https://gist.github.com/muemarco/19fce9ab05c0abee18b077b4a3234a22#file-googlereviewxml-php-L20-L23

---

Verbesserungspotenzial (XML-Knoten)
Die Inhalte der folgenden XML-Knoten werden mit "user generated content" befüllt. Hier ergibt sich die Herausforderung, dass speziell in den Knoten title und content von unseren Kunden oft Steuerzeichen in die Produktbewertungen getippelt werden. Das beliebteste ist "&". Das gleiche gilt für den Knoten product_name. Sofern das passiert, validiert der Feed nicht mehr.

Lösungsvorschlag
Das Problem lässt sich mittels CDATA-Abschnitten unkompliziert lösen. Die Datentypen der genannten XML-Knoten sind in der product_reviews.xsd mit "nonEmptyStringType" angegeben, validieren daher erfolgreich gegen die eingefügten CDATA-Abschnitte. Hier die geänderten Zeilen in der Datei "GoogleReviewXML.php":

title-Knoten, Zeile 261
Original: https://gitlab.com/jtl-software/jtl.../master/Exportformat/GoogleReviewXML.php#L261
Patch: https://gist.github.com/muemarco/19fce9ab05c0abee18b077b4a3234a22#file-googlereviewxml-php-L261

content-Knoten, Zeile 262
Original: https://gitlab.com/jtl-software/jtl.../master/Exportformat/GoogleReviewXML.php#L262
Patch: https://gist.github.com/muemarco/19fce9ab05c0abee18b077b4a3234a22#file-googlereviewxml-php-L262

product_name-Knoten, Zeile 308
Original: https://gitlab.com/jtl-software/jtl.../master/Exportformat/GoogleReviewXML.php#L308
Patch: https://gist.github.com/muemarco/19fce9ab05c0abee18b077b4a3234a22#file-googlereviewxml-php-L308

Alternative Lösung via sanitize-Funktion
Das Steuerzeichen & in str_replace hinzufügen und durch & ersetzen. Lösung:

    /**
     * @param string $content
     * @return string
     */
    private function sanitize(string $content): string
    {
        return \str_replace(['>', '<', '&'], ['&gt;', '&lt;', '&amp;'], \html_entity_decode($content));
    }

Falls ihr einen Feed für interne Tests benötigt (unverändertes Shoping Plugin Version 2.2.0), in dem alle nicht erlaubten Steuerzeichen in den Bewertungen verwendet wurden, könnt ihr euch gerne bei uns bedienen (ca. 7.700 Produktbewertungen / 6,4 MB). Den neuen Feed, resultierend aus der gepatchten GoogleReviewXML.php findet ihr an gewohnter Stelle. Upload im Merchant Center sowie XML Validierung waren erfolgreich.

Mit den besten Grüßen,
Marco

 

[FMoche]

Hallo @Marco Stark und vielen Dank für die Hinweise.
Das werde ich so gerne übernehmen, wobei das Sanitizen hier eher komplett unnötig erscheint, oder?
Wenn die Felder in CDATA gewrappt werden, kann ja auch genauso direkt ">", "<" und "&" genutzt werden.
Zumindest validiert das XML dann auch via
xmllint --schema http://www.google.com/shopping/reviews/schema/product/2.3/product_reviews.xsd --noout FILE.xml

Darauf, dass Google hier HTML-Entities erwarten würde, finde ich jedenfalls keinen Hinweis.

 

[Marco Stark]

Hey Felix,

ja, in dem Fall wäre "sanitize" überflüssig.

 

[FMoche]

Dann könntest du die Änderungen aus https://gitlab.com/jtl-software/jtl-shop/plugins/jtl_google_shopping/-/merge_requests/20 testen.

 

[Marco Stark]

Super Felix, vielen Dank. Ich geb dir Feedback, ob alles wie gewünscht funktioniert.

VG,
Marco

 

[Marco Stark]

Guten Morgen Felix,

der Upload des neuen/geänderten Feeds war erfolgreich. Goggle hat ihn vollständig verarbeitet.