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 (corner cases only) 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 (now even if 'query' is an SQL query string)
  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     # Agent Virtualization parameters:
 123     #   In this context, only available if your selected table has agentnum.
 124     #   You must also include agentnum as a SELECT column in your SQL query,
 125     #     or experience non-obvious problems
 126     #
 127     'agent_virt'            => 1, # set true if this search should be
 128                                   # agent-virtualized
 129     'agent_null'            => 1, # set true to view global records always
 130     'agent_null_right'      => 'Access Right', # optional right to view global
 131                                                # records
 132     'agent_null_right_link' => 'Access Right'  # optional right to link to
 133                                                # global records; defaults to
 134                                                # same as agent_null_right
 135     'agent_pos'             => 3, # optional position (starting from 0) to
 136                                   # insert an Agent column (query needs to be a
 137                                   # qsearch hashref and header & fields need to
 138                                   # be defined)
 139
 140     # sort, link & display properties for fields
 141
 142     'sort_fields' => [], #optional list of field names or SQL expressions for sorts
 143
 144     'order_by_sql' => {              #to keep complex SQL expressions out of cgi order_by value,
 145       'fieldname' => 'sql snippet',  #  maps fields/sort_fields values to sql snippets
 146     }
 147
 148     #listref - each item is the empty string,
 149     #          or a listref of link and method name to append,
 150     #          or a listref of link and coderef to run and append
 151     #          or a coderef that returns such a listref
 152     'links'       => [],
 153
 154     #listref - each item is the empty string,
 155     #          or a string onClick handler for the corresponding link
 156     #          or a coderef that returns string onClick handler
 157     'link_onclicks' => [],
 158
 159     #one letter for each column, left/right/center/none
 160     # or pass a listref with full values: [ 'left', 'right', 'center', '' ]
 161     'align'       => 'lrc.',
 162
 163     #listrefs of ( scalars or coderefs )
 164     # currently only HTML, maybe eventually Excel too
 165     'color'       => [],
 166     'size'        => [],
 167     'style'       => [], #<B> or <I>, etc.
 168     'cell_style'  => [], #STYLE= attribute of TR, very HTML-specific...
 169
 170     # Excel-specific listref of ( hashrefs or coderefs )
 171     # each hashref: http://search.cpan.org/dist/Spreadsheet-WriteExcel/lib/Spreadsheet/WriteExcel.pm#Format_methods_and_Format_properties
 172     'xls_format' => => [],
 173
 174
 175     # miscellany
 176    'download_label' => 'Download this report',
 177                         # defaults to 'Download full results'
 178    'link_field'     => 'pkgpart'
 179                         # will create internal links for each row,
 180                         # with the value of this field as the NAME attribute
 181                         # If this is a coderef, will evaluate it, passing the
 182                         # row as an argument, and use the result as the NAME.
 183   &>
 184
 185 </%doc>
 186 % # if changing this, also update saved search behavior to match!
 187 % if ( $type eq 'csv' ) {
 188 %
 189 <% include('search-csv.html',  header=>$header, rows=>$rows, opt=>\%opt ) %>
 190 %
 191 % } elsif ( $type =~ /\.xls$/ ) {
 192 %
 193 <& 'search-xls.html',  header=>$header, rows=>$rows, opt=>\%opt &>\
 194 % # prevent the caller from polluting our output stream
 195 % $m->abort;
 196 %
 197 % } elsif ( $type eq 'xml' ) {
 198 %
 199 <% include('search-xml.html',  rows=>$rows, opt=>\%opt ) %>
 200 %
 201 % } else {
 202 %
 203 <% include('search-html.html',
 204              type           => $type,
 205              header         => $header,
 206              rows           => $rows,
 207              link_agentnums => \@link_agentnums,
 208              null_link      => $null_link,
 209              confmax        => $confmax,
 210              maxrecords     => $maxrecords,
 211              offset         => $offset,
 212              totals         => $totals,
 213              opt            => \%opt
 214           )
 215 %>
 216 %
 217 % }
 218 <%init>
 219
 220 my(%opt) = @_;
 221 #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
 222
 223 my $curuser = $FS::CurrentUser::CurrentUser;
 224
 225 my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|xml|select|html(-print)?)$/
 226            ? $1 : 'html' ;
 227
 228 if ( !$curuser->access_right('Download report data') ) {
 229   $opt{'disable_download'} = 1;
 230   $type = 'html';
 231 }
 232
 233 # split/map aligns here before doing anything else
 234 my %align = (
 235   'l' => 'left',
 236   'r' => 'right',
 237   'c' => 'center',
 238   ' ' => '',
 239   '.' => '',
 240 );
 241
 242 $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
 243   unless !$opt{align} || ref($opt{align});
 244
 245 if($type =~ /csv|xls/) {
 246   my $h = $opt{'header'};
 247   my @del;
 248   my $i = 0;
 249   do {
 250     if( ref($h->[$i]) and exists($h->[$i]->{'nodownload'}) ) {
 251       splice(@{$opt{$_}}, $i, 1) foreach
 252         qw(header footer fields links link_onclicks
 253            align color size style cell_style xls_format);
 254     }
 255     else {
 256       $i++;
 257     }
 258   } while ( exists($h->[$i]) );
 259 }
 260
 261 # wtf?
 262 $opt{disable_download} = 0
 263   if $opt{disable_download} && $curuser->access_right('Configuration download');
 264
 265 $opt{disable_download} = 1
 266   if $opt{really_disable_download};
 267
 268 # get our queries ready
 269 my $query = $opt{query} or die "query required";
 270 my $count_query = $opt{count_query} or die "count_query required";
 271 # there was a default count_query but it hasn't worked in about ten years
 272
 273 # set up agent restriction
 274 my @link_agentnums = ();
 275 my $null_link = '';
 276 if ( $opt{'agent_virt'} ) {
 277
 278   @link_agentnums = $curuser->agentnums;
 279   $null_link = $curuser->access_right(    $opt{'agent_null_right_link'}
 280                                        || $opt{'agent_null_right'}      );
 281
 282   my $agentnums_sql = $curuser->agentnums_sql(
 283                         'null'       => $opt{'agent_null'},
 284                         'null_right' => $opt{'agent_null_right'},
 285                         'table'      => $query->{'table'},
 286                       );
 287
 288   # this is ridiculous, but we do have searches where $query has constraints
 289   # and $count_query doesn't, or vice versa.
 290   if ( $query->{'extra_sql'} =~ /\bWHERE\b/i or keys %{$query->{hashref}} ) {
 291     $query->{'extra_sql'} .= " AND $agentnums_sql";
 292   } else {
 293     $query->{'extra_sql'} .= " WHERE $agentnums_sql";
 294   }
 295
 296   if ( $count_query =~ /\bWHERE\b/i ) {
 297     $count_query .= " AND $agentnums_sql";
 298   } else {
 299     $count_query .= " WHERE $agentnums_sql";
 300   }
 301
 302   if ( $opt{'agent_pos'} || $opt{'agent_pos'} eq '0'
 303        and scalar($curuser->agentnums) > 1           ) {
 304     #false laziness w/statuspos above
 305     my $pos = $opt{'agent_pos'};
 306
 307     foreach my $att (qw( align color size style cell_style xls_format )) {
 308       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 309     }
 310
 311     splice @{ $opt{'header'} }, $pos, 0, 'Agent';
 312     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 313     splice @{ $opt{'style'}  }, $pos, 0, '';
 314     splice @{ $opt{'size'}   }, $pos, 0, '';
 315     splice @{ $opt{'fields'} }, $pos, 0,
 316       sub { $_[0]->agentnum ? $_[0]->agent->agent : '(global)'; };
 317     splice @{ $opt{'color'}  }, $pos, 0, '';
 318     splice @{ $opt{'links'}  }, $pos, 0, '' #[ 'agent link?', 'agentnum' ]
 319       if $opt{'links'};
 320     splice @{ $opt{'link_onclicks'}  }, $pos, 0, ''
 321       if $opt{'link_onclicks'};
 322
 323   }
 324
 325 }
 326
 327 if ( $opt{'disableable'} ) {
 328
 329   unless ( $cgi->param('showdisabled') ) { #modify searches
 330
 331     $query->{'hashref'}{'disabled'} = '';
 332     $query->{'extra_sql'} =~ s/^\s*\bWHERE\b/ AND/i;
 333
 334     my $table = $query->{'table'};
 335
 336     $count_query .=
 337       ( $count_query =~ /\bWHERE\b/i ? ' AND ' : ' WHERE ' ).
 338       "( $table.disabled = '' OR $table.disabled IS NULL )";
 339
 340   } elsif (    $opt{'disabled_statuspos'}
 341             || $opt{'disabled_statuspos'} eq '0' ) { #add status column
 342
 343     my $pos = $opt{'disabled_statuspos'};
 344
 345     foreach my $att (qw( align style color size )) {
 346       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 347     }
 348
 349     splice @{ $opt{'header'} }, $pos, 0, 'Status';
 350     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 351     splice @{ $opt{'style'}  }, $pos, 0, 'b';
 352     splice @{ $opt{'size'}   }, $pos, 0, '';
 353     splice @{ $opt{'fields'} }, $pos, 0,
 354       sub { shift->disabled ? 'DISABLED' : 'Active'; };
 355     splice @{ $opt{'color'}  }, $pos, 0,
 356       sub { shift->disabled ? 'FF0000'   : '00CC00'; };
 357     splice @{ $opt{'links'}  }, $pos, 0, ''
 358       if $opt{'links'};
 359     splice @{ $opt{'link_onclicks'}  }, $pos, 0, ''
 360       if $opt{'link_onclicks'};
 361   }
 362
 363   #add show/hide disabled links
 364   my $items = $opt{'name'} || PL($opt{'name_singular'});
 365   if ( $cgi->param('showdisabled') ) {
 366     $cgi->param('showdisabled', 0);
 367     $opt{'html_posttotal'} .=
 368       '( <a href="'. $cgi->self_url. qq!">hide disabled $items</a> )!; #"
 369     $cgi->param('showdisabled', 1);
 370   } else {
 371     $cgi->param('showdisabled', 1);
 372     $opt{'html_posttotal'} .=
 373       '( <a href="'. $cgi->self_url. qq!">show disabled $items</a> )!; #"
 374     $cgi->param('showdisabled', 0);
 375   }
 376
 377 }
 378
 379 my $limit = '';
 380 my($confmax, $maxrecords, $offset );
 381
 382 unless ( $type =~ /^(csv|xml|\w*.xls)$/) {
 383 # html mode
 384
 385   unless ( $type eq 'html-print' ) {
 386
 387     #setup some pagination things if we're in html mode
 388
 389     my $conf = new FS::Conf;
 390     $confmax = $conf->config('maxsearchrecordsperpage') || 100;
 391     if ( $cgi->param('maxrecords') =~ /^(\d+)$/ ) {
 392       $maxrecords = $1;
 393     } else {
 394       $maxrecords ||= $confmax;
 395     }
 396
 397     $opt{'disable_maxselect'} ||= $conf->exists('disable_maxselect');
 398
 399     $limit = $maxrecords ? "LIMIT $maxrecords" : '';
 400
 401     $offset = $cgi->param('offset') =~ /^(\d+)$/ ? $1 : 0;
 402     $limit .= " OFFSET $offset" if $offset;
 403
 404   }
 405
 406 }
 407
 408 #order by override
 409 my $order_by = $opt{order_by} || '';
 410 $order_by = $cgi->param('order_by') if $cgi->param('order_by');
 411
 412 # run the query
 413
 414 my $header = [ map { ref($_) ? $_->{'label'} : $_ } @{$opt{header}} ];
 415 my $rows;
 416
 417 my ($order_by_key,$order_by_desc) = ($order_by =~ /^\s*(.*?)(\s+DESC)?\s*$/i);
 418 my $union_order_by;
 419 $opt{'order_by_sql'} ||= {};
 420 $order_by_desc ||= '';
 421 $order_by = $opt{'order_by_sql'}{$order_by_key} . $order_by_desc
 422   if $opt{'order_by_sql'}{$order_by_key};
 423
 424 if ( ref $query ) {
 425   my @query;
 426   if (ref($query) eq 'HASH') {
 427     @query = $query;
 428
 429     # Assemble peices of order_by information as SQL fragment,
 430     # store as query->{order_by}
 431     if ( $order_by ) {
 432       if ( $query->{'order_by'} ) {
 433         if ( $query->{'order_by'} =~ /^(\s*ORDER\s+BY\s+)?(\S.*)$/is ) {
 434           $query->{'order_by'} = "ORDER BY $order_by, $2";
 435         } else {
 436           warn "unparsable query order_by: ". $query->{'order_by'};
 437           die "unparsable query order_by: ". $query->{'order_by'};
 438         }
 439       } else {
 440         $query->{'order_by'} = "ORDER BY $order_by";
 441       }
 442     }
 443     $query->{'order_by'} .= " $limit";
 444
 445   } elsif (ref($query) eq 'ARRAY') {
 446     # Presented query is a UNION query, with multiple query references
 447     @query = @{ $query };
 448
 449     # Assemble peices of order_by information as SQL fragment,
 450     # store as $union_order_by.  Omit order_by/limit from individual
 451     # $query hashrefs, because this is a union query
 452     #
 453     # ! Currently, order_by data is only fetched from $cgi->param('order_by')
 454     # ! for union queries. If it eventually needs to be passed within query
 455     # ! hashrefs, or as mason template options, would need implemented
 456     $union_order_by = " ORDER BY $order_by " if $order_by;
 457     $union_order_by .= " $limit " if $limit;
 458
 459   } else {
 460     die "invalid query reference ($query)";
 461   }
 462
 463   #eval "use FS::$opt{'query'};";
 464   my @param = qw( select table addl_from hashref extra_sql order_by debug );
 465   if ($opt{classname_from_column}) {
 466     # Perform a union of multiple queries, while using the
 467     # classname_from_column qsearch union option
 468
 469     # Constrain hashkeys for each query from @param
 470     @query = map{
 471       my $query = $_;
 472       my $new_query = {};
 473       $new_query->{$_} = $query->{$_} for @param;
 474       $new_query;
 475     } @query;
 476
 477     $rows = [
 478       qsearch(
 479         \@query,
 480         order_by => $union_order_by,
 481         classname_from_column => 1,
 482       )
 483     ];
 484
 485   } else {
 486     # default perform a query with qsearch
 487     $rows = [ qsearch( [ map { my $query = $_;
 488                                ({ map { $_ => $query->{$_} } @param });
 489                              }
 490                          @query
 491                        ],
 492                        #'order_by' => $opt{order_by}. " ". $limit,
 493                      )
 494             ];
 495   }
 496 } else { # not ref $query; plain SQL (still used as of 07/2015)
 497
 498   $query .= " $limit";
 499   my $sth = dbh->prepare($query)
 500     or die "Error preparing $query: ". dbh->errstr;
 501   $sth->execute
 502     or die "Error executing $query: ". $sth->errstr;
 503
 504   $rows = $sth->fetchall_arrayref;
 505   $header ||= $sth->{NAME};
 506 }
 507
 508 # run the count query to get number of rows and other totals
 509 my $count_sth = dbh->prepare($count_query);
 510 $count_sth->execute
 511   or die "Error executing '$count_query': ".$count_sth->errstr;
 512 my $totals = $count_sth->fetchrow_arrayref;
 513
 514 push @$rows, $opt{'footer_data'} if $opt{'footer_data'};
 515
 516 </%init>