Trackbacks senden und empfangen
24. September 2008 | 02:55:35
Da ich keine fertige Blog-Software (wie z.B. WordPress oder Serendipity) nutze, musste ich mich selbst um die Erstellung der Trackback-Funktionalität auf meiner Seite kümmern. Allerdings hatte ich keine Ahnung von der Materie und habe erst einmal per Google nach dem Thema Trackback gesucht.
Es wurden auch zahlreiche Suchergebnisse aufgelistet, aber davon konnte man die meisten echt vergessen. Einige erklärten kurz, was Trackbacks überhaupt sind, andere schwelgten in Zukunftsvisionen, was mit Trackback möglich wäre. Aber keiner erklärte mir, wie genau Trackbacks (in PHP) zu realisieren waren.
Vielleicht lag es einfach auch daran, dass ich nach der sechsten Google-Page keinen Bock mehr hatte, weiter nach Artikeln zu suchen.
Im Endeffekt hatte ich hauptsächlich nur die offizielle Trackback-Spezifikation. Naja, besser als Nichts.
Der Server-Artikel ist ein Artikel, den du in einem anderen Blog gefunden hast und auf den sich dein eigener Artikel (Client-Artikel) bezieht.
Der Client-Artikel bezeichnet deinen Artikel und dieser bezieht sich auf den Server-Artikel. Du möchtest mittels Trackback-Eintrag diese Beziehung hervorheben.
Der Trackback-Client bezeichnet hier deinen Blog bzw. deine Seite (Skript), die den Trackback an den Trackback-Server postet (verschickt).
Der Trackback-Server ist eine Seite (Skript) des Blogs, der den Server-Artikel enthält. Sein Skript empfängt deinen Trackback und verarbeitet ihn (z.B. in Datenbank speichern und dann in den Kommentaren des Server-Artikels anzeigen).
Die Trackback-URL ist der Link zum Server-Artikel auf dem Trackback-Server (eventuell mit einigen Parametern im Querystring). Die Trackback-URL ist bei mir z.B. ein "toter" Link mit der Bezeichnung "Trackback-URL zu diesem Beitrag".
Der PermaLink ist die URL deines Artikels - also der Link zum Client-Artikel. Dieser Link soll mittels deines Trackback-Eintrags im Server-Artikel einen Verweis auf deinen Artikel (Client-Artikel) ermöglichen.
Die Spezifikation gibt folgende vier Parameter vor, die an den Trackback-Server gepostet werden sollten:
Ich habe es aber auch schon erlebt, dass die POST-Variable "blog_name" auch "blogname" genannt wird. Ich prüfe daher beim Empfang eines Trackbacks auf beide Varianten.
Diese Parameter müssen noch encodiert werden - dies erledigt urlencode() für uns.
Nun benötigen wir noch die Trackback-URL und den entsprechenden Trackback-Server (Host):
Jetzt öffnen wir eine Socket-Verbindung zum Trackback-Server ($host) und versenden unsere eingetragenen Werte an diesen:
So, wir sind fast durch. Zum Schluß wollen wir ja noch wissen, ob der Versand erfolgreich war oder nicht. Daher lesen wir noch die Daten aus, die der Trackback-Server an den Trackback-Client zurück sendet und schliessen die Verbindung wieder:
Damit hätten wir das Versenden eines Trackbacks abgehakt. Kommen wir nun zum Empfangen von Trackbacks.
Ist der Trackback erfolgreich durch diese Prüfung gekommen, so holen wir uns nun die POST-Parameter:
Jetzt wird geprüft, ob die URL $url bzw. der Blogname $blog_name leer sind. Mein Skript erwartet diese Werte, schließlich soll ja ein Link im - bei mir - erzeugten Kommentar auf den Client-Artikel (PermaLink) verweisen. Der Name ist notwendig, weil bei mir jeder Kommentar den Namen des Verfassers haben muss (allerdings kann der beliebig gewählt sein).
Falls es schon einen Trackback-Eintrag mit der ID und der URL gibt, dann diesen nicht nochmal eintragen, sondern zurück zum Aufrufer:
Wurde ein Titel übergeben, so wird nun geprüft, ob dieser eine gewisse Länge (in diesem Fall 50 Zeichen) überscheitet. Wenn ja, dann wird er gekürzt und die Zeichenkette "[...]" angefügt. Danach machen wir mit dem Auszug aus dem Client-Artikel das Gleiche - allerdings darf dieser (bei mir) maximal 255 Zeichen lang sein:
Zum Schluß wird der Trackback in die Datenbank eingetragen und dies dem Trackback-Client mitgeteilt:
Ein weiterer wichtiger Punkt ist die Handhabung hinsichtlich SPAM. Sollte man Trackbacks besser immer moderieren oder reicht der Einsatz von Sicherheitstools (z.B. das Simple Trackback Validation Plugin)? Dazu aber mehr in einem späteren Artikel.
Es wurden auch zahlreiche Suchergebnisse aufgelistet, aber davon konnte man die meisten echt vergessen. Einige erklärten kurz, was Trackbacks überhaupt sind, andere schwelgten in Zukunftsvisionen, was mit Trackback möglich wäre. Aber keiner erklärte mir, wie genau Trackbacks (in PHP) zu realisieren waren.
Vielleicht lag es einfach auch daran, dass ich nach der sechsten Google-Page keinen Bock mehr hatte, weiter nach Artikeln zu suchen.
Im Endeffekt hatte ich hauptsächlich nur die offizielle Trackback-Spezifikation. Naja, besser als Nichts.
Ausgangspunkt / Annahme
Wir nehmen nachfolgend an, dass du einen Artikel auf deinem Blog geschrieben hast, der sich auf ein Thema bzw. einen Artikel bezieht, den du auf einem anderen Blog gefunden hast. Du möchtest diesen anderen Blog bzw. dessen Leser nun davon in Kenntnis setzen, dass du auch etwas zu diesem Thema geschrieben hast. Du erreichst dies z.B. mittels Trackbacks. Somit bist du der Sender und der andere Blog der Empfänger.Einige Begriffe vorab
Auch bei den Begrifflichkeiten herrschte ein ziemliches Durcheinander auf den gefundenen Websiten (zu diesem Thema). Aus diesem Grund will ich zuerst einmal ein paar Begriffe klären. Diese "Definitionen" erheben keinen Anspruch darauf, korrekt bezeichnet zu sein (man könnte Trackback-Client auch Sender nennen usw.), sondern dienen nur dem besseren Verständnis dieses Artikels. Also fangen wir an.Der Server-Artikel ist ein Artikel, den du in einem anderen Blog gefunden hast und auf den sich dein eigener Artikel (Client-Artikel) bezieht.
Der Client-Artikel bezeichnet deinen Artikel und dieser bezieht sich auf den Server-Artikel. Du möchtest mittels Trackback-Eintrag diese Beziehung hervorheben.
Der Trackback-Client bezeichnet hier deinen Blog bzw. deine Seite (Skript), die den Trackback an den Trackback-Server postet (verschickt).
Der Trackback-Server ist eine Seite (Skript) des Blogs, der den Server-Artikel enthält. Sein Skript empfängt deinen Trackback und verarbeitet ihn (z.B. in Datenbank speichern und dann in den Kommentaren des Server-Artikels anzeigen).
Die Trackback-URL ist der Link zum Server-Artikel auf dem Trackback-Server (eventuell mit einigen Parametern im Querystring). Die Trackback-URL ist bei mir z.B. ein "toter" Link mit der Bezeichnung "Trackback-URL zu diesem Beitrag".
Der PermaLink ist die URL deines Artikels - also der Link zum Client-Artikel. Dieser Link soll mittels deines Trackback-Eintrags im Server-Artikel einen Verweis auf deinen Artikel (Client-Artikel) ermöglichen.
Einen Trackback senden
Bevor wir uns um das Empfangen von Trackbacks kümmern, sehen wir uns erst einmal das Versenden eines Trackbacks an. Daran sehen wir, welche Parameter übergeben werden (die der Trackback-Server dann auswerten muss bzw. kann).Die Spezifikation gibt folgende vier Parameter vor, die an den Trackback-Server gepostet werden sollten:
title = der Titel des Client-Artikels (optional)
excerpt = ein Auszug aus dem Client-Artikel (optional)
url = der PermaLink (notwendig)
blog_name = Der Name des Blogs, der den PermaLink enthält (optional)Ich habe es aber auch schon erlebt, dass die POST-Variable "blog_name" auch "blogname" genannt wird. Ich prüfe daher beim Empfang eines Trackbacks auf beide Varianten.
Diese Parameter müssen noch encodiert werden - dies erledigt urlencode() für uns.
$title = "title=" . urlencode("Trackbacks senden und empfangen");
$url = "url=" . urlencode("http://trackback-client/client_artikel/artikel.php");
$excerpt = "excerpt=" . urlencode("Da ich keine fertige Blog-Software...");
$blog_name = "blog_name=" . urlencode("mein-blog");
$data = $title . "&" . $url . "&" . $excerpt . "&" . $blog_name;
Nun benötigen wir noch die Trackback-URL und den entsprechenden Trackback-Server (Host):
$tb_url = "http://www.matthias-sonnenkalb.net/trackback.php?tb_id=24";
$host = "tcp://" . parse_url( $tb_url, PHP_URL_HOST );
Jetzt öffnen wir eine Socket-Verbindung zum Trackback-Server ($host) und versenden unsere eingetragenen Werte an diesen:
$fp = fsockopen( $host, 80 );
if( $fp == FALSE ){ exit(); }
$out = "POST ". $tb_url ." HTTP/1.1\r\n";
$out .= "Host: ".$host."\r\n";
$out .= "Content-Type: application/x-www-form-urlencoded; charset=utf-8\r\n";
$out .= "Content-length: ".strlen($data)."\r\n";
$out .= "Connection: close\r\n\r\n";
$out .= $data;
fwrite( $fp, $out );
So, wir sind fast durch. Zum Schluß wollen wir ja noch wissen, ob der Versand erfolgreich war oder nicht. Daher lesen wir noch die Daten aus, die der Trackback-Server an den Trackback-Client zurück sendet und schliessen die Verbindung wieder:
while( !feof( $fp ))
{
$response = fgets( $fp, 128 );
//$response = str_replace( "\n", "<br>", $response );
echo $response;
}
@fclose($fp);Damit hätten wir das Versenden eines Trackbacks abgehakt. Kommen wir nun zum Empfangen von Trackbacks.
Einen Trackback empfangen
Ich prüfe in meinem Skript zuerst, ob der Parameter "tb_id" im Querystring übergeben wurde. Falls nicht, bricht das Skript mit einer Fehlermeldung ab. Diese Fehlermeldung kann der Trackback-Client auslesen (z.B. mittels der oben gezeigten while-Schleife). Wurde der Parameter übergeben, so prüfe ich nur noch, ob sein Wert ein Integer-Wert - also ganzzahlig - ist (gleichzeitig merke ich mir diesen Wert in der Variablen $tb_id):// Wurde der notwendige Parameter tb_id übergeben?
if( !$_GET['tb_id'])
{
trackback_response( 1, 'Error :: No ID was given' );
}
// Ist dessen Wert ganzzahlig?
elseif( !intval( $tb_id = $_GET['tb_id'] ))
{
trackback_response( 1, 'Error :: No valid ID was given.' );
}
// Sind für diesen Artikel überhaupt noch Kommentare erlaubt?
elseif( Article :: getLockStatus( $tb_id ))
{
trackback_response( 1, 'INFORMATION :: no comments allowed.' );
}
// Gibt es bei mir denn einen Artikel mit dieser ID?
elseif( !Article :: getArticleById( $tb_id ))
{
trackback_response( 1, 'Error :: Could not found given ID.' );
}Ist der Trackback erfolgreich durch diese Prüfung gekommen, so holen wir uns nun die POST-Parameter:
$url = $_POST['url'];
$title = stripslashes( $_POST['title'] );
$excerpt = stripslashes( $_POST['excerpt'] );
$blog_name = stripslashes( $_POST['blog_name'] );
// falls Parameter 'blog_name' nicht vorhanden, dann ...
if( empty( $blog_name ))
{
// ... versuche es mit dem Parameter 'blogname'
$blog_name = stripslashes( $_POST['blogname'] );
}Jetzt wird geprüft, ob die URL $url bzw. der Blogname $blog_name leer sind. Mein Skript erwartet diese Werte, schließlich soll ja ein Link im - bei mir - erzeugten Kommentar auf den Client-Artikel (PermaLink) verweisen. Der Name ist notwendig, weil bei mir jeder Kommentar den Namen des Verfassers haben muss (allerdings kann der beliebig gewählt sein).
if( empty( $url ) || empty( $blog_name ))
{
trackback_response( 1, 'Error :: No url and/or no blog_name given.');
}Falls es schon einen Trackback-Eintrag mit der ID und der URL gibt, dann diesen nicht nochmal eintragen, sondern zurück zum Aufrufer:
if( Comment :: isTrackBackComment( $tb_id, $url ))
{
trackback_response( 1, 'ERROR :: trackback already exists.');
}Wurde ein Titel übergeben, so wird nun geprüft, ob dieser eine gewisse Länge (in diesem Fall 50 Zeichen) überscheitet. Wenn ja, dann wird er gekürzt und die Zeichenkette "[...]" angefügt. Danach machen wir mit dem Auszug aus dem Client-Artikel das Gleiche - allerdings darf dieser (bei mir) maximal 255 Zeichen lang sein:
$tb_content = '';
if( !empty( $title ))
{
if( strlen( urldecode( $title )) > 50 )
{
$tb_content .= '[...]';
}
$title = substr( urldecode( $title ), 0, 50 ) . $tb_content;
// als Titel kennzeichnen
$tb_content = urlencode("<h2>" . $title . "</h2>");
}
if( !empty( $excerpt ))
{
$tb_content .= '[...] ' . substr( urldecode( $excerpt ), 0, 255 ) . ' [...]';
$tb_content .= urlencode( $tb_content );
}Zum Schluß wird der Trackback in die Datenbank eingetragen und dies dem Trackback-Client mitgeteilt:
if( !Comment :: insert( $tb_ip, $url, $tb_content, $blog_name, 1 ))
{
trackback_response( 1, 'ERROR :: Could not insert Trackback.');
}
// Trackback wurde erfolgreich eingetragen
// Trackback-Client erhält den Fehlercode 0 zurück
trackback_response(0);Bemerkungen
Einige Bedenken habe ich wegen der Bezeichnungen der POST-Parameter. Ist denn garantiert, dass diese immer so in den Sender-Skripten bezeichnet werden, wie in der Spezifikation vorgegeben? Wie das Beispiel mit dem Blog-Namen zeigte, kann man sich wohl nicht darauf verlassen (Simpletracks-Formular - hat bei mir überhaupt nicht funktioniert). Mittels Trackback Pinger konnte ich Trackbacks an meinen Blog senden. Diese wurden auch empfangen und korrekt angezeigt.Ein weiterer wichtiger Punkt ist die Handhabung hinsichtlich SPAM. Sollte man Trackbacks besser immer moderieren oder reicht der Einsatz von Sicherheitstools (z.B. das Simple Trackback Validation Plugin)? Dazu aber mehr in einem späteren Artikel.
Artikel als Bookmark:
IP-Vergleich: Mittel gegen Trackba...
Ich hatte vergessen die Funktion trackback_response() anzugeben. Diese sieht wie folgt aus:
Sorry.