774c922ae3d5c8ab613d804987fdf5857b3e43a4
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI.pm
1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
3
4 use base 'DBIx::Class::Storage';
5
6 use strict;    
7 use warnings;
8 use DBI;
9 use SQL::Abstract::Limit;
10 use DBIx::Class::Storage::DBI::Cursor;
11 use DBIx::Class::Storage::Statistics;
12 use IO::File;
13 use Scalar::Util 'blessed';
14
15 __PACKAGE__->mk_group_accessors(
16   'simple' =>
17     qw/_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid _conn_tid
18        disable_sth_caching cursor on_connect_do transaction_depth/
19 );
20
21 BEGIN {
22
23 package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
24
25 use base qw/SQL::Abstract::Limit/;
26
27 # This prevents the caching of $dbh in S::A::L, I believe
28 sub new {
29   my $self = shift->SUPER::new(@_);
30
31   # If limit_dialect is a ref (like a $dbh), go ahead and replace
32   #   it with what it resolves to:
33   $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
34     if ref $self->{limit_dialect};
35
36   $self;
37 }
38
39 sub _RowNumberOver {
40   my ($self, $sql, $order, $rows, $offset ) = @_;
41
42   $offset += 1;
43   my $last = $rows + $offset;
44   my ( $order_by ) = $self->_order_by( $order );
45
46   $sql = <<"";
47 SELECT * FROM
48 (
49    SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
50       $sql
51       $order_by
52    ) Q1
53 ) Q2
54 WHERE ROW_NUM BETWEEN $offset AND $last
55
56   return $sql;
57 }
58
59
60 # While we're at it, this should make LIMIT queries more efficient,
61 #  without digging into things too deeply
62 use Scalar::Util 'blessed';
63 sub _find_syntax {
64   my ($self, $syntax) = @_;
65   my $dbhname = blessed($syntax) ?  $syntax->{Driver}{Name} : $syntax;
66   if(ref($self) && $dbhname && $dbhname eq 'DB2') {
67     return 'RowNumberOver';
68   }
69
70   $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
71 }
72
73 sub select {
74   my ($self, $table, $fields, $where, $order, @rest) = @_;
75   $table = $self->_quote($table) unless ref($table);
76   local $self->{rownum_hack_count} = 1
77     if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
78   @rest = (-1) unless defined $rest[0];
79   die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
80     # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
81   local $self->{having_bind} = [];
82   my ($sql, @ret) = $self->SUPER::select(
83     $table, $self->_recurse_fields($fields), $where, $order, @rest
84   );
85   return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
86 }
87
88 sub insert {
89   my $self = shift;
90   my $table = shift;
91   $table = $self->_quote($table) unless ref($table);
92   $self->SUPER::insert($table, @_);
93 }
94
95 sub update {
96   my $self = shift;
97   my $table = shift;
98   $table = $self->_quote($table) unless ref($table);
99   $self->SUPER::update($table, @_);
100 }
101
102 sub delete {
103   my $self = shift;
104   my $table = shift;
105   $table = $self->_quote($table) unless ref($table);
106   $self->SUPER::delete($table, @_);
107 }
108
109 sub _emulate_limit {
110   my $self = shift;
111   if ($_[3] == -1) {
112     return $_[1].$self->_order_by($_[2]);
113   } else {
114     return $self->SUPER::_emulate_limit(@_);
115   }
116 }
117
118 sub _recurse_fields {
119   my ($self, $fields) = @_;
120   my $ref = ref $fields;
121   return $self->_quote($fields) unless $ref;
122   return $$fields if $ref eq 'SCALAR';
123
124   if ($ref eq 'ARRAY') {
125     return join(', ', map {
126       $self->_recurse_fields($_)
127       .(exists $self->{rownum_hack_count}
128          ? ' AS col'.$self->{rownum_hack_count}++
129          : '')
130      } @$fields);
131   } elsif ($ref eq 'HASH') {
132     foreach my $func (keys %$fields) {
133       return $self->_sqlcase($func)
134         .'( '.$self->_recurse_fields($fields->{$func}).' )';
135     }
136   }
137 }
138
139 sub _order_by {
140   my $self = shift;
141   my $ret = '';
142   my @extra;
143   if (ref $_[0] eq 'HASH') {
144     if (defined $_[0]->{group_by}) {
145       $ret = $self->_sqlcase(' group by ')
146                .$self->_recurse_fields($_[0]->{group_by});
147     }
148     if (defined $_[0]->{having}) {
149       my $frag;
150       ($frag, @extra) = $self->_recurse_where($_[0]->{having});
151       push(@{$self->{having_bind}}, @extra);
152       $ret .= $self->_sqlcase(' having ').$frag;
153     }
154     if (defined $_[0]->{order_by}) {
155       $ret .= $self->_order_by($_[0]->{order_by});
156     }
157   } elsif (ref $_[0] eq 'SCALAR') {
158     $ret = $self->_sqlcase(' order by ').${ $_[0] };
159   } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
160     my @order = @{+shift};
161     $ret = $self->_sqlcase(' order by ')
162           .join(', ', map {
163                         my $r = $self->_order_by($_, @_);
164                         $r =~ s/^ ?ORDER BY //i;
165                         $r;
166                       } @order);
167   } else {
168     $ret = $self->SUPER::_order_by(@_);
169   }
170   return $ret;
171 }
172
173 sub _order_directions {
174   my ($self, $order) = @_;
175   $order = $order->{order_by} if ref $order eq 'HASH';
176   return $self->SUPER::_order_directions($order);
177 }
178
179 sub _table {
180   my ($self, $from) = @_;
181   if (ref $from eq 'ARRAY') {
182     return $self->_recurse_from(@$from);
183   } elsif (ref $from eq 'HASH') {
184     return $self->_make_as($from);
185   } else {
186     return $from; # would love to quote here but _table ends up getting called
187                   # twice during an ->select without a limit clause due to
188                   # the way S::A::Limit->select works. should maybe consider
189                   # bypassing this and doing S::A::select($self, ...) in
190                   # our select method above. meantime, quoting shims have
191                   # been added to select/insert/update/delete here
192   }
193 }
194
195 sub _recurse_from {
196   my ($self, $from, @join) = @_;
197   my @sqlf;
198   push(@sqlf, $self->_make_as($from));
199   foreach my $j (@join) {
200     my ($to, $on) = @$j;
201
202     # check whether a join type exists
203     my $join_clause = '';
204     my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
205     if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
206       $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
207     } else {
208       $join_clause = ' JOIN ';
209     }
210     push(@sqlf, $join_clause);
211
212     if (ref $to eq 'ARRAY') {
213       push(@sqlf, '(', $self->_recurse_from(@$to), ')');
214     } else {
215       push(@sqlf, $self->_make_as($to));
216     }
217     push(@sqlf, ' ON ', $self->_join_condition($on));
218   }
219   return join('', @sqlf);
220 }
221
222 sub _make_as {
223   my ($self, $from) = @_;
224   return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
225                      reverse each %{$self->_skip_options($from)});
226 }
227
228 sub _skip_options {
229   my ($self, $hash) = @_;
230   my $clean_hash = {};
231   $clean_hash->{$_} = $hash->{$_}
232     for grep {!/^-/} keys %$hash;
233   return $clean_hash;
234 }
235
236 sub _join_condition {
237   my ($self, $cond) = @_;
238   if (ref $cond eq 'HASH') {
239     my %j;
240     for (keys %$cond) {
241       my $v = $cond->{$_};
242       if (ref $v) {
243         # XXX no throw_exception() in this package and croak() fails with strange results
244         Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
245             if ref($v) ne 'SCALAR';
246         $j{$_} = $v;
247       }
248       else {
249         my $x = '= '.$self->_quote($v); $j{$_} = \$x;
250       }
251     };
252     return scalar($self->_recurse_where(\%j));
253   } elsif (ref $cond eq 'ARRAY') {
254     return join(' OR ', map { $self->_join_condition($_) } @$cond);
255   } else {
256     die "Can't handle this yet!";
257   }
258 }
259
260 sub _quote {
261   my ($self, $label) = @_;
262   return '' unless defined $label;
263   return "*" if $label eq '*';
264   return $label unless $self->{quote_char};
265   if(ref $self->{quote_char} eq "ARRAY"){
266     return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
267       if !defined $self->{name_sep};
268     my $sep = $self->{name_sep};
269     return join($self->{name_sep},
270         map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1]  }
271        split(/\Q$sep\E/,$label));
272   }
273   return $self->SUPER::_quote($label);
274 }
275
276 sub limit_dialect {
277     my $self = shift;
278     $self->{limit_dialect} = shift if @_;
279     return $self->{limit_dialect};
280 }
281
282 sub quote_char {
283     my $self = shift;
284     $self->{quote_char} = shift if @_;
285     return $self->{quote_char};
286 }
287
288 sub name_sep {
289     my $self = shift;
290     $self->{name_sep} = shift if @_;
291     return $self->{name_sep};
292 }
293
294 } # End of BEGIN block
295
296 =head1 NAME
297
298 DBIx::Class::Storage::DBI - DBI storage handler
299
300 =head1 SYNOPSIS
301
302 =head1 DESCRIPTION
303
304 This class represents the connection to an RDBMS via L<DBI>.  See
305 L<DBIx::Class::Storage> for general information.  This pod only
306 documents DBI-specific methods and behaviors.
307
308 =head1 METHODS
309
310 =cut
311
312 sub new {
313   my $new = shift->next::method(@_);
314
315   $new->cursor("DBIx::Class::Storage::DBI::Cursor");
316   $new->transaction_depth(0);
317   $new->_sql_maker_opts({});
318   $new->{_in_dbh_do} = 0;
319   $new->{_dbh_gen} = 0;
320
321   $new;
322 }
323
324 =head2 connect_info
325
326 The arguments of C<connect_info> are always a single array reference.
327
328 This is normally accessed via L<DBIx::Class::Schema/connection>, which
329 encapsulates its argument list in an arrayref before calling
330 C<connect_info> here.
331
332 The arrayref can either contain the same set of arguments one would
333 normally pass to L<DBI/connect>, or a lone code reference which returns
334 a connected database handle.
335
336 In either case, if the final argument in your connect_info happens
337 to be a hashref, C<connect_info> will look there for several
338 connection-specific options:
339
340 =over 4
341
342 =item on_connect_do
343
344 This can be set to an arrayref of literal sql statements, which will
345 be executed immediately after making the connection to the database
346 every time we [re-]connect.
347
348 =item disable_sth_caching
349
350 If set to a true value, this option will disable the caching of
351 statement handles via L<DBI/prepare_cached>.
352
353 =item limit_dialect 
354
355 Sets the limit dialect. This is useful for JDBC-bridge among others
356 where the remote SQL-dialect cannot be determined by the name of the
357 driver alone.
358
359 =item quote_char
360
361 Specifies what characters to use to quote table and column names. If 
362 you use this you will want to specify L<name_sep> as well.
363
364 quote_char expects either a single character, in which case is it is placed
365 on either side of the table/column, or an arrayref of length 2 in which case the
366 table/column name is placed between the elements.
367
368 For example under MySQL you'd use C<quote_char =E<gt> '`'>, and user SQL Server you'd 
369 use C<quote_char =E<gt> [qw/[ ]/]>.
370
371 =item name_sep
372
373 This only needs to be used in conjunction with L<quote_char>, and is used to 
374 specify the charecter that seperates elements (schemas, tables, columns) from 
375 each other. In most cases this is simply a C<.>.
376
377 =back
378
379 These options can be mixed in with your other L<DBI> connection attributes,
380 or placed in a seperate hashref after all other normal L<DBI> connection
381 arguments.
382
383 Every time C<connect_info> is invoked, any previous settings for
384 these options will be cleared before setting the new ones, regardless of
385 whether any options are specified in the new C<connect_info>.
386
387 Important note:  DBIC expects the returned database handle provided by 
388 a subref argument to have RaiseError set on it.  If it doesn't, things
389 might not work very well, YMMV.  If you don't use a subref, DBIC will
390 force this setting for you anyways.  Setting HandleError to anything
391 other than simple exception object wrapper might cause problems too.
392
393 Examples:
394
395   # Simple SQLite connection
396   ->connect_info([ 'dbi:SQLite:./foo.db' ]);
397
398   # Connect via subref
399   ->connect_info([ sub { DBI->connect(...) } ]);
400
401   # A bit more complicated
402   ->connect_info(
403     [
404       'dbi:Pg:dbname=foo',
405       'postgres',
406       'my_pg_password',
407       { AutoCommit => 0 },
408       { quote_char => q{"}, name_sep => q{.} },
409     ]
410   );
411
412   # Equivalent to the previous example
413   ->connect_info(
414     [
415       'dbi:Pg:dbname=foo',
416       'postgres',
417       'my_pg_password',
418       { AutoCommit => 0, quote_char => q{"}, name_sep => q{.} },
419     ]
420   );
421
422   # Subref + DBIC-specific connection options
423   ->connect_info(
424     [
425       sub { DBI->connect(...) },
426       {
427           quote_char => q{`},
428           name_sep => q{@},
429           on_connect_do => ['SET search_path TO myschema,otherschema,public'],
430           disable_sth_caching => 1,
431       },
432     ]
433   );
434
435 =cut
436
437 sub connect_info {
438   my ($self, $info_arg) = @_;
439
440   return $self->_connect_info if !$info_arg;
441
442   # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
443   #  the new set of options
444   $self->_sql_maker(undef);
445   $self->_sql_maker_opts({});
446
447   my $info = [ @$info_arg ]; # copy because we can alter it
448   my $last_info = $info->[-1];
449   if(ref $last_info eq 'HASH') {
450     for my $storage_opt (qw/on_connect_do disable_sth_caching/) {
451       if(my $value = delete $last_info->{$storage_opt}) {
452         $self->$storage_opt($value);
453       }
454     }
455     for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
456       if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
457         $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
458       }
459     }
460
461     # Get rid of any trailing empty hashref
462     pop(@$info) if !keys %$last_info;
463   }
464
465   $self->_connect_info($info);
466 }
467
468 =head2 on_connect_do
469
470 This method is deprecated in favor of setting via L</connect_info>.
471
472 =head2 dbh_do
473
474 Arguments: $subref, @extra_coderef_args?
475
476 Execute the given subref using the new exception-based connection management.
477
478 The first two arguments will be the storage object that C<dbh_do> was called
479 on and a database handle to use.  Any additional arguments will be passed
480 verbatim to the called subref as arguments 2 and onwards.
481
482 Using this (instead of $self->_dbh or $self->dbh) ensures correct
483 exception handling and reconnection (or failover in future subclasses).
484
485 Your subref should have no side-effects outside of the database, as
486 there is the potential for your subref to be partially double-executed
487 if the database connection was stale/dysfunctional.
488
489 Example:
490
491   my @stuff = $schema->storage->dbh_do(
492     sub {
493       my ($storage, $dbh, @cols) = @_;
494       my $cols = join(q{, }, @cols);
495       $dbh->selectrow_array("SELECT $cols FROM foo");
496     },
497     @column_list
498   );
499
500 =cut
501
502 sub dbh_do {
503   my $self = shift;
504   my $coderef = shift;
505
506   ref $coderef eq 'CODE' or $self->throw_exception
507     ('$coderef must be a CODE reference');
508
509   return $coderef->($self, $self->_dbh, @_) if $self->{_in_dbh_do};
510   local $self->{_in_dbh_do} = 1;
511
512   my @result;
513   my $want_array = wantarray;
514
515   eval {
516     $self->_verify_pid if $self->_dbh;
517     $self->_populate_dbh if !$self->_dbh;
518     if($want_array) {
519         @result = $coderef->($self, $self->_dbh, @_);
520     }
521     elsif(defined $want_array) {
522         $result[0] = $coderef->($self, $self->_dbh, @_);
523     }
524     else {
525         $coderef->($self, $self->_dbh, @_);
526     }
527   };
528
529   my $exception = $@;
530   if(!$exception) { return $want_array ? @result : $result[0] }
531
532   $self->throw_exception($exception) if $self->connected;
533
534   # We were not connected - reconnect and retry, but let any
535   #  exception fall right through this time
536   $self->_populate_dbh;
537   $coderef->($self, $self->_dbh, @_);
538 }
539
540 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
541 # It also informs dbh_do to bypass itself while under the direction of txn_do,
542 #  via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
543 sub txn_do {
544   my $self = shift;
545   my $coderef = shift;
546
547   ref $coderef eq 'CODE' or $self->throw_exception
548     ('$coderef must be a CODE reference');
549
550   local $self->{_in_dbh_do} = 1;
551
552   my @result;
553   my $want_array = wantarray;
554
555   my $tried = 0;
556   while(1) {
557     eval {
558       $self->_verify_pid if $self->_dbh;
559       $self->_populate_dbh if !$self->_dbh;
560
561       $self->txn_begin;
562       if($want_array) {
563           @result = $coderef->(@_);
564       }
565       elsif(defined $want_array) {
566           $result[0] = $coderef->(@_);
567       }
568       else {
569           $coderef->(@_);
570       }
571       $self->txn_commit;
572     };
573
574     my $exception = $@;
575     if(!$exception) { return $want_array ? @result : $result[0] }
576
577     if($tried++ > 0 || $self->connected) {
578       eval { $self->txn_rollback };
579       my $rollback_exception = $@;
580       if($rollback_exception) {
581         my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
582         $self->throw_exception($exception)  # propagate nested rollback
583           if $rollback_exception =~ /$exception_class/;
584
585         $self->throw_exception(
586           "Transaction aborted: ${exception}. "
587           . "Rollback failed: ${rollback_exception}"
588         );
589       }
590       $self->throw_exception($exception)
591     }
592
593     # We were not connected, and was first try - reconnect and retry
594     # via the while loop
595     $self->_populate_dbh;
596   }
597 }
598
599 =head2 disconnect
600
601 Our C<disconnect> method also performs a rollback first if the
602 database is not in C<AutoCommit> mode.
603
604 =cut
605
606 sub disconnect {
607   my ($self) = @_;
608
609   if( $self->connected ) {
610     $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
611     $self->_dbh->disconnect;
612     $self->_dbh(undef);
613     $self->{_dbh_gen}++;
614   }
615 }
616
617 sub connected {
618   my ($self) = @_;
619
620   if(my $dbh = $self->_dbh) {
621       if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
622           $self->_dbh(undef);
623           $self->{_dbh_gen}++;
624           return;
625       }
626       else {
627           $self->_verify_pid;
628       }
629       return ($dbh->FETCH('Active') && $dbh->ping);
630   }
631
632   return 0;
633 }
634
635 # handle pid changes correctly
636 #  NOTE: assumes $self->_dbh is a valid $dbh
637 sub _verify_pid {
638   my ($self) = @_;
639
640   return if $self->_conn_pid == $$;
641
642   $self->_dbh->{InactiveDestroy} = 1;
643   $self->_dbh(undef);
644   $self->{_dbh_gen}++;
645
646   return;
647 }
648
649 sub ensure_connected {
650   my ($self) = @_;
651
652   unless ($self->connected) {
653     $self->_populate_dbh;
654   }
655 }
656
657 =head2 dbh
658
659 Returns the dbh - a data base handle of class L<DBI>.
660
661 =cut
662
663 sub dbh {
664   my ($self) = @_;
665
666   $self->ensure_connected;
667   return $self->_dbh;
668 }
669
670 sub _sql_maker_args {
671     my ($self) = @_;
672     
673     return ( bindtype=>'columns', limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
674 }
675
676 sub sql_maker {
677   my ($self) = @_;
678   unless ($self->_sql_maker) {
679     $self->_sql_maker(new DBIC::SQL::Abstract( $self->_sql_maker_args ));
680   }
681   return $self->_sql_maker;
682 }
683
684 sub _populate_dbh {
685   my ($self) = @_;
686   my @info = @{$self->_connect_info || []};
687   $self->_dbh($self->_connect(@info));
688
689   if(ref $self eq 'DBIx::Class::Storage::DBI') {
690     my $driver = $self->_dbh->{Driver}->{Name};
691     if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
692       bless $self, "DBIx::Class::Storage::DBI::${driver}";
693       $self->_rebless() if $self->can('_rebless');
694     }
695   }
696
697   # if on-connect sql statements are given execute them
698   foreach my $sql_statement (@{$self->on_connect_do || []}) {
699     $self->debugobj->query_start($sql_statement) if $self->debug();
700     $self->_dbh->do($sql_statement);
701     $self->debugobj->query_end($sql_statement) if $self->debug();
702   }
703
704   # Rebless after we connect to the database, so we can take advantage of
705   # values in get_info
706   if(ref $self eq 'DBIx::Class::Storage::DBI') {
707     my $driver = $self->_dbh->{Driver}->{Name};
708     if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
709       bless $self, "DBIx::Class::Storage::DBI::${driver}";
710       $self->_rebless() if $self->can('_rebless');
711     }
712   }
713
714   $self->_conn_pid($$);
715   $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
716 }
717
718 sub _connect {
719   my ($self, @info) = @_;
720
721   $self->throw_exception("You failed to provide any connection info")
722       if !@info;
723
724   my ($old_connect_via, $dbh);
725
726   if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
727       $old_connect_via = $DBI::connect_via;
728       $DBI::connect_via = 'connect';
729   }
730
731   eval {
732     if(ref $info[0] eq 'CODE') {
733        $dbh = &{$info[0]}
734     }
735     else {
736        $dbh = DBI->connect(@info);
737        $dbh->{RaiseError} = 1;
738        $dbh->{PrintError} = 0;
739        $dbh->{PrintWarn} = 0;
740     }
741   };
742
743   $DBI::connect_via = $old_connect_via if $old_connect_via;
744
745   if (!$dbh || $@) {
746     $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
747   }
748
749   $dbh;
750 }
751
752 sub _dbh_txn_begin {
753   my ($self, $dbh) = @_;
754   if ($dbh->{AutoCommit}) {
755     $self->debugobj->txn_begin()
756       if ($self->debug);
757     $dbh->begin_work;
758   }
759 }
760
761 sub txn_begin {
762   my $self = shift;
763   $self->dbh_do($self->can('_dbh_txn_begin'))
764     if $self->{transaction_depth}++ == 0;
765 }
766
767 sub _dbh_txn_commit {
768   my ($self, $dbh) = @_;
769   if ($self->{transaction_depth} == 0) {
770     unless ($dbh->{AutoCommit}) {
771       $self->debugobj->txn_commit()
772         if ($self->debug);
773       $dbh->commit;
774     }
775   }
776   else {
777     if (--$self->{transaction_depth} == 0) {
778       $self->debugobj->txn_commit()
779         if ($self->debug);
780       $dbh->commit;
781     }
782   }
783 }
784
785 sub txn_commit {
786   my $self = shift;
787   $self->dbh_do($self->can('_dbh_txn_commit'));
788 }
789
790 sub _dbh_txn_rollback {
791   my ($self, $dbh) = @_;
792   if ($self->{transaction_depth} == 0) {
793     unless ($dbh->{AutoCommit}) {
794       $self->debugobj->txn_rollback()
795         if ($self->debug);
796       $dbh->rollback;
797     }
798   }
799   else {
800     if (--$self->{transaction_depth} == 0) {
801       $self->debugobj->txn_rollback()
802         if ($self->debug);
803       $dbh->rollback;
804     }
805     else {
806       die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
807     }
808   }
809 }
810
811 sub txn_rollback {
812   my $self = shift;
813
814   eval { $self->dbh_do($self->can('_dbh_txn_rollback')) };
815   if ($@) {
816     my $error = $@;
817     my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
818     $error =~ /$exception_class/ and $self->throw_exception($error);
819     $self->{transaction_depth} = 0;          # ensure that a failed rollback
820     $self->throw_exception($error);          # resets the transaction depth
821   }
822 }
823
824 # This used to be the top-half of _execute.  It was split out to make it
825 #  easier to override in NoBindVars without duping the rest.  It takes up
826 #  all of _execute's args, and emits $sql, @bind.
827 sub _prep_for_execute {
828   my ($self, $op, $extra_bind, $ident, @args) = @_;
829
830   my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
831   unshift(@bind,
832     map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
833       if $extra_bind;
834   @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
835
836   return ($sql, @bind);
837 }
838
839 sub _execute {
840   my ($self, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
841   
842   if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
843     $ident = $ident->from();
844   }
845   
846   my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
847   unshift(@bind,
848     map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
849       if $extra_bind;
850   if ($self->debug) {
851       my @debug_bind =
852         map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind;
853       $self->debugobj->query_start($sql, @debug_bind);
854   }
855   my $sth = eval { $self->sth($sql,$op) };
856
857   if (!$sth || $@) {
858     $self->throw_exception(
859       'no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql"
860     );
861   }
862
863   my $rv;
864   if ($sth) {
865     my $time = time();
866     $rv = eval {
867       my $placeholder_index = 1; 
868
869       foreach my $bound (@bind) {
870
871         my $attributes = {};
872         my($column_name, @data) = @$bound;
873
874         if( $bind_attributes ) {
875           $attributes = $bind_attributes->{$column_name}
876           if defined $bind_attributes->{$column_name};
877         }
878
879         foreach my $data (@data)
880         {
881           $data = ref $data ? ''.$data : $data; # stringify args
882
883           $sth->bind_param($placeholder_index, $data, $attributes);
884           $placeholder_index++;
885         }
886       }
887       $sth->execute();
888     };
889   
890     if ($@ || !$rv) {
891       $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr));
892     }
893   } else {
894     $self->throw_exception("'$sql' did not generate a statement.");
895   }
896   if ($self->debug) {
897      my @debug_bind =
898        map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind; 
899      $self->debugobj->query_end($sql, @debug_bind);
900   }
901   return (wantarray ? ($rv, $sth, @bind) : $rv);
902 }
903
904 sub insert {
905   my ($self, $source, $to_insert) = @_;
906   
907   my $ident = $source->from; 
908   my $bind_attributes = $self->source_bind_attributes($source);
909
910   $self->throw_exception(
911     "Couldn't insert ".join(', ',
912       map "$_ => $to_insert->{$_}", keys %$to_insert
913     )." into ${ident}"
914   ) unless ($self->_execute('insert' => [], $source, $bind_attributes, $to_insert));
915   return $to_insert;
916 }
917
918 ## Still not quite perfect, and EXPERIMENTAL
919 ## Currently it is assumed that all values passed will be "normal", i.e. not 
920 ## scalar refs, or at least, all the same type as the first set, the statement is
921 ## only prepped once.
922 sub insert_bulk {
923   my ($self, $source, $cols, $data) = @_;
924   my %colvalues;
925   my $table = $source->from;
926   @colvalues{@$cols} = (0..$#$cols);
927   my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
928   
929   if ($self->debug) {
930       my @debug_bind = map { defined $_->[1] ? qq{$_->[1]} : q{'NULL'} } @bind;
931       $self->debugobj->query_start($sql, @debug_bind);
932   }
933   my $sth = $self->sth($sql);
934
935 #  @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
936
937   my $rv;
938   
939   ## This must be an arrayref, else nothing works!
940   
941   my $tuple_status = [];
942   
943   ##use Data::Dumper;
944   ##print STDERR Dumper( $data, $sql, [@bind] );
945
946   if ($sth) {
947   
948     my $time = time();
949
950     ## Get the bind_attributes, if any exist
951     my $bind_attributes = $self->source_bind_attributes($source);
952
953     ## Bind the values and execute
954     $rv = eval {
955
956      my $placeholder_index = 1; 
957
958         foreach my $bound (@bind) {
959
960           my $attributes = {};
961           my ($column_name, $data_index) = @$bound;
962
963           if( $bind_attributes ) {
964             $attributes = $bind_attributes->{$column_name}
965             if defined $bind_attributes->{$column_name};
966           }
967
968           my @data = map { $_->[$data_index] } @$data;
969
970           $sth->bind_param_array( $placeholder_index, [@data], $attributes );
971           $placeholder_index++;
972       }
973       $sth->execute_array( {ArrayTupleStatus => $tuple_status} );
974
975     };
976    
977     if ($@ || !defined $rv) {
978       my $errors = '';
979       foreach my $tuple (@$tuple_status) {
980           $errors .= "\n" . $tuple->[1] if(ref $tuple);
981       }
982       $self->throw_exception("Error executing '$sql': ".($@ || $errors));
983     }
984   } else {
985     $self->throw_exception("'$sql' did not generate a statement.");
986   }
987   if ($self->debug) {
988       my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
989       $self->debugobj->query_end($sql, @debug_bind);
990   }
991   return (wantarray ? ($rv, $sth, @bind) : $rv);
992 }
993
994 sub update {
995   my $self = shift @_;
996   my $source = shift @_;
997   my $bind_attributes = $self->source_bind_attributes($source);
998   
999   return $self->_execute('update' => [], $source, $bind_attributes, @_);
1000 }
1001
1002
1003 sub delete {
1004   my $self = shift @_;
1005   my $source = shift @_;
1006   
1007   my $bind_attrs = {}; ## If ever it's needed...
1008   
1009   return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1010 }
1011
1012 sub _select {
1013   my ($self, $ident, $select, $condition, $attrs) = @_;
1014   my $order = $attrs->{order_by};
1015   if (ref $condition eq 'SCALAR') {
1016     $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
1017   }
1018   if (exists $attrs->{group_by} || $attrs->{having}) {
1019     $order = {
1020       group_by => $attrs->{group_by},
1021       having => $attrs->{having},
1022       ($order ? (order_by => $order) : ())
1023     };
1024   }
1025   my $bind_attrs = {}; ## Future support
1026   my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1027   if ($attrs->{software_limit} ||
1028       $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1029         $attrs->{software_limit} = 1;
1030   } else {
1031     $self->throw_exception("rows attribute must be positive if present")
1032       if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1033     push @args, $attrs->{rows}, $attrs->{offset};
1034   }
1035   return $self->_execute(@args);
1036 }
1037
1038 sub source_bind_attributes {
1039   my ($self, $source) = @_;
1040   
1041   my $bind_attributes;
1042   foreach my $column ($source->columns) {
1043   
1044     my $data_type = $source->column_info($column)->{data_type} || '';
1045     $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1046      if $data_type;
1047   }
1048
1049   return $bind_attributes;
1050 }
1051
1052 =head2 select
1053
1054 =over 4
1055
1056 =item Arguments: $ident, $select, $condition, $attrs
1057
1058 =back
1059
1060 Handle a SQL select statement.
1061
1062 =cut
1063
1064 sub select {
1065   my $self = shift;
1066   my ($ident, $select, $condition, $attrs) = @_;
1067   return $self->cursor->new($self, \@_, $attrs);
1068 }
1069
1070 sub select_single {
1071   my $self = shift;
1072   my ($rv, $sth, @bind) = $self->_select(@_);
1073   my @row = $sth->fetchrow_array;
1074   # Need to call finish() to work round broken DBDs
1075   $sth->finish();
1076   return @row;
1077 }
1078
1079 =head2 sth
1080
1081 =over 4
1082
1083 =item Arguments: $sql
1084
1085 =back
1086
1087 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1088
1089 =cut
1090
1091 sub _dbh_sth {
1092   my ($self, $dbh, $sql) = @_;
1093
1094   # 3 is the if_active parameter which avoids active sth re-use
1095   my $sth = $self->disable_sth_caching
1096     ? $dbh->prepare($sql)
1097     : $dbh->prepare_cached($sql, {}, 3);
1098
1099   $self->throw_exception(
1100     'no sth generated via sql (' . ($@ || $dbh->errstr) . "): $sql"
1101   ) if !$sth;
1102
1103   $sth;
1104 }
1105
1106 sub sth {
1107   my ($self, $sql) = @_;
1108   $self->dbh_do($self->can('_dbh_sth'), $sql);
1109 }
1110
1111 sub _dbh_columns_info_for {
1112   my ($self, $dbh, $table) = @_;
1113
1114   if ($dbh->can('column_info')) {
1115     my %result;
1116     eval {
1117       my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1118       my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1119       $sth->execute();
1120       while ( my $info = $sth->fetchrow_hashref() ){
1121         my %column_info;
1122         $column_info{data_type}   = $info->{TYPE_NAME};
1123         $column_info{size}      = $info->{COLUMN_SIZE};
1124         $column_info{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
1125         $column_info{default_value} = $info->{COLUMN_DEF};
1126         my $col_name = $info->{COLUMN_NAME};
1127         $col_name =~ s/^\"(.*)\"$/$1/;
1128
1129         $result{$col_name} = \%column_info;
1130       }
1131     };
1132     return \%result if !$@ && scalar keys %result;
1133   }
1134
1135   my %result;
1136   my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
1137   $sth->execute;
1138   my @columns = @{$sth->{NAME_lc}};
1139   for my $i ( 0 .. $#columns ){
1140     my %column_info;
1141     my $type_num = $sth->{TYPE}->[$i];
1142     my $type_name;
1143     if(defined $type_num && $dbh->can('type_info')) {
1144       my $type_info = $dbh->type_info($type_num);
1145       $type_name = $type_info->{TYPE_NAME} if $type_info;
1146     }
1147     $column_info{data_type} = $type_name ? $type_name : $type_num;
1148     $column_info{size} = $sth->{PRECISION}->[$i];
1149     $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1150
1151     if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1152       $column_info{data_type} = $1;
1153       $column_info{size}    = $2;
1154     }
1155
1156     $result{$columns[$i]} = \%column_info;
1157   }
1158
1159   return \%result;
1160 }
1161
1162 sub columns_info_for {
1163   my ($self, $table) = @_;
1164   $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
1165 }
1166
1167 =head2 last_insert_id
1168
1169 Return the row id of the last insert.
1170
1171 =cut
1172
1173 sub _dbh_last_insert_id {
1174     my ($self, $dbh, $source, $col) = @_;
1175     # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1176     $dbh->func('last_insert_rowid');
1177 }
1178
1179 sub last_insert_id {
1180   my $self = shift;
1181   $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
1182 }
1183
1184 =head2 sqlt_type
1185
1186 Returns the database driver name.
1187
1188 =cut
1189
1190 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1191
1192 =head2 bind_attribute_by_data_type
1193
1194 Given a datatype from column info, returns a database specific bind attribute for
1195 $dbh->bind_param($val,$attribute) or nothing if we will let the database planner
1196 just handle it.
1197
1198 Generally only needed for special case column types, like bytea in postgres.
1199
1200 =cut
1201
1202 sub bind_attribute_by_data_type {
1203     return;
1204 }
1205
1206 =head2 create_ddl_dir (EXPERIMENTAL)
1207
1208 =over 4
1209
1210 =item Arguments: $schema \@databases, $version, $directory, $preversion, $sqlt_args
1211
1212 =back
1213
1214 Creates a SQL file based on the Schema, for each of the specified
1215 database types, in the given directory.
1216
1217 Note that this feature is currently EXPERIMENTAL and may not work correctly
1218 across all databases, or fully handle complex relationships.
1219
1220 =cut
1221
1222 sub create_ddl_dir
1223 {
1224   my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1225
1226   if(!$dir || !-d $dir)
1227   {
1228     warn "No directory given, using ./\n";
1229     $dir = "./";
1230   }
1231   $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1232   $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1233   $version ||= $schema->VERSION || '1.x';
1234   $sqltargs = { ( add_drop_table => 1 ), %{$sqltargs || {}} };
1235
1236   eval "use SQL::Translator";
1237   $self->throw_exception("Can't create a ddl file without SQL::Translator: $@") if $@;
1238
1239   my $sqlt = SQL::Translator->new({
1240 #      debug => 1,
1241       add_drop_table => 1,
1242   });
1243   foreach my $db (@$databases)
1244   {
1245     $sqlt->reset();
1246     $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1247 #    $sqlt->parser_args({'DBIx::Class' => $schema);
1248     $sqlt = $self->configure_sqlt($sqlt, $db);
1249     $sqlt->data($schema);
1250     $sqlt->producer($db);
1251
1252     my $file;
1253     my $filename = $schema->ddl_filename($db, $dir, $version);
1254     if(-e $filename)
1255     {
1256       warn("$filename already exists, skipping $db");
1257       next;
1258     }
1259
1260     my $output = $sqlt->translate;
1261     if(!$output)
1262     {
1263       warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1264       next;
1265     }
1266     if(!open($file, ">$filename"))
1267     {
1268         $self->throw_exception("Can't open $filename for writing ($!)");
1269         next;
1270     }
1271     print $file $output;
1272     close($file);
1273
1274     if($preversion)
1275     {
1276       eval "use SQL::Translator::Diff";
1277       if($@)
1278       {
1279         warn("Can't diff versions without SQL::Translator::Diff: $@");
1280         next;
1281       }
1282
1283       my $prefilename = $schema->ddl_filename($db, $dir, $preversion);
1284 #      print "Previous version $prefilename\n";
1285       if(!-e $prefilename)
1286       {
1287         warn("No previous schema file found ($prefilename)");
1288         next;
1289       }
1290       #### We need to reparse the SQLite file we just wrote, so that 
1291       ##   Diff doesnt get all confoosed, and Diff is *very* confused.
1292       ##   FIXME: rip Diff to pieces!
1293 #      my $target_schema = $sqlt->schema;
1294 #      unless ( $target_schema->name ) {
1295 #        $target_schema->name( $filename );
1296 #      }
1297       my @input;
1298       push @input, {file => $prefilename, parser => $db};
1299       push @input, {file => $filename, parser => $db};
1300       my ( $source_schema, $source_db, $target_schema, $target_db ) = map {
1301         my $file   = $_->{'file'};
1302         my $parser = $_->{'parser'};
1303
1304         my $t = SQL::Translator->new;
1305         $t->debug( 0 );
1306         $t->trace( 0 );
1307         $t->parser( $parser )            or die $t->error;
1308         my $out = $t->translate( $file ) or die $t->error;
1309         my $schema = $t->schema;
1310         unless ( $schema->name ) {
1311           $schema->name( $file );
1312         }
1313         ($schema, $parser);
1314       } @input;
1315
1316       my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1317                                                     $target_schema, $db,
1318                                                     {}
1319                                                    );
1320       my $difffile = $schema->ddl_filename($db, $dir, $version, $preversion);
1321       print STDERR "Diff: $difffile: $db, $dir, $version, $preversion \n";
1322       if(-e $difffile)
1323       {
1324         warn("$difffile already exists, skipping");
1325         next;
1326       }
1327       if(!open $file, ">$difffile")
1328       { 
1329         $self->throw_exception("Can't write to $difffile ($!)");
1330         next;
1331       }
1332       print $file $diff;
1333       close($file);
1334     }
1335   }
1336 }
1337
1338 sub configure_sqlt() {
1339   my $self = shift;
1340   my $tr = shift;
1341   my $db = shift || $self->sqlt_type;
1342   if ($db eq 'PostgreSQL') {
1343     $tr->quote_table_names(0);
1344     $tr->quote_field_names(0);
1345   }
1346   return $tr;
1347 }
1348
1349 =head2 deployment_statements
1350
1351 =over 4
1352
1353 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1354
1355 =back
1356
1357 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1358 The database driver name is given by C<$type>, though the value from
1359 L</sqlt_type> is used if it is not specified.
1360
1361 C<$directory> is used to return statements from files in a previously created
1362 L</create_ddl_dir> directory and is optional. The filenames are constructed
1363 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1364
1365 If no C<$directory> is specified then the statements are constructed on the
1366 fly using L<SQL::Translator> and C<$version> is ignored.
1367
1368 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1369
1370 =cut
1371
1372 sub deployment_statements {
1373   my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1374   # Need to be connected to get the correct sqlt_type
1375   $self->ensure_connected() unless $type;
1376   $type ||= $self->sqlt_type;
1377   $version ||= $schema->VERSION || '1.x';
1378   $dir ||= './';
1379   my $filename = $schema->ddl_filename($type, $dir, $version);
1380   if(-f $filename)
1381   {
1382       my $file;
1383       open($file, "<$filename") 
1384         or $self->throw_exception("Can't open $filename ($!)");
1385       my @rows = <$file>;
1386       close($file);
1387       return join('', @rows);
1388   }
1389
1390   eval "use SQL::Translator";
1391   if(!$@)
1392   {
1393     eval "use SQL::Translator::Parser::DBIx::Class;";
1394     $self->throw_exception($@) if $@;
1395     eval "use SQL::Translator::Producer::${type};";
1396     $self->throw_exception($@) if $@;
1397
1398     # sources needs to be a parser arg, but for simplicty allow at top level 
1399     # coming in
1400     $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1401         if exists $sqltargs->{sources};
1402
1403     my $tr = SQL::Translator->new(%$sqltargs);
1404     SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1405     return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1406   }
1407
1408   $self->throw_exception("No SQL::Translator, and no Schema file found, aborting deploy");
1409   return;
1410
1411 }
1412
1413 sub deploy {
1414   my ($self, $schema, $type, $sqltargs, $dir) = @_;
1415   foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1416     for ( split(";\n", $statement)) {
1417       next if($_ =~ /^--/);
1418       next if(!$_);
1419 #      next if($_ =~ /^DROP/m);
1420       next if($_ =~ /^BEGIN TRANSACTION/m);
1421       next if($_ =~ /^COMMIT/m);
1422       next if $_ =~ /^\s+$/; # skip whitespace only
1423       $self->debugobj->query_start($_) if $self->debug;
1424       $self->dbh->do($_) or warn "SQL was:\n $_"; # XXX exceptions?
1425       $self->debugobj->query_end($_) if $self->debug;
1426     }
1427   }
1428 }
1429
1430 =head2 datetime_parser
1431
1432 Returns the datetime parser class
1433
1434 =cut
1435
1436 sub datetime_parser {
1437   my $self = shift;
1438   return $self->{datetime_parser} ||= $self->build_datetime_parser(@_);
1439 }
1440
1441 =head2 datetime_parser_type
1442
1443 Defines (returns) the datetime parser class - currently hardwired to
1444 L<DateTime::Format::MySQL>
1445
1446 =cut
1447
1448 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1449
1450 =head2 build_datetime_parser
1451
1452 See L</datetime_parser>
1453
1454 =cut
1455
1456 sub build_datetime_parser {
1457   my $self = shift;
1458   my $type = $self->datetime_parser_type(@_);
1459   eval "use ${type}";
1460   $self->throw_exception("Couldn't load ${type}: $@") if $@;
1461   return $type;
1462 }
1463
1464 sub DESTROY {
1465   my $self = shift;
1466   return if !$self->_dbh;
1467   $self->_verify_pid;
1468   $self->_dbh(undef);
1469 }
1470
1471 1;
1472
1473 =head1 SQL METHODS
1474
1475 The module defines a set of methods within the DBIC::SQL::Abstract
1476 namespace.  These build on L<SQL::Abstract::Limit> to provide the
1477 SQL query functions.
1478
1479 The following methods are extended:-
1480
1481 =over 4
1482
1483 =item delete
1484
1485 =item insert
1486
1487 =item select
1488
1489 =item update
1490
1491 =item limit_dialect
1492
1493 See L</connect_info> for details.
1494 For setting, this method is deprecated in favor of L</connect_info>.
1495
1496 =item quote_char
1497
1498 See L</connect_info> for details.
1499 For setting, this method is deprecated in favor of L</connect_info>.
1500
1501 =item name_sep
1502
1503 See L</connect_info> for details.
1504 For setting, this method is deprecated in favor of L</connect_info>.
1505
1506 =back
1507
1508 =head1 AUTHORS
1509
1510 Matt S. Trout <mst@shadowcatsystems.co.uk>
1511
1512 Andy Grundman <andy@hybridized.org>
1513
1514 =head1 LICENSE
1515
1516 You may distribute this code under the same terms as Perl itself.
1517
1518 =cut