1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.20 2004-01-15 20:40:15 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.20 $ =~ /(\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 format_package => $t->format_package_name,
62 format_module => $t->format_module_name,
63 template => $args->{'template'} || '',
64 baseclass => $baseclass,
65 db_dsn => $args->{'db_dsn'} || '',
66 db_user => $args->{'db_user'} || '',
67 db_pass => $args->{'db_pass'} || '',
68 db_str => $args->{'db_str'} || '',
69 parser => $t->parser_type,
70 producer => __PACKAGE__,
71 dsn => $args->{'dsn'} || sprintf( 'dbi:%s:_', $producer2dsn{ $parser_type }
72 ? $producer2dsn{ $parser_type }
80 foreach my $node_from ($graph->node_values){
82 next unless $node_from->table->is_data or !$node_from->table->is_trivial_link;
84 foreach my $cedge ( $node_from->compoundedges ){
86 my $hyperedge = SQL::Translator::Schema::Graph::HyperEdge->new();
89 foreach my $edge ($cedge->edges){
90 if($edge->thisnode->name eq $node_from->name){
91 $hyperedge->vianode($edge->thatnode);
93 if($edge->thatnode->name ne $cedge->via->name){
94 $node_to ||= $graph->node($edge->thatnode->table->name);
97 $hyperedge->push_thisnode($edge->thisnode);
98 $hyperedge->push_thisfield($edge->thisfield);
99 $hyperedge->push_thisviafield($edge->thatfield);
102 if($edge->thisnode->name ne $cedge->via->name){
103 $node_to ||= $graph->node($edge->thisnode->table->name);
105 $hyperedge->push_thatnode($edge->thisnode);
106 $hyperedge->push_thatfield($edge->thisfield);
107 $hyperedge->push_thatviafield($edge->thatfield);
109 $log->debug($edge->thisfield->name);
110 $log->debug($edge->thatfield->name);
113 if($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('one2one') }
114 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('many2one') }
115 elsif($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('one2many') }
116 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('many2many') }
118 $log->debug($_) foreach sort keys %::SQL::Translator::Schema::Graph::HyperEdge::;
120 #node_to won't always be defined b/c of multiple edges to a single other node
121 if(defined($node_to)){
122 $log->debug($node_from->name);
123 $log->debug($node_to->name);
125 if(scalar($hyperedge->thisnode) > 1){
126 $log->debug($hyperedge->type ." via ". $hyperedge->vianode->name);
128 foreach my $thisnode ( $hyperedge->thisnode ){
129 $log->debug($thisnode->name .' '.
130 $hyperedge->thisfield_index(0)->name .' -> '.
131 $hyperedge->thisviafield_index($i)->name .' '.
132 $hyperedge->vianode->name .' '.
133 $hyperedge->thatviafield_index(0)->name .' <- '.
134 $hyperedge->thatfield_index(0)->name .' '.
135 $hyperedge->thatnode_index(0)->name ."\n"
140 $node_from->push_hyperedges($hyperedge);
144 $meta{"nodes"} = $graph->node;
145 return(translateForm($t, \%meta));
154 #warn Dumper $meta->{nodes};
157 my $args = $t->producer_args;
158 my $type = $meta->{'template'};
160 $tt2 = template($type);
161 my $template = Template->new({
168 $template->process(\$tt2, $meta, \$result) || die $template->error();
174 # -------------------------------------------------------------------
180 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
184 Creates output for use with the Turnkey project.
188 L<http://turnkey.sourceforge.net>.
192 Allen Day E<lt>allenday@ucla.eduE<gt>
193 Brian O\'Connor E<lt>brian.oconnor@excite.comE<gt>.
200 ###########################################
201 # Here documents for the tt2 templates #
202 ###########################################
206 [% MACRO printPackage(node) BLOCK %]
207 # --------------------------------------------
209 package [% node.name %];
210 use base '[% node.base %]';
211 use Class::DBI::Pager;
213 [% node.name %]->set_up_table('[% node.table.name %]');
214 [% printPKAccessors(node.primary_key, node.table.name) %]
215 [% printHasA(node.edges, node) %]
216 [% printHasMany(node.edges, node) %]
217 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
218 [% #printHasFriendly(node) %]
223 [% MACRO printPKAccessors(array, name) BLOCK %]
225 # Primary key accessors
227 [% FOREACH item = array %]
228 sub id { shift->[% item %] }
229 sub [% name %] { shift->[% item %] }
234 [% MACRO printHasA(edges, name) BLOCK %]
239 [% FOREACH edge = edges %]
240 [% IF edge.type == 'import' %]
241 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
242 [% IF node.has(edge.thatnode.name) < 2 %]
243 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
245 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
253 [% MACRO printHasMany(edges, node) BLOCK %]
258 [% FOREACH edge = edges %]
259 [% IF edge.type == 'export' %]
260 [% node.name %]->has_many('[% edge.thatnode.table.name %]_[% edge.thatfield.name %]', '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
261 [% IF node.via(edge.thatnode.name) >= 1 %]
262 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
263 [% ELSIF edge.thatnode.table.is_data %]
264 [% IF node.edgecount(edge.thatnode.name) > 1 %]
265 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
267 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
276 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
280 [% FOREACH cedge = cedges %]
281 [% FOREACH edge = cedge.edges %]
282 [% NEXT IF edge.thisnode.name != name %]
283 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
287 [% FOREACH h = hedges %]
288 ########## [% h.type %] ##########
289 [% IF h.type == 'one2one' %]
290 sub [% h.thatnode.table.name %]s { my \$self = shift; return map \$_->[% h.thatviafield.name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
292 [% ELSIF h.type == 'one2many' %]
293 [% thisnode = h.thisnode_index(0) %]
295 [% FOREACH thatnode = h.thatnode %]
296 #[% 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 %]
297 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 %] }
301 [% ELSIF h.type == 'many2one' %]
303 [% FOREACH thisnode = h.thisnode %]
304 #[% 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 %]
305 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 %] }
310 [% ELSIF h.type == 'many2many' %]
312 [% FOREACH thisnode = h.thisnode %]
314 [% FOREACH thatnode = h.thatnode %]
315 #[% 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 %]
316 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->[% %] }
327 [% MACRO printHasFriendly(node) BLOCK %]
334 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
335 package [% baseclass %];
337 # Created by SQL::Translator::Producer::Turnkey
338 # Template used: classdbi
341 use base qw(Class::DBI::Pg);
343 [% baseclass %]->set_db('Main', '[% db_dsn %]', '[% db_user %]', '[% db_pass %]', {AutoCommit=>1});
344 sub search_ilike { shift->_do_search(ILIKE => [% "\@\_" %] ) }
347 [% FOREACH node = nodes %]
348 [% printPackage(node.value) %]
354 elsif($type eq 'atom'){
357 [% ###### DOCUMENT START ###### %]
359 [% FOREACH node = nodes %]
360 [% IF !node.value.is_trivial_link %]
362 ##############################################
364 package Turnkey::Atom::[% node.value.name FILTER replace "Turnkey::Model::", "" %];
366 [% pname = node.value.name FILTER replace "Turnkey::Model::", "" %]
368 use base qw(Turnkey::Atom);
377 my $dbobject = shift;
379 # Assumption here that if it's not rendering on it's own dbobject
380 # then it's a list. This will be updated when AtomLists are implemented -boconnor
381 if(ref($dbobject) eq 'Turnkey::Model::[% pname %]') {
383 return(_render_record($dbobject));
385 else { return(_render_list($dbobject)); }
389 my $dbobject = shift;
395 [% FOREACH value = node.value.data_fields %]
397 $field_hash->{[% value %]} = $dbobject->[% value %]();
402 [% FOREACH value = node.value.edges %]
403 [% NEXT IF value.type != 'import' %]
404 $field_hash->{[% value.thisfield.name %]} = $dbobject->[% value.thisfield.name %]();
407 $row->{data} = $field_hash;
408 $row->{id} = $dbobject->id();
414 my $dbobject = shift;
416 my @objects = $dbobject->[% node.key %]s;
417 foreach my $object (@objects){
422 [% FOREACH value = node.value.data_fields %]
424 $field_hash->{[% value %]} = $object->[% value %]();
429 [% FOREACH value = node.value.edges %]
430 [% NEXT IF value.type != 'import' %]
431 $field_hash->{[% value.thisfield.name %]} = $object->[% value.thisfield.name %]();
434 $row->{data} = $field_hash;
435 $row->{id} = $object->id();
450 } elsif($type eq 'xml'){
452 <?xml version="1.0" encoding="UTF-8"?>
453 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
456 <!-- The basic layout is fixed -->
457 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
458 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
459 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
460 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
464 <!-- Atom Classes -->
465 [% FOREACH node = nodes %]
466 [% IF !node.value.is_trivial_link %]
467 <atom class="Turnkey::Atom::[% format_module(node.key) %]" name="[% format_module(node.key) %]" xlink:label="[% format_module(node.key) %]Atom"/>
471 <!-- Atom Bindings -->
473 [% FOREACH focus_atom = nodes %]
474 [% IF !focus_atom.value.is_trivial_link %]
475 [% FOREACH link_atom = focus_atom.value.hyperedges %]
476 <atomatombinding xlink:from="#[% format_module(focus_atom.key) %]Atom" xlink:to="#[% format_module(link_atom.thatnode.table.name) %]Atom" xlink:label="[% format_module(focus_atom.key) %]Atom2[% format_module(link_atom.thatnode.table.name) %]Atom"/>
479 [% FOREACH link_atom = focus_atom.value.edges %]
480 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
481 <atomatombinding xlink:from="#[% format_module(focus_atom.key) %]Atom" xlink:to="#[% format_module(link_atom.thatnode.table.name) %]Atom" xlink:label="[% format_module(focus_atom.key) %]Atom2[% format_module(link_atom.thatnode.table.name) %]Atom"/>
482 [% previous = link_atom.thatnode.table.name %]
489 <atomcontainerbindings>
490 [% FOREACH focus_atom = nodes %]
491 [% IF !focus_atom.value.is_trivial_link %]
492 <atomcontainerbindingslayout xlink:label="Turnkey::Model::[% format_module(focus_atom.key) %]">
493 [% FOREACH link_atom = focus_atom.value.hyperedges %]
494 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% format_module(link_atom.thatnode.table.name) %]Atom" xlink:to="#[% format_module(link_atom.thatnode.table.name) %]Atom"/>
497 [% FOREACH link_atom = focus_atom.value.edges %]
498 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
499 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% format_module(link_atom.thatnode.table.name) %]Atom" xlink:to="#[% format_module(link_atom.thatnode.table.name) %]Atom"/>
500 [% previous = link_atom.thatnode.table.name %]
503 <atomcontainerbinding xlink:from="#MainContainer" xlink:label="MainContainer2[% format_module(focus_atom.key) %]Atom" xlink:to="#[% format_module(focus_atom.key) %]Atom"/>
504 </atomcontainerbindingslayout>
507 </atomcontainerbindings>
510 <uribinding uri="/" class="Turnkey::Util::Frontpage"/>
514 [% FOREACH focus_atom = nodes %]
515 [% IF !focus_atom.value.is_trivial_link %]
516 <classbinding class="Turnkey::Model::[% format_module(focus_atom.key) %]" plugin="#[% format_module(focus_atom.key) %]Atom" rank="0"/>
524 } elsif($type eq 'template'){
527 [% MACRO renderpanel(panel,dbobject) BLOCK %]
528 <!-- begin panel: [% panel.label %] -->
529 <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 %]">
531 [% FOREACH p = panel.containers %]
532 [% IF p.can_render(panel) %]
533 <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
534 [% IF p.type == 'Container' %]
535 [% renderpanel(p,dbobject) %]
537 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
539 <tr class="dbtabletitle" height="1">
540 <td class="dbtabletitle">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</td>
541 <td align="right" width="0"></td>
544 <tr><td colspan="2" class="dbtablerow">
545 <!-- begin atom: [% p.label %] -->
546 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
547 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
552 [% IF panel.orientation == 'vertical' %]
559 <!-- end panel: [% panel.label %] -->
561 [% BLOCK make_linked_dbobject %]
563 $stash->set(linked_dbobject => [% class %]->retrieve([% id %]));
566 [% MACRO obj2link(obj) SWITCH ref(obj) %]
571 <a href="[% obj2url(obj) %]">[% obj.name %]</a>
573 <a href="[% obj2url(obj) %]">[% obj %]</a>
576 [% MACRO obj2url(obj) SWITCH obj %]
578 /?id=[% obj %];class=[% ref(obj) %]
580 [% MACRO obj2desc(obj) SWITCH ref(obj) %]
590 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
591 [- FOREACH node = nodes -]
592 [- IF !node.value.is_trivial_link -]
593 [% CASE '[- format_module(node.key) -]' %]
594 [% render[- format_module(node.key) -]Atom(atom,dbobject) %]
598 [% renderlist(atom.render(dbobject)) %]
600 [- FOREACH node = nodes -]
601 [- IF !node.value.is_trivial_link -]
602 [% MACRO render[- format_module(node.key) -]Atom(atom, dbobject) BLOCK %]
603 [% lstArr = atom.render(dbobject) %]
605 [% IF atom.focus == "yes" %]
606 [% FOREACH record = lstArr %]
607 [% fields = record.data %]
608 [- pname = format_module(node.key) -]
609 [- pkey = "Turnkey::Model::${pname}" -]
610 [- FOREACH field = node.value.data_fields -]
611 [- IF field != "1" -]
612 <tr><td class="dbfieldname">[- field -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field -]) %]</td></tr>
615 [- FOREACH field = node.value.edges -]
616 [- NEXT IF field.type != 'import' -]
617 <tr><td class="dbfieldname">[- field.thisfield.name -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.thisfield.name -]) %]</td></tr>
620 [% IF (rowcount > 1) %] <tr><td colspan="2"><hr></td></tr> [% END %]
621 [% rowcount = rowcount + 1 %]
625 [% FOREACH record = lstArr %]
626 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
628 [% PROCESS make_linked_dbobject %]
629 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>
636 [% MACRO renderlist(lstArr) BLOCK %]
638 [% FOREACH item = lstArr %]
639 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
641 [% PROCESS make_linked_dbobject %]
642 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>