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 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
36 'invoice' => 'MyAccount/invoice',
37 'invoice_pdf' => 'MyAccount/invoice_pdf',
38 'legacy_invoice' => 'MyAccount/legacy_invoice',
39 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
40 'invoice_logo' => 'MyAccount/invoice_logo',
41 'list_invoices' => 'MyAccount/list_invoices', #?
42 'cancel' => 'MyAccount/cancel', #add to ss cgi!
43 'payment_info' => 'MyAccount/payment_info',
44 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
45 'process_payment' => 'MyAccount/process_payment',
46 'store_payment' => 'MyAccount/store_payment',
47 'process_stored_payment' => 'MyAccount/process_stored_payment',
48 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
49 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
50 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
51 'process_prepay' => 'MyAccount/process_prepay',
52 'realtime_collect' => 'MyAccount/realtime_collect',
53 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
54 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
55 'list_svc_usage' => 'MyAccount/list_svc_usage',
56 'svc_status_html' => 'MyAccount/svc_status_html',
57 'svc_status_hash' => 'MyAccount/svc_status_hash',
58 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
59 'acct_forward_info' => 'MyAccount/acct_forward_info',
60 'process_acct_forward' => 'MyAccount/process_acct_forward',
61 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
62 'add_dsl_device' => 'MyAccount/add_dsl_device',
63 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
64 'port_graph' => 'MyAccount/port_graph',
65 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
66 'list_support_usage' => 'MyAccount/list_support_usage',
67 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
68 'change_pkg' => 'MyAccount/change_pkg',
69 'order_recharge' => 'MyAccount/order_recharge',
70 'renew_info' => 'MyAccount/renew_info',
71 'order_renew' => 'MyAccount/order_renew',
72 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
73 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
74 'charge' => 'MyAccount/charge', #?
75 'part_svc_info' => 'MyAccount/part_svc_info',
76 'provision_acct' => 'MyAccount/provision_acct',
77 'provision_phone' => 'MyAccount/provision_phone',
78 'provision_external' => 'MyAccount/provision_external',
79 'unprovision_svc' => 'MyAccount/unprovision_svc',
80 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
81 'reset_passwd' => 'MyAccount/reset_passwd',
82 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
83 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
84 'create_ticket' => 'MyAccount/create_ticket',
85 'get_ticket' => 'MyAccount/get_ticket',
86 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
87 'did_report' => 'MyAccount/did_report',
88 'signup_info' => 'Signup/signup_info',
89 'skin_info' => 'MyAccount/skin_info',
90 'access_info' => 'MyAccount/access_info',
91 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
92 'new_customer' => 'Signup/new_customer',
93 'capture_payment' => 'Signup/capture_payment',
94 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
95 'new_agent' => 'Agent/new_agent',
96 'agent_login' => 'Agent/agent_login',
97 'agent_logout' => 'Agent/agent_logout',
98 'agent_info' => 'Agent/agent_info',
99 'agent_list_customers' => 'Agent/agent_list_customers',
100 'check_username' => 'Agent/check_username',
101 'suspend_username' => 'Agent/suspend_username',
102 'unsuspend_username' => 'Agent/unsuspend_username',
103 'mason_comp' => 'MasonComponent/mason_comp',
104 'call_time' => 'PrepaidPhone/call_time',
105 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
106 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
108 #'bulk_processrow' => 'Bulk/processrow',
109 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
111 'ping' => 'SGNG/ping',
112 'decompify_pkgs' => 'SGNG/decompify_pkgs',
113 'previous_payment_info' => 'SGNG/previous_payment_info',
114 'previous_payment_info_renew_info'
115 => 'SGNG/previous_payment_info_renew_info',
116 'previous_process_payment' => 'SGNG/previous_process_payment',
117 'previous_process_payment_order_pkg'
118 => 'SGNG/previous_process_payment_order_pkg',
119 'previous_process_payment_change_pkg'
120 => 'SGNG/previous_process_payment_change_pkg',
121 'previous_process_payment_order_renew'
122 => 'SGNG/previous_process_payment_order_renew',
126 qw( regionselector regionselector_hashref location_form
127 expselect popselector domainselector didselector
131 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
132 $ENV{'SHELL'} = '/bin/sh';
133 $ENV{'IFS'} = " \t\n";
136 $ENV{'BASH_ENV'} = '';
138 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
139 #if you grant appropriate permissions to whatever user
140 my $freeside_uid = scalar(getpwnam('freeside'));
141 die "not running as the freeside user\n"
142 if $> != $freeside_uid && ! $skip_uid_check;
144 -e $dir or die "FATAL: $dir doesn't exist!";
145 -d $dir or die "FATAL: $dir isn't a directory!";
146 -r $dir or die "FATAL: Can't read $dir as freeside user!";
147 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
149 foreach my $autoload ( keys %autoload ) {
152 "sub $autoload { ". '
157 #warn scalar(@_). ": ". join(" / ", @_);
161 $param->{_packet} = \''. $autoload{$autoload}. '\';
163 simple_packet($param);
173 warn "sending ". $packet->{_packet}. " to server"
175 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
176 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
177 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
180 #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
182 #block until there is a message on socket
183 # my $w = new IO::Select;
185 # my @wait = $w->can_read;
187 warn "reading message from server"
190 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
191 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
193 warn "returning message to client"
201 FS::SelfService - Freeside self-service API
205 # password and shell account changes
206 use FS::SelfService qw(passwd chfn chsh);
208 # "my account" functionality
209 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
211 my $rv = login( { 'username' => $username,
213 'password' => $password,
217 if ( $rv->{'error'} ) {
218 #handle login error...
221 my $session_id = $rv->{'session_id'};
224 my $customer_info = customer_info( { 'session_id' => $session_id } );
226 #payment_info and process_payment are available in 1.5+ only
227 my $payment_info = payment_info( { 'session_id' => $session_id } );
229 #!!! process_payment example
231 #!!! list_pkgs example
233 #!!! order_pkg example
235 #!!! cancel_pkg example
237 # signup functionality
238 use FS::SelfService qw( signup_info new_customer );
240 my $signup_info = signup_info;
242 $rv = new_customer( {
245 'company' => $company,
246 'address1' => $address1,
247 'address2' => $address2,
251 'country' => $country,
252 'daytime' => $daytime,
256 'payinfo' => $payinfo,
258 'paystart_month' => $paystart_month
259 'paystart_year' => $paystart_year,
260 'payissue' => $payissue,
262 'paydate' => $paydate,
263 'payname' => $payname,
264 'invoicing_list' => $invoicing_list,
265 'referral_custnum' => $referral_custnum,
266 'agentnum' => $agentnum,
267 'pkgpart' => $pkgpart,
269 'username' => $username,
270 '_password' => $password,
274 'phonenum' => $phonenum,
279 my $error = $rv->{'error'};
280 if ( $error eq '_decline' ) {
290 Use this API to implement your own client "self-service" module.
292 If you just want to customize the look of the existing "self-service" module,
295 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
307 =head1 "MY ACCOUNT" FUNCTIONS
313 Creates a user session. Takes a hash reference as parameter with the
332 Returns a hash reference with the following keys:
338 Empty on success, or an error message on errors.
342 Session identifier for successful logins
346 =item customer_info HASHREF
348 Returns general customer information.
350 Takes a hash reference as parameter with a single key: B<session_id>
352 Returns a hash reference with the following keys:
366 Array reference of hash references of open inoices. Each hash reference has
367 the following keys: invnum, date, owed
371 An HTML fragment containing shipping and billing addresses.
373 =item The following fields are also returned
375 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
379 =item edit_info HASHREF
381 Takes a hash reference as parameter with any of the following keys:
383 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
385 If a field exists, the customer record is updated with the new value of that
386 field. If a field does not exist, that field is not changed on the customer
389 Returns a hash reference with a single key, B<error>, empty on success, or an
390 error message on errors
392 =item invoice HASHREF
394 Returns an invoice. Takes a hash reference as parameter with two keys:
395 session_id and invnum
397 Returns a hash reference with the following keys:
403 Empty on success, or an error message on errors
415 =item list_invoices HASHREF
417 Returns a list of all customer invoices. Takes a hash references with a single
420 Returns a hash reference with the following keys:
426 Empty on success, or an error message on errors
430 Reference to array of hash references with the following keys:
440 Invoice date, in UNIX epoch time
448 Cancels this customer.
450 Takes a hash reference as parameter with a single key: B<session_id>
452 Returns a hash reference with a single key, B<error>, which is empty on
453 success or an error message on errors.
455 =item payment_info HASHREF
457 Returns information that may be useful in displaying a payment page.
459 Takes a hash reference as parameter with a single key: B<session_id>.
461 Returns a hash reference with the following keys:
467 Empty on success, or an error message on errors
475 Exact name on credit card (CARD/DCRD)
499 Customer's current default payment type.
503 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
507 For CARD/DCRD payment types, the card number
511 For CARD/DCRD payment types, expiration month
515 For CARD/DCRD payment types, expiration year
517 =item cust_main_county
519 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.
523 Array reference of all states in the current default country.
527 Hash reference of card types; keys are card types, values are the exact strings
528 passed to the process_payment function
532 #this doesn't actually work yet
536 #Unique transaction identifier (prevents multiple charges), passed to the
537 #process_payment function
541 =item process_payment HASHREF
543 Processes a payment and possible change of address or payment type. Takes a
544 hash reference as parameter with the following keys:
558 If true, address and card information entered will be saved for subsequent
563 If true, future credit card payments will be done automatically (sets payby to
564 CARD). If false, future credit card payments will be done on-demand (sets
565 payby to DCRD). This option only has meaning if B<save> is set true.
593 Two-letter country code
601 Card expiration month
609 #this doesn't actually work yet
613 #Unique transaction identifier, returned from the payment_info function.
614 #Prevents multiple charges.
618 Returns a hash reference with a single key, B<error>, empty on success, or an
619 error message on errors.
621 =item process_payment_order_pkg
623 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
624 payment processes sucessfully, the package is ordered. Takes a hash reference
625 as parameter with the keys of both methods.
627 Returns a hash reference with a single key, B<error>, empty on success, or an
628 error message on errors.
630 =item process_payment_change_pkg
632 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
633 payment processes sucessfully, the package is ordered. Takes a hash reference
634 as parameter with the keys of both methods.
636 Returns a hash reference with a single key, B<error>, empty on success, or an
637 error message on errors.
640 =item process_payment_order_renew
642 Combines the B<process_payment> and B<order_renew> functions in one step. If
643 the payment processes sucessfully, the renewal is processed. Takes a hash
644 reference as parameter with the keys of both methods.
646 Returns a hash reference with a single key, B<error>, empty on success, or an
647 error message on errors.
651 Returns package information for this customer. For more detail on services,
654 Takes a hash reference as parameter with a single key: B<session_id>
656 Returns a hash reference containing customer package information. The hash reference contains the following keys:
666 Empty on success, or an error message on errors.
668 =item cust_pkg HASHREF
670 Array reference of hash references, each of which has the fields of a cust_pkg
671 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
672 the internal FS:: objects, but hash references of columns and values.
676 =item part_pkg fields
678 All fields of part_pkg for this specific cust_pkg (be careful with this
679 information - it may reveal more about your available packages than you would
680 like users to know in aggregate)
684 #XXX pare part_pkg fields down to a more secure subset
688 An array of hash references indicating information on unprovisioned services
689 available for provisioning for this specific cust_pkg. Each has the following
694 =item part_svc fields
696 All fields of part_svc (be careful with this information - it may reveal more
697 about your available packages than you would like users to know in aggregate)
701 #XXX pare part_svc fields down to a more secure subset
707 An array of hash references indicating information on the customer services
708 already provisioned for this specific cust_pkg. Each has the following keys:
714 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.
720 Primary key for this service
724 Service definition (see L<FS::part_svc>)
728 Customer package (see L<FS::cust_pkg>)
732 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
740 Returns service information for this customer.
742 Takes a hash reference as parameter with a single key: B<session_id>
744 Returns a hash reference containing customer package information. The hash reference contains the following keys:
754 An array of hash references indicating information on all of this customer's
755 services. Each has the following keys:
761 Primary key for this service
769 Meaningful user-specific identifier for the service (i.e. username, domain, or
774 Account (svc_acct) services also have the following keys:
792 Upload bytes remaining
796 Download bytes remaining
800 Total bytes remaining
802 =item recharge_amount
806 =item recharge_seconds
808 Number of seconds gained by recharge
810 =item recharge_upbytes
812 Number of upload bytes gained by recharge
814 =item recharge_downbytes
816 Number of download bytes gained by recharge
818 =item recharge_totalbytes
820 Number of total bytes gained by recharge
828 Orders a package for this customer.
830 Takes a hash reference as parameter with the following keys:
840 Package to order (see L<FS::part_pkg>).
844 Service to order (see L<FS::part_svc>).
846 Normally optional; required only to provision a non-svc_acct service, or if the
847 package definition does not contain one svc_acct service definition with
848 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
849 also be specified to indicate that no initial service should be provisioned.
853 Fields used when provisioning an svc_acct service:
867 Optional security phrase
871 Optional Access number number
875 Fields used when provisioning an svc_domain service:
885 Fields used when provisioning an svc_phone service:
903 Fields used when provisioning an svc_external service:
917 Fields used when provisioning an svc_pbx service:
931 Returns a hash reference with a single key, B<error>, empty on success, or an
932 error message on errors. The special error '_decline' is returned for
933 declined transactions.
937 Changes a package for this customer.
939 Takes a hash reference as parameter with the following keys:
949 Existing customer package.
953 New package to order (see L<FS::part_pkg>).
957 Returns a hash reference with the following keys:
963 Empty on success, or an error message on errors.
967 On success, the new pkgnum
974 Provides useful info for early renewals.
976 Takes a hash reference as parameter with the following keys:
986 Returns a hash reference. On errors, it contains a single key, B<error>, with
987 the error message. Otherwise, contains a single key, B<dates>, pointing to
988 an array refernce of hash references. Each hash reference contains the
995 (Future) Bill date. Indicates a future date for which billing could be run.
996 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
999 =item bill_date_pretty
1001 (Future) Bill date as a human-readable string. (Convenience for display;
1002 subject to change, so best not to parse for the date.)
1006 Base amount which will be charged if renewed early as of this date.
1010 Renewal date; i.e. even-futher future date at which the customer will be paid
1011 through if the early renewal is completed with the given B<bill-date>.
1012 Specified as a integer UNIX timestamp.
1014 =item renew_date_pretty
1016 Renewal date as a human-readable string. (Convenience for display;
1017 subject to change, so best not to parse for the date.)
1021 Package that will be renewed.
1025 Expiration date of the package that will be renewed.
1027 =item expire_date_pretty
1029 Expiration date of the package that will be renewed, as a human-readable
1030 string. (Convenience for display; subject to change, so best not to parse for
1037 Renews this customer early; i.e. runs billing for this customer in advance.
1039 Takes a hash reference as parameter with the following keys:
1049 Integer date as returned by the B<renew_info> function, indicating the advance
1050 date for which to run billing.
1054 Returns a hash reference with a single key, B<error>, empty on success, or an
1055 error message on errors.
1059 Cancels a package for this customer.
1061 Takes a hash reference as parameter with the following keys:
1071 pkgpart of package to cancel
1075 Returns a hash reference with a single key, B<error>, empty on success, or an
1076 error message on errors.
1080 =head1 SIGNUP FUNCTIONS
1084 =item signup_info HASHREF
1086 Takes a hash reference as parameter with the following keys:
1090 =item session_id - Optional agent/reseller interface session
1094 Returns a hash reference containing information that may be useful in
1095 displaying a signup page. The hash reference contains the following keys:
1099 =item cust_main_county
1101 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.
1105 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
1106 an agentnum specified explicitly via reseller interface session_id in the
1111 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.
1113 =item agentnum2part_pkg
1115 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.
1119 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.
1121 =item security_phrase
1123 True if the "security_phrase" feature is enabled
1127 Array reference of acceptable payment types for signup
1133 credit card - automatic
1137 credit card - on-demand - version 1.5+ only
1141 electronic check - automatic
1145 electronic check - on-demand - version 1.5+ only
1153 billing, not recommended for signups
1157 free, definitely not recommended for signups
1161 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1167 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1171 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".
1177 =item countrydefault
1183 =item new_customer HASHREF
1185 Creates a new customer. Takes a hash reference as parameter with the
1192 first name (required)
1196 last name (required)
1200 (not typically collected; mostly used for ACH transactions)
1206 =item address1 (required)
1214 =item city (required)
1222 =item state (required)
1226 =item zip (required)
1232 Daytime phone number
1236 Evening phone number
1244 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1248 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1252 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1256 Expiration date for CARD/DCRD
1260 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1262 =item invoicing_list
1264 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),
1266 =item referral_custnum
1268 referring customer number
1276 pkgpart of initial package
1292 Access number (index, not the literal number)
1296 Country code (to be provisioned as a service)
1300 Phone number (to be provisioned as a service)
1308 Returns a hash reference with the following keys:
1314 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)
1318 =item regionselector HASHREF | LIST
1320 Takes as input a hashref or list of key/value pairs with the following keys:
1324 =item selected_county
1326 Currently selected county
1328 =item selected_state
1330 Currently selected state
1332 =item selected_country
1334 Currently selected country
1338 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1342 Specify a javascript subroutine to call on changes
1348 =item default_country
1354 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>.
1358 Returns a list consisting of three HTML fragments for county selection,
1359 state selection and country selection, respectively.
1363 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1364 sub regionselector {
1371 $param->{'selected_country'} ||= $param->{'default_country'};
1372 $param->{'selected_state'} ||= $param->{'default_state'};
1374 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1378 my %cust_main_county;
1380 # unless ( @cust_main_county ) { #cache
1381 #@cust_main_county = qsearch('cust_main_county', {} );
1382 #foreach my $c ( @cust_main_county ) {
1383 foreach my $c ( @{ $param->{'locales'} } ) {
1384 #$countyflag=1 if $c->county;
1385 $countyflag=1 if $c->{county};
1386 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1387 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1388 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1391 $countyflag=1 if $param->{selected_county};
1393 my $script_html = <<END;
1395 function opt(what,value,text) {
1396 var optionName = new Option(text, value, false, false);
1397 var length = what.length;
1398 what.options[length] = optionName;
1400 function ${prefix}country_changed(what) {
1401 country = what.options[what.selectedIndex].text;
1402 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1403 what.form.${prefix}state.options[i] = null;
1405 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1407 foreach my $country ( sort keys %cust_main_county ) {
1408 $script_html .= "\nif ( country == \"$country\" ) {\n";
1409 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1410 my $text = $state || '(n/a)';
1411 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1413 $script_html .= "}\n";
1416 $script_html .= <<END;
1418 function ${prefix}state_changed(what) {
1421 if ( $countyflag ) {
1422 $script_html .= <<END;
1423 state = what.options[what.selectedIndex].text;
1424 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1425 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1426 what.form.${prefix}county.options[i] = null;
1429 foreach my $country ( sort keys %cust_main_county ) {
1430 $script_html .= "\nif ( country == \"$country\" ) {\n";
1431 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1432 $script_html .= "\nif ( state == \"$state\" ) {\n";
1433 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1434 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1435 my $text = $county || '(n/a)';
1437 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1439 $script_html .= "}\n";
1441 $script_html .= "}\n";
1445 $script_html .= <<END;
1450 my $county_html = $script_html;
1451 if ( $countyflag ) {
1452 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1453 foreach my $county (
1454 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1456 my $text = $county || '(n/a)';
1457 $county_html .= qq!<OPTION VALUE="$county"!.
1458 ($county eq $param->{'selected_county'} ?
1465 $county_html .= '</SELECT>';
1468 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1471 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1472 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1473 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1474 my $text = $state || '(n/a)';
1475 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1476 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1478 $state_html .= '</SELECT>';
1480 my $country_html = '';
1481 if ( scalar( keys %cust_main_county ) > 1 ) {
1483 $country_html = qq(<SELECT NAME="${prefix}country" ).
1484 qq(onChange="${prefix}country_changed(this); ).
1485 $param->{'onchange'}.
1488 my $countrydefault = $param->{default_country} || 'US';
1489 foreach my $country (
1490 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1491 keys %cust_main_county
1493 my $selected = $country eq $param->{'selected_country'}
1496 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1498 $country_html .= '</SELECT>';
1501 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1502 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1506 ($county_html, $state_html, $country_html);
1510 sub regionselector_hashref {
1511 my ($county_html, $state_html, $country_html) = regionselector(@_);
1513 'county_html' => $county_html,
1514 'state_html' => $state_html,
1515 'country_html' => $country_html,
1519 =item location_form HASHREF | LIST
1521 Takes as input a hashref or list of key/value pairs with the following keys:
1527 Current customer session_id
1531 Omit red asterisks from required fields.
1533 =item address1_label
1535 Label for first address line.
1539 Returns an HTML fragment for a location form (address, city, state, zip,
1552 my $session_id = delete $param->{'session_id'};
1554 my $rv = mason_comp( 'session_id' => $session_id,
1555 'comp' => '/elements/location.html',
1556 'args' => [ %$param ],
1560 $rv->{'error'} || $rv->{'output'};
1565 #=item expselect HASHREF | LIST
1567 #Takes as input a hashref or list of key/value pairs with the following keys:
1571 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1573 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1577 =item expselect PREFIX [ DATE ]
1579 Takes as input a unique prefix string and the current expiration date, in
1580 yyyy-mm-dd or m-d-yyyy format
1582 Returns an HTML fragments for expiration date selection.
1588 #if ( ref($_[0]) ) {
1592 #my $prefix = $param->{'prefix'};
1593 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1594 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1596 my $date = scalar(@_) ? shift : '';
1598 my( $m, $y ) = ( 0, 0 );
1599 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1600 ( $m, $y ) = ( $2, $1 );
1601 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1602 ( $m, $y ) = ( $1, $3 );
1604 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1606 $return .= qq!<OPTION VALUE="$_"!;
1607 $return .= " SELECTED" if $_ == $m;
1610 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1612 my $thisYear = $t[5] + 1900;
1613 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1614 $return .= qq!<OPTION VALUE="$_"!;
1615 $return .= " SELECTED" if $_ == $y;
1618 $return .= "</SELECT>";
1623 =item popselector HASHREF | LIST
1625 Takes as input a hashref or list of key/value pairs with the following keys:
1631 Access number number
1635 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>.
1639 Returns an HTML fragment for access number selection.
1643 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1651 my $popnum = $param->{'popnum'};
1652 my $pops = $param->{'pops'};
1654 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1655 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1656 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1657 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1658 if scalar(@$pops) == 1;
1661 my %popnum2pop = ();
1663 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1664 $popnum2pop{$_->{popnum}} = $_;
1669 function opt(what,href,text) {
1670 var optionName = new Option(text, href, false, false)
1671 var length = what.length;
1672 what.options[length] = optionName;
1676 my $init_popstate = $param->{'init_popstate'};
1677 if ( $init_popstate ) {
1678 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1679 $init_popstate. '">';
1682 function acstate_changed(what) {
1683 state = what.options[what.selectedIndex].text;
1684 what.form.popac.options.length = 0
1685 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1689 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1690 foreach my $state ( sort { $a cmp $b } @states ) {
1691 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1693 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1694 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1695 if ($ac eq $param->{'popac'}) {
1696 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1699 $text .= "}\n" unless $init_popstate;
1701 $text .= "popac_changed(what.form.popac)}\n";
1704 function popac_changed(what) {
1705 ac = what.options[what.selectedIndex].text;
1706 what.form.popnum.options.length = 0;
1707 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1711 foreach my $state ( @states ) {
1712 foreach my $popac ( keys %{ $pop{$state} } ) {
1713 $text .= "\nif ( ac == \"$popac\" ) {\n";
1715 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1716 my $o_popnum = $pop->{popnum};
1717 my $poptext = $pop->{city}. ', '. $pop->{state}.
1718 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1720 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1721 if ($popnum == $o_popnum) {
1722 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1730 $text .= "}\n</SCRIPT>\n";
1732 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1735 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1736 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1737 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1738 ">$_" foreach sort { $a cmp $b } @states;
1739 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1742 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1743 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1745 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1748 #comment this block to disable initial list polulation
1749 my @initial_select = ();
1750 if ( scalar( @$pops ) > 100 ) {
1751 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1753 @initial_select = @$pops;
1755 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1756 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1757 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1758 $pop->{city}. ', '. $pop->{state}.
1759 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1762 $text .= qq!</SELECT></TD></TR></TABLE>!;
1768 =item domainselector HASHREF | LIST
1770 Takes as input a hashref or list of key/value pairs with the following keys:
1780 Service number of the selected item.
1784 Returns an HTML fragment for domain selection.
1788 sub domainselector {
1795 my $domsvc= $param->{'domsvc'};
1797 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1798 my $domains = $rv->{'domains'};
1799 $domsvc = $rv->{'domsvc'} unless $domsvc;
1801 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1802 unless scalar(keys %$domains);
1804 if (scalar(keys %$domains) == 1) {
1806 foreach(keys %$domains) {
1809 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1810 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1813 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1816 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1817 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1818 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1819 $domains->{$domain};
1822 $text .= qq!</SELECT></TD></TR>!;
1828 =item didselector HASHREF | LIST
1830 Takes as input a hashref or list of key/value pairs with the following keys:
1836 Field name for the returned HTML fragment.
1840 Service definition (see L<FS::part_svc>)
1844 Returns an HTML fragment for DID selection.
1856 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1857 'args'=>[ %$param ],
1861 $rv->{'error'} || $rv->{'output'};
1867 =head1 RESELLER FUNCTIONS
1869 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1870 with their active session, and the B<customer_info> and B<order_pkg> functions
1871 with their active session and an additional I<custnum> parameter.
1873 For the most part, development of the reseller web interface has been
1874 superceded by agent-virtualized access to the backend.
1886 =item agent_list_customers
1888 List agent's customers.
1896 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>