win32-changejournal 0.3.2 → 0.3.3

data/CHANGES

@@ -1,3 +1,11 @@
+== 0.3.3 - 18-Aug-2009
+* Changed license to Artistic 2.0.
+* ChangeJournalStruct objects are now frozen. This is read-only data.
+* ChangeJournalError is now ChangeJournal::Error.
+* Added test-unit 2.x as a development dependency.
+* Renamed the test and example files.
+* Some updates to the Rakefile and gemspec.
+
 == 0.3.2 - 27-Apr-2008
 * Fixed RubyForge bug #10555 (bignum too big to convert into long).
 * Lots of internal reorganization, partially in preparation for the

data/MANIFEST

@@ -1,11 +1,10 @@
-CHANGES
-README
-MANIFEST
-Rakefile
-win32-changejournal.gemspec
-ext/extconf.rb
-ext/win32/changejournal.c
-ext/win32/changejournal.h
-examples/test.rb
-lib/win32/changejournal.rb
-test/tc_changejournal.rb
+* CHANGES
+* README
+* MANIFEST
+* Rakefile
+* win32-changejournal.gemspec
+* ext/extconf.rb
+* ext/win32/changejournal.c
+* ext/win32/changejournal.h
+* examples/example_changejournal.rb
+* test/test_win32_changejournal.rb

data/README

@@ -2,8 +2,10 @@
    A class for monitoring events related to files and directories on NTFS.
 
 == Installation
-   rake install (non-gem)
-   rake gem-install (gem)
+=== Gem Installation
+   gem install win32-changejournal
+=== Local Installation
+   rake install
 
 == Synopsis
    require 'win32/changejournal'
@@ -11,8 +13,7 @@
 
    # Indefinitely wait for a change in 'C:\' and any of its
    # subdirectories. Print the file and action affected.
