about summary refs log tree commit homepage
path: root/lib/PublicInbox/InboxIdle.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/PublicInbox/InboxIdle.pm')
-rw-r--r--lib/PublicInbox/InboxIdle.pm106
1 files changed, 106 insertions, 0 deletions
diff --git a/lib/PublicInbox/InboxIdle.pm b/lib/PublicInbox/InboxIdle.pm
new file mode 100644
index 00000000..3c4d4a68
--- /dev/null
+++ b/lib/PublicInbox/InboxIdle.pm
@@ -0,0 +1,106 @@
+# Copyright (C) all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+
+# fields:
+# inot: Linux::Inotify2-like object
+# pathmap => { inboxdir => [ ibx, watch1, watch2, watch3... ] } mapping
+package PublicInbox::InboxIdle;
+use v5.12;
+use parent qw(PublicInbox::DS);
+use PublicInbox::Syscall qw(EPOLLIN);
+my $IN_MODIFY = 0x02; # match Linux inotify
+my $ino_cls;
+if ($^O eq 'linux' && eval { require PublicInbox::Inotify }) {
+        $IN_MODIFY = PublicInbox::Inotify::IN_MODIFY();
+        $ino_cls = 'PublicInbox::Inotify';
+} elsif (eval { require PublicInbox::KQNotify }) {
+        $IN_MODIFY = PublicInbox::KQNotify::NOTE_WRITE();
+        $ino_cls = 'PublicInbox::KQNotify';
+}
+require PublicInbox::In2Tie if $ino_cls;
+
+sub in2_arm ($$) { # PublicInbox::Config::each_inbox callback
+        my ($ibx, $self) = @_;
+        my $dir = $ibx->{inboxdir};
+        my $inot = $self->{inot};
+        my $cur = $self->{pathmap}->{$dir} //= [];
+        my $lock = "$dir/".($ibx->version >= 2 ? 'inbox.lock' : 'ssoma.lock');
+
+        # transfer old subscriptions to the current inbox, cancel the old watch
+        my $old_ibx = $cur->[0];
+        $cur->[0] = $ibx;
+        if ($old_ibx) {
+                my $u = $ibx->{unlock_subs};
+                $ibx->{unlock_subs} = $old_ibx->{unlock_subs};
+                %{$ibx->{unlock_subs}} = (%$u, %{$ibx->{unlock_subs}}) if $u;
+
+                # *::Inotify*::Watch::name matches if watches are the
+                # same, no point in replacing a watch of the same name
+                if ($cur->[1]->name eq $lock) {
+                        $self->{on_unlock}->{$lock} = $ibx;
+                        return;
+                }
+                # rare, name changed (v1 inbox converted to v2)
+                $cur->[1]->cancel; # Linux::Inotify2::Watch::cancel
+        }
+
+        if (my $w = $cur->[1] = $inot->watch($lock, $IN_MODIFY)) {
+                $self->{on_unlock}->{$w->name} = $ibx;
+        } else {
+                warn "E: ".ref($inot)."->watch($lock, IN_MODIFY) failed: $!\n";
+                warn <<"" if $!{ENOSPC} && $^O eq 'linux';
+# consider increasing /proc/sys/fs/inotify/max_user_watches
+
+        }
+
+        # TODO: detect deleted packs (and possibly other files)
+}
+
+sub refresh {
+        my ($self, $pi_cfg) = @_;
+        $pi_cfg->each_inbox(\&in2_arm, $self);
+}
+
+# internal API for ease-of-use
+sub watch_inbox { in2_arm($_[1], $_[0]) };
+
+sub new {
+        my ($class, $pi_cfg) = @_;
+        my $self = bless {}, $class;
+        my $inot;
+        if ($ino_cls) {
+                $inot = $ino_cls->new or die "E: $ino_cls->new: $!";
+                my $io = PublicInbox::In2Tie::io($inot);
+                $self->SUPER::new($io, EPOLLIN);
+        } else {
+                require PublicInbox::FakeInotify;
+                $inot = PublicInbox::FakeInotify->new;
+        }
+        $self->{inot} = $inot;
+        $self->{pathmap} = {}; # inboxdir => [ ibx, watch1, watch2, watch3...]
+        $self->{on_unlock} = {}; # lock path => ibx
+        refresh($self, $pi_cfg) if $pi_cfg;
+        PublicInbox::FakeInotify::poll_once($self) if !$ino_cls;
+        $self;
+}
+
+sub event_step {
+        my ($self) = @_;
+        eval {
+                my @events = $self->{inot}->read; # PublicInbox::Inotify3::read
+                my $on_unlock = $self->{on_unlock};
+                for my $ev (@events) {
+                        my $fn = $ev->fullname // next; # cancelled
+                        if (my $ibx = $on_unlock->{$fn}) {
+                                $ibx->on_unlock;
+                        }
+                }
+        };
+        warn "{inot}->read err: $@\n" if $@;
+}
+
+# for graceful shutdown in PublicInbox::Daemon,
+# just ensure the FD gets closed ASAP and subscribers
+sub busy { 0 }
+
+1;