Import ICS 2 et supérieur (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 [1], 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.

Note sur la présente documentation

Le présent article documente la version 4.6.0 du plugin.

Configuration requise

Le plugin nécessite les plugins suivants :
-  Agenda
-  Icalendar
-  Saisies
-  Champs extra core

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 [2].

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

Voici la liste des paramètres configurables :

-  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');.
-  Définir l’article par défaut. Pas de constante PHP.

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 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.

A noter :
-  si un évènement apparait 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é. Vous pouvez utiliser le plugin Timezone si vous ne disposez pas de l’accès à la configuration php.

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 modifier le statut d’un almanach, les évènements voient leurs statuts modifiés.

Lorsque vous modifier 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

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

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