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.
48 G_LOCK_DEFINE_STATIC(cancelled);
55 G_DEFINE_ABSTRACT_TYPE (GFileMonitor, g_file_monitor, G_TYPE_OBJECT);
59 guint32 last_sent_change_time; /* 0 == not sent */
60 guint32 send_delayed_change_at; /* 0 == never */
61 guint32 send_virtual_changes_done_at; /* 0 == never */
64 struct _GFileMonitorPrivate {
68 /* Rate limiting change events */
69 GHashTable *rate_limiter;
72 guint32 timeout_fires_at;
82 g_file_monitor_set_property (GObject *object,
87 GFileMonitor *monitor;
89 monitor = G_FILE_MONITOR (object);
94 g_file_monitor_set_rate_limit (monitor, g_value_get_int (value));
98 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
104 g_file_monitor_get_property (GObject *object,
109 GFileMonitor *monitor;
110 GFileMonitorPrivate *priv;
112 monitor = G_FILE_MONITOR (object);
113 priv = monitor->priv;
117 case PROP_RATE_LIMIT:
118 g_value_set_int (value, priv->rate_limit_msec);
123 g_value_set_boolean (value, priv->cancelled);
124 G_UNLOCK (cancelled);
128 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
133 #define DEFAULT_RATE_LIMIT_MSECS 800
134 #define DEFAULT_VIRTUAL_CHANGES_DONE_DELAY_SECS 2
136 static guint signals[LAST_SIGNAL] = { 0 };
139 rate_limiter_free (RateLimiter *limiter)
141 g_object_unref (limiter->file);
142 g_slice_free (RateLimiter, limiter);
146 g_file_monitor_finalize (GObject *object)
148 GFileMonitor *monitor;
150 monitor = G_FILE_MONITOR (object);
152 if (monitor->priv->timeout)
154 g_source_destroy (monitor->priv->timeout);
155 g_source_unref (monitor->priv->timeout);
158 g_hash_table_destroy (monitor->priv->rate_limiter);
160 if (G_OBJECT_CLASS (g_file_monitor_parent_class)->finalize)
161 (*G_OBJECT_CLASS (g_file_monitor_parent_class)->finalize) (object);
165 g_file_monitor_dispose (GObject *object)
167 GFileMonitor *monitor;
169 monitor = G_FILE_MONITOR (object);
171 /* Make sure we cancel on last unref */
172 g_file_monitor_cancel (monitor);
174 if (G_OBJECT_CLASS (g_file_monitor_parent_class)->dispose)
175 (*G_OBJECT_CLASS (g_file_monitor_parent_class)->dispose) (object);
179 g_file_monitor_class_init (GFileMonitorClass *klass)
181 GObjectClass *object_class;
183 g_type_class_add_private (klass, sizeof (GFileMonitorPrivate));
185 object_class = G_OBJECT_CLASS (klass);
186 object_class->finalize = g_file_monitor_finalize;
187 object_class->dispose = g_file_monitor_dispose;
188 object_class->get_property = g_file_monitor_get_property;
189 object_class->set_property = g_file_monitor_set_property;
192 * GFileMonitor::changed:
193 * @monitor: a #GFileMonitor.
195 * @other_file: a #GFile.
196 * @event_type: a #GFileMonitorEvent.
198 * Emitted when a file has been changed.
201 g_signal_new (I_("changed"),
204 G_STRUCT_OFFSET (GFileMonitorClass, changed),
206 _gio_marshal_VOID__OBJECT_OBJECT_ENUM,
208 G_TYPE_FILE, G_TYPE_FILE, G_TYPE_FILE_MONITOR_EVENT);
210 g_object_class_install_property (object_class,
212 g_param_spec_int ("rate-limit",
214 P_("The limit of the monitor to watch for changes, in milliseconds"),
216 DEFAULT_RATE_LIMIT_MSECS,
218 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
220 g_object_class_install_property (object_class,
222 g_param_spec_boolean ("cancelled",
224 P_("Whether the monitor has been cancelled"),
227 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
231 g_file_monitor_init (GFileMonitor *monitor)
233 monitor->priv = G_TYPE_INSTANCE_GET_PRIVATE (monitor,
235 GFileMonitorPrivate);
236 monitor->priv->rate_limit_msec = DEFAULT_RATE_LIMIT_MSECS;
237 monitor->priv->rate_limiter = g_hash_table_new_full (g_file_hash, (GEqualFunc)g_file_equal,
238 NULL, (GDestroyNotify) rate_limiter_free);
242 * g_file_monitor_is_cancelled:
243 * @monitor: a #GFileMonitor
245 * Returns whether the monitor is canceled.
247 * Returns: %TRUE if monitor is canceled. %FALSE otherwise.
250 g_file_monitor_is_cancelled (GFileMonitor *monitor)
254 g_return_val_if_fail (G_IS_FILE_MONITOR (monitor), FALSE);
257 res = monitor->priv->cancelled;
258 G_UNLOCK (cancelled);
264 * g_file_monitor_cancel:
265 * @monitor: a #GFileMonitor.
267 * Cancels a file monitor.
269 * Returns: %TRUE if monitor was cancelled.
272 g_file_monitor_cancel (GFileMonitor* monitor)
274 GFileMonitorClass *klass;
276 g_return_val_if_fail (G_IS_FILE_MONITOR (monitor), FALSE);
279 if (monitor->priv->cancelled)
281 G_UNLOCK (cancelled);
285 monitor->priv->cancelled = TRUE;
286 G_UNLOCK (cancelled);
288 g_object_notify (G_OBJECT (monitor), "cancelled");
290 klass = G_FILE_MONITOR_GET_CLASS (monitor);
291 return (* klass->cancel) (monitor);
295 * g_file_monitor_set_rate_limit:
296 * @monitor: a #GFileMonitor.
297 * @limit_msecs: a integer with the limit in milliseconds to
300 * Sets the rate limit to which the @monitor will report
301 * consecutive change events to the same file.
305 g_file_monitor_set_rate_limit (GFileMonitor *monitor,
308 GFileMonitorPrivate *priv;
310 g_return_if_fail (G_IS_FILE_MONITOR (monitor));
312 priv = monitor->priv;
313 if (priv->rate_limit_msec != limit_msecs)
315 monitor->priv->rate_limit_msec = limit_msecs;
316 g_object_notify (G_OBJECT (monitor), "rate-limit");
321 GFileMonitor *monitor;
324 GFileMonitorEvent event_type;
328 emit_cb (gpointer data)
330 FileChange *change = data;
331 g_signal_emit (change->monitor, signals[CHANGED], 0,
332 change->child, change->other_file, change->event_type);
337 file_change_free (FileChange *change)
339 g_object_unref (change->monitor);
340 g_object_unref (change->child);
341 if (change->other_file)
342 g_object_unref (change->other_file);
344 g_slice_free (FileChange, change);
348 emit_in_idle (GFileMonitor *monitor,
351 GFileMonitorEvent event_type)
356 change = g_slice_new (FileChange);
358 change->monitor = g_object_ref (monitor);
359 change->child = g_object_ref (child);
361 change->other_file = g_object_ref (other_file);
363 change->other_file = NULL;
364 change->event_type = event_type;
366 source = g_idle_source_new ();
367 g_source_set_priority (source, 0);
369 g_source_set_callback (source, emit_cb, change, (GDestroyNotify)file_change_free);
370 g_source_attach (source, NULL);
371 g_source_unref (source);
375 get_time_msecs (void)
377 return g_thread_gettime() / (1000 * 1000);
381 time_difference (guint32 from, guint32 to)
388 /* Change event rate limiting support: */
391 new_limiter (GFileMonitor *monitor,
394 RateLimiter *limiter;
396 limiter = g_slice_new0 (RateLimiter);
397 limiter->file = g_object_ref (file);
398 g_hash_table_insert (monitor->priv->rate_limiter, file, limiter);
404 rate_limiter_send_virtual_changes_done_now (GFileMonitor *monitor,
405 RateLimiter *limiter)
407 if (limiter->send_virtual_changes_done_at != 0)
409 emit_in_idle (monitor, limiter->file, NULL,
410 G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT);
411 limiter->send_virtual_changes_done_at = 0;
416 rate_limiter_send_delayed_change_now (GFileMonitor *monitor,
417 RateLimiter *limiter,
420 if (limiter->send_delayed_change_at != 0)
422 emit_in_idle (monitor,
424 G_FILE_MONITOR_EVENT_CHANGED);
425 limiter->send_delayed_change_at = 0;
426 limiter->last_sent_change_time = time_now;
433 GFileMonitor *monitor;
437 calc_min_time (GFileMonitor *monitor,
438 RateLimiter *limiter,
447 if (limiter->last_sent_change_time != 0)
449 /* Set a timeout at 2*rate limit so that we can clear out the change from the hash eventualy */
450 expire_at = limiter->last_sent_change_time + 2 * monitor->priv->rate_limit_msec;
452 if (time_difference (time_now, expire_at) > 0)
455 *min_time = MIN (*min_time,
456 time_difference (time_now, expire_at));
460 if (limiter->send_delayed_change_at != 0)
463 *min_time = MIN (*min_time,
464 time_difference (time_now, limiter->send_delayed_change_at));
467 if (limiter->send_virtual_changes_done_at != 0)
470 *min_time = MIN (*min_time,
471 time_difference (time_now, limiter->send_virtual_changes_done_at));
478 foreach_rate_limiter_fire (gpointer key,
482 RateLimiter *limiter = value;
483 ForEachData *data = user_data;
485 if (limiter->send_delayed_change_at != 0 &&
486 time_difference (data->time_now, limiter->send_delayed_change_at) == 0)
487 rate_limiter_send_delayed_change_now (data->monitor, limiter, data->time_now);
489 if (limiter->send_virtual_changes_done_at != 0 &&
490 time_difference (data->time_now, limiter->send_virtual_changes_done_at) == 0)
491 rate_limiter_send_virtual_changes_done_now (data->monitor, limiter);
493 return calc_min_time (data->monitor, limiter, data->time_now, &data->min_time);
497 rate_limiter_timeout (gpointer timeout_data)
499 GFileMonitor *monitor = timeout_data;
503 data.min_time = G_MAXUINT32;
504 data.monitor = monitor;
505 data.time_now = get_time_msecs ();
506 g_hash_table_foreach_remove (monitor->priv->rate_limiter,
507 foreach_rate_limiter_fire,
510 /* Remove old timeout */
511 if (monitor->priv->timeout)
513 g_source_destroy (monitor->priv->timeout);
514 g_source_unref (monitor->priv->timeout);
515 monitor->priv->timeout = NULL;
516 monitor->priv->timeout_fires_at = 0;
519 /* Set up new timeout */
520 if (data.min_time != G_MAXUINT32)
522 source = g_timeout_source_new (data.min_time + 1); /* + 1 to make sure we've really passed the time */
523 g_source_set_callback (source, rate_limiter_timeout, monitor, NULL);
524 g_source_attach (source, NULL);
526 monitor->priv->timeout = source;
527 monitor->priv->timeout_fires_at = data.time_now + data.min_time;
534 foreach_rate_limiter_update (gpointer key,
538 RateLimiter *limiter = value;
539 ForEachData *data = user_data;
541 return calc_min_time (data->monitor, limiter, data->time_now, &data->min_time);
545 update_rate_limiter_timeout (GFileMonitor *monitor,
551 if (monitor->priv->timeout_fires_at != 0 && new_time != 0 &&
552 time_difference (new_time, monitor->priv->timeout_fires_at) == 0)
553 return; /* Nothing to do, we already fire earlier than that */
555 data.min_time = G_MAXUINT32;
556 data.monitor = monitor;
557 data.time_now = get_time_msecs ();
558 g_hash_table_foreach_remove (monitor->priv->rate_limiter,
559 foreach_rate_limiter_update,
562 /* Remove old timeout */
563 if (monitor->priv->timeout)
565 g_source_destroy (monitor->priv->timeout);
566 g_source_unref (monitor->priv->timeout);
567 monitor->priv->timeout_fires_at = 0;
568 monitor->priv->timeout = NULL;
571 /* Set up new timeout */
572 if (data.min_time != G_MAXUINT32)
574 source = g_timeout_source_new (data.min_time + 1); /* + 1 to make sure we've really passed the time */
575 g_source_set_callback (source, rate_limiter_timeout, monitor, NULL);
576 g_source_attach (source, NULL);
578 monitor->priv->timeout = source;
579 monitor->priv->timeout_fires_at = data.time_now + data.min_time;
584 * g_file_monitor_emit_event:
585 * @monitor: a #GFileMonitor.
587 * @other_file: a #GFile.
588 * @event_type: a set of #GFileMonitorEvent flags.
590 * Emits the #GFileMonitor::changed signal if a change
591 * has taken place. Should be called from file monitor
592 * implementations only.
594 * The signal will be emitted from an idle handler.
597 g_file_monitor_emit_event (GFileMonitor *monitor,
600 GFileMonitorEvent event_type)
602 guint32 time_now, since_last;
604 RateLimiter *limiter;
606 g_return_if_fail (G_IS_FILE_MONITOR (monitor));
607 g_return_if_fail (G_IS_FILE (child));
609 limiter = g_hash_table_lookup (monitor->priv->rate_limiter, child);
611 if (event_type != G_FILE_MONITOR_EVENT_CHANGED)
615 rate_limiter_send_delayed_change_now (monitor, limiter, get_time_msecs ());
616 if (event_type == G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT)
617 limiter->send_virtual_changes_done_at = 0;
619 rate_limiter_send_virtual_changes_done_now (monitor, limiter);
620 update_rate_limiter_timeout (monitor, 0);
622 emit_in_idle (monitor, child, other_file, event_type);
626 /* Changed event, rate limit */
627 time_now = get_time_msecs ();
632 since_last = time_difference (limiter->last_sent_change_time, time_now);
633 if (since_last < monitor->priv->rate_limit_msec)
635 /* We ignore this change, but arm a timer so that we can fire it later if we
636 don't get any other events (that kill this timeout) */
638 if (limiter->send_delayed_change_at == 0)
640 limiter->send_delayed_change_at = time_now + monitor->priv->rate_limit_msec;
641 update_rate_limiter_timeout (monitor, limiter->send_delayed_change_at);
647 limiter = new_limiter (monitor, child);
651 emit_in_idle (monitor, child, other_file, event_type);
653 limiter->last_sent_change_time = time_now;
654 limiter->send_delayed_change_at = 0;
655 /* Set a timeout of 2*rate limit so that we can clear out the change from the hash eventualy */
656 update_rate_limiter_timeout (monitor, time_now + 2 * monitor->priv->rate_limit_msec);
659 /* Schedule a virtual change done. This is removed if we get a real one, and
660 postponed if we get more change events. */
662 limiter->send_virtual_changes_done_at = time_now + DEFAULT_VIRTUAL_CHANGES_DONE_DELAY_SECS * 1000;
663 update_rate_limiter_timeout (monitor, limiter->send_virtual_changes_done_at);
667 #define __G_FILE_MONITOR_C__
668 #include "gioaliasdef.c"