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_pdf' => 'MyAccount/invoice_pdf',
35 'invoice_logo' => 'MyAccount/invoice_logo',
36 'list_invoices' => 'MyAccount/list_invoices', #?
37 'cancel' => 'MyAccount/cancel', #add to ss cgi!
38 'payment_info' => 'MyAccount/payment_info',
39 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
40 'process_payment' => 'MyAccount/process_payment',
41 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
42 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
43 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
44 'process_prepay' => 'MyAccount/process_prepay',
45 'realtime_collect' => 'MyAccount/realtime_collect',
46 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
47 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
48 'list_svc_usage' => 'MyAccount/list_svc_usage',
49 'port_graph' => 'MyAccount/port_graph',
50 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
51 'list_support_usage' => 'MyAccount/list_support_usage',
52 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
53 'change_pkg' => 'MyAccount/change_pkg',
54 'order_recharge' => 'MyAccount/order_recharge',
55 'renew_info' => 'MyAccount/renew_info',
56 'order_renew' => 'MyAccount/order_renew',
57 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
58 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
59 'charge' => 'MyAccount/charge', #?
60 'part_svc_info' => 'MyAccount/part_svc_info',
61 'provision_acct' => 'MyAccount/provision_acct',
62 'provision_phone' => 'MyAccount/provision_phone',
63 'provision_external' => 'MyAccount/provision_external',
64 'unprovision_svc' => 'MyAccount/unprovision_svc',
65 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
66 'create_ticket' => 'MyAccount/create_ticket',
67 'get_ticket' => 'MyAccount/get_ticket',
68 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
69 'did_report' => 'MyAccount/did_report',
70 'signup_info' => 'Signup/signup_info',
71 'skin_info' => 'MyAccount/skin_info',
72 'access_info' => 'MyAccount/access_info',
73 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
74 'new_customer' => 'Signup/new_customer',
75 'capture_payment' => 'Signup/capture_payment',
76 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
77 'new_agent' => 'Agent/new_agent',
78 'agent_login' => 'Agent/agent_login',
79 'agent_logout' => 'Agent/agent_logout',
80 'agent_info' => 'Agent/agent_info',
81 'agent_list_customers' => 'Agent/agent_list_customers',
82 'check_username' => 'Agent/check_username',
83 'suspend_username' => 'Agent/suspend_username',
84 'unsuspend_username' => 'Agent/unsuspend_username',
85 'mason_comp' => 'MasonComponent/mason_comp',
86 'call_time' => 'PrepaidPhone/call_time',
87 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
88 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
90 #'bulk_processrow' => 'Bulk/processrow',
91 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
93 'ping' => 'SGNG/ping',
94 'decompify_pkgs' => 'SGNG/decompify_pkgs',
95 'previous_payment_info' => 'SGNG/previous_payment_info',
96 'previous_payment_info_renew_info'
97 => 'SGNG/previous_payment_info_renew_info',
98 'previous_process_payment' => 'SGNG/previous_process_payment',
99 'previous_process_payment_order_pkg'
100 => 'SGNG/previous_process_payment_order_pkg',
101 'previous_process_payment_change_pkg'
102 => 'SGNG/previous_process_payment_change_pkg',
103 'previous_process_payment_order_renew'
104 => 'SGNG/previous_process_payment_order_renew',
108 qw( regionselector regionselector_hashref location_form
109 expselect popselector domainselector didselector
113 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
114 $ENV{'SHELL'} = '/bin/sh';
115 $ENV{'IFS'} = " \t\n";
118 $ENV{'BASH_ENV'} = '';
120 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
121 #if you grant appropriate permissions to whatever user
122 my $freeside_uid = scalar(getpwnam('freeside'));
123 die "not running as the freeside user\n"
124 if $> != $freeside_uid && ! $skip_uid_check;
126 -e $dir or die "FATAL: $dir doesn't exist!";
127 -d $dir or die "FATAL: $dir isn't a directory!";
128 -r $dir or die "FATAL: Can't read $dir as freeside user!";
129 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
131 foreach my $autoload ( keys %autoload ) {
134 "sub $autoload { ". '
139 #warn scalar(@_). ": ". join(" / ", @_);
143 $param->{_packet} = \''. $autoload{$autoload}. '\';
145 simple_packet($param);
155 warn "sending ". $packet->{_packet}. " to server"
157 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
158 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
159 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
162 #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
164 #block until there is a message on socket
165 # my $w = new IO::Select;
167 # my @wait = $w->can_read;
169 warn "reading message from server"
172 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
173 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
175 warn "returning message to client"
183 FS::SelfService - Freeside self-service API
187 # password and shell account changes
188 use FS::SelfService qw(passwd chfn chsh);
190 # "my account" functionality
191 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
193 my $rv = login( { 'username' => $username,
195 'password' => $password,
199 if ( $rv->{'error'} ) {
200 #handle login error...
203 my $session_id = $rv->{'session_id'};
206 my $customer_info = customer_info( { 'session_id' => $session_id } );
208 #payment_info and process_payment are available in 1.5+ only
209 my $payment_info = payment_info( { 'session_id' => $session_id } );
211 #!!! process_payment example
213 #!!! list_pkgs example
215 #!!! order_pkg example
217 #!!! cancel_pkg example
219 # signup functionality
220 use FS::SelfService qw( signup_info new_customer );
222 my $signup_info = signup_info;
224 $rv = new_customer( {
227 'company' => $company,
228 'address1' => $address1,
229 'address2' => $address2,
233 'country' => $country,
234 'daytime' => $daytime,
238 'payinfo' => $payinfo,
240 'paystart_month' => $paystart_month
241 'paystart_year' => $paystart_year,
242 'payissue' => $payissue,
244 'paydate' => $paydate,
245 'payname' => $payname,
246 'invoicing_list' => $invoicing_list,
247 'referral_custnum' => $referral_custnum,
248 'agentnum' => $agentnum,
249 'pkgpart' => $pkgpart,
251 'username' => $username,
252 '_password' => $password,
256 'phonenum' => $phonenum,
261 my $error = $rv->{'error'};
262 if ( $error eq '_decline' ) {
272 Use this API to implement your own client "self-service" module.
274 If you just want to customize the look of the existing "self-service" module,
277 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
289 =head1 "MY ACCOUNT" FUNCTIONS
295 Creates a user session. Takes a hash reference as parameter with the
314 Returns a hash reference with the following keys:
320 Empty on success, or an error message on errors.
324 Session identifier for successful logins
328 =item customer_info HASHREF
330 Returns general customer information.
332 Takes a hash reference as parameter with a single key: B<session_id>
334 Returns a hash reference with the following keys:
348 Array reference of hash references of open inoices. Each hash reference has
349 the following keys: invnum, date, owed
353 An HTML fragment containing shipping and billing addresses.
355 =item The following fields are also returned
357 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
361 =item edit_info HASHREF
363 Takes a hash reference as parameter with any of the following keys:
365 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
367 If a field exists, the customer record is updated with the new value of that
368 field. If a field does not exist, that field is not changed on the customer
371 Returns a hash reference with a single key, B<error>, empty on success, or an
372 error message on errors
374 =item invoice HASHREF
376 Returns an invoice. Takes a hash reference as parameter with two keys:
377 session_id and invnum
379 Returns a hash reference with the following keys:
385 Empty on success, or an error message on errors
397 =item list_invoices HASHREF
399 Returns a list of all customer invoices. Takes a hash references with a single
402 Returns a hash reference with the following keys:
408 Empty on success, or an error message on errors
412 Reference to array of hash references with the following keys:
422 Invoice date, in UNIX epoch time
430 Cancels this customer.
432 Takes a hash reference as parameter with a single key: B<session_id>
434 Returns a hash reference with a single key, B<error>, which is empty on
435 success or an error message on errors.
437 =item payment_info HASHREF
439 Returns information that may be useful in displaying a payment page.
441 Takes a hash reference as parameter with a single key: B<session_id>.
443 Returns a hash reference with the following keys:
449 Empty on success, or an error message on errors
457 Exact name on credit card (CARD/DCRD)
481 Customer's current default payment type.
485 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
489 For CARD/DCRD payment types, the card number
493 For CARD/DCRD payment types, expiration month
497 For CARD/DCRD payment types, expiration year
499 =item cust_main_county
501 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.
505 Array reference of all states in the current default country.
509 Hash reference of card types; keys are card types, values are the exact strings
510 passed to the process_payment function
514 #this doesn't actually work yet
518 #Unique transaction identifier (prevents multiple charges), passed to the
519 #process_payment function
523 =item process_payment HASHREF
525 Processes a payment and possible change of address or payment type. Takes a
526 hash reference as parameter with the following keys:
540 If true, address and card information entered will be saved for subsequent
545 If true, future credit card payments will be done automatically (sets payby to
546 CARD). If false, future credit card payments will be done on-demand (sets
547 payby to DCRD). This option only has meaning if B<save> is set true.
575 Two-letter country code
583 Card expiration month
591 #this doesn't actually work yet
595 #Unique transaction identifier, returned from the payment_info function.
596 #Prevents multiple charges.
600 Returns a hash reference with a single key, B<error>, empty on success, or an
601 error message on errors.
603 =item process_payment_order_pkg
605 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
606 payment processes sucessfully, the package is ordered. Takes a hash reference
607 as parameter with the keys of both methods.
609 Returns a hash reference with a single key, B<error>, empty on success, or an
610 error message on errors.
612 =item process_payment_change_pkg
614 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
615 payment processes sucessfully, the package is ordered. Takes a hash reference
616 as parameter with the keys of both methods.
618 Returns a hash reference with a single key, B<error>, empty on success, or an
619 error message on errors.
622 =item process_payment_order_renew
624 Combines the B<process_payment> and B<order_renew> functions in one step. If
625 the payment processes sucessfully, the renewal is processed. Takes a hash
626 reference as parameter with the keys of both methods.
628 Returns a hash reference with a single key, B<error>, empty on success, or an
629 error message on errors.
633 Returns package information for this customer. For more detail on services,
636 Takes a hash reference as parameter with a single key: B<session_id>
638 Returns a hash reference containing customer package information. The hash reference contains the following keys:
648 Empty on success, or an error message on errors.
650 =item cust_pkg HASHREF
652 Array reference of hash references, each of which has the fields of a cust_pkg
653 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
654 the internal FS:: objects, but hash references of columns and values.
658 =item part_pkg fields
660 All fields of part_pkg for this specific cust_pkg (be careful with this
661 information - it may reveal more about your available packages than you would
662 like users to know in aggregate)
666 #XXX pare part_pkg fields down to a more secure subset
670 An array of hash references indicating information on unprovisioned services
671 available for provisioning for this specific cust_pkg. Each has the following
676 =item part_svc fields
678 All fields of part_svc (be careful with this information - it may reveal more
679 about your available packages than you would like users to know in aggregate)
683 #XXX pare part_svc fields down to a more secure subset
689 An array of hash references indicating information on the customer services
690 already provisioned for this specific cust_pkg. Each has the following keys:
696 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.
702 Primary key for this service
706 Service definition (see L<FS::part_svc>)
710 Customer package (see L<FS::cust_pkg>)
714 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
722 Returns service information for this customer.
724 Takes a hash reference as parameter with a single key: B<session_id>
726 Returns a hash reference containing customer package information. The hash reference contains the following keys:
736 An array of hash references indicating information on all of this customer's
737 services. Each has the following keys:
743 Primary key for this service
751 Meaningful user-specific identifier for the service (i.e. username, domain, or
756 Account (svc_acct) services also have the following keys:
774 Upload bytes remaining
778 Download bytes remaining
782 Total bytes remaining
784 =item recharge_amount
788 =item recharge_seconds
790 Number of seconds gained by recharge
792 =item recharge_upbytes
794 Number of upload bytes gained by recharge
796 =item recharge_downbytes
798 Number of download bytes gained by recharge
800 =item recharge_totalbytes
802 Number of total bytes gained by recharge
810 Orders a package for this customer.
812 Takes a hash reference as parameter with the following keys:
822 Package to order (see L<FS::part_pkg>).
826 Service to order (see L<FS::part_svc>).
828 Normally optional; required only to provision a non-svc_acct service, or if the
829 package definition does not contain one svc_acct service definition with
830 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
831 also be specified to indicate that no initial service should be provisioned.
835 Fields used when provisioning an svc_acct service:
849 Optional security phrase
853 Optional Access number number
857 Fields used when provisioning an svc_domain service:
867 Fields used when provisioning an svc_phone service:
885 Fields used when provisioning an svc_external service:
899 Fields used when provisioning an svc_pbx service:
913 Returns a hash reference with a single key, B<error>, empty on success, or an
914 error message on errors. The special error '_decline' is returned for
915 declined transactions.
919 Changes a package for this customer.
921 Takes a hash reference as parameter with the following keys:
931 Existing customer package.
935 New package to order (see L<FS::part_pkg>).
939 Returns a hash reference with the following keys:
945 Empty on success, or an error message on errors.
949 On success, the new pkgnum
956 Provides useful info for early renewals.
958 Takes a hash reference as parameter with the following keys:
968 Returns a hash reference. On errors, it contains a single key, B<error>, with
969 the error message. Otherwise, contains a single key, B<dates>, pointing to
970 an array refernce of hash references. Each hash reference contains the
977 (Future) Bill date. Indicates a future date for which billing could be run.
978 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
981 =item bill_date_pretty
983 (Future) Bill date as a human-readable string. (Convenience for display;
984 subject to change, so best not to parse for the date.)
988 Base amount which will be charged if renewed early as of this date.
992 Renewal date; i.e. even-futher future date at which the customer will be paid
993 through if the early renewal is completed with the given B<bill-date>.
994 Specified as a integer UNIX timestamp.
996 =item renew_date_pretty
998 Renewal date as a human-readable string. (Convenience for display;
999 subject to change, so best not to parse for the date.)
1003 Package that will be renewed.
1007 Expiration date of the package that will be renewed.
1009 =item expire_date_pretty
1011 Expiration date of the package that will be renewed, as a human-readable
1012 string. (Convenience for display; subject to change, so best not to parse for
1019 Renews this customer early; i.e. runs billing for this customer in advance.
1021 Takes a hash reference as parameter with the following keys:
1031 Integer date as returned by the B<renew_info> function, indicating the advance
1032 date for which to run billing.
1036 Returns a hash reference with a single key, B<error>, empty on success, or an
1037 error message on errors.
1041 Cancels a package for this customer.
1043 Takes a hash reference as parameter with the following keys:
1053 pkgpart of package to cancel
1057 Returns a hash reference with a single key, B<error>, empty on success, or an
1058 error message on errors.
1062 =head1 SIGNUP FUNCTIONS
1066 =item signup_info HASHREF
1068 Takes a hash reference as parameter with the following keys:
1072 =item session_id - Optional agent/reseller interface session
1076 Returns a hash reference containing information that may be useful in
1077 displaying a signup page. The hash reference contains the following keys:
1081 =item cust_main_county
1083 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.
1087 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
1088 an agentnum specified explicitly via reseller interface session_id in the
1093 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.
1095 =item agentnum2part_pkg
1097 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.
1101 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.
1103 =item security_phrase
1105 True if the "security_phrase" feature is enabled
1109 Array reference of acceptable payment types for signup
1115 credit card - automatic
1119 credit card - on-demand - version 1.5+ only
1123 electronic check - automatic
1127 electronic check - on-demand - version 1.5+ only
1135 billing, not recommended for signups
1139 free, definitely not recommended for signups
1143 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1149 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1153 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".
1159 =item countrydefault
1165 =item new_customer HASHREF
1167 Creates a new customer. Takes a hash reference as parameter with the
1174 first name (required)
1178 last name (required)
1182 (not typically collected; mostly used for ACH transactions)
1188 =item address1 (required)
1196 =item city (required)
1204 =item state (required)
1208 =item zip (required)
1214 Daytime phone number
1218 Evening phone number
1226 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1230 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1234 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1238 Expiration date for CARD/DCRD
1242 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1244 =item invoicing_list
1246 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),
1248 =item referral_custnum
1250 referring customer number
1258 pkgpart of initial package
1274 Access number (index, not the literal number)
1278 Country code (to be provisioned as a service)
1282 Phone number (to be provisioned as a service)
1290 Returns a hash reference with the following keys:
1296 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)
1300 =item regionselector HASHREF | LIST
1302 Takes as input a hashref or list of key/value pairs with the following keys:
1306 =item selected_county
1308 Currently selected county
1310 =item selected_state
1312 Currently selected state
1314 =item selected_country
1316 Currently selected country
1320 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1324 Specify a javascript subroutine to call on changes
1330 =item default_country
1336 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>.
1340 Returns a list consisting of three HTML fragments for county selection,
1341 state selection and country selection, respectively.
1345 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1346 sub regionselector {
1353 $param->{'selected_country'} ||= $param->{'default_country'};
1354 $param->{'selected_state'} ||= $param->{'default_state'};
1356 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1360 my %cust_main_county;
1362 # unless ( @cust_main_county ) { #cache
1363 #@cust_main_county = qsearch('cust_main_county', {} );
1364 #foreach my $c ( @cust_main_county ) {
1365 foreach my $c ( @{ $param->{'locales'} } ) {
1366 #$countyflag=1 if $c->county;
1367 $countyflag=1 if $c->{county};
1368 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1369 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1370 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1373 $countyflag=1 if $param->{selected_county};
1375 my $script_html = <<END;
1377 function opt(what,value,text) {
1378 var optionName = new Option(text, value, false, false);
1379 var length = what.length;
1380 what.options[length] = optionName;
1382 function ${prefix}country_changed(what) {
1383 country = what.options[what.selectedIndex].text;
1384 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1385 what.form.${prefix}state.options[i] = null;
1387 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1389 foreach my $country ( sort keys %cust_main_county ) {
1390 $script_html .= "\nif ( country == \"$country\" ) {\n";
1391 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1392 my $text = $state || '(n/a)';
1393 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1395 $script_html .= "}\n";
1398 $script_html .= <<END;
1400 function ${prefix}state_changed(what) {
1403 if ( $countyflag ) {
1404 $script_html .= <<END;
1405 state = what.options[what.selectedIndex].text;
1406 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1407 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1408 what.form.${prefix}county.options[i] = null;
1411 foreach my $country ( sort keys %cust_main_county ) {
1412 $script_html .= "\nif ( country == \"$country\" ) {\n";
1413 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1414 $script_html .= "\nif ( state == \"$state\" ) {\n";
1415 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1416 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1417 my $text = $county || '(n/a)';
1419 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1421 $script_html .= "}\n";
1423 $script_html .= "}\n";
1427 $script_html .= <<END;
1432 my $county_html = $script_html;
1433 if ( $countyflag ) {
1434 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1435 foreach my $county (
1436 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1438 my $text = $county || '(n/a)';
1439 $county_html .= qq!<OPTION VALUE="$county"!.
1440 ($county eq $param->{'selected_county'} ?
1447 $county_html .= '</SELECT>';
1450 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1453 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1454 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1455 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1456 my $text = $state || '(n/a)';
1457 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1458 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1460 $state_html .= '</SELECT>';
1462 my $country_html = '';
1463 if ( scalar( keys %cust_main_county ) > 1 ) {
1465 $country_html = qq(<SELECT NAME="${prefix}country" ).
1466 qq(onChange="${prefix}country_changed(this); ).
1467 $param->{'onchange'}.
1470 my $countrydefault = $param->{default_country} || 'US';
1471 foreach my $country (
1472 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1473 keys %cust_main_county
1475 my $selected = $country eq $param->{'selected_country'}
1478 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1480 $country_html .= '</SELECT>';
1483 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1484 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1488 ($county_html, $state_html, $country_html);
1492 sub regionselector_hashref {
1493 my ($county_html, $state_html, $country_html) = regionselector(@_);
1495 'county_html' => $county_html,
1496 'state_html' => $state_html,
1497 'country_html' => $country_html,
1501 =item location_form HASHREF | LIST
1503 Takes as input a hashref or list of key/value pairs with the following keys:
1509 Current customer session_id
1513 Omit red asterisks from required fields.
1515 =item address1_label
1517 Label for first address line.
1521 Returns an HTML fragment for a location form (address, city, state, zip,
1534 my $session_id = delete $param->{'session_id'};
1536 my $rv = mason_comp( 'session_id' => $session_id,
1537 'comp' => '/elements/location.html',
1538 'args' => [ %$param ],
1542 $rv->{'error'} || $rv->{'output'};
1547 #=item expselect HASHREF | LIST
1549 #Takes as input a hashref or list of key/value pairs with the following keys:
1553 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1555 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1559 =item expselect PREFIX [ DATE ]
1561 Takes as input a unique prefix string and the current expiration date, in
1562 yyyy-mm-dd or m-d-yyyy format
1564 Returns an HTML fragments for expiration date selection.
1570 #if ( ref($_[0]) ) {
1574 #my $prefix = $param->{'prefix'};
1575 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1576 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1578 my $date = scalar(@_) ? shift : '';
1580 my( $m, $y ) = ( 0, 0 );
1581 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1582 ( $m, $y ) = ( $2, $1 );
1583 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1584 ( $m, $y ) = ( $1, $3 );
1586 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1588 $return .= qq!<OPTION VALUE="$_"!;
1589 $return .= " SELECTED" if $_ == $m;
1592 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1594 my $thisYear = $t[5] + 1900;
1595 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1596 $return .= qq!<OPTION VALUE="$_"!;
1597 $return .= " SELECTED" if $_ == $y;
1600 $return .= "</SELECT>";
1605 =item popselector HASHREF | LIST
1607 Takes as input a hashref or list of key/value pairs with the following keys:
1613 Access number number
1617 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>.
1621 Returns an HTML fragment for access number selection.
1625 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1633 my $popnum = $param->{'popnum'};
1634 my $pops = $param->{'pops'};
1636 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1637 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1638 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1639 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1640 if scalar(@$pops) == 1;
1643 my %popnum2pop = ();
1645 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1646 $popnum2pop{$_->{popnum}} = $_;
1651 function opt(what,href,text) {
1652 var optionName = new Option(text, href, false, false)
1653 var length = what.length;
1654 what.options[length] = optionName;
1658 my $init_popstate = $param->{'init_popstate'};
1659 if ( $init_popstate ) {
1660 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1661 $init_popstate. '">';
1664 function acstate_changed(what) {
1665 state = what.options[what.selectedIndex].text;
1666 what.form.popac.options.length = 0
1667 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1671 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1672 foreach my $state ( sort { $a cmp $b } @states ) {
1673 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1675 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1676 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1677 if ($ac eq $param->{'popac'}) {
1678 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1681 $text .= "}\n" unless $init_popstate;
1683 $text .= "popac_changed(what.form.popac)}\n";
1686 function popac_changed(what) {
1687 ac = what.options[what.selectedIndex].text;
1688 what.form.popnum.options.length = 0;
1689 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1693 foreach my $state ( @states ) {
1694 foreach my $popac ( keys %{ $pop{$state} } ) {
1695 $text .= "\nif ( ac == \"$popac\" ) {\n";
1697 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1698 my $o_popnum = $pop->{popnum};
1699 my $poptext = $pop->{city}. ', '. $pop->{state}.
1700 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1702 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1703 if ($popnum == $o_popnum) {
1704 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1712 $text .= "}\n</SCRIPT>\n";
1714 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1717 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1718 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1719 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1720 ">$_" foreach sort { $a cmp $b } @states;
1721 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1724 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1725 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1727 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1730 #comment this block to disable initial list polulation
1731 my @initial_select = ();
1732 if ( scalar( @$pops ) > 100 ) {
1733 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1735 @initial_select = @$pops;
1737 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1738 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1739 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1740 $pop->{city}. ', '. $pop->{state}.
1741 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1744 $text .= qq!</SELECT></TD></TR></TABLE>!;
1750 =item domainselector HASHREF | LIST
1752 Takes as input a hashref or list of key/value pairs with the following keys:
1762 Service number of the selected item.
1766 Returns an HTML fragment for domain selection.
1770 sub domainselector {
1777 my $domsvc= $param->{'domsvc'};
1779 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1780 my $domains = $rv->{'domains'};
1781 $domsvc = $rv->{'domsvc'} unless $domsvc;
1783 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1784 unless scalar(keys %$domains);
1786 if (scalar(keys %$domains) == 1) {
1788 foreach(keys %$domains) {
1791 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1792 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1795 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1798 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1799 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1800 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1801 $domains->{$domain};
1804 $text .= qq!</SELECT></TD></TR>!;
1810 =item didselector HASHREF | LIST
1812 Takes as input a hashref or list of key/value pairs with the following keys:
1818 Field name for the returned HTML fragment.
1822 Service definition (see L<FS::part_svc>)
1826 Returns an HTML fragment for DID selection.
1838 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1839 'args'=>[ %$param ],
1843 $rv->{'error'} || $rv->{'output'};
1849 =head1 RESELLER FUNCTIONS
1851 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1852 with their active session, and the B<customer_info> and B<order_pkg> functions
1853 with their active session and an additional I<custnum> parameter.
1855 For the most part, development of the reseller web interface has been
1856 superceded by agent-virtualized access to the backend.
1868 =item agent_list_customers
1870 List agent's customers.
1878 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>