# Copyright © 2008-2009 Raphaël Hertzog <hertzog@debian.org>
# Copyright © 2008, 2012-2015 Guillem Jover <guillem@debian.org>
#
# 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
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

=encoding utf8

=head1 NAME

Dpkg::Source::Package::V1 - class for source format 1.0

=head1 DESCRIPTION

This module provides a class to handle the source package format 1.0.

B<Note>: This is a private module, its API can change at any time.

=cut

package Dpkg::Source::Package::V1 0.01;

use v5.36;

use Errno qw(ENOENT);
use Cwd;
use File::Basename;
use File::Temp;
use File::Spec;

use Dpkg ();
use Dpkg::Gettext;
use Dpkg::ErrorHandling;
use Dpkg::Version;
use Dpkg::Compression;
use Dpkg::Source::Archive;
use Dpkg::Source::Patch;
use Dpkg::Exit qw(push_exit_handler pop_exit_handler);
use Dpkg::Source::Functions qw(erasedir);
use Dpkg::Source::Package::V3::Native;
use Dpkg::Vendor qw(run_vendor_hook);

use parent qw(Dpkg::Source::Package);

our $CURRENT_MINOR_VERSION = '0';

sub init_options {
    my $self = shift;

    # Do not call $self->SUPER::init_options() on purpose, V1.0 has no
    # ignore by default.
    if ($self->{options}{diff_ignore_regex}) {
        $self->{options}{diff_ignore_regex} .= '|(?:^|/)debian/source/local-.*$';
    } else {
        $self->{options}{diff_ignore_regex} = '(?:^|/)debian/source/local-.*$';
    }
    $self->{options}{diff_ignore_regex} .= '|(?:^|/)debian/files(?:\.new)?$';
    push @{$self->{options}{tar_ignore}},
        'debian/source/local-options',
        'debian/source/local-patch-header',
        'debian/files',
        'debian/files.new';
    $self->{options}{sourcestyle} //= 'X';
    $self->{options}{skip_debianization} //= 0;
    $self->{options}{ignore_bad_version} //= 0;
    $self->{options}{abort_on_upstream_changes} //= 0;

    # Set default validation checks.
    $self->{options}{certs} //= [];
    $self->{options}{use_vendor_certs} //= 1;
    $self->{options}{require_valid_signature} //= 0;
    $self->{options}{require_strong_checksums} //= 0;

    # V1.0 only supports gzip compression.
    $self->{options}{compression} //= 'gzip';
    $self->{options}{comp_level} //= compression_get_level('gzip');
    $self->{options}{comp_ext} //= compression_get_file_extension('gzip');
}

my @module_cmdline = (
    {
        name => '-sa',
        help => N_('auto select original source'),
        when => 'build',
    }, {
        name => '-sk',
        help => N_('use packed original source (unpack and keep)'),
        when => 'build',
    }, {
        name => '-sp',
        help => N_('use packed original source (unpack and remove)'),
        when => 'build',
    }, {
        name => '-su',
        help => N_('use unpacked original source (pack and keep)'),
        when => 'build',
    }, {
        name => '-sr',
        help => N_('use unpacked original source (pack and remove)'),
        when => 'build',
    }, {
        name => '-ss',
        help => N_('trust packed and unpacked original sources are same'),
        when => 'build',
    }, {
        name => '-sn',
        help => N_('there is no diff, do main tarfile only'),
        when => 'build',
    }, {
        name => '-sA, -sK, -sP, -sU, -sR',
        help => N_('like -sa, -sk, -sp, -su, -sr but may overwrite'),
        when => 'build',
    }, {
        name => '--abort-on-upstream-changes',
        help => N_('abort if generated diff has upstream files changes'),
        when => 'build',
    }, {
        name => '-sp',
        help => N_('leave original source packed in current directory'),
        when => 'extract',
    }, {
        name => '-su',
        help => N_('do not copy original source to current directory'),
        when => 'extract',
    }, {
        name => '-sn',
        help => N_('unpack original source tree too'),
        when => 'extract',
    }, {
        name => '--skip-debianization',
        help => N_('do not apply debian diff to upstream sources'),
        when => 'extract',
    },
);

