1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.22 2004-02-09 23:02:17 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 SQLFairy Authors
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.
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.
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
21 # -------------------------------------------------------------------
24 use vars qw[ $VERSION $DEBUG ];
25 $VERSION = sprintf "%d.%02d", q$Revision: 1.22 $ =~ /(\d+)\.(\d+)/;
26 $DEBUG = 1 unless defined $DEBUG;
28 use SQL::Translator::Schema::Constants;
29 use SQL::Translator::Schema::Graph;
30 use SQL::Translator::Schema::Graph::HyperEdge;
31 use Log::Log4perl; Log::Log4perl::init('/etc/log4perl.conf');
41 # -------------------------------------------------------------------
43 my $log = Log::Log4perl->get_logger('SQL.Translator.Producer.Turnkey');
47 my $args = $t->producer_args;
48 my $no_comments = $t->no_comments;
49 my $baseclass = $args->{'main_pkg_name'} || $t->format_package_name('DBI');
50 my $graph = SQL::Translator::Schema::Graph->new(translator => $t,
51 baseclass => $baseclass
54 my $parser_type = (split /::/, $t->parser_type)[-1];
56 local $DEBUG = $t->debug;
59 format_fk => $t->format_fk_name,
60 format_package => $t->format_package_name,
61 format_table => $t->format_table_name,
62 template => $args->{'template'} || '',
63 baseclass => $baseclass,
64 db_dsn => $args->{'db_dsn'} || '',
65 db_user => $args->{'db_user'} || '',
66 db_pass => $args->{'db_pass'} || '',
67 db_str => $args->{'db_str'} || '',
68 parser => $t->parser_type,
69 producer => __PACKAGE__,
70 dsn => $args->{'dsn'} || sprintf( 'dbi:%s:_', $producer2dsn{ $parser_type }
71 ? $producer2dsn{ $parser_type }
79 foreach my $node_from ($graph->node_values){
81 next unless $node_from->table->is_data or !$node_from->table->is_trivial_link;
83 foreach my $cedge ( $node_from->compoundedges ){
85 my $hyperedge = SQL::Translator::Schema::Graph::HyperEdge->new();
88 foreach my $edge ($cedge->edges){
89 if($edge->thisnode->name eq $node_from->name){
90 $hyperedge->vianode($edge->thatnode);
92 if($edge->thatnode->name ne $cedge->via->name){
93 $node_to ||= $graph->node($edge->thatnode->table->name);
96 $hyperedge->push_thisnode($edge->thisnode);
97 $hyperedge->push_thisfield($edge->thisfield);
98 $hyperedge->push_thisviafield($edge->thatfield);
101 if($edge->thisnode->name ne $cedge->via->name){
102 $node_to ||= $graph->node($edge->thisnode->table->name);
104 $hyperedge->push_thatnode($edge->thisnode);
105 $hyperedge->push_thatfield($edge->thisfield);
106 $hyperedge->push_thatviafield($edge->thatfield);
108 $log->debug($edge->thisfield->name);
109 $log->debug($edge->thatfield->name);
112 if($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('one2one') }
113 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('many2one') }
114 elsif($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('one2many') }
115 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('many2many') }
117 $log->debug($_) foreach sort keys %::SQL::Translator::Schema::Graph::HyperEdge::;
119 #node_to won't always be defined b/c of multiple edges to a single other node
120 if(defined($node_to)){
121 $log->debug($node_from->name);
122 $log->debug($node_to->name);
124 if(scalar($hyperedge->thisnode) > 1){
125 $log->debug($hyperedge->type ." via ". $hyperedge->vianode->name);
127 foreach my $thisnode ( $hyperedge->thisnode ){
128 $log->debug($thisnode->name .' '.
129 $hyperedge->thisfield_index(0)->name .' -> '.
130 $hyperedge->thisviafield_index($i)->name .' '.
131 $hyperedge->vianode->name .' '.
132 $hyperedge->thatviafield_index(0)->name .' <- '.
133 $hyperedge->thatfield_index(0)->name .' '.
134 $hyperedge->thatnode_index(0)->name ."\n"
139 $node_from->push_hyperedges($hyperedge);
143 $meta{"nodes"} = $graph->node;
144 return(translateForm($t, \%meta));
153 #warn Dumper $meta->{nodes};
156 my $args = $t->producer_args;
157 my $type = $meta->{'template'};
159 $tt2 = template($type);
160 my $template = Template->new({
167 $template->process(\$tt2, $meta, \$result) || die $template->error();
173 # -------------------------------------------------------------------
179 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
183 Creates output for use with the Turnkey project.
187 L<http://turnkey.sourceforge.net>.
191 Allen Day E<lt>allenday@ucla.eduE<gt>
192 Brian O\'Connor E<lt>brian.oconnor@excite.comE<gt>.
199 ###########################################
200 # Here documents for the tt2 templates #
201 ###########################################
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_dsn %]', '[% db_user %]', '[% db_pass %]', {AutoCommit=>1});
343 sub search_ilike { shift->_do_search(ILIKE => [% "\@\_" %] ) }
346 [% FOREACH node = nodes %]
347 [% printPackage(node.value) %]
353 elsif($type eq 'atom'){
356 [% ###### DOCUMENT START ###### %]
358 [% FOREACH node = nodes %]
359 [% IF !node.value.is_trivial_link %]
361 ##############################################
363 package Turnkey::Atom::[% node.value.name FILTER replace "Turnkey::Model::", "" %];
365 [% pname = node.value.name FILTER replace "Turnkey::Model::", "" %]
367 use base qw(Turnkey::Atom);
376 my $dbobject = shift;
378 # Assumption here that if it's not rendering on it's own dbobject
379 # then it's a list. This will be updated when AtomLists are implemented -boconnor
380 if(ref($dbobject) eq 'Turnkey::Model::[% pname %]') {
382 return(_render_record($dbobject));
384 else { return(_render_list($dbobject)); }
388 my $dbobject = shift;
394 [% FOREACH value = node.value.data_fields %]
396 $field_hash->{[% value %]} = $dbobject->[% value %]();
401 [% FOREACH value = node.value.edges %]
402 [% NEXT IF value.type != 'import' %]
403 $field_hash->{[% value.thisfield.name %]} = $dbobject->[% value.thisfield.name %]();
406 $row->{data} = $field_hash;
407 $row->{id} = $dbobject->id();
413 my $dbobject = shift;
415 my @objects = $dbobject->[% node.key %]s;
416 foreach my $object (@objects){
421 [% FOREACH value = node.value.data_fields %]
423 $field_hash->{[% value %]} = $object->[% value %]();
428 [% FOREACH value = node.value.edges %]
429 [% NEXT IF value.type != 'import' %]
430 $field_hash->{[% value.thisfield.name %]} = $object->[% value.thisfield.name %]();
433 $row->{data} = $field_hash;
434 $row->{id} = $object->id();
449 } elsif($type eq 'xml'){
451 <?xml version="1.0" encoding="UTF-8"?>
452 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
455 <!-- The basic layout is fixed -->
456 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
457 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
458 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
459 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
463 <!-- Atom Classes -->
464 [% FOREACH node = nodes %]
465 [% IF !node.value.is_trivial_link %]
466 <atom class="Turnkey::Atom::[% format_table(node.key) %]" name="[% format_table(node.key) %]" xlink:label="[% format_table(node.key) %]Atom"/>
470 <!-- Atom Bindings -->
472 [% FOREACH focus_atom = nodes %]
473 [% IF !focus_atom.value.is_trivial_link %]
474 [% FOREACH link_atom = focus_atom.value.hyperedges %]
475 <atomatombinding xlink:from="#[% format_table(focus_atom.key) %]Atom" xlink:to="#[% format_table(link_atom.thatnode.table.name) %]Atom" xlink:label="[% format_table(focus_atom.key) %]Atom2[% format_table(link_atom.thatnode.table.name) %]Atom"/>
478 [% FOREACH link_atom = focus_atom.value.edges %]
479 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
480 <atomatombinding xlink:from="#[% format_table(focus_atom.key) %]Atom" xlink:to="#[% format_table(link_atom.thatnode.table.name) %]Atom" xlink:label="[% format_table(focus_atom.key) %]Atom2[% format_table(link_atom.thatnode.table.name) %]Atom"/>
481 [% previous = link_atom.thatnode.table.name %]
488 <atomcontainerbindings>
489 [% FOREACH focus_atom = nodes %]
490 [% IF !focus_atom.value.is_trivial_link %]
491 <atomcontainerbindingslayout xlink:label="Turnkey::Model::[% format_table(focus_atom.key) %]">
492 [% FOREACH link_atom = focus_atom.value.hyperedges %]
493 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" xlink:to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
496 [% FOREACH link_atom = focus_atom.value.edges %]
497 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
498 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" xlink:to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
499 [% previous = link_atom.thatnode.table.name %]
502 <atomcontainerbinding xlink:from="#MainContainer" xlink:label="MainContainer2[% format_table(focus_atom.key) %]Atom" xlink:to="#[% format_table(focus_atom.key) %]Atom"/>
503 </atomcontainerbindingslayout>
506 </atomcontainerbindings>
509 <uribinding uri="/" class="Turnkey::Util::Frontpage"/>
513 [% FOREACH focus_atom = nodes %]
514 [% IF !focus_atom.value.is_trivial_link %]
515 <classbinding class="Turnkey::Model::[% format_table(focus_atom.key) %]" plugin="#[% format_table(focus_atom.key) %]Atom" rank="0"/>
523 } elsif($type eq 'template'){
526 [% MACRO renderpanel(panel,dbobject) BLOCK %]
527 <!-- begin panel: [% panel.label %] -->
528 <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 %]">
530 [% FOREACH p = panel.containers %]
531 [% IF p.can_render(panel) %]
532 <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
533 [% IF p.type == 'Container' %]
534 [% renderpanel(p,dbobject) %]
536 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
538 <tr class="dbtabletitle" height="1">
539 <td class="dbtabletitle">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</td>
540 <td align="right" width="0"></td>
543 <tr><td colspan="2" class="dbtablerow">
544 <!-- begin atom: [% p.label %] -->
545 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
546 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
551 [% IF panel.orientation == 'vertical' %]
558 <!-- end panel: [% panel.label %] -->
560 [% BLOCK make_linked_dbobject %]
562 $stash->set(linked_dbobject => [% class %]->retrieve([% id %]));
565 [% MACRO obj2link(obj) SWITCH ref(obj) %]
570 <a href="[% obj2url(obj) %]">[% obj.name %]</a>
572 <a href="[% obj2url(obj) %]">[% obj %]</a>
575 [% MACRO obj2url(obj) SWITCH obj %]
577 /?id=[% obj %];class=[% ref(obj) %]
579 [% MACRO obj2desc(obj) SWITCH ref(obj) %]
589 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
590 [- FOREACH node = nodes -]
591 [- IF !node.value.is_trivial_link -]
592 [% CASE '[- format_table(node.key) -]' %]
593 [% render[- format_table(node.key) -]Atom(atom,dbobject) %]
597 [% renderlist(atom.render(dbobject)) %]
599 [- FOREACH node = nodes -]
600 [- IF !node.value.is_trivial_link -]
601 [% MACRO render[- format_table(node.key) -]Atom(atom, dbobject) BLOCK %]
602 [% lstArr = atom.render(dbobject) %]
604 [% IF atom.focus == "yes" %]
605 [% FOREACH record = lstArr %]
606 [% fields = record.data %]
607 [- pname = format_table(node.key) -]
608 [- pkey = "Turnkey::Model::${pname}" -]
609 [- FOREACH field = node.value.data_fields -]
610 [- IF field != "1" -]
611 <tr><td class="dbfieldname">[- field -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field -]) %]</td></tr>
614 [- FOREACH field = node.value.edges -]
615 [- NEXT IF field.type != 'import' -]
616 <tr><td class="dbfieldname">[- field.thisfield.name -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.thisfield.name -]) %]</td></tr>
619 [% IF (rowcount > 1) %] <tr><td colspan="2"><hr></td></tr> [% END %]
620 [% rowcount = rowcount + 1 %]
624 [% FOREACH record = lstArr %]
625 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
627 [% PROCESS make_linked_dbobject %]
628 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>
635 [% MACRO renderlist(lstArr) BLOCK %]
637 [% FOREACH item = lstArr %]
638 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
640 [% PROCESS make_linked_dbobject %]
641 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>