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' => 'MyAccount/login',
30 'logout' => 'MyAccount/logout',
31 'customer_info' => 'MyAccount/customer_info',
32 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
33 'invoice' => 'MyAccount/invoice',
34 'invoice_logo' => 'MyAccount/invoice_logo',
35 'list_invoices' => 'MyAccount/list_invoices', #?
36 'cancel' => 'MyAccount/cancel', #add to ss cgi!
37 'payment_info' => 'MyAccount/payment_info',
38 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
39 'process_payment' => 'MyAccount/process_payment',
40 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
41 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
42 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
43 'process_prepay' => 'MyAccount/process_prepay',
44 'realtime_collect' => 'MyAccount/realtime_collect',
45 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
46 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
47 'list_svc_usage' => 'MyAccount/list_svc_usage',
48 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
49 'list_support_usage' => 'MyAccount/list_support_usage',
50 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
51 'change_pkg' => 'MyAccount/change_pkg',
52 'order_recharge' => 'MyAccount/order_recharge',
53 'renew_info' => 'MyAccount/renew_info',
54 'order_renew' => 'MyAccount/order_renew',
55 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
56 'charge' => 'MyAccount/charge', #?
57 'part_svc_info' => 'MyAccount/part_svc_info',
58 'provision_acct' => 'MyAccount/provision_acct',
59 'provision_external' => 'MyAccount/provision_external',
60 'unprovision_svc' => 'MyAccount/unprovision_svc',
61 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
62 'signup_info' => 'Signup/signup_info',
63 'skin_info' => 'MyAccount/skin_info',
64 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
65 'new_customer' => 'Signup/new_customer',
66 'capture_payment' => 'Signup/capture_payment',
67 'agent_login' => 'Agent/agent_login',
68 'agent_logout' => 'Agent/agent_logout',
69 'agent_info' => 'Agent/agent_info',
70 'agent_list_customers' => 'Agent/agent_list_customers',
71 'mason_comp' => 'MasonComponent/mason_comp',
72 'call_time' => 'PrepaidPhone/call_time',
73 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
74 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
75 'bulk_processrow' => 'Bulk/processrow',
76 'check_username' => 'Bulk/check_username',
78 'decompify_pkgs' => 'SGNG/decompify_pkgs',
79 'previous_payment_info' => 'SGNG/previous_payment_info',
80 'previous_payment_info_renew_info'
81 => 'SGNG/previous_payment_info_renew_info',
82 'previous_process_payment' => 'SGNG/previous_process_payment',
83 'previous_process_payment_order_pkg'
84 => 'SGNG/previous_process_payment_order_pkg',
85 'previous_process_payment_change_pkg'
86 => 'SGNG/previous_process_payment_change_pkg',
87 'previous_process_payment_order_renew'
88 => 'SGNG/previous_process_payment_order_renew',
92 qw( regionselector regionselector_hashref location_form
93 expselect popselector domainselector didselector
97 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
98 $ENV{'SHELL'} = '/bin/sh';
99 $ENV{'IFS'} = " \t\n";
102 $ENV{'BASH_ENV'} = '';
104 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
105 #if you grant appropriate permissions to whatever user
106 my $freeside_uid = scalar(getpwnam('freeside'));
107 die "not running as the freeside user\n"
108 if $> != $freeside_uid && ! $skip_uid_check;
110 -e $dir or die "FATAL: $dir doesn't exist!";
111 -d $dir or die "FATAL: $dir isn't a directory!";
112 -r $dir or die "FATAL: Can't read $dir as freeside user!";
113 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
115 foreach my $autoload ( keys %autoload ) {
118 "sub $autoload { ". '
123 #warn scalar(@_). ": ". join(" / ", @_);
127 $param->{_packet} = \''. $autoload{$autoload}. '\';
129 simple_packet($param);
139 warn "sending ". $packet->{_packet}. " to server"
141 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
142 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
143 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
146 #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
148 #block until there is a message on socket
149 # my $w = new IO::Select;
151 # my @wait = $w->can_read;
153 warn "reading message from server"
156 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
157 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
159 warn "returning message to client"
167 FS::SelfService - Freeside self-service API
171 # password and shell account changes
172 use FS::SelfService qw(passwd chfn chsh);
174 # "my account" functionality
175 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
177 my $rv = login( { 'username' => $username,
179 'password' => $password,
183 if ( $rv->{'error'} ) {
184 #handle login error...
187 my $session_id = $rv->{'session_id'};
190 my $customer_info = customer_info( { 'session_id' => $session_id } );
192 #payment_info and process_payment are available in 1.5+ only
193 my $payment_info = payment_info( { 'session_id' => $session_id } );
195 #!!! process_payment example
197 #!!! list_pkgs example
199 #!!! order_pkg example
201 #!!! cancel_pkg example
203 # signup functionality
204 use FS::SelfService qw( signup_info new_customer );
206 my $signup_info = signup_info;
208 $rv = new_customer( {
211 'company' => $company,
212 'address1' => $address1,
213 'address2' => $address2,
217 'country' => $country,
218 'daytime' => $daytime,
222 'payinfo' => $payinfo,
224 'paystart_month' => $paystart_month
225 'paystart_year' => $paystart_year,
226 'payissue' => $payissue,
228 'paydate' => $paydate,
229 'payname' => $payname,
230 'invoicing_list' => $invoicing_list,
231 'referral_custnum' => $referral_custnum,
232 'agentnum' => $agentnum,
233 'pkgpart' => $pkgpart,
235 'username' => $username,
236 '_password' => $password,
240 'phonenum' => $phonenum,
245 my $error = $rv->{'error'};
246 if ( $error eq '_decline' ) {
256 Use this API to implement your own client "self-service" module.
258 If you just want to customize the look of the existing "self-service" module,
261 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
273 =head1 "MY ACCOUNT" FUNCTIONS
279 Creates a user session. Takes a hash reference as parameter with the
298 Returns a hash reference with the following keys:
304 Empty on success, or an error message on errors.
308 Session identifier for successful logins
312 =item customer_info HASHREF
314 Returns general customer information.
316 Takes a hash reference as parameter with a single key: B<session_id>
318 Returns a hash reference with the following keys:
332 Array reference of hash references of open inoices. Each hash reference has
333 the following keys: invnum, date, owed
337 An HTML fragment containing shipping and billing addresses.
339 =item The following fields are also returned
341 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
345 =item edit_info HASHREF
347 Takes a hash reference as parameter with any of the following keys:
349 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
351 If a field exists, the customer record is updated with the new value of that
352 field. If a field does not exist, that field is not changed on the customer
355 Returns a hash reference with a single key, B<error>, empty on success, or an
356 error message on errors
358 =item invoice HASHREF
360 Returns an invoice. Takes a hash reference as parameter with two keys:
361 session_id and invnum
363 Returns a hash reference with the following keys:
369 Empty on success, or an error message on errors
381 =item list_invoices HASHREF
383 Returns a list of all customer invoices. Takes a hash references with a single
386 Returns a hash reference with the following keys:
392 Empty on success, or an error message on errors
396 Reference to array of hash references with the following keys:
406 Invoice date, in UNIX epoch time
414 Cancels this customer.
416 Takes a hash reference as parameter with a single key: B<session_id>
418 Returns a hash reference with a single key, B<error>, which is empty on
419 success or an error message on errors.
421 =item payment_info HASHREF
423 Returns information that may be useful in displaying a payment page.
425 Takes a hash reference as parameter with a single key: B<session_id>.
427 Returns a hash reference with the following keys:
433 Empty on success, or an error message on errors
441 Exact name on credit card (CARD/DCRD)
465 Customer's current default payment type.
469 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
473 For CARD/DCRD payment types, the card number
477 For CARD/DCRD payment types, expiration month
481 For CARD/DCRD payment types, expiration year
483 =item cust_main_county
485 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.
489 Array reference of all states in the current default country.
493 Hash reference of card types; keys are card types, values are the exact strings
494 passed to the process_payment function
498 #this doesn't actually work yet
502 #Unique transaction identifier (prevents multiple charges), passed to the
503 #process_payment function
507 =item process_payment HASHREF
509 Processes a payment and possible change of address or payment type. Takes a
510 hash reference as parameter with the following keys:
524 If true, address and card information entered will be saved for subsequent
529 If true, future credit card payments will be done automatically (sets payby to
530 CARD). If false, future credit card payments will be done on-demand (sets
531 payby to DCRD). This option only has meaning if B<save> is set true.
559 Two-letter country code
567 Card expiration month
575 #this doesn't actually work yet
579 #Unique transaction identifier, returned from the payment_info function.
580 #Prevents multiple charges.
584 Returns a hash reference with a single key, B<error>, empty on success, or an
585 error message on errors.
587 =item process_payment_order_pkg
589 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
590 payment processes sucessfully, the package is ordered. Takes a hash reference
591 as parameter with the keys of both methods.
593 Returns a hash reference with a single key, B<error>, empty on success, or an
594 error message on errors.
596 =item process_payment_change_pkg
598 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
599 payment processes sucessfully, the package is ordered. Takes a hash reference
600 as parameter with the keys of both methods.
602 Returns a hash reference with a single key, B<error>, empty on success, or an
603 error message on errors.
606 =item process_payment_order_renew
608 Combines the B<process_payment> and B<order_renew> functions in one step. If
609 the payment processes sucessfully, the renewal is processed. Takes a hash
610 reference as parameter with the keys of both methods.
612 Returns a hash reference with a single key, B<error>, empty on success, or an
613 error message on errors.
617 Returns package information for this customer. For more detail on services,
620 Takes a hash reference as parameter with a single key: B<session_id>
622 Returns a hash reference containing customer package information. The hash reference contains the following keys:
632 Empty on success, or an error message on errors.
634 =item cust_pkg HASHREF
636 Array reference of hash references, each of which has the fields of a cust_pkg
637 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
638 the internal FS:: objects, but hash references of columns and values.
642 =item part_pkg fields
644 All fields of part_pkg for this specific cust_pkg (be careful with this
645 information - it may reveal more about your available packages than you would
646 like users to know in aggregate)
650 #XXX pare part_pkg fields down to a more secure subset
654 An array of hash references indicating information on unprovisioned services
655 available for provisioning for this specific cust_pkg. Each has the following
660 =item part_svc fields
662 All fields of part_svc (be careful with this information - it may reveal more
663 about your available packages than you would like users to know in aggregate)
667 #XXX pare part_svc fields down to a more secure subset
673 An array of hash references indicating information on the customer services
674 already provisioned for this specific cust_pkg. Each has the following keys:
680 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.
686 Primary key for this service
690 Service definition (see L<FS::part_svc>)
694 Customer package (see L<FS::cust_pkg>)
698 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
706 Returns service information for this customer.
708 Takes a hash reference as parameter with a single key: B<session_id>
710 Returns a hash reference containing customer package information. The hash reference contains the following keys:
720 An array of hash references indicating information on all of this customer's
721 services. Each has the following keys:
727 Primary key for this service
735 Meaningful user-specific identifier for the service (i.e. username, domain, or
740 Account (svc_acct) services also have the following keys:
758 Upload bytes remaining
762 Download bytes remaining
766 Total bytes remaining
768 =item recharge_amount
772 =item recharge_seconds
774 Number of seconds gained by recharge
776 =item recharge_upbytes
778 Number of upload bytes gained by recharge
780 =item recharge_downbytes
782 Number of download bytes gained by recharge
784 =item recharge_totalbytes
786 Number of total bytes gained by recharge
794 Orders a package for this customer.
796 Takes a hash reference as parameter with the following keys:
806 Package to order (see L<FS::part_pkg>).
810 Service to order (see L<FS::part_svc>).
812 Normally optional; required only to provision a non-svc_acct service, or if the
813 package definition does not contain one svc_acct service definition with
814 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
815 also be specified to indicate that no initial service should be provisioned.
819 Fields used when provisioning an svc_acct service:
833 Optional security phrase
837 Optional Access number number
841 Fields used when provisioning an svc_domain service:
851 Fields used when provisioning an svc_phone service:
869 Fields used when provisioning an svc_external service:
883 Returns a hash reference with a single key, B<error>, empty on success, or an
884 error message on errors. The special error '_decline' is returned for
885 declined transactions.
889 Changes a package for this customer.
891 Takes a hash reference as parameter with the following keys:
901 Existing customer package.
905 New package to order (see L<FS::part_pkg>).
909 Returns a hash reference with a single key, B<error>, empty on success, or an
910 error message on errors.
914 Provides useful info for early renewals.
916 Takes a hash reference as parameter with the following keys:
926 Returns a hash reference. On errors, it contains a single key, B<error>, with
927 the error message. Otherwise, contains a single key, B<dates>, pointing to
928 an array refernce of hash references. Each hash reference contains the
935 (Future) Bill date. Indicates a future date for which billing could be run.
936 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
939 =item bill_date_pretty
941 (Future) Bill date as a human-readable string. (Convenience for display;
942 subject to change, so best not to parse for the date.)
946 Base amount which will be charged if renewed early as of this date.
950 Renewal date; i.e. even-futher future date at which the customer will be paid
951 through if the early renewal is completed with the given B<bill-date>.
952 Specified as a integer UNIX timestamp.
954 =item renew_date_pretty
956 Renewal date as a human-readable string. (Convenience for display;
957 subject to change, so best not to parse for the date.)
961 Package that will be renewed.
965 Expiration date of the package that will be renewed.
967 =item expire_date_pretty
969 Expiration date of the package that will be renewed, as a human-readable
970 string. (Convenience for display; subject to change, so best not to parse for
977 Renews this customer early; i.e. runs billing for this customer in advance.
979 Takes a hash reference as parameter with the following keys:
989 Integer date as returned by the B<renew_info> function, indicating the advance
990 date for which to run billing.
994 Returns a hash reference with a single key, B<error>, empty on success, or an
995 error message on errors.
999 Cancels a package for this customer.
1001 Takes a hash reference as parameter with the following keys:
1011 pkgpart of package to cancel
1015 Returns a hash reference with a single key, B<error>, empty on success, or an
1016 error message on errors.
1020 =head1 SIGNUP FUNCTIONS
1024 =item signup_info HASHREF
1026 Takes a hash reference as parameter with the following keys:
1030 =item session_id - Optional agent/reseller interface session
1034 Returns a hash reference containing information that may be useful in
1035 displaying a signup page. The hash reference contains the following keys:
1039 =item cust_main_county
1041 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.
1045 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
1046 an agentnum specified explicitly via reseller interface session_id in the
1051 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.
1053 =item agentnum2part_pkg
1055 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.
1059 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.
1061 =item security_phrase
1063 True if the "security_phrase" feature is enabled
1067 Array reference of acceptable payment types for signup
1073 credit card - automatic
1077 credit card - on-demand - version 1.5+ only
1081 electronic check - automatic
1085 electronic check - on-demand - version 1.5+ only
1093 billing, not recommended for signups
1097 free, definitely not recommended for signups
1101 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1107 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1111 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".
1117 =item countrydefault
1123 =item new_customer HASHREF
1125 Creates a new customer. Takes a hash reference as parameter with the
1132 first name (required)
1136 last name (required)
1140 (not typically collected; mostly used for ACH transactions)
1146 =item address1 (required)
1154 =item city (required)
1162 =item state (required)
1166 =item zip (required)
1172 Daytime phone number
1176 Evening phone number
1184 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1188 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1192 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1196 Expiration date for CARD/DCRD
1200 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1202 =item invoicing_list
1204 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),
1206 =item referral_custnum
1208 referring customer number
1216 pkgpart of initial package
1232 Access number (index, not the literal number)
1236 Country code (to be provisioned as a service)
1240 Phone number (to be provisioned as a service)
1248 Returns a hash reference with the following keys:
1254 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)
1258 =item regionselector HASHREF | LIST
1260 Takes as input a hashref or list of key/value pairs with the following keys:
1264 =item selected_county
1266 Currently selected county
1268 =item selected_state
1270 Currently selected state
1272 =item selected_country
1274 Currently selected country
1278 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1282 Specify a javascript subroutine to call on changes
1288 =item default_country
1294 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>.
1298 Returns a list consisting of three HTML fragments for county selection,
1299 state selection and country selection, respectively.
1303 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1304 sub regionselector {
1311 $param->{'selected_country'} ||= $param->{'default_country'};
1312 $param->{'selected_state'} ||= $param->{'default_state'};
1314 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1318 my %cust_main_county;
1320 # unless ( @cust_main_county ) { #cache
1321 #@cust_main_county = qsearch('cust_main_county', {} );
1322 #foreach my $c ( @cust_main_county ) {
1323 foreach my $c ( @{ $param->{'locales'} } ) {
1324 #$countyflag=1 if $c->county;
1325 $countyflag=1 if $c->{county};
1326 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1327 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1328 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1331 $countyflag=1 if $param->{selected_county};
1333 my $script_html = <<END;
1335 function opt(what,value,text) {
1336 var optionName = new Option(text, value, false, false);
1337 var length = what.length;
1338 what.options[length] = optionName;
1340 function ${prefix}country_changed(what) {
1341 country = what.options[what.selectedIndex].text;
1342 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1343 what.form.${prefix}state.options[i] = null;
1345 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1347 foreach my $country ( sort keys %cust_main_county ) {
1348 $script_html .= "\nif ( country == \"$country\" ) {\n";
1349 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1350 my $text = $state || '(n/a)';
1351 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1353 $script_html .= "}\n";
1356 $script_html .= <<END;
1358 function ${prefix}state_changed(what) {
1361 if ( $countyflag ) {
1362 $script_html .= <<END;
1363 state = what.options[what.selectedIndex].text;
1364 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1365 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1366 what.form.${prefix}county.options[i] = null;
1369 foreach my $country ( sort keys %cust_main_county ) {
1370 $script_html .= "\nif ( country == \"$country\" ) {\n";
1371 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1372 $script_html .= "\nif ( state == \"$state\" ) {\n";
1373 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1374 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1375 my $text = $county || '(n/a)';
1377 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1379 $script_html .= "}\n";
1381 $script_html .= "}\n";
1385 $script_html .= <<END;
1390 my $county_html = $script_html;
1391 if ( $countyflag ) {
1392 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1393 $county_html .= '</SELECT>';
1396 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1399 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1400 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1401 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1402 my $text = $state || '(n/a)';
1403 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1404 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1406 $state_html .= '</SELECT>';
1408 my $country_html = '';
1409 if ( scalar( keys %cust_main_county ) > 1 ) {
1411 $country_html = qq(<SELECT NAME="${prefix}country" ).
1412 qq(onChange="${prefix}country_changed(this); ).
1413 $param->{'onchange'}.
1416 my $countrydefault = $param->{default_country} || 'US';
1417 foreach my $country (
1418 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1419 keys %cust_main_county
1421 my $selected = $country eq $param->{'selected_country'}
1424 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1426 $country_html .= '</SELECT>';
1429 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1430 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1434 ($county_html, $state_html, $country_html);
1438 sub regionselector_hashref {
1439 my ($county_html, $state_html, $country_html) = regionselector(@_);
1441 'county_html' => $county_html,
1442 'state_html' => $state_html,
1443 'country_html' => $country_html,
1447 =item location_form HASHREF | LIST
1449 Takes as input a hashref or list of key/value pairs with the following keys:
1455 Current customer session_id
1459 Omit red asterisks from required fields.
1461 =item address1_label
1463 Label for first address line.
1467 Returns an HTML fragment for a location form (address, city, state, zip,
1480 my $session_id = delete $param->{'session_id'};
1482 my $rv = mason_comp( 'session_id' => $session_id,
1483 'comp' => '/elements/location.html',
1484 'args' => [ %$param ],
1488 $rv->{'error'} || $rv->{'output'};
1493 #=item expselect HASHREF | LIST
1495 #Takes as input a hashref or list of key/value pairs with the following keys:
1499 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1501 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1505 =item expselect PREFIX [ DATE ]
1507 Takes as input a unique prefix string and the current expiration date, in
1508 yyyy-mm-dd or m-d-yyyy format
1510 Returns an HTML fragments for expiration date selection.
1516 #if ( ref($_[0]) ) {
1520 #my $prefix = $param->{'prefix'};
1521 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1522 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1524 my $date = scalar(@_) ? shift : '';
1526 my( $m, $y ) = ( 0, 0 );
1527 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1528 ( $m, $y ) = ( $2, $1 );
1529 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1530 ( $m, $y ) = ( $1, $3 );
1532 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1534 $return .= qq!<OPTION VALUE="$_"!;
1535 $return .= " SELECTED" if $_ == $m;
1538 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1540 my $thisYear = $t[5] + 1900;
1541 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1542 $return .= qq!<OPTION VALUE="$_"!;
1543 $return .= " SELECTED" if $_ == $y;
1546 $return .= "</SELECT>";
1551 =item popselector HASHREF | LIST
1553 Takes as input a hashref or list of key/value pairs with the following keys:
1559 Access number number
1563 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>.
1567 Returns an HTML fragment for access number selection.
1571 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1579 my $popnum = $param->{'popnum'};
1580 my $pops = $param->{'pops'};
1582 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1583 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1584 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1585 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1586 if scalar(@$pops) == 1;
1589 my %popnum2pop = ();
1591 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1592 $popnum2pop{$_->{popnum}} = $_;
1597 function opt(what,href,text) {
1598 var optionName = new Option(text, href, false, false)
1599 var length = what.length;
1600 what.options[length] = optionName;
1604 my $init_popstate = $param->{'init_popstate'};
1605 if ( $init_popstate ) {
1606 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1607 $init_popstate. '">';
1610 function acstate_changed(what) {
1611 state = what.options[what.selectedIndex].text;
1612 what.form.popac.options.length = 0
1613 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1617 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1618 foreach my $state ( sort { $a cmp $b } @states ) {
1619 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1621 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1622 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1623 if ($ac eq $param->{'popac'}) {
1624 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1627 $text .= "}\n" unless $init_popstate;
1629 $text .= "popac_changed(what.form.popac)}\n";
1632 function popac_changed(what) {
1633 ac = what.options[what.selectedIndex].text;
1634 what.form.popnum.options.length = 0;
1635 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1639 foreach my $state ( @states ) {
1640 foreach my $popac ( keys %{ $pop{$state} } ) {
1641 $text .= "\nif ( ac == \"$popac\" ) {\n";
1643 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1644 my $o_popnum = $pop->{popnum};
1645 my $poptext = $pop->{city}. ', '. $pop->{state}.
1646 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1648 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1649 if ($popnum == $o_popnum) {
1650 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1658 $text .= "}\n</SCRIPT>\n";
1661 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1662 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1663 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1664 ">$_" foreach sort { $a cmp $b } @states;
1665 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1668 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1669 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1671 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1674 #comment this block to disable initial list polulation
1675 my @initial_select = ();
1676 if ( scalar( @$pops ) > 100 ) {
1677 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1679 @initial_select = @$pops;
1681 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1682 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1683 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1684 $pop->{city}. ', '. $pop->{state}.
1685 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1688 $text .= qq!</SELECT></TD></TR></TABLE>!;
1694 =item domainselector HASHREF | LIST
1696 Takes as input a hashref or list of key/value pairs with the following keys:
1706 Service number of the selected item.
1710 Returns an HTML fragment for domain selection.
1714 sub domainselector {
1721 my $domsvc= $param->{'domsvc'};
1723 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1724 my $domains = $rv->{'domains'};
1725 $domsvc = $rv->{'domsvc'} unless $domsvc;
1727 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1728 unless scalar(keys %$domains);
1730 if (scalar(keys %$domains) == 1) {
1732 foreach(keys %$domains) {
1735 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1736 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1739 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1742 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1743 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1744 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1745 $domains->{$domain};
1748 $text .= qq!</SELECT></TD></TR>!;
1754 =item didselector HASHREF | LIST
1756 Takes as input a hashref or list of key/value pairs with the following keys:
1762 Field name for the returned HTML fragment.
1766 Service definition (see L<FS::part_svc>)
1770 Returns an HTML fragment for DID selection.
1782 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1783 'args'=>[ %$param ],
1787 $rv->{'error'} || $rv->{'output'};
1793 =head1 RESELLER FUNCTIONS
1795 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1796 with their active session, and the B<customer_info> and B<order_pkg> functions
1797 with their active session and an additional I<custnum> parameter.
1799 For the most part, development of the reseller web interface has been
1800 superceded by agent-virtualized access to the backend.
1812 =item agent_list_customers
1814 List agent's customers.
1822 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>