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',
233 # obsolete but might still be referenced in configuration
234 '(bill) Customer' => 'name',
235 '(service) Customer' => 'ship_name',
236 '(bill) Name' => 'contact',
237 '(service) Name' => 'ship_contact',
238 '(bill) Company' => 'company',
239 '(service) Company' => 'ship_company',
240 '(bill) Day phone' => 'daytime',
241 '(bill) Night phone' => 'night',
242 '(bill) Fax number' => 'fax',
244 'Customer' => 'name',
245 'Address 1' => 'bill_address1',
246 'Address 2' => 'bill_address2',
247 'City' => 'bill_city',
248 'State' => 'bill_state',
250 'Country' => 'bill_country_full',
251 'Day phone' => 'daytime', # XXX should use msgcat, but how?
252 'Night phone' => 'night', # XXX should use msgcat, but how?
253 'Fax number' => 'fax',
254 '(bill) Address 1' => 'bill_address1',
255 '(bill) Address 2' => 'bill_address2',
256 '(bill) City' => 'bill_city',
257 '(bill) State' => 'bill_state',
258 '(bill) Zip' => 'bill_zip',
259 '(bill) Country' => 'bill_country_full',
260 '(service) Address 1' => 'ship_address1',
261 '(service) Address 2' => 'ship_address2',
262 '(service) City' => 'ship_city',
263 '(service) State' => 'ship_state',
264 '(service) Zip' => 'ship_zip',
265 '(service) Country' => 'ship_country_full',
266 'Invoicing email(s)' => 'invoicing_list_emailonly_scalar',
267 'Payment Type' => 'payby',
268 'Current Balance' => 'current_balance',
270 $header2method{'Cust#'} = 'display_custnum'
271 if $conf->exists('cust_main-default_agent_custid');
273 my %header2colormethod = (
274 'Cust. Status' => 'cust_statuscolor',
277 'Cust. Status' => 'b',
280 'Cust. Status' => 'c',
288 warn " using supplied cust-fields override".
289 " (ignoring cust-fields config file)"
291 $cust_fields = shift;
295 if ( $conf->exists('cust-fields')
296 && $conf->config('cust-fields') =~ /^([\w\. \|\#\(\)]+):?/
299 warn " found cust-fields configuration value"
303 warn " no cust-fields configuration value found; using default 'Cust. Status | Customer'"
305 $cust_fields = 'Cust. Status | Customer';
310 @cust_header = split(/ \| /, $cust_fields);
311 @cust_fields = map { $header2method{$_} || $_ } @cust_header;
312 @cust_colors = map { exists $header2colormethod{$_}
313 ? $header2colormethod{$_}
317 @cust_styles = map { exists $header2style{$_} ? $header2style{$_} : '' }
319 @cust_aligns = map { exists $header2align{$_} ? $header2align{$_} : 'l' }
326 =item cust_sql_fields [ CUST_FIELDS_VALUE ]
328 Returns a list of fields for the SELECT portion of an SQL query.
330 As with L<the cust_header subroutine|/cust_header>, the fields returned are
331 defined by the supplied customer fields setting, or if no customer fields
332 setting is supplied, the <B>cust-fields</B> configuration value.
336 sub cust_sql_fields {
338 my @fields = qw( last first company );
339 # push @fields, map "ship_$_", @fields;
342 #inefficientish, but tiny lists and only run once per page
345 foreach my $field (qw( address1 address2 city state zip )) {
346 foreach my $pre ('bill_','ship_') {
347 if ( grep { $_ eq $pre.$field } @cust_fields ) {
348 push @location_fields, $pre.'location.'.$field.' AS '.$pre.$field;
353 foreach my $field (qw(daytime night fax payby)) {
354 push @fields, $field if (grep { $_ eq $field } @cust_fields);
356 push @fields, 'agent_custid';
358 my @extra_fields = ();
359 if (grep { $_ eq 'current_balance' } @cust_fields) {
360 push @extra_fields, FS::cust_main->balance_sql . " AS current_balance";
363 map("cust_main.$_", @fields), @location_fields, @extra_fields;
366 =item join_cust_main [ TABLE[.CUSTNUM] ] [ LOCATION_TABLE[.LOCATIONNUM] ]
368 Returns an SQL join phrase for the FROM clause so that the fields listed
369 in L<cust_sql_fields> will be available. Currently joins to cust_main
370 itself, as well as cust_location (under the aliases 'bill_location' and
371 'ship_location') if address fields are needed. L<cust_header()> should have
374 All of these will be left joins; if you want to exclude rows with no linked
375 cust_main record (or bill_location/ship_location), you can do so in the
378 TABLE is the table containing the custnum field. If CUSTNUM (a field name
379 in that table) is specified, that field will be joined to cust_main.custnum.
380 Otherwise, this function will assume the field is named "custnum". If the
381 argument isn't present at all, the join will just say "USING (custnum)",
384 As a special case, if TABLE is 'cust_main', only the joins to cust_location
387 LOCATION_TABLE is an optional table name to use for joining ship_location,
388 in case your query also includes package information and you want the
389 "service address" columns to reflect package addresses.
394 my ($cust_table, $location_table) = @_;
395 my ($custnum, $locationnum);
396 ($cust_table, $custnum) = split(/\./, $cust_table);
397 $custnum ||= 'custnum';
398 ($location_table, $locationnum) = split(/\./, $location_table);
399 $locationnum ||= 'locationnum';
403 $sql = " LEFT JOIN cust_main ON (cust_main.custnum = $cust_table.$custnum)"
404 unless $cust_table eq 'cust_main';
406 $sql = " LEFT JOIN cust_main USING (custnum)";
409 if ( !@cust_fields or grep /^bill_/, @cust_fields ) {
411 $sql .= ' LEFT JOIN cust_location bill_location'.
412 ' ON (bill_location.locationnum = cust_main.bill_locationnum)';
416 if ( !@cust_fields or grep /^ship_/, @cust_fields ) {
418 if (!$location_table) {
419 $location_table = 'cust_main';
420 $locationnum = 'ship_locationnum';
423 $sql .= ' LEFT JOIN cust_location ship_location'.
424 " ON (ship_location.locationnum = $location_table.$locationnum) ";
430 =item cust_fields OBJECT [ CUST_FIELDS_VALUE ]
432 Given an object that contains fields from cust_main (say, from a
433 JOINed search. See httemplate/search/svc_* for examples), returns an array
434 of customer information, or "(unlinked)" if this service is not linked to a
437 As with L<the cust_header subroutine|/cust_header>, the fields returned are
438 defined by the supplied customer fields setting, or if no customer fields
439 setting is supplied, the <B>cust-fields</B> configuration value.
446 warn "FS::UI::Web::cust_fields called for $record ".
447 "(cust_fields: @cust_fields)"
450 #cust_header(@_) unless @cust_fields; #now need to cache to keep cust_fields
451 # #override incase we were passed as a sub
453 my $seen_unlinked = 0;
456 if ( $record->custnum ) {
457 warn " $record -> $_" if $DEBUG > 1;
458 encode_entities( $record->$_(@_) );
460 warn " ($record unlinked)" if $DEBUG > 1;
461 $seen_unlinked++ ? '' : '(unlinked)';
466 =item cust_fields_subs
468 Returns an array of subroutine references for returning customer field values.
469 This is similar to cust_fields, but returns each field's sub as a distinct
474 sub cust_fields_subs {
475 my $unlinked_warn = 0;
478 if ( $unlinked_warn++ ) {
482 if ( $record->custnum ) {
483 encode_entities( $record->$f(@_) );
493 $record->custnum ? encode_entities( $record->$f(@_) ) : '';
503 Returns an array of subroutine references (or empty strings) for returning
504 customer information colors.
506 As with L<the cust_header subroutine|/cust_header>, the fields returned are
507 defined by the supplied customer fields setting, or if no customer fields
508 setting is supplied, the <B>cust-fields</B> configuration value.
516 sub { shift->$method(@_) };
525 Returns an array of customer information styles.
527 As with L<the cust_header subroutine|/cust_header>, the fields returned are
528 defined by the supplied customer fields setting, or if no customer fields
529 setting is supplied, the <B>cust-fields</B> configuration value.
545 Returns an array or scalar (depending on context) of customer information
548 As with L<the cust_header subroutine|/cust_header>, the fields returned are
549 defined by the supplied customer fields setting, or if no customer fields
550 setting is supplied, the <B>cust-fields</B> configuration value.
558 join('', @cust_aligns);
564 Utility function to determine if the client is a mobile browser.
569 my $ua = $ENV{'HTTP_USER_AGENT'} || '';
570 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 ) {
577 # begin JSRPC code...
580 package FS::UI::Web::JSRPC;
585 use Storable qw(nfreeze);
589 use FS::Record qw(qsearchs);
591 use FS::CGI qw(rooturl);
605 croak "CGI object required as second argument" unless $self->{'cgi'};
614 my $cgi = $self->{'cgi'};
616 # XXX this should parse JSON foo and build a proper data structure
617 my @args = $cgi->param('arg');
619 #work around konqueror bug!
620 @args = map { s/\x00$//; $_; } @args;
622 my $sub = $cgi->param('sub'); #????
624 warn "FS::UI::Web::JSRPC::process:\n".
627 " args=".join(', ',@args)."\n"
630 if ( $sub eq 'start_job' ) {
632 $self->start_job(@args);
634 } elsif ( $sub eq 'job_status' ) {
636 $self->job_status(@args);
640 die "unknown sub $sub";
649 warn "FS::UI::Web::start_job: ". join(', ', @_) if $DEBUG;
653 my( $field, $value ) = splice(@_, 0, 2);
654 unless ( exists( $param{$field} ) ) {
655 $param{$field} = $value;
656 } elsif ( ! ref($param{$field}) ) {
657 $param{$field} = [ $param{$field}, $value ];
659 push @{$param{$field}}, $value;
662 $param{CurrentUser} = $FS::CurrentUser::CurrentUser->username;
663 $param{RootURL} = rooturl($self->{cgi}->self_url);
664 warn "FS::UI::Web::start_job\n".
666 if ( ref($param{$_}) ) {
667 " $_ => [ ". join(', ', @{$param{$_}}). " ]\n";
669 " $_ => $param{$_}\n";
674 #first get the CGI params shipped off to a job ASAP so an id can be returned
677 my $job = new FS::queue { 'job' => $self->{'job'} };
679 #too slow to insert all the cgi params as individual args..,?
680 #my $error = $queue->insert('_JOB', $cgi->Vars);
682 #warn 'froze string of size '. length(nfreeze(\%param)). " for job args\n"
685 # XXX FS::queue::insert knows how to do this.
686 # not changing it here because that requires changing it everywhere else,
687 # too, but we should eventually fix it
689 my $error = $job->insert( '_JOB', encode_base64(nfreeze(\%param)) );
693 warn "job not inserted: $error\n"
696 $error; #this doesn't seem to be handled well,
697 # will trigger "illegal jobnum" below?
698 # (should never be an error inserting the job, though, only thing
699 # would be Pg f%*kage)
702 warn "job inserted successfully with jobnum ". $job->jobnum. "\n"
711 my( $self, $jobnum ) = @_; #$url ???
713 sleep 1; # XXX could use something better...
716 if ( $jobnum =~ /^(\d+)$/ ) {
717 $job = qsearchs('queue', { 'jobnum' => $jobnum } );
719 die "FS::UI::Web::job_status: illegal jobnum $jobnum\n";
723 if ( $job && $job->status ne 'failed' && $job->status ne 'done' ) {
724 my ($progress, $action) = split ',', $job->statustext, 2;
725 $action ||= 'Server processing job';
726 @return = ( 'progress', $progress, $action );
727 } elsif ( !$job ) { #handle job gone case : job successful
728 # so close popup, redirect parent window...
729 @return = ( 'complete' );
730 } elsif ( $job->status eq 'done' ) {
731 @return = ( 'done', $job->statustext, '' );
733 @return = ( 'error', $job ? $job->statustext : $jobnum );
736 encode_json \@return;