1 package FS::ClientAPI::Signup;
4 use vars qw( $DEBUG $me );
8 use FS::Record qw(qsearch qsearchs dbdef);
9 use FS::CGI qw(popurl);
10 use FS::Msgcat qw(gettext);
11 use FS::Misc qw(card_types);
12 use FS::ClientAPI_SessionCache;
14 use FS::cust_main_county;
27 $me = '[FS::ClientAPI::Signup]';
30 warn "$me clear_cache called\n" if $DEBUG;
31 my $cache = new FS::ClientAPI_SessionCache( {
32 'namespace' => 'FS::ClientAPI::Signup',
41 warn "$me signup_info called on $packet\n" if $DEBUG;
43 my $conf = new FS::Conf;
44 my $svc_x = $conf->config('signup_server-service') || 'svc_acct';
46 my $cache = new FS::ClientAPI_SessionCache( {
47 'namespace' => 'FS::ClientAPI::Signup',
49 my $signup_info_cache = $cache->get('signup_info_cache');
51 if ( $signup_info_cache ) {
53 warn "$me loading cached signup info\n" if $DEBUG > 1;
57 warn "$me populating signup info cache\n" if $DEBUG > 1;
59 my $agentnum2part_pkg =
63 my $href = $agent->pkgpart_hashref;
66 map { { 'payby' => [ $_->payby ],
67 'freq_pretty' => $_->freq_pretty,
68 'options' => { $_->options },
71 grep { $_->svcpart($svc_x)
72 && ( $href->{ $_->pkgpart }
74 && $_->agentnum == $agent->agentnum
78 qsearch( 'part_pkg', { 'disabled' => '' } )
80 } qsearch('agent', { 'disabled' => '' })
83 my $msgcat = { map { $_=>gettext($_) }
84 qw( passwords_dont_match invalid_card unknown_card_type
85 not_a empty_password illegal_or_empty_text )
87 warn "msgcat: ". Dumper($msgcat). "\n" if $DEBUG > 2;
89 my $label = { map { $_ => FS::Msgcat::_gettext($_) }
90 qw( stateid stateid_state )
92 warn "label: ". Dumper($label). "\n" if $DEBUG > 2;
94 my @agent_fields = qw( agentnum agent );
96 $signup_info_cache = {
97 'cust_main_county' => [ map $_->hashref,
98 qsearch('cust_main_county', {} )
101 'agent' => [ map { my $agent = $_;
102 +{ map { $_ => $agent->get($_) } @agent_fields }
104 qsearch('agent', { 'disabled' => '' } )
107 'part_referral' => [ map $_->hashref,
108 qsearch('part_referral', { 'disabled' => '' } )
111 'agentnum2part_pkg' => $agentnum2part_pkg,
113 'svc_acct_pop' => [ map $_->hashref, qsearch('svc_acct_pop',{} ) ],
115 'emailinvoiceonly' => $conf->exists('emailinvoiceonly'),
117 'security_phrase' => $conf->exists('security_phrase'),
119 'nomadix' => $conf->exists('signup_server-nomadix'),
121 'payby' => [ $conf->config('signup_server-payby') ],
123 'payby_longname' => [ map { FS::payby->longname($_) }
124 $conf->config('signup_server-payby') ],
126 'card_types' => card_types(),
128 'paytypes' => [ @FS::cust_main::paytypes ],
132 'stateid_enabled' => $conf->exists('show_stateid'),
134 'paystate_enabled' => $conf->exists('show_bankstate'),
142 'statedefault' => scalar($conf->config('statedefault')) || 'CA',
144 'countrydefault' => scalar($conf->config('countrydefault')) || 'US',
146 'refnum' => scalar($conf->config('signup_server-default_refnum')),
148 'default_pkgpart' => scalar($conf->config('signup_server-default_pkgpart')),
150 'signup_service' => $svc_x,
151 'default_svcpart' => scalar($conf->config('signup_server-default_svcpart')),
153 'head' => join("\n", $conf->config('selfservice-head') ),
154 'body_header' => join("\n", $conf->config('selfservice-body_header') ),
155 'body_footer' => join("\n", $conf->config('selfservice-body_footer') ),
156 'body_bgcolor' => scalar( $conf->config('selfservice-body_bgcolor') ),
157 'box_bgcolor' => scalar( $conf->config('selfservice-box_bgcolor') ),
159 'company_name' => scalar($conf->config('company_name')),
162 'agent_ship_address' => scalar($conf->exists('agent-ship_address')),
164 'no_company' => scalar($conf->exists('signup-no_company')),
165 'require_phone' => scalar($conf->exists('cust_main-require_phone')),
166 'recommend_daytime' => scalar($conf->exists('signup-recommend_daytime')),
167 'recommend_email' => scalar($conf->exists('signup-recommend_email')),
171 $cache->set('signup_info_cache', $signup_info_cache);
175 my $signup_info = { %$signup_info_cache };
176 warn "$me signup info loaded\n" if $DEBUG > 1;
177 warn Dumper($signup_info). "\n" if $DEBUG > 2;
179 my @addl = qw( signup_server-classnum2 signup_server-classnum3 );
181 if ( grep { $conf->exists($_) } @addl ) {
183 $signup_info->{optional_packages} = [];
185 foreach my $addl ( @addl ) {
187 warn "$me adding optional package info\n" if $DEBUG > 1;
189 my $classnum = $conf->config($addl) or next;
192 'freq_pretty' => $_->freq_pretty,
193 'options' => { $_->options },
197 qsearch( 'part_pkg', { classnum => $classnum } );
199 push @{$signup_info->{optional_packages}}, \@pkgs;
201 warn "$me done adding opt. package info for $classnum\n" if $DEBUG > 1;
207 my $agentnum = $packet->{'agentnum'}
208 || $conf->config('signup_server-default_agentnum');
209 $agentnum =~ /^(\d*)$/ or die "illegal agentnum";
213 if ( exists $packet->{'session_id'} ) {
215 warn "$me loading agent session\n" if $DEBUG > 1;
216 my $cache = new FS::ClientAPI_SessionCache( {
217 'namespace' => 'FS::ClientAPI::Agent',
219 $session = $cache->get($packet->{'session_id'});
221 $agentnum = $session->{'agentnum'};
223 return { 'error' => "Can't resume session" }; #better error message
225 warn "$me done loading agent session\n" if $DEBUG > 1;
227 } elsif ( exists $packet->{'customer_session_id'} ) {
229 warn "$me loading customer session\n" if $DEBUG > 1;
230 my $cache = new FS::ClientAPI_SessionCache( {
231 'namespace' => 'FS::ClientAPI::MyAccount',
233 $session = $cache->get($packet->{'customer_session_id'});
235 my $custnum = $session->{'custnum'};
236 my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum });
237 return { 'error' => "Can't find your customer record" } unless $cust_main;
238 $agentnum = $cust_main->agentnum;
240 return { 'error' => "Can't resume session" }; #better error message
242 warn "$me done loading customer session\n" if $DEBUG > 1;
246 $signup_info->{'part_pkg'} = [];
248 if ( $packet->{'reg_code'} ) {
250 warn "$me setting package list via reg_code\n" if $DEBUG > 1;
252 $signup_info->{'part_pkg'} =
253 [ map { { 'payby' => [ $_->payby ],
254 'freq_pretty' => $_->freq_pretty,
255 'options' => { $_->options },
259 grep { $_->svcpart($svc_x) }
261 qsearchs( 'reg_code', { 'code' => $packet->{'reg_code'},
262 'agentnum' => $agentnum, } )
266 $signup_info->{'error'} = 'Unknown registration code'
267 unless @{ $signup_info->{'part_pkg'} };
269 warn "$me done setting package list via reg_code\n" if $DEBUG > 1;
271 } elsif ( $packet->{'promo_code'} ) {
273 warn "$me setting package list via promo_code\n" if $DEBUG > 1;
275 $signup_info->{'part_pkg'} =
276 [ map { { 'payby' => [ $_->payby ],
277 'freq_pretty' => $_->freq_pretty,
278 'options' => { $_->options },
281 grep { $_->svcpart($svc_x) }
282 qsearch( 'part_pkg', { 'promo_code' => {
284 value=>$packet->{'promo_code'}
286 'disabled' => '', } )
289 $signup_info->{'error'} = 'Unknown promotional code'
290 unless @{ $signup_info->{'part_pkg'} };
292 warn "$me done setting package list via promo_code\n" if $DEBUG > 1;
297 warn "$me setting agent-specific payment flag\n" if $DEBUG > 1;
298 my $agent = qsearchs('agent', { 'agentnum' => $agentnum } );
299 warn "$me has agent $agent\n" if $DEBUG > 1;
300 if ( $agent ) { #else complain loudly?
301 $signup_info->{'hide_payment_fields'} = [];
302 foreach my $payby (@{$signup_info->{payby}}) {
303 warn "$me checking $payby payment fields\n" if $DEBUG > 1;
305 if ( FS::payby->realtime($payby) ) {
306 my $payment_gateway =
307 $agent->payment_gateway( 'method' => FS::payby->payby2bop($payby),
310 if ( $payment_gateway
311 && $payment_gateway->gateway_namespace
312 eq 'Business::OnlineThirdPartyPayment'
314 warn "$me hiding $payby payment fields\n" if $DEBUG > 1;
318 push @{$signup_info->{'hide_payment_fields'}}, $hide;
321 warn "$me done setting agent-specific payment flag\n" if $DEBUG > 1;
323 warn "$me setting agent-specific package list\n" if $DEBUG > 1;
324 $signup_info->{'part_pkg'} = $signup_info->{'agentnum2part_pkg'}{$agentnum}
325 unless @{ $signup_info->{'part_pkg'} };
326 warn "$me done setting agent-specific package list\n" if $DEBUG > 1;
328 warn "$me setting agent-specific adv. source list\n" if $DEBUG > 1;
329 $signup_info->{'part_referral'} =
333 'table' => 'part_referral',
334 'hashref' => { 'disabled' => '' },
335 'extra_sql' => "AND ( agentnum = $agentnum ".
336 " OR agentnum IS NULL ) ",
340 warn "$me done setting agent-specific adv. source list\n" if $DEBUG > 1;
342 $signup_info->{'agent_name'} = $agent->agent;
344 $signup_info->{'company_name'} = $conf->config('company_name', $agentnum);
346 if ( $signup_info->{'agent_ship_address'} && $agent->agent_custnum ) {
347 my $cust_main = $agent->agent_cust_main;
348 my $prefix = length($cust_main->ship_last) ? 'ship_' : '';
349 $signup_info->{"ship_$_"} = $cust_main->get("$prefix$_")
350 foreach qw( address1 city county state zip country );
353 #some of the above could probably be cached, too
355 my $signup_info_cache_agent = $cache->get("signup_info_cache_agent$agentnum");
357 if ( $signup_info_cache_agent ) {
359 warn "$me loading cached signup info for agentnum $agentnum\n"
364 warn "$me populating signup info cache for agentnum $agentnum\n"
367 $signup_info_cache_agent = {
368 #( map { $_ => scalar( $conf->config($_, $agentnum) ) }
369 # qw( company_name ) ),
370 ( map { $_ => scalar( $conf->config("selfservice-$_", $agentnum ) ) }
371 qw( body_bgcolor box_bgcolor) ),
372 ( map { $_ => join("\n", $conf->config("selfservice-$_", $agentnum ) ) }
373 qw( head body_header body_footer ) ),
376 $cache->set("signup_info_cache_agent$agentnum", $signup_info_cache_agent);
380 $signup_info->{$_} = $signup_info_cache_agent->{$_}
381 foreach keys %$signup_info_cache_agent;
385 # delete $signup_info->{'part_pkg'};
388 warn "$me sorting package list\n" if $DEBUG > 1;
389 $signup_info->{'part_pkg'} = [ sort { $a->{pkg} cmp $b->{pkg} } # case?
390 @{ $signup_info->{'part_pkg'} }
392 warn "$me done sorting package list\n" if $DEBUG > 1;
394 if ( exists $packet->{'session_id'} ) {
395 my $agent_signup_info = { %$signup_info };
396 delete $agent_signup_info->{agentnum2part_pkg};
397 $agent_signup_info->{'agent'} = $session->{'agent'};
398 return $agent_signup_info;
400 elsif ( exists $packet->{'keys'} ) {
401 my @keys = @{ $packet->{'keys'} };
402 return { map { $_ => $signup_info->{$_} } @keys };
410 sub domain_select_hash {
415 if ($packet->{pkgpart}) {
416 my $part_pkg = qsearchs('part_pkg' => { 'pkgpart' => $packet->{pkgpart} } );
417 #$packet->{svcpart} = $part_pkg->svcpart('svc_acct')
418 $packet->{svcpart} = $part_pkg->svcpart
422 if ($packet->{svcpart}) {
423 my $part_svc = qsearchs('part_svc' => { 'svcpart' => $packet->{svcpart} } );
424 $response->{'domsvc'} = $part_svc->part_svc_column('domsvc')->columnvalue
425 if ($part_svc && $part_svc->part_svc_column('domsvc')->columnflag eq 'D');
428 $response->{'domains'}
429 = { domain_select_hash FS::svc_acct( map { $_ => $packet->{$_} }
439 my $conf = new FS::Conf;
440 my $svc_x = $conf->config('signup_server-service') || 'svc_acct';
442 if ( $svc_x eq 'svc_acct' ) {
444 #things that aren't necessary in base class, but are for signup server
445 #return "Passwords don't match"
446 # if $hashref->{'_password'} ne $hashref->{'_password2'}
447 return { 'error' => gettext('empty_password') }
448 unless length($packet->{'_password'});
449 # a bit inefficient for large numbers of pops
450 return { 'error' => gettext('no_access_number_selected') }
451 unless $packet->{'popnum'} || !scalar(qsearch('svc_acct_pop',{} ));
456 if ( exists $packet->{'session_id'} ) {
457 my $cache = new FS::ClientAPI_SessionCache( {
458 'namespace' => 'FS::ClientAPI::Agent',
460 my $session = $cache->get($packet->{'session_id'});
462 $agentnum = $session->{'agentnum'};
464 return { 'error' => "Can't resume session" }; #better error message
467 $agentnum = $packet->{agentnum}
468 || $conf->config('signup_server-default_agentnum');
471 #shares some stuff with htdocs/edit/process/cust_main.cgi... take any
472 # common that are still here and library them.
473 my $cust_main = new FS::cust_main ( {
475 'agentnum' => $agentnum,
476 'refnum' => $packet->{refnum}
477 || $conf->config('signup_server-default_refnum'),
479 map { $_ => $packet->{$_} } qw(
481 last first ss company address1 address2
482 city county state zip country
483 daytime night fax stateid stateid_state
485 ship_last ship_first ship_ss ship_company ship_address1 ship_address2
486 ship_city ship_county ship_state ship_zip ship_country
487 ship_daytime ship_night ship_fax
490 payinfo paycvv paydate payname paystate paytype
491 paystart_month paystart_year payissue
494 referral_custnum comments
499 my $agent = qsearchs('agent', { 'agentnum' => $agentnum } );
500 if ( $conf->exists('agent_ship_address') && $agent->agent_custnum ) {
501 my $agent_cust_main = $agent->agent_cust_main;
502 my $prefix = length($agent_cust_main->ship_last) ? 'ship_' : '';
503 $cust_main->set("ship_$_", $agent_cust_main->get("$prefix$_") )
504 foreach qw( address1 city county state zip country );
506 $cust_main->set("ship_$_", $cust_main->get($_))
507 foreach qw( last first );
512 return { 'error' => "Illegal payment type" }
513 unless grep { $_ eq $packet->{'payby'} }
514 $conf->config('signup_server-payby');
516 if (FS::payby->realtime($packet->{payby})) {
517 my $payby = $packet->{payby};
519 my $agent = qsearchs('agent', { 'agentnum' => $agentnum });
520 return { 'error' => "Unknown reseller" }
523 my $gw = $agent->payment_gateway( 'method' => FS::payby->payby2bop($payby),
527 $cust_main->payby('BILL') # MCRD better?
528 if $gw && $gw->gateway_namespace eq 'Business::OnlineThirdPartyPayment';
531 $cust_main->payinfo($cust_main->daytime)
532 if $cust_main->payby eq 'LECB' && ! $cust_main->payinfo;
534 my @invoicing_list = $packet->{'invoicing_list'}
535 ? split( /\s*\,\s*/, $packet->{'invoicing_list'} )
538 $packet->{'pkgpart'} =~ /^(\d+)$/ or '' =~ /^()$/;
540 return { 'error' => 'Please select a package' } unless $pkgpart; #msgcat
543 qsearchs( 'part_pkg', { 'pkgpart' => $pkgpart } )
544 or return { 'error' => "WARNING: unknown pkgpart: $pkgpart" };
545 my $svcpart = $part_pkg->svcpart($svc_x);
548 if ( $packet->{'reg_code'} ) {
549 $reg_code = qsearchs( 'reg_code', { 'code' => $packet->{'reg_code'},
550 'agentnum' => $agentnum, } )
551 or return { 'error' => 'Unknown registration code' };
554 my $cust_pkg = new FS::cust_pkg ( {
555 #later#'custnum' => $custnum,
556 'pkgpart' => $packet->{'pkgpart'},
557 'promo_code' => $packet->{'promo_code'},
558 'reg_code' => $packet->{'reg_code'},
560 #my $error = $cust_pkg->check;
561 #return { 'error' => $error } if $error;
563 #should be all auto-magic and shit
565 if ( $svc_x eq 'svc_acct' ) {
567 my $svc = new FS::svc_acct {
568 'svcpart' => $svcpart,
569 map { $_ => $packet->{$_} }
570 qw( username _password sec_phrase popnum ),
575 while ( exists($packet->{"snarf_machine$snarfnum"})
576 && length($packet->{"snarf_machine$snarfnum"}) ) {
577 my $acct_snarf = new FS::acct_snarf ( {
578 'machine' => $packet->{"snarf_machine$snarfnum"},
579 'protocol' => $packet->{"snarf_protocol$snarfnum"},
580 'username' => $packet->{"snarf_username$snarfnum"},
581 '_password' => $packet->{"snarf_password$snarfnum"},
584 push @acct_snarf, $acct_snarf;
586 $svc->child_objects( \@acct_snarf );
590 } elsif ( $svc_x eq 'svc_phone' ) {
592 my $svc = new FS::svc_phone ( {
593 'svcpart' => $svcpart,
594 map { $_ => $packet->{$_} }
595 qw( countrycode phonenum sip_password pin ),
601 die "unknown signup service $svc_x";
603 my $y = $svc[0]->setdefault; # arguably should be in new method
604 return { 'error' => $y } if $y && !ref($y);
606 if ($packet->{'mac_addr'} && $conf->exists('signup_server-mac_addr_svcparts'))
609 my %mac_addr_svcparts = map { $_ => 1 }
610 $conf->config('signup_server-mac_addr_svcparts');
611 my @pkg_svc = grep { $_->quantity && $mac_addr_svcparts{$_->svcpart} }
612 $cust_pkg->part_pkg->pkg_svc;
614 return { 'error' => 'No service defined to assign mac address' }
617 my $svc = new FS::svc_acct {
618 'svcpart' => $pkg_svc[0]->svcpart, #multiple matches? alas..
619 'username' => $packet->{'mac_addr'},
620 '_password' => '', #blank as requested (set passwordmin to 0)
623 my $y = $svc->setdefault; # arguably should be in new method
624 return { 'error' => $y } if $y && !ref($y);
630 #$error = $svc->check;
631 #return { 'error' => $error } if $error;
633 #setup a job dependancy to delay provisioning
634 my $placeholder = new FS::queue ( {
635 'job' => 'FS::ClientAPI::Signup::__placeholder',
636 'status' => 'locked',
638 my $error = $placeholder->insert;
639 return { 'error' => $error } if $error;
642 tie my %hash, 'Tie::RefHash';
643 %hash = ( $cust_pkg => \@svc );
645 $error = $cust_main->insert(
648 'depend_jobnum' => $placeholder->jobnum,
651 my $perror = $placeholder->delete;
652 $error .= " (Additionally, error removing placeholder: $perror)" if $perror;
653 return { 'error' => $error };
656 if ( $conf->exists('signup_server-realtime') ) {
658 #warn "$me Billing customer...\n" if $Debug;
660 my $bill_error = $cust_main->bill;
661 #warn "$me error billing new customer: $bill_error"
664 $bill_error = $cust_main->apply_payments_and_credits;
665 #warn "$me error applying payments and credits for".
666 # " new customer: $bill_error"
669 $bill_error = $cust_main->realtime_collect(
670 method => FS::payby->payby2bop( $packet->{payby} ),
671 depend_jobnum => $placeholder->jobnum,
673 #warn "$me error collecting from new customer: $bill_error"
676 if ($bill_error && ref($bill_error) eq 'HASH') {
677 return { 'error' => '_collect',
678 ( map { $_ => $bill_error->{$_} }
679 qw(popup_url reference collectitems)
681 amount => $cust_main->balance,
685 $bill_error = $cust_main->apply_payments_and_credits;
686 #warn "$me error applying payments and credits for".
687 # " new customer: $bill_error"
690 if ( $cust_main->balance > 0 ) {
692 #this makes sense. credit is "un-doing" the invoice
693 $cust_main->credit( $cust_main->balance, 'signup server decline',
694 'reason_type' => $conf->config('signup_credit_type'),
696 $cust_main->apply_credits;
698 #should check list for errors...
699 #$cust_main->suspend;
700 local $FS::svc_Common::noexport_hack = 1;
701 $cust_main->cancel('quiet'=>1);
703 my $perror = $placeholder->depended_delete;
704 warn "error removing provisioning jobs after decline: $perror" if $perror;
706 $perror = $placeholder->delete;
707 warn "error removing placeholder after decline: $perror" if $perror;
710 return { 'error' => '_decline' };
716 $error = $reg_code->delete;
717 return { 'error' => $error } if $error;
720 $error = $placeholder->delete;
721 return { 'error' => $error } if $error;
723 my %return = ( 'error' => '',
724 'signup_service' => $svc_x,
727 if ( $svc_x eq 'svc_acct' ) {
728 $return{$_} = $svc[0]->$_() for qw( username _password );
729 } elsif ( $svc_x eq 'svc_phone' ) {
730 $return{$_} = $svc[0]->$_() for qw( countrycode phonenum sip_password pin );
732 die "unknown signup service $svc_x";
739 sub capture_payment {
742 warn "$me capture_payment called on $packet\n" if $DEBUG;
745 # identify processor/gateway from called back URL
748 my $conf = new FS::Conf;
750 my $url = $packet->{url};
751 my $payment_gateway =
752 qsearchs('payment_gateway', { 'gateway_callback_url' => popurl(0, $url) } );
754 unless ($payment_gateway) {
756 my ( $processor, $login, $password, $action, @bop_options ) =
757 $conf->config('business-onlinepayment');
758 $action ||= 'normal authorization';
759 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
760 die "No real-time processor is enabled - ".
761 "did you set the business-onlinepayment configuration value?\n"
764 $payment_gateway = new FS::payment_gateway( {
765 gateway_namespace => $conf->config('business-onlinepayment-namespace'),
766 gateway_module => $processor,
767 gateway_username => $login,
768 gateway_password => $password,
769 gateway_action => $action,
770 options => [ ( @bop_options ) ],
775 die "No real-time third party processor is enabled - ".
776 "did you set the business-onlinepayment configuration value?\n*"
777 unless $payment_gateway->gateway_namespace eq 'Business::OnlineThirdPartyPayment';
780 # locate pending transaction
783 eval "use Business::OnlineThirdPartyPayment";
787 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
788 @{ [ $payment_gateway->options ] },
791 my $paypendingnum = $transaction->reference($packet->{data});
793 my $cust_pay_pending =
794 qsearchs('cust_pay_pending', { paypendingnum => $paypendingnum } );
796 unless ($cust_pay_pending) {
797 my $bill_error = "No payment is being processed with id $paypendingnum".
798 "; Transaction aborted.";
799 return { error => '_decline', bill_error => $bill_error };
802 if ($cust_pay_pending->status ne 'pending') {
803 my $bill_error = "Payment with id $paypendingnum is not pending, but ".
804 $cust_pay_pending->status. "; Transaction aborted.";
805 return { error => '_decline', bill_error => $bill_error };
808 my $cust_main = $cust_pay_pending->cust_main;
810 $cust_main->realtime_botpp_capture( $cust_pay_pending, %{$packet->{data}} );
812 return { 'error' => ( $bill_error->{bill_error} ? '_decline' : '' ),