-   #
-   cj = ChangeJournal.new('C:\')
+   cj = ChangeJournal.new("C:\\")
 
    cj.wait{ |array|
       array.each{ |info|
@@ -23,34 +24,14 @@
    }
 
    c.delete
-
-== Class Methods
-ChangeJournal.new(drive)
-   Returns a new ChangeJournal object and places a monitor on +drive+.
-       
-== Instance Methods
-ChangeJournal#wait(num_seconds=INFINITE)
-ChangeJournal#wait(num_seconds=INFINITE){ |arr| ... }
-
-   Waits up to 'num_seconds' for a notification to occur, or infinitely if
-   no value is specified.
-	
-   If a block is provided, yields an array of ChangeJournalStruct's that
-   contains three members: file_name, action, and path.  An array is returned
-   because multiple actions can be associated with a single event.
-
-== Constants
-=== Standard constants
-VERSION
-   Returns the current version number of this library as a String.
 	
 == Notes
    Based on what the MSDN documentation says, this library requires NTFS, and
-   should be preferred on that filesystem.  On FAT filesystems, you should
+   should be preferred on that filesystem. On FAT filesystems, you should
    use the win32-changenotify library instead.
 
 == Acknowledgements
-   This class was originally based on the CJTest module by Jeffrey
+   This library was originally based on the CJTest module by Jeffrey
    Cooperstein & Jeffrey Richter.
 	
 == Future Plans
@@ -61,10 +42,10 @@ VERSION
    project page at http://www.rubyforge.net/projects/win32utils
 
 == License
-   Ruby's
+   Artistic 2.0
     
 == Copyright
-   (C) 2003-2008 Daniel J. Berger, All Rights Reserved
+   (C) 2003-2009 Daniel J. Berger, All Rights Reserved
     
 == Warranty
    This library is provided "as is" and without any express or

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+desc 'Install the win32-changejournal library'
+task :install => [:build] do
+   Dir.chdir('ext'){
+      sh 'nmake install'
+   }
+end
+
+desc 'Clean any build files for win32-changejournal'
+task :clean do
+   Dir.chdir('ext') do
+      sh 'nmake distclean' if File.exists?('changejournal.obj')
+      rm 'win32/changejournal.so' if File.exists?('win32/changejournal.so') 
+   end
+   rm_rf('lib') if File.exists?('lib')
+end
+
+desc "Build win32-changejournal (but don't install it)"
+task :build => [:clean] do
+   Dir.chdir('ext') do
+      ruby 'extconf.rb'
+      sh 'nmake'
+      mv 'changejournal.so', 'win32' # For the test suite
+   end
+end
+
+desc 'Build gem'
+task :build_gem do
+   eval(IO.read('win32-changejournal.gemspec'))
+end
+
+desc 'Build a binary gem'
+task :build_binary_gem => [:build] do
+   mkdir_p 'lib/win32'
+   mv 'ext/win32/changejournal.so', 'lib/win32'
+   task :build_binary_gem => [:clean]
+
+   spec = Gem::Specification.new do |gem|
+      gem.name       = 'win32-changejournal'
+      gem.version    = '0.3.3'
+      gem.authors    = ['Daniel J. Berger', 'Park Heesob']
+      gem.license    = 'Artistic 2.0'
+      gem.email      = 'djberg96@gmail.com'
+      gem.homepage   = 'http://www.rubyforge.org/projects/win32utils'
+      gem.platform   = Gem::Platform::CURRENT
+      gem.summary    = 'A library for monitoring files and directories on NTFS'
+      gem.has_rdoc   = true
+      gem.test_file  = 'test/test_win32_changejournal.rb'
+
+      gem.files = [
+         Dir['*'],
+         Dir['test/*'],
+         Dir['examples/*'],
+         'ext/extconf.rb',
+         'ext/win32/changejournal.c',
+         'lib/win32/changejournal.so'
+      ].flatten.reject{ |f| f.include?('CVS') }
+
+      gem.required_ruby_version = '>= 1.8.2'
+      gem.rubyforge_project = 'win32utils'
+
+      gem.extra_rdoc_files = [
+         'README',
+         'CHANGES',
+         'MANIFEST',
+         'ext/win32/changejournal.c'
+      ]
+
+      gem.add_development_dependency('test-unit', '>= 2.0.3')
+
+      gem.description = <<-EOF
+         The win32-changejournal library provides an interface for MS Windows
+         change journals. A change journal is a record of any changes on a given
+         volume maintained by the operating system itself.
+      EOF
+   end
+
+   Gem::Builder.new(spec).build
+end
+
+desc 'Run the example program'
+task :example => [:build] do |t|
+   ruby '-Iext examples/example_changejournal.rb'
+end
+
+Rake::TestTask.new(:test) do |t|
+   task :test => [:build]
+   t.libs << 'ext'
+   t.warning = true
+   t.verbose = true
+end

data/examples/example_changejournal.rb

@@ -0,0 +1,23 @@
+########################################################################
+# example_changejournal.rb
+#
+# A test script for general futzing.  Modify as you see fit. You can
+# run this test script via the 'rake example' task.
+########################################################################
+require 'win32/changejournal'
+
+puts 'VERSION: ' + Win32::ChangeJournal::VERSION
+
+cj = Win32::ChangeJournal.new('c:\\')
+
+# Wait up to 5 minutes for a change journals
+cj.wait(300){ |array|
+   array.each{ |struct|
+      puts 'Something changed'
+      puts 'File: ' + struct.file_name
+      puts 'Action: ' + struct.action
+      puts 'Path: ' + struct.path
+   }
+}
+
+cj.delete

data/ext/extconf.rb

@@ -0,0 +1,36 @@
+require 'mkmf'
+require 'Win32API'
+
+# Ensure that win32-ipc is installed.
+begin
+   require 'win32/ipc'
+rescue LoadError
+   STDERR.puts 'The win32-ipc library is a prerequisite for this package.'
+   STDERR.puts 'Please install win32-ipc before continuing.'
+   STDERR.puts 'Exiting...'
+   exit
+end
+
+# Set $CPPFLAGS as needed since mkmf doesn't do this for us.
+GetVersionEx = Win32API.new('kernel32','GetVersionEx','P','I')
+swCSDVersion = "\0" * 128
+OSVERSIONINFO = [148,0,0,0,0,swCSDVersion].pack("LLLLLa128")
+GetVersionEx.call(OSVERSIONINFO)
+info = OSVERSIONINFO.unpack("LLLLLa128")
+
+major, minor = info[1,2]
+platform = info[4]
+macro = '_WIN32_WINNT='
+
+case minor
+   when 2   # 2003
+      macro += '0x0502'
+   when 1   # XP
+      macro += '0x0501'
+   else     # 2000
+      macro += '0x0500'
+end
+
+$CPPFLAGS += " -D#{macro}"
+
+create_makefile('win32/changejournal', 'win32')

data/ext/win32/changejournal.c

@@ -155,7 +155,7 @@ PUSN_RECORD EnumNext(ChangeJournalStruct *ptr) {
 
    // Make sure we have a buffer to use
    if(ptr->pbCJData == NULL)
-     rb_raise(cChangeJournalError, "make sure we have a buffer to use");
+     rb_raise(cCJError, "make sure we have a buffer to use");
 
    // If we do not have a record loaded, or enumerating to the next record
    // will point us past the end of the output buffer returned
@@ -233,7 +233,7 @@ void CleanUp(ChangeJournalStruct *ptr) {
  */
 BOOL Init(ChangeJournalStruct *ptr, TCHAR cDriveLetter, DWORD cbBuffer){
    if(ptr->pbCJData != NULL){
-      rb_raise(cChangeJournalError,
+      rb_raise(cCJError,
          "you should not call this function twice for one instance."
       );
    }
@@ -295,7 +295,7 @@ void InitialzeForMonitoring(ChangeJournalStruct *ptr) {
       default:
          // Some other error happened while querying the journal information.
          // There is nothing we can do from here
-         rb_raise(cChangeJournalError, "unable to query journal");
+         rb_raise(cCJError, "unable to query journal");
          fOk = FALSE;
          break;
       }
@@ -324,9 +324,14 @@ static VALUE changejournal_allocate(VALUE klass){
 /*
  * :call-seq:
  *
- *    ChangeJournal.new(drive)
+ *    Win32::ChangeJournal.new(volume)
  *
- * Returns a new ChangeJournal object and places a monitor on 'drive'.
+ * Returns a new ChangeJournal object and places a monitor on +volume+.
+ * 
+ * Example:
+ *
+ *    # Put a change journal monitor on the C: drive
+ *    cj = Win32::Change::Journal.new("C:\\")
  */
 static VALUE changejournal_init(VALUE self, VALUE v_drive)
 {
@@ -337,7 +342,7 @@ static VALUE changejournal_init(VALUE self, VALUE v_drive)
 
    // Do not allow a block for this class
    if(rb_block_given_p())
-      rb_raise(cChangeJournalError, "block not permitted for this class");
+      rb_raise(cCJError, "block not permitted for this class");
 
    // Initialize member variables
    ptr->hCJ = INVALID_HANDLE_VALUE;
@@ -346,8 +351,9 @@ static VALUE changejournal_init(VALUE self, VALUE v_drive)
    ptr->pbCJData = NULL;
    ptr->pUsnRecord = NULL;
 
-   // Initialize the ChangeJournal object with the current drive letter and tell
-   // it to allocate a buffer of 10000 bytes to read journal records.
+   /* Initialize the ChangeJournal object with the current drive letter and tell
+    * it to allocate a buffer of 10000 bytes to read journal records.
+    */
    if(!Init(ptr, lpDriveLetter[0], 10000))
       rb_raise(rb_eTypeError, "initialization error");
 
@@ -359,14 +365,28 @@ static VALUE changejournal_init(VALUE self, VALUE v_drive)
 /*
  * :call-seq:
  *
- *    ChangeJournal#wait(num_seconds=INFINITE)
- *    ChangeJournal#wait(num_seconds=INFINITE){ |s| ... }
+ *    Win32::ChangeJournal#wait(num_seconds=INFINITE)
+ *    Win32::ChangeJournal#wait(num_seconds=INFINITE){ |struct| ... }
  *
  * Waits up to 'num_seconds' for a notification to occur, or infinitely if
  * no value is specified.
  *
- * If a block is provided, yields a ChangeJournalStruct that contains two
- * members - file_name and action.
+ * If a block is provided, yields a frozen ChangeJournalStruct that contains
+ * three members - file_name, action, and path.
+ *
+ * Example:
+ *
+ *    require 'win32/changejournal'
+ *    cj = Win32::ChangeJournal.new("C:\\")
+ *
+ *    # Wait for something to happen for 5 seconds, but ignore the details
+ *    cj.wait(5)
+ *
+ *    # Wait for 5 seconds, print the details if any, then bail out
+ *    cj.wait(5){ |struct| p struct }
+ *
+ *    # Wait indefinitely, and print the details when something happens
+ *    cj.wait{ |struct| p struct }
  */
 static VALUE changejournal_wait(int argc, VALUE* argv, VALUE self){
 	VALUE v_timeout, v_block;
@@ -411,7 +431,7 @@ static VALUE changejournal_wait(int argc, VALUE* argv, VALUE self){
 
    switch(dwWait){
       case WAIT_FAILED:
-         rb_raise(cChangeJournalError, ErrorDescription(GetLastError()));
+         rb_raise(cCJError, ErrorDescription(GetLastError()));
          break;
       case WAIT_OBJECT_0:
          rb_iv_set(self, "@signaled", Qtrue);
@@ -427,7 +447,7 @@ static VALUE changejournal_wait(int argc, VALUE* argv, VALUE self){
          return INT2NUM(0);
          break;
       default:
-         rb_raise(cChangeJournalError,
+         rb_raise(cCJError,
             "unknown return value from WaitForSingleObject()"
          );
    };
@@ -438,10 +458,17 @@ static VALUE changejournal_wait(int argc, VALUE* argv, VALUE self){
 /*
  * call-seq:
  * 
- *    ChangeJournal#delete
+ *    Win32::ChangeJournal#delete
  * 
  * Deletes the change journal on a volume, or waits for notification of
  * change journal deletion.
+ *
+ * Example:
+ *
+ *    require 'win32/changejournal'
+ *    cj = Win32::ChangeJournal.new("C:\\")
+ *    cj.wait(5)
+ *    cj.delete
  */
 static VALUE changejournal_delete(VALUE self){
    ChangeJournalStruct *ptr;
@@ -459,19 +486,27 @@ void Init_changejournal()
 {
 	VALUE mWin32, cChangeJournal;
 
-   // Module and class definitions
+   /* The Win32 module serves as a namespace only. */
    mWin32 = rb_define_module("Win32");
+
+   /* The Win32::ChangeJournal class encapsulates functions related to a
+    * Windows change journal.
+    */
    cChangeJournal = rb_define_class_under(mWin32, "ChangeJournal", rb_cObject);
-   cChangeJournalError = rb_define_class_under(mWin32, "ChangeJournalError",
-      rb_eStandardError);
 
-   // ChangeJournal class and instance methods
-   rb_define_alloc_func(cChangeJournal,changejournal_allocate);
+   /* The ChangeJournal::Error class is typically raised if any of the
+    * Win32::ChangeJournal methods fail.
+    */
+   cCJError = rb_define_class_under(cChangeJournal, "Error", rb_eStandardError);
+
+   /* ChangeJournal class and instance methods */
+   rb_define_alloc_func(cChangeJournal, changejournal_allocate);
+
    rb_define_method(cChangeJournal, "initialize", changejournal_init, 1);
    rb_define_method(cChangeJournal, "wait", changejournal_wait, -1);
    rb_define_method(cChangeJournal, "delete", changejournal_delete, 0);
 
-   // Struct definitions
+   /* Struct definitions */
    sChangeJournalStruct = rb_struct_define(
       "ChangeJournalStruct",
       "action",
@@ -480,8 +515,7 @@ void Init_changejournal()
       0
    );
 
-   // 0.3.2 - The version of the win32-changejournal library
+   /* 0.3.3: The version of the win32-changejournal library */
    rb_define_const(cChangeJournal, "VERSION",
       rb_str_new2(WIN32_CHANGEJOURNAL_VERSION));
 }
-

data/ext/win32/changejournal.h

@@ -0,0 +1,356 @@
+#define WIN32_CHANGEJOURNAL_VERSION "0.3.3"
+#define MAX_STRING 1024
+
+static VALUE cCJError;
+static VALUE sChangeJournalStruct;
+static char error[MAX_STRING];
+static VALUE hPathDB;
+
+// Prototype
+BOOL Query(ChangeJournalStruct, PUSN_JOURNAL_DATA);
+void add_reason(char*, const char*);
+
+struct changejournalstruct {
+   TCHAR  cDriveLetter; // drive letter of volume
+   HANDLE hCJ;          // handle to volume
+
+   // Members used to enumerate journal records
+   READ_USN_JOURNAL_DATA rujd;       // parameters for reading records
+   PBYTE                 pbCJData;   // buffer of records
+   DWORD                 cbCJData;   // valid bytes in buffer
+   PUSN_RECORD           pUsnRecord; // pointer to current record
+
+   // Members used to notify application of new data
+   HANDLE     hCJAsync;      // Async handle to volume
+   OVERLAPPED oCJAsync;      // overlapped structure
+   USN        UsnAsync;      // output buffer for overlapped I/O
+   DWORD      dwDelay;       // delay before sending notification
+};
+
+typedef struct changejournalstruct ChangeJournalStruct;
+
+void CleanUp(ChangeJournalStruct *ptr);
+
+static void changejournal_free(ChangeJournalStruct *p)
+{
+   CleanUp(p);
+   free(p);
+}
+
+// Helper function for the get_file_action function.
+void add_reason(char* str, const char* reason){
+   if(strlen(str) > 0)
+      strcat(str, ", ");
+
+   strcat(str, reason);
+}
+
+PUSN_RECORD EnumNext(ChangeJournalStruct *ptr);
+
+// Enumerate the MFT for all entries. Store the file reference numbers of
+// any directories in the database.
+void PopulatePath(ChangeJournalStruct *ptr) {
+   USN_JOURNAL_DATA ujd;
+   BY_HANDLE_FILE_INFORMATION fi;
+   TCHAR szRoot[_MAX_PATH];
+   HANDLE hDir;
+   MFT_ENUM_DATA med;
+   BYTE pData[sizeof(DWORDLONG) + 0x10000]; // Process MFT in 64k chunks
+   DWORDLONG fnLast = 0;
+   DWORDLONG IndexRoot, FRN, PFRN;
+   DWORD cb;
+   LPWSTR pszFileName;
+   WCHAR szFile[MAX_PATH];
+   int cFileName;
+   VALUE v_path_db;
+
+   v_path_db = rb_hash_new();
+   Query(ptr, &ujd);
+
+   // Get the FRN of the root directory
+   wsprintf(szRoot, TEXT("%c:\\"), ptr->cDriveLetter);
+
+   hDir = CreateFile(
+      szRoot,
+      0,
+      FILE_SHARE_READ | FILE_SHARE_WRITE,
+      NULL,
+      OPEN_EXISTING,
+      FILE_FLAG_BACKUP_SEMANTICS,
+      NULL
+   );
+
+   GetFileInformationByHandle(hDir, &fi);
+   CloseHandle(hDir);
+
+   IndexRoot = (((DWORDLONG) fi.nFileIndexHigh) << 32) | fi.nFileIndexLow;
+
+   wsprintf(szRoot, TEXT("%c:"), ptr->cDriveLetter);
+
+   FRN = IndexRoot;
+   PFRN =  0;
+
+   rb_hash_aset(v_path_db,ULL2NUM(FRN),
+      rb_ary_new3(2, rb_str_new(szRoot,2), ULL2NUM(PFRN)));
+
+   med.StartFileReferenceNumber = 0;
+   med.LowUsn = 0;
+   med.HighUsn = ujd.NextUsn;
+
+   while (DeviceIoControl(ptr->hCJ, FSCTL_ENUM_USN_DATA, &med, sizeof(med),
+      pData, sizeof(pData), &cb, NULL) != FALSE) {
+      PUSN_RECORD pRecord = (PUSN_RECORD) &pData[sizeof(USN)];
+
+      while((PBYTE) pRecord < (pData + cb)){
+         if(0 != (pRecord->FileAttributes & FILE_ATTRIBUTE_DIRECTORY)){
+            pszFileName = (LPWSTR)((PBYTE) pRecord + pRecord->FileNameOffset);
+            cFileName = pRecord->FileNameLength / sizeof(WCHAR);
+
+            wcsncpy(szFile, pszFileName, cFileName);
+            szFile[cFileName] = 0;
+
+            FRN = pRecord->FileReferenceNumber;
+            PFRN = pRecord->ParentFileReferenceNumber;
+
+            WideCharToMultiByte(
+               CP_ACP,
+               0,
+               szFile,
+               -1,
+               szRoot,
+               MAX_PATH,
+               NULL,
+               NULL
+            );
+
+         	rb_hash_aset(
+               v_path_db,
+               ULL2NUM(FRN),
+               rb_ary_new3(2, rb_str_new2((char*)szRoot), ULL2NUM(PFRN))
+            );
+
+         }
+         pRecord = (PUSN_RECORD) ((PBYTE) pRecord + pRecord->RecordLength);
+      }
+
+      med.StartFileReferenceNumber = * (DWORDLONG *) pData;
+   }
+
+   hPathDB = v_path_db;
+}
+
+// Returns both the file action and name in a Ruby struct
+static VALUE get_file_action(ChangeJournalStruct *ptr){
+   VALUE v_struct, v_action, v_array, v_arr, v_path, v_path_array;
+   WCHAR szFile[MAX_PATH];
+   char file_name[MAX_PATH];
+   char path[MAX_PATH];
+   char szReason[MAX_STRING];
+   LPWSTR pszFileName;
+   int cFileName;
+   DWORDLONG FRN;
+   DWORDLONG PFRN;
+   VALUE v_path_db = hPathDB;
+
+   v_array = rb_ary_new();
+
+   while(EnumNext(ptr)) {
+      pszFileName =
+          (LPWSTR)((PBYTE) ptr->pUsnRecord + ptr->pUsnRecord->FileNameOffset);
+
+      cFileName = ptr->pUsnRecord->FileNameLength / sizeof(WCHAR);
+      wcsncpy(szFile, pszFileName, cFileName);
+      szFile[cFileName] = 0;
+
+      // If this is a close record for a directory, we may need to adjust
+      // our directory database
+
+      if(0 != (ptr->pUsnRecord->FileAttributes & FILE_ATTRIBUTE_DIRECTORY)
+         && 0 != (ptr->pUsnRecord->Reason & USN_REASON_CLOSE))
+      {
+
+         FRN = ptr->pUsnRecord->FileReferenceNumber;
+         PFRN = ptr->pUsnRecord->ParentFileReferenceNumber;
+
+         WideCharToMultiByte(
+            CP_ACP,
+            0,
+            szFile,
+            -1,
+            path,
+            MAX_PATH,
+            NULL,
+            NULL
+         );
+
+         // Process newly created directories
+         if(0 != (ptr->pUsnRecord->Reason & USN_REASON_FILE_CREATE)){
+            rb_hash_aset(v_path_db,ULL2NUM(FRN),
+            rb_ary_new3(2, rb_str_new2(path), ULL2NUM(PFRN)));
+         }
+
+         // Process renamed directories
+         if(0 != (ptr->pUsnRecord->Reason & USN_REASON_RENAME_NEW_NAME)) {
+            rb_hash_aset(v_path_db,ULL2NUM(FRN),
+            rb_ary_new3(2, rb_str_new2(path), ULL2NUM(PFRN)));
+         }
+
+          // Process deleted directories
+         if(0 != (ptr->pUsnRecord->Reason & USN_REASON_FILE_DELETE)){
+            rb_hash_delete(v_path_db,ULL2NUM(FRN));
+          }
+      }
+
+      szReason[0] = 0;
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_DATA_OVERWRITE)
+         add_reason(szReason, "data_overwrite");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_DATA_EXTEND)
+         add_reason(szReason, "data_extend");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_DATA_TRUNCATION)
+         add_reason(szReason, "data_truncation");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_NAMED_DATA_OVERWRITE)
+         add_reason(szReason, "named_data_overwrite");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_NAMED_DATA_EXTEND)
+         add_reason(szReason, "named_data_extend");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_NAMED_DATA_TRUNCATION)
+         add_reason(szReason, "named_data_truncation");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_FILE_CREATE)
+         add_reason(szReason, "file_create");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_FILE_DELETE)
+         add_reason(szReason, "file_delete");
+
+#ifdef USN_REASON_PROPERTY_CHANGE
+      if(ptr->pUsnRecord->Reason & USN_REASON_PROPERTY_CHANGE)
+         add_reason(szReason, "property_change");
+#endif
+
+#ifdef USN_REASON_EA_CHANGE
+      if(ptr->pUsnRecord->Reason & USN_REASON_EA_CHANGE)
+         add_reason(szReason, "property_change");
+#endif
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_SECURITY_CHANGE)
+         add_reason(szReason, "security_change");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_RENAME_OLD_NAME)
+         add_reason(szReason, "rename_old_name");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_RENAME_NEW_NAME)
+         add_reason(szReason, "rename_new_name");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_INDEXABLE_CHANGE)
+         add_reason(szReason, "indexable_change");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_BASIC_INFO_CHANGE)
+         add_reason(szReason, "basic_info_change");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_HARD_LINK_CHANGE)
+         add_reason(szReason, "hard_link_change");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_COMPRESSION_CHANGE)
+         add_reason(szReason, "compression_change");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_ENCRYPTION_CHANGE)
+         add_reason(szReason, "encryption_change");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_OBJECT_ID_CHANGE)
+         add_reason(szReason, "object_id_change");
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_REPARSE_POINT_CHANGE)
+         add_reason(szReason, "reparse_point_change");
+
+#ifdef USN_REASON_MOUNT_TABLE_CHANGE
+      if(ptr->pUsnRecord->Reason & USN_REASON_MOUNT_TABLE_CHANGE)
+         add_reason(szReason, "stream_change");
+
+#endif
+#ifdef USN_REASON_STREAM_CHANGE
+      if(ptr->pUsnRecord->Reason & USN_REASON_STREAM_CHANGE)
+         add_reason(szReason, "stream_change");
+#endif
+
+      if(ptr->pUsnRecord->Reason & USN_REASON_CLOSE)
+         add_reason(szReason, "close");
+
+      v_action = rb_str_new2(szReason);
+
+	   *path = '\0';
+
+	   FRN = ptr->pUsnRecord->ParentFileReferenceNumber;
+	   v_path_array = rb_ary_new();
+
+	   while(FRN != 0) {
+         v_arr = rb_hash_aref(v_path_db,ULL2NUM(FRN));
+
+         if(NIL_P(v_arr))
+            break;
+
+		   v_path = RARRAY(v_arr)->ptr[0];
+		   rb_ary_unshift(v_path_array, v_path);
+         FRN = NUM2ULL(RARRAY(rb_hash_aref(v_path_db, ULL2NUM(FRN)))->ptr[1]);
+	   }
+
+	   v_path = rb_ary_join(v_path_array, rb_str_new("\\", 1));
+	   strcpy(path, StringValuePtr(v_path));
+
+      WideCharToMultiByte(
+         CP_ACP,
+         0,
+         szFile,
+         -1,
+         file_name,
+         MAX_PATH,
+         NULL,
+         NULL
+      );
+
+      v_struct = rb_struct_new(
+         sChangeJournalStruct,
+         v_action,
+         rb_str_new2(file_name),
+         rb_str_new2(path)
+      );
+
+      // This is read-only information
+      rb_obj_freeze(v_struct);
+
+      rb_ary_push(v_array, v_struct);
+   }
+
+   return v_array;
+}
+
+// Return an error code as a string
+LPTSTR ErrorDescription(DWORD p_dwError)
+{
+   HLOCAL hLocal = NULL;
+   static char ErrStr[MAX_STRING];
+   int len;
+
+   if (!(len=FormatMessage(
+      FORMAT_MESSAGE_ALLOCATE_BUFFER |
+      FORMAT_MESSAGE_FROM_SYSTEM |
+      FORMAT_MESSAGE_IGNORE_INSERTS,
+      NULL,
+      p_dwError,
+      MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
+      (LPTSTR)&hLocal,
+      0,
+      NULL)))
+   {
+      rb_raise(rb_eStandardError, "Unable to format error message");
+   }
+
+   memset(ErrStr, 0, MAX_STRING);
+   strncpy(ErrStr, (LPTSTR)hLocal, len-2); // remove \r\n
+   LocalFree(hLocal);
+   return ErrStr;
+}

