lib/SQL/Translator/Producer/Turnkey.pm

   1 package SQL::Translator::Producer::Turnkey;
   2
   3 # -------------------------------------------------------------------
   4 # $Id: Turnkey.pm,v 1.9 2003-10-15 16:48:39 kycl4rk Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
   7 #   Brian O'Connor <brian.oconnor@excite.com>.
   8 #
   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.
  12 #
  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.
  17 #
  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
  21 # 02111-1307  USA
  22 # -------------------------------------------------------------------
  23
  24 use strict;
  25 use vars qw[ $VERSION $DEBUG ];
  26 $VERSION = sprintf "%d.%02d", q$Revision: 1.9 $ =~ /(\d+)\.(\d+)/;
  27 $DEBUG   = 1 unless defined $DEBUG;
  28
  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');
  33 use Data::Dumper;
  34 use Template;
  35
  36 my %producer2dsn = (
  37     MySQL      => 'mysql',
  38     PostgreSQL => 'Pg',
  39     Oracle     => 'Oracle',
  40 );
  41
  42 # -------------------------------------------------------------------
  43 sub produce {
  44     my $log           = Log::Log4perl->get_logger('sql.translator');
  45
  46     my $t             = shift;
  47         my $create        = undef;
  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
  53                                                                                                                    );
  54
  55         my $parser_type   = (split /::/, $t->parser_type)[-1];
  56
  57     local $DEBUG      = $t->debug;
  58
  59         my %meta          = (
  60                                                  format_fk => $t->format_fk_name,
  61                                                  template  => $args->{'template'}      || '',
  62                                                  baseclass => $baseclass,
  63                                                  db_user   => $args->{'db_user'}       || '',
  64                                                  db_pass   => $args->{'db_pass'}       || '',
  65                                                  parser    => $t->parser_type,
  66                                                  producer  => __PACKAGE__,
  67                                                  dsn       => $args->{'dsn'} || sprintf( 'dbi:%s:_', $producer2dsn{ $parser_type }
  68                                                                                                                                  ? $producer2dsn{ $parser_type }
  69                                                                                                                                  : $parser_type
  70                                                                                                                            )
  71                                                  );
  72
  73     #
  74     # create methods
  75     #
  76         foreach my $node_from ($graph->node_values){
  77
  78           next unless $node_from->table->is_data or !$node_from->table->is_trivial_link;
  79
  80           foreach my $cedge ( $node_from->compoundedges ){
  81
  82                 my $hyperedge = SQL::Translator::Schema::Graph::HyperEdge->new();
  83
  84                 my $node_to;
  85                 foreach my $edge ($cedge->edges){
  86                   if($edge->thisnode->name eq $node_from->name){
  87                         $hyperedge->vianode($edge->thatnode);
  88
  89                         if($edge->thatnode->name ne $cedge->via->name){
  90                           $node_to ||= $graph->node($edge->thatnode->table->name);
  91                         }
  92
  93                         $hyperedge->push_thisnode($edge->thisnode);
  94                         $hyperedge->push_thisfield($edge->thisfield);
  95                         $hyperedge->push_thisviafield($edge->thatfield);
  96
  97                   } else {
  98                         if($edge->thisnode->name ne $cedge->via->name){
  99                           $node_to ||= $graph->node($edge->thisnode->table->name);
 100                         }
 101                         $hyperedge->push_thatnode($edge->thisnode);
 102                         $hyperedge->push_thatfield($edge->thisfield);
 103                         $hyperedge->push_thatviafield($edge->thatfield);
 104                   }
 105                   $log->debug($edge->thisfield->name);
 106                   $log->debug($edge->thatfield->name);
 107                 }
 108
 109                    if($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('one2one')   }
 110                 elsif($hyperedge->count_thisnode  > 1 and $hyperedge->count_thatnode == 1){ $hyperedge->type('many2one')  }
 111                 elsif($hyperedge->count_thisnode == 1 and $hyperedge->count_thatnode  > 1){ $hyperedge->type('one2many')  }
 112                 elsif($hyperedge->count_thisnode  > 1 and $hyperedge->count_thatnode  > 1){ $hyperedge->type('many2many') }
 113
 114 #warn join "\n", sort keys %::SQL::Translator::Schema::Graph::HyperEdge::;
 115
 116                 #node_to won't always be defined b/c of multiple edges to a single other node
 117                 if(defined($node_to)){
 118                   $log->debug($node_from->name);
 119                   $log->debug($node_to->name);
 120
 121                   if(scalar($hyperedge->thisnode) > 1){
 122                         $log->debug($hyperedge->type ." via ". $hyperedge->vianode->name);
 123                         my $i = 0;
 124                         foreach my $thisnode ( $hyperedge->thisnode ){
 125                           $log->debug($thisnode->name .' '.
 126                                                   $hyperedge->thisfield_index(0)->name .' -> '.
 127                                                   $hyperedge->thisviafield_index($i)->name .' '.
 128                                                   $hyperedge->vianode->name .' '.
 129                                                   $hyperedge->thatviafield_index(0)->name .' <- '.
 130                                                   $hyperedge->thatfield_index(0)->name .' '.
 131                                                   $hyperedge->thatnode_index(0)->name ."\n"
 132                                                  );
 133                           $i++;
 134                         }
 135                   }
 136                   $node_from->push_hyperedges($hyperedge);
 137                 }
 138           }
 139         }
 140
 141         $meta{"nodes"} = $graph->node;
 142         return(translateForm($t, \%meta));
 143 }
 144
 145 sub translateForm {
 146   my $t = shift;
 147   my $meta = shift;
 148   my $args = $t->producer_args;
 149   my $type = $meta->{'template'};
 150   my $tt2;
 151   $tt2 = template($type);
 152   my $template = Template->new({
 153                                                                 PRE_CHOMP => 1,
 154                                                                 POST_CHOMP => 0,
 155                                                                 EVAL_PERL => 1
 156                                                            });
 157
 158   my $result;
 159   $template->process(\$tt2, $meta, \$result) || die $template->error();
 160   return($result);
 161 }
 162
 163 1;
 164
 165 # -------------------------------------------------------------------
 166
 167 =pod
 168
 169 =head1 NAME
 170
 171 SQL::Translator::Producer::Turnkey - create Turnkey classes from schema
 172
 173 =head1 SYNOPSIS
 174
 175 Creates output for use with the Turnkey project.
 176
 177 =head1 SEE ALSO
 178
 179 L<http://turnkey.sourceforge.net>.
 180
 181 =head1 AUTHORS
 182
 183 Allen Day E<lt>allenday@ucla.eduE<gt>
 184 Brian O\'Connor E<lt>brian.oconnor@excite.comE<gt>.
 185
 186 =cut
 187
 188 sub template {
 189   my $type = shift;
 190
 191 ###########################################
 192 # Here documents for the tt2 templates    #
 193 ###########################################
 194
 195   if($type eq 'classdbi'){
 196         return <<EOF;
 197 [% MACRO printPackage(node) BLOCK %]
 198 # --------------------------------------------
 199
 200 package [% node.name %];
 201 use base '[% node.base %]';
 202 use Class::DBI::Pager;
 203
 204 [% node.name %]->set_up_table('[% node.table.name %]');
 205 [% printPKAccessors(node.primary_key, node.table.name) %]
 206 [% printHasA(node.edges, node) %]
 207 [% printHasMany(node.edges, node) %]
 208 [% printHasCompound(node.compoundedges, node.hyperedges, node.name) %]
 209 [% #printHasFriendly(node) %]
 210 [% END %]
 211
 212 [% MACRO printPKAccessors(array, name) BLOCK %]
 213 #
 214 # Primary key accessors
 215 #
 216 [% FOREACH item = array %]
 217 sub id { shift->[% item %] }
 218 sub [% name %] { shift->[% item %] }
 219 [% END %]
 220
 221 [% END %]
 222
 223 [% MACRO printHasA(edges, name) BLOCK %]
 224 #
 225 # Has A
 226 #
 227
 228 [% FOREACH edge = edges %]
 229   [% IF edge.type == 'import' %]
 230 [% node.name %]->has_a([% edge.thisfield.name %] => '[% edge.thatnode.name %]');
 231     [% IF node.has(edge.thatnode.name) < 2 %]
 232 sub [% edge.thatnode.table.name %] { return shift->[% edge.thisfield.name %] }
 233     [% ELSE %]
 234 sub [% format_fk(edge.thisnode.table.name,edge.thisfield.name) %] { return shift->[% edge.thisfield.name %] }
 235     [% END %]
 236
 237   [% END %]
 238 [% END %]
 239
 240 [% END %]
 241
 242 [% MACRO printHasMany(edges, node) BLOCK %]
 243 #
 244 # Has Many
 245 #
 246
 247 [% FOREACH edge = edges %]
 248   [% IF edge.type == 'export' %]
 249 [% node.name %]->has_many([% edge.thatnode.table.name %]_[% edge.thatfield.name %], '[% edge.thatnode.name %]' => '[% edge.thatfield.name %]');
 250     [% IF node.via(edge.thatnode.name) >= 1 %]
 251 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
 252     [% ELSIF edge.thatnode.table.is_data %]
 253       [% IF node.edgecount(edge.thatnode.name) > 1 %]
 254 sub [% edge.thatnode.table.name %]_[% format_fk(edge.thatnode.name,edge.thatfield.name) %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
 255       [% ELSE %]
 256 sub [% edge.thatnode.table.name %]s { return shift->[% edge.thatnode.table.name %]_[% edge.thatfield.name %] }
 257       [% END %]
 258     [% END %]
 259
 260   [% END %]
 261 [% END %]
 262
 263 [% END %]
 264
 265 [% MACRO printHasCompound(cedges,hedges,name) BLOCK %]
 266 #
 267 # Has Compound Many
 268 #
 269 [% FOREACH cedge = cedges %]
 270 [% FOREACH edge = cedge.edges %]
 271   [% NEXT IF edge.thisnode.name != name %]
 272 sub [% cedge.via.table.name %]_[% format_fk(edge.thatnode.table.name,edge.thatfield.name) %]s { return shift->[% cedge.via.table.name %]_[% edge.thatfield.name %] }
 273 [% END %]
 274 [% END %]
 275
 276 [% FOREACH h = hedges %]
 277 ########## [% h.type %] ##########
 278   [% IF h.type == 'one2one' %]
 279 sub [% h.thatnode.table.name %]s { my \$self = shift; return map \$_->[% h.thatviafield.name %], \$self->[% h.vianode.table.name %]_[% h.thisviafield.name %] }
 280
 281   [% ELSIF h.type == 'one2many' %]
 282     [% thisnode = h.thisnode_index(0) %]
 283     [% i = 0 %]
 284     [% FOREACH thatnode = h.thatnode %]
 285 #[% 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 %]
 286 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 %] }
 287       [% i = i + 1 %]
 288     [% END %]
 289
 290   [% ELSIF h.type == 'many2one' %]
 291     [% i = 0 %]
 292     [% FOREACH thisnode = h.thisnode %]
 293 #[% 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 %]
 294 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 %] }
 295       [% i = i + 1 %]
 296
 297     [% END %]
 298
 299   [% ELSIF h.type == 'many2many' %]
 300     [% i = 0 %]
 301     [% FOREACH thisnode = h.thisnode %]
 302       [% j = 0 %]
 303       [% FOREACH thatnode = h.thatnode %]
 304 #[% 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 %]
 305 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->[% %] }
 306         [% j = j + 1 %]
 307
 308       [% END %]
 309       [% i = i + 1 %]
 310     [% END %]
 311   [% END %]
 312 [% END %]
 313
 314 [% END %]
 315
 316 [% MACRO printHasFriendly(node) BLOCK %]
 317 #
 318 # Has Friendly
 319 #
 320 hello, sailor!
 321 [% END %]
 322
 323 [% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
 324 package [% baseclass %];
 325
 326 # Created by SQL::Translator::Producer::Turnkey
 327 # Template used: classdbi
 328
 329 use strict;
 330 use base qw(Class::DBI::Pg);
 331
 332 [% baseclass %]->set_db('Main', '[% db_str  %]', '[% db_user %]', '[% db_pass %]');
 333
 334 [% FOREACH node = nodes %]
 335     [% printPackage(node.value) %]
 336 [% END %]
 337 EOF
 338
 339 } elsif($type eq 'atom'){
 340   return <<'EOF';
 341 [% ###### DOCUMENT START ###### %]
 342
 343 [% FOREACH node = linkable %]
 344
 345 ##############################################
 346
 347 package Durian::Atom::[% node.key FILTER ucfirst %];
 348
 349 [% pname = node.key FILTER ucfirst%]
 350 [% pkey = "Durian::Model::${pname}" %]
 351
 352 use base qw(Durian::Atom);
 353 use Data::Dumper;
 354
 355 sub can_render {
 356         return 1;
 357 }
 358
 359 sub render {
 360         my $self = shift;
 361         my $dbobject = shift;
 362     # Assumption here that if it's not rendering on it's own dbobject
 363     # then it's a list. This will be updated when AtomLists are implemented -boconnor
 364         if(ref($dbobject) eq 'Durian::Model::[% node.key FILTER ucfirst %]') {
 365                 return(_render_record($dbobject));
 366         }
 367         else { return(_render_list($dbobject)); }
 368 }
 369
 370 sub _render_record {
 371         my $dbobject = shift;
 372         my @output = ();
 373         my $row = {};
 374         my $field_hash = {};
 375         [% FOREACH field = nodes.$pkey.columns_essential %]
 376         $field_hash->{[% field %]} = $dbobject->[% field %]();
 377     [% END %]
 378         $row->{data} = $field_hash;
 379         $row->{id} = $dbobject->id();
 380         push @output, $row;
 381         return(\@output);
 382 }
 383
 384 sub _render_list {
 385         my $dbobject = shift;
 386         my @output = ();
 387         my @objects = $dbobject->[% node.key %]s;
 388         foreach my $object (@objects)
 389     {
 390                 my $row = {};
 391             my $field_hash = {};
 392           [% FOREACH field = nodes.$pkey.columns_essential %]
 393                 $field_hash->{[% field %]} = $object->[% field %]();
 394           [% END %]
 395                 $row->{data} = $field_hash;
 396             $row->{id} = $object->id();
 397             push @output, $row;
 398     }
 399         return(\@output);
 400 }
 401
 402 sub head {
 403         return 1;
 404 }
 405
 406 1;
 407
 408 [% END %]
 409 EOF
 410
 411 } elsif($type eq 'xml'){
 412   return <<EOF;
 413 <?xml version="1.0" encoding="UTF-8"?>
 414 <!DOCTYPE Durian SYSTEM "Durian.dtd">
 415 <Durian>
 416
 417 <!-- The basic layout is fixed -->
 418   <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
 419         <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
 420           <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
 421           <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
 422         </container>
 423   </container>
 424
 425 <!-- Atom Classes -->
 426 [% FOREACH node = linkable %]
 427   <atom class="Durian::Atom::[% node.key FILTER ucfirst %]"  name="[% node.key FILTER ucfirst %]" xlink:label="[% node.key FILTER ucfirst %]Atom"/>
 428 [%- END -%]
 429
 430 <!-- Atom Bindings -->
 431 <atomatombindings>
 432 [% FOREACH focus_atom = linkable %]
 433   [% FOREACH link_atom = focus_atom.value %]
 434   <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"/>
 435   [%- END -%]
 436 [%- END -%]
 437 </atomatombindings>
 438
 439 <atomcontainerbindings>
 440 [% FOREACH focus_atom = linkable %]
 441   <atomcontainerbindingslayout xlink:label="Durian::Model::[% focus_atom.key FILTER ucfirst %]">
 442   [% FOREACH link_atom = focus_atom.value %]
 443     <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% link_atom.key FILTER ucfirst %]Atom"  xlink:to="#[% link_atom.key FILTER ucfirst %]Atom"/>
 444   [%- END -%]
 445   <atomcontainerbinding xlink:from="#MainContainer"    xlink:label="MainContainer2[% focus_atom.key FILTER ucfirst %]Atom"    xlink:to="#[% focus_atom.key FILTER ucfirst %]Atom"/>
 446   </atomcontainerbindingslayout>
 447   [%- END -%]
 448 </atomcontainerbindings>
 449
 450 <uribindings>
 451   <uribinding uri="/" class="Durian::Util::Frontpage"/>
 452 </uribindings>
 453
 454 <classbindings>
 455 [% FOREACH focus_atom = linkable %]
 456    <classbinding class="Durian::Model::[% focus_atom.key FILTER ucfirst %]" plugin="#[% focus_atom.key FILTER ucfirst %]Atom" rank="0"/>
 457 [%- END -%]
 458
 459 </classbindings>
 460
 461 </Durian>
 462 EOF
 463
 464 } elsif($type eq 'template'){
 465   return <<'EOF';
 466 [% TAGS [- -] %]
 467 [% MACRO renderpanel(panel,dbobject) BLOCK %]
 468   <!-- begin panel: [% panel.label %] -->
 469   <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 %]">
 470     <tr>
 471     [% FOREACH p = panel.containers %]
 472       [% IF p.can_render(panel) %]
 473         <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
 474           [% IF p.type == 'Container' %]
 475             [% renderpanel(p,dbobject) %]
 476           [% ELSE %]
 477             <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
 478               [% IF p.name %]
 479                 <tr bgcolor="#4444FF" height="1">
 480                   <td><font color="#FFFFFF">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</font></td>
 481                   <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>
 482                 </tr>
 483               [% END %]
 484               <tr><td colspan="2" bgcolor="#FFFFFF">
 485               <!-- begin atom: [% p.label %] -->
 486               <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
 487                 [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
 488               </table>
 489             </table>
 490           [% END %]
 491         </td>
 492         [% IF panel.orientation == 'vertical' %]
 493           </tr><tr>
 494         [% END %]
 495       [% END %]
 496     [% END %]
 497     </tr>
 498   </table>
 499   <!-- end panel: [% panel.label %] -->
 500 [% END %]
 501 [% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
 502   [- FOREACH node = linkable -]
 503     [% CASE '[- node.key FILTER ucfirst -]' %]
 504       [% render[- node.key FILTER ucfirst -]Atom(atom.render(dbobject)) %]
 505   [- END -]
 506     [% CASE DEFAULT %]
 507       [% renderlist(atom.render(dbobject)) %]
 508 [% END %]
 509 [- FOREACH node = linkable -]
 510 [% MACRO render[- node.key FILTER ucfirst -]Atom(lstArr) BLOCK %]
 511   [% FOREACH record = lstArr %]
 512     [% fields = record.data %]
 513     [- pname = node.key FILTER ucfirst -]
 514     [- pkey = "Durian::Model::${pname}" -]
 515     [- FOREACH field = nodes.$pkey.columns_essential -]
 516       <tr><td><b>[- field -]</b></td><td>[% fields.[- field -] %]</td></tr>
 517     [- END -]
 518     [% id = record.id %]
 519     <tr><td><a href="?id=[% id %];class=Durian::Model::[- node.key FILTER ucfirst -]">Link</a></td><td></td></tr>
 520   [% END %]
 521 [% END %]
 522 [- END -]
 523 [% MACRO renderlist(lstArr) BLOCK %]
 524   [%  FOREACH item = lstArr %]
 525     <tr>[% item %]</tr>
 526   [% END %]
 527 [% END %]
 528 EOF
 529
 530 1;
 531
 532 }
 533 }