1 package Turnkey::Package;
4 use Class::MakeMethods::Template::Hash (
6 'array' => [ qw( many ) ],
7 hash_of_arrays => [ qw( one2one one2many many2one many2many) ],
8 scalar => [ qw( base name order primary_key primary_key_accessor table) ],
12 # get_set => [ qw(order base name table primary_key primary_key_accessor) ],
13 # new_with_init => 'new',
21 package SQL::Translator::Producer::Turnkey;
23 # -------------------------------------------------------------------
24 # $Id: Turnkey.pm,v 1.5 2003-08-29 14:52:56 kycl4rk Exp $
25 # -------------------------------------------------------------------
26 # Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
27 # Brian O'Connor <boconnor@ucla.edu>,
28 # Ying Zhang <zyolive@yahoo.com>
30 # This program is free software; you can redistribute it and/or
31 # modify it under the terms of the GNU General Public License as
32 # published by the Free Software Foundation; version 2.
34 # This program is distributed in the hope that it will be useful, but
35 # WITHOUT ANY WARRANTY; without even the implied warranty of
36 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
37 # General Public License for more details.
39 # You should have received a copy of the GNU General Public License
40 # along with this program; if not, write to the Free Software
41 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
43 # -------------------------------------------------------------------
46 use vars qw[ $VERSION $DEBUG ];
47 $VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
48 $DEBUG = 1 unless defined $DEBUG;
50 use SQL::Translator::Schema::Constants;
51 use SQL::Translator::Utils qw(header_comment);
55 my %CDBI_auto_pkgs = (
61 # -------------------------------------------------------------------
65 local $DEBUG = $t->debug;
66 my $no_comments = $t->no_comments;
67 my $schema = $t->schema;
68 my $args = $t->producer_args;
69 my $db_user = $args->{'db_user'} || '';
70 my $db_pass = $args->{'db_pass'} || '';
71 my $main_pkg_name = $args->{'main_pkg_name'} ||
72 $t->format_package_name('DBI');
73 my $header = header_comment(__PACKAGE__, "# ");
74 my $parser_type = ( split /::/, $t->parser_type )[-1];
75 my $from = $CDBI_auto_pkgs{ $parser_type } || '';
76 my $dsn = $args->{'dsn'} || sprintf( 'dbi:%s:_',
77 $CDBI_auto_pkgs{ $parser_type }
78 ? $CDBI_auto_pkgs{ $parser_type } : $parser_type
80 my $sep = '# ' . '-' x 67;
83 # Identify "link tables" (have only PK and FK fields).
91 # build package objects
93 foreach my $table ($schema->get_tables){
94 die __PACKAGE__." table ".$table->name." doesn't have a primary key!" unless $table->primary_key;
95 die __PACKAGE__." table ".$table->name." can't have a composite primary key!" if ($table->primary_key->fields)[1];
98 my $package = Turnkey::Package->new();
99 $packages{ $table->name } = $package;
101 $package->order( ++$order );
102 $package->name( $t->format_package_name($table->name) );
103 $package->base( $main_pkg_name );
104 $package->table( $table );
105 $package->primary_key( ($table->primary_key->fields)[0] );
106 # Primary key may have a differenct accessor method name
107 $package->primary_key_accessor(
108 defined($t->format_pk_name) ? $t->format_pk_name->( $package->name, $package->primary_key )
112 foreach my $field ($table->get_fields){
113 next unless $field->is_foreign_key;
115 $package->push_many( $field->foreign_key_reference->reference_table );
120 # identify FK relationships
122 foreach my $maylink ( $schema->get_tables ){
123 foreach my $left ($schema->get_tables){
124 foreach my $right ($schema->get_tables){
126 next if $left->name eq $right->name;
128 my $lpackage = $packages{$left->name};
129 my $rpackage = $packages{$right->name};
131 my($link,$lconstraints,$rconstraints) = @{ $maylink->can_link($left,$right) };
132 warn $left->name, "\t", $maylink->name, "\t", $right->name if $link ne '0';
135 if( $link eq 'one2one'){
137 $lpackage->one2one_push($rpackage->name, [$rpackage, $maylink]);
138 $rpackage->one2one_push($lpackage->name, [$lpackage, $maylink]);
141 } elsif( $link eq 'one2many'){
143 $lpackage->one2many_push($rpackage->name, [$rpackage, $maylink]);
144 $rpackage->many2one_push($lpackage->name, [$lpackage, $maylink]);
147 } elsif( $link eq 'many2one'){
149 $lpackage->many2one_push($rpackage->name, [$rpackage, $maylink]);
150 $rpackage->one2many_push($lpackage->name, [$lpackage, $maylink]);
153 } elsif( $link eq 'many2many'){
157 $lpackage->many2many_push($rpackage->name, [$rpackage, $maylink]);
158 $rpackage->many2many_push($lpackage->name, [$lpackage, $maylink]);
170 foreach my $package_from (values %packages){
171 next unless $package_from->table->is_data;
175 my %o2o = $package_from->one2one;
177 my %o2m = $package_from->one2many;
179 my %m2o = $package_from->many2one;
181 my %m2m = $package_from->many2many;
184 foreach my $package_to (keys %{ $package_from->one2one }){
185 $package_to = $packages{$package_to};
186 foreach my $bridge ( $package_from->one2one($package_to->name) ){
187 $bridge->[3] = $t->format_fk_name ? $t->format_fk_name->(
188 $package_from->one2one($package_to->name)->[1]->name,
189 $package_to->primary_key
191 : $package_from->one2one($package_to->name)->[1]->name .'_'.
192 $package_to->primary_key .'s';
196 foreach my $package_to (keys %{ $package_from->one2many }){
197 $package_to = $packages{$package_to};
198 foreach my $bridge ( $package_from->one2many($package_to->name) ){
199 $bridge->[3] = $t->format_fk_name ? $t->format_fk_name->(
200 $package_from->one2many($package_to->name)->[1]->name,
201 $package_to->primary_key
203 : $package_from->one2many($package_to->name)->[1]->name .'_'.
204 $package_to->primary_key .'s';
208 foreach my $package_to (keys %{ $package_from->many2one }){
209 $package_to = $packages{$package_to};
210 foreach my $bridge ( $package_from->many2one($package_to->name) ){
211 $bridge->[3] = $t->format_fk_name ? $t->format_fk_name->(
212 $package_from->many2one($package_to->name)->[1]->name,
213 $package_to->primary_key
215 : $package_from->many2one($package_to->name)->[1]->name .'_'.
216 $package_to->primary_key .'s';
220 foreach my $package_to (keys %{ $package_from->many2many }){
221 $package_to = $packages{$package_to};
222 foreach my $bridge ( $package_from->many2many($package_to->name) ){
223 $bridge->[3] = $t->format_fk_name ? $t->format_fk_name->(
224 $package_from->many2many($package_to->name)->[1]->name,
225 $package_to->primary_key
227 : $package_from->many2many($package_to->name)->[1]->name .'_'.
228 $package_to->primary_key .'s';
235 # #if one possible traversal via link table
236 # if (scalar(@rk_fields) == 1 and scalar(@lk_fields) == 1) {
237 # foreach my $rk_field (@rk_fields) {
238 # push @{ $packages{ $package->name }{'has_many'}{$link}{'link_one_one'} },
239 # "sub ".$linkmethodname." { my \$self = shift; ".
240 # "return map \$_->".
241 # ($schema->get_table($link)->primary_key->fields)[0].
242 # ", \$self->".$linkable{$table_from->name}{$link}->name.
243 # "_".$rk_field." }\n\n";
245 # #NOTE: we need to rethink the link method name, as the cardinality
246 # #has shifted on us.
247 # } elsif (scalar(@rk_fields) == 1) {
248 # foreach my $rk_field (@rk_fields) {
249 # # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
250 # push @{ $packages{ $package->name }{'has_many'}{ $link }{'link_many_one'} },
251 # "sub " . $linkable{$table_from->name}{$link}->name .
252 # "s { my \$self = shift; return \$self->" .
253 # $linkable{$table_from->name}{$link}->name . "_" .
254 # $rk_field . "(\@_) }\n\n";
256 # } elsif (scalar(@lk_fields) == 1) {
257 # #these will be taken care of on the other end...
259 # #many many many. need multiple iterations here, data structure revision
260 # #to handle N FK sources. This code has not been tested and likely doesn't
262 # foreach my $rk_field (@rk_fields) {
263 # # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
264 # push @{ $packages{ $package->name }{'has_many'}{ $link }{'link_many_many'} },
265 # "sub " . $linkable{$table_from->name}{$link}->name . "_" . $rk_field .
266 # "s { my \$self = shift; return \$self->" .
267 # $linkable{$table_from->name}{$link}->name . "_" .
268 # $rk_field . "(\@_) }\n\n";
275 # # Use foreign keys to set up "has_a/has_many" relationships.
277 # foreach my $field ( $table_from->get_fields ) {
278 # if ( $field->is_foreign_key ) {
279 # my $table_name = $table_from->name;
280 # my $field_name = $field->name;
281 # my $fk_method = $t->format_fk_name($table_name, $field_name);
282 # my $fk = $field->foreign_key_reference;
283 # my $ref_table = $fk->reference_table;
284 # my $ref_pkg = $t->format_package_name($ref_table);
285 # my $ref_field = ($fk->reference_fields)[0];
287 # push @{ $packages{ $package->name }{'has_a'} },
288 # $package->name."->has_a( $field_name => '$ref_pkg');\n".
289 # "sub $fk_method { return shift->$field_name }\n\n"
294 # # If this table "has a" to the other, then it follows
295 # # that the other table "has many" of this one, right?
297 # # No... there is the possibility of 1-1 cardinality
299 # #if there weren't M-M relationships via the has_many
300 # #being set up here, create nice pluralized method alias
301 # #rather for user as alt. to ugly tablename_fieldname name
302 # if(! $packages{ $ref_pkg }{ 'has_many' }{ $table_from->name } ){
303 # # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
304 # #push @{ $packages{ $ref_pkg }{'has_many'}{ $table_name } },
305 # # "sub $table_name\s {\n return shift->$table_name\_$field_name\n}\n\n";
306 # push @{ $packages{ $ref_pkg }{'has_many'}{ $table_from->name }{'fk_pluralized'} },
307 # { table_name => $table_from->name, field_name => $field_name };
313 # #push @{ $packages{ $ref_pkg }{'has_many'}{ $table_name } },
314 # # "$ref_pkg->has_many(\n '${table_name}_${field_name}', ".
315 # # "'$table_pkg_name' => '$field_name'\n);\n\n";
316 # push @{ $packages{ $ref_pkg }{'has_many'}{ $table_name }{pluralized} },
317 # { ref_pkg => $ref_pkg, table_pkg_name => $package->name, table_name => $table_from->name, field_name => $field_name };
323 $metadata{"packages"} = \%packages;
324 $metadata{"linkable"} = \%linkable;
325 return(translateForm($t, \%metadata));
328 ###########################################
329 # Here documents for the tt2 templates #
330 ###########################################
332 my $turnkey_atom_tt2 = <<'EOF';
333 [% ###### DOCUMENT START ###### %]
335 [% FOREACH package = linkable %]
337 ##############################################
339 package Durian::Atom::[% package.key FILTER ucfirst %];
341 [% pname = package.key FILTER ucfirst%]
342 [% pkey = "Durian::Model::${pname}" %]
344 use base qw(Durian::Atom);
353 my $dbobject = shift;
354 # Assumption here that if it's not rendering on it's own dbobject
355 # then it's a list. This will be updated when AtomLists are implemented -boconnor
356 if(ref($dbobject) eq 'Durian::Model::[% package.key FILTER ucfirst %]') {
357 return(_render_record($dbobject));
359 else { return(_render_list($dbobject)); }
363 my $dbobject = shift;
367 [% FOREACH field = packages.$pkey.columns_essential %]
368 $field_hash->{[% field %]} = $dbobject->[% field %]();
370 $row->{data} = $field_hash;
371 $row->{id} = $dbobject->id();
377 my $dbobject = shift;
379 my @objects = $dbobject->[% package.key %]s;
380 foreach my $object (@objects)
384 [% FOREACH field = packages.$pkey.columns_essential %]
385 $field_hash->{[% field %]} = $object->[% field %]();
387 $row->{data} = $field_hash;
388 $row->{id} = $object->id();
403 my $turnkey_dbi_tt2 = <<EOF;
404 [% ####### MACRO START ###### %]
406 [% MACRO printPackage(package) BLOCK %]
407 # --------------------------------------------
408 package [% package.pkg_name %];
409 use base '[% package.base %]';
410 use Class::DBI::Pager;
412 [% package.pkg_name %]->set_up_table('[% package.table %]');
413 [% package.pkg_name %]->columns(Primary => qw/[% printList(package.columns_primary) %]/);
414 [% package.pkg_name %]->columns(Essential => qw/[% printList(package.columns_essential) %]/);
416 [% printPKAccessors(package.columns_primary, package.table) %]
417 [% printHasMany(package.has_many, package.table) %]
418 [% printHasA(package.has_a, package.pkg_name) %]
422 [% MACRO printPKAccessors(array, name) BLOCK %]
424 # Primary key accessor
426 [% FOREACH item = array %]
433 [% MACRO printHasMany(hash, name) BLOCK %]
437 [% FOREACH group = hash %][% FOREACH item = group.value %][% FOREACH arr = item.value %]
438 # Key: [% group.key %]
439 # Relationship: [% item.key %]
440 [% IF item.key == 'fk_pluralized' %]
441 sub [% arr.table_name -%]s {
442 return shift->[% arr.table_name %]_[% arr.field_name %]
444 [% ELSIF item.key == 'pluralized' %]
445 [% arr.ref_pkg %]->has_many('[% arr.table_name %]_[% arr.field_name %]', '[% arr.table_pkg_name %]' => '[% arr.field_name %]');
446 [% ELSIF item.key == 'link_one_one' %]
447 [% FOREACH line = item.value %]
450 [% ELSIF item.key == 'link_many_one' %]
451 [% FOREACH line = item.value %]
454 [% ELSIF item.key == 'link_many_many' %]
455 [% FOREACH line = item.value %]
460 [% END %][% END %][% END %][% END %]
462 [% MACRO printHasA(hash, pkg_name) BLOCK %]
467 [% FOREACH item = hash %][% item %]
470 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
473 [% ###### DOCUMENT START ###### %]
475 package Durian::Model::DBI;
477 # Created by SQL::Translator::Producer::ClassDBI
478 # Template used AutoDBI.tt2
481 use base qw(Class::DBI::Pg);
483 Durian::Model::DBI->set_db('Main', '[% db_str %]', '[% db_user %]', '[% db_pass %]');
485 [% FOREACH package = packages %]
486 [% printPackage(package.value) %]
490 my $turnkey_xml_tt2 = <<EOF;
491 <?xml version="1.0" encoding="UTF-8"?>
492 <!DOCTYPE Durian SYSTEM "Durian.dtd">
495 <!-- The basic layout is fixed -->
496 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
497 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
498 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
499 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
503 <!-- Atom Classes -->
504 [% FOREACH package = linkable %]
505 <atom class="Durian::Atom::[% package.key FILTER ucfirst %]" name="[% package.key FILTER ucfirst %]" xlink:label="[% package.key FILTER ucfirst %]Atom"/>
508 <!-- Atom Bindings -->
510 [% FOREACH focus_atom = linkable %]
511 [% FOREACH link_atom = focus_atom.value %]
512 <atomatombinding xlink:from="#[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% link_atom.key FILTER ucfirst %]Atom" xlink:label="[% focus_atom.key FILTER ucfirst %]Atom2[% link_atom.key FILTER ucfirst %]Atom"/>
517 <atomcontainerbindings>
518 [% FOREACH focus_atom = linkable %]
519 <atomcontainerbindingslayout xlink:label="Durian::Model::[% focus_atom.key FILTER ucfirst %]">
520 [% FOREACH link_atom = focus_atom.value %]
521 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% link_atom.key FILTER ucfirst %]Atom" xlink:to="#[% link_atom.key FILTER ucfirst %]Atom"/>
523 <atomcontainerbinding xlink:from="#MainContainer" xlink:label="MainContainer2[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% focus_atom.key FILTER ucfirst %]Atom"/>
524 </atomcontainerbindingslayout>
526 </atomcontainerbindings>
529 <uribinding uri="/" class="Durian::Util::Frontpage"/>
533 [% FOREACH focus_atom = linkable %]
534 <classbinding class="Durian::Model::[% focus_atom.key FILTER ucfirst %]" plugin="#[% focus_atom.key FILTER ucfirst %]Atom" rank="0"/>
542 my $turnkey_template_tt2 = <<'EOF';
544 [% MACRO renderpanel(panel,dbobject) BLOCK %]
545 <!-- begin panel: [% panel.label %] -->
546 <table border="0" width="[% panel.width %]" height="[% panel.height %]" bgcolor="[% panel.bgcolor %]" valign="top" cellpadding="[% panel.cellpadding %]" cellspacing="[% panel.cellspacing %]" align="[% panel.align %]" valign="[% panel.valign %]">
548 [% FOREACH p = panel.containers %]
549 [% IF p.can_render(panel) %]
550 <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
551 [% IF p.type == 'Container' %]
552 [% renderpanel(p,dbobject) %]
554 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
556 <tr bgcolor="#4444FF" height="1">
557 <td><font color="#FFFFFF">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</font></td>
558 <td align="right" width="0"><!--<nobr><img src="/images/v.gif"/><img src="/images/^.gif"/>[% IF p.delible == 'yes' %]<img src="/images/x.gif"/>[% END %]</nobr>--></td>
561 <tr><td colspan="2" bgcolor="#FFFFFF">
562 <!-- begin atom: [% p.label %] -->
563 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
564 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
569 [% IF panel.orientation == 'vertical' %]
576 <!-- end panel: [% panel.label %] -->
578 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
579 [- FOREACH package = linkable -]
580 [% CASE '[- package.key FILTER ucfirst -]' %]
581 [% render[- package.key FILTER ucfirst -]Atom(atom.render(dbobject)) %]
584 [% renderlist(atom.render(dbobject)) %]
586 [- FOREACH package = linkable -]
587 [% MACRO render[- package.key FILTER ucfirst -]Atom(lstArr) BLOCK %]
588 [% FOREACH record = lstArr %]
589 [% fields = record.data %]
590 [- pname = package.key FILTER ucfirst -]
591 [- pkey = "Durian::Model::${pname}" -]
592 [- FOREACH field = packages.$pkey.columns_essential -]
593 <tr><td><b>[- field -]</b></td><td>[% fields.[- field -] %]</td></tr>
596 <tr><td><a href="?id=[% id %];class=Durian::Model::[- package.key FILTER ucfirst -]">Link</a></td><td></td></tr>
600 [% MACRO renderlist(lstArr) BLOCK %]
601 [% FOREACH item = lstArr %]
611 my $args = $t->producer_args;
612 my $tt2 = $args->{'template'};
615 if ($tt2 eq 'atom') { $tt2Ref = \$turnkey_atom_tt2; }
616 elsif ($tt2 eq 'classdbi') { $tt2Ref = \$turnkey_dbi_tt2; }
617 elsif ($tt2 eq 'xml') { $tt2Ref = \$turnkey_xml_tt2; }
618 elsif ($tt2 eq 'template') { $tt2Ref = \$turnkey_template_tt2; }
619 else { die __PACKAGE__." didn't recognize your template option: $tt2" }
622 packages => $output->{packages},
623 linkable => $output->{linkable},
624 linktable => $output->{linktable},
625 db_str => $args->{db_str},
626 db_user => $args->{db_user},
627 db_pass => $args->{db_pass},
630 EVAL_PERL => 1, # evaluate Perl code blocks
633 # create Template object
634 my $template = Template->new($config);
637 # specify input filename, or file handle, text reference, etc.
638 # process input template, substituting variables
639 $template->process($tt2Ref, $vars, \$result) || die $template->error();
645 # -------------------------------------------------------------------
651 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
655 Creates output for use with the Turnkey project.
659 L<http://turnkey.sourceforge.net>.
663 Allen Day E<lt>allenday@ucla.eduE<gt>
664 Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
665 Brian O'Connor E<lt>brian.oconnor@excite.comE<gt>.