1 package SQL::Translator::Producer::Turnkey;
4 use vars qw[ $VERSION $DEBUG ];
5 $VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
6 $DEBUG = 1 unless defined $DEBUG;
8 use SQL::Translator::Schema::Constants;
9 use SQL::Translator::Schema::Graph;
10 use SQL::Translator::Schema::Graph::HyperEdge;
11 use Log::Log4perl; Log::Log4perl::init('/etc/log4perl.conf');
21 # -------------------------------------------------------------------
23 my $log = Log::Log4perl->get_logger('sql.translator');
27 my $args = $t->producer_args;
28 my $no_comments = $t->no_comments;
29 my $baseclass = $args->{'main_pkg_name'} || $t->format_package_name('DBI');
30 my $graph = SQL::Translator::Schema::Graph->new(translator => $t,
31 baseclass => $baseclass
34 my $parser_type = (split /::/, $t->parser_type)[-1];
36 local $DEBUG = $t->debug;
39 format_fk => $t->format_fk_name,
40 template => $args->{'template'} || '',
41 baseclass => $baseclass,
42 db_user => $args->{'db_user'} || '',
43 db_pass => $args->{'db_pass'} || '',
44 parser => $t->parser_type,
45 producer => __PACKAGE__,
46 dsn => $args->{'dsn'} || sprintf( 'dbi:%s:_', $producer2dsn{ $parser_type }
47 ? $producer2dsn{ $parser_type }
55 foreach my $node_from ($graph->node_values){
57 next unless $node_from->table->is_data or !$node_from->table->is_trivial_link;
59 foreach my $cedge ( $node_from->compoundedges ){
61 my $hyperedge = SQL::Translator::Schema::Graph::HyperEdge->new();
64 foreach my $edge ($cedge->edges){
65 if($edge->thisnode->name eq $node_from->name){
66 $hyperedge->vianode($edge->thatnode);
68 if($edge->thatnode->name ne $cedge->via->name){
69 $node_to ||= $graph->node($edge->thatnode->table->name);
72 $hyperedge->push_thisnode($edge->thisnode);
73 $hyperedge->push_thisfield($edge->thisfield);
74 $hyperedge->push_thisviafield($edge->thatfield);
77 if($edge->thisnode->name ne $cedge->via->name){
78 $node_to ||= $graph->node($edge->thisnode->table->name);
80 $hyperedge->push_thatnode($edge->thisnode);
81 $hyperedge->push_thatfield($edge->thisfield);
82 $hyperedge->push_thatviafield($edge->thatfield);
84 $log->debug($edge->thisfield->name);
85 $log->debug($edge->thatfield->name);
88 if($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('one2one') }
89 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('many2one') }
90 elsif($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('one2many') }
91 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('many2many') }
93 #warn join "\n", sort keys %::SQL::Translator::Schema::Graph::HyperEdge::;
95 #node_to won't always be defined b/c of multiple edges to a single other node
96 if(defined($node_to)){
97 $log->debug($node_from->name);
98 $log->debug($node_to->name);
100 if(scalar($hyperedge->thisnode) > 1){
101 $log->debug($hyperedge->type ." via ". $hyperedge->vianode->name);
103 foreach my $thisnode ( $hyperedge->thisnode ){
104 $log->debug($thisnode->name .' '.
105 $hyperedge->thisfield_index(0)->name .' -> '.
106 $hyperedge->thisviafield_index($i)->name .' '.
107 $hyperedge->vianode->name .' '.
108 $hyperedge->thatviafield_index(0)->name .' <- '.
109 $hyperedge->thatfield_index(0)->name .' '.
110 $hyperedge->thatnode_index(0)->name ."\n"
115 $node_from->push_hyperedges($hyperedge);
120 $meta{"nodes"} = $graph->node;
121 return(translateForm($t, \%meta));
127 my $args = $t->producer_args;
128 my $type = $meta->{'template'};
130 $tt2 = template($type);
131 my $template = Template->new({
138 $template->process(\$tt2, $meta, \$result) || die $template->error();
144 # -------------------------------------------------------------------
150 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
154 Creates output for use with the Turnkey project.
158 L<http://turnkey.sourceforge.net>.
162 Allen Day E<lt>allenday@ucla.eduE<gt>
163 Brian O\'Connor E<lt>brian.oconnor@excite.comE<gt>.
170 ###########################################
171 # Here documents for the tt2 templates #
172 ###########################################
174 if($type eq 'classdbi'){
176 [% MACRO printPackage(node) BLOCK %]
177 # --------------------------------------------
179 package [% node.name %];
180 use base '[% node.base %]';
181 use Class::DBI::Pager;
183 [% node.name %]->set_up_table('[% node.table.name %]');
184 [% printPKAccessors(node.primary_key, node.table.name) %]
185 [% printHasA(node.edges, node) %]
186 [% printHasMany(node.edges, node) %]
187 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
188 [% #printHasFriendly(node) %]
191 [% MACRO printPKAccessors(array, name) BLOCK %]
193 # Primary key accessors
195 [% FOREACH item = array %]
196 sub id { shift->[% item %] }
197 sub [% name %] { shift->[% item %] }
202 [% MACRO printHasA(edges, name) BLOCK %]
207 [% FOREACH edge = edges %]
208 [% IF edge.type == 'import' %]
209 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
210 [% IF node.has(edge.thatnode.name) < 2 %]
211 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
213 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
221 [% MACRO printHasMany(edges, node) BLOCK %]
226 [% FOREACH edge = edges %]
227 [% IF edge.type == 'export' %]
228 [% node.name %]->has_many([% edge.thatnode.table.name %]_[% edge.thatfield.name %], '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
229 [% IF node.via(edge.thatnode.name) >= 1 %]
230 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
231 [% ELSIF edge.thatnode.table.is_data %]
232 [% IF node.edgecount(edge.thatnode.name) > 1 %]
233 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
235 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
244 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
248 [% FOREACH cedge = cedges %]
249 [% FOREACH edge = cedge.edges %]
250 [% NEXT IF edge.thisnode.name != name %]
251 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
255 [% FOREACH h = hedges %]
256 ########## [% h.type %] ##########
257 [% IF h.type == 'one2one' %]
258 sub [% h.thatnode.table.name %]s { my \$self = shift; return map \$_->[% h.thatviafield.name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
260 [% ELSIF h.type == 'one2many' %]
261 [% thisnode = h.thisnode_index(0) %]
263 [% FOREACH thatnode = h.thatnode %]
264 #[% 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 %]
265 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 %] }
269 [% ELSIF h.type == 'many2one' %]
271 [% FOREACH thisnode = h.thisnode %]
272 #[% 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 %]
273 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 %] }
278 [% ELSIF h.type == 'many2many' %]
280 [% FOREACH thisnode = h.thisnode %]
282 [% FOREACH thatnode = h.thatnode %]
283 #[% 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 %]
284 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->[% %] }
295 [% MACRO printHasFriendly(node) BLOCK %]
302 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
303 package [% baseclass %];
305 # Created by SQL::Translator::Producer::Turnkey
306 # Template used: classdbi
309 use base qw(Class::DBI::Pg);
311 [% baseclass %]->set_db('Main', '[% db_str %]', '[% db_user %]', '[% db_pass %]');
313 [% FOREACH node = nodes %]
314 [% printPackage(node.value) %]
318 } elsif($type eq 'atom'){
320 [% ###### DOCUMENT START ###### %]
322 [% FOREACH node = linkable %]
324 ##############################################
326 package Durian::Atom::[% node.key FILTER ucfirst %];
328 [% pname = node.key FILTER ucfirst%]
329 [% pkey = "Durian::Model::${pname}" %]
331 use base qw(Durian::Atom);
340 my $dbobject = shift;
341 # Assumption here that if it's not rendering on it's own dbobject
342 # then it's a list. This will be updated when AtomLists are implemented -boconnor
343 if(ref($dbobject) eq 'Durian::Model::[% node.key FILTER ucfirst %]') {
344 return(_render_record($dbobject));
346 else { return(_render_list($dbobject)); }
350 my $dbobject = shift;
354 [% FOREACH field = nodes.$pkey.columns_essential %]
355 $field_hash->{[% field %]} = $dbobject->[% field %]();
357 $row->{data} = $field_hash;
358 $row->{id} = $dbobject->id();
364 my $dbobject = shift;
366 my @objects = $dbobject->[% node.key %]s;
367 foreach my $object (@objects)
371 [% FOREACH field = nodes.$pkey.columns_essential %]
372 $field_hash->{[% field %]} = $object->[% field %]();
374 $row->{data} = $field_hash;
375 $row->{id} = $object->id();
390 } elsif($type eq 'xml'){
392 <?xml version="1.0" encoding="UTF-8"?>
393 <!DOCTYPE Durian SYSTEM "Durian.dtd">
396 <!-- The basic layout is fixed -->
397 <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
398 <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
399 <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
400 <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
404 <!-- Atom Classes -->
405 [% FOREACH node = linkable %]
406 <atom class="Durian::Atom::[% node.key FILTER ucfirst %]" name="[% node.key FILTER ucfirst %]" xlink:label="[% node.key FILTER ucfirst %]Atom"/>
409 <!-- Atom Bindings -->
411 [% FOREACH focus_atom = linkable %]
412 [% FOREACH link_atom = focus_atom.value %]
413 <atomatombinding xlink:from="#[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% link_atom.key FILTER ucfirst %]Atom" xlink:label="[% focus_atom.key FILTER ucfirst %]Atom2[% link_atom.key FILTER ucfirst %]Atom"/>
418 <atomcontainerbindings>
419 [% FOREACH focus_atom = linkable %]
420 <atomcontainerbindingslayout xlink:label="Durian::Model::[% focus_atom.key FILTER ucfirst %]">
421 [% FOREACH link_atom = focus_atom.value %]
422 <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% link_atom.key FILTER ucfirst %]Atom" xlink:to="#[% link_atom.key FILTER ucfirst %]Atom"/>
424 <atomcontainerbinding xlink:from="#MainContainer" xlink:label="MainContainer2[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% focus_atom.key FILTER ucfirst %]Atom"/>
425 </atomcontainerbindingslayout>
427 </atomcontainerbindings>
430 <uribinding uri="/" class="Durian::Util::Frontpage"/>
434 [% FOREACH focus_atom = linkable %]
435 <classbinding class="Durian::Model::[% focus_atom.key FILTER ucfirst %]" plugin="#[% focus_atom.key FILTER ucfirst %]Atom" rank="0"/>
443 } elsif($type eq 'template'){
446 [% MACRO renderpanel(panel,dbobject) BLOCK %]
447 <!-- begin panel: [% panel.label %] -->
448 <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 %]">
450 [% FOREACH p = panel.containers %]
451 [% IF p.can_render(panel) %]
452 <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
453 [% IF p.type == 'Container' %]
454 [% renderpanel(p,dbobject) %]
456 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
458 <tr bgcolor="#4444FF" height="1">
459 <td><font color="#FFFFFF">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</font></td>
460 <td align="right" width="0"><!--<nobr><img src="/images/v.gif"/><img src="/images/^.gif"/>[% IF p.delible == 'yes' %]<img src="/images/x.gif"/>[% END %]</nobr>--></td>
463 <tr><td colspan="2" bgcolor="#FFFFFF">
464 <!-- begin atom: [% p.label %] -->
465 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
466 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
471 [% IF panel.orientation == 'vertical' %]
478 <!-- end panel: [% panel.label %] -->
480 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
481 [- FOREACH node = linkable -]
482 [% CASE '[- node.key FILTER ucfirst -]' %]
483 [% render[- node.key FILTER ucfirst -]Atom(atom.render(dbobject)) %]
486 [% renderlist(atom.render(dbobject)) %]
488 [- FOREACH node = linkable -]
489 [% MACRO render[- node.key FILTER ucfirst -]Atom(lstArr) BLOCK %]
490 [% FOREACH record = lstArr %]
491 [% fields = record.data %]
492 [- pname = node.key FILTER ucfirst -]
493 [- pkey = "Durian::Model::${pname}" -]
494 [- FOREACH field = nodes.$pkey.columns_essential -]
495 <tr><td><b>[- field -]</b></td><td>[% fields.[- field -] %]</td></tr>
498 <tr><td><a href="?id=[% id %];class=Durian::Model::[- node.key FILTER ucfirst -]">Link</a></td><td></td></tr>
502 [% MACRO renderlist(lstArr) BLOCK %]
503 [% FOREACH item = lstArr %]