[dbsrgits/SQL-Translator.git] / bin / sql_translator.cgi

#!/usr/bin/perl

# -------------------------------------------------------------------
# $Id: sql_translator.cgi,v 1.2 2003-08-04 20:55:45 kycl4rk Exp $
# -------------------------------------------------------------------
# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
#
# 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
# -------------------------------------------------------------------

=head1 NAME

auto-viv.cgi

=head1 DESCRIPTION

A CGI script for transforming SQL schemas into pictures, either GraphViz
graphs or ER diagrams.  Basically, a simple web-form front-end for the
myriad options available to "auto-dia.pl" and "auto-graph.pl."

=cut

use strict;
use CGI;
use SQL::Translator;

my $q = CGI->new;

eval {
    if ( $q->param ) {
        my $t                =  SQL::Translator->new( 
            from             => $q->param('parser'),
            producer_args    => {
                image_type   => $q->param('output_type') || 'png',
                title        => $q->param('title')       || 'Schema',
                natural_join => $q->param('natural_join') eq 'no' ? 0 : 1, 
                join_pk_only => $q->param('natural_join') eq 'pk_only' ? 1 : 0,
                add_color    => $q->param('add_color'),
                skip_fields  => $q->param('skip_fields'),
                show_fk_only => $q->param('show_fk_only'),
                font_size    => $q->param('font_size'),
                no_columns   => $q->param('no_columns'),
                node_shape   => $q->param('node_shape'),
                height       => $q->param('height')      || 0,
                width        => $q->param('width')       || 0,
                show_fields  => $q->param('show_fields') || 0,
            },
        ) or die SQL::Translator->error;

        my $data;
        if ( $q->param('schema') ) {
            $data = $q->param('schema');
        }
        elsif ( my $fh = $q->upload('schema_file') ) {
            local $/;
            $data = <$fh>;
        }
        die "No schema provided!\n" unless $data;

        my $producer    = $q->param('producer');
        my $image_type  = $q->param('output_type') || 'png';
        my $header_type = 
            $producer =~ m/(GraphViz|Diagram)/ 
            ? "image/$image_type"
            : 'text/plain';

        $t->data( $data );
        $t->producer( $producer );
        my $output = $t->translate or die $t->error;

        print $q->header( -type => $header_type ), $output;
    }
    else {
        show_form( $q );
    }
};

if ( my $error = $@ ) {
    print $q->header, $q->start_html('Error'),
        $q->h1('Error'), $error, $q->end_html;
}

