1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.19 2004-01-09 02:41:35 boconnor 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.19 $ =~ /(\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});
342 sub search_ilike { shift->_do_search(ILIKE => [% "\@\_" %] ) }
345 [% FOREACH node = nodes %]
346 [% printPackage(node.value) %]
352 elsif($type eq 'atom'){
355 [% ###### DOCUMENT START ###### %]
357 [% FOREACH node = nodes %]
358 [% IF !node.value.is_trivial_link %]
360 ##############################################
362 package Turnkey::Atom::[% node.value.name FILTER replace "Turnkey::Model::", "" %];
364 [% pname = node.value.name FILTER replace "Turnkey::Model::", "" %]
366 use base qw(Turnkey::Atom);
375 my $dbobject = shift;
377 # Assumption here that if it's not rendering on it's own dbobject
378 # then it's a list. This will be updated when AtomLists are implemented -boconnor
379 if(ref($dbobject) eq 'Turnkey::Model::[% pname %]') {
381 return(_render_record($dbobject));
383 else { return(_render_list($dbobject)); }
387 my $dbobject = shift;
393 [% FOREACH value = node.value.data_fields %]
395 $field_hash->{[% value %]} = $dbobject->[% value %]();
400 [% FOREACH value = node.value.edges %]
401 [% NEXT IF value.type != 'import' %]
402 $field_hash->{[% value.thisfield.name %]} = $dbobject->[% value.thisfield.name %]();
405 $row->{data} = $field_hash;
406 $row->{id} = $dbobject->id();
412 my $dbobject = shift;
414 my @objects = $dbobject->[% node.key %]s;
415 foreach my $object (@objects){
420 [% FOREACH value = node.value.data_fields %]
422 $field_hash->{[% value %]} = $object->[% value %]();
427 [% FOREACH value = node.value.edges %]
428 [% NEXT IF value.type != 'import' %]
429 $field_hash->{[% value.thisfield.name %]} = $object->[% value.thisfield.name %]();
432 $row->{data} = $field_hash;
433 $row->{id} = $object->id();
448 } elsif($type eq 'xml'){
450 <?xml version="1.0" encoding="UTF-8"?>
451 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
454 <!-- The basic layout is fixed -->
455 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
456 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
457 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
458 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
462 <!-- Atom Classes -->
463 [% FOREACH node = nodes %]
464 [% IF !node.value.is_trivial_link %]
465 <atom class="Turnkey::Atom::[% node.key FILTER ucfirst %]" name="[% node.key FILTER ucfirst %]" xlink:label="[% node.key FILTER ucfirst %]Atom"/>
469 <!-- Atom Bindings -->
471 [% FOREACH focus_atom = nodes %]
472 [% IF !focus_atom.value.is_trivial_link %]
473 [% FOREACH link_atom = focus_atom.value.hyperedges %]
474 <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"/>
477 [% FOREACH link_atom = focus_atom.value.edges %]
478 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
479 <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"/>
480 [% previous = link_atom.thatnode.table.name %]
487 <atomcontainerbindings>
488 [% FOREACH focus_atom = nodes %]
489 [% IF !focus_atom.value.is_trivial_link %]
490 <atomcontainerbindingslayout xlink:label="Turnkey::Model::[% focus_atom.key FILTER ucfirst %]">
491 [% FOREACH link_atom = focus_atom.value.hyperedges %]
492 <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"/>
495 [% FOREACH link_atom = focus_atom.value.edges %]
496 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
497 <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"/>
498 [% previous = link_atom.thatnode.table.name %]
501 <atomcontainerbinding xlink:from="#MainContainer" xlink:label="MainContainer2[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% focus_atom.key FILTER ucfirst %]Atom"/>
502 </atomcontainerbindingslayout>
505 </atomcontainerbindings>
508 <uribinding uri="/" class="Turnkey::Util::Frontpage"/>
512 [% FOREACH focus_atom = nodes %]
513 [% IF !focus_atom.value.is_trivial_link %]
514 <classbinding class="Turnkey::Model::[% focus_atom.key FILTER ucfirst %]" plugin="#[% focus_atom.key FILTER ucfirst %]Atom" rank="0"/>
522 } elsif($type eq 'template'){
525 [% MACRO renderpanel(panel,dbobject) BLOCK %]
526 <!-- begin panel: [% panel.label %] -->
527 <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 %]">
529 [% FOREACH p = panel.containers %]
530 [% IF p.can_render(panel) %]
531 <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
532 [% IF p.type == 'Container' %]
533 [% renderpanel(p,dbobject) %]
535 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
537 <tr class="dbtabletitle" height="1">
538 <td class="dbtabletitle">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</td>
539 <td align="right" width="0"></td>
542 <tr><td colspan="2" class="dbtablerow">
543 <!-- begin atom: [% p.label %] -->
544 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
545 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
550 [% IF panel.orientation == 'vertical' %]
557 <!-- end panel: [% panel.label %] -->
559 [% BLOCK make_linked_dbobject %]
561 $stash->set(linked_dbobject => [% class %]->retrieve([% id %]));
564 [% MACRO obj2link(obj) SWITCH ref(obj) %]
569 <a href="[% obj2url(obj) %]">[% obj.name %]</a>
571 <a href="[% obj2url(obj) %]">[% obj %]</a>
574 [% MACRO obj2url(obj) SWITCH obj %]
576 /?id=[% obj %];class=[% ref(obj) %]
578 [% MACRO obj2desc(obj) SWITCH ref(obj) %]
588 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
589 [- FOREACH node = nodes -]
590 [- IF !node.value.is_trivial_link -]
591 [% CASE '[- node.key FILTER ucfirst -]' %]
592 [% render[- node.key FILTER ucfirst -]Atom(atom,dbobject) %]
596 [% renderlist(atom.render(dbobject)) %]
598 [- FOREACH node = nodes -]
599 [- IF !node.value.is_trivial_link -]
600 [% MACRO render[- node.key FILTER ucfirst -]Atom(atom, dbobject) BLOCK %]
601 [% lstArr = atom.render(dbobject) %]
603 [% IF atom.focus == "yes" %]
604 [% FOREACH record = lstArr %]
605 [% fields = record.data %]
606 [- pname = node.key FILTER ucfirst -]
607 [- pkey = "Turnkey::Model::${pname}" -]
608 [- FOREACH field = node.value.data_fields -]
609 [- IF field != "1" -]
610 <tr><td class="dbfieldname">[- field -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field -]) %]</td></tr>
613 [- FOREACH field = node.value.edges -]
614 [- NEXT IF field.type != 'import' -]
615 <tr><td class="dbfieldname">[- field.thisfield.name -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.thisfield.name -]) %]</td></tr>
618 [% IF (rowcount > 1) %] <tr><td colspan="2"><hr></td></tr> [% END %]
619 [% rowcount = rowcount + 1 %]
623 [% FOREACH record = lstArr %]
624 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
626 [% PROCESS make_linked_dbobject %]
627 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>
634 [% MACRO renderlist(lstArr) BLOCK %]
636 [% FOREACH item = lstArr %]
637 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
639 [% PROCESS make_linked_dbobject %]
640 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>