mkstandardsgmltable

#!/usr/bin/perl

use Carp;
use Getopt::Long;
use DBI;
use HTML::Entities;

use Env qw(LSBUSER LSBDBPASSWD LSBDB LSBDBHOST);

sub usage()
{
print STDERR <<"EOM"
mkstandardsgmltable -a <archname> [-v <lsbversion> [-m <submodule>]] [-s <specids>] [-x <exclids>] [-t <spectype>]

Generate SGML table of referenced standards.

-a      Architecture.
-v      LSB Version.

The following options take a single name or a comma-separated list:

-m      SubModule name(s). If specified, entries from the SModStd table will 
        be taken into account.  If this option is set, LSB Version must
        also be specified, too.
               
-s      Spec identifier(s) (Standard.Sid) to be included in the table.

-x      Spec identifier(s) (Standard.Sid) that should not be included in
        the table, even if they would be selected in other ways.
                
-t      Type of specification(s) (Standard.Stype) that should be taken into 
        account when generating. Default is "'Standard','Reference'".
EOM
      ; exit(1);
}

# make sure a string (including a list) is quoted properly for mysql
sub quote($)
{
    my ($type) = @_;
    return $type if ($type =~ /^'.*'$/);
    my @tlist = split(/,/, $type);
    foreach $t (@tlist) {
        $t = "'$t'" if ($t !~ /^'.*'$/);
    }
    return join(',', @tlist);
}

# Uncomment to trace SQL statments
#$trace=1;

#
# 1) process the arguments
#
my $Stype="'Standard','Reference'";
GetOptions( "a=s" => \$archname,
        "s=s" => \$specids,
        "x=s" => \$exclids,
        "m=s" => \$submodule,
        "v=s" => \$lsbversion,
        "t=s" => \$Stype,
      );
if( !$archname && !$specids ) { usage(); }

if( $submodule && !$lsbversion ) {
    die "When specifying submodule name, you should also specify target LSB version.";
}

#
# 2) Establish connection to the database
#
$dbh = DBI->connect('DBI:mysql:database='.$LSBDB.';host='.$LSBDBHOST, $LSBUSER, $LSBDBPASSWD)
    or die "Couldn't connect to database: ".DBI->errstr;

#
# 3) get architecture info
#
if( $archname ) {
    $select = "SELECT * FROM Architecture WHERE ";
    $select.= "Architecture.Aname=".$dbh->quote($archname);
    print STDERR $select,"\n" if $trace;
    $sth = $dbh->prepare($select) or die "Couldn't prepare $select query: ".DBI->errstr;
    $sth->execute or die "Couldn't execute $select query: ".DBI->errstr;

    $entry=$sth->fetchrow_hashref;
    $sth->finish;
    $Aid=$entry->{'Aid'};

    if( not $entry->{'Aname'} ) {
        die "Unsupported architecture";
    }
} else {
    $Aid=0;
}

#
# 4) get submodule info
#
if( $submodule ) {
    if( $submodule !~ /^'/ ) {
	$submodule = "'$submodule'";
	$submodule =~ s/\s//g; # drop spaces, if any
	$submodule =~ s/,/','/g;
    }
    $select = "SELECT GROUP_CONCAT(SMid SEPARATOR ',') FROM SubModule WHERE ";
    $select.= "SMname IN ($submodule)";
    print STDERR $select,"\n" if $trace;
    ($SMid) = $dbh->selectrow_array($select) or die "Couldn't prepare $select query: ".DBI->errstr;

    if( not $SMid ) {
        die "Unknown submodule(s)";
    }
} else {
    $SMid=0;
}

# check Stype is quoted properly
$Stype = quote($Stype);

#
# 5) Get Standards. Include those standards that are listed in the $specids
#    or which assigned to $submodule in the $lsbversion. Exclude entries
#    listed in the $exclids.
#
$select = "SELECT DISTINCT Standard.* FROM Standard ";
if( $SMid ) {
    $select.= "LEFT JOIN SModStd ON SMSsid=Sid ";
}
$select.= "WHERE Stype IN ($Stype) ";
if( $lsbversion ) {
    $select.= "AND Sappearedin > '' AND Sappearedin <= '$lsbversion' ";
    $select.= "AND (Swithdrawnin IS NULL OR Swithdrawnin > '$lsbversion') ";
}
$select.= "AND ( Sarch=$Aid OR Sarch=1 ) ";
if( $specids or $exclids or $SMid ) {
    $select.= "AND (";
}
if( $exclids ) {
    $select.= "Sname NOT IN ( $exclids ) ";
}
if( $specids ) {
    $select.= " AND ( " if( $exclids );
    $select.= "Sname IN ( $specids ) ";
}
if( $SMid ) {
    if( $specids ) {
        $select.= " OR (";
    }
    elsif( $exclids ) {
        $select.= " AND (";
    }
    $select.= " SMSsmid IN ($SMid) ";
    $select.= "AND SMSappearedin > '' AND SMSappearedin <= '$lsbversion' ";
    $select.= "AND (SMSwithdrawnin IS NULL OR SMSwithdrawnin > '$lsbversion') ";
    $select.= " ) " if( $specids or $exclids );
}
if( $specids or $exclids or $SMid ) {
    $select.= ") ";
    if( $specids and $exclids  ) {
        $select.= ") ";
    }
}
$select.= "ORDER BY Sshort";
print STDERR $select,"\n" if $trace;

$sth = $dbh->prepare($select) or die "Couldn't prepare $select query: ".DBI->errstr;
$sth->execute or die "Couldn't execute $select query: ".DBI->errstr;

printf("<!-- Start of generated text - do not edit! -->\n");
printf("<!-- generated from the LSB specification database by mkstandardsgmltable -->\n");

print "<thead>\n";
print "<row>";
print "<entry>Name</entry><entry>Title</entry><entry>URL</entry>";
print "</row>";
print "</thead>\n";
print "<tbody>\n";
for(1..$sth->rows) {
    $entry=$sth->fetchrow_hashref;
    print "<row>";
    # Don't print the nickname. It may be confusing
    #printf "<entry>%s</entry>",$entry->{'Sname'};
    printf "<entry id=\"std.%s\" xreflabel=\"%s\">%s</entry>",$entry->{'Stag'},$entry->{'Sshort'},$entry->{'Sshort'};
    printf "<entry>%s</entry>", $entry->{'Sfull'};
    printf "<entry><ulink url=\"%s\">%s</ulink></entry>",
                    encode_entities($entry->{'Surl'},"%&"),
                    encode_entities($entry->{'Surl'});
    #printf "<entry>%s</entry>",$entry->{'Sdescription'};
    print "</row>\n";
}
$sth->finish;
$dbh->disconnect;

print "</tbody>\n";
printf("<!-- End of text generated from database -->\n");