i18n, RT#12515
[freeside.git] / httemplate / search / elements / search.html
index 5913932..81ec4d0 100644 (file)
@@ -2,7 +2,7 @@
 
 Example:
 
-  include( 'elements/search.html',
+  <& elements/search.html,
 
     ###
     # required
@@ -16,7 +16,8 @@ Example:
                                 # (deprecated, will be singularlized
                                 #  simplisticly)
 
-    #literal SQL query string (deprecated?) or qsearch hashref
+    #literal SQL query string (deprecated?) or qsearch hashref or arrayref
+    #of qsearch hashrefs for a union of qsearches
     'query'       => {
                        'table'     => 'tablename',
                        #everything else is optional...
@@ -120,6 +121,7 @@ Example:
     #handling agent virtualization
     'agent_virt'            => 1, # set true if this search should be
                                   # agent-virtualized
+    'agent_null'            => 1, # set true to view global records always
     'agent_null_right'      => 'Access Right', # optional right to view global
                                                # records
     'agent_null_right_link' => 'Access Right'  # optional right to link to
@@ -130,7 +132,10 @@ Example:
                                   # qsearch hashref and header & fields need to
                                   # be defined)
 
-    # link & display properties for fields
+    # sort, link & display properties for fields
+
+    'sort_fields' => [], #optional list of field names or SQL expressions for
+                         # sorts
    
     #listref - each item is the empty string,
     #          or a listref of link and method name to append,
@@ -148,13 +153,17 @@ Example:
     'align'       => 'lrc.',
    
     #listrefs of ( scalars or coderefs )
-    #currently only HTML, maybe eventually Excel too
+    # currently only HTML, maybe eventually Excel too
     'color'       => [],
     'size'        => [],
     'style'       => [], #<B> or <I>, etc.
     'cell_style'  => [], #STYLE= attribute of TR, very HTML-specific...
+
+    # Excel-specific listref of ( hashrefs or coderefs )
+    # each hashref: http://search.cpan.org/dist/Spreadsheet-WriteExcel/lib/Spreadsheet/WriteExcel.pm#Format_methods_and_Format_properties
+    'xls_format' => => [],
     
-  );
+  &>
 
 </%doc>
 % if ( $type eq 'csv' ) {
@@ -166,6 +175,10 @@ Example:
 %
 <% include('search-xls.html',  header=>$header, rows=>$rows, opt=>\%opt ) %>
 %
+% } elsif ( $type eq 'xml' ) {
+%
+<% include('search-xml.html',  rows=>$rows, opt=>\%opt ) %>
+%
 % } else { # regular HTML
 %
 <% include('search-html.html',
@@ -189,6 +202,9 @@ my(%opt) = @_;
 
 my $curuser = $FS::CurrentUser::CurrentUser;
 
+my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|xml|select|html(-print)?)$/
+           ? $1 : 'html' ;
+
 my %align = (
   'l' => 'left',
   'r' => 'right',
@@ -199,9 +215,29 @@ my %align = (
 $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
   unless !$opt{align} || ref($opt{align});
 
+if($type =~ /csv|xls/) {
+  my $h = $opt{'header'};
+  my @del;
+  my $i = 0;
+  do {
+    if( ref($h->[$i]) and exists($h->[$i]->{'nodownload'}) ) {
+      splice(@{$opt{$_}}, $i, 1) foreach
+        qw(header footer fields links link_onclicks
+           align color size style cell_style xls_format);
+    }
+    else {
+      $i++;
+    }
+  } while ( exists($h->[$i]) );
+}
+
+# wtf?
 $opt{disable_download} = 0
   if $opt{disable_download} && $curuser->access_right('Configuration download');
 
+$opt{disable_download} = 1
+  if $opt{really_disable_download};
+
 my @link_agentnums = ();
 my $null_link = '';
 if ( $opt{'agent_virt'} ) {
@@ -211,7 +247,9 @@ if ( $opt{'agent_virt'} ) {
                                        || $opt{'agent_null_right'}      );
 
   my $agentnums_sql = $curuser->agentnums_sql(
-                        'null_right' => $opt{'agent_null_right'}
+                        'null'       => $opt{'agent_null'},
+                        'null_right' => $opt{'agent_null_right'},
+                        'table'      => $opt{'query'}{'table'},
                       );
 
   $opt{'query'}{'extra_sql'} .=
@@ -227,7 +265,7 @@ if ( $opt{'agent_virt'} ) {
     #false laziness w/statuspos above
     my $pos = $opt{'agent_pos'};
 
-    foreach my $att (qw( align style color size )) {
+    foreach my $att (qw( align color size style cell_style xls_format )) {
       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
     }
 
@@ -286,25 +324,22 @@ if ( $opt{'disableable'} ) {
   if ( $cgi->param('showdisabled') ) {
     $cgi->param('showdisabled', 0);
     $opt{'html_posttotal'} .=
-      '( <a href="'. $cgi->self_url. qq!">hide disabled $items</a> )!;
+      '( <a href="'. $cgi->self_url. qq!">hide disabled $items</a> )!; #"
     $cgi->param('showdisabled', 1);
   } else {
     $cgi->param('showdisabled', 1);
     $opt{'html_posttotal'} .=
-      '( <a href="'. $cgi->self_url. qq!">show disabled $items</a> )!;
+      '( <a href="'. $cgi->self_url. qq!">show disabled $items</a> )!; #"
     $cgi->param('showdisabled', 0);
   }
 
 }
 
-my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|select|html(-print)?)$/
-           ? $1 : 'html';
-
 my $limit = '';
 my($confmax, $maxrecords, $offset );
 
-unless ( $type =~ /^(csv|\w*\.xls)$/ ) {
-
+unless ( $type =~ /^(csv|\w*.xls)$/) {
+# html mode
   unless (exists($opt{count_query}) && length($opt{count_query})) {
     ( $opt{count_query} = $opt{query} ) =~
       s/^\s*SELECT\s*(.*?)\s+FROM\s/SELECT COUNT(*) FROM /i; #silly vim:/
@@ -337,12 +372,42 @@ unless ( $type =~ /^(csv|\w*\.xls)$/ ) {
 
 }
 
+#order by override
+my $order_by = '';
+#if ( $cgi->param('order_by') =~ /^([\w\, ]+)$/ ) {
+#  $order_by = $1;
+#}
+$order_by = $cgi->param('order_by') if $cgi->param('order_by');
+
 # run the query
 
 my $header = [ map { ref($_) ? $_->{'label'} : $_ } @{$opt{header}} ];
 my $rows;
 if ( ref($opt{query}) ) {
 
+  my @query;
+  if (ref($opt{query}) eq 'HASH') {
+    @query = ( $opt{query} );
+
+    if ( $order_by ) {
+      if ( $opt{query}->{'order_by'} ) {
+        if ( $opt{query}->{'order_by'} =~ /^(\s*ORDER\s+BY\s+)?(\S.*)$/is ) {
+          $opt{query}->{'order_by'} = "ORDER BY $order_by, $2";
+        } else {
+          warn "unparsable query order_by: ". $opt{query}->{'order_by'};
+          die "unparsable query order_by: ". $opt{query}->{'order_by'};
+        }
+      } else {
+        $opt{query}->{'order_by'} = "ORDER BY $order_by";
+      }
+    }
+
+  } elsif (ref($opt{query}) eq 'ARRAY') {
+    @query = @{ $opt{query} };
+  } else {
+    die "invalid query reference";
+  }
+
   if ( $opt{disableable} && ! $cgi->param('showdisabled') ) {
     #%search = ( 'disabled' => '' );
     $opt{'query'}->{'hashref'}->{'disabled'} = '';
@@ -350,14 +415,15 @@ if ( ref($opt{query}) ) {
   }
 
   #eval "use FS::$opt{'query'};";
-  $rows = [ qsearch({
-    'select'    => $opt{'query'}->{'select'},
-    'table'     => $opt{'query'}->{'table'}, 
-    'addl_from' => (exists($opt{'query'}->{'addl_from'}) ? $opt{'query'}->{'addl_from'} : ''),
-    'hashref'   => $opt{'query'}->{'hashref'} || {}, 
-    'extra_sql' => $opt{'query'}->{'extra_sql'},
-    'order_by'  => $opt{'query'}->{'order_by'}. " $limit",
-  }) ];
+  my @param = qw( select table addl_from hashref extra_sql order_by );
+  $rows = [ qsearch( [ map { my $query = $_;
+                             ({ map { $_ => $query->{$_} } @param });
+                           }
+                       @query
+                     ],
+                     'order_by' => $opt{order_by}. " ". $limit,
+                   )
+          ]; 
 } else {
   my $sth = dbh->prepare("$opt{'query'} $limit")
     or die "Error preparing $opt{'query'}: ". dbh->errstr;