1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.18 2004-01-03 04:03:56 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.18 $ =~ /(\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_dsn => $args->{'db_dsn'} || '',
64 db_user => $args->{'db_user'} || '',
65 db_pass => $args->{'db_pass'} || '',
66 db_str => $args->{'db_str'} || '',
67 parser => $t->parser_type,
68 producer => __PACKAGE__,
69 dsn => $args->{'dsn'} || sprintf( 'dbi:%s:_', $producer2dsn{ $parser_type }
70 ? $producer2dsn{ $parser_type }
78 foreach my $node_from ($graph->node_values){
80 next unless $node_from->table->is_data or !$node_from->table->is_trivial_link;
82 foreach my $cedge ( $node_from->compoundedges ){
84 my $hyperedge = SQL::Translator::Schema::Graph::HyperEdge->new();
87 foreach my $edge ($cedge->edges){
88 if($edge->thisnode->name eq $node_from->name){
89 $hyperedge->vianode($edge->thatnode);
91 if($edge->thatnode->name ne $cedge->via->name){
92 $node_to ||= $graph->node($edge->thatnode->table->name);
95 $hyperedge->push_thisnode($edge->thisnode);
96 $hyperedge->push_thisfield($edge->thisfield);
97 $hyperedge->push_thisviafield($edge->thatfield);
100 if($edge->thisnode->name ne $cedge->via->name){
101 $node_to ||= $graph->node($edge->thisnode->table->name);
103 $hyperedge->push_thatnode($edge->thisnode);
104 $hyperedge->push_thatfield($edge->thisfield);
105 $hyperedge->push_thatviafield($edge->thatfield);
107 $log->debug($edge->thisfield->name);
108 $log->debug($edge->thatfield->name);
111 if($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('one2one') }
112 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('many2one') }
113 elsif($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('one2many') }
114 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('many2many') }
116 $log->debug($_) foreach sort keys %::SQL::Translator::Schema::Graph::HyperEdge::;
118 #node_to won't always be defined b/c of multiple edges to a single other node
119 if(defined($node_to)){
120 $log->debug($node_from->name);
121 $log->debug($node_to->name);
123 if(scalar($hyperedge->thisnode) > 1){
124 $log->debug($hyperedge->type ." via ". $hyperedge->vianode->name);
126 foreach my $thisnode ( $hyperedge->thisnode ){
127 $log->debug($thisnode->name .' '.
128 $hyperedge->thisfield_index(0)->name .' -> '.
129 $hyperedge->thisviafield_index($i)->name .' '.
130 $hyperedge->vianode->name .' '.
131 $hyperedge->thatviafield_index(0)->name .' <- '.
132 $hyperedge->thatfield_index(0)->name .' '.
133 $hyperedge->thatnode_index(0)->name ."\n"
138 $node_from->push_hyperedges($hyperedge);
142 $meta{"nodes"} = $graph->node;
143 return(translateForm($t, \%meta));
152 #warn Dumper $meta->{nodes};
155 my $args = $t->producer_args;
156 my $type = $meta->{'template'};
158 $tt2 = template($type);
159 my $template = Template->new({
166 $template->process(\$tt2, $meta, \$result) || die $template->error();
172 # -------------------------------------------------------------------
178 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
182 Creates output for use with the Turnkey project.
186 L<http://turnkey.sourceforge.net>.
190 Allen Day E<lt>allenday@ucla.eduE<gt>
191 Brian O\'Connor E<lt>brian.oconnor@excite.comE<gt>.
198 ###########################################
199 # Here documents for the tt2 templates #
200 ###########################################
204 [% MACRO printPackage(node) BLOCK %]
205 # --------------------------------------------
207 package [% node.name %];
208 use base '[% node.base %]';
209 use Class::DBI::Pager;
211 [% node.name %]->set_up_table('[% node.table.name %]');
212 [% printPKAccessors(node.primary_key, node.table.name) %]
213 [% printHasA(node.edges, node) %]
214 [% printHasMany(node.edges, node) %]
215 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
216 [% #printHasFriendly(node) %]
221 [% MACRO printPKAccessors(array, name) BLOCK %]
223 # Primary key accessors
225 [% FOREACH item = array %]
226 sub id { shift->[% item %] }
227 sub [% name %] { shift->[% item %] }
232 [% MACRO printHasA(edges, name) BLOCK %]
237 [% FOREACH edge = edges %]
238 [% IF edge.type == 'import' %]
239 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
240 [% IF node.has(edge.thatnode.name) < 2 %]
241 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
243 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
251 [% MACRO printHasMany(edges, node) BLOCK %]
256 [% FOREACH edge = edges %]
257 [% IF edge.type == 'export' %]
258 [% node.name %]->has_many('[% edge.thatnode.table.name %]_[% edge.thatfield.name %]', '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
259 [% IF node.via(edge.thatnode.name) >= 1 %]
260 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
261 [% ELSIF edge.thatnode.table.is_data %]
262 [% IF node.edgecount(edge.thatnode.name) > 1 %]
263 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
265 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
274 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
278 [% FOREACH cedge = cedges %]
279 [% FOREACH edge = cedge.edges %]
280 [% NEXT IF edge.thisnode.name != name %]
281 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
285 [% FOREACH h = hedges %]
286 ########## [% h.type %] ##########
287 [% IF h.type == 'one2one' %]
288 sub [% h.thatnode.table.name %]s { my \$self = shift; return map \$_->[% h.thatviafield.name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
290 [% ELSIF h.type == 'one2many' %]
291 [% thisnode = h.thisnode_index(0) %]
293 [% FOREACH thatnode = h.thatnode %]
294 #[% 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 %]
295 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 %] }
299 [% ELSIF h.type == 'many2one' %]
301 [% FOREACH thisnode = h.thisnode %]
302 #[% 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 %]
303 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 %] }
308 [% ELSIF h.type == 'many2many' %]
310 [% FOREACH thisnode = h.thisnode %]
312 [% FOREACH thatnode = h.thatnode %]
313 #[% 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 %]
314 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->[% %] }
325 [% MACRO printHasFriendly(node) BLOCK %]
332 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
333 package [% baseclass %];
335 # Created by SQL::Translator::Producer::Turnkey
336 # Template used: classdbi
339 use base qw(Class::DBI::Pg);
341 [% baseclass %]->set_db('Main', '[% db_dsn %]', '[% db_user %]', '[% db_pass %]', {AutoCommit=>1});
343 [% FOREACH node = nodes %]
344 [% printPackage(node.value) %]
350 elsif($type eq 'atom'){
353 [% ###### DOCUMENT START ###### %]
355 [% FOREACH node = nodes %]
356 [% IF !node.value.is_trivial_link %]
358 ##############################################
360 package Turnkey::Atom::[% node.value.name FILTER replace "Turnkey::Model::", "" %];
362 [% pname = node.value.name FILTER replace "Turnkey::Model::", "" %]
364 use base qw(Turnkey::Atom);
373 my $dbobject = shift;
375 # Assumption here that if it's not rendering on it's own dbobject
376 # then it's a list. This will be updated when AtomLists are implemented -boconnor
377 if(ref($dbobject) eq 'Turnkey::Model::[% pname %]') {
379 return(_render_record($dbobject));
381 else { return(_render_list($dbobject)); }
385 my $dbobject = shift;
391 [% FOREACH value = node.value.data_fields %]
393 $field_hash->{[% value %]} = $dbobject->[% value %]();
398 [% FOREACH value = node.value.edges %]
399 [% NEXT IF value.type != 'import' %]
400 $field_hash->{[% value.thisfield.name %]} = $dbobject->[% value.thisfield.name %]();
403 $row->{data} = $field_hash;
404 $row->{id} = $dbobject->id();
410 my $dbobject = shift;
412 my @objects = $dbobject->[% node.key %]s;
413 foreach my $object (@objects){
418 [% FOREACH value = node.value.data_fields %]
420 $field_hash->{[% value %]} = $object->[% value %]();
425 [% FOREACH value = node.value.edges %]
426 [% NEXT IF value.type != 'import' %]
427 $field_hash->{[% value.thisfield.name %]} = $object->[% value.thisfield.name %]();
430 $row->{data} = $field_hash;
431 $row->{id} = $object->id();
446 } elsif($type eq 'xml'){
448 <?xml version="1.0" encoding="UTF-8"?>
449 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
452 <!-- The basic layout is fixed -->
453 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
454 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
455 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
456 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
460 <!-- Atom Classes -->
461 [% FOREACH node = nodes %]
462 [% IF !node.value.is_trivial_link %]
463 <atom class="Turnkey::Atom::[% node.key FILTER ucfirst %]" name="[% node.key FILTER ucfirst %]" xlink:label="[% node.key FILTER ucfirst %]Atom"/>
467 <!-- Atom Bindings -->
469 [% FOREACH focus_atom = nodes %]
470 [% IF !focus_atom.value.is_trivial_link %]
471 [% FOREACH link_atom = focus_atom.value.hyperedges %]
472 <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"/>
475 [% FOREACH link_atom = focus_atom.value.edges %]
476 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
477 <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"/>
478 [% previous = link_atom.thatnode.table.name %]
485 <atomcontainerbindings>
486 [% FOREACH focus_atom = nodes %]
487 [% IF !focus_atom.value.is_trivial_link %]
488 <atomcontainerbindingslayout xlink:label="Turnkey::Model::[% focus_atom.key FILTER ucfirst %]">
489 [% FOREACH link_atom = focus_atom.value.hyperedges %]
490 <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"/>
493 [% FOREACH link_atom = focus_atom.value.edges %]
494 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
495 <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"/>
496 [% previous = link_atom.thatnode.table.name %]
499 <atomcontainerbinding xlink:from="#MainContainer" xlink:label="MainContainer2[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% focus_atom.key FILTER ucfirst %]Atom"/>
500 </atomcontainerbindingslayout>
503 </atomcontainerbindings>
506 <uribinding uri="/" class="Turnkey::Util::Frontpage"/>
510 [% FOREACH focus_atom = nodes %]
511 [% IF !focus_atom.value.is_trivial_link %]
512 <classbinding class="Turnkey::Model::[% focus_atom.key FILTER ucfirst %]" plugin="#[% focus_atom.key FILTER ucfirst %]Atom" rank="0"/>
520 } elsif($type eq 'template'){
523 [% MACRO renderpanel(panel,dbobject) BLOCK %]
524 <!-- begin panel: [% panel.label %] -->
525 <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 %]">
527 [% FOREACH p = panel.containers %]
528 [% IF p.can_render(panel) %]
529 <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
530 [% IF p.type == 'Container' %]
531 [% renderpanel(p,dbobject) %]
533 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
535 <tr class="dbtabletitle" height="1">
536 <td class="dbtabletitle">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</td>
537 <td align="right" width="0"></td>
540 <tr><td colspan="2" class="dbtablerow">
541 <!-- begin atom: [% p.label %] -->
542 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
543 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
548 [% IF panel.orientation == 'vertical' %]
555 <!-- end panel: [% panel.label %] -->
557 [% BLOCK make_linked_dbobject %]
559 $stash->set(linked_dbobject => [% class %]->retrieve([% id %]));
562 [% MACRO obj2link(obj) SWITCH ref(obj) %]
567 <a href="[% obj2url(obj) %]">[% obj.name %]</a>
569 <a href="[% obj2url(obj) %]">[% obj %]</a>
572 [% MACRO obj2url(obj) SWITCH obj %]
574 /?id=[% obj %];class=[% ref(obj) %]
576 [% MACRO obj2desc(obj) SWITCH ref(obj) %]
586 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
587 [- FOREACH node = nodes -]
588 [- IF !node.value.is_trivial_link -]
589 [% CASE '[- node.key FILTER ucfirst -]' %]
590 [% render[- node.key FILTER ucfirst -]Atom(atom,dbobject) %]
594 [% renderlist(atom.render(dbobject)) %]
596 [- FOREACH node = nodes -]
597 [- IF !node.value.is_trivial_link -]
598 [% MACRO render[- node.key FILTER ucfirst -]Atom(atom, dbobject) BLOCK %]
599 [% lstArr = atom.render(dbobject) %]
601 [% IF atom.focus == "yes" %]
602 [% FOREACH record = lstArr %]
603 [% fields = record.data %]
604 [- pname = node.key FILTER ucfirst -]
605 [- pkey = "Turnkey::Model::${pname}" -]
606 [- FOREACH field = node.value.data_fields -]
607 [- IF field != "1" -]
608 <tr><td class="dbfieldname">[- field -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field -]) %]</td></tr>
611 [- FOREACH field = node.value.edges -]
612 [- NEXT IF field.type != 'import' -]
613 <tr><td class="dbfieldname">[- field.thisfield.name -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.thisfield.name -]) %]</td></tr>
616 [% IF (rowcount > 1) %] <tr><td colspan="2"><hr></td></tr> [% END %]
617 [% rowcount = rowcount + 1 %]
621 [% FOREACH record = lstArr %]
622 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
624 [% PROCESS make_linked_dbobject %]
625 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>
632 [% MACRO renderlist(lstArr) BLOCK %]
634 [% FOREACH item = lstArr %]
635 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
637 [% PROCESS make_linked_dbobject %]
638 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>