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 my $sidx = PublicInbox::SearchIdx->new($self, 1); # just create
48 $sidx->begin_txn_lazy;
49 $self->with_umask(sub {
50 my $mm = PublicInbox::Msgmap->new($dir, 1);
51 $mm->{dbh}->begin_work;
52 $mm->skip_artnum($skip_artnum);
54 }) if defined($skip_artnum);
55 $sidx->commit_txn_lazy;
58 my $v2w = importer($self);
59 $v2w->init_inbox($shards, $skip_epoch, $skip_artnum);
64 my ($self, $parallel) = @_;
65 my $v = $self->version;
67 eval { require PublicInbox::V2Writable };
68 die "v2 not supported: $@\n" if $@;
69 my $opt = $self->{-creat_opt};
70 my $v2w = PublicInbox::V2Writable->new($self, $opt);
71 $v2w->{parallel} = $parallel if defined $parallel;
74 my @arg = (undef, undef, undef, $self);
75 PublicInbox::Import->new(@arg);
77 $! = 78; # EX_CONFIG 5.3.5 local configuration error
78 die "unsupported inbox version: $v\n";
84 my $f = $self->{filter};
85 if ($f && $f =~ /::/) {
86 # v2 keeps msgmap open, which causes conflicts for filters
87 # such as PublicInbox::Filter::RubyLang which overload msgmap
88 # for a predictable serial number.
89 if ($im && $self->version >= 2 && $self->{altid}) {
93 my @args = (-inbox => $self);
94 # basic line splitting, only
95 # Perhaps we can have proper quote splitting one day...
96 ($f, @args) = split(/\s+/, $f) if $f =~ /\s+/;
102 # e.g: PublicInbox::Filter::Vger->new(@args)
103 return $f->new(@args);
109 sub is_maildir_basename ($) {
111 return 0 if $bn !~ /\A[a-zA-Z0-9][\-\w:,=\.]+\z/;
112 if ($bn =~ /:2,([A-Z]+)\z/i) {
114 return 0 if $flags =~ /[DT]/; # no [D]rafts or [T]rashed mail
119 sub is_maildir_path ($) {
121 my @p = split(m!/+!, $path);
122 (is_maildir_basename($p[-1]) && -f $path) ? 1 : 0;
125 sub mime_from_path ($) {
127 if (open my $fh, '<', $path) {
131 return PublicInbox::Eml->new(\$str);
132 } elsif ($!{ENOENT}) {
133 # common with Maildir
136 warn "failed to open $path: $!\n";
142 my ($self, $dir) = @_;
143 my $im = $self->importer(1);
145 foreach my $sub (qw(cur new tmp)) {
146 -d "$dir/$sub" or die "$dir is not a Maildir (missing $sub)\n";
148 foreach my $sub (qw(cur new)) {
149 opendir my $dh, "$dir/$sub" or die "opendir $dir/$sub: $!\n";
150 while (defined(my $fn = readdir($dh))) {
151 next unless is_maildir_basename($fn);
152 my $mime = mime_from_path("$dir/$fn") or next;
154 if (my $filter = $self->filter($im)) {
155 my $ret = $filter->scrub($mime) or return;
156 return if $ret == REJECT();
165 # asctime: From example@example.com Fri Jun 23 02:56:55 2000
166 my $from_strict = qr/^From \S+ +\S+ \S+ +\S+ [^:]+:[^:]+:[^:]+ [^:]+/;
169 my ($im, $variant, $filter, $msg) = @_;
170 $$msg =~ s/(\r?\n)+\z/$1/s;
171 if ($variant eq 'mboxrd') {
172 $$msg =~ s/^>(>*From )/$1/gms;
173 } elsif ($variant eq 'mboxo') {
174 $$msg =~ s/^>From /From /gms;
176 my $mime = PublicInbox::Eml->new($msg);
178 my $ret = $filter->scrub($mime) or return;
179 return if $ret == REJECT();
186 my ($self, $fh, $variant) = @_;
187 if ($variant !~ /\A(?:mboxrd|mboxo)\z/) {
188 die "variant must be 'mboxrd' or 'mboxo'\n";
190 my $im = $self->importer(1);
193 my $filter = $self->filter;
194 while (defined(my $l = <$fh>)) {
195 if ($l =~ /$from_strict/o) {
196 if (!defined($prev) || $prev =~ /^\r?$/) {
197 mb_add($im, $variant, $filter, \$msg) if $msg;
207 mb_add($im, $variant, $filter, \$msg) if $msg;
211 sub _read_git_config_perm {
213 chomp(my $perm = $self->git->qx('config', 'core.sharedRepository'));
217 sub _git_config_perm {
219 my $perm = scalar @_ ? $_[0] : _read_git_config_perm($self);
220 return PERM_UMASK if (!defined($perm) || $perm eq '');
221 return PERM_UMASK if ($perm eq 'umask');
222 return PERM_GROUP if ($perm eq 'group');
223 if ($perm =~ /\A(?:all|world|everybody)\z/) {
224 return PERM_EVERYBODY;
226 return PERM_GROUP if ($perm =~ /\A(?:true|yes|on|1)\z/);
227 return PERM_UMASK if ($perm =~ /\A(?:false|no|off|0)\z/);
230 return PERM_UMASK if ($i == PERM_UMASK);
231 return PERM_GROUP if ($i == OLD_PERM_GROUP);
232 return PERM_EVERYBODY if ($i == OLD_PERM_EVERYBODY);
234 if (($i & 0600) != 0600) {
235 die "core.sharedRepository mode invalid: ".
236 sprintf('%.3o', $i) . "\nOwner must have permissions\n";
242 my ($perm) = @_; # _git_config_perm return value
244 return umask if $rv == 0;
246 # set +x bit if +r or +w were set
247 $rv |= 0100 if ($rv & 0600);
248 $rv |= 0010 if ($rv & 0060);
249 $rv |= 0001 if ($rv & 0006);
254 my ($self, $cb) = @_;
255 my $old = umask $self->{umask};
256 my $rv = eval { $cb->() };
265 my $perm = _git_config_perm($self);
266 my $umask = _umask_for($perm);
267 $self->{umask} = $umask;
271 delete @{$_[0]}{qw(over mm git search)};