RefererTagging - eine Erweiterung für das CMS Contao

tl_files/images/leistungsspektrum/contao-partner.png Seit 2010 setzen wir in der Internetagentur trilobit in Karlsruhe im Bereich Content-Management-Systeme voll auf Contao. Die Gründe für den Einsatz von Contao¹ sind zahlreich - die Begeisterung bei uns enorm, so dass wir auch offizieller Contao-Partner² geworden sind. RefererTagging ist unsere erste Erweiterung für Contao.

Was ist ein Referer?

Der Referer gibt an, woher der Besucher Ihrer Seite kommt. Bei Ihnen ist kein Referer feststellbar, d.h. Sie haben unsere URL wahrscheinlich direkt eingegeben. Diese Angabe bezieht sich immer auf die derzeit aktive Session. Wenn Sie also eine Veränderung des obigen Satzes sehen wollen, müssen Sie erst Ihren Browser schließen und dann wieder (direkt oder z.B. über eine Google-Suche) auf diese Seite gelangen. Wichtig in diesem Zusammenhang ist, dass immer nur der erste Referer einer Session gespeichert wird. Wenn Sie also die Seite über Google besuchen und nachher über ein Suchergebnis bei Bing, werden Sie nur den Aufruf von Google sehen. Es sei denn - wie gesagt - der Browser wurde daziwschen geschlossen.

Das Wissen um den Referer können Sie neben statistischen Auswertungen auch dazu nutzen, dem Besucher individuelle Inhalte anzuzeigen. Kommt er von einer Suchmaschine, ist er vielleicht neu und benötigt Hilfestellung. Oder möchten Sie "Neulingen" ein besonderes Angebot in Ihrem Shop machen? Hat eine Webseite die Lösung zu Ihrem Gewinnspiel veröffentlicht, können Sie Benutzer von dieser Seite auch markieren und später bei der Ziehung nicht berücksichtigen. Viele weitere Einsatzgebiete sind denkbar.

Was bietet die Erweiterung RefererTagging?

RefererTagging kann über das Contao-Repository³ installiert werden. Es bietet die Möglichkeit, Referer zu erkennen und mit einem Session-Cookie zu taggen, d.h. Sie können konfigurieren, dass bei einem Referer mit bing.com im Namen, das Cookie suchmaschine auf bing gesetzt wird. Dafür wird das Backend um den Menüpunkt RefererTagging im Abschnitt System ergänzt.

Folgende Werte können Sie konfigurieren

Pattern
Auf diesen regulären Ausdruck wird der Referer geprüft.
Beispiele:
- google trifft auf google.de und plus.google.com zu, aber auch auf http://trilobit.de/google.html.
- bing.com trifft auf http://www.bing.com zu, allerdings auch auf bingocom.de.
  Das hat damit zu tun, dass der Punkt ein spezielles Zeichen bei den regulären Ausdrücken ist und als Platzhalter für ein beliebiges Zeichen steht. Korrekt wäre daher das Muster bing\.com.
- google\.(de|com)\/ prüft, ob der Referer google gefolgt von einem Punkt und dann de oder com enthält. Danach muss ein "/" kommen. Klammern zeigen also Alternativen auf.
- Möchte man ganz sicher gehen, dass es sich um die richtige Domain handelt, sollte man diese samt Protokoll abprüfen, z.B. ^https:\/\/trilobit.de\/
  Durch das Dach muss am Anfang des Referers https://trilobit.de/ stehen.
- Eine Hilfestellung zu regulären Ausdrücken bietet beispielsweise Dr. Web⁴.
Tag Name
Name des Eintrags, der bei positivem Abgleich des Referers mit Pattern in die Session geschrieben wird. Ein gleichnamiges Cookie wird gesetzt.
Tag Wert
Wert des Eintrags, der bei positivem Abgleich des Referers mit Pattern in die Session geschrieben wird. Ein Cookie mit diesem Wert und Tag Name wird gesetzt.

Es werden alle Einträge nacheinander durchgegangen, so dass auch mehrere Tags und Cookies gesetzt werden können.

Wie kann ich die gesetzten Werte nutzen?

DIes geht einmal durch das Auslesen der Cookies. Das können Sie aus Contao heraus tun oder - von anderen Anwendungen aus - in einer beliebigen anderen Webseite unter dieser Domain. Zugriffe auf Session-Cookies gibt es in allen Programmiersprachen wie JavaScript, PHP, Java, ...

Außerdem besteht innerhalb Contaos die Möglichkeit über die Session auf die gesetzten Werte zuzugreifen. Mit

<?php echo $_SESSION['referertagging']['tags']['suchmaschine'] ?>

geben Sie den Wert des Tags suchmaschine auf der Webseite aus.

Hinweise zum Internet Explorer

Beim Internet Explorer (Versionen 8, 9) wird nicht in allen Fällen der Referer gesetzt. Folgendes Verhalten beim Verlinkung auf eine andere Seite gibt es:

<a href="http://www.neue-seite.de">Neue Seite</a>
- Mausklick auf den Link
  - der Referer wird korrekt gesetzt
  - die Seite wird im selben Fenster bzw Tab geöffnet
<a href="http://www.neue-seite.de" onclick="window.open(this.href); return false;">Neue Seite</a>
- Mausklick auf den Link
  - der Referer wird korrekt gesetzt
  - die Seite wird in einem neuen Fenster bzw Tab geöffnet
<a href="http://www.neue-seite.de" onclick="window.open(this.href); return
false;">Neue Seite</a>
- Mausklick auf den Link
  - der Referer wird nicht gesetzt
  - die Seite wird in einem neuen Fenster bzw Tab geöffnet
- Diese Version wird von Contao verwendet, wenn die Option "in neuem Fenster öffnen" gesetzt ist
<a href="http://www.neue-seite.de" ... >Neue Seite</a>
- Mausklick auf den Link mit gedrückter [Strg]-Taste
  - der Referer wird korrekt gesetzt (egal, ob target oder onclick Attribute gesetzt sind)
  - die Seite in einem neuen Fenster bzw Tab geöffnet

Versionsübersicht

Version 1.0.0 stable vom 10.8.2011
Erste Version der Erweiterung RefererTagging.

Das Modul ist natürlich auch im Contao-Wiki⁵ dokumentiert.

Hilfe

Bei Fragen und Anregungen zu der Erweiterung stehen wir natürlich gerne zur Verfügung. Nutzen Sie einfach unser Kontaktformular⁶.