1 package FS::SelfService;
4 use vars qw($VERSION @ISA @EXPORT_OK $socket %autoload $tag);
10 use Storable 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 'signup_info' => 'Signup/signup_info',
35 'new_customer' => 'Signup/new_customer',
37 @EXPORT_OK = keys %autoload;
39 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
40 $ENV{'SHELL'} = '/bin/sh';
41 $ENV{'IFS'} = " \t\n";
44 $ENV{'BASH_ENV'} = '';
46 my $freeside_uid = scalar(getpwnam('freeside'));
47 die "not running as the freeside user\n" if $> != $freeside_uid;
49 foreach my $autoload ( keys %autoload ) {
60 $param->{_packet} = \''. $autoload{$autoload}. '\';
62 simple_packet($param);
72 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
73 connect(SOCK, sockaddr_un($socket)) or die "connect: $!";
74 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
77 #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
79 #block until there is a message on socket
80 # my $w = new IO::Select;
82 # my @wait = $w->can_read;
83 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
84 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
91 FS::SelfService - Freeside self-service API
95 # password and shell account changes
96 use FS::SelfService qw(passwd chfn chsh);
98 # "my account" functionality
99 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
101 my $rv = login( { 'username' => $username,
103 'password' => $password,
107 if ( $rv->{'error'} ) {
108 #handle login error...
111 my $session_id = $rv->{'session_id'};
114 my $customer_info = customer_info( { 'session_id' => $session_id } );
116 #payment_info and process_payment are available in 1.5+ only
117 my $payment_info = payment_info( { 'session_id' => $session_id } );
119 #!!! process_payment example
121 #!!! list_pkgs example
123 #!!! order_pkg example
125 #!!! cancel_pkg example
127 # signup functionality
128 use FS::SelfService qw( signup_info new_customer );
130 my $signup_info = signup_info;
132 $rv = new_customer( {
135 'company' => $company,
136 'address1' => $address1,
137 'address2' => $address2,
141 'country' => $country,
142 'daytime' => $daytime,
146 'payinfo' => $payinfo,
148 'paydate' => $paydate,
149 'payname' => $payname,
150 'invoicing_list' => $invoicing_list,
151 'referral_custnum' => $referral_custnum,
152 'pkgpart' => $pkgpart,
153 'username' => $username,
154 '_password' => $password,
156 'agentnum' => $agentnum,
160 my $error = $rv->{'error'};
161 if ( $error eq '_decline' ) {
171 Use this API to implement your own client "self-service" module.
173 If you just want to customize the look of the existing "self-service" module,
176 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
188 =head1 "MY ACCOUNT" FUNCTIONS
194 Creates a user session. Takes a hash reference as parameter with the
207 Returns a hash reference with the following keys:
213 Empty on success, or an error message on errors.
217 Session identifier for successful logins
221 =item customer_info HASHREF
223 Returns general customer information.
225 Takes a hash reference as parameter with a single key: B<session_id>
227 Returns a hash reference with the following keys:
241 Array reference of hash references of open inoices. Each hash reference has
242 the following keys: invnum, date, owed
246 An HTML fragment containing shipping and billing addresses.
248 =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
252 =item edit_info HASHREF
254 Takes a hash reference as parameter with any of the following keys:
256 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
258 If a field exists, the customer record is updated with the new value of that
259 field. If a field does not exist, that field is not changed on the customer
262 Returns a hash reference with a single key, B<error>, empty on success, or an
263 error message on errors
265 =item invoice HASHREF
267 Returns an invoice. Takes a hash reference as parameter with two keys:
268 session_id and invnum
270 Returns a hash reference with the following keys:
276 Empty on success, or an error message on errors
290 Cancels this customer.
292 Takes a hash reference as parameter with a single key: B<session_id>
294 Returns a hash reference with a single key, B<error>, which is empty on
295 success or an error message on errors.
297 =item payment_info HASHREF
299 Returns information that may be useful in displaying a payment page.
301 Takes a hash reference as parameter with a single key: B<session_id>.
303 Returns a hash reference with the following keys:
309 Empty on success, or an error message on errors
317 Exact name on credit card (CARD/DCRD)
331 Customer's current default payment type.
335 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
339 For CARD/DCRD payment types, the card number
343 For CARD/DCRD payment types, expiration month
347 For CARD/DCRD payment types, expiration year
349 =item cust_main_county
351 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.
355 Array reference of all states in the current default country.
359 Hash reference of card types; keys are card types, values are the exact strings
360 passed to the process_payment function
364 Unique transaction identifier (prevents multiple charges), passed to the
365 process_payment function
369 =item process_payment HASHREF
371 Processes a payment and possible change of address or payment type. Takes a
372 hash reference as parameter with the following keys:
380 If true, address and card information entered will be saved for subsequent
385 If true, future credit card payments will be done automatically (sets payby to
386 CARD). If false, future credit card payments will be done on-demand (sets
387 payby to DCRD). This option only has meaning if B<save> is set true.
407 Card expiration month
415 Unique transaction identifier, returned from the payment_info function.
416 Prevents multiple charges.
420 Returns a hash reference with a single key, B<error>, empty on success, or an
421 error message on errors
425 Returns package information for this customer.
427 Takes a hash reference as parameter with a single key: B<session_id>
429 Returns a hash reference containing customer package information. The hash reference contains the following keys:
433 =item cust_pkg HASHREF
435 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.
441 Orders a package for this customer.
443 Takes a hash reference as parameter with the following keys:
453 optional svcpart, required only if the package definition does not contain
454 one svc_acct service definition with quantity 1 (it may contain others with
467 Returns a hash reference with a single key, B<error>, empty on success, or an
468 error message on errors. The special error '_decline' is returned for
469 declined transactions.
473 Cancels a package for this customer.
475 Takes a hash reference as parameter with the following keys:
485 Returns a hash reference with a single key, B<error>, empty on success, or an
486 error message on errors.
490 =head1 SIGNUP FUNCTIONS
496 Returns a hash reference containing information that may be useful in
497 displaying a signup page. The hash reference contains the following keys:
501 =item cust_main_county
503 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.
507 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.
511 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.
513 =item agentnum2part_pkg
515 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.
519 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.
521 =item security_phrase
523 True if the "security_phrase" feature is enabled
527 Array reference of acceptable payment types for signup
531 =item CARD (credit card - automatic)
533 =item DCRD (credit card - on-demand - version 1.5+ only)
535 =item CHEK (electronic check - automatic)
537 =item DCHK (electronic check - on-demand - version 1.5+ only)
539 =item LECB (Phone bill billing)
541 =item BILL (billing, not recommended for signups)
543 =item COMP (free, definately not recommended for signups)
545 =item PREPAY (special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL)
551 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
555 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".
567 =item new_customer HASHREF
569 Creates a new customer. Takes a hash reference as parameter with the
574 =item first - first name (required)
576 =item last - last name (required)
578 =item ss (not typically collected; mostly used for ACH transactions)
582 =item address1 (required)
586 =item city (required)
590 =item state (required)
594 =item daytime - phone
600 =item payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
602 =item payinfo - Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
604 =item paycvv - Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
606 =item paydate - Expiration date for CARD/DCRD
608 =item payname - Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
610 =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),
612 =item referral_custnum - referring customer number
614 =item pkgpart - pkgpart of initial package
620 =item sec_phrase - security phrase
622 =item popnum - access number (index, not the literal number)
624 =item agentnum - agent number
628 Returns a hash reference with the following keys:
632 =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)
643 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>