Merge branch 'patch-19' of https://github.com/gjones2/Freeside
[freeside.git] / httemplate / search / elements / cust_pay_or_refund.html
index 114f245..7b2a170 100755 (executable)
@@ -39,21 +39,22 @@ Examples:
          )
 
 </%doc>
-<% include( 'search.html',
-                'title'          => $title,
+<& search.html,
+                'title'          => $title, # XXX: translate
                 'name_singular'  => $name_singular,
                 'query'          => $sql_query,
                 'count_query'    => $count_query,
-                'count_addl'     => [ '$%.2f total '.$opt{name_verb}, ],
+                'count_addl'     => \@count_addl,
                 'redirect_empty' => $opt{'redirect_empty'},
                 'header'         => \@header,
                 'fields'         => \@fields,
+                'sort_fields'    => \@sort_fields,
                 'align'          => $align,
                 'links'          => \@links,
+                'link_onclicks'  => \@link_onclicks,
                 'color'          => \@color,
                 'style'          => \@style,
-          )
-%>
+&>
 <%init>
 
 my %opt = @_;
@@ -68,11 +69,15 @@ my $table = $opt{'table'} || 'cust_'.$opt{'thing'};
 my $amount_field = $opt{'amount_field'};
 my $name_singular = $opt{'name_singular'};
 
-my $title = "\u$name_singular Search Results";
+my $unapplied = $cgi->param('unapplied');
+my $title = '';
+$title = 'Unapplied ' if $unapplied;
+$title .= "\u$name_singular Search Results";
 
 my $link = '';
