windows下文件的监控--ReadDirectoryChangesW函数的使用

 

windows下文件的监控--ReadDirectoryChangesW函数的使用

2012-07-13 20:11  3276人阅读  评论(3)  收藏  举报

windows file null action winapi 存储

目录(?)[+]

最近在做一个项目，其中涉及到监控指定目录下所有文件和子目录内的修改信息。经过一番努力，总算实现这一功能，在此特别感谢那些帮助过我的朋友和同事们。今天整理一下这几天的收获，列出相关的知识点，供后来者参考。

1.FindFirstChangeNotification()函数：

功能：创建一个改变通知句柄，并设置通知条件，即发生某种修改时，该通知句柄将被促发生效。该函数仅仅负责对文件修改作出通知，并不记录和反馈修改信息，ReadDirectoryChangesW()函数可以返回修改新的信息，参考第二部分。

函数参数：

[cpp]  view plain copy

1. HANDLEFindFirstChangeNotification(  
2. LPCTSTR lpPathName,//监控的路径  
3. BOOL bWatchSubtree,//True则监控子目录，False则不监控子目录  
4. DWORDdwNotifyFilter//通知条件  
5. );  

返回值：成功时返回指向改变通知的句柄，失败时返回INVALID_HANDLE_VALUE，可以用GetLastError()函数得到。

例子：部分代码如下

[cpp]  view plain copy

1. void WatchDirectory(LPTSTR lpDir)  
2. {  
3.    DWORD dwWaitStatus;  
4.    HANDLE dwChangeHandles[3];  
5.    TCHAR lpDrive[4];//存储磁盘符  
6.    TCHAR lpFile[_MAX_FNAME];//用于存储文件名  
7.    TCHAR lpExt[_MAX_EXT];//用于存储对应文件的后缀  
8.    
9.    _tsplitpath(lpDir, lpDrive,NULL, lpFile, lpExt);  
10.    lpDrive[2] = (TCHAR)'\\';  
11.    lpDrive[3] = (TCHAR)'\0';  
12.      
13.    //分别监控文件名，路径名，文件内容的修改   
14.    dwChangeHandles[0] =FindFirstChangeNotification(   
15.       lpDir,                         
16.       TRUE,                         
17.      FILE_NOTIFY_CHANGE_FILE_NAME); //文件名     
18.    if (dwChangeHandles[0] ==INVALID_HANDLE_VALUE)   
19.          ExitProcess(GetLastError());   
20.      
21.    dwChangeHandles[1] =FindFirstChangeNotification(   
22.       lpDrive,                     
23.       TRUE,  
24.      FILE_NOTIFY_CHANGE_DIR_NAME); //路径名    
25.    if (dwChangeHandles[1] ==INVALID_HANDLE_VALUE)   
26.     ExitProcess(GetLastError());  
27.    
28.    dwChangeHandles[2] =FindFirstChangeNotification(   
29.       lpDir,  
30.       TRUE,  
31.      FILE_NOTIFY_CHANGE_LAST_WRITE); //文件内容/或者说最后保存时间    
32.    if (dwChangeHandles[2] ==INVALID_HANDLE_VALUE)   
33.                    ExitProcess(GetLastError());   
34.      
35.    //改变通知已经设置完成，现在只需等待这些通知被触发，然后做相应处理  
36.    while (TRUE)   
37.    {   
38.          dwWaitStatus= WaitForMultipleObjects(3, dwChangeHandles, FALSE, INFINITE);   
39.          time(&ChangeTime);  
40.               
41.          switch(dwWaitStatus)  
42.          {  
43.          caseWAIT_OBJECT_0:   
44.                    //执行某对应操作  
45.                    RefreshDirectory(lpDir); //某操作接口  
46.                    if( FindNextChangeNotification(dwChangeHandles[0]) == FALSE )   
47.                             ExitProcess(GetLastError());   
48.                    break;  
49.          caseWAIT_OBJECT_0 + 1:  
50.                    //执行某对应操作  
51.                    RefreshTree(lpDrive);//某操作接口  
52.                    if(FindNextChangeNotification(dwChangeHandles[1]) == FALSE)   
53.                             ExitProcess(GetLastError());  
54.                    break;  
55.          caseWAIT_OBJECT_0 + 2:  
56.                    //执行某对应操作  
57.                    RefreshFile(lpDrive);//某操作接口  
58.                    if(FindNextChangeNotification(dwChangeHandles[2]) == FALSE)   
59.                             ExitProcess(GetLastError());  
60.                    break;       
61.          default:  
62.                    ExitProcess(GetLastError());  
63.          }  
64.    }  
65. }  