data/test/{tc_changejournal.rb → test_win32_changejournal.rb}

@@ -1,28 +1,33 @@
 #############################################################################
-# tc_changejournal.rb
+# test_win32_changejournal.rb
 #
-# Test suite for the win32-changejournal package. You should run this
+# Test suite for the win32-changejournal library. You should run this
 # via the 'rake test' task.
 #############################################################################
+require 'rubygems'
+gem 'test-unit'
+
 require 'test/unit'
 require 'win32/changejournal'
 include Win32
 
-STDOUT.print "\n\nThis may take a few seconds - be patient\n\n"
-
 class TC_Win32_ChangeJournal < Test::Unit::TestCase
-   # The thread here is used to force an event to happen for one of the tests
+   def self.startup
+      Dir.chdir(File.expand_path(File.dirname(__FILE__)))
+      @@file = 'win32_changejournal_test.txt'
+   end
+
    def setup
+      # The thread is used to force an event to happen for the tests
       @journal = ChangeJournal.new("c:\\")
-      @file    = "C:\\delete_me.txt"
-      @thread = Thread.new{
+      @thread  = Thread.new{
          sleep 2
-         File.open(@file, 'w+'){ |fh| fh.puts 'Delete me!' }
+         File.open(@@file, 'w'){ |fh| fh.puts 'Delete me!' }
       }
    end
 	
    def test_version
-      assert_equal('0.3.2', ChangeJournal::VERSION)
+      assert_equal('0.3.3', ChangeJournal::VERSION)
    end
    
    def test_changejournal_action
@@ -31,6 +36,7 @@ class TC_Win32_ChangeJournal < Test::Unit::TestCase
          assert_kind_of(Array, c)
          assert_kind_of(Struct::ChangeJournalStruct, c.first)
          assert_equal(['action', 'file_name', 'path'], c.first.members)
+         assert_true(c.first.frozen?)
       }
    end
    
