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 'create_ticket' => 'MyAccount/create_ticket',
63 'signup_info' => 'Signup/signup_info',
64 'skin_info' => 'MyAccount/skin_info',
65 'access_info' => 'MyAccount/access_info',
66 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
67 'new_customer' => 'Signup/new_customer',
68 'capture_payment' => 'Signup/capture_payment',
69 'agent_login' => 'Agent/agent_login',
70 'agent_logout' => 'Agent/agent_logout',
71 'agent_info' => 'Agent/agent_info',
72 'agent_list_customers' => 'Agent/agent_list_customers',
73 'check_username' => 'Agent/check_username',
74 'suspend_username' => 'Agent/suspend_username',
75 'unsuspend_username' => 'Agent/unsuspend_username',
76 'mason_comp' => 'MasonComponent/mason_comp',
77 'call_time' => 'PrepaidPhone/call_time',
78 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
79 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
80 'bulk_processrow' => 'Bulk/processrow',
81 'check_username' => 'Bulk/check_username',
83 'ping' => 'SGNG/ping',
84 'decompify_pkgs' => 'SGNG/decompify_pkgs',
85 'previous_payment_info' => 'SGNG/previous_payment_info',
86 'previous_payment_info_renew_info'
87 => 'SGNG/previous_payment_info_renew_info',
88 'previous_process_payment' => 'SGNG/previous_process_payment',
89 'previous_process_payment_order_pkg'
90 => 'SGNG/previous_process_payment_order_pkg',
91 'previous_process_payment_change_pkg'
92 => 'SGNG/previous_process_payment_change_pkg',
93 'previous_process_payment_order_renew'
94 => 'SGNG/previous_process_payment_order_renew',
98 qw( regionselector regionselector_hashref location_form
99 expselect popselector domainselector didselector
103 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
104 $ENV{'SHELL'} = '/bin/sh';
105 $ENV{'IFS'} = " \t\n";
108 $ENV{'BASH_ENV'} = '';
110 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
111 #if you grant appropriate permissions to whatever user
112 my $freeside_uid = scalar(getpwnam('freeside'));
113 die "not running as the freeside user\n"
114 if $> != $freeside_uid && ! $skip_uid_check;
116 -e $dir or die "FATAL: $dir doesn't exist!";
117 -d $dir or die "FATAL: $dir isn't a directory!";
118 -r $dir or die "FATAL: Can't read $dir as freeside user!";
119 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
121 foreach my $autoload ( keys %autoload ) {
124 "sub $autoload { ". '
129 #warn scalar(@_). ": ". join(" / ", @_);
133 $param->{_packet} = \''. $autoload{$autoload}. '\';
135 simple_packet($param);
145 warn "sending ". $packet->{_packet}. " to server"
147 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
148 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
149 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
152 #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
154 #block until there is a message on socket
155 # my $w = new IO::Select;
157 # my @wait = $w->can_read;
159 warn "reading message from server"
162 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
163 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
165 warn "returning message to client"
173 FS::SelfService - Freeside self-service API
177 # password and shell account changes
178 use FS::SelfService qw(passwd chfn chsh);
180 # "my account" functionality
181 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
183 my $rv = login( { 'username' => $username,
185 'password' => $password,
189 if ( $rv->{'error'} ) {
190 #handle login error...
193 my $session_id = $rv->{'session_id'};
196 my $customer_info = customer_info( { 'session_id' => $session_id } );
198 #payment_info and process_payment are available in 1.5+ only
199 my $payment_info = payment_info( { 'session_id' => $session_id } );
201 #!!! process_payment example
203 #!!! list_pkgs example
205 #!!! order_pkg example
207 #!!! cancel_pkg example
209 # signup functionality
210 use FS::SelfService qw( signup_info new_customer );
212 my $signup_info = signup_info;
214 $rv = new_customer( {
217 'company' => $company,
218 'address1' => $address1,
219 'address2' => $address2,
223 'country' => $country,
224 'daytime' => $daytime,
228 'payinfo' => $payinfo,
230 'paystart_month' => $paystart_month
231 'paystart_year' => $paystart_year,
232 'payissue' => $payissue,
234 'paydate' => $paydate,
235 'payname' => $payname,
236 'invoicing_list' => $invoicing_list,
237 'referral_custnum' => $referral_custnum,
238 'agentnum' => $agentnum,
239 'pkgpart' => $pkgpart,
241 'username' => $username,
242 '_password' => $password,
246 'phonenum' => $phonenum,
251 my $error = $rv->{'error'};
252 if ( $error eq '_decline' ) {
262 Use this API to implement your own client "self-service" module.
264 If you just want to customize the look of the existing "self-service" module,
267 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
279 =head1 "MY ACCOUNT" FUNCTIONS
285 Creates a user session. Takes a hash reference as parameter with the
304 Returns a hash reference with the following keys:
310 Empty on success, or an error message on errors.
314 Session identifier for successful logins
318 =item customer_info HASHREF
320 Returns general customer information.
322 Takes a hash reference as parameter with a single key: B<session_id>
324 Returns a hash reference with the following keys:
338 Array reference of hash references of open inoices. Each hash reference has
339 the following keys: invnum, date, owed
343 An HTML fragment containing shipping and billing addresses.
345 =item The following fields are also returned
347 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
351 =item edit_info HASHREF
353 Takes a hash reference as parameter with any of the following keys:
355 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
357 If a field exists, the customer record is updated with the new value of that
358 field. If a field does not exist, that field is not changed on the customer
361 Returns a hash reference with a single key, B<error>, empty on success, or an
362 error message on errors
364 =item invoice HASHREF
366 Returns an invoice. Takes a hash reference as parameter with two keys:
367 session_id and invnum
369 Returns a hash reference with the following keys:
375 Empty on success, or an error message on errors
387 =item list_invoices HASHREF
389 Returns a list of all customer invoices. Takes a hash references with a single
392 Returns a hash reference with the following keys:
398 Empty on success, or an error message on errors
402 Reference to array of hash references with the following keys:
412 Invoice date, in UNIX epoch time
420 Cancels this customer.
422 Takes a hash reference as parameter with a single key: B<session_id>
424 Returns a hash reference with a single key, B<error>, which is empty on
425 success or an error message on errors.
427 =item payment_info HASHREF
429 Returns information that may be useful in displaying a payment page.
431 Takes a hash reference as parameter with a single key: B<session_id>.
433 Returns a hash reference with the following keys:
439 Empty on success, or an error message on errors
447 Exact name on credit card (CARD/DCRD)
471 Customer's current default payment type.
475 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
479 For CARD/DCRD payment types, the card number
483 For CARD/DCRD payment types, expiration month
487 For CARD/DCRD payment types, expiration year
489 =item cust_main_county
491 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.
495 Array reference of all states in the current default country.
499 Hash reference of card types; keys are card types, values are the exact strings
500 passed to the process_payment function
504 #this doesn't actually work yet
508 #Unique transaction identifier (prevents multiple charges), passed to the
509 #process_payment function
513 =item process_payment HASHREF
515 Processes a payment and possible change of address or payment type. Takes a
516 hash reference as parameter with the following keys:
530 If true, address and card information entered will be saved for subsequent
535 If true, future credit card payments will be done automatically (sets payby to
536 CARD). If false, future credit card payments will be done on-demand (sets
537 payby to DCRD). This option only has meaning if B<save> is set true.
565 Two-letter country code
573 Card expiration month
581 #this doesn't actually work yet
585 #Unique transaction identifier, returned from the payment_info function.
586 #Prevents multiple charges.
590 Returns a hash reference with a single key, B<error>, empty on success, or an
591 error message on errors.
593 =item process_payment_order_pkg
595 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
596 payment processes sucessfully, the package is ordered. Takes a hash reference
597 as parameter with the keys of both methods.
599 Returns a hash reference with a single key, B<error>, empty on success, or an
600 error message on errors.
602 =item process_payment_change_pkg
604 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
605 payment processes sucessfully, the package is ordered. Takes a hash reference
606 as parameter with the keys of both methods.
608 Returns a hash reference with a single key, B<error>, empty on success, or an
609 error message on errors.
612 =item process_payment_order_renew
614 Combines the B<process_payment> and B<order_renew> functions in one step. If
615 the payment processes sucessfully, the renewal is processed. Takes a hash
616 reference 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.
623 Returns package information for this customer. For more detail on services,
626 Takes a hash reference as parameter with a single key: B<session_id>
628 Returns a hash reference containing customer package information. The hash reference contains the following keys:
638 Empty on success, or an error message on errors.
640 =item cust_pkg HASHREF
642 Array reference of hash references, each of which has the fields of a cust_pkg
643 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
644 the internal FS:: objects, but hash references of columns and values.
648 =item part_pkg fields
650 All fields of part_pkg for this specific cust_pkg (be careful with this
651 information - it may reveal more about your available packages than you would
652 like users to know in aggregate)
656 #XXX pare part_pkg fields down to a more secure subset
660 An array of hash references indicating information on unprovisioned services
661 available for provisioning for this specific cust_pkg. Each has the following
666 =item part_svc fields
668 All fields of part_svc (be careful with this information - it may reveal more
669 about your available packages than you would like users to know in aggregate)
673 #XXX pare part_svc fields down to a more secure subset
679 An array of hash references indicating information on the customer services
680 already provisioned for this specific cust_pkg. Each has the following keys:
686 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.
692 Primary key for this service
696 Service definition (see L<FS::part_svc>)
700 Customer package (see L<FS::cust_pkg>)
704 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
712 Returns service information for this customer.
714 Takes a hash reference as parameter with a single key: B<session_id>
716 Returns a hash reference containing customer package information. The hash reference contains the following keys:
726 An array of hash references indicating information on all of this customer's
727 services. Each has the following keys:
733 Primary key for this service
741 Meaningful user-specific identifier for the service (i.e. username, domain, or
746 Account (svc_acct) services also have the following keys:
764 Upload bytes remaining
768 Download bytes remaining
772 Total bytes remaining
774 =item recharge_amount
778 =item recharge_seconds
780 Number of seconds gained by recharge
782 =item recharge_upbytes
784 Number of upload bytes gained by recharge
786 =item recharge_downbytes
788 Number of download bytes gained by recharge
790 =item recharge_totalbytes
792 Number of total bytes gained by recharge
800 Orders a package for this customer.
802 Takes a hash reference as parameter with the following keys:
812 Package to order (see L<FS::part_pkg>).
816 Service to order (see L<FS::part_svc>).
818 Normally optional; required only to provision a non-svc_acct service, or if the
819 package definition does not contain one svc_acct service definition with
820 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
821 also be specified to indicate that no initial service should be provisioned.
825 Fields used when provisioning an svc_acct service:
839 Optional security phrase
843 Optional Access number number
847 Fields used when provisioning an svc_domain service:
857 Fields used when provisioning an svc_phone service:
875 Fields used when provisioning an svc_external service:
889 Returns a hash reference with a single key, B<error>, empty on success, or an
890 error message on errors. The special error '_decline' is returned for
891 declined transactions.
895 Changes a package for this customer.
897 Takes a hash reference as parameter with the following keys:
907 Existing customer package.
911 New package to order (see L<FS::part_pkg>).
915 Returns a hash reference with a single key, B<error>, empty on success, or an
916 error message on errors.
920 Provides useful info for early renewals.
922 Takes a hash reference as parameter with the following keys:
932 Returns a hash reference. On errors, it contains a single key, B<error>, with
933 the error message. Otherwise, contains a single key, B<dates>, pointing to
934 an array refernce of hash references. Each hash reference contains the
941 (Future) Bill date. Indicates a future date for which billing could be run.
942 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
945 =item bill_date_pretty
947 (Future) Bill date as a human-readable string. (Convenience for display;
948 subject to change, so best not to parse for the date.)
952 Base amount which will be charged if renewed early as of this date.
956 Renewal date; i.e. even-futher future date at which the customer will be paid
957 through if the early renewal is completed with the given B<bill-date>.
958 Specified as a integer UNIX timestamp.
960 =item renew_date_pretty
962 Renewal date as a human-readable string. (Convenience for display;
963 subject to change, so best not to parse for the date.)
967 Package that will be renewed.
971 Expiration date of the package that will be renewed.
973 =item expire_date_pretty
975 Expiration date of the package that will be renewed, as a human-readable
976 string. (Convenience for display; subject to change, so best not to parse for
983 Renews this customer early; i.e. runs billing for this customer in advance.
985 Takes a hash reference as parameter with the following keys:
995 Integer date as returned by the B<renew_info> function, indicating the advance
996 date for which to run billing.
1000 Returns a hash reference with a single key, B<error>, empty on success, or an
1001 error message on errors.
1005 Cancels a package for this customer.
1007 Takes a hash reference as parameter with the following keys:
1017 pkgpart of package to cancel
1021 Returns a hash reference with a single key, B<error>, empty on success, or an
1022 error message on errors.
1026 =head1 SIGNUP FUNCTIONS
1030 =item signup_info HASHREF
1032 Takes a hash reference as parameter with the following keys:
1036 =item session_id - Optional agent/reseller interface session
1040 Returns a hash reference containing information that may be useful in
1041 displaying a signup page. The hash reference contains the following keys:
1045 =item cust_main_county
1047 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.
1051 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
1052 an agentnum specified explicitly via reseller interface session_id in the
1057 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.
1059 =item agentnum2part_pkg
1061 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.
1065 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.
1067 =item security_phrase
1069 True if the "security_phrase" feature is enabled
1073 Array reference of acceptable payment types for signup
1079 credit card - automatic
1083 credit card - on-demand - version 1.5+ only
1087 electronic check - automatic
1091 electronic check - on-demand - version 1.5+ only
1099 billing, not recommended for signups
1103 free, definitely not recommended for signups
1107 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1113 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1117 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".
1123 =item countrydefault
1129 =item new_customer HASHREF
1131 Creates a new customer. Takes a hash reference as parameter with the
1138 first name (required)
1142 last name (required)
1146 (not typically collected; mostly used for ACH transactions)
1152 =item address1 (required)
1160 =item city (required)
1168 =item state (required)
1172 =item zip (required)
1178 Daytime phone number
1182 Evening phone number
1190 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1194 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1198 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1202 Expiration date for CARD/DCRD
1206 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1208 =item invoicing_list
1210 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),
1212 =item referral_custnum
1214 referring customer number
1222 pkgpart of initial package
1238 Access number (index, not the literal number)
1242 Country code (to be provisioned as a service)
1246 Phone number (to be provisioned as a service)
1254 Returns a hash reference with the following keys:
1260 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)
1264 =item regionselector HASHREF | LIST
1266 Takes as input a hashref or list of key/value pairs with the following keys:
1270 =item selected_county
1272 Currently selected county
1274 =item selected_state
1276 Currently selected state
1278 =item selected_country
1280 Currently selected country
1284 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1288 Specify a javascript subroutine to call on changes
1294 =item default_country
1300 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>.
1304 Returns a list consisting of three HTML fragments for county selection,
1305 state selection and country selection, respectively.
1309 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1310 sub regionselector {
1317 $param->{'selected_country'} ||= $param->{'default_country'};
1318 $param->{'selected_state'} ||= $param->{'default_state'};
1320 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1324 my %cust_main_county;
1326 # unless ( @cust_main_county ) { #cache
1327 #@cust_main_county = qsearch('cust_main_county', {} );
1328 #foreach my $c ( @cust_main_county ) {
1329 foreach my $c ( @{ $param->{'locales'} } ) {
1330 #$countyflag=1 if $c->county;
1331 $countyflag=1 if $c->{county};
1332 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1333 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1334 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1337 $countyflag=1 if $param->{selected_county};
1339 my $script_html = <<END;
1341 function opt(what,value,text) {
1342 var optionName = new Option(text, value, false, false);
1343 var length = what.length;
1344 what.options[length] = optionName;
1346 function ${prefix}country_changed(what) {
1347 country = what.options[what.selectedIndex].text;
1348 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1349 what.form.${prefix}state.options[i] = null;
1351 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1353 foreach my $country ( sort keys %cust_main_county ) {
1354 $script_html .= "\nif ( country == \"$country\" ) {\n";
1355 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1356 my $text = $state || '(n/a)';
1357 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1359 $script_html .= "}\n";
1362 $script_html .= <<END;
1364 function ${prefix}state_changed(what) {
1367 if ( $countyflag ) {
1368 $script_html .= <<END;
1369 state = what.options[what.selectedIndex].text;
1370 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1371 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1372 what.form.${prefix}county.options[i] = null;
1375 foreach my $country ( sort keys %cust_main_county ) {
1376 $script_html .= "\nif ( country == \"$country\" ) {\n";
1377 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1378 $script_html .= "\nif ( state == \"$state\" ) {\n";
1379 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1380 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1381 my $text = $county || '(n/a)';
1383 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1385 $script_html .= "}\n";
1387 $script_html .= "}\n";
1391 $script_html .= <<END;
1396 my $county_html = $script_html;
1397 if ( $countyflag ) {
1398 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1399 foreach my $county (
1400 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1402 my $text = $county || '(n/a)';
1403 $county_html .= qq!<OPTION VALUE="$county"!.
1404 ($county eq $param->{'selected_county'} ?
1411 $county_html .= '</SELECT>';
1414 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1417 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1418 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1419 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1420 my $text = $state || '(n/a)';
1421 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1422 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1424 $state_html .= '</SELECT>';
1426 my $country_html = '';
1427 if ( scalar( keys %cust_main_county ) > 1 ) {
1429 $country_html = qq(<SELECT NAME="${prefix}country" ).
1430 qq(onChange="${prefix}country_changed(this); ).
1431 $param->{'onchange'}.
1434 my $countrydefault = $param->{default_country} || 'US';
1435 foreach my $country (
1436 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1437 keys %cust_main_county
1439 my $selected = $country eq $param->{'selected_country'}
1442 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1444 $country_html .= '</SELECT>';
1447 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1448 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1452 ($county_html, $state_html, $country_html);
1456 sub regionselector_hashref {
1457 my ($county_html, $state_html, $country_html) = regionselector(@_);
1459 'county_html' => $county_html,
1460 'state_html' => $state_html,
1461 'country_html' => $country_html,
1465 =item location_form HASHREF | LIST
1467 Takes as input a hashref or list of key/value pairs with the following keys:
1473 Current customer session_id
1477 Omit red asterisks from required fields.
1479 =item address1_label
1481 Label for first address line.
1485 Returns an HTML fragment for a location form (address, city, state, zip,
1498 my $session_id = delete $param->{'session_id'};
1500 my $rv = mason_comp( 'session_id' => $session_id,
1501 'comp' => '/elements/location.html',
1502 'args' => [ %$param ],
1506 $rv->{'error'} || $rv->{'output'};
1511 #=item expselect HASHREF | LIST
1513 #Takes as input a hashref or list of key/value pairs with the following keys:
1517 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1519 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1523 =item expselect PREFIX [ DATE ]
1525 Takes as input a unique prefix string and the current expiration date, in
1526 yyyy-mm-dd or m-d-yyyy format
1528 Returns an HTML fragments for expiration date selection.
1534 #if ( ref($_[0]) ) {
1538 #my $prefix = $param->{'prefix'};
1539 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1540 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1542 my $date = scalar(@_) ? shift : '';
1544 my( $m, $y ) = ( 0, 0 );
1545 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1546 ( $m, $y ) = ( $2, $1 );
1547 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1548 ( $m, $y ) = ( $1, $3 );
1550 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1552 $return .= qq!<OPTION VALUE="$_"!;
1553 $return .= " SELECTED" if $_ == $m;
1556 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1558 my $thisYear = $t[5] + 1900;
1559 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1560 $return .= qq!<OPTION VALUE="$_"!;
1561 $return .= " SELECTED" if $_ == $y;
1564 $return .= "</SELECT>";
1569 =item popselector HASHREF | LIST
1571 Takes as input a hashref or list of key/value pairs with the following keys:
1577 Access number number
1581 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>.
1585 Returns an HTML fragment for access number selection.
1589 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1597 my $popnum = $param->{'popnum'};
1598 my $pops = $param->{'pops'};
1600 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1601 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1602 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1603 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1604 if scalar(@$pops) == 1;
1607 my %popnum2pop = ();
1609 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1610 $popnum2pop{$_->{popnum}} = $_;
1615 function opt(what,href,text) {
1616 var optionName = new Option(text, href, false, false)
1617 var length = what.length;
1618 what.options[length] = optionName;
1622 my $init_popstate = $param->{'init_popstate'};
1623 if ( $init_popstate ) {
1624 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1625 $init_popstate. '">';
1628 function acstate_changed(what) {
1629 state = what.options[what.selectedIndex].text;
1630 what.form.popac.options.length = 0
1631 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1635 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1636 foreach my $state ( sort { $a cmp $b } @states ) {
1637 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1639 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1640 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1641 if ($ac eq $param->{'popac'}) {
1642 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1645 $text .= "}\n" unless $init_popstate;
1647 $text .= "popac_changed(what.form.popac)}\n";
1650 function popac_changed(what) {
1651 ac = what.options[what.selectedIndex].text;
1652 what.form.popnum.options.length = 0;
1653 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1657 foreach my $state ( @states ) {
1658 foreach my $popac ( keys %{ $pop{$state} } ) {
1659 $text .= "\nif ( ac == \"$popac\" ) {\n";
1661 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1662 my $o_popnum = $pop->{popnum};
1663 my $poptext = $pop->{city}. ', '. $pop->{state}.
1664 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1666 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1667 if ($popnum == $o_popnum) {
1668 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1676 $text .= "}\n</SCRIPT>\n";
1678 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1681 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1682 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1683 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1684 ">$_" foreach sort { $a cmp $b } @states;
1685 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1688 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1689 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1691 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1694 #comment this block to disable initial list polulation
1695 my @initial_select = ();
1696 if ( scalar( @$pops ) > 100 ) {
1697 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1699 @initial_select = @$pops;
1701 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1702 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1703 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1704 $pop->{city}. ', '. $pop->{state}.
1705 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1708 $text .= qq!</SELECT></TD></TR></TABLE>!;
1714 =item domainselector HASHREF | LIST
1716 Takes as input a hashref or list of key/value pairs with the following keys:
1726 Service number of the selected item.
1730 Returns an HTML fragment for domain selection.
1734 sub domainselector {
1741 my $domsvc= $param->{'domsvc'};
1743 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1744 my $domains = $rv->{'domains'};
1745 $domsvc = $rv->{'domsvc'} unless $domsvc;
1747 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1748 unless scalar(keys %$domains);
1750 if (scalar(keys %$domains) == 1) {
1752 foreach(keys %$domains) {
1755 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1756 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1759 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1762 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1763 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1764 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1765 $domains->{$domain};
1768 $text .= qq!</SELECT></TD></TR>!;
1774 =item didselector HASHREF | LIST
1776 Takes as input a hashref or list of key/value pairs with the following keys:
1782 Field name for the returned HTML fragment.
1786 Service definition (see L<FS::part_svc>)
1790 Returns an HTML fragment for DID selection.
1802 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1803 'args'=>[ %$param ],
1807 $rv->{'error'} || $rv->{'output'};
1813 =head1 RESELLER FUNCTIONS
1815 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1816 with their active session, and the B<customer_info> and B<order_pkg> functions
1817 with their active session and an additional I<custnum> parameter.
1819 For the most part, development of the reseller web interface has been
1820 superceded by agent-virtualized access to the backend.
1832 =item agent_list_customers
1834 List agent's customers.
1842 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>