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?";
118 my $generic = $opt{action} eq 'search' ? 'cust_svc' : 'svc_Common';
120 $url = "$generic.html?svcdb=$svcdb;";
121 $url .= 'svcnum=' if $query =~ /^\d+(;|$)/ or $query eq '';
124 import FS::CGI 'rooturl'; #WTF! why is this necessary
125 my $return = 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) = @_;
182 foreach my $op (keys %op) {
184 warn "checking for ${field}_$op field\n"
187 if ( $cgi->param($field."_$op") =~ /^\s*\$?\s*(-?[\d\,\s]+(\.\d\d)?)\s*$/ ) {
190 $num =~ s/[\,\s]+//g;
191 my $search = "$field $op{$op} $num";
192 push @search, $search;
194 warn "found ${field}_$op field; adding search element $search\n"
205 # cust_main report subroutines
209 =item cust_header [ CUST_FIELDS_VALUE ]
211 Returns an array of customer information headers according to the supplied
212 customer fields value, or if no value is supplied, the B<cust-fields>
217 use vars qw( @cust_fields @cust_colors @cust_styles @cust_aligns );
221 warn "FS::UI:Web::cust_header called"
224 my $conf = new FS::Conf;
226 my %header2method = (
227 'Customer' => 'name',
228 'Cust. Status' => 'ucfirst_cust_status',
229 'Cust#' => 'custnum',
231 'Company' => 'company',
232 '(bill) Customer' => 'name',
233 '(service) Customer' => 'ship_name',
234 '(bill) Name' => 'contact',
235 '(service) Name' => 'ship_contact',
236 '(bill) Company' => 'company',
237 '(service) Company' => 'ship_company',
238 'Address 1' => 'bill_address1',
239 'Address 2' => 'bill_address2',
240 'City' => 'bill_city',
241 'State' => 'bill_state',
243 'Country' => 'country_full',
244 'Day phone' => 'daytime', # XXX should use msgcat, but how?
245 'Night phone' => 'night', # XXX should use msgcat, but how?
246 'Fax number' => 'fax',
247 '(bill) Address 1' => 'bill_address1',
248 '(bill) Address 2' => 'bill_address2',
249 '(bill) City' => 'bill_city',
250 '(bill) State' => 'bill_state',
251 '(bill) Zip' => 'bill_zip',
252 '(bill) Country' => 'country_full',
253 '(bill) Day phone' => 'daytime', # XXX should use msgcat, but how?
254 '(bill) Night phone' => 'night', # XXX should use msgcat, but how?
255 '(bill) Fax number' => 'fax',
256 '(service) Address 1' => 'ship_address1',
257 '(service) Address 2' => 'ship_address2',
258 '(service) City' => 'ship_city',
259 '(service) State' => 'ship_state',
260 '(service) Zip' => 'ship_zip',
261 '(service) Country' => 'ship_country_full',
262 '(service) Day phone' => 'ship_daytime', # XXX should use msgcat, how?
263 '(service) Night phone' => 'ship_night', # XXX should use msgcat, how?
264 '(service) Fax number' => 'ship_fax',
265 'Invoicing email(s)' => 'invoicing_list_emailonly_scalar',
266 'Payment Type' => 'payby',
267 'Current Balance' => 'current_balance',
269 $header2method{'Cust#'} = 'display_custnum'
270 if $conf->exists('cust_main-default_agent_custid');
272 my %header2colormethod = (
273 'Cust. Status' => 'cust_statuscolor',
276 'Cust. Status' => 'b',
279 'Cust. Status' => 'c',
287 warn " using supplied cust-fields override".
288 " (ignoring cust-fields config file)"
290 $cust_fields = shift;
294 if ( $conf->exists('cust-fields')
295 && $conf->config('cust-fields') =~ /^([\w\. \|\#\(\)]+):?/
298 warn " found cust-fields configuration value"
302 warn " no cust-fields configuration value found; using default 'Cust. Status | Customer'"
304 $cust_fields = 'Cust. Status | Customer';
309 @cust_header = split(/ \| /, $cust_fields);
310 @cust_fields = map { $header2method{$_} || $_ } @cust_header;
311 @cust_colors = map { exists $header2colormethod{$_}
312 ? $header2colormethod{$_}
316 @cust_styles = map { exists $header2style{$_} ? $header2style{$_} : '' }
318 @cust_aligns = map { exists $header2align{$_} ? $header2align{$_} : 'l' }
325 =item cust_sql_fields [ CUST_FIELDS_VALUE ]
327 Returns a list of fields for the SELECT portion of an SQL query.
329 As with L<the cust_header subroutine|/cust_header>, the fields returned are
330 defined by the supplied customer fields setting, or if no customer fields
331 setting is supplied, the <B>cust-fields</B> configuration value.
335 sub cust_sql_fields {
337 my @fields = qw( last first company );
338 # push @fields, map "ship_$_", @fields;
341 #inefficientish, but tiny lists and only run once per page
344 foreach my $field (qw( address1 address2 city state zip )) {
345 foreach my $pre ('bill_','ship_') {
346 if ( grep { $_ eq $pre.$field } @cust_fields ) {
347 push @location_fields, $pre.'location.'.$field.' AS '.$pre.$field;
352 push @fields, 'payby' if grep { $_ eq 'payby'} @cust_fields;
353 push @fields, 'agent_custid';
355 my @extra_fields = ();
356 if (grep { $_ eq 'current_balance' } @cust_fields) {
357 push @extra_fields, FS::cust_main->balance_sql . " AS current_balance";
360 map("cust_main.$_", @fields), @location_fields, @extra_fields;
363 =item join_cust_main [ TABLE[.CUSTNUM] ] [ LOCATION_TABLE[.LOCATIONNUM] ]
365 Returns an SQL join phrase for the FROM clause so that the fields listed
366 in L<cust_sql_fields> will be available. Currently joins to cust_main
367 itself, as well as cust_location (under the aliases 'bill_location' and
368 'ship_location') if address fields are needed. L<cust_header()> should have
371 All of these will be left joins; if you want to exclude rows with no linked
372 cust_main record (or bill_location/ship_location), you can do so in the
375 TABLE is the table containing the custnum field. If CUSTNUM (a field name
376 in that table) is specified, that field will be joined to cust_main.custnum.
377 Otherwise, this function will assume the field is named "custnum". If the
378 argument isn't present at all, the join will just say "USING (custnum)",
381 As a special case, if TABLE is 'cust_main', only the joins to cust_location
384 LOCATION_TABLE is an optional table name to use for joining ship_location,
385 in case your query also includes package information and you want the
386 "service address" columns to reflect package addresses.
391 my ($cust_table, $location_table) = @_;
392 my ($custnum, $locationnum);
393 ($cust_table, $custnum) = split(/\./, $cust_table);
394 $custnum ||= 'custnum';
395 ($location_table, $locationnum) = split(/\./, $location_table);
396 $locationnum ||= 'locationnum';
400 $sql = " LEFT JOIN cust_main ON (cust_main.custnum = $cust_table.$custnum)"
401 unless $cust_table eq 'cust_main';
403 $sql = " LEFT JOIN cust_main USING (custnum)";
406 if ( !@cust_fields or grep /^bill_/, @cust_fields ) {
408 $sql .= ' LEFT JOIN cust_location bill_location'.
409 ' ON (bill_location.locationnum = cust_main.bill_locationnum)';
413 if ( !@cust_fields or grep /^ship_/, @cust_fields ) {
415 if (!$location_table) {
416 $location_table = 'cust_main';
417 $locationnum = 'ship_locationnum';
420 $sql .= ' LEFT JOIN cust_location ship_location'.
421 " ON (ship_location.locationnum = $location_table.$locationnum) ";
427 =item cust_fields OBJECT [ CUST_FIELDS_VALUE ]
429 Given an object that contains fields from cust_main (say, from a
430 JOINed search. See httemplate/search/svc_* for examples), returns an array
431 of customer information, or "(unlinked)" if this service is not linked to a
434 As with L<the cust_header subroutine|/cust_header>, the fields returned are
435 defined by the supplied customer fields setting, or if no customer fields
436 setting is supplied, the <B>cust-fields</B> configuration value.
443 warn "FS::UI::Web::cust_fields called for $record ".
444 "(cust_fields: @cust_fields)"
447 #cust_header(@_) unless @cust_fields; #now need to cache to keep cust_fields
448 # #override incase we were passed as a sub
450 my $seen_unlinked = 0;
453 if ( $record->custnum ) {
454 warn " $record -> $_" if $DEBUG > 1;
455 encode_entities( $record->$_(@_) );
457 warn " ($record unlinked)" if $DEBUG > 1;
458 $seen_unlinked++ ? '' : '(unlinked)';
463 =item cust_fields_subs
465 Returns an array of subroutine references for returning customer field values.
466 This is similar to cust_fields, but returns each field's sub as a distinct
471 sub cust_fields_subs {
472 my $unlinked_warn = 0;
475 if ( $unlinked_warn++ ) {
479 if ( $record->custnum ) {
480 encode_entities( $record->$f(@_) );
490 $record->custnum ? encode_entities( $record->$f(@_) ) : '';
500 Returns an array of subroutine references (or empty strings) for returning
501 customer information colors.
503 As with L<the cust_header subroutine|/cust_header>, the fields returned are
504 defined by the supplied customer fields setting, or if no customer fields
505 setting is supplied, the <B>cust-fields</B> configuration value.
513 sub { shift->$method(@_) };
522 Returns an array of customer information styles.
524 As with L<the cust_header subroutine|/cust_header>, the fields returned are
525 defined by the supplied customer fields setting, or if no customer fields
526 setting is supplied, the <B>cust-fields</B> configuration value.
542 Returns an array or scalar (depending on context) of customer information
545 As with L<the cust_header subroutine|/cust_header>, the fields returned are
546 defined by the supplied customer fields setting, or if no customer fields
547 setting is supplied, the <B>cust-fields</B> configuration value.
555 join('', @cust_aligns);
561 Utility function to determine if the client is a mobile browser.
566 my $ua = $ENV{'HTTP_USER_AGENT'} || '';
567 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 ) {
574 # begin JSRPC code...
577 package FS::UI::Web::JSRPC;
582 use Storable qw(nfreeze);
586 use FS::Record qw(qsearchs);
588 use FS::CGI qw(rooturl);
602 croak "CGI object required as second argument" unless $self->{'cgi'};
611 my $cgi = $self->{'cgi'};
613 # XXX this should parse JSON foo and build a proper data structure
614 my @args = $cgi->param('arg');
616 #work around konqueror bug!
617 @args = map { s/\x00$//; $_; } @args;
619 my $sub = $cgi->param('sub'); #????
621 warn "FS::UI::Web::JSRPC::process:\n".
624 " args=".join(', ',@args)."\n"
627 if ( $sub eq 'start_job' ) {
629 $self->start_job(@args);
631 } elsif ( $sub eq 'job_status' ) {
633 $self->job_status(@args);
637 die "unknown sub $sub";
646 warn "FS::UI::Web::start_job: ". join(', ', @_) if $DEBUG;
650 my( $field, $value ) = splice(@_, 0, 2);
651 unless ( exists( $param{$field} ) ) {
652 $param{$field} = $value;
653 } elsif ( ! ref($param{$field}) ) {
654 $param{$field} = [ $param{$field}, $value ];
656 push @{$param{$field}}, $value;
659 $param{CurrentUser} = $FS::CurrentUser::CurrentUser->username;
660 $param{RootURL} = rooturl($self->{cgi}->self_url);
661 warn "FS::UI::Web::start_job\n".
663 if ( ref($param{$_}) ) {
664 " $_ => [ ". join(', ', @{$param{$_}}). " ]\n";
666 " $_ => $param{$_}\n";
671 #first get the CGI params shipped off to a job ASAP so an id can be returned
674 my $job = new FS::queue { 'job' => $self->{'job'} };
676 #too slow to insert all the cgi params as individual args..,?
677 #my $error = $queue->insert('_JOB', $cgi->Vars);
679 #warn 'froze string of size '. length(nfreeze(\%param)). " for job args\n"
682 # XXX FS::queue::insert knows how to do this.
683 # not changing it here because that requires changing it everywhere else,
684 # too, but we should eventually fix it
686 my $error = $job->insert( '_JOB', encode_base64(nfreeze(\%param)) );
690 warn "job not inserted: $error\n"
693 $error; #this doesn't seem to be handled well,
694 # will trigger "illegal jobnum" below?
695 # (should never be an error inserting the job, though, only thing
696 # would be Pg f%*kage)
699 warn "job inserted successfully with jobnum ". $job->jobnum. "\n"
708 my( $self, $jobnum ) = @_; #$url ???
710 sleep 1; # XXX could use something better...
713 if ( $jobnum =~ /^(\d+)$/ ) {
714 $job = qsearchs('queue', { 'jobnum' => $jobnum } );
716 die "FS::UI::Web::job_status: illegal jobnum $jobnum\n";
720 if ( $job && $job->status ne 'failed' && $job->status ne 'done' ) {
721 my ($progress, $action) = split ',', $job->statustext, 2;
722 $action ||= 'Server processing job';
723 @return = ( 'progress', $progress, $action );
724 } elsif ( !$job ) { #handle job gone case : job successful
725 # so close popup, redirect parent window...
726 @return = ( 'complete' );
727 } elsif ( $job->status eq 'done' ) {
728 @return = ( 'done', $job->statustext, '' );
730 @return = ( 'error', $job ? $job->statustext : $jobnum );
733 encode_json \@return;