wdm 0.0.1 → 0.0.3

data/ext/wdm/queue.c

@@ -1,3 +1,5 @@
+#include <stdarg.h>
+
 #include "wdm.h"
 
 #include "memory.h"
@@ -7,22 +9,73 @@
 // Queue item functions
 // ---------------------------------------------------------
 
+WDM_PQueueItemError wdm_queue_item_error_new(VALUE exception, LPCSTR format, ...) {
+    WDM_PQueueItemError error;
+    va_list ap;
+    int length;
+
+    error = WDM_ALLOC(WDM_QueueItemError);
+
+    va_start(ap, format);
+    length = _vscprintf(format, ap);
+    error->message = WDM_ALLOC_N(CHAR, length + 1);
+    vsprintf(error->message, format, ap);
+    va_end(ap);
+
+    error->exception_klass = exception;
+
+    return error;
+}
+
+void wdm_queue_item_error_free(WDM_PQueueItemError error) {
+    if ( error->message != NULL ) free(error->message);
+    free(error);
+}
+
+WDM_PQueueItemData wdm_queue_item_data_new() {
+    WDM_PQueueItemData data;
+
+    data = ALLOC(WDM_QueueItemData);
+    data->user_data = NULL;
+
+    ZeroMemory(&data->buffer, WDM_BUFFER_SIZE);
+
+    return data;
+}
+
+void wdm_queue_item_data_free(WDM_PQueueItemData data) {
+    free(data);
+}
+
 WDM_PQueueItem