sub describe_cmdline_options {
    return @module_cmdline;
}

sub parse_cmdline_option {
    my ($self, $opt) = @_;
    my $o = $self->{options};
    if ($opt =~ m/^-s([akpursnAKPUR])$/) {
        warning(g_('-s%s option overrides earlier -s%s option'), $1,
                $o->{sourcestyle}) if $o->{sourcestyle} ne 'X';
        $o->{sourcestyle} = $1;
        # Extract option -sn.
        $o->{copy_orig_tarballs} = 0 if $1 eq 'n';
        return 1;
    } elsif ($opt eq '--skip-debianization') {
        $o->{skip_debianization} = 1;
        return 1;
    } elsif ($opt eq '--ignore-bad-version') {
        $o->{ignore_bad_version} = 1;
        return 1;
    } elsif ($opt eq '--abort-on-upstream-changes') {
        $o->{abort_on_upstream_changes} = 1;
        return 1;
    }
    return 0;
}

sub do_extract {
    my ($self, $newdirectory) = @_;
    my $sourcestyle = $self->{options}{sourcestyle};
    my $fields = $self->{fields};

    $sourcestyle =~ y/X/p/;
    unless ($sourcestyle =~ m/[pun]/) {
        usageerr(g_('source handling style -s%s not allowed with -x'),
                 $sourcestyle);
    }

    my $basename = $self->get_basename();
    my $basenamerev = $self->get_basename(1);

    # V1.0 only supports gzip compression.
    my ($tarfile, $difffile);
    my $tarsign;
    foreach my $file ($self->get_files()) {
        if ($file =~ /^(?:\Q$basename\E\.orig|\Q$basenamerev\E)\.tar\.gz$/) {
            error(g_('multiple tarfiles in v1.0 source package')) if $tarfile;
            $tarfile = $file;
        } elsif ($file =~ /^\Q$basename\E\.orig\.tar\.gz\.asc$/) {
            $tarsign = $file;
        } elsif ($file =~ /^\Q$basenamerev\E\.diff\.gz$/) {
            $difffile = $file;
        } else {
            error(g_('unrecognized file for a %s source package: %s'),
                  'v1.0', $file);
        }
    }

    error(g_('no tarfile in Files field')) unless $tarfile;
    my $native = $difffile ? 0 : 1;
    my $v = Dpkg::Version->new($fields->{'Version'});
    if ($native) {
        if ($tarfile =~ m/\.orig\.tar\.gz$/) {
            # We only need to warn on this branch, because of the $native reset
            # below, otherwise the V3::Native module will handle the warning.
            if ($v->has_revision()) {
                warning(g_('native package version may not have a revision'));
            }

            warning(g_('native package with .orig.tar'));
            # V3::Native does not handle "orig.tar".
            $native = 0;
        }
    } else {
        if (! $v->has_revision()) {
            warning(g_('non-native package version does not contain a revision'))
        }
    }

    if ($native) {
        Dpkg::Source::Package::V3::Native::do_extract($self, $newdirectory);
    } else {
        my $expectprefix = $newdirectory;
        $expectprefix .= '.orig';

        if ($self->{options}{no_overwrite_dir} and -e $newdirectory) {
            error(g_('unpack target exists: %s'), $newdirectory);
        } else {
            erasedir($newdirectory);
        }
        if (-e $expectprefix) {
            rename($expectprefix, "$newdirectory.tmp-keep")
                or syserr(g_("unable to rename '%s' to '%s'"), $expectprefix,
                          "$newdirectory.tmp-keep");
        }

        info(g_('unpacking %s'), $tarfile);
        my $tar = Dpkg::Source::Archive->new(
            filename => File::Spec->catfile($self->{basedir}, $tarfile),
        );
        $tar->extract($expectprefix);

        if ($sourcestyle =~ /u/) {
            # -su: keep .orig directory unpacked.
            if (-e "$newdirectory.tmp-keep") {
                error(g_('unable to keep orig directory (already exists)'));
            }
            system('cp', '-RPp', '--', $expectprefix, "$newdirectory.tmp-keep");
            subprocerr("cp $expectprefix to $newdirectory.tmp-keep") if $?;
        }

        rename($expectprefix, $newdirectory)
            or syserr(g_('failed to rename newly-extracted %s to %s'),
                      $expectprefix, $newdirectory);

        # Rename the copied .orig directory.
        if (-e "$newdirectory.tmp-keep") {
            rename("$newdirectory.tmp-keep", $expectprefix)
                or syserr(g_('failed to rename saved %s to %s'),
                          "$newdirectory.tmp-keep", $expectprefix);
        }
    }

    if ($difffile and not $self->{options}{skip_debianization}) {
        my $patch = File::Spec->catfile($self->{basedir}, $difffile);
        info(g_('applying %s'), $difffile);
        my $patch_obj = Dpkg::Source::Patch->new(filename => $patch);
        my $analysis = $patch_obj->apply($newdirectory,
            force_timestamp => 1,
        );
        my @files = grep { ! m{^\Q$newdirectory\E/debian/} }
                    sort keys %{$analysis->{filepatched}};
        info(g_('upstream files that have been modified: %s'),
             "\n " . join("\n ", @files)) if scalar @files;

        # As the diff might not represent executable permissions, we need to
        # make sure debian/rules is executable if it exists. Otherwise the
        # debian-rules build driver will take care of the warnings.
        my $rules = File::Spec->catfile($newdirectory, 'debian', 'rules');
        my @s = lstat $rules;
        if (not scalar @s) {
            syserr(g_('cannot stat %s'), $rules) if $! != ENOENT;
        } elsif (-f _) {
            chmod $s[2] | 0o111, $rules
                or syserr(g_('cannot make %s executable'), $rules);
        } else {
            warning(g_('%s is not a plain file'), $rules);
        }
    }
}

sub can_build {
    my ($self, $dir) = @_;

    # As long as we can use gzip, we can do it as we have native packages as
    # fallback.
    return (0, g_('only supports gzip compression'))
        unless $self->{options}{compression} eq 'gzip';
    return 1;
}

sub do_build {
    my ($self, $dir) = @_;
    my $sourcestyle = $self->{options}{sourcestyle};
    my @argv = @{$self->{options}{ARGV}};
    my @tar_ignore = map { "--exclude=$_" } @{$self->{options}{tar_ignore}};
    my $diff_ignore_regex = $self->{options}{diff_ignore_regex};

    if (scalar(@argv) > 1) {
        usageerr(g_('-b takes at most a directory and an orig source ' .
                    'argument (with v1.0 source package)'));
    }

    $sourcestyle =~ y/X/a/;
    unless ($sourcestyle =~ m/[akpursnAKPUR]/) {
        usageerr(g_('source handling style -s%s not allowed with -b'),
                 $sourcestyle);
    }

    my $sourcepackage = $self->{fields}{'Source'};
    my $basenamerev = $self->get_basename(1);
    my $basename = $self->get_basename();
    my $basedirname = $self->get_basedirname();

    # Try to find a .orig tarball for the package.
    my $origdir = "$dir.orig";
    my $origtargz = $self->get_basename() . '.orig.tar.gz';
    if (-e $origtargz) {
        unless (-f $origtargz) {
            error(g_("packed orig '%s' exists but is not a plain file"), $origtargz);
        }
    } else {
        $origtargz = undef;
    }

    if (@argv) {
        # We have a second-argument <orig-dir> or <orig-targz>, check what it
        # is to decide the mode to use.
        my $origarg = shift(@argv);
        if (length($origarg)) {
            stat($origarg)
                or syserr(g_('cannot stat orig argument %s'), $origarg);
            if (-d _) {
                $origdir = File::Spec->catdir($origarg);

                $sourcestyle =~ y/aA/rR/;
                unless ($sourcestyle =~ m/[ursURS]/) {
                    error(g_('orig argument is unpacked but source handling ' .
                             'style -s%s calls for packed (.orig.tar.<ext>)'),
                          $sourcestyle);
                }
            } elsif (-f _) {
                $origtargz = $origarg;
                $sourcestyle =~ y/aA/pP/;
                unless ($sourcestyle =~ m/[kpsKPS]/) {
                    error(g_('orig argument is packed but source handling ' .
                             'style -s%s calls for unpacked (.orig/)'),
                          $sourcestyle);
                }
            } else {
                error(g_('orig argument %s is not a plain file or directory'),
                      $origarg);
            }
        } else {
            $sourcestyle =~ y/aA/nn/;
            unless ($sourcestyle =~ m/n/) {
                error(g_('orig argument is empty (means no orig, no diff) ' .
                         'but source handling style -s%s wants something'),
                      $sourcestyle);
            }
        }
    } elsif ($sourcestyle =~ m/[aA]/) {
        # We have no explicit <orig-dir> or <orig-targz>, try to use a ".orig"
        # tarball first, then a ".orig" directory and fall back to creating a
        # native ".tar.gz".
        if ($origtargz) {
            # ".orig.tar.<ext>".
            $sourcestyle =~ y/aA/pP/;
        } elsif (stat($origdir)) {
            unless (-d _) {
                error(g_("unpacked orig '%s' exists but is not a directory"),
                      $origdir);
            }
            # ".orig" directory.
            $sourcestyle =~ y/aA/rR/;
        } elsif ($! != ENOENT) {
            syserr(g_("unable to stat putative unpacked orig '%s'"), $origdir);
        } else {
            # Native "tar.gz".
            $sourcestyle =~ y/aA/nn/;
        }
    }

    my $v = Dpkg::Version->new($self->{fields}->{'Version'});
    if ($sourcestyle =~ m/[kpursKPUR]/) {
        error(g_('non-native package version does not contain a revision'))
            if ! $v->has_revision();
    } else {
        if ($v->has_revision()) {
            if (run_vendor_hook('has-fuzzy-native-source')) {
                warning(g_('native package version may not have a revision'));
            } else {
                error(g_('native package version may not have a revision'));
            }
        }
    }

    my ($dirname, $dirbase) = fileparse($dir);
    if ($dirname ne $basedirname) {
        warning(g_("source directory '%s' is not <sourcepackage>" .
                   "-<upstreamversion> '%s'"), $dir, $basedirname);
    }

    my ($tarname, $tardirname, $tardirbase);
    my $tarsign;
    if ($sourcestyle ne 'n') {
        my ($origdirname, $origdirbase) = fileparse($origdir);

        if ($origdirname ne "$basedirname.orig") {
            warning(g_('.orig directory name %s is not <package>' .
                       '-<upstreamversion> (wanted %s)'),
                    $origdirname, "$basedirname.orig");
        }
        $tardirbase = $origdirbase;
        $tardirname = $origdirname;

        $tarname = $origtargz || "$basename.orig.tar.gz";
        $tarsign = "$tarname.asc";
        unless ($tarname =~ /\Q$basename\E\.orig\.tar\.gz/) {
            warning(g_('.orig.tar name %s is not <package>_<upstreamversion>' .
                       '.orig.tar (wanted %s)'),
                    $tarname, "$basename.orig.tar.gz");
        }
    }

    if ($sourcestyle eq 'n') {
        # Initialize ARGV to ensure we have no error.
        $self->{options}{ARGV} = [];
        Dpkg::Source::Package::V3::Native::do_build($self, $dir);
    } elsif ($sourcestyle =~ m/[urUR]/) {
        if (stat($tarname)) {
            unless ($sourcestyle =~ m/[UR]/) {
                error(g_("tarfile '%s' already exists, not overwriting, " .
                         'giving up; use -sU or -sR to override'), $tarname);
            }
        } elsif ($! != ENOENT) {
            syserr(g_("unable to check for existence of '%s'"), $tarname);
        }

        info(g_('building %s in %s'),
             $sourcepackage, $tarname);

        my $newtar = File::Temp->new(
            TEMPLATE => "$tarname.new.XXXXXX",
            DIR => getcwd(),
            UNLINK => 0,
        );
        my $tar = Dpkg::Source::Archive->new(
            filename => $newtar,
            compression => compression_guess_from_filename($tarname),
            compression_level => $self->{options}{comp_level},
        );
        $tar->create(
            options => \@tar_ignore,
            chdir => $tardirbase,
        );
        $tar->add_directory($tardirname);
        $tar->finish();
        rename($newtar, $tarname)
            or syserr(g_("unable to rename '%s' (newly created) to '%s'"),
                      $newtar, $tarname);
        chmod(0o666 &~ umask(), $tarname)
            or syserr(g_("unable to change permission of '%s'"), $tarname);
    } else {
        info(g_('building %s using existing %s'),
             $sourcepackage, $tarname);
    }

    if ($tarname) {
        $self->add_file($tarname);
        if (-e "$tarname.sig" and not -e "$tarname.asc") {
            $self->armor_original_tarball_signature("$tarname.sig", "$tarname.asc");
        }
    }
    if ($tarsign and -e $tarsign) {
        $self->check_original_tarball_signature($dir, $tarsign);

        info(g_('building %s using existing %s'), $sourcepackage, $tarsign);
        $self->add_file($tarsign);
    } else {
        my $key = $self->get_upstream_signing_key($dir);
        if (-e $key) {
            warning(g_('upstream signing key but no upstream tarball signature'));
        }
    }

    if ($sourcestyle =~ m/[kpKP]/) {
        if (stat($origdir)) {
            unless ($sourcestyle =~ m/[KP]/) {
                error(g_("orig directory '%s' already exists, not overwriting, ".
                         'giving up; use -sA, -sK or -sP to override'),
                      $origdir);
            }
            erasedir($origdir);
        } elsif ($! != ENOENT) {
            syserr(g_("unable to check for existence of orig directory '%s'"),
                    $origdir);
        }

        my $tar = Dpkg::Source::Archive->new(filename => $origtargz);
        $tar->extract($origdir);
    }

    # Unrepresentable changes.
    my $ur;
    if ($sourcestyle =~ m/[kpursKPUR]/) {
        my $diffname = "$basenamerev.diff.gz";
        info(g_('building %s in %s'),
             $sourcepackage, $diffname);
        my $newdiffgz = File::Temp->new(
            TEMPLATE => "$diffname.new.XXXXXX",
            DIR => getcwd(),
            UNLINK => 0,
        );
        push_exit_handler(sub { unlink($newdiffgz) });
        my $diff = Dpkg::Source::Patch->new(
            filename => $newdiffgz,
            compression => 'gzip',
            compression_level => $self->{options}{comp_level},
        );
        $diff->create();
        $diff->add_diff_directory($origdir, $dir,
            basedirname => $basedirname,
            diff_ignore_regex => $diff_ignore_regex,
            # Force empty set of options to drop the default -p option.
            options => [],
        );

        $diff->finish() || $ur++;
        pop_exit_handler();

        my $analysis = $diff->analyze($origdir);
        my @files = grep { ! m{^debian/} }
                    map { s{^[^/]+/+}{}r }
                    sort keys %{$analysis->{filepatched}};
        if (scalar @files) {
            warning(g_('the diff modifies the following upstream files: %s'),
                    "\n " . join("\n ", @files));
            info(g_("use the '3.0 (quilt)' format to have separate and " .
                    'documented changes to upstream files, see dpkg-source(1)'));
            error(g_('aborting due to --abort-on-upstream-changes'))
                if $self->{options}{abort_on_upstream_changes};
        }

        rename($newdiffgz, $diffname)
            or syserr(g_("unable to rename '%s' (newly created) to '%s'"),
                      $newdiffgz, $diffname);
        chmod(0o666 &~ umask(), $diffname)
            or syserr(g_("unable to change permission of '%s'"), $diffname);

        $self->add_file($diffname);
    }

    if ($sourcestyle =~ m/[prPR]/) {
        erasedir($origdir);
    }

    if ($ur) {
        errormsg(g_('unrepresentable changes to source'));
        exit(1);
    }
}

=head1 CHANGES

=head2 Version 0.xx

This is a private module.

=cut

1;
