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"
36 * SECTION:gfilemonitor
37 * @short_description: File Monitor
40 * Monitors a file or directory for changes.
42 * To obtain a #GFileMonitor for a file or directory, use
43 * g_file_monitor_file() or g_file_monitor_directory().
45 * To get informed about changes to the file or directory you
46 * are monitoring, connect to the #GFileMonitor::changed signal.
49 G_LOCK_DEFINE_STATIC(cancelled
);
56 /* work around a limitation of the aliasing foo */
59 G_DEFINE_ABSTRACT_TYPE (GFileMonitor
, g_file_monitor
, G_TYPE_OBJECT
);
63 guint32 last_sent_change_time
; /* 0 == not sent */
64 guint32 send_delayed_change_at
; /* 0 == never */
65 guint32 send_virtual_changes_done_at
; /* 0 == never */
68 struct _GFileMonitorPrivate
{
72 /* Rate limiting change events */
73 GHashTable
*rate_limiter
;
76 guint32 timeout_fires_at
;
86 g_file_monitor_set_property (GObject
*object
,
91 GFileMonitor
*monitor
;
93 monitor
= G_FILE_MONITOR (object
);
98 g_file_monitor_set_rate_limit (monitor
, g_value_get_int (value
));
102 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
108 g_file_monitor_get_property (GObject
*object
,
113 GFileMonitor
*monitor
;
114 GFileMonitorPrivate
*priv
;
116 monitor
= G_FILE_MONITOR (object
);
117 priv
= monitor
->priv
;
121 case PROP_RATE_LIMIT
:
122 g_value_set_int (value
, priv
->rate_limit_msec
);
127 g_value_set_boolean (value
, priv
->cancelled
);
128 G_UNLOCK (cancelled
);
132 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
137 #define DEFAULT_RATE_LIMIT_MSECS 800
138 #define DEFAULT_VIRTUAL_CHANGES_DONE_DELAY_SECS 2
140 static guint signals
[LAST_SIGNAL
] = { 0 };
143 rate_limiter_free (RateLimiter
*limiter
)
145 g_object_unref (limiter
->file
);
146 g_slice_free (RateLimiter
, limiter
);
150 g_file_monitor_finalize (GObject
*object
)
152 GFileMonitor
*monitor
;
154 monitor
= G_FILE_MONITOR (object
);
156 if (monitor
->priv
->timeout
)
158 g_source_destroy (monitor
->priv
->timeout
);
159 g_source_unref (monitor
->priv
->timeout
);
162 g_hash_table_destroy (monitor
->priv
->rate_limiter
);
164 G_OBJECT_CLASS (g_file_monitor_parent_class
)->finalize (object
);
168 g_file_monitor_dispose (GObject
*object
)
170 GFileMonitor
*monitor
;
172 monitor
= G_FILE_MONITOR (object
);
174 /* Make sure we cancel on last unref */
175 g_file_monitor_cancel (monitor
);
177 G_OBJECT_CLASS (g_file_monitor_parent_class
)->dispose (object
);
181 g_file_monitor_class_init (GFileMonitorClass
*klass
)
183 GObjectClass
*object_class
;
185 g_type_class_add_private (klass
, sizeof (GFileMonitorPrivate
));
187 object_class
= G_OBJECT_CLASS (klass
);
188 object_class
->finalize
= g_file_monitor_finalize
;
189 object_class
->dispose
= g_file_monitor_dispose
;
190 object_class
->get_property
= g_file_monitor_get_property
;
191 object_class
->set_property
= g_file_monitor_set_property
;
194 * GFileMonitor::changed:
195 * @monitor: a #GFileMonitor.
197 * @other_file: a #GFile.
198 * @event_type: a #GFileMonitorEvent.
200 * Emitted when a file has been changed.
203 g_signal_new (I_("changed"),
206 G_STRUCT_OFFSET (GFileMonitorClass
, changed
),
208 _gio_marshal_VOID__OBJECT_OBJECT_ENUM
,
210 G_TYPE_FILE
, G_TYPE_FILE
, G_TYPE_FILE_MONITOR_EVENT
);
212 g_object_class_install_property (object_class
,
214 g_param_spec_int ("rate-limit",
216 P_("The limit of the monitor to watch for changes, in milliseconds"),
218 DEFAULT_RATE_LIMIT_MSECS
,
220 G_PARAM_STATIC_NAME
|G_PARAM_STATIC_NICK
|G_PARAM_STATIC_BLURB
));
222 g_object_class_install_property (object_class
,
224 g_param_spec_boolean ("cancelled",
226 P_("Whether the monitor has been cancelled"),
229 G_PARAM_STATIC_NAME
|G_PARAM_STATIC_NICK
|G_PARAM_STATIC_BLURB
));
233 g_file_monitor_init (GFileMonitor
*monitor
)
235 monitor
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (monitor
,
237 GFileMonitorPrivate
);
238 monitor
->priv
->rate_limit_msec
= DEFAULT_RATE_LIMIT_MSECS
;
239 monitor
->priv
->rate_limiter
= g_hash_table_new_full (g_file_hash
, (GEqualFunc
)g_file_equal
,
240 NULL
, (GDestroyNotify
) rate_limiter_free
);
244 * g_file_monitor_is_cancelled:
245 * @monitor: a #GFileMonitor
247 * Returns whether the monitor is canceled.
249 * Returns: %TRUE if monitor is canceled. %FALSE otherwise.
252 g_file_monitor_is_cancelled (GFileMonitor
*monitor
)
256 g_return_val_if_fail (G_IS_FILE_MONITOR (monitor
), FALSE
);
259 res
= monitor
->priv
->cancelled
;
260 G_UNLOCK (cancelled
);
266 * g_file_monitor_cancel:
267 * @monitor: a #GFileMonitor.
269 * Cancels a file monitor.
271 * Returns: %TRUE if monitor was cancelled.
274 g_file_monitor_cancel (GFileMonitor
* monitor
)
276 GFileMonitorClass
*klass
;
278 g_return_val_if_fail (G_IS_FILE_MONITOR (monitor
), FALSE
);
281 if (monitor
->priv
->cancelled
)
283 G_UNLOCK (cancelled
);
287 monitor
->priv
->cancelled
= TRUE
;
288 G_UNLOCK (cancelled
);
290 g_object_notify (G_OBJECT (monitor
), "cancelled");
292 klass
= G_FILE_MONITOR_GET_CLASS (monitor
);
293 return (* klass
->cancel
) (monitor
);
297 * g_file_monitor_set_rate_limit:
298 * @monitor: a #GFileMonitor.
299 * @limit_msecs: a integer with the limit in milliseconds to
302 * Sets the rate limit to which the @monitor will report
303 * consecutive change events to the same file.
307 g_file_monitor_set_rate_limit (GFileMonitor
*monitor
,
310 GFileMonitorPrivate
*priv
;
312 g_return_if_fail (G_IS_FILE_MONITOR (monitor
));
314 priv
= monitor
->priv
;
315 if (priv
->rate_limit_msec
!= limit_msecs
)
317 monitor
->priv
->rate_limit_msec
= limit_msecs
;
318 g_object_notify (G_OBJECT (monitor
), "rate-limit");
323 GFileMonitor
*monitor
;
326 GFileMonitorEvent event_type
;
330 emit_cb (gpointer data
)
332 FileChange
*change
= data
;
333 g_signal_emit (change
->monitor
, signals
[CHANGED
], 0,
334 change
->child
, change
->other_file
, change
->event_type
);
339 file_change_free (FileChange
*change
)
341 g_object_unref (change
->monitor
);
342 g_object_unref (change
->child
);
343 if (change
->other_file
)
344 g_object_unref (change
->other_file
);
346 g_slice_free (FileChange
, change
);
350 emit_in_idle (GFileMonitor
*monitor
,
353 GFileMonitorEvent event_type
)
358 change
= g_slice_new (FileChange
);
360 change
->monitor
= g_object_ref (monitor
);
361 change
->child
= g_object_ref (child
);
363 change
->other_file
= g_object_ref (other_file
);
365 change
->other_file
= NULL
;
366 change
->event_type
= event_type
;
368 source
= g_idle_source_new ();
369 g_source_set_priority (source
, 0);
371 g_source_set_callback (source
, emit_cb
, change
, (GDestroyNotify
)file_change_free
);
372 g_source_attach (source
, NULL
);
373 g_source_unref (source
);
377 get_time_msecs (void)
379 return g_thread_gettime() / (1000 * 1000);
383 time_difference (guint32 from
, guint32 to
)
390 /* Change event rate limiting support: */
393 new_limiter (GFileMonitor
*monitor
,
396 RateLimiter
*limiter
;
398 limiter
= g_slice_new0 (RateLimiter
);
399 limiter
->file
= g_object_ref (file
);
400 g_hash_table_insert (monitor
->priv
->rate_limiter
, file
, limiter
);
406 rate_limiter_send_virtual_changes_done_now (GFileMonitor
*monitor
,
407 RateLimiter
*limiter
)
409 if (limiter
->send_virtual_changes_done_at
!= 0)
411 emit_in_idle (monitor
, limiter
->file
, NULL
,
412 G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
);
413 limiter
->send_virtual_changes_done_at
= 0;
418 rate_limiter_send_delayed_change_now (GFileMonitor
*monitor
,
419 RateLimiter
*limiter
,
422 if (limiter
->send_delayed_change_at
!= 0)
424 emit_in_idle (monitor
,
426 G_FILE_MONITOR_EVENT_CHANGED
);
427 limiter
->send_delayed_change_at
= 0;
428 limiter
->last_sent_change_time
= time_now
;
435 GFileMonitor
*monitor
;
439 calc_min_time (GFileMonitor
*monitor
,
440 RateLimiter
*limiter
,
449 if (limiter
->last_sent_change_time
!= 0)
451 /* Set a timeout at 2*rate limit so that we can clear out the change from the hash eventualy */
452 expire_at
= limiter
->last_sent_change_time
+ 2 * monitor
->priv
->rate_limit_msec
;
454 if (time_difference (time_now
, expire_at
) > 0)
457 *min_time
= MIN (*min_time
,
458 time_difference (time_now
, expire_at
));
462 if (limiter
->send_delayed_change_at
!= 0)
465 *min_time
= MIN (*min_time
,
466 time_difference (time_now
, limiter
->send_delayed_change_at
));
469 if (limiter
->send_virtual_changes_done_at
!= 0)
472 *min_time
= MIN (*min_time
,
473 time_difference (time_now
, limiter
->send_virtual_changes_done_at
));
480 foreach_rate_limiter_fire (gpointer key
,
484 RateLimiter
*limiter
= value
;
485 ForEachData
*data
= user_data
;
487 if (limiter
->send_delayed_change_at
!= 0 &&
488 time_difference (data
->time_now
, limiter
->send_delayed_change_at
) == 0)
489 rate_limiter_send_delayed_change_now (data
->monitor
, limiter
, data
->time_now
);
491 if (limiter
->send_virtual_changes_done_at
!= 0 &&
492 time_difference (data
->time_now
, limiter
->send_virtual_changes_done_at
) == 0)
493 rate_limiter_send_virtual_changes_done_now (data
->monitor
, limiter
);
495 return calc_min_time (data
->monitor
, limiter
, data
->time_now
, &data
->min_time
);
499 rate_limiter_timeout (gpointer timeout_data
)
501 GFileMonitor
*monitor
= timeout_data
;
505 data
.min_time
= G_MAXUINT32
;
506 data
.monitor
= monitor
;
507 data
.time_now
= get_time_msecs ();
508 g_hash_table_foreach_remove (monitor
->priv
->rate_limiter
,
509 foreach_rate_limiter_fire
,
512 /* Remove old timeout */
513 if (monitor
->priv
->timeout
)
515 g_source_destroy (monitor
->priv
->timeout
);
516 g_source_unref (monitor
->priv
->timeout
);
517 monitor
->priv
->timeout
= NULL
;
518 monitor
->priv
->timeout_fires_at
= 0;
521 /* Set up new timeout */
522 if (data
.min_time
!= G_MAXUINT32
)
524 source
= g_timeout_source_new (data
.min_time
+ 1); /* + 1 to make sure we've really passed the time */
525 g_source_set_callback (source
, rate_limiter_timeout
, monitor
, NULL
);
526 g_source_attach (source
, NULL
);
528 monitor
->priv
->timeout
= source
;
529 monitor
->priv
->timeout_fires_at
= data
.time_now
+ data
.min_time
;
536 foreach_rate_limiter_update (gpointer key
,
540 RateLimiter
*limiter
= value
;
541 ForEachData
*data
= user_data
;
543 return calc_min_time (data
->monitor
, limiter
, data
->time_now
, &data
->min_time
);
547 update_rate_limiter_timeout (GFileMonitor
*monitor
,
553 if (monitor
->priv
->timeout_fires_at
!= 0 && new_time
!= 0 &&
554 time_difference (new_time
, monitor
->priv
->timeout_fires_at
) == 0)
555 return; /* Nothing to do, we already fire earlier than that */
557 data
.min_time
= G_MAXUINT32
;
558 data
.monitor
= monitor
;
559 data
.time_now
= get_time_msecs ();
560 g_hash_table_foreach_remove (monitor
->priv
->rate_limiter
,
561 foreach_rate_limiter_update
,
564 /* Remove old timeout */
565 if (monitor
->priv
->timeout
)
567 g_source_destroy (monitor
->priv
->timeout
);
568 g_source_unref (monitor
->priv
->timeout
);
569 monitor
->priv
->timeout_fires_at
= 0;
570 monitor
->priv
->timeout
= NULL
;
573 /* Set up new timeout */
574 if (data
.min_time
!= G_MAXUINT32
)
576 source
= g_timeout_source_new (data
.min_time
+ 1); /* + 1 to make sure we've really passed the time */
577 g_source_set_callback (source
, rate_limiter_timeout
, monitor
, NULL
);
578 g_source_attach (source
, NULL
);
580 monitor
->priv
->timeout
= source
;
581 monitor
->priv
->timeout_fires_at
= data
.time_now
+ data
.min_time
;
586 * g_file_monitor_emit_event:
587 * @monitor: a #GFileMonitor.
589 * @other_file: a #GFile.
590 * @event_type: a set of #GFileMonitorEvent flags.
592 * Emits the #GFileMonitor::changed signal if a change
593 * has taken place. Should be called from file monitor
594 * implementations only.
596 * The signal will be emitted from an idle handler.
599 g_file_monitor_emit_event (GFileMonitor
*monitor
,
602 GFileMonitorEvent event_type
)
604 guint32 time_now
, since_last
;
606 RateLimiter
*limiter
;
608 g_return_if_fail (G_IS_FILE_MONITOR (monitor
));
609 g_return_if_fail (G_IS_FILE (child
));
611 limiter
= g_hash_table_lookup (monitor
->priv
->rate_limiter
, child
);
613 if (event_type
!= G_FILE_MONITOR_EVENT_CHANGED
)
617 rate_limiter_send_delayed_change_now (monitor
, limiter
, get_time_msecs ());
618 if (event_type
== G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
)
619 limiter
->send_virtual_changes_done_at
= 0;
621 rate_limiter_send_virtual_changes_done_now (monitor
, limiter
);
622 update_rate_limiter_timeout (monitor
, 0);
624 emit_in_idle (monitor
, child
, other_file
, event_type
);
628 /* Changed event, rate limit */
629 time_now
= get_time_msecs ();
634 since_last
= time_difference (limiter
->last_sent_change_time
, time_now
);
635 if (since_last
< monitor
->priv
->rate_limit_msec
)
637 /* We ignore this change, but arm a timer so that we can fire it later if we
638 don't get any other events (that kill this timeout) */
640 if (limiter
->send_delayed_change_at
== 0)
642 limiter
->send_delayed_change_at
= time_now
+ monitor
->priv
->rate_limit_msec
;
643 update_rate_limiter_timeout (monitor
, limiter
->send_delayed_change_at
);
649 limiter
= new_limiter (monitor
, child
);
653 emit_in_idle (monitor
, child
, other_file
, event_type
);
655 limiter
->last_sent_change_time
= time_now
;
656 limiter
->send_delayed_change_at
= 0;
657 /* Set a timeout of 2*rate limit so that we can clear out the change from the hash eventualy */
658 update_rate_limiter_timeout (monitor
, time_now
+ 2 * monitor
->priv
->rate_limit_msec
);
661 /* Schedule a virtual change done. This is removed if we get a real one, and
662 postponed if we get more change events. */
664 limiter
->send_virtual_changes_done_at
= time_now
+ DEFAULT_VIRTUAL_CHANGES_DONE_DELAY_SECS
* 1000;
665 update_rate_limiter_timeout (monitor
, limiter
->send_virtual_changes_done_at
);
669 #define __G_FILE_MONITOR_C__
670 #include "gioaliasdef.c"