4 use vars qw($DEBUG @ISA @EXPORT_OK $me);
6 use Carp qw( confess );
9 use FS::Misc::DateTime qw( parse_datetime day_end );
10 use FS::Record qw(dbdef);
11 use FS::cust_main; # are sql_balance and sql_date_balance in the right module?
16 @ISA = qw( Exporter );
18 @EXPORT_OK = qw( svc_url );
21 $me = '[FS::UID::Web]';
28 sub parse_beginning_ending {
29 my($cgi, $prefix) = @_;
30 $prefix .= '_' if $prefix;
33 if ( $cgi->param($prefix.'begin') =~ /^(\d+)$/ ) {
35 } elsif ( $cgi->param($prefix.'beginning') =~ /^([ 0-9\-\/\:]{1,64})$/ ) {
36 $beginning = parse_datetime($1) || 0;
39 my $ending = 4294967295; #2^32-1
40 if ( $cgi->param($prefix.'end') =~ /^(\d+)$/ ) {
42 } elsif ( $cgi->param($prefix.'ending') =~ /^([ 0-9\-\/\:]{1,64})$/ ) {
43 $ending = parse_datetime($1);
44 $ending = day_end($ending) unless $ending =~ /:/;
47 ( $beginning, $ending );
52 Returns a service URL, first checking to see if there is a service-specific
53 page to link to, otherwise to a generic service handling page. Options are
54 passed as a list of name-value pairs, and include:
58 =item * m - Mason request object ($m)
60 =item * action - The action for which to construct "edit", "view", or "search"
62 =item ** part_svc - Service definition (see L<FS::part_svc>)
64 =item ** svcdb - Service table
66 =item *** query - Query string
68 =item *** svc - FS::cust_svc or FS::svc_* object
70 =item ahref - Optional flag, if set true returns <A HREF="$url"> instead of just the URL.
76 ** part_svc OR svcdb is required
78 *** query OR svc is required
85 # 'm' => $m, #mason request object
86 # 'action' => 'edit', #or 'view'
88 # 'part_svc' => $part_svc, #usual
90 # 'svcdb' => 'svc_table',
92 # 'query' => #optional query string
93 # # (pass a blank string if you want a "raw" URL to add your
96 # 'svc' => $svc_x, #or $cust_svc, it just needs a svcnum
101 # 'ahref' => 1, # if set true, returns <A HREF="$url">
103 use FS::CGI qw(rooturl);
107 #? return '' unless ref($opt{part_svc});
109 my $svcdb = $opt{svcdb} || $opt{part_svc}->svcdb;
110 my $query = exists($opt{query}) ? $opt{query} : $opt{svc}->svcnum;
112 warn "$me [svc_url] checking for /$opt{action}/$svcdb.cgi component"
114 if ( $opt{m}->interp->comp_exists("/$opt{action}/$svcdb.cgi") ) {
115 $url = "$svcdb.cgi?";
116 } elsif ( $opt{m}->interp->comp_exists("/$opt{action}/$svcdb.html") ) {
117 $url = "$svcdb.html?";
119 my $generic = $opt{action} eq 'search' ? 'cust_svc' : 'svc_Common';
121 $url = "$generic.html?svcdb=$svcdb;";
122 $url .= 'svcnum=' if $query =~ /^\d+(;|$)/ or $query eq '';
125 my $return = FS::CGI::rooturl(). "$opt{action}/$url$query";
127 $return = qq!<A HREF="$return">! if $opt{ahref};
133 my($m, $part_svc, $cust_svc) = @_ or return '';
134 svc_X_link( $part_svc->svc, @_ );
138 my($m, $part_svc, $cust_svc) = @_ or return '';
139 my($svc, $label, $svcdb) = $cust_svc->label;
140 svc_X_link( $label, @_ );
144 my ($x, $m, $part_svc, $cust_svc) = @_ or return '';
147 unless $FS::CurrentUser::CurrentUser->access_right('View customer services');
149 confess "svc_X_link called without a service ($x, $m, $part_svc, $cust_svc)\n"
156 'part_svc' => $part_svc,
163 #this probably needs an ACL too...
164 sub svc_export_links {
165 my ($m, $part_svc, $cust_svc) = @_ or return '';
167 my $ahref = $cust_svc->export_links;
173 my($cgi, $field) = (shift, shift);
174 my $table = ( @_ && length($_[0]) ) ? shift.'.' : '';
183 foreach my $op (keys %op) {
185 warn "checking for ${field}_$op field\n"
188 if ( $cgi->param($field."_$op") =~ /^\s*\$?\s*(-?[\d\,\s]+(\.\d\d)?)\s*$/ ) {
191 $num =~ s/[\,\s]+//g;
192 my $search = "$table$field $op{$op} $num";
193 push @search, $search;
195 warn "found ${field}_$op field; adding search element $search\n"
206 # cust_main report subroutines
210 =item cust_header [ CUST_FIELDS_VALUE ]
212 Returns an array of customer information headers according to the supplied
213 customer fields value, or if no value is supplied, the B<cust-fields>
218 use vars qw( @cust_fields @cust_colors @cust_styles @cust_aligns );
222 warn "FS::UI:Web::cust_header called"
225 my $conf = new FS::Conf;
227 my %header2method = (
228 'Customer' => 'name',
229 'Cust. Status' => 'ucfirst_cust_status',
230 'Cust#' => 'custnum',
232 'Company' => 'company',
234 # obsolete but might still be referenced in configuration
235 '(bill) Customer' => 'name',
236 '(service) Customer' => 'ship_name',
237 '(bill) Name' => 'contact',
238 '(service) Name' => 'ship_contact',
239 '(bill) Company' => 'company',
240 '(service) Company' => 'ship_company',
241 '(bill) Day phone' => 'daytime',
242 '(bill) Night phone' => 'night',
243 '(bill) Fax number' => 'fax',
245 'Customer' => 'name',
246 'Address 1' => 'bill_address1',
247 'Address 2' => 'bill_address2',
248 'City' => 'bill_city',
249 'State' => 'bill_state',
251 'Country' => 'bill_country_full',
252 'Day phone' => 'daytime', # XXX should use msgcat, but how?
253 'Night phone' => 'night', # XXX should use msgcat, but how?
254 'Mobile phone' => 'mobile', # XXX should use msgcat, but how?
255 'Fax number' => 'fax',
256 '(bill) Address 1' => 'bill_address1',
257 '(bill) Address 2' => 'bill_address2',
258 '(bill) City' => 'bill_city',
259 '(bill) State' => 'bill_state',
260 '(bill) Zip' => 'bill_zip',
261 '(bill) Country' => 'bill_country_full',
262 '(service) Address 1' => 'ship_address1',
263 '(service) Address 2' => 'ship_address2',
264 '(service) City' => 'ship_city',
265 '(service) State' => 'ship_state',
266 '(service) Zip' => 'ship_zip',
267 '(service) Country' => 'ship_country_full',
268 'Invoicing email(s)' => 'invoicing_list_emailonly_scalar',
269 'Payment Type' => 'payby',
270 'Current Balance' => 'current_balance',
272 $header2method{'Cust#'} = 'display_custnum'
273 if $conf->exists('cust_main-default_agent_custid');
275 my %header2colormethod = (
276 'Cust. Status' => 'cust_statuscolor',
279 'Cust. Status' => 'b',
282 'Cust. Status' => 'c',
290 warn " using supplied cust-fields override".
291 " (ignoring cust-fields config file)"
293 $cust_fields = shift;
297 if ( $conf->exists('cust-fields')
298 && $conf->config('cust-fields') =~ /^([\w\. \|\#\(\)]+):?/
301 warn " found cust-fields configuration value"
305 warn " no cust-fields configuration value found; using default 'Cust. Status | Customer'"
307 $cust_fields = 'Cust. Status | Customer';
312 @cust_header = split(/ \| /, $cust_fields);
313 @cust_fields = map { $header2method{$_} || $_ } @cust_header;
314 @cust_colors = map { exists $header2colormethod{$_}
315 ? $header2colormethod{$_}
319 @cust_styles = map { exists $header2style{$_} ? $header2style{$_} : '' }
321 @cust_aligns = map { exists $header2align{$_} ? $header2align{$_} : 'l' }
328 sub cust_sort_fields {
329 cust_header(@_) if( @_ or !@cust_fields );
330 #inefficientish, but tiny lists and only run once per page
332 map { $_ eq 'custnum' ? 'custnum' : '' } @cust_fields;
336 =item cust_sql_fields [ CUST_FIELDS_VALUE ]
338 Returns a list of fields for the SELECT portion of an SQL query.
340 As with L<the cust_header subroutine|/cust_header>, the fields returned are
341 defined by the supplied customer fields setting, or if no customer fields
342 setting is supplied, the <B>cust-fields</B> configuration value.
346 sub cust_sql_fields {
348 my @fields = qw( last first company );
349 # push @fields, map "ship_$_", @fields;
351 cust_header(@_) if( @_ or !@cust_fields );
352 #inefficientish, but tiny lists and only run once per page
355 foreach my $field (qw( address1 address2 city state zip )) {
356 foreach my $pre ('bill_','ship_') {
357 if ( grep { $_ eq $pre.$field } @cust_fields ) {
358 push @location_fields, $pre.'location.'.$field.' AS '.$pre.$field;
362 foreach my $pre ('bill_','ship_') {
363 if ( grep { $_ eq $pre.'country_full' } @cust_fields ) {
364 push @location_fields, $pre.'locationnum';
368 foreach my $field (qw(daytime night mobile fax payby)) {
369 push @fields, $field if (grep { $_ eq $field } @cust_fields);
371 push @fields, 'agent_custid';
373 my @extra_fields = ();
374 if (grep { $_ eq 'current_balance' } @cust_fields) {
375 push @extra_fields, FS::cust_main->balance_sql . " AS current_balance";
378 map("cust_main.$_", @fields), @location_fields, @extra_fields;
381 =item join_cust_main [ TABLE[.CUSTNUM] ] [ LOCATION_TABLE[.LOCATIONNUM] ]
383 Returns an SQL join phrase for the FROM clause so that the fields listed
384 in L<cust_sql_fields> will be available. Currently joins to cust_main
385 itself, as well as cust_location (under the aliases 'bill_location' and
386 'ship_location') if address fields are needed. L<cust_header()> should have
389 All of these will be left joins; if you want to exclude rows with no linked
390 cust_main record (or bill_location/ship_location), you can do so in the
393 TABLE is the table containing the custnum field. If CUSTNUM (a field name
394 in that table) is specified, that field will be joined to cust_main.custnum.
395 Otherwise, this function will assume the field is named "custnum". If the
396 argument isn't present at all, the join will just say "USING (custnum)",
399 As a special case, if TABLE is 'cust_main', only the joins to cust_location
402 LOCATION_TABLE is an optional table name to use for joining ship_location,
403 in case your query also includes package information and you want the
404 "service address" columns to reflect package addresses.
409 my ($cust_table, $location_table) = @_;
410 my ($custnum, $locationnum);
411 ($cust_table, $custnum) = split(/\./, $cust_table);
412 $custnum ||= 'custnum';
413 ($location_table, $locationnum) = split(/\./, $location_table);
414 $locationnum ||= 'locationnum';
418 $sql = " LEFT JOIN cust_main ON (cust_main.custnum = $cust_table.$custnum)"
419 unless $cust_table eq 'cust_main';
421 $sql = " LEFT JOIN cust_main USING (custnum)";
424 if ( !@cust_fields or grep /^bill_/, @cust_fields ) {
426 $sql .= ' LEFT JOIN cust_location bill_location'.
427 ' ON (bill_location.locationnum = cust_main.bill_locationnum)';
431 if ( !@cust_fields or grep /^ship_/, @cust_fields ) {
433 if (!$location_table) {
434 $location_table = 'cust_main';
435 $locationnum = 'ship_locationnum';
438 $sql .= ' LEFT JOIN cust_location ship_location'.
439 " ON (ship_location.locationnum = $location_table.$locationnum) ";
445 =item cust_fields OBJECT [ CUST_FIELDS_VALUE ]
447 Given an object that contains fields from cust_main (say, from a
448 JOINed search. See httemplate/search/svc_* for examples), returns an array
449 of customer information, or "(unlinked)" if this service is not linked to a
452 As with L<the cust_header subroutine|/cust_header>, the fields returned are
453 defined by the supplied customer fields setting, or if no customer fields
454 setting is supplied, the <B>cust-fields</B> configuration value.
461 warn "FS::UI::Web::cust_fields called for $record ".
462 "(cust_fields: @cust_fields)"
465 #cust_header(@_) unless @cust_fields; #now need to cache to keep cust_fields
466 # #override incase we were passed as a sub
468 my $seen_unlinked = 0;
471 if ( $record->custnum ) {
472 warn " $record -> $_" if $DEBUG > 1;
473 encode_entities( $record->$_(@_) );
475 warn " ($record unlinked)" if $DEBUG > 1;
476 $seen_unlinked++ ? '' : '(unlinked)';
481 =item cust_fields_subs
483 Returns an array of subroutine references for returning customer field values.
484 This is similar to cust_fields, but returns each field's sub as a distinct
489 sub cust_fields_subs {
490 my $unlinked_warn = 0;
494 if ( $unlinked_warn++ ) {
498 if ( $record->custnum ) {
499 encode_entities( $record->$f(@_) );
509 $record->custnum ? encode_entities( $record->$f(@_) ) : '';
519 Returns an array of subroutine references (or empty strings) for returning
520 customer information colors.
522 As with L<the cust_header subroutine|/cust_header>, the fields returned are
523 defined by the supplied customer fields setting, or if no customer fields
524 setting is supplied, the <B>cust-fields</B> configuration value.
532 sub { shift->$method(@_) };
541 Returns an array of customer information styles.
543 As with L<the cust_header subroutine|/cust_header>, the fields returned are
544 defined by the supplied customer fields setting, or if no customer fields
545 setting is supplied, the <B>cust-fields</B> configuration value.
561 Returns an array or scalar (depending on context) of customer information
564 As with L<the cust_header subroutine|/cust_header>, the fields returned are
565 defined by the supplied customer fields setting, or if no customer fields
566 setting is supplied, the <B>cust-fields</B> configuration value.
574 join('', @cust_aligns);
580 Returns an array of links to view/cust_main.cgi, for use with cust_fields.
585 my $link = [ FS::CGI::rooturl().'view/cust_main.cgi?', 'custnum' ];
587 return map { $_ eq 'cust_status_label' ? '' : $link }
593 Utility function to determine if the client is a mobile browser.
598 my $ua = $ENV{'HTTP_USER_AGENT'} || '';
599 if ( $ua =~ /(?:hiptop|Blazer|Novarra|Vagabond|SonyEricsson|Symbian|NetFront|UP.Browser|UP.Link|Windows CE|MIDP|J2ME|DoCoMo|J-PHONE|PalmOS|PalmSource|iPhone|iPod|AvantGo|Nokia|Android|WebOS|S60|Opera Mini|Opera Mobi)/io ) {
606 # begin JSRPC code...
609 package FS::UI::Web::JSRPC;
614 use Storable qw(nfreeze);
617 use FS::UID qw(getotaker);
618 use FS::Record qw(qsearchs);
620 use FS::CGI qw(rooturl);
634 croak "CGI object required as second argument" unless $self->{'cgi'};
643 my $cgi = $self->{'cgi'};
645 # XXX this should parse JSON foo and build a proper data structure
646 my @args = $cgi->param('arg');
648 #work around konqueror bug!
649 @args = map { s/\x00$//; $_; } @args;
651 my $sub = $cgi->param('sub'); #????
653 warn "FS::UI::Web::JSRPC::process:\n".
656 " args=".join(', ',@args)."\n"
659 if ( $sub eq 'start_job' ) {
661 $self->start_job(@args);
663 } elsif ( $sub eq 'job_status' ) {
665 $self->job_status(@args);
669 die "unknown sub $sub";
678 warn "FS::UI::Web::start_job: ". join(', ', @_) if $DEBUG;
682 my( $field, $value ) = splice(@_, 0, 2);
683 unless ( exists( $param{$field} ) ) {
684 $param{$field} = $value;
685 } elsif ( ! ref($param{$field}) ) {
686 $param{$field} = [ $param{$field}, $value ];
688 push @{$param{$field}}, $value;
691 $param{CurrentUser} = getotaker();
692 $param{RootURL} = rooturl($self->{cgi}->self_url);
693 warn "FS::UI::Web::start_job\n".
695 if ( ref($param{$_}) ) {
696 " $_ => [ ". join(', ', @{$param{$_}}). " ]\n";
698 " $_ => $param{$_}\n";
703 #first get the CGI params shipped off to a job ASAP so an id can be returned
706 my $job = new FS::queue { 'job' => $self->{'job'} };
708 #too slow to insert all the cgi params as individual args..,?
709 #my $error = $queue->insert('_JOB', $cgi->Vars);
711 #warn 'froze string of size '. length(nfreeze(\%param)). " for job args\n"
714 # XXX FS::queue::insert knows how to do this.
715 # not changing it here because that requires changing it everywhere else,
716 # too, but we should eventually fix it
718 my $error = $job->insert( '_JOB', encode_base64(nfreeze(\%param)) );
722 warn "job not inserted: $error\n"
725 $error; #this doesn't seem to be handled well,
726 # will trigger "illegal jobnum" below?
727 # (should never be an error inserting the job, though, only thing
728 # would be Pg f%*kage)
731 warn "job inserted successfully with jobnum ". $job->jobnum. "\n"
740 my( $self, $jobnum ) = @_; #$url ???
742 sleep 1; # XXX could use something better...
745 if ( $jobnum =~ /^(\d+)$/ ) {
746 $job = qsearchs('queue', { 'jobnum' => $jobnum } );
748 die "FS::UI::Web::job_status: illegal jobnum $jobnum\n";
752 if ( $job && $job->status ne 'failed' && $job->status ne 'done' ) {
753 my ($progress, $action) = split ',', $job->statustext, 2;
754 $action ||= 'Server processing job';
755 @return = ( 'progress', $progress, $action );
756 } elsif ( !$job ) { #handle job gone case : job successful
757 # so close popup, redirect parent window...
758 @return = ( 'complete' );
759 } elsif ( $job->status eq 'done' ) {
760 @return = ( 'done', $job->statustext, '' );
762 @return = ( 'error', $job ? $job->statustext : $jobnum );
765 encode_json \@return;