# -------------------------------------------------------------------
sub show_form {
    my $q     = shift;
    my $title = 'SQL::Translator';

    print $q->header, 
        $q->start_html( -title => $title ),
        $q->h1( qq[<a href="http://sqlfairy.sourceforge.net">$title</a>] ),
        $q->start_form(-enctype => 'multipart/form-data'),
        $q->table( { -border => 1 },
            $q->Tr( 
                $q->td( [
                    'Paste your schema here:',
                    $q->textarea( 
                        -name    => 'schema', 
                        -rows    => 10, 
                        -columns => 60,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Or upload your schema file:',
                    $q->filefield( -name => 'schema_file'),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Parser:',
                    $q->radio_group(
                        -name    => 'parser',
                        -values  => [ 'MySQL', 'PostgreSQL', 'Oracle' ],
                        -default => 'MySQL',
                        -rows    => 3,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Producer:',
                    $q->radio_group(
                        -name    => 'producer',
                        -values  => [ qw[ ClassDBI Diagram GraphViz HTML
                            MySQL Oracle POD PostgreSQL SQLite Sybase XML
                        ] ],
                        -default => 'GraphViz',
                        -rows    => 3,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Title:',
                    $q->textfield('title'),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Output Type:',
                    $q->radio_group(
                        -name    => 'output_type',
                        -values  => [ 'png', 'jpeg' ],
                        -default => 'png',
                        -rows    => 2,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Perform Natural Joins:',
                    $q->radio_group(
                        -name       => 'natural_join',
                        -values     => [ 'no', 'yes', 'pk_only' ],
                        -labels     => {
                            no      => 'No',
                            yes     => 'Yes, on all like-named fields',
                            pk_only => 'Yes, but only from primary keys'
                        },
                        -default    => 'no',
                        -rows       => 3,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Skip These Fields in Natural Joins:',
                    $q->textarea(
                        -name    => 'skip_fields',
                        -rows    => 3,
                        -columns => 60,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Color:',
                    $q->radio_group(
                        -name    => 'add_color',
                        -values  => [ 1, 0 ],
                        -labels  => { 
                            1    => 'Yes', 
                            0    => 'No' 
                        },
                        -default => 1,
                        -rows    => 2,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Show Only Foreign Keys *:',
                    $q->radio_group(
                        -name    => 'show_fk_only',
                        -values  => [ 1, 0 ],
                        -default => 0,
                        -labels  => {
                            1    => 'Yes',
                            0    => 'No',
                        },
                        -rows    => 2,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Font Size *:',
                    $q->radio_group(
                        -name    => 'font_size',
                        -values  => [ qw( small medium large ) ],
                        -default => 'medium',
                        -rows    => 3,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Number of Columns *:',
                    $q->textfield('no_columns'),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Layout **:',
                    $q->radio_group(
                        -name    => 'layout',
                        -values  => [ qw( dot neato twopi ) ],
                        -default => 'neato',
                        -rows    => 3,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Node Shape **:',
                    $q->radio_group(
                        -name    => 'node_shape',
                        -values  => [ qw( record plaintext ellipse 
                            circle egg triangle box diamond trapezium 
                            parallelogram house hexagon octagon 
                        ) ],
                        -default => 'record',
                        -rows    => 13,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Show Field Names **:',
                    $q->radio_group(
                        -name    => 'show_fields',
                        -values  => [ 1, 0 ],
                        -default => 1,
                        -labels  => {
                            1    => 'Yes',
                            0    => 'No',
                        },
                        -rows    => 2,
                    ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Height **:',
                    $q->textfield( -name => 'height', -default => 11 ),
                ] ),
            ),
            $q->Tr( 
                $q->td( [
                    'Width **:',
                    $q->textfield( -name => 'width', -default => 8.5 ),
                ] ),
            ),
            $q->Tr( 
                $q->td(
                    { -colspan => 2, -align => 'center' },
                    $q->submit( 
                        -name  => 'submit', 
                        -value => 'Submit',
                    ),
                    $q->br,
                    q[
                        <small>
                        * -- Applies to diagram only<br>
                        ** -- Applies to graph only<br>
                        </small>
                    ],
                ),
            ),
        ),
        $q->end_form,
        $q->end_html;
}

=pod

=head1 AUTHOR

Ken Y. Clark E<lt>kclark@cpan.orgE<gt>

=cut
Commit	Line	Data
69e4626f	1	#!/usr/bin/perl
	2
	3	# -------------------------------------------------------------------
5d8ea9f7	4	# $Id: sql_translator.cgi,v 1.2 2003-08-04 20:55:45 kycl4rk Exp $
69e4626f	5	# -------------------------------------------------------------------
	6	# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
	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	=head1 NAME
	24
	25	auto-viv.cgi
	26
	27	=head1 DESCRIPTION
	28
	29	A CGI script for transforming SQL schemas into pictures, either GraphViz
	30	graphs or ER diagrams. Basically, a simple web-form front-end for the
	31	myriad options available to "auto-dia.pl" and "auto-graph.pl."
	32
	33	=cut
	34
	35	use strict;
	36	use CGI;
	37	use SQL::Translator;
	38
	39	my $q = CGI->new;
	40
	41	eval {
	42	if ( $q->param ) {
	43	my $t = SQL::Translator->new(
5d8ea9f7	44	from => $q->param('parser'),
69e4626f	45	producer_args => {
	46	image_type => $q->param('output_type') \|\| 'png',
	47	title => $q->param('title') \|\| 'Schema',
	48	natural_join => $q->param('natural_join') eq 'no' ? 0 : 1,
	49	join_pk_only => $q->param('natural_join') eq 'pk_only' ? 1 : 0,
	50	add_color => $q->param('add_color'),
	51	skip_fields => $q->param('skip_fields'),
	52	show_fk_only => $q->param('show_fk_only'),
	53	font_size => $q->param('font_size'),
	54	no_columns => $q->param('no_columns'),
	55	node_shape => $q->param('node_shape'),
be35c82f	56	height => $q->param('height') \|\| 0,
	57	width => $q->param('width') \|\| 0,
	58	show_fields => $q->param('show_fields') \|\| 0,
69e4626f	59	},
	60	) or die SQL::Translator->error;
	61
	62	my $data;
	63	if ( $q->param('schema') ) {
	64	$data = $q->param('schema');
	65	}
	66	elsif ( my $fh = $q->upload('schema_file') ) {
	67	local $/;
	68	$data = <$fh>;
	69	}
69e4626f	70	die "No schema provided!\n" unless $data;
5d8ea9f7	71
	72	my $producer = $q->param('producer');
	73	my $image_type = $q->param('output_type') \|\| 'png';
	74	my $header_type =
	75	$producer =~ m/(GraphViz\|Diagram)/
	76	? "image/$image_type"
	77	: 'text/plain';
	78
69e4626f	79	$t->data( $data );
5d8ea9f7	80	$t->producer( $producer );
69e4626f	81	my $output = $t->translate or die $t->error;
69e4626f	82
5d8ea9f7	83	print $q->header( -type => $header_type ), $output;
69e4626f	84	}
	85	else {
	86	show_form( $q );
	87	}
	88	};
	89
	90	if ( my $error = $@ ) {
	91	print $q->header, $q->start_html('Error'),
	92	$q->h1('Error'), $error, $q->end_html;
	93	}
	94
	95	# -------------------------------------------------------------------
	96	sub show_form {
	97	my $q = shift;
	98	my $title = 'SQL::Translator';
	99
	100	print $q->header,
	101	$q->start_html( -title => $title ),
	102	$q->h1( qq[<a href="http://sqlfairy.sourceforge.net">$title</a>] ),
	103	$q->start_form(-enctype => 'multipart/form-data'),
	104	$q->table( { -border => 1 },
	105	$q->Tr(
	106	$q->td( [
	107	'Paste your schema here:',
	108	$q->textarea(
	109	-name => 'schema',
	110	-rows => 10,
	111	-columns => 60,
	112	),
	113	] ),
	114	),
	115	$q->Tr(
	116	$q->td( [
	117	'Or upload your schema file:',
	118	$q->filefield( -name => 'schema_file'),
	119	] ),
	120	),
	121	$q->Tr(
	122	$q->td( [
5d8ea9f7	123	'Parser:',
69e4626f	124	$q->radio_group(
5d8ea9f7	125	-name => 'parser',
69e4626f	126	-values => [ 'MySQL', 'PostgreSQL', 'Oracle' ],
	127	-default => 'MySQL',
	128	-rows => 3,
	129	),
	130	] ),
	131	),
	132	$q->Tr(
	133	$q->td( [
5d8ea9f7	134	'Producer:',
	135	$q->radio_group(
	136	-name => 'producer',
	137	-values => [ qw[ ClassDBI Diagram GraphViz HTML
	138	MySQL Oracle POD PostgreSQL SQLite Sybase XML
	139	] ],
	140	-default => 'GraphViz',
	141	-rows => 3,
	142	),
	143	] ),
	144	),
	145	$q->Tr(
	146	$q->td( [
69e4626f	147	'Title:',
	148	$q->textfield('title'),
	149	] ),
	150	),
	151	$q->Tr(
	152	$q->td( [
	153	'Output Type:',
	154	$q->radio_group(
	155	-name => 'output_type',
	156	-values => [ 'png', 'jpeg' ],
	157	-default => 'png',
	158	-rows => 2,
	159	),
	160	] ),
	161	),
	162	$q->Tr(
	163	$q->td( [
	164	'Perform Natural Joins:',
	165	$q->radio_group(
	166	-name => 'natural_join',
	167	-values => [ 'no', 'yes', 'pk_only' ],
	168	-labels => {
	169	no => 'No',
	170	yes => 'Yes, on all like-named fields',
	171	pk_only => 'Yes, but only from primary keys'
	172	},
	173	-default => 'no',
	174	-rows => 3,
	175	),
	176	] ),
	177	),
	178	$q->Tr(
	179	$q->td( [
	180	'Skip These Fields in Natural Joins:',
	181	$q->textarea(
	182	-name => 'skip_fields',
	183	-rows => 3,
	184	-columns => 60,
	185	),
	186	] ),
	187	),
	188	$q->Tr(
	189	$q->td( [
	190	'Color:',
	191	$q->radio_group(
	192	-name => 'add_color',
	193	-values => [ 1, 0 ],
	194	-labels => {
	195	1 => 'Yes',
	196	0 => 'No'
	197	},
	198	-default => 1,
	199	-rows => 2,
	200	),
	201	] ),
	202	),
	203	$q->Tr(
	204	$q->td( [
	205	'Show Only Foreign Keys *:',
	206	$q->radio_group(
	207	-name => 'show_fk_only',
	208	-values => [ 1, 0 ],
	209	-default => 0,
	210	-labels => {
211	1 => 'Yes',
212	0 => 'No',
213	},
214	-rows => 2,
215	),
216	] ),
217	),
218	$q->Tr(
219	$q->td( [
220	'Font Size *:',
221	$q->radio_group(
222	-name => 'font_size',
223	-values => [ qw( small medium large ) ],
224	-default => 'medium',
225	-rows => 3,
226	),
227	] ),
228	),
229	$q->Tr(
230	$q->td( [
231	'Number of Columns *:',
232	$q->textfield('no_columns'),
233	] ),
234	),
235	$q->Tr(
236	$q->td( [
237	'Layout **:',
238	$q->radio_group(
239	-name => 'layout',
240	-values => [ qw( dot neato twopi ) ],
241	-default => 'neato',
242	-rows => 3,
243	),
244	] ),
245	),
246	$q->Tr(
247	$q->td( [
248	'Node Shape **:',
249	$q->radio_group(
250	-name => 'node_shape',
251	-values => [ qw( record plaintext ellipse
252	circle egg triangle box diamond trapezium
253	parallelogram house hexagon octagon
254	) ],
be35c82f	255	-default => 'record',
69e4626f	256	-rows => 13,
	257	),
	258	] ),
	259	),
	260	$q->Tr(
be35c82f	261	$q->td( [
	262	'Show Field Names **:',
	263	$q->radio_group(
	264	-name => 'show_fields',
	265	-values => [ 1, 0 ],
	266	-default => 1,
	267	-labels => {
	268	1 => 'Yes',
	269	0 => 'No',
	270	},
	271	-rows => 2,
	272	),
	273	] ),
	274	),
	275	$q->Tr(
	276	$q->td( [
	277	'Height **:',
	278	$q->textfield( -name => 'height', -default => 11 ),
	279	] ),
	280	),
	281	$q->Tr(
	282	$q->td( [
	283	'Width **:',
	284	$q->textfield( -name => 'width', -default => 8.5 ),
	285	] ),
	286	),
	287	$q->Tr(
69e4626f	288	$q->td(
	289	{ -colspan => 2, -align => 'center' },
	290	$q->submit(
5d8ea9f7	291	-name => 'submit',
5d8ea9f7	292	-value => 'Submit',
69e4626f	293	),
	294	$q->br,
	295	q[
	296	<small>
	297	* -- Applies to diagram only<br>
	298	** -- Applies to graph only<br>
	299	</small>
	300	],
	301	),
	302	),
	303	),
	304	$q->end_form,
	305	$q->end_html;
	306	}
	307
	308	=pod
	309
	310	=head1 AUTHOR
	311
	312	Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
	313
	314	=cut