Winnt is not NT
On voit plus ou moins régulièrement sur les forums des demandes concernant des scripts afin de surveiller la modification, suppression… de fichiers ou répertoires.
Généralement, les réponses orientent sur la création de scripts lancés par cron à intervalles réguliers ou, moins fréquemment, sur l’utilisation de inotify (intégré au noyau de puis le 2.6.13).
Ces réponses, si elles sont pertinentes, posent des problèmes soit de charge (exécution inutile de script avec cron) soit des difficultés d’extensibilité ou maintenance.
C’est la que Incron peu apporter une réponse simple et facile à mettre en oeuvre.
Alors que cron réagis en fonction des heures, minutes, mois…
Incron réagis en fonction des événements affectant les fichiers tels modification, accès, suppression, déplacement…
D’ailleurs Incron n’est rien d’autre que l’acronyme de Inotify Cron.
Cette capacité à réagir aux événements fichiers va être mise en place au travers de incrontab tout comme cron au travers de crontab.
Une fois installé nous pourrons aborder un exemple très simple d’utilisation d’incron.
Sous Debian :
aptitude install incron inotify-tools
Pous les autres distributions la manipulation est similaire avec le gestionnaire de paquets de celles-ci.
Le fichier /etc/incron.conf contient les paramètres de fonctionnement d’incron. Ce fichier est très simple et facilement compréhensible.
Incron réagis à des événements mais sans une liste de ceux-ci cela sera bien difficile de faire quoi que ce soit.
Heureusement pour nous, incrond, le démon d’incron nous permet d’en avoir la liste très facilement en saisissant la commande suivante :
incrond -t
Résultat de la commande :
| IN_ACCESS | Le fichier a été accèdé en lecture (). |
| IN_ATTRIB | Les métadonnées ont changés, par exemple, les permissions, l’horodatage, les attributs étendus, le nombre de liens (depuis Linux 2.6.25), uid, gid, etc… () |
| IN_CLOSE_WRITE | Le fichier ouvert en écriture a été fermé (). |
| IN_CLOSE_NOWRITE | Le fichier non ouvert en écriture a été fermé (). |
| IN_CREATE | Un fichier ou répertoire a été créé dans le répertoire surveillé (). |
| IN_DELETE | Un fichier ou répertoire a été supprimé à partir du répertoire surveillé (). |
| IN_DELETE_SELF | Le fichier ou répertoire surveillé a été lui-même supprimé. |
| IN_MODIFY | Le fichier a été modifié (). |
| IN_MOVE_SELF | Le fichier ou répertoire surveillé a été lui-même déplacé. |
| IN_MOVED_FROM | Le fichier a été déplacé hors du répertoire surveillé (). |
| IN_MOVED_TO | Un fichier a été déplacé dans le répertoire surveillé (). |
| IN_OPEN | Le fichier surveillé a été ouvert (). |
Lors de la surveillance d’un répertoire, les événements marqués d’un astérisque (*) ci-dessus peuvent se produire pour les fichiers dans le répertoire, auquel cas le nom retourné identifie le nom du fichier dans le répertoire.
La macro IN_ALL_EVENTS est définie comme l’ensemble des événements ci-dessus.
Deux macros supplémentaires sont définie : IN_MOVE, qui équivaut à IN_MOVED_FROM | IN_MOVED_TO et IN_CLOSE, qui équivaut à IN_CLOSE_WRITE | IN_CLOSE_NOWRITE.
| IN_DONT_FOLLOW (depuis Linux 2.6.15) | Ne pas déréférencer chemin s’il s’agit d’un lien symbolique. |
| IN_ONESHOT | Surveiller chemin pour un événement, puis le retirer de la liste de surveillance. |
| IN_ONLYDIR (depuis Linux 2.6.15) | Surveiller chemin si c’est un répertoire. |
| IN_ISDIR | La cible de cet événement est un répertoire. |
| IN_UNMOUNT | Le système de fichiers contenant l’objet surveillé a été démonté. |
La table contenant les règles incron est invoquée par la commande :
incrontab -e
La ligne décrivant les règles dans la table est séparée en quatre champs décrits ci-dessous.
Exemple : /home/toto/répertoire surveillé/
Exemple : IN_CLOSE_WRITE
Il est possible de préciser plusieurs événements. Dans ce cas, il suffit de les séparer par une virgule.
Exemple : /home/toto/scripts/mon_script.sh
Ceux-ci sont facultatifs mais en pratique très utilisés (principalement les deux premiers).
$@ : chemin du répertoire surveillé
$# : nom du fichier qui a déclenché l’événement
$$ : affiche le signe $
$% : affiche le nom de l’événement
$& : affiche la valeur numérique de l’événement
NB : Il est impératif de saisir les chemins absolus.
Si l’on ne se souvient plus des règles en vigueur dans incrontab, il suffit de saisir la ligne suivante dans un terminal afin d’en avoir la liste.
incrontab -l
Nous allons mettre en oeuvre au travers des exemples qui suivent des utilisations simples d’incron qui devraient vous donner des idées (du moins je l’espère).
Il s’agira de générer la clef MD5 d’un fichier quelconque qui sera déplacé d’un répertoire source vers notre répertoire cible qui sera surveillé par incron.
La clef sera écrite dans un fichier portant le même nom que celui dont on calcule la clef, mais se terminant par «.md5».
Nous supposerons que le fichier source aura une extension comme jpg, iso, mkv…
Voici la ligne que nous allons saisir dans incrontab. Elle présuppose que le répertoire surveillé md5 existe et que notre script se situe dans le répertoire /home/toto/scripts/.
/home/toto/md5 IN_MOVED_TO /home/toto/scripts/incron_md5.sh $@ $#
Nous allons décortiquer cette ligne.
/home/toto/md5 : il s’agit du répertoire que nous surveillons.
IN_MOVED_TO : nous voulons réagir à tout fichier qui sera déplacé d’un répertoire dans le répertoire surveillé.
/home/toto/scripts/incron_md5.sh : le script qui sera utilisé pour calculer la clef md5.
$@ $# : nous passons le chemin du répertoire surveillé et le nom du fichier qui a déclenché l’événement à notre script.
#!/bin/bash
##############################
# script générant les hash md5
# recoit en paramêtre => $1 : le répertoire / $2 :le nom du fichier
# événement IN_MOVED_TO
###############################
#
# déplacement répertoire /home/toto/md5
cd "$1"
# création somme md5 seulement si c'est un fichier dont l'extension n'est pas .md5
if [[ ${2##*.} != "md5" ]]
then
md5sum "$2" > "${2%.*}.md5"
fi
Comme on peut le voir, le script n’est pas très compliqué en lui même. Et avec incron on peut automatiser nombre de choses, comme le calcul d’un hash md5 de l’iso de notre distribution préférée après téléchargement.
Comme je suis particulièrement flemmard, j’ai envie que lorsque je télécharge l’iso de ma distribution préférée le hash md5 soit calculé de façon automatique et que l’iso et son hash md5 soit rangé proprement dans mon répertoire d’archive.
Pour ce faire, nous allons surveiller le répertoire /home/toto/download/ qui est notre répertoire par défaut pour tous nos téléchargements.
Une fois que notre fichier sera entièrement téléchargé, nous le basculerons dans le répertoire /home/toto/md5 afin de calculer son hash md5.
Ceci nous permettra de vérifier qu’il n’y a pas eu d’erreur de téléchargement.
Nous avons déjà mis en place une partie de ce que nous voulons faire avec l’exemple précédent.
Il ne nous reste qu’à mettre en place la surveillance du répertoire /home/toto/download et le déplacement du fichier une fois fini le téléchargement.
Nous ouvrons la table incron par la commande :
incrontab -e
Puis nous saisissons la ligne suivante afin de surveiller le répertoire /home/toto/download.
/home/toto/download IN_CLOSE /home/toto/scripts/incron_download.sh $@ $#
Regardons maintenant notre script incron_download.sh.
#!/bin/bash
##############################
# script générant les hash md5
# recoit en paramêtre => $1 : le répertoire / $2 :le nom du fichier
# événement IN_CLOSE
###############################
#
# déplacement répertoire /home/toto/download
cd "$1"
# Déplacement du fichier reçut en paramètre
# et du fichier de hash md5 vers le répertoire d'archive
#
if [[ ${2##*.} != "md5" ]]
then
md5sum "$2" > "${2%.*}.md5"
fi
mv ${2%.*}.* /home/toto/Archive
Voilà cette rapide présentation de cet utilitaire (presque indispensable) qu’est incron est terminée.
J’espère que cela vous encouragera à devenir flemmard au vu des possibilités qui s’ouvrent à vous.
Si vous avez des trucs ou astuces avec incron à faire partager n’hésitez pas à prendre contact avec moi.
Commentaires