fix server disconnect checking for select outside of transaction
[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   $self->_conn_pid($$);
705   $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
706 }
707
708 sub _connect {
709   my ($self, @info) = @_;
710
711   $self->throw_exception("You failed to provide any connection info")
712       if !@info;
713
714   my ($old_connect_via, $dbh);
715
716   if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
717       $old_connect_via = $DBI::connect_via;
718       $DBI::connect_via = 'connect';
719   }
720
721   eval {
722     if(ref $info[0] eq 'CODE') {
723        $dbh = &{$info[0]}
724     }
725     else {
726        $dbh = DBI->connect(@info);
727        $dbh->{RaiseError} = 1;
728        $dbh->{PrintError} = 0;
729        $dbh->{PrintWarn} = 0;
730     }
731   };
732
733   $DBI::connect_via = $old_connect_via if $old_connect_via;
734
735   if (!$dbh || $@) {
736     $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
737   }
738
739   $dbh;
740 }
741
742 sub _dbh_txn_begin {
743   my ($self, $dbh) = @_;
744   if ($dbh->{AutoCommit}) {
745     $self->debugobj->txn_begin()
746       if ($self->debug);
747     $dbh->begin_work;
748   }
749 }
750
751 sub txn_begin {
752   my $self = shift;
753   $self->dbh_do($self->can('_dbh_txn_begin'))
754     if $self->{transaction_depth}++ == 0;
755 }
756
757 sub _dbh_txn_commit {
758   my ($self, $dbh) = @_;
759   if ($self->{transaction_depth} == 0) {
760     unless ($dbh->{AutoCommit}) {
761       $self->debugobj->txn_commit()
762         if ($self->debug);
763       $dbh->commit;
764     }
765   }
766   else {
767     if (--$self->{transaction_depth} == 0) {
768       $self->debugobj->txn_commit()
769         if ($self->debug);
770       $dbh->commit;
771     }
772   }
773 }
774
775 sub txn_commit {
776   my $self = shift;
777   $self->dbh_do($self->can('_dbh_txn_commit'));
778 }
779
780 sub _dbh_txn_rollback {
781   my ($self, $dbh) = @_;
782   if ($self->{transaction_depth} == 0) {
783     unless ($dbh->{AutoCommit}) {
784       $self->debugobj->txn_rollback()
785         if ($self->debug);
786       $dbh->rollback;
787     }
788   }
789   else {
790     if (--$self->{transaction_depth} == 0) {
791       $self->debugobj->txn_rollback()
792         if ($self->debug);
793       $dbh->rollback;
794     }
795     else {
796       die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
797     }
798   }
799 }
800
801 sub txn_rollback {
802   my $self = shift;
803
804   eval { $self->dbh_do($self->can('_dbh_txn_rollback')) };
805   if ($@) {
806     my $error = $@;
807     my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
808     $error =~ /$exception_class/ and $self->throw_exception($error);
809     $self->{transaction_depth} = 0;          # ensure that a failed rollback
810     $self->throw_exception($error);          # resets the transaction depth
811   }
812 }
813
814 # This used to be the top-half of _execute.  It was split out to make it
815 #  easier to override in NoBindVars without duping the rest.  It takes up
816 #  all of _execute's args, and emits $sql, @bind.
817 sub _prep_for_execute {
818   my ($self, $op, $extra_bind, $ident, @args) = @_;
819
820   my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
821   unshift(@bind,
822     map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
823       if $extra_bind;
824   @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
825
826   return ($sql, @bind);
827 }
828
829 sub _execute {
830   my ($self, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
831   
832   if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
833     $ident = $ident->from();
834   }
835   
836   my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
837   unshift(@bind,
838     map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
839       if $extra_bind;
840   if ($self->debug) {
841       my @debug_bind =
842         map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind;
843       $self->debugobj->query_start($sql, @debug_bind);
844   }
845
846   my ($rv, $sth);
847   RETRY: while (1) {
848     $sth = eval { $self->sth($sql,$op) };
849
850     if (!$sth || $@) {
851       $self->throw_exception(
852         'no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql"
853       );
854     }
855
856     if ($sth) {
857       my $time = time();
858       $rv = eval {
859         my $placeholder_index = 1; 
860
861         foreach my $bound (@bind) {
862
863           my $attributes = {};
864           my($column_name, @data) = @$bound;
865
866           if( $bind_attributes ) {
867             $attributes = $bind_attributes->{$column_name}
868             if defined $bind_attributes->{$column_name};
869           }
870
871           foreach my $data (@data)
872           {
873             $data = ref $data ? ''.$data : $data; # stringify args
874
875             $sth->bind_param($placeholder_index, $data, $attributes);
876             $placeholder_index++;
877           }
878         }
879         $sth->execute();
880       };
881     
882       if ($@ || !$rv) {
883         $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr))
884           if $self->connected;
885         $self->_populate_dbh;
886       } else {
887         last RETRY;
888       }
889     } else {
890       $self->throw_exception("'$sql' did not generate a statement.");
891     }
892   } # While(1) to retry if disconencted
893
894   if ($self->debug) {
895      my @debug_bind =
896        map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind; 
897      $self->debugobj->query_end($sql, @debug_bind);
898   }
899   return (wantarray ? ($rv, $sth, @bind) : $rv);
900 }
901
902 sub insert {
903   my ($self, $source, $to_insert) = @_;
904   
905   my $ident = $source->from; 
906   my $bind_attributes = $self->source_bind_attributes($source);
907
908   $self->throw_exception(
909     "Couldn't insert ".join(', ',
910       map "$_ => $to_insert->{$_}", keys %$to_insert
911     )." into ${ident}"
912   ) unless ($self->_execute('insert' => [], $source, $bind_attributes, $to_insert));
913   return $to_insert;
914 }
915
916 ## Still not quite perfect, and EXPERIMENTAL
917 ## Currently it is assumed that all values passed will be "normal", i.e. not 
918 ## scalar refs, or at least, all the same type as the first set, the statement is
919 ## only prepped once.
920 sub insert_bulk {
921   my ($self, $source, $cols, $data) = @_;
922   my %colvalues;
923   my $table = $source->from;
924   @colvalues{@$cols} = (0..$#$cols);
925   my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
926   
927   if ($self->debug) {
928       my @debug_bind = map { defined $_->[1] ? qq{$_->[1]} : q{'NULL'} } @bind;
929       $self->debugobj->query_start($sql, @debug_bind);
930   }
931   my $sth = $self->sth($sql);
932
933 #  @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
934
935   my $rv;
936   
937   ## This must be an arrayref, else nothing works!
938   
939   my $tuple_status = [];
940   
941   ##use Data::Dumper;
942   ##print STDERR Dumper( $data, $sql, [@bind] );
943
944   if ($sth) {
945   
946     my $time = time();
947
948     ## Get the bind_attributes, if any exist
949     my $bind_attributes = $self->source_bind_attributes($source);
950
951     ## Bind the values and execute
952     $rv = eval {
953
954      my $placeholder_index = 1; 
955
956         foreach my $bound (@bind) {
957
958           my $attributes = {};
959           my ($column_name, $data_index) = @$bound;
960
961           if( $bind_attributes ) {
962             $attributes = $bind_attributes->{$column_name}
963             if defined $bind_attributes->{$column_name};
964           }
965
966           my @data = map { $_->[$data_index] } @$data;
967
968           $sth->bind_param_array( $placeholder_index, [@data], $attributes );
969           $placeholder_index++;
970       }
971       $sth->execute_array( {ArrayTupleStatus => $tuple_status} );
972
973     };
974    
975     if ($@ || !defined $rv) {
976       my $errors = '';
977       foreach my $tuple (@$tuple_status) {
978           $errors .= "\n" . $tuple->[1] if(ref $tuple);
979       }
980       $self->throw_exception("Error executing '$sql': ".($@ || $errors));
981     }
982   } else {
983     $self->throw_exception("'$sql' did not generate a statement.");
984   }
985   if ($self->debug) {
986       my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
987       $self->debugobj->query_end($sql, @debug_bind);
988   }
989   return (wantarray ? ($rv, $sth, @bind) : $rv);
990 }
991
992 sub update {
993   my $self = shift @_;
994   my $source = shift @_;
995   my $bind_attributes = $self->source_bind_attributes($source);
996   
997   return $self->_execute('update' => [], $source, $bind_attributes, @_);
998 }
999
1000
1001 sub delete {
1002   my $self = shift @_;
1003   my $source = shift @_;
1004   
1005   my $bind_attrs = {}; ## If ever it's needed...
1006   
1007   return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1008 }
1009
1010 sub _select {
1011   my ($self, $ident, $select, $condition, $attrs) = @_;
1012   my $order = $attrs->{order_by};
1013   if (ref $condition eq 'SCALAR') {
1014     $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
1015   }
1016   if (exists $attrs->{group_by} || $attrs->{having}) {
1017     $order = {
1018       group_by => $attrs->{group_by},
1019       having => $attrs->{having},
1020       ($order ? (order_by => $order) : ())
1021     };
1022   }
1023   my $bind_attrs = {}; ## Future support
1024   my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1025   if ($attrs->{software_limit} ||
1026       $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1027         $attrs->{software_limit} = 1;
1028   } else {
1029     $self->throw_exception("rows attribute must be positive if present")
1030       if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1031     push @args, $attrs->{rows}, $attrs->{offset};
1032   }
1033   return $self->_execute(@args);
1034 }
1035
1036 sub source_bind_attributes {
1037   my ($self, $source) = @_;
1038   
1039   my $bind_attributes;
1040   foreach my $column ($source->columns) {
1041   
1042     my $data_type = $source->column_info($column)->{data_type} || '';
1043     $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1044      if $data_type;
1045   }
1046
1047   return $bind_attributes;
1048 }
1049
1050 =head2 select
1051
1052 =over 4
1053
1054 =item Arguments: $ident, $select, $condition, $attrs
1055
1056 =back
1057
1058 Handle a SQL select statement.
1059
1060 =cut
1061
1062 sub select {
1063   my $self = shift;
1064   my ($ident, $select, $condition, $attrs) = @_;
1065   return $self->cursor->new($self, \@_, $attrs);
1066 }
1067
1068 sub select_single {
1069   my $self = shift;
1070   my ($rv, $sth, @bind) = $self->_select(@_);
1071   my @row = $sth->fetchrow_array;
1072   # Need to call finish() to work round broken DBDs
1073   $sth->finish();
1074   return @row;
1075 }
1076
1077 =head2 sth
1078
1079 =over 4
1080
1081 =item Arguments: $sql
1082
1083 =back
1084
1085 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1086
1087 =cut
1088
1089 sub _dbh_sth {
1090   my ($self, $dbh, $sql) = @_;
1091
1092   # 3 is the if_active parameter which avoids active sth re-use
1093   my $sth = $self->disable_sth_caching
1094     ? $dbh->prepare($sql)
1095     : $dbh->prepare_cached($sql, {}, 3);
1096
1097   $self->throw_exception(
1098     'no sth generated via sql (' . ($@ || $dbh->errstr) . "): $sql"
1099   ) if !$sth;
1100
1101   $sth;
1102 }
1103
1104 sub sth {
1105   my ($self, $sql) = @_;
1106   $self->dbh_do($self->can('_dbh_sth'), $sql);
1107 }
1108
1109 sub _dbh_columns_info_for {
1110   my ($self, $dbh, $table) = @_;
1111
1112   if ($dbh->can('column_info')) {
1113     my %result;
1114     eval {
1115       my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1116       my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1117       $sth->execute();
1118       while ( my $info = $sth->fetchrow_hashref() ){
1119         my %column_info;
1120         $column_info{data_type}   = $info->{TYPE_NAME};
1121         $column_info{size}      = $info->{COLUMN_SIZE};
1122         $column_info{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
1123         $column_info{default_value} = $info->{COLUMN_DEF};
1124         my $col_name = $info->{COLUMN_NAME};
1125         $col_name =~ s/^\"(.*)\"$/$1/;
1126
1127         $result{$col_name} = \%column_info;
1128       }
1129     };
1130     return \%result if !$@ && scalar keys %result;
1131   }
1132
1133   my %result;
1134   my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
1135   $sth->execute;
1136   my @columns = @{$sth->{NAME_lc}};
1137   for my $i ( 0 .. $#columns ){
1138     my %column_info;
1139     my $type_num = $sth->{TYPE}->[$i];
1140     my $type_name;
1141     if(defined $type_num && $dbh->can('type_info')) {
1142       my $type_info = $dbh->type_info($type_num);
1143       $type_name = $type_info->{TYPE_NAME} if $type_info;
1144     }
1145     $column_info{data_type} = $type_name ? $type_name : $type_num;
1146     $column_info{size} = $sth->{PRECISION}->[$i];
1147     $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1148
1149     if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1150       $column_info{data_type} = $1;
1151       $column_info{size}    = $2;
1152     }
1153
1154     $result{$columns[$i]} = \%column_info;
1155   }
1156
1157   return \%result;
1158 }
1159
1160 sub columns_info_for {
1161   my ($self, $table) = @_;
1162   $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
1163 }
1164
1165 =head2 last_insert_id
1166
1167 Return the row id of the last insert.
1168
1169 =cut
1170
1171 sub _dbh_last_insert_id {
1172     my ($self, $dbh, $source, $col) = @_;
1173     # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1174     $dbh->func('last_insert_rowid');
1175 }
1176
1177 sub last_insert_id {
1178   my $self = shift;
1179   $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
1180 }
1181
1182 =head2 sqlt_type
1183
1184 Returns the database driver name.
1185
1186 =cut
1187
1188 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1189
1190 =head2 bind_attribute_by_data_type
1191
1192 Given a datatype from column info, returns a database specific bind attribute for
1193 $dbh->bind_param($val,$attribute) or nothing if we will let the database planner
1194 just handle it.
1195
1196 Generally only needed for special case column types, like bytea in postgres.
1197
1198 =cut
1199
1200 sub bind_attribute_by_data_type {
1201     return;
1202 }
1203
1204 =head2 create_ddl_dir (EXPERIMENTAL)
1205
1206 =over 4
1207
1208 =item Arguments: $schema \@databases, $version, $directory, $preversion, $sqlt_args
1209
1210 =back
1211
1212 Creates a SQL file based on the Schema, for each of the specified
1213 database types, in the given directory.
1214
1215 Note that this feature is currently EXPERIMENTAL and may not work correctly
1216 across all databases, or fully handle complex relationships.
1217
1218 =cut
1219
1220 sub create_ddl_dir
1221 {
1222   my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1223
1224   if(!$dir || !-d $dir)
1225   {
1226     warn "No directory given, using ./\n";
1227     $dir = "./";
1228   }
1229   $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1230   $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1231   $version ||= $schema->VERSION || '1.x';
1232   $sqltargs = { ( add_drop_table => 1 ), %{$sqltargs || {}} };
1233
1234   eval "use SQL::Translator";
1235   $self->throw_exception("Can't create a ddl file without SQL::Translator: $@") if $@;
1236
1237   my $sqlt = SQL::Translator->new({
1238 #      debug => 1,
1239       add_drop_table => 1,
1240   });
1241   foreach my $db (@$databases)
1242   {
1243     $sqlt->reset();
1244     $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1245 #    $sqlt->parser_args({'DBIx::Class' => $schema);
1246     $sqlt = $self->configure_sqlt($sqlt, $db);
1247     $sqlt->data($schema);
1248     $sqlt->producer($db);
1249
1250     my $file;
1251     my $filename = $schema->ddl_filename($db, $dir, $version);
1252     if(-e $filename)
1253     {
1254       warn("$filename already exists, skipping $db");
1255       next;
1256     }
1257
1258     my $output = $sqlt->translate;
1259     if(!$output)
1260     {
1261       warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1262       next;
1263     }
1264     if(!open($file, ">$filename"))
1265     {
1266         $self->throw_exception("Can't open $filename for writing ($!)");
1267         next;
1268     }
1269     print $file $output;
1270     close($file);
1271
1272     if($preversion)
1273     {
1274       eval "use SQL::Translator::Diff";
1275       if($@)
1276       {
1277         warn("Can't diff versions without SQL::Translator::Diff: $@");
1278         next;
1279       }
1280
1281       my $prefilename = $schema->ddl_filename($db, $dir, $preversion);
1282 #      print "Previous version $prefilename\n";
1283       if(!-e $prefilename)
1284       {
1285         warn("No previous schema file found ($prefilename)");
1286         next;
1287       }
1288       #### We need to reparse the SQLite file we just wrote, so that 
1289       ##   Diff doesnt get all confoosed, and Diff is *very* confused.
1290       ##   FIXME: rip Diff to pieces!
1291 #      my $target_schema = $sqlt->schema;
1292 #      unless ( $target_schema->name ) {
1293 #        $target_schema->name( $filename );
1294 #      }
1295       my @input;
1296       push @input, {file => $prefilename, parser => $db};
1297       push @input, {file => $filename, parser => $db};
1298       my ( $source_schema, $source_db, $target_schema, $target_db ) = map {
1299         my $file   = $_->{'file'};
1300         my $parser = $_->{'parser'};
1301
1302         my $t = SQL::Translator->new;
1303         $t->debug( 0 );
1304         $t->trace( 0 );
1305         $t->parser( $parser )            or die $t->error;
1306         my $out = $t->translate( $file ) or die $t->error;
1307         my $schema = $t->schema;
1308         unless ( $schema->name ) {
1309           $schema->name( $file );
1310         }
1311         ($schema, $parser);
1312       } @input;
1313
1314       my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1315                                                     $target_schema, $db,
1316                                                     {}
1317                                                    );
1318       my $difffile = $schema->ddl_filename($db, $dir, $version, $preversion);
1319       print STDERR "Diff: $difffile: $db, $dir, $version, $preversion \n";
1320       if(-e $difffile)
1321       {
1322         warn("$difffile already exists, skipping");
1323         next;
1324       }
1325       if(!open $file, ">$difffile")
1326       { 
1327         $self->throw_exception("Can't write to $difffile ($!)");
1328         next;
1329       }
1330       print $file $diff;
1331       close($file);
1332     }
1333   }
1334 }
1335
1336 sub configure_sqlt() {
1337   my $self = shift;
1338   my $tr = shift;
1339   my $db = shift || $self->sqlt_type;
1340   if ($db eq 'PostgreSQL') {
1341     $tr->quote_table_names(0);
1342     $tr->quote_field_names(0);
1343   }
1344   return $tr;
1345 }
1346
1347 =head2 deployment_statements
1348
1349 =over 4
1350
1351 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1352
1353 =back
1354
1355 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1356 The database driver name is given by C<$type>, though the value from
1357 L</sqlt_type> is used if it is not specified.
1358
1359 C<$directory> is used to return statements from files in a previously created
1360 L</create_ddl_dir> directory and is optional. The filenames are constructed
1361 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1362
1363 If no C<$directory> is specified then the statements are constructed on the
1364 fly using L<SQL::Translator> and C<$version> is ignored.
1365
1366 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1367
1368 =cut
1369
1370 sub deployment_statements {
1371   my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1372   # Need to be connected to get the correct sqlt_type
1373   $self->ensure_connected() unless $type;
1374   $type ||= $self->sqlt_type;
1375   $version ||= $schema->VERSION || '1.x';
1376   $dir ||= './';
1377   my $filename = $schema->ddl_filename($type, $dir, $version);
1378   if(-f $filename)
1379   {
1380       my $file;
1381       open($file, "<$filename") 
1382         or $self->throw_exception("Can't open $filename ($!)");
1383       my @rows = <$file>;
1384       close($file);
1385       return join('', @rows);
1386   }
1387
1388   eval "use SQL::Translator";
1389   if(!$@)
1390   {
1391     eval "use SQL::Translator::Parser::DBIx::Class;";
1392     $self->throw_exception($@) if $@;
1393     eval "use SQL::Translator::Producer::${type};";
1394     $self->throw_exception($@) if $@;
1395
1396     # sources needs to be a parser arg, but for simplicty allow at top level 
1397     # coming in
1398     $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1399         if exists $sqltargs->{sources};
1400
1401     my $tr = SQL::Translator->new(%$sqltargs);
1402     SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1403     return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1404   }
1405
1406   $self->throw_exception("No SQL::Translator, and no Schema file found, aborting deploy");
1407   return;
1408
1409 }
1410
1411 sub deploy {
1412   my ($self, $schema, $type, $sqltargs, $dir) = @_;
1413   foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1414     for ( split(";\n", $statement)) {
1415       next if($_ =~ /^--/);
1416       next if(!$_);
1417 #      next if($_ =~ /^DROP/m);
1418       next if($_ =~ /^BEGIN TRANSACTION/m);
1419       next if($_ =~ /^COMMIT/m);
1420       next if $_ =~ /^\s+$/; # skip whitespace only
1421       $self->debugobj->query_start($_) if $self->debug;
1422       $self->dbh->do($_) or warn "SQL was:\n $_"; # XXX exceptions?
1423       $self->debugobj->query_end($_) if $self->debug;
1424     }
1425   }
1426 }
1427
1428 =head2 datetime_parser
1429
1430 Returns the datetime parser class
1431
1432 =cut
1433
1434 sub datetime_parser {
1435   my $self = shift;
1436   return $self->{datetime_parser} ||= $self->build_datetime_parser(@_);
1437 }
1438
1439 =head2 datetime_parser_type
1440
1441 Defines (returns) the datetime parser class - currently hardwired to
1442 L<DateTime::Format::MySQL>
1443
1444 =cut
1445
1446 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1447
1448 =head2 build_datetime_parser
1449
1450 See L</datetime_parser>
1451
1452 =cut
1453
1454 sub build_datetime_parser {
1455   my $self = shift;
1456   my $type = $self->datetime_parser_type(@_);
1457   eval "use ${type}";
1458   $self->throw_exception("Couldn't load ${type}: $@") if $@;
1459   return $type;
1460 }
1461
1462 sub DESTROY {
1463   my $self = shift;
1464   return if !$self->_dbh;
1465   $self->_verify_pid;
1466   $self->_dbh(undef);
1467 }
1468
1469 1;
1470
1471 =head1 SQL METHODS
1472
1473 The module defines a set of methods within the DBIC::SQL::Abstract
1474 namespace.  These build on L<SQL::Abstract::Limit> to provide the
1475 SQL query functions.
1476
1477 The following methods are extended:-
1478
1479 =over 4
1480
1481 =item delete
1482
1483 =item insert
1484
1485 =item select
1486
1487 =item update
1488
1489 =item limit_dialect
1490
1491 See L</connect_info> for details.
1492 For setting, this method is deprecated in favor of L</connect_info>.
1493
1494 =item quote_char
1495
1496 See L</connect_info> for details.
1497 For setting, this method is deprecated in favor of L</connect_info>.
1498
1499 =item name_sep
1500
1501 See L</connect_info> for details.
1502 For setting, this method is deprecated in favor of L</connect_info>.
1503
1504 =back
1505
1506 =head1 AUTHORS
1507
1508 Matt S. Trout <mst@shadowcatsystems.co.uk>
1509
1510 Andy Grundman <andy@hybridized.org>
1511
1512 =head1 LICENSE
1513
1514 You may distribute this code under the same terms as Perl itself.
1515
1516 =cut