@@ -39,7 +45,7 @@ class TC_Win32_ChangeJournal < Test::Unit::TestCase
       assert_nothing_raised{ @journal.delete }
    end
    
-   # We provide some very short timeouts here - shouldn't slow the tests down	
+   # We provide some very short timeouts here - shouldn't slow the tests down
    def test_wait_basic
       assert_respond_to(@journal, :wait)
       assert_nothing_raised{ @journal.wait(0.01) }
@@ -50,11 +56,20 @@ class TC_Win32_ChangeJournal < Test::Unit::TestCase
       assert_raise(ArgumentError){ @journal.wait(1,1) }
       assert_raise(TypeError){ @journal.wait('a') }
    end
+
+   def test_error_class_defined
+      assert_kind_of(Object, Win32::ChangeJournal::Error)
+   end
 		
    def teardown
-      @thread.kill rescue nil
-      File.delete(@file) if File.exists?(@file)
+      @thread.kill if @thread.alive?
+
       @journal = nil
       @flags   = nil      
+      @thread  = nil
+   end
+
+   def self.shutdown
+      File.delete(@@file) if File.exists?(@@file)
    end
 end

data/win32-changejournal.gemspec

@@ -0,0 +1,36 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |gem|
+   gem.name       = 'win32-changejournal'
+   gem.version    = '0.3.3'
+   gem.authors    = ['Daniel J. Berger', 'Park Heesob']
+   gem.license    = 'Artistic 2.0'
+   gem.email      = 'djberg96@gmail.com'
+   gem.homepage   = 'http://www.rubyforge.org/projects/win32utils'
+   gem.platform   = Gem::Platform::RUBY
+   gem.summary    = 'A library for monitoring files and directories on NTFS'
+   gem.has_rdoc   = true
+   gem.test_file  = 'test/test_win32_changejournal.rb'
+   gem.extensions = ['ext/extconf.rb']
+   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.required_ruby_version = '>= 1.8.2'
+   gem.rubyforge_project = 'win32utils'
+
+   gem.extra_rdoc_files = [
+      'README',
+      'CHANGES',
+      'MANIFEST',
+      'ext/win32/changejournal.c'
+   ]
+
+   gem.add_development_dependency('test-unit', '>= 2.0.3')
+
+   gem.description = <<-EOF
+      The win32-changejournal library provides an interface for MS Windows
+      change journals. A change journal is a record of any changes on a given
+      volume maintained by the operating system itself.
+   EOF
+end
+
+Gem::Builder.new(spec).build

