httemplate/search/elements/search.html

   1 <%doc>
   2
   3 Example:
   4
   5   include( '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)
  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
  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
 110     #handling "disabled" fields in the records
 111     'disableable' => 1,  # set set to 1 (or column position for "disabled"
 112                          # status col) to enable if this table has a "disabled"
 113                          # field, to hide disabled records & have
 114                          # "show disabled/hide disabled" links
 115                          #(can't be used with a literal query)
 116     'disabled_statuspos' => 3, #optional position (starting from 0) to insert
 117                                #a Status column when showing disabled records
 118                                #(query needs to be a qsearch hashref and
 119                                # header & fields need to be defined)
 120
 121     #handling agent virtualization
 122     'agent_virt'            => 1, # set true if this search should be
 123                                   # agent-virtualized
 124     'agent_null'            => 1, # set true to view global records always
 125     'agent_null_right'      => 'Access Right', # optional right to view global
 126                                                # records
 127     'agent_null_right_link' => 'Access Right'  # optional right to link to
 128                                                # global records; defaults to
 129                                                # same as agent_null_right
 130     'agent_pos'             => 3, # optional position (starting from 0) to
 131                                   # insert an Agent column (query needs to be a
 132                                   # qsearch hashref and header & fields need to
 133                                   # be defined)
 134
 135     # sort, link & display properties for fields
 136
 137     'sort_fields' => [], #optional list of field names or SQL expressions for
 138                          # sorts
 139
 140     #listref - each item is the empty string,
 141     #          or a listref of link and method name to append,
 142     #          or a listref of link and coderef to run and append
 143     #          or a coderef that returns such a listref
 144     'links'       => [],`
 145
 146     #listref - each item is the empty string,
 147     #          or a string onClick handler for the corresponding link
 148     #          or a coderef that returns string onClick handler
 149     'link_onclicks' => [],
 150
 151     #one letter for each column, left/right/center/none
 152     # or pass a listref with full values: [ 'left', 'right', 'center', '' ]
 153     'align'       => 'lrc.',
 154
 155     #listrefs of ( scalars or coderefs )
 156     # currently only HTML, maybe eventually Excel too
 157     'color'       => [],
 158     'size'        => [],
 159     'style'       => [], #<B> or <I>, etc.
 160     'cell_style'  => [], #STYLE= attribute of TR, very HTML-specific...
 161
 162     # Excel-specific listref of ( hashrefs or coderefs )
 163     # each hashref: http://search.cpan.org/dist/Spreadsheet-WriteExcel/lib/Spreadsheet/WriteExcel.pm#Format_methods_and_Format_properties
 164     'xls_format' => => [],
 165
 166   )
 167
 168 </%doc>
 169 % if ( $type eq 'csv' ) {
 170 %
 171 <% include('search-csv.html',  header=>$header, rows=>$rows, opt=>\%opt ) %>
 172 %
 173 % #} elsif ( $type eq 'excel' ) {
 174 % } elsif ( $type =~ /\.xls$/ ) {
 175 %
 176 <% include('search-xls.html',  header=>$header, rows=>$rows, opt=>\%opt ) %>
 177 %
 178 % } elsif ( $type eq 'xml' ) {
 179 %
 180 <% include('search-xml.html',  rows=>$rows, opt=>\%opt ) %>
 181 %
 182 % } else { # regular HTML
 183 %
 184 <% include('search-html.html',
 185              type           => $type,
 186              header         => $header,
 187              rows           => $rows,
 188              link_agentnums => \@link_agentnums,
 189              null_link      => $null_link,
 190              confmax        => $confmax,
 191              maxrecords     => $maxrecords,
 192              offset         => $offset,
 193              opt            => \%opt
 194           )
 195 %>
 196 %
 197 % }
 198 <%init>
 199
 200 my(%opt) = @_;
 201 #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
 202
 203 my $curuser = $FS::CurrentUser::CurrentUser;
 204
 205 my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|xml|select|html(-print)?)$/
 206            ? $1 : 'html' ;
 207
 208 my %align = (
 209   'l' => 'left',
 210   'r' => 'right',
 211   'c' => 'center',
 212   ' ' => '',
 213   '.' => '',
 214 );
 215 $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
 216   unless !$opt{align} || ref($opt{align});
 217
 218 if($type =~ /csv|xls/) {
 219   my $h = $opt{'header'};
 220   my @del;
 221   my $i = 0;
 222   do {
 223     if( ref($h->[$i]) and exists($h->[$i]->{'nodownload'}) ) {
 224       splice(@{$opt{$_}}, $i, 1) foreach
 225         qw(header footer fields links link_onclicks
 226            align color size style cell_style xls_format);
 227     }
 228     else {
 229       $i++;
 230     }
 231   } while ( exists($h->[$i]) );
 232 }
 233
 234 # wtf?
 235 $opt{disable_download} = 0
 236   if $opt{disable_download} && $curuser->access_right('Configuration download');
 237
 238 $opt{disable_download} = 1
 239   if $opt{really_disable_download};
 240
 241 my @link_agentnums = ();
 242 my $null_link = '';
 243 if ( $opt{'agent_virt'} ) {
 244
 245   @link_agentnums = $curuser->agentnums;
 246   $null_link = $curuser->access_right(    $opt{'agent_null_right_link'}
 247                                        || $opt{'agent_null_right'}      );
 248
 249   my $agentnums_sql = $curuser->agentnums_sql(
 250                         'null'       => $opt{'agent_null'},
 251                         'null_right' => $opt{'agent_null_right'},
 252                         'table'      => $opt{'query'}{'table'},
 253                       );
 254
 255   $opt{'query'}{'extra_sql'} .=
 256     ( $opt{'query'}{'extra_sql'} =~ /WHERE/i || keys %{$opt{'query'}{'hashref'}}
 257       ? ' AND '
 258       : ' WHERE ' ). $agentnums_sql;
 259
 260   $opt{'count_query'} .=
 261     ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' WHERE ' ).  $agentnums_sql;
 262
 263   if ( $opt{'agent_pos'} || $opt{'agent_pos'} eq '0'
 264        and scalar($curuser->agentnums) > 1           ) {
 265     #false laziness w/statuspos above
 266     my $pos = $opt{'agent_pos'};
 267
 268     foreach my $att (qw( align color size style cell_style xls_format )) {
 269       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 270     }
 271
 272     splice @{ $opt{'header'} }, $pos, 0, 'Agent';
 273     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 274     splice @{ $opt{'style'}  }, $pos, 0, '';
 275     splice @{ $opt{'size'}   }, $pos, 0, '';
 276     splice @{ $opt{'fields'} }, $pos, 0,
 277       sub { $_[0]->agentnum ? $_[0]->agent->agent : '(global)'; };
 278     splice @{ $opt{'color'}  }, $pos, 0, '';
 279     splice @{ $opt{'links'}  }, $pos, 0, '' #[ 'agent link?', 'agentnum' ]
 280       if $opt{'links'};
 281     splice @{ $opt{'link_onclicks'}  }, $pos, 0, ''
 282       if $opt{'link_onclicks'};
 283
 284   }
 285
 286 }
 287
 288 if ( $opt{'disableable'} ) {
 289
 290   unless ( $cgi->param('showdisabled') ) { #modify searches
 291
 292     $opt{'query'}{'hashref'}{'disabled'} = '';
 293     $opt{'query'}{'extra_sql'} =~ s/^\s*WHERE/ AND/i;
 294
 295     $opt{'count_query'} .=
 296       ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' WHERE ' ).
 297       "( disabled = '' OR disabled IS NULL )";
 298
 299   } elsif (    $opt{'disabled_statuspos'}
 300             || $opt{'disabled_statuspos'} eq '0' ) { #add status column
 301
 302     my $pos = $opt{'disabled_statuspos'};
 303
 304     foreach my $att (qw( align style color size )) {
 305       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 306     }
 307
 308     splice @{ $opt{'header'} }, $pos, 0, 'Status';
 309     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 310     splice @{ $opt{'style'}  }, $pos, 0, 'b';
 311     splice @{ $opt{'size'}   }, $pos, 0, '';
 312     splice @{ $opt{'fields'} }, $pos, 0,
 313       sub { shift->disabled ? 'DISABLED' : 'Active'; };
 314     splice @{ $opt{'color'}  }, $pos, 0,
 315       sub { shift->disabled ? 'FF0000'   : '00CC00'; };
 316     splice @{ $opt{'links'}  }, $pos, 0, ''
 317       if $opt{'links'};
 318     splice @{ $opt{'link_onlicks'}  }, $pos, 0, ''
 319       if $opt{'link_onlicks'};
 320   }
 321
 322   #add show/hide disabled links
 323   my $items = $opt{'name'} || PL($opt{'name_singular'});
 324   if ( $cgi->param('showdisabled') ) {
 325     $cgi->param('showdisabled', 0);
 326     $opt{'html_posttotal'} .=
 327       '( <a href="'. $cgi->self_url. qq!">hide disabled $items</a> )!; #"
 328     $cgi->param('showdisabled', 1);
 329   } else {
 330     $cgi->param('showdisabled', 1);
 331     $opt{'html_posttotal'} .=
 332       '( <a href="'. $cgi->self_url. qq!">show disabled $items</a> )!; #"
 333     $cgi->param('showdisabled', 0);
 334   }
 335
 336 }
 337
 338 my $limit = '';
 339 my($confmax, $maxrecords, $offset );
 340
 341 unless ( $type =~ /^(csv|\w*.xls)$/) {
 342 # html mode
 343   unless (exists($opt{count_query}) && length($opt{count_query})) {
 344     ( $opt{count_query} = $opt{query} ) =~
 345       s/^\s*SELECT\s*(.*?)\s+FROM\s/SELECT COUNT(*) FROM /i; #silly vim:/
 346   }
 347
 348   if ( $opt{disableable} && ! $cgi->param('showdisabled') ) {
 349     $opt{count_query} .=
 350       ( ( $opt{count_query} =~ /WHERE/i ) ? ' AND ' : ' WHERE ' ).
 351       "( disabled = '' OR disabled IS NULL )";
 352   }
 353
 354   unless ( $type eq 'html-print' ) {
 355
 356     #setup some pagination things if we're in html mode
 357
 358     my $conf = new FS::Conf;
 359     $confmax = $conf->config('maxsearchrecordsperpage');
 360     if ( $cgi->param('maxrecords') =~ /^(\d+)$/ ) {
 361       $maxrecords = $1;
 362     } else {
 363       $maxrecords ||= $confmax;
 364     }
 365
 366     $limit = $maxrecords ? "LIMIT $maxrecords" : '';
 367
 368     $offset = $cgi->param('offset') =~ /^(\d+)$/ ? $1 : 0;
 369     $limit .= " OFFSET $offset" if $offset;
 370
 371   }
 372
 373 }
 374
 375 #order by override
 376 my $order_by = '';
 377 #if ( $cgi->param('order_by') =~ /^([\w\, ]+)$/ ) {
 378 #  $order_by = $1;
 379 #}
 380 $order_by = $cgi->param('order_by') if $cgi->param('order_by');
 381
 382 # run the query
 383
 384 my $header = [ map { ref($_) ? $_->{'label'} : $_ } @{$opt{header}} ];
 385 my $rows;
 386 if ( ref($opt{query}) ) {
 387
 388   my @query;
 389   if (ref($opt{query}) eq 'HASH') {
 390     @query = ( $opt{query} );
 391
 392     if ( $order_by ) {
 393       if ( $opt{query}->{'order_by'} ) {
 394         if ( $opt{query}->{'order_by'} =~ /^(\s*ORDER\s+BY\s+)?(\S.*)$/is ) {
 395           $opt{query}->{'order_by'} = "ORDER BY $order_by, $2";
 396         } else {
 397           warn "unparsable query order_by: ". $opt{query}->{'order_by'};
 398           die "unparsable query order_by: ". $opt{query}->{'order_by'};
 399         }
 400       } else {
 401         $opt{query}->{'order_by'} = "ORDER BY $order_by";
 402       }
 403     }
 404
 405   } elsif (ref($opt{query}) eq 'ARRAY') {
 406     @query = @{ $opt{query} };
 407   } else {
 408     die "invalid query reference";
 409   }
 410
 411   if ( $opt{disableable} && ! $cgi->param('showdisabled') ) {
 412     #%search = ( 'disabled' => '' );
 413     $opt{'query'}->{'hashref'}->{'disabled'} = '';
 414     $opt{'query'}->{'extra_sql'} =~ s/^\s*WHERE/ AND/i;
 415   }
 416
 417   #eval "use FS::$opt{'query'};";
 418   my @param = qw( select table addl_from hashref extra_sql order_by );
 419   $rows = [ qsearch( [ map { my $query = $_;
 420                              ({ map { $_ => $query->{$_} } @param });
 421                            }
 422                        @query
 423                      ],
 424                      'order_by' => $opt{order_by}. " ". $limit,
 425                    )
 426           ];
 427 } else {
 428   my $sth = dbh->prepare("$opt{'query'} $limit")
 429     or die "Error preparing $opt{'query'}: ". dbh->errstr;
 430   $sth->execute
 431     or die "Error executing $opt{'query'}: ". $sth->errstr;
 432
 433   #can get # of rows without fetching them all?
 434   $rows = $sth->fetchall_arrayref;
 435
 436   $header ||= $sth->{NAME};
 437 }
 438
 439 </%init>