Boussole v2, nouveau fonctionnement client-serveur

L’objectif de cette nouvelle version v2 du plugin est de simplifier les mises à jour d’une boussole pour les sites utilisateur en ne les obligeant plus à upgrader leur plugin Boussole comme c’est le cas avec les versions v0 et v1.

L’article Evolution v2 du plugin Boussole décrit plus précisément les problèmes posés par la v1 et les nouvelles exigences qui ont conduit à l’élaboration de cette v2.

Migration du plugin en version 2

Si vous avez déjà le plugin Boussole en version 0 pour SPIP 2 ou 1 pour SPIP 3 vous êtes concernés par ce chapitre.

Pour migrer Boussole en version 2, désactiver tout d’abord la version 0 ou 1 déjà installée. Surtout ne désinstallez pas le plugin sinon vous perdrez d’emblée les boussoles que vous avez ajoutées et configurées.

Ensuite installez la version 2 et activez-la. Le processus d’installation procèdera à la migration du schéma de la base de données (structure des tables) et des informations de la «boussole SPIP» uniquement. En effet, les autres boussoles ne peuvent être migrées car on ne connait pas leur serveur a contrario de la «boussole SPIP» qui est d’ores et déjà servie par le site boussole.spip.net.

En conclusion, si vous n’utilisez que la «boussole SPIP» le processus de migration est immédiat. Les modèles n’ayant pas été modifiés, les affichages seront conservés.
Si par contre vous avez d’autres boussoles il faudra les ajouter et les configurer à nouveau.

Si vous souhaitez en savoir plus sur la nouvelle version, vous pouvez lire la suite de cet article. Sinon, pour utiliser les fonctions client (affichage, configuration...) veuillez toujours lire l’article de référence Boussole qui reste d’actualité.

Un gestionnaire et des boussoles

L’objectif principal de cette refonte du plugin Boussole était de simplifier la mise à jour des modifications de la «boussole SPIP» sur les sites utilisateurs, en particulier ne pas avoir à upgrader le plugin lui-même.

Une première réponse a été de scinder le plugin Boussole v1 en deux plugins distincts :

  • le plugin Boussole v2 proprement dit, dont la fonction client se limite à gérer les boussoles, leur ajout, leur suppression, leur mise à jour et leur affichage, et la fonction serveur à envoyer sur demande les informations sur une boussole. C’est un gestionnaire de boussoles qui fonctionne aujourd’hui en mode client et serveur comme expliqué plus loin dans l’article.
  • la «Boussole SPIP», incluse aujourd’hui dans un plugin dédié et contenant les informations littérales, les logos et le fichier XML de description.

Ainsi, pour un site souhaitant afficher la «Boussole SPIP» —ou tout autre boussole— il suffit d’installer le plugin «gestionnaire» Boussole v2.

Par contre, le plugin «Boussole SPIP» n’est utile que pour le serveur hébergeant cette boussole, à savoir, aujourd’hui boussole.spip.net. L’intérêt d’un plugin pour cette boussole réside dans la facilité d’installation, de mise à jour et surtout la traduction via le site trad.spip.net.

Fonctionnement serveur

À partir du moment où la «Boussole SPIP» —et toute autre boussole— n’est plus incluse dans le plugin Boussole v2, il devient indispensable de proposer un service fournissant ces données à tous les sites utilisateurs.

C’est ainsi que le plugin Boussole v2 intègre aujourd’hui une fonction serveur qui permet de mettre à disposition des sites clients les informations d’une boussole (sites, groupes, traductions) ainsi que ses logos.
Le mode serveur n’est pas actif par défaut car il est assez rare qu’on en ait besoin.

Pour en savoir plus sur ce mode et sur la façon de créer un serveur veuillez lire l’article Boussole v2, usages avancés.

Fonctionnement client

La fonction client de Boussole v2 n’a pas été modifiée dans son utilisation basique. Les affichages par les modèles ont été strictement conservés à l’instar du formulaire de configuration. Du point de vue utilisateur l’expérience est inchangée.

Néanmoins, la mise à jour des boussoles a été adaptée pour coller au nouveau mode client-serveur. En outre, les informations littérales (nom, slogan et description) sont maintenant chargées en base de données ce qui a nécessité un upgrade du schéma.

L’actualisation des boussoles est toujours faite une fois par jour, automatiquement.

updated on 16 March 2019

Discussion

Une discussion

Comment on this article

Who are you?
  • [Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom