File Coverage

blib/lib/Filename/Type/Archive.pm

Criterion	Covered	Total	%
statement	34	35	97.1
branch	8	10	80.0
condition	1	2	50.0
subroutine	5	5	100.0
pod	1	1	100.0
total	49	53	92.4

package Filename::Type::Archive;

use 5.010001;
use strict;
use warnings;

use Exporter 'import';

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-12-20'; # DATE
our $DIST = 'Filename-Type-Archive'; # DIST
our $VERSION = '0.033'; # VERSION

our @EXPORT_OK = qw(check_archive_filename);
#list_archive_suffixes

# XXX multi-part archive?

our %SUFFIXES = (
    '.7z'  => {name=>'7-zip'},
    '.cb7'  => {name=>'7-zip'},

    '.zip' => {name=>'Zip'},
    '.cbz' => {name=>'Zip'},

    '.rar' => {name=>'RAR'},
    '.cbr' => {name=>'RAR'},

    '.tar' => {name=>'tar'},
    '.cbt' => {name=>'tar'},

    '.tgz' => {name=>'tar+gzip'},
    '.tbz' => {name=>'tar+bzip2'},

    '.ace' => {name=>'ACE'},
    '.cba' => {name=>'ACE'},

    '.arj' => {name=>'arj'},
    # XXX other older/less popular: lha, zoo
    # XXX windows: cab
    # XXX zip-based archives: war, etc
    # XXX tar-based archives: linux packages
);

our %ARCHIVES = (
    'arj' => {
    },
    '7-zip' => {
    },
    Zip => {
        # all programs mentioned here must accept filename(s) as arguments.
        # preferably CLI. XXX specify capabilities (password-protection, unix
        # permission, etc). XXX specify how to create (with password, etc). XXX
        # specify how to extract.
        archiver_programs => [
            {name => 'zip', opts => ''},
        ],
        extractor_programs => [
            {name => 'zip', opts => ''},
            {name => 'unzip', opts => ''},
        ],
    },
    RAR => {
    },
    tar => {
    },
    'tar+gzip' => {
    },
    'tar+bzip2' => {
    },
    ace => {
        extractor_programs => [
            {name => 'unace', opts => ''},
        ],
    },
);

our %SPEC;

$SPEC{check_archive_filename} = {
    v => 1.1,
    summary => 'Check whether filename indicates being an archive file',
    description => <<'_',


_
    args => {
        filename => {
            schema => 'str*',
            req => 1,
            pos => 0,
        },
        # XXX recurse?
        ignore_case => {
            summary => 'Whether to match case-insensitively',
            schema  => 'bool',
            default => 1,
        },
    },
    result_naked => 1,
    result => {
        schema => ['any*', of=>['bool*', 'hash*']],
        description => <<'MARKDOWN',

Return false if no archive suffixes detected. Otherwise return a hash of
information, which contains these keys: `archive_name`, `archive_suffix`,
`compressor_info`, `filename_without_suffix`.

MARKDOWN
    },
    examples => [
        {
            args => {filename=>'foo.tar.bz2'},
        },
        {
            args => {filename=>'bar.Zip', ignore_case=>1},
        },
    ],
};
sub check_archive_filename {
    require Filename::Type::Compressed;

    my %args = @_;

    my $filename = $args{filename};
    my $ci = $args{ignore_case} // 1;

    my @compressor_info;
    while (1) {
        my $res = Filename::Type::Compressed::check_compressed_filename(
            filename => $filename, ci => $ci);
        if ($res) {
            push @compressor_info, $res;
            $filename = $res->{uncompressed_filename};
            next;
        } else {
            last;
        }
    }

    $filename =~ /(.+)(\.\w+)\z/ or return 0;
    my ($filename_without_suffix, $suffix) = ($1, $2);

    my $spec;
    if ($ci) {
        my $suffix_lc = lc($suffix);
        for (keys %SUFFIXES) {
            if (lc($_) eq $suffix_lc) {
                $spec = $SUFFIXES{$_};
                last;
            }
        }
    } else {
        $spec = $SUFFIXES{$suffix};
    }
    return 0 unless $spec;

    return {
        archive_name       => $spec->{name},
        archive_suffix     => $suffix,
        filename_without_suffix => $filename_without_suffix,
        (compressor_info    => \@compressor_info) x !!@compressor_info,
    };
}

1;
# ABSTRACT: Check whether filename indicates being an archive file

__END__