Archive.pm 31.6 KB
Newer Older
1
2
3
4
# -*- indent-tabs-mode: nil; -*-
# vim:ft=perl:et:sw=4
# $Id$

5
# Sympa - SYsteme de Multi-Postage Automatique
6
7
8
9
#
# Copyright (c) 1997, 1998, 1999 Institut Pasteur & Christophe Wolfhugel
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
10
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
11
12
13
14
15
16
17
18
19
20
21
22
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
23
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
root's avatar
root committed
24

25
package Sympa::Archive;
root's avatar
root committed
26

27
use strict;
28
use warnings;
sikeda's avatar
sikeda committed
29
use Cwd qw();
30
use Digest::MD5 qw();
sikeda's avatar
sikeda committed
31
use Encode qw();
32
33
use English qw(-no_match_vars);
use File::Path qw();
34
use IO::File;
35
use POSIX qw();
36

37
use Sympa;
38
use Conf;
39
40
use Sympa::Constants;
use Sympa::LockedFile;
41
use Sympa::Log;
42
use Sympa::Message;
43
use Sympa::Spool;
44
use Sympa::Tools::File;
45
use Sympa::Tools::Text;
root's avatar
root committed
46

47
48
my $log = Sympa::Log->instance;

49
50
sub new {
    my $class = shift;
51
52
53
54
55
56
57
58

    my $list;
    if (ref $_[0]) {    # Compat., not recommended.
        $list = shift;
    } else {
        my %options = @_;
        $list = $options{context};
    }
59
60
61
62
63

    die 'Bug in logic.  Ask developer' unless ref $list eq 'Sympa::List';

    my $self = bless {
        context           => $list,
64
        base_directory    => $list->get_archive_dir,
65
66
67
68
69
70
71
72
73
74
        arc_directory     => undef,
        directory         => undef,
        deleted_directory => undef,
        _metadatas        => undef,
    } => $class;

    $self->_create_spool();

    return $self;
}
root's avatar
root committed
75

76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
sub _create_spool {
    my $self = shift;

    my $umask = umask oct $Conf::Conf{'umask'};
    foreach my $directory ($Conf::Conf{'arc_path'}, $self->{base_directory}) {
        unless (-d $directory) {
            $log->syslog('info', 'Creating spool %s', $directory);
            unless (
                mkdir($directory, 0755)
                and Sympa::Tools::File::set_file_rights(
                    file  => $directory,
                    user  => Sympa::Constants::USER(),
                    group => Sympa::Constants::GROUP()
                )
                ) {
                die sprintf 'Cannot create %s: %s', $directory, $ERRNO;
            }
        }
    }
    umask $umask;
}
root's avatar
root committed
97

98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
sub add_archive {
    my $self = shift;
    my $arc  = shift;

    return undef unless $arc;
    return undef unless $arc =~ /\A\d{4}-\d{2}\z/;

    my $umask = umask oct $Conf::Conf{'umask'};
    my $error;
    File::Path::make_path(
        $self->{base_directory} . '/' . $arc . '/arctxt',
        {   mode  => 0775,
            owner => Sympa::Constants::USER(),
            group => Sympa::Constants::GROUP(),
            error => \$error
        }
    );
    umask $umask;
root's avatar
root committed
116

117
118
119
120
121
    if (@$error) {
        return undef;
    }
    return 1;
}
122

123
124
125
sub purge_archive {
    my $self = shift;
    my $arc  = shift;
126

127
128
    return undef unless $arc;
    return undef unless $arc =~ /\A\d{4}-\d{2}\z/;
129

130
131
132
    my $error;
    File::Path::remove_tree($self->{base_directory} . '/' . $arc,
        {error => \$error});
133

134
135
    if (@$error) {
        return undef;
salaun's avatar
salaun committed
136
    }
137
138
    return 1;
}
139

140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
sub select_archive {
    my $self    = shift;
    my $arc     = shift;
    my %options = @_;

    return undef unless $arc;
    return undef unless $arc =~ /\A\d{4}-\d{2}\z/;

    my $arc_directory     = $self->{base_directory} . '/' . $arc;
    my $directory         = $arc_directory . '/arctxt';
    my $deleted_directory = $arc_directory . '/deleted';

    my $dh;
    return undef unless opendir $dh, $directory;
    closedir $dh;

    undef $self->{_metadatas};
sikeda's avatar
sikeda committed
157
    undef $self->{_html_metadatas};
158
159
160
161
162
163
    $self->{arc_directory}     = $arc_directory;
    $self->{directory}         = $directory;
    $self->{deleted_directory} = $deleted_directory;

    if ($options{info}) {
        return {
164
165
            size  => Sympa::Tools::File::get_dir_size($directory),
            mtime => Sympa::Tools::File::get_mtime($directory),
166
        };
sikeda's avatar
sikeda committed
167
168
169
170
171
172
173
174
    } elsif ($options{count}) {
        my $count;
        if (open my $fh, '<', $self->{arc_directory} . '/index') {
            $count = <$fh>;
            chomp $count;
            close $fh;
        }
        return {count => ($count || 0)};
175
176
177
    } else {
        return $arc;
    }
root's avatar
root committed
178
179
}

