httemplate/search/elements/search.html

   1 <%doc>
   2
   3 Example:
   4
   5   <& elements/search.html,
   6
   7     ###
   8     # required
   9     ###
  10
  11     'title'         => 'Page title',
  12
  13     'name_singular' => 'item',  #singular name for the records returned
  14        #OR#                     # (preferred, will be pluralized automatically)
  15     'name'          => 'items', #plural name for the records returned
  16                                 # (deprecated, will be singularlized
  17                                 #  simplisticly)
  18
  19     #literal SQL query string (deprecated?) or qsearch hashref or arrayref
  20     #of qsearch hashrefs for a union of qsearches
  21     'query'       => {
  22                        'table'     => 'tablename',
  23                        #everything else is optional...
  24                        'hashref'   => { 'field' => 'value',
  25                                         'field' => { 'op'    => '<',
  26                                                      'value' => '54',
  27                                                    },
  28                                       },
  29                        'select'    => '*',
  30                        'addl_from' => '', #'LEFT JOIN othertable USING ( key )',
  31                        'extra_sql' => '', #'AND otherstuff', #'WHERE onlystuff',
  32                        'order_by'  => 'ORDER BY something',
  33
  34                      },
  35                      # "select * from tablename";
  36
  37     #required unless 'query' is an SQL query string (shouldn't be...)
  38     'count_query' => 'SELECT COUNT(*) FROM tablename',
  39
  40     ###
  41     # recommended / common
  42     ###
  43
  44     #listref of column labels, <TH>
  45     #recommended unless 'query' is an SQL query string
  46     # (if not specified the database column names will be used) (XXX this is not currently working either)
  47     'header'      => [ '#',
  48                        'Item',
  49                        { 'label' => 'Another Item',
  50
  51                        },
  52                      ],
  53
  54     #listref - each item is a literal column name (or method) or coderef
  55     #if not specified all columns will be shown (XXX this is not currently working?)
  56     'fields'      => [
  57                        'column',
  58                        sub { my $row = shift; $row->column; },
  59                      ],
  60
  61     #redirect if there's only one item...
  62     # listref of URL base and column name (or method)
  63     # or a coderef that returns the same
  64     'redirect' => sub { my( $record, $cgi ) = @_;
  65                         [ popurl(2).'view/item.html', 'primary_key' ];
  66                       },
  67
  68     #redirect if there's no items
  69     # scalar URL or a coderef that returns a URL
  70     'redirect_empty' => sub { my( $cgi ) = @_;
  71                               popurl(2).'view/item.html';
  72                             },
  73
  74     ###
  75     # optional
  76     ###
  77
  78     # some HTML callbacks...
  79     'menubar'          => '', #menubar arrayref
  80     'html_init'        => '', #after the header/menubar and before the pager
  81     'html_form'        => '', #after the pager, right before the results
  82                               # (only shown if there are results)
  83                               # (use this for any form-opening tag rather than
  84                               #  html_init, to avoid a nested form)
  85     'html_foot'        => '', #at the bottom
  86     'html_posttotal'   => '', #at the bottom
  87                               # (these three can be strings or coderefs)
  88
  89     'count_addl' => [], #additional count fields listref of sprintf strings or coderefs
  90                         # [ $money_char.'%.2f total paid', ],
  91
  92     #second (smaller) header line, currently only for HTML
  93     'header2      => [ '#',
  94                        'Item',
  95                        { 'label' => 'Another Item',
  96
  97                        },
  98                      ],
  99
 100     #listref of column footers
 101     'footer'      => [],
 102
 103     #disabling things
 104     'disable_download'  => '', # set true to hide the CSV/Excel download links
 105     'disable_total'     => '', # set true to hide the total"
 106     'disable_maxselect' => '', # set true to disable record/page selection
 107     'disable_nonefound' => '', # set true to disable the "No matching Xs found"
 108                                # message
 109     'nohtmlheader'      => '', # set true to remove the header and menu bar
 110
 111     #handling "disabled" fields in the records
 112     'disableable' => 1,  # set set to 1 (or column position for "disabled"
 113                          # status col) to enable if this table has a "disabled"
 114                          # field, to hide disabled records & have
 115                          # "show disabled/hide disabled" links
 116                          #(can't be used with a literal query)
 117     'disabled_statuspos' => 3, #optional position (starting from 0) to insert
 118                                #a Status column when showing disabled records
 119                                #(query needs to be a qsearch hashref and
 120                                # header & fields need to be defined)
 121
 122     #handling agent virtualization
 123     'agent_virt'            => 1, # set true if this search should be
 124                                   # agent-virtualized
 125     'agent_null'            => 1, # set true to view global records always
 126     'agent_null_right'      => 'Access Right', # optional right to view global
 127                                                # records
 128     'agent_null_right_link' => 'Access Right'  # optional right to link to
 129                                                # global records; defaults to
 130                                                # same as agent_null_right
 131     'agent_pos'             => 3, # optional position (starting from 0) to
 132                                   # insert an Agent column (query needs to be a
 133                                   # qsearch hashref and header & fields need to
 134                                   # be defined)cust_pkg_susp.html
 135
 136     # sort, link & display properties for fields
 137
 138     'sort_fields' => [], #optional list of field names or SQL expressions for sorts
 139
 140     'order_by_sql' => {              #to keep complex SQL expressions out of cgi order_by value,
 141       'fieldname' => 'sql snippet',  #  maps fields/sort_fields values to sql snippets
 142     }
 143
 144     #listref - each item is the empty string,
 145     #          or a listref of link and method name to append,
 146     #          or a listref of link and coderef to run and append
 147     #          or a coderef that returns such a listref
 148     'links'       => [],
 149
 150     #listref - each item is the empty string,
 151     #          or a string onClick handler for the corresponding link
 152     #          or a coderef that returns string onClick handler
 153     'link_onclicks' => [],
 154
 155     #one letter for each column, left/right/center/none
 156     # or pass a listref with full values: [ 'left', 'right', 'center', '' ]
 157     'align'       => 'lrc.',
 158
 159     #listrefs of ( scalars or coderefs )
 160     # currently only HTML, maybe eventually Excel too
 161     'color'       => [],
 162     'size'        => [],
 163     'style'       => [], #<B> or <I>, etc.
 164     'cell_style'  => [], #STYLE= attribute of TR, very HTML-specific...
 165
 166     # Excel-specific listref of ( hashrefs or coderefs )
 167     # each hashref: http://search.cpan.org/dist/Spreadsheet-WriteExcel/lib/Spreadsheet/WriteExcel.pm#Format_methods_and_Format_properties
 168     'xls_format' => => [],
 169
 170
 171     # miscellany
 172    'download_label' => 'Download this report',
 173                         # defaults to 'Download full results'
 174    'link_field'     => 'pkgpart'
 175                         # will create internal links for each row,
 176                         # with the value of this field as the NAME attribute
 177                         # If this is a coderef, will evaluate it, passing the
 178                         # row as an argument, and use the result as the NAME.
 179   &>
 180
 181 </%doc>
 182 % if ( $type eq 'csv' ) {
 183 %
 184 <% include('search-csv.html',  header=>$header, rows=>$rows, opt=>\%opt ) %>
 185 %
 186 % } elsif ( $type =~ /\.xls$/ ) {
 187 %
 188 <& 'search-xls.html',  header=>$header, rows=>$rows, opt=>\%opt &>\
 189 % # prevent the caller from polluting our output stream
 190 % $m->abort;
 191 %
 192 % } elsif ( $type eq 'xml' ) {
 193 %
 194 <% include('search-xml.html',  rows=>$rows, opt=>\%opt ) %>
 195 %
 196 % } else {
 197 %
 198 <% include('search-html.html',
 199              type           => $type,
 200              header         => $header,
 201              rows           => $rows,
 202              link_agentnums => \@link_agentnums,
 203              null_link      => $null_link,
 204              confmax        => $confmax,
 205              maxrecords     => $maxrecords,
 206              offset         => $offset,
 207              totals         => $totals,
 208              opt            => \%opt
 209           )
 210 %>
 211 %
 212 % }
 213 <%init>
 214
 215 my(%opt) = @_;
 216 #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
 217
 218 my $curuser = $FS::CurrentUser::CurrentUser;
 219
 220 my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|xml|select|html(-print)?)$/
 221            ? $1 : 'html' ;
 222
 223 if ( !$curuser->access_right('Download report data') ) {
 224   $opt{'disable_download'} = 1;
 225   $type = 'html';
 226 }
 227
 228 # split/map aligns here before doing anything else
 229 my %align = (
 230   'l' => 'left',
 231   'r' => 'right',
 232   'c' => 'center',
 233   ' ' => '',
 234   '.' => '',
 235 );
 236
 237 $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
 238   unless !$opt{align} || ref($opt{align});
 239
 240 if($type =~ /csv|xls/) {
 241   my $h = $opt{'header'};
 242   my @del;
 243   my $i = 0;
 244   do {
 245     if( ref($h->[$i]) and exists($h->[$i]->{'nodownload'}) ) {
 246       splice(@{$opt{$_}}, $i, 1) foreach
 247         qw(header footer fields links link_onclicks
 248            align color size style cell_style xls_format);
 249     }
 250     else {
 251       $i++;
 252     }
 253   } while ( exists($h->[$i]) );
 254 }
 255
 256 # wtf?
 257 $opt{disable_download} = 0
 258   if $opt{disable_download} && $curuser->access_right('Configuration download');
 259
 260 $opt{disable_download} = 1
 261   if $opt{really_disable_download};
 262
 263 # get our queries ready
 264 my $query = $opt{query} or die "query required";
 265 my $count_query = $opt{count_query} or die "count_query required";
 266 # there was a default count_query but it hasn't worked in about ten years
 267
 268 # set up agent restriction
 269 my @link_agentnums = ();
 270 my $null_link = '';
 271 if ( $opt{'agent_virt'} ) {
 272
 273   @link_agentnums = $curuser->agentnums;
 274   $null_link = $curuser->access_right(    $opt{'agent_null_right_link'}
 275                                        || $opt{'agent_null_right'}      );
 276
 277   my $agentnums_sql = $curuser->agentnums_sql(
 278                         'null'       => $opt{'agent_null'},
 279                         'null_right' => $opt{'agent_null_right'},
 280                         'table'      => $query->{'table'},
 281                       );
 282
 283   # this is ridiculous, but we do have searches where $query has constraints
 284   # and $count_query doesn't, or vice versa.
 285   if ( $query->{'extra_sql'} =~ /\bWHERE\b/i or keys %{$query->{hashref}} ) {
 286     $query->{'extra_sql'} .= " AND $agentnums_sql";
 287   } else {
 288     $query->{'extra_sql'} .= " WHERE $agentnums_sql";
 289   }
 290
 291   if ( $count_query =~ /\bWHERE\b/i ) {
 292     $count_query .= " AND $agentnums_sql";
 293   } else {
 294     $count_query .= " WHERE $agentnums_sql";
 295   }
 296
 297   if ( $opt{'agent_pos'} || $opt{'agent_pos'} eq '0'
 298        and scalar($curuser->agentnums) > 1           ) {
 299     #false laziness w/statuspos above
 300     my $pos = $opt{'agent_pos'};
 301
 302     foreach my $att (qw( align color size style cell_style xls_format )) {
 303       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 304     }
 305
 306     splice @{ $opt{'header'} }, $pos, 0, 'Agent';
 307     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 308     splice @{ $opt{'style'}  }, $pos, 0, '';
 309     splice @{ $opt{'size'}   }, $pos, 0, '';
 310     splice @{ $opt{'fields'} }, $pos, 0,
 311       sub { $_[0]->agentnum ? $_[0]->agent->agent : '(global)'; };
 312     splice @{ $opt{'color'}  }, $pos, 0, '';
 313     splice @{ $opt{'links'}  }, $pos, 0, '' #[ 'agent link?', 'agentnum' ]
 314       if $opt{'links'};
 315     splice @{ $opt{'link_onclicks'}  }, $pos, 0, ''
 316       if $opt{'link_onclicks'};
 317
 318   }
 319
 320 }
 321
 322 if ( $opt{'disableable'} ) {
 323
 324   unless ( $cgi->param('showdisabled') ) { #modify searches
 325
 326     $query->{'hashref'}{'disabled'} = '';
 327     $query->{'extra_sql'} =~ s/^\s*\bWHERE\b/ AND/i;
 328
 329     my $table = $query->{'table'};
 330
 331     $count_query .=
 332       ( $count_query =~ /\bWHERE\b/i ? ' AND ' : ' WHERE ' ).
 333       "( $table.disabled = '' OR $table.disabled IS NULL )";
 334
 335   } elsif (    $opt{'disabled_statuspos'}
 336             || $opt{'disabled_statuspos'} eq '0' ) { #add status column
 337
 338     my $pos = $opt{'disabled_statuspos'};
 339
 340     foreach my $att (qw( align style color size )) {
 341       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 342     }
 343
 344     splice @{ $opt{'header'} }, $pos, 0, 'Status';
 345     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 346     splice @{ $opt{'style'}  }, $pos, 0, 'b';
 347     splice @{ $opt{'size'}   }, $pos, 0, '';
 348     splice @{ $opt{'fields'} }, $pos, 0,
 349       sub { shift->disabled ? 'DISABLED' : 'Active'; };
 350     splice @{ $opt{'color'}  }, $pos, 0,
 351       sub { shift->disabled ? 'FF0000'   : '00CC00'; };
 352     splice @{ $opt{'links'}  }, $pos, 0, ''
 353       if $opt{'links'};
 354     splice @{ $opt{'link_onclicks'}  }, $pos, 0, ''
 355       if $opt{'link_onclicks'};
 356   }
 357
 358   #add show/hide disabled links
 359   my $items = $opt{'name'} || PL($opt{'name_singular'});
 360   if ( $cgi->param('showdisabled') ) {
 361     $cgi->param('showdisabled', 0);
 362     $opt{'html_posttotal'} .=
 363       '( <a href="'. $cgi->self_url. qq!">hide disabled $items</a> )!; #"
 364     $cgi->param('showdisabled', 1);
 365   } else {
 366     $cgi->param('showdisabled', 1);
 367     $opt{'html_posttotal'} .=
 368       '( <a href="'. $cgi->self_url. qq!">show disabled $items</a> )!; #"
 369     $cgi->param('showdisabled', 0);
 370   }
 371
 372 }
 373
 374 my $limit = '';
 375 my($confmax, $maxrecords, $offset );
 376
 377 unless ( $type =~ /^(csv|xml|\w*.xls)$/) {
 378 # html mode
 379
 380   unless ( $type eq 'html-print' ) {
 381
 382     #setup some pagination things if we're in html mode
 383
 384     my $conf = new FS::Conf;
 385     $confmax = $conf->config('maxsearchrecordsperpage');
 386     if ( $cgi->param('maxrecords') =~ /^(\d+)$/ ) {
 387       $maxrecords = $1;
 388     } else {
 389       $maxrecords ||= $confmax;
 390     }
 391
 392     $opt{'disable_maxselect'} ||= $conf->exists('disable_maxselect');
 393
 394     $limit = $maxrecords ? "LIMIT $maxrecords" : '';
 395
 396     $offset = $cgi->param('offset') =~ /^(\d+)$/ ? $1 : 0;
 397     $limit .= " OFFSET $offset" if $offset;
 398
 399   }
 400
 401 }
 402
 403 #order by override
 404 my $order_by = $opt{order_by} || '';
 405 $order_by = $cgi->param('order_by') if $cgi->param('order_by');
 406
 407 # run the query
 408
 409 my $header = [ map { ref($_) ? $_->{'label'} : $_ } @{$opt{header}} ];
 410 my $rows;
 411
 412 my ($order_by_key,$order_by_desc) = ($order_by =~ /^\s*(.*?)(\s+DESC)?\s*$/i);
 413 $opt{'order_by_sql'} ||= {};
 414 $order_by_desc ||= '';
 415 $order_by = $opt{'order_by_sql'}{$order_by_key} . $order_by_desc
 416   if $opt{'order_by_sql'}{$order_by_key};
 417
 418 if ( ref $query ) {
 419   my @query;
 420   if (ref($query) eq 'HASH') {
 421     @query = $query;
 422
 423     if ( $order_by ) {
 424       if ( $query->{'order_by'} ) {
 425         if ( $query->{'order_by'} =~ /^(\s*ORDER\s+BY\s+)?(\S.*)$/is ) {
 426           $query->{'order_by'} = "ORDER BY $order_by, $2";
 427         } else {
 428           warn "unparsable query order_by: ". $query->{'order_by'};
 429           die "unparsable query order_by: ". $query->{'order_by'};
 430         }
 431       } else {
 432         $query->{'order_by'} = "ORDER BY $order_by";
 433       }
 434     }
 435
 436     $query->{'order_by'} .= " $limit";
 437
 438   } elsif (ref($query) eq 'ARRAY') {
 439     # do we still use this? it was for the old 477 report.
 440     @query = @{ $query };
 441   } else {
 442     die "invalid query reference";
 443   }
 444
 445   #eval "use FS::$opt{'query'};";
 446   my @param = qw( select table addl_from hashref extra_sql order_by debug );
 447   $rows = [ qsearch( [ map { my $query = $_;
 448                              ({ map { $_ => $query->{$_} } @param });
 449                            }
 450                        @query
 451                      ],
 452                      #'order_by' => $opt{order_by}. " ". $limit,
 453                    )
 454           ];
 455
 456 } else { # not ref $query; plain SQL (still used as of 07/2015)
 457
 458   $query .= " $limit";
 459   my $sth = dbh->prepare($query)
 460     or die "Error preparing $query: ". dbh->errstr;
 461   $sth->execute
 462     or die "Error executing $query: ". $sth->errstr;
 463
 464   $rows = $sth->fetchall_arrayref;
 465   $header ||= $sth->{NAME};
 466 }
 467
 468 # run the count query to get number of rows and other totals
 469 my $count_sth = dbh->prepare($count_query);
 470 $count_sth->execute
 471   or die "Error executing '$count_query': ".$count_sth->errstr;
 472 my $totals = $count_sth->fetchrow_arrayref;
 473
 474 push @$rows, $opt{'footer_data'} if $opt{'footer_data'};
 475
 476 </%init>