1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
26 #include "gfilemonitor.h"
27 #include "gio-marshal.h"
28 #include "gioenumtypes.h"
35 * SECTION:gfilemonitor
36 * @short_description: File Monitor
39 * Monitors a file or directory for changes.
41 * To obtain a #GFileMonitor for a file or directory, use
42 * g_file_monitor_file() or g_file_monitor_directory().
44 * To get informed about changes to the file or directory you
45 * are monitoring, connect to the #GFileMonitor::changed signal.
53 G_DEFINE_ABSTRACT_TYPE (GFileMonitor, g_file_monitor, G_TYPE_OBJECT);
57 guint32 last_sent_change_time; /* 0 == not sent */
58 guint32 send_delayed_change_at; /* 0 == never */
59 guint32 send_virtual_changes_done_at; /* 0 == never */
62 struct _GFileMonitorPrivate {
66 /* Rate limiting change events */
67 GHashTable *rate_limiter;
70 guint32 timeout_fires_at;
80 g_file_monitor_set_property (GObject *object,
85 GFileMonitor *monitor;
87 monitor = G_FILE_MONITOR (object);
92 g_file_monitor_set_rate_limit (monitor, g_value_get_int (value));
96 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
102 g_file_monitor_get_property (GObject *object,
107 GFileMonitor *monitor;
108 GFileMonitorPrivate *priv;
110 monitor = G_FILE_MONITOR (object);
111 priv = monitor->priv;
115 case PROP_RATE_LIMIT:
116 g_value_set_int (value, priv->rate_limit_msec);
120 g_value_set_boolean (value, priv->cancelled);
124 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
129 #define DEFAULT_RATE_LIMIT_MSECS 800
130 #define DEFAULT_VIRTUAL_CHANGES_DONE_DELAY_SECS 2
132 static guint signals[LAST_SIGNAL] = { 0 };
135 rate_limiter_free (RateLimiter *limiter)
137 g_object_unref (limiter->file);
138 g_slice_free (RateLimiter, limiter);
142 g_file_monitor_finalize (GObject *object)
144 GFileMonitor *monitor;
146 monitor = G_FILE_MONITOR (object);
148 if (monitor->priv->timeout)
150 g_source_destroy (monitor->priv->timeout);
151 g_source_unref (monitor->priv->timeout);
154 g_hash_table_destroy (monitor->priv->rate_limiter);
156 if (G_OBJECT_CLASS (g_file_monitor_parent_class)->finalize)
157 (*G_OBJECT_CLASS (g_file_monitor_parent_class)->finalize) (object);
161 g_file_monitor_dispose (GObject *object)
163 GFileMonitor *monitor;
165 monitor = G_FILE_MONITOR (object);
167 /* Make sure we cancel on last unref */
168 if (!monitor->priv->cancelled)
169 g_file_monitor_cancel (monitor);
171 if (G_OBJECT_CLASS (g_file_monitor_parent_class)->dispose)
172 (*G_OBJECT_CLASS (g_file_monitor_parent_class)->dispose) (object);
176 g_file_monitor_class_init (GFileMonitorClass *klass)
178 GObjectClass *object_class;
180 g_type_class_add_private (klass, sizeof (GFileMonitorPrivate));
182 object_class = G_OBJECT_CLASS (klass);
183 object_class->finalize = g_file_monitor_finalize;
184 object_class->dispose = g_file_monitor_dispose;
185 object_class->get_property = g_file_monitor_get_property;
186 object_class->set_property = g_file_monitor_set_property;
189 * GFileMonitor::changed:
190 * @monitor: a #GFileMonitor.
192 * @other_file: a #GFile.
193 * @event_type: a #GFileMonitorEvent.
195 * Emitted when a file has been changed.
198 g_signal_new (I_("changed"),
201 G_STRUCT_OFFSET (GFileMonitorClass, changed),
203 _gio_marshal_VOID__OBJECT_OBJECT_ENUM,
205 G_TYPE_FILE, G_TYPE_FILE, G_TYPE_FILE_MONITOR_EVENT);
207 g_object_class_install_property (object_class,
209 g_param_spec_int ("rate-limit",
211 P_("The limit of the monitor to watch for changes, in milliseconds"),
213 DEFAULT_RATE_LIMIT_MSECS,
215 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
217 g_object_class_install_property (object_class,
219 g_param_spec_boolean ("cancelled",
221 P_("Whether the monitor has been cancelled"),
224 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
228 g_file_monitor_init (GFileMonitor *monitor)
230 monitor->priv = G_TYPE_INSTANCE_GET_PRIVATE (monitor,
232 GFileMonitorPrivate);
233 monitor->priv->rate_limit_msec = DEFAULT_RATE_LIMIT_MSECS;
234 monitor->priv->rate_limiter = g_hash_table_new_full (g_file_hash, (GEqualFunc)g_file_equal,
235 NULL, (GDestroyNotify) rate_limiter_free);
239 * g_file_monitor_is_cancelled:
240 * @monitor: a #GFileMonitor
242 * Returns whether the monitor is canceled.
244 * Returns: %TRUE if monitor is canceled. %FALSE otherwise.
247 g_file_monitor_is_cancelled (GFileMonitor *monitor)
249 g_return_val_if_fail (G_IS_FILE_MONITOR (monitor), FALSE);
251 return monitor->priv->cancelled;
255 * g_file_monitor_cancel:
256 * @monitor: a #GFileMonitor.
258 * Cancels a file monitor.
260 * Returns: %TRUE if monitor was cancelled.
263 g_file_monitor_cancel (GFileMonitor* monitor)
265 GFileMonitorClass *klass;
267 g_return_val_if_fail (G_IS_FILE_MONITOR (monitor), FALSE);
269 if (monitor->priv->cancelled)
272 monitor->priv->cancelled = TRUE;
273 g_object_notify (G_OBJECT (monitor), "cancelled");
275 klass = G_FILE_MONITOR_GET_CLASS (monitor);
276 return (* klass->cancel) (monitor);
280 * g_file_monitor_set_rate_limit:
281 * @monitor: a #GFileMonitor.
282 * @limit_msecs: a integer with the limit in milliseconds to
285 * Sets the rate limit to which the @monitor will report
286 * consecutive change events to the same file.
290 g_file_monitor_set_rate_limit (GFileMonitor *monitor,
293 GFileMonitorPrivate *priv;
295 g_return_if_fail (G_IS_FILE_MONITOR (monitor));
297 priv = monitor->priv;
298 if (priv->rate_limit_msec != limit_msecs)
300 monitor->priv->rate_limit_msec = limit_msecs;
301 g_object_notify (G_OBJECT (monitor), "rate-limit");
306 get_time_msecs (void)
308 return g_thread_gettime() / (1000 * 1000);
312 time_difference (guint32 from, guint32 to)
319 /* Change event rate limiting support: */
322 new_limiter (GFileMonitor *monitor,
325 RateLimiter *limiter;
327 limiter = g_slice_new0 (RateLimiter);
328 limiter->file = g_object_ref (file);
329 g_hash_table_insert (monitor->priv->rate_limiter, file, limiter);
335 rate_limiter_send_virtual_changes_done_now (GFileMonitor *monitor,
336 RateLimiter *limiter)
338 if (limiter->send_virtual_changes_done_at != 0)
340 g_signal_emit (monitor, signals[CHANGED], 0,
342 G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT);
343 limiter->send_virtual_changes_done_at = 0;
348 rate_limiter_send_delayed_change_now (GFileMonitor *monitor,
349 RateLimiter *limiter,
352 if (limiter->send_delayed_change_at != 0)
354 g_signal_emit (monitor, signals[CHANGED], 0,
356 G_FILE_MONITOR_EVENT_CHANGED);
357 limiter->send_delayed_change_at = 0;
358 limiter->last_sent_change_time = time_now;
365 GFileMonitor *monitor;
369 calc_min_time (GFileMonitor *monitor,
370 RateLimiter *limiter,
379 if (limiter->last_sent_change_time != 0)
381 /* Set a timeout at 2*rate limit so that we can clear out the change from the hash eventualy */
382 expire_at = limiter->last_sent_change_time + 2 * monitor->priv->rate_limit_msec;
384 if (time_difference (time_now, expire_at) > 0)
387 *min_time = MIN (*min_time,
388 time_difference (time_now, expire_at));
392 if (limiter->send_delayed_change_at != 0)
395 *min_time = MIN (*min_time,
396 time_difference (time_now, limiter->send_delayed_change_at));
399 if (limiter->send_virtual_changes_done_at != 0)
402 *min_time = MIN (*min_time,
403 time_difference (time_now, limiter->send_virtual_changes_done_at));
410 foreach_rate_limiter_fire (gpointer key,
414 RateLimiter *limiter = value;
415 ForEachData *data = user_data;
417 if (limiter->send_delayed_change_at != 0 &&
418 time_difference (data->time_now, limiter->send_delayed_change_at) == 0)
419 rate_limiter_send_delayed_change_now (data->monitor, limiter, data->time_now);
421 if (limiter->send_virtual_changes_done_at != 0 &&
422 time_difference (data->time_now, limiter->send_virtual_changes_done_at) == 0)
423 rate_limiter_send_virtual_changes_done_now (data->monitor, limiter);
425 return calc_min_time (data->monitor, limiter, data->time_now, &data->min_time);
429 rate_limiter_timeout (gpointer timeout_data)
431 GFileMonitor *monitor = timeout_data;
435 data.min_time = G_MAXUINT32;
436 data.monitor = monitor;
437 data.time_now = get_time_msecs ();
438 g_hash_table_foreach_remove (monitor->priv->rate_limiter,
439 foreach_rate_limiter_fire,
442 /* Remove old timeout */
443 if (monitor->priv->timeout)
445 g_source_destroy (monitor->priv->timeout);
446 g_source_unref (monitor->priv->timeout);
447 monitor->priv->timeout = NULL;
448 monitor->priv->timeout_fires_at = 0;
451 /* Set up new timeout */
452 if (data.min_time != G_MAXUINT32)
454 source = g_timeout_source_new (data.min_time + 1); /* + 1 to make sure we've really passed the time */
455 g_source_set_callback (source, rate_limiter_timeout, monitor, NULL);
456 g_source_attach (source, NULL);
458 monitor->priv->timeout = source;
459 monitor->priv->timeout_fires_at = data.time_now + data.min_time;
466 foreach_rate_limiter_update (gpointer key,
470 RateLimiter *limiter = value;
471 ForEachData *data = user_data;
473 return calc_min_time (data->monitor, limiter, data->time_now, &data->min_time);
477 update_rate_limiter_timeout (GFileMonitor *monitor,
483 if (monitor->priv->timeout_fires_at != 0 && new_time != 0 &&
484 time_difference (new_time, monitor->priv->timeout_fires_at) == 0)
485 return; /* Nothing to do, we already fire earlier than that */
487 data.min_time = G_MAXUINT32;
488 data.monitor = monitor;
489 data.time_now = get_time_msecs ();
490 g_hash_table_foreach_remove (monitor->priv->rate_limiter,
491 foreach_rate_limiter_update,
494 /* Remove old timeout */
495 if (monitor->priv->timeout)
497 g_source_destroy (monitor->priv->timeout);
498 g_source_unref (monitor->priv->timeout);
499 monitor->priv->timeout_fires_at = 0;
500 monitor->priv->timeout = NULL;
503 /* Set up new timeout */
504 if (data.min_time != G_MAXUINT32)
506 source = g_timeout_source_new (data.min_time + 1); /* + 1 to make sure we've really passed the time */
507 g_source_set_callback (source, rate_limiter_timeout, monitor, NULL);
508 g_source_attach (source, NULL);
510 monitor->priv->timeout = source;
511 monitor->priv->timeout_fires_at = data.time_now + data.min_time;
516 * g_file_monitor_emit_event:
517 * @monitor: a #GFileMonitor.
519 * @other_file: a #GFile.
520 * @event_type: a set of #GFileMonitorEvent flags.
522 * Emits the #GFileMonitor::changed signal if a change
523 * has taken place. Should be called from file monitor
524 * implementations only.
527 g_file_monitor_emit_event (GFileMonitor *monitor,
530 GFileMonitorEvent event_type)
532 guint32 time_now, since_last;
534 RateLimiter *limiter;
536 g_return_if_fail (G_IS_FILE_MONITOR (monitor));
537 g_return_if_fail (G_IS_FILE (child));
539 limiter = g_hash_table_lookup (monitor->priv->rate_limiter, child);
541 if (event_type != G_FILE_MONITOR_EVENT_CHANGED)
545 rate_limiter_send_delayed_change_now (monitor, limiter, get_time_msecs ());
546 if (event_type == G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT)
547 limiter->send_virtual_changes_done_at = 0;
549 rate_limiter_send_virtual_changes_done_now (monitor, limiter);
550 update_rate_limiter_timeout (monitor, 0);
552 g_signal_emit (monitor, signals[CHANGED], 0, child, other_file, event_type);
556 /* Changed event, rate limit */
557 time_now = get_time_msecs ();
562 since_last = time_difference (limiter->last_sent_change_time, time_now);
563 if (since_last < monitor->priv->rate_limit_msec)
565 /* We ignore this change, but arm a timer so that we can fire it later if we
566 don't get any other events (that kill this timeout) */
568 if (limiter->send_delayed_change_at == 0)
570 limiter->send_delayed_change_at = time_now + monitor->priv->rate_limit_msec;
571 update_rate_limiter_timeout (monitor, limiter->send_delayed_change_at);
577 limiter = new_limiter (monitor, child);
581 g_signal_emit (monitor, signals[CHANGED], 0, child, other_file, event_type);
583 limiter->last_sent_change_time = time_now;
584 limiter->send_delayed_change_at = 0;
585 /* Set a timeout of 2*rate limit so that we can clear out the change from the hash eventualy */
586 update_rate_limiter_timeout (monitor, time_now + 2 * monitor->priv->rate_limit_msec);
589 /* Schedule a virtual change done. This is removed if we get a real one, and
590 postponed if we get more change events. */
592 limiter->send_virtual_changes_done_at = time_now + DEFAULT_VIRTUAL_CHANGES_DONE_DELAY_SECS * 1000;
593 update_rate_limiter_timeout (monitor, limiter->send_virtual_changes_done_at);
597 #define __G_FILE_MONITOR_C__
598 #include "gioaliasdef.c"