1 # Copyright (C) 2018-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Extends read-only Inbox for writing
5 package PublicInbox::InboxWritable;
8 use base qw(PublicInbox::Inbox);
9 use PublicInbox::Import;
10 use PublicInbox::Filter::Base qw(REJECT);
15 OLD_PERM_EVERYBODY => 2,
17 PERM_EVERYBODY => 0664,
21 my ($class, $ibx, $creat_opt) = @_;
22 return $ibx if ref($ibx) eq $class;
23 my $self = bless $ibx, $class;
25 # TODO: maybe stop supporting this
26 if ($creat_opt) { # for { nproc => $N }
27 $self->{-creat_opt} = $creat_opt;
28 init_inbox($self) if $self->version == 1;
33 sub assert_usable_dir {
35 my $dir = $self->{inboxdir};
36 return $dir if defined($dir) && $dir ne '';
37 die "no inboxdir defined for $self->{name}\n";
41 my ($self, $shards, $skip_epoch, $skip_artnum) = @_;
42 if ($self->version == 1) {
43 my $dir = assert_usable_dir($self);
44 PublicInbox::Import::init_bare($dir);
45 if (defined($self->{indexlevel}) || defined($skip_artnum)) {
46 require PublicInbox::SearchIdx;
47 require PublicInbox::Msgmap;
48 my $sidx = PublicInbox::SearchIdx->new($self, 1); # just create
49 $sidx->begin_txn_lazy;
50 $self->with_umask(sub {
51 my $mm = PublicInbox::Msgmap->new($dir, 1);
52 $mm->{dbh}->begin_work;
53 $mm->skip_artnum($skip_artnum);
55 }) if defined($skip_artnum);
56 $sidx->commit_txn_lazy;
58 open my $fh, '>>', "$dir/ssoma.lock" or
59 die "$dir/ssoma.lock: $!\n";
62 my $v2w = importer($self);
63 $v2w->init_inbox($shards, $skip_epoch, $skip_artnum);
68 my ($self, $parallel) = @_;
69 my $v = $self->version;
71 eval { require PublicInbox::V2Writable };
72 die "v2 not supported: $@\n" if $@;
73 my $opt = $self->{-creat_opt};
74 my $v2w = PublicInbox::V2Writable->new($self, $opt);
75 $v2w->{parallel} = $parallel if defined $parallel;
78 my @arg = (undef, undef, undef, $self);
79 PublicInbox::Import->new(@arg);
81 $! = 78; # EX_CONFIG 5.3.5 local configuration error
82 die "unsupported inbox version: $v\n";
88 my $f = $self->{filter};
89 if ($f && $f =~ /::/) {
90 # v2 keeps msgmap open, which causes conflicts for filters
91 # such as PublicInbox::Filter::RubyLang which overload msgmap
92 # for a predictable serial number.
93 if ($im && $self->version >= 2 && $self->{altid}) {
97 my @args = (-inbox => $self);
98 # basic line splitting, only
99 # Perhaps we can have proper quote splitting one day...
100 ($f, @args) = split(/\s+/, $f) if $f =~ /\s+/;
106 # e.g: PublicInbox::Filter::Vger->new(@args)
107 return $f->new(@args);
113 sub is_maildir_basename ($) {
115 return 0 if $bn !~ /\A[a-zA-Z0-9][\-\w:,=\.]+\z/;
116 if ($bn =~ /:2,([A-Z]+)\z/i) {
118 return 0 if $flags =~ /[DT]/; # no [D]rafts or [T]rashed mail
123 sub is_maildir_path ($) {
125 my @p = split(m!/+!, $path);
126 (is_maildir_basename($p[-1]) && -f $path) ? 1 : 0;
129 sub mime_from_path ($) {
131 if (open my $fh, '<', $path) {
135 return PublicInbox::Eml->new(\$str);
136 } elsif ($!{ENOENT}) {
137 # common with Maildir
140 warn "failed to open $path: $!\n";
146 my ($self, $dir) = @_;
147 my $im = $self->importer(1);
149 foreach my $sub (qw(cur new tmp)) {
150 -d "$dir/$sub" or die "$dir is not a Maildir (missing $sub)\n";
152 foreach my $sub (qw(cur new)) {
153 opendir my $dh, "$dir/$sub" or die "opendir $dir/$sub: $!\n";
154 while (defined(my $fn = readdir($dh))) {
155 next unless is_maildir_basename($fn);
156 my $mime = mime_from_path("$dir/$fn") or next;
158 if (my $filter = $self->filter($im)) {
159 my $ret = $filter->scrub($mime) or return;
160 return if $ret == REJECT();
169 # asctime: From example@example.com Fri Jun 23 02:56:55 2000
170 my $from_strict = qr/^From \S+ +\S+ \S+ +\S+ [^:]+:[^:]+:[^:]+ [^:]+/;
173 my ($im, $variant, $filter, $msg) = @_;
174 $$msg =~ s/(\r?\n)+\z/$1/s;
175 if ($variant eq 'mboxrd') {
176 $$msg =~ s/^>(>*From )/$1/gms;
177 } elsif ($variant eq 'mboxo') {
178 $$msg =~ s/^>From /From /gms;
180 my $mime = PublicInbox::Eml->new($msg);
182 my $ret = $filter->scrub($mime) or return;
183 return if $ret == REJECT();
190 my ($self, $fh, $variant) = @_;
191 if ($variant !~ /\A(?:mboxrd|mboxo)\z/) {
192 die "variant must be 'mboxrd' or 'mboxo'\n";
194 my $im = $self->importer(1);
197 my $filter = $self->filter;
198 while (defined(my $l = <$fh>)) {
199 if ($l =~ /$from_strict/o) {
200 if (!defined($prev) || $prev =~ /^\r?$/) {
201 mb_add($im, $variant, $filter, \$msg) if $msg;
211 mb_add($im, $variant, $filter, \$msg) if $msg;
215 sub _read_git_config_perm {
217 chomp(my $perm = $self->git->qx('config', 'core.sharedRepository'));
221 sub _git_config_perm {
223 my $perm = scalar @_ ? $_[0] : _read_git_config_perm($self);
224 return PERM_UMASK if (!defined($perm) || $perm eq '');
225 return PERM_UMASK if ($perm eq 'umask');
226 return PERM_GROUP if ($perm eq 'group');
227 if ($perm =~ /\A(?:all|world|everybody)\z/) {
228 return PERM_EVERYBODY;
230 return PERM_GROUP if ($perm =~ /\A(?:true|yes|on|1)\z/);
231 return PERM_UMASK if ($perm =~ /\A(?:false|no|off|0)\z/);
234 return PERM_UMASK if ($i == PERM_UMASK);
235 return PERM_GROUP if ($i == OLD_PERM_GROUP);
236 return PERM_EVERYBODY if ($i == OLD_PERM_EVERYBODY);
238 if (($i & 0600) != 0600) {
239 die "core.sharedRepository mode invalid: ".
240 sprintf('%.3o', $i) . "\nOwner must have permissions\n";
246 my ($perm) = @_; # _git_config_perm return value
248 return umask if $rv == 0;
250 # set +x bit if +r or +w were set
251 $rv |= 0100 if ($rv & 0600);
252 $rv |= 0010 if ($rv & 0060);
253 $rv |= 0001 if ($rv & 0006);
258 my ($self, $cb) = @_;
259 my $old = umask $self->{umask};
260 my $rv = eval { $cb->() };
269 my $perm = _git_config_perm($self);
270 my $umask = _umask_for($perm);
271 $self->{umask} = $umask;
275 delete @{$_[0]}{qw(over mm git search)};