Massive rewrite of bind handling, and overall simplification of ::Storage::DBI

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / NoBindVars.pm

diff --git a/lib/DBIx/Class/Storage/DBI/NoBindVars.pm b/lib/DBIx/Class/Storage/DBI/NoBindVars.pm
index 73c7b43..71de5b9 100644 (file)
--- a/lib/DBIx/Class/Storage/DBI/NoBindVars.pm
+++ b/lib/DBIx/Class/Storage/DBI/NoBindVars.pm
@@ -4,68 +4,116 @@ use strict;
 use warnings;
 
 use base 'DBIx::Class::Storage::DBI';
+use mro 'c3';
 
-sub _execute {
-  my ($self, $op, $extra_bind, $ident, @args) = @_;
-  my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
-  unshift(@bind, @$extra_bind) if $extra_bind;
-  if ($self->debug) {
-    my @debug_bind = map { defined $_ ? qq{'$_'} : q{'NULL'} } @bind;
-    $self->debugobj->query_start($sql, @debug_bind);
-  }
+=head1 NAME 
 
-  while(my $bvar = shift @bind) {
-    $bvar = $self->dbh->quote($bvar);
-    $sql =~ s/\?/$bvar/;
-  }
+DBIx::Class::Storage::DBI::NoBindVars - Sometime DBDs have poor to no support for bind variables
 
-  my $sth = eval { $self->sth($sql,$op) };
+=head1 DESCRIPTION
 
-  if (!$sth || $@) {
-    $self->throw_exception(
-      'no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql"
-    );
-  }
+This class allows queries to work when the DBD or underlying library does not
+support the usual C<?> placeholders, or at least doesn't support them very
+well, as is the case with L<DBD::Sybase>
 
-  my $rv;
-  if ($sth) {
-    my $time = time();
-    $rv = eval { $sth->execute };
+=head1 METHODS
 
-    if ($@ || !$rv) {
-      $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr));
-    }
-  } else {
-    $self->throw_exception("'$sql' did not generate a statement.");
-  }
-  if ($self->debug) {
-    my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
-    $self->debugobj->query_end($sql, @debug_bind);
+=head2 connect_info
+
+We can't cache very effectively without bind variables, so force the C<disable_sth_caching> setting to be turned on when the connect info is set.
+
+=cut
+
+sub connect_info {
+    my $self = shift;
+    my $retval = $self->next::method(@_);
+    $self->disable_sth_caching(1);
+    $retval;
+}
+
+=head2 _prep_for_execute
+
+Manually subs in the values for the usual C<?> placeholders.
+
+=cut
+
+sub _prep_for_execute {
+  my $self = shift;
+
+  my ($sql, $bind) = $self->next::method(@_);
+
+  # stringify bind args, quote via $dbh, and manually insert
+  #my ($op, $ident, $args) = @_;
+  my $ident = $_[1];
+
+  my @sql_part = split /\?/, $sql;
+  my $new_sql;
+
+  my $col_info = $self->_resolve_column_info(
+    $ident, [ map { $_->[0]{dbic_colname} || () } @$bind ]
+  );
+
+  for (@$bind) {
+    my $datatype = $col_info->{ $_->[0]{dbic_colname}||'' }{data_type};
+
+    my $data = (ref $_->[1]) ? "$_->[1]" : $_->[1]; # always stringify
+
+    $data = $self->_prep_interpolated_value($datatype, $data)
+      if $datatype;
+
+    $data = $self->_get_dbh->quote($data)
+      unless $self->interpolate_unquoted($datatype, $data);
+
+    $new_sql .= shift(@sql_part) . $data;
   }
-  return (wantarray ? ($rv, $sth, @bind) : $rv);
+
+  $new_sql .= join '', @sql_part;
+
+  return ($new_sql, []);
 }
 
-1;
+=head2 interpolate_unquoted
 
-=head1 NAME 
+This method is called by L</_prep_for_execute> for every column in
+order to determine if its value should be quoted or not. The arguments
+are the current column data type and the actual bind value. The return
+value is interpreted as: true - do not quote, false - do quote. You should
+override this in you Storage::DBI::<database> subclass, if your RDBMS
+does not like quotes around certain datatypes (e.g. Sybase and integer
+columns). The default method always returns false (do quote).
 
-DBIx::Class::Storage::DBI::NoBindVars - Sometime DBDs have poor to no support for bind variables
+ WARNING!!!
 
-=head1 SYNOPSIS
+ Always validate that the bind-value is valid for the current datatype.
+ Otherwise you may very well open the door to SQL injection attacks.
 
-=head1 DESCRIPTION
+=cut
 
-This class allows queries to work when the DBD or underlying library does not
-support the usual C<?> placeholders, or at least doesn't support them very
-well, as is the case with L<DBD::Sybase>
+sub interpolate_unquoted {
+  #my ($self, $datatype, $value) = @_;
+  return 0;
+}
+
+=head2 _prep_interpolated_value
+
+Given a datatype and the value to be inserted directly into a SQL query, returns
+the necessary string to represent that value (by e.g. adding a '$' sign)
+
+=cut
+
+sub _prep_interpolated_value {
+  #my ($self, $datatype, $value) = @_;
+  return $_[2];
+}
 
 =head1 AUTHORS
 
-Brandon Black <blblack@gmail.com>
-Trym Skaar <trym@tryms.no>
+See L<DBIx::Class/CONTRIBUTORS>
 
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
 
 =cut
+
+1;