备注：例子中还有几个其他的API，这里不做解释，具体查msdn吧。

2.ReadDirectoryChangesW()函数：

功能：监控文件修改，并记录文件修改的相关信息，如修改的文件名，何种类型的修改等。

函数参数：

[cpp]  view plain copy

1. BOOL WINAPI ReadDirectoryChangesW(  
2.   __in          HANDLE hDirectory,//指向监控目录的句柄，可以用CreatFile生成  
3.   __in_out      LPVOID lpBuffer,//存储修改信息的首地址  
4.   __in          DWORD nBufferLength,//分配的存储修改信息的空间的长度  
5.   __in          BOOL bWatchSubtree,//TRUE则监控子目录，FALSE则不监控  
6.   __in          DWORD dwNotifyFilter,//通知条件  
7.   __out         LPDWORD lpBytesReturned,//该函数返回信息的字节数，也就是存到lpBuffer中的内容的字节数  
8.   __in          LPOVERLAPPED lpOverlapped,//一个指向OVERLAPPED结构的指针，他在同步调用时提供数据供使用，否则他就为NULL  
9.   __in          LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine//当操作结束或被取消或者线程进入等待状态时的一个指向将被调用操作的指针  
10. );  

返回值：如果函数成功，返回值就是非0。对于同步调用，这意味着操作成功，对于异步调用，这意味着操作成功地排队。如果函数失败，返回值是0。如果操作目录或文件系统不支持这个操作，函数将返回ERROR_INVALID_FUNCTION，可以使用GetLastError()函数获取。

例子：部分代码如下

[cpp]  view plain copy

1. //ThreadParameter结构体的定义  
2. /* 
3. *整合参数为一个结构体传给子线程的原因在于创建线程时 
4. *指定的线程入口函数只接受一个LPVOID类型的指针，具体内容可以参考msdn， 
5. *实际上向子线程传递参数还有一种方法，全局变量， 
6. *例如后面程序中的WriteLog就是一个文件输入流对象，我就是在程序首部定义的全局变量。 
7. */  
8. typedef struct ThreadParameter   
9. {  
10.     LPTSTR in_directory;//监控的路径  
11.     FILE_NOTIFY_INFORMATION *in_out_notification;//存储监控函数返回信息地址  
12.     DWORD in_MemorySize;//传递存储返回信息的内存的字节数  
13.     DWORD *in_out_BytesReturned;//存储监控函数返回信息的字节数  
14.     DWORD *in_out_version;//返回版本信息  
15.     FILE_NOTIFY_INFORMATION *temp_notification;//备用的一个参数  
16. }ThreadParameter;  

[cpp]  view plain copy

1. //传递给WatchChanges函数的参数,这部分代码截自主函数  
2.         char notify[1024];  
3.         memset(notify,'\0',1024);  
4.         FILE_NOTIFY_INFORMATION *Notification=(FILE_NOTIFY_INFORMATION *)notify;  
5.         FILE_NOTIFY_INFORMATION *TempNotification=NULL;  
6.         DWORD BytesReturned=0;  
7.         DWORD version=0;  
8.   
9.         //整合传给子线程的参数，该结构体的定义参考上面的定义  
10.         ThreadParameter ParameterToThread={Directory,Notification,sizeof(notify),&BytesReturned,&version,TempNotification};  
11.   
12.         //创建一个线程专门用于监控文件变化  
13.         HANDLE TrheadWatch=CreateThread(NULL,0,(LPTHREAD_START_ROUTINE)WatchChanges,&ParameterToThread,0,NULL);  
14.         CloseHandle(TrheadWatch);  

[cpp]  view plain copy

