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 );
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
326 =head1 "MY ACCOUNT" FUNCTIONS
332 Creates a user session. Takes a hash reference as parameter with the
339 Email address (username@domain), instead of username and domain. Required for
340 contact-based self-service login, can also be used for svc_acct-based login.
356 Returns a hash reference with the following keys:
362 Empty on success, or an error message on errors.
366 Session identifier for successful logins
370 =item customer_info HASHREF
372 Returns general customer information.
374 Takes a hash reference as parameter with a single key: B<session_id>
376 Returns a hash reference with the following keys:
390 Array reference of hash references of open inoices. Each hash reference has
391 the following keys: invnum, date, owed
395 An HTML fragment containing shipping and billing addresses.
397 =item The following fields are also returned
399 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
403 =item edit_info HASHREF
405 Takes a hash reference as parameter with any of the following keys:
407 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
409 If a field exists, the customer record is updated with the new value of that
410 field. If a field does not exist, that field is not changed on the customer
413 Returns a hash reference with a single key, B<error>, empty on success, or an
414 error message on errors
416 =item invoice HASHREF
418 Returns an invoice. Takes a hash reference as parameter with two keys:
419 session_id and invnum
421 Returns a hash reference with the following keys:
427 Empty on success, or an error message on errors
439 =item list_invoices HASHREF
441 Returns a list of all customer invoices. Takes a hash references with a single
444 Returns a hash reference with the following keys:
450 Empty on success, or an error message on errors
454 Reference to array of hash references with the following keys:
464 Invoice date, in UNIX epoch time
472 Cancels this customer.
474 Takes a hash reference as parameter with a single key: B<session_id>
476 Returns a hash reference with a single key, B<error>, which is empty on
477 success or an error message on errors.
479 =item payment_info HASHREF
481 Returns information that may be useful in displaying a payment page.
483 Takes a hash reference as parameter with a single key: B<session_id>.
485 Returns a hash reference with the following keys:
491 Empty on success, or an error message on errors
499 Exact name on credit card (CARD/DCRD)
523 Customer's current default payment type.
527 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
531 For CARD/DCRD payment types, the card number
535 For CARD/DCRD payment types, expiration month
539 For CARD/DCRD payment types, expiration year
541 =item cust_main_county
543 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.
547 Array reference of all states in the current default country.
551 Hash reference of card types; keys are card types, values are the exact strings
552 passed to the process_payment function
556 #this doesn't actually work yet
560 #Unique transaction identifier (prevents multiple charges), passed to the
561 #process_payment function
565 =item process_payment HASHREF
567 Processes a payment and possible change of address or payment type. Takes a
568 hash reference as parameter with the following keys:
582 If true, address and card information entered will be saved for subsequent
587 If true, future credit card payments will be done automatically (sets payby to
588 CARD). If false, future credit card payments will be done on-demand (sets
589 payby to DCRD). This option only has meaning if B<save> is set true.
617 Two-letter country code
625 Card expiration month
633 #this doesn't actually work yet
637 #Unique transaction identifier, returned from the payment_info function.
638 #Prevents multiple charges.
642 Returns a hash reference with a single key, B<error>, empty on success, or an
643 error message on errors.
645 =item process_payment_order_pkg
647 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
648 payment processes sucessfully, the package is ordered. Takes a hash reference
649 as parameter with the keys of both methods.
651 Returns a hash reference with a single key, B<error>, empty on success, or an
652 error message on errors.
654 =item process_payment_change_pkg
656 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
657 payment processes sucessfully, the package is ordered. Takes a hash reference
658 as parameter with the keys of both methods.
660 Returns a hash reference with a single key, B<error>, empty on success, or an
661 error message on errors.
664 =item process_payment_order_renew
666 Combines the B<process_payment> and B<order_renew> functions in one step. If
667 the payment processes sucessfully, the renewal is processed. Takes a hash
668 reference as parameter with the keys of both methods.
670 Returns a hash reference with a single key, B<error>, empty on success, or an
671 error message on errors.
675 Returns package information for this customer. For more detail on services,
678 Takes a hash reference as parameter with a single key: B<session_id>
680 Returns a hash reference containing customer package information. The hash reference contains the following keys:
690 Empty on success, or an error message on errors.
692 =item cust_pkg HASHREF
694 Array reference of hash references, each of which has the fields of a cust_pkg
695 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
696 the internal FS:: objects, but hash references of columns and values.
700 =item part_pkg fields
702 All fields of part_pkg for this specific cust_pkg (be careful with this
703 information - it may reveal more about your available packages than you would
704 like users to know in aggregate)
708 #XXX pare part_pkg fields down to a more secure subset
712 An array of hash references indicating information on unprovisioned services
713 available for provisioning for this specific cust_pkg. Each has the following
718 =item part_svc fields
720 All fields of part_svc (be careful with this information - it may reveal more
721 about your available packages than you would like users to know in aggregate)
725 #XXX pare part_svc fields down to a more secure subset
731 An array of hash references indicating information on the customer services
732 already provisioned for this specific cust_pkg. Each has the following keys:
738 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.
744 Primary key for this service
748 Service definition (see L<FS::part_svc>)
752 Customer package (see L<FS::cust_pkg>)
756 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
764 Returns service information for this customer.
766 Takes a hash reference as parameter with a single key: B<session_id>
768 Returns a hash reference containing customer package information. The hash reference contains the following keys:
778 An array of hash references indicating information on all of this customer's
779 services. Each has the following keys:
785 Primary key for this service
793 Meaningful user-specific identifier for the service (i.e. username, domain, or
798 Account (svc_acct) services also have the following keys:
816 Upload bytes remaining
820 Download bytes remaining
824 Total bytes remaining
826 =item recharge_amount
830 =item recharge_seconds
832 Number of seconds gained by recharge
834 =item recharge_upbytes
836 Number of upload bytes gained by recharge
838 =item recharge_downbytes
840 Number of download bytes gained by recharge
842 =item recharge_totalbytes
844 Number of total bytes gained by recharge
852 Orders a package for this customer.
854 Takes a hash reference as parameter with the following keys:
864 Package to order (see L<FS::part_pkg>).
868 Quantity for this package order (default 1).
872 Optional locationnum for this package order, for existing locations.
874 Or, for new locations, pass the following fields: address1*, address2, city*,
875 county, state*, zip*, country. (* = required in this case)
887 Service to order (see L<FS::part_svc>).
889 Normally optional; required only to provision a non-svc_acct service, or if the
890 package definition does not contain one svc_acct service definition with
891 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
892 also be specified to indicate that no initial service should be provisioned.
896 Fields used when provisioning an svc_acct service:
910 Optional security phrase
914 Optional Access number number
918 Fields used when provisioning an svc_domain service:
928 Fields used when provisioning an svc_phone service:
946 Fields used when provisioning an svc_external service:
960 Fields used when provisioning an svc_pbx service:
974 Returns a hash reference with a single key, B<error>, empty on success, or an
975 error message on errors. The special error '_decline' is returned for
976 declined transactions.
980 Changes a package for this customer.
982 Takes a hash reference as parameter with the following keys:
992 Existing customer package.
996 New package to order (see L<FS::part_pkg>).
1000 Returns a hash reference with the following keys:
1006 Empty on success, or an error message on errors.
1010 On success, the new pkgnum
1017 Provides useful info for early renewals.
1019 Takes a hash reference as parameter with the following keys:
1029 Returns a hash reference. On errors, it contains a single key, B<error>, with
1030 the error message. Otherwise, contains a single key, B<dates>, pointing to
1031 an array refernce of hash references. Each hash reference contains the
1038 (Future) Bill date. Indicates a future date for which billing could be run.
1039 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1042 =item bill_date_pretty
1044 (Future) Bill date as a human-readable string. (Convenience for display;
1045 subject to change, so best not to parse for the date.)
1049 Base amount which will be charged if renewed early as of this date.
1053 Renewal date; i.e. even-futher future date at which the customer will be paid
1054 through if the early renewal is completed with the given B<bill-date>.
1055 Specified as a integer UNIX timestamp.
1057 =item renew_date_pretty
1059 Renewal date as a human-readable string. (Convenience for display;
1060 subject to change, so best not to parse for the date.)
1064 Package that will be renewed.
1068 Expiration date of the package that will be renewed.
1070 =item expire_date_pretty
1072 Expiration date of the package that will be renewed, as a human-readable
1073 string. (Convenience for display; subject to change, so best not to parse for
1080 Renews this customer early; i.e. runs billing for this customer in advance.
1082 Takes a hash reference as parameter with the following keys:
1092 Integer date as returned by the B<renew_info> function, indicating the advance
1093 date for which to run billing.
1097 Returns a hash reference with a single key, B<error>, empty on success, or an
1098 error message on errors.
1102 Cancels a package for this customer.
1104 Takes a hash reference as parameter with the following keys:
1114 pkgpart of package to cancel
1118 Returns a hash reference with a single key, B<error>, empty on success, or an
1119 error message on errors.
1123 =head1 SIGNUP FUNCTIONS
1127 =item signup_info HASHREF
1129 Takes a hash reference as parameter with the following keys:
1133 =item session_id - Optional agent/reseller interface session
1137 Returns a hash reference containing information that may be useful in
1138 displaying a signup page. The hash reference contains the following keys:
1142 =item cust_main_county
1144 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.
1148 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
1149 an agentnum specified explicitly via reseller interface session_id in the
1154 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.
1156 =item agentnum2part_pkg
1158 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.
1162 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.
1164 =item security_phrase
1166 True if the "security_phrase" feature is enabled
1170 Array reference of acceptable payment types for signup
1176 credit card - automatic
1180 credit card - on-demand - version 1.5+ only
1184 electronic check - automatic
1188 electronic check - on-demand - version 1.5+ only
1196 billing, not recommended for signups
1200 free, definitely not recommended for signups
1204 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1210 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1214 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".
1220 =item countrydefault
1226 =item new_customer HASHREF
1228 Creates a new customer. Takes a hash reference as parameter with the
1235 first name (required)
1239 last name (required)
1243 (not typically collected; mostly used for ACH transactions)
1249 =item address1 (required)
1257 =item city (required)
1265 =item state (required)
1269 =item zip (required)
1275 Daytime phone number
1279 Evening phone number
1287 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1291 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1295 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1299 Expiration date for CARD/DCRD
1303 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1305 =item invoicing_list
1307 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),
1309 =item referral_custnum
1311 referring customer number
1319 pkgpart of initial package
1335 Access number (index, not the literal number)
1339 Country code (to be provisioned as a service)
1343 Phone number (to be provisioned as a service)
1351 Returns a hash reference with the following keys:
1357 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)
1361 =item regionselector HASHREF | LIST
1363 Takes as input a hashref or list of key/value pairs with the following keys:
1367 =item selected_county
1369 Currently selected county
1371 =item selected_state
1373 Currently selected state
1375 =item selected_country
1377 Currently selected country
1381 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1385 Specify a javascript subroutine to call on changes
1391 =item default_country
1397 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>.
1401 Returns a list consisting of three HTML fragments for county selection,
1402 state selection and country selection, respectively.
1406 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1407 sub regionselector {
1414 $param->{'selected_country'} ||= $param->{'default_country'};
1415 $param->{'selected_state'} ||= $param->{'default_state'};
1417 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1421 my %cust_main_county;
1423 # unless ( @cust_main_county ) { #cache
1424 #@cust_main_county = qsearch('cust_main_county', {} );
1425 #foreach my $c ( @cust_main_county ) {
1426 foreach my $c ( @{ $param->{'locales'} } ) {
1427 #$countyflag=1 if $c->county;
1428 $countyflag=1 if $c->{county};
1429 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1430 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1431 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1434 $countyflag=1 if $param->{selected_county};
1436 my $script_html = <<END;
1438 function opt(what,value,text) {
1439 var optionName = new Option(text, value, false, false);
1440 var length = what.length;
1441 what.options[length] = optionName;
1443 function ${prefix}country_changed(what) {
1444 country = what.options[what.selectedIndex].text;
1445 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1446 what.form.${prefix}state.options[i] = null;
1448 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1450 foreach my $country ( sort keys %cust_main_county ) {
1451 $script_html .= "\nif ( country == \"$country\" ) {\n";
1452 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1453 my $text = $state || '(n/a)';
1454 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1456 $script_html .= "}\n";
1459 $script_html .= <<END;
1461 function ${prefix}state_changed(what) {
1464 if ( $countyflag ) {
1465 $script_html .= <<END;
1466 state = what.options[what.selectedIndex].text;
1467 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1468 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1469 what.form.${prefix}county.options[i] = null;
1472 foreach my $country ( sort keys %cust_main_county ) {
1473 $script_html .= "\nif ( country == \"$country\" ) {\n";
1474 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1475 $script_html .= "\nif ( state == \"$state\" ) {\n";
1476 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1477 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1478 my $text = $county || '(n/a)';
1480 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1482 $script_html .= "}\n";
1484 $script_html .= "}\n";
1488 $script_html .= <<END;
1493 my $county_html = $script_html;
1494 if ( $countyflag ) {
1495 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1496 foreach my $county (
1497 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1499 my $text = $county || '(n/a)';
1500 $county_html .= qq!<OPTION VALUE="$county"!.
1501 ($county eq $param->{'selected_county'} ?
1508 $county_html .= '</SELECT>';
1511 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1514 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1515 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1516 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1517 my $text = $state || '(n/a)';
1518 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1519 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1521 $state_html .= '</SELECT>';
1523 my $country_html = '';
1524 if ( scalar( keys %cust_main_county ) > 1 ) {
1526 $country_html = qq(<SELECT NAME="${prefix}country" ).
1527 qq(onChange="${prefix}country_changed(this); ).
1528 $param->{'onchange'}.
1531 my $countrydefault = $param->{default_country} || 'US';
1532 foreach my $country (
1533 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1534 keys %cust_main_county
1536 my $selected = $country eq $param->{'selected_country'}
1539 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1541 $country_html .= '</SELECT>';
1544 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1545 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1549 ($county_html, $state_html, $country_html);
1553 sub regionselector_hashref {
1554 my ($county_html, $state_html, $country_html) = regionselector(@_);
1556 'county_html' => $county_html,
1557 'state_html' => $state_html,
1558 'country_html' => $country_html,
1562 =item location_form HASHREF | LIST
1564 Takes as input a hashref or list of key/value pairs with the following keys:
1570 Current customer session_id
1574 Omit red asterisks from required fields.
1576 =item address1_label
1578 Label for first address line.
1582 Returns an HTML fragment for a location form (address, city, state, zip,
1595 my $session_id = delete $param->{'session_id'};
1597 my $rv = mason_comp( 'session_id' => $session_id,
1598 'comp' => '/elements/location.html',
1599 'args' => [ %$param ],
1603 $rv->{'error'} || $rv->{'output'};
1608 #=item expselect HASHREF | LIST
1610 #Takes as input a hashref or list of key/value pairs with the following keys:
1614 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1616 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1620 =item expselect PREFIX [ DATE ]
1622 Takes as input a unique prefix string and the current expiration date, in
1623 yyyy-mm-dd or m-d-yyyy format
1625 Returns an HTML fragments for expiration date selection.
1631 #if ( ref($_[0]) ) {
1635 #my $prefix = $param->{'prefix'};
1636 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1637 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1639 my $date = scalar(@_) ? shift : '';
1641 my( $m, $y ) = ( 0, 0 );
1642 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1643 ( $m, $y ) = ( $2, $1 );
1644 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1645 ( $m, $y ) = ( $1, $3 );
1647 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1649 $return .= qq!<OPTION VALUE="$_"!;
1650 $return .= " SELECTED" if $_ == $m;
1653 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1655 my $thisYear = $t[5] + 1900;
1656 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1657 $return .= qq!<OPTION VALUE="$_"!;
1658 $return .= " SELECTED" if $_ == $y;
1661 $return .= "</SELECT>";
1666 =item popselector HASHREF | LIST
1668 Takes as input a hashref or list of key/value pairs with the following keys:
1674 Access number number
1678 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>.
1682 Returns an HTML fragment for access number selection.
1686 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1694 my $popnum = $param->{'popnum'};
1695 my $pops = $param->{'pops'};
1697 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1698 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1699 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1700 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1701 if scalar(@$pops) == 1;
1704 my %popnum2pop = ();
1706 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1707 $popnum2pop{$_->{popnum}} = $_;
1712 function opt(what,href,text) {
1713 var optionName = new Option(text, href, false, false)
1714 var length = what.length;
1715 what.options[length] = optionName;
1719 my $init_popstate = $param->{'init_popstate'};
1720 if ( $init_popstate ) {
1721 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1722 $init_popstate. '">';
1725 function acstate_changed(what) {
1726 state = what.options[what.selectedIndex].text;
1727 what.form.popac.options.length = 0
1728 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1732 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1733 foreach my $state ( sort { $a cmp $b } @states ) {
1734 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1736 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1737 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1738 if ($ac eq $param->{'popac'}) {
1739 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1742 $text .= "}\n" unless $init_popstate;
1744 $text .= "popac_changed(what.form.popac)}\n";
1747 function popac_changed(what) {
1748 ac = what.options[what.selectedIndex].text;
1749 what.form.popnum.options.length = 0;
1750 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1754 foreach my $state ( @states ) {
1755 foreach my $popac ( keys %{ $pop{$state} } ) {
1756 $text .= "\nif ( ac == \"$popac\" ) {\n";
1758 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1759 my $o_popnum = $pop->{popnum};
1760 my $poptext = $pop->{city}. ', '. $pop->{state}.
1761 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1763 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1764 if ($popnum == $o_popnum) {
1765 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1773 $text .= "}\n</SCRIPT>\n";
1775 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1778 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1779 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1780 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1781 ">$_" foreach sort { $a cmp $b } @states;
1782 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1785 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1786 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1788 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1791 #comment this block to disable initial list polulation
1792 my @initial_select = ();
1793 if ( scalar( @$pops ) > 100 ) {
1794 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1796 @initial_select = @$pops;
1798 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1799 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1800 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1801 $pop->{city}. ', '. $pop->{state}.
1802 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1805 $text .= qq!</SELECT></TD></TR></TABLE>!;
1811 =item domainselector HASHREF | LIST
1813 Takes as input a hashref or list of key/value pairs with the following keys:
1823 Service number of the selected item.
1827 Returns an HTML fragment for domain selection.
1831 sub domainselector {
1838 my $domsvc= $param->{'domsvc'};
1840 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1841 my $domains = $rv->{'domains'};
1842 $domsvc = $rv->{'domsvc'} unless $domsvc;
1844 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1845 unless scalar(keys %$domains);
1847 if (scalar(keys %$domains) == 1) {
1849 foreach(keys %$domains) {
1852 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1853 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1856 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
1858 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
1860 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1861 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1862 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1863 $domains->{$domain};
1866 $text .= qq!</SELECT></TD></TR>!;
1872 =item didselector HASHREF | LIST
1874 Takes as input a hashref or list of key/value pairs with the following keys:
1880 Field name for the returned HTML fragment.
1884 Service definition (see L<FS::part_svc>)
1888 Returns an HTML fragment for DID selection.
1900 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1901 'args'=>[ %$param ],
1905 $rv->{'error'} || $rv->{'output'};
1911 =head1 RESELLER FUNCTIONS
1913 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1914 with their active session, and the B<customer_info> and B<order_pkg> functions
1915 with their active session and an additional I<custnum> parameter.
1917 For the most part, development of the reseller web interface has been
1918 superceded by agent-virtualized access to the backend.
1930 =item agent_list_customers
1932 List agent's customers.
1940 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>