Documentation du module Abonnement Page 1 sur 14 Historique des révisions du document
SIST
o Module ABONNEMENT
Manuel d’utilisation :
Module Abonnement
Version Date Modifications Auteur
0.0.1 18/01/2006 Version initiale Olivier DOUARCHE
1.0 25/01/2006 Relecture Cédric CHAMBERLIN
Sommaire
1 INTRODUCTION...4
1.1 PRÉAMBULE... 4
1.2 OBJECTIFS... 4
1.3 PRÉREQUISTECHNIQUES... 4
2 PRÉSENTATION...5
3 FONCTIONNALITÉS...6
3.1 S’ABONNER... 6
3.2 VOIRLESPARAMÈTRESDESONABONNEMENT...9
3.3 SEDÉSABONNER... 9
4 ADMINISTRATION...10
4.1 GESTIONDESABONNÉS...10
4.2 GESTIONDESSITESSYNDIQUÉS...12
5 PARAMÉTRAGE...14
1 INTRODUCTION
1.1 P RÉAMBULE
Le module d’Abonnement permet une diffusion sélective de l’information, provenant soit d’une ou plusieurs équations de recherche Hubble, soit de fils RSS de sites syndiqués.
L’information est envoyée par email ou stockée dans un fichier Xml à la norme RSS 2.0 personnalisé.
1.2 O BJECTIFS
L’objectif de ce document et de décrire les fonctionnalités du module d’abonnement et la manière de le mettre en œuvre via son interface d’administration.
1.3 P RÉ REQUIS TECHNIQUES
Le module Abonnement fonctionne sur la plateforme suivante : - PHP v4.3 est supérieure,
- Base MySql v3.23 est supérieure, - Environnement Linux,
- Javascript activé,
- Script de diffusion à placer dans la crontable,
- Nécessite le dossier Commun au même niveau que le répertoire du module.
2 PRÉSENTATION
Le module d’Abonnement se présente sur la partie publique du site comme un formulaire permettant à tout utilisateur de s’abonner à la diffusion sélective de l’information.
Les informations pour lesquelles l’utilisateur s’abonne sont de 2 types : - Des fils RSS provenant de sites syndiqués
- Des équations de recherche Hubble
L’utilisateur définit la fréquence de la diffusion de l’information ainsi que le moyen.
Ce moyen peut être de 2 sortes :
- Soit l’information est envoyée par email à l’adresse spécifiée lors de l’ouverture du compte
- Soit l’information est stockée dans un fichier RSS personnalisé (backend), l’adresse de récupération de ce fichier est alors fournie à l’utilisateur.
3 FONCTIONNALITÉS
3.1 S’ ABONNER
Pour s’abonner la saisie de plusieurs informations est obligatoire :
- L’email : l’email est en quelque sorte le moyen d’identifier un utilisateur.
Cependant un utilisateur peut créer un abonnement pour plusieurs emails sans problèmes.
- Le mot de passe : pour chaque abonnement un mot de passe est requis afin de protéger le compte.
- Le choix d’un site syndiqué ou d’une équation de recherche Hubble : il est nécessaire d’indiquer au moins une source d’information à laquelle on souhaite s’abonner.
- La date de départ : la date de départ détermine à partir de quel moment le gestionnaire de diffusion sera mis en œuvre pour l’abonnement.
- La périodicité : elle détermine la fréquence d’envoi de l’information
- Le type de diffusion : le type de diffusion correspond au moyen d’accès à l’information, soit par email, soit en récupérant un fichier RSS mis à disposition par la plateforme.
Information de l’utilisateur
Sites syndiqués
Recherche Hubble
Fréquence de la diffusion
Moyens de diffusion
Une fois ces informations renseignées, il suffit de cliquer sur le bouton « S’abonner » pour procéder à l’enregistrement de l’abonnement.
Lorsque l’abonnement s’est bien déroulé un message de confirmation s’affiche en fonction de vos paramètres :
Dans le cas d’un abonnement par émail Ou
Dans le cas d’un abonnement par fichier backend
3.1.1 Ajout d’une équation de recherche Hubble
Pour s’abonner à une équation de recherche Hubble, il suffit de : - Cocher une ou plusieurs sources :
o cette opération peut s’effectuer soit en sélectionnant directement une source au moyen de leur case à cocher respectives, soit en sélectionnant un filtre particulier grâces aux différentes listes de choix (Pays, Thème, Catégorie, Type). Des sources protégées peuvent également être déverrouillées en saisissant le code de déverrouillage et en cliquant sur
« Ok ».
- Renseigner des critères de recherche
o Les critères de recherches peuvent comporter plusieurs mots séparés par des espaces.
- Cliquer sur le bouton « Ajouter »
Pour plus de détails sur la manipulation du formulaire d’interrogation du moteur Hubble, veuillez vous conférer à sa documentation.
Une fois l’équation de recherche ajoutée, celle-ci apparaît dans un tableau récapitulatif :
3.1.2 Suppression d’une équation de recherche Hubble
Pour supprimer une équation de recherche préalablement saisie, il suffit de cliquer sur le bouton « » correspondant.
3.2 V OIR LES PARAMÈTRES DE SON ABONNEMENT
Les utilisateurs déjà inscrits peuvent visualiser les paramètres de leur abonnement, pour cela ils doivent saisir :
- L’email
- Le mot de passe et cliquer sur le bouton « Voir »
3.3 S E DÉSABONNER
Pour se désabonner, il suffit de renseigner : - L’email
- Le mot de passe
et cliquer sur le bouton « Se désabonner »
Une fois l’action effectuée un message d’information s’affiche :
4 ADMINISTRATION
Pour administrer ce composant, rendez-vous au niveau de la gestion des modules dans la partie back-office du framework
4.1 G ESTION DES ABONNÉS
En cliquant sur le l’entrée « Les abonnés » du menu du composant, la page présentant la liste des abonnés s’affiche.
Pour chaque abonné il est possible de : - Le modifier
- Le supprimer
4.1.1 Modifier un abonné
Il est alors possible : - de modifier l’email
- de modifier le mot de passe
Les boutons :
- « » procède à l’enregistrement des modifications - « » permet de revenir à la liste des abonnés
4.1.2 Supprimer un abonné
Depuis la liste des abonnés, en cliquant sur le bouton « », une demande de confirmation de la suppression s’affiche
En cliquant sur le bouton « Ok », la suppression devient effective.
4.2 G ESTION DES SITES SYNDIQUÉS
En cliquant sur le l’entrée « Les sites syndiqués » du menu du composant, la page présentant la liste des sites syndiqués s’affiche.
Pour chaque site syndiqué, il est possible de : - Le modifier
- Le supprimer
Il est également possible d’ajouter un nouveau site syndiqué.
4.2.1 Ajouter ou modifier un site syndiqué
Depuis la liste des abonnés, en cliquant sur le bouton de création « » ou sur le bouton de modification « », le formulaire de gestion d’un site syndiqué s’affiche.
Il est alors possible :
- de modifier Le nom du site
- de modifier l’URL de syndication (lien vers le fichier backend)
Les boutons :
- « » procède à l’enregistrement des informations - « » permet de revenir à la liste des sites syndiqués
4.2.2 Supprimer un site syndiqué
Depuis la liste des sites syndiqués, en cliquant sur le bouton « », une demande de confirmation de la suppression s’affiche
En cliquant sur le bouton « Ok », la suppression devient effective.
5 PARAMÉTRAGE
Le module d’Abonnement nécessite un paramétrage pour définir certaines variables.
Editez le fichier AbonnementParam.inc visible dans le répertoire /var/www/html/[MON_SITE]/modules/Abonnement
Paramétrez les variables suivantes :
$_SESSION["ABONNEMENT"]["MAX_REQUETE"] = 5;
Nombre maximum de requête Hubble auxquelles l’utilisateur peut s’abonner
Donner les droits d’écriture sur le répertoire Abonnement/Cron pour le user Apache
Donner les droits d’écriture sur le répertoire Abonnement/Temp pour le user Apache
La diffusion quotidienne pourra être effectuée par le fichier Abonnement.cron (disponible dans Abonnement/Cron) à rajouter dans le /etc/cron.daily/
rm -f [PATH_SITE]/modules/Abonnement/Cron/Temp/*
wget [URL_SITE]/modules/Abonnement/Cron/LanceurImportBackend.php -O [PATH_SITE]/modules/Abonnement/Cron/Temp/backend.log
wget [[URL_SITE]/modules/Abonnement/Cron/LanceurRequeteurHubble.php -O [PATH_SITE] /modules/Abonnement/Cron/Temp/requete.log
wget [[URL_SITE]/modules/Abonnement/Cron/LanceurDiffuseur.php -O [PATH_SITE]/modules/Abonnement/Cron/Temp/diffuseur.log
Les fichiers :
/modules/Abonnement/Cron/Temp/backend.log /modules/Abonnement/Cron/Temp/requete.log /modules/Abonnement/Cron/Temp/diffuseur.log seront ainsi générés.