-wdm_queue_item_new() {
+wdm_queue_item_new(WDM_QueueItemType type) {
     WDM_PQueueItem item;
 
     item = WDM_ALLOC(WDM_QueueItem);
-    item->user_data = NULL;
+    item->type = type;
+
+    if ( type == WDM_QUEUE_ITEM_TYPE_ERROR ) {
+        item->error = NULL;
+    }
+    else {
+        item->data = NULL;
+    }
+
     item->previous    = NULL;
     item->next        = NULL;
 
-    ZeroMemory(&item->buffer, WDM_BUFFER_SIZE);
-
     return item;
 }
 
 void
 wdm_queue_item_free(WDM_PQueueItem item) {
+    if ( item->type == WDM_QUEUE_ITEM_TYPE_ERROR ) {
+        if ( item->error != NULL ) wdm_queue_item_error_free(item->error);
+    }
+    else {
+        if ( item->data != NULL ) wdm_queue_item_data_free(item->data);
+    }
+
     // We can't really do anything to the prev pointer nor the next pointer,
     // because we might break any linking the user has established.
     free(item);

data/ext/wdm/queue.h

@@ -13,9 +13,27 @@ extern "C" {
 // Types
 // ---------------------------------------------------------
 
-typedef struct WDM_QueueItem {
+typedef enum {
+    WDM_QUEUE_ITEM_TYPE_ERROR,
+    WDM_QUEUE_ITEM_TYPE_DATA
+} WDM_QueueItemType;
+
+typedef struct {
     WDM_PEntryUserData user_data;
     BYTE buffer[WDM_BUFFER_SIZE];
+} WDM_QueueItemData, *WDM_PQueueItemData;
+
+typedef struct {
+    VALUE exception_klass;
+    LPSTR message;
+} WDM_QueueItemError, *WDM_PQueueItemError;
+
+typedef struct WDM_QueueItem {
+    WDM_QueueItemType type;
+    union {
+        WDM_PQueueItemData data;
+        WDM_PQueueItemError error;
+    };
     struct WDM_QueueItem* previous;
     struct WDM_QueueItem* next;
 } WDM_QueueItem, *WDM_PQueueItem;
@@ -30,7 +48,13 @@ typedef struct WDM_Queue {
 // Prototypes
 // ---------------------------------------------------------
 
-WDM_PQueueItem wdm_queue_item_new();
+WDM_PQueueItemError wdm_queue_item_error_new(VALUE, LPCSTR, ...);
+void wdm_queue_item_error_free(WDM_PQueueItemError);
+
+WDM_PQueueItemData wdm_queue_item_data_new();
+void wdm_queue_item_data_free(WDM_PQueueItemData);
+
+WDM_PQueueItem wdm_queue_item_new(WDM_QueueItemType);
 void wdm_queue_item_free(WDM_PQueueItem);
 
 WDM_PQueue wdm_queue_new();

data/ext/wdm/rb_change.c

@@ -86,12 +86,22 @@ extract_absolute_path_from_notification(const LPWSTR base_dir, const PFILE_NOTIF
     {
         LPWSTR unicode_absolute_filepath;
         WCHAR absolute_long_filepath[WDM_MAX_WCHAR_LONG_PATH];
+        BOOL is_unc_path;
 
-        unicode_absolute_filepath = ALLOCA_N(WCHAR, absolute_filepath_len + 4 + 1); // 4 for "\\?\" and 1 for NULL
+        is_unc_path = wdm_utils_is_unc_path(absolute_filepath);
+
+        unicode_absolute_filepath = ALLOCA_N(WCHAR, absolute_filepath_len + (is_unc_path ? 8 : 4) + 1); // 8 for "\\?\UNC\" or 4 for "\\?\", and 1 for \0
 
         unicode_absolute_filepath[0] = L'\0';
         wcscat(unicode_absolute_filepath, L"\\\\?\\");
-        wcscat(unicode_absolute_filepath, absolute_filepath);
+
+        if ( is_unc_path ) {
+            wcscat(unicode_absolute_filepath, L"UNC\\");
+            wcscat(unicode_absolute_filepath, absolute_filepath + 2); // +2 to skip the begin of a UNC path
+        }
+        else {
+            wcscat(unicode_absolute_filepath, absolute_filepath);
+        }
 
         // Convert to the long filename form. Unfortunately, this
         // does not work for deletions, so it's an imperfect fix.

data/ext/wdm/rb_monitor.c

@@ -47,7 +47,7 @@ static VALUE rb_monitor_watch(int, VALUE*, VALUE);
 static VALUE rb_monitor_watch_recursively(int, VALUE*, VALUE);
 
 static void CALLBACK handle_entry_change(DWORD, DWORD, LPOVERLAPPED);
-static void register_monitoring_entry(WDM_PEntry);
+static BOOL register_monitoring_entry(WDM_PEntry);
 static DWORD WINAPI start_monitoring(LPVOID);
 
 static VALUE wait_for_changes(LPVOID);
@@ -169,9 +169,6 @@ combined_watch(BOOL recursively, int argc, VALUE *argv, VALUE self) {
     entry->user_data->callback =  rb_block_proc();
     entry->user_data->flags = RARRAY_LEN(flags) == 0 ? WDM_MONITOR_FLAGS_DEFAULT : extract_flags_from_rb_array(flags);
 
-    // Prevent the GC from collecting the block until we are done.
-    rb_global_variable(&entry->user_data->callback);
-
     // WTF Ruby source: The original code (file.c) uses the following macro to make sure that the encoding
     // of the string is ASCII-compatible, but UTF-16LE (Windows default encoding) is not!!!
     //
@@ -273,14 +270,15 @@ handle_entry_change(
     }
 
     param = (WDM_PMonitorCallbackParam)event_container->hEvent;
-    data_to_process = wdm_queue_item_new();
+    data_to_process = wdm_queue_item_new(WDM_QUEUE_ITEM_TYPE_DATA);
+    data_to_process->data = wdm_queue_item_data_new();
 
     WDM_WDEBUG("Change detected in '%s'", param->entry->user_data->dir);
 
-    data_to_process->user_data = param->entry->user_data;
+    data_to_process->data->user_data = param->entry->user_data;
 
     // Copy change data to the backup buffer
-    memcpy(data_to_process->buffer, param->entry->buffer, bytes_transfered);
+    memcpy(data_to_process->data->buffer, param->entry->buffer, bytes_transfered);
 
     // Add the backup buffer to the change queue
     wdm_queue_enqueue(param->monitor->changes, data_to_process);
@@ -289,12 +287,12 @@ handle_entry_change(
     register_monitoring_entry(param->entry);
 
     // Tell the processing thread to process the changes
-    if ( WaitForSingleObject( param->monitor->process_event, 0) != WAIT_OBJECT_0 ) { // Check if already signaled
+    if ( WaitForSingleObject(param->monitor->process_event, 0) != WAIT_OBJECT_0 ) { // Check if already signaled
         SetEvent(param->monitor->process_event);
     }
 }
 
-static void
+static BOOL
 register_monitoring_entry(WDM_PEntry entry) {
     BOOL success;
     DWORD bytes;
@@ -312,11 +310,11 @@ register_monitoring_entry(WDM_PEntry entry) {
     );
 
     if ( ! success ) {
-        // --------------------------
-        // TODO: Handle error!
-        // --------------------------
-        WDM_DEBUG("Failed registering directory: '%s'!", entry->user_data->dir);
+        WDM_DEBUG("ReadDirectoryChangesW failed with error (%d): %s", GetLastError(), rb_w32_strerror(GetLastError()));
+        return FALSE;
     }
+
+    return TRUE;
 }
 
 static DWORD WINAPI
@@ -330,7 +328,24 @@ start_monitoring(LPVOID param) {
     WDM_DEBUG("Starting the monitoring thread!");
 
     while(curr_entry != NULL) {
-        register_monitoring_entry(curr_entry);
+        if ( ! register_monitoring_entry(curr_entry) ) {
+            WDM_PQueueItem error_item;
+            int directory_bytes;
+            LPSTR multibyte_directory;
+
+            directory_bytes = WideCharToMultiByte(CP_UTF8, 0, curr_entry->user_data->dir, -1, NULL, 0, NULL, NULL);
+            multibyte_directory = ALLOCA_N(CHAR, directory_bytes);
+            WideCharToMultiByte(CP_UTF8, 0, curr_entry->user_data->dir, -1, multibyte_directory, directory_bytes, NULL, NULL);
+
+            error_item = wdm_queue_item_new(WDM_QUEUE_ITEM_TYPE_ERROR);
+            error_item->error = wdm_queue_item_error_new(
+                eWDM_UnwatchableDirectoryError, "Can't watch directory: '%s'!", multibyte_directory
+            );
+
+            wdm_queue_enqueue(monitor->changes, error_item);
+            SetEvent(monitor->process_event);
+        }
+
         curr_entry = curr_entry->next;
     }
 
@@ -367,23 +382,29 @@ process_changes(WDM_PQueue changes) {
 
     while( ! wdm_queue_is_empty(changes) ) {
         item = wdm_queue_dequeue(changes);
-        current_info_entry_offset = (LPBYTE)item->buffer;
 
-        for(;;) {
-            info = (PFILE_NOTIFY_INFORMATION)current_info_entry_offset;
-            event = wdm_rb_change_new_from_notification(item->user_data->dir, info);
+        if ( item->type == WDM_QUEUE_ITEM_TYPE_ERROR ) {
+            rb_raise(item->error->exception_klass, item->error->message);
+        }
+        else {
+            current_info_entry_offset = (LPBYTE)item->data->buffer;
 
-            WDM_DEBUG("---------------------------");
-            WDM_DEBUG("Running user callback");
-            WDM_DEBUG("--------------------------");
+            for(;;) {
+                info = (PFILE_NOTIFY_INFORMATION)current_info_entry_offset;
+                event = wdm_rb_change_new_from_notification(item->data->user_data->dir, info);
 
-            rb_funcall(item->user_data->callback, wdm_rb_sym_call, 1, event);
+                WDM_DEBUG("---------------------------");
+                WDM_DEBUG("Running user callback");
+                WDM_DEBUG("--------------------------");
 
-            WDM_DEBUG("---------------------------");
+                rb_funcall(item->data->user_data->callback, wdm_rb_sym_call, 1, event);
 
-            if ( ! info->NextEntryOffset ) break;
+                WDM_DEBUG("---------------------------");
 
-            current_info_entry_offset += info->NextEntryOffset;
+                if ( ! info->NextEntryOffset ) break;
+
+                current_info_entry_offset += info->NextEntryOffset;
+            }
         }
 
         wdm_queue_item_free(item);
@@ -450,7 +471,7 @@ rb_monitor_run_bang(VALUE self) {
 
     if (already_running) {
         WDM_DEBUG("Not doing anything because the monitor is already running!");
-        return;
+        return Qnil;
     }
 
     // Reset events
@@ -479,7 +500,7 @@ rb_monitor_run_bang(VALUE self) {
 
         if ( ! monitor->running ) {
             wdm_queue_empty(monitor->changes);
-            return;
+            return Qnil;
         }
 
         process_changes(monitor->changes);
@@ -523,6 +544,7 @@ wdm_rb_monitor_init() {
     eWDM_MonitorRunningError = rb_define_class_under(mWDM, "MonitorRunningError", eWDM_Error);
     eWDM_InvalidDirectoryError = rb_define_class_under(mWDM, "InvalidDirectoryError", eWDM_Error);
     eWDM_UnknownFlagError = rb_define_class_under(mWDM, "UnknownFlagError", eWDM_Error);
+    eWDM_UnwatchableDirectoryError = rb_define_class_under(mWDM, "UnwatchableDirectoryError", eWDM_Error);
 
     cWDM_Monitor = rb_define_class_under(mWDM, "Monitor", rb_cObject);
 

data/ext/wdm/rb_monitor.h

@@ -23,6 +23,7 @@ extern VALUE cWDM_Monitor;
 extern VALUE eWDM_UnknownFlagError;
 extern VALUE eWDM_MonitorRunningError;
 extern VALUE eWDM_InvalidDirectoryError;
+extern VALUE eWDM_UnwatchableDirectoryError;
 
 // ---------------------------------------------------------
 // Prototypes

data/ext/wdm/utils.c

@@ -46,7 +46,14 @@ wdm_utils_unicode_is_directory(const LPWSTR path) {
     WCHAR unicode_path[WDM_MAX_WCHAR_LONG_PATH];
 
     wcscpy(unicode_path, L"\\\\?\\");
-    wcscat(unicode_path, path);
+
+    if ( wdm_utils_is_unc_path(path) ) {
+        wcscat(unicode_path, L"UNC\\");
+        wcscat(unicode_path, path + 2); // +2 to skip the begin of a UNC path
+    }
+    else {
+        wcscat(unicode_path, path);
+    }
 
     return wdm_utils_is_directory(unicode_path);
 }
@@ -57,4 +64,9 @@ wdm_utils_is_directory(const LPWSTR path) {
 
   return (dwAttrib != INVALID_FILE_ATTRIBUTES &&
          (dwAttrib & FILE_ATTRIBUTE_DIRECTORY));
+}
+
+BOOL
+wdm_utils_is_unc_path(const LPWSTR path) {
+    return path[0] == path[1] && path[0] == L'\\';
 }

data/ext/wdm/utils.h

@@ -13,6 +13,7 @@ extern "C" {
 
 LPWSTR wdm_utils_convert_back_to_forward_slashes(LPWSTR, DWORD);
 LPWSTR wdm_utils_full_pathname(const LPWSTR path);
+BOOL wdm_utils_is_unc_path(const LPWSTR);
 BOOL wdm_utils_is_directory(const LPWSTR);
 BOOL wdm_utils_unicode_is_directory(const LPWSTR);
 

data/ext/wdm/wdm.c

@@ -16,6 +16,7 @@ VALUE mWDM;
 VALUE eWDM_Error;
 VALUE eWDM_MonitorRunningError;
 VALUE eWDM_InvalidDirectoryError;
+VALUE eWDM_UnwatchableDirectoryError;
 
 ID wdm_rb_sym_call;
 ID wdm_rb_sym_at_file;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wdm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pimpmychangelog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Windows Directory Monitor (WDM) is a library which can be used to monitor
   directories for changes. It's mostly implemented in C and uses the Win32 API for
   a better performance.
@@ -157,11 +173,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 341068911
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Windows Directory Monitor (WDM) is a threaded directories monitor for Windows.
 test_files: []
-has_rdoc: