Skip to content

Latest commit

 

History

History
121 lines (88 loc) · 5.62 KB

README_FR.md

File metadata and controls

121 lines (88 loc) · 5.62 KB
Raw

Pingback

Pingback est une classe PHP qui vous permet d'envoyer et de recevoir des pingback.

A propos

Les pingback sont un moyen d'informer d'autres blogs que vous avez rédigé du contenu et qu'un lien pointant vers un de leur article existe à l'intérieur. Cette classe vous permet d'intéragir avec des plateformes de blog, comme WordPress, et implémente les pingback comme décrits par la spécification officielle. Seule exception : la librairie XML-RPC n'est pas utilisée, car son installation est devenue trop contraignante depuis PHP 8.

Comment ça marche

Le fonctionnement des pingback est celui-ci :

  • Une personne A écrit un article, avec un lien vers un article de blog, écrit par une personne B
  • Le blog A va envoyer un pingback au blog B pour signaler le lien existant
  • Le blog B va recevoir ce ping. Si tout est correct, il va le traiter et généralement ajouter un commentaire à l'article B, avec le lien vers l'article A
  • Le blog B répond au blog A : Soit une erreur, soit succès

Cette classe va gérer ces envois et réponses presque automatiquement.

Pré-requis

Pingback nécessite PHP >= 7.4 et les librairies suivantes :

  • libxml, installée par défaut depuis PHP 7.4
  • cURL

Installation

Il suffit d'inclure le fichier :

require_once('pingback.php');

Mise en place

Pour mettre en place ce système de pingback, vous devez suivre ces quelques étapes.

Envoyer un pingback

Pour notifier les autres blogs que vous avez écrit un article et que des liens pointent vers leurs articles, il suffit de faire cela :

$ping = new Pingback();
$ping->inspect('http://mydomain.com/blog/my_article');

En remplaçant http://mydomain.com/blog/my_article par l'URL de votre article que vous avez rédigé. La classe Pingback va alors récupérer le contenu de la page, tester tous les liens présents sur celle-ci en checkant la présence d'une balise pingback, et envoyer des pingback à tous les liens valides.

Ajouter une page de pingback

Pour que les autres sites vous répondent, nous allons devoir mettre en place une adresse et une page de pingback. Pour l'exemple, nous créerons ici une page ping.php, destinée à recevoir les pingback que les autres blogs peuvent nous envoyer, mais aussi les réponses à nos pingback. Dans ce fichier, que nous mettrons à la racine du site, mettons ce contenu :

$ping = new Pingback();
$res = $ping->listen('pingCallBack');
if ($res === null) {
  // Erreur pendant le traitement du ping. On envoi l'erreur correspondante et on ferme le script.
  $ping->sendResponse();
}
if (!$res) {
  $ping->generateErrorResponse(Pingback::ERR_ALREADY_REGISTERRED);
}
// On envoi la réponse à l'autre blog
$ping->sendResponse();

function pingCallBack($sourceURL, $targetURL, $reqBody) {
  echo "Un ping est arrivé de $sourceURL vers notre article $target";
  echo "La requête envoyée est de " . strlen($reqBody) . " caractères";
  // Traitement du ping
  if ('lePingEstAjouté') {
    return true;
  } else {
    // On refuse le ping s'il est déjà enregistré
    return false;
  }
}

La méthode listen n'attend qu'un argument : une fonction de callback valide.

  • $sourceURL est l'adresse de l'article qui parle de notre article
  • $targetURL est l'adresse de notre article, celui vers qui le pingback est envoyé
  • $reqBody est le contenu HTML de $sourceURL, page qui a fait un lien vers notre article

Cette méthode va "écouter" toutes les requêtes envoyées à l'adresse http://mydomain.com/ping.php. Si une requête est envoyée en POST, avec une méthode de pingback, et que le ping est valide, alors elle exécutera la fonction de callback fournie en argument (ici la fonction pingCallBack). Si le retour de la méthode est null, alors une erreur a été trouvée pendant le traitement du ping.

Dans la fonction de callback, vous avez le soin de traiter le ping entrant, grâce aux 3 variables fournies et décrites plus haut :

  • Soit vous ajoutez le commentaire
  • Ou alors vous le refusez, peut-être parce qu'il existe déjà par exemple.

Déclarer l'adresse de pingback

Pour le moment, notre adresse de pingback existe (http://mydomain.com/ping.php), mais les autres blogs ne peuvent pas la trouver. Nous allons devoir mettre en place un moyen de faire connaître cette page. Il existe 2 façons de procèder, et une de ces 2 méthodes doit être mise en place sur chaque article où vous souhaitez recevoir des pingback

Header

La première est d'envoyer un header sur la page d'un article de blog :

header('X-Pingback: http://mydomain.com/ping.php');

Balise link

Ou alors, vous pouvez mettre en place dans le <head> de votre page HTML, une balise d'entête destinée à donner aux autres blogs votre adresse de ping :

<link rel="pingback" href="http://mydomain.com/ping.php">

Et c'est tout !

Risques et exploits

Tous les blogs WordPress utilisent l'adresse de pingback suivante : http://domain.com/xmlrpc.php A cause des robots qui tentent de spammer cette adresse, je vous recommande de ne pas utiliser la même, mais préférer par exemple http://domain.com/ping.php.

Enfin, ne mettez en place une des 2 balises pingback que sur les pages qui peuvent réellement accepter les pingback. Sinon, vous allez recevoir des ping inutiles sur votre page contact, sur la liste des articles de blog, etc alors que vous ne pourrez jamais ajouter de commentaire dans ces pages.