1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
35 'billing_history' => 'MyAccount/billing_history',
36 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
37 'invoice' => 'MyAccount/invoice',
38 'invoice_pdf' => 'MyAccount/invoice_pdf',
39 'legacy_invoice' => 'MyAccount/legacy_invoice',
40 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
41 'invoice_logo' => 'MyAccount/invoice_logo',
42 'list_invoices' => 'MyAccount/list_invoices', #?
43 'cancel' => 'MyAccount/cancel', #add to ss cgi!
44 'payment_info' => 'MyAccount/payment_info',
45 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
46 'process_payment' => 'MyAccount/process_payment',
47 'store_payment' => 'MyAccount/store_payment',
48 'process_stored_payment' => 'MyAccount/process_stored_payment',
49 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
50 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
51 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
52 'process_prepay' => 'MyAccount/process_prepay',
53 'realtime_collect' => 'MyAccount/realtime_collect',
54 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
55 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
56 'list_svc_usage' => 'MyAccount/list_svc_usage',
57 'svc_status_html' => 'MyAccount/svc_status_html',
58 'svc_status_hash' => 'MyAccount/svc_status_hash',
59 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
60 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
61 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
62 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
63 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
64 'acct_forward_info' => 'MyAccount/acct_forward_info',
65 'process_acct_forward' => 'MyAccount/process_acct_forward',
66 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
67 'add_dsl_device' => 'MyAccount/add_dsl_device',
68 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
69 'port_graph' => 'MyAccount/port_graph',
70 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
71 'list_support_usage' => 'MyAccount/list_support_usage',
72 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
73 'change_pkg' => 'MyAccount/change_pkg',
74 'order_recharge' => 'MyAccount/order_recharge',
75 'renew_info' => 'MyAccount/renew_info',
76 'order_renew' => 'MyAccount/order_renew',
77 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
78 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
79 'charge' => 'MyAccount/charge', #?
80 'part_svc_info' => 'MyAccount/part_svc_info',
81 'provision_acct' => 'MyAccount/provision_acct',
82 'provision_phone' => 'MyAccount/provision_phone',
83 'provision_external' => 'MyAccount/provision_external',
84 'unprovision_svc' => 'MyAccount/unprovision_svc',
85 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
86 'reset_passwd' => 'MyAccount/reset_passwd',
87 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
88 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
89 'list_tickets' => 'MyAccount/list_tickets',
90 'create_ticket' => 'MyAccount/create_ticket',
91 'get_ticket' => 'MyAccount/get_ticket',
92 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
93 'did_report' => 'MyAccount/did_report',
94 'signup_info' => 'Signup/signup_info',
95 'skin_info' => 'MyAccount/skin_info',
96 'access_info' => 'MyAccount/access_info',
97 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
98 'new_customer' => 'Signup/new_customer',
99 'capture_payment' => 'Signup/capture_payment',
100 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
101 'new_agent' => 'Agent/new_agent',
102 'agent_login' => 'Agent/agent_login',
103 'agent_logout' => 'Agent/agent_logout',
104 'agent_info' => 'Agent/agent_info',
105 'agent_list_customers' => 'Agent/agent_list_customers',
106 'check_username' => 'Agent/check_username',
107 'suspend_username' => 'Agent/suspend_username',
108 'unsuspend_username' => 'Agent/unsuspend_username',
109 'mason_comp' => 'MasonComponent/mason_comp',
110 'call_time' => 'PrepaidPhone/call_time',
111 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
112 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
114 'start_thirdparty' => 'MyAccount/start_thirdparty',
115 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
119 qw( regionselector regionselector_hashref location_form
120 expselect popselector domainselector didselector
124 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
125 $ENV{'SHELL'} = '/bin/sh';
126 $ENV{'IFS'} = " \t\n";
129 $ENV{'BASH_ENV'} = '';
131 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
132 #if you grant appropriate permissions to whatever user
133 my $freeside_uid = scalar(getpwnam('freeside'));
134 die "not running as the freeside user\n"
135 if $> != $freeside_uid && ! $skip_uid_check;
137 -e $dir or die "FATAL: $dir doesn't exist!";
138 -d $dir or die "FATAL: $dir isn't a directory!";
139 -r $dir or die "FATAL: Can't read $dir as freeside user!";
140 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
142 foreach my $autoload ( keys %autoload ) {
145 "sub $autoload { ". '
150 #warn scalar(@_). ": ". join(" / ", @_);
154 $param->{_packet} = \''. $autoload{$autoload}. '\';
156 simple_packet($param);
166 warn "sending ". $packet->{_packet}. " to server"
168 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
169 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
170 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
173 #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
175 #block until there is a message on socket
176 # my $w = new IO::Select;
178 # my @wait = $w->can_read;
180 warn "reading message from server"
183 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
184 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
186 warn "returning message to client"
194 FS::SelfService - Freeside self-service API
198 # password and shell account changes
199 use FS::SelfService qw(passwd chfn chsh);
201 # "my account" functionality
202 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
204 #new-style login with an email address and password
205 # can also be used for svc_acct login, set $emailaddress to username@domain
206 my $rv = login ( { 'email' => $emailaddress,
207 'password' => $password,
210 if ( $rv->{'error'} ) {
211 #handle login error...
214 $session_id = $rv->{'session_id'};
217 #classic svc_acct-based login with separate username and password
218 my $rv = login( { 'username' => $username,
220 'password' => $password,
223 if ( $rv->{'error'} ) {
224 #handle login error...
227 $session_id = $rv->{'session_id'};
230 #svc_phone login with phone number and PIN
231 my $rv = login( { 'username' => $phone_number,
232 'domain' => 'svc_phone',
236 if ( $rv->{'error'} ) {
237 #handle login error...
240 $session_id = $rv->{'session_id'};
243 my $customer_info = customer_info( { 'session_id' => $session_id } );
245 #payment_info and process_payment are available in 1.5+ only
246 my $payment_info = payment_info( { 'session_id' => $session_id } );
248 #!!! process_payment example
250 #!!! list_pkgs example
252 #!!! order_pkg example
254 #!!! cancel_pkg example
256 # signup functionality
257 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
259 my $signup_info = signup_info;
261 $rv = new_customer( {
264 'company' => $company,
265 'address1' => $address1,
266 'address2' => $address2,
270 'country' => $country,
271 'daytime' => $daytime,
275 'payinfo' => $payinfo,
277 'paystart_month' => $paystart_month
278 'paystart_year' => $paystart_year,
279 'payissue' => $payissue,
281 'paydate' => $paydate,
282 'payname' => $payname,
283 'invoicing_list' => $invoicing_list,
284 'referral_custnum' => $referral_custnum,
285 'agentnum' => $agentnum,
286 'pkgpart' => $pkgpart,
288 'username' => $username,
289 '_password' => $password,
293 'phonenum' => $phonenum,
298 my $error = $rv->{'error'};
299 if ( $error eq '_decline' ) {
309 Use this API to implement your own client "self-service" module.
311 If you just want to customize the look of the existing "self-service" module,
314 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
320 Changes the password for an existing user in svc_acct. Takes a hash
321 reference with the following keys:
327 Username of the account (required)
331 Domain of the account (required)
335 Old password (required)
339 New password (required)
357 =head1 "MY ACCOUNT" FUNCTIONS
363 Creates a user session. Takes a hash reference as parameter with the
370 Email address (username@domain), instead of username and domain. Required for
371 contact-based self-service login, can also be used for svc_acct-based login.
387 Returns a hash reference with the following keys:
393 Empty on success, or an error message on errors.
397 Session identifier for successful logins
401 =item customer_info HASHREF
403 Returns general customer information.
405 Takes a hash reference as parameter with a single key: B<session_id>
407 Returns a hash reference with the following keys:
421 Array reference of hash references of open inoices. Each hash reference has
422 the following keys: invnum, date, owed
426 An HTML fragment containing shipping and billing addresses.
428 =item The following fields are also returned
430 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
434 =item edit_info HASHREF
436 Takes a hash reference as parameter with any of the following keys:
438 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
440 If a field exists, the customer record is updated with the new value of that
441 field. If a field does not exist, that field is not changed on the customer
444 Returns a hash reference with a single key, B<error>, empty on success, or an
445 error message on errors
447 =item invoice HASHREF
449 Returns an invoice. Takes a hash reference as parameter with two keys:
450 session_id and invnum
452 Returns a hash reference with the following keys:
458 Empty on success, or an error message on errors
470 =item list_invoices HASHREF
472 Returns a list of all customer invoices. Takes a hash references with a single
475 Returns a hash reference with the following keys:
481 Empty on success, or an error message on errors
485 Reference to array of hash references with the following keys:
495 Invoice date, in UNIX epoch time
503 Cancels this customer.
505 Takes a hash reference as parameter with a single key: B<session_id>
507 Returns a hash reference with a single key, B<error>, which is empty on
508 success or an error message on errors.
510 =item payment_info HASHREF
512 Returns information that may be useful in displaying a payment page.
514 Takes a hash reference as parameter with a single key: B<session_id>.
516 Returns a hash reference with the following keys:
522 Empty on success, or an error message on errors
530 Exact name on credit card (CARD/DCRD)
554 Customer's current default payment type.
558 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
562 For CARD/DCRD payment types, the card number
566 For CARD/DCRD payment types, expiration month
570 For CARD/DCRD payment types, expiration year
572 =item cust_main_county
574 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.
578 Array reference of all states in the current default country.
582 Hash reference of card types; keys are card types, values are the exact strings
583 passed to the process_payment function
587 #this doesn't actually work yet
591 #Unique transaction identifier (prevents multiple charges), passed to the
592 #process_payment function
596 =item process_payment HASHREF
598 Processes a payment and possible change of address or payment type. Takes a
599 hash reference as parameter with the following keys:
613 If true, address and card information entered will be saved for subsequent
618 If true, future credit card payments will be done automatically (sets payby to
619 CARD). If false, future credit card payments will be done on-demand (sets
620 payby to DCRD). This option only has meaning if B<save> is set true.
648 Two-letter country code
656 Card expiration month
664 #this doesn't actually work yet
668 #Unique transaction identifier, returned from the payment_info function.
669 #Prevents multiple charges.
673 Returns a hash reference with a single key, B<error>, empty on success, or an
674 error message on errors.
676 =item process_payment_order_pkg
678 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
679 payment processes sucessfully, the package is ordered. Takes a hash reference
680 as parameter with the keys of both methods.
682 Returns a hash reference with a single key, B<error>, empty on success, or an
683 error message on errors.
685 =item process_payment_change_pkg
687 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
688 payment processes sucessfully, the package is ordered. Takes a hash reference
689 as parameter with the keys of both methods.
691 Returns a hash reference with a single key, B<error>, empty on success, or an
692 error message on errors.
695 =item process_payment_order_renew
697 Combines the B<process_payment> and B<order_renew> functions in one step. If
698 the payment processes sucessfully, the renewal is processed. Takes a hash
699 reference as parameter with the keys of both methods.
701 Returns a hash reference with a single key, B<error>, empty on success, or an
702 error message on errors.
706 Returns package information for this customer. For more detail on services,
709 Takes a hash reference as parameter with a single key: B<session_id>
711 Returns a hash reference containing customer package information. The hash reference contains the following keys:
721 Empty on success, or an error message on errors.
723 =item cust_pkg HASHREF
725 Array reference of hash references, each of which has the fields of a cust_pkg
726 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
727 the internal FS:: objects, but hash references of columns and values.
731 =item part_pkg fields
733 All fields of part_pkg for this specific cust_pkg (be careful with this
734 information - it may reveal more about your available packages than you would
735 like users to know in aggregate)
739 #XXX pare part_pkg fields down to a more secure subset
743 An array of hash references indicating information on unprovisioned services
744 available for provisioning for this specific cust_pkg. Each has the following
749 =item part_svc fields
751 All fields of part_svc (be careful with this information - it may reveal more
752 about your available packages than you would like users to know in aggregate)
756 #XXX pare part_svc fields down to a more secure subset
762 An array of hash references indicating information on the customer services
763 already provisioned for this specific cust_pkg. Each has the following keys:
769 Array reference with three elements: The first element is the name of this service. The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias). The last element is the table name of this service.
775 Primary key for this service
779 Service definition (see L<FS::part_svc>)
783 Customer package (see L<FS::cust_pkg>)
787 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
795 Returns service information for this customer.
797 Takes a hash reference as parameter with a single key: B<session_id>
799 Returns a hash reference containing customer package information. The hash reference contains the following keys:
809 An array of hash references indicating information on all of this customer's
810 services. Each has the following keys:
816 Primary key for this service
824 Meaningful user-specific identifier for the service (i.e. username, domain, or
829 Account (svc_acct) services also have the following keys:
847 Upload bytes remaining
851 Download bytes remaining
855 Total bytes remaining
857 =item recharge_amount
861 =item recharge_seconds
863 Number of seconds gained by recharge
865 =item recharge_upbytes
867 Number of upload bytes gained by recharge
869 =item recharge_downbytes
871 Number of download bytes gained by recharge
873 =item recharge_totalbytes
875 Number of total bytes gained by recharge
883 Orders a package for this customer.
885 Takes a hash reference as parameter with the following keys:
895 Package to order (see L<FS::part_pkg>).
899 Quantity for this package order (default 1).
903 Optional locationnum for this package order, for existing locations.
905 Or, for new locations, pass the following fields: address1*, address2, city*,
906 county, state*, zip*, country. (* = required in this case)
918 Service to order (see L<FS::part_svc>).
920 Normally optional; required only to provision a non-svc_acct service, or if the
921 package definition does not contain one svc_acct service definition with
922 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
923 also be specified to indicate that no initial service should be provisioned.
927 Fields used when provisioning an svc_acct service:
941 Optional security phrase
945 Optional Access number number
949 Fields used when provisioning an svc_domain service:
959 Fields used when provisioning an svc_phone service:
977 Fields used when provisioning an svc_external service:
991 Fields used when provisioning an svc_pbx service:
1005 Returns a hash reference with a single key, B<error>, empty on success, or an
1006 error message on errors. The special error '_decline' is returned for
1007 declined transactions.
1011 Changes a package for this customer.
1013 Takes a hash reference as parameter with the following keys:
1023 Existing customer package.
1027 New package to order (see L<FS::part_pkg>).
1031 Quantity for this package order (default 1).
1035 Returns a hash reference with the following keys:
1041 Empty on success, or an error message on errors.
1045 On success, the new pkgnum
1052 Provides useful info for early renewals.
1054 Takes a hash reference as parameter with the following keys:
1064 Returns a hash reference. On errors, it contains a single key, B<error>, with
1065 the error message. Otherwise, contains a single key, B<dates>, pointing to
1066 an array refernce of hash references. Each hash reference contains the
1073 (Future) Bill date. Indicates a future date for which billing could be run.
1074 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1077 =item bill_date_pretty
1079 (Future) Bill date as a human-readable string. (Convenience for display;
1080 subject to change, so best not to parse for the date.)
1084 Base amount which will be charged if renewed early as of this date.
1088 Renewal date; i.e. even-futher future date at which the customer will be paid
1089 through if the early renewal is completed with the given B<bill-date>.
1090 Specified as a integer UNIX timestamp.
1092 =item renew_date_pretty
1094 Renewal date as a human-readable string. (Convenience for display;
1095 subject to change, so best not to parse for the date.)
1099 Package that will be renewed.
1103 Expiration date of the package that will be renewed.
1105 =item expire_date_pretty
1107 Expiration date of the package that will be renewed, as a human-readable
1108 string. (Convenience for display; subject to change, so best not to parse for
1115 Renews this customer early; i.e. runs billing for this customer in advance.
1117 Takes a hash reference as parameter with the following keys:
1127 Integer date as returned by the B<renew_info> function, indicating the advance
1128 date for which to run billing.
1132 Returns a hash reference with a single key, B<error>, empty on success, or an
1133 error message on errors.
1137 Cancels a package for this customer.
1139 Takes a hash reference as parameter with the following keys:
1149 pkgpart of package to cancel
1153 Returns a hash reference with a single key, B<error>, empty on success, or an
1154 error message on errors.
1158 =head1 SIGNUP FUNCTIONS
1162 =item signup_info HASHREF
1164 Takes a hash reference as parameter with the following keys:
1168 =item session_id - Optional agent/reseller interface session
1172 Returns a hash reference containing information that may be useful in
1173 displaying a signup page. The hash reference contains the following keys:
1177 =item cust_main_county
1179 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.
1183 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
1184 an agentnum specified explicitly via reseller interface session_id in the
1189 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.
1191 =item agentnum2part_pkg
1193 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.
1197 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.
1199 =item security_phrase
1201 True if the "security_phrase" feature is enabled
1205 Array reference of acceptable payment types for signup
1211 credit card - automatic
1215 credit card - on-demand - version 1.5+ only
1219 electronic check - automatic
1223 electronic check - on-demand - version 1.5+ only
1231 billing, not recommended for signups
1235 free, definitely not recommended for signups
1239 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1245 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1249 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".
1255 =item countrydefault
1261 =item new_customer_minimal HASHREF
1263 Creates a new customer.
1265 Current differences from new_customer: An address is not required. promo_code
1266 and reg_code are not supported. If invoicing_list and _password is passed, a
1267 contact will be created with self-service access (no pkgpart or username is
1268 necessary). No initial billing is run (this may change in a future version).
1270 Takes a hash reference as parameter with the following keys:
1276 first name (required)
1280 last name (required)
1284 (not typically collected; mostly used for ACH transactions)
1316 Daytime phone number
1320 Evening phone number
1328 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1332 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1336 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1340 Expiration date for CARD/DCRD
1344 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1346 =item invoicing_list
1348 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),
1350 =item referral_custnum
1352 referring customer number
1360 pkgpart of initial package
1376 Access number (index, not the literal number)
1380 Country code (to be provisioned as a service)
1384 Phone number (to be provisioned as a service)
1392 Returns a hash reference with the following keys:
1398 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 Configuration | View/Edit message catalog)
1402 =item new_customer HASHREF
1404 Creates a new customer. Takes a hash reference as parameter with the
1411 first name (required)
1415 last name (required)
1419 (not typically collected; mostly used for ACH transactions)
1425 =item address1 (required)
1433 =item city (required)
1441 =item state (required)
1445 =item zip (required)
1451 Daytime phone number
1455 Evening phone number
1463 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1467 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1471 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1475 Expiration date for CARD/DCRD
1479 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1481 =item invoicing_list
1483 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),
1485 =item referral_custnum
1487 referring customer number
1495 pkgpart of initial package
1511 Access number (index, not the literal number)
1515 Country code (to be provisioned as a service)
1519 Phone number (to be provisioned as a service)
1527 Returns a hash reference with the following keys:
1533 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 Configuration | View/Edit message catalog)
1537 =item regionselector HASHREF | LIST
1539 Takes as input a hashref or list of key/value pairs with the following keys:
1543 =item selected_county
1545 Currently selected county
1547 =item selected_state
1549 Currently selected state
1551 =item selected_country
1553 Currently selected country
1557 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1561 Specify a javascript subroutine to call on changes
1567 =item default_country
1573 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>.
1577 Returns a list consisting of three HTML fragments for county selection,
1578 state selection and country selection, respectively.
1582 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1583 sub regionselector {
1590 $param->{'selected_country'} ||= $param->{'default_country'};
1591 $param->{'selected_state'} ||= $param->{'default_state'};
1593 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1597 my %cust_main_county;
1599 # unless ( @cust_main_county ) { #cache
1600 #@cust_main_county = qsearch('cust_main_county', {} );
1601 #foreach my $c ( @cust_main_county ) {
1602 foreach my $c ( @{ $param->{'locales'} } ) {
1603 #$countyflag=1 if $c->county;
1604 $countyflag=1 if $c->{county};
1605 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1606 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1607 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1610 $countyflag=1 if $param->{selected_county};
1612 my $script_html = <<END;
1614 function opt(what,value,text) {
1615 var optionName = new Option(text, value, false, false);
1616 var length = what.length;
1617 what.options[length] = optionName;
1619 function ${prefix}country_changed(what) {
1620 country = what.options[what.selectedIndex].text;
1621 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1622 what.form.${prefix}state.options[i] = null;
1624 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1626 foreach my $country ( sort keys %cust_main_county ) {
1627 $script_html .= "\nif ( country == \"$country\" ) {\n";
1628 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1629 my $text = $state || '(n/a)';
1630 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1632 $script_html .= "}\n";
1635 $script_html .= <<END;
1637 function ${prefix}state_changed(what) {
1640 if ( $countyflag ) {
1641 $script_html .= <<END;
1642 state = what.options[what.selectedIndex].text;
1643 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1644 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1645 what.form.${prefix}county.options[i] = null;
1648 foreach my $country ( sort keys %cust_main_county ) {
1649 $script_html .= "\nif ( country == \"$country\" ) {\n";
1650 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1651 $script_html .= "\nif ( state == \"$state\" ) {\n";
1652 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1653 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1654 my $text = $county || '(n/a)';
1656 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1658 $script_html .= "}\n";
1660 $script_html .= "}\n";
1664 $script_html .= <<END;
1669 my $county_html = $script_html;
1670 if ( $countyflag ) {
1671 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1672 foreach my $county (
1673 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1675 my $text = $county || '(n/a)';
1676 $county_html .= qq!<OPTION VALUE="$county"!.
1677 ($county eq $param->{'selected_county'} ?
1684 $county_html .= '</SELECT>';
1687 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1690 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1691 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1692 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1693 my $text = $state || '(n/a)';
1694 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1695 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1697 $state_html .= '</SELECT>';
1699 my $country_html = '';
1700 if ( scalar( keys %cust_main_county ) > 1 ) {
1702 $country_html = qq(<SELECT NAME="${prefix}country" ).
1703 qq(onChange="${prefix}country_changed(this); ).
1704 $param->{'onchange'}.
1707 my $countrydefault = $param->{default_country} || 'US';
1708 foreach my $country (
1709 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1710 keys %cust_main_county
1712 my $selected = $country eq $param->{'selected_country'}
1715 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1717 $country_html .= '</SELECT>';
1720 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1721 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1725 ($county_html, $state_html, $country_html);
1729 sub regionselector_hashref {
1730 my ($county_html, $state_html, $country_html) = regionselector(@_);
1732 'county_html' => $county_html,
1733 'state_html' => $state_html,
1734 'country_html' => $country_html,
1738 =item location_form HASHREF | LIST
1740 Takes as input a hashref or list of key/value pairs with the following keys:
1746 Current customer session_id
1750 Omit red asterisks from required fields.
1752 =item address1_label
1754 Label for first address line.
1758 Returns an HTML fragment for a location form (address, city, state, zip,
1771 my $session_id = delete $param->{'session_id'};
1773 my $rv = mason_comp( 'session_id' => $session_id,
1774 'comp' => '/elements/location.html',
1775 'args' => [ %$param ],
1779 $rv->{'error'} || $rv->{'output'};
1784 #=item expselect HASHREF | LIST
1786 #Takes as input a hashref or list of key/value pairs with the following keys:
1790 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1792 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1796 =item expselect PREFIX [ DATE ]
1798 Takes as input a unique prefix string and the current expiration date, in
1799 yyyy-mm-dd or m-d-yyyy format
1801 Returns an HTML fragments for expiration date selection.
1807 #if ( ref($_[0]) ) {
1811 #my $prefix = $param->{'prefix'};
1812 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1813 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1815 my $date = scalar(@_) ? shift : '';
1817 my( $m, $y ) = ( 0, 0 );
1818 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1819 ( $m, $y ) = ( $2, $1 );
1820 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1821 ( $m, $y ) = ( $1, $3 );
1823 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1825 $return .= qq!<OPTION VALUE="$_"!;
1826 $return .= " SELECTED" if $_ == $m;
1829 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1831 my $thisYear = $t[5] + 1900;
1832 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1833 $return .= qq!<OPTION VALUE="$_"!;
1834 $return .= " SELECTED" if $_ == $y;
1837 $return .= "</SELECT>";
1842 =item popselector HASHREF | LIST
1844 Takes as input a hashref or list of key/value pairs with the following keys:
1850 Access number number
1854 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>.
1858 Returns an HTML fragment for access number selection.
1862 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1870 my $popnum = $param->{'popnum'};
1871 my $pops = $param->{'pops'};
1873 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1874 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1875 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1876 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1877 if scalar(@$pops) == 1;
1880 my %popnum2pop = ();
1882 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1883 $popnum2pop{$_->{popnum}} = $_;
1888 function opt(what,href,text) {
1889 var optionName = new Option(text, href, false, false)
1890 var length = what.length;
1891 what.options[length] = optionName;
1895 my $init_popstate = $param->{'init_popstate'};
1896 if ( $init_popstate ) {
1897 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1898 $init_popstate. '">';
1901 function acstate_changed(what) {
1902 state = what.options[what.selectedIndex].text;
1903 what.form.popac.options.length = 0
1904 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1908 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1909 foreach my $state ( sort { $a cmp $b } @states ) {
1910 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1912 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1913 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1914 if ($ac eq $param->{'popac'}) {
1915 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1918 $text .= "}\n" unless $init_popstate;
1920 $text .= "popac_changed(what.form.popac)}\n";
1923 function popac_changed(what) {
1924 ac = what.options[what.selectedIndex].text;
1925 what.form.popnum.options.length = 0;
1926 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1930 foreach my $state ( @states ) {
1931 foreach my $popac ( keys %{ $pop{$state} } ) {
1932 $text .= "\nif ( ac == \"$popac\" ) {\n";
1934 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1935 my $o_popnum = $pop->{popnum};
1936 my $poptext = $pop->{city}. ', '. $pop->{state}.
1937 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1939 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1940 if ($popnum == $o_popnum) {
1941 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1949 $text .= "}\n</SCRIPT>\n";
1951 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1954 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1955 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1956 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1957 ">$_" foreach sort { $a cmp $b } @states;
1958 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1961 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1962 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1964 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1967 #comment this block to disable initial list polulation
1968 my @initial_select = ();
1969 if ( scalar( @$pops ) > 100 ) {
1970 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1972 @initial_select = @$pops;
1974 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1975 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1976 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1977 $pop->{city}. ', '. $pop->{state}.
1978 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1981 $text .= qq!</SELECT></TD></TR></TABLE>!;
1987 =item domainselector HASHREF | LIST
1989 Takes as input a hashref or list of key/value pairs with the following keys:
1999 Service number of the selected item.
2003 Returns an HTML fragment for domain selection.
2007 sub domainselector {
2014 my $domsvc= $param->{'domsvc'};
2016 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2017 my $domains = $rv->{'domains'};
2018 $domsvc = $rv->{'domsvc'} unless $domsvc;
2020 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2021 unless scalar(keys %$domains);
2023 if (scalar(keys %$domains) == 1) {
2025 foreach(keys %$domains) {
2028 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2029 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2032 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2034 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2036 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2037 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2038 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2039 $domains->{$domain};
2042 $text .= qq!</SELECT></TD></TR>!;
2048 =item didselector HASHREF | LIST
2050 Takes as input a hashref or list of key/value pairs with the following keys:
2056 Field name for the returned HTML fragment.
2060 Service definition (see L<FS::part_svc>)
2064 Returns an HTML fragment for DID selection.
2076 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2077 'args'=>[ %$param ],
2081 $rv->{'error'} || $rv->{'output'};
2087 =head1 RESELLER FUNCTIONS
2089 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2090 with their active session, and the B<customer_info> and B<order_pkg> functions
2091 with their active session and an additional I<custnum> parameter.
2093 For the most part, development of the reseller web interface has been
2094 superceded by agent-virtualized access to the backend.
2106 =item agent_list_customers
2108 List agent's customers.
2116 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>