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 'cancel' => 'MyAccount/cancel',
29 'payment_info' => 'MyAccount/payment_info',
30 'process_payment' => 'MyAccount/process_payment',
31 'list_pkgs' => 'MyAccount/list_pkgs',
32 'order_pkg' => 'MyAccount/order_pkg',
33 'cancel_pkg' => 'MyAccount/cancel_pkg',
34 'charge' => 'MyAccount/charge',
35 'signup_info' => 'Signup/signup_info',
36 'new_customer' => 'Signup/new_customer',
38 @EXPORT_OK = keys %autoload;
40 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
41 $ENV{'SHELL'} = '/bin/sh';
42 $ENV{'IFS'} = " \t\n";
45 $ENV{'BASH_ENV'} = '';
47 my $freeside_uid = scalar(getpwnam('freeside'));
48 die "not running as the freeside user\n" if $> != $freeside_uid;
50 foreach my $autoload ( keys %autoload ) {
61 $param->{_packet} = \''. $autoload{$autoload}. '\';
63 simple_packet($param);
73 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
74 connect(SOCK, sockaddr_un($socket)) or die "connect: $!";
75 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
78 #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
80 #block until there is a message on socket
81 # my $w = new IO::Select;
83 # my @wait = $w->can_read;
84 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
85 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
92 FS::SelfService - Freeside self-service API
96 # password and shell account changes
97 use FS::SelfService qw(passwd chfn chsh);
99 # "my account" functionality
100 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
102 my $rv = login( { 'username' => $username,
104 'password' => $password,
108 if ( $rv->{'error'} ) {
109 #handle login error...
112 my $session_id = $rv->{'session_id'};
115 my $customer_info = customer_info( { 'session_id' => $session_id } );
117 #payment_info and process_payment are available in 1.5+ only
118 my $payment_info = payment_info( { 'session_id' => $session_id } );
120 #!!! process_payment example
122 #!!! list_pkgs example
124 #!!! order_pkg example
126 #!!! cancel_pkg example
128 # signup functionality
129 use FS::SelfService qw( signup_info new_customer );
131 my $signup_info = signup_info;
133 $rv = new_customer( {
136 'company' => $company,
137 'address1' => $address1,
138 'address2' => $address2,
142 'country' => $country,
143 'daytime' => $daytime,
147 'payinfo' => $payinfo,
149 'paydate' => $paydate,
150 'payname' => $payname,
151 'invoicing_list' => $invoicing_list,
152 'referral_custnum' => $referral_custnum,
153 'pkgpart' => $pkgpart,
154 'username' => $username,
155 '_password' => $password,
157 'agentnum' => $agentnum,
161 my $error = $rv->{'error'};
162 if ( $error eq '_decline' ) {
172 Use this API to implement your own client "self-service" module.
174 If you just want to customize the look of the existing "self-service" module,
177 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
189 =head1 "MY ACCOUNT" FUNCTIONS
195 Creates a user session. Takes a hash reference as parameter with the
208 Returns a hash reference with the following keys:
214 Empty on success, or an error message on errors.
218 Session identifier for successful logins
222 =item customer_info HASHREF
224 Returns general customer information.
226 Takes a hash reference as parameter with a single key: B<session_id>
228 Returns a hash reference with the following keys:
242 Array reference of hash references of open inoices. Each hash reference has
243 the following keys: invnum, date, owed
247 An HTML fragment containing shipping and billing addresses.
249 =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
253 =item edit_info HASHREF
255 Takes a hash reference as parameter with any of the following keys:
257 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
259 If a field exists, the customer record is updated with the new value of that
260 field. If a field does not exist, that field is not changed on the customer
263 Returns a hash reference with a single key, B<error>, empty on success, or an
264 error message on errors
266 =item invoice HASHREF
268 Returns an invoice. Takes a hash reference as parameter with two keys:
269 session_id and invnum
271 Returns a hash reference with the following keys:
277 Empty on success, or an error message on errors
291 Cancels this customer.
293 Takes a hash reference as parameter with a single key: B<session_id>
295 Returns a hash reference with a single key, B<error>, which is empty on
296 success or an error message on errors.
298 =item payment_info HASHREF
300 Returns information that may be useful in displaying a payment page.
302 Takes a hash reference as parameter with a single key: B<session_id>.
304 Returns a hash reference with the following keys:
310 Empty on success, or an error message on errors
318 Exact name on credit card (CARD/DCRD)
332 Customer's current default payment type.
336 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
340 For CARD/DCRD payment types, the card number
344 For CARD/DCRD payment types, expiration month
348 For CARD/DCRD payment types, expiration year
350 =item cust_main_county
352 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.
356 Array reference of all states in the current default country.
360 Hash reference of card types; keys are card types, values are the exact strings
361 passed to the process_payment function
365 Unique transaction identifier (prevents multiple charges), passed to the
366 process_payment function
370 =item process_payment HASHREF
372 Processes a payment and possible change of address or payment type. Takes a
373 hash reference as parameter with the following keys:
381 If true, address and card information entered will be saved for subsequent
386 If true, future credit card payments will be done automatically (sets payby to
387 CARD). If false, future credit card payments will be done on-demand (sets
388 payby to DCRD). This option only has meaning if B<save> is set true.
408 Card expiration month
416 Unique transaction identifier, returned from the payment_info function.
417 Prevents multiple charges.
421 Returns a hash reference with a single key, B<error>, empty on success, or an
422 error message on errors
426 Returns package information for this customer.
428 Takes a hash reference as parameter with a single key: B<session_id>
430 Returns a hash reference containing customer package information. The hash reference contains the following keys:
434 =item cust_pkg HASHREF
436 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.
442 Orders a package for this customer.
444 Takes a hash reference as parameter with the following keys:
454 optional svcpart, required only if the package definition does not contain
455 one svc_acct service definition with quantity 1 (it may contain others with
468 Returns a hash reference with a single key, B<error>, empty on success, or an
469 error message on errors. The special error '_decline' is returned for
470 declined transactions.
474 Cancels a package for this customer.
476 Takes a hash reference as parameter with the following keys:
486 Returns a hash reference with a single key, B<error>, empty on success, or an
487 error message on errors.
491 =head1 SIGNUP FUNCTIONS
497 Returns a hash reference containing information that may be useful in
498 displaying a signup page. The hash reference contains the following keys:
502 =item cust_main_county
504 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.
508 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.
512 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.
514 =item agentnum2part_pkg
516 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.
520 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.
522 =item security_phrase
524 True if the "security_phrase" feature is enabled
528 Array reference of acceptable payment types for signup
532 =item CARD (credit card - automatic)
534 =item DCRD (credit card - on-demand - version 1.5+ only)
536 =item CHEK (electronic check - automatic)
538 =item DCHK (electronic check - on-demand - version 1.5+ only)
540 =item LECB (Phone bill billing)
542 =item BILL (billing, not recommended for signups)
544 =item COMP (free, definately not recommended for signups)
546 =item PREPAY (special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL)
552 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
556 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".
568 =item new_customer HASHREF
570 Creates a new customer. Takes a hash reference as parameter with the
575 =item first - first name (required)
577 =item last - last name (required)
579 =item ss (not typically collected; mostly used for ACH transactions)
583 =item address1 (required)
587 =item city (required)
591 =item state (required)
595 =item daytime - phone
601 =item payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
603 =item payinfo - Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
605 =item paycvv - Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
607 =item paydate - Expiration date for CARD/DCRD
609 =item payname - Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
611 =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),
613 =item referral_custnum - referring customer number
615 =item pkgpart - pkgpart of initial package
621 =item sec_phrase - security phrase
623 =item popnum - access number (index, not the literal number)
625 =item agentnum - agent number
629 Returns a hash reference with the following keys:
633 =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)
644 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>