Version vom 19. Juni 2010, 22:03 Uhr (Quelltext anzeigen) BugBuster (Diskussion | Beiträge) K (→‎Methode BD_CheckBotIP) ← Zum vorherigen Versionsunterschied		Version vom 19. Juni 2010, 22:03 Uhr (Quelltext anzeigen) BugBuster (Diskussion | Beiträge) (→‎Methode BD_CheckBotAgentAdvanced) Zum nächsten Versionsunterschied →
Zeile 84:		Zeile 84:
	$GLOBALS['TL_BOTDETECTION']['BOT_AGENT'][] = array("myprivat","My privat bot");		$GLOBALS['TL_BOTDETECTION']['BOT_AGENT'][] = array("myprivat","My privat bot");
	Die Parameter sind: Kurzname in Kleinbuchstaben, Beschreibung.		Die Parameter sind: Kurzname in Kleinbuchstaben, Beschreibung.
		+	{{Hinweis|Ab Version 1.0.3 wird im Namen das "TL_" gestrichen, die alte Notation wird aber weiterhin unterstützt.}}
	=Demo Module=		=Demo Module=

---

Version vom 19. Juni 2010, 22:03 Uhr

Bot Detection dient als Hilfsklasse für andere Extensions (Frontend) die erkennen müssen, ob der Zugriff von Mensch oder Maschine erfolgt.

(Erkennung von Suchmaschinen, Spider, Crawler, Bots, Harvester, ...)

Forum

Fragen zum Bot Detection Modul werden im Forum beantwortet: Forum - Support für Extensions
Fehler und Wünsche können im Tracking System gemeldet werden.

Installation

Installation erfolgt über das Extension Repository im Backend der Contao Installation.
Eine manuelle Installation ist möglich, dazu die ZIP Datei vom Extension Repository laden, entpacken und entsprechend übertragen.
Dadurch ein Verzeichnis /system/modules/botdetection angelegt worden sein.
Danach wie dabei üblich /contao/install.php Aufrufen - Update Database durchführen.

Nutzung

Das Modul Bot Detection stellt 3 Methoden zur Erkennung bereit.
Eine sichere Erkennung gibt es dabei natürlich nicht.
Es wird über 2 Verfahren versucht dieses zu erkennen:

• User Agent Kennung
• IP Adresse

Die ersten beiden Methoden, BD_CheckBotAgent und BD_CheckBotIP, geben nur "true" oder "false" zurück und arbeiten mit internen Teilstrings zur Suche bzw. mit einer externen Datei zur Definition der IP Adressen / Netze.

Eine dritte Methode BD_CheckBotAgentAdvanced kam in Version 1.0.2 hinzu, die über eine externe Konfigurationsdatei die Erkennung über User Agent durchführt und als Ergebnis den Kurznamen des Bots zurückgibt bzw. "false" wenn keine Erkennung erfolgte.

Methode BD_CheckBotAgent

Die Methode "BD_CheckBotAgent" sucht in 2 Schritten, um möglichst schnell zu Ziel zu kommen.
Schritt 1 sucht nach Teilstrings die in den meisten Suchmaschinen / Bots im Namen auftauchen:

'bot'
'spider'
'spyder'
'crawl'
'slurp'
'robo'
'yahoo'

War Schritt 1 nicht erfolgreich sucht dann Schritt 2 nach weiteren Strings die meist der Name der Suchmaschine entsprechen, wie:

'altavista'
'archiver'
'inktomi'
'twiceler'
...

Als Ergebnis kommt "true" oder "false" zurück ("true" = Suchmaschine / Bot gefunden)

Methode BD_CheckBotIP

Der Bot von Google oder der MSN-Suche bzw. von Bing sind manchmal verdeckt unterwegs, was verfälschte Statistiken zur Folge hat.
Um diese "Undercover" Suchmaschinen aufdecken zu können, muss über die IP-Adresse gefiltert werden.
Dazu dient die Methode "BD_CheckBotIP".

Dazu gibt es eine Kofigurationsdatei im Verzeichnis config des Moduls: bot-ip-list.txt
Derzeitiger Inhalt kennt eine IP Adresse eines Spiders aus Israel sowie Netzadressen für Google und MSN/Bing.

Eigene IP-Adressen bzw. Netze können in dieser Datei ebenfalls eingetragen werden, diese sind dann aber nicht updatesicher. Daher ist es besser diese, wie dort erwähnt, in der localconfig.php einzutragen wie folgt:

$GLOBALS['TL_BOTDETECTION']['BOT_IP'][] = '192.168.1.2';
$GLOBALS['TL_BOTDETECTION']['BOT_IP'][] = '192.168.0.0/24';

Methode BD_CheckBotAgentAdvanced

Die Methode "BD_CheckBotAgentAdvanced" wird von einer externen Konfigurationsdatei gesteuert zur Erkennnug der User Agents. Als Ergebnis folgt der Kurznamen des Bots bzw. "false", wenn keine Erkennung erfolgte.

Die externe Konfigurationsdatei wird aus bekannten User Agent Angaben von Suchmaschinen / Bots generiert und regelmäßig erneuert.

Hinweis
Diese externe DB unterscheidet auch zwischen den verschiedenen Arten von Suchmaschinen eines Herstellers.
D.h., es folgt nicht einfach die Rückgabe von beispielsweise "Google" sondern "Googlebot" oder "Googlebot-Image" oder "Googlebot-Mobile" usw. je nachdem was erkannt wurde. Diese mehrfachen Namen einer Suchmaschine gibt es auch bei anderen Herstellern wie MSN, Yahoo, um nur einige zu nennen.

Eigene bzw. unbekannte User Agent Kennungen können in der Datei /system/config/localconfig.php eingetragen werden:

$GLOBALS['TL_BOTDETECTION']['BOT_AGENT'][] = array("unitbot","UniBot from FHTW");
$GLOBALS['TL_BOTDETECTION']['BOT_AGENT'][] = array("myprivat","My privat bot");

Die Parameter sind: Kurzname in Kleinbuchstaben, Beschreibung.

Demo Module

Dem Modul Bot Detection sind 2 Demos beigefügt. Die Einbindung in die Demo Klasse erfolgt per Import.

$this->import('ModuleBotDetection');

Frontend Demo 1

Demo 1 testet mit allen 3 Methoden die aktuelle IP und User Agent Kennung und zeigt die Ergebnisse an.
Beispiel siehe auf der Entwickler Webseite - Demo 1.

Frontend Demo 2

Demo 2 stellt ein Formular zur Verfügung, um zu prüfen, ob eine User Agent Kennung vom Modul als Bot erkannt werden würde.
Dazu werden die beiden Agent Methoden aufgerufen und das Ergebnis angezeigt.
Beispiel siehe auf der Entwickler Webseite - Demo 2.