1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
#![allow(missing_docs)]
mod timer;
use super::{op, DebouncedEvent, RawEvent};
use self::timer::WatchTimer;
use std::collections::HashMap;
use std::path::PathBuf;
use std::sync::mpsc;
use std::sync::{Arc, Mutex};
use std::time::Duration;
pub type OperationsBufferInner = HashMap<PathBuf, (Option<op::Op>, Option<PathBuf>, Option<u64>)>;
pub type OperationsBuffer = Arc<Mutex<OperationsBufferInner>>;
pub enum EventTx {
Raw {
tx: mpsc::Sender<RawEvent>,
},
Debounced {
tx: mpsc::Sender<DebouncedEvent>,
debounce: Debounce,
},
DebouncedTx {
tx: mpsc::Sender<DebouncedEvent>,
},
}
impl EventTx {
pub fn send(&mut self, event: RawEvent) {
match *self {
EventTx::Raw { ref tx } => {
let _ = tx.send(event);
}
EventTx::Debounced {
ref tx,
ref mut debounce,
} => {
match (event.path, event.op, event.cookie) {
(None, Ok(op::Op::RESCAN), None) => {
let _ = tx.send(DebouncedEvent::Rescan);
}
(Some(path), Ok(op), cookie) => {
debounce.event(path, op, cookie);
}
(None, Ok(_op), _cookie) => {
// TODO panic!("path is None: {:?} ({:?})", _op, _cookie);
}
(path, Err(e), _) => {
let _ = tx.send(DebouncedEvent::Error(e, path));
}
}
}
EventTx::DebouncedTx { ref tx } => {
match (event.path, event.op, event.cookie) {
(None, Ok(op::Op::RESCAN), None) => {
let _ = tx.send(DebouncedEvent::Rescan);
}
(Some(_path), Ok(_op), _cookie) => {
// TODO debounce.event(_path, _op, _cookie);
}
(None, Ok(_op), _cookie) => {
// TODO panic!("path is None: {:?} ({:?})", _op, _cookie);
}
(path, Err(e), _) => {
let _ = tx.send(DebouncedEvent::Error(e, path));
}
}
}
}
}
}
pub struct Debounce {
tx: mpsc::Sender<DebouncedEvent>,
operations_buffer: OperationsBuffer,
rename_path: Option<PathBuf>,
rename_cookie: Option<u32>,
timer: WatchTimer,
}
impl Debounce {
pub fn new(delay: Duration, tx: mpsc::Sender<DebouncedEvent>) -> Debounce {
let operations_buffer: OperationsBuffer = Arc::new(Mutex::new(HashMap::new()));
// spawns new thread
let timer = WatchTimer::new(tx.clone(), operations_buffer.clone(), delay);
Debounce {
tx,
operations_buffer: operations_buffer,
rename_path: None,
rename_cookie: None,
timer,
}
}
fn check_partial_rename(&mut self, path: PathBuf, op: op::Op, cookie: Option<u32>) {
if let Ok(mut op_buf) = self.operations_buffer.lock() {
// the previous event was a rename event, but this one isn't; something went wrong
let mut remove_path: Option<PathBuf> = None;
// get details for the last rename event from the operations_buffer.
// the last rename event might not be found in case the timer already fired
// (https://github.com/notify-rs/notify/issues/101).
if let Some(&mut (ref mut operation, ref mut from_path, ref mut timer_id)) =
op_buf.get_mut(self.rename_path.as_ref().unwrap())
{
if op != op::Op::RENAME
|| self.rename_cookie.is_none()
|| self.rename_cookie != cookie
{
if self.rename_path.as_ref().unwrap().exists() {
match *operation {
Some(op::Op::RENAME) if from_path.is_none() => {
// file has been moved into the watched directory
*operation = Some(op::Op::CREATE);
restart_timer(timer_id, path, &mut self.timer);
}
Some(op::Op::REMOVE) => {
// file has been moved removed before and has now been moved into
// the watched directory
*operation = Some(op::Op::WRITE);
restart_timer(timer_id, path, &mut self.timer);
}
_ => {
// this code can only be reached with fsevents because it may
// repeat a rename event for a file that has been renamed before
// (https://github.com/notify-rs/notify/issues/99)
}
}
} else {
match *operation {
Some(op::Op::CREATE) => {
// file was just created, so just remove the operations_buffer
// entry / no need to emit NoticeRemove because the file has just
// been created.
// ignore running timer
if let Some(timer_id) = *timer_id {
self.timer.ignore(timer_id);
}
// remember for deletion
remove_path = Some(path);
}
Some(op::Op::WRITE) | // change to remove event
Some(op::Op::CHMOD) => { // change to remove event
*operation = Some(op::Op::REMOVE);
let _ = self.tx.send(DebouncedEvent::NoticeRemove(path.clone()));
restart_timer(timer_id, path, &mut self.timer);
}
Some(op::Op::RENAME) => {
// file has been renamed before, change to remove event / no need
// to emit NoticeRemove because the file has been renamed before
*operation = Some(op::Op::REMOVE);
restart_timer(timer_id, path, &mut self.timer);
}
Some(op::Op::REMOVE) => {
// file has been renamed and then removed / keep write event
// this code can only be reached with fsevents because it may
// repeat a rename event for a file that has been renamed before
// (https://github.com/notify-rs/notify/issues/100)
restart_timer(timer_id, path, &mut self.timer);
}
// CLOSE_WRITE and RESCAN aren't tracked by operations_buffer
_ => {
unreachable!();
}
}
}
self.rename_path = None;
}
}
if let Some(path) = remove_path {
op_buf.remove(&path);
}
}
}
pub fn event(&mut self, path: PathBuf, mut op: op::Op, cookie: Option<u32>) {
if op.contains(op::Op::RESCAN) {
let _ = self.tx.send(DebouncedEvent::Rescan);
}
if self.rename_path.is_some() {
self.check_partial_rename(path.clone(), op, cookie);
}
if let Ok(mut op_buf) = self.operations_buffer.lock() {
if let Some(&(operation, _, _)) = op_buf.get(&path) {
op = remove_repeated_events(op, operation);
} else if op.contains(op::Op::CREATE | op::Op::REMOVE) {
if path.exists() {
op.remove(op::Op::REMOVE);
} else {
op.remove(op::Op::CREATE);
}
}
if op.contains(op::Op::CREATE) {
let &mut (ref mut operation, _, ref mut timer_id) =
op_buf.entry(path.clone()).or_insert((None, None, None));
match *operation {
// file can't be created twice
Some(op::Op::CREATE) |
// file can't be written to before being created
Some(op::Op::WRITE) |
// file can't be changed before being created
Some(op::Op::CHMOD) |
// file can't be renamed to before being created
// (repetitions are removed anyway),
// but with fsevents everything is possible
Some(op::Op::RENAME) => {}
// file has been removed and is now being re-created;
// convert this to a write event
Some(op::Op::REMOVE) => {
*operation = Some(op::Op::WRITE);
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// operations_buffer entry didn't exist
None => {
*operation = Some(op::Op::CREATE);
restart_timer(timer_id, path.clone(), &mut self.timer);
}
_ => { unreachable!(); }
}
}
if op.contains(op::Op::WRITE) {
let &mut (ref mut operation, _, ref mut timer_id) =
op_buf.entry(path.clone()).or_insert((None, None, None));
match *operation {
// keep create event / no need to emit NoticeWrite because
// the file has just been created
Some(op::Op::CREATE) |
// keep write event / not need to emit NoticeWrite because
// it already was a write event
Some(op::Op::WRITE) => {
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// upgrade to write event
Some(op::Op::CHMOD) |
// file has been renamed before, upgrade to write event
Some(op::Op::RENAME) |
// operations_buffer entry didn't exist
None => {
*operation = Some(op::Op::WRITE);
let _ = self.tx.send(DebouncedEvent::NoticeWrite(path.clone()));
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// writing to a deleted file is impossible,
// but with fsevents everything is possible
Some(op::Op::REMOVE) => {}
_ => { unreachable!(); }
}
}
if op.contains(op::Op::CHMOD) {
let &mut (ref mut operation, _, ref mut timer_id) =
op_buf.entry(path.clone()).or_insert((None, None, None));
match *operation {
// keep create event
Some(op::Op::CREATE) |
// keep write event
Some(op::Op::WRITE) |
// keep chmod event
Some(op::Op::CHMOD) => { restart_timer(timer_id, path.clone(), &mut self.timer); }
// file has been renamed before, upgrade to chmod event
Some(op::Op::RENAME) |
// operations_buffer entry didn't exist
None => {
*operation = Some(op::Op::CHMOD);
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// changing a deleted file is impossible,
// but with fsevents everything is possible
Some(op::Op::REMOVE) => {}
_ => { unreachable!(); }
}
}
if op.contains(op::Op::RENAME) {
// unwrap is safe because rename_path is Some
if self.rename_path.is_some()
&& self.rename_cookie.is_some()
&& self.rename_cookie == cookie
&& op_buf.contains_key(self.rename_path.as_ref().unwrap())
{
// This is the second part of a rename operation, the old path is stored in the
// rename_path variable.
// unwrap is safe because rename_path is Some and op_buf contains rename_path
let (from_operation, from_from_path, from_timer_id) =
op_buf.remove(self.rename_path.as_ref().unwrap()).unwrap();
// ignore running timer of removed operations_buffer entry
if let Some(from_timer_id) = from_timer_id {
self.timer.ignore(from_timer_id);
}
// if the file has been renamed before, use original name as from_path
let use_from_path = from_from_path.or_else(|| self.rename_path.clone());
let &mut (ref mut operation, ref mut from_path, ref mut timer_id) =
op_buf.entry(path.clone()).or_insert((None, None, None));
match from_operation {
// file has just been created, so move the create event to the new path
Some(op::Op::CREATE) => {
*operation = from_operation;
*from_path = None;
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// file has been written to, so move the event to the new path, but keep
// the write event
Some(op::Op::WRITE) |
// file has been changed, so move the event to the new path, but keep the
// chmod event
Some(op::Op::CHMOD) |
// file has been renamed before, so move the event to the new path and
// update the from_path
Some(op::Op::RENAME) => {
*operation = from_operation;
*from_path = use_from_path;
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// file can't be renamed after being removed,
// but with fsevents everything is possible
Some(op::Op::REMOVE) => {}
_ => { unreachable!(); }
}
// reset the rename_path
self.rename_path = None;
} else {
// this is the first part of a rename operation,
// store path for the subsequent rename event
self.rename_path = Some(path.clone());
self.rename_cookie = cookie;
let &mut (ref mut operation, _, ref mut timer_id) =
op_buf.entry(path.clone()).or_insert((None, None, None));
match *operation {
// keep create event / no need to emit NoticeRemove because
// the file has just been created
Some(op::Op::CREATE) |
// file has been renamed before, so
// keep rename event / no need to emit NoticeRemove because
// the file has been renamed before
Some(op::Op::RENAME) => {
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// keep write event
Some(op::Op::WRITE) |
// keep chmod event
Some(op::Op::CHMOD) => {
let _ = self.tx.send(DebouncedEvent::NoticeRemove(path.clone()));
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// operations_buffer entry didn't exist
None => {
*operation = Some(op::Op::RENAME);
let _ = self.tx.send(DebouncedEvent::NoticeRemove(path.clone()));
restart_timer(timer_id, path.clone(), &mut self.timer);
}
// renaming a deleted file should be impossible,
// but with fsevents everything is possible
// (https://github.com/notify-rs/notify/issues/101)
Some(op::Op::REMOVE) => {}
_ => { unreachable!(); }
}
}
}
if op.contains(op::Op::REMOVE) {
let mut remove_path: Option<PathBuf> = None;
{
if let Some(&(_, ref from_path, ref timer_id)) = op_buf.get(&path) {
if let Some(ref from_path) = *from_path {
if op_buf.contains_key(from_path) {
// a file has already been created at the same location this file
// has been moved from before being deleted / all events
// regarding this file can be ignored
// ignore running timer
if let Some(timer_id) = *timer_id {
self.timer.ignore(timer_id);
}
// remember for deletion
remove_path = Some(path.clone());
}
}
}
let &mut (ref mut operation, _, ref mut timer_id) =
op_buf.entry(path.clone()).or_insert((None, None, None));
if remove_path.is_none() {
match *operation {
// file was just created, so just remove the operations_buffer entry / no
// need to emit NoticeRemove because the file has just been created
Some(op::Op::CREATE) => {
// ignore running timer
if let Some(timer_id) = *timer_id {
self.timer.ignore(timer_id);
}
// remember for deletion
remove_path = Some(path);
}
// change to remove event
Some(op::Op::WRITE) |
// change to remove event
Some(op::Op::CHMOD) |
// operations_buffer entry didn't exist
None => {
*operation = Some(op::Op::REMOVE);
let _ = self.tx.send(DebouncedEvent::NoticeRemove(path.clone()));
restart_timer(timer_id, path, &mut self.timer);
}
// file has been renamed before, change to remove event /
// no need to emit NoticeRemove because the file has been renamed before
Some(op::Op::RENAME) => {
*operation = Some(op::Op::REMOVE);
restart_timer(timer_id, path, &mut self.timer);
}
// multiple remove events are possible if the file/directory
// is itself watched and in a watched directory
Some(op::Op::REMOVE) => {}
_ => { unreachable!(); }
}
}
}
if let Some(path) = remove_path {
op_buf.remove(&path);
if self.rename_path == Some(path) {
self.rename_path = None;
}
}
}
}
}
}
fn remove_repeated_events(mut op: op::Op, prev_op: Option<op::Op>) -> op::Op {
if let Some(prev_op) = prev_op {
if prev_op.intersects(op::Op::CREATE | op::Op::WRITE | op::Op::CHMOD | op::Op::RENAME) {
op.remove(op::Op::CREATE);
}
if prev_op.contains(op::Op::REMOVE) {
op.remove(op::Op::REMOVE);
}
if prev_op.contains(op::Op::RENAME) && op & !op::Op::RENAME != op::Op::empty() {
op.remove(op::Op::RENAME);
}
}
op
}
fn restart_timer(timer_id: &mut Option<u64>, path: PathBuf, timer: &mut WatchTimer) {
if let Some(timer_id) = *timer_id {
timer.ignore(timer_id);
}
*timer_id = Some(timer.schedule(path));
}