user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
blob 6d2696019d8324fc3676d4e49efb783e10efc15a 4011 bytes (raw)
name: lib/PublicInbox/FakeInotify.pm 	 # note: path name is non-authoritative(*)

  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
 
# Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

# for systems lacking Linux::Inotify2 or IO::KQueue, just emulates
# enough of Linux::Inotify2
package PublicInbox::FakeInotify;
use strict;
use v5.10.1;
use parent qw(Exporter);
use Time::HiRes qw(stat);
use PublicInbox::DS qw(add_timer);
sub IN_MODIFY () { 0x02 } # match Linux inotify
# my $IN_MOVED_FROM	 0x00000040	/* File was moved from X.  */
# my $IN_MOVED_TO = 0x80;
# my $IN_CREATE = 0x100;
sub MOVED_TO_OR_CREATE () { 0x80 | 0x100 }
sub IN_DELETE () { 0x200 }
sub IN_DELETE_SELF () { 0x400 }
sub IN_MOVE_SELF () { 0x800 }

our @EXPORT_OK = qw(fill_dirlist on_dir_change);

my $poll_intvl = 2; # same as Filesys::Notify::Simple

sub new { bless { watch => {}, dirlist => {} }, __PACKAGE__ }

sub fill_dirlist ($$$) {
	my ($self, $path, $dh) = @_;
	my $dirlist = $self->{dirlist}->{$path} = {};
	while (defined(my $n = readdir($dh))) {
		$dirlist->{$n} = undef if $n !~ /\A\.\.?\z/;
	}
}

# behaves like Linux::Inotify2->watch
sub watch {
	my ($self, $path, $mask) = @_;
	my @st = stat($path) or return;
	my $k = "$path\0$mask";
	$self->{watch}->{$k} = $st[10]; # 10 - ctime
	if ($mask & IN_DELETE) {
		opendir(my $dh, $path) or return;
		fill_dirlist($self, $path, $dh);
	}
	bless [ $self->{watch}, $k ], 'PublicInbox::FakeInotify::Watch';
}

# also used by KQNotify since it kevent requires readdir on st_nlink
# count changes.
sub on_dir_change ($$$$$) {
	my ($events, $dh, $path, $old_ctime, $dirlist) = @_;
	my $oldlist = $dirlist->{$path};
	my $newlist = $oldlist ? {} : undef;
	while (defined(my $base = readdir($dh))) {
		next if $base =~ /\A\.\.?\z/;
		my $full = "$path/$base";
		my @st = stat($full);
		if (@st && $st[10] > $old_ctime) {
			push @$events,
				bless(\$full, 'PublicInbox::FakeInotify::Event')
		}
		if (!@st) {
			# ignore ENOENT due to race
			warn "unhandled stat($full) error: $!\n" if !$!{ENOENT};
		} elsif ($newlist) {
			$newlist->{$base} = undef;
		}
	}
	return if !$newlist;
	delete @$oldlist{keys %$newlist};
	$dirlist->{$path} = $newlist;
	push(@$events, map {
		bless \"$path/$_", 'PublicInbox::FakeInotify::GoneEvent'
	} keys %$oldlist);
}

# behaves like non-blocking Linux::Inotify2->read
sub read {
	my ($self) = @_;
	my $watch = $self->{watch} or return ();
	my $events = [];
	my @watch_gone;
	for my $x (keys %$watch) {
		my ($path, $mask) = split(/\0/, $x, 2);
		my @now = stat($path);
		if (!@now && $!{ENOENT} && ($mask & IN_DELETE_SELF)) {
			push @$events, bless(\$path,
				'PublicInbox::FakeInotify::SelfGoneEvent');
			push @watch_gone, $x;
			delete $self->{dirlist}->{$path};
		}
		next if !@now;
		my $old_ctime = $watch->{$x};
		$watch->{$x} = $now[10];
		next if $old_ctime == $now[10];
		if ($mask & IN_MODIFY) {
			push @$events,
				bless(\$path, 'PublicInbox::FakeInotify::Event')
		} elsif ($mask & (MOVED_TO_OR_CREATE | IN_DELETE)) {
			if (opendir(my $dh, $path)) {
				on_dir_change($events, $dh, $path, $old_ctime,
						$self->{dirlist});
			} elsif ($!{ENOENT}) {
				push @watch_gone, $x;
				delete $self->{dirlist}->{$path};
			} else {
				warn "W: opendir $path: $!\n";
			}
		}
	}
	delete @$watch{@watch_gone};
	@$events;
}

sub poll_once {
	my ($obj) = @_;
	$obj->event_step; # PublicInbox::InboxIdle::event_step
	add_timer($poll_intvl, \&poll_once, $obj);
}

package PublicInbox::FakeInotify::Watch;
use strict;

sub cancel {
	my ($self) = @_;
	delete $self->[0]->{$self->[1]};
}

sub name {
	my ($self) = @_;
	(split(/\0/, $self->[1], 2))[0];
}

package PublicInbox::FakeInotify::Event;
use strict;

sub fullname { ${$_[0]} }

sub IN_DELETE { 0 }
sub IN_MOVED_FROM { 0 }
sub IN_DELETE_SELF { 0 }

package PublicInbox::FakeInotify::GoneEvent;
use strict;
our @ISA = qw(PublicInbox::FakeInotify::Event);

sub IN_DELETE { 1 }
sub IN_MOVED_FROM { 0 }

package PublicInbox::FakeInotify::SelfGoneEvent;
use strict;
our @ISA = qw(PublicInbox::FakeInotify::GoneEvent);

sub IN_DELETE_SELF { 1 }

1;

debug log:

solving 6d2696019d83 ...
found 6d2696019d83 in https://80x24.org/public-inbox.git

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).