gio/inotify/inotify-helper.c

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 2; tab-width: 8 -*- */
   2
   3 /* inotify-helper.c - GVFS Monitor based on inotify.
   4
   5    Copyright (C) 2007 John McCutchan
   6
   7    The Gnome Library is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU Library General Public License as
   9    published by the Free Software Foundation; either version 2 of the
  10    License, or (at your option) any later version.
  11
  12    The Gnome Library is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    Library General Public License for more details.
  16
  17    You should have received a copy of the GNU Library General Public
  18    License along with the Gnome Library; see the file COPYING.LIB.  If not,
  19    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.
  21
  22    Authors:
  23                  John McCutchan <john@johnmccutchan.com>
  24 */
  25
  26 #include "config.h"
  27 #include <errno.h>
  28 #include <time.h>
  29 #include <string.h>
  30 #include <sys/ioctl.h>
  31 /* Just include the local header to stop all the pain */
  32 #include <sys/inotify.h>
  33 #include <gio/glocalfile.h>
  34 #include <gio/gfilemonitor.h>
  35 #include <gio/gfile.h>
  36 #include "inotify-helper.h"
  37 #include "inotify-missing.h"
  38 #include "inotify-path.h"
  39 #include "inotify-diag.h"
  40
  41 static gboolean ih_debug_enabled = FALSE;
  42 #define IH_W if (ih_debug_enabled) g_warning
  43
  44 static void ih_event_callback (ik_event_t *event, inotify_sub *sub);
  45 static void ih_not_missing_callback (inotify_sub *sub);
  46
  47 /* We share this lock with inotify-kernel.c and inotify-missing.c
  48  *
  49  * inotify-kernel.c takes the lock when it reads events from
  50  * the kernel and when it processes those events
  51  *
  52  * inotify-missing.c takes the lock when it is scanning the missing
  53  * list.
  54  *
  55  * We take the lock in all public functions
  56  */
  57 G_GNUC_INTERNAL G_LOCK_DEFINE (inotify_lock);
  58
  59 static GFileMonitorEvent ih_mask_to_EventFlags (guint32 mask);
  60
  61 /**
  62  * _ih_startup:
  63  *
  64  * Initializes the inotify backend.  This must be called before
  65  * any other functions in this module.
  66  *
  67  * Return value: #TRUE if initialization succeeded, #FALSE otherwise
  68  */
  69 gboolean
  70 _ih_startup (void)
  71 {
  72   static gboolean initialized = FALSE;
  73   static gboolean result = FALSE;
  74
  75   G_LOCK (inotify_lock);
  76
  77   if (initialized == TRUE)
  78     {
  79       G_UNLOCK (inotify_lock);
  80       return result;
  81     }
  82
  83   result = _ip_startup (ih_event_callback);
  84   if (!result)
  85     {
  86       G_UNLOCK (inotify_lock);
  87       return FALSE;
  88     }
  89   _im_startup (ih_not_missing_callback);
  90   _id_startup ();
  91
  92   IH_W ("started gvfs inotify backend\n");
  93
  94   initialized = TRUE;
  95
  96   G_UNLOCK (inotify_lock);
  97
  98   return TRUE;
  99 }
 100
 101 /*
 102  * Adds a subscription to be monitored.
 103  */
 104 gboolean
 105 _ih_sub_add (inotify_sub *sub)
 106 {
 107   G_LOCK (inotify_lock);
 108
 109   if (!_ip_start_watching (sub))
 110     _im_add (sub);
 111
 112   G_UNLOCK (inotify_lock);
 113   return TRUE;
 114 }
 115
 116 /*
 117  * Cancels a subscription which was being monitored.
 118  */
 119 gboolean
 120 _ih_sub_cancel (inotify_sub *sub)
 121 {
 122   G_LOCK (inotify_lock);
 123
 124   if (!sub->cancelled)
 125     {
 126       IH_W ("cancelling %s\n", sub->dirname);
 127       sub->cancelled = TRUE;
 128       _im_rm (sub);
 129       _ip_stop_watching (sub);
 130     }
 131
 132   G_UNLOCK (inotify_lock);
 133
 134   return TRUE;
 135 }
 136
 137 static char *
 138 _ih_fullpath_from_event (ik_event_t *event, char *dirname)
 139 {
 140   char *fullpath;
 141
 142   if (event->name)
 143     fullpath = g_strdup_printf ("%s/%s", dirname, event->name);
 144   else
 145     fullpath = g_strdup_printf ("%s/", dirname);
 146
 147    return fullpath;
 148 }
 149
 150
 151 static gboolean
 152 ih_event_is_paired_move (ik_event_t *event)
 153 {
 154   if (event->pair)
 155     {
 156       ik_event_t *paired = event->pair;
 157       /* intofiy(7): IN_MOVE == IN_MOVED_FROM | IN_MOVED_TO */
 158       return (event->mask | paired->mask) & IN_MOVE;
 159     }
 160
 161     return FALSE;
 162 }
 163
 164 static void
 165 ih_event_callback (ik_event_t  *event,
 166                    inotify_sub *sub)
 167 {
 168   gchar *fullpath;
 169   GFileMonitorEvent eflags;
 170   GFile* child;
 171   GFile* other;
 172
 173   eflags = ih_mask_to_EventFlags (event->mask);
 174   fullpath = _ih_fullpath_from_event (event, sub->dirname);
 175   child = g_file_new_for_path (fullpath);
 176   g_free (fullpath);
 177
 178   if (ih_event_is_paired_move (event) && sub->pair_moves)
 179     {
 180       const char *parent_dir = (char *) _ip_get_path_for_wd (event->pair->wd);
 181       fullpath = _ih_fullpath_from_event (event->pair, parent_dir);
 182       other = g_file_new_for_path (fullpath);
 183       g_free (fullpath);
 184       eflags = G_FILE_MONITOR_EVENT_MOVED;
 185       event->pair = NULL; /* prevents the paired event to be emitted as well */
 186     }
 187   else
 188     other = NULL;
 189
 190   g_file_monitor_emit_event (G_FILE_MONITOR (sub->user_data),
 191                              child, other, eflags);
 192
 193   g_object_unref (child);
 194   if (other)
 195     g_object_unref (other);
 196 }
 197
 198 static void
 199 ih_not_missing_callback (inotify_sub *sub)
 200 {
 201   gchar *fullpath;
 202   GFileMonitorEvent eflags;
 203   guint32 mask;
 204   GFile* child;
 205
 206   if (sub->filename)
 207     {
 208       fullpath = g_strdup_printf ("%s/%s", sub->dirname, sub->filename);
 209       g_warning ("Missing callback called fullpath = %s\n", fullpath);
 210       if (!g_file_test (fullpath, G_FILE_TEST_EXISTS))
 211         {
 212           g_free (fullpath);
 213           return;
 214         }
 215       mask = IN_CREATE;
 216     }
 217   else
 218     {
 219       fullpath = g_strdup_printf ("%s", sub->dirname);
 220       mask = IN_CREATE|IN_ISDIR;
 221     }
 222
 223   eflags = ih_mask_to_EventFlags (mask);
 224   child = g_file_new_for_path (fullpath);
 225   g_free (fullpath);
 226
 227   g_file_monitor_emit_event (G_FILE_MONITOR (sub->user_data),
 228                              child, NULL, eflags);
 229
 230   g_object_unref (child);
 231 }
 232
 233 /* Transforms a inotify event to a GVFS event. */
 234 static GFileMonitorEvent
 235 ih_mask_to_EventFlags (guint32 mask)
 236 {
 237   mask &= ~IN_ISDIR;
 238   switch (mask)
 239     {
 240     case IN_MODIFY:
 241       return G_FILE_MONITOR_EVENT_CHANGED;
 242     case IN_CLOSE_WRITE:
 243       return G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT;
 244     case IN_ATTRIB:
 245       return G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED;
 246     case IN_MOVE_SELF:
 247     case IN_MOVED_FROM:
 248     case IN_DELETE:
 249     case IN_DELETE_SELF:
 250       return G_FILE_MONITOR_EVENT_DELETED;
 251     case IN_CREATE:
 252     case IN_MOVED_TO:
 253       return G_FILE_MONITOR_EVENT_CREATED;
 254     case IN_UNMOUNT:
 255       return G_FILE_MONITOR_EVENT_UNMOUNTED;
 256     case IN_Q_OVERFLOW:
 257     case IN_OPEN:
 258     case IN_CLOSE_NOWRITE:
 259     case IN_ACCESS:
 260     case IN_IGNORED:
 261     default:
 262       return -1;
 263     }
 264 }