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 'switch_cust' => 'MyAccount/switch_cust',
34 'customer_info' => 'MyAccount/customer_info',
35 'customer_info_short' => 'MyAccount/customer_info_short',
36 'billing_history' => 'MyAccount/billing_history',
37 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
38 'invoice' => 'MyAccount/invoice',
39 'invoice_pdf' => 'MyAccount/invoice_pdf',
40 'legacy_invoice' => 'MyAccount/legacy_invoice',
41 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
42 'invoice_logo' => 'MyAccount/invoice_logo',
43 'list_invoices' => 'MyAccount/list_invoices', #?
44 'cancel' => 'MyAccount/cancel', #add to ss cgi!
45 'payment_info' => 'MyAccount/payment_info',
46 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
47 'process_payment' => 'MyAccount/process_payment',
48 'store_payment' => 'MyAccount/store_payment',
49 'process_stored_payment' => 'MyAccount/process_stored_payment',
50 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
51 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
52 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
53 'process_prepay' => 'MyAccount/process_prepay',
54 'realtime_collect' => 'MyAccount/realtime_collect',
55 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
56 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
57 'list_svc_usage' => 'MyAccount/list_svc_usage',
58 'svc_status_html' => 'MyAccount/svc_status_html',
59 'svc_status_hash' => 'MyAccount/svc_status_hash',
60 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
61 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
62 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
63 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
64 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
65 'acct_forward_info' => 'MyAccount/acct_forward_info',
66 'process_acct_forward' => 'MyAccount/process_acct_forward',
67 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
68 'add_dsl_device' => 'MyAccount/add_dsl_device',
69 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
70 'port_graph' => 'MyAccount/port_graph',
71 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
72 'list_support_usage' => 'MyAccount/list_support_usage',
73 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
74 'change_pkg' => 'MyAccount/change_pkg',
75 'order_recharge' => 'MyAccount/order_recharge',
76 'renew_info' => 'MyAccount/renew_info',
77 'order_renew' => 'MyAccount/order_renew',
78 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
79 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
80 'charge' => 'MyAccount/charge', #?
81 'part_svc_info' => 'MyAccount/part_svc_info',
82 'provision_acct' => 'MyAccount/provision_acct',
83 'provision_phone' => 'MyAccount/provision_phone',
84 'provision_external' => 'MyAccount/provision_external',
85 'unprovision_svc' => 'MyAccount/unprovision_svc',
86 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
87 'reset_passwd' => 'MyAccount/reset_passwd',
88 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
89 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
90 'list_tickets' => 'MyAccount/list_tickets',
91 'create_ticket' => 'MyAccount/create_ticket',
92 'get_ticket' => 'MyAccount/get_ticket',
93 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
94 'did_report' => 'MyAccount/did_report',
95 'signup_info' => 'Signup/signup_info',
96 'skin_info' => 'MyAccount/skin_info',
97 'access_info' => 'MyAccount/access_info',
98 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
99 'new_customer' => 'Signup/new_customer',
100 'new_customer_minimal' => 'Signup/new_customer_minimal',
101 'capture_payment' => 'Signup/capture_payment',
102 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
103 'new_agent' => 'Agent/new_agent',
104 'agent_login' => 'Agent/agent_login',
105 'agent_logout' => 'Agent/agent_logout',
106 'agent_info' => 'Agent/agent_info',
107 'agent_list_customers' => 'Agent/agent_list_customers',
108 'check_username' => 'Agent/check_username',
109 'suspend_username' => 'Agent/suspend_username',
110 'unsuspend_username' => 'Agent/unsuspend_username',
111 'mason_comp' => 'MasonComponent/mason_comp',
112 'call_time' => 'PrepaidPhone/call_time',
113 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
114 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
116 'start_thirdparty' => 'MyAccount/start_thirdparty',
117 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
121 qw( regionselector regionselector_hashref location_form
122 expselect popselector domainselector didselector
126 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
127 $ENV{'SHELL'} = '/bin/sh';
128 $ENV{'IFS'} = " \t\n";
131 $ENV{'BASH_ENV'} = '';
133 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
134 #if you grant appropriate permissions to whatever user
135 my $freeside_uid = scalar(getpwnam('freeside'));
136 die "not running as the freeside user\n"
137 if $> != $freeside_uid && ! $skip_uid_check;
139 -e $dir or die "FATAL: $dir doesn't exist!";
140 -d $dir or die "FATAL: $dir isn't a directory!";
141 -r $dir or die "FATAL: Can't read $dir as freeside user!";
142 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
144 foreach my $autoload ( keys %autoload ) {
147 "sub $autoload { ". '
152 #warn scalar(@_). ": ". join(" / ", @_);
156 $param->{_packet} = \''. $autoload{$autoload}. '\';
158 simple_packet($param);
168 warn "sending ". $packet->{_packet}. " to server"
170 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
171 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
172 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
175 #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
177 #block until there is a message on socket
178 # my $w = new IO::Select;
180 # my @wait = $w->can_read;
182 warn "reading message from server"
185 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
186 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
188 warn "returning message to client"
196 FS::SelfService - Freeside self-service API
200 # password and shell account changes
201 use FS::SelfService qw(passwd chfn chsh);
203 # "my account" functionality
204 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
206 #new-style login with an email address and password
207 # can also be used for svc_acct login, set $emailaddress to username@domain
208 my $rv = login ( { 'email' => $emailaddress,
209 'password' => $password,
212 if ( $rv->{'error'} ) {
213 #handle login error...
216 $session_id = $rv->{'session_id'};
219 #classic svc_acct-based login with separate username and password
220 my $rv = login( { 'username' => $username,
222 'password' => $password,
225 if ( $rv->{'error'} ) {
226 #handle login error...
229 $session_id = $rv->{'session_id'};
232 #svc_phone login with phone number and PIN
233 my $rv = login( { 'username' => $phone_number,
234 'domain' => 'svc_phone',
238 if ( $rv->{'error'} ) {
239 #handle login error...
242 $session_id = $rv->{'session_id'};
245 my $customer_info = customer_info( { 'session_id' => $session_id } );
247 #payment_info and process_payment are available in 1.5+ only
248 my $payment_info = payment_info( { 'session_id' => $session_id } );
250 #!!! process_payment example
252 #!!! list_pkgs example
254 #ordering a package with an svc_acct service
255 my $rv = order_pkg( { 'session_id' => $session_id,
256 'pkgpart' => $pkgpart,
257 'svcpart' => $svcpart,
258 'username' => $username,
259 'domsvc' => $domsvc, #svcnum of svc_domain
260 '_password' => $password,
264 #!!! ordering a package with an svc_domain service example
266 #!!! ordering a package with an svc_phone service example
268 #!!! ordering a package with an svc_external service example
270 #!!! ordering a package with an svc_pbx service
272 #ordering a package with no service
273 my $rv = order_pkg( { 'session_id' => $session_id,
274 'pkgpart' => $pkgpart,
279 #!!! cancel_pkg example
281 # signup functionality
282 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
284 my $signup_info = signup_info;
286 $rv = new_customer( {
289 'company' => $company,
290 'address1' => $address1,
291 'address2' => $address2,
295 'country' => $country,
296 'daytime' => $daytime,
300 'payinfo' => $payinfo,
302 'paystart_month' => $paystart_month
303 'paystart_year' => $paystart_year,
304 'payissue' => $payissue,
306 'paydate' => $paydate,
307 'payname' => $payname,
308 'invoicing_list' => $invoicing_list,
309 'referral_custnum' => $referral_custnum,
310 'agentnum' => $agentnum,
311 'pkgpart' => $pkgpart,
313 'username' => $username,
314 '_password' => $password,
318 'phonenum' => $phonenum,
323 my $error = $rv->{'error'};
324 if ( $error eq '_decline' ) {
334 Use this API to implement your own client "self-service" module.
336 If you just want to customize the look of the existing "self-service" module,
339 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
345 Changes the password for an existing user in svc_acct. Takes a hash
346 reference with the following keys:
352 Username of the account (required)
356 Domain of the account (required)
360 Old password (required)
364 New password (required)
382 =head1 "MY ACCOUNT" FUNCTIONS
388 Creates a user session. Takes a hash reference as parameter with the
395 Email address (username@domain), instead of username and domain. Required for
396 contact-based self-service login, can also be used for svc_acct-based login.
412 Returns a hash reference with the following keys:
418 Empty on success, or an error message on errors.
422 Session identifier for successful logins
426 =item customer_info HASHREF
428 Returns general customer information.
430 Takes a hash reference as parameter with a single key: B<session_id>
432 Returns a hash reference with the following keys:
446 Array reference of hash references of open inoices. Each hash reference has
447 the following keys: invnum, date, owed
451 An HTML fragment containing shipping and billing addresses.
453 =item The following fields are also returned
455 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
459 =item edit_info HASHREF
461 Takes a hash reference as parameter with any of the following keys:
463 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
465 If a field exists, the customer record is updated with the new value of that
466 field. If a field does not exist, that field is not changed on the customer
469 Returns a hash reference with a single key, B<error>, empty on success, or an
470 error message on errors
472 =item invoice HASHREF
474 Returns an invoice. Takes a hash reference as parameter with two keys:
475 session_id and invnum
477 Returns a hash reference with the following keys:
483 Empty on success, or an error message on errors
495 =item list_invoices HASHREF
497 Returns a list of all customer invoices. Takes a hash references with a single
500 Returns a hash reference with the following keys:
506 Empty on success, or an error message on errors
510 Reference to array of hash references with the following keys:
520 Invoice date, in UNIX epoch time
528 Cancels this customer.
530 Takes a hash reference as parameter with a single key: B<session_id>
532 Returns a hash reference with a single key, B<error>, which is empty on
533 success or an error message on errors.
535 =item payment_info HASHREF
537 Returns information that may be useful in displaying a payment page.
539 Takes a hash reference as parameter with a single key: B<session_id>.
541 Returns a hash reference with the following keys:
547 Empty on success, or an error message on errors
555 Exact name on credit card (CARD/DCRD)
579 Customer's current default payment type.
583 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
587 For CARD/DCRD payment types, the card number
591 For CARD/DCRD payment types, expiration month
595 For CARD/DCRD payment types, expiration year
597 =item cust_main_county
599 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.
603 Array reference of all states in the current default country.
607 Hash reference of card types; keys are card types, values are the exact strings
608 passed to the process_payment function
612 #this doesn't actually work yet
616 #Unique transaction identifier (prevents multiple charges), passed to the
617 #process_payment function
621 =item process_payment HASHREF
623 Processes a payment and possible change of address or payment type. Takes a
624 hash reference as parameter with the following keys:
638 If true, address and card information entered will be saved for subsequent
643 If true, future credit card payments will be done automatically (sets payby to
644 CARD). If false, future credit card payments will be done on-demand (sets
645 payby to DCRD). This option only has meaning if B<save> is set true.
673 Two-letter country code
681 Card expiration month
689 #this doesn't actually work yet
693 #Unique transaction identifier, returned from the payment_info function.
694 #Prevents multiple charges.
698 Returns a hash reference with a single key, B<error>, empty on success, or an
699 error message on errors.
701 =item process_payment_order_pkg
703 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
704 payment processes sucessfully, the package is ordered. Takes a hash reference
705 as parameter with the keys of both methods.
707 Returns a hash reference with a single key, B<error>, empty on success, or an
708 error message on errors.
710 =item process_payment_change_pkg
712 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
713 payment processes sucessfully, the package is ordered. Takes a hash reference
714 as parameter with the keys of both methods.
716 Returns a hash reference with a single key, B<error>, empty on success, or an
717 error message on errors.
720 =item process_payment_order_renew
722 Combines the B<process_payment> and B<order_renew> functions in one step. If
723 the payment processes sucessfully, the renewal is processed. Takes a hash
724 reference as parameter with the keys of both methods.
726 Returns a hash reference with a single key, B<error>, empty on success, or an
727 error message on errors.
731 Returns package information for this customer. For more detail on services,
734 Takes a hash reference as parameter with a single key: B<session_id>
736 Returns a hash reference containing customer package information. The hash reference contains the following keys:
746 Empty on success, or an error message on errors.
748 =item cust_pkg HASHREF
750 Array reference of hash references, each of which has the fields of a cust_pkg
751 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
752 the internal FS:: objects, but hash references of columns and values.
756 =item part_pkg fields
758 All fields of part_pkg for this specific cust_pkg (be careful with this
759 information - it may reveal more about your available packages than you would
760 like users to know in aggregate)
764 #XXX pare part_pkg fields down to a more secure subset
768 An array of hash references indicating information on unprovisioned services
769 available for provisioning for this specific cust_pkg. Each has the following
774 =item part_svc fields
776 All fields of part_svc (be careful with this information - it may reveal more
777 about your available packages than you would like users to know in aggregate)
781 #XXX pare part_svc fields down to a more secure subset
787 An array of hash references indicating information on the customer services
788 already provisioned for this specific cust_pkg. Each has the following keys:
794 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.
800 Primary key for this service
804 Service definition (see L<FS::part_svc>)
808 Customer package (see L<FS::cust_pkg>)
812 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
820 Returns service information for this customer.
822 Takes a hash reference as parameter with a single key: B<session_id>
824 Returns a hash reference containing customer package information. The hash reference contains the following keys:
834 An array of hash references indicating information on all of this customer's
835 services. Each has the following keys:
841 Primary key for this service
849 Meaningful user-specific identifier for the service (i.e. username, domain, or
854 Account (svc_acct) services also have the following keys:
872 Upload bytes remaining
876 Download bytes remaining
880 Total bytes remaining
882 =item recharge_amount
886 =item recharge_seconds
888 Number of seconds gained by recharge
890 =item recharge_upbytes
892 Number of upload bytes gained by recharge
894 =item recharge_downbytes
896 Number of download bytes gained by recharge
898 =item recharge_totalbytes
900 Number of total bytes gained by recharge
908 Orders a package for this customer.
910 Takes a hash reference as parameter with the following keys:
920 Package to order (see L<FS::part_pkg>).
924 Quantity for this package order (default 1).
928 Optional locationnum for this package order, for existing locations.
930 Or, for new locations, pass the following fields: address1*, address2, city*,
931 county, state*, zip*, country. (* = required in this case)
943 Service to order (see L<FS::part_svc>).
945 Normally optional; required only to provision a non-svc_acct service, or if the
946 package definition does not contain one svc_acct service definition with
947 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
948 also be specified to indicate that no initial service should be provisioned.
952 Fields used when provisioning an svc_acct service:
966 Optional security phrase
970 Optional Access number number
974 Fields used when provisioning an svc_domain service:
984 Fields used when provisioning an svc_phone service:
1002 Fields used when provisioning an svc_external service:
1008 External numeric ID.
1012 External text title.
1016 Fields used when provisioning an svc_pbx service:
1030 Returns a hash reference with a single key, B<error>, empty on success, or an
1031 error message on errors. The special error '_decline' is returned for
1032 declined transactions.
1036 Changes a package for this customer.
1038 Takes a hash reference as parameter with the following keys:
1048 Existing customer package.
1052 New package to order (see L<FS::part_pkg>).
1056 Quantity for this package order (default 1).
1060 Returns a hash reference with the following keys:
1066 Empty on success, or an error message on errors.
1070 On success, the new pkgnum
1077 Provides useful info for early renewals.
1079 Takes a hash reference as parameter with the following keys:
1089 Returns a hash reference. On errors, it contains a single key, B<error>, with
1090 the error message. Otherwise, contains a single key, B<dates>, pointing to
1091 an array refernce of hash references. Each hash reference contains the
1098 (Future) Bill date. Indicates a future date for which billing could be run.
1099 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1102 =item bill_date_pretty
1104 (Future) Bill date as a human-readable string. (Convenience for display;
1105 subject to change, so best not to parse for the date.)
1109 Base amount which will be charged if renewed early as of this date.
1113 Renewal date; i.e. even-futher future date at which the customer will be paid
1114 through if the early renewal is completed with the given B<bill-date>.
1115 Specified as a integer UNIX timestamp.
1117 =item renew_date_pretty
1119 Renewal date as a human-readable string. (Convenience for display;
1120 subject to change, so best not to parse for the date.)
1124 Package that will be renewed.
1128 Expiration date of the package that will be renewed.
1130 =item expire_date_pretty
1132 Expiration date of the package that will be renewed, as a human-readable
1133 string. (Convenience for display; subject to change, so best not to parse for
1140 Renews this customer early; i.e. runs billing for this customer in advance.
1142 Takes a hash reference as parameter with the following keys:
1152 Integer date as returned by the B<renew_info> function, indicating the advance
1153 date for which to run billing.
1157 Returns a hash reference with a single key, B<error>, empty on success, or an
1158 error message on errors.
1162 Cancels a package for this customer.
1164 Takes a hash reference as parameter with the following keys:
1174 pkgpart of package to cancel
1178 Returns a hash reference with a single key, B<error>, empty on success, or an
1179 error message on errors.
1181 =item provision_acct
1183 Provisions an account (svc_acct).
1185 Takes a hash references as parameter with the following keys:
1195 pkgnum of package into which this service is provisioned
1199 svcpart or service definition to provision
1209 =item provision_phone
1211 Provisions a phone number (svc_phone).
1213 Takes a hash references as parameter with the following keys:
1223 pkgnum of package into which this service is provisioned
1227 svcpart or service definition to provision
1247 E911 Address (optional)
1251 =item provision_external
1253 Provisions an external service (svc_external).
1255 Takes a hash references as parameter with the following keys:
1265 pkgnum of package into which this service is provisioned
1269 svcpart or service definition to provision
1279 =head1 SIGNUP FUNCTIONS
1283 =item signup_info HASHREF
1285 Takes a hash reference as parameter with the following keys:
1289 =item session_id - Optional agent/reseller interface session
1293 Returns a hash reference containing information that may be useful in
1294 displaying a signup page. The hash reference contains the following keys:
1298 =item cust_main_county
1300 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.
1304 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
1305 an agentnum specified explicitly via reseller interface session_id in the
1310 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.
1312 =item agentnum2part_pkg
1314 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.
1318 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.
1320 =item security_phrase
1322 True if the "security_phrase" feature is enabled
1326 Array reference of acceptable payment types for signup
1332 credit card - automatic
1336 credit card - on-demand - version 1.5+ only
1340 electronic check - automatic
1344 electronic check - on-demand - version 1.5+ only
1352 billing, not recommended for signups
1356 free, definitely not recommended for signups
1360 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1366 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1370 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".
1376 =item countrydefault
1382 =item new_customer_minimal HASHREF
1384 Creates a new customer.
1386 Current differences from new_customer: An address is not required. promo_code
1387 and reg_code are not supported. If invoicing_list and _password is passed, a
1388 contact will be created with self-service access (no pkgpart or username is
1389 necessary). No initial billing is run (this may change in a future version).
1391 Takes a hash reference as parameter with the following keys:
1397 first name (required)
1401 last name (required)
1405 (not typically collected; mostly used for ACH transactions)
1437 Daytime phone number
1441 Evening phone number
1449 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1453 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1457 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1461 Expiration date for CARD/DCRD
1465 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1467 =item invoicing_list
1469 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),
1471 =item referral_custnum
1473 referring customer number
1481 pkgpart of initial package
1497 Access number (index, not the literal number)
1501 Country code (to be provisioned as a service)
1505 Phone number (to be provisioned as a service)
1513 Returns a hash reference with the following keys:
1519 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)
1523 =item new_customer HASHREF
1525 Creates a new customer. Takes a hash reference as parameter with the
1532 first name (required)
1536 last name (required)
1540 (not typically collected; mostly used for ACH transactions)
1546 =item address1 (required)
1554 =item city (required)
1562 =item state (required)
1566 =item zip (required)
1572 Daytime phone number
1576 Evening phone number
1584 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1588 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1592 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1596 Expiration date for CARD/DCRD
1600 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1602 =item invoicing_list
1604 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),
1606 =item referral_custnum
1608 referring customer number
1616 pkgpart of initial package
1632 Access number (index, not the literal number)
1636 Country code (to be provisioned as a service)
1640 Phone number (to be provisioned as a service)
1648 Returns a hash reference with the following keys:
1654 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)
1658 =item regionselector HASHREF | LIST
1660 Takes as input a hashref or list of key/value pairs with the following keys:
1664 =item selected_county
1666 Currently selected county
1668 =item selected_state
1670 Currently selected state
1672 =item selected_country
1674 Currently selected country
1678 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1682 Specify a javascript subroutine to call on changes
1688 =item default_country
1694 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>.
1698 Returns a list consisting of three HTML fragments for county selection,
1699 state selection and country selection, respectively.
1703 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1704 sub regionselector {
1711 $param->{'selected_country'} ||= $param->{'default_country'};
1712 $param->{'selected_state'} ||= $param->{'default_state'};
1714 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1718 my %cust_main_county;
1720 # unless ( @cust_main_county ) { #cache
1721 #@cust_main_county = qsearch('cust_main_county', {} );
1722 #foreach my $c ( @cust_main_county ) {
1723 foreach my $c ( @{ $param->{'locales'} } ) {
1724 #$countyflag=1 if $c->county;
1725 $countyflag=1 if $c->{county};
1726 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1727 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1728 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1731 $countyflag=1 if $param->{selected_county};
1733 my $script_html = <<END;
1735 function opt(what,value,text) {
1736 var optionName = new Option(text, value, false, false);
1737 var length = what.length;
1738 what.options[length] = optionName;
1740 function ${prefix}country_changed(what) {
1741 country = what.options[what.selectedIndex].text;
1742 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1743 what.form.${prefix}state.options[i] = null;
1745 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1747 foreach my $country ( sort keys %cust_main_county ) {
1748 $script_html .= "\nif ( country == \"$country\" ) {\n";
1749 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1750 my $text = $state || '(n/a)';
1751 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1753 $script_html .= "}\n";
1756 $script_html .= <<END;
1758 function ${prefix}state_changed(what) {
1761 if ( $countyflag ) {
1762 $script_html .= <<END;
1763 state = what.options[what.selectedIndex].text;
1764 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1765 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1766 what.form.${prefix}county.options[i] = null;
1769 foreach my $country ( sort keys %cust_main_county ) {
1770 $script_html .= "\nif ( country == \"$country\" ) {\n";
1771 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1772 $script_html .= "\nif ( state == \"$state\" ) {\n";
1773 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1774 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1775 my $text = $county || '(n/a)';
1777 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1779 $script_html .= "}\n";
1781 $script_html .= "}\n";
1785 $script_html .= <<END;
1790 my $county_html = $script_html;
1791 if ( $countyflag ) {
1792 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1793 foreach my $county (
1794 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1796 my $text = $county || '(n/a)';
1797 $county_html .= qq!<OPTION VALUE="$county"!.
1798 ($county eq $param->{'selected_county'} ?
1805 $county_html .= '</SELECT>';
1808 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1811 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1812 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1813 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1814 my $text = $state || '(n/a)';
1815 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1816 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
1818 $state_html .= '</SELECT>';
1820 my $country_html = '';
1821 if ( scalar( keys %cust_main_county ) > 1 ) {
1823 $country_html = qq(<SELECT NAME="${prefix}country" ).
1824 qq(onChange="${prefix}country_changed(this); ).
1825 $param->{'onchange'}.
1828 my $countrydefault = $param->{default_country} || 'US';
1829 foreach my $country (
1830 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1831 keys %cust_main_county
1833 my $selected = $country eq $param->{'selected_country'}
1836 $country_html .= "\n<OPTION $selected>$country</OPTION>"
1838 $country_html .= '</SELECT>';
1841 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1842 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1846 ($county_html, $state_html, $country_html);
1850 sub regionselector_hashref {
1851 my ($county_html, $state_html, $country_html) = regionselector(@_);
1853 'county_html' => $county_html,
1854 'state_html' => $state_html,
1855 'country_html' => $country_html,
1859 =item location_form HASHREF | LIST
1861 Takes as input a hashref or list of key/value pairs with the following keys:
1867 Current customer session_id
1871 Omit red asterisks from required fields.
1873 =item address1_label
1875 Label for first address line.
1879 Returns an HTML fragment for a location form (address, city, state, zip,
1892 my $session_id = delete $param->{'session_id'};
1894 my $rv = mason_comp( 'session_id' => $session_id,
1895 'comp' => '/elements/location.html',
1896 'args' => [ %$param ],
1900 $rv->{'error'} || $rv->{'output'};
1905 #=item expselect HASHREF | LIST
1907 #Takes as input a hashref or list of key/value pairs with the following keys:
1911 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1913 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1917 =item expselect PREFIX [ DATE ]
1919 Takes as input a unique prefix string and the current expiration date, in
1920 yyyy-mm-dd or m-d-yyyy format
1922 Returns an HTML fragments for expiration date selection.
1928 #if ( ref($_[0]) ) {
1932 #my $prefix = $param->{'prefix'};
1933 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1934 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1936 my $date = scalar(@_) ? shift : '';
1938 my( $m, $y ) = ( 0, 0 );
1939 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1940 ( $m, $y ) = ( $2, $1 );
1941 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1942 ( $m, $y ) = ( $1, $3 );
1944 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1946 $return .= qq!<OPTION VALUE="$_"!;
1947 $return .= " SELECTED" if $_ == $m;
1950 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1952 my $thisYear = $t[5] + 1900;
1953 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1954 $return .= qq!<OPTION VALUE="$_"!;
1955 $return .= " SELECTED" if $_ == $y;
1958 $return .= "</SELECT>";
1963 =item popselector HASHREF | LIST
1965 Takes as input a hashref or list of key/value pairs with the following keys:
1971 Access number number
1975 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>.
1979 Returns an HTML fragment for access number selection.
1983 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1991 my $popnum = $param->{'popnum'};
1992 my $pops = $param->{'pops'};
1994 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1995 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1996 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1997 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1998 if scalar(@$pops) == 1;
2001 my %popnum2pop = ();
2003 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2004 $popnum2pop{$_->{popnum}} = $_;
2009 function opt(what,href,text) {
2010 var optionName = new Option(text, href, false, false)
2011 var length = what.length;
2012 what.options[length] = optionName;
2016 my $init_popstate = $param->{'init_popstate'};
2017 if ( $init_popstate ) {
2018 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2019 $init_popstate. '">';
2022 function acstate_changed(what) {
2023 state = what.options[what.selectedIndex].text;
2024 what.form.popac.options.length = 0
2025 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2029 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2030 foreach my $state ( sort { $a cmp $b } @states ) {
2031 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2033 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2034 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2035 if ($ac eq $param->{'popac'}) {
2036 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2039 $text .= "}\n" unless $init_popstate;
2041 $text .= "popac_changed(what.form.popac)}\n";
2044 function popac_changed(what) {
2045 ac = what.options[what.selectedIndex].text;
2046 what.form.popnum.options.length = 0;
2047 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2051 foreach my $state ( @states ) {
2052 foreach my $popac ( keys %{ $pop{$state} } ) {
2053 $text .= "\nif ( ac == \"$popac\" ) {\n";
2055 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2056 my $o_popnum = $pop->{popnum};
2057 my $poptext = $pop->{city}. ', '. $pop->{state}.
2058 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2060 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2061 if ($popnum == $o_popnum) {
2062 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2070 $text .= "}\n</SCRIPT>\n";
2072 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2075 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2076 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2077 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2078 ">$_" foreach sort { $a cmp $b } @states;
2079 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2082 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2083 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2085 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2088 #comment this block to disable initial list polulation
2089 my @initial_select = ();
2090 if ( scalar( @$pops ) > 100 ) {
2091 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2093 @initial_select = @$pops;
2095 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2096 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2097 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2098 $pop->{city}. ', '. $pop->{state}.
2099 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2102 $text .= qq!</SELECT></TD></TR></TABLE>!;
2108 =item domainselector HASHREF | LIST
2110 Takes as input a hashref or list of key/value pairs with the following keys:
2120 Service number of the selected item.
2124 Returns an HTML fragment for domain selection.
2128 sub domainselector {
2135 my $domsvc= $param->{'domsvc'};
2137 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2138 my $domains = $rv->{'domains'};
2139 $domsvc = $rv->{'domsvc'} unless $domsvc;
2141 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2142 unless scalar(keys %$domains);
2144 if (scalar(keys %$domains) == 1) {
2146 foreach(keys %$domains) {
2149 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2150 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2153 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2155 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2157 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2158 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2159 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2160 $domains->{$domain};
2163 $text .= qq!</SELECT></TD></TR>!;
2169 =item didselector HASHREF | LIST
2171 Takes as input a hashref or list of key/value pairs with the following keys:
2177 Field name for the returned HTML fragment.
2181 Service definition (see L<FS::part_svc>)
2185 Returns an HTML fragment for DID selection.
2197 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2198 'args'=>[ %$param ],
2202 $rv->{'error'} || $rv->{'output'};
2208 =head1 RESELLER FUNCTIONS
2210 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2211 with their active session, and the B<customer_info> and B<order_pkg> functions
2212 with their active session and an additional I<custnum> parameter.
2214 For the most part, development of the reseller web interface has been
2215 superceded by agent-virtualized access to the backend.
2227 =item agent_list_customers
2229 List agent's customers.
2237 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>