Import ICS — agenda distant

Le besoin

Le plugin Agenda permet de gérer des évènements. Il peut être utile de récupérer automatiquement des évènements d’un site distant qui fournirait un fichier .ics, afin de proposer un site agrégeant les calendriers de différents sites.

Exemple de cas d’application:

• des séminaires de recherche de plusieurs organismes diffusés sur le même site;
• un site d’information locale reprenant les évènements des associations et entreprises locales;
• un site d’association affichant les évènements de ses partenaires.

Utilisation avec un site SPIP distant

Dans le cas d’un site distant sous SPIP utilisant le plugin agenda, le fichier .ics distant est disponible à la page http://url-du-site/spip.php?page=agenda-ical. Un paramètre &id_article=xxx ou &id_mot=xxx peut être ajouté pour filtre par article ou par mot clé.

Fonctionnement

Ce plugin permet de s’abonner à un calendrier distant. L’abonnement se fait via la création d’un nouvel objet “Almanach”. Celui-ci est lié à un fichier ics distant. Le plugin lira régulièrement ce fichier et ajoutera automatiquement des évènements dans la base de données du site SPIP local. Les évènements créés sont du même type que ceux gérés par le plugin Agenda.

Les évènements ainsi ajoutés seront liés:

• à l’almanach;
• à l’article choisi lors de la création de l’almanach;

Ce plugin ajoute donc une entrée “Almanachs” au menu “Édition” ainsi qu’un bouton d’ajout rapide d’almanach. Les évènements importés sont liés à ces objets.

La page {Almanachs} permet de lister les almanachs présents sur le site et de les administrer.

Configuration du plugin

Une fois le plugin installé, il existe deux possibilités de configurer le plugin:

• soit à travers le formulaire accessible à travers le lien de configuration sur la page de gestion des plugins ;
• soit par des constantes PHP mises dans le fichier mes_options.php – ou dans un fichier options.php d’un plugin. Ceci permet de déployer rapidement à grande échelle une configuration du plugin.

La configuration PHP l’emporte sur la configuration par formulaire.

Voici la liste des paramètres configurables:

• Définir l’article par défaut. Pas de constante PHP.
• Archiver automatiquement les évènements distants qui ne sont plus présents dans le fichier ics distant lors de la vérification de celui-ci. En PHP define ('_IMPORT_ICS_DEPUBLIER_ANCIENS_EVTS','on');.
• Ne pas importer les évènements passés, utiles pour les sites qui se contente d’afficher les évènements à venir.
• Permettre d’éditer certains champs manuellement

Ajouter un almanach

L’ajout d’un almanach est simple. Il suffit de remplir le formulaire d’ajout dans lequel tous les champs sont obligatoires.

L’url du flux peut être de la forme http, https ou webcal.

Une fois le formulaire validé, les évènements importés apparaissent dans la page récapitulative de l’almanach. Si ces évènements sont trop nombreux, la liste est paginée. Le plugin récupérera à intervalle régulier la nouvelle version du flux pour mettre à jour la liste des évènements.

À noter :

• si un évènement apparaît dans plusieurs flux avec le même uid (identifiant unique distant), il ne sera pas réimporté ;
• afin que la reconnaissance de l’heure d’été / d’hiver puisse fonctionner, il est nécessaire que la configuration PHP ait un timezone correspondant à un pays où le changement d’heure est effectué. SPIP permet de configurer si besoin le timezone.

Supprimer un almanach

Pour supprimer un almanach, le passer en statut “à la poubelle”. Tous les évènements liés sont alors basculés en “à la poubelle”.

Comme pour les articles, SPIP supprime régulièrement les évènements et les almanachs à la poubelle.

Statut des évènements

Les évènements possèdent le statut de l’almanach:

• si l’almanach est publié, les évènements sont automatiquement publiés (modération a posteriori), à condition que l’article lui-même soit publié ;
• si l’almanach est proposé, les évènements sont proposés, et il vous faut les publier manuellement (modération a priori).

Lorsque vous modifiez le statut d’un almanach, les évènements voient leurs statuts modifiés.

Lorsque vous modifiez le statut d’un article, les évènements et almanachs liés voient leurs statuts modifiés.

