5 <& elements/search.html,
11 'title' => 'Page title',
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
19 #literal SQL query string (corner cases only) or qsearch hashref or arrayref
20 #of qsearch hashrefs for a union of qsearches
22 'table' => 'tablename',
23 #everything else is optional...
24 'hashref' => { 'field' => 'value',
25 'field' => { 'op' => '<',
30 'addl_from' => '', #'LEFT JOIN othertable USING ( key )',
31 'extra_sql' => '', #'AND otherstuff', #'WHERE onlystuff',
32 'order_by' => 'ORDER BY something',
35 # "select * from tablename";
37 #required (now even if 'query' is an SQL query string)
38 'count_query' => 'SELECT COUNT(*) FROM tablename',
41 # recommended / common
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)
49 { 'label' => 'Another Item',
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?)
58 sub { my $row = shift; $row->column; },
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' ];
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';
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)
89 'count_addl' => [], #additional count fields listref of sprintf strings or coderefs
90 # [ $money_char.'%.2f total paid', ],
92 #second (smaller) header line, currently only for HTML
95 { 'label' => 'Another Item',
100 #listref of column footers
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"
109 'nohtmlheader' => '', # set true to remove the header and menu bar
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)
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
127 'agent_virt' => 1, # set true if this search should be
129 'agent_null' => 1, # set true to view global records always
130 'agent_null_right' => 'Access Right', # optional right to view global
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
140 # sort, link & display properties for fields
142 'sort_fields' => [], #optional list of field names or SQL expressions for sorts
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
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
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' => [],
159 #one letter for each column, left/right/center/none
160 # or pass a listref with full values: [ 'left', 'right', 'center', '' ]
163 #listrefs of ( scalars or coderefs )
164 # currently only HTML, maybe eventually Excel too
167 'style' => [], #<B> or <I>, etc.
168 'cell_style' => [], #STYLE= attribute of TR, very HTML-specific...
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' => => [],
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.
186 % # if changing this, also update saved search behavior to match!
187 % if ( $type eq 'csv' ) {
189 <% include('search-csv.html', header=>$header, rows=>$rows, opt=>\%opt ) %>
191 % } elsif ( $type =~ /\.xls$/ ) {
193 <& 'search-xls.html', header=>$header, rows=>$rows, opt=>\%opt &>\
194 % # prevent the caller from polluting our output stream
197 % } elsif ( $type eq 'xml' ) {
199 <% include('search-xml.html', rows=>$rows, opt=>\%opt ) %>
201 % } elsif ( $type eq 'deposit_slip' ) {
203 <% include('search-deposit_slip.html', rows=>$rows, opt=>\%opt ) %>
207 <% include('search-html.html',
211 link_agentnums => \@link_agentnums,
212 null_link => $null_link,
214 maxrecords => $maxrecords,
225 #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
227 my $curuser = $FS::CurrentUser::CurrentUser;
229 $m->comp('/elements/handle_uri_query');
231 my $type = $cgi->param('_type')
232 =~ /^(csv|\w*\.xls|xml|select|html(-print)?|deposit_slip)$/
235 if ( !$curuser->access_right('Download report data') ) {
236 $opt{'disable_download'} = 1;
240 # split/map aligns here before doing anything else
249 $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
250 unless !$opt{align} || ref($opt{align});
252 if($type =~ /csv|xls/) {
253 my $h = $opt{'header'};
257 if( ref($h->[$i]) and exists($h->[$i]->{'nodownload'}) ) {
258 splice(@{$opt{$_}}, $i, 1) foreach
259 qw(header footer fields links link_onclicks
260 align color size style cell_style xls_format);
265 } while ( exists($h->[$i]) );
269 $opt{disable_download} = 0
270 if $opt{disable_download} && $curuser->access_right('Configuration download');
272 $opt{disable_download} = 1
273 if $opt{really_disable_download};
275 # get our queries ready
276 my $query = $opt{query} or die "query required";
277 my $count_query = $opt{count_query} or die "count_query required";
278 # there was a default count_query but it hasn't worked in about ten years
280 # set up agent restriction
281 my @link_agentnums = ();
283 if ( $opt{'agent_virt'} ) {
285 @link_agentnums = $curuser->agentnums;
286 $null_link = $curuser->access_right( $opt{'agent_null_right_link'}
287 || $opt{'agent_null_right'} );
289 my $agentnums_sql = $curuser->agentnums_sql(
290 'null' => $opt{'agent_null'},
291 'null_right' => $opt{'agent_null_right'},
292 'table' => $query->{'table'},
295 # this is ridiculous, but we do have searches where $query has constraints
296 # and $count_query doesn't, or vice versa.
297 if ( $query->{'extra_sql'} =~ /\bWHERE\b/i or keys %{$query->{hashref}} ) {
298 $query->{'extra_sql'} .= " AND $agentnums_sql";
300 $query->{'extra_sql'} .= " WHERE $agentnums_sql";
303 if ( $count_query =~ /\bWHERE\b/i ) {
304 $count_query .= " AND $agentnums_sql";
306 $count_query .= " WHERE $agentnums_sql";
309 if ( $opt{'agent_pos'} || $opt{'agent_pos'} eq '0'
310 and scalar($curuser->agentnums) > 1 ) {
311 #false laziness w/statuspos above
312 my $pos = $opt{'agent_pos'};
314 foreach my $att (qw( align color size style cell_style xls_format )) {
315 $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
318 splice @{ $opt{'header'} }, $pos, 0, 'Agent';
319 splice @{ $opt{'align'} }, $pos, 0, 'c';
320 splice @{ $opt{'style'} }, $pos, 0, '';
321 splice @{ $opt{'size'} }, $pos, 0, '';
322 splice @{ $opt{'fields'} }, $pos, 0,
323 sub { $_[0]->agentnum ? $_[0]->agent->agent : '(global)'; };
324 splice @{ $opt{'color'} }, $pos, 0, '';
325 splice @{ $opt{'links'} }, $pos, 0, '' #[ 'agent link?', 'agentnum' ]
327 splice @{ $opt{'link_onclicks'} }, $pos, 0, ''
328 if $opt{'link_onclicks'};
334 if ( $opt{'disableable'} ) {
336 unless ( $cgi->param('showdisabled') ) { #modify searches
338 $query->{'hashref'}{'disabled'} = '';
339 $query->{'extra_sql'} =~ s/^\s*\bWHERE\b/ AND/i;
341 my $table = $query->{'table'};
344 ( $count_query =~ /\bWHERE\b/i ? ' AND ' : ' WHERE ' ).
345 "( $table.disabled = '' OR $table.disabled IS NULL )";
347 } elsif ( $opt{'disabled_statuspos'}
348 || $opt{'disabled_statuspos'} eq '0' ) { #add status column
350 my $pos = $opt{'disabled_statuspos'};
352 foreach my $att (qw( align style color size )) {
353 $opt{$att} ||= [ map '', @{ $opt{'fields'} } ];
356 splice @{ $opt{'header'} }, $pos, 0, 'Status';
357 splice @{ $opt{'align'} }, $pos, 0, 'c';
358 splice @{ $opt{'style'} }, $pos, 0, 'b';
359 splice @{ $opt{'size'} }, $pos, 0, '';
360 splice @{ $opt{'fields'} }, $pos, 0,
361 sub { shift->disabled ? 'DISABLED' : 'Active'; };
362 splice @{ $opt{'color'} }, $pos, 0,
363 sub { shift->disabled ? 'FF0000' : '00CC00'; };
364 splice @{ $opt{'links'} }, $pos, 0, ''
366 splice @{ $opt{'link_onclicks'} }, $pos, 0, ''
367 if $opt{'link_onclicks'};
370 #add show/hide disabled links
371 my $items = $opt{'name'} || PL($opt{'name_singular'});
372 if ( $cgi->param('showdisabled') ) {
373 $cgi->param('showdisabled', 0);
374 $opt{'html_posttotal'} .=
375 '( <a href="'. $cgi->self_url. qq!">hide disabled $items</a> )!; #"
376 $cgi->param('showdisabled', 1);
378 $cgi->param('showdisabled', 1);
379 $opt{'html_posttotal'} .=
380 '( <a href="'. $cgi->self_url. qq!">show disabled $items</a> )!; #"
381 $cgi->param('showdisabled', 0);
387 my($confmax, $maxrecords, $offset );
389 unless ( $type =~ /^(csv|xml|\w*.xls)$/) {
392 unless ( $type eq 'html-print' ) {
394 #setup some pagination things if we're in html mode
396 my $conf = new FS::Conf;
397 $opt{'disable_maxselect'} ||= $conf->exists('disable_maxselect');
398 unless ($opt{'disable_maxselect'}) {
399 $confmax = $conf->config('maxsearchrecordsperpage') || 100;
400 if ( $cgi->param('maxrecords') =~ /^(\d+)$/ ) {
403 $maxrecords ||= $confmax;
407 $limit = $maxrecords ? "LIMIT $maxrecords" : '';
409 $offset = $cgi->param('offset') =~ /^(\d+)$/ ? $1 : 0;
410 $limit .= " OFFSET $offset" if $offset;
417 my $order_by = $opt{order_by} || '';
418 $order_by = $cgi->param('order_by') if $cgi->param('order_by');
422 my $header = [ map { ref($_) ? $_->{'label'} : $_ } @{$opt{header}} ];
425 my ($order_by_key,$order_by_desc) = ($order_by =~ /^\s*(.*?)(\s+DESC)?\s*$/i);
427 $opt{'order_by_sql'} ||= {};
428 $order_by_desc ||= '';
429 $order_by = $opt{'order_by_sql'}{$order_by_key} . $order_by_desc
430 if $opt{'order_by_sql'}{$order_by_key};
434 if (ref($query) eq 'HASH') {
437 # Assemble peices of order_by information as SQL fragment,
438 # store as query->{order_by}
440 if ( $query->{'order_by'} ) {
441 if ( $query->{'order_by'} =~ /^(\s*ORDER\s+BY\s+)?(\S.*)$/is ) {
442 $query->{'order_by'} = "ORDER BY $order_by, $2";
444 warn "unparsable query order_by: ". $query->{'order_by'};
445 die "unparsable query order_by: ". $query->{'order_by'};
448 $query->{'order_by'} = "ORDER BY $order_by";
451 $query->{'order_by'} .= " $limit";
453 } elsif (ref($query) eq 'ARRAY') {
454 # Presented query is a UNION query, with multiple query references
455 @query = @{ $query };
457 # Assemble peices of order_by information as SQL fragment,
458 # store as $union_order_by. Omit order_by/limit from individual
459 # $query hashrefs, because this is a union query
461 # ! Currently, order_by data is only fetched from $cgi->param('order_by')
462 # ! for union queries. If it eventually needs to be passed within query
463 # ! hashrefs, or as mason template options, would need implemented
464 $union_order_by = " ORDER BY $order_by " if $order_by;
465 $union_order_by .= " $limit " if $limit;
468 die "invalid query reference ($query)";
471 #eval "use FS::$opt{'query'};";
472 my @param = qw( select table addl_from hashref extra_sql order_by debug );
473 if ($opt{classname_from_column}) {
474 # Perform a union of multiple queries, while using the
475 # classname_from_column qsearch union option
477 # Constrain hashkeys for each query from @param
481 $new_query->{$_} = $query->{$_} for @param;
488 order_by => $union_order_by,
489 classname_from_column => 1,
494 # default perform a query with qsearch
495 $rows = [ qsearch( [ map { my $query = $_;
496 ({ map { $_ => $query->{$_} } @param });
500 #'order_by' => $opt{order_by}. " ". $limit,
504 } else { # not ref $query; plain SQL (still used as of 07/2015)
507 my $sth = dbh->prepare($query)
508 or die "Error preparing $query: ". dbh->errstr;
510 or die "Error executing $query: ". $sth->errstr;
512 $rows = $sth->fetchall_arrayref;
513 $header ||= $sth->{NAME};
516 # run the count query to get number of rows and other totals
517 my $count_sth = dbh->prepare($count_query);
519 or die "Error executing '$count_query': ".$count_sth->errstr;
520 my $totals = $count_sth->fetchrow_arrayref;
522 push @$rows, $opt{'footer_data'} if $opt{'footer_data'};