1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.14 2004-01-02 08:15:09 allenday Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
7 # Brian O'Connor <brian.oconnor@excite.com>.
9 # This program is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU General Public License as
11 # published by the Free Software Foundation; version 2.
13 # This program is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 # General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
22 # -------------------------------------------------------------------
25 use vars qw[ $VERSION $DEBUG ];
26 $VERSION = sprintf "%d.%02d", q$Revision: 1.14 $ =~ /(\d+)\.(\d+)/;
27 $DEBUG = 1 unless defined $DEBUG;
29 use SQL::Translator::Schema::Constants;
30 use SQL::Translator::Schema::Graph;
31 use SQL::Translator::Schema::Graph::HyperEdge;
32 use Log::Log4perl; Log::Log4perl::init('/etc/log4perl.conf');
42 # -------------------------------------------------------------------
44 my $log = Log::Log4perl->get_logger('SQL.Translator.Producer.Turnkey');
48 my $args = $t->producer_args;
49 my $no_comments = $t->no_comments;
50 my $baseclass = $args->{'main_pkg_name'} || $t->format_package_name('DBI');
51 my $graph = SQL::Translator::Schema::Graph->new(translator => $t,
52 baseclass => $baseclass
55 my $parser_type = (split /::/, $t->parser_type)[-1];
57 local $DEBUG = $t->debug;
60 format_fk => $t->format_fk_name,
61 template => $args->{'template'} || '',
62 baseclass => $baseclass,
63 db_user => $args->{'db_user'} || '',
64 db_pass => $args->{'db_pass'} || '',
65 parser => $t->parser_type,
66 producer => __PACKAGE__,
67 dsn => $args->{'dsn'} || sprintf( 'dbi:%s:_', $producer2dsn{ $parser_type }
68 ? $producer2dsn{ $parser_type }
76 foreach my $node_from ($graph->node_values){
78 next unless $node_from->table->is_data or !$node_from->table->is_trivial_link;
80 foreach my $cedge ( $node_from->compoundedges ){
82 my $hyperedge = SQL::Translator::Schema::Graph::HyperEdge->new();
85 foreach my $edge ($cedge->edges){
86 if($edge->thisnode->name eq $node_from->name){
87 $hyperedge->vianode($edge->thatnode);
89 if($edge->thatnode->name ne $cedge->via->name){
90 $node_to ||= $graph->node($edge->thatnode->table->name);
93 $hyperedge->push_thisnode($edge->thisnode);
94 $hyperedge->push_thisfield($edge->thisfield);
95 $hyperedge->push_thisviafield($edge->thatfield);
98 if($edge->thisnode->name ne $cedge->via->name){
99 $node_to ||= $graph->node($edge->thisnode->table->name);
101 $hyperedge->push_thatnode($edge->thisnode);
102 $hyperedge->push_thatfield($edge->thisfield);
103 $hyperedge->push_thatviafield($edge->thatfield);
105 $log->debug($edge->thisfield->name);
106 $log->debug($edge->thatfield->name);
109 if($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('one2one') }
110 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('many2one') }
111 elsif($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('one2many') }
112 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('many2many') }
114 $log->debug($_) foreach sort keys %::SQL::Translator::Schema::Graph::HyperEdge::;
116 #node_to won't always be defined b/c of multiple edges to a single other node
117 if(defined($node_to)){
118 $log->debug($node_from->name);
119 $log->debug($node_to->name);
121 if(scalar($hyperedge->thisnode) > 1){
122 $log->debug($hyperedge->type ." via ". $hyperedge->vianode->name);
124 foreach my $thisnode ( $hyperedge->thisnode ){
125 $log->debug($thisnode->name .' '.
126 $hyperedge->thisfield_index(0)->name .' -> '.
127 $hyperedge->thisviafield_index($i)->name .' '.
128 $hyperedge->vianode->name .' '.
129 $hyperedge->thatviafield_index(0)->name .' <- '.
130 $hyperedge->thatfield_index(0)->name .' '.
131 $hyperedge->thatnode_index(0)->name ."\n"
136 $node_from->push_hyperedges($hyperedge);
140 $meta{"nodes"} = $graph->node;
141 return(translateForm($t, \%meta));
150 #warn Dumper $meta->{nodes};
153 my $args = $t->producer_args;
154 my $type = $meta->{'template'};
156 $tt2 = template($type);
157 my $template = Template->new({
164 $template->process(\$tt2, $meta, \$result) || die $template->error();
170 # -------------------------------------------------------------------
176 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
180 Creates output for use with the Turnkey project.
184 L<http://turnkey.sourceforge.net>.
188 Allen Day E<lt>allenday@ucla.eduE<gt>
189 Brian O\'Connor E<lt>brian.oconnor@excite.comE<gt>.
196 ###########################################
197 # Here documents for the tt2 templates #
198 ###########################################
205 [% MACRO printPackage(node) BLOCK %]
206 # --------------------------------------------
208 package [% node.name %];
209 use base '[% node.base %]';
210 use Class::DBI::Pager;
212 [% node.name %]->set_up_table('[% node.table.name %]');
213 [% printPKAccessors(node.primary_key, node.table.name) %]
214 [% printHasA(node.edges, node) %]
215 [% printHasMany(node.edges, node) %]
216 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
217 [% #printHasFriendly(node) %]
222 [% MACRO printPKAccessors(array, name) BLOCK %]
224 # Primary key accessors
226 [% FOREACH item = array %]
227 sub id { shift->[% item %] }
228 sub [% name %] { shift->[% item %] }
233 [% MACRO printHasA(edges, name) BLOCK %]
238 [% FOREACH edge = edges %]
239 [% IF edge.type == 'import' %]
240 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
241 [% IF node.has(edge.thatnode.name) < 2 %]
242 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
244 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
252 [% MACRO printHasMany(edges, node) BLOCK %]
257 [% FOREACH edge = edges %]
258 [% IF edge.type == 'export' %]
259 [% node.name %]->has_many('[% edge.thatnode.table.name %]_[% edge.thatfield.name %]', '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
260 [% IF node.via(edge.thatnode.name) >= 1 %]
261 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
262 [% ELSIF edge.thatnode.table.is_data %]
263 [% IF node.edgecount(edge.thatnode.name) > 1 %]
264 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
266 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
275 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
279 [% FOREACH cedge = cedges %]
280 [% FOREACH edge = cedge.edges %]
281 [% NEXT IF edge.thisnode.name != name %]
282 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
286 [% FOREACH h = hedges %]
287 ########## [% h.type %] ##########
288 [% IF h.type == 'one2one' %]
289 sub [% h.thatnode.table.name %]s { my \$self = shift; return map \$_->[% h.thatviafield.name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
291 [% ELSIF h.type == 'one2many' %]
292 [% thisnode = h.thisnode_index(0) %]
294 [% FOREACH thatnode = h.thatnode %]
295 #[% thisnode.name %]::[% h.thisfield_index(0).name %] -> [% h.vianode.name %]::[% h.thisviafield_index(i).name %] ... [% h.vianode.name %]::[% h.thatviafield_index(0).name %] <- [% h.thatnode_index(0).name %]::[% h.thatfield_index(0).name %]
296 sub [% h.vianode.table.name %]_[% format_fk(h.vianode,h.thatviafield_index(0).name) %]s { my \$self = shift; return map \$_->[% h.thatviafield_index(0).name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield_index(i).name %] }
300 [% ELSIF h.type == 'many2one' %]
302 [% FOREACH thisnode = h.thisnode %]
303 #[% thisnode.name %]::[% h.thisfield_index(0).name %] -> [% h.vianode.name %]::[% h.thisviafield_index(i).name %] ... [% h.vianode.name %]::[% h.thatviafield_index(0).name %] <- [% h.thatnode_index(0).name %]::[% h.thatfield_index(0).name %]
304 sub [% h.vianode.table.name %]_[% format_fk(h.vianode,h.thisviafield_index(i).name) %]_[% format_fk(h.vianode,h.thatviafield_index(0).name) %]s { my \$self = shift; return map \$_->[% h.thatviafield_index(0).name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield_index(i).name %] }
309 [% ELSIF h.type == 'many2many' %]
311 [% FOREACH thisnode = h.thisnode %]
313 [% FOREACH thatnode = h.thatnode %]
314 #[% thisnode.name %]::[% h.thisfield_index(i).name %] -> [% h.vianode.name %]::[% h.thisviafield_index(i).name %] ... [% h.vianode.name %]::[% h.thatviafield_index(j).name %] <- [% h.thatnode_index(j).name %]::[% h.thatfield_index(j).name %]
315 sub [% h.vianode.table.name %]_[% format_fk(h.vianode,h.thisviafield_index(i).name) %]_[% format_fk(h.vianode,h.thatviafield_index(j).name) %]s { my \$self = shift; return map \$_->[% %], \$self->[% %] }
326 [% MACRO printHasFriendly(node) BLOCK %]
333 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
334 package [% baseclass %];
336 # Created by SQL::Translator::Producer::Turnkey
337 # Template used: classdbi
340 use base qw(Class::DBI::Pg);
342 [% baseclass %]->set_db('Main', '[% db_str %]', '[% db_user %]', '[% db_pass %]');
344 [% FOREACH node = nodes %]
345 [% printPackage(node.value) %]
351 elsif($type eq 'atom'){
354 [% ###### DOCUMENT START ###### %]
356 [% FOREACH node = nodes %]
357 [% IF !node.value.is_trivial_link %]
359 ##############################################
361 package Turnkey::Atom::[% node.value.name FILTER replace "Turnkey::Model::", "" %];
363 [% pname = node.value.name FILTER replace "Turnkey::Model::", "" %]
366 use base qw(Turnkey::Atom);
375 my $dbobject = shift;
376 # Assumption here that if it's not rendering on it's own dbobject
377 # then it's a list. This will be updated when AtomLists are implemented -boconnor
378 if(ref($dbobject) eq 'Turnkey::Model::[% pname %]') {
379 return(_render_record($dbobject));
381 else { return(_render_list($dbobject)); }
385 my $dbobject = shift;
389 [% FOREACH value = node.value.data_fields %]
391 $field_hash->{[% value %]} = $dbobject->[% value %]();
394 $row->{data} = $field_hash;
395 $row->{id} = $dbobject->id();
401 my $dbobject = shift;
403 my @objects = $dbobject->[% node.key %]s;
404 foreach my $object (@objects)
408 [% FOREACH value = node.value.data_fields %]
410 $field_hash->{[% value %]} = $object->[% value %]();
413 $row->{data} = $field_hash;
414 $row->{id} = $object->id();
429 } elsif($type eq 'xml'){
431 <?xml version="1.0" encoding="UTF-8"?>
432 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
435 <!-- The basic layout is fixed -->
436 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
437 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
438 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
439 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
443 <!-- Atom Classes -->
444 [% FOREACH node = nodes %]
445 [% IF !node.value.is_trivial_link %]
446 <atom class="Turnkey::Atom::[% node.key FILTER ucfirst %]" name="[% node.key FILTER ucfirst %]" xlink:label="[% node.key FILTER ucfirst %]Atom"/>
450 <!-- Atom Bindings -->
452 [% FOREACH focus_atom = nodes %]
453 [% IF !focus_atom.value.is_trivial_link %]
454 [% FOREACH link_atom = focus_atom.value.hyperedges %]
455 <atomatombinding xlink:from="#[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% link_atom.thatnode.table.name FILTER ucfirst %]Atom" xlink:label="[% focus_atom.key FILTER ucfirst %]Atom2[% link_atom.thatnode.table.name FILTER ucfirst %]Atom"/>
458 [% FOREACH link_atom = focus_atom.value.edges %]
459 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
460 <atomatombinding xlink:from="#[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% link_atom.thatnode.table.name FILTER ucfirst %]Atom" xlink:label="[% focus_atom.key FILTER ucfirst %]Atom2[% link_atom.thatnode.table.name FILTER ucfirst %]Atom"/>
461 [% previous = link_atom.thatnode.table.name %]
468 <atomcontainerbindings>
469 [% FOREACH focus_atom = nodes %]
470 [% IF !focus_atom.value.is_trivial_link %]
471 <atomcontainerbindingslayout xlink:label="Turnkey::Model::[% focus_atom.key FILTER ucfirst %]">
472 [% FOREACH link_atom = focus_atom.value.hyperedges %]
473 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% link_atom.thatnode.table.name FILTER ucfirst %]Atom" xlink:to="#[% link_atom.thatnode.table.name FILTER ucfirst %]Atom"/>
476 [% FOREACH link_atom = focus_atom.value.edges %]
477 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
478 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% link_atom.thatnode.table.name FILTER ucfirst %]Atom" xlink:to="#[% link_atom.thatnode.table.name FILTER ucfirst %]Atom"/>
479 [% previous = link_atom.thatnode.table.name %]
482 <atomcontainerbinding xlink:from="#MainContainer" xlink:label="MainContainer2[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% focus_atom.key FILTER ucfirst %]Atom"/>
483 </atomcontainerbindingslayout>
486 </atomcontainerbindings>
489 <uribinding uri="/" class="Turnkey::Util::Frontpage"/>
493 [% FOREACH focus_atom = nodes %]
494 [% IF !focus_atom.value.is_trivial_link %]
495 <classbinding class="Turnkey::Model::[% focus_atom.key FILTER ucfirst %]" plugin="#[% focus_atom.key FILTER ucfirst %]Atom" rank="0"/>
503 } elsif($type eq 'template'){
506 [% MACRO renderpanel(panel,dbobject) BLOCK %]
507 <!-- begin panel: [% panel.label %] -->
508 <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 %]">
510 [% FOREACH p = panel.containers %]
511 [% IF p.can_render(panel) %]
512 <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
513 [% IF p.type == 'Container' %]
514 [% renderpanel(p,dbobject) %]
516 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
518 <tr class="dbtabletitle" height="1">
519 <td class="dbtabletitle">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</td>
520 <td align="right" width="0"></td>
523 <tr><td colspan="2" class="dbtablerow">
524 <!-- begin atom: [% p.label %] -->
525 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
526 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
531 [% IF panel.orientation == 'vertical' %]
538 <!-- end panel: [% panel.label %] -->
540 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
541 [- FOREACH node = nodes -]
542 [- IF !node.value.is_trivial_link -]
543 [% CASE '[- node.key FILTER ucfirst -]' %]
544 [% render[- node.key FILTER ucfirst -]Atom(atom.render(dbobject)) %]
548 [% renderlist(atom.render(dbobject)) %]
550 [- FOREACH node = nodes -]
551 [- IF !node.value.is_trivial_link -]
552 [% MACRO render[- node.key FILTER ucfirst -]Atom(lstArr) BLOCK %]
553 [% FOREACH record = lstArr %]
554 [% fields = record.data %]
555 [- pname = node.key FILTER ucfirst -]
556 [- pkey = "Turnkey::Model::${pname}" -]
557 [- FOREACH field = node.value.data_fields -]
558 [- IF field != "1" -]
559 <tr><td class="dbfieldname">[- field -]</td><td class="dbfieldvalue">[% fields.[- field -] %]</td></tr>
563 <tr><td><a href="?id=[% id %];class=Durian::Model::[- node.key FILTER ucfirst -]">Link</a></td><td></td></tr>
568 [% MACRO renderlist(lstArr) BLOCK %]
569 [% FOREACH item = lstArr %]