1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.37 2004-04-07 19:21:27 allenday 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.37 $ =~ /(\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));
151 my $args = $t->producer_args;
152 my $type = $meta->{'template'};
154 my $template = Template->new({
161 $tt2 = template($type);
164 if($type eq 'atomtemplate'){
166 foreach my $node (values %{ $meta->{'nodes'} }){
168 my $param = { node => $node };
169 $template->process(\$tt2, $param, \$result) || die $template->error();
170 $result =~ s/^\s*(.+)\s*$/$1/s;
172 $result{$node->table->name} = $result;
176 $template->process(\$tt2, $meta, \$result) || die $template->error();
184 # -------------------------------------------------------------------
190 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
194 Creates output for use with the Turnkey project.
198 L<http://turnkey.sourceforge.net>.
202 Allen Day E<lt>allenday@ucla.eduE<gt>
203 Brian O\'Connor E<lt>brian.oconnor@excite.comE<gt>.
210 ###########################################
211 # Here documents for the tt2 templates #
212 ###########################################
216 [% MACRO printPackage(node) BLOCK %]
217 # --------------------------------------------
219 package [% node.name %];
220 use base '[% node.base %]';
221 use Class::DBI::Pager;
223 [% node.name %]->set_up_table('[% node.table.name %]');
224 [% printPKAccessors(node.primary_key, node.table.name) %]
225 [% printHasA(node.edges, node) %]
226 [% printHasMany(node.edges, node) %]
227 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
228 [% #printHasFriendly(node) %]
230 [% MACRO printPKAccessors(array, name) BLOCK %]
232 # Primary key accessors
235 [% FOREACH item = array %]
236 [% IF item != "id" %]sub id { shift->[% item %] }[% END %]
237 [% IF item != name %]sub [% name %] { shift->[% item %] }[% END %]
241 [% MACRO printHasA(edges, name) BLOCK %]
242 [% FOREACH edge = edges %]
243 [% IF loop.first() %]
249 [% IF edge.type == 'import' %]
250 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
251 [% IF node.has(edge.thatnode.name) < 2 %]
252 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
254 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
261 [% MACRO printHasMany(edges, node) BLOCK %]
262 [% FOREACH edge = edges %]
263 [% IF loop.first() %]
269 [% IF edge.type == 'export' %]
270 [% node.name %]->has_many('[% edge.thatnode.table.name %]_[% edge.thatfield.name %]', '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
271 [% IF node.via(edge.thatnode.name) >= 1 %]
272 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
273 [% ELSIF edge.thatnode.table.is_data %]
274 [% IF node.edgecount(edge.thatnode.name) > 1 %]
275 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
277 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
285 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
286 [% FOREACH cedge = cedges %]
287 [% IF loop.first() %]
292 [% FOREACH edge = cedge.edges %]
293 [% NEXT IF edge.thisnode.name != name %]
294 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
299 [% FOREACH h = hedges %]
300 [% NEXT UNLESS h.type == 'one2one' %]
301 [% IF seen == 0 ; seen = 1 %]########## one2one ###########[% END %]
302 sub [% h.thatnode.table.name %]s { my \$self = shift; return map \$_->[% h.thatviafield.name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
306 [% FOREACH h = hedges %]
307 [% NEXT UNLESS h.type == 'one2many' %]
308 [% IF seen == 0 ; seen = 1 %]########## one2many ##########[% END %]
309 [% thisnode = h.thisnode_index(0) %]
311 [% FOREACH thatnode = h.thatnode %]
312 [% NEXT UNLESS h.thisviafield_index(i).name %]
313 #[% 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 %]
314 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 %] }
320 [% FOREACH h = hedges %]
321 [% NEXT UNLESS h.type == 'many2one' %]
322 [% IF seen == 0 ; seen = 1 %]########## many2one ##########[% END %]
324 [% FOREACH thisnode = h.thisnode %]
325 #[% 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 %]
326 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 %] }
332 [% FOREACH h = hedges %]
333 [% NEXT UNLESS h.type == 'many2many' %]
334 [% IF seen == 0 ; seen = 1 %]########## many2many #########[% END %]
336 [% FOREACH thisnode = h.thisnode %]
338 [% FOREACH thatnode = h.thatnode %]
339 #[% 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 %]
340 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->[% %] }
348 [% MACRO printHasFriendly(node) BLOCK %]
352 #FIXME, why aren't these being generated?
355 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
356 package [% baseclass %];
358 # Created by SQL::Translator::Producer::Turnkey
359 # Template used: classdbi
362 no warnings 'redefine';
363 use base qw(Class::DBI::Pg);
365 [% baseclass %]->set_db('Main', '[% db_dsn %]', '[% db_user %]', '[% db_pass %]', {AutoCommit=>1});
366 sub search_ilike { shift->_do_search(ILIKE => [% "\@\_" %] ) }
369 [% FOREACH node = nodes %]
370 [% printPackage(node.value) %]
376 elsif($type eq 'atom'){
379 [% ###### DOCUMENT START ###### %]
381 [% FOREACH node = nodes %]
382 [% IF !node.value.is_trivial_link %]
384 ##############################################
386 package Turnkey::Atom::[% node.value.name FILTER replace "Turnkey::Model::", "" %];
388 [% pname = node.value.name FILTER replace "Turnkey::Model::", "" %]
390 use base qw(Turnkey::Atom);
399 my $dbobject = shift;
401 # Assumption here that if it's not rendering on it's own dbobject
402 # then it's a list. This will be updated when AtomLists are implemented -boconnor
403 if(ref($dbobject) eq 'Turnkey::Model::[% pname %]') {
405 return(_render_record($dbobject));
407 else { return(_render_list($dbobject)); }
411 my $dbobject = shift;
417 [% FOREACH value = node.value.data_fields %]
419 $field_hash->{[% value %]} = $dbobject->[% value %]();
424 [% FOREACH value = node.value.edges %]
425 [% NEXT IF value.type != 'import' %]
426 $field_hash->{[% value.thisfield.name %]} = $dbobject->[% value.thisfield.name %]();
429 $row->{data} = $field_hash;
430 $row->{id} = $dbobject->id();
436 my $dbobject = shift;
438 my @objects = $dbobject->[% node.key %]s;
439 foreach my $object (@objects){
444 [% FOREACH value = node.value.data_fields %]
446 $field_hash->{[% value %]} = $object->[% value %]();
451 [% FOREACH value = node.value.edges %]
452 [% NEXT IF value.type != 'import' %]
453 $field_hash->{[% value.thisfield.name %]} = $object->[% value.thisfield.name %]();
456 $row->{data} = $field_hash;
457 $row->{id} = $object->id();
472 } elsif($type eq 'xml'){
474 <?xml version="1.0" encoding="UTF-8"?>
475 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
478 <!-- The basic layout is fixed -->
479 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
480 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
481 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
482 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
486 <!-- Atom Classes -->
487 [% FOREACH node = nodes %]
488 [% IF !node.value.is_trivial_link %]
489 <atom class="[% format_table(node.key) %]" name="[% format_table(node.key) %]" xlink:label="[% format_table(node.key) %]Atom"/>
493 <!-- Atom Bindings -->
495 [% FOREACH focus_atom = nodes %]
496 [% IF !focus_atom.value.is_trivial_link %]
497 [% FOREACH link_atom = focus_atom.value.hyperedges %]
498 <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"/>
501 [% FOREACH link_atom = focus_atom.value.edges %]
502 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
503 <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"/>
504 [% previous = link_atom.thatnode.table.name %]
512 [% FOREACH focus_atom = nodes %]
513 [% IF !focus_atom.value.is_trivial_link %]
514 <layout xlink:label="[% format_table(focus_atom.key) %]">
515 [% FOREACH link_atom = focus_atom.value.hyperedges %]
516 <placement xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" xlink:to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
519 [% FOREACH link_atom = focus_atom.value.edges %]
520 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
521 <placement xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" xlink:to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
522 [% previous = link_atom.thatnode.table.name %]
525 <placement xlink:from="#MainContainer" xlink:label="MainContainer2[% format_table(focus_atom.key) %]Atom" xlink:to="#[% format_table(focus_atom.key) %]Atom"/>
532 <uribinding uri="/" class="Turnkey::Util::Frontpage"/>
536 [% FOREACH focus_atom = nodes %]
537 [% IF !focus_atom.value.is_trivial_link %]
538 <classbinding class="[% format_table(focus_atom.key) %]" plugin="#[% format_table(focus_atom.key) %]Atom" rank="0"/>
546 } elsif($type eq 'template'){
549 [% MACRO renderpanel(panel,dbobject) BLOCK %]
550 <!-- begin panel: [% panel.label %] -->
551 [% FOREACH p = panel.containers %]
552 [% IF p.can_render(panel) %]
553 [% IF p.type == 'Container' %]
554 [% renderpanel(p,dbobject) %]
556 [% IF panel.label == 'MainContainer' %]
557 <div class="middle"><div class="column-in">
559 <div class="middle-header">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</div>
561 <!-- begin atom: [% p.label %] -->
562 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
563 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
566 <div class="cleaner"></div>
568 <div class="left"><div class="column-in">
569 <div class="left-item">
571 <div class="box-header">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</div>
573 <!-- begin atom: [% p.label %] -->
574 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
575 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
580 [% IF panel.orientation == 'vertical' %]
585 <!-- end panel: [% panel.label %] -->
588 [% BLOCK make_linked_dbobject %]
590 $stash->set(linked_dbobject => [% class %]->retrieve([% id %]));
593 [% MACRO obj2link(obj) SWITCH ref(obj) %]
598 <a href="[% obj2url(obj) %]">[% obj.name %]</a>
600 <a href="[% obj2url(obj) %]">[% obj %]</a>
603 [% MACRO obj2url(obj) SWITCH obj %]
605 /[% ref(obj) | replace('.+::','') %]/[% obj %]
607 [% MACRO obj2desc(obj) SWITCH ref(obj) %]
617 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
618 [- FOREACH node = nodes -]
619 [- IF !node.value.is_trivial_link -]
620 [% CASE '[- format_table(node.key) -]' %]
621 [% INCLUDE [- node.key -].tt2 %]
625 [% renderlist(atom.render(dbobject)) %]
627 [% MACRO renderlist(lstArr) BLOCK %]
628 <div class="left-item"><ul>
629 [% FOREACH item = lstArr %]
630 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
632 [% PROCESS make_linked_dbobject %]
633 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>
639 } elsif($type eq 'atomtemplate') {
642 [-- IF !node.is_trivial_link --]
644 [% IF atom.focus == "yes" %]
646 [- FOREACH field = node.data_fields -]
647 [- IF field != "1" -]
648 <tr><td class="dbfieldname">[- field -]</td><td class="dbfieldvalue">[% obj2link(dbobject.[- field -]) %]</td></tr>
651 [- FOREACH field = node.edges -]
652 [- NEXT IF field.type != 'import' -]
653 <tr><td class="dbfieldname">[- field.thisfield.name -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.thisfield.name -]) %]</td></tr>
655 [% IF (rowcount > 1) %] <tr><td colspan="2"><hr></td></tr> [% END %]
656 [% rowcount = rowcount + 1 %]
660 [% FOREACH record = atom.render(dbobject) %]
661 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
662 [% id = record.id #needed by make_linked_dbobject macro %]
663 [% PROCESS make_linked_dbobject %]
664 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>