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 #include "gioalias.h"
  42
  43
  44 static gboolean ih_debug_enabled = FALSE;
  45 #define IH_W if (ih_debug_enabled) g_warning
  46
  47 static void ih_event_callback (ik_event_t *event, inotify_sub *sub);
  48 static void ih_not_missing_callback (inotify_sub *sub);
  49
  50 /* We share this lock with inotify-kernel.c and inotify-missing.c
  51  *
  52  * inotify-kernel.c takes the lock when it reads events from
  53  * the kernel and when it processes those events
  54  *
  55  * inotify-missing.c takes the lock when it is scanning the missing
  56  * list.
  57  *
  58  * We take the lock in all public functions
  59  */
  60 G_GNUC_INTERNAL G_LOCK_DEFINE (inotify_lock);
  61
  62 static GFileMonitorEvent ih_mask_to_EventFlags (guint32 mask);
  63
  64 /**
  65  * _ih_startup:
  66  *
  67  * Initializes the inotify backend.  This must be called before
  68  * any other functions in this module.
  69  *
  70  * Return value: #TRUE if initialization succeeded, #FALSE otherwise
  71  */
  72 gboolean
  73 _ih_startup (void)
  74 {
  75   static gboolean initialized = FALSE;
  76   static gboolean result = FALSE;
  77
  78   G_LOCK (inotify_lock);
  79
  80   if (initialized == TRUE)
  81     {
  82       G_UNLOCK (inotify_lock);
  83       return result;
  84     }
  85
  86   result = _ip_startup (ih_event_callback);
  87   if (!result)
  88     {
  89       G_UNLOCK (inotify_lock);
  90       return FALSE;
  91     }
  92   _im_startup (ih_not_missing_callback);
  93   _id_startup ();
  94
  95   IH_W ("started gvfs inotify backend\n");
  96
  97   initialized = TRUE;
  98
  99   G_UNLOCK (inotify_lock);
 100
 101   return TRUE;
 102 }
 103
 104 /*
 105  * Adds a subscription to be monitored.
 106  */
 107 gboolean
 108 _ih_sub_add (inotify_sub *sub)
 109 {
 110   G_LOCK (inotify_lock);
 111
 112   if (!_ip_start_watching (sub))
 113     _im_add (sub);
 114
 115   G_UNLOCK (inotify_lock);
 116   return TRUE;
 117 }
 118
 119 /*
 120  * Cancels a subscription which was being monitored.
 121  */
 122 gboolean
 123 _ih_sub_cancel (inotify_sub *sub)
 124 {
 125   G_LOCK (inotify_lock);
 126
 127   if (!sub->cancelled)
 128     {
 129       IH_W ("cancelling %s\n", sub->dirname);
 130       sub->cancelled = TRUE;
 131       _im_rm (sub);
 132       _ip_stop_watching (sub);
 133     }
 134
 135   G_UNLOCK (inotify_lock);
 136
 137   return TRUE;
 138 }
 139
 140 static char *
 141 _ih_fullpath_from_event (ik_event_t *event, char *dirname)
 142 {
 143   char *fullpath;
 144
 145   if (event->name)
 146     fullpath = g_strdup_printf ("%s/%s", dirname, event->name);
 147   else
 148     fullpath = g_strdup_printf ("%s/", dirname);
 149
 150    return fullpath;
 151 }
 152
 153
 154 static gboolean
 155 ih_event_is_paired_move (ik_event_t *event)
 156 {
 157   if (event->pair)
 158     {
 159       ik_event_t *paired = event->pair;
 160       /* intofiy(7): IN_MOVE == IN_MOVED_FROM | IN_MOVED_TO */
 161       return (event->mask | paired->mask) & IN_MOVE;
 162     }
 163
 164     return FALSE;
 165 }
 166
 167 static void
 168 ih_event_callback (ik_event_t  *event,
 169                    inotify_sub *sub)
 170 {
 171   gchar *fullpath;
 172   GFileMonitorEvent eflags;
 173   GFile* parent;
 174   GFile* child;
 175   GFile* other;
 176
 177   eflags = ih_mask_to_EventFlags (event->mask);
 178   parent = g_file_new_for_path (sub->dirname);
 179   fullpath = _ih_fullpath_from_event (event, sub->dirname);
 180   child = g_file_new_for_path (fullpath);
 181   g_free (fullpath);
 182
 183   if (ih_event_is_paired_move (event) && sub->pair_moves)
 184     {
 185       char *parent_dir = (char *) _ip_get_path_for_wd (event->pair->wd);
 186       fullpath = _ih_fullpath_from_event (event->pair, parent_dir);
 187       other = g_file_new_for_path (fullpath);
 188       g_free (fullpath);
 189       eflags = G_FILE_MONITOR_EVENT_MOVED;
 190       event->pair = NULL; /* prevents the paired event to be emitted as well */
 191     }
 192   else
 193     other = NULL;
 194
 195   g_file_monitor_emit_event (G_FILE_MONITOR (sub->user_data),
 196                              child, other, eflags);
 197
 198   g_object_unref (child);
 199   g_object_unref (parent);
 200   if (other)
 201     g_object_unref (other);
 202 }
 203
 204 static void
 205 ih_not_missing_callback (inotify_sub *sub)
 206 {
 207   gchar *fullpath;
 208   GFileMonitorEvent eflags;
 209   guint32 mask;
 210   GFile* parent;
 211   GFile* child;
 212
 213   parent = g_file_new_for_path (sub->dirname);
 214
 215   if (sub->filename)
 216     {
 217       fullpath = g_strdup_printf ("%s/%s", sub->dirname, sub->filename);
 218       g_warning ("Missing callback called fullpath = %s\n", fullpath);
 219       if (!g_file_test (fullpath, G_FILE_TEST_EXISTS))
 220         {
 221           g_free (fullpath);
 222           return;
 223         }
 224       mask = IN_CREATE;
 225     }
 226   else
 227     {
 228       fullpath = g_strdup_printf ("%s", sub->dirname);
 229       mask = IN_CREATE|IN_ISDIR;
 230     }
 231
 232   eflags = ih_mask_to_EventFlags (mask);
 233   child = g_file_new_for_path (fullpath);
 234   g_free (fullpath);
 235
 236   g_file_monitor_emit_event (G_FILE_MONITOR (sub->user_data),
 237                              child, NULL, eflags);
 238
 239   g_object_unref (child);
 240   g_object_unref (parent);
 241 }
 242
 243 /* Transforms a inotify event to a GVFS event. */
 244 static GFileMonitorEvent
 245 ih_mask_to_EventFlags (guint32 mask)
 246 {
 247   mask &= ~IN_ISDIR;
 248   switch (mask)
 249     {
 250     case IN_MODIFY:
 251       return G_FILE_MONITOR_EVENT_CHANGED;
 252     case IN_CLOSE_WRITE:
 253       return G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT;
 254     case IN_ATTRIB:
 255       return G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED;
 256     case IN_MOVE_SELF:
 257     case IN_MOVED_FROM:
 258     case IN_DELETE:
 259     case IN_DELETE_SELF:
 260       return G_FILE_MONITOR_EVENT_DELETED;
 261     case IN_CREATE:
 262     case IN_MOVED_TO:
 263       return G_FILE_MONITOR_EVENT_CREATED;
 264     case IN_UNMOUNT:
 265       return G_FILE_MONITOR_EVENT_UNMOUNTED;
 266     case IN_Q_OVERFLOW:
 267     case IN_OPEN:
 268     case IN_CLOSE_NOWRITE:
 269     case IN_ACCESS:
 270     case IN_IGNORED:
 271     default:
 272       return -1;
 273     }
 274 }