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

package SQL::Translator::Producer::Diagram;

# -------------------------------------------------------------------
# $Id: Diagram.pm,v 1.8 2003-11-05 22:27:25 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

SQL::Translator::Producer::Diagram - ER diagram producer for SQL::Translator

=head1 SYNOPSIS

Use via SQL::Translator:

  use SQL::Translator;

  my $t = SQL::Translator->new( parser => 'MySQL', '...' );
  $t->translate;

Or use more directly:

  use SQL::Translator;
  use SQL::Translator::MySQL 'parse';

  my $t = SQL::Translator->new( filename => '...' );;
  parse( $t, 


=cut

use strict;
use GD;
use Data::Dumper;
use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(debug);

use vars qw[ $VERSION $DEBUG ];
$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
$DEBUG   = 0 unless defined $DEBUG;

use constant VALID_FONT_SIZE => {
    small  => 1,
    medium => 1,
    large  => 1,
    huge   => 1,
};

use constant VALID_IMAGE_TYPE => {
    png  => 1,
    jpeg => 1,
};

sub produce {
    my $t          = shift;
    my $schema     = $t->schema;
    my $args       = $t->producer_args;
    local $DEBUG   = $t->debug;
    debug("Schema =\n", Dumper( $schema ));
    debug("Producer args =\n", Dumper( $args ));

    my $out_file     = $args->{'out_file'}     || '';
    my $output_type  = $args->{'output_type'}   || 'png';
    my $title        = $args->{'title'}        || $t->filename;
    my $font_size    = $args->{'font_size'}    || 'medium';
    my $imap_file    = $args->{'imap_file'}    || '';
    my $imap_url     = $args->{'imap_url'}     || '';
    my $no_columns   = $args->{'no_columns'};
    my $no_lines     = $args->{'no_lines'};
    my $add_color    = $args->{'add_color'};
    my $show_fk_only = $args->{'show_fk_only'};
    my $join_pk_only = $args->{'join_pk_only'};
    my $natural_join = $args->{'natural_join'} || $join_pk_only;
    my $skip_fields  = $args->{'skip_fields'};
    my %skip         = map { s/^\s+|\s+$//g; $_,1 } split (/,/, $skip_fields);

    $schema->make_natural_joins(
        join_pk_only => $join_pk_only,
        skip_fields  => $args->{'skip_fields'},
    ) if $natural_join;

    die "Invalid image type '$output_type'"
        unless VALID_IMAGE_TYPE ->{ $output_type  };
    die "Invalid font size '$font_size'"
        unless VALID_FONT_SIZE->{ $font_size };

    #
    # Layout the image.
    #
    my $font         = 
        $font_size eq 'small'  ? gdTinyFont  :
        $font_size eq 'medium' ? gdSmallFont :
        $font_size eq 'large'  ? gdLargeFont : gdGiantFont;
    my @tables       = $schema->get_tables;
    my $no_tables    = scalar @tables;
    $no_columns      = 0 unless $no_columns =~ /^\d+$/;
    $no_columns    ||= sprintf( "%.0f", sqrt( $no_tables ) + .5 );
    $no_columns    ||= .5;
    my $no_per_col   = sprintf( "%.0f", $no_tables/$no_columns + .5 );

    my @shapes;            
    my ( $max_x, $max_y );          # the furthest x and y used
    my $orig_y      = 40;           # used to reset y for each column
    my ( $x, $y )   = (30,$orig_y); # where to start
    my $cur_col     = 1;            # the current column
    my $no_this_col = 0;            # number of tables in current column
    my $this_col_x  = $x;           # current column's x
    my $gutter      = 30;           # distance b/w columns
    my %nj_registry;                # for locations of fields for natural joins
    my @fk_registry;                # for locations of fields for foreign keys
    my %table_x;                    # for max x of each table
    my $field_no;                   # counter to give distinct no. to each field
    my %coords;                     # holds fields coordinates
    my @imap_coords;                # for making clickable image map
    my %legend;

    for my $table ( @tables ) {
        my $table_name = $table->name;
        my $top        = $y;
        push @shapes, 
            [ 'string', $font, $this_col_x, $y, $table_name, 'black' ];
        $y                   += $font->height + 2;
        my $below_table_name  = $y;
        $y                   += 2;
        my $this_max_x        = 
            $this_col_x + ($font->width * length($table_name));

        debug("Processing table '$table_name'");

        my @fields = $table->get_fields;
        debug("Fields = ", join(', ', map { $_->name } @fields));

        my ( @fld_desc, $max_name );
        for my $f ( @fields ) {
            my $name  = $f->name or next;
            my $is_pk = $f->is_primary_key;

            #
            # Decide if we should skip this field.
            #
            if ( $show_fk_only ) {
                next unless $is_pk || $f->is_foreign_key;
            }

            if ( $is_pk ) {
                $name .= ' *';
                $legend{'Primary key'} = '*';
            }

            if ( $f->is_unique ) {
                $name .= ' [U]';
                $legend{'Unique constraint'} = '[U]';
            }

            my $desc = $f->data_type;
            $desc   .= '('.$f->size.')' if $f->size;
            
            my $nlen  = length $name;
            $max_name = $nlen if $nlen > $max_name;
            push @fld_desc, [ $name, $desc, $f->{'name'}, $is_pk ];
        }

        $max_name += 4;
        for my $fld_desc ( @fld_desc ) {
            my ( $name, $desc, $orig_name, $is_pk ) = @$fld_desc;
            my $diff = $max_name - length $name;
            $name   .= ' ' x $diff;
            $desc    = $name . $desc;

            push @shapes, [ 'string', $font, $this_col_x, $y, $desc, 'black' ];
            $y         += $font->height + 2;
            my $length  = $this_col_x + ( $font->width * length( $desc ) );
            $this_max_x = $length if $length > $this_max_x;

            my $constraints = $table->{'fields'}{ $orig_name }{'constraints'};

            if ( $natural_join && !$skip{ $orig_name } ) {
                push @{ $nj_registry{ $orig_name } }, $table_name;
            }

            my $y_link = $y - $font->height/2;
            $coords{ $table_name }{ $orig_name }{'coords'} = {
                left     => [ $this_col_x - 6, $y_link ],
                right    => [ $length + 2    , $y_link ],
                table    => $table_name,
                field_no => ++$field_no,
                is_pk    => $is_pk,
                fld_name => $orig_name,
            };

            push @imap_coords, [ 
                $imap_url."#$table_name-$orig_name",
                $this_col_x, $y - $font->height, $length, $y_link,
            ];
        }

        unless ( $natural_join ) {
            for my $c ( $table->get_constraints ) {
                next unless $c->type eq FOREIGN_KEY;
                my $fk_table = $c->reference_table or next;

                for my $field_name ( $c->fields ) {
                    for my $fk_field ( $c->reference_fields ) {
                        next unless defined $schema->get_table( $fk_table );
                        push @fk_registry, [
                            [ $fk_table  , $fk_field  ],
                            [ $table_name, $field_name ],
                        ];
                    }
                }
            }
        }

        $this_max_x += 5;
        $table_x{ $table_name } = $this_max_x + 5;
        push @shapes, [ 'line', $this_col_x - 5, $below_table_name, 
            $this_max_x, $below_table_name, 'black' ];
        my @bounds = ( $this_col_x - 5, $top - 5, $this_max_x, $y + 5 );
        if ( $add_color ) {
            unshift @shapes, [ 
                'filledRectangle', 
                $bounds[0], $bounds[1],
                $this_max_x, $below_table_name,
                'khaki' 
            ];
            unshift @shapes, [ 'filledRectangle', @bounds, 'white' ];
        }

        push @imap_coords, [ 
            $imap_url."#$table_name",
            $bounds[0], $bounds[1], $this_max_x, $below_table_name,
        ];

        push @shapes, [ 'rectangle', @bounds, 'black' ];
        $max_x = $this_max_x if $this_max_x > $max_x;
        $y    += 25;
        
        if ( ++$no_this_col == $no_per_col ) {# if we've filled up this column
            $cur_col++;                       # up the column number
            $no_this_col = 0;                 # reset the number of tables
            $max_x      += $gutter;           # push the x over for next column
            $this_col_x  = $max_x;            # remember the max x for this col
            $max_y       = $y if $y > $max_y; # note the max y
            $y           = $orig_y;           # reset the y for next column
        }
    }

    #
    # Connect the lines.
    #
    my %horz_taken;
    my %done;
    unless ( $no_lines ) {
        my @position_bunches;

        if ( $natural_join ) {
            for my $field_name ( keys %nj_registry ) {
                my @positions;
                my @table_names = 
                    @{ $nj_registry{ $field_name } || [] } or next;
                next if scalar @table_names == 1;

                for my $table_name ( @table_names ) {
                    push @positions,
                        $coords{ $table_name }{ $field_name }{'coords'};
                }

                push @position_bunches, [ @positions ];
            }
        }
        else {
            for my $pair ( @fk_registry ) {
                push @position_bunches, [ 
                    $coords{$pair->[0][0]}{ $pair->[0][1] }{'coords'},
                    $coords{$pair->[1][0]}{ $pair->[1][1] }{'coords'},
                ];
            }
        }

        my $is_directed = $natural_join ? 0 : 1;

        for my $bunch ( @position_bunches ) {
            my @positions = @$bunch;

            for my $i ( 0 .. $#positions ) {
                my $pos1        = $positions[ $i ];
                my ( $ax, $ay ) = @{ $pos1->{'left'}  || [] } or next;
                my ( $bx, $by ) = @{ $pos1->{'right'} || [] } or next;
                my $table1      = $pos1->{'table'};
                my $fno1        = $pos1->{'field_no'};
                my $is_pk       = $pos1->{'is_pk'};
                next if $join_pk_only and !$is_pk;

                for my $j ( 0 .. $#positions ) {
                    my $pos2        = $positions[ $j ];
                    my ( $cx, $cy ) = @{ $pos2->{'left'}  || [] } or next;
                    my ( $dx, $dy ) = @{ $pos2->{'right'} || [] } or next;
                    my $table2      = $pos2->{'table'};
                    my $fno2        = $pos2->{'field_no'};
                    next if $table1 eq $table2;
                    next if $done{ $fno1 }{ $fno2 };
                    next if $fno1 == $fno2;

                    my @distances = ();
                    push @distances, [
                        abs ( $ax - $cx ) + abs ( $ay - $cy ),
                        [ $ax, $ay, $cx, $cy ],
                        [ 'left', 'left' ]
                    ];
                    push @distances, [
                        abs ( $ax - $dx ) + abs ( $ay - $dy ),
                        [ $ax, $ay, $dx, $dy ],
                        [ 'left', 'right' ],
                    ];
                    push @distances, [
                        abs ( $bx - $cx ) + abs ( $by - $cy ),
                        [ $bx, $by, $cx, $cy ],
                        [ 'right', 'left' ],
                    ];
                    push @distances, [
                        abs ( $bx - $dx ) + abs ( $by - $dy ),
                        [ $bx, $by, $dx, $dy ],
                        [ 'right', 'right' ],
                    ];
                    @distances   = sort { $a->[0] <=> $b->[0] } @distances;
                    my $shortest = $distances[0];
                    my ( $x1, $y1, $x2, $y2 ) = @{ $shortest->[1] };
                    my ( $side1, $side2     ) = @{ $shortest->[2] };
                    my ( $start, $end );
                    my $offset     = 9;
                    my $col1_right = $table_x{ $table1 };
                    my $col2_right = $table_x{ $table2 };

                    my $diff = 0;
                    if ( $x1 == $x2 ) {
                        while ( $horz_taken{ $x1 + $diff } ) {
                            $diff = $side1 eq 'left' ? $diff - 2 : $diff + 2; 
                        }
                        $horz_taken{ $x1 + $diff } = 1;
                    }

                    if ( $side1 eq 'left' ) {
                        $start = $x1 - $offset + $diff;
                    }
                    else {
                        $start = $col1_right + $diff;
                    }

                    if ( $side2 eq 'left' ) {
                        $end = $x2 - $offset + $diff;
                    } 
                    else {
                        $end = $col2_right + $diff;
                    } 

                    push @shapes, 
                        [ 'line', $x1,    $y1, $start, $y1, 'cadetblue' ];
                    push @shapes, 
                        [ 'line', $start, $y1, $end,   $y2, 'cadetblue' ];
                    push @shapes, 
                        [ 'line', $end,   $y2, $x2,    $y2, 'cadetblue' ];

                    if ( $is_directed ) {
                        if (
                            $side1 eq 'right' && $side2 eq 'left'
                            ||
                            $side1 eq 'left' && $side2 eq 'left'
                        ) {
                            push @shapes, [ 
                                'line', $x2 - 3, $y2 - 3, $x2, $y2, 'cadetblue' 
                            ];
                            push @shapes, [ 
                                'line', $x2 - 3, $y2 + 3, $x2, $y2, 'cadetblue' 
                            ];
                            push @shapes, [ 
                                'line', $x2 - 3, $y2 - 3, $x2 - 3, $y2 +3, 
                                'cadetblue' 
                            ];
                        }
                        else {
                            push @shapes, [ 
                                'line', $x2 + 3, $y2 - 3, $x2, $y2, 'cadetblue' 
                            ];
                            push @shapes, [ 
                                'line', $x2 + 3, $y2 + 3, $x2, $y2, 'cadetblue' 
                            ];
                            push @shapes, [ 
                                'line', $x2 + 3, $y2 - 3, $x2 + 3, $y2 +3, 
                                'cadetblue' 
                            ];
                        }
                    }

                    $done{ $fno1 }{ $fno2 } = 1;
                    $done{ $fno2 }{ $fno1 } = 1;
                }
            }
        }
    }

    #
    # Add the title, legend and signature.
    #
    my $large_font = gdLargeFont;
    my $title_len  = $large_font->width * length $title;
    push @shapes, [ 
        'string', $large_font, $max_x/2 - $title_len/2, 10, $title, 'black' 
    ];

    if ( %legend ) {
        $max_y += 5;
        push @shapes, [ 
            'string', $font, $x, $max_y - $font->height - 4, 'Legend', 'black'
        ];
        $max_y += $font->height + 4;

        my $longest;
        for my $len ( map { length $_ } values %legend ) {
            $longest = $len if $len > $longest; 
        }
        $longest += 2;

        while ( my ( $key, $shape ) = each %legend ) {
            my $space = $longest - length $shape;
            push @shapes, [ 
                'string', $font, $x, $max_y - $font->height - 4, 
                join( '', $shape, ' ' x $space, $key ), 'black'
            ];

            $max_y += $font->height + 4;
        }
    }

    my $sig     = __PACKAGE__." $VERSION";
    my $sig_len = $font->width * length $sig;
    push @shapes, [ 
        'string', $font, $max_x - $sig_len, $max_y - $font->height - 4, 
        $sig, 'black'
    ];

    #
    # Render the image.
    #
    my $gd = GD::Image->new( $max_x + 30, $max_y );
    unless ( $gd->can( $output_type ) ) {
        die "GD can't create images of type '$output_type'\n";
    }
    my %colors = map { $_->[0], $gd->colorAllocate( @{$_->[1]} ) } (
        [ white                => [ 255, 255, 255 ] ],
        [ beige                => [ 245, 245, 220 ] ],
        [ black                => [   0,   0,   0 ] ],
        [ lightblue            => [ 173, 216, 230 ] ],
        [ cadetblue            => [  95, 158, 160 ] ],
        [ lightgoldenrodyellow => [ 250, 250, 210 ] ],
        [ khaki                => [ 240, 230, 140 ] ],
        [ red                  => [ 255,   0,   0 ] ],
    );
    $gd->interlaced( 'true' );
    my $background_color = $add_color ? 'lightgoldenrodyellow' : 'white';
    $gd->fill( 0, 0, $colors{ $background_color } );
    for my $shape ( @shapes ) {
        my $method = shift @$shape;
        my $color  = pop   @$shape;
        $gd->$method( @$shape, $colors{ $color } );
    }

    #
    # Make image map.
    #
    debug("imap file = '$imap_file'");
    if ( $imap_file && @imap_coords ) {
        open my $fh, ">$imap_file" or die "Can't write '$imap_file': $!\n";
        print $fh qq[<html><body><img src="" usemap="#imap" border="0">\n].
            qq[<map name="imap">\n];
        for my $rec ( @imap_coords ) {
            my $href = shift @$rec;
            print $fh q[<area coords="].join(',', @$rec).qq[" href="$href">\n];
        } 
        print $fh qq[</body></html>];
        close $fh;
    }

    #
    # Print the image.
    #
    if ( $out_file ) {
        open my $fh, ">$out_file" or die "Can't write '$out_file': $!\n";
        print $fh $gd->$output_type;
        close $fh;
    }
    else {
        return $gd->$output_type;
    }
}

1;

=pod

=head1 AUTHOR

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

=cut
Commit	Line	Data
37503827	1	package SQL::Translator::Producer::Diagram;
	2
	3	# -------------------------------------------------------------------
e966b2b0	4	# $Id: Diagram.pm,v 1.8 2003-11-05 22:27:25 kycl4rk Exp $
37503827	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
e966b2b0	23	=head1 NAME
	24
	25	SQL::Translator::Producer::Diagram - ER diagram producer for SQL::Translator
	26
	27	=head1 SYNOPSIS
	28
	29	Use via SQL::Translator:
	30
	31	use SQL::Translator;
	32
	33	my $t = SQL::Translator->new( parser => 'MySQL', '...' );
	34	$t->translate;
	35
	36	Or use more directly:
	37
	38	use SQL::Translator;
	39	use SQL::Translator::MySQL 'parse';
	40
	41	my $t = SQL::Translator->new( filename => '...' );;
	42	parse( $t,
	43
	44
	45	=cut
	46
37503827	47	use strict;
	48	use GD;
	49	use Data::Dumper;
761fa621	50	use SQL::Translator::Schema::Constants;
37503827	51	use SQL::Translator::Utils qw(debug);
	52
	53	use vars qw[ $VERSION $DEBUG ];
e966b2b0	54	$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
37503827	55	$DEBUG = 0 unless defined $DEBUG;
	56
	57	use constant VALID_FONT_SIZE => {
	58	small => 1,
	59	medium => 1,
	60	large => 1,
	61	huge => 1,
	62	};
	63
	64	use constant VALID_IMAGE_TYPE => {
	65	png => 1,
	66	jpeg => 1,
	67	};
	68
	69	sub produce {
761fa621	70	my $t = shift;
761fa621	71	my $schema = $t->schema;
37503827	72	my $args = $t->producer_args;
37503827	73	local $DEBUG = $t->debug;
761fa621	74	debug("Schema =\n", Dumper( $schema ));
37503827	75	debug("Producer args =\n", Dumper( $args ));
37503827	76
6a20798b	77	my $out_file = $args->{'out_file'} \|\| '';
7652721a	78	my $output_type = $args->{'output_type'} \|\| 'png';
6a20798b	79	my $title = $args->{'title'} \|\| $t->filename;
	80	my $font_size = $args->{'font_size'} \|\| 'medium';
	81	my $imap_file = $args->{'imap_file'} \|\| '';
	82	my $imap_url = $args->{'imap_url'} \|\| '';
37503827	83	my $no_columns = $args->{'no_columns'};
	84	my $no_lines = $args->{'no_lines'};
	85	my $add_color = $args->{'add_color'};
	86	my $show_fk_only = $args->{'show_fk_only'};
	87	my $join_pk_only = $args->{'join_pk_only'};
	88	my $natural_join = $args->{'natural_join'} \|\| $join_pk_only;
	89	my $skip_fields = $args->{'skip_fields'};
761fa621	90	my %skip = map { s/^\s+\|\s+$//g; $_,1 } split (/,/, $skip_fields);
	91
	92	$schema->make_natural_joins(
	93	join_pk_only => $join_pk_only,
	94	skip_fields => $args->{'skip_fields'},
	95	) if $natural_join;
37503827	96
7652721a	97	die "Invalid image type '$output_type'"
7652721a	98	unless VALID_IMAGE_TYPE ->{ $output_type };
37503827	99	die "Invalid font size '$font_size'"
	100	unless VALID_FONT_SIZE->{ $font_size };
	101
	102	#
	103	# Layout the image.
	104	#
	105	my $font =
	106	$font_size eq 'small' ? gdTinyFont :
	107	$font_size eq 'medium' ? gdSmallFont :
	108	$font_size eq 'large' ? gdLargeFont : gdGiantFont;
761fa621	109	my @tables = $schema->get_tables;
761fa621	110	my $no_tables = scalar @tables;
550022e5	111	$no_columns = 0 unless $no_columns =~ /^\d+$/;
37503827	112	$no_columns \|\|= sprintf( "%.0f", sqrt( $no_tables ) + .5 );
	113	$no_columns \|\|= .5;
	114	my $no_per_col = sprintf( "%.0f", $no_tables/$no_columns + .5 );
	115
	116	my @shapes;
	117	my ( $max_x, $max_y ); # the furthest x and y used
	118	my $orig_y = 40; # used to reset y for each column
	119	my ( $x, $y ) = (30,$orig_y); # where to start
	120	my $cur_col = 1; # the current column
	121	my $no_this_col = 0; # number of tables in current column
	122	my $this_col_x = $x; # current column's x
	123	my $gutter = 30; # distance b/w columns
	124	my %nj_registry; # for locations of fields for natural joins
	125	my @fk_registry; # for locations of fields for foreign keys
	126	my %table_x; # for max x of each table
	127	my $field_no; # counter to give distinct no. to each field
761fa621	128	my %coords; # holds fields coordinates
6a20798b	129	my @imap_coords; # for making clickable image map
37503827	130	my %legend;
37503827	131
761fa621	132	for my $table ( @tables ) {
761fa621	133	my $table_name = $table->name;
37503827	134	my $top = $y;
	135	push @shapes,
	136	[ 'string', $font, $this_col_x, $y, $table_name, 'black' ];
37503827	137	$y += $font->height + 2;
	138	my $below_table_name = $y;
	139	$y += 2;
	140	my $this_max_x =
	141	$this_col_x + ($font->width * length($table_name));
	142
	143	debug("Processing table '$table_name'");
	144
761fa621	145	my @fields = $table->get_fields;
761fa621	146	debug("Fields = ", join(', ', map { $_->name } @fields));
37503827	147
	148	my ( @fld_desc, $max_name );
	149	for my $f ( @fields ) {
761fa621	150	my $name = $f->name or next;
761fa621	151	my $is_pk = $f->is_primary_key;
37503827	152
	153	#
	154	# Decide if we should skip this field.
	155	#
	156	if ( $show_fk_only ) {
761fa621	157	next unless $is_pk \|\| $f->is_foreign_key;
37503827	158	}
	159
	160	if ( $is_pk ) {
	161	$name .= ' *';
	162	$legend{'Primary key'} = '*';
	163	}
cd9ccb3e	164
cd9ccb3e	165	if ( $f->is_unique ) {
37503827	166	$name .= ' [U]';
	167	$legend{'Unique constraint'} = '[U]';
	168	}
	169
761fa621	170	my $desc = $f->data_type;
761fa621	171	$desc .= '('.$f->size.')' if $f->size;
37503827	172
	173	my $nlen = length $name;
	174	$max_name = $nlen if $nlen > $max_name;
	175	push @fld_desc, [ $name, $desc, $f->{'name'}, $is_pk ];
	176	}
	177
	178	$max_name += 4;
	179	for my $fld_desc ( @fld_desc ) {
	180	my ( $name, $desc, $orig_name, $is_pk ) = @$fld_desc;
	181	my $diff = $max_name - length $name;
	182	$name .= ' ' x $diff;
	183	$desc = $name . $desc;
	184
	185	push @shapes, [ 'string', $font, $this_col_x, $y, $desc, 'black' ];
	186	$y += $font->height + 2;
	187	my $length = $this_col_x + ( $font->width * length( $desc ) );
	188	$this_max_x = $length if $length > $this_max_x;
	189
	190	my $constraints = $table->{'fields'}{ $orig_name }{'constraints'};
	191
	192	if ( $natural_join && !$skip{ $orig_name } ) {
	193	push @{ $nj_registry{ $orig_name } }, $table_name;
	194	}
37503827	195
37503827	196	my $y_link = $y - $font->height/2;
761fa621	197	$coords{ $table_name }{ $orig_name }{'coords'} = {
37503827	198	left => [ $this_col_x - 6, $y_link ],
	199	right => [ $length + 2 , $y_link ],
	200	table => $table_name,
	201	field_no => ++$field_no,
	202	is_pk => $is_pk,
	203	fld_name => $orig_name,
	204	};
6a20798b	205
	206	push @imap_coords, [
	207	$imap_url."#$table_name-$orig_name",
	208	$this_col_x, $y - $font->height, $length, $y_link,
	209	];
37503827	210	}
37503827	211
761fa621	212	unless ( $natural_join ) {
	213	for my $c ( $table->get_constraints ) {
	214	next unless $c->type eq FOREIGN_KEY;
	215	my $fk_table = $c->reference_table or next;
	216
	217	for my $field_name ( $c->fields ) {
	218	for my $fk_field ( $c->reference_fields ) {
	219	next unless defined $schema->get_table( $fk_table );
	220	push @fk_registry, [
761fa621	221	[ $fk_table , $fk_field ],
761a28bb	222	[ $table_name, $field_name ],
761fa621	223	];
	224	}
	225	}
	226	}
	227	}
	228
37503827	229	$this_max_x += 5;
	230	$table_x{ $table_name } = $this_max_x + 5;
	231	push @shapes, [ 'line', $this_col_x - 5, $below_table_name,
	232	$this_max_x, $below_table_name, 'black' ];
	233	my @bounds = ( $this_col_x - 5, $top - 5, $this_max_x, $y + 5 );
	234	if ( $add_color ) {
	235	unshift @shapes, [
	236	'filledRectangle',
	237	$bounds[0], $bounds[1],
	238	$this_max_x, $below_table_name,
	239	'khaki'
	240	];
	241	unshift @shapes, [ 'filledRectangle', @bounds, 'white' ];
	242	}
6a20798b	243
	244	push @imap_coords, [
	245	$imap_url."#$table_name",
	246	$bounds[0], $bounds[1], $this_max_x, $below_table_name,
	247	];
	248
37503827	249	push @shapes, [ 'rectangle', @bounds, 'black' ];
	250	$max_x = $this_max_x if $this_max_x > $max_x;
	251	$y += 25;
	252
	253	if ( ++$no_this_col == $no_per_col ) {# if we've filled up this column
	254	$cur_col++; # up the column number
	255	$no_this_col = 0; # reset the number of tables
	256	$max_x += $gutter; # push the x over for next column
	257	$this_col_x = $max_x; # remember the max x for this col
	258	$max_y = $y if $y > $max_y; # note the max y
	259	$y = $orig_y; # reset the y for next column
	260	}
	261	}
	262
	263	#
	264	# Connect the lines.
	265	#
	266	my %horz_taken;
	267	my %done;
	268	unless ( $no_lines ) {
	269	my @position_bunches;
	270
	271	if ( $natural_join ) {
	272	for my $field_name ( keys %nj_registry ) {
	273	my @positions;
	274	my @table_names =
	275	@{ $nj_registry{ $field_name } \|\| [] } or next;
	276	next if scalar @table_names == 1;
	277
	278	for my $table_name ( @table_names ) {
	279	push @positions,
761fa621	280	$coords{ $table_name }{ $field_name }{'coords'};
37503827	281	}
	282
	283	push @position_bunches, [ @positions ];
	284	}
	285	}
	286	else {
	287	for my $pair ( @fk_registry ) {
	288	push @position_bunches, [
761fa621	289	$coords{$pair->[0][0]}{ $pair->[0][1] }{'coords'},
761fa621	290	$coords{$pair->[1][0]}{ $pair->[1][1] }{'coords'},
37503827	291	];
	292	}
	293	}
	294
	295	my $is_directed = $natural_join ? 0 : 1;
	296
	297	for my $bunch ( @position_bunches ) {
	298	my @positions = @$bunch;
	299
	300	for my $i ( 0 .. $#positions ) {
	301	my $pos1 = $positions[ $i ];
	302	my ( $ax, $ay ) = @{ $pos1->{'left'} \|\| [] } or next;
	303	my ( $bx, $by ) = @{ $pos1->{'right'} \|\| [] } or next;
	304	my $table1 = $pos1->{'table'};
	305	my $fno1 = $pos1->{'field_no'};
	306	my $is_pk = $pos1->{'is_pk'};
	307	next if $join_pk_only and !$is_pk;
	308
	309	for my $j ( 0 .. $#positions ) {
	310	my $pos2 = $positions[ $j ];
	311	my ( $cx, $cy ) = @{ $pos2->{'left'} \|\| [] } or next;
	312	my ( $dx, $dy ) = @{ $pos2->{'right'} \|\| [] } or next;
	313	my $table2 = $pos2->{'table'};
	314	my $fno2 = $pos2->{'field_no'};
	315	next if $table1 eq $table2;
	316	next if $done{ $fno1 }{ $fno2 };
	317	next if $fno1 == $fno2;
	318
	319	my @distances = ();
	320	push @distances, [
	321	abs ( $ax - $cx ) + abs ( $ay - $cy ),
	322	[ $ax, $ay, $cx, $cy ],
	323	[ 'left', 'left' ]
	324	];
	325	push @distances, [
	326	abs ( $ax - $dx ) + abs ( $ay - $dy ),
	327	[ $ax, $ay, $dx, $dy ],
	328	[ 'left', 'right' ],
	329	];
	330	push @distances, [
	331	abs ( $bx - $cx ) + abs ( $by - $cy ),
	332	[ $bx, $by, $cx, $cy ],
	333	[ 'right', 'left' ],
	334	];
	335	push @distances, [
	336	abs ( $bx - $dx ) + abs ( $by - $dy ),
	337	[ $bx, $by, $dx, $dy ],
	338	[ 'right', 'right' ],
	339	];
	340	@distances = sort { $a->[0] <=> $b->[0] } @distances;
	341	my $shortest = $distances[0];
	342	my ( $x1, $y1, $x2, $y2 ) = @{ $shortest->[1] };
	343	my ( $side1, $side2 ) = @{ $shortest->[2] };
	344	my ( $start, $end );
	345	my $offset = 9;
	346	my $col1_right = $table_x{ $table1 };
	347	my $col2_right = $table_x{ $table2 };
	348
	349	my $diff = 0;
	350	if ( $x1 == $x2 ) {
	351	while ( $horz_taken{ $x1 + $diff } ) {
	352	$diff = $side1 eq 'left' ? $diff - 2 : $diff + 2;
	353	}
	354	$horz_taken{ $x1 + $diff } = 1;
355	}
356
357	if ( $side1 eq 'left' ) {
358	$start = $x1 - $offset + $diff;
359	}
360	else {
361	$start = $col1_right + $diff;
362	}
363
364	if ( $side2 eq 'left' ) {
365	$end = $x2 - $offset + $diff;
366	}
367	else {
368	$end = $col2_right + $diff;
369	}
370
371	push @shapes,
372	[ 'line', $x1, $y1, $start, $y1, 'cadetblue' ];
373	push @shapes,
374	[ 'line', $start, $y1, $end, $y2, 'cadetblue' ];
375	push @shapes,
376	[ 'line', $end, $y2, $x2, $y2, 'cadetblue' ];
377
378	if ( $is_directed ) {
379	if (
380	$side1 eq 'right' && $side2 eq 'left'
381	\|\|
382	$side1 eq 'left' && $side2 eq 'left'
383	) {
384	push @shapes, [
385	'line', $x2 - 3, $y2 - 3, $x2, $y2, 'cadetblue'
386	];
387	push @shapes, [
388	'line', $x2 - 3, $y2 + 3, $x2, $y2, 'cadetblue'
389	];
390	push @shapes, [
391	'line', $x2 - 3, $y2 - 3, $x2 - 3, $y2 +3,
392	'cadetblue'
393	];
394	}
395	else {
396	push @shapes, [
397	'line', $x2 + 3, $y2 - 3, $x2, $y2, 'cadetblue'
398	];
399	push @shapes, [
400	'line', $x2 + 3, $y2 + 3, $x2, $y2, 'cadetblue'
401	];
402	push @shapes, [
403	'line', $x2 + 3, $y2 - 3, $x2 + 3, $y2 +3,
404	'cadetblue'
405	];
406	}
407	}
408
409	$done{ $fno1 }{ $fno2 } = 1;
410	$done{ $fno2 }{ $fno1 } = 1;
411	}
412	}
413	}
414	}
415
416	#
417	# Add the title, legend and signature.
418	#
419	my $large_font = gdLargeFont;
420	my $title_len = $large_font->width * length $title;
421	push @shapes, [
422	'string', $large_font, $max_x/2 - $title_len/2, 10, $title, 'black'
423	];
424
425	if ( %legend ) {
426	$max_y += 5;
427	push @shapes, [
428	'string', $font, $x, $max_y - $font->height - 4, 'Legend', 'black'
429	];
430	$max_y += $font->height + 4;
431
432	my $longest;
433	for my $len ( map { length $_ } values %legend ) {
434	$longest = $len if $len > $longest;
435	}
436	$longest += 2;
437
438	while ( my ( $key, $shape ) = each %legend ) {
439	my $space = $longest - length $shape;
440	push @shapes, [
441	'string', $font, $x, $max_y - $font->height - 4,
442	join( '', $shape, ' ' x $space, $key ), 'black'
443	];
444
445	$max_y += $font->height + 4;
446	}
447	}
448
449	my $sig = __PACKAGE__." $VERSION";
450	my $sig_len = $font->width * length $sig;
451	push @shapes, [
452	'string', $font, $max_x - $sig_len, $max_y - $font->height - 4,
453	$sig, 'black'
454	];
455
456	#
457	# Render the image.
458	#
459	my $gd = GD::Image->new( $max_x + 30, $max_y );
7652721a	460	unless ( $gd->can( $output_type ) ) {
7652721a	461	die "GD can't create images of type '$output_type'\n";
37503827	462	}
	463	my %colors = map { $_->[0], $gd->colorAllocate( @{$_->[1]} ) } (
	464	[ white => [ 255, 255, 255 ] ],
	465	[ beige => [ 245, 245, 220 ] ],
	466	[ black => [ 0, 0, 0 ] ],
	467	[ lightblue => [ 173, 216, 230 ] ],
	468	[ cadetblue => [ 95, 158, 160 ] ],
	469	[ lightgoldenrodyellow => [ 250, 250, 210 ] ],
	470	[ khaki => [ 240, 230, 140 ] ],
	471	[ red => [ 255, 0, 0 ] ],
	472	);
	473	$gd->interlaced( 'true' );
	474	my $background_color = $add_color ? 'lightgoldenrodyellow' : 'white';
	475	$gd->fill( 0, 0, $colors{ $background_color } );
	476	for my $shape ( @shapes ) {
	477	my $method = shift @$shape;
	478	my $color = pop @$shape;
	479	$gd->$method( @$shape, $colors{ $color } );
	480	}
	481
	482	#
6a20798b	483	# Make image map.
	484	#
	485	debug("imap file = '$imap_file'");
	486	if ( $imap_file && @imap_coords ) {
	487	open my $fh, ">$imap_file" or die "Can't write '$imap_file': $!\n";
	488	print $fh qq[<html><body><img src="" usemap="#imap" border="0">\n].
	489	qq[<map name="imap">\n];
	490	for my $rec ( @imap_coords ) {
	491	my $href = shift @$rec;
	492	print $fh q[<area coords="].join(',', @$rec).qq[" href="$href">\n];
	493	}
	494	print $fh qq[</body></html>];
	495	close $fh;
	496	}
	497
	498	#
37503827	499	# Print the image.
	500	#
	501	if ( $out_file ) {
	502	open my $fh, ">$out_file" or die "Can't write '$out_file': $!\n";
7652721a	503	print $fh $gd->$output_type;
37503827	504	close $fh;
	505	}
	506	else {
7652721a	507	return $gd->$output_type;
37503827	508	}
	509	}
	510
	511	1;
	512
	513	=pod
	514
37503827	515	=head1 AUTHOR
37503827	516
e966b2b0	517	Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
37503827	518
37503827	519	=cut