1. //  函数: WatchChanges(LPVOID lpParameter)  
2. //  
3. //  目的: 监控目录的程序  
4. //  
5. //  注释:主函数创建线程时制定了这个函数的入口  
6. //       届时该子程序将自动启动执行。  
7. //  备注：因为代码不全，看下面的代码时，主要参考红色的字体部分  
8.   
9. DWORD WINAPI WatchChanges(LPVOID lpParameter)//返回版本信息  
10. {  
11.     ThreadParameter *parameter=(ThreadParameter*)lpParameter;  
12.     LPCTSTR WatchDirectory=parameter->in_directory;//  
13.   
14.   
15.     //创建一个目录句柄  
16.     HANDLE handle_directory=CreateFile(WatchDirectory,  
17.         FILE_LIST_DIRECTORY,  
18.         FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,  
19.         NULL,  
20.         OPEN_EXISTING,  
21.         FILE_FLAG_BACKUP_SEMANTICS,  
22.         NULL);  
23.     if(handle_directory==INVALID_HANDLE_VALUE)  
24.     {  
25.         DWORD ERROR_DIR=GetLastError();  
26.         MessageBox(NULL,TEXT("打开目录错误!"),TEXT("文件监控"),0);  
27.     }  
28.   
29.   
30.     BOOL watch_state;  
31.   
32.   
33.     while (TRUE)  
34.     {  
35.         watch_state=ReadDirectoryChangesW(handle_directory,  
36.             (LPVOID)parameter->in_out_notification,  
37.             parameter->in_MemorySize,  
38.             TRUE,  
39.             FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME|FILE_NOTIFY_CHANGE_LAST_WRITE,  
40.             (LPDWORD)parameter->in_out_BytesReturned,  
41.             NULL,  
42.             NULL);  
43.         //printf("########%d########\n",watch_state);//检测结果为1，表明函数已成功执行  
44.         time(&ChangeTime);//记录修改时间  
45.   
46.   
47.         if (GetLastError()==ERROR_INVALID_FUNCTION)  
48.         {  
49.             MessageBox(NULL,TEXT("系统不支持!"),TEXT("文件监控"),0);  
50.         }  
51.         else if(watch_state==0)  
52.         {  
53.             MessageBox(NULL,TEXT("监控失败!"),TEXT("文件监控"),0);  
54.         }  
55.         else if (GetLastError()==ERROR_NOTIFY_ENUM_DIR)  
56.         {  
57.             MessageBox(NULL,TEXT("内存溢出!"),TEXT("文件监控"),0);  
58.         }  
59.         else  
60.         {  
61.               
62.             //将宽字符类型的FileName变量转换成string，便于写入log文件，否则写不进去正确的文件名  
63.             string file_name;  
64.             DWORD length=WideCharToMultiByte(0,0,parameter->in_out_notification->FileName,-1,NULL,0,NULL,NULL);  
65.             PSTR ps=new CHAR[length];  
66.             if(length>=0)  
67.             {  
68.                 WideCharToMultiByte(0,0,parameter->in_out_notification->FileName,-1,ps,length,NULL,NULL);  
69.                 file_name=string(ps);  
70.                 delete[] ps;  
71.             }  
72.               
73.             //这里主要就是检测返回的信息，需要注意FILE_NOTIFY_INFORMATION结构体的定义，以便正确调用返回信息  
74.   
75.             if (parameter->in_out_notification->Action==FILE_ACTION_ADDED)  
76.             {  
77.                 WriteLog<<ctime(&ChangeTime)<<"新增文件 : "<<file_name<<"\n"<<flush;  
78.             }  
79.             if (parameter->in_out_notification->Action==FILE_ACTION_REMOVED)  
80.             {  
81.                 WriteLog<<ctime(&ChangeTime)<<"删除文件 : "<<file_name<<"\n"<<flush;  
82.             }  
83.             if (parameter->in_out_notification->Action==FILE_ACTION_MODIFIED)  
84.             {  
85.                 edit_flag++;  
86.                 if(edit_flag==1)  
87.                     WriteLog<<ctime(&ChangeTime)<<"修改文件 : "<<file_name<<"\n"<<flush;  
88.                 else if(edit_flag==2)  
89.                 {  
90.                     edit_flag=0;  
91.                     (*(parameter->in_out_version))--;  
92.                 }  
93.                 else  
94.                     return -1;//break;  
95.             }  
96.   
97.   
98.             //对于下面两种情况，Action本身也是文件名（可能是old_name也可能是new_name）  
99.             if (parameter->in_out_notification->Action==FILE_ACTION_RENAMED_OLD_NAME)  
100.             {  
101.                 WriteLog<<ctime(&ChangeTime)<<"重命名\""<<file_name<<"\"文件\n"<<flush;  
102.             }  
103.             if (parameter->in_out_notification->Action==FILE_ACTION_RENAMED_NEW_NAME)  
104.             {  
105.                 WriteLog<<ctime(&ChangeTime)<<"重命名\""<<file_name<<"\"文件为\""<<parameter->in_out_notification->Action<<"\"\n"<<flush;  
106.                   
107.             }  
108.             (*(parameter->in_out_version))++;  
109.             memset(parameter->in_out_notification,'\0',1024);  
110.               
111.         }  
112.         Sleep(500);  
113.     }  
114.     return 0;  
115. }  

最后贴一张log文件中的记录内容：