Evénements

De ISPWiki.

Le mécanisme des évènements sert d'une extension supplémentaire du panneau grâce à l'ajout des programmes CGI d'utilisateur ou des scripts qui seront lancés automatiquement après l'exécution d'une fonction adéquate.

Il y a trois types du manipulateur d'événements:

• Evénements indépendants lançant après la bonne exécution d'une fonction, ces événements n'affectent pas de résultats de cette fonction. Mais, tels manipulateurs peuvent appeler les fonctions de manager.
• Lançant avant l'exécution d'une fonction. Tels événements ne peuvent pas appeler au manager. Mais, ils renvoient xml qui sera lié avec xml créé par manager. De plus, si cet événement renvoie une erreur, le manipulateur de la fonction manager ne sera pas appelé.
• Lançant après l'exécution d'une fonction. Tels événements ne peuvent pas appeler au manager. Mais, ils renvoient xml qui sera lié avec xml créé par manager. A l'encontre du type d'événement précédent, ces événements seront appelés si la fonction de manager est exécutée avec succès.

Quand les xml sont liés, les balises auront la valeur suivante:

• error - une erreur lors du traitement d'un événement. Aucunes balises ne seront traités après cette balise.
• redirect - une redirection. Le contenu de cette balise sera redirigé au client au format de javascript. Par exemple: location='ispmgr?func=usrparam' provoque l'ouverture du formulaire des paramètres d'utilisateur.
• ok - signifie une valeur de la balise ok.
• param - les données d'une balise seront ignorées.

Le programme GGI (manipulateur d'événements) reçoit les mêmes données d'entrée que le panneau d'administration. Ce programme donne le xml correct de sortie (résultat des manipulateurs indépendants n'a aucune valeur).

Pour que vous sachez le nom d'utilisateur qui a appelé cette fonction, veuillez utiliser REMOTE_USER. Vous pouvez être sûr que cet utilisateur a passé son authentification.

Les variables de situation sont disponibles (ENV):

• AUTHID - l'id unique de la session.
• REMOTE_USER - le nom d'utilisateur qui a demandé la fonction.
• SESSION_LEVEL - le niveau d'utilisateur qui a demandé la fonction.
• SESSION_LANG - la langue de l'interface d'utilisateur
• RECORDLIMIT - le quota sur le nombre d'enregistrements dans le tableau (spécifié dans les paramètres du panneau). Lorsque vous créez le tableau, le plugiciel ne doit pas créer plus enregistrements que indiqué dans ce paramètre. Dans ce cas la bannière correspondante s'affichera.
• MGR - le nom de produit (par exemple: ispmgr). Vous pouvez l'utiliser quand le même plugiciel est destiné à être utilisé avec plusieurs produits.
• MGR_DISTRIBUTION - le nom complet du logiciel de distribution (par exemple: ISPmanager-Lite).
• MGR_VERSION - la mise à jour du logiciel.
• MSG_OSNAME - le système d'exploitation de ce logiciel.
• LICID - le numéro de licence qui peut être utilisé pour autoriser vos plugiciels. A noter! Les licences sont fournies pour une gamme d'adresses IP, dans ce cas la plupart des licences auront le même numéro.

Pour ajouter votre manipulateur d'événements, il faut suppléer à xml:

<handler name="myhandler" type="cgi">
  <event after="yes">eventname</event>
</handler>

myhandler - le nom de votre programme qui doit être placé dans la catalogue /usr/local/ispmgr/addon

eventname - le nom d'événement. Vous pouvez prendre la liste des événements possibles à l'aide d'une fonction du panneau d'administration eventlist, par exemple en utilisant mgrctl:

/usr/local/ispmgr/sbin/mgrctl eventlist