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 'process_payment' => 'MyAccount/process_payment',
39 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
40 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
41 'process_prepay' => 'MyAccount/process_prepay',
42 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
43 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
44 'list_svc_usage' => 'MyAccount/list_svc_usage',
45 'list_support_usage' => 'MyAccount/list_support_usage',
46 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
47 'change_pkg' => 'MyAccount/change_pkg',
48 'order_recharge' => 'MyAccount/order_recharge',
49 'renew_info' => 'MyAccount/renew_info',
50 'order_renew' => 'MyAccount/order_renew',
51 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
52 'charge' => 'MyAccount/charge', #?
53 'part_svc_info' => 'MyAccount/part_svc_info',
54 'provision_acct' => 'MyAccount/provision_acct',
55 'provision_external' => 'MyAccount/provision_external',
56 'unprovision_svc' => 'MyAccount/unprovision_svc',
57 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
58 'signup_info' => 'Signup/signup_info',
59 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
60 'new_customer' => 'Signup/new_customer',
61 'agent_login' => 'Agent/agent_login',
62 'agent_logout' => 'Agent/agent_logout',
63 'agent_info' => 'Agent/agent_info',
64 'agent_list_customers' => 'Agent/agent_list_customers',
65 'mason_comp' => 'MasonComponent/mason_comp',
66 'call_time' => 'PrepaidPhone/call_time',
67 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
68 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
72 qw( regionselector regionselector_hashref
73 expselect popselector domainselector didselector )
76 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
77 $ENV{'SHELL'} = '/bin/sh';
78 $ENV{'IFS'} = " \t\n";
81 $ENV{'BASH_ENV'} = '';
83 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
84 #if you grant appropriate permissions to whatever user
85 my $freeside_uid = scalar(getpwnam('freeside'));
86 die "not running as the freeside user\n"
87 if $> != $freeside_uid && ! $skip_uid_check;
89 -e $dir or die "FATAL: $dir doesn't exist!";
90 -d $dir or die "FATAL: $dir isn't a directory!";
91 -r $dir or die "FATAL: Can't read $dir as freeside user!";
92 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
94 foreach my $autoload ( keys %autoload ) {
102 #warn scalar(@_). ": ". join(" / ", @_);
106 $param->{_packet} = \''. $autoload{$autoload}. '\';
108 simple_packet($param);
118 warn "sending ". $packet->{_packet}. " to server"
120 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
121 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
122 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
125 #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
127 #block until there is a message on socket
128 # my $w = new IO::Select;
130 # my @wait = $w->can_read;
132 warn "reading message from server"
135 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
136 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
138 warn "returning message to client"
146 FS::SelfService - Freeside self-service API
150 # password and shell account changes
151 use FS::SelfService qw(passwd chfn chsh);
153 # "my account" functionality
154 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
156 my $rv = login( { 'username' => $username,
158 'password' => $password,
162 if ( $rv->{'error'} ) {
163 #handle login error...
166 my $session_id = $rv->{'session_id'};
169 my $customer_info = customer_info( { 'session_id' => $session_id } );
171 #payment_info and process_payment are available in 1.5+ only
172 my $payment_info = payment_info( { 'session_id' => $session_id } );
174 #!!! process_payment example
176 #!!! list_pkgs example
178 #!!! order_pkg example
180 #!!! cancel_pkg example
182 # signup functionality
183 use FS::SelfService qw( signup_info new_customer );
185 my $signup_info = signup_info;
187 $rv = new_customer( {
190 'company' => $company,
191 'address1' => $address1,
192 'address2' => $address2,
196 'country' => $country,
197 'daytime' => $daytime,
201 'payinfo' => $payinfo,
203 'paystart_month' => $paystart_month
204 'paystart_year' => $paystart_year,
205 'payissue' => $payissue,
207 'paydate' => $paydate,
208 'payname' => $payname,
209 'invoicing_list' => $invoicing_list,
210 'referral_custnum' => $referral_custnum,
211 'agentnum' => $agentnum,
212 'pkgpart' => $pkgpart,
214 'username' => $username,
215 '_password' => $password,
219 'phonenum' => $phonenum,
224 my $error = $rv->{'error'};
225 if ( $error eq '_decline' ) {
235 Use this API to implement your own client "self-service" module.
237 If you just want to customize the look of the existing "self-service" module,
240 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
252 =head1 "MY ACCOUNT" FUNCTIONS
258 Creates a user session. Takes a hash reference as parameter with the
277 Returns a hash reference with the following keys:
283 Empty on success, or an error message on errors.
287 Session identifier for successful logins
291 =item customer_info HASHREF
293 Returns general customer information.
295 Takes a hash reference as parameter with a single key: B<session_id>
297 Returns a hash reference with the following keys:
311 Array reference of hash references of open inoices. Each hash reference has
312 the following keys: invnum, date, owed
316 An HTML fragment containing shipping and billing addresses.
318 =item The following fields are also returned
320 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
324 =item edit_info HASHREF
326 Takes a hash reference as parameter with any of the following keys:
328 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
330 If a field exists, the customer record is updated with the new value of that
331 field. If a field does not exist, that field is not changed on the customer
334 Returns a hash reference with a single key, B<error>, empty on success, or an
335 error message on errors
337 =item invoice HASHREF
339 Returns an invoice. Takes a hash reference as parameter with two keys:
340 session_id and invnum
342 Returns a hash reference with the following keys:
348 Empty on success, or an error message on errors
360 =item list_invoices HASHREF
362 Returns a list of all customer invoices. Takes a hash references with a single
365 Returns a hash reference with the following keys:
371 Empty on success, or an error message on errors
375 Reference to array of hash references with the following keys:
385 Invoice date, in UNIX epoch time
393 Cancels this customer.
395 Takes a hash reference as parameter with a single key: B<session_id>
397 Returns a hash reference with a single key, B<error>, which is empty on
398 success or an error message on errors.
400 =item payment_info HASHREF
402 Returns information that may be useful in displaying a payment page.
404 Takes a hash reference as parameter with a single key: B<session_id>.
406 Returns a hash reference with the following keys:
412 Empty on success, or an error message on errors
420 Exact name on credit card (CARD/DCRD)
444 Customer's current default payment type.
448 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
452 For CARD/DCRD payment types, the card number
456 For CARD/DCRD payment types, expiration month
460 For CARD/DCRD payment types, expiration year
462 =item cust_main_county
464 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.
468 Array reference of all states in the current default country.
472 Hash reference of card types; keys are card types, values are the exact strings
473 passed to the process_payment function
477 #this doesn't actually work yet
481 #Unique transaction identifier (prevents multiple charges), passed to the
482 #process_payment function
486 =item process_payment HASHREF
488 Processes a payment and possible change of address or payment type. Takes a
489 hash reference as parameter with the following keys:
503 If true, address and card information entered will be saved for subsequent
508 If true, future credit card payments will be done automatically (sets payby to
509 CARD). If false, future credit card payments will be done on-demand (sets
510 payby to DCRD). This option only has meaning if B<save> is set true.
542 Card expiration month
550 #this doesn't actually work yet
554 #Unique transaction identifier, returned from the payment_info function.
555 #Prevents multiple charges.
559 Returns a hash reference with a single key, B<error>, empty on success, or an
560 error message on errors.
562 =item process_payment_order_pkg
564 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
565 payment processes sucessfully, the package is ordered. Takes a hash reference
566 as parameter with the keys of both methods.
568 Returns a hash reference with a single key, B<error>, empty on success, or an
569 error message on errors.
571 =item process_payment_order_renew
573 Combines the B<process_payment> and B<order_renew> functions in one step. If
574 the payment processes sucessfully, the renewal is processed. Takes a hash
575 reference as parameter with the keys of both methods.
577 Returns a hash reference with a single key, B<error>, empty on success, or an
578 error message on errors.
582 Returns package information for this customer. For more detail on services,
585 Takes a hash reference as parameter with a single key: B<session_id>
587 Returns a hash reference containing customer package information. The hash reference contains the following keys:
597 Empty on success, or an error message on errors.
599 =item cust_pkg HASHREF
601 Array reference of hash references, each of which has the fields of a cust_pkg
602 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
603 the internal FS:: objects, but hash references of columns and values.
607 =item part_pkg fields
609 All fields of part_pkg for this specific cust_pkg (be careful with this
610 information - it may reveal more about your available packages than you would
611 like users to know in aggregate)
615 #XXX pare part_pkg fields down to a more secure subset
619 An array of hash references indicating information on unprovisioned services
620 available for provisioning for this specific cust_pkg. Each has the following
625 =item part_svc fields
627 All fields of part_svc (be careful with this information - it may reveal more
628 about your available packages than you would like users to know in aggregate)
632 #XXX pare part_svc fields down to a more secure subset
638 An array of hash references indicating information on the customer services
639 already provisioned for this specific cust_pkg. Each has the following keys:
645 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.
651 Primary key for this service
655 Service definition (see L<FS::part_svc>)
659 Customer package (see L<FS::cust_pkg>)
663 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
671 Returns service information for this customer.
673 Takes a hash reference as parameter with a single key: B<session_id>
675 Returns a hash reference containing customer package information. The hash reference contains the following keys:
685 An array of hash references indicating information on all of this customer's
686 services. Each has the following keys:
692 Primary key for this service
700 Meaningful user-specific identifier for the service (i.e. username, domain, or
705 Account (svc_acct) services also have the following keys:
723 Upload bytes remaining
727 Download bytes remaining
731 Total bytes remaining
733 =item recharge_amount
737 =item recharge_seconds
739 Number of seconds gained by recharge
741 =item recharge_upbytes
743 Number of upload bytes gained by recharge
745 =item recharge_downbytes
747 Number of download bytes gained by recharge
749 =item recharge_totalbytes
751 Number of total bytes gained by recharge
759 Orders a package for this customer.
761 Takes a hash reference as parameter with the following keys:
771 Package to order (see L<FS::part_pkg>).
775 Service to order (see L<FS::part_svc>).
777 Normally optional; required only to provision a non-svc_acct service, or if the
778 package definition does not contain one svc_acct service definition with
779 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
780 also be specified to indicate that no initial service should be provisioned.
784 Fields used when provisioning an svc_acct service:
798 Optional security phrase
802 Optional Access number number
806 Fields used when provisioning an svc_domain service:
816 Fields used when provisioning an svc_phone service:
834 Fields used when provisioning an svc_external service:
848 Returns a hash reference with a single key, B<error>, empty on success, or an
849 error message on errors. The special error '_decline' is returned for
850 declined transactions.
854 Provides useful info for early renewals.
856 Takes a hash reference as parameter with the following keys:
866 Returns a hash reference. On errors, it contains a single key, B<error>, with
867 the error message. Otherwise, contains a single key, B<dates>, pointing to
868 an array refernce of hash references. Each hash reference contains the
875 (Future) Bill date. Indicates a future date for which billing could be run.
876 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
879 =item bill_date_pretty
881 (Future) Bill date as a human-readable string. (Convenience for display;
882 subject to change, so best not to parse for the date.)
886 Base amount which will be charged if renewed early as of this date.
890 Renewal date; i.e. even-futher future date at which the customer will be paid
891 through if the early renewal is completed with the given B<bill-date>.
892 Specified as a integer UNIX timestamp.
894 =item renew_date_pretty
896 Renewal date as a human-readable string. (Convenience for display;
897 subject to change, so best not to parse for the date.)
903 Renews this customer early; i.e. runs billing for this customer in advance.
905 Takes a hash reference as parameter with the following keys:
915 Integer date as returned by the B<renew_info> function, indicating the advance
916 date for which to run billing.
920 Returns a hash reference with a single key, B<error>, empty on success, or an
921 error message on errors.
925 Cancels a package for this customer.
927 Takes a hash reference as parameter with the following keys:
937 pkgpart of package to cancel
941 Returns a hash reference with a single key, B<error>, empty on success, or an
942 error message on errors.
946 =head1 SIGNUP FUNCTIONS
950 =item signup_info HASHREF
952 Takes a hash reference as parameter with the following keys:
956 =item session_id - Optional agent/reseller interface session
960 Returns a hash reference containing information that may be useful in
961 displaying a signup page. The hash reference contains the following keys:
965 =item cust_main_county
967 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.
971 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
972 an agentnum specified explicitly via reseller interface session_id in the
977 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.
979 =item agentnum2part_pkg
981 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.
985 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.
987 =item security_phrase
989 True if the "security_phrase" feature is enabled
993 Array reference of acceptable payment types for signup
999 credit card - automatic
1003 credit card - on-demand - version 1.5+ only
1007 electronic check - automatic
1011 electronic check - on-demand - version 1.5+ only
1019 billing, not recommended for signups
1023 free, definitely not recommended for signups
1027 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1033 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1037 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".
1043 =item countrydefault
1049 =item new_customer HASHREF
1051 Creates a new customer. Takes a hash reference as parameter with the
1058 first name (required)
1062 last name (required)
1066 (not typically collected; mostly used for ACH transactions)
1072 =item address1 (required)
1080 =item city (required)
1088 =item state (required)
1092 =item zip (required)
1098 Daytime phone number
1102 Evening phone number
1110 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1114 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1118 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1122 Expiration date for CARD/DCRD
1126 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1128 =item invoicing_list
1130 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),
1132 =item referral_custnum
1134 referring customer number
1142 pkgpart of initial package
1158 Access number (index, not the literal number)
1162 Country code (to be provisioned as a service)
1166 Phone number (to be provisioned as a service)
1174 Returns a hash reference with the following keys:
1180 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)
1184 =item regionselector HASHREF | LIST
1186 Takes as input a hashref or list of key/value pairs with the following keys:
1190 =item selected_county
1192 Currently selected county
1194 =item selected_state
1196 Currently selected state
1198 =item selected_country
1200 Currently selected country
1204 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1208 Specify a javascript subroutine to call on changes
1214 =item default_country
1220 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>.
1224 Returns a list consisting of three HTML fragments for county selection,
1225 state selection and country selection, respectively.
1229 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1230 sub regionselector {
1237 $param->{'selected_country'} ||= $param->{'default_country'};
1238 $param->{'selected_state'} ||= $param->{'default_state'};
1240 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1244 my %cust_main_county;
1246 # unless ( @cust_main_county ) { #cache
1247 #@cust_main_county = qsearch('cust_main_county', {} );
1248 #foreach my $c ( @cust_main_county ) {
1249 foreach my $c ( @{ $param->{'locales'} } ) {
1250 #$countyflag=1 if $c->county;
1251 $countyflag=1 if $c->{county};
1252 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1253 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1254 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1257 $countyflag=1 if $param->{selected_county};
1259 my $script_html = <<END;
1261 function opt(what,value,text) {
1262 var optionName = new Option(text, value, false, false);
1263 var length = what.length;
1264 what.options[length] = optionName;
1266 function ${prefix}country_changed(what) {
1267 country = what.options[what.selectedIndex].text;
1268 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1269 what.form.${prefix}state.options[i] = null;
1271 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1273 foreach my $country ( sort keys %cust_main_county ) {
1274 $script_html .= "\nif ( country == \"$country\" ) {\n";
1275 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1276 my $text = $state || '(n/a)';
1277 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1279 $script_html .= "}\n";
1282 $script_html .= <<END;
1284 function ${prefix}state_changed(what) {
1287 if ( $countyflag ) {
1288 $script_html .= <<END;
1289 state = what.options[what.selectedIndex].text;
1290 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1291 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1292 what.form.${prefix}county.options[i] = null;
1295 foreach my $country ( sort keys %cust_main_county ) {
1296 $script_html .= "\nif ( country == \"$country\" ) {\n";
1297 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1298 $script_html .= "\nif ( state == \"$state\" ) {\n";
1299 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1300 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1301 my $text = $county || '(n/a)';
1303 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1305 $script_html .= "}\n";
1307 $script_html .= "}\n";
1311 $script_html .= <<END;
1316 my $county_html = $script_html;
1317 if ( $countyflag ) {
1318 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1319 $county_html .= '</SELECT>';
1322 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1325 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1326 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1327 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1328 my $text = $state || '(n/a)';
1329 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1330 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1332 $state_html .= '</SELECT>';
1334 my $country_html = '';
1335 if ( scalar( keys %cust_main_county ) > 1 ) {
1337 $country_html = qq(<SELECT NAME="${prefix}country" ).
1338 qq(onChange="${prefix}country_changed(this); ).
1339 $param->{'onchange'}.
1342 my $countrydefault = $param->{default_country} || 'US';
1343 foreach my $country (
1344 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1345 keys %cust_main_county
1347 my $selected = $country eq $param->{'selected_country'}
1350 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1352 $country_html .= '</SELECT>';
1355 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1356 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1360 ($county_html, $state_html, $country_html);
1364 sub regionselector_hashref {
1365 my ($county_html, $state_html, $country_html) = regionselector(@_);
1367 'county_html' => $county_html,
1368 'state_html' => $state_html,
1369 'country_html' => $country_html,
1373 #=item expselect HASHREF | LIST
1375 #Takes as input a hashref or list of key/value pairs with the following keys:
1379 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1381 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1385 =item expselect PREFIX [ DATE ]
1387 Takes as input a unique prefix string and the current expiration date, in
1388 yyyy-mm-dd or m-d-yyyy format
1390 Returns an HTML fragments for expiration date selection.
1396 #if ( ref($_[0]) ) {
1400 #my $prefix = $param->{'prefix'};
1401 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1402 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1404 my $date = scalar(@_) ? shift : '';
1406 my( $m, $y ) = ( 0, 0 );
1407 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1408 ( $m, $y ) = ( $2, $1 );
1409 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1410 ( $m, $y ) = ( $1, $3 );
1412 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1414 $return .= qq!<OPTION VALUE="$_"!;
1415 $return .= " SELECTED" if $_ == $m;
1418 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1420 my $thisYear = $t[5] + 1900;
1421 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1422 $return .= qq!<OPTION VALUE="$_"!;
1423 $return .= " SELECTED" if $_ == $y;
1426 $return .= "</SELECT>";
1431 =item popselector HASHREF | LIST
1433 Takes as input a hashref or list of key/value pairs with the following keys:
1439 Access number number
1443 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>.
1447 Returns an HTML fragment for access number selection.
1451 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1459 my $popnum = $param->{'popnum'};
1460 my $pops = $param->{'pops'};
1462 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1463 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1464 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1465 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1466 if scalar(@$pops) == 1;
1469 my %popnum2pop = ();
1471 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1472 $popnum2pop{$_->{popnum}} = $_;
1477 function opt(what,href,text) {
1478 var optionName = new Option(text, href, false, false)
1479 var length = what.length;
1480 what.options[length] = optionName;
1484 my $init_popstate = $param->{'init_popstate'};
1485 if ( $init_popstate ) {
1486 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1487 $init_popstate. '">';
1490 function acstate_changed(what) {
1491 state = what.options[what.selectedIndex].text;
1492 what.form.popac.options.length = 0
1493 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1497 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1498 foreach my $state ( sort { $a cmp $b } @states ) {
1499 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1501 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1502 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1503 if ($ac eq $param->{'popac'}) {
1504 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1507 $text .= "}\n" unless $init_popstate;
1509 $text .= "popac_changed(what.form.popac)}\n";
1512 function popac_changed(what) {
1513 ac = what.options[what.selectedIndex].text;
1514 what.form.popnum.options.length = 0;
1515 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1519 foreach my $state ( @states ) {
1520 foreach my $popac ( keys %{ $pop{$state} } ) {
1521 $text .= "\nif ( ac == \"$popac\" ) {\n";
1523 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1524 my $o_popnum = $pop->{popnum};
1525 my $poptext = $pop->{city}. ', '. $pop->{state}.
1526 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1528 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1529 if ($popnum == $o_popnum) {
1530 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1538 $text .= "}\n</SCRIPT>\n";
1541 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1542 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1543 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1544 ">$_" foreach sort { $a cmp $b } @states;
1545 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1548 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1549 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1551 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1554 #comment this block to disable initial list polulation
1555 my @initial_select = ();
1556 if ( scalar( @$pops ) > 100 ) {
1557 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1559 @initial_select = @$pops;
1561 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1562 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1563 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1564 $pop->{city}. ', '. $pop->{state}.
1565 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1568 $text .= qq!</SELECT></TD></TR></TABLE>!;
1574 =item domainselector HASHREF | LIST
1576 Takes as input a hashref or list of key/value pairs with the following keys:
1586 Service number of the selected item.
1590 Returns an HTML fragment for domain selection.
1594 sub domainselector {
1601 my $domsvc= $param->{'domsvc'};
1603 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1604 my $domains = $rv->{'domains'};
1605 $domsvc = $rv->{'domsvc'} unless $domsvc;
1607 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1608 unless scalar(keys %$domains);
1610 if (scalar(keys %$domains) == 1) {
1612 foreach(keys %$domains) {
1615 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1616 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1619 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1622 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1623 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1624 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1625 $domains->{$domain};
1628 $text .= qq!</SELECT></TD></TR>!;
1634 =item didselector HASHREF | LIST
1636 Takes as input a hashref or list of key/value pairs with the following keys:
1642 Field name for the returned HTML fragment.
1646 Service definition (see L<FS::part_svc>)
1650 Returns an HTML fragment for DID selection.
1662 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1663 'args'=>[ %$param ],
1667 $rv->{'error'} || $rv->{'output'};
1673 =head1 RESELLER FUNCTIONS
1675 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1676 with their active session, and the B<customer_info> and B<order_pkg> functions
1677 with their active session and an additional I<custnum> parameter.
1679 For the most part, development of the reseller web interface has been
1680 superceded by agent-virtualized access to the backend.
1692 =item agent_list_customers
1694 List agent's customers.
1702 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>