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 'ping' => 'SGNG/ping',
80 'decompify_pkgs' => 'SGNG/decompify_pkgs',
81 'previous_payment_info' => 'SGNG/previous_payment_info',
82 'previous_payment_info_renew_info'
83 => 'SGNG/previous_payment_info_renew_info',
84 'previous_process_payment' => 'SGNG/previous_process_payment',
85 'previous_process_payment_order_pkg'
86 => 'SGNG/previous_process_payment_order_pkg',
87 'previous_process_payment_change_pkg'
88 => 'SGNG/previous_process_payment_change_pkg',
89 'previous_process_payment_order_renew'
90 => 'SGNG/previous_process_payment_order_renew',
94 qw( regionselector regionselector_hashref location_form
95 expselect popselector domainselector didselector
99 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
100 $ENV{'SHELL'} = '/bin/sh';
101 $ENV{'IFS'} = " \t\n";
104 $ENV{'BASH_ENV'} = '';
106 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
107 #if you grant appropriate permissions to whatever user
108 my $freeside_uid = scalar(getpwnam('freeside'));
109 die "not running as the freeside user\n"
110 if $> != $freeside_uid && ! $skip_uid_check;
112 -e $dir or die "FATAL: $dir doesn't exist!";
113 -d $dir or die "FATAL: $dir isn't a directory!";
114 -r $dir or die "FATAL: Can't read $dir as freeside user!";
115 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
117 foreach my $autoload ( keys %autoload ) {
120 "sub $autoload { ". '
125 #warn scalar(@_). ": ". join(" / ", @_);
129 $param->{_packet} = \''. $autoload{$autoload}. '\';
131 simple_packet($param);
141 warn "sending ". $packet->{_packet}. " to server"
143 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
144 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
145 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
148 #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
150 #block until there is a message on socket
151 # my $w = new IO::Select;
153 # my @wait = $w->can_read;
155 warn "reading message from server"
158 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
159 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
161 warn "returning message to client"
169 FS::SelfService - Freeside self-service API
173 # password and shell account changes
174 use FS::SelfService qw(passwd chfn chsh);
176 # "my account" functionality
177 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
179 my $rv = login( { 'username' => $username,
181 'password' => $password,
185 if ( $rv->{'error'} ) {
186 #handle login error...
189 my $session_id = $rv->{'session_id'};
192 my $customer_info = customer_info( { 'session_id' => $session_id } );
194 #payment_info and process_payment are available in 1.5+ only
195 my $payment_info = payment_info( { 'session_id' => $session_id } );
197 #!!! process_payment example
199 #!!! list_pkgs example
201 #!!! order_pkg example
203 #!!! cancel_pkg example
205 # signup functionality
206 use FS::SelfService qw( signup_info new_customer );
208 my $signup_info = signup_info;
210 $rv = new_customer( {
213 'company' => $company,
214 'address1' => $address1,
215 'address2' => $address2,
219 'country' => $country,
220 'daytime' => $daytime,
224 'payinfo' => $payinfo,
226 'paystart_month' => $paystart_month
227 'paystart_year' => $paystart_year,
228 'payissue' => $payissue,
230 'paydate' => $paydate,
231 'payname' => $payname,
232 'invoicing_list' => $invoicing_list,
233 'referral_custnum' => $referral_custnum,
234 'agentnum' => $agentnum,
235 'pkgpart' => $pkgpart,
237 'username' => $username,
238 '_password' => $password,
242 'phonenum' => $phonenum,
247 my $error = $rv->{'error'};
248 if ( $error eq '_decline' ) {
258 Use this API to implement your own client "self-service" module.
260 If you just want to customize the look of the existing "self-service" module,
263 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
275 =head1 "MY ACCOUNT" FUNCTIONS
281 Creates a user session. Takes a hash reference as parameter with the
300 Returns a hash reference with the following keys:
306 Empty on success, or an error message on errors.
310 Session identifier for successful logins
314 =item customer_info HASHREF
316 Returns general customer information.
318 Takes a hash reference as parameter with a single key: B<session_id>
320 Returns a hash reference with the following keys:
334 Array reference of hash references of open inoices. Each hash reference has
335 the following keys: invnum, date, owed
339 An HTML fragment containing shipping and billing addresses.
341 =item The following fields are also returned
343 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
347 =item edit_info HASHREF
349 Takes a hash reference as parameter with any of the following keys:
351 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
353 If a field exists, the customer record is updated with the new value of that
354 field. If a field does not exist, that field is not changed on the customer
357 Returns a hash reference with a single key, B<error>, empty on success, or an
358 error message on errors
360 =item invoice HASHREF
362 Returns an invoice. Takes a hash reference as parameter with two keys:
363 session_id and invnum
365 Returns a hash reference with the following keys:
371 Empty on success, or an error message on errors
383 =item list_invoices HASHREF
385 Returns a list of all customer invoices. Takes a hash references with a single
388 Returns a hash reference with the following keys:
394 Empty on success, or an error message on errors
398 Reference to array of hash references with the following keys:
408 Invoice date, in UNIX epoch time
416 Cancels this customer.
418 Takes a hash reference as parameter with a single key: B<session_id>
420 Returns a hash reference with a single key, B<error>, which is empty on
421 success or an error message on errors.
423 =item payment_info HASHREF
425 Returns information that may be useful in displaying a payment page.
427 Takes a hash reference as parameter with a single key: B<session_id>.
429 Returns a hash reference with the following keys:
435 Empty on success, or an error message on errors
443 Exact name on credit card (CARD/DCRD)
467 Customer's current default payment type.
471 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
475 For CARD/DCRD payment types, the card number
479 For CARD/DCRD payment types, expiration month
483 For CARD/DCRD payment types, expiration year
485 =item cust_main_county
487 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.
491 Array reference of all states in the current default country.
495 Hash reference of card types; keys are card types, values are the exact strings
496 passed to the process_payment function
500 #this doesn't actually work yet
504 #Unique transaction identifier (prevents multiple charges), passed to the
505 #process_payment function
509 =item process_payment HASHREF
511 Processes a payment and possible change of address or payment type. Takes a
512 hash reference as parameter with the following keys:
526 If true, address and card information entered will be saved for subsequent
531 If true, future credit card payments will be done automatically (sets payby to
532 CARD). If false, future credit card payments will be done on-demand (sets
533 payby to DCRD). This option only has meaning if B<save> is set true.
561 Two-letter country code
569 Card expiration month
577 #this doesn't actually work yet
581 #Unique transaction identifier, returned from the payment_info function.
582 #Prevents multiple charges.
586 Returns a hash reference with a single key, B<error>, empty on success, or an
587 error message on errors.
589 =item process_payment_order_pkg
591 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
592 payment processes sucessfully, the package is ordered. Takes a hash reference
593 as parameter with the keys of both methods.
595 Returns a hash reference with a single key, B<error>, empty on success, or an
596 error message on errors.
598 =item process_payment_change_pkg
600 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
601 payment processes sucessfully, the package is ordered. Takes a hash reference
602 as parameter with the keys of both methods.
604 Returns a hash reference with a single key, B<error>, empty on success, or an
605 error message on errors.
608 =item process_payment_order_renew
610 Combines the B<process_payment> and B<order_renew> functions in one step. If
611 the payment processes sucessfully, the renewal is processed. Takes a hash
612 reference as parameter with the keys of both methods.
614 Returns a hash reference with a single key, B<error>, empty on success, or an
615 error message on errors.
619 Returns package information for this customer. For more detail on services,
622 Takes a hash reference as parameter with a single key: B<session_id>
624 Returns a hash reference containing customer package information. The hash reference contains the following keys:
634 Empty on success, or an error message on errors.
636 =item cust_pkg HASHREF
638 Array reference of hash references, each of which has the fields of a cust_pkg
639 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
640 the internal FS:: objects, but hash references of columns and values.
644 =item part_pkg fields
646 All fields of part_pkg for this specific cust_pkg (be careful with this
647 information - it may reveal more about your available packages than you would
648 like users to know in aggregate)
652 #XXX pare part_pkg fields down to a more secure subset
656 An array of hash references indicating information on unprovisioned services
657 available for provisioning for this specific cust_pkg. Each has the following
662 =item part_svc fields
664 All fields of part_svc (be careful with this information - it may reveal more
665 about your available packages than you would like users to know in aggregate)
669 #XXX pare part_svc fields down to a more secure subset
675 An array of hash references indicating information on the customer services
676 already provisioned for this specific cust_pkg. Each has the following keys:
682 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.
688 Primary key for this service
692 Service definition (see L<FS::part_svc>)
696 Customer package (see L<FS::cust_pkg>)
700 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
708 Returns service information for this customer.
710 Takes a hash reference as parameter with a single key: B<session_id>
712 Returns a hash reference containing customer package information. The hash reference contains the following keys:
722 An array of hash references indicating information on all of this customer's
723 services. Each has the following keys:
729 Primary key for this service
737 Meaningful user-specific identifier for the service (i.e. username, domain, or
742 Account (svc_acct) services also have the following keys:
760 Upload bytes remaining
764 Download bytes remaining
768 Total bytes remaining
770 =item recharge_amount
774 =item recharge_seconds
776 Number of seconds gained by recharge
778 =item recharge_upbytes
780 Number of upload bytes gained by recharge
782 =item recharge_downbytes
784 Number of download bytes gained by recharge
786 =item recharge_totalbytes
788 Number of total bytes gained by recharge
796 Orders a package for this customer.
798 Takes a hash reference as parameter with the following keys:
808 Package to order (see L<FS::part_pkg>).
812 Service to order (see L<FS::part_svc>).
814 Normally optional; required only to provision a non-svc_acct service, or if the
815 package definition does not contain one svc_acct service definition with
816 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
817 also be specified to indicate that no initial service should be provisioned.
821 Fields used when provisioning an svc_acct service:
835 Optional security phrase
839 Optional Access number number
843 Fields used when provisioning an svc_domain service:
853 Fields used when provisioning an svc_phone service:
871 Fields used when provisioning an svc_external service:
885 Returns a hash reference with a single key, B<error>, empty on success, or an
886 error message on errors. The special error '_decline' is returned for
887 declined transactions.
891 Changes a package for this customer.
893 Takes a hash reference as parameter with the following keys:
903 Existing customer package.
907 New package to order (see L<FS::part_pkg>).
911 Returns a hash reference with a single key, B<error>, empty on success, or an
912 error message on errors.
916 Provides useful info for early renewals.
918 Takes a hash reference as parameter with the following keys:
928 Returns a hash reference. On errors, it contains a single key, B<error>, with
929 the error message. Otherwise, contains a single key, B<dates>, pointing to
930 an array refernce of hash references. Each hash reference contains the
937 (Future) Bill date. Indicates a future date for which billing could be run.
938 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
941 =item bill_date_pretty
943 (Future) Bill date as a human-readable string. (Convenience for display;
944 subject to change, so best not to parse for the date.)
948 Base amount which will be charged if renewed early as of this date.
952 Renewal date; i.e. even-futher future date at which the customer will be paid
953 through if the early renewal is completed with the given B<bill-date>.
954 Specified as a integer UNIX timestamp.
956 =item renew_date_pretty
958 Renewal date as a human-readable string. (Convenience for display;
959 subject to change, so best not to parse for the date.)
963 Package that will be renewed.
967 Expiration date of the package that will be renewed.
969 =item expire_date_pretty
971 Expiration date of the package that will be renewed, as a human-readable
972 string. (Convenience for display; subject to change, so best not to parse for
979 Renews this customer early; i.e. runs billing for this customer in advance.
981 Takes a hash reference as parameter with the following keys:
991 Integer date as returned by the B<renew_info> function, indicating the advance
992 date for which to run billing.
996 Returns a hash reference with a single key, B<error>, empty on success, or an
997 error message on errors.
1001 Cancels a package for this customer.
1003 Takes a hash reference as parameter with the following keys:
1013 pkgpart of package to cancel
1017 Returns a hash reference with a single key, B<error>, empty on success, or an
1018 error message on errors.
1022 =head1 SIGNUP FUNCTIONS
1026 =item signup_info HASHREF
1028 Takes a hash reference as parameter with the following keys:
1032 =item session_id - Optional agent/reseller interface session
1036 Returns a hash reference containing information that may be useful in
1037 displaying a signup page. The hash reference contains the following keys:
1041 =item cust_main_county
1043 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.
1047 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
1048 an agentnum specified explicitly via reseller interface session_id in the
1053 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.
1055 =item agentnum2part_pkg
1057 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.
1061 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.
1063 =item security_phrase
1065 True if the "security_phrase" feature is enabled
1069 Array reference of acceptable payment types for signup
1075 credit card - automatic
1079 credit card - on-demand - version 1.5+ only
1083 electronic check - automatic
1087 electronic check - on-demand - version 1.5+ only
1095 billing, not recommended for signups
1099 free, definitely not recommended for signups
1103 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1109 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1113 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".
1119 =item countrydefault
1125 =item new_customer HASHREF
1127 Creates a new customer. Takes a hash reference as parameter with the
1134 first name (required)
1138 last name (required)
1142 (not typically collected; mostly used for ACH transactions)
1148 =item address1 (required)
1156 =item city (required)
1164 =item state (required)
1168 =item zip (required)
1174 Daytime phone number
1178 Evening phone number
1186 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1190 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1194 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1198 Expiration date for CARD/DCRD
1202 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1204 =item invoicing_list
1206 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),
1208 =item referral_custnum
1210 referring customer number
1218 pkgpart of initial package
1234 Access number (index, not the literal number)
1238 Country code (to be provisioned as a service)
1242 Phone number (to be provisioned as a service)
1250 Returns a hash reference with the following keys:
1256 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)
1260 =item regionselector HASHREF | LIST
1262 Takes as input a hashref or list of key/value pairs with the following keys:
1266 =item selected_county
1268 Currently selected county
1270 =item selected_state
1272 Currently selected state
1274 =item selected_country
1276 Currently selected country
1280 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1284 Specify a javascript subroutine to call on changes
1290 =item default_country
1296 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>.
1300 Returns a list consisting of three HTML fragments for county selection,
1301 state selection and country selection, respectively.
1305 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1306 sub regionselector {
1313 $param->{'selected_country'} ||= $param->{'default_country'};
1314 $param->{'selected_state'} ||= $param->{'default_state'};
1316 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1320 my %cust_main_county;
1322 # unless ( @cust_main_county ) { #cache
1323 #@cust_main_county = qsearch('cust_main_county', {} );
1324 #foreach my $c ( @cust_main_county ) {
1325 foreach my $c ( @{ $param->{'locales'} } ) {
1326 #$countyflag=1 if $c->county;
1327 $countyflag=1 if $c->{county};
1328 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1329 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1330 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1333 $countyflag=1 if $param->{selected_county};
1335 my $script_html = <<END;
1337 function opt(what,value,text) {
1338 var optionName = new Option(text, value, false, false);
1339 var length = what.length;
1340 what.options[length] = optionName;
1342 function ${prefix}country_changed(what) {
1343 country = what.options[what.selectedIndex].text;
1344 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1345 what.form.${prefix}state.options[i] = null;
1347 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1349 foreach my $country ( sort keys %cust_main_county ) {
1350 $script_html .= "\nif ( country == \"$country\" ) {\n";
1351 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1352 my $text = $state || '(n/a)';
1353 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1355 $script_html .= "}\n";
1358 $script_html .= <<END;
1360 function ${prefix}state_changed(what) {
1363 if ( $countyflag ) {
1364 $script_html .= <<END;
1365 state = what.options[what.selectedIndex].text;
1366 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1367 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1368 what.form.${prefix}county.options[i] = null;
1371 foreach my $country ( sort keys %cust_main_county ) {
1372 $script_html .= "\nif ( country == \"$country\" ) {\n";
1373 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1374 $script_html .= "\nif ( state == \"$state\" ) {\n";
1375 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1376 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1377 my $text = $county || '(n/a)';
1379 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1381 $script_html .= "}\n";
1383 $script_html .= "}\n";
1387 $script_html .= <<END;
1392 my $county_html = $script_html;
1393 if ( $countyflag ) {
1394 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1395 $county_html .= '</SELECT>';
1398 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1401 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1402 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1403 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1404 my $text = $state || '(n/a)';
1405 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1406 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1408 $state_html .= '</SELECT>';
1410 my $country_html = '';
1411 if ( scalar( keys %cust_main_county ) > 1 ) {
1413 $country_html = qq(<SELECT NAME="${prefix}country" ).
1414 qq(onChange="${prefix}country_changed(this); ).
1415 $param->{'onchange'}.
1418 my $countrydefault = $param->{default_country} || 'US';
1419 foreach my $country (
1420 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1421 keys %cust_main_county
1423 my $selected = $country eq $param->{'selected_country'}
1426 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1428 $country_html .= '</SELECT>';
1431 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1432 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1436 ($county_html, $state_html, $country_html);
1440 sub regionselector_hashref {
1441 my ($county_html, $state_html, $country_html) = regionselector(@_);
1443 'county_html' => $county_html,
1444 'state_html' => $state_html,
1445 'country_html' => $country_html,
1449 =item location_form HASHREF | LIST
1451 Takes as input a hashref or list of key/value pairs with the following keys:
1457 Current customer session_id
1461 Omit red asterisks from required fields.
1463 =item address1_label
1465 Label for first address line.
1469 Returns an HTML fragment for a location form (address, city, state, zip,
1482 my $session_id = delete $param->{'session_id'};
1484 my $rv = mason_comp( 'session_id' => $session_id,
1485 'comp' => '/elements/location.html',
1486 'args' => [ %$param ],
1490 $rv->{'error'} || $rv->{'output'};
1495 #=item expselect HASHREF | LIST
1497 #Takes as input a hashref or list of key/value pairs with the following keys:
1501 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1503 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1507 =item expselect PREFIX [ DATE ]
1509 Takes as input a unique prefix string and the current expiration date, in
1510 yyyy-mm-dd or m-d-yyyy format
1512 Returns an HTML fragments for expiration date selection.
1518 #if ( ref($_[0]) ) {
1522 #my $prefix = $param->{'prefix'};
1523 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1524 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1526 my $date = scalar(@_) ? shift : '';
1528 my( $m, $y ) = ( 0, 0 );
1529 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1530 ( $m, $y ) = ( $2, $1 );
1531 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1532 ( $m, $y ) = ( $1, $3 );
1534 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1536 $return .= qq!<OPTION VALUE="$_"!;
1537 $return .= " SELECTED" if $_ == $m;
1540 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1542 my $thisYear = $t[5] + 1900;
1543 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1544 $return .= qq!<OPTION VALUE="$_"!;
1545 $return .= " SELECTED" if $_ == $y;
1548 $return .= "</SELECT>";
1553 =item popselector HASHREF | LIST
1555 Takes as input a hashref or list of key/value pairs with the following keys:
1561 Access number number
1565 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>.
1569 Returns an HTML fragment for access number selection.
1573 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1581 my $popnum = $param->{'popnum'};
1582 my $pops = $param->{'pops'};
1584 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1585 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1586 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1587 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1588 if scalar(@$pops) == 1;
1591 my %popnum2pop = ();
1593 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1594 $popnum2pop{$_->{popnum}} = $_;
1599 function opt(what,href,text) {
1600 var optionName = new Option(text, href, false, false)
1601 var length = what.length;
1602 what.options[length] = optionName;
1606 my $init_popstate = $param->{'init_popstate'};
1607 if ( $init_popstate ) {
1608 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1609 $init_popstate. '">';
1612 function acstate_changed(what) {
1613 state = what.options[what.selectedIndex].text;
1614 what.form.popac.options.length = 0
1615 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1619 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1620 foreach my $state ( sort { $a cmp $b } @states ) {
1621 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1623 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1624 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1625 if ($ac eq $param->{'popac'}) {
1626 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1629 $text .= "}\n" unless $init_popstate;
1631 $text .= "popac_changed(what.form.popac)}\n";
1634 function popac_changed(what) {
1635 ac = what.options[what.selectedIndex].text;
1636 what.form.popnum.options.length = 0;
1637 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1641 foreach my $state ( @states ) {
1642 foreach my $popac ( keys %{ $pop{$state} } ) {
1643 $text .= "\nif ( ac == \"$popac\" ) {\n";
1645 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1646 my $o_popnum = $pop->{popnum};
1647 my $poptext = $pop->{city}. ', '. $pop->{state}.
1648 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1650 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1651 if ($popnum == $o_popnum) {
1652 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1660 $text .= "}\n</SCRIPT>\n";
1662 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1665 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1666 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1667 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1668 ">$_" foreach sort { $a cmp $b } @states;
1669 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1672 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1673 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1675 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1678 #comment this block to disable initial list polulation
1679 my @initial_select = ();
1680 if ( scalar( @$pops ) > 100 ) {
1681 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1683 @initial_select = @$pops;
1685 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1686 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1687 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1688 $pop->{city}. ', '. $pop->{state}.
1689 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1692 $text .= qq!</SELECT></TD></TR></TABLE>!;
1698 =item domainselector HASHREF | LIST
1700 Takes as input a hashref or list of key/value pairs with the following keys:
1710 Service number of the selected item.
1714 Returns an HTML fragment for domain selection.
1718 sub domainselector {
1725 my $domsvc= $param->{'domsvc'};
1727 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1728 my $domains = $rv->{'domains'};
1729 $domsvc = $rv->{'domsvc'} unless $domsvc;
1731 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1732 unless scalar(keys %$domains);
1734 if (scalar(keys %$domains) == 1) {
1736 foreach(keys %$domains) {
1739 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1740 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1743 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1746 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1747 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1748 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1749 $domains->{$domain};
1752 $text .= qq!</SELECT></TD></TR>!;
1758 =item didselector HASHREF | LIST
1760 Takes as input a hashref or list of key/value pairs with the following keys:
1766 Field name for the returned HTML fragment.
1770 Service definition (see L<FS::part_svc>)
1774 Returns an HTML fragment for DID selection.
1786 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1787 'args'=>[ %$param ],
1791 $rv->{'error'} || $rv->{'output'};
1797 =head1 RESELLER FUNCTIONS
1799 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1800 with their active session, and the B<customer_info> and B<order_pkg> functions
1801 with their active session and an additional I<custnum> parameter.
1803 For the most part, development of the reseller web interface has been
1804 superceded by agent-virtualized access to the backend.
1816 =item agent_list_customers
1818 List agent's customers.
1826 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>