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

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

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

$VERSION = '1.59';

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