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 'new_customer_minimal' => 'Signup/new_customer_minimal',
100 'capture_payment' => 'Signup/capture_payment',
101 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
102 'new_agent' => 'Agent/new_agent',
103 'agent_login' => 'Agent/agent_login',
104 'agent_logout' => 'Agent/agent_logout',
105 'agent_info' => 'Agent/agent_info',
106 'agent_list_customers' => 'Agent/agent_list_customers',
107 'check_username' => 'Agent/check_username',
108 'suspend_username' => 'Agent/suspend_username',
109 'unsuspend_username' => 'Agent/unsuspend_username',
110 'mason_comp' => 'MasonComponent/mason_comp',
111 'call_time' => 'PrepaidPhone/call_time',
112 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
113 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
115 'start_thirdparty' => 'MyAccount/start_thirdparty',
116 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
118 'quotation_info' => 'MyAccount/quotation/quotation_info',
119 'quotation_print' => 'MyAccount/quotation/quotation_print',
120 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
121 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
122 'quotation_order' => 'MyAccount/quotation/quotation_order',
127 qw( regionselector regionselector_hashref location_form
128 expselect popselector domainselector didselector
132 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
133 $ENV{'SHELL'} = '/bin/sh';
134 $ENV{'IFS'} = " \t\n";
137 $ENV{'BASH_ENV'} = '';
139 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
140 #if you grant appropriate permissions to whatever user
141 my $freeside_uid = scalar(getpwnam('freeside'));
142 die "not running as the freeside user\n"
143 if $> != $freeside_uid && ! $skip_uid_check;
145 -e $dir or die "FATAL: $dir doesn't exist!";
146 -d $dir or die "FATAL: $dir isn't a directory!";
147 -r $dir or die "FATAL: Can't read $dir as freeside user!";
148 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
150 foreach my $autoload ( keys %autoload ) {
153 "sub $autoload { ". '
158 #warn scalar(@_). ": ". join(" / ", @_);
162 $param->{_packet} = \''. $autoload{$autoload}. '\';
164 simple_packet($param);
174 warn "sending ". $packet->{_packet}. " to server"
176 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
177 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
178 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
181 #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
183 #block until there is a message on socket
184 # my $w = new IO::Select;
186 # my @wait = $w->can_read;
188 warn "reading message from server"
191 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
192 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
194 warn "returning message to client"
202 FS::SelfService - Freeside self-service API
206 # password and shell account changes
207 use FS::SelfService qw(passwd chfn chsh);
209 # "my account" functionality
210 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
212 #new-style login with an email address and password
213 # can also be used for svc_acct login, set $emailaddress to username@domain
214 my $rv = login ( { 'email' => $emailaddress,
215 'password' => $password,
218 if ( $rv->{'error'} ) {
219 #handle login error...
222 $session_id = $rv->{'session_id'};
225 #classic svc_acct-based login with separate username and password
226 my $rv = login( { 'username' => $username,
228 'password' => $password,
231 if ( $rv->{'error'} ) {
232 #handle login error...
235 $session_id = $rv->{'session_id'};
238 #svc_phone login with phone number and PIN
239 my $rv = login( { 'username' => $phone_number,
240 'domain' => 'svc_phone',
244 if ( $rv->{'error'} ) {
245 #handle login error...
248 $session_id = $rv->{'session_id'};
251 my $customer_info = customer_info( { 'session_id' => $session_id } );
253 #payment_info and process_payment are available in 1.5+ only
254 my $payment_info = payment_info( { 'session_id' => $session_id } );
256 #!!! process_payment example
258 #!!! list_pkgs example
260 #!!! order_pkg example
262 #!!! cancel_pkg example
264 # signup functionality
265 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
267 my $signup_info = signup_info;
269 $rv = new_customer( {
272 'company' => $company,
273 'address1' => $address1,
274 'address2' => $address2,
278 'country' => $country,
279 'daytime' => $daytime,
283 'payinfo' => $payinfo,
285 'paystart_month' => $paystart_month
286 'paystart_year' => $paystart_year,
287 'payissue' => $payissue,
289 'paydate' => $paydate,
290 'payname' => $payname,
291 'invoicing_list' => $invoicing_list,
292 'referral_custnum' => $referral_custnum,
293 'agentnum' => $agentnum,
294 'pkgpart' => $pkgpart,
296 'username' => $username,
297 '_password' => $password,
301 'phonenum' => $phonenum,
306 my $error = $rv->{'error'};
307 if ( $error eq '_decline' ) {
317 Use this API to implement your own client "self-service" module.
319 If you just want to customize the look of the existing "self-service" module,
322 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
328 Changes the password for an existing user in svc_acct. Takes a hash
329 reference with the following keys:
335 Username of the account (required)
339 Domain of the account (required)
343 Old password (required)
347 New password (required)
365 =head1 "MY ACCOUNT" FUNCTIONS
371 Creates a user session. Takes a hash reference as parameter with the
378 Email address (username@domain), instead of username and domain. Required for
379 contact-based self-service login, can also be used for svc_acct-based login.
395 Returns a hash reference with the following keys:
401 Empty on success, or an error message on errors.
405 Session identifier for successful logins
409 =item customer_info HASHREF
411 Returns general customer information.
413 Takes a hash reference as parameter with a single key: B<session_id>
415 Returns a hash reference with the following keys:
429 Array reference of hash references of open inoices. Each hash reference has
430 the following keys: invnum, date, owed
434 An HTML fragment containing shipping and billing addresses.
436 =item The following fields are also returned
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 payname month year invoicing_list postal_invoicing
442 =item edit_info HASHREF
444 Takes a hash reference as parameter with any of the following keys:
446 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
448 If a field exists, the customer record is updated with the new value of that
449 field. If a field does not exist, that field is not changed on the customer
452 Returns a hash reference with a single key, B<error>, empty on success, or an
453 error message on errors
455 =item invoice HASHREF
457 Returns an invoice. Takes a hash reference as parameter with two keys:
458 session_id and invnum
460 Returns a hash reference with the following keys:
466 Empty on success, or an error message on errors
478 =item list_invoices HASHREF
480 Returns a list of all customer invoices. Takes a hash references with a single
483 Returns a hash reference with the following keys:
489 Empty on success, or an error message on errors
493 Reference to array of hash references with the following keys:
503 Invoice date, in UNIX epoch time
511 Cancels this customer.
513 Takes a hash reference as parameter with a single key: B<session_id>
515 Returns a hash reference with a single key, B<error>, which is empty on
516 success or an error message on errors.
518 =item payment_info HASHREF
520 Returns information that may be useful in displaying a payment page.
522 Takes a hash reference as parameter with a single key: B<session_id>.
524 Returns a hash reference with the following keys:
530 Empty on success, or an error message on errors
538 Exact name on credit card (CARD/DCRD)
562 Customer's current default payment type.
566 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
570 For CARD/DCRD payment types, the card number
574 For CARD/DCRD payment types, expiration month
578 For CARD/DCRD payment types, expiration year
580 =item cust_main_county
582 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.
586 Array reference of all states in the current default country.
590 Hash reference of card types; keys are card types, values are the exact strings
591 passed to the process_payment function
595 #this doesn't actually work yet
599 #Unique transaction identifier (prevents multiple charges), passed to the
600 #process_payment function
604 =item process_payment HASHREF
606 Processes a payment and possible change of address or payment type. Takes a
607 hash reference as parameter with the following keys:
621 If true, address and card information entered will be saved for subsequent
626 If true, future credit card payments will be done automatically (sets payby to
627 CARD). If false, future credit card payments will be done on-demand (sets
628 payby to DCRD). This option only has meaning if B<save> is set true.
656 Two-letter country code
664 Card expiration month
672 #this doesn't actually work yet
676 #Unique transaction identifier, returned from the payment_info function.
677 #Prevents multiple charges.
681 Returns a hash reference with a single key, B<error>, empty on success, or an
682 error message on errors.
684 =item process_payment_order_pkg
686 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
687 payment processes sucessfully, the package is ordered. Takes a hash reference
688 as parameter with the keys of both methods.
690 Returns a hash reference with a single key, B<error>, empty on success, or an
691 error message on errors.
693 =item process_payment_change_pkg
695 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
696 payment processes sucessfully, the package is ordered. Takes a hash reference
697 as parameter with the keys of both methods.
699 Returns a hash reference with a single key, B<error>, empty on success, or an
700 error message on errors.
703 =item process_payment_order_renew
705 Combines the B<process_payment> and B<order_renew> functions in one step. If
706 the payment processes sucessfully, the renewal is processed. Takes a hash
707 reference as parameter with the keys of both methods.
709 Returns a hash reference with a single key, B<error>, empty on success, or an
710 error message on errors.
714 Returns package information for this customer. For more detail on services,
717 Takes a hash reference as parameter with a single key: B<session_id>
719 Returns a hash reference containing customer package information. The hash reference contains the following keys:
729 Empty on success, or an error message on errors.
731 =item cust_pkg HASHREF
733 Array reference of hash references, each of which has the fields of a cust_pkg
734 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
735 the internal FS:: objects, but hash references of columns and values.
739 =item part_pkg fields
741 All fields of part_pkg for this specific cust_pkg (be careful with this
742 information - it may reveal more about your available packages than you would
743 like users to know in aggregate)
747 #XXX pare part_pkg fields down to a more secure subset
751 An array of hash references indicating information on unprovisioned services
752 available for provisioning for this specific cust_pkg. Each has the following
757 =item part_svc fields
759 All fields of part_svc (be careful with this information - it may reveal more
760 about your available packages than you would like users to know in aggregate)
764 #XXX pare part_svc fields down to a more secure subset
770 An array of hash references indicating information on the customer services
771 already provisioned for this specific cust_pkg. Each has the following keys:
777 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.
783 Primary key for this service
787 Service definition (see L<FS::part_svc>)
791 Customer package (see L<FS::cust_pkg>)
795 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
803 Returns service information for this customer.
805 Takes a hash reference as parameter with a single key: B<session_id>
807 Returns a hash reference containing customer package information. The hash reference contains the following keys:
817 An array of hash references indicating information on all of this customer's
818 services. Each has the following keys:
824 Primary key for this service
832 Meaningful user-specific identifier for the service (i.e. username, domain, or
837 Account (svc_acct) services also have the following keys:
855 Upload bytes remaining
859 Download bytes remaining
863 Total bytes remaining
865 =item recharge_amount
869 =item recharge_seconds
871 Number of seconds gained by recharge
873 =item recharge_upbytes
875 Number of upload bytes gained by recharge
877 =item recharge_downbytes
879 Number of download bytes gained by recharge
881 =item recharge_totalbytes
883 Number of total bytes gained by recharge
891 Orders a package for this customer.
893 Takes a hash reference as parameter with the following keys:
903 Package to order (see L<FS::part_pkg>).
907 Quantity for this package order (default 1).
911 Optional locationnum for this package order, for existing locations.
913 Or, for new locations, pass the following fields: address1*, address2, city*,
914 county, state*, zip*, country. (* = required in this case)
926 Service to order (see L<FS::part_svc>).
928 Normally optional; required only to provision a non-svc_acct service, or if the
929 package definition does not contain one svc_acct service definition with
930 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
931 also be specified to indicate that no initial service should be provisioned.
935 Fields used when provisioning an svc_acct service:
949 Optional security phrase
953 Optional Access number number
957 Fields used when provisioning an svc_domain service:
967 Fields used when provisioning an svc_phone service:
985 Fields used when provisioning an svc_external service:
999 Fields used when provisioning an svc_pbx service:
1013 Returns a hash reference with a single key, B<error>, empty on success, or an
1014 error message on errors. The special error '_decline' is returned for
1015 declined transactions.
1019 Changes a package for this customer.
1021 Takes a hash reference as parameter with the following keys:
1031 Existing customer package.
1035 New package to order (see L<FS::part_pkg>).
1039 Quantity for this package order (default 1).
1043 Returns a hash reference with the following keys:
1049 Empty on success, or an error message on errors.
1053 On success, the new pkgnum
1060 Provides useful info for early renewals.
1062 Takes a hash reference as parameter with the following keys:
1072 Returns a hash reference. On errors, it contains a single key, B<error>, with
1073 the error message. Otherwise, contains a single key, B<dates>, pointing to
1074 an array refernce of hash references. Each hash reference contains the
1081 (Future) Bill date. Indicates a future date for which billing could be run.
1082 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1085 =item bill_date_pretty
1087 (Future) Bill date as a human-readable string. (Convenience for display;
1088 subject to change, so best not to parse for the date.)
1092 Base amount which will be charged if renewed early as of this date.
1096 Renewal date; i.e. even-futher future date at which the customer will be paid
1097 through if the early renewal is completed with the given B<bill-date>.
1098 Specified as a integer UNIX timestamp.
1100 =item renew_date_pretty
1102 Renewal date as a human-readable string. (Convenience for display;
1103 subject to change, so best not to parse for the date.)
1107 Package that will be renewed.
1111 Expiration date of the package that will be renewed.
1113 =item expire_date_pretty
1115 Expiration date of the package that will be renewed, as a human-readable
1116 string. (Convenience for display; subject to change, so best not to parse for
1123 Renews this customer early; i.e. runs billing for this customer in advance.
1125 Takes a hash reference as parameter with the following keys:
1135 Integer date as returned by the B<renew_info> function, indicating the advance
1136 date for which to run billing.
1140 Returns a hash reference with a single key, B<error>, empty on success, or an
1141 error message on errors.
1145 Cancels a package for this customer.
1147 Takes a hash reference as parameter with the following keys:
1157 pkgpart of package to cancel
1161 Returns a hash reference with a single key, B<error>, empty on success, or an
1162 error message on errors.
1164 =item provision_acct
1166 Provisions an account (svc_acct).
1168 Takes a hash references as parameter with the following keys:
1178 pkgnum of package into which this service is provisioned
1182 svcpart or service definition to provision
1192 =item provision_phone
1194 Provisions a phone number (svc_phone).
1196 Takes a hash references as parameter with the following keys:
1206 pkgnum of package into which this service is provisioned
1210 svcpart or service definition to provision
1230 E911 Address (optional)
1234 =item provision_external
1236 Provisions an external service (svc_external).
1238 Takes a hash references as parameter with the following keys:
1248 pkgnum of package into which this service is provisioned
1252 svcpart or service definition to provision
1262 =head1 SIGNUP FUNCTIONS
1266 =item signup_info HASHREF
1268 Takes a hash reference as parameter with the following keys:
1272 =item session_id - Optional agent/reseller interface session
1276 Returns a hash reference containing information that may be useful in
1277 displaying a signup page. The hash reference contains the following keys:
1281 =item cust_main_county
1283 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.
1287 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
1288 an agentnum specified explicitly via reseller interface session_id in the
1293 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.
1295 =item agentnum2part_pkg
1297 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.
1301 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.
1303 =item security_phrase
1305 True if the "security_phrase" feature is enabled
1309 Array reference of acceptable payment types for signup
1315 credit card - automatic
1319 credit card - on-demand - version 1.5+ only
1323 electronic check - automatic
1327 electronic check - on-demand - version 1.5+ only
1335 billing, not recommended for signups
1339 free, definitely not recommended for signups
1343 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1349 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1353 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".
1359 =item countrydefault
1365 =item new_customer_minimal HASHREF
1367 Creates a new customer.
1369 Current differences from new_customer: An address is not required. promo_code
1370 and reg_code are not supported. If invoicing_list and _password is passed, a
1371 contact will be created with self-service access (no pkgpart or username is
1372 necessary). No initial billing is run (this may change in a future version).
1374 Takes a hash reference as parameter with the following keys:
1380 first name (required)
1384 last name (required)
1388 (not typically collected; mostly used for ACH transactions)
1420 Daytime phone number
1424 Evening phone number
1432 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1436 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1440 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1444 Expiration date for CARD/DCRD
1448 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1450 =item invoicing_list
1452 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),
1454 =item referral_custnum
1456 referring customer number
1464 pkgpart of initial package
1480 Access number (index, not the literal number)
1484 Country code (to be provisioned as a service)
1488 Phone number (to be provisioned as a service)
1496 Returns a hash reference with the following keys:
1502 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)
1506 =item new_customer HASHREF
1508 Creates a new customer. Takes a hash reference as parameter with the
1515 first name (required)
1519 last name (required)
1523 (not typically collected; mostly used for ACH transactions)
1529 =item address1 (required)
1537 =item city (required)
1545 =item state (required)
1549 =item zip (required)
1555 Daytime phone number
1559 Evening phone number
1567 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1571 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1575 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1579 Expiration date for CARD/DCRD
1583 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1585 =item invoicing_list
1587 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),
1589 =item referral_custnum
1591 referring customer number
1599 pkgpart of initial package
1615 Access number (index, not the literal number)
1619 Country code (to be provisioned as a service)
1623 Phone number (to be provisioned as a service)
1631 Returns a hash reference with the following keys:
1637 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)
1641 =item regionselector HASHREF | LIST
1643 Takes as input a hashref or list of key/value pairs with the following keys:
1647 =item selected_county
1649 Currently selected county
1651 =item selected_state
1653 Currently selected state
1655 =item selected_country
1657 Currently selected country
1661 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1665 Specify a javascript subroutine to call on changes
1671 =item default_country
1677 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>.
1681 Returns a list consisting of three HTML fragments for county selection,
1682 state selection and country selection, respectively.
1686 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1687 sub regionselector {
1694 $param->{'selected_country'} ||= $param->{'default_country'};
1695 $param->{'selected_state'} ||= $param->{'default_state'};
1697 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1701 my %cust_main_county;
1703 # unless ( @cust_main_county ) { #cache
1704 #@cust_main_county = qsearch('cust_main_county', {} );
1705 #foreach my $c ( @cust_main_county ) {
1706 foreach my $c ( @{ $param->{'locales'} } ) {
1707 #$countyflag=1 if $c->county;
1708 $countyflag=1 if $c->{county};
1709 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1710 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1711 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1714 $countyflag=1 if $param->{selected_county};
1716 my $script_html = <<END;
1718 function opt(what,value,text) {
1719 var optionName = new Option(text, value, false, false);
1720 var length = what.length;
1721 what.options[length] = optionName;
1723 function ${prefix}country_changed(what) {
1724 country = what.options[what.selectedIndex].text;
1725 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1726 what.form.${prefix}state.options[i] = null;
1728 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1730 foreach my $country ( sort keys %cust_main_county ) {
1731 $script_html .= "\nif ( country == \"$country\" ) {\n";
1732 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1733 my $text = $state || '(n/a)';
1734 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1736 $script_html .= "}\n";
1739 $script_html .= <<END;
1741 function ${prefix}state_changed(what) {
1744 if ( $countyflag ) {
1745 $script_html .= <<END;
1746 state = what.options[what.selectedIndex].text;
1747 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1748 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1749 what.form.${prefix}county.options[i] = null;
1752 foreach my $country ( sort keys %cust_main_county ) {
1753 $script_html .= "\nif ( country == \"$country\" ) {\n";
1754 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1755 $script_html .= "\nif ( state == \"$state\" ) {\n";
1756 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1757 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1758 my $text = $county || '(n/a)';
1760 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1762 $script_html .= "}\n";
1764 $script_html .= "}\n";
1768 $script_html .= <<END;
1773 my $county_html = $script_html;
1774 if ( $countyflag ) {
1775 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1776 foreach my $county (
1777 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1779 my $text = $county || '(n/a)';
1780 $county_html .= qq!<OPTION VALUE="$county"!.
1781 ($county eq $param->{'selected_county'} ?
1788 $county_html .= '</SELECT>';
1791 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1794 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1795 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1796 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1797 my $text = $state || '(n/a)';
1798 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1799 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1801 $state_html .= '</SELECT>';
1803 my $country_html = '';
1804 if ( scalar( keys %cust_main_county ) > 1 ) {
1806 $country_html = qq(<SELECT NAME="${prefix}country" ).
1807 qq(onChange="${prefix}country_changed(this); ).
1808 $param->{'onchange'}.
1811 my $countrydefault = $param->{default_country} || 'US';
1812 foreach my $country (
1813 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1814 keys %cust_main_county
1816 my $selected = $country eq $param->{'selected_country'}
1819 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1821 $country_html .= '</SELECT>';
1824 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1825 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1829 ($county_html, $state_html, $country_html);
1833 sub regionselector_hashref {
1834 my ($county_html, $state_html, $country_html) = regionselector(@_);
1836 'county_html' => $county_html,
1837 'state_html' => $state_html,
1838 'country_html' => $country_html,
1842 =item location_form HASHREF | LIST
1844 Takes as input a hashref or list of key/value pairs with the following keys:
1850 Current customer session_id
1854 Omit red asterisks from required fields.
1856 =item address1_label
1858 Label for first address line.
1862 Returns an HTML fragment for a location form (address, city, state, zip,
1875 my $session_id = delete $param->{'session_id'};
1877 my $rv = mason_comp( 'session_id' => $session_id,
1878 'comp' => '/elements/location.html',
1879 'args' => [ %$param ],
1883 $rv->{'error'} || $rv->{'output'};
1888 #=item expselect HASHREF | LIST
1890 #Takes as input a hashref or list of key/value pairs with the following keys:
1894 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1896 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1900 =item expselect PREFIX [ DATE ]
1902 Takes as input a unique prefix string and the current expiration date, in
1903 yyyy-mm-dd or m-d-yyyy format
1905 Returns an HTML fragments for expiration date selection.
1911 #if ( ref($_[0]) ) {
1915 #my $prefix = $param->{'prefix'};
1916 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1917 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1919 my $date = scalar(@_) ? shift : '';
1921 my( $m, $y ) = ( 0, 0 );
1922 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1923 ( $m, $y ) = ( $2, $1 );
1924 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1925 ( $m, $y ) = ( $1, $3 );
1927 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1929 $return .= qq!<OPTION VALUE="$_"!;
1930 $return .= " SELECTED" if $_ == $m;
1933 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1935 my $thisYear = $t[5] + 1900;
1936 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1937 $return .= qq!<OPTION VALUE="$_"!;
1938 $return .= " SELECTED" if $_ == $y;
1941 $return .= "</SELECT>";
1946 =item popselector HASHREF | LIST
1948 Takes as input a hashref or list of key/value pairs with the following keys:
1954 Access number number
1958 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>.
1962 Returns an HTML fragment for access number selection.
1966 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1974 my $popnum = $param->{'popnum'};
1975 my $pops = $param->{'pops'};
1977 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1978 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1979 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1980 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1981 if scalar(@$pops) == 1;
1984 my %popnum2pop = ();
1986 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1987 $popnum2pop{$_->{popnum}} = $_;
1992 function opt(what,href,text) {
1993 var optionName = new Option(text, href, false, false)
1994 var length = what.length;
1995 what.options[length] = optionName;
1999 my $init_popstate = $param->{'init_popstate'};
2000 if ( $init_popstate ) {
2001 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2002 $init_popstate. '">';
2005 function acstate_changed(what) {
2006 state = what.options[what.selectedIndex].text;
2007 what.form.popac.options.length = 0
2008 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2012 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2013 foreach my $state ( sort { $a cmp $b } @states ) {
2014 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2016 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2017 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2018 if ($ac eq $param->{'popac'}) {
2019 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2022 $text .= "}\n" unless $init_popstate;
2024 $text .= "popac_changed(what.form.popac)}\n";
2027 function popac_changed(what) {
2028 ac = what.options[what.selectedIndex].text;
2029 what.form.popnum.options.length = 0;
2030 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2034 foreach my $state ( @states ) {
2035 foreach my $popac ( keys %{ $pop{$state} } ) {
2036 $text .= "\nif ( ac == \"$popac\" ) {\n";
2038 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2039 my $o_popnum = $pop->{popnum};
2040 my $poptext = $pop->{city}. ', '. $pop->{state}.
2041 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2043 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2044 if ($popnum == $o_popnum) {
2045 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2053 $text .= "}\n</SCRIPT>\n";
2055 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2058 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2059 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2060 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2061 ">$_" foreach sort { $a cmp $b } @states;
2062 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2065 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2066 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2068 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2071 #comment this block to disable initial list polulation
2072 my @initial_select = ();
2073 if ( scalar( @$pops ) > 100 ) {
2074 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2076 @initial_select = @$pops;
2078 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2079 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2080 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2081 $pop->{city}. ', '. $pop->{state}.
2082 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2085 $text .= qq!</SELECT></TD></TR></TABLE>!;
2091 =item domainselector HASHREF | LIST
2093 Takes as input a hashref or list of key/value pairs with the following keys:
2103 Service number of the selected item.
2107 Returns an HTML fragment for domain selection.
2111 sub domainselector {
2118 my $domsvc= $param->{'domsvc'};
2120 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2121 my $domains = $rv->{'domains'};
2122 $domsvc = $rv->{'domsvc'} unless $domsvc;
2124 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2125 unless scalar(keys %$domains);
2127 if (scalar(keys %$domains) == 1) {
2129 foreach(keys %$domains) {
2132 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2133 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2136 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2138 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2140 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2141 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2142 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2143 $domains->{$domain};
2146 $text .= qq!</SELECT></TD></TR>!;
2152 =item didselector HASHREF | LIST
2154 Takes as input a hashref or list of key/value pairs with the following keys:
2160 Field name for the returned HTML fragment.
2164 Service definition (see L<FS::part_svc>)
2168 Returns an HTML fragment for DID selection.
2180 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2181 'args'=>[ %$param ],
2185 $rv->{'error'} || $rv->{'output'};
2191 =head1 RESELLER FUNCTIONS
2193 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2194 with their active session, and the B<customer_info> and B<order_pkg> functions
2195 with their active session and an additional I<custnum> parameter.
2197 For the most part, development of the reseller web interface has been
2198 superceded by agent-virtualized access to the backend.
2210 =item agent_list_customers
2212 List agent's customers.
2220 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>