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( get_page_pref set_page_pref svc_url random_id );
21 $me = '[FS::UID::Web]';
29 =item get_page_pref NAME, TABLENUM
31 Returns the user's page preference named NAME for the current page. If the
32 page is a view or edit page or otherwise shows a single record at a time,
33 it should use TABLENUM to link the preference to that record.
38 my ($prefname, $tablenum) = @_;
40 my $m = $HTML::Mason::Commands::m
41 or die "can't get page pref when running outside the UI";
42 # what's more useful: to tie prefs to the base_comp (usually where
43 # code is executing right now), or to the request_comp (approximately the
44 # one in the URL)? not sure.
45 $FS::CurrentUser::CurrentUser->get_page_pref( $m->request_comp->path,
51 =item set_page_pref NAME, TABLENUM, VALUE
53 Sets the user's page preference named NAME for the current page. Use TABLENUM
56 If VALUE is an empty string, the preference will be deleted (and
57 C<get_page_pref> will return an empty string).
59 my $mypref = set_page_pref('mypref', '', 100);
64 my ($prefname, $tablenum, $prefvalue) = @_;
66 my $m = $HTML::Mason::Commands::m
67 or die "can't set page pref when running outside the UI";
68 $FS::CurrentUser::CurrentUser->set_page_pref( $m->request_comp->path,
78 =item parse_beginning_ending CGI [, PREFIX ]
80 Parses a beginning/ending date range, as used on many reports. This function
81 recognizes two sets of CGI params: "begin" and "end", the integer timestamp
82 values, and "beginning" and "ending", the user-readable date fields.
84 If "begin" contains an integer, that's passed through as the beginning date.
85 Otherwise, "beginning" is passed to L<DateTime::Format::Natural> and turned
86 into an integer. If this fails or it doesn't have a value, zero is used as the
89 The same happens for "end" and "ending", except that if "ending" contains a
90 date without a time, it gets moved to the end of that day, and if there's no
91 value, the value returned is the highest unsigned 32-bit time value (some time
94 PREFIX is optionally a string to prepend (with '_' as a delimiter) to the form
100 sub parse_beginning_ending {
101 my($cgi, $prefix) = @_;
102 $prefix .= '_' if $prefix;
105 if ( $cgi->param($prefix.'begin') =~ /^(\d+)$/ ) {
107 } elsif ( $cgi->param($prefix.'beginning') =~ /^([ 0-9\-\/\:]{1,64})$/ ) {
108 $beginning = parse_datetime($1) || 0;
111 my $ending = 4294967295; #2^32-1
112 if ( $cgi->param($prefix.'end') =~ /^(\d+)$/ ) {
114 } elsif ( $cgi->param($prefix.'ending') =~ /^([ 0-9\-\/\:]{1,64})$/ ) {
115 $ending = parse_datetime($1);
116 $ending = day_end($ending) unless $ending =~ /:/;
119 ( $beginning, $ending );
124 Returns a service URL, first checking to see if there is a service-specific
125 page to link to, otherwise to a generic service handling page. Options are
126 passed as a list of name-value pairs, and include:
130 =item * m - Mason request object ($m)
132 =item * action - The action for which to construct "edit", "view", or "search"
134 =item ** part_svc - Service definition (see L<FS::part_svc>)
136 =item ** svcdb - Service table
138 =item *** query - Query string
140 =item *** svc - FS::cust_svc or FS::svc_* object
142 =item ahref - Optional flag, if set true returns <A HREF="$url"> instead of just the URL.
148 ** part_svc OR svcdb is required
150 *** query OR svc is required
157 # 'm' => $m, #mason request object
158 # 'action' => 'edit', #or 'view'
160 # 'part_svc' => $part_svc, #usual
162 # 'svcdb' => 'svc_table',
164 # 'query' => #optional query string
165 # # (pass a blank string if you want a "raw" URL to add your
168 # 'svc' => $svc_x, #or $cust_svc, it just needs a svcnum
173 # 'ahref' => 1, # if set true, returns <A HREF="$url">
175 use FS::CGI qw(rooturl);
179 #? return '' unless ref($opt{part_svc});
181 my $svcdb = $opt{svcdb} || $opt{part_svc}->svcdb;
182 my $query = exists($opt{query}) ? $opt{query} : $opt{svc}->svcnum;
184 warn "$me [svc_url] checking for /$opt{action}/$svcdb.cgi component"
186 if ( $opt{m}->interp->comp_exists("/$opt{action}/$svcdb.cgi") ) {
187 $url = "$svcdb.cgi?";
188 } elsif ( $opt{m}->interp->comp_exists("/$opt{action}/$svcdb.html") ) {
189 $url = "$svcdb.html?";
191 my $generic = $opt{action} eq 'search' ? 'cust_svc' : 'svc_Common';
193 $url = "$generic.html?svcdb=$svcdb;";
194 $url .= 'svcnum=' if $query =~ /^\d+(;|$)/ or $query eq '';
197 my $return = FS::CGI::rooturl(). "$opt{action}/$url$query";
199 $return = qq!<A HREF="$return">! if $opt{ahref};
205 my($m, $part_svc, $cust_svc) = @_ or return '';
206 svc_X_link( $part_svc->svc, @_ );
210 my($m, $part_svc, $cust_svc) = @_ or return '';
211 my($svc, $label, $svcdb) = $cust_svc->label;
212 svc_X_link( $label, @_ );
216 my ($x, $m, $part_svc, $cust_svc) = @_ or return '';
219 unless $FS::CurrentUser::CurrentUser->access_right('View customer services');
221 confess "svc_X_link called without a service ($x, $m, $part_svc, $cust_svc)\n"
228 'part_svc' => $part_svc,
235 #this probably needs an ACL too...
236 sub svc_export_links {
237 my ($m, $part_svc, $cust_svc) = @_ or return '';
239 my $ahref = $cust_svc->export_links;
245 my($cgi, $field) = (shift, shift);
246 my $table = ( @_ && length($_[0]) ) ? shift.'.' : '';
255 foreach my $op (keys %op) {
257 warn "checking for ${field}_$op field\n"
260 if ( $cgi->param($field."_$op") =~ /^\s*\$?\s*(-?[\d\,\s]+(\.\d\d)?)\s*$/ ) {
263 $num =~ s/[\,\s]+//g;
264 my $search = "$table$field $op{$op} $num";
265 push @search, $search;
267 warn "found ${field}_$op field; adding search element $search\n"
278 # cust_main report subroutines
283 =item cust_header [ CUST_FIELDS_VALUE ]
285 Returns an array of customer information headers according to the supplied
286 customer fields value, or if no value is supplied, the B<cust-fields>
291 use vars qw( @cust_fields @cust_colors @cust_styles @cust_aligns );
295 warn "FS::UI:Web::cust_header called"
298 my $conf = new FS::Conf;
300 my %header2method = (
301 'Customer' => 'name',
302 'Cust. Status' => 'ucfirst_cust_status',
303 'Cust#' => 'custnum',
305 'Company' => 'company',
307 # obsolete but might still be referenced in configuration
308 '(bill) Customer' => 'name',
309 '(service) Customer' => 'ship_name',
310 '(bill) Name' => 'contact',
311 '(service) Name' => 'ship_contact',
312 '(bill) Company' => 'company',
313 '(service) Company' => 'ship_company',
314 '(bill) Day phone' => 'daytime',
315 '(bill) Night phone' => 'night',
316 '(bill) Fax number' => 'fax',
318 'Customer' => 'name',
319 'Address 1' => 'bill_address1',
320 'Address 2' => 'bill_address2',
321 'City' => 'bill_city',
322 'State' => 'bill_state',
324 'Country' => 'bill_country_full',
325 'Day phone' => 'daytime', # XXX should use msgcat, but how?
326 'Night phone' => 'night', # XXX should use msgcat, but how?
327 'Mobile phone' => 'mobile', # XXX should use msgcat, but how?
328 'Fax number' => 'fax',
329 '(bill) Address 1' => 'bill_address1',
330 '(bill) Address 2' => 'bill_address2',
331 '(bill) City' => 'bill_city',
332 '(bill) State' => 'bill_state',
333 '(bill) Zip' => 'bill_zip',
334 '(bill) Country' => 'bill_country_full',
335 '(bill) Latitude' => 'bill_latitude',
336 '(bill) Longitude' => 'bill_longitude',
337 '(service) Address 1' => 'ship_address1',
338 '(service) Address 2' => 'ship_address2',
339 '(service) City' => 'ship_city',
340 '(service) State' => 'ship_state',
341 '(service) Zip' => 'ship_zip',
342 '(service) Country' => 'ship_country_full',
343 '(service) Latitude' => 'ship_latitude',
344 '(service) Longitude' => 'ship_longitude',
345 'Invoicing email(s)' => 'invoicing_list_emailonly_scalar',
346 'Payment Type' => 'cust_payby',
347 'Current Balance' => 'current_balance',
348 'Agent Cust#' => 'agent_custid',
349 'Agent' => 'agent_name',
350 'Agent Cust# or Cust#' => 'display_custnum',
351 'Advertising Source' => 'referral',
353 $header2method{'Cust#'} = 'display_custnum'
354 if $conf->exists('cust_main-default_agent_custid');
356 my %header2colormethod = (
357 'Cust. Status' => 'cust_statuscolor',
360 'Cust. Status' => 'b',
363 'Cust. Status' => 'c',
371 warn " using supplied cust-fields override".
372 " (ignoring cust-fields config file)"
374 $cust_fields = shift;
378 if ( $conf->exists('cust-fields')
379 && $conf->config('cust-fields') =~ /^([\w\. \|\#\(\)]+):?/
382 warn " found cust-fields configuration value"
386 warn " no cust-fields configuration value found; using default 'Cust. Status | Customer'"
388 $cust_fields = 'Cust. Status | Customer';
393 @cust_header = split(/ \| /, $cust_fields);
394 @cust_fields = map { $header2method{$_} || $_ } @cust_header;
395 @cust_colors = map { exists $header2colormethod{$_}
396 ? $header2colormethod{$_}
400 @cust_styles = map { exists $header2style{$_} ? $header2style{$_} : '' }
402 @cust_aligns = map { exists $header2align{$_} ? $header2align{$_} : 'l' }
409 sub cust_sort_fields {
410 cust_header(@_) if( @_ or !@cust_fields );
411 #inefficientish, but tiny lists and only run once per page
413 map { $_ eq 'custnum' ? 'custnum' : '' } @cust_fields;
417 =item cust_sql_fields [ CUST_FIELDS_VALUE ]
419 Returns a list of fields for the SELECT portion of an SQL query.
421 As with L<the cust_header subroutine|/cust_header>, the fields returned are
422 defined by the supplied customer fields setting, or if no customer fields
423 setting is supplied, the <B>cust-fields</B> configuration value.
427 sub cust_sql_fields {
429 my @fields = qw( last first company );
430 # push @fields, map "ship_$_", @fields;
432 cust_header(@_) if( @_ or !@cust_fields );
433 #inefficientish, but tiny lists and only run once per page
436 foreach my $field (qw( address1 address2 city state zip latitude longitude )) {
437 foreach my $pre ('bill_','ship_') {
438 if ( grep { $_ eq $pre.$field } @cust_fields ) {
439 push @location_fields, $pre.'location.'.$field.' AS '.$pre.$field;
443 foreach my $pre ('bill_','ship_') {
444 if ( grep { $_ eq $pre.'country_full' } @cust_fields ) {
445 push @location_fields, $pre.'locationnum';
449 foreach my $field (qw(daytime night mobile fax )) {
450 push @fields, $field if (grep { $_ eq $field } @cust_fields);
452 push @fields, "payby AS cust_payby"
453 if grep { $_ eq 'cust_payby' } @cust_fields;
454 push @fields, 'agent_custid';
456 push @fields, 'agentnum' if grep { $_ eq 'agent_name' } @cust_fields;
458 my @extra_fields = ();
459 if (grep { $_ eq 'current_balance' } @cust_fields) {
460 push @extra_fields, FS::cust_main->balance_sql . " AS current_balance";
463 push @extra_fields, 'part_referral_x.referral AS referral'
464 if grep { $_ eq 'referral' } @cust_fields;
466 map("cust_main.$_", @fields), @location_fields, @extra_fields;
469 =item join_cust_main [ TABLE[.CUSTNUM] ] [ LOCATION_TABLE[.LOCATIONNUM] ]
471 Returns an SQL join phrase for the FROM clause so that the fields listed
472 in L<cust_sql_fields> will be available. Currently joins to cust_main
473 itself, as well as cust_location (under the aliases 'bill_location' and
474 'ship_location') if address fields are needed. L<cust_header()> should have
477 All of these will be left joins; if you want to exclude rows with no linked
478 cust_main record (or bill_location/ship_location), you can do so in the
481 TABLE is the table containing the custnum field. If CUSTNUM (a field name
482 in that table) is specified, that field will be joined to cust_main.custnum.
483 Otherwise, this function will assume the field is named "custnum". If the
484 argument isn't present at all, the join will just say "USING (custnum)",
487 As a special case, if TABLE is 'cust_main', only the joins to cust_location
490 LOCATION_TABLE is an optional table name to use for joining ship_location,
491 in case your query also includes package information and you want the
492 "service address" columns to reflect package addresses.
497 my ($cust_table, $location_table) = @_;
498 my ($custnum, $locationnum);
499 ($cust_table, $custnum) = split(/\./, $cust_table);
500 $custnum ||= 'custnum';
501 ($location_table, $locationnum) = split(/\./, $location_table);
502 $locationnum ||= 'locationnum';
506 $sql = " LEFT JOIN cust_main ON (cust_main.custnum = $cust_table.$custnum)"
507 unless $cust_table eq 'cust_main';
509 $sql = " LEFT JOIN cust_main USING (custnum)";
512 if ( !@cust_fields or grep /^bill_/, @cust_fields ) {
514 $sql .= ' LEFT JOIN cust_location bill_location'.
515 ' ON (bill_location.locationnum = cust_main.bill_locationnum)';
519 if ( !@cust_fields or grep /^ship_/, @cust_fields ) {
521 if (!$location_table) {
522 $location_table = 'cust_main';
523 $locationnum = 'ship_locationnum';
526 $sql .= ' LEFT JOIN cust_location ship_location'.
527 " ON (ship_location.locationnum = $location_table.$locationnum) ";
530 if ( !@cust_fields or grep { $_ eq 'referral' } @cust_fields ) {
531 $sql .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
537 =item cust_fields OBJECT [ CUST_FIELDS_VALUE ]
539 Given an object that contains fields from cust_main (say, from a
540 JOINed search. See httemplate/search/svc_* for examples), returns an array
541 of customer information, or "(unlinked)" if this service is not linked to a
544 As with L<the cust_header subroutine|/cust_header>, the fields returned are
545 defined by the supplied customer fields setting, or if no customer fields
546 setting is supplied, the <B>cust-fields</B> configuration value.
553 warn "FS::UI::Web::cust_fields called for $record ".
554 "(cust_fields: @cust_fields)"
557 #cust_header(@_) unless @cust_fields; #now need to cache to keep cust_fields
558 # #override incase we were passed as a sub
560 my $seen_unlinked = 0;
563 if ( $record->custnum ) {
564 warn " $record -> $_" if $DEBUG > 1;
565 encode_entities( $record->$_(@_) );
567 warn " ($record unlinked)" if $DEBUG > 1;
568 $seen_unlinked++ ? '' : '(unlinked)';
573 =item cust_fields_subs
575 Returns an array of subroutine references for returning customer field values.
576 This is similar to cust_fields, but returns each field's sub as a distinct
581 sub cust_fields_subs {
582 my $unlinked_warn = 0;
586 if ( $unlinked_warn++ ) {
590 if ( $record->custnum ) {
591 encode_entities( $record->$f(@_) );
601 $record->custnum ? encode_entities( $record->$f(@_) ) : '';
611 Returns an array of subroutine references (or empty strings) for returning
612 customer information colors.
614 As with L<the cust_header subroutine|/cust_header>, the fields returned are
615 defined by the supplied customer fields setting, or if no customer fields
616 setting is supplied, the <B>cust-fields</B> configuration value.
624 sub { shift->$method(@_) };
633 Returns an array of customer information styles.
635 As with L<the cust_header subroutine|/cust_header>, the fields returned are
636 defined by the supplied customer fields setting, or if no customer fields
637 setting is supplied, the <B>cust-fields</B> configuration value.
653 Returns an array or scalar (depending on context) of customer information
656 As with L<the cust_header subroutine|/cust_header>, the fields returned are
657 defined by the supplied customer fields setting, or if no customer fields
658 setting is supplied, the <B>cust-fields</B> configuration value.
666 join('', @cust_aligns);
672 Returns an array of links to view/cust_main.cgi, for use with cust_fields.
677 my $link = [ FS::CGI::rooturl().'view/cust_main.cgi?', 'custnum' ];
679 return map { $_ eq 'cust_status_label' ? '' : $link }
685 Utility function to determine if the client is a mobile browser.
690 my $ua = $ENV{'HTTP_USER_AGENT'} || '';
691 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 ) {
697 =item random_id [ DIGITS ]
699 Returns a random number of length DIGITS, or if unspecified, a long random
700 identifier consisting of the timestamp, process ID, and a random number.
701 Anything in the UI that needs a random identifier should use this.
707 if (!defined $NO_RANDOM_IDS) {
708 my $conf = FS::Conf->new;
709 $NO_RANDOM_IDS = $conf->exists('no_random_ids') ? 1 : 0;
710 warn "TEST MODE--RANDOM ID NUMBERS DISABLED\n" if $NO_RANDOM_IDS;
712 if ( $NO_RANDOM_IDS ) {
716 return '0000000000-0000-000000000.000000';
720 return int(rand(10 ** $digits));
722 return time . "-$$-" . rand() * 2**32;
732 # begin JSRPC code...
735 package FS::UI::Web::JSRPC;
740 use Storable qw(nfreeze);
743 use FS::UID qw(getotaker);
744 use FS::Record qw(qsearchs);
746 use FS::CGI qw(rooturl);
760 croak "CGI object required as second argument" unless $self->{'cgi'};
769 my $cgi = $self->{'cgi'};
771 # XXX this should parse JSON foo and build a proper data structure
772 my @args = $cgi->param('arg');
774 #work around konqueror bug!
775 @args = map { s/\x00$//; $_; } @args;
777 my $sub = $cgi->param('sub'); #????
779 warn "FS::UI::Web::JSRPC::process:\n".
782 " args=".join(', ',@args)."\n"
785 if ( $sub eq 'start_job' ) {
787 $self->start_job(@args);
789 } elsif ( $sub eq 'job_status' ) {
791 $self->job_status(@args);
795 die "unknown sub $sub";
804 warn "FS::UI::Web::start_job: ". join(', ', @_) if $DEBUG;
808 my( $field, $value ) = splice(@_, 0, 2);
809 unless ( exists( $param{$field} ) ) {
810 $param{$field} = $value;
811 } elsif ( ! ref($param{$field}) ) {
812 $param{$field} = [ $param{$field}, $value ];
814 push @{$param{$field}}, $value;
817 $param{CurrentUser} = getotaker();
818 $param{RootURL} = rooturl($self->{cgi}->self_url);
819 warn "FS::UI::Web::start_job\n".
821 if ( ref($param{$_}) ) {
822 " $_ => [ ". join(', ', @{$param{$_}}). " ]\n";
824 " $_ => $param{$_}\n";
829 #first get the CGI params shipped off to a job ASAP so an id can be returned
832 my $job = new FS::queue { 'job' => $self->{'job'} };
834 #too slow to insert all the cgi params as individual args..,?
835 #my $error = $queue->insert('_JOB', $cgi->Vars);
837 #warn 'froze string of size '. length(nfreeze(\%param)). " for job args\n"
840 # XXX FS::queue::insert knows how to do this.
841 # not changing it here because that requires changing it everywhere else,
842 # too, but we should eventually fix it
844 my $error = $job->insert( '_JOB', encode_base64(nfreeze(\%param)) );
848 warn "job not inserted: $error\n"
851 $error; #this doesn't seem to be handled well,
852 # will trigger "illegal jobnum" below?
853 # (should never be an error inserting the job, though, only thing
854 # would be Pg f%*kage)
857 warn "job inserted successfully with jobnum ". $job->jobnum. "\n"
866 my( $self, $jobnum ) = @_; #$url ???
868 sleep 1; # XXX could use something better...
871 if ( $jobnum =~ /^(\d+)$/ ) {
872 $job = qsearchs('queue', { 'jobnum' => $jobnum } );
874 die "FS::UI::Web::job_status: illegal jobnum $jobnum\n";
878 if ( $job && $job->status ne 'failed' && $job->status ne 'done' ) {
879 my ($progress, $action) = split ',', $job->statustext, 2;
880 $action ||= 'Server processing job';
881 @return = ( 'progress', $progress, $action );
882 } elsif ( !$job ) { #handle job gone case : job successful
883 # so close popup, redirect parent window...
884 @return = ( 'complete' );
885 } elsif ( $job->status eq 'done' ) {
886 @return = ( 'done', $job->statustext, '' );
888 @return = ( 'error', $job ? $job->statustext : $jobnum );
891 encode_json \@return;