X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fsearch%2Felements%2Fsearch.html;h=d72bcfdb1797e9aa7a82a375173c3b544d2ac18a;hb=4688c4a55a51c4ce2100c1c98e7e650eb77ac95d;hp=226c4f784499669276e1833e98e0409e32615961;hpb=87227cd405166484ca7b791b2bd3c8829ce8d969;p=freeside.git
diff --git a/httemplate/search/elements/search.html b/httemplate/search/elements/search.html
index 226c4f784..d72bcfdb1 100644
--- a/httemplate/search/elements/search.html
+++ b/httemplate/search/elements/search.html
@@ -1,120 +1,704 @@
-<%
-
- my(%opt) = @_;
-
- if ( ref($opt{'query'}) ) {
-
- }
-
- 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;
- }
-
- my $conf = new FS::Conf;
- my $maxrecords = $conf->config('maxsearchrecordsperpage');
-
- my $limit = $maxrecords ? "LIMIT $maxrecords" : '';
-
- my $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;
- my $count_arrayref = $count_sth->fetchrow_arrayref;
- my $total = $count_arrayref->[0];
-
- #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
-
- 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",
- ) ];
- } 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};
- }
-
- if ( exists($opt{'redirect'}) && scalar(@$rows) == 1 && $total == 1 ) {
- my( $url, $method ) = @{$opt{'redirect'}};
- redirect( $url. $rows->[0]->$method() );
- } else {
- $opt{'name'} =~ s/s$// if $total == 1;
-%>
-<%= include( '/elements/header.html', $opt{'title'},
- include( '/elements/menubar.html', 'Main menu' => $p )
- )
-%>
-<% my $pager = include ( '/elements/pager.html',
+% # 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',
+% # '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',
+% #
+% # '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
+% #
+% # 'disableable' => 1, # set true if this table has a "disabled" field, to
+% # # hide disabled records & have "show disabled" links
+% # '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_virt' => 1, # set true if this search should be agent-virtualized
+% # 'agent_null_right' => 'Access Right', #opt. right to view global records
+% # '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)
+% #
+% # #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(%opt) = @_;
+% #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
+%
+% my $curuser = $FS::CurrentUser::CurrentUser;
+%
+% my %align = (
+% 'l' => 'left',
+% 'r' => 'right',
+% 'c' => 'center',
+% ' ' => '',
+% '.' => '',
+% );
+% $opt{align} = [ map $align{$_}, split(//, $opt{align}) ],
+% unless !$opt{align} || ref($opt{align});
+%
+% if ( $opt{'agent_virt'} ) {
+%
+% my $agentnums_sql = $curuser->agentnums_sql(
+% 'null_right' => $opt{'agent_null_right'}
+% );
+%
+% $opt{'query'}{'extra_sql'} .=
+% ( $opt{'query'} =~ /WHERE/i ? ' AND ' : ' WHERE ' ).
+% $agentnums_sql;
+% $opt{'count_query'} .=
+% ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' 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 style color size )) {
+% $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'};
+%
+% }
+%
+% }
+%
+% if ( $opt{'disableable'} ) {
+%
+% unless ( $cgi->param('showdisabled') ) { #modify searches
+%
+% $opt{'query'}{'hashref'}{'disabled'} = '';
+% $opt{'query'}{'extra_sql'} =~ s/^\s*WHERE/ AND/i;
+%
+% $opt{'count_query'} .=
+% ( $opt{'count_query'} =~ /WHERE/i ? ' AND ' : ' WHERE ' ).
+% "( disabled = '' OR 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'};
+% }
+%
+% #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 $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];
+%
+% }
+%
+% # 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({
+% 'select' => $opt{'query'}->{'select'},
+% 'table' => $opt{'query'}->{'table'},
+% 'addl_from' => (exists($opt{'query'}->{'addl_from'}) ? $opt{'query'}->{'addl_from'} : ''),
+% 'hashref' => $opt{'query'}->{'hashref'} || {},
+% 'extra_sql' => $opt{'query'}->{'extra_sql'},
+% 'order_by' => $opt{'query'}->{'order_by'}. " $limit",
+% }) ];
+% } 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};
+% }
+%
+% 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', "$xlsname.xls" );
+
+ Download full results
+ as Excel spreadsheet
+% $cgi->param('_type', 'csv');
+
+ as CSV file
+ |
+% $cgi->param('_type', "html" );
+% }
+
+
+
+
+
+ <% my $pager = include ( '/elements/pager.html',
'offset' => $offset,
'num_rows' => scalar(@$rows),
'total' => $total,
'maxrecords' => $maxrecords,
- );
-%>
-<%= $total %> total <%= $opt{'name'} %>
-<% if ( $opt{'count_addl'} ) { %>
- <% my $n=0; foreach my $count ( @{$opt{'count_addl'}} ) { %>
- <%= sprintf( $count, $count_arrayref->[++$n] ) %>
- <% } %>
-<% } %>
- <%= $pager %>
-<%= include( '/elements/table.html' ) %>
- |
- <% foreach my $header ( @$header ) { %>
- <%= $header %> |
- <% } %>
-
- <% foreach my $row ( @$rows ) { %>
-
- <% if ( $opt{'fields'} ) { %>
- <% my $links = $opt{'links'} ? [ @{$opt{'links'}} ] : ''; %>
- <% foreach my $field ( @{$opt{'fields'}} ) { %>
- <% my $a = ''; %>
- <% if ( $links ) {
- my $link = shift @$links;
- 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' ) { %>
- <%= $a %><%= &{$field}($row) %><%= $a ? '' : '' %> |
- <% } else { %>
- <%= $a %><%= $row->$field() %><%= $a ? '' : '' %> |
- <% } %>
- <% } %>
- <% } else { %>
- <% foreach ( @$row ) { %>
- <%= $_ %> |
- <% } %>
- <% } %>
-
- <% } %>
-
-
-<%= $pager %>
- |