Qu’on se le dise : le compteur de lecteurs Feedburner par défaut est sympa mais s’intègre mal dans n’importe quel design de site Web. Lors de la refonte du thème graphique de ce blog, j’ai eu envie de remettre mon compteur d’abonnés Feedburner mais sous forme de texte. Même si le chiffre indiqué peut se révéler inexact, j’estime que c’est un indicateur intéressant sur la consultation d’un flux. Je suis également convaincu qu’à partir d’un certain nombre de lecteurs, ça facilite la conversion : si le nombre est élevé, c’est que le site est bien  … donc je m’abonne.

Bref, j’ai voulu implémenter ça de manière propre et peu gourmande avec WP-Cron, l’API Feedburner Awareness et la classe PHP 5 SimpleXML. Une poignée de lignes de code suffisent, pourquoi s’en priver ?

Le besoin

La plupart des exemples que l’on trouve sur le Web attaquent directement l’API Feedburner Awareness. Autrement dit, votre page ne s’affichera pas tant que l’API n’aura pas été appelée et son résultat interprété. Étant donné que cette valeur change 1 fois par jour, il vaut mieux aborder la chose différemment. C’est pourquoi je voulais :

• récupérer 1 à 2 fois par jour la valeur courante du nombre de lecteurs ;
• accéder à cette valeur simplement depuis mes templates (avec un appel à get_option() par exemple).

On y gagne sur tous les fronts : on ne ralentit pas l’affichage côté utilisateur, l’information est récupérée en arrière-plan, nos templates graphiques restent simples.

Activation du service Feedburner Awareness

La première chose à faire est d’activer l’API Awareness pour votre flux. Cette API permet de récupérer des statistiques sur un flux Feedburner au format XML. On y retrouve entre autre le nombre de lecteurs. On peut obtenir ces informations pour la date courante, la veille ou une plage de jours par exemple.

C’est vraiment simple à utiliser, la documentation Feedburner Awareness est complète dans son genre.

Activation du service Feedburner Awareness

Remarque : cette API s’active par flux Feedburner de manière individuelle et est désactivée par défaut.

Extraction du nombre de lecteurs

Dans un premier temps, on va récupérer le nombre de lecteurs pour son flux. On verra dans un second temps comment l’automatiser.

