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. Funções para monitoramento de alterações em arquivos (FAM)
Introdução
FAM monitora arquivos e diretórios, notificando alterações relevantes na aplicação. Maiores informações sobre FAM estão disponíveis em http://oss.sgi.com/projects/fam/.
Um script PHP deve especificar uma lista de arquivos para o monitor FAM, usando as funções disponíveis por essa extensão.
O processo FAM é iniciado quando a primeira conexão de alguma aplicação está aberta. E fecha após todas as conexões feitas por ele terminarem.
Nota: Esta extensão não está disponível na plataforma Windows.
Dependências
Essa extensão usa as funções da biblioteca FAM, desenvolvida por SGI. Portanto, você deverá fazer o download e instalar a biblioteca FAM. ======= This extension uses the functions of the FAM library, developed by SGI. Therefore you have to download and install the FAM library. >>>>>>> 1.6
Instalação
Para ter suporte ao FAM no php você deve compilar o PHP com --with-fam[=DIR] onde DIR é a localização do diretório contendo a biblioteca e diretório de includes.
Configurações em execução
Esta extensão não define nenhum parâmetro de configuração no php.ini.
Constantes pré-definidas
As contantes abaixo são definidas por esta extensão e somente estarão disponíveis quando a extensão foi compilada com o PHP ou carregada dinamicamente durante a execução.
Tabela 1. Constantes de eventos do FAM
| Constantes | Descrição |
|---|---|
| FAMChanged (integer) | Algum valor que pode ser obtido com fstat(1) alterado para um arquivo ou diretório. |
| FAMDeleted (integer) | Um arquivo que foi deletado ou renomeado. |
| FAMStartExecuting (integer) | Um arquivo executável que acabou de ser iniciado. |
| FAMStopExecuting (integer) | Um arquivo executável que foi executado. |
| FAMCreated (integer) | Um arquivo foi criado no diretório. |
| FAMMoved (integer) | Esse evento nunca ocorre. |
| FAMAcknowledge (integer) | Um evento em resposta para fam_cancel_monitor(). |
| FAMExists (integer) | Um evento acima de uma requisição para monitorar um arquivo ou diretório. Quando um diretório é monitorado, um evento para esse diretório e cada arquivo contido nele é usado. |
| FAMEndExist (integer) | Evento após o último evento FAMEExists. |
- Índice
- fam_cancel_monitor -- Finalizando monitoramento
- fam_close -- Fecha uma conexão FAM
- fam_monitor_collection -- Monitora alterações de uma coleção de arquivos em um diretório
- fam_monitor_directory -- Monitora alterações em diretórios
- fam_monitor_file -- Monitora alterações em um arquivo
- fam_next_event -- Pega o próximo evento FAM pendente
- fam_open -- Abre uma conexão para o daemon FAM
- fam_pending -- Verifica por eventos FAM pendentes
- fam_resume_monitor -- Recomeça um monitoramento suspendido
- fam_suspend_monitor -- Suspende monitoramento temporariamente
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
