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 'access_info' => 'MyAccount/access_info',
65 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
66 'new_customer' => 'Signup/new_customer',
67 'capture_payment' => 'Signup/capture_payment',
68 'agent_login' => 'Agent/agent_login',
69 'agent_logout' => 'Agent/agent_logout',
70 'agent_info' => 'Agent/agent_info',
71 'agent_list_customers' => 'Agent/agent_list_customers',
72 'mason_comp' => 'MasonComponent/mason_comp',
73 'call_time' => 'PrepaidPhone/call_time',
74 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
75 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
76 'bulk_processrow' => 'Bulk/processrow',
77 'check_username' => 'Bulk/check_username',
79 'decompify_pkgs' => 'SGNG/decompify_pkgs',
80 'previous_payment_info' => 'SGNG/previous_payment_info',
81 'previous_payment_info_renew_info'
82 => 'SGNG/previous_payment_info_renew_info',
83 'previous_process_payment' => 'SGNG/previous_process_payment',
84 'previous_process_payment_order_pkg'
85 => 'SGNG/previous_process_payment_order_pkg',
86 'previous_process_payment_change_pkg'
87 => 'SGNG/previous_process_payment_change_pkg',
88 'previous_process_payment_order_renew'
89 => 'SGNG/previous_process_payment_order_renew',
93 qw( regionselector regionselector_hashref location_form
94 expselect popselector domainselector didselector
98 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
99 $ENV{'SHELL'} = '/bin/sh';
100 $ENV{'IFS'} = " \t\n";
103 $ENV{'BASH_ENV'} = '';
105 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
106 #if you grant appropriate permissions to whatever user
107 my $freeside_uid = scalar(getpwnam('freeside'));
108 die "not running as the freeside user\n"
109 if $> != $freeside_uid && ! $skip_uid_check;
111 -e $dir or die "FATAL: $dir doesn't exist!";
112 -d $dir or die "FATAL: $dir isn't a directory!";
113 -r $dir or die "FATAL: Can't read $dir as freeside user!";
114 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
116 foreach my $autoload ( keys %autoload ) {
119 "sub $autoload { ". '
124 #warn scalar(@_). ": ". join(" / ", @_);
128 $param->{_packet} = \''. $autoload{$autoload}. '\';
130 simple_packet($param);
140 warn "sending ". $packet->{_packet}. " to server"
142 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
143 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
144 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
147 #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
149 #block until there is a message on socket
150 # my $w = new IO::Select;
152 # my @wait = $w->can_read;
154 warn "reading message from server"
157 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
158 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
160 warn "returning message to client"
168 FS::SelfService - Freeside self-service API
172 # password and shell account changes
173 use FS::SelfService qw(passwd chfn chsh);
175 # "my account" functionality
176 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
178 my $rv = login( { 'username' => $username,
180 'password' => $password,
184 if ( $rv->{'error'} ) {
185 #handle login error...
188 my $session_id = $rv->{'session_id'};
191 my $customer_info = customer_info( { 'session_id' => $session_id } );
193 #payment_info and process_payment are available in 1.5+ only
194 my $payment_info = payment_info( { 'session_id' => $session_id } );
196 #!!! process_payment example
198 #!!! list_pkgs example
200 #!!! order_pkg example
202 #!!! cancel_pkg example
204 # signup functionality
205 use FS::SelfService qw( signup_info new_customer );
207 my $signup_info = signup_info;
209 $rv = new_customer( {
212 'company' => $company,
213 'address1' => $address1,
214 'address2' => $address2,
218 'country' => $country,
219 'daytime' => $daytime,
223 'payinfo' => $payinfo,
225 'paystart_month' => $paystart_month
226 'paystart_year' => $paystart_year,
227 'payissue' => $payissue,
229 'paydate' => $paydate,
230 'payname' => $payname,
231 'invoicing_list' => $invoicing_list,
232 'referral_custnum' => $referral_custnum,
233 'agentnum' => $agentnum,
234 'pkgpart' => $pkgpart,
236 'username' => $username,
237 '_password' => $password,
241 'phonenum' => $phonenum,
246 my $error = $rv->{'error'};
247 if ( $error eq '_decline' ) {
257 Use this API to implement your own client "self-service" module.
259 If you just want to customize the look of the existing "self-service" module,
262 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
274 =head1 "MY ACCOUNT" FUNCTIONS
280 Creates a user session. Takes a hash reference as parameter with the
299 Returns a hash reference with the following keys:
305 Empty on success, or an error message on errors.
309 Session identifier for successful logins
313 =item customer_info HASHREF
315 Returns general customer information.
317 Takes a hash reference as parameter with a single key: B<session_id>
319 Returns a hash reference with the following keys:
333 Array reference of hash references of open inoices. Each hash reference has
334 the following keys: invnum, date, owed
338 An HTML fragment containing shipping and billing addresses.
340 =item The following fields are also returned
342 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
346 =item edit_info HASHREF
348 Takes a hash reference as parameter with any of the following keys:
350 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
352 If a field exists, the customer record is updated with the new value of that
353 field. If a field does not exist, that field is not changed on the customer
356 Returns a hash reference with a single key, B<error>, empty on success, or an
357 error message on errors
359 =item invoice HASHREF
361 Returns an invoice. Takes a hash reference as parameter with two keys:
362 session_id and invnum
364 Returns a hash reference with the following keys:
370 Empty on success, or an error message on errors
382 =item list_invoices HASHREF
384 Returns a list of all customer invoices. Takes a hash references with a single
387 Returns a hash reference with the following keys:
393 Empty on success, or an error message on errors
397 Reference to array of hash references with the following keys:
407 Invoice date, in UNIX epoch time
415 Cancels this customer.
417 Takes a hash reference as parameter with a single key: B<session_id>
419 Returns a hash reference with a single key, B<error>, which is empty on
420 success or an error message on errors.
422 =item payment_info HASHREF
424 Returns information that may be useful in displaying a payment page.
426 Takes a hash reference as parameter with a single key: B<session_id>.
428 Returns a hash reference with the following keys:
434 Empty on success, or an error message on errors
442 Exact name on credit card (CARD/DCRD)
466 Customer's current default payment type.
470 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
474 For CARD/DCRD payment types, the card number
478 For CARD/DCRD payment types, expiration month
482 For CARD/DCRD payment types, expiration year
484 =item cust_main_county
486 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.
490 Array reference of all states in the current default country.
494 Hash reference of card types; keys are card types, values are the exact strings
495 passed to the process_payment function
499 #this doesn't actually work yet
503 #Unique transaction identifier (prevents multiple charges), passed to the
504 #process_payment function
508 =item process_payment HASHREF
510 Processes a payment and possible change of address or payment type. Takes a
511 hash reference as parameter with the following keys:
525 If true, address and card information entered will be saved for subsequent
530 If true, future credit card payments will be done automatically (sets payby to
531 CARD). If false, future credit card payments will be done on-demand (sets
532 payby to DCRD). This option only has meaning if B<save> is set true.
560 Two-letter country code
568 Card expiration month
576 #this doesn't actually work yet
580 #Unique transaction identifier, returned from the payment_info function.
581 #Prevents multiple charges.
585 Returns a hash reference with a single key, B<error>, empty on success, or an
586 error message on errors.
588 =item process_payment_order_pkg
590 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
591 payment processes sucessfully, the package is ordered. Takes a hash reference
592 as parameter with the keys of both methods.
594 Returns a hash reference with a single key, B<error>, empty on success, or an
595 error message on errors.
597 =item process_payment_change_pkg
599 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
600 payment processes sucessfully, the package is ordered. Takes a hash reference
601 as parameter with the keys of both methods.
603 Returns a hash reference with a single key, B<error>, empty on success, or an
604 error message on errors.
607 =item process_payment_order_renew
609 Combines the B<process_payment> and B<order_renew> functions in one step. If
610 the payment processes sucessfully, the renewal is processed. Takes a hash
611 reference as parameter with the keys of both methods.
613 Returns a hash reference with a single key, B<error>, empty on success, or an
614 error message on errors.
618 Returns package information for this customer. For more detail on services,
621 Takes a hash reference as parameter with a single key: B<session_id>
623 Returns a hash reference containing customer package information. The hash reference contains the following keys:
633 Empty on success, or an error message on errors.
635 =item cust_pkg HASHREF
637 Array reference of hash references, each of which has the fields of a cust_pkg
638 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
639 the internal FS:: objects, but hash references of columns and values.
643 =item part_pkg fields
645 All fields of part_pkg for this specific cust_pkg (be careful with this
646 information - it may reveal more about your available packages than you would
647 like users to know in aggregate)
651 #XXX pare part_pkg fields down to a more secure subset
655 An array of hash references indicating information on unprovisioned services
656 available for provisioning for this specific cust_pkg. Each has the following
661 =item part_svc fields
663 All fields of part_svc (be careful with this information - it may reveal more
664 about your available packages than you would like users to know in aggregate)
668 #XXX pare part_svc fields down to a more secure subset
674 An array of hash references indicating information on the customer services
675 already provisioned for this specific cust_pkg. Each has the following keys:
681 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.
687 Primary key for this service
691 Service definition (see L<FS::part_svc>)
695 Customer package (see L<FS::cust_pkg>)
699 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
707 Returns service information for this customer.
709 Takes a hash reference as parameter with a single key: B<session_id>
711 Returns a hash reference containing customer package information. The hash reference contains the following keys:
721 An array of hash references indicating information on all of this customer's
722 services. Each has the following keys:
728 Primary key for this service
736 Meaningful user-specific identifier for the service (i.e. username, domain, or
741 Account (svc_acct) services also have the following keys:
759 Upload bytes remaining
763 Download bytes remaining
767 Total bytes remaining
769 =item recharge_amount
773 =item recharge_seconds
775 Number of seconds gained by recharge
777 =item recharge_upbytes
779 Number of upload bytes gained by recharge
781 =item recharge_downbytes
783 Number of download bytes gained by recharge
785 =item recharge_totalbytes
787 Number of total bytes gained by recharge
795 Orders a package for this customer.
797 Takes a hash reference as parameter with the following keys:
807 Package to order (see L<FS::part_pkg>).
811 Service to order (see L<FS::part_svc>).
813 Normally optional; required only to provision a non-svc_acct service, or if the
814 package definition does not contain one svc_acct service definition with
815 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
816 also be specified to indicate that no initial service should be provisioned.
820 Fields used when provisioning an svc_acct service:
834 Optional security phrase
838 Optional Access number number
842 Fields used when provisioning an svc_domain service:
852 Fields used when provisioning an svc_phone service:
870 Fields used when provisioning an svc_external service:
884 Returns a hash reference with a single key, B<error>, empty on success, or an
885 error message on errors. The special error '_decline' is returned for
886 declined transactions.
890 Changes a package for this customer.
892 Takes a hash reference as parameter with the following keys:
902 Existing customer package.
906 New package to order (see L<FS::part_pkg>).
910 Returns a hash reference with a single key, B<error>, empty on success, or an
911 error message on errors.
915 Provides useful info for early renewals.
917 Takes a hash reference as parameter with the following keys:
927 Returns a hash reference. On errors, it contains a single key, B<error>, with
928 the error message. Otherwise, contains a single key, B<dates>, pointing to
929 an array refernce of hash references. Each hash reference contains the
936 (Future) Bill date. Indicates a future date for which billing could be run.
937 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
940 =item bill_date_pretty
942 (Future) Bill date as a human-readable string. (Convenience for display;
943 subject to change, so best not to parse for the date.)
947 Base amount which will be charged if renewed early as of this date.
951 Renewal date; i.e. even-futher future date at which the customer will be paid
952 through if the early renewal is completed with the given B<bill-date>.
953 Specified as a integer UNIX timestamp.
955 =item renew_date_pretty
957 Renewal date as a human-readable string. (Convenience for display;
958 subject to change, so best not to parse for the date.)
962 Package that will be renewed.
966 Expiration date of the package that will be renewed.
968 =item expire_date_pretty
970 Expiration date of the package that will be renewed, as a human-readable
971 string. (Convenience for display; subject to change, so best not to parse for
978 Renews this customer early; i.e. runs billing for this customer in advance.
980 Takes a hash reference as parameter with the following keys:
990 Integer date as returned by the B<renew_info> function, indicating the advance
991 date for which to run billing.
995 Returns a hash reference with a single key, B<error>, empty on success, or an
996 error message on errors.
1000 Cancels a package for this customer.
1002 Takes a hash reference as parameter with the following keys:
1012 pkgpart of package to cancel
1016 Returns a hash reference with a single key, B<error>, empty on success, or an
1017 error message on errors.
1021 =head1 SIGNUP FUNCTIONS
1025 =item signup_info HASHREF
1027 Takes a hash reference as parameter with the following keys:
1031 =item session_id - Optional agent/reseller interface session
1035 Returns a hash reference containing information that may be useful in
1036 displaying a signup page. The hash reference contains the following keys:
1040 =item cust_main_county
1042 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.
1046 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
1047 an agentnum specified explicitly via reseller interface session_id in the
1052 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.
1054 =item agentnum2part_pkg
1056 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.
1060 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.
1062 =item security_phrase
1064 True if the "security_phrase" feature is enabled
1068 Array reference of acceptable payment types for signup
1074 credit card - automatic
1078 credit card - on-demand - version 1.5+ only
1082 electronic check - automatic
1086 electronic check - on-demand - version 1.5+ only
1094 billing, not recommended for signups
1098 free, definitely not recommended for signups
1102 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1108 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1112 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".
1118 =item countrydefault
1124 =item new_customer HASHREF
1126 Creates a new customer. Takes a hash reference as parameter with the
1133 first name (required)
1137 last name (required)
1141 (not typically collected; mostly used for ACH transactions)
1147 =item address1 (required)
1155 =item city (required)
1163 =item state (required)
1167 =item zip (required)
1173 Daytime phone number
1177 Evening phone number
1185 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1189 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1193 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1197 Expiration date for CARD/DCRD
1201 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1203 =item invoicing_list
1205 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),
1207 =item referral_custnum
1209 referring customer number
1217 pkgpart of initial package
1233 Access number (index, not the literal number)
1237 Country code (to be provisioned as a service)
1241 Phone number (to be provisioned as a service)
1249 Returns a hash reference with the following keys:
1255 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)
1259 =item regionselector HASHREF | LIST
1261 Takes as input a hashref or list of key/value pairs with the following keys:
1265 =item selected_county
1267 Currently selected county
1269 =item selected_state
1271 Currently selected state
1273 =item selected_country
1275 Currently selected country
1279 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1283 Specify a javascript subroutine to call on changes
1289 =item default_country
1295 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>.
1299 Returns a list consisting of three HTML fragments for county selection,
1300 state selection and country selection, respectively.
1304 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1305 sub regionselector {
1312 $param->{'selected_country'} ||= $param->{'default_country'};
1313 $param->{'selected_state'} ||= $param->{'default_state'};
1315 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1319 my %cust_main_county;
1321 # unless ( @cust_main_county ) { #cache
1322 #@cust_main_county = qsearch('cust_main_county', {} );
1323 #foreach my $c ( @cust_main_county ) {
1324 foreach my $c ( @{ $param->{'locales'} } ) {
1325 #$countyflag=1 if $c->county;
1326 $countyflag=1 if $c->{county};
1327 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1328 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1329 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1332 $countyflag=1 if $param->{selected_county};
1334 my $script_html = <<END;
1336 function opt(what,value,text) {
1337 var optionName = new Option(text, value, false, false);
1338 var length = what.length;
1339 what.options[length] = optionName;
1341 function ${prefix}country_changed(what) {
1342 country = what.options[what.selectedIndex].text;
1343 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1344 what.form.${prefix}state.options[i] = null;
1346 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1348 foreach my $country ( sort keys %cust_main_county ) {
1349 $script_html .= "\nif ( country == \"$country\" ) {\n";
1350 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1351 my $text = $state || '(n/a)';
1352 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1354 $script_html .= "}\n";
1357 $script_html .= <<END;
1359 function ${prefix}state_changed(what) {
1362 if ( $countyflag ) {
1363 $script_html .= <<END;
1364 state = what.options[what.selectedIndex].text;
1365 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1366 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1367 what.form.${prefix}county.options[i] = null;
1370 foreach my $country ( sort keys %cust_main_county ) {
1371 $script_html .= "\nif ( country == \"$country\" ) {\n";
1372 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1373 $script_html .= "\nif ( state == \"$state\" ) {\n";
1374 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1375 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1376 my $text = $county || '(n/a)';
1378 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1380 $script_html .= "}\n";
1382 $script_html .= "}\n";
1386 $script_html .= <<END;
1391 my $county_html = $script_html;
1392 if ( $countyflag ) {
1393 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1394 $county_html .= '</SELECT>';
1397 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1400 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1401 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1402 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1403 my $text = $state || '(n/a)';
1404 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1405 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1407 $state_html .= '</SELECT>';
1409 my $country_html = '';
1410 if ( scalar( keys %cust_main_county ) > 1 ) {
1412 $country_html = qq(<SELECT NAME="${prefix}country" ).
1413 qq(onChange="${prefix}country_changed(this); ).
1414 $param->{'onchange'}.
1417 my $countrydefault = $param->{default_country} || 'US';
1418 foreach my $country (
1419 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1420 keys %cust_main_county
1422 my $selected = $country eq $param->{'selected_country'}
1425 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1427 $country_html .= '</SELECT>';
1430 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1431 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1435 ($county_html, $state_html, $country_html);
1439 sub regionselector_hashref {
1440 my ($county_html, $state_html, $country_html) = regionselector(@_);
1442 'county_html' => $county_html,
1443 'state_html' => $state_html,
1444 'country_html' => $country_html,
1448 =item location_form HASHREF | LIST
1450 Takes as input a hashref or list of key/value pairs with the following keys:
1456 Current customer session_id
1460 Omit red asterisks from required fields.
1462 =item address1_label
1464 Label for first address line.
1468 Returns an HTML fragment for a location form (address, city, state, zip,
1481 my $session_id = delete $param->{'session_id'};
1483 my $rv = mason_comp( 'session_id' => $session_id,
1484 'comp' => '/elements/location.html',
1485 'args' => [ %$param ],
1489 $rv->{'error'} || $rv->{'output'};
1494 #=item expselect HASHREF | LIST
1496 #Takes as input a hashref or list of key/value pairs with the following keys:
1500 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1502 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1506 =item expselect PREFIX [ DATE ]
1508 Takes as input a unique prefix string and the current expiration date, in
1509 yyyy-mm-dd or m-d-yyyy format
1511 Returns an HTML fragments for expiration date selection.
1517 #if ( ref($_[0]) ) {
1521 #my $prefix = $param->{'prefix'};
1522 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1523 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1525 my $date = scalar(@_) ? shift : '';
1527 my( $m, $y ) = ( 0, 0 );
1528 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1529 ( $m, $y ) = ( $2, $1 );
1530 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1531 ( $m, $y ) = ( $1, $3 );
1533 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1535 $return .= qq!<OPTION VALUE="$_"!;
1536 $return .= " SELECTED" if $_ == $m;
1539 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1541 my $thisYear = $t[5] + 1900;
1542 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1543 $return .= qq!<OPTION VALUE="$_"!;
1544 $return .= " SELECTED" if $_ == $y;
1547 $return .= "</SELECT>";
1552 =item popselector HASHREF | LIST
1554 Takes as input a hashref or list of key/value pairs with the following keys:
1560 Access number number
1564 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>.
1568 Returns an HTML fragment for access number selection.
1572 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1580 my $popnum = $param->{'popnum'};
1581 my $pops = $param->{'pops'};
1583 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1584 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1585 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1586 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1587 if scalar(@$pops) == 1;
1590 my %popnum2pop = ();
1592 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1593 $popnum2pop{$_->{popnum}} = $_;
1598 function opt(what,href,text) {
1599 var optionName = new Option(text, href, false, false)
1600 var length = what.length;
1601 what.options[length] = optionName;
1605 my $init_popstate = $param->{'init_popstate'};
1606 if ( $init_popstate ) {
1607 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1608 $init_popstate. '">';
1611 function acstate_changed(what) {
1612 state = what.options[what.selectedIndex].text;
1613 what.form.popac.options.length = 0
1614 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1618 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1619 foreach my $state ( sort { $a cmp $b } @states ) {
1620 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1622 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1623 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1624 if ($ac eq $param->{'popac'}) {
1625 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1628 $text .= "}\n" unless $init_popstate;
1630 $text .= "popac_changed(what.form.popac)}\n";
1633 function popac_changed(what) {
1634 ac = what.options[what.selectedIndex].text;
1635 what.form.popnum.options.length = 0;
1636 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1640 foreach my $state ( @states ) {
1641 foreach my $popac ( keys %{ $pop{$state} } ) {
1642 $text .= "\nif ( ac == \"$popac\" ) {\n";
1644 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1645 my $o_popnum = $pop->{popnum};
1646 my $poptext = $pop->{city}. ', '. $pop->{state}.
1647 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1649 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1650 if ($popnum == $o_popnum) {
1651 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1659 $text .= "}\n</SCRIPT>\n";
1662 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1663 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1664 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1665 ">$_" foreach sort { $a cmp $b } @states;
1666 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1669 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1670 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1672 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1675 #comment this block to disable initial list polulation
1676 my @initial_select = ();
1677 if ( scalar( @$pops ) > 100 ) {
1678 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1680 @initial_select = @$pops;
1682 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1683 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1684 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1685 $pop->{city}. ', '. $pop->{state}.
1686 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1689 $text .= qq!</SELECT></TD></TR></TABLE>!;
1695 =item domainselector HASHREF | LIST
1697 Takes as input a hashref or list of key/value pairs with the following keys:
1707 Service number of the selected item.
1711 Returns an HTML fragment for domain selection.
1715 sub domainselector {
1722 my $domsvc= $param->{'domsvc'};
1724 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1725 my $domains = $rv->{'domains'};
1726 $domsvc = $rv->{'domsvc'} unless $domsvc;
1728 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1729 unless scalar(keys %$domains);
1731 if (scalar(keys %$domains) == 1) {
1733 foreach(keys %$domains) {
1736 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1737 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1740 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1743 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1744 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1745 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1746 $domains->{$domain};
1749 $text .= qq!</SELECT></TD></TR>!;
1755 =item didselector HASHREF | LIST
1757 Takes as input a hashref or list of key/value pairs with the following keys:
1763 Field name for the returned HTML fragment.
1767 Service definition (see L<FS::part_svc>)
1771 Returns an HTML fragment for DID selection.
1783 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1784 'args'=>[ %$param ],
1788 $rv->{'error'} || $rv->{'output'};
1794 =head1 RESELLER FUNCTIONS
1796 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1797 with their active session, and the B<customer_info> and B<order_pkg> functions
1798 with their active session and an additional I<custnum> parameter.
1800 For the most part, development of the reseller web interface has been
1801 superceded by agent-virtualized access to the backend.
1813 =item agent_list_customers
1815 List agent's customers.
1823 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>