1 package SQL::Translator::Producer::Turnkey;
3 # -------------------------------------------------------------------
4 # $Id: Turnkey.pm,v 1.61 2004-10-13 23:14:06 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.61 $ =~ /(\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 # -------------------------------------------------------------------
47 my $args = $t->producer_args;
48 my $no_comments = $t->no_comments;
49 my $baseclass = $args->{'main_pkg_name'} || $t->format_package_name('DBI');
50 my $graph = SQL::Translator::Schema::Graph->new(translator => $t);
52 my $parser_type = (split /::/, $t->parser_type)[-1];
54 local $DEBUG = $t->debug;
57 concat => $args->{'concat'} || '',
58 format_fk => $t->format_fk_name,
59 format_package => $t->format_package_name,
60 format_table => $t->format_table_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 }
75 foreach my $node ($graph->node()){
76 $node->base($baseclass);
79 $meta{"nodes"} = $graph->node;
80 return(translateForm($t, \%meta));
87 my $args = $t->producer_args;
88 my $type = $meta->{'template'};
90 my $template = Template->new({
97 $tt2 = template($type);
100 if ($type eq 'atomtemplate') {
102 foreach my $node (values %{ $meta->{'nodes'} }) {
104 my $param = { node => $node };
105 $template->process(\$tt2, $param, \$result) || die $template->error();
106 $result =~ s/^\s*(.+)\s*$/$1/s;
108 $result{$node->table->name} = $result;
112 $template->process(\$tt2, $meta, \$result) || die $template->error();
115 #warn $result if $type eq 'dbi';
122 # -------------------------------------------------------------------
128 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
132 Creates output for use with the Turnkey project.
136 L<http://turnkey.sourceforge.net>.
140 Allen Day E<lt>allenday@ucla.eduE<gt>
141 Brian O\'Connor E<lt>boconnor@ucla.comE<gt>.
148 ###########################################
149 # Here documents for the tt2 templates #
150 ###########################################
154 [% MACRO printPackage(node) BLOCK %]
156 ########[% node.table.name | ucfirst #node.name | replace("Turnkey${concat}::Model::", '') %]########
158 package [% node.name %];
159 use base '[% node.base %]';
160 use Class::DBI::Pager;
161 no warnings qw(redefine);
163 [% node.name %]->set_up_table('[% node.table.name %]');
164 [% printPKAccessors(node.primary_key, node.table.name) %]
165 [% printHasA(node.edges, node) %]
166 [% printHasMany(node.edges, node) %]
167 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
168 [% #printHasFriendly(node) %]
170 [% MACRO printPKAccessors(array, name) BLOCK %]
172 # Primary key accessors
175 [% FOREACH item = array %]
176 [% IF item != "id" %]sub id { shift->[% item %] }[% END %]
177 [% IF item != name %]sub [% name %] { shift->[% item %] }[% END %]
181 [% MACRO printHasA(edges, name) BLOCK %]
182 [% FOREACH edge = edges %]
183 [% IF loop.first() %]
189 [% IF edge.type == 'import' %]
190 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
191 [% IF node.has(edge.thatnode.name) < 2 %]
192 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
194 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
201 [% MACRO printHasMany(edges, node) BLOCK %]
202 [% FOREACH edge = edges %]
203 [% IF loop.first() %]
209 [% IF edge.type == 'export' %]
210 [% node.name %]->has_many('[% edge.thatnode.table.name %]_[% edge.thatfield.name %]', '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
211 [% IF node.via(edge.thatnode.name) >= 1 %]
212 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
213 [% ELSIF edge.thatnode.table.is_data %]
214 [% IF node.edgecount(edge.thatnode.name) > 1 %]
215 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
217 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
225 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
226 [% FOREACH cedge = cedges %]
227 [% IF loop.first() %]
232 [% FOREACH edge = cedge.edges %]
233 [% NEXT IF edge.thisnode.name != name %]
234 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
239 [% FOREACH h = hedges %]
240 [% NEXT UNLESS h.type == 'one2one' %]
241 [% IF seen == 0 ; seen = 1 %]# one2one #[% END %]
242 sub [% h.thatnode.table.name %]s { my $self = shift; return map $_->[% h.thatviafield.name %], $self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
246 [% FOREACH h = hedges %]
247 [% NEXT UNLESS h.type == 'one2many' %]
248 [% IF seen == 0 ; seen = 1 %]# one2many #[% END %]
249 [% thisnode = h.thisnode_index(0) %]
251 [% FOREACH thatnode = h.thatnode %]
252 [% NEXT UNLESS h.thisviafield_index(i).name %]
253 #[% 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 %]
254 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 %] }
260 [% FOREACH h = hedges %]
261 [% NEXT UNLESS h.type == 'many2one' %]
262 [% IF seen == 0 ; seen = 1 %]# many2one #[% END %]
264 [% FOREACH thisnode = h.thisnode %]
265 #[% 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 %]
266 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 %] }
272 [% FOREACH h = hedges %]
273 [% NEXT UNLESS h.type == 'many2many' %]
274 [% IF seen == 0 ; seen = 1 %]# many2many #[% END %]
276 [% FOREACH thisnode = h.thisnode %]
278 [% FOREACH thatnode = h.thatnode %]
279 #[% 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 %]
280 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 }
288 [% MACRO printHasFriendly(node) BLOCK %]
292 #FIXME, why aren't these being generated?
295 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
297 ########AutoDBI########
298 use Turnkey[% concat %]::Model::DBI;
299 [% FOREACH node = nodes %]
300 use [% node.value.name %];
305 package [% baseclass %];
307 # Created by SQL::Translator::Producer::Turnkey
308 # Template used: classdbi
312 no warnings 'redefine';
313 use base qw(Class::DBI::Pg);
315 [% baseclass %]->set_db('Main', '[% db_dsn %]', '[% db_user %]', '[% db_pass %]');
316 sub search_ilike { shift->_do_search(ILIKE => [% "\@\_" %] ) }
321 foreach my $k (keys %q){
322 $t{"lower($k)"} = lc($q{$k});
324 $c->_do_search(LIKE => %t);
331 my %arg = %{shift @_};
332 $arg{'indent'} ||= 1;
334 $Data::Dumper::Maxdepth = $arg{'depth'} if defined $arg{'depth'};
335 $Data::Dumper::Indent = $arg{'indent'} if defined $arg{'indent'};
336 return(Dumper($arg{'object'}));
341 [% FOREACH node = nodes %][% printPackage(node.value) %][% END %]
345 elsif($type eq 'soap'){
347 [% FOREACH node = nodes %][% node.value.name %], [%- END -%]
351 elsif($type eq 'atom'){
354 [% # DOCUMENT START # %]
356 ########AutoAtom########
357 [% FOREACH node = nodes %]
358 use [% node.value.name %];
362 [% FOREACH node = nodes %]
363 [% IF !node.value.is_trivial_link %]
365 ########[% node.value.name | replace('.+::', '') %]########
367 package Turnkey[% concat %]::Atom::[% node.value.name FILTER replace '.+::', '' %];
369 [% pname = node.value.name FILTER replace '.+::', '' %]
371 use base qw(Turnkey[% concat %]::Atom);
380 my $dbobject = shift;
382 # Assumption here that if it's not rendering on it's own dbobject
383 # then it's a list. This will be updated when AtomLists are implemented -boconnor
384 if(ref($dbobject) eq 'Turnkey[% concat %]::Model::[% pname %]') {
386 return(_render_record($dbobject));
388 else { return(_render_list($dbobject)); }
392 my $dbobject = shift;
398 [% FOREACH value = node.value.data_fields %]
400 $field_hash->{[% value.key %]} = $dbobject->[% value.key %]();
405 [% FOREACH value = node.value.edges %]
406 [% NEXT IF value.type != 'import' %]
407 $field_hash->{[% value.thisfield.name %]} = $dbobject->[% value.thisfield.name %]();
410 $row->{data} = $field_hash;
411 $row->{id} = $dbobject->id();
417 my $dbobject = shift;
419 my @objects = $dbobject->[% node.key %]s;
420 foreach my $object (@objects){
425 [% FOREACH value = node.value.data_fields %]
427 $field_hash->{[% value.key %]} = $object->[% value.key %]();
432 [% FOREACH value = node.value.edges %]
433 [% NEXT IF value.type != 'import' %]
434 $field_hash->{[% value.thisfield.name %]} = $object->[% value.thisfield.name %]();
437 $row->{data} = $field_hash;
438 $row->{id} = $object->id();
453 } elsif($type eq 'xml'){
455 <?xml version="1.0" encoding="UTF-8"?>
456 <!DOCTYPE Turnkey SYSTEM "Turnkey.dtd">
459 <!-- The basic layout is fixed -->
460 <container orientation="vertical" type="Container" label="RootContainer">
461 <container orientation="horizontal" type="Container" label="MiddleContainer">
462 <container align="center" class="leftbar" orientation="vertical" type="minor" label="MidLeftContainer"/>
463 <container orientation="vertical" type="major" label="MainContainer"/>
467 <!-- Atom Classes -->
468 [% FOREACH node = nodes %]
469 [% IF !node.value.is_trivial_link %]
470 <atom class="[% format_table(node.key) %]" name="[% format_table(node.key) %]" label="[% format_table(node.key) %]Atom"/>
474 <atom class="Frontpage" name="Frontpage" label="FrontpageAtom"/>
475 <atom class="Search" name="Search" label="SearchAtom"/>
476 <atom class="Userinfo" name="UserInfo" label="UserinfoAtom"/>
480 <!-- Atom Bindings -->
482 [% FOREACH focus_atom = nodes %]
483 [% IF !focus_atom.value.is_trivial_link %]
484 [% FOREACH link_atom = focus_atom.value.hyperedges %]
485 <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"/>
488 [% FOREACH link_atom = focus_atom.value.edges %]
489 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name && link_atom.thatnode.table.name != "" %]
490 <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"/>
491 [% previous = link_atom.thatnode.table.name %]
499 [% FOREACH focus_atom = nodes %]
500 [% IF !focus_atom.value.is_trivial_link %]
501 <layout label="[% format_table(focus_atom.key) %]">
502 [% FOREACH link_atom = focus_atom.value.hyperedges %]
503 <placement from="#MidLeftContainer" label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
506 [% FOREACH link_atom = focus_atom.value.edges %]
507 [% IF link_atom.type == 'export' && previous != link_atom.thatnode.table.name %]
508 <placement from="#MidLeftContainer" label="MidLeftContainer2[% format_table(link_atom.thatnode.table.name) %]Atom" to="#[% format_table(link_atom.thatnode.table.name) %]Atom"/>
509 [% previous = link_atom.thatnode.table.name %]
512 <placement from="#MainContainer" label="MainContainer2[% format_table(focus_atom.key) %]Atom" to="#[% format_table(focus_atom.key) %]Atom"/>
516 <!-- custom FIXME remove -->
517 <layout label="Turnkey[% concat%]::Util::Frontpage">
518 <placement from="#MainContainer" label="MainContainer2AnalysisAtom" to="#FrontpageAtom"/>
520 <layout label="Turnkey[% concat %]::Util::Search">
521 <placement from="#MainContainer" label="MainContainer2AnalysisAtom" to="#SearchAtom"/>
523 <layout label="Turnkey[% concat %]::Util::Userinfo">
524 <placement from="#MainContainer" label="MainContainer2UserinfoAtom" to="#UserinfoAtom"/>
530 <uribinding uri="/db" class="Turnkey[% concat%]::Util::Frontpage"/>
531 <uribinding uri="/db/search" class="Turnkey[% concat %]::Util::Search"/>
532 <uribinding uri="/db/userinfo" class="Turnkey[% concat %]::Util::Userinfo"/>
536 [% FOREACH focus_atom = nodes %]
537 [% IF !focus_atom.value.is_trivial_link %]
538 <classbinding class="[% format_table(focus_atom.key) %]" plugin="#[% format_table(focus_atom.key) %]Atom" rank="0"/>
542 <classbinding class="Turnkey[% concat %]::Util::Frontpage" plugin="#FrontpageAtom" rank="0"/>
543 <classbinding class="Turnkey[% concat %]::Util::Search" plugin="#SearchAtom" rank="0"/>
544 <classbinding class="Turnkey[% concat %]::Util::Userinfo" plugin="#UserinfoAtom" rank="0"/>
551 } elsif($type eq 'template'){
554 [% MACRO renderpanel(panel,name,dbobject) BLOCK %]
555 <!-- begin panel: [% panel.label %] -->
556 [% FOREACH p = panel.containers %]
557 [% IF p.can_render(panel) %]
558 [% IF p.type == 'Container' %]
559 [% renderpanel(p,name,dbobject) %]
561 [% IF p.type == 'major' %]
562 <div class="middle"><div class="column-in">
564 <div class="middle-header">[% name %]</div>
566 <!-- begin atom: [% p.label %] -->
567 <!-- table cellpadding="0" cellspacing="0" width="100%" --><!-- [% ref(atom) %] [% ref(dbobject) %] -->
568 [% renderatom(name,dbobject,p.containers[0]) %]
571 <div class="cleaner"></div>
572 [% ELSIF p.type == 'minor' %]
573 <div class="left"><div class="column-in">
574 [% FOREACH atom = p.containers %]
575 <div class="left-item">
577 [% linkname = ref(p.containers[0]) %]
578 <div class="box-header">[% atom.name | replace("Turnkey${concat}::Atom::", '') %]</div>
580 <!-- begin atom: [% p.label %] -->
581 <!-- table cellpadding="0" cellspacing="0" width="100%" --><!-- [% ref(atom) %] [% ref(dbobject) %] -->
582 [% renderatom(name,dbobject,atom) %]
589 [% IF panel.orientation == 'vertical' %]
594 <!-- end panel: [% panel.label %] -->
597 [% BLOCK make_linked_dbobject %]
599 $stash->set(linked_dbobject => [% class %]->retrieve([% id %]));
602 [% MACRO obj2link(obj) SWITCH ref(obj) %]
607 <a href="[% obj2url(obj) %]">[% obj.name %]</a>
609 <a href="[% obj2url(obj) %]">[% obj %]</a>
612 [% MACRO obj2url(obj) SWITCH obj %]
614 /db/[% ref(obj) | replace('.+::','') %]/[% obj %]
616 <!-- the above method should be updated when additional namespaces are used -->
617 [% MACRO obj2desc(obj) SWITCH ref(obj) %]
627 [% MACRO renderatom(name, dbobject, atom) SWITCH name %]
628 [- FOREACH node = nodes -]
629 [- IF !node.value.is_trivial_link -]
630 [% CASE '[- format_table(node.key) -]' %]
631 [% INCLUDE [- format_table(node.key) | lower -].tt2 %]
635 [% renderlist(atom.render(dbobject)) %]
637 [% MACRO renderlist(lstArr) BLOCK %]
638 <div class="left-item">
640 [% FOREACH item = lstArr %]
641 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
643 [% PROCESS make_linked_dbobject %]
644 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>
651 } elsif($type eq 'atomtemplate') {
654 [-- IF !node.is_trivial_link --]
655 [% records = atom.render(dbobject) %]
657 [% IF atom.focus == "yes" %]
658 [% FOREACH record = records %]
659 [% fields = record.data %]
661 [- FOREACH field = node.data_fields -]
662 [- IF field != "1" -]
663 <tr><td class="dbfieldname">[- field.key -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.key -]) %]</td></tr>
666 [- FOREACH field = node.edges -]
667 [- NEXT IF field.type != 'import' -]
668 <tr><td class="dbfieldname">[- field.thisfield.name -]</td><td class="dbfieldvalue">[% obj2link(fields.[- field.thisfield.name -]) %]</td></tr>
670 [% IF (rowcount > 1) %] <tr><td colspan="2"><hr></td></tr> [% END %]
671 [% rowcount = rowcount + 1 %]
676 [% FOREACH record = atom.render(dbobject) %]
677 [% class = ref(atom) | replace('::Atom::', '::Model::') %]
678 [% id = record.id #needed by make_linked_dbobject macro %]
679 [% PROCESS make_linked_dbobject %]
680 <li class="minorfocus">[% obj2link(linked_dbobject) %]</li>