From: Eric Wong <e@80x24.org>
Date: Wed, 22 Nov 2023 01:04:18 +0000 (+0000)
Subject: watch: support `watch=false' to negate watchspam
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=19655cb200b8d0ecbd217d4c468bbba8d40ce014;p=thirdparty%2Fpublic-inbox.git

watch: support `watch=false' to negate watchspam

For users hosting read-only mirrors (via clone|fetch) and feeding
inboxes via -watch
---

diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index 7c21f7ce0..6f8129669 100644
--- a/Documentation/public-inbox-watch.pod
+++ b/Documentation/public-inbox-watch.pod
@@ -78,7 +78,7 @@ C<maildir:> paths:
 	[publicinbox "test"]
 		watch = maildir:/path/to/maildirs/.INBOX.test/
 
-public-inbox 1.6.0 supports C<nntp://>, C<nntps://>,
+public-inbox 1.6.0+ supports C<nntp://>, C<nntps://>,
 C<imap://> and C<imaps://> URLs:
 
 		watch = nntp://news.example.com/inbox.test.group
@@ -89,6 +89,9 @@ into a single public-inbox.  URLs requiring authentication
 will require L<netrc(5)> and/or L<git-credential(1)> (preferred) to fill
 in the username and password.
 
+public-inbox 2.0+ supports boolean C<false> to prevent the global
+L</publicinboxwatch.watchspam> directive from writing to the inbox.
+
 Default: none
 
 =item publicinbox.<name>.watchheader
diff --git a/lib/PublicInbox/Watch.pm b/lib/PublicInbox/Watch.pm
index 5253ec942..b83a77ebf 100644
--- a/lib/PublicInbox/Watch.pm
+++ b/lib/PublicInbox/Watch.pm
@@ -85,7 +85,10 @@ sub new {
 		$watches = PublicInbox::Config::_array($watches);
 		for my $watch (@$watches) {
 			my $uri;
-			if (is_maildir($watch)) {
+			my $bool = $cfg->git_bool($watch);
+			if (defined $bool && !$bool) {
+				$ibx->{-watch_disabled} = 1;
+			} elsif (is_maildir($watch)) {
 				compile_watchheaders($ibx);
 				my ($new, $cur) = ("$watch/new", "$watch/cur");
 				my $cur_dst = $mdmap{$cur} //= [];
@@ -143,6 +146,7 @@ sub _done_for_now {
 
 sub remove_eml_i { # each_inbox callback
 	my ($ibx, $self, $eml, $loc) = @_;
+	return if $ibx->{-watch_disabled};
 
 	eval {
 		# try to avoid taking a lock or unnecessary spawning
diff --git a/t/watch_maildir.t b/t/watch_maildir.t
index 69a5e1f3e..07ebeef6c 100644
--- a/t/watch_maildir.t
+++ b/t/watch_maildir.t
@@ -16,7 +16,6 @@ use_ok 'PublicInbox::Emergency';
 my $addr = 'test-public@example.com';
 my $default_branch = PublicInbox::Import::default_branch;
 PublicInbox::Import::init_bare($git_dir);
-
 my $msg = <<EOF;
 From: user\@example.com
 To: $addr
@@ -26,6 +25,9 @@ Date: Sat, 18 Jun 2016 00:00:00 +0000
 
 something
 EOF
+
+my $ibx_ro = create_inbox 'ro', sub { $_[0]->add(PublicInbox::Eml->new($msg)) };
+
 PublicInbox::Emergency->new($maildir)->prepare(\$msg);
 ok(POSIX::mkfifo("$maildir/cur/fifo", 0777),
 	'create FIFO to ensure we do not get stuck on it :P');
@@ -56,6 +58,10 @@ my $cfg = cfg_new $tmpdir, <<EOF;
 	filter = PublicInbox::Filter::Vger
 [publicinboxlearn]
 	watchspam = maildir:$spamdir
+[publicinbox "test-ro"]
+	watch = false
+	inboxdir = $ibx_ro->{inboxdir}
+	address = ro-test\@example.com
 EOF
 my $cfg_path = $cfg->{-f};
 PublicInbox::Watch->new($cfg)->scan('full');
@@ -82,6 +88,10 @@ is(scalar @list, 2, 'two revisions in rev-list');
 is(scalar @list, 0, 'tree is empty');
 is(unlink(glob("$spamdir/cur/*")), 1, 'unlinked trained spam');
 
+@list = $ibx_ro->git->qx(qw(ls-tree -r --name-only), $default_branch);
+undef $ibx_ro;
+is scalar(@list), 1, 'read-only inbox is unchanged';
+
 # check with scrubbing
 {
 	$msg .= qq(--