1 package FS::SelfService;
4 use vars qw($VERSION @ISA @EXPORT_OK $socket %autoload $tag);
10 use Storable 2.09 qw(nstore_fd fd_retrieve);
14 @ISA = qw( Exporter );
16 $socket = "/usr/local/freeside/selfservice_socket";
17 $socket .= '.'.$tag if defined $tag && length($tag);
19 #maybe should ask ClientAPI for this list
21 'passwd' => 'passwd/passwd',
22 'chfn' => 'passwd/passwd',
23 'chsh' => 'passwd/passwd',
24 'login' => 'MyAccount/login',
25 'customer_info' => 'MyAccount/customer_info',
26 'edit_info' => 'MyAccount/edit_info',
27 'invoice' => 'MyAccount/invoice',
28 'list_invoices' => 'MyAccount/list_invoices',
29 'cancel' => 'MyAccount/cancel',
30 'payment_info' => 'MyAccount/payment_info',
31 'process_payment' => 'MyAccount/process_payment',
32 'list_pkgs' => 'MyAccount/list_pkgs',
33 'order_pkg' => 'MyAccount/order_pkg',
34 'cancel_pkg' => 'MyAccount/cancel_pkg',
35 'charge' => 'MyAccount/charge',
36 'signup_info' => 'Signup/signup_info',
37 'new_customer' => 'Signup/new_customer',
38 'agent_login' => 'Agent/agent_login',
39 'agent_info' => 'Agent/agent_info',
40 'agent_list_customers' => 'Agent/agent_list_customers',
42 @EXPORT_OK = ( keys(%autoload), qw( regionselector expselect popselector ) );
44 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
45 $ENV{'SHELL'} = '/bin/sh';
46 $ENV{'IFS'} = " \t\n";
49 $ENV{'BASH_ENV'} = '';
51 my $freeside_uid = scalar(getpwnam('freeside'));
52 die "not running as the freeside user\n" if $> != $freeside_uid;
54 foreach my $autoload ( keys %autoload ) {
65 $param->{_packet} = \''. $autoload{$autoload}. '\';
67 simple_packet($param);
77 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
78 connect(SOCK, sockaddr_un($socket)) or die "connect: $!";
79 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
82 #shoudl trap: Magic number checking on storable file failed at blib/lib/Storable.pm (autosplit into blib/lib/auto/Storable/fd_retrieve.al) line 337, at /usr/local/share/perl/5.6.1/FS/SelfService.pm line 71
84 #block until there is a message on socket
85 # my $w = new IO::Select;
87 # my @wait = $w->can_read;
88 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
89 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
96 FS::SelfService - Freeside self-service API
100 # password and shell account changes
101 use FS::SelfService qw(passwd chfn chsh);
103 # "my account" functionality
104 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
106 my $rv = login( { 'username' => $username,
108 'password' => $password,
112 if ( $rv->{'error'} ) {
113 #handle login error...
116 my $session_id = $rv->{'session_id'};
119 my $customer_info = customer_info( { 'session_id' => $session_id } );
121 #payment_info and process_payment are available in 1.5+ only
122 my $payment_info = payment_info( { 'session_id' => $session_id } );
124 #!!! process_payment example
126 #!!! list_pkgs example
128 #!!! order_pkg example
130 #!!! cancel_pkg example
132 # signup functionality
133 use FS::SelfService qw( signup_info new_customer );
135 my $signup_info = signup_info;
137 $rv = new_customer( {
140 'company' => $company,
141 'address1' => $address1,
142 'address2' => $address2,
146 'country' => $country,
147 'daytime' => $daytime,
151 'payinfo' => $payinfo,
153 'paydate' => $paydate,
154 'payname' => $payname,
155 'invoicing_list' => $invoicing_list,
156 'referral_custnum' => $referral_custnum,
157 'pkgpart' => $pkgpart,
158 'username' => $username,
159 '_password' => $password,
161 'agentnum' => $agentnum,
165 my $error = $rv->{'error'};
166 if ( $error eq '_decline' ) {
176 Use this API to implement your own client "self-service" module.
178 If you just want to customize the look of the existing "self-service" module,
181 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
193 =head1 "MY ACCOUNT" FUNCTIONS
199 Creates a user session. Takes a hash reference as parameter with the
212 Returns a hash reference with the following keys:
218 Empty on success, or an error message on errors.
222 Session identifier for successful logins
226 =item customer_info HASHREF
228 Returns general customer information.
230 Takes a hash reference as parameter with a single key: B<session_id>
232 Returns a hash reference with the following keys:
246 Array reference of hash references of open inoices. Each hash reference has
247 the following keys: invnum, date, owed
251 An HTML fragment containing shipping and billing addresses.
253 =item The following fields are also returned: first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo payname month year invoicing_list postal_invoicing
257 =item edit_info HASHREF
259 Takes a hash reference as parameter with any of the following keys:
261 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
263 If a field exists, the customer record is updated with the new value of that
264 field. If a field does not exist, that field is not changed on the customer
267 Returns a hash reference with a single key, B<error>, empty on success, or an
268 error message on errors
270 =item invoice HASHREF
272 Returns an invoice. Takes a hash reference as parameter with two keys:
273 session_id and invnum
275 Returns a hash reference with the following keys:
281 Empty on success, or an error message on errors
293 =item list_invoices HASHREF
295 Returns a list of all customer invoices. Takes a hash references with a single
298 Returns a hash reference with the following keys:
304 Empty on success, or an error message on errors
308 Reference to array of hash references with the following keys:
318 Invoice date, in UNIX epoch time
326 Cancels this customer.
328 Takes a hash reference as parameter with a single key: B<session_id>
330 Returns a hash reference with a single key, B<error>, which is empty on
331 success or an error message on errors.
333 =item payment_info HASHREF
335 Returns information that may be useful in displaying a payment page.
337 Takes a hash reference as parameter with a single key: B<session_id>.
339 Returns a hash reference with the following keys:
345 Empty on success, or an error message on errors
353 Exact name on credit card (CARD/DCRD)
367 Customer's current default payment type.
371 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
375 For CARD/DCRD payment types, the card number
379 For CARD/DCRD payment types, expiration month
383 For CARD/DCRD payment types, expiration year
385 =item cust_main_county
387 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
391 Array reference of all states in the current default country.
395 Hash reference of card types; keys are card types, values are the exact strings
396 passed to the process_payment function
400 Unique transaction identifier (prevents multiple charges), passed to the
401 process_payment function
405 =item process_payment HASHREF
407 Processes a payment and possible change of address or payment type. Takes a
408 hash reference as parameter with the following keys:
416 If true, address and card information entered will be saved for subsequent
421 If true, future credit card payments will be done automatically (sets payby to
422 CARD). If false, future credit card payments will be done on-demand (sets
423 payby to DCRD). This option only has meaning if B<save> is set true.
443 Card expiration month
451 Unique transaction identifier, returned from the payment_info function.
452 Prevents multiple charges.
456 Returns a hash reference with a single key, B<error>, empty on success, or an
457 error message on errors
461 Returns package information for this customer.
463 Takes a hash reference as parameter with a single key: B<session_id>
465 Returns a hash reference containing customer package information. The hash reference contains the following keys:
469 =item cust_pkg HASHREF
471 Array reference of hash references, each of which has the fields of a cust_pkg record (see L<FS::cust_pkg>). Note these are not FS::cust_pkg objects, but hash references of columns and values.
477 Orders a package for this customer.
479 Takes a hash reference as parameter with the following keys:
489 optional svcpart, required only if the package definition does not contain
490 one svc_acct service definition with quantity 1 (it may contain others with
503 Returns a hash reference with a single key, B<error>, empty on success, or an
504 error message on errors. The special error '_decline' is returned for
505 declined transactions.
509 Cancels a package for this customer.
511 Takes a hash reference as parameter with the following keys:
521 Returns a hash reference with a single key, B<error>, empty on success, or an
522 error message on errors.
526 =head1 SIGNUP FUNCTIONS
530 =item signup_info HASHREF
532 Takes a hash reference as parameter with the following keys:
536 =item session_id - Optional agent/reseller interface session
540 Returns a hash reference containing information that may be useful in
541 displaying a signup page. The hash reference contains the following keys:
545 =item cust_main_county
547 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
551 Available packages - array reference of hash references, each of which has the fields of a part_pkg record (see L<FS::part_pkg>). Each hash reference also has an additional 'payby' field containing an array reference of acceptable payment types specific to this package (see below and L<FS::part_pkg/payby>). Note these are not FS::part_pkg objects, but hash references of columns and values. Requires the 'signup_server-default_agentnum' configuration value to be set, or
552 an agentnum specified explicitly via reseller interface session_id in the
557 Array reference of hash references, each of which has the fields of an agent record (see L<FS::agent>). Note these are not FS::agent objects, but hash references of columns and values.
559 =item agentnum2part_pkg
561 Hash reference; keys are agentnums, values are array references of available packages for that agent, in the same format as the part_pkg arrayref above.
565 Access numbers - array reference of hash references, each of which has the fields of an svc_acct_pop record (see L<FS::svc_acct_pop>). Note these are not FS::svc_acct_pop objects, but hash references of columns and values.
567 =item security_phrase
569 True if the "security_phrase" feature is enabled
573 Array reference of acceptable payment types for signup
577 =item CARD (credit card - automatic)
579 =item DCRD (credit card - on-demand - version 1.5+ only)
581 =item CHEK (electronic check - automatic)
583 =item DCHK (electronic check - on-demand - version 1.5+ only)
585 =item LECB (Phone bill billing)
587 =item BILL (billing, not recommended for signups)
589 =item COMP (free, definately not recommended for signups)
591 =item PREPAY (special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL)
597 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
601 Hash reference of message catalog values, to support error message customization. Currently available keys are: passwords_dont_match, invalid_card, unknown_card_type, and not_a (as in "Not a Discover card"). Values are configured in the web interface under "View/Edit message catalog".
613 =item new_customer HASHREF
615 Creates a new customer. Takes a hash reference as parameter with the
620 =item first - first name (required)
622 =item last - last name (required)
624 =item ss (not typically collected; mostly used for ACH transactions)
628 =item address1 (required)
632 =item city (required)
636 =item state (required)
640 =item daytime - phone
646 =item payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
648 =item payinfo - Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
650 =item paycvv - Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
652 =item paydate - Expiration date for CARD/DCRD
654 =item payname - Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
656 =item invoicing_list - comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses),
658 =item referral_custnum - referring customer number
660 =item pkgpart - pkgpart of initial package
666 =item sec_phrase - security phrase
668 =item popnum - access number (index, not the literal number)
670 =item agentnum - agent number
674 Returns a hash reference with the following keys:
678 =item error Empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Sysadmin | View/Edit message catalog)
682 =item regionselector HASHREF | LIST
684 Takes as input a hashref or list of key/value pairs with the following keys:
688 =item selected_county
692 =item selected_country
694 =item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
696 =item onchange - Specify a javascript subroutine to call on changes
700 =item default_country
702 =item locales - An arrayref of hash references specifying regions. Normally you can just pass the value of the I<cust_main_county> field returned by B<signup_info>.
706 Returns a list consisting of three HTML fragments for county selection,
707 state selection and country selection, respectively.
711 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
719 $param->{'selected_country'} ||= $param->{'default_country'};
720 $param->{'selected_state'} ||= $param->{'default_state'};
722 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
726 my %cust_main_county;
728 # unless ( @cust_main_county ) { #cache
729 #@cust_main_county = qsearch('cust_main_county', {} );
730 #foreach my $c ( @cust_main_county ) {
731 foreach my $c ( @{ $param->{'locales'} } ) {
732 #$countyflag=1 if $c->county;
733 $countyflag=1 if $c->{county};
734 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
735 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
736 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
739 $countyflag=1 if $param->{selected_county};
741 my $script_html = <<END;
743 function opt(what,value,text) {
744 var optionName = new Option(text, value, false, false);
745 var length = what.length;
746 what.options[length] = optionName;
748 function ${prefix}country_changed(what) {
749 country = what.options[what.selectedIndex].text;
750 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
751 what.form.${prefix}state.options[i] = null;
753 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
755 foreach my $country ( sort keys %cust_main_county ) {
756 $script_html .= "\nif ( country == \"$country\" ) {\n";
757 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
758 my $text = $state || '(n/a)';
759 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
761 $script_html .= "}\n";
764 $script_html .= <<END;
766 function ${prefix}state_changed(what) {
770 $script_html .= <<END;
771 state = what.options[what.selectedIndex].text;
772 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
773 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
774 what.form.${prefix}county.options[i] = null;
777 foreach my $country ( sort keys %cust_main_county ) {
778 $script_html .= "\nif ( country == \"$country\" ) {\n";
779 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
780 $script_html .= "\nif ( state == \"$state\" ) {\n";
781 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
782 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
783 my $text = $county || '(n/a)';
785 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
787 $script_html .= "}\n";
789 $script_html .= "}\n";
793 $script_html .= <<END;
798 my $county_html = $script_html;
800 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
801 $county_html .= '</SELECT>';
804 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
807 my $state_html = qq!<SELECT NAME="${prefix}state" !.
808 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
809 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
810 my $text = $state || '(n/a)';
811 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
812 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
814 $state_html .= '</SELECT>';
816 $state_html .= '</SELECT>';
818 my $country_html = qq!<SELECT NAME="${prefix}country" !.
819 qq!onChange="${prefix}country_changed(this); $param->{'onchange'}">!;
820 my $countrydefault = $param->{default_country} || 'US';
821 foreach my $country (
822 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
823 keys %cust_main_county
825 my $selected = $country eq $param->{'selected_country'} ? ' SELECTED' : '';
826 $country_html .= "\n<OPTION$selected>$country</OPTION>"
828 $country_html .= '</SELECT>';
830 ($county_html, $state_html, $country_html);
834 #=item expselect HASHREF | LIST
836 #Takes as input a hashref or list of key/value pairs with the following keys:
840 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
842 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
846 =item expselect PREFIX [ DATE ]
848 Takes as input a unique prefix string and the current expiration date, in
849 yyyy-mm-dd or m-d-yyyy format
851 Returns an HTML fragments for expiration date selection.
861 #my $prefix = $param->{'prefix'};
862 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
863 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
865 my $date = scalar(@_) ? shift : '';
867 my( $m, $y ) = ( 0, 0 );
868 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
869 ( $m, $y ) = ( $2, $1 );
870 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
871 ( $m, $y ) = ( $1, $3 );
873 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
875 $return .= "<OPTION";
876 $return .= " SELECTED" if $_ == $m;
879 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
881 my $thisYear = $t[5] + 1900;
882 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. 2037 ) {
883 $return .= "<OPTION";
884 $return .= " SELECTED" if $_ == $y;
887 $return .= "</SELECT>";
892 =item popselector HASHREF | LIST
894 Takes as input a hashref or list of key/value pairs with the following keys:
900 =item pops - An arrayref of hash references specifying access numbers. Normally you can just pass the value of the I<svc_acct_pop> field returned by B<signup_info>.
904 Returns an HTML fragment for access number selection.
908 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
916 my $popnum = $param->{'popnum'};
917 my $pops = $param->{'pops'};
919 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
920 return $pops->[0]{city}. ', '. $pops->[0]{state}.
921 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
922 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
923 if scalar(@$pops) == 1;
928 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
929 $popnum2pop{$_->{popnum}} = $_;
934 function opt(what,href,text) {
935 var optionName = new Option(text, href, false, false)
936 var length = what.length;
937 what.options[length] = optionName;
941 my $init_popstate = $param->{'init_popstate'};
942 if ( $init_popstate ) {
943 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
944 $init_popstate. '">';
947 function acstate_changed(what) {
948 state = what.options[what.selectedIndex].text;
949 what.form.popac.options.length = 0
950 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
954 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
955 foreach my $state ( sort { $a cmp $b } @states ) {
956 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
958 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
959 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
960 if ($ac eq $param->{'popac'}) {
961 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
964 $text .= "}\n" unless $init_popstate;
966 $text .= "popac_changed(what.form.popac)}\n";
969 function popac_changed(what) {
970 ac = what.options[what.selectedIndex].text;
971 what.form.popnum.options.length = 0;
972 what.form.popnum.options[0] = new Option("City", "-1", false, true);
976 foreach my $state ( @states ) {
977 foreach my $popac ( keys %{ $pop{$state} } ) {
978 $text .= "\nif ( ac == \"$popac\" ) {\n";
980 foreach my $pop ( @{$pop{$state}->{$popac}}) {
981 my $o_popnum = $pop->{popnum};
982 my $poptext = $pop->{city}. ', '. $pop->{state}.
983 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
985 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
986 if ($popnum == $o_popnum) {
987 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
995 $text .= "}\n</SCRIPT>\n";
998 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
999 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1000 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1001 ">$_" foreach sort { $a cmp $b } @states;
1002 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1005 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1006 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1008 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1011 #comment this block to disable initial list polulation
1012 my @initial_select = ();
1013 if ( scalar( @$pops ) > 100 ) {
1014 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1016 @initial_select = @$pops;
1018 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1019 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1020 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1021 $pop->{city}. ', '. $pop->{state}.
1022 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1025 $text .= qq!</SELECT></TD></TR></TABLE>!;
1033 =head1 RESELLER FUNCTIONS
1035 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1036 with their active session.
1044 =item agent_list_customers
1052 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>