180
181
182
183
184
185
186
187
188
189
190
sub fetch {
    my $self    = shift;
    my %options = @_;

    undef $self->{_metadatas};    # Rewind cache.
    while (1) {
        my ($message, $handle) = $self->next;
        last unless $handle;      # No more messages.
        next unless $message;     # Malformed message.

        if ($options{message_id}) {
191
192
193
            my $message_id = Sympa::Tools::Text::canonic_message_id(
                $message->get_header('Message-Id'))
                || '';
194
195
196
197
198
199
200
201
202
            if ($message_id eq $options{message_id}) {
                undef $self->{_metadatas};    # Rewind cache.
                return ($message, $handle);
            }
        }
    }

    return;
}
sympa-authors's avatar
   
sympa-authors committed
203

sikeda's avatar
sikeda committed
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
sub html_fetch {
    $log->syslog('debug2', '(%s, %s => %s)', @_);
    my $self    = shift;
    my %options = @_;

    return undef unless $self->{arc_directory};
    return undef unless $options{file};

    my $handle =
        IO::File->new($self->{arc_directory} . '/' . $options{file}, '<');
    return undef unless $handle;

    my $metadata = {};    # May be empty.
    while (<$handle>) {
        last if /^\s*$/;    ## Metadata end with an emtpy line

        if (/^<!--(\S+): (.*) -->$/) {
            my ($key, $value) = ($1, $2);
222
            $value = Sympa::Tools::Text::decode_html($value);
sikeda's avatar
sikeda committed
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
            if ($key eq 'X-From-R13') {
                $metadata->{'X-From'} = $value;
                # MHonArc protection of email addresses.
                $metadata->{'X-From'} =~ tr/N-Z[@A-Mn-za-m/@A-Z[a-z/;
                # Remove the gecos.
                $metadata->{'X-From'} =~ s/^.*<(.*)>/$1/g;
            }
            $metadata->{$key} = $value;
        }
    }
    seek $handle, 0, 0;
    $metadata->{html_content} = do { local $RS; <$handle> };
    $metadata->{filename} = $options{file};

    return $metadata;
}

240
sub next {
241
242
    my $self    = shift;
    my %options = @_;
243

244
    return unless $self->{directory};
sympa-authors's avatar
   
sympa-authors committed
245

246
247
248
249
250
251
252
253
254
255
    unless ($self->{_metadatas}) {
        my $dh;
        unless (opendir $dh, $self->{directory}) {
            die sprintf 'Cannot open dir %s: %s', $self->{directory}, $ERRNO;
        }
        $self->{_metadatas} = [
            sort _cmp_numeric grep {
                        !/,lock/
                    and !m{(?:\A|/)(?:\.|T\.|BAD-)}
                    and -f ($self->{directory} . '/' . $_)
256
            } readdir $dh
257
258
        ];
        closedir $dh;
259
260
261
262

        # The "reverse" option specific to this class is set.
        $self->{_metadatas} = [reverse @{$self->{_metadatas}}]
            if $options{reverse};
263
    }
264
265
266
    unless (@{$self->{_metadatas}}) {
        undef $self->{_metadatas};
        return;
267
    }
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287

    while (my $marshalled = shift @{$self->{_metadatas}}) {
        my ($lock_fh, $metadata, $message);

        # Try locking message.  Those locked or removed by other process will
        # be skipped.
        $lock_fh =
            Sympa::LockedFile->new($self->{directory} . '/' . $marshalled,
            -1, '+<');
        next unless $lock_fh;

        $metadata =
            Sympa::Spool::unmarshal_metadata($self->{directory}, $marshalled,
            qr{\A(\d+)\z}, [qw(serial)]);

        if ($metadata) {
            my $msg_string = do { local $RS; <$lock_fh> };
            $message = Sympa::Message->new($msg_string, %$metadata);
        }

sikeda's avatar
sikeda committed
288
289
290
        # Metadata doesn't contain context; add it.
        $message->{context} = $self->{context} if $message;

291
292
        # Though message might not be deserialized, anyway return the result.
        return ($message, $lock_fh);
root's avatar
root committed
293
    }
294
    return;
root's avatar
root committed
295
296
}

sikeda's avatar
sikeda committed
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
sub html_next {
    my $self    = shift;
    my %options = @_;

    return undef unless $self->{arc_directory};

    unless ($self->{_html_metadatas}) {
        my $dh;
        unless (opendir $dh, $self->{arc_directory}) {
            die sprintf 'Cannot open dir %s: %s', $self->{arc_directory},
                $ERRNO;
        }
        $self->{_html_metadatas} = [
            sort _cmp_numeric grep {
                        !/,lock/
                    and !m{(?:\A|/)(?:\.|T\.|BAD-)}
                    and -f ($self->{arc_directory} . '/' . $_)
314
            } readdir $dh
sikeda's avatar
sikeda committed
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
        ];
        closedir $dh;

        # The "reverse" option specific to this class is set.
        $self->{_html_metadatas} = [reverse @{$self->{_html_metadatas}}]
            if $options{reverse};
    }
    unless (@{$self->{_html_metadatas}}) {
        undef $self->{_html_metadatas};
        return undef;
    }

    while (my $marshalled = shift @{$self->{_html_metadatas}}) {
        return $self->html_fetch(file => $marshalled);
    }
    return undef;
}

333
sub _cmp_numeric {
sikeda's avatar
sikeda committed
334
335
336
337
    my $a_num = $1 if defined $a and $a =~ /(\d+)/;
    my $b_num = $1 if defined $b and $b =~ /(\d+)/;
    if (defined $a_num and defined $b_num) {
        return $a_num <=> $b_num || $a cmp $b;
338
339
340
341
342
343
344
345
346
347
348
    } else {
        return $a cmp $b;
    }
}

sub remove {
    $log->syslog('debug2', '(%s, %s)', @_);
    my $self   = shift;
    my $handle = shift;

    return undef unless $self->{arc_directory};
349

350
    my $list = $self->{context};
351

352
353
354
355
356
357
358
359
360
361
362
363
364
365
    # Move text message to deleted/ directory.
    unless (-d $self->{deleted_directory}) {
        my $umask = umask oct $Conf::Conf{'umask'};
        unless (mkdir $self->{deleted_directory}, 0777) {
            die sprintf 'Unable to create %s: %s',
                $self->{deleted_directory}, $ERRNO;
        }
        umask $umask;
    }
    unless (
        $handle->rename($self->{deleted_directory} . '/' . $handle->basename))
    {
        $log->syslog('info', 'Unable to rename message %s in archive %s: %s',
            $handle->basename, $self, Sympa::LockedFile->last_error);
366
        return undef;
sympa-authors's avatar
   
sympa-authors committed
367
    }
368

369
370
    # Remove directory if empty arctxt.
    rmdir $self->{directory};
371

372
373
    return 1;
}
sympa-authors's avatar
   
sympa-authors committed
374

375
# Old name: remove() in archived.pl.
sikeda's avatar
sikeda committed
376
sub html_remove {
377
378
    my $self  = shift;
    my $msgid = shift;
sympa-authors's avatar
   
sympa-authors committed
379

380
381
    return undef unless $self->{arc_directory};
    return undef unless $msgid and $msgid !~ /NO-ID-FOUND\.mhonarc\.org/;
sympa-authors's avatar
   
sympa-authors committed
382

383
    my $list = $self->{context};
sympa-authors's avatar
   
sympa-authors committed
384

385
386
387
388
389
390
    # Remove message from HTML archive.
    system(
        Conf::get_robot_conf($list->{'domain'}, 'mhonarc'),
        '-outdir' => $self->{arc_directory},
        '-rmm'    => $msgid
    );
sympa-authors's avatar
   
sympa-authors committed
391

392
    # Remomve urlized message.
393
394
395
396
    my $url_dir =
          $list->{'dir'}
        . '/urlized/'
        . Sympa::Tools::Text::escape_chars($msgid);
397
398
    my $error;
    File::Path::remove_tree($url_dir, {error => \$error});
sympa-authors's avatar
   
sympa-authors committed
399

400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
    return 1;
}

# Does the real job : stores the message given as an argument into
# the indicated directory.
# Old name: (part of) mail2arc() in archived.pl.
sub store {
    my $self    = shift;
    my $message = shift;

    my $list = $self->{context};
    my $arc = POSIX::strftime('%Y-%m', localtime $message->{date});
    my $newfile;

    unless ($self->select_archive($arc)) {
        $self->add_archive($arc);
        unless ($self->select_archive($arc)) {
            $log->syslog('err', 'Cannot create directory %s in archive %s',
                $arc, $self);
            return undef;
        }
sympa-authors's avatar
   
sympa-authors committed
421
422
    }

423
424
425
426
427
428
429
430
431
432
433
434
435
    # Copy the file in the arctxt.
    if (-f $self->{arc_directory} . "/index") {
        open my $fh, '<', $self->{arc_directory} . '/index'
            or die sprintf 'Can\'t read index of %s in %s: %s', $arc, $self,
            $ERRNO;
        $newfile = <$fh>;
        chomp $newfile;
        $newfile++;
        close $fh;
    } else {
        # recreate index file if needed and update it
        $newfile = _create_idx($self->{arc_directory}) + 1;
    }
sympa-authors's avatar
   
sympa-authors committed
436

437
438
439
440
441
442
    # Save arctxt dump of original message.
    open my $fh, '>', $self->{directory} . '/' . $newfile
        or die sprintf 'Can\'t open file %s/%s: %s', $self->{directory},
        $newfile, $ERRNO;
    print $fh $message->as_string;
    close $fh;
sympa-authors's avatar
   
sympa-authors committed
443

444
    _save_idx($self->{arc_directory} . '/index', $newfile);
sympa-authors's avatar
   
sympa-authors committed
445

446
447
448
449
    $log->syslog('notice', 'Message %s is stored into archive %s as <%s>',
        $message, $self, $newfile);
    return $newfile;
}
450

451
# Old name: (part of) mail2arc in archived.pl.
sikeda's avatar
sikeda committed
452
sub html_store {
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
    my $self    = shift;
    my $message = shift->dup;

    my $list = $self->{context};
    my $arc  = POSIX::strftime('%Y-%m', localtime $message->{date});
    my $yyyy = POSIX::strftime('%Y', localtime $message->{date});
    my $mm   = POSIX::strftime('%m', localtime $message->{date});

    unless ($self->select_archive($arc)) {
        $self->add_archive($arc);
        unless ($self->select_archive($arc)) {
            $log->syslog('err', 'Cannot create directory %s in archive %s',
                $arc, $self);
            return undef;
        }
    }
469

470
471
472
    # Prepare clean message content (HTML parts are cleaned)
    unless ($message->clean_html) {
        $log->syslog('err', "Could not clean message, ignoring message");
473
474
        return undef;
    }
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491

    my $mhonarc_ressources =
        Sympa::search_fullpath($list, 'mhonarc-ressources.tt2');

    $log->syslog(
        'debug',
        'Calling %s for list %s',
        Conf::get_robot_conf($list->{'domain'}, 'mhonarc'), $list
    );

    my $tag = _get_tag($list);

    # Call mhonarc on cleaned message source to make clean htlm view of
    # message.
    my @cmd = (
        Conf::get_robot_conf($list->{'domain'}, 'mhonarc'),
        '-add',
sikeda's avatar
sikeda committed
492
493
494
495
        '-addressmodifycode' => '1',    # w/a: Clear old cache in .mhonarc.db.
        '-rcfile'     => $mhonarc_ressources,
        '-outdir'     => $self->{arc_directory},
        '-definevars' => sprintf(
496
            "listname='%s' hostname=%s yyyy=%s mois=%s yyyymm=%s-%s wdir=%s base=%s/arc tag=%s with_tslice=1 with_powered_by=1",
497
498
499
500
501
502
503
            $list->{'name'},
            $list->{'domain'},
            $yyyy,
            $mm,
            $yyyy,
            $mm,
            Conf::get_robot_conf($list->{'domain'}, 'arc_path'),
IKEDA Soji's avatar
IKEDA Soji committed
504
            (Conf::get_robot_conf($list->{'domain'}, 'wwsympa_url') || ''),
505
506
507
508
509
510
511
512
513
514
            $tag
        ),
        '-umask' => $Conf::Conf{'umask'}
    );

    $log->syslog('debug', 'System call: %s', join(' ', @cmd));

    my $pipeout;
    unless (open $pipeout, '|-', @cmd) {
        $log->syslog('err', 'Could not open pipe: %m');
515
        return undef;
sympa-authors's avatar
   
sympa-authors committed
516
    }
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
    print $pipeout $message->as_string;
    close $pipeout;
    my $status = $? >> 8;

    ## Remove lock if required
    if ($status == 75) {
        $log->syslog(
            'notice',
            'Removing lock directory %s',
            $self->{arc_directory} . '/.mhonarc.lck'
        );
        rmdir $self->{arc_directory} . '/.mhonarc.lck';

        my $pipeout;
        unless (open $pipeout, '|-', @cmd) {
            $log->syslog('err', 'Could not open pipe: %m');
            return undef;
534
        }
535
536
537
        print $pipeout $message->as_string;
        close $pipeout;
        $status = $? >> 8;
sympa-authors's avatar
   
sympa-authors committed
538
    }
539
540
541
542
543
544
545
546
547
    if ($status) {
        $log->syslog(
            'err',
            'Command %s failed with exit code %s',
            join(' ', @cmd), $status
        );
    }

    return 1;
sympa-authors's avatar
   
sympa-authors committed
548
549
}

550
551
# DEPRECATED.  No longer used.
#sub store_last;
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571

# DEPRECATED.  Use get_archives() and select_archive().
#sub list;

# Lists the files included in the archive, preformatted for printing
# Returns an array.
sub get_archives {
    $log->syslog('debug2', '(%s)', @_);
    my $self = shift;

    my $base_directory = $self->{base_directory};

    my $dh;
    unless ($base_directory and opendir $dh, $base_directory) {
        $log->syslog('err', 'Cannot open directory %s: %m', $base_directory);
        return;
    }
    my @arcs =
        grep {
        /\A\d\d\d\d\-\d\d\z/
572
            and -d $base_directory . '/'
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
            . $_
            . '/arctxt'
        }
        sort readdir $dh;
    closedir $dh;

    return @arcs;
}

# DEPRECATED.  Use select_archive() and next().
#sub scan_dir_archive;

# DEPRECATED.  Use select_archive() and fetch().
#sub search_msgid;

588
589
590
591
592
593
594
595
596
# Old name: Sympa::List::get_arc_size().
sub get_size {
    my $self = shift;
    my $dir  = shift;

    return 0 unless -d $self->{base_directory};
    return Sympa::Tools::File::get_dir_size($self->{base_directory});
}

597
# OBSOLETED.  No longer used.
root's avatar
root committed
598
sub exist {
599
    my ($name, $file) = @_;
root's avatar
root committed
600
    my $fn = "$name/$file";
601

root's avatar
root committed
602
603
604
605
    return $fn if (-r $fn && -f $fn);
    return undef;
}

sympa-authors's avatar
sympa-authors committed
606
# return path for latest message distributed in the list
607
608
# DEPRECATED.  No longer used.
#sub last_path;
609
610
611

## Load an archived message, returns the mhonarc metadata
## IN : file_path
sikeda's avatar
sikeda committed
612
613
# DEPRECATED.  Use html_fetch() or html_next().
#sub load_html_message;
614

615
# Old name: rebuild() in archived.pl.
sikeda's avatar
sikeda committed
616
sub html_rebuild {
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
    my $self = shift;
    my $arc  = shift;

    $arc =~ /^(\d{4})-(\d{2})$/;
    my $yyyy = $1;
    my $mm   = $2;

    return unless $self->select_archive($arc);

    my $list          = $self->{context};
    my $listname      = $list->{'name'};
    my $robot_id      = $list->{'domain'};
    my $arc_directory = $self->{arc_directory};

    my $tag = _get_tag($list);
    my $mhonarc_ressources =
        Sympa::search_fullpath($list, 'mhonarc-ressources.tt2');

    # Remove existing HTML files and .mhonarc.db.
    my $dh;
    opendir $dh, $arc_directory;
    unlink map { $arc_directory . '/' . $_ }
        grep {
                $_ ne 'arctxt'
            and $_ ne 'index'
            and $_ ne 'deleted'
            and !/\A\.+\z/
        } readdir $dh;
    closedir $dh;

    my $dir_to_rebuild = $self->{directory};
    my $arcs_dir       = $self->_clean_archive_directory($arc);
    if ($arcs_dir) {
        $dir_to_rebuild = $arcs_dir->{'dir_to_rebuild'};
    }

    # recreate index file if needed
    unless (-f $arc_directory . '/index') {
        _create_idx($arc_directory);
    }

    my @cmd = (
        Conf::get_robot_conf($robot_id, 'mhonarc'),
sikeda's avatar
sikeda committed
660
661
662
663
        '-addressmodifycode' => '1',    # w/a: Clear old cache in .mhonarc.db.
        '-rcfile'     => $mhonarc_ressources,
        '-outdir'     => $arc_directory,
        '-definevars' => sprintf(
664
            "listname='%s' hostname=%s yyyy=%s mois=%s yyyymm=%s-%s wdir=%s base=%s/arc tag=%s with_tslice=1 with_powered_by=1",
665
666
667
668
669
670
671
            $listname,
            $robot_id,
            $yyyy,
            $mm,
            $yyyy,
            $mm,
            Conf::get_robot_conf($robot_id, 'arc_path'),
IKEDA Soji's avatar
IKEDA Soji committed
672
            (Conf::get_robot_conf($robot_id, 'wwsympa_url') || ''),
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
            $tag
        ),
        '-umask' => $Conf::Conf{'umask'},
        $dir_to_rebuild
    );
    my $exitcode = system(@cmd) >> 8;

    # Delete temporary directory containing files with escaped HTML.
    if ($arcs_dir and -d $arcs_dir->{'cleaned_dir'}) {
        my $error;
        File::Path::remove_tree($arcs_dir->{'cleaned_dir'},
            {error => \$error});
    }

    ## Remove lock if required
    if ($exitcode == 75) {
        $log->syslog(
            'notice',
            'Removing lock directory %s',
            $arc_directory . '/.mhonarc.lck'
        );
        rmdir $arc_directory . '/.mhonarc.lck';

        $exitcode = system(@cmd) >> 8;
    }
    if ($exitcode) {
        $log->syslog(
            'err',
            'Command %s failed with exit code %s',
            join(' ', @cmd), $exitcode
        );
    }
}

# Sets the value of $ENV{'M2H_ADDRESSMODIFYCODE'} and
# $ENV{'M2H_MODIFYBODYADDRESSES'}.
#* $tag a character string (containing the result of _get_tag($list))
710
# NO LONGER USED.
sikeda's avatar
sikeda committed
711
#sub _set_hidden_mode;
712
713

# Empties $ENV{'M2H_ADDRESSMODIFYCODE'}.
714
# NO LONGER USED.
sikeda's avatar
sikeda committed
715
#sub _unset_hidden_mode;
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759

# Saves the archives index file
#* $index, a string corresponding to the file name to which save an index.
#* $lst, a character string
# Old name: save_idx() in archived.pl.
sub _save_idx {
    my ($index, $lst) = @_;

    return unless $lst;

    open INDEXF, '>', $index
        or die sprintf 'Couldn\'t overwrite index %s: %s', $index, $!;
    print INDEXF "$lst\n";
    close INDEXF;
}

# Create the 'index' file for one archive subdir
# Old name: create_idx() in archived.pl.
sub _create_idx {
    my $arc_dir = shift;    ## corresponds to the yyyy-mm directory

    my $arc_txt_dir = $arc_dir . '/arctxt';

    unless (opendir(DIR, $arc_txt_dir)) {
        $log->syslog('err', 'Failed to open directory "%s"', $arc_txt_dir);
        return undef;
    }

    my @files = (sort { $a <=> $b; } grep(/^\d+$/, (readdir DIR)));
    my $index = $files[$#files] || 0;
    _save_idx($arc_dir . '/index', $index);

    closedir DIR;

    return $index;
}

# Old name: clean_archive_directory().
sub _clean_archive_directory {
    $log->syslog('debug3', '(%s, %s)', @_);
    my $self = shift;
    my $arc  = shift;

    return undef unless $self->select_archive($arc);
760
761

    my $answer;
762
763
764
    $answer->{'dir_to_rebuild'} = $self->{directory};
    $answer->{'cleaned_dir'}    = sprintf '%s/%s/%s/arctxt',
        $Conf::Conf{'tmpdir'}, $self->{context}->get_id, $arc;
765
    unless (
766
767
768
        my $number_of_copies = Sympa::Tools::File::copy_dir(
            $answer->{'dir_to_rebuild'},
            $answer->{'cleaned_dir'}
769
770
        )
        ) {
771
        $log->syslog(
772
            'err',
773
            'Unable to create a temporary directory where to store files for HTML escaping (%s). Cancelling',
774
775
776
777
778
779
780
781
782
            $number_of_copies
        );
        return undef;
    }
    if (opendir ARCDIR, $answer->{'cleaned_dir'}) {
        my $files_left_uncleaned = 0;
        foreach my $file (readdir(ARCDIR)) {
            next if ($file =~ /^\./);
            $files_left_uncleaned++
783
784
                unless _clean_archived_message(
                $self->{context}->{'domain'},    #FIXME
785
786
787
                $answer->{'cleaned_dir'} . '/' . $file,
                $answer->{'cleaned_dir'} . '/' . $file
                );
788
        }
789
        closedir ARCDIR;
790
        if ($files_left_uncleaned) {
791
            $log->syslog('err',
792
                'HTML cleaning failed for %s files in the directory %s',
793
794
795
796
                $files_left_uncleaned, $answer->{'dir_to_rebuild'});
        }
        $answer->{'dir_to_rebuild'} = $answer->{'cleaned_dir'};
    } else {
797
        $log->syslog(
798
            'err',
799
800
            'Unable to open directory %s: %m',
            $answer->{'dir_to_rebuild'}
801
        );
802
        Sympa::Tools::File::del_dir($answer->{'cleaned_dir'});
803
804
805
806
        return undef;
    }
    return $answer;
}
807

808
809
# Old name: clean_archived_message().
sub _clean_archived_message {
810
    $log->syslog('debug2', '(%s, %s, %s)', @_);
811
812
    my $robot  = shift;
    my $input  = shift;
813
814
    my $output = shift;

815
    my $message = Sympa::Message->new_from_file($input, context => $robot);
816
    unless ($message) {
817
        $log->syslog('err', 'Unable to create a Message object with file %s',
818
819
820
            $input);
        return undef;
    }
821

822
    if ($message->clean_html) {
823
824
        if (open TMP, '>', $output) {
            print TMP $message->as_string;
825
826
827
            close TMP;
            return 1;
        } else {
828
            $log->syslog(
829
                'err',
830
                'Unable to create a tmp file to write clean HTML to file %s',
831
832
                $output
            );
833
834
835
            return undef;
        }
    } else {
836
        $log->syslog('err', 'HTML cleaning in file %s failed', $output);
837
        return undef;
838
839
    }
}
root's avatar
root committed
840

sikeda's avatar
sikeda committed
841
842
843
844
# Old names archive::convert_single_msg_2_html(),
# Sympa::Archive::convert_single_message().
sub html_format {
    my $message = shift;
845
    my %opts    = @_;
846

sikeda's avatar
sikeda committed
847
    my $that = $message->{context};
848
849
850
    my $list;
    my $robot;
    my $listname;
851
    my $domain;
852
    if (ref $that eq 'Sympa::List') {
853
854
855
        $list     = $that;
        $robot    = $that->{'domain'};
        $listname = $that->{'name'};
856
        $domain   = $that->{'domain'};
857
858
859
860
    } elsif (!ref($that) and $that and $that ne '*') {
        $list     = '';
        $robot    = $that;
        $listname = '';
861
        $domain   = Conf::get_robot_conf($that, 'domain');
862
    } else {
863
        die 'bug in logic.  Ask developer';
864
865
    }

sikeda's avatar
sikeda committed
866
    my $msg_as_string = $message->as_string;
root's avatar
root committed
867

868
    my $destination_dir = $opts{'destination_dir'};
869
    my $attachment_url  = $opts{'attachment_url'};
870
871
872
873
    if (ref $attachment_url eq 'ARRAY') {
        $attachment_url = join '/',
            map { Sympa::Tools::Text::encode_uri($_) } @$attachment_url;
    }
874

875
    my $mhonarc_ressources =
876
        Sympa::search_fullpath($that, 'mhonarc-ressources.tt2');
877
    unless ($mhonarc_ressources) {
878
        $log->syslog('notice', 'Cannot find any MhOnArc ressource file');
879
        return undef;
880
881
882
    }

    unless (-d $destination_dir) {
883
        unless (Sympa::Tools::File::mkdir_all($destination_dir, 0755)) {
884
            $log->syslog('err', 'Unable to create %s', $destination_dir);
885
886
            return undef;
        }
887
    }
888
889
890

    my $msg_file = $destination_dir . '/msg00000.txt';
    unless (open OUT, '>', $msg_file) {
sikeda's avatar
sikeda committed
891
        $log->syslog('notice', 'Can\'t open %s', $msg_file);
892
        return undef;
893
    }
894
895
896
    print OUT $msg_as_string;
    close OUT;

897
    # mhonarc require du change workdir so this proc must retore it
sikeda's avatar
sikeda committed
898
    my $pwd = Cwd::getcwd();
899

900
901
    ## generate HTML
    unless (chdir $destination_dir) {
902
        $log->syslog('err', 'Could not change working directory to %s',
903
904
            $destination_dir);
        return undef;
905
906
    }

907
    my $tag      = _get_tag($that);
908
    my $exitcode = system(
sikeda's avatar
sikeda committed
909
910
911
        Conf::get_robot_conf($robot, 'mhonarc'),
        '-single',
        '-rcfile'     => $mhonarc_ressources,
912
        '-definevars' => sprintf(
913
            "listname='%s' hostname=%s yyyy='' mois='' tag=%s with_tslice='' with_powered_by=''",
914
            $listname, $domain, $tag
sikeda's avatar
sikeda committed
915
        ),
916
        '-outdir'        => $destination_dir,
917
        '-attachmentdir' => $destination_dir,
918
919
920
921
        '-attachmenturl' =>
            sprintf('(%s%% path_cgi %%%s)/%s', $tag, $tag, $attachment_url),
        '-umask'  => $Conf::Conf{'umask'},
        '-stdout' => "$destination_dir/msg00000.html",
sikeda's avatar
sikeda committed
922
923
        '--',
        $msg_file
924
    ) >> 8;
925

926
927
    # restore current wd
    chdir $pwd;
928

929
    if ($exitcode) {
930
        $log->syslog(
931
932
933
934
            'err',
            'Command %s failed with exit code %d',
            Conf::get_robot_conf($robot, 'mhonarc'), $exitcode
        );
935
936
    }

937
938
939
    return 1;
}

940
941
942
# Old name: Sympa::Archive::get_tag(), get_tag() in archived.pl.
sub _get_tag {
    my $that = shift;
943

944
945
946
947
948
949
950
951
    my $name;
    if (ref $that eq 'Sympa::List') {
        $name = $that->{'name'};
    } elsif (!ref($that) and $that and $that ne '*') {
        $name = $that;
    } elsif (!ref($that)) {
        $name = '*';
    }
952

953
954
955
956
    my $cookie = $Conf::Conf{'cookie'};
    $cookie = '' unless defined $cookie;
    return substr(Digest::MD5::md5_hex(join '/', $cookie, $name), -10);
}
957

958
959
sub get_id {
    my $self = shift;
960

961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
    my $context = $self->{context};
    unless (ref $context eq 'Sympa::List') {
        return '';
    } elsif ($self->{arc_directory}) {
        return sprintf '%s/%s', $context->get_id,
            [split '/', $self->{arc_directory}]->[-1];
    } else {
        return $context->get_id;
    }
}

1;
__END__

=encoding utf-8

=head1 NAME

Sympa::Archive - Archives of Sympa

=head1 SYNOPSIS

  use Sympa::Archive;
984
  $archive = Sympa::Archive->new(context => $list);
985
986
987
988

  @arcs = $archive->get_archives;

  $archive->store($message);
sikeda's avatar
sikeda committed
989
  $archive->html_store($message);
990
991
992
993
994
995

  $archive->select_archive('2015-04');
  ($message, $handle) = $archive->next;

  $archive->select_archive('2015-04');
  ($message, $handle) = $archive->fetch(message_id => $message_id);
sikeda's avatar
sikeda committed
996
  $archive->html_remove($message_id);
997
998
  $archive->remove($handle);

sikeda's avatar
sikeda committed
999
  $archive->html_rebuild('2015-04');
1000
1001
1002
1003
1004
1005

=head1 DESCRIPTION

L<Sympa::Archive> implements the interface to handle archives.

=head2 Methods and functions
1006

1007
=over
1008

1009
=item new ( context =E<gt> $list )
1010

1011
1012
I<Constructor>.
Creates new instance of L<Sympa::Archive>.
1013

sikeda's avatar
sikeda committed
1014
1015
1016
1017
Parameter:

=over

1018
=item context =E<gt> $list
sikeda's avatar
sikeda committed
1019
1020
1021
1022
1023

Context of object, a L<Sympa::List> instance.

=back

1024
=item add_archive ( $arc )
1025

1026
1027
1028
I<Instance method>.
Adds archive directory named $arc.
Currently, archive directory must have the form C<YYYY-MM>.
1029

1030
=item purge_archive ( $arc )
1031

1032
1033
1034
I<Instance method>.
Removes archive directory and its content entirely.
removed content can not be recovered.
1035

1036
=item select_archive ( $arc, [ info =E<gt> 1 ] )
1037

1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
I<Instance method>.
Selects an archive directory.
It will be referred by consequent operations.

=item fetch ( message_id =E<gt> $message_id )

I<Instance method>.
Gets a message from archive.
select_archive() must be called in advance.

1048
Message will be locked to prevent multiple processing of a single message.
1049
1050
1051
1052
1053
1054
1055

Parameter:

=over

=item message_id =E<gt> $message_id

1056
Message ID of the message to be fetched.
1057
1058
1059

=back

1060
Returns:
1061

1062
1063
Two-elements list of L<Sympa::Message> instance and filehandle locking
a message.
1064

sikeda's avatar
sikeda committed
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
=item html_fetch ( file =E<gt> $filename )

I<Instance method>.
Gets a metadata of formatted message from HTML archive.
select_archive() must be called in advance.

Parameter:

=over

=item file =E<gt> $filename

1077
File name of the message to be fetched.
sikeda's avatar
sikeda committed
1078
1079
1080
1081
1082
1083
1084
1085

=back

Returns:

Hashref.
Note that message won't be locked.

1086
1087
1088
1089
1090
1091
=item get_size ( )

I<Instance method>.
Gets total size of messages in archives.
This method was introduced on Sympa 6.2.17.

1092
=item next ( [ reverse =E<gt> 1 ] )
1093

1094
1095
1096
I<Instance method>.
Gets next message in archive.
select_archive() must be called in advance.
1097

1098
Message will be locked to prevent multiple processing of a single message.
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108

Parameters:

None.

Returns:

Two-elements list of L<Sympa::Message> instance and filehandle locking
a message.

sikeda's avatar
sikeda committed
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
=item html_next ( [ reverse =E<gt> 1 ] )

I<Instance method>.
Gets next metadata of formatted message in archive.
select_archive() must be called in advance.

Parameters:

None.

Returns:

Hashref.
Note that message will not be locked.

1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
=item remove ( $handle )

I<Instance method>.
Removes a message from archive.

Parameter:

=over

=item $handle

Filehandle, L<Sympa::LockedFile> instance, locking message.
It is returned by L</fetch>() or L</next>().

=back

Returns:

True value if message could be removed.
Otherwise false value.

sikeda's avatar
sikeda committed
1145
=item html_remove ( $message_id )
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178

I<Instance method>.
TBD.

=item store ( $message )

I<Instance method>.
Stores the message into archive.

Parameters:

=over

=item $message

A L<Sympa::Message> instance to be stored.
Following attributes and metadata are referred:

=over

=item {date}

Unix time when the message would be delivered.

=back

=back

Returns:

If storing succeeded, marshalled metadata (file name) of the message.
Otherwise C<undef>.

sikeda's avatar
sikeda committed
1179
=item html_store ( $message )
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189

I<Instance method>.
TBD.

=item get_archives ( )

I<Instance method>.
Gets a list of archive directories this archive contains.
Items of returned value may be fed to select_archive() and so on.

sikeda's avatar
sikeda committed
1190
=item html_rebuild ( $arc )
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210

I<Instance method>.
Rebuilds archives for the list the name of which is given in the argument
$arc.

Parameters:

=over

=item $arc

A character string containing the name of archive directory in the list
which we want to rebuild.

=back

Returns:

I<undef> if something goes wrong.

sikeda's avatar
sikeda committed
1211
1212
=item html_format ( $message,
destination_dir =E<gt> $destination_dir,
1213
attachment_url =E<gt> $attachment_url )
1214

sikeda's avatar
sikeda committed
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
I<Function>.
Converts a message to HTML.

Parameters:

=over

=item $message

Message to be formatted.
L<Sympa::Message> instance.

=item $destination_dir

The directory result is stored in.

=item $attachment_url

1233
1234
1235
1236
Base URL used to link attachments.

Note:
On 6.2.13 and earlier, this option was named "C<attachB<e>ment_url>".
sikeda's avatar
sikeda committed
1237

1238
1239
1240
1241
1242
Note:
On 6.2.17 and later, this option may take an arrayref value.
In such case items will be percent-encoded and conjuncted.
Otherwise if a string is given, it will not be encoded.

sikeda's avatar
sikeda committed
1243
=back
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257

=item get_id ( )

I<Instance method>.
Gets unique identifier of instance.

=back

=head1 SEE ALSO

L<archived(8)>, L<mhonarc(1)>, L<wwsympa(8)>, L<Sympa::Message>.

=head1 HISTORY

sikeda's avatar
sikeda committed
1258
L<Archive> was renamed to L<Sympa::Archive> on Sympa 6.2.
1259
1260

=cut