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)
  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     # miscellany
 168    'download_label' => 'Download this report',
 169                         # defaults to 'Download full results'
 170   &>
 171
 172 </%doc>
 173 % if ( $type eq 'csv' ) {
 174 %
 175 <% include('search-csv.html',  header=>$header, rows=>$rows, opt=>\%opt ) %>
 176 %
 177 % } elsif ( $type =~ /\.xls$/ ) {
 178 %
 179 <% include('search-xls.html',  header=>$header, rows=>$rows, opt=>\%opt ) %>
 180 %
 181 % } elsif ( $type eq 'xml' ) {
 182 %
 183 <% include('search-xml.html',  rows=>$rows, opt=>\%opt ) %>
 184 %
 185 % } else {
 186 %
 187 <% include('search-html.html',
 188              type           => $type,
 189              header         => $header,
 190              rows           => $rows,
 191              link_agentnums => \@link_agentnums,
 192              null_link      => $null_link,
 193              confmax        => $confmax,
 194              maxrecords     => $maxrecords,
 195              offset         => $offset,
 196              opt            => \%opt
 197           )
 198 %>
 199 %
 200 % }
 201 <%init>
 202
 203 my(%opt) = @_;
 204 #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
 205
 206 my $curuser = $FS::CurrentUser::CurrentUser;
 207
 208 my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|xml|select|html(-print)?)$/
 209            ? $1 : 'html' ;
 210
 211 if ( !$curuser->access_right('Download report data') ) {
 212   $opt{'disable_download'} = 1;
 213   $type = 'html';
 214 }
 215
 216 my %align = (
 217   'l' => 'left',
 218   'r' => 'right',
 219   'c' => 'center',
 220   ' ' => '',
 221   '.' => '',
 222 );
 223 $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
 224   unless !$opt{align} || ref($opt{align});
 225
 226 if($type =~ /csv|xls/) {
 227   my $h = $opt{'header'};
 228   my @del;
 229   my $i = 0;
 230   do {
 231     if( ref($h->[$i]) and exists($h->[$i]->{'nodownload'}) ) {
 232       splice(@{$opt{$_}}, $i, 1) foreach
 233         qw(header footer fields links link_onclicks
 234            align color size style cell_style xls_format);
 235     }
 236     else {
 237       $i++;
 238     }
 239   } while ( exists($h->[$i]) );
 240 }
 241
 242 # wtf?
 243 $opt{disable_download} = 0
 244   if $opt{disable_download} && $curuser->access_right('Configuration download');
 245
 246 $opt{disable_download} = 1
 247   if $opt{really_disable_download};
 248
 249 my @link_agentnums = ();
 250 my $null_link = '';
 251 if ( $opt{'agent_virt'} ) {
 252
 253   @link_agentnums = $curuser->agentnums;
 254   $null_link = $curuser->access_right(    $opt{'agent_null_right_link'}
 255                                        || $opt{'agent_null_right'}      );
 256
 257   my $agentnums_sql = $curuser->agentnums_sql(
 258                         'null'       => $opt{'agent_null'},
 259                         'null_right' => $opt{'agent_null_right'},
 260                         'table'      => $opt{'query'}{'table'},
 261                       );
 262
 263   $opt{'query'}{'extra_sql'} .=
 264     ( $opt{'query'}{'extra_sql'} =~ /WHERE/i || keys %{$opt{'query'}{'hashref'}}
 265       ? ' AND '
 266       : ' WHERE ' ). $agentnums_sql;
 267
 268   $opt{'count_query'} .=
 269     ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' WHERE ' ).  $agentnums_sql;
 270
 271   if ( $opt{'agent_pos'} || $opt{'agent_pos'} eq '0'
 272        and scalar($curuser->agentnums) > 1           ) {
 273     #false laziness w/statuspos above
 274     my $pos = $opt{'agent_pos'};
 275
 276     foreach my $att (qw( align color size style cell_style xls_format )) {
 277       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 278     }
 279
 280     splice @{ $opt{'header'} }, $pos, 0, 'Agent';
 281     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 282     splice @{ $opt{'style'}  }, $pos, 0, '';
 283     splice @{ $opt{'size'}   }, $pos, 0, '';
 284     splice @{ $opt{'fields'} }, $pos, 0,
 285       sub { $_[0]->agentnum ? $_[0]->agent->agent : '(global)'; };
 286     splice @{ $opt{'color'}  }, $pos, 0, '';
 287     splice @{ $opt{'links'}  }, $pos, 0, '' #[ 'agent link?', 'agentnum' ]
 288       if $opt{'links'};
 289     splice @{ $opt{'link_onclicks'}  }, $pos, 0, ''
 290       if $opt{'link_onclicks'};
 291
 292   }
 293
 294 }
 295
 296 if ( $opt{'disableable'} ) {
 297
 298   unless ( $cgi->param('showdisabled') ) { #modify searches
 299
 300     $opt{'query'}{'hashref'}{'disabled'} = '';
 301     $opt{'query'}{'extra_sql'} =~ s/^\s*WHERE/ AND/i;
 302
 303     $opt{'count_query'} .=
 304       ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' WHERE ' ).
 305       "( disabled = '' OR disabled IS NULL )";
 306
 307   } elsif (    $opt{'disabled_statuspos'}
 308             || $opt{'disabled_statuspos'} eq '0' ) { #add status column
 309
 310     my $pos = $opt{'disabled_statuspos'};
 311
 312     foreach my $att (qw( align style color size )) {
 313       $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
 314     }
 315
 316     splice @{ $opt{'header'} }, $pos, 0, 'Status';
 317     splice @{ $opt{'align'}  }, $pos, 0, 'c';
 318     splice @{ $opt{'style'}  }, $pos, 0, 'b';
 319     splice @{ $opt{'size'}   }, $pos, 0, '';
 320     splice @{ $opt{'fields'} }, $pos, 0,
 321       sub { shift->disabled ? 'DISABLED' : 'Active'; };
 322     splice @{ $opt{'color'}  }, $pos, 0,
 323       sub { shift->disabled ? 'FF0000'   : '00CC00'; };
 324     splice @{ $opt{'links'}  }, $pos, 0, ''
 325       if $opt{'links'};
 326     splice @{ $opt{'link_onlicks'}  }, $pos, 0, ''
 327       if $opt{'link_onlicks'};
 328   }
 329
 330   #add show/hide disabled links
 331   my $items = $opt{'name'} || PL($opt{'name_singular'});
 332   if ( $cgi->param('showdisabled') ) {
 333     $cgi->param('showdisabled', 0);
 334     $opt{'html_posttotal'} .=
 335       '( <a href="'. $cgi->self_url. qq!">hide disabled $items</a> )!; #"
 336     $cgi->param('showdisabled', 1);
 337   } else {
 338     $cgi->param('showdisabled', 1);
 339     $opt{'html_posttotal'} .=
 340       '( <a href="'. $cgi->self_url. qq!">show disabled $items</a> )!; #"
 341     $cgi->param('showdisabled', 0);
 342   }
 343
 344 }
 345
 346 my $limit = '';
 347 my($confmax, $maxrecords, $offset );
 348
 349 unless ( $type =~ /^(csv|\w*.xls)$/) {
 350 # html mode
 351   unless (exists($opt{count_query}) && length($opt{count_query})) {
 352     ( $opt{count_query} = $opt{query} ) =~
 353       s/^\s*SELECT\s*(.*?)\s+FROM\s/SELECT COUNT(*) FROM /i; #silly vim:/
 354   }
 355
 356   if ( $opt{disableable} && ! $cgi->param('showdisabled') ) {
 357     $opt{count_query} .=
 358       ( ( $opt{count_query} =~ /WHERE/i ) ? ' AND ' : ' WHERE ' ).
 359       "( disabled = '' OR disabled IS NULL )";
 360   }
 361
 362   unless ( $type eq 'html-print' ) {
 363
 364     #setup some pagination things if we're in html mode
 365
 366     my $conf = new FS::Conf;
 367     $confmax = $conf->config('maxsearchrecordsperpage');
 368     if ( $cgi->param('maxrecords') =~ /^(\d+)$/ ) {
 369       $maxrecords = $1;
 370     } else {
 371       $maxrecords ||= $confmax;
 372     }
 373
 374     $opt{'disable_maxselect'} ||= $conf->exists('disable_maxselect');
 375
 376     $limit = $maxrecords ? "LIMIT $maxrecords" : '';
 377
 378     $offset = $cgi->param('offset') =~ /^(\d+)$/ ? $1 : 0;
 379     $limit .= " OFFSET $offset" if $offset;
 380
 381   }
 382
 383 }
 384
 385 #order by override
 386 my $order_by = '';
 387 #if ( $cgi->param('order_by') =~ /^([\w\, ]+)$/ ) {
 388 #  $order_by = $1;
 389 #}
 390 $order_by = $cgi->param('order_by') if $cgi->param('order_by');
 391
 392 # run the query
 393
 394 my $header = [ map { ref($_) ? $_->{'label'} : $_ } @{$opt{header}} ];
 395 my $rows;
 396 if ( ref($opt{query}) ) {
 397
 398   my @query;
 399   if (ref($opt{query}) eq 'HASH') {
 400     @query = ( $opt{query} );
 401
 402     if ( $order_by ) {
 403       if ( $opt{query}->{'order_by'} ) {
 404         if ( $opt{query}->{'order_by'} =~ /^(\s*ORDER\s+BY\s+)?(\S.*)$/is ) {
 405           $opt{query}->{'order_by'} = "ORDER BY $order_by, $2";
 406         } else {
 407           warn "unparsable query order_by: ". $opt{query}->{'order_by'};
 408           die "unparsable query order_by: ". $opt{query}->{'order_by'};
 409         }
 410       } else {
 411         $opt{query}->{'order_by'} = "ORDER BY $order_by";
 412       }
 413     }
 414
 415   } elsif (ref($opt{query}) eq 'ARRAY') {
 416     @query = @{ $opt{query} };
 417   } else {
 418     die "invalid query reference";
 419   }
 420
 421   if ( $opt{disableable} && ! $cgi->param('showdisabled') ) {
 422     #%search = ( 'disabled' => '' );
 423     $opt{'query'}->{'hashref'}->{'disabled'} = '';
 424     $opt{'query'}->{'extra_sql'} =~ s/^\s*WHERE/ AND/i;
 425   }
 426
 427   #eval "use FS::$opt{'query'};";
 428   my @param = qw( select table addl_from hashref extra_sql order_by );
 429   $rows = [ qsearch( [ map { my $query = $_;
 430                              ({ map { $_ => $query->{$_} } @param });
 431                            }
 432                        @query
 433                      ],
 434                      'order_by' => $opt{order_by}. " ". $limit,
 435                    )
 436           ];
 437 } else {
 438   my $sth = dbh->prepare("$opt{'query'} $limit")
 439     or die "Error preparing $opt{'query'}: ". dbh->errstr;
 440   $sth->execute
 441     or die "Error executing $opt{'query'}: ". $sth->errstr;
 442
 443   #can get # of rows without fetching them all?
 444   $rows = $sth->fetchall_arrayref;
 445
 446   $header ||= $sth->{NAME};
 447 }
 448
 449 </%init>