I make a VERY simple class that monitors a folder (and its subfolders) for new or removed files. I use it in order to auto index a folder where I have all my eBooks into a MySQL database.
CLASS FILE:
<?php
class FileAlterationMonitor
{
private $scanFolder, $initialFoundFiles;
public function __construct($scanFolder)
{
$this->scanFolder = $scanFolder;
$this->updateMonitor();
}
private function _arrayValuesRecursive($array)
{
$arrayValues = array();
foreach ($array as $value)
{
if (is_scalar($value) OR is_resource($value))
{
$arrayValues[] = $value;
}
elseif (is_array($value))
{
$arrayValues = array_merge( $arrayValues, $this->_arrayValuesRecursive($value));
}
}
return $arrayValues;
}
private function _scanDirRecursive($directory)
{
$folderContents = array();
$directory = realpath($directory).DIRECTORY_SEPARATOR;
foreach (scandir($directory) as $folderItem)
{
if ($folderItem != "." AND $folderItem != "..")
{
if (is_dir($directory.$folderItem.DIRECTORY_SEPARATOR))
{
$folderContents[$folderItem] = $this->_scanDirRecursive( $directory.$folderItem."\\");
}
else
{
$folderContents[] = $folderItem;
}
}
}
return $folderContents;
}
public function getNewFiles()
{
$finalFoundFiles = $this->_arrayValuesRecursive( $this->_scanDirRecursive($this->scanFolder));
if ($this->initialFoundFiles != $finalFoundFiles)
{
$newFiles = array_diff($finalFoundFiles, $this->initialFoundFiles);
return empty($newFiles) ? FALSE : $newFiles;
}
}
public function getRemovedFiles()
{
$finalFoundFiles = $this->_arrayValuesRecursive( $this->_scanDirRecursive($this->scanFolder));
if ($this->initialFoundFiles != $finalFoundFiles)
{
$removedFiles = array_diff( $this->initialFoundFiles, $finalFoundFiles);
return empty($removedFiles) ? FALSE : $removedFiles;
}
}
public function updateMonitor()
{
$this->initialFoundFiles = $this->_arrayValuesRecursive($this->_scanDirRecursive( $this->scanFolder));
}
}
?>
A simple script that uses this class could be like this one (use it with PHP CLI):
<?php
$f = new FileAlterationMonitor($MY_FOLDER_TO_MONITOR)
while (TRUE)
{
sleep(1);
if ($newFiles = $f->getNewFiles())
{
// Code to handle new files
// $newFiles is an array that contains added files
}
if ($removedFiles = $f->getRemovedFiles())
{
// Code to handle removed files
// $newFiles is an array that contains removed files
}
$f->updateMonitor();
}
XXXVI. Fonctions de monitorage d'altération de fichiers
Introduction
FAM surveille les fichiers et les dossiers, alertant les applications impliquées de changement. Pour plus d'informations sur FAM, voyez le site http://oss.sgi.com/projects/fam/.
Un script PHP peut spécifier une liste de fichiers à FAM pour les surveiller en utilisant les fonctions fournies par cette extension.
Le processus FAM est démarré lorsque la première connexion d'une application est ouverte. Il se termine après la fermeture de toutes les connexions.
Note : Cette extension a été déplacée dans le module PECL et ne sera plus intégrée dans PHP à partir de PHP 5.1.0.
Note : Cette extension n'est pas disponible sur les plates-formes Windows.
Pré-requis
Cette extension utilise les fonctions de la bibliothèque FAM, développée par SGI. Vous devez la télécharger et installer la bibliothèque FAM.
Configuration à l'exécution
Cette extension ne définit aucune directive de configuration.
Constantes pré-définies
Ces constantes sont définies par cette extension, et ne sont disponibles que si cette extension a été compilée avec PHP, ou bien chargée au moment de l'exécution.
Tableau 1. Constantes d'événements FAM
| Constante | Description |
|---|---|
| FAMChanged (entier) | Une valeur qui a été modifiée pour un fichier ou un dossier. Elle est accessible via fstat(1). |
| FAMDeleted (entier) | Un fichier ou un dossier a été effacé. |
| FAMStartExecuting (entier) | Un fichier exécutable a été lancé. |
| FAMStopExecuting (entier) | Un fichier exécutable a fini de s'exécuter. |
| FAMCreated (entier) | Un fichier a été créé dans un dossier. |
| FAMMoved (entier) | Cet événement ne se produit jamais. |
| FAMAcknowledge (entier) | Evénement survenu en réponse à fam_cancel_monitor(). |
| FAMExists (entier) | Un événement survenu suite à une commande de surveillance d'un fichier ou d'un dossier. Lorsque le dossier est sous surveillance, un événement est généré pour ce dossier et tous ses fichiers. |
| FAMEndExist (entier) | Un événement après le dernier événement. |
- Table des matières
- fam_cancel_monitor -- Termine le monitoring
- fam_close -- Ferme la connexion FAM
- fam_monitor_collection -- Monitore les changements d'une collection de fichiers dans un dossier
- fam_monitor_directory -- Monitore un dossier pour les changements
- fam_monitor_file -- Monitore un fichier régulier pour les changements
- fam_next_event -- Retourne le prochain événement FAM en attente
- fam_open -- Ouvre une connexion vers le démon FAM
- fam_pending -- Vérifie si des événements FAM sont disponibles
- fam_resume_monitor -- Reprend un monitoring suspendu
- fam_suspend_monitor -- Suspend temporairement le monitoring
if u want do recursive monitoring on directory tree,
dont use fam_monitor_directory()
try to use fam_monitor_collection() instead
:)
in the example above, I would not use the while(1) and sleep() functions, since then you're back at waiting and polling for file changes, which you were trying to avoid using fam.
Instead, you can use while(fam_next_event($resource)), which blocks until there is an event. No polling, no useless wasting of cpu cycles.
Anyway, I have some problems with fam: It is very limited and almost useless.
- You cannot monitor a directory tree easily, since fam_monitor_directory() is non-recursive. Its an ugly hack, but you can go through each subdir and also monitor it with fam_monitor_directory().
- When you do that, you will have another problem: The events you get contain the code and the filename, but not the pathname of the file that caused the event. Thus, if you monitor two or more directories, and they possibly contain files with the same basename, you cannot find out what file has changed. One ugly solution might be to create a new fam_resource for each directory you want to monitor, but then you cannot use fam_next_event() in your while loop anymore.
- When a big file is saved (i.e. with photoshop via samba), you get file_changed events pretty much every second the file is being written to. It is not possible to receive ONE event AFTER the file operation is done.
I'm not sure, but I think most of this is not PHPs fault. Its just that fam (or dnotify, which fam uses on linux) sucks very badly. If you search on google, it seems everyone hates fam/dnotify (even linus), but noone has done anything about it yet.
If you find out how to work around thing, or if I'm completely wrong about all of this, please post here! Thanks!
Here is a simple script to check changes etc. to a file.
<?php
/* opens a connection to the FAM service daemon */
$fam_res = fam_open ();
/*
* The second argument is the full pathname
* of the file to monitor.
* Note that you can't use relative pathnames.
*/
$nres = fam_monitor_file ( $fam_res, '/home/sergio/test/fam/file_to_monitor.log');
while(1){
if( fam_pending ( $fam_res ) ) $arr = (fam_next_event($fam_res)) ;
switch ($arr['code']){
case 1:
echo "FAMChanged\n";
break;
case 2:
echo "FAMDeleted\n";
break;
case 3:
echo "FAMStartExecuting\n";
break;
case 4:
echo "FAMStopExecuting\n";
break;
case 5:
echo "FAMCreated\n";
break;
case 6:
echo "FAMMoved\n";
break;
case 7:
echo "FAMAcknowledge\n";
break;
case 8:
echo "FAMExists\n";
break;
case 9:
echo "FAMEndExist\n";
break;
default:
break;
}
if(isset($arr)) unset($arr);
/* In order to avoid too much CPU load */
usleep(5000);
}
/* Close FAM connection */
fam_close($fam_res);
?>
Hope this could help.
God Belss PHP!
regards
Sergio Paternoster
