Example:
- include( 'elements/search.html',
+ <& elements/search.html,
###
# required
#listref of column labels, <TH>
#recommended unless 'query' is an SQL query string
- # (if not specified the database column names will be used)
+ # (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
+ #if not specified all columns will be shown (XXX this is not currently working?)
'fields' => [
'column',
sub { my $row = shift; $row->column; },
'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"
#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
'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)
+ # be defined)cust_pkg_susp.html
+
+ # sort, link & display properties for fields
+
+ 'sort_fields' => [], #optional list of field names or SQL expressions for sorts
- # link & display properties for fields
+ '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' => [],`
+ 'links' => [],
#listref - each item is the empty string,
# or a string onClick handler for the corresponding link
# 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 eq 'excel' ) {
% } elsif ( $type =~ /\.xls$/ ) {
%
-<% include('search-xls.html', header=>$header, rows=>$rows, opt=>\%opt ) %>
+<& 'search-xls.html', header=>$header, rows=>$rows, opt=>\%opt &>\
+% # prevent the caller from polluting our output stream
+% $m->abort;
+%
+% } elsif ( $type eq 'xml' ) {
%
-% } else { # regular HTML
+<% include('search-xml.html', rows=>$rows, opt=>\%opt ) %>
+%
+% } else {
%
<% include('search-html.html',
type => $type,
confmax => $confmax,
maxrecords => $maxrecords,
offset => $offset,
+ totals => $totals,
opt => \%opt
)
%>
my $curuser = $FS::CurrentUser::CurrentUser;
-my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|select|html(-print)?)$/
+my $type = $cgi->param('_type') =~ /^(csv|\w*\.xls|xml|select|html(-print)?)$/
? $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',
' ' => '',
'.' => '',
);
+
$opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
unless !$opt{align} || ref($opt{align});
} 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'} ) {
|| $opt{'agent_null_right'} );
my $agentnums_sql = $curuser->agentnums_sql(
- 'null_right' => $opt{'agent_null_right'}
+ 'null' => $opt{'agent_null'},
+ 'null_right' => $opt{'agent_null_right'},
+ 'table' => $query->{'table'},
);
- $opt{'query'}{'extra_sql'} .=
- ( $opt{'query'}{'extra_sql'} =~ /WHERE/i || keys %{$opt{'query'}{'hashref'}}
- ? ' AND '
- : ' WHERE ' ). $agentnums_sql;
+ # 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";
+ }
- $opt{'count_query'} .=
- ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' 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 ) {
unless ( $cgi->param('showdisabled') ) { #modify searches
- $opt{'query'}{'hashref'}{'disabled'} = '';
- $opt{'query'}{'extra_sql'} =~ s/^\s*WHERE/ AND/i;
+ $query->{'hashref'}{'disabled'} = '';
+ $query->{'extra_sql'} =~ s/^\s*\bWHERE\b/ AND/i;
+
+ my $table = $query->{'table'};
- $opt{'count_query'} .=
- ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' WHERE ' ).
- "( disabled = '' OR disabled IS NULL )";
+ $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
sub { shift->disabled ? 'FF0000' : '00CC00'; };
splice @{ $opt{'links'} }, $pos, 0, ''
if $opt{'links'};
- splice @{ $opt{'link_onlicks'} }, $pos, 0, ''
- if $opt{'link_onlicks'};
+ splice @{ $opt{'link_onclicks'} }, $pos, 0, ''
+ if $opt{'link_onclicks'};
}
#add show/hide disabled links
my $limit = '';
my($confmax, $maxrecords, $offset );
-if ( !$type =~ /^(csv|\w*.xls)$/) {
+unless ( $type =~ /^(csv|xml|\w*.xls)$/) {
# 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 )";
- }
unless ( $type eq 'html-print' ) {
$maxrecords ||= $confmax;
}
+ $opt{'disable_maxselect'} ||= $conf->exists('disable_maxselect');
+
$limit = $maxrecords ? "LIMIT $maxrecords" : '';
$offset = $cgi->param('offset') =~ /^(\d+)$/ ? $1 : 0;
}
+#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;
-if ( ref($opt{query}) ) {
+my ($order_by_key,$order_by_desc) = ($order_by =~ /^\s*(.*?)(\s+DESC)?\s*$/i);
+$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($opt{query}) eq 'HASH') {
- @query = ( $opt{query} );
- } elsif (ref($opt{query}) eq 'ARRAY') {
- @query = @{ $opt{query} };
+ if (ref($query) eq 'HASH') {
+ @query = $query;
+
+ 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') {
+ # do we still use this? it was for the old 477 report.
+ @query = @{ $query };
} else {
die "invalid query reference";
}
- 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'};";
- my @param = qw( select table addl_from hashref extra_sql order_by );
+ my @param = qw( select table addl_from hashref extra_sql order_by debug );
$rows = [ qsearch( [ map { my $query = $_;
({ map { $_ => $query->{$_} } @param });
}
@query
],
- 'order_by' => $opt{order_by}. " ". $limit,
+ #'order_by' => $opt{order_by}. " ". $limit,
)
];
-} else {
- my $sth = dbh->prepare("$opt{'query'} $limit")
- or die "Error preparing $opt{'query'}: ". dbh->errstr;
+
+} 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 $opt{'query'}: ". $sth->errstr;
+ or die "Error executing $query: ". $sth->errstr;
- #can get # of rows without fetching them all?
$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'};
+
</%init>
projects / freeside.git / blobdiff