improvements to cat / feature listing
[scpubgit/stemmatology.git] / script / make_tradition.pl
1 #!/usr/bin/env perl
2
3 use lib 'lib';
4 use strict;
5 use warnings;
6 use Getopt::Long;
7 use TryCatch;
8 use Text::Tradition;
9 use Text::Tradition::Directory;
10 use Text::Tradition::StemmaUtil qw/ character_input phylip_pars /;
11
12 binmode STDERR, ":utf8";
13 binmode STDOUT, ":utf8";
14 eval { no warnings; binmode $DB::OUT, ":utf8"; };
15
16 my( $informat, $inbase, $outformat, $help, $language, $name, $sep, $stemmafile, 
17         $dsn, $dbuser, $dbpass, $from, $to ) 
18     = ( '', '', '', '', 'Default', 'Tradition', "\t", '',
19         "dbi:SQLite:dbname=stemmaweb/db/traditions.db", undef, undef, undef, undef );
20
21 GetOptions( 'i|in=s'    => \$informat,
22             'b|base=s'  => \$inbase,
23             'o|out=s'   => \$outformat,
24             'l|language=s' => \$language,
25             'n|name=s'  => \$name,
26             'h|help'    => \$help,
27             's|stemma=s' => \$stemmafile,
28             'u|user=s'  => \$dbuser,
29             'p|pass=s'  => \$dbpass,
30             'f|from=s'  => \$from,
31             't|to=s'    => \$to,
32             'sep=s'             => \$sep,
33             'dsn=s'             => \$dsn,
34     );
35
36 if( $help ) {
37     help();
38 }
39
40 unless( $informat =~ /^(CSV|CTE|KUL|Self|TEI|CollateX|tab(ular)?)|stone$/i ) {
41     help( "Input format must be one of CollateX, CSV, CTE, Self, TEI" );
42 }
43 $informat = 'CollateX' if $informat =~ /^c(ollate)?x$/i;
44 $informat = 'KUL' if $informat =~ /^kul$/i;
45 $informat = 'CTE' if $informat =~ /^cte$/i;
46 $informat = 'Self' if $informat =~ /^self$/i;
47 $informat = 'TEI' if $informat =~ /^tei$/i;
48 $informat = 'Tabular' if $informat =~ /^tab$/i;
49 $informat = 'CollateText' if $informat =~ /^stone$/i;
50
51 unless( $outformat =~ /^(graphml|svg|dot|stemma|csv|db)$/ ) {
52     help( "Output format must be one of db, graphml, svg, csv, stemma, or dot" );
53 }
54
55 if( $from || $to ) {
56         help( "Subgraphs only supported in GraphML format" ) 
57                 unless $outformat eq 'graphml';
58 }
59
60 # Do we have a base if we need it?
61 if( $informat =~ /^(KUL|CollateText)$/ && !$inbase ) {
62     help( "$informat input needs a base text" );
63 }
64 $sep = "\t" if $sep eq 'tab';
65
66 my $input = $ARGV[0];
67
68 # First: read the base. Make a graph, but also note which
69 # nodes represent line beginnings.
70 my %args = ( 'input' => $informat,
71              'file' => $input );
72 $args{'base'} = $inbase if $inbase;
73 $args{'language'} = $language if $language;
74 $args{'name'} = $name if $name;
75 $args{'sep_char'} = $sep if $informat eq 'Tabular';
76 ### Custom hacking for Stone
77 if( $informat eq 'CollateText' ) {
78     $args{'sigla'} = [ qw/ S M X V Z Bb B K W L / ];
79 }
80 my $tradition = Text::Tradition->new( %args );
81 if( $stemmafile ) {
82         my $stemma = $tradition->add_stemma( dotfile => $stemmafile );
83         print STDERR "Saved stemma at $stemmafile\n" if $stemma;
84 }
85
86 # Now output what we have been asked to.
87 if( $outformat eq 'stemma' ) {
88     my $cdata = character_input( $tradition->collation->alignment_table );
89     try {
90         print phylip_pars( $cdata );
91     } catch( Text::Tradition::Error $e ) {
92         print STDERR "Bad result: " . $e->message;
93     }
94 } elsif( $outformat eq 'db' ) {
95         my $extra_args = { 'create' => 1 };
96         $extra_args->{'user'} = $dbuser if $dbuser;
97         $extra_args->{'password'} = $dbpass if $dbpass;
98         my $dir = Text::Tradition::Directory->new( 'dsn' => $dsn, 
99                 'extra_args' => $extra_args );
100         my $scope = $dir->new_scope;
101         my $uuid = $dir->store( $tradition );
102         print STDERR "Saved tradition to database with ID $uuid\n";
103 } else {
104     my $output = "as_$outformat";
105     my $opts = {};
106     $opts->{'from'} = $from if $from;
107     $opts->{'to'} = $to if $to;
108     print $tradition->collation->$output( $opts );
109 }
110
111 sub help {
112     my( $msg ) = @_;
113     print STDERR << "EOF"
114 Usage: $0 -i [format] -o [format] (--base [filename]) (--(no)linear) [inputfile]
115     i, input: Format of the input file.  Must be one of CollateX, CSV, CTE, Self, TEI.
116     o, output: Format of the output.  Must be one of svg, dot, graphml, csv, stemma.
117     b, base: Filename that contains a base text.  Needed for CSV input.
118     l, linear: Treat transposed readings separately, producing a linear graph.  
119         If nolinear, treat transposed readings as the same node.
120     h, help: Print this message.
121 EOF
122     ;
123     if( $msg ) {
124         print STDERR "$msg\n";
125     }
126     exit ($msg ? 1 : 0 );
127 }