1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.53 2004-06-24 00:35:36 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.53 $ =~ /(\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');
33 $Data::Dumper::Maxdepth = 3;
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_table => $t->format_table_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 # this code needs to move to Graph.pm
81 foreach my $node_from ($graph->node_values){
83 next unless $node_from->table->is_data or !$node_from->table->is_trivial_link;
85 foreach my $cedge ( $node_from->compoundedges ){
87 my $hyperedge = SQL::Translator::Schema::Graph::HyperEdge->new();
90 foreach my $edge ($cedge->edges){
91 if($edge->thisnode->name eq $node_from->name){
92 $hyperedge->vianode($edge->thatnode);
94 if($edge->thatnode->name ne $cedge->via->name){
95 $node_to ||= $graph->node($edge->thatnode->table->name);
98 $hyperedge->push_thisnode($edge->thisnode);
99 $hyperedge->push_thisfield($edge->thisfield);
100 $hyperedge->push_thisviafield($edge->thatfield);
103 if($edge->thisnode->name ne $cedge->via->name){
104 $node_to ||= $graph->node($edge->thisnode->table->name);
106 $hyperedge->push_thatnode($edge->thisnode);
107 $hyperedge->push_thatfield($edge->thisfield);
108 $hyperedge->push_thatviafield($edge->thatfield);
110 $log->debug($edge->thisfield->name);
111 $log->debug($edge->thatfield->name);
114 if($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('one2one') }
115 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('many2one') }
116 elsif($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('one2many') }
117 elsif($hyperedge->count_thisnode > 1 and $hyperedge->count_thatnode > 1){ $hyperedge->type('many2many') }
119 $log->debug($_) foreach sort keys %::SQL::Translator::Schema::Graph::HyperEdge::;
121 #node_to won't always be defined b/c of multiple edges to a single other node
122 if(defined($node_to)){
123 $log->debug($node_from->name);
124 $log->debug($node_to->name);
126 if(scalar($hyperedge->thisnode) > 1){
127 $log->debug($hyperedge->type ." via ". $hyperedge->vianode->name);
129 foreach my $thisnode ( $hyperedge->thisnode ){
130 $log->debug($thisnode->name .' '.
131 $hyperedge->thisfield_index(0)->name .' -> '.
132 $hyperedge->thisviafield_index($i)->name .' '.
133 $hyperedge->vianode->name .' '.
134 $hyperedge->thatviafield_index(0)->name .' <- '.
135 $hyperedge->thatfield_index(0)->name .' '.
136 $hyperedge->thatnode_index(0)->name ."\n"
141 #warn Dumper($hyperedge) if $hyperedge->type eq 'many2many';
142 $node_from->push_hyperedges($hyperedge);
146 $meta{"nodes"} = $graph->node;
147 return(translateForm($t, \%meta));
154 my $args = $t->producer_args;
155 my $type = $meta->{'template'};
157 my $template = Template->new({
164 $tt2 = template($type);
167 if($type eq 'atomtemplate'){
169 foreach my $node (values %{ $meta->{'nodes'} }){
171 my $param = { node => $node };
172 $template->process(\$tt2, $param, \$result) || die $template->error();
173 $result =~ s/^\s*(.+)\s*$/$1/s;
175 $result{$node->table->name} = $result;
179 $template->process(\$tt2, $meta, \$result) || die $template->error();
187 # -------------------------------------------------------------------
193 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
197 Creates output for use with the Turnkey project.
201 L<http://turnkey.sourceforge.net>.
205 Allen Day E<lt>allenday@ucla.eduE<gt>
206 Brian O\'Connor E<lt>boconnor@ucla.comE<gt>.
213 ###########################################
214 # Here documents for the tt2 templates #
215 ###########################################
219 [% MACRO printPackage(node) BLOCK %]
220 # --------------------------------------------
222 package [% node.name %];
223 use base '[% node.base %]';
224 use Class::DBI::Pager;
225 no warnings qw(redefine);
227 [% node.name %]->set_up_table('[% node.table.name %]');
228 [% printPKAccessors(node.primary_key, node.table.name) %]
229 [% printHasA(node.edges, node) %]
230 [% printHasMany(node.edges, node) %]
231 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
232 [% #printHasFriendly(node) %]
234 [% MACRO printPKAccessors(array, name) BLOCK %]
236 # Primary key accessors
239 [% FOREACH item = array %]
240 [% IF item != "id" %]sub id { shift->[% item %] }[% END %]
241 [% IF item != name %]sub [% name %] { shift->[% item %] }[% END %]
245 [% MACRO printHasA(edges, name) BLOCK %]
246 [% FOREACH edge = edges %]
247 [% IF loop.first() %]
253 [% IF edge.type == 'import' %]
254 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
255 [% IF node.has(edge.thatnode.name) < 2 %]
256 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
258 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
265 [% MACRO printHasMany(edges, node) BLOCK %]
266 [% FOREACH edge = edges %]
267 [% IF loop.first() %]
273 [% IF edge.type == 'export' %]
274 [% node.name %]->has_many('[% edge.thatnode.table.name %]_[% edge.thatfield.name %]', '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
275 [% IF node.via(edge.thatnode.name) >= 1 %]
276 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
277 [% ELSIF edge.thatnode.table.is_data %]
278 [% IF node.edgecount(edge.thatnode.name) > 1 %]
279 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
281 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
289 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
290 [% FOREACH cedge = cedges %]
291 [% IF loop.first() %]
296 [% FOREACH edge = cedge.edges %]
297 [% NEXT IF edge.thisnode.name != name %]
298 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
303 [% FOREACH h = hedges %]
304 [% NEXT UNLESS h.type == 'one2one' %]
305 [% IF seen == 0 ; seen = 1 %]########## one2one ###########[% END %]
306 sub [% h.thatnode.table.name %]s { my $self = shift; return map $_->[% h.thatviafield.name %], $self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
310 [% FOREACH h = hedges %]
311 [% NEXT UNLESS h.type == 'one2many' %]
312 [% IF seen == 0 ; seen = 1 %]########## one2many ##########[% END %]
313 [% thisnode = h.thisnode_index(0) %]
315 [% FOREACH thatnode = h.thatnode %]
316 [% NEXT UNLESS h.thisviafield_index(i).name %]
317 #[% 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 %]
318 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 %] }
324 [% FOREACH h = hedges %]
325 [% NEXT UNLESS h.type == 'many2one' %]
326 [% IF seen == 0 ; seen = 1 %]########## many2one ##########[% END %]
328 [% FOREACH thisnode = h.thisnode %]
329 #[% 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 %]
330 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 %] }
336 [% FOREACH h = hedges %]
337 [% NEXT UNLESS h.type == 'many2many' %]
338 [% IF seen == 0 ; seen = 1 %]########## many2many #########[% END %]
340 [% FOREACH thisnode = h.thisnode %]
342 [% FOREACH thatnode = h.thatnode %]
343 #[% 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 %]
344 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 $_->[% h.vianode.table.name %]_[% format_fk(h.vianode,h.thatviafield_index(j).name) %]s, $self->[% h.vianode.table.name %]_[% format_fk(h.vianode,h.thisviafield_index(i).name) %]s }
352 [% MACRO printHasFriendly(node) BLOCK %]
356 #FIXME, why aren't these being generated?
359 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
360 package [% baseclass %];
362 # Created by SQL::Translator::Producer::Turnkey
363 # Template used: classdbi
367 no warnings 'redefine';
368 use base qw(Class::DBI::Pg);
370 [% baseclass %]->set_db('Main', '[% db_dsn %]', '[% db_user %]', '[% db_pass %]');
371 sub search_ilike { shift->_do_search(ILIKE => [% "\@\_" %] ) }
376 foreach my $k (keys %q){
377 $t{"lower($k)"} = lc($q{$k});
379 $c->_do_search(LIKE => %t);
386 my %arg = %{shift @_};
387 $arg{'indent'} ||= 1;
389 $Data::Dumper::Maxdepth = $arg{'depth'} if defined $arg{'depth'};
390 $Data::Dumper::Indent = $arg{'indent'} if defined $arg{'indent'};
391 return(Dumper($arg{'object'}));
394 [% FOREACH node = nodes %]
395 [% printPackage(node.value) %]
401 elsif($type eq 'atom'){
404 [% ###### DOCUMENT START ###### %]
406 [% FOREACH node = nodes %]
407 [% IF !node.value.is_trivial_link %]
409 ##############################################
411 package Turnkey::Atom::[% node.value.name FILTER replace "Turnkey::Model::", "" %];
413 [% pname = node.value.name FILTER replace "Turnkey::Model::", "" %]
415 use base qw(Turnkey::Atom);
424 my $dbobject = shift;
426 # Assumption here that if it's not rendering on it's own dbobject
427 # then it's a list. This will be updated when AtomLists are implemented -boconnor
428 if(ref($dbobject) eq 'Turnkey::Model::[% pname %]') {
430 return(_render_record($dbobject));
432 else { return(_render_list($dbobject)); }
436 my $dbobject = shift;
442 [% FOREACH value = node.value.data_fields %]
444 $field_hash->{[% value.key %]} = $dbobject->[% value.key %]();
449 [% FOREACH value = node.value.edges %]
450 [% NEXT IF value.type != 'import' %]
451 $field_hash->{[% value.thisfield.name %]} = $dbobject->[% value.thisfield.name %]();
454 $row->{data} = $field_hash;
455 $row->{id} = $dbobject->id();
461 my $dbobject = shift;
463 my @objects = $dbobject->[% node.key %]s;
464 foreach my $object (@objects){
469 [% FOREACH value = node.value.data_fields %]
471 $field_hash->{[% value.key %]} = $object->[% value.key %]();
476 [% FOREACH value = node.value.edges %]
477 [% NEXT IF value.type != 'import' %]
478 $field_hash->{[% value.thisfield.name %]} = $object->[% value.thisfield.name %]();
481 $row->{data} = $field_hash;
482 $row->{id} = $object->id();
497 } elsif($type eq 'xml'){
499 <?xml version="1.0" encoding="UTF-8"?>
500 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
503 <!-- The basic layout is fixed -->
504 <container orientation="vertical" type="Container" label="RootContainer">
505 <container orientation="horizontal" type="Container" label="MiddleContainer">
506 <container align="center" class="leftbar" orientation="vertical" type="minor" label="MidLeftContainer"/>
507 <container orientation="vertical" type="major" label="MainContainer"/>
511 <!-- Atom Classes -->
512 [% FOREACH node = nodes %]
513 [% IF !node.value.is_trivial_link %]
514 <atom class="[% format_table(node.key) %]" name="[% format_table(node.key) %]" label="[% format_table(node.key) %]Atom"/>
518 <atom class="Frontpage" name="Frontpage" label="FrontpageAtom"/>
519 <atom class="Search" name="Search" label="SearchAtom"/>
520 <atom class="Userinfo" name="UserInfo" label="UserinfoAtom"/>
524 <!-- Atom Bindings -->
526 [% FOREACH focus_atom = nodes %]
527 [% IF !focus_atom.value.is_trivial_link %]
528 [% FOREACH link_atom = focus_atom.value.hyperedges %]
529 <atomatombinding from="#[% format_table(focus_atom.key) %]Atom" to="#[% format_table(link_atom.thatnode.table.name) %]Atom" label="[% format_table(focus_atom.key) %]Atom2[% format_table(link_atom.thatnode.table.name) %]Atom"/>
532 [% FOREACH link_atom = focus_atom.value.edges %]
533 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
534 <atomatombinding from="#[% format_table(focus_atom.key) %]Atom" to="#[% format_table(link_atom.thatnode.table.name) %]Atom" label="[% format_table(focus_atom.key) %]Atom2[% format_table(link_atom.thatnode.table.name) %]Atom"/>
535 [% previous = link_atom.thatnode.table.name %]
543 [% FOREACH focus_atom = nodes %]
544 [% IF !focus_atom.value.is_trivial_link %]
545 <layout label="[% format_table(focus_atom.key) %]">
546 [% FOREACH link_atom = focus_atom.value.hyperedges %]
547 <placement from="#MidLeftContainer" label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
550 [% FOREACH link_atom = focus_atom.value.edges %]
551 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
552 <placement from="#MidLeftContainer" label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
553 [% previous = link_atom.thatnode.table.name %]
556 <placement from="#MainContainer" label="MainContainer2[% format_table(focus_atom.key) %]Atom" to="#[% format_table(focus_atom.key) %]Atom"/>
561 <layout label="Turnkey::Util::Frontpage">
562 <placement from="#MainContainer" label="MainContainer2AnalysisAtom" to="#FrontpageAtom"/>
564 <layout label="Turnkey::Util::Search">
565 <placement from="#MainContainer" label="MainContainer2AnalysisAtom" to="#SearchAtom"/>
567 <layout label="Turnkey::Util::Userinfo">
568 <placement from="#MainContainer" label="MainContainer2UserinfoAtom" to="#UserinfoAtom"/>
574 <uribinding uri="/db" class="Turnkey::Util::Frontpage"/>
575 <uribinding uri="/db/search" class="Turnkey::Util::Search"/>
576 <uribinding uri="/db/userinfo" class="Turnkey::Util::Userinfo"/>
580 [% FOREACH focus_atom = nodes %]
581 [% IF !focus_atom.value.is_trivial_link %]
582 <classbinding class="[% format_table(focus_atom.key) %]" plugin="#[% format_table(focus_atom.key) %]Atom" rank="0"/>
586 <classbinding class="Turnkey::Util::Frontpage" plugin="#FrontpageAtom" rank="0"/>
587 <classbinding class="Turnkey::Util::Search" plugin="#SearchAtom" rank="0"/>
588 <classbinding class="Turnkey::Util::Userinfo" plugin="#UserinfoAtom" rank="0"/>
595 } elsif($type eq 'template'){
598 [% MACRO renderpanel(panel,name,dbobject) BLOCK %]
599 <!-- begin panel: [% panel.label %] -->
600 [% FOREACH p = panel.containers %]
601 [% IF p.can_render(panel) %]
602 [% IF p.type == 'Container' %]
603 [% renderpanel(p,name,dbobject) %]
605 [% IF p.type == 'major' %]
606 <div class="middle"><div class="column-in">
608 <div class="middle-header">[% name %]</div>
610 <!-- begin atom: [% p.label %] -->
611 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
612 [% renderatom(name,dbobject,p.containers[0]) %]
615 <div class="cleaner"></div>
616 [% ELSIF p.type == 'minor' %]
617 <div class="left"><div class="column-in">
618 [% FOREACH atom = p.containers %]
619 <div class="left-item">
621 [% linkname = ref(p.containers[0]) %]
622 <div class="box-header">[% atom.name | replace('Turnkey::Atom::', '') %]</div>
624 <!-- begin atom: [% p.label %] -->
625 <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
626 [% renderatom(name,dbobject,atom) %]
633 [% IF panel.orientation == 'vertical' %]
638 <!-- end panel: [% panel.label %] -->
641 [% BLOCK make_linked_dbobject %]
643 $stash->set(linked_dbobject => [% class %]->retrieve([% id %]));
646 [% MACRO obj2link(obj) SWITCH ref(obj) %]
651 <a href="[% obj2url(obj) %]">[% obj.name %]</a>
653 <a href="[% obj2url(obj) %]">[% obj %]</a>
656 [% MACRO obj2url(obj) SWITCH obj %]
658 /db/[% ref(obj) | replace('.+::','') %]/[% obj %]
660 <!-- the above method should be updated when additional namespaces are used -->
661 [% MACRO obj2desc(obj) SWITCH ref(obj) %]
671 [% MACRO renderatom(name, dbobject, atom) SWITCH name %]
672 [- FOREACH node = nodes -]
673 [- IF !node.value.is_trivial_link -]
674 [% CASE '[- format_table(node.key) -]' %]
675 [% INCLUDE [- node.key -].tt2 %]
679 [% renderlist(atom.render(dbobject)) %]
681 [% MACRO renderlist(lstArr) BLOCK %]
682 <div class="left-item"><ul>
683 [% FOREACH item = lstArr %]
684 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
686 [% PROCESS make_linked_dbobject %]
687 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>
693 } elsif($type eq 'atomtemplate') {
696 [-- IF !node.is_trivial_link --]
697 [% records = atom.render(dbobject) %]
699 [% IF atom.focus == "yes" %]
700 [% FOREACH record = records %]
701 [% fields = record.data %]
703 [- FOREACH field = node.data_fields -]
704 [- IF field != "1" -]
705 <tr><td class="dbfieldname">[- field.key -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.key -]) %]</td></tr>
708 [- FOREACH field = node.edges -]
709 [- NEXT IF field.type != 'import' -]
710 <tr><td class="dbfieldname">[- field.thisfield.name -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.thisfield.name -]) %]</td></tr>
712 [% IF (rowcount > 1) %] <tr><td colspan="2"><hr></td></tr> [% END %]
713 [% rowcount = rowcount + 1 %]
718 [% FOREACH record = atom.render(dbobject) %]
719 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
720 [% id = record.id #needed by make_linked_dbobject macro %]
721 [% PROCESS make_linked_dbobject %]
722 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>