1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 2; tab-width: 8 -*- */
3 /* inotify-helper.c - GVFS Monitor based on inotify.
5 Copyright (C) 2007 John McCutchan
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.
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.
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 see <http://www.gnu.org/licenses/>.
22 John McCutchan <john@johnmccutchan.com>
29 #include <sys/ioctl.h>
30 /* Just include the local header to stop all the pain */
31 #include <sys/inotify.h>
32 #include <gio/glocalfile.h>
33 #include <gio/gfilemonitor.h>
34 #include <gio/gfile.h>
35 #include "inotify-helper.h"
36 #include "inotify-missing.h"
37 #include "inotify-path.h"
39 static gboolean ih_debug_enabled = FALSE;
40 #define IH_W if (ih_debug_enabled) g_warning
42 static void ih_event_callback (ik_event_t *event,
45 static void ih_not_missing_callback (inotify_sub *sub);
47 /* We share this lock with inotify-kernel.c and inotify-missing.c
49 * inotify-kernel.c takes the lock when it reads events from
50 * the kernel and when it processes those events
52 * inotify-missing.c takes the lock when it is scanning the missing
55 * We take the lock in all public functions
57 G_LOCK_DEFINE (inotify_lock);
59 static GFileMonitorEvent ih_mask_to_EventFlags (guint32 mask);
64 * Initializes the inotify backend. This must be called before
65 * any other functions in this module.
67 * Returns: #TRUE if initialization succeeded, #FALSE otherwise
72 static gboolean initialized = FALSE;
73 static gboolean result = FALSE;
75 G_LOCK (inotify_lock);
77 if (initialized == TRUE)
79 G_UNLOCK (inotify_lock);
83 result = _ip_startup (ih_event_callback);
86 G_UNLOCK (inotify_lock);
89 _im_startup (ih_not_missing_callback);
91 IH_W ("started gvfs inotify backend\n");
95 G_UNLOCK (inotify_lock);
101 * Adds a subscription to be monitored.
104 _ih_sub_add (inotify_sub *sub)
106 G_LOCK (inotify_lock);
108 if (!_ip_start_watching (sub))
111 G_UNLOCK (inotify_lock);
116 * Cancels a subscription which was being monitored.
119 _ih_sub_cancel (inotify_sub *sub)
121 G_LOCK (inotify_lock);
125 IH_W ("cancelling %s\n", sub->dirname);
126 sub->cancelled = TRUE;
128 _ip_stop_watching (sub);
131 G_UNLOCK (inotify_lock);
137 _ih_fullpath_from_event (ik_event_t *event,
139 const char *filename)
144 fullpath = g_strdup_printf ("%s/%s", dirname, filename);
145 else if (event->name)
146 fullpath = g_strdup_printf ("%s/%s", dirname, event->name);
148 fullpath = g_strdup_printf ("%s/", dirname);
155 ih_event_is_paired_move (ik_event_t *event)
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;
168 ih_event_callback (ik_event_t *event,
173 GFileMonitorEvent eflags;
177 eflags = ih_mask_to_EventFlags (event->mask);
178 fullpath = _ih_fullpath_from_event (event, sub->dirname,
179 file_event ? sub->filename : NULL);
180 child = g_file_new_for_path (fullpath);
183 if (ih_event_is_paired_move (event) && sub->pair_moves)
185 const char *parent_dir = (char *) _ip_get_path_for_wd (event->pair->wd);
186 fullpath = _ih_fullpath_from_event (event->pair, parent_dir, NULL);
187 other = g_file_new_for_path (fullpath);
189 eflags = G_FILE_MONITOR_EVENT_MOVED;
190 event->pair = NULL; /* prevents the paired event to be emitted as well */
195 g_file_monitor_emit_event (G_FILE_MONITOR (sub->user_data),
196 child, other, eflags);
198 /* For paired moves or moves whose mask has been changed from IN_MOVED_TO to
199 * IN_CREATE, notify also that it's probably the last change to the file,
200 * emitting CHANGES_DONE_HINT.
201 * The first (first part of the if's guard below) is the case of a normal
202 * move within the monitored tree and in the same mounted volume.
203 * The latter (second part of the guard) is the case of a move within the
204 * same mounted volume, but from a not monitored directory.
206 * It's not needed in cases like moves across mounted volumes as the IN_CREATE
207 * will be followed by a IN_MODIFY and IN_CLOSE_WRITE events.
208 * Also not needed if sub->pair_moves is set as EVENT_MOVED will be emitted
209 * instead of EVENT_CREATED which implies no further modification will be
210 * applied to the file
211 * See: https://bugzilla.gnome.org/show_bug.cgi?id=640077
213 if ((!sub->pair_moves &&
214 event->is_second_in_pair && (event->mask & IN_MOVED_TO)) ||
215 (!ih_event_is_paired_move (event) &&
216 (event->original_mask & IN_MOVED_TO) && (event->mask & IN_CREATE)))
218 g_file_monitor_emit_event (G_FILE_MONITOR (sub->user_data),
219 child, NULL, G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT);
222 g_object_unref (child);
224 g_object_unref (other);
228 ih_not_missing_callback (inotify_sub *sub)
231 GFileMonitorEvent eflags;
237 fullpath = g_strdup_printf ("%s/%s", sub->dirname, sub->filename);
238 g_warning ("Missing callback called fullpath = %s\n", fullpath);
239 if (!g_file_test (fullpath, G_FILE_TEST_EXISTS))
248 fullpath = g_strdup_printf ("%s", sub->dirname);
249 mask = IN_CREATE|IN_ISDIR;
252 eflags = ih_mask_to_EventFlags (mask);
253 child = g_file_new_for_path (fullpath);
256 g_file_monitor_emit_event (G_FILE_MONITOR (sub->user_data),
257 child, NULL, eflags);
259 g_object_unref (child);
262 /* Transforms a inotify event to a GVFS event. */
263 static GFileMonitorEvent
264 ih_mask_to_EventFlags (guint32 mask)
270 return G_FILE_MONITOR_EVENT_CHANGED;
272 return G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT;
274 return G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED;
279 return G_FILE_MONITOR_EVENT_DELETED;
282 return G_FILE_MONITOR_EVENT_CREATED;
284 return G_FILE_MONITOR_EVENT_UNMOUNTED;
287 case IN_CLOSE_NOWRITE: