source: ProjectBuilder/devel/pb/lib/ProjectBuilder/Changelog.pm

#!/usr/bin/perl -w
#
# ProjectBuilder Changelog module
# Changelog management subroutines brought by the the Project-Builder project
#
# $Id$
#
# Copyright B. Cornec 2007-today
# Provided under the GPL v2

package ProjectBuilder::Changelog;

use strict 'vars';
use Data::Dumper;
use English;
use Date::Manip;
use POSIX qw(strftime);
use lib qw (lib);
use Text::Wrap;
use ProjectBuilder::Version;
use ProjectBuilder::Base;
use ProjectBuilder::Conf;

# Inherit from the "Exporter" module which handles exporting functions.
 
use vars qw($VERSION $REVISION @ISA @EXPORT);
use Exporter;
 
# Export, by default, all the functions into the namespace of
# any code which uses this module.
 
our @ISA = qw(Exporter);
our @EXPORT = qw(pb_changelog);
our ($VERSION,$REVISION,$PBCONFVER) = pb_version_init();

=pod

=head1 NAME

ProjectBuilder::Changelog, part of the project-builder.org - module dealing with changelog management

=head1 DESCRIPTION

This modules provides generic functions suitable for changelog management for project-builder.org

=head1 USAGE

=over 4

=item B<pb_changelog>

Function that generates the changelog used in build files, or for announcements (web, mailing-list, ...)

It takes 3 parameters:
The first parameter is the %pb hash containing packge info
The second parameter is the file descriptor on which to write the changelog content.
The third parameter is a flag in the configuration file indicating whether we want changelog expansion or not.

=cut

sub pb_changelog {

my $pb = shift;

my $dtype = $pb->{'pbos'}->{'type'};
my $pbrealpkg = $pb->{'realpkg'};
my $pbver = $pb->{'ver'};
my $pbtag = $pb->{'tag'};
my $pbsuf = $pb->{'pbos'}->{'suffix'};
my $OUTPUT = shift;
my $doit = shift;
my $chglog = $pb->{'chglog'};

my $log = "";

pb_log(3,"Entering pb_changelog - pb: ".Dumper($pb)."\n");
pb_log(3,"Entering pb_changelog - doit: $doit\n") if (defined $doit);
# For date handling
$ENV{'LANG'}="C";

if ((not (defined $dtype)) || ($dtype eq "") || 
        (not (defined $pbrealpkg)) || ($pbrealpkg eq "") || 
        (not (defined $pbver)) || ($pbver eq "") || 
        (not (defined $pbtag)) || ($pbtag eq "") || 
        (not (defined $pbsuf)) || ($pbsuf eq "") || 
        (not (defined $OUTPUT)) || ($OUTPUT eq "") ||
        (not (defined $doit)) || ($doit eq "")) {
    pb_log(2,"Not enough input params\n");
    print $OUTPUT "\n";
    return;
}

my $date;
my $ndate;
my $n2date;
my $ver;
my $ver2;
my ($pbpackager) = pb_conf_get("pbpackager");

if (not defined $pbpackager->{$ENV{'PBPROJ'}}) {
    $pbpackager->{$ENV{'PBPROJ'}} = "undefined\@noproject.noorg";
}

my @date = pb_get_date();
# If we don't need to do it, or don't have it fake something
if (((not defined $chglog) || (! -f $chglog)) || ($doit ne "yes")) {
    pb_log(2,"No ChangeLog file for $pbrealpkg - faking one\n");
    $date = strftime("%Y-%m-%d", @date);
    $ndate = &UnixDate($date,"%a", "%b", "%d", "%Y");
    $n2date = &UnixDate($date,"%a, %d %b %Y %H:%M:%S %z");
    if ($dtype eq "rpm") {
        $ver2 = "$pbver-$pbtag";
        print $OUTPUT "* $ndate $pbpackager->{$ENV{'PBPROJ'}} $ver2\n";
        print $OUTPUT "- Updated to $pbver\n";
    } elsif ($dtype eq "deb") {
        if ($pbver !~ /^[0-9]/) {
            # dpkg-deb doesn't accept non digit versions. 
            # Prepending 0 in order to make updates easy hopefully
            $pbver =~ s/^/0/;
        }
        print $OUTPUT "$pbrealpkg ($pbver-$pbtag) unstable; urgency=low\n";
        print $OUTPUT "  * Updated to $pbver\n";
        print $OUTPUT " -- $pbpackager->{$ENV{'PBPROJ'}}  $n2date\n\n\n";
    } else {
        pb_log(0,"No ChangeLog file for $pbrealpkg and no way faking one for type $dtype\n");
    }
    return;
}

die "No changelog file for $pbrealpkg found at $ENV{'PBROOTDIR'}/$pbrealpkg/pbcl" if (not defined $chglog);

open(INPUT,"$chglog") || die "Unable to open $chglog (read)";

# Skip first 4 lines
my $tmp = <INPUT>;
$tmp = <INPUT>;
$tmp = <INPUT>;
if ($dtype eq "announce") {
    chomp($tmp);
    print $OUTPUT "$tmp<br>\n";
}
$tmp = <INPUT>;
if ($dtype eq "announce") {
    chomp($tmp);
    print $OUTPUT "$tmp<br>\n";
}

my $first=1;

# Handle each block separated by newline
while (<INPUT>) {
    ($ver, $date) = split(/ /);
    # In case there is a v before the real version string
    $ver =~ s/^v//;
    chomp($date);
    $date =~ s/\(([0-9-]+)\)/$1/;
    pb_log(3,"**Date:$date**\n");
    $ndate = UnixDate($date,"%a", "%b", "%d", "%Y");
    $n2date = UnixDate($date,"%a, %d %b %Y %H:%M:%S %z");
    pb_log(3,"**nDate:$ndate**\n");

    pb_log(3,"**Ver:$ver**\n");
    if ($ver !~ /-/) {
        if ($first eq 1) {
            $ver2 = "$ver-$pbtag";
            $first = 0;
        } else {
            $ver2 = "$ver-1";
        }
    } else {
        $ver2 = $ver;
    }
    pb_log(3,"**Ver2:$ver2**\n");

    if (($dtype eq "rpm") || ($dtype eq "fc")) {
        print $OUTPUT "* $ndate $pbpackager->{$ENV{'PBPROJ'}} $ver2\n";
        print $OUTPUT "- Updated to $ver\n";
        }
    if ($dtype eq "deb") {
        if ($ver2 !~ /^[0-9]/) {
            # dpkg-deb doesn't accept non digit versions. 
            # Prepending 0 in order to make updates easy hopefully
            $ver2 =~ s/^/0/;
        }
        print $OUTPUT "$pbrealpkg ($ver2) unstable; urgency=low\n";
        print $OUTPUT "\n";
    }

    $tmp = <INPUT>; 
    while ((defined $tmp) && ($tmp !~ /^$/)) {
        if ($dtype eq "deb") {
            $tmp =~ s/^- //;
            $Text::Wrap::columns = 80;
            print $OUTPUT "  * ".wrap('','    ',$tmp);
        } elsif ($dtype eq "rpm") {
            print $OUTPUT "$tmp";
        } else {
            chomp($tmp);
            print $OUTPUT "$tmp<br>\n";
        }
        last if (eof(INPUT));
        $tmp = <INPUT>;
    }
    print $OUTPUT "\n";

    if ($dtype eq "deb") {
        # Cf: http://www.debian.org/doc/debian-policy/ch-source.html#s-dpkgchangelog
        print $OUTPUT " -- $pbpackager->{$ENV{'PBPROJ'}}  $n2date\n\n\n";
        }

    last if (eof(INPUT));
    last if ($dtype eq "announce");
}
close(INPUT);
pb_log(3,"Exiting pb_changelog\n");
}


=back 

=head1 WEB SITES

The main Web site of the project is available at L<http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.

=head1 USER MAILING LIST

None exists for the moment.

=head1 AUTHORS

The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.

=head1 COPYRIGHT

Project-Builder.org is distributed under the GPL v2.0 license
described in the file C<COPYING> included with the distribution.

=cut

1;