[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / HTML.pm

package SQL::Translator::Producer::HTML;

# -------------------------------------------------------------------
# $Id$
# -------------------------------------------------------------------
# Copyright (C) 2002-2009 SQLFairy Authors
#
# 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; version 2.
#
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# 02111-1307  USA
# -------------------------------------------------------------------

use strict;
use Data::Dumper;
use vars qw($VERSION $NOWRAP $NOLINKTABLE $NAME);

$VERSION = '1.99';

$NAME = __PACKAGE__;
$NOWRAP = 0 unless defined $NOWRAP;
$NOLINKTABLE = 0 unless defined $NOLINKTABLE;

# Emit XHTML by default
$CGI::XHTML = $CGI::XHTML = 42;

use SQL::Translator::Schema::Constants;

# -------------------------------------------------------------------
# Main entry point.  Returns a string containing HTML.
# -------------------------------------------------------------------
sub produce {
    my $t           = shift;
    my $args        = $t->producer_args;
    my $schema      = $t->schema;
    my $schema_name = $schema->name || 'Schema';
    my $title       = $args->{'title'} || "Description of $schema_name";
    my $wrap        = ! (defined $args->{'nowrap'}
                               ? $args->{'nowrap'}
                               : $NOWRAP);
    my $linktable   = ! (defined $args->{'nolinktable'}
                               ? $args->{'nolinktable'}
                               : $NOLINKTABLE);
    my %stylesheet  = defined $args->{'stylesheet'}
                    ? ( -style => { src => $args->{'stylesheet'} } )
                    : ( );
    my @html;
    my $q           = defined $args->{'pretty'}
                    ? do { require CGI::Pretty;
                            import CGI::Pretty;
                                   CGI::Pretty->new }
                    : do { require CGI;
                            import CGI; 
                                   CGI->new };
    my ($table, @table_names);

    if ($wrap) {
        push @html,
            $q->start_html({
                -title => $title,
                %stylesheet,
                -meta => { generator => $NAME },
            }),
            $q->h1({ -class => 'SchemaDescription' }, $title),
            $q->hr;
    }

    @table_names = grep { length $_->name } $schema->get_tables; 

    if ($linktable) {
        # Generate top menu, with links to full table information
        my $count = scalar(@table_names);
        $count = sprintf "%d table%s", $count, $count == 1 ? '' : 's';

        # Leading table of links
        push @html, 
            $q->comment("Table listing ($count)"),
            $q->a({ -name => 'top' }),
            $q->start_table({ -width => '100%', -class => 'LinkTable'}),

            # XXX This needs to be colspan="$#{$table->fields}" class="LinkTableHeader"
            $q->Tr(
                $q->td({ -class => 'LinkTableCell' },
                    $q->h2({ -class => 'LinkTableTitle' },
                        'Tables'
                    ),
                ),
            );

        for my $table (@table_names) {
            my $table_name = $table->name;
            push @html, 
                $q->comment("Start link to table '$table_name'"),
                $q->Tr({ -class => 'LinkTableRow' },
                    $q->td({ -class => 'LinkTableCell' },
                        qq[<a id="${table_name}-link" href="#$table_name">$table_name</a>]
                    )
                ),
                $q->comment("End link to table '$table_name'");
        }
        push @html, $q->end_table;
    }

    for my $table ($schema->get_tables) {
        my $table_name = $table->name       or next;
        my @fields     = $table->get_fields or next;
        push @html,
            $q->comment("Starting table '$table_name'"),
            $q->a({ -name => $table_name }),
            $q->table({ -class => 'TableHeader', -width => '100%' },
                $q->Tr({ -class => 'TableHeaderRow' },
                    $q->td({ -class => 'TableHeaderCell' }, $q->h3($table_name)),
                        qq[<a name="$table_name">],
                    $q->td({ -class => 'TableHeaderCell', -align => 'right' },
                        qq[<a href="#top">Top</a>]
                    )
                )
            );

        if ( my @comments = map { $_ ? $_ : () } $table->comments ) {
            push @html,
                $q->b("Comments:"),
                    $q->br,
                    $q->em(map { $q->br, $_ } @comments);
        }

        #
        # Fields
        #
        push @html,
            $q->start_table({ -border => 1 }),
                $q->Tr(
                    $q->th({ -class => 'FieldHeader' },
                           [ 
                            'Field Name', 
                            'Data Type', 
                            'Size', 
                            'Default Value', 
                            'Other', 
                            'Foreign Key' 
                           ]
                    ) 
                );

        my $i = 0;
        for my $field ( @fields ) {
            my $name      = $field->name      || '';
               $name      = qq[<a name="$table_name-$name">$name</a>];
            my $data_type = $field->data_type || '';
            my $size      = defined $field->size ? $field->size : '';
            my $default   = defined $field->default_value 
                            ? $field->default_value : '';
            my $comment   = $field->comments  || '';
            my $fk        = '';

            if ($field->is_foreign_key) {
                my $c         = $field->foreign_key_reference;
                my $ref_table = $c->reference_table       || '';
                my $ref_field = ($c->reference_fields)[0] || '';
                $fk           = 
                qq[<a href="#$ref_table-$ref_field">$ref_table.$ref_field</a>];
            }

            my @other = ();
            push @other, 'PRIMARY KEY' if $field->is_primary_key;
            push @other, 'UNIQUE'      if $field->is_unique;
            push @other, 'NOT NULL'    unless $field->is_nullable;
            push @other, $comment      if $comment;
            my $class = $i++ % 2 ? 'even' : 'odd';
            push @html,
                $q->Tr(
                    { -class => "tr-$class" },
                    $q->td({ -class => "FieldCellName" }, $name),
                    $q->td({ -class => "FieldCellType" }, $data_type),
                    $q->td({ -class => "FieldCellSize" }, $size),
                    $q->td({ -class => "FieldCellDefault" }, $default),
                    $q->td({ -class => "FieldCellOther" }, join(', ', @other)),
                    $q->td({ -class => "FieldCellFK" }, $fk),
                );
        }
        push @html, $q->end_table;

        #
        # Indices
        #
        if ( my @indices = $table->get_indices ) {
            push @html, 
                $q->h3('Indices'),
                $q->start_table({ -border => 1 }),
                    $q->Tr({ -class => 'IndexRow' },
                        $q->th([ 'Name', 'Fields' ]) 
                    );

            for my $index ( @indices ) {
                my $name   = $index->name || '';
                my $fields = join( ', ', $index->fields ) || '';

                push @html,
                    $q->Tr({ -class => 'IndexCell' },
                        $q->td( [ $name, $fields ] )
                    );
            }

            push @html, $q->end_table;
        }

        #
        # Constraints
        #
        my @constraints = 
            grep { $_->type ne PRIMARY_KEY } $table->get_constraints;
        if ( @constraints ) {
            push @html, 
                $q->h3('Constraints'),
                $q->start_table({ -border => 1 }),
                    $q->Tr({ -class => 'IndexRow' },
                        $q->th([ 'Type', 'Fields' ]) 
                    );

            for my $c ( @constraints ) {
                my $type   = $c->type || '';
                my $fields = join( ', ', $c->fields ) || '';

                push @html,
                    $q->Tr({ -class => 'IndexCell' },
                        $q->td( [ $type, $fields ] )
                    );
            }

            push @html, $q->end_table;
        }

        push @html, $q->hr;
    }

    my $sqlt_version = $t->version;
    if ($wrap) {
        push @html,
            qq[Created by <a href="http://sqlfairy.sourceforge.net">],
            qq[SQL::Translator $sqlt_version</a>],
            $q->end_html;
    }


    return join "\n", @html;
}

1;

# -------------------------------------------------------------------
# Always be ready to speak your mind,
# and a base man will avoid you.
# William Blake
# -------------------------------------------------------------------

=head1 NAME

SQL::Translator::Producer::HTML - HTML producer for SQL::Translator

=head1 SYNOPSIS

  use SQL::Translator::Producer::HTML;

=head1 DESCRIPTION

Creates an HTML document describing the tables.

The HTML produced is composed of a number of tables:

=over 4

=item Links

A link table sits at the top of the output, and contains anchored
links to elements in the rest of the document.

If the I<nolinktable> producer arg is present, then this table is not
produced.

=item Tables

Each table in the schema has its own HTML table.  The top row is a row
of E<lt>thE<gt> elements, with a class of B<FieldHeader>; these
elements are I<Field Name>, I<Data Type>, I<Size>, I<Default Value>,
I<Other> and I<Foreign Key>.  Each successive row describes one field
in the table, and has a class of B<FieldCell$item>, where $item id
corresponds to the label of the column.  For example:

    <tr>
        <td class="FieldCellName"><a name="random-id">id</a></td>
        <td class="FieldCellType">int</td>
        <td class="FieldCellSize">11</td>
        <td class="FieldCellDefault"></td>
        <td class="FieldCellOther">PRIMARY KEY, NOT NULL</td>
        <td class="FieldCellFK"></td>
    </tr>

    <tr>
        <td class="FieldCellName"><a name="random-foo">foo</a></td>
        <td class="FieldCellType">varchar</td>
        <td class="FieldCellSize">255</td>
        <td class="FieldCellDefault"></td>
        <td class="FieldCellOther">NOT NULL</td>
        <td class="FieldCellFK"></td>
    </tr>

    <tr>
        <td class="FieldCellName"><a name="random-updated">updated</a></td>
        <td class="FieldCellType">timestamp</td>
        <td class="FieldCellSize">0</td>
        <td class="FieldCellDefault"></td>
        <td class="FieldCellOther"></td>
        <td class="FieldCellFK"></td>
    </tr>

=back

Unless the I<nowrap> producer arg is present, the HTML will be
enclosed in a basic HTML header and footer.

If the I<pretty> producer arg is present, the generated HTML will be
nicely spaced and human-readable.  Otherwise, it will have very little
insignificant whitespace and be generally smaller.


=head1 AUTHORS

Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
Darren Chamberlain E<lt>darren@cpan.orgE<gt>.

=cut
Commit	Line	Data
aca7d777	1	package SQL::Translator::Producer::HTML;
	2
	3	# -------------------------------------------------------------------
782b5a43	4	# $Id$
aca7d777	5	# -------------------------------------------------------------------
478f608d	6	# Copyright (C) 2002-2009 SQLFairy Authors
aca7d777	7	#
	8	# This program is free software; you can redistribute it and/or
	9	# modify it under the terms of the GNU General Public License as
	10	# published by the Free Software Foundation; version 2.
	11	#
	12	# This program is distributed in the hope that it will be useful, but
	13	# WITHOUT ANY WARRANTY; without even the implied warranty of
	14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	# General Public License for more details.
	16	#
	17	# You should have received a copy of the GNU General Public License
	18	# along with this program; if not, write to the Free Software
	19	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	20	# 02111-1307 USA
	21	# -------------------------------------------------------------------
	22
	23	use strict;
a11fbaea	24	use Data::Dumper;
da06ac74	25	use vars qw($VERSION $NOWRAP $NOLINKTABLE $NAME);
	26
	27	$VERSION = '1.99';
64e36ec8	28
f9c96971	29	$NAME = __PACKAGE__;
64e36ec8	30	$NOWRAP = 0 unless defined $NOWRAP;
	31	$NOLINKTABLE = 0 unless defined $NOLINKTABLE;
	32
	33	# Emit XHTML by default
	34	$CGI::XHTML = $CGI::XHTML = 42;
aca7d777	35
aca7d777	36	use SQL::Translator::Schema::Constants;
aca7d777	37
aca7d777	38	# -------------------------------------------------------------------
64e36ec8	39	# Main entry point. Returns a string containing HTML.
64e36ec8	40	# -------------------------------------------------------------------
aca7d777	41	sub produce {
aca7d777	42	my $t = shift;
84474a81	43	my $args = $t->producer_args;
aca7d777	44	my $schema = $t->schema;
aca7d777	45	my $schema_name = $schema->name \|\| 'Schema';
84474a81	46	my $title = $args->{'title'} \|\| "Description of $schema_name";
64e36ec8	47	my $wrap = ! (defined $args->{'nowrap'}
	48	? $args->{'nowrap'}
	49	: $NOWRAP);
	50	my $linktable = ! (defined $args->{'nolinktable'}
	51	? $args->{'nolinktable'}
	52	: $NOLINKTABLE);
	53	my %stylesheet = defined $args->{'stylesheet'}
	54	? ( -style => { src => $args->{'stylesheet'} } )
	55	: ( );
	56	my @html;
1ea530d4	57	my $q = defined $args->{'pretty'}
29ecbf4e	58	? do { require CGI::Pretty;
	59	import CGI::Pretty;
	60	CGI::Pretty->new }
	61	: do { require CGI;
	62	import CGI;
	63	CGI->new };
64e36ec8	64	my ($table, @table_names);
	65
	66	if ($wrap) {
	67	push @html,
	68	$q->start_html({
	69	-title => $title,
	70	%stylesheet,
	71	-meta => { generator => $NAME },
c012e81a	72	}),
64e36ec8	73	$q->h1({ -class => 'SchemaDescription' }, $title),
64e36ec8	74	$q->hr;
	75	}
	76
	77	@table_names = grep { length $_->name } $schema->get_tables;
aca7d777	78
64e36ec8	79	if ($linktable) {
	80	# Generate top menu, with links to full table information
	81	my $count = scalar(@table_names);
	82	$count = sprintf "%d table%s", $count, $count == 1 ? '' : 's';
aca7d777	83
64e36ec8	84	# Leading table of links
	85	push @html,
	86	$q->comment("Table listing ($count)"),
a3de76be	87	$q->a({ -name => 'top' }),
a3de76be	88	$q->start_table({ -width => '100%', -class => 'LinkTable'}),
64e36ec8	89
	90	# XXX This needs to be colspan="$#{$table->fields}" class="LinkTableHeader"
	91	$q->Tr(
	92	$q->td({ -class => 'LinkTableCell' },
	93	$q->h2({ -class => 'LinkTableTitle' },
	94	'Tables'
	95	),
	96	),
	97	);
ad02944a	98
d8b098e5	99	for my $table (@table_names) {
64e36ec8	100	my $table_name = $table->name;
	101	push @html,
	102	$q->comment("Start link to table '$table_name'"),
	103	$q->Tr({ -class => 'LinkTableRow' },
	104	$q->td({ -class => 'LinkTableCell' },
	105	qq[<a id="${table_name}-link" href="#$table_name">$table_name</a>]
	106	)
	107	),
	108	$q->comment("End link to table '$table_name'");
ad02944a	109	}
64e36ec8	110	push @html, $q->end_table;
ad02944a	111	}
ad02944a	112
64e36ec8	113	for my $table ($schema->get_tables) {
84474a81	114	my $table_name = $table->name or next;
aca7d777	115	my @fields = $table->get_fields or next;
64e36ec8	116	push @html,
a3de76be	117	$q->comment("Starting table '$table_name'"),
a3de76be	118	$q->a({ -name => $table_name }),
64e36ec8	119	$q->table({ -class => 'TableHeader', -width => '100%' },
	120	$q->Tr({ -class => 'TableHeaderRow' },
	121	$q->td({ -class => 'TableHeaderCell' }, $q->h3($table_name)),
	122	qq[<a name="$table_name">],
	123	$q->td({ -class => 'TableHeaderCell', -align => 'right' },
	124	qq[<a href="#top">Top</a>]
	125	)
	126	)
	127	);
aca7d777	128
84474a81	129	if ( my @comments = map { $_ ? $_ : () } $table->comments ) {
64e36ec8	130	push @html,
	131	$q->b("Comments:"),
	132	$q->br,
	133	$q->em(map { $q->br, $_ } @comments);
a11fbaea	134	}
a11fbaea	135
aca7d777	136	#
	137	# Fields
	138	#
64e36ec8	139	push @html,
a3de76be	140	$q->start_table({ -border => 1 }),
64e36ec8	141	$q->Tr(
	142	$q->th({ -class => 'FieldHeader' },
	143	[
	144	'Field Name',
	145	'Data Type',
	146	'Size',
	147	'Default Value',
	148	'Other',
	149	'Foreign Key'
	150	]
	151	)
	152	);
aca7d777	153
3d4edd30	154	my $i = 0;
aca7d777	155	for my $field ( @fields ) {
84474a81	156	my $name = $field->name \|\| '';
aca7d777	157	$name = qq[<a name="$table_name-$name">$name</a>];
84474a81	158	my $data_type = $field->data_type \|\| '';
	159	my $size = defined $field->size ? $field->size : '';
	160	my $default = defined $field->default_value
	161	? $field->default_value : '';
	162	my $comment = $field->comments \|\| '';
	163	my $fk = '';
aca7d777	164
64e36ec8	165	if ($field->is_foreign_key) {
84474a81	166	my $c = $field->foreign_key_reference;
	167	my $ref_table = $c->reference_table \|\| '';
	168	my $ref_field = ($c->reference_fields)[0] \|\| '';
	169	$fk =
aca7d777	170	qq[<a href="#$ref_table-$ref_field">$ref_table.$ref_field</a>];
	171	}
	172
84474a81	173	my @other = ();
aca7d777	174	push @other, 'PRIMARY KEY' if $field->is_primary_key;
	175	push @other, 'UNIQUE' if $field->is_unique;
	176	push @other, 'NOT NULL' unless $field->is_nullable;
ad02944a	177	push @other, $comment if $comment;
3d4edd30	178	my $class = $i++ % 2 ? 'even' : 'odd';
64e36ec8	179	push @html,
64e36ec8	180	$q->Tr(
3d4edd30	181	{ -class => "tr-$class" },
64e36ec8	182	$q->td({ -class => "FieldCellName" }, $name),
	183	$q->td({ -class => "FieldCellType" }, $data_type),
	184	$q->td({ -class => "FieldCellSize" }, $size),
	185	$q->td({ -class => "FieldCellDefault" }, $default),
	186	$q->td({ -class => "FieldCellOther" }, join(', ', @other)),
	187	$q->td({ -class => "FieldCellFK" }, $fk),
	188	);
aca7d777	189	}
64e36ec8	190	push @html, $q->end_table;
aca7d777	191
	192	#
	193	# Indices
	194	#
	195	if ( my @indices = $table->get_indices ) {
64e36ec8	196	push @html,
	197	$q->h3('Indices'),
	198	$q->start_table({ -border => 1 }),
	199	$q->Tr({ -class => 'IndexRow' },
	200	$q->th([ 'Name', 'Fields' ])
	201	);
aca7d777	202
aca7d777	203	for my $index ( @indices ) {
84474a81	204	my $name = $index->name \|\| '';
	205	my $fields = join( ', ', $index->fields ) \|\| '';
	206
64e36ec8	207	push @html,
	208	$q->Tr({ -class => 'IndexCell' },
	209	$q->td( [ $name, $fields ] )
	210	);
aca7d777	211	}
aca7d777	212
64e36ec8	213	push @html, $q->end_table;
aca7d777	214	}
aca7d777	215
a3de76be	216	#
	217	# Constraints
	218	#
	219	my @constraints =
	220	grep { $_->type ne PRIMARY_KEY } $table->get_constraints;
	221	if ( @constraints ) {
	222	push @html,
	223	$q->h3('Constraints'),
	224	$q->start_table({ -border => 1 }),
	225	$q->Tr({ -class => 'IndexRow' },
	226	$q->th([ 'Type', 'Fields' ])
	227	);
	228
	229	for my $c ( @constraints ) {
	230	my $type = $c->type \|\| '';
	231	my $fields = join( ', ', $c->fields ) \|\| '';
	232
	233	push @html,
	234	$q->Tr({ -class => 'IndexCell' },
	235	$q->td( [ $type, $fields ] )
	236	);
	237	}
	238
	239	push @html, $q->end_table;
	240	}
	241
64e36ec8	242	push @html, $q->hr;
aca7d777	243	}
aca7d777	244
a3de76be	245	my $sqlt_version = $t->version;
64e36ec8	246	if ($wrap) {
	247	push @html,
	248	qq[Created by <a href="http://sqlfairy.sourceforge.net">],
a3de76be	249	qq[SQL::Translator $sqlt_version</a>],
64e36ec8	250	$q->end_html;
64e36ec8	251	}
aca7d777	252
64e36ec8	253
64e36ec8	254	return join "\n", @html;
aca7d777	255	}
	256
	257	1;
	258
	259	# -------------------------------------------------------------------
	260	# Always be ready to speak your mind,
	261	# and a base man will avoid you.
	262	# William Blake
	263	# -------------------------------------------------------------------
	264
	265	=head1 NAME
	266
	267	SQL::Translator::Producer::HTML - HTML producer for SQL::Translator
	268
	269	=head1 SYNOPSIS
	270
	271	use SQL::Translator::Producer::HTML;
	272
	273	=head1 DESCRIPTION
	274
	275	Creates an HTML document describing the tables.
	276
64e36ec8	277	The HTML produced is composed of a number of tables:
	278
	279	=over 4
	280
	281	=item Links
	282
	283	A link table sits at the top of the output, and contains anchored
	284	links to elements in the rest of the document.
	285
	286	If the I<nolinktable> producer arg is present, then this table is not
	287	produced.
	288
	289	=item Tables
	290
	291	Each table in the schema has its own HTML table. The top row is a row
	292	of E<lt>thE<gt> elements, with a class of B<FieldHeader>; these
	293	elements are I<Field Name>, I<Data Type>, I<Size>, I<Default Value>,
	294	I<Other> and I<Foreign Key>. Each successive row describes one field
	295	in the table, and has a class of B<FieldCell$item>, where $item id
	296	corresponds to the label of the column. For example:
	297
	298	<tr>
	299	<td class="FieldCellName"><a name="random-id">id</a></td>
	300	<td class="FieldCellType">int</td>
	301	<td class="FieldCellSize">11</td>
	302	<td class="FieldCellDefault"></td>
	303	<td class="FieldCellOther">PRIMARY KEY, NOT NULL</td>
	304	<td class="FieldCellFK"></td>
	305	</tr>
	306
	307	<tr>
	308	<td class="FieldCellName"><a name="random-foo">foo</a></td>
	309	<td class="FieldCellType">varchar</td>
	310	<td class="FieldCellSize">255</td>
	311	<td class="FieldCellDefault"></td>
	312	<td class="FieldCellOther">NOT NULL</td>
	313	<td class="FieldCellFK"></td>
	314	</tr>
	315
	316	<tr>
	317	<td class="FieldCellName"><a name="random-updated">updated</a></td>
	318	<td class="FieldCellType">timestamp</td>
	319	<td class="FieldCellSize">0</td>
	320	<td class="FieldCellDefault"></td>
	321	<td class="FieldCellOther"></td>
	322	<td class="FieldCellFK"></td>
	323	</tr>
	324
	325	=back
	326
	327	Unless the I<nowrap> producer arg is present, the HTML will be
	328	enclosed in a basic HTML header and footer.
	329
	330	If the I<pretty> producer arg is present, the generated HTML will be
	331	nicely spaced and human-readable. Otherwise, it will have very little
	332	insignificant whitespace and be generally smaller.
	333
	334
977651a5	335	=head1 AUTHORS
aca7d777	336
64e36ec8	337	Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
977651a5	338	Darren Chamberlain E<lt>darren@cpan.orgE<gt>.
aca7d777	339
aca7d777	340	=cut