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 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
64 'new_customer' => 'Signup/new_customer',
65 'capture_payment' => 'Signup/capture_payment',
66 'agent_login' => 'Agent/agent_login',
67 'agent_logout' => 'Agent/agent_logout',
68 'agent_info' => 'Agent/agent_info',
69 'agent_list_customers' => 'Agent/agent_list_customers',
70 'mason_comp' => 'MasonComponent/mason_comp',
71 'call_time' => 'PrepaidPhone/call_time',
72 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
73 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
75 'decompify_pkgs' => 'SGNG/decompify_pkgs',
76 'previous_payment_info' => 'SGNG/previous_payment_info',
77 'previous_payment_info_renew_info'
78 => 'SGNG/previous_payment_info_renew_info',
79 'previous_process_payment' => 'SGNG/previous_process_payment',
80 'previous_process_payment_order_pkg'
81 => 'SGNG/previous_process_payment_order_pkg',
82 'previous_process_payment_change_pkg'
83 => 'SGNG/previous_process_payment_change_pkg',
84 'previous_process_payment_order_renew'
85 => 'SGNG/previous_process_payment_order_renew',
89 qw( regionselector regionselector_hashref location_form
90 expselect popselector domainselector didselector
94 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
95 $ENV{'SHELL'} = '/bin/sh';
96 $ENV{'IFS'} = " \t\n";
99 $ENV{'BASH_ENV'} = '';
101 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
102 #if you grant appropriate permissions to whatever user
103 my $freeside_uid = scalar(getpwnam('freeside'));
104 die "not running as the freeside user\n"
105 if $> != $freeside_uid && ! $skip_uid_check;
107 -e $dir or die "FATAL: $dir doesn't exist!";
108 -d $dir or die "FATAL: $dir isn't a directory!";
109 -r $dir or die "FATAL: Can't read $dir as freeside user!";
110 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
112 foreach my $autoload ( keys %autoload ) {
115 "sub $autoload { ". '
120 #warn scalar(@_). ": ". join(" / ", @_);
124 $param->{_packet} = \''. $autoload{$autoload}. '\';
126 simple_packet($param);
136 warn "sending ". $packet->{_packet}. " to server"
138 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
139 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
140 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
143 #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
145 #block until there is a message on socket
146 # my $w = new IO::Select;
148 # my @wait = $w->can_read;
150 warn "reading message from server"
153 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
154 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
156 warn "returning message to client"
164 FS::SelfService - Freeside self-service API
168 # password and shell account changes
169 use FS::SelfService qw(passwd chfn chsh);
171 # "my account" functionality
172 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
174 my $rv = login( { 'username' => $username,
176 'password' => $password,
180 if ( $rv->{'error'} ) {
181 #handle login error...
184 my $session_id = $rv->{'session_id'};
187 my $customer_info = customer_info( { 'session_id' => $session_id } );
189 #payment_info and process_payment are available in 1.5+ only
190 my $payment_info = payment_info( { 'session_id' => $session_id } );
192 #!!! process_payment example
194 #!!! list_pkgs example
196 #!!! order_pkg example
198 #!!! cancel_pkg example
200 # signup functionality
201 use FS::SelfService qw( signup_info new_customer );
203 my $signup_info = signup_info;
205 $rv = new_customer( {
208 'company' => $company,
209 'address1' => $address1,
210 'address2' => $address2,
214 'country' => $country,
215 'daytime' => $daytime,
219 'payinfo' => $payinfo,
221 'paystart_month' => $paystart_month
222 'paystart_year' => $paystart_year,
223 'payissue' => $payissue,
225 'paydate' => $paydate,
226 'payname' => $payname,
227 'invoicing_list' => $invoicing_list,
228 'referral_custnum' => $referral_custnum,
229 'agentnum' => $agentnum,
230 'pkgpart' => $pkgpart,
232 'username' => $username,
233 '_password' => $password,
237 'phonenum' => $phonenum,
242 my $error = $rv->{'error'};
243 if ( $error eq '_decline' ) {
253 Use this API to implement your own client "self-service" module.
255 If you just want to customize the look of the existing "self-service" module,
258 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
270 =head1 "MY ACCOUNT" FUNCTIONS
276 Creates a user session. Takes a hash reference as parameter with the
295 Returns a hash reference with the following keys:
301 Empty on success, or an error message on errors.
305 Session identifier for successful logins
309 =item customer_info HASHREF
311 Returns general customer information.
313 Takes a hash reference as parameter with a single key: B<session_id>
315 Returns a hash reference with the following keys:
329 Array reference of hash references of open inoices. Each hash reference has
330 the following keys: invnum, date, owed
334 An HTML fragment containing shipping and billing addresses.
336 =item The following fields are also returned
338 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
342 =item edit_info HASHREF
344 Takes a hash reference as parameter with any of the following keys:
346 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
348 If a field exists, the customer record is updated with the new value of that
349 field. If a field does not exist, that field is not changed on the customer
352 Returns a hash reference with a single key, B<error>, empty on success, or an
353 error message on errors
355 =item invoice HASHREF
357 Returns an invoice. Takes a hash reference as parameter with two keys:
358 session_id and invnum
360 Returns a hash reference with the following keys:
366 Empty on success, or an error message on errors
378 =item list_invoices HASHREF
380 Returns a list of all customer invoices. Takes a hash references with a single
383 Returns a hash reference with the following keys:
389 Empty on success, or an error message on errors
393 Reference to array of hash references with the following keys:
403 Invoice date, in UNIX epoch time
411 Cancels this customer.
413 Takes a hash reference as parameter with a single key: B<session_id>
415 Returns a hash reference with a single key, B<error>, which is empty on
416 success or an error message on errors.
418 =item payment_info HASHREF
420 Returns information that may be useful in displaying a payment page.
422 Takes a hash reference as parameter with a single key: B<session_id>.
424 Returns a hash reference with the following keys:
430 Empty on success, or an error message on errors
438 Exact name on credit card (CARD/DCRD)
462 Customer's current default payment type.
466 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
470 For CARD/DCRD payment types, the card number
474 For CARD/DCRD payment types, expiration month
478 For CARD/DCRD payment types, expiration year
480 =item cust_main_county
482 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.
486 Array reference of all states in the current default country.
490 Hash reference of card types; keys are card types, values are the exact strings
491 passed to the process_payment function
495 #this doesn't actually work yet
499 #Unique transaction identifier (prevents multiple charges), passed to the
500 #process_payment function
504 =item process_payment HASHREF
506 Processes a payment and possible change of address or payment type. Takes a
507 hash reference as parameter with the following keys:
521 If true, address and card information entered will be saved for subsequent
526 If true, future credit card payments will be done automatically (sets payby to
527 CARD). If false, future credit card payments will be done on-demand (sets
528 payby to DCRD). This option only has meaning if B<save> is set true.
556 Two-letter country code
564 Card expiration month
572 #this doesn't actually work yet
576 #Unique transaction identifier, returned from the payment_info function.
577 #Prevents multiple charges.
581 Returns a hash reference with a single key, B<error>, empty on success, or an
582 error message on errors.
584 =item process_payment_order_pkg
586 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
587 payment processes sucessfully, the package is ordered. Takes a hash reference
588 as parameter with the keys of both methods.
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_change_pkg
595 Combines the B<process_payment> and B<change_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.
603 =item process_payment_order_renew
605 Combines the B<process_payment> and B<order_renew> functions in one step. If
606 the payment processes sucessfully, the renewal is processed. Takes a hash
607 reference 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.
614 Returns package information for this customer. For more detail on services,
617 Takes a hash reference as parameter with a single key: B<session_id>
619 Returns a hash reference containing customer package information. The hash reference contains the following keys:
629 Empty on success, or an error message on errors.
631 =item cust_pkg HASHREF
633 Array reference of hash references, each of which has the fields of a cust_pkg
634 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
635 the internal FS:: objects, but hash references of columns and values.
639 =item part_pkg fields
641 All fields of part_pkg for this specific cust_pkg (be careful with this
642 information - it may reveal more about your available packages than you would
643 like users to know in aggregate)
647 #XXX pare part_pkg fields down to a more secure subset
651 An array of hash references indicating information on unprovisioned services
652 available for provisioning for this specific cust_pkg. Each has the following
657 =item part_svc fields
659 All fields of part_svc (be careful with this information - it may reveal more
660 about your available packages than you would like users to know in aggregate)
664 #XXX pare part_svc fields down to a more secure subset
670 An array of hash references indicating information on the customer services
671 already provisioned for this specific cust_pkg. Each has the following keys:
677 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.
683 Primary key for this service
687 Service definition (see L<FS::part_svc>)
691 Customer package (see L<FS::cust_pkg>)
695 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
703 Returns service information for this customer.
705 Takes a hash reference as parameter with a single key: B<session_id>
707 Returns a hash reference containing customer package information. The hash reference contains the following keys:
717 An array of hash references indicating information on all of this customer's
718 services. Each has the following keys:
724 Primary key for this service
732 Meaningful user-specific identifier for the service (i.e. username, domain, or
737 Account (svc_acct) services also have the following keys:
755 Upload bytes remaining
759 Download bytes remaining
763 Total bytes remaining
765 =item recharge_amount
769 =item recharge_seconds
771 Number of seconds gained by recharge
773 =item recharge_upbytes
775 Number of upload bytes gained by recharge
777 =item recharge_downbytes
779 Number of download bytes gained by recharge
781 =item recharge_totalbytes
783 Number of total bytes gained by recharge
791 Orders a package for this customer.
793 Takes a hash reference as parameter with the following keys:
803 Package to order (see L<FS::part_pkg>).
807 Service to order (see L<FS::part_svc>).
809 Normally optional; required only to provision a non-svc_acct service, or if the
810 package definition does not contain one svc_acct service definition with
811 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
812 also be specified to indicate that no initial service should be provisioned.
816 Fields used when provisioning an svc_acct service:
830 Optional security phrase
834 Optional Access number number
838 Fields used when provisioning an svc_domain service:
848 Fields used when provisioning an svc_phone service:
866 Fields used when provisioning an svc_external service:
880 Returns a hash reference with a single key, B<error>, empty on success, or an
881 error message on errors. The special error '_decline' is returned for
882 declined transactions.
886 Changes a package for this customer.
888 Takes a hash reference as parameter with the following keys:
898 Existing customer package.
902 New package to order (see L<FS::part_pkg>).
906 Returns a hash reference with a single key, B<error>, empty on success, or an
907 error message on errors.
911 Provides useful info for early renewals.
913 Takes a hash reference as parameter with the following keys:
923 Returns a hash reference. On errors, it contains a single key, B<error>, with
924 the error message. Otherwise, contains a single key, B<dates>, pointing to
925 an array refernce of hash references. Each hash reference contains the
932 (Future) Bill date. Indicates a future date for which billing could be run.
933 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
936 =item bill_date_pretty
938 (Future) Bill date as a human-readable string. (Convenience for display;
939 subject to change, so best not to parse for the date.)
943 Base amount which will be charged if renewed early as of this date.
947 Renewal date; i.e. even-futher future date at which the customer will be paid
948 through if the early renewal is completed with the given B<bill-date>.
949 Specified as a integer UNIX timestamp.
951 =item renew_date_pretty
953 Renewal date as a human-readable string. (Convenience for display;
954 subject to change, so best not to parse for the date.)
958 Package that will be renewed.
962 Expiration date of the package that will be renewed.
964 =item expire_date_pretty
966 Expiration date of the package that will be renewed, as a human-readable
967 string. (Convenience for display; subject to change, so best not to parse for
974 Renews this customer early; i.e. runs billing for this customer in advance.
976 Takes a hash reference as parameter with the following keys:
986 Integer date as returned by the B<renew_info> function, indicating the advance
987 date for which to run billing.
991 Returns a hash reference with a single key, B<error>, empty on success, or an
992 error message on errors.
996 Cancels a package for this customer.
998 Takes a hash reference as parameter with the following keys:
1008 pkgpart of package to cancel
1012 Returns a hash reference with a single key, B<error>, empty on success, or an
1013 error message on errors.
1017 =head1 SIGNUP FUNCTIONS
1021 =item signup_info HASHREF
1023 Takes a hash reference as parameter with the following keys:
1027 =item session_id - Optional agent/reseller interface session
1031 Returns a hash reference containing information that may be useful in
1032 displaying a signup page. The hash reference contains the following keys:
1036 =item cust_main_county
1038 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.
1042 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
1043 an agentnum specified explicitly via reseller interface session_id in the
1048 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.
1050 =item agentnum2part_pkg
1052 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.
1056 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.
1058 =item security_phrase
1060 True if the "security_phrase" feature is enabled
1064 Array reference of acceptable payment types for signup
1070 credit card - automatic
1074 credit card - on-demand - version 1.5+ only
1078 electronic check - automatic
1082 electronic check - on-demand - version 1.5+ only
1090 billing, not recommended for signups
1094 free, definitely not recommended for signups
1098 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1104 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1108 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".
1114 =item countrydefault
1120 =item new_customer HASHREF
1122 Creates a new customer. Takes a hash reference as parameter with the
1129 first name (required)
1133 last name (required)
1137 (not typically collected; mostly used for ACH transactions)
1143 =item address1 (required)
1151 =item city (required)
1159 =item state (required)
1163 =item zip (required)
1169 Daytime phone number
1173 Evening phone number
1181 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1185 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1189 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1193 Expiration date for CARD/DCRD
1197 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1199 =item invoicing_list
1201 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),
1203 =item referral_custnum
1205 referring customer number
1213 pkgpart of initial package
1229 Access number (index, not the literal number)
1233 Country code (to be provisioned as a service)
1237 Phone number (to be provisioned as a service)
1245 Returns a hash reference with the following keys:
1251 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)
1255 =item regionselector HASHREF | LIST
1257 Takes as input a hashref or list of key/value pairs with the following keys:
1261 =item selected_county
1263 Currently selected county
1265 =item selected_state
1267 Currently selected state
1269 =item selected_country
1271 Currently selected country
1275 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1279 Specify a javascript subroutine to call on changes
1285 =item default_country
1291 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>.
1295 Returns a list consisting of three HTML fragments for county selection,
1296 state selection and country selection, respectively.
1300 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1301 sub regionselector {
1308 $param->{'selected_country'} ||= $param->{'default_country'};
1309 $param->{'selected_state'} ||= $param->{'default_state'};
1311 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1315 my %cust_main_county;
1317 # unless ( @cust_main_county ) { #cache
1318 #@cust_main_county = qsearch('cust_main_county', {} );
1319 #foreach my $c ( @cust_main_county ) {
1320 foreach my $c ( @{ $param->{'locales'} } ) {
1321 #$countyflag=1 if $c->county;
1322 $countyflag=1 if $c->{county};
1323 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1324 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1325 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1328 $countyflag=1 if $param->{selected_county};
1330 my $script_html = <<END;
1332 function opt(what,value,text) {
1333 var optionName = new Option(text, value, false, false);
1334 var length = what.length;
1335 what.options[length] = optionName;
1337 function ${prefix}country_changed(what) {
1338 country = what.options[what.selectedIndex].text;
1339 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1340 what.form.${prefix}state.options[i] = null;
1342 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1344 foreach my $country ( sort keys %cust_main_county ) {
1345 $script_html .= "\nif ( country == \"$country\" ) {\n";
1346 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1347 my $text = $state || '(n/a)';
1348 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1350 $script_html .= "}\n";
1353 $script_html .= <<END;
1355 function ${prefix}state_changed(what) {
1358 if ( $countyflag ) {
1359 $script_html .= <<END;
1360 state = what.options[what.selectedIndex].text;
1361 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1362 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1363 what.form.${prefix}county.options[i] = null;
1366 foreach my $country ( sort keys %cust_main_county ) {
1367 $script_html .= "\nif ( country == \"$country\" ) {\n";
1368 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1369 $script_html .= "\nif ( state == \"$state\" ) {\n";
1370 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1371 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1372 my $text = $county || '(n/a)';
1374 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1376 $script_html .= "}\n";
1378 $script_html .= "}\n";
1382 $script_html .= <<END;
1387 my $county_html = $script_html;
1388 if ( $countyflag ) {
1389 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1390 $county_html .= '</SELECT>';
1393 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1396 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1397 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1398 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1399 my $text = $state || '(n/a)';
1400 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1401 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1403 $state_html .= '</SELECT>';
1405 my $country_html = '';
1406 if ( scalar( keys %cust_main_county ) > 1 ) {
1408 $country_html = qq(<SELECT NAME="${prefix}country" ).
1409 qq(onChange="${prefix}country_changed(this); ).
1410 $param->{'onchange'}.
1413 my $countrydefault = $param->{default_country} || 'US';
1414 foreach my $country (
1415 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1416 keys %cust_main_county
1418 my $selected = $country eq $param->{'selected_country'}
1421 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1423 $country_html .= '</SELECT>';
1426 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1427 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1431 ($county_html, $state_html, $country_html);
1435 sub regionselector_hashref {
1436 my ($county_html, $state_html, $country_html) = regionselector(@_);
1438 'county_html' => $county_html,
1439 'state_html' => $state_html,
1440 'country_html' => $country_html,
1444 =item location_form HASHREF | LIST
1446 Takes as input a hashref or list of key/value pairs with the following keys:
1452 Current customer session_id
1456 Omit red asterisks from required fields.
1458 =item address1_label
1460 Label for first address line.
1464 Returns an HTML fragment for a location form (address, city, state, zip,
1477 my $session_id = delete $param->{'session_id'};
1479 my $rv = mason_comp( 'session_id' => $session_id,
1480 'comp' => '/elements/location.html',
1481 'args' => [ %$param ],
1485 $rv->{'error'} || $rv->{'output'};
1490 #=item expselect HASHREF | LIST
1492 #Takes as input a hashref or list of key/value pairs with the following keys:
1496 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1498 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1502 =item expselect PREFIX [ DATE ]
1504 Takes as input a unique prefix string and the current expiration date, in
1505 yyyy-mm-dd or m-d-yyyy format
1507 Returns an HTML fragments for expiration date selection.
1513 #if ( ref($_[0]) ) {
1517 #my $prefix = $param->{'prefix'};
1518 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1519 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1521 my $date = scalar(@_) ? shift : '';
1523 my( $m, $y ) = ( 0, 0 );
1524 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1525 ( $m, $y ) = ( $2, $1 );
1526 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1527 ( $m, $y ) = ( $1, $3 );
1529 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1531 $return .= qq!<OPTION VALUE="$_"!;
1532 $return .= " SELECTED" if $_ == $m;
1535 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1537 my $thisYear = $t[5] + 1900;
1538 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1539 $return .= qq!<OPTION VALUE="$_"!;
1540 $return .= " SELECTED" if $_ == $y;
1543 $return .= "</SELECT>";
1548 =item popselector HASHREF | LIST
1550 Takes as input a hashref or list of key/value pairs with the following keys:
1556 Access number number
1560 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>.
1564 Returns an HTML fragment for access number selection.
1568 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1576 my $popnum = $param->{'popnum'};
1577 my $pops = $param->{'pops'};
1579 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1580 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1581 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1582 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1583 if scalar(@$pops) == 1;
1586 my %popnum2pop = ();
1588 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1589 $popnum2pop{$_->{popnum}} = $_;
1594 function opt(what,href,text) {
1595 var optionName = new Option(text, href, false, false)
1596 var length = what.length;
1597 what.options[length] = optionName;
1601 my $init_popstate = $param->{'init_popstate'};
1602 if ( $init_popstate ) {
1603 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1604 $init_popstate. '">';
1607 function acstate_changed(what) {
1608 state = what.options[what.selectedIndex].text;
1609 what.form.popac.options.length = 0
1610 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1614 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1615 foreach my $state ( sort { $a cmp $b } @states ) {
1616 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1618 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1619 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1620 if ($ac eq $param->{'popac'}) {
1621 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1624 $text .= "}\n" unless $init_popstate;
1626 $text .= "popac_changed(what.form.popac)}\n";
1629 function popac_changed(what) {
1630 ac = what.options[what.selectedIndex].text;
1631 what.form.popnum.options.length = 0;
1632 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1636 foreach my $state ( @states ) {
1637 foreach my $popac ( keys %{ $pop{$state} } ) {
1638 $text .= "\nif ( ac == \"$popac\" ) {\n";
1640 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1641 my $o_popnum = $pop->{popnum};
1642 my $poptext = $pop->{city}. ', '. $pop->{state}.
1643 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1645 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1646 if ($popnum == $o_popnum) {
1647 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1655 $text .= "}\n</SCRIPT>\n";
1658 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1659 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1660 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1661 ">$_" foreach sort { $a cmp $b } @states;
1662 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1665 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1666 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1668 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1671 #comment this block to disable initial list polulation
1672 my @initial_select = ();
1673 if ( scalar( @$pops ) > 100 ) {
1674 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1676 @initial_select = @$pops;
1678 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1679 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1680 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1681 $pop->{city}. ', '. $pop->{state}.
1682 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1685 $text .= qq!</SELECT></TD></TR></TABLE>!;
1691 =item domainselector HASHREF | LIST
1693 Takes as input a hashref or list of key/value pairs with the following keys:
1703 Service number of the selected item.
1707 Returns an HTML fragment for domain selection.
1711 sub domainselector {
1718 my $domsvc= $param->{'domsvc'};
1720 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1721 my $domains = $rv->{'domains'};
1722 $domsvc = $rv->{'domsvc'} unless $domsvc;
1724 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1725 unless scalar(keys %$domains);
1727 if (scalar(keys %$domains) == 1) {
1729 foreach(keys %$domains) {
1732 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1733 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1736 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1739 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1740 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1741 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1742 $domains->{$domain};
1745 $text .= qq!</SELECT></TD></TR>!;
1751 =item didselector HASHREF | LIST
1753 Takes as input a hashref or list of key/value pairs with the following keys:
1759 Field name for the returned HTML fragment.
1763 Service definition (see L<FS::part_svc>)
1767 Returns an HTML fragment for DID selection.
1779 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1780 'args'=>[ %$param ],
1784 $rv->{'error'} || $rv->{'output'};
1790 =head1 RESELLER FUNCTIONS
1792 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1793 with their active session, and the B<customer_info> and B<order_pkg> functions
1794 with their active session and an additional I<custnum> parameter.
1796 For the most part, development of the reseller web interface has been
1797 superceded by agent-virtualized access to the backend.
1809 =item agent_list_customers
1811 List agent's customers.
1819 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>