Le plugin ajoute également un statut “archivé” aux évènements, pour les évènements qui ne sont plus présents sur le flux distant. Une fois un évènement archivé, il n’est plus jamais désarchivé, sauf intervention manuel d’un·e rédacteur·ctrice.

Mots-clé

Dans la configuration des mots-clé, vous pouvez activer l’ajout de mots-clés aux almanachs.

Les évènements associés à un almanach reçoivent automatiquement les mots-clé de l’almanach. Si les mots-clé de l’almanach changent, les mots-clé des évènements sont automatiquement modifiés.

Outils pour squelette

Le plugin ajoute le critère {id_almanach} sur la boucle (EVENEMENTS) pour sélectionner les évènements liés à un almanach précis.

Usages avancés

Champs extras, adresse, gestion des inscriptions

Le flux ICAL du plugin peut agenda peut transmettre, sous forme de propriété supplémentaire :

• l’adresse (et pas seulement le lieu)
• le nombre de places et s’il faut gérer les inscriptions
• les éventuels champs extras Pour ce faire il faut definir à true la constant PHP _EVENEMENT_ICAL_X_PROPERTIES.

Techniquement, ces champs sont passés dans le flux ICAL sous forme de propriétés préfixées par X. Dans l’exemple ci-dessous, est indiqué l’adresse, le nombre de place, la gestion de la réservation ainsi qu’un champ extra public.

X-ADRESSE:3 place Babel
X-INSCRIPTION:1
X-PLACES:10
X-PLACES-RESERVEES:6
X-PLACES-RESTANTES:4
X-PUBLIC:enfants

Un site SPIP peut abonné à flux distant peut également insérer la valeur de ces champs dans sa base de données. Les champs synchronisés sont :

• adresse
• nombre d’inscriptions
• gestion des inscriptions
• champs extra, s’ils existent sur le site receveur, L’identification se base par homonymie. Ainsi dans l’exemple précédent, X-PUBLIC alimentera le champ public.

Pipeline

Le principe du plugin est de convertir des champs d’un flux ICAL en champ SQL. Le plugin propose des équivalences par défaut. Mais il est possible de modifier cela, en utilisant le pipeline evenement_ical_to_sql. Ce pipeline reçoit en arguments:

• data la valeur des champs SQL qui seront mis en base;
• args un tableau regroupant différents paramètres :
  • objet_evenement un objet PHP décrivant l’évènement, généré par la librairie IcalCreator
  • decalage : les infos à propos du décalage horaire pour l’almanach courant
  • dtend_inclus : si le DTEND est inclus dans l’évènement pour l’almanach courant
  • xprops les propriétés ICAL d’évènements préfixées par X; qui sont difficiles à récupérer depuis objet_evenement
  • champs_x la liste des champs SQL ayant des équivalents potentiels dans les propriétés ICAL préfixées par X (champs extra, gestion des inscriptions, etc).

Exemple : pour un site, je souhaite que la synchronisation des évènements récupère dans le champ places le nombre de places restantes, et non pas le nombre de places totales. Après avoir déclarer dans paquet.xml l’emploi du pipeline, je le règle ainsi :

function formations_evenement_ical_to_sql($flux = array()) {
	if (isset($flux['data']['places'])) {
			$flux['data']['places'] = $flux['args']['xprops']['X-PLACES-RESTANTES'];
	}
	return $flux;
}

Fréquence d’actualisation

Toutes les 5 minutes, sous réserves que le site soit visités, le plugin :

• recherche le flux dont l’actualisation est la plus ancienne, s’il a été actualisé il y a plus de 1,5 h ;
• recherche un flux qui a (éventuellement) échoué à être actualisé, il y a plus de 1,5 h, en commencant par celui dont l’echec d’actualisation est le plus ancien ;
• actualise les 1 ou 2 flux trouvés.

Il est possible de définir dans un fichier mes_options.php la constante _PERIODE_IMPORT_ICS pour régler le temps d’actualisation (en secondes, par défaut 5400 = 1,5h).

Attention à ne pas actualiser trop souvent : lire un flux ICAL et l’interpréter mobilise des ressources importantes.