lib/DBIx/Class/SQLAHacks.pm

   1 package # Hide from PAUSE
   2   DBIx::Class::SQLAHacks;
   3
   4 # This module is a subclass of SQL::Abstract::Limit and includes a number
   5 # of DBIC-specific workarounds, not yet suitable for inclusion into the
   6 # SQLA core
   7
   8 use base qw/SQL::Abstract::Limit/;
   9 use strict;
  10 use warnings;
  11 use Carp::Clan qw/^DBIx::Class|^SQL::Abstract/;
  12 use Sub::Name();
  13
  14 BEGIN {
  15   # reinstall the carp()/croak() functions imported into SQL::Abstract
  16   # as Carp and Carp::Clan do not like each other much
  17   no warnings qw/redefine/;
  18   no strict qw/refs/;
  19   for my $f (qw/carp croak/) {
  20
  21     my $orig = \&{"SQL::Abstract::$f"};
  22     *{"SQL::Abstract::$f"} = Sub::Name::subname "SQL::Abstract::$f" =>
  23       sub {
  24         if (Carp::longmess() =~ /DBIx::Class::SQLAHacks::[\w]+ .+? called \s at/x) {
  25           __PACKAGE__->can($f)->(@_);
  26         }
  27         else {
  28           goto $orig;
  29         }
  30       };
  31   }
  32 }
  33
  34
  35 # Tries to determine limit dialect.
  36 #
  37 sub new {
  38   my $self = shift->SUPER::new(@_);
  39
  40   # This prevents the caching of $dbh in S::A::L, I believe
  41   # If limit_dialect is a ref (like a $dbh), go ahead and replace
  42   #   it with what it resolves to:
  43   $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
  44     if ref $self->{limit_dialect};
  45
  46   $self;
  47 }
  48
  49
  50 # ANSI standard Limit/Offset implementation. DB2 and MSSQL use this
  51 sub _RowNumberOver {
  52   my ($self, $sql, $order, $rows, $offset ) = @_;
  53
  54   # get the select to make the final amount of columns equal the original one
  55   my ($select) = $sql =~ /^ \s* SELECT \s+ (.+?) \s+ FROM/ix
  56     or croak "Unrecognizable SELECT: $sql";
  57
  58   # get the order_by only (or make up an order if none exists)
  59   my $order_by = $self->_order_by(
  60     (delete $order->{order_by}) || $self->_rno_default_order
  61   );
  62
  63   # whatever is left of the order_by
  64   my $group_having = $self->_order_by($order);
  65
  66   my $qalias = $self->_quote ($self->{_dbic_rs_attrs}{alias});
  67
  68   $sql = sprintf (<<EOS, $offset + 1, $offset + $rows, );
  69
  70 SELECT $select FROM (
  71   SELECT $qalias.*, ROW_NUMBER() OVER($order_by ) AS rno__row__index FROM (
  72     ${sql}${group_having}
  73   ) $qalias
  74 ) $qalias WHERE rno__row__index BETWEEN %d AND %d
  75
  76 EOS
  77
  78   $sql =~ s/\s*\n\s*/ /g;   # easier to read in the debugger
  79   return $sql;
  80 }
  81
  82 # some databases are happy with OVER (), some need OVER (ORDER BY (SELECT (1)) )
  83 sub _rno_default_order {
  84   return undef;
  85 }
  86
  87 # Informix specific limit, almost like LIMIT/OFFSET
  88 sub _SkipFirst {
  89   my ($self, $sql, $order, $rows, $offset) = @_;
  90
  91   $sql =~ s/^ \s* SELECT \s+ //ix
  92     or croak "Unrecognizable SELECT: $sql";
  93
  94   return sprintf ('SELECT %s%s%s%s',
  95     $offset
  96       ? sprintf ('SKIP %d ', $offset)
  97       : ''
  98     ,
  99     sprintf ('FIRST %d ', $rows),
 100     $sql,
 101     $self->_order_by ($order),
 102   );
 103 }
 104
 105 # Firebird specific limit, reverse of _SkipFirst for Informix
 106 sub _FirstSkip {
 107   my ($self, $sql, $order, $rows, $offset) = @_;
 108
 109   $sql =~ s/^ \s* SELECT \s+ //ix
 110     or croak "Unrecognizable SELECT: $sql";
 111
 112   return sprintf ('SELECT %s%s%s%s',
 113     sprintf ('FIRST %d ', $rows),
 114     $offset
 115       ? sprintf ('SKIP %d ', $offset)
 116       : ''
 117     ,
 118     $sql,
 119     $self->_order_by ($order),
 120   );
 121 }
 122
 123 # Crappy Top based Limit/Offset support. Legacy from MSSQL.
 124 sub _Top {
 125   my ( $self, $sql, $order, $rows, $offset ) = @_;
 126
 127   # mangle the input sql so it can be properly aliased in the outer queries
 128   $sql =~ s/^ \s* SELECT \s+ (.+?) \s+ (?=FROM)//ix
 129     or croak "Unrecognizable SELECT: $sql";
 130   my $sql_select = $1;
 131   my @sql_select = split (/\s*,\s*/, $sql_select);
 132
 133   # we can't support subqueries (in fact MSSQL can't) - croak
 134   if (@sql_select != @{$self->{_dbic_rs_attrs}{select}}) {
 135     croak (sprintf (
 136       'SQL SELECT did not parse cleanly - retrieved %d comma separated elements, while '
 137     . 'the resultset select attribure contains %d elements: %s',
 138       scalar @sql_select,
 139       scalar @{$self->{_dbic_rs_attrs}{select}},
 140       $sql_select,
 141     ));
 142   }
 143
 144   my $name_sep = $self->name_sep || '.';
 145   my $esc_name_sep = "\Q$name_sep\E";
 146   my $col_re = qr/ ^ (?: (.+) $esc_name_sep )? ([^$esc_name_sep]+) $ /x;
 147
 148   my $rs_alias = $self->{_dbic_rs_attrs}{alias};
 149   my $quoted_rs_alias = $self->_quote ($rs_alias);
 150
 151   # construct the new select lists, rename(alias) some columns if necessary
 152   my (@outer_select, @inner_select, %seen_names, %col_aliases, %outer_col_aliases);
 153
 154   for (@{$self->{_dbic_rs_attrs}{select}}) {
 155     next if ref $_;
 156     my ($table, $orig_colname) = ( $_ =~ $col_re );
 157     next unless $table;
 158     $seen_names{$orig_colname}++;
 159   }
 160
 161   for my $i (0 .. $#sql_select) {
 162
 163     my $colsel_arg = $self->{_dbic_rs_attrs}{select}[$i];
 164     my $colsel_sql = $sql_select[$i];
 165
 166     # this may or may not work (in case of a scalarref or something)
 167     my ($table, $orig_colname) = ( $colsel_arg =~ $col_re );
 168
 169     my $quoted_alias;
 170     # do not attempt to understand non-scalar selects - alias numerically
 171     if (ref $colsel_arg) {
 172       $quoted_alias = $self->_quote ('column_' . (@inner_select + 1) );
 173     }
 174     # column name seen more than once - alias it
 175     elsif ($orig_colname &&
 176           ($seen_names{$orig_colname} && $seen_names{$orig_colname} > 1) ) {
 177       $quoted_alias = $self->_quote ("${table}__${orig_colname}");
 178     }
 179
 180     # we did rename - make a record and adjust
 181     if ($quoted_alias) {
 182       # alias inner
 183       push @inner_select, "$colsel_sql AS $quoted_alias";
 184
 185       # push alias to outer
 186       push @outer_select, $quoted_alias;
 187
 188       # Any aliasing accumulated here will be considered
 189       # both for inner and outer adjustments of ORDER BY
 190       $self->__record_alias (
 191         \%col_aliases,
 192         $quoted_alias,
 193         $colsel_arg,
 194         $table ? $orig_colname : undef,
 195       );
 196     }
 197
 198     # otherwise just leave things intact inside, and use the abbreviated one outside
 199     # (as we do not have table names anymore)
 200     else {
 201       push @inner_select, $colsel_sql;
 202
 203       my $outer_quoted = $self->_quote ($orig_colname);  # it was not a duplicate so should just work
 204       push @outer_select, $outer_quoted;
 205       $self->__record_alias (
 206         \%outer_col_aliases,
 207         $outer_quoted,
 208         $colsel_arg,
 209         $table ? $orig_colname : undef,
 210       );
 211     }
 212   }
 213
 214   my $outer_select = join (', ', @outer_select );
 215   my $inner_select = join (', ', @inner_select );
 216
 217   %outer_col_aliases = (%outer_col_aliases, %col_aliases);
 218
 219   # deal with order
 220   croak '$order supplied to SQLAHacks limit emulators must be a hash'
 221     if (ref $order ne 'HASH');
 222
 223   $order = { %$order }; #copy
 224
 225   my $req_order = $order->{order_by};
 226
 227   # examine normalized version, collapses nesting
 228   my $limit_order;
 229   if (scalar $self->_order_by_chunks ($req_order)) {
 230     $limit_order = $req_order;
 231   }
 232   else {
 233     $limit_order = [ map
 234       { join ('', $rs_alias, $name_sep, $_ ) }
 235       ( $self->{_dbic_rs_attrs}{_source_handle}->resolve->primary_columns )
 236     ];
 237   }
 238
 239   my ( $order_by_inner, $order_by_outer ) = $self->_order_directions($limit_order);
 240   my $order_by_requested = $self->_order_by ($req_order);
 241
 242   # generate the rest
 243   delete $order->{order_by};
 244   my $grpby_having = $self->_order_by ($order);
 245
 246   # short circuit for counts - the ordering complexity is needless
 247   if ($self->{_dbic_rs_attrs}{-for_count_only}) {
 248     return "SELECT TOP $rows $inner_select $sql $grpby_having $order_by_outer";
 249   }
 250
 251   # we can't really adjust the order_by columns, as introspection is lacking
 252   # resort to simple substitution
 253   for my $col (keys %outer_col_aliases) {
 254     for ($order_by_requested, $order_by_outer) {
 255       $_ =~ s/\s+$col\s+/ $outer_col_aliases{$col} /g;
 256     }
 257   }
 258   for my $col (keys %col_aliases) {
 259     $order_by_inner =~ s/\s+$col\s+/ $col_aliases{$col} /g;
 260   }
 261
 262
 263   my $inner_lim = $rows + $offset;
 264
 265   $sql = "SELECT TOP $inner_lim $inner_select $sql $grpby_having $order_by_inner";
 266
 267   if ($offset) {
 268     $sql = <<"SQL";
 269
 270     SELECT TOP $rows $outer_select FROM
 271     (
 272       $sql
 273     ) $quoted_rs_alias
 274     $order_by_outer
 275 SQL
 276
 277   }
 278
 279   if ($order_by_requested) {
 280     $sql = <<"SQL";
 281
 282     SELECT $outer_select FROM
 283       ( $sql ) $quoted_rs_alias
 284     $order_by_requested
 285 SQL
 286
 287   }
 288
 289   $sql =~ s/\s*\n\s*/ /g; # parsing out multiline statements is harder than a single line
 290   return $sql;
 291 }
 292
 293 # action at a distance to shorten Top code above
 294 sub __record_alias {
 295   my ($self, $register, $alias, $fqcol, $col) = @_;
 296
 297   # record qualified name
 298   $register->{$fqcol} = $alias;
 299   $register->{$self->_quote($fqcol)} = $alias;
 300
 301   return unless $col;
 302
 303   # record unqualified name, undef (no adjustment) if a duplicate is found
 304   if (exists $register->{$col}) {
 305     $register->{$col} = undef;
 306   }
 307   else {
 308     $register->{$col} = $alias;
 309   }
 310
 311   $register->{$self->_quote($col)} = $register->{$col};
 312 }
 313
 314
 315
 316 # While we're at it, this should make LIMIT queries more efficient,
 317 #  without digging into things too deeply
 318 sub _find_syntax {
 319   my ($self, $syntax) = @_;
 320   return $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
 321 }
 322
 323 my $for_syntax = {
 324   update => 'FOR UPDATE',
 325   shared => 'FOR SHARE',
 326 };
 327 # Quotes table names, handles "limit" dialects (e.g. where rownum between x and
 328 # y), supports SELECT ... FOR UPDATE and SELECT ... FOR SHARE.
 329 sub select {
 330   my ($self, $table, $fields, $where, $order, @rest) = @_;
 331
 332   $self->{"${_}_bind"} = [] for (qw/having from order/);
 333
 334   if (not ref($table) or ref($table) eq 'SCALAR') {
 335     $table = $self->_quote($table);
 336   }
 337
 338   local $self->{rownum_hack_count} = 1
 339     if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
 340   @rest = (-1) unless defined $rest[0];
 341   croak "LIMIT 0 Does Not Compute" if $rest[0] == 0;
 342     # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
 343   my ($sql, @where_bind) = $self->SUPER::select(
 344     $table, $self->_recurse_fields($fields), $where, $order, @rest
 345   );
 346   if (my $for = delete $self->{_dbic_rs_attrs}{for}) {
 347     $sql .= " $for_syntax->{$for}" if $for_syntax->{$for};
 348   }
 349
 350   return wantarray ? ($sql, @{$self->{from_bind}}, @where_bind, @{$self->{having_bind}}, @{$self->{order_bind}} ) : $sql;
 351 }
 352
 353 # Quotes table names, and handles default inserts
 354 sub insert {
 355   my $self = shift;
 356   my $table = shift;
 357   $table = $self->_quote($table);
 358
 359   # SQLA will emit INSERT INTO $table ( ) VALUES ( )
 360   # which is sadly understood only by MySQL. Change default behavior here,
 361   # until SQLA2 comes with proper dialect support
 362   if (! $_[0] or (ref $_[0] eq 'HASH' and !keys %{$_[0]} ) ) {
 363     my $sql = "INSERT INTO ${table} DEFAULT VALUES";
 364
 365     if (my $ret = ($_[1]||{})->{returning} ) {
 366       $sql .= $self->_insert_returning ($ret);
 367     }
 368
 369     return $sql;
 370   }
 371
 372   $self->SUPER::insert($table, @_);
 373 }
 374
 375 # Just quotes table names.
 376 sub update {
 377   my $self = shift;
 378   my $table = shift;
 379   $table = $self->_quote($table);
 380   $self->SUPER::update($table, @_);
 381 }
 382
 383 # Just quotes table names.
 384 sub delete {
 385   my $self = shift;
 386   my $table = shift;
 387   $table = $self->_quote($table);
 388   $self->SUPER::delete($table, @_);
 389 }
 390
 391 sub _emulate_limit {
 392   my $self = shift;
 393   if ($_[3] == -1) {
 394     return $_[1].$self->_order_by($_[2]);
 395   } else {
 396     return $self->SUPER::_emulate_limit(@_);
 397   }
 398 }
 399
 400 sub _recurse_fields {
 401   my ($self, $fields, $params) = @_;
 402   my $ref = ref $fields;
 403   return $self->_quote($fields) unless $ref;
 404   return $$fields if $ref eq 'SCALAR';
 405
 406   if ($ref eq 'ARRAY') {
 407     return join(', ', map {
 408       $self->_recurse_fields($_)
 409         .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
 410           ? ' AS col'.$self->{rownum_hack_count}++
 411           : '')
 412       } @$fields);
 413   }
 414   elsif ($ref eq 'HASH') {
 415     my %hash = %$fields;
 416
 417     my $as = delete $hash{-as};   # if supplied
 418
 419     my ($func, $args) = each %hash;
 420     delete $hash{$func};
 421
 422     if (lc ($func) eq 'distinct' && ref $args eq 'ARRAY' && @$args > 1) {
 423       croak (
 424         'The select => { distinct => ... } syntax is not supported for multiple columns.'
 425        .' Instead please use { group_by => [ qw/' . (join ' ', @$args) . '/ ] }'
 426        .' or { select => [ qw/' . (join ' ', @$args) . '/ ], distinct => 1 }'
 427       );
 428     }
 429
 430     my $select = sprintf ('%s( %s )%s',
 431       $self->_sqlcase($func),
 432       $self->_recurse_fields($args),
 433       $as
 434         ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) )
 435         : ''
 436     );
 437
 438     # there should be nothing left
 439     if (keys %hash) {
 440       croak "Malformed select argument - too many keys in hash: " . join (',', keys %$fields );
 441     }
 442
 443     return $select;
 444   }
 445   # Is the second check absolutely necessary?
 446   elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) {
 447     return $self->_fold_sqlbind( $fields );
 448   }
 449   else {
 450     croak($ref . qq{ unexpected in _recurse_fields()})
 451   }
 452 }
 453
 454 sub _order_by {
 455   my ($self, $arg) = @_;
 456
 457   if (ref $arg eq 'HASH' and keys %$arg and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) {
 458
 459     my $ret = '';
 460
 461     if (my $g = $self->_recurse_fields($arg->{group_by}, { no_rownum_hack => 1 }) ) {
 462       $ret = $self->_sqlcase(' group by ') . $g;
 463     }
 464
 465     if (defined $arg->{having}) {
 466       my ($frag, @bind) = $self->_recurse_where($arg->{having});
 467       push(@{$self->{having_bind}}, @bind);
 468       $ret .= $self->_sqlcase(' having ').$frag;
 469     }
 470
 471     if (defined $arg->{order_by}) {
 472       my ($frag, @bind) = $self->SUPER::_order_by($arg->{order_by});
 473       push(@{$self->{order_bind}}, @bind);
 474       $ret .= $frag;
 475     }
 476
 477     return $ret;
 478   }
 479   else {
 480     my ($sql, @bind) = $self->SUPER::_order_by ($arg);
 481     push(@{$self->{order_bind}}, @bind);
 482     return $sql;
 483   }
 484 }
 485
 486 sub _order_directions {
 487   my ($self, $order) = @_;
 488
 489   # strip bind values - none of the current _order_directions users support them
 490   return $self->SUPER::_order_directions( [ map
 491     { ref $_ ? $_->[0] : $_ }
 492     $self->_order_by_chunks ($order)
 493   ]);
 494 }
 495
 496 sub _table {
 497   my ($self, $from) = @_;
 498   if (ref $from eq 'ARRAY') {
 499     return $self->_recurse_from(@$from);
 500   } elsif (ref $from eq 'HASH') {
 501     return $self->_make_as($from);
 502   } else {
 503     return $from; # would love to quote here but _table ends up getting called
 504                   # twice during an ->select without a limit clause due to
 505                   # the way S::A::Limit->select works. should maybe consider
 506                   # bypassing this and doing S::A::select($self, ...) in
 507                   # our select method above. meantime, quoting shims have
 508                   # been added to select/insert/update/delete here
 509   }
 510 }
 511
 512 sub _generate_join_clause {
 513     my ($self, $join_type) = @_;
 514
 515     return sprintf ('%s JOIN ',
 516       $join_type ?  ' ' . uc($join_type) : ''
 517     );
 518 }
 519
 520 sub _recurse_from {
 521   my ($self, $from, @join) = @_;
 522   my @sqlf;
 523   push(@sqlf, $self->_make_as($from));
 524   foreach my $j (@join) {
 525     my ($to, $on) = @$j;
 526
 527
 528     # check whether a join type exists
 529     my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
 530     my $join_type;
 531     if (ref($to_jt) eq 'HASH' and defined($to_jt->{-join_type})) {
 532       $join_type = $to_jt->{-join_type};
 533       $join_type =~ s/^\s+ | \s+$//xg;
 534     }
 535
 536     $join_type = $self->{_default_jointype} if not defined $join_type;
 537
 538     push @sqlf, $self->_generate_join_clause( $join_type );
 539
 540     if (ref $to eq 'ARRAY') {
 541       push(@sqlf, '(', $self->_recurse_from(@$to), ')');
 542     } else {
 543       push(@sqlf, $self->_make_as($to));
 544     }
 545     push(@sqlf, ' ON ', $self->_join_condition($on));
 546   }
 547   return join('', @sqlf);
 548 }
 549
 550 sub _fold_sqlbind {
 551   my ($self, $sqlbind) = @_;
 552
 553   my @sqlbind = @$$sqlbind; # copy
 554   my $sql = shift @sqlbind;
 555   push @{$self->{from_bind}}, @sqlbind;
 556
 557   return $sql;
 558 }
 559
 560 sub _make_as {
 561   my ($self, $from) = @_;
 562   return join(' ', map { (ref $_ eq 'SCALAR' ? $$_
 563                         : ref $_ eq 'REF'    ? $self->_fold_sqlbind($_)
 564                         : $self->_quote($_))
 565                        } reverse each %{$self->_skip_options($from)});
 566 }
 567
 568 sub _skip_options {
 569   my ($self, $hash) = @_;
 570   my $clean_hash = {};
 571   $clean_hash->{$_} = $hash->{$_}
 572     for grep {!/^-/} keys %$hash;
 573   return $clean_hash;
 574 }
 575
 576 sub _join_condition {
 577   my ($self, $cond) = @_;
 578   if (ref $cond eq 'HASH') {
 579     my %j;
 580     for (keys %$cond) {
 581       my $v = $cond->{$_};
 582       if (ref $v) {
 583         croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
 584             if ref($v) ne 'SCALAR';
 585         $j{$_} = $v;
 586       }
 587       else {
 588         my $x = '= '.$self->_quote($v); $j{$_} = \$x;
 589       }
 590     };
 591     return scalar($self->_recurse_where(\%j));
 592   } elsif (ref $cond eq 'ARRAY') {
 593     return join(' OR ', map { $self->_join_condition($_) } @$cond);
 594   } else {
 595     die "Can't handle this yet!";
 596   }
 597 }
 598
 599 sub _quote {
 600   my ($self, $label) = @_;
 601   return '' unless defined $label;
 602   return $$label if ref($label) eq 'SCALAR';
 603   return "*" if $label eq '*';
 604   return $label unless $self->{quote_char};
 605   if(ref $self->{quote_char} eq "ARRAY"){
 606     return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
 607       if !defined $self->{name_sep};
 608     my $sep = $self->{name_sep};
 609     return join($self->{name_sep},
 610         map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1]  }
 611        split(/\Q$sep\E/,$label));
 612   }
 613   return $self->SUPER::_quote($label);
 614 }
 615
 616 sub limit_dialect {
 617     my $self = shift;
 618     $self->{limit_dialect} = shift if @_;
 619     return $self->{limit_dialect};
 620 }
 621
 622 # Set to an array-ref to specify separate left and right quotes for table names.
 623 # A single scalar is equivalen to [ $char, $char ]
 624 sub quote_char {
 625     my $self = shift;
 626     $self->{quote_char} = shift if @_;
 627     return $self->{quote_char};
 628 }
 629
 630 # Character separating quoted table names.
 631 sub name_sep {
 632     my $self = shift;
 633     $self->{name_sep} = shift if @_;
 634     return $self->{name_sep};
 635 }
 636
 637 1;