Le principe est simple : on appelle une URI avec son identifiant de flux Feedburner (exemple dans mon cas : http://feeds.feedburner.com/LaCaseDeLoncTom). On lui spécifie 2 dates : la veille et l’avant-veille. Pourquoi ? Car les données de la veille ne sont pas toujours existantes : les compteurs sont actualisés à 11h heure française. L’idée est de pouvoir se mettre un nombre de lecteurs sous la dent.

define('FEEDBURNER_URI', 'LaCaseDeLoncTom');
function oncletom_update_feed_readers()
{
  $uri = sprintf('https://feedburner.google.com/api/awareness/1.0/GetFeedData?uri=%s&dates=%s,%s',
    FEEDBURNER_URI,
    date('Y-m-d', strtotime('-2 day')),
    date('Y-m-d', strtotime('-1 day'))
  );
  $http = new WP_Http();
  $readers = (int)get_option('feed_readers');
  $response = $http->get($uri);
  $xml = new SimpleXMLElement(WP_Http::chunkTransferDecode($response['body']));
  $feed = (array)$xml->feed;
  foreach (array_reverse($feed['entry']) as $entry)
  {
    if ((int)$entry['circulation'])
    {
      $readers = (int)$entry['circulation'];
      update_option('feed_readers', $readers);
      break;
    }
  }
  return $readers;
}

Quelques remarques :

• j’ai utilisé la classe  WP_http qui fournit une abstraction d’appel à des ressources distantes. C’est le plus propre pour fonctionner sur la majorité des installations ;
• j’inverse le tableau des résultats car ils sont triés par ordre chronologique croissant par défaut  ; nous voulons l’information la plus fraîche d’abord ;
• on aurait pu utiliser un paramètre de fonction pour fournir l’URI du flux mais dans l’étape d’après, il se trouve qu’on ne pourra lui en passer … dommage ;
• on aurait également pu remplacer la constante par un appel à un get_option() et pourquoi pas, récupérer l’ID depuis un réglage du plugin Feedburner FeedSmith.

Programmation d’une tâche planifiée avec WP-Cron

On en arrive à la partie sympa : programmer cette récupération du nombre d’abonnés pour qu’on n’ait pas de travail manuel à faire. L’idéal est de placer ceci dans un plugin. Personnellement je l’ai inséré dans le hook switch_theme() de mon thème pour économiser un fichier/plugin.

//dans un fichier wp-content/plugins/oncletom-awareness-cron.php
/*
Plugin Name: Simple Feedburner Awareness
Description: Asynchroneous feed readers collector scheduled twice a day.
Author: Oncle Tom
Version: 1.0
Author URI: http://case.oncle-tom.net/
Plugin URI:
  This plugin is released under version 3 of the GPL:
http://www.opensource.org/licenses/gpl-3.0.html
*/
register_activation_hook(__FILE__, 'oncletom_awareness_cron_activate');
register_deactivation_hook(__FILE__, 'oncletom_awareness_cron_deactivate');
add_action('oncletom_cron_twicedaily_hook', 'oncletom_update_feed_readers');
function oncletom_awareness_cron_activate()
{
  add_option('feed_readers', 0, '', 'yes');
  wp_schedule_event(time(), 'twicedaily', 'oncletom_cron_twicedaily_hook');
}
function oncletom_awareness_cron_deactivate()
{
  delete_option('feed_readers');
  wp_clear_scheduled_hook('oncletom_cron_twicedaily_hook');
}

Vous vous souvenez encore de notre fonction oncletom_update_feed_readers() ? Et bien on pourrait la rajouter dans ce plugin pour tout avoir au même endroit. L’organisation de votre code vous appartient

Quoiqu’il en soit, une fois le plugin activé, tout est prêt : il ne reste qu’à intégrer le compteur d’abonnés dans le thème. C’est notre prochaine étape.
Juste une remarque : la fonction wp_schedule_event() prend comme dernier argument un nom de hook et non un nom de fonction.

Intégration dans le thème

C’est la partie la plus simple et pour cause, un simple appel à get_option('feed_readers') nous retourne le nombre d’abonnés. On ne pouvait pas faire plus rapide

<p>J'ai <?php echo get_option('feed_readers') ?> abonnés</p>

Conclusion

WordPress fournit tous les mécanismes pour accéder aisément à des données de manière asynchrone. Il ne nous a pas coûté grand chose de collecter le flux XML et de l’enregistrer. En le faisant ainsi en arrière plan, on évite toute gêne pour l’utilisateur et tout traitement superflu exécuté en affichage.

Assez étonnamment, je n’ai croisé aucune extension dans le catalogue WordPress. J’espère que ça vous dépannera et que votre thème graphique appréciera !
Mise à jour : aucun plugin n’était tagué awareness ; FeedBurnerCount, Feed Subscriber Stats et Feedburner Text Count produisent très probablement le même résultat que le contenu de cet article.

Pour mesurer l’utilisation des flux RSS d’Emu Nova, j’ai décidé d’utiliser Feedburner dans sa version gratuite. Je l’utilise déjà pour ce blog et j’en suis très satisfait, que ce soit pour les données fournies, les personnalisations possibles ou encore la qualité du service.

La problématique du jour : comment utiliser Feedburner sur des flux RSS déjà existants ? Le changement doit être transparent pour les utilisateurs.

Créer son flux Feedburner

Avant de faire quoi que ce soit, il convient de créer son flux Feedburner à partir d’un flux déjà existant (qu’on souhaite rediriger tant qu’à faire). L’étape la plus simple.

Modifier les liens vers les flux

Une fois le flux créé, pensez à mettre à jour tous vos liens pointant vers ce fichier (balises <link />, liens hypertextes, boutons personnalisés etc.). Ceci a pour but d’unifier toute les adresses et éviter qu’il y aient plusieurs adresses visibles pour accéder à la même information.

Rediriger les flux existants

Arrivé à ce stade, il faut bien comprendre que nous avons 2 cas de figure :

• les anciens abonnés : ceux qui ont souscrit au flux avant que la modification précédente n’ait eu lieu. Le changement doit être transparent pour eux et ils ne doivent pas avoir à modifier la configuration de leurs agrégateurs actuels
• les nouveaux abonnés

L’intérêt est d’auditer tous les abonnés et donc pas seulement les nouveaux. C’est là que la redirection s’avère indispensable.
On est bien d’accord qu’il faudrait créer une redirection renvoyant l’ancienne adresse du flux vers la nouvelle adresse (celle fournie par Feedburner).

Le plus simple consiste à créer un fichier .htaccess (ou d’éditer directement les directives de votre serveur virtuel) dans le même répertoire que celui du fichier XML. Il contiendrait ce code :

RewriteEngine on
RewriteRule ^votreFlux\.xml$ http://feeds.feedburner.com/votreFluxFeedburner [R=301,L]

On teste, ça marche. Un peu trop bien puisqu’en suivant ce principe, quiconque appelle la véritable URL de votre flux sera redirigé vers le flux Feedburner. Si en soi ça ne pose pas problème majeur, ça l’est pourtant pour le robot d’indexation Feedburner qui, lui, a besoin d’accéder au véritable flux pour en extraire les informations.

Feedburner ayant bien fait les choses, leur robot d’indexation se signale en envoyant une entête User Agent FeedBurner/1.0 (http://www.FeedBurner.com). Ca tombe bien, il existe un filtre RewriteCond dans le module mod_rewrite. Ce dernier va nous servir à exclure le robot Feedburner de notre redirection précédente.

Juste au-dessus de notre RewriteRule, il suffit d’insérer la ligne suivante :

RewriteCond %{HTTP_USER_AGENT} !FeedBurner

L’utilisation de cette condition est d’ailleurs la seule raison pour laquelle une règle de réécriture a été employée en lieu et place d’un RedirectPermanent.
Attention cependant, le RewriteCond est à spécifier à chaque règle de réécriture. La documentation est assez explicite à ce sujet : la condition n’est effective que pour une seule règle de réécriture.

Le résultat final

Et plutôt qu’un long discours, voici le résultat final obtenu pour Emu Nova. Les fichiers RSS étaient placés dans le répertoire go/rss/. J’y ai donc placé un fichier .htaccess contenant le code suivant :

RewriteEngine on
RewriteCond %{HTTP_USER_AGENT} !FeedBurner
RewriteRule ^news\.xml$ http://feeds.feedburner.com/emunovaNews [R=301,L]
RewriteCond %{HTTP_USER_AGENT} !FeedBurner
RewriteRule ^veda\.xml$ http://feeds.feedburner.com/emunovaVedaTests [R=301,L]
RewriteCond %{HTTP_USER_AGENT} !FeedBurner
RewriteRule ^veda_commentaires\.xml$ http://feeds.feedburner.com/emunovaVedaCommentaires [R=301,L]

Pas difficile et tellement pratique