4 use vars qw($DEBUG @ISA @EXPORT_OK $me);
8 use FS::Record qw(dbdef);
13 @ISA = qw( Exporter );
15 @EXPORT_OK = qw( svc_url );
18 $me = '[FS::UID::Web]';
25 sub parse_beginning_ending {
26 my($cgi, $prefix) = @_;
27 $prefix .= '_' if $prefix;
30 if ( $cgi->param($prefix.'begin') =~ /^(\d+)$/ ) {
32 } elsif ( $cgi->param($prefix.'beginning') =~ /^([ 0-9\-\/]{1,64})$/ ) {
33 $beginning = str2time($1) || 0;
36 my $ending = 4294967295; #2^32-1
37 if ( $cgi->param($prefix.'end') =~ /^(\d+)$/ ) {
39 } elsif ( $cgi->param($prefix.'ending') =~ /^([ 0-9\-\/]{1,64})$/ ) {
40 #probably need an option to turn off the + 86399
41 $ending = str2time($1) + 86399;
44 ( $beginning, $ending );
49 Returns a service URL, first checking to see if there is a service-specific
50 page to link to, otherwise to a generic service handling page. Options are
51 passed as a list of name-value pairs, and include:
55 =item * m - Mason request object ($m)
57 =item * action - The action for which to construct "edit", "view", or "search"
59 =item ** part_svc - Service definition (see L<FS::part_svc>)
61 =item ** svcdb - Service table
63 =item *** query - Query string
65 =item *** svc - FS::cust_svc or FS::svc_* object
67 =item ahref - Optional flag, if set true returns <A HREF="$url"> instead of just the URL.
73 ** part_svc OR svcdb is required
75 *** query OR svc is required
82 # 'm' => $m, #mason request object
83 # 'action' => 'edit', #or 'view'
85 # 'part_svc' => $part_svc, #usual
87 # 'svcdb' => 'svc_table',
89 # 'query' => #optional query string
90 # # (pass a blank string if you want a "raw" URL to add your
93 # 'svc' => $svc_x, #or $cust_svc, it just needs a svcnum
98 # 'ahref' => 1, # if set true, returns <A HREF="$url">
100 use FS::CGI qw(rooturl);
104 #? return '' unless ref($opt{part_svc});
106 my $svcdb = $opt{svcdb} || $opt{part_svc}->svcdb;
107 my $query = exists($opt{query}) ? $opt{query} : $opt{svc}->svcnum;
109 warn "$me [svc_url] checking for /$opt{action}/$svcdb.cgi component"
111 if ( $opt{m}->interp->comp_exists("/$opt{action}/$svcdb.cgi") ) {
112 $url = "$svcdb.cgi?";
115 my $generic = $opt{action} eq 'search' ? 'cust_svc' : 'svc_Common';
117 $url = "$generic.html?svcdb=$svcdb;";
118 $url .= 'svcnum=' if $query =~ /^\d+(;|$)/ or $query eq '';
121 import FS::CGI 'rooturl'; #WTF! why is this necessary
122 my $return = rooturl(). "$opt{action}/$url$query";
124 $return = qq!<A HREF="$return">! if $opt{ahref};
130 my($m, $part_svc, $cust_svc) = @_ or return '';
131 svc_X_link( $part_svc->svc, @_ );
135 my($m, $part_svc, $cust_svc) = @_ or return '';
136 svc_X_link( ($cust_svc->label)[1], @_ );
140 my ($x, $m, $part_svc, $cust_svc) = @_ or return '';
145 'part_svc' => $part_svc,
153 my($cgi, $field) = @_;
162 foreach my $op (keys %op) {
164 warn "checking for ${field}_$op field\n"
167 if ( $cgi->param($field."_$op") =~ /^\s*\$?\s*([\d\,\s]+(\.\d\d)?)\s*$/ ) {
170 $num =~ s/[\,\s]+//g;
171 my $search = "$field $op{$op} $num";
172 push @search, $search;
174 warn "found ${field}_$op field; adding search element $search\n"
184 sub bytecount_unexact {
188 return(sprintf("%.2f Kbytes", $bc/1000))
190 return(sprintf("%.2f Mbytes", $bc/1000000))
191 if ($bc < 1000000000);
192 return(sprintf("%.2f Gbytes", $bc/1000000000));
195 sub parse_bytecount {
197 return $bc if (($bc =~ tr/.//) > 1);
198 $bc =~ /^\s*([\d.]*)\s*([kKmMgGtT]?)[bB]?\s*$/ or return $bc;
200 return $bc unless length $base;
201 my $exponent = index ' kmgt', lc($2);
202 return $bc if ($exponent < 0 && $2);
203 $exponent = 0 if ($exponent < 0);
204 return $base * 1024 ** $exponent;
207 sub display_bytecount {
209 return $bc unless ($bc =~ /^(\d+)$/);
210 my $conf = new FS::Conf;
211 my $f = new Number::Format;
212 my $precision = $conf->exists('datavolume-significantdigits')
213 ? $conf->config('datavolume-significantdigits')
215 my $unit = $conf->exists('datavolume-forcemegabytes') ? 'M' : 'A';
217 return $f->format_bytes($bc, precision => $precision, unit => $unit);
221 # cust_main report subroutines
225 =item cust_header [ CUST_FIELDS_VALUE ]
227 Returns an array of customer information headers according to the supplied
228 customer fields value, or if no value is supplied, the B<cust-fields>
233 use vars qw( @cust_fields @cust_colors @cust_styles @cust_aligns );
237 warn "FS::UI:Web::cust_header called"
240 my %header2method = (
241 'Customer' => 'name',
242 'Cust. Status' => 'ucfirst_cust_status',
243 'Cust#' => 'custnum',
245 'Company' => 'company',
246 '(bill) Customer' => 'name',
247 '(service) Customer' => 'ship_name',
248 '(bill) Name' => 'contact',
249 '(service) Name' => 'ship_contact',
250 '(bill) Company' => 'company',
251 '(service) Company' => 'ship_company',
252 'Address 1' => 'address1',
253 'Address 2' => 'address2',
257 'Country' => 'country_full',
258 'Day phone' => 'daytime', # XXX should use msgcat, but how?
259 'Night phone' => 'night', # XXX should use msgcat, but how?
260 'Invoicing email(s)' => 'invoicing_list_emailonly_scalar',
263 my %header2colormethod = (
264 'Cust. Status' => 'cust_statuscolor',
267 'Cust. Status' => 'b',
270 'Cust. Status' => 'c',
277 warn " using supplied cust-fields override".
278 " (ignoring cust-fields config file)"
280 $cust_fields = shift;
284 my $conf = new FS::Conf;
285 if ( $conf->exists('cust-fields')
286 && $conf->config('cust-fields') =~ /^([\w\. \|\#\(\)]+):?/
289 warn " found cust-fields configuration value"
293 warn " no cust-fields configuration value found; using default 'Cust. Status | Customer'"
295 $cust_fields = 'Cust. Status | Customer';
300 @cust_header = split(/ \| /, $cust_fields);
301 @cust_fields = map { $header2method{$_} } @cust_header;
302 @cust_colors = map { exists $header2colormethod{$_}
303 ? $header2colormethod{$_}
307 @cust_styles = map { exists $header2style{$_} ? $header2style{$_} : '' }
309 @cust_aligns = map { exists $header2align{$_} ? $header2align{$_} : 'l' }
316 =item cust_sql_fields [ CUST_FIELDS_VALUE ]
318 Returns a list of fields for the SELECT portion of an SQL query.
320 As with L<the cust_header subroutine|/cust_header>, the fields returned are
321 defined by the supplied customer fields setting, or if no customer fields
322 setting is supplied, the <B>cust-fields</B> configuration value.
326 sub cust_sql_fields {
328 my @fields = qw( last first company );
329 push @fields, map "ship_$_", @fields;
330 push @fields, 'country';
333 #inefficientish, but tiny lists and only run once per page
335 grep { my $field = $_; grep { $_ eq $field } @cust_fields }
336 qw( address1 address2 city state zip daytime night );
338 map "cust_main.$_", @fields;
341 =item cust_fields OBJECT [ CUST_FIELDS_VALUE ]
343 Given an object that contains fields from cust_main (say, from a
344 JOINed search. See httemplate/search/svc_* for examples), returns an array
345 of customer information, or "(unlinked)" if this service is not linked to a
348 As with L<the cust_header subroutine|/cust_header>, the fields returned are
349 defined by the supplied customer fields setting, or if no customer fields
350 setting is supplied, the <B>cust-fields</B> configuration value.
356 warn "FS::UI::Web::cust_fields called for $svc_x ".
357 "(cust_fields: @cust_fields)"
360 #cust_header(@_) unless @cust_fields; #now need to cache to keep cust_fields
361 # #override incase we were passed as a sub
363 my $seen_unlinked = 0;
365 if ( $svc_x->custnum ) {
370 warn " ($svc_x unlinked)"
372 $seen_unlinked++ ? '' : '(unlinked)';
379 Returns an array of subroutine references (or empty strings) for returning
380 customer information colors.
382 As with L<the cust_header subroutine|/cust_header>, the fields returned are
383 defined by the supplied customer fields setting, or if no customer fields
384 setting is supplied, the <B>cust-fields</B> configuration value.
392 sub { shift->$method(@_) };
401 Returns an array of customer information styles.
403 As with L<the cust_header subroutine|/cust_header>, the fields returned are
404 defined by the supplied customer fields setting, or if no customer fields
405 setting is supplied, the <B>cust-fields</B> configuration value.
421 Returns an array or scalar (depending on context) of customer information
424 As with L<the cust_header subroutine|/cust_header>, the fields returned are
425 defined by the supplied customer fields setting, or if no customer fields
426 setting is supplied, the <B>cust-fields</B> configuration value.
434 join('', @cust_aligns);
439 # begin JSRPC code...
442 package FS::UI::Web::JSRPC;
447 use Storable qw(nfreeze);
451 use FS::Record qw(qsearchs);
466 croak "CGI object required as second argument" unless $self->{'cgi'};
475 my $cgi = $self->{'cgi'};
477 # XXX this should parse JSON foo and build a proper data structure
478 my @args = $cgi->param('arg');
480 #work around konqueror bug!
481 @args = map { s/\x00$//; $_; } @args;
483 my $sub = $cgi->param('sub'); #????
485 warn "FS::UI::Web::JSRPC::process:\n".
488 " args=".join(', ',@args)."\n"
491 if ( $sub eq 'start_job' ) {
493 $self->start_job(@args);
495 } elsif ( $sub eq 'job_status' ) {
497 $self->job_status(@args);
501 die "unknown sub $sub";
510 warn "FS::UI::Web::start_job: ". join(', ', @_) if $DEBUG;
514 my( $field, $value ) = splice(@_, 0, 2);
515 unless ( exists( $param{$field} ) ) {
516 $param{$field} = $value;
517 } elsif ( ! ref($param{$field}) ) {
518 $param{$field} = [ $param{$field}, $value ];
520 push @{$param{$field}}, $value;
523 warn "FS::UI::Web::start_job\n".
525 if ( ref($param{$_}) ) {
526 " $_ => [ ". join(', ', @{$param{$_}}). " ]\n";
528 " $_ => $param{$_}\n";
533 #first get the CGI params shipped off to a job ASAP so an id can be returned
536 my $job = new FS::queue { 'job' => $self->{'job'} };
538 #too slow to insert all the cgi params as individual args..,?
539 #my $error = $queue->insert('_JOB', $cgi->Vars);
541 #warn 'froze string of size '. length(nfreeze(\%param)). " for job args\n"
544 my $error = $job->insert( '_JOB', encode_base64(nfreeze(\%param)) );
548 warn "job not inserted: $error\n"
551 $error; #this doesn't seem to be handled well,
552 # will trigger "illegal jobnum" below?
553 # (should never be an error inserting the job, though, only thing
554 # would be Pg f%*kage)
557 warn "job inserted successfully with jobnum ". $job->jobnum. "\n"
566 my( $self, $jobnum ) = @_; #$url ???
568 sleep 1; # XXX could use something better...
571 if ( $jobnum =~ /^(\d+)$/ ) {
572 $job = qsearchs('queue', { 'jobnum' => $jobnum } );
574 die "FS::UI::Web::job_status: illegal jobnum $jobnum\n";
578 if ( $job && $job->status ne 'failed' ) {
579 @return = ( 'progress', $job->statustext );
580 } elsif ( !$job ) { #handle job gone case : job successful
581 # so close popup, redirect parent window...
582 @return = ( 'complete' );
584 @return = ( 'error', $job ? $job->statustext : $jobnum );