# Copyrights 2001-2023 by [Mark Overmeer].
#  For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.03.
# This code is part of distribution Mail-Box.  Meta-POD processed with
# OODoc into POD and HTML manual-pages.  See README.md
# Copyright Mark Overmeer.  Licensed under the same terms as Perl itself.
package Mail::Box::Mbox;
use vars '$VERSION';
$VERSION = '3.010';
use base 'Mail::Box::File';
use strict;
use warnings;
use filetest 'access';
use Mail::Box::Mbox::Message;
our $default_folder_dir    = exists $ENV{HOME} ? $ENV{HOME} . '/Mail' : '.';
our $default_sub_extension = '.d';
sub init($)
{   my ($self, $args) = @_;
    $self->{MBM_sub_ext}    # required during init
        = $args->{subfolder_extension} || $default_sub_extension;
    $self->SUPER::init($args);
}
sub create($@)
{   my ($thingy, $name, %args) = @_;
    my $class = ref $thingy    || $thingy;
    $args{folderdir}           ||= $default_folder_dir;
    $args{subfolder_extension} ||= $default_sub_extension;
    $class->SUPER::create($name, %args);
}
sub foundIn($@)
{   my $class = shift;
    my $name  = @_ % 2 ? shift : undef;
    my %args  = @_;
    $name   ||= $args{folder} or return;
    my $folderdir = $args{folderdir} || $default_folder_dir;
    my $extension = $args{subfolder_extension} || $default_sub_extension;
    my $filename  = $class->folderToFilename($name, $folderdir, $extension);
    if(-d $filename)
    {   # Maildir and MH Sylpheed have a 'new' sub-directory
        return 0 if -d File::Spec->catdir($filename, 'new');
        local *DIR;
        if(opendir DIR, $filename)
        {    my @f = grep !/^\./, readdir DIR;   # skip . .. and hidden
             return 0 if @f && ! grep /\D/, @f;              # MH
             closedir DIR;
        }
        return 0                                             # Other MH
            if -f "$filename/.mh_sequences";
        return 1;      # faked empty Mbox sub-folder (with subsub-folders?)
    }
    return 0 unless -f $filename;
    return 1 if -z $filename;               # empty folder is ok
    open my $file, '<:raw', $filename or return 0;
    local $_;
    while(<$file>)
    {   next if /^\s*$/;                    # skip empty lines
        $file->close;
        return substr($_, 0, 5) eq 'From '; # found Mbox separator?
    }
    return 1;
}
sub delete(@)
{   my $self = shift;
    $self->SUPER::delete(@_);
    my $subfdir = $self->filename . $default_sub_extension;
    rmdir $subfdir;   # may fail, when there are still subfolders (no recurse)
}
sub writeMessages($)
{   my ($self, $args) = @_;
    $self->SUPER::writeMessages($args) or return;
    if($self->{MB_remove_empty})
    {   # Can the sub-folder directory be removed?  Don't mind if this
        # doesn't work: probably no subdir or still something in it.  This
        # is a rather blunt approach...
        rmdir $self->filename . $self->{MBM_sub_ext};
    }
    $self;
}
sub type() {'mbox'}
sub listSubFolders(@)
{   my ($thingy, %args)  = @_;
    my $class      = ref $thingy || $thingy;
    my $skip_empty = $args{skip_empty} || 0;
    my $check      = $args{check}      || 0;
    my $folder     = exists $args{folder} ? $args{folder} : '=';
    my $folderdir  = exists $args{folderdir}
                   ? $args{folderdir}
                   : $default_folder_dir;
    my $extension  = $args{subfolder_extension};
    my $dir;
    if(ref $thingy)   # Mail::Box::Mbox
    {    $extension ||= $thingy->{MBM_sub_ext};
         $dir = $thingy->filename;
    }
    else
    {    $extension ||= $default_sub_extension;
         $dir = $class->folderToFilename($folder, $folderdir, $extension);
    }
    my $real  = -d $dir ? $dir : "$dir$extension";
    opendir DIR, $real
        or return ();
    # Some files have to be removed because they are created by all
    # kinds of programs, but are no folders.
    my @entries = grep !m/\.lo?ck$|^\./, readdir DIR;
    closedir DIR;
    # Look for files in the folderdir.  They should be readable to
    # avoid warnings for usage later.  Furthermore, if we check on
    # the size too, we avoid a syscall especially to get the size
    # of the file by performing that check immediately.
    my %folders;  # hash to immediately un-double names.
    foreach (@entries)
    {   my $entry = File::Spec->catfile($real, $_);
        if( -f $entry )
        {   next if $args{skip_empty} && ! -s _;
            next if $args{check} && !$class->foundIn($entry);
            $folders{$_}++;
        }
        elsif( -d _ )
        {   # Directories may create fake folders.
            if($args{skip_empty})
            {   opendir DIR, $entry or next;
                my @sub = grep !/^\./, readdir DIR;
                closedir DIR;
                next unless @sub;
            }
            (my $folder = $_) =~ s/$extension$//;
            $folders{$folder}++;
        }
    }
    map +(m/(.*)/ && $1), keys %folders;   # untained names
}
sub openRelatedFolder(@)
{   my $self = shift;
    $self->SUPER::openRelatedFolder(subfolder_extension => $self->{MBM_sub_ext}
      , @_);
}
#-------------------------------------------
sub folderToFilename($$;$)
{   my ($thingy, $name, $folderdir, $extension) = @_;
    $extension ||=
          ref $thingy ? $thingy->{MBM_sub_ext} : $default_sub_extension;
    $name     =~ s#^=#$folderdir/#;
    my @parts = split m!/!, $name;
    my $real  = shift @parts;
    $real     = '/' if $real eq '';
    if(@parts)
    {   my $file  = pop @parts;
        $real = File::Spec->catdir($real.(-d $real ? '' : $extension), $_) 
            foreach @parts;
        $real = File::Spec->catfile($real.(-d $real ? '' : $extension), $file);
    }
    $real;
}
#-------------------------------------------
1;