metadata

@@ -1,39 +1,54 @@
 --- !ruby/object:Gem::Specification 
 name: win32-changejournal
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Daniel J. Berger
+- Park Heesob
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-05-05 00:00:00 -06:00
+date: 2009-08-18 00:00:00 -06:00
 default_executable: 
-dependencies: []
-
-description: A library for monitoring files and directories on NTFS
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+description: "      The win32-changejournal library provides an interface for MS Windows\n      change journals. A change journal is a record of any changes on a given\n      volume maintained by the operating system itself.\n"
 email: djberg96@gmail.com
 executables: []
 
-extensions: []
-
+extensions: 
+- ext/extconf.rb
 extra_rdoc_files: 
 - README
 - CHANGES
 - MANIFEST
 - ext/win32/changejournal.c
 files: 
-- lib/win32
-- lib/win32/changejournal.so
-- test/tc_changejournal.rb
-- README
 - CHANGES
-- MANIFEST
+- examples/example_changejournal.rb
+- ext/extconf.rb
 - ext/win32/changejournal.c
+- ext/win32/changejournal.h
+- MANIFEST
+- Rakefile
+- README
+- test/test_win32_changejournal.rb
+- win32-changejournal.gemspec
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -43,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.8.0
+      version: 1.8.2
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
@@ -54,9 +69,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.1.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A library for monitoring files and directories on NTFS
 test_files: 
-- test/tc_changejournal.rb
+- test/test_win32_changejournal.rb