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 'list_pkgs' => 'MyAccount/list_pkgs',
30 'order_pkg' => 'MyAccount/order_pkg',
31 'cancel_pkg' => 'MyAccount/cancel_pkg',
32 'signup_info' => 'Signup/signup_info',
33 'new_customer' => 'Signup/new_customer',
35 @EXPORT_OK = keys %autoload;
37 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
38 $ENV{'SHELL'} = '/bin/sh';
39 $ENV{'IFS'} = " \t\n";
42 $ENV{'BASH_ENV'} = '';
44 my $freeside_uid = scalar(getpwnam('freeside'));
45 die "not running as the freeside user\n" if $> != $freeside_uid;
47 foreach my $autoload ( keys %autoload ) {
58 $param->{_packet} = \''. $autoload{$autoload}. '\';
60 simple_packet($param);
70 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
71 connect(SOCK, sockaddr_un($socket)) or die "connect: $!";
72 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
75 #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
77 #block until there is a message on socket
78 # my $w = new IO::Select;
80 # my @wait = $w->can_read;
81 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
82 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
89 FS::SelfService - Freeside self-service API
93 # password and shell account changes
94 use FS::SelfService qw(passwd chfn chsh);
96 # "my account" functionality
97 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
99 my $rv = login( { 'username' => $username,
101 'password' => $password,
105 if ( $rv->{'error'} ) {
106 #handle login error...
109 my $session_id = $rv->{'session_id'};
112 my $customer_info = customer_info( { 'session_id' => $session_id } );
114 #payment_info and process_payment are available in 1.5+ only
115 my $payment_info = payment_info( { 'session_id' => $session_id } );
117 #!!! process_payment example
119 #!!! list_pkgs example
121 #!!! order_pkg example
123 #!!! cancel_pkg example
125 # signup functionality
126 use FS::SelfService qw( signup_info new_customer );
128 my $signup_info = signup_info;
130 $rv = new_customer( {
133 'company' => $company,
134 'address1' => $address1,
135 'address2' => $address2,
139 'country' => $country,
140 'daytime' => $daytime,
144 'payinfo' => $payinfo,
146 'paydate' => $paydate,
147 'payname' => $payname,
148 'invoicing_list' => $invoicing_list,
149 'referral_custnum' => $referral_custnum,
150 'pkgpart' => $pkgpart,
151 'username' => $username,
152 '_password' => $password,
154 'agentnum' => $agentnum,
158 my $error = $rv->{'error'};
159 if ( $error eq '_decline' ) {
169 Use this API to implement your own client "self-service" module.
171 If you just want to customize the look of the existing "self-service" module,
174 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
186 =head1 "MY ACCOUNT" FUNCTIONS
192 Creates a user session. Takes a hash reference as parameter with the
205 Returns a hash reference with the following keys:
211 Empty on success, or an error message on errors.
215 Session identifier for successful logins
219 =item customer_info HASHREF
221 Returns general customer information.
223 Takes a hash reference as parameter with a single key: B<session_id>
225 Returns a hash reference with the following keys:
239 Array reference of hash references of open inoices. Each hash reference has
240 the following keys: invnum, date, owed
244 An HTML fragment containing shipping and billing addresses.
246 =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
250 =item edit_info HASHREF
252 Takes a hash reference as parameter with any of the following keys:
254 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
256 If a field exists, the customer record is updated with the new value of that
257 field. If a field does not exist, that field is not changed on the customer
260 Returns a hash reference with a single key, B<error>, empty on success, or an
261 error message on errors
263 =item invoice HASHREF
265 Returns an invoice. Takes a hash reference as parameter with two keys:
266 session_id and invnum
268 Returns a hash reference with the following keys:
274 Empty on success, or an error message on errors
288 Cancels this customer.
290 Takes a hash reference as parameter with a single key: B<session_id>
292 Returns a hash reference with a single key, B<error>, which is empty on
293 success or an error message on errors.
295 =item payment_info HASHREF
297 Returns information that may be useful in displaying a payment page.
299 Takes a hash reference as parameter with a single key: B<session_id>.
301 Returns a hash reference with the following keys:
307 Empty on success, or an error message on errors
315 Exact name on credit card (CARD/DCRD)
329 Customer's current default payment type.
333 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
337 For CARD/DCRD payment types, the card number
341 For CARD/DCRD payment types, expiration month
345 For CARD/DCRD payment types, expiration year
347 =item cust_main_county
349 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.
353 Array reference of all states in the current default country.
357 Hash reference of card types; keys are card types, values are the exact strings
358 passed to the process_payment function
362 Unique transaction identifier (prevents multiple charges), passed to the
363 process_payment function
367 =item process_payment HASHREF
369 Processes a payment and possible change of address or payment type. Takes a
370 hash reference as parameter with the following keys:
378 If true, address and card information entered will be saved for subsequent
383 If true, future credit card payments will be done automatically (sets payby to
384 CARD). If false, future credit card payments will be done on-demand (sets
385 payby to DCRD). This option only has meaning if B<save> is set true.
405 Card expiration month
413 Unique transaction identifier, returned from the payment_info function.
414 Prevents multiple charges.
418 Returns a hash reference with a single key, B<error>, empty on success, or an
419 error message on errors
423 Returns package information for this customer.
425 Takes a hash reference as parameter with a single key: B<session_id>
427 Returns a hash reference containing customer package information. The hash reference contains the following keys:
431 =item cust_pkg HASHREF
433 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.
439 Orders a package for this customer.
441 Takes a hash reference as parameter with the following keys:
451 optional svcpart, required only if the package definition does not contain
452 one svc_acct service definition with quantity 1 (it may contain others with
465 Returns a hash reference with a single key, B<error>, empty on success, or an
466 error message on errors. The special error '_decline' is returned for
467 declined transactions.
471 Cancels a package for this customer.
473 Takes a hash reference as parameter with the following keys:
483 Returns a hash reference with a single key, B<error>, empty on success, or an
484 error message on errors.
488 =head1 SIGNUP FUNCTIONS
494 Returns a hash reference containing information that may be useful in
495 displaying a signup page. The hash reference contains the following keys:
499 =item cust_main_county
501 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.
505 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.
509 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.
511 =item agentnum2part_pkg
513 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.
517 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.
519 =item security_phrase
521 True if the "security_phrase" feature is enabled
525 Array reference of acceptable payment types for signup
529 =item CARD (credit card - automatic)
531 =item DCRD (credit card - on-demand - version 1.5+ only)
533 =item CHEK (electronic check - automatic)
535 =item DCHK (electronic check - on-demand - version 1.5+ only)
537 =item LECB (Phone bill billing)
539 =item BILL (billing, not recommended for signups)
541 =item COMP (free, definately not recommended for signups)
543 =item PREPAY (special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL)
549 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
553 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".
565 =item new_customer HASHREF
567 Creates a new customer. Takes a hash reference as parameter with the
572 =item first - first name (required)
574 =item last - last name (required)
576 =item ss (not typically collected; mostly used for ACH transactions)
580 =item address1 (required)
584 =item city (required)
588 =item state (required)
592 =item daytime - phone
598 =item payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
600 =item payinfo - Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
602 =item paycvv - Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
604 =item paydate - Expiration date for CARD/DCRD
606 =item payname - Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
608 =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),
610 =item referral_custnum - referring customer number
612 =item pkgpart - pkgpart of initial package
618 =item sec_phrase - security phrase
620 =item popnum - access number (index, not the literal number)
622 =item agentnum - agent number
626 Returns a hash reference with the following keys:
630 =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)
641 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>