X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fsearch%2Felements%2Fsearch.html;h=60548e28edffb2bfbc6287c4f66e0e01625e48ea;hp=689cbe38938833ede03d664d2db529e7e27776db;hb=fc263806f5e475559a0c4cfdb70a5f1cefe0ffa3;hpb=5eb3dab3ea20a9861074a41bef19c9ac4dcb2336 diff --git a/httemplate/search/elements/search.html b/httemplate/search/elements/search.html index 689cbe389..60548e28e 100644 --- a/httemplate/search/elements/search.html +++ b/httemplate/search/elements/search.html @@ -1,576 +1,524 @@ -% # 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_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, -% # #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' => -% -% 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:/ -% } -% -% 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]; -% -% } -% -% # run the query -% -% my $header = $opt{'header'}; -% my $rows; -% if ( ref($opt{'query'}) ) { -% -% #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(); -% # } -% #} -% 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'} - ) - : '' - %> -% -% unless ( $total ) { -% unless ( $opt{'disable_nonefound'} ) { - - No matching <% $opt{'name'} %> found.
-% } -% } else { - - - - - - -% unless ( $opt{'disable_download'} ) { - - -% $cgi->param('_type', "html" ); -% } - - - - -% -% foreach my $header ( @$header ) { - - -% } - - -% my $bgcolor1 = '#eeeeee'; -% my $bgcolor2 = '#ffffff'; -% my $bgcolor; -% foreach my $row ( @$rows ) { -% if ( $bgcolor eq $bgcolor1 ) { -% $bgcolor = $bgcolor2; -% } else { -% $bgcolor = $bgcolor1; -% } -% - - -% if ( $opt{'fields'} ) { -% -% my $links = $opt{'links'} ? [ @{$opt{'links'}} ] : ''; -% my $aligns = $opt{'align'} ? [ @{$opt{'align'}} ] : ''; -% my $colors = $opt{'color'} ? [ @{$opt{'color'}} ] : []; -% my $sizes = $opt{'size'} ? [ @{$opt{'size'}} ] : []; -% my $styles = $opt{'style'} ? [ @{$opt{'style'}} ] : []; -% -% foreach my $field ( -% -% map { -% if ( ref($_) eq 'ARRAY' ) { -% -% my $tableref = $_; -% -% '
- -
- - <% $total %> total <% $opt{'name'} %> - -% if ( $confmax && $total > $confmax ) { -% $cgi->delete('maxrecords'); -% $cgi->param('_dummy', 1); - -%# ( show - -% foreach my $max ( map { $_ * $confmax } qw( 1 5 10 25 ) ) { - -% } - - per page ) - -% $cgi->param('maxrecords', $maxrecords); -% } - - - <% defined($opt{'html_posttotal'}) - ? ( ref($opt{'html_posttotal'}) - ? &{$opt{'html_posttotal'}}() - : $opt{'html_posttotal'} - ) - : '' - %> -
- -% if ( $opt{'count_addl'} ) { -% my $n=0; foreach my $count ( @{$opt{'count_addl'}} ) { - - <% sprintf( $count, $count_arrayref->[++$n] ) %>
- -% } -% } -
- - 		-% $cgi->param('_type', "$xlsname.xls" ); - - Download full results
- as Excel spreadsheet
-% $cgi->param('_type', 'csv'); - - as CSV file -
- - <% my $pager = include ( '/elements/pager.html', - 'offset' => $offset, - 'num_rows' => scalar(@$rows), - 'total' => $total, - 'maxrecords' => $maxrecords, - ) %> - - <% include('/elements/table-grid.html') %> - -
<% $header %>
'. -% -% join('', map { -% -% my $rowref = $_; -% -% ''. -% -% join('', map { -% -% my $element = $_; -% -% '{'align'} -% ? ' ALIGN="'. $element->{'align'}. '"' -% : '' -% ). '>'. -% ( $element->{'link'} -% ? '' -% : '' -% ). -% $element->{'data'}. -% ( $element->{'link'} -% ? '' -% : '' -% ). -% ''; -% -% } @$rowref ). -% -% ''; -% } @$tableref ). -% -% '
'; -% -% } else { -% $_; -% } -% } -% -% map { -% if ( ref($_) eq 'CODE' ) { -% &{$_}($row); -% } else { -% $row->$_(); -% } -% } -% @{$opt{'fields'}} -% -% ) { -% -% my $class = ( $field =~ /^$method(); -% } -% $a = qq(); -% } -% } -% -% my $font = ''; -% my $color = shift @$colors; -% $color = &{$color}($row) if ref($color) eq 'CODE'; -% my $size = shift @$sizes; -% $size = &{$size}($row) if ref($size) eq 'CODE'; -% if ( $color || $size ) { -% $font = ''; -% } -% -% my($s, $es) = ( '', '' ); -% my $style = shift @$styles; -% $style = &{$style}($row) if ref($style) eq 'CODE'; -% if ( $style ) { -% $s = join( '', map "<$_>", split('', $style) ); -% $es = join( '', map "", split('', $style) ); -% } -% -% - - -% } -% } else { -% foreach ( @$row ) { - - -% } -% } - - -% } -% if ( $opt{'footer'} ) { - - -% foreach my $footer ( @{ $opt{'footer'} } ) { - - -% } - - -
><% $font %><% $a %><% $s %><% $field %><% $es %><% $a ? '' : '' %><% $font ? '' : '' %><% $_ %>
<% $footer %> -% } - -
- <% $pager %> - - - - -% } - - <% defined($opt{'html_foot'}) - ? ( ref($opt{'html_foot'}) - ? &{$opt{'html_foot'}}() - : $opt{'html_foot'} +<%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 (corner cases only) 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 (now even if 'query' is an SQL query string) + 'count_query' => 'SELECT COUNT(*) FROM tablename', + + ### + # recommended / common + ### + + #listref of column labels, + #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 + 'nohtmlheader' => '', # set true to remove the header and menu bar + + #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) + + # Agent Virtualization parameters: + # In this context, only available if your selected table has agentnum. + # You must also include agentnum as a SELECT column in your SQL query, + # or experience non-obvious problems + # + '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) + + # sort, link & display properties for fields + + 'sort_fields' => [], #optional list of field names or SQL expressions for sorts + + 'order_by_sql' => { #to keep complex SQL expressions out of cgi order_by value, + 'fieldname' => 'sql snippet', # maps fields/sort_fields values to sql snippets + } + + #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' => [], # or , 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. + &> + + +% # if changing this, also update saved search behavior to match! +% 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 ) %> +% +% } elsif ( $type eq 'deposit_slip' ) { +% +<% include('search-deposit_slip.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, + totals => $totals, + opt => \%opt ) - : '' - %> - <% include( '/elements/footer.html' ) %> -% } -% } +%> +% +% } +<%init> + +my(%opt) = @_; +#warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n"; + +my $curuser = $FS::CurrentUser::CurrentUser; + +$m->comp('/elements/handle_uri_query'); + +my $type = $cgi->param('_type') + =~ /^(csv|\w*\.xls|xml|select|html(-print)?|deposit_slip)$/ + ? $1 : 'html' ; + +if ( !$curuser->access_right('Download report data') ) { + $opt{'disable_download'} = 1; + $type = 'html'; +} + +# split/map aligns here before doing anything else +my %align = ( + 'l' => 'left', + 'r' => 'right', + 'c' => 'center', + ' ' => '', + '.' => '', +); + +$opt{align} = [ map $align{$_}, split(//, $opt{align}) ], + unless !$opt{align} || ref($opt{align}); + +if($type =~ /csv|xls/) { + my $h = $opt{'header'}; + my @del; + my $i = 0; + do { + if( ref($h->[$i]) and exists($h->[$i]->{'nodownload'}) ) { + splice(@{$opt{$_}}, $i, 1) foreach + qw(header footer fields links link_onclicks + align color size style cell_style xls_format); + } + else { + $i++; + } + } while ( exists($h->[$i]) ); +} + +# wtf? +$opt{disable_download} = 0 + if $opt{disable_download} && $curuser->access_right('Configuration download'); + +$opt{disable_download} = 1 + if $opt{really_disable_download}; + +# get our queries ready +my $query = $opt{query} or die "query required"; +my $count_query = $opt{count_query} or die "count_query required"; +# there was a default count_query but it hasn't worked in about ten years + +# set up agent restriction +my @link_agentnums = (); +my $null_link = ''; +if ( $opt{'agent_virt'} ) { + + @link_agentnums = $curuser->agentnums; + $null_link = $curuser->access_right( $opt{'agent_null_right_link'} + || $opt{'agent_null_right'} ); + + my $agentnums_sql = $curuser->agentnums_sql( + 'null' => $opt{'agent_null'}, + 'null_right' => $opt{'agent_null_right'}, + 'table' => $query->{'table'}, + ); + + # this is ridiculous, but we do have searches where $query has constraints + # and $count_query doesn't, or vice versa. + if ( $query->{'extra_sql'} =~ /\bWHERE\b/i or keys %{$query->{hashref}} ) { + $query->{'extra_sql'} .= " AND $agentnums_sql"; + } else { + $query->{'extra_sql'} .= " WHERE $agentnums_sql"; + } + + if ( $count_query =~ /\bWHERE\b/i ) { + $count_query .= " AND $agentnums_sql"; + } else { + $count_query .= " WHERE $agentnums_sql"; + } + + if ( $opt{'agent_pos'} || $opt{'agent_pos'} eq '0' + and scalar($curuser->agentnums) > 1 ) { + #false laziness w/statuspos above + my $pos = $opt{'agent_pos'}; + + foreach my $att (qw( align color size style cell_style xls_format )) { + $opt{$att} ||= [ map '', @{ $opt{'fields'} } ]; + } + + splice @{ $opt{'header'} }, $pos, 0, 'Agent'; + splice @{ $opt{'align'} }, $pos, 0, 'c'; + splice @{ $opt{'style'} }, $pos, 0, ''; + splice @{ $opt{'size'} }, $pos, 0, ''; + splice @{ $opt{'fields'} }, $pos, 0, + sub { $_[0]->agentnum ? $_[0]->agent->agent : '(global)'; }; + splice @{ $opt{'color'} }, $pos, 0, ''; + splice @{ $opt{'links'} }, $pos, 0, '' #[ 'agent link?', 'agentnum' ] + if $opt{'links'}; + splice @{ $opt{'link_onclicks'} }, $pos, 0, '' + if $opt{'link_onclicks'}; + + } + +} + +if ( $opt{'disableable'} ) { + + unless ( $cgi->param('showdisabled') ) { #modify searches + + $query->{'hashref'}{'disabled'} = ''; + $query->{'extra_sql'} =~ s/^\s*\bWHERE\b/ AND/i; + + my $table = $query->{'table'}; + + $count_query .= + ( $count_query =~ /\bWHERE\b/i ? ' AND ' : ' WHERE ' ). + "( $table.disabled = '' OR $table.disabled IS NULL )"; + + } elsif ( $opt{'disabled_statuspos'} + || $opt{'disabled_statuspos'} eq '0' ) { #add status column + + my $pos = $opt{'disabled_statuspos'}; + + foreach my $att (qw( align style color size )) { + $opt{$att} ||= [ map '', @{ $opt{'fields'} } ]; + } + + splice @{ $opt{'header'} }, $pos, 0, 'Status'; + splice @{ $opt{'align'} }, $pos, 0, 'c'; + splice @{ $opt{'style'} }, $pos, 0, 'b'; + splice @{ $opt{'size'} }, $pos, 0, ''; + splice @{ $opt{'fields'} }, $pos, 0, + sub { shift->disabled ? 'DISABLED' : 'Active'; }; + splice @{ $opt{'color'} }, $pos, 0, + sub { shift->disabled ? 'FF0000' : '00CC00'; }; + splice @{ $opt{'links'} }, $pos, 0, '' + if $opt{'links'}; + splice @{ $opt{'link_onclicks'} }, $pos, 0, '' + if $opt{'link_onclicks'}; + } + + #add show/hide disabled links + my $items = $opt{'name'} || PL($opt{'name_singular'}); + if ( $cgi->param('showdisabled') ) { + $cgi->param('showdisabled', 0); + $opt{'html_posttotal'} .= + '( hide disabled $items )!; #" + $cgi->param('showdisabled', 1); + } else { + $cgi->param('showdisabled', 1); + $opt{'html_posttotal'} .= + '( show disabled $items )!; #" + $cgi->param('showdisabled', 0); + } + +} + +my $limit = ''; +my($confmax, $maxrecords, $offset ); + +unless ( $type =~ /^(csv|xml|\w*.xls)$/) { +# html mode + + unless ( $type eq 'html-print' ) { + + #setup some pagination things if we're in html mode + + my $conf = new FS::Conf; + $opt{'disable_maxselect'} ||= $conf->exists('disable_maxselect'); + unless ($opt{'disable_maxselect'}) { + $confmax = $conf->config('maxsearchrecordsperpage') || 100; + if ( $cgi->param('maxrecords') =~ /^(\d+)$/ ) { + $maxrecords = $1; + } else { + $maxrecords ||= $confmax; + } + } + + $limit = $maxrecords ? "LIMIT $maxrecords" : ''; + + $offset = $cgi->param('offset') =~ /^(\d+)$/ ? $1 : 0; + $limit .= " OFFSET $offset" if $offset; + + } + +} + +#order by override +my $order_by = $opt{order_by} || ''; +$order_by = $cgi->param('order_by') if $cgi->param('order_by'); + +# run the query + +my $header = [ map { ref($_) ? $_->{'label'} : $_ } @{$opt{header}} ]; +my $rows; + +my ($order_by_key,$order_by_desc) = ($order_by =~ /^\s*(.*?)(\s+DESC)?\s*$/i); +my $union_order_by; +$opt{'order_by_sql'} ||= {}; +$order_by_desc ||= ''; +$order_by = $opt{'order_by_sql'}{$order_by_key} . $order_by_desc + if $opt{'order_by_sql'}{$order_by_key}; + +if ( ref $query ) { + my @query; + if (ref($query) eq 'HASH') { + @query = $query; + + # Assemble peices of order_by information as SQL fragment, + # store as query->{order_by} + if ( $order_by ) { + if ( $query->{'order_by'} ) { + if ( $query->{'order_by'} =~ /^(\s*ORDER\s+BY\s+)?(\S.*)$/is ) { + $query->{'order_by'} = "ORDER BY $order_by, $2"; + } else { + warn "unparsable query order_by: ". $query->{'order_by'}; + die "unparsable query order_by: ". $query->{'order_by'}; + } + } else { + $query->{'order_by'} = "ORDER BY $order_by"; + } + } + $query->{'order_by'} .= " $limit"; + + } elsif (ref($query) eq 'ARRAY') { + # Presented query is a UNION query, with multiple query references + @query = @{ $query }; + + # Assemble peices of order_by information as SQL fragment, + # store as $union_order_by. Omit order_by/limit from individual + # $query hashrefs, because this is a union query + # + # ! Currently, order_by data is only fetched from $cgi->param('order_by') + # ! for union queries. If it eventually needs to be passed within query + # ! hashrefs, or as mason template options, would need implemented + $union_order_by = " ORDER BY $order_by " if $order_by; + $union_order_by .= " $limit " if $limit; + + } else { + die "invalid query reference ($query)"; + } + + #eval "use FS::$opt{'query'};"; + my @param = qw( select table addl_from hashref extra_sql order_by debug ); + if ($opt{classname_from_column}) { + # Perform a union of multiple queries, while using the + # classname_from_column qsearch union option + + # Constrain hashkeys for each query from @param + @query = map{ + my $query = $_; + my $new_query = {}; + $new_query->{$_} = $query->{$_} for @param; + $new_query; + } @query; + + $rows = [ + qsearch( + \@query, + order_by => $union_order_by, + classname_from_column => 1, + ) + ]; + + } else { + # default perform a query with qsearch + $rows = [ qsearch( [ map { my $query = $_; + ({ map { $_ => $query->{$_} } @param }); + } + @query + ], + #'order_by' => $opt{order_by}. " ". $limit, + ) + ]; + } +} else { # not ref $query; plain SQL (still used as of 07/2015) + + $query .= " $limit"; + my $sth = dbh->prepare($query) + or die "Error preparing $query: ". dbh->errstr; + $sth->execute + or die "Error executing $query: ". $sth->errstr; + + $rows = $sth->fetchall_arrayref; + $header ||= $sth->{NAME}; +} + +# run the count query to get number of rows and other totals +my $count_sth = dbh->prepare($count_query); +$count_sth->execute + or die "Error executing '$count_query': ".$count_sth->errstr; +my $totals = $count_sth->fetchrow_arrayref; + +push @$rows, $opt{'footer_data'} if $opt{'footer_data'}; + +