-if (    ( $curuser->access_right('View invoices') #XXX for now
-          || $curuser->access_right('View customer payments')
+if (    ( $curuser->access_right('View invoices') #remove in 2.5 (2.7?)
+          || ($curuser->access_right('View payments') && $table =~ /^cust_pay/)
+          || ($curuser->access_right('View refunds') && $table eq 'cust_refund')
         )
      && ! $opt{'disable_link'}
    )
@@ -100,30 +105,87 @@ my $cust_link = sub {
     : '';
 };
 
-my @header = ();
-my @fields = ();
+# only valid for $table == 'cust_pay' atm
+my  $tax_names = '';
+if ( $cgi->param('tax_names') ) {
+  if ( dbh->{Driver}->{Name} eq 'Pg' ) {
+
+    $tax_names = "
+      array_to_string(
+        array(
+          SELECT itemdesc
+            FROM cust_bill_pay
+            LEFT JOIN cust_bill_pay_pkg USING ( billpaynum )
+            LEFT JOIN cust_bill_pkg USING ( billpkgnum )
+              WHERE cust_bill_pkg.pkgnum = 0
+                AND cust_bill_pay.paynum = cust_pay.paynum
+        ), '|'
+      ) AS tax_names"
+    ;
+
+  } elsif ( dbh->{Driver}->{Name} =~ /^mysql/i ) {
+
+    $tax_names = "GROUP_CONCAT(itemdesc SEPARATOR '|') AS tax_names";
+
+  } else {
+
+    warn "warning: unknown database type ". dbh->{Driver}->{Name}.
+         "omitting tax name information from report.";
+
+  }
+}
+
+my @header;
+my @fields;
+my @sort_fields;
 my $align = '';
-my @links = ();
+my @links;
+my @link_onclicks;
 if ( $opt{'pre_header'} ) {
   push @header, @{ $opt{'pre_header'} };
   $align .= 'c' x scalar(@{ $opt{'pre_header'} });
   push @links, map '', @{ $opt{'pre_header'} };
   push @fields, @{ $opt{'pre_fields'} };
+  push @sort_fields, @{ $opt{'pre_fields'} };
 }
 
+my $sub_receipt = sub {
+  my $obj = shift;
+  my $objnum = $obj->primary_key . '=' . $obj->get($obj->primary_key);
+
+  include('/elements/popup_link_onclick.html',
+    'action'  => $p.'view/cust_pay.html?link=popup;'.$objnum,
+    'actionlabel' => emt('Payment Receipt'),
+  );
+};
+
 push @header, "\u$name_singular",
               'Amount',
-              'Date',
 ;
-$align .= 'rrr';
-push @links, '', '', '';
+$align .= 'rr';
+push @links, '', '';
 push @fields, 'payby_payinfo_pretty',
               sub { sprintf('$%.2f', shift->$amount_field() ) },
-              sub { time2str('%b %d %Y', shift->_date ) },
 ;
+push @link_onclicks, $sub_receipt, '',
+push @sort_fields, '', $amount_field;
+
+if ( $unapplied ) {
+  push @header, emt('Unapplied');
+  $align .= 'r';
+  push @links, '';
+  push @fields, sub { sprintf('$%.2f', shift->unapplied_amount) };
+  push @sort_fields, '';
+}
+
+push @header, emt('Date');
+$align .= 'r';
+push @links, '';
+push @fields, sub { time2str('%b %d %Y', shift->_date ) };
+push @sort_fields, '_date';
 
 unless ( $opt{'disable_by'} ) {
-  push @header, 'By';
+  push @header, emt('By');
   $align .= 'c';
   push @links, '';
   push @fields, sub { my $o = shift->otaker;
@@ -133,6 +195,22 @@ unless ( $opt{'disable_by'} ) {
                     };
 }
 
+if ( $tax_names ) {
+  push @header, (emt('Tax names'), emt('Tax province'));
+  $align .= 'cc';
+  push @links, ('','');
+  push @fields, sub { join (' + ', map { /^(.*?)(, \w\w)?$/; $1 }
+                                   split('\|', shift->tax_names)
+                           );
+                    };
+  push @fields, sub { join (' + ', map { if (/^(?:.*)(?:, )(\w\w)$/){ $1 }
+                                         else { () }
+                                       }
+                                   split('\|', shift->tax_names)
+                           );
+                    };
+}
+
 push @header, FS::UI::Web::cust_header();
 $align .=  FS::UI::Web::cust_aligns();
 push @links, map { $_ ne 'Cust. Status' ? $cust_link : '' }
@@ -146,10 +224,17 @@ push @header, @{ $opt{'addl_header'} }
 push @fields, @{ $opt{'addl_fields'} }
   if $opt{'addl_fields'};
 
-my( $count_query, $sql_query );
+my( $count_query, $sql_query, @count_addl );
 if ( $cgi->param('magic') ) {
 
   my @search = ();
+  my @select = (
+    "$table.*",
+    FS::UI::Web::cust_sql_fields(),
+    'cust_main.custnum AS cust_main_custnum',
+  );
+  push @select, $tax_names if $tax_names;
+
   my $orderby;
   if ( $cgi->param('magic') eq '_date' ) {
 
@@ -160,83 +245,142 @@ if ( $cgi->param('magic') ) {
       $title = $agent->agent. " $title";
     }
 
+    if ( $cgi->param('refnum') && $cgi->param('refnum') =~ /^(\d+)$/ ) {
+      push @search, "refnum = $1";
+      my $part_referral = qsearchs('part_referral', { 'refnum' => $1 } );
+      die "unknown refnum $1" unless $part_referral;
+      $title = $part_referral->referral. " $title";
+    }
+
+    # cust_classnum (false laziness w/ elements/cust_main_dayranges.html, prepaid_income.html, cust_bill_pay.html, cust_bill_pkg.html cust_bill_pkg_referral.html, unearned_detail.html, cust_credit.html, cust_credit_refund.html, cust_main::Search::search_sql)
+    if ( grep { $_ eq 'cust_classnum' } $cgi->param ) {
+      my @classnums = grep /^\d*$/, $cgi->param('cust_classnum');
+      push @search, 'COALESCE( cust_main.classnum, 0) IN ( '.
+                        join(',', map { $_ || '0' } @classnums ).
+                    ' )'
+        if @classnums;
+    }
+
     if ( $cgi->param('custnum') =~ /^(\d+)$/ ) {
       push @search, "custnum = $1";
     }
 
     if ( $cgi->param('payby') ) {
-      $cgi->param('payby') =~
-        /^(CARD|CHEK|BILL|PREP|CASH|WEST|MCRD)(-(VisaMC|Amex|Discover|Maestro))?$/
-          or die "illegal payby ". $cgi->param('payby');
-      push @search, "$table.payby = '$1'";
-      if ( $3 ) {
-
-        my $cardtype = $3;
-
-        my $search;
-        if ( $cardtype eq 'VisaMC' ) {
-          #avoid posix regexes for portability
-          $search =
-            " ( (     substring($table.payinfo from 1 for 1) = '4'     ".
-            "     AND substring($table.payinfo from 1 for 4) != '4936' ".
-            "     AND substring($table.payinfo from 1 for 6)           ".
-            "         NOT SIMILAR TO '49030[2-9]'                        ".
-            "     AND substring($table.payinfo from 1 for 6)           ".
-            "         NOT SIMILAR TO '49033[5-9]'                        ".
-            "     AND substring($table.payinfo from 1 for 6)           ".
-            "         NOT SIMILAR TO '49110[1-2]'                        ".
-            "     AND substring($table.payinfo from 1 for 6)           ".
-            "         NOT SIMILAR TO '49117[4-9]'                        ".
-            "     AND substring($table.payinfo from 1 for 6)           ".
-            "         NOT SIMILAR TO '49118[1-2]'                        ".
-            "   )".
-            "   OR substring($table.payinfo from 1 for 2) = '51' ".
-            "   OR substring($table.payinfo from 1 for 2) = '52' ".
-            "   OR substring($table.payinfo from 1 for 2) = '53' ".
-            "   OR substring($table.payinfo from 1 for 2) = '54' ".
-            "   OR substring($table.payinfo from 1 for 2) = '54' ".
-            "   OR substring($table.payinfo from 1 for 2) = '55' ".
-            "   OR substring($table.payinfo from 1 for 2) = '36' ". #Diner's int'l processed as Visa/MC inside US
-            " ) ";
-        } elsif ( $cardtype eq 'Amex' ) {
-          $search =
-            " (    substring($table.payinfo from 1 for 2 ) = '34' ".
-            "   OR substring($table.payinfo from 1 for 2 ) = '37' ".
-            " ) ";
-        } elsif ( $cardtype eq 'Discover' ) {
-          $search =
-            " (    substring($table.payinfo from 1 for 4 ) = '6011'  ".
-            "   OR substring($table.payinfo from 1 for 2 ) = '65'    ".
-            "   OR substring($table.payinfo from 1 for 3 ) = '622'   ". #China Union Pay processed as Discover outside CN
-            " ) ";
-        } elsif ( $cardtype eq 'Maestro' ) { 
-          $search =
-            " (    substring($table.payinfo from 1 for 2 ) = '63'     ".
-            "   OR substring($table.payinfo from 1 for 2 ) = '67'     ".
-            "   OR substring($table.payinfo from 1 for 6 ) = '564182' ".
-            "   OR substring($table.payinfo from 1 for 4 ) = '4936'   ".
-            "   OR substring($table.payinfo from 1 for 6 )            ".
-            "      SIMILAR TO '49030[2-9]'                             ".
-            "   OR substring($table.payinfo from 1 for 6 )            ".
-            "      SIMILAR TO '49033[5-9]'                             ".
-            "   OR substring($table.payinfo from 1 for 6 )            ".
-            "      SIMILAR TO '49110[1-2]'                             ".
-            "   OR substring($table.payinfo from 1 for 6 )            ".
-            "      SIMILAR TO '49117[4-9]'                             ".
-            "   OR substring($table.payinfo from 1 for 6 )            ".
-            "      SIMILAR TO '49118[1-2]'                             ".
-            " ) ";
-        } else {
-          die "unknown card type $cardtype";
-        }
 
-        my $masksearch = $search;
-        $masksearch =~ s/$table\.payinfo/$table.paymask/gi;
+      my @all_payby_search = ();
+      foreach my $payby ( $cgi->param('payby') ) {
+
+        $payby =~
+          /^(CARD|CHEK|BILL|PREP|CASH|WEST|MCRD)(-(VisaMC|Amex|Discover|Maestro))?$/
+            or die "illegal payby $payby";
+
+        my $payby_search = "$table.payby = '$1'";
+
+        if ( $3 ) {
+
+          my $cardtype = $3;
+
+          my $search;
+          if ( $cardtype eq 'VisaMC' ) {
+            #avoid posix regexes for portability
+            $search =
+              " ( (     substring($table.payinfo from 1 for 1) = '4'     ".
+              "     AND substring($table.payinfo from 1 for 4) != '4936' ".
+              "     AND substring($table.payinfo from 1 for 6)           ".
+              "         NOT SIMILAR TO '49030[2-9]'                        ".
+              "     AND substring($table.payinfo from 1 for 6)           ".
+              "         NOT SIMILAR TO '49033[5-9]'                        ".
+              "     AND substring($table.payinfo from 1 for 6)           ".
+              "         NOT SIMILAR TO '49110[1-2]'                        ".
+              "     AND substring($table.payinfo from 1 for 6)           ".
+              "         NOT SIMILAR TO '49117[4-9]'                        ".
+              "     AND substring($table.payinfo from 1 for 6)           ".
+              "         NOT SIMILAR TO '49118[1-2]'                        ".
+              "   )".
+              "   OR substring($table.payinfo from 1 for 2) = '51' ".
+              "   OR substring($table.payinfo from 1 for 2) = '52' ".
+              "   OR substring($table.payinfo from 1 for 2) = '53' ".
+              "   OR substring($table.payinfo from 1 for 2) = '54' ".
+              "   OR substring($table.payinfo from 1 for 2) = '54' ".
+              "   OR substring($table.payinfo from 1 for 2) = '55' ".
+#              "   OR substring($table.payinfo from 1 for 2) = '36' ". #Diner's int'l was processed as Visa/MC inside US, now Discover
+              " ) ";
+          } elsif ( $cardtype eq 'Amex' ) {
+            $search =
+              " (    substring($table.payinfo from 1 for 2 ) = '34' ".
+              "   OR substring($table.payinfo from 1 for 2 ) = '37' ".
+              " ) ";
+          } elsif ( $cardtype eq 'Discover' ) {
+
+            my $conf = new FS::Conf;
+            my $country = $conf->config('countrydefault') || 'US';
+
+            $search =
+              " (    substring($table.payinfo from 1 for 4 ) = '6011'  ".
+              "   OR substring($table.payinfo from 1 for 2 ) = '65'    ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '300'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '301'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '302'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '303'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '304'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '305'   ".
+              "   OR substring($table.payinfo from 1 for 4 ) = '3095'  ".
+              "   OR substring($table.payinfo from 1 for 2 ) = '36'    ".
+              "   OR substring($table.payinfo from 1 for 2 ) = '38'    ".
+              "   OR substring($table.payinfo from 1 for 2 ) = '39'    ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '644'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '645'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '646'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '647'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '648'   ".
+              "   OR substring($table.payinfo from 1 for 3 ) = '649'   ".
+              ( $country =~ /^(US|CA)$/
+               ?" OR substring($table.payinfo from 1 for 4 ) = '3528'  ". # JCB cards in the 3528-3589 range identified as Discover inside US/CA
+                " OR substring($table.payinfo from 1 for 4 ) = '3529'  ".
+                " OR substring($table.payinfo from 1 for 3 ) = '353'   ".
+                " OR substring($table.payinfo from 1 for 3 ) = '354'   ".
+                " OR substring($table.payinfo from 1 for 3 ) = '355'   ".
+                " OR substring($table.payinfo from 1 for 3 ) = '356'   ".
+                " OR substring($table.payinfo from 1 for 3 ) = '357'   ".
+                " OR substring($table.payinfo from 1 for 3 ) = '358'   "
+               :""
+              ).
+              "   OR substring($table.payinfo from 1 for 3 ) = '622'   ". #China Union Pay processed as Discover outside CN
+              " ) ";
+          } elsif ( $cardtype eq 'Maestro' ) { 
+            $search =
+              " (    substring($table.payinfo from 1 for 2 ) = '63'     ".
+              "   OR substring($table.payinfo from 1 for 2 ) = '67'     ".
+              "   OR substring($table.payinfo from 1 for 6 ) = '564182' ".
+              "   OR substring($table.payinfo from 1 for 4 ) = '4936'   ".
+              "   OR substring($table.payinfo from 1 for 6 )            ".
+              "      SIMILAR TO '49030[2-9]'                             ".
+              "   OR substring($table.payinfo from 1 for 6 )            ".
+              "      SIMILAR TO '49033[5-9]'                             ".
+              "   OR substring($table.payinfo from 1 for 6 )            ".
+              "      SIMILAR TO '49110[1-2]'                             ".
+              "   OR substring($table.payinfo from 1 for 6 )            ".
+              "      SIMILAR TO '49117[4-9]'                             ".
+              "   OR substring($table.payinfo from 1 for 6 )            ".
+              "      SIMILAR TO '49118[1-2]'                             ".
+              " ) ";
+          } else {
+            die "unknown card type $cardtype";
+          }
+
+          my $masksearch = $search;
+          $masksearch =~ s/$table\.payinfo/$table.paymask/gi;
+
+          $payby_search = "( $payby_search AND ( $search OR ( $table.paymask IS NOT NULL AND $masksearch ) ) )";
 
-        push @search,
-          "( $search OR ( $table.paymask IS NOT NULL AND $masksearch ) )";
+        }
+
+        push @all_payby_search, $payby_search;
 
       }
+
+      push @search, ' ( '. join(' OR ', @all_payby_search). ' ) ' if @all_payby_search;
+
     }
 
     if ( $cgi->param('payinfo') ) {
@@ -245,6 +389,16 @@ if ( $cgi->param('magic') ) {
       push @search, "$table.payinfo = '$1'";
     }
 
+    if ( $cgi->param('ccpay') =~ /^([\w-:]+)$/ ) {
+      # I think that's all the characters we need to allow.
+      # To avoid confusion, this parameter searches both auth and order_number.
+      push @search, "($table.auth LIKE '$1%') OR ($table.order_number LIKE '$1%')";
+      push @fields, 'auth', 'order_number';
+      push @header, 'Auth #', 'Transaction #';
+      $align .= 'rr';
+
+    }
+
     if ( $cgi->param('usernum') =~ /^(\d+)$/ ) {
       push @search, "$table.usernum = $1";
     }
@@ -255,6 +409,7 @@ if ( $cgi->param('magic') ) {
     }
 
     my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
+
     push @search, "_date >= $beginning ",
                   "_date <= $ending";
 
@@ -278,10 +433,26 @@ if ( $cgi->param('magic') ) {
 
     $orderby = "LOWER(company || ' ' || last || ' ' || first )";
 
+  } elsif ( $cgi->param('magic') eq 'batchnum' ) {
+
+    $cgi->param('batchnum') =~ /^(\d+)$/
+      or die "illegal batchnum: ".$cgi->param('batchnum');
+
+    push @search, "batchnum = $1";
+
+    $orderby = "LOWER(company || ' ' || last || ' ' || first )";
+
   } else {
     die "unknown search magic: ". $cgi->param('magic');
   }
 
+  #unapplied payment/refund
+  if ( $unapplied ) {
+    push @select, '(' . "FS::$table"->unapplied_sql . ') AS unapplied_amount';
+    push @search, "FS::$table"->unapplied_sql . ' > 0';
+
+  }
+
   #for the history search
   if ( $cgi->param('history_action') =~ /^([\w,]+)$/ ) {
     my @history_action = split(/,/, $1);
@@ -300,22 +471,50 @@ if ( $cgi->param('magic') ) {
   #here is the agent virtualization
   push @search, $curuser->agentnums_sql;
 
+  my $addl_from = FS::UI::Web::join_cust_main($table);
+  my $group_by = '';
+
+  if ( $cgi->param('tax_names') ) {
+    if ( dbh->{Driver}->{Name} eq 'Pg' ) {
+
+      0;#twiddle thumbs
+
+    } elsif ( dbh->{Driver}->{Name} =~ /^mysql/i ) {
+
+      $addl_from .= "LEFT JOIN cust_bill_pay USING ( paynum )
+                     LEFT JOIN cust_bill_pay_pkg USING ( billpaynum )
+                     LEFT JOIN cust_bill_pkg USING ( billpkgnum ) AS tax_names";
+      $group_by  .= "GROUP BY $table.*,cust_main_custnum,".
+                    FS::UI::Web::cust_sql_fields();
+      push @search,
+       "( cust_bill_pkg.pkgnum = 0 OR cust_bill_pkg.pkgnum is NULL )";
+
+    } else {
+
+      warn "warning: unknown database type ". dbh->{Driver}->{Name}.
+           "omitting tax name information from report.";
+
+    }
+  }
+
   my $search = ' WHERE '. join(' AND ', @search);
 
-  $count_query = "SELECT COUNT(*), SUM($amount_field) ".
-                 "FROM $table LEFT JOIN cust_main USING ( custnum )".
-                 $search;
+  $count_query = "SELECT COUNT(*), SUM($amount_field) ";
+  $count_query .= ', SUM(' . "FS::$table"->unapplied_sql . ') ' 
+    if $unapplied;
+  $count_query .= "FROM $table $addl_from".
+                  "$search $group_by";
+
+  @count_addl = ( '$%.2f total '.$opt{name_verb} );
+  push @count_addl, '$%.2f unapplied' if $unapplied;
 
   $sql_query = {
     'table'     => $table,
-    'select'    => join(', ',
-                     "$table.*",
-                     'cust_main.custnum as cust_main_custnum',
-                     FS::UI::Web::cust_sql_fields(),
-                   ),
+    'select'    => join(', ', @select),
     'hashref'   => {},
-    'extra_sql' => "$search ORDER BY $orderby",
-    'addl_from' => 'LEFT JOIN cust_main USING ( custnum )',
+    'extra_sql' => "$search $group_by",
+    'order_by'  => "ORDER BY $orderby",
+    'addl_from' => $addl_from,
   };
 
 } else {
@@ -331,6 +530,7 @@ if ( $cgi->param('magic') ) {
   $count_query = "SELECT COUNT(*), SUM($amount_field) FROM $table".
                  "  WHERE payinfo = '$payinfo' AND payby = '$payby'".
                  "  AND ". $curuser->agentnums_sql;
+  @count_addl = ( '$%.2f total '.$opt{name_verb} );
 
   $sql_query = {
     'table'     => $table,
@@ -342,4 +542,7 @@ if ( $cgi->param('magic') ) {
 
 }
 
+# for consistency
+$title = join('',map {ucfirst} split(/\b/,$title));
+
 </%init>