-% # options example...
-% # (everything not commented required is optional)
-% #
-% # # basic options, required
-% # 'title' => 'Page title',
-% #
-% # 'name_singular' => 'item', #singular name for the records returned
-% # #OR# # (preferred, will be pluralized automatically)
-% # 'name' => 'items', #plural name for the records returned
-% # # (deprecated, will be singularlized
-% # # simplisticly)
-% #
-% # # some HTML callbacks...
-% # 'menubar' => '', #menubar arrayref
-% # 'html_init' => '', #after the header/menubar and before the pager
-% # 'html_form' => '', #after the pager, right before the results
-% # # (only shown if there are results)
-% # # (use this for any form-opening tag rather than
-% # # html_init, to avoid a nested form)
-% # 'html_foot' => '', #at the bottom
-% # 'html_posttotal' => '', #at the bottom
-% # # (these three can be strings or coderefs)
-% #
-% #
-% # #literal SQL query string or qsearch hashref, required
-% # 'query' => {
-% # 'table' => 'tablename',
-% # #everything else is optional...
-% # 'hashref' => { 'field' => 'value',
-% # 'field' => { 'op' => '<',
-% # 'value' => '54',
-% # },
-% # },
-% # 'select' => '*',
-% # 'addl_from' => '', #'LEFT JOIN othertable USING ( key )',
-% # 'extra_sql' => '', #'AND otherstuff', #'WHERE onlystuff',
-% #
-% #
-% # },
-% # # "select * from tablename";
-% #
-% # #required unless 'query' is an SQL query string (shouldn't be...)
-% # 'count_query' => 'SELECT COUNT(*) FROM tablename',
-% #
-% # 'count_addl' => [], #additional count fields listref of sprintf strings
-% # # [ $money_char.'%.2f total paid', ],
-% #
-% # #listref of column labels, <TH>
-% # #required unless 'query' is an SQL query string
-% # # (if not specified the database column names will be used)
-% # 'header' => [ '#', 'Item' ],
-% #
-% # 'disable_download' => '', # set true to hide the CSV/Excel download links
-% # 'disable_nonefound' => '', # set true to disable the "No matching Xs found"
-% # # message
-% #
-% # #listref - each item is a literal column name (or method) or coderef
-% # #if not specified all columns will be shown
-% # 'fields' => [
-% # 'column',
-% # sub { my $row = shift; $row->column; },
-% # ],
-% #
-% # #listref of column footers
-% # 'footer' => [],
-% #
-% # #listref - each item is the empty string, or a listref of ...
-% # 'links' =>
-% #
-% #
-% # 'align' => 'lrc.', #one letter for each column, left/right/center/none
-% # # can also pass a listref with full values:
-% # # [ 'left', 'right', 'center', '' ]
-% #
-% # #listrefs...
-% # #currently only HTML, maybe eventually Excel too
-% # 'color' => [],
-% # 'size' => [],
-% # 'style' => [],
-% #
-% # #redirect if there's only one item...
-% # # listref of URL base and column name (or method)
-% # # or a coderef that returns the same
-% # 'redirect' =>
-% #
-% # #set to 1 (or column position for "disabled" status col) to enable
-% # #"show disabled/hide disabled" links
-% # #(can't be used with a literal query)
-% # 'disableable' => 1,
-%
-% my $DEBUG = 0;
-%
-% my(%opt) = @_;
-% #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
-%
-% my %align = (
-% 'l' => 'left',
-% 'r' => 'right',
-% 'c' => 'center',
-% ' ' => '',
-% '.' => '',
-% );
-% $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
-% unless !$opt{align} || ref($opt{align});
-%
-% my $type = '';
-% my $limit = '';
-% my($confmax, $maxrecords, $total, $offset, $count_arrayref);
-%
-% if ( $cgi->param('_type') =~ /^(csv|\w*\.xls)$/ ) {
-%
-% $type = $1;
-%
-% } else { #setup some pagination things if we're in 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:/
-% }
-%
-% if ( $opt{disableable} && ! $cgi->param('showdisabled') ) {
-% $opt{count_query} .=
-% ( ( $opt{count_query} =~ /WHERE/i ) ? ' AND ' : ' WHERE ' ).
-% "( disabled = '' OR disabled IS NULL )";
-% }
-%
-% my $conf = new FS::Conf;
-% $confmax = $conf->config('maxsearchrecordsperpage');
-% if ( $cgi->param('maxrecords') =~ /^(\d+)$/ ) {
-% $maxrecords = $1;
-% } else {
-% $maxrecords ||= $confmax;
-% }
-%
-% $limit = $maxrecords ? "LIMIT $maxrecords" : '';
-%
-% $offset = $cgi->param('offset') || 0;
-% $limit .= " OFFSET $offset" if $offset;
-%
-% my $count_sth = dbh->prepare($opt{'count_query'})
-% or die "Error preparing $opt{'count_query'}: ". dbh->errstr;
-% $count_sth->execute
-% or die "Error executing $opt{'count_query'}: ". $count_sth->errstr;
-% $count_arrayref = $count_sth->fetchrow_arrayref;
-% $total = $count_arrayref->[0];
-%
-% }
-%
-% #disableable handling
-% my $posttotal = '';
-% if ( $opt{disableable} ) {
-%
-% my $name= $opt{'name_singular'} ? PL($opt{'name_singular'}) : $opt{'name'};
-%
-% if ( $cgi->param('showdisabled') ) {
-% $cgi->param('showdisabled', 0);
-% $posttotal= '( <a href="'. $cgi->self_url. '">'.
-% "hide disabled $name</a> )";
-% $cgi->param('showdisabled', 1);
-% } else {
-% $cgi->param('showdisabled', 1);
-% $posttotal= '( <a href="'. $cgi->self_url. '">'.
-% "show disabled $name</a> )";
-% $cgi->param('showdisabled', 0);
-% }
-%
-% if ( $cgi->param('showdisabled') ) {
-%
-% my $offset = $opt{disableable};
-%
-% splice @{ $opt{header} }, $offset, 0, 'Status';
-%
-% splice @{ $opt{fields} }, $offset, 0,
-% sub { shift->disabled ? 'DISABLED' : 'Active' };
-%
-% if ( $opt{links} && scalar( @{ $opt{links} } ) ) {
-% splice @{ $opt{links} }, $offset, 0, '';
-% }
-%
-% if ( $opt{align} && scalar( @{ $opt{align} } ) ) {
-% splice @{ $opt{align} }, $offset, 0, 'center';
-% }
-%
-% unless ( $opt{color} && scalar( @{ $opt{color} } ) ) {
-% #$opt{color} = [ map { '000000'; } @{$opt{header}} ];
-% $opt{color} = [ map { ''; } @{$opt{header}} ];
-% }
-% splice @{ $opt{color} }, $offset, 0,
-% sub { shift->disabled ? 'FF0000' : '00CC00'; };
-%
-% if ( $opt{size} && scalar( @{ $opt{size} } ) ) {
-% splice @{ $opt{size} }, $offset, 0, '';
-% }
-%
-% unless ( $opt{style} && scalar( @{ $opt{style} } ) ) {
-% $opt{style} = [ map { ''; } @{$opt{header}} ];
-% }
-% splice @{ $opt{style} }, $offset, 0, 'b';
-%
-% }
-%
-% }
-%
-% # run the query
-%
-% my $header = $opt{header};
-% my $rows;
-% if ( ref($opt{query}) ) {
-%
-% if ( $opt{disableable} && ! $cgi->param('showdisabled') ) {
-% #%search = ( 'disabled' => '' );
-% $opt{'query'}->{'hashref'}->{'disabled'} = '';
-% $opt{'query'}->{'extra_sql'} =~ s/^\s*WHERE/ AND/i;
-% }
-%
-% #eval "use FS::$opt{'query'};";
-% $rows = [ qsearch(
-% $opt{'query'}->{'table'},
-% $opt{'query'}->{'hashref'} || {},
-% $opt{'query'}->{'select'},
-% $opt{'query'}->{'extra_sql'}. " $limit",
-% '',
-% (exists($opt{'query'}->{'addl_from'}) ? $opt{'query'}->{'addl_from'} : '')
-% ) ];
-%
-% } else {
-%
-% my $sth = dbh->prepare("$opt{'query'} $limit")
-% or die "Error preparing $opt{'query'}: ". dbh->errstr;
-% $sth->execute
-% or die "Error executing $opt{'query'}: ". $sth->errstr;
-%
-% #can get # of rows without fetching them all?
-% $rows = $sth->fetchall_arrayref;
-%
-% $header ||= $sth->{NAME};
-%
-% }
-%
-% warn scalar(@$rows). ' rows returned from '.
-% ( ref($opt{'query'}) ? 'qsearch query' : 'literal SQL query' )
-% if $DEBUG || $opt{'debug'};
-%
-% # display the results - csv, xls or html
-%
-% if ( $type eq 'csv' ) {
-%
-% #http_header('Content-Type' => 'text/comma-separated-values' ); #IE chokes
-% http_header('Content-Type' => 'text/plain' );
-%
-% my $csv = new Text::CSV_XS { 'always_quote' => 1,
-% 'eol' => "\n", #"\015\012", #"\012"
-% };
-%
-% $csv->combine(@$header); #or die $csv->status;
-%
-<% $csv->string %>
-%
-%
-% foreach my $row ( @$rows ) {
-%
-% if ( $opt{'fields'} ) {
-%
-% my @line = ();
-%
-% foreach my $field ( @{$opt{'fields'}} ) {
-% if ( ref($field) eq 'CODE' ) {
-% push @line, map {
-% ref($_) eq 'ARRAY'
-% ? '(N/A)' #unimplemented
-% : $_;
-% }
-% &{$field}($row);
-% } else {
-% push @line, $row->$field();
-% }
-% }
-%
-% $csv->combine(@line); #or die $csv->status;
-%
-% } else {
-% $csv->combine(@$row); #or die $csv->status;
-% }
-%
-%
-<% $csv->string %>
-%
-%
-% }
-%
-% #} elsif ( $type eq 'excel' ) {
-% } elsif ( $type =~ /\.xls$/ ) {
-%
-% #http_header('Content-Type' => 'application/excel' ); #eww
-% http_header('Content-Type' => 'application/vnd.ms-excel' );
-% #http_header('Content-Type' => 'application/msexcel' ); #alas
-%
-% my $data = '';
-% my $XLS = new IO::Scalar \$data;
-% my $workbook = Spreadsheet::WriteExcel->new($XLS)
-% or die "Error opening .xls file: $!";
-%
-% my $worksheet = $workbook->add_worksheet(substr($opt{'title'},0,31));
-%
-% my($r,$c) = (0,0);
-%
-% $worksheet->write($r, $c++, $_) foreach @$header;
-%
-% foreach my $row ( @$rows ) {
-% $r++;
-% $c = 0;
-%
-% if ( $opt{'fields'} ) {
-%
-% #my $links = $opt{'links'} ? [ @{$opt{'links'}} ] : '';
-% #my $aligns = $opt{'align'} ? [ @{$opt{'align'}} ] : '';
-%
-% foreach my $field ( @{$opt{'fields'}} ) {
-% #my $align = $aligns ? shift @$aligns : '';
-% #$align = " ALIGN=$align" if $align;
-% #my $a = '';
-% #if ( $links ) {
-% # my $link = shift @$links;
-% # $link = &{$link}($row) if ref($link) eq 'CODE';
-% # if ( $link ) {
-% # my( $url, $method ) = @{$link};
-% # if ( ref($method) eq 'CODE' ) {
-% # $a = $url. &{$method}($row);
-% # } else {
-% # $a = $url. $row->$method();
-% # }
-% # $a = qq(<A HREF="$a">);
-% # }
-% #}
-% if ( ref($field) eq 'CODE' ) {
-% foreach my $value ( &{$field}($row) ) {
-% if ( ref($value) eq 'ARRAY' ) {
-% $worksheet->write($r, $c++, '(N/A)' ); #unimplemented
-% } else {
-% $worksheet->write($r, $c++, $value );
-% }
-% }
-% } else {
-% $worksheet->write($r, $c++, $row->$field() );
-% }
-% }
-%
-% } else {
-% $worksheet->write($r, $c++, $_) foreach @$row;
-% }
-%
-% }
-%
-% $workbook->close();# or die "Error creating .xls file: $!";
-%
-% http_header('Content-Length' => length($data) );
-%
-<% $data %>
-%
-%
-% } else { # regular HTML
-%
-% if ( exists($opt{'redirect'}) && scalar(@$rows) == 1 && $total == 1 ) {
-% my $redirect = $opt{'redirect'};
-% $redirect = &{$redirect}($rows->[0]) if ref($redirect) eq 'CODE';
-% my( $url, $method ) = @$redirect;
-% redirect( $url. $rows->[0]->$method() );
-% } else {
-% if ( $opt{'name_singular'} ) {
-% $opt{'name'} = PL($opt{'name_singular'});
-% }
-% ( my $xlsname = $opt{'name'} ) =~ s/\W//g;
-% if ( $total == 1 ) {
-% if ( $opt{'name_singular'} ) {
-% $opt{'name'} = $opt{'name_singular'}
-% } else {
-% #$opt{'name'} =~ s/s$// if $total == 1;
-% $opt{'name'} =~ s/((s)e)?s$/$2/ if $total == 1;
-% }
-% }
-%
-% my @menubar = ();
-% if ( $opt{'menubar'} ) {
-% @menubar = @{ $opt{'menubar'} };
-% #} else {
-% # @menubar = ( 'Main menu' => $p );
-% }
-
- <% include( '/elements/header.html', $opt{'title'},
- include( '/elements/menubar.html', @menubar )
- )
- %>
- <% defined($opt{'html_init'})
- ? ( ref($opt{'html_init'})
- ? &{$opt{'html_init'}}()
- : $opt{'html_init'}
+<%doc>
+
+Example:
+
+ <& elements/search.html,
+
+ ###
+ # required
+ ###
+
+ 'title' => 'Page title',
+
+ 'name_singular' => 'item', #singular name for the records returned
+ #OR# # (preferred, will be pluralized automatically)
+ 'name' => 'items', #plural name for the records returned
+ # (deprecated, will be singularlized
+ # simplisticly)
+
+ #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...
+ 'hashref' => { 'field' => 'value',
+ 'field' => { 'op' => '<',
+ 'value' => '54',
+ },
+ },
+ 'select' => '*',
+ 'addl_from' => '', #'LEFT JOIN othertable USING ( key )',
+ 'extra_sql' => '', #'AND otherstuff', #'WHERE onlystuff',
+ 'order_by' => 'ORDER BY something',
+
+ },
+ # "select * from tablename";
+
+ #required unless 'query' is an SQL query string (shouldn't be...)
+ 'count_query' => 'SELECT COUNT(*) FROM tablename',
+
+ ###
+ # recommended / common
+ ###
+
+ #listref of column labels, <TH>
+ #recommended unless 'query' is an SQL query string
+ # (if not specified the database column names will be used) (XXX this is not currently working either)
+ 'header' => [ '#',
+ 'Item',
+ { 'label' => 'Another Item',
+
+ },
+ ],
+
+ #listref - each item is a literal column name (or method) or coderef
+ #if not specified all columns will be shown (XXX this is not currently working?)
+ 'fields' => [
+ 'column',
+ sub { my $row = shift; $row->column; },
+ ],
+
+ #redirect if there's only one item...
+ # listref of URL base and column name (or method)
+ # or a coderef that returns the same
+ 'redirect' => sub { my( $record, $cgi ) = @_;
+ [ popurl(2).'view/item.html', 'primary_key' ];
+ },
+
+ #redirect if there's no items
+ # scalar URL or a coderef that returns a URL
+ 'redirect_empty' => sub { my( $cgi ) = @_;
+ popurl(2).'view/item.html';
+ },
+
+ ###
+ # optional
+ ###
+
+ # some HTML callbacks...
+ 'menubar' => '', #menubar arrayref
+ 'html_init' => '', #after the header/menubar and before the pager
+ 'html_form' => '', #after the pager, right before the results
+ # (only shown if there are results)
+ # (use this for any form-opening tag rather than
+ # html_init, to avoid a nested form)
+ 'html_foot' => '', #at the bottom
+ 'html_posttotal' => '', #at the bottom
+ # (these three can be strings or coderefs)
+
+ 'count_addl' => [], #additional count fields listref of sprintf strings or coderefs
+ # [ $money_char.'%.2f total paid', ],
+
+ #second (smaller) header line, currently only for HTML
+ 'header2 => [ '#',
+ 'Item',
+ { 'label' => 'Another Item',
+
+ },
+ ],
+
+ #listref of column footers
+ 'footer' => [],
+
+ #disabling things
+ 'disable_download' => '', # set true to hide the CSV/Excel download links
+ 'disable_total' => '', # set true to hide the total"
+ 'disable_maxselect' => '', # set true to disable record/page selection
+ 'disable_nonefound' => '', # set true to disable the "No matching Xs found"
+ # message
+
+ #handling "disabled" fields in the records
+ 'disableable' => 1, # set set to 1 (or column position for "disabled"
+ # status col) to enable if this table has a "disabled"
+ # field, to hide disabled records & have
+ # "show disabled/hide disabled" links
+ #(can't be used with a literal query)
+ 'disabled_statuspos' => 3, #optional position (starting from 0) to insert
+ #a Status column when showing disabled records
+ #(query needs to be a qsearch hashref and
+ # header & fields need to be defined)
+
+ #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
+ # global records; defaults to
+ # same as agent_null_right
+ 'agent_pos' => 3, # optional position (starting from 0) to
+ # insert an Agent column (query needs to be a
+ # qsearch hashref and header & fields need to
+ # be defined)cust_pkg_susp.html
+
+ # 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,
+ # or a listref of link and coderef to run and append
+ # or a coderef that returns such a listref
+ 'links' => [],
+
+ #listref - each item is the empty string,
+ # or a string onClick handler for the corresponding link
+ # or a coderef that returns string onClick handler
+ 'link_onclicks' => [],
+
+ #one letter for each column, left/right/center/none
+ # or pass a listref with full values: [ 'left', 'right', 'center', '' ]
+ 'align' => 'lrc.',
+
+ #listrefs of ( scalars or coderefs )
+ # 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' => => [],
+
+
+ # miscellany
+ 'download_label' => 'Download this report',
+ # defaults to 'Download full results'
+ 'link_field' => 'pkgpart'
+ # will create internal links for each row,
+ # with the value of this field as the NAME attribute
+ # If this is a coderef, will evaluate it, passing the
+ # row as an argument, and use the result as the NAME.
+ &>
+
+</%doc>
+% if ( $type eq 'csv' ) {
+%
+<% include('search-csv.html', header=>$header, rows=>$rows, opt=>\%opt ) %>
+%
+% } elsif ( $type =~ /\.xls$/ ) {
+%
+<& 'search-xls.html', header=>$header, rows=>$rows, opt=>\%opt &>\
+% # prevent the caller from polluting our output stream
+% $m->abort;
+%
+% } elsif ( $type eq 'xml' ) {
+%
+<% include('search-xml.html', rows=>$rows, opt=>\%opt ) %>
+%
+% } else {
+%
+<% include('search-html.html',
+ type => $type,
+ header => $header,
+ rows => $rows,
+ link_agentnums => \@link_agentnums,
+ null_link => $null_link,
+ confmax => $confmax,
+ maxrecords => $maxrecords,
+ offset => $offset,
+ opt => \%opt