Example for tailing a file (like tail -f) using inotify.
<?php
/**
* Tail a file (UNIX only!)
* Watch a file for changes using inotify and return the changed data
*
* @param string $file - filename of the file to be watched
* @param integer $pos - actual position in the file
* @return string
*/
function tail($file,&$pos) {
// get the size of the file
if(!$pos) $pos = filesize($file);
// Open an inotify instance
$fd = inotify_init();
// Watch $file for changes.
$watch_descriptor = inotify_add_watch($fd, $file, IN_ALL_EVENTS);
// Loop forever (breaks are below)
while (true) {
// Read events (inotify_read is blocking!)
$events = inotify_read($fd);
// Loop though the events which occured
foreach ($events as $event=>$evdetails) {
// React on the event type
switch (true) {
// File was modified
case ($evdetails['mask'] & IN_MODIFY):
// Stop watching $file for changes
inotify_rm_watch($fd, $watch_descriptor);
// Close the inotify instance
fclose($fd);
// open the file
$fp = fopen($file,'r');
if (!$fp) return false;
// seek to the last EOF position
fseek($fp,$pos);
// read until EOF
while (!feof($fp)) {
$buf .= fread($fp,8192);
}
// save the new EOF to $pos
$pos = ftell($fp); // (remember: $pos is called by reference)
// close the file pointer
fclose($fp);
// return the new data and leave the function
return $buf;
// be a nice guy and program good code ;-)
break;
// File was moved or deleted
case ($evdetails['mask'] & IN_MOVE):
case ($evdetails['mask'] & IN_MOVE_SELF):
case ($evdetails['mask'] & IN_DELETE):
case ($evdetails['mask'] & IN_DELETE_SELF):
// Stop watching $file for changes
inotify_rm_watch($fd, $watch_descriptor);
// Close the inotify instance
fclose($fd);
// Return a failure
return false;
break;
}
}
}
}
// Use it like that:
$lastpos = 0;
while (true) {
echo tail($file,$lastpos);
}
?>
inotify_init
(PECL inotify >= 0.1.2)
inotify_init — Initialise une instance inotify
Description
Initialise une instance inotify pour utiliser avec la fonction inotify_add_watch()
Liste de paramètres
Cette fonction ne contient aucun paramètre.
Valeurs de retour
Un flux ou false en cas d'erreur.
Exemples
Exemple #1 Exemple d'utilisatio d'inotify
<?php
// Crée une instance inotify
$fd = inotify_init();
// Surveille les modifications des métadonées du fichier __FILE__ (e.g. mtime)
$watch_descriptor = inotify_add_watch($fd, __FILE__, IN_ATTRIB);
// Génère un événement
touch(__FILE__);
// Lit les événements
$events = inotify_read($fd);
print_r($events);
// Les méthodes suivantes permettent d'utiliser les fonctions inotify sans bloquer sur inotify_read():
// - Utiliser stream_select() sur $fd:
$read = array($fd);
$write = null;
$except = null;
stream_select($read,$write,$except,0);
// - Utiliser stream_set_blocking() sur $fd
stream_set_blocking($fd, 0);
inotify_read($fd); // Does no block, and return false if no events are pending
// - Utiliser inotify_queue_len() pour vérifier la taille de la file d'attente
$queue_len = inotify_queue_len($fd); // If > 0, inotify_read() will not block
// Arrêt de la surveillance de __FILE__
inotify_rm_watch($fd, $watch_descriptor);
// Destruction de l'instance inotify
// Cela aurait arrêté toutes les surveillances si ce n'était pas déjà fait
fclose($fd);
?>Résultat de l'exemple ci-dessus est similaire à :
array(
array(
'wd' => 1, // Egale le $watch_descriptor
'mask' => 4, // Le bit IN_ATTRIB est activé
'cookie' => 0, // identifiant uique pour relier des événements (e.g.
// IN_MOVE_FROM et IN_MOVE_TO)
'name' => '', // Le nom du fichier (e.g. si un dossier était sous surveillance)
),
);
Voir aussi
- inotify_add_watch() - Ajoute un point de surveillance à une instance inotify
- inotify_rm_watch() - Supprime un point de surveillance d'une instance inotify
- inotify_queue_len() - Retourne le nombre d'événements qui sont survenus
- inotify_read() - Lit les événements dans une instance inotify
- fclose() - Ferme un fichier
add a note
User Contributed Notes 1 note
david dot schueler at tel-billig dot de ¶
13 years ago
