1 package FS::SelfService;
4 use vars qw($VERSION @ISA @EXPORT_OK $DEBUG $dir $socket %autoload $tag);
10 use Storable 2.09 qw(nstore_fd fd_retrieve);
14 @ISA = qw( Exporter );
18 $dir = "/usr/local/freeside";
19 $socket = "$dir/selfservice_socket";
20 $socket .= '.'.$tag if defined $tag && length($tag);
22 #maybe should ask ClientAPI for this list
24 'passwd' => 'passwd/passwd',
25 'chfn' => 'passwd/passwd',
26 'chsh' => 'passwd/passwd',
27 'login' => 'MyAccount/login',
28 'logout' => 'MyAccount/logout',
29 'customer_info' => 'MyAccount/customer_info',
30 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
31 'invoice' => 'MyAccount/invoice',
32 'invoice_logo' => 'MyAccount/invoice_logo',
33 'list_invoices' => 'MyAccount/list_invoices', #?
34 'cancel' => 'MyAccount/cancel', #add to ss cgi!
35 'payment_info' => 'MyAccount/payment_info',
36 'process_payment' => 'MyAccount/process_payment',
37 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
38 'process_prepay' => 'MyAccount/process_prepay',
39 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
40 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
41 'list_svc_usage' => 'MyAccount/list_svc_usage',
42 'list_support_usage' => 'MyAccount/list_support_usage',
43 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
44 'change_pkg' => 'MyAccount/change_pkg',
45 'order_recharge' => 'MyAccount/order_recharge',
46 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
47 'charge' => 'MyAccount/charge', #?
48 'part_svc_info' => 'MyAccount/part_svc_info',
49 'provision_acct' => 'MyAccount/provision_acct',
50 'provision_external' => 'MyAccount/provision_external',
51 'unprovision_svc' => 'MyAccount/unprovision_svc',
52 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
53 'signup_info' => 'Signup/signup_info',
54 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
55 'new_customer' => 'Signup/new_customer',
56 'agent_login' => 'Agent/agent_login',
57 'agent_logout' => 'Agent/agent_logout',
58 'agent_info' => 'Agent/agent_info',
59 'agent_list_customers' => 'Agent/agent_list_customers',
60 'mason_comp' => 'MasonComponent/mason_comp',
62 @EXPORT_OK = ( keys(%autoload), qw( regionselector expselect popselector domainselector didselector) );
64 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
65 $ENV{'SHELL'} = '/bin/sh';
66 $ENV{'IFS'} = " \t\n";
69 $ENV{'BASH_ENV'} = '';
71 my $freeside_uid = scalar(getpwnam('freeside'));
72 die "not running as the freeside user\n" if $> != $freeside_uid;
74 -e $dir or die "FATAL: $dir doesn't exist!";
75 -d $dir or die "FATAL: $dir isn't a directory!";
76 -r $dir or die "FATAL: Can't read $dir as freeside user!";
77 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
79 foreach my $autoload ( keys %autoload ) {
87 #warn scalar(@_). ": ". join(" / ", @_);
91 $param->{_packet} = \''. $autoload{$autoload}. '\';
93 simple_packet($param);
103 warn "sending ". $packet->{_packet}. " to server"
105 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
106 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
107 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
110 #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
112 #block until there is a message on socket
113 # my $w = new IO::Select;
115 # my @wait = $w->can_read;
117 warn "reading message from server"
120 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
121 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
123 warn "returning message to client"
131 FS::SelfService - Freeside self-service API
135 # password and shell account changes
136 use FS::SelfService qw(passwd chfn chsh);
138 # "my account" functionality
139 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
141 my $rv = login( { 'username' => $username,
143 'password' => $password,
147 if ( $rv->{'error'} ) {
148 #handle login error...
151 my $session_id = $rv->{'session_id'};
154 my $customer_info = customer_info( { 'session_id' => $session_id } );
156 #payment_info and process_payment are available in 1.5+ only
157 my $payment_info = payment_info( { 'session_id' => $session_id } );
159 #!!! process_payment example
161 #!!! list_pkgs example
163 #!!! order_pkg example
165 #!!! cancel_pkg example
167 # signup functionality
168 use FS::SelfService qw( signup_info new_customer );
170 my $signup_info = signup_info;
172 $rv = new_customer( {
175 'company' => $company,
176 'address1' => $address1,
177 'address2' => $address2,
181 'country' => $country,
182 'daytime' => $daytime,
186 'payinfo' => $payinfo,
188 'paystart_month' => $paystart_month
189 'paystart_year' => $paystart_year,
190 'payissue' => $payissue,
192 'paydate' => $paydate,
193 'payname' => $payname,
194 'invoicing_list' => $invoicing_list,
195 'referral_custnum' => $referral_custnum,
196 'pkgpart' => $pkgpart,
197 'username' => $username,
198 '_password' => $password,
200 'agentnum' => $agentnum,
204 my $error = $rv->{'error'};
205 if ( $error eq '_decline' ) {
215 Use this API to implement your own client "self-service" module.
217 If you just want to customize the look of the existing "self-service" module,
220 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
232 =head1 "MY ACCOUNT" FUNCTIONS
238 Creates a user session. Takes a hash reference as parameter with the
257 Returns a hash reference with the following keys:
263 Empty on success, or an error message on errors.
267 Session identifier for successful logins
271 =item customer_info HASHREF
273 Returns general customer information.
275 Takes a hash reference as parameter with a single key: B<session_id>
277 Returns a hash reference with the following keys:
291 Array reference of hash references of open inoices. Each hash reference has
292 the following keys: invnum, date, owed
296 An HTML fragment containing shipping and billing addresses.
298 =item The following fields are also returned
300 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
304 =item edit_info HASHREF
306 Takes a hash reference as parameter with any of the following keys:
308 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
310 If a field exists, the customer record is updated with the new value of that
311 field. If a field does not exist, that field is not changed on the customer
314 Returns a hash reference with a single key, B<error>, empty on success, or an
315 error message on errors
317 =item invoice HASHREF
319 Returns an invoice. Takes a hash reference as parameter with two keys:
320 session_id and invnum
322 Returns a hash reference with the following keys:
328 Empty on success, or an error message on errors
340 =item list_invoices HASHREF
342 Returns a list of all customer invoices. Takes a hash references with a single
345 Returns a hash reference with the following keys:
351 Empty on success, or an error message on errors
355 Reference to array of hash references with the following keys:
365 Invoice date, in UNIX epoch time
373 Cancels this customer.
375 Takes a hash reference as parameter with a single key: B<session_id>
377 Returns a hash reference with a single key, B<error>, which is empty on
378 success or an error message on errors.
380 =item payment_info HASHREF
382 Returns information that may be useful in displaying a payment page.
384 Takes a hash reference as parameter with a single key: B<session_id>.
386 Returns a hash reference with the following keys:
392 Empty on success, or an error message on errors
400 Exact name on credit card (CARD/DCRD)
424 Customer's current default payment type.
428 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
432 For CARD/DCRD payment types, the card number
436 For CARD/DCRD payment types, expiration month
440 For CARD/DCRD payment types, expiration year
442 =item cust_main_county
444 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.
448 Array reference of all states in the current default country.
452 Hash reference of card types; keys are card types, values are the exact strings
453 passed to the process_payment function
457 Unique transaction identifier (prevents multiple charges), passed to the
458 process_payment function
462 =item process_payment HASHREF
464 Processes a payment and possible change of address or payment type. Takes a
465 hash reference as parameter with the following keys:
479 If true, address and card information entered will be saved for subsequent
484 If true, future credit card payments will be done automatically (sets payby to
485 CARD). If false, future credit card payments will be done on-demand (sets
486 payby to DCRD). This option only has meaning if B<save> is set true.
518 Card expiration month
526 Unique transaction identifier, returned from the payment_info function.
527 Prevents multiple charges.
531 Returns a hash reference with a single key, B<error>, empty on success, or an
532 error message on errors
536 Returns package information for this customer. For more detail on services,
539 Takes a hash reference as parameter with a single key: B<session_id>
541 Returns a hash reference containing customer package information. The hash reference contains the following keys:
549 =item cust_pkg HASHREF
551 Array reference of hash references, each of which has the fields of a cust_pkg
552 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
553 the internal FS:: objects, but hash references of columns and values.
557 =item part_pkg fields
559 All fields of part_pkg for this specific cust_pkg (be careful with this
560 information - it may reveal more about your available packages than you would
561 like users to know in aggregate)
565 #XXX pare part_pkg fields down to a more secure subset
569 An array of hash references indicating information on unprovisioned services
570 available for provisioning for this specific cust_pkg. Each has the following
575 =item part_svc fields
577 All fields of part_svc (be careful with this information - it may reveal more
578 about your available packages than you would like users to know in aggregate)
582 #XXX pare part_svc fields down to a more secure subset
588 An array of hash references indicating information on the customer services
589 already provisioned for this specific cust_pkg. Each has the following keys:
595 Array reference with three elements:
599 =item Name of this service
601 =item Meaningful user-specific identifier for the service (i.e. username, domain or mail alias)
603 =item Table name of this service
609 Primary key for this service
613 Service definition (part_pkg)
617 Customer package (cust_pkg)
621 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
629 Empty on success, or an error message on errors.
635 Returns service information for this customer.
637 Takes a hash reference as parameter with a single key: B<session_id>
639 Returns a hash reference containing customer package information. The hash reference contains the following keys:
649 An array of hash references indicating information on all of this customer's
650 services. Each has the following keys:
656 Primary key for this service
664 Meaningful user-specific identifier for the service (i.e. username, domain, or
669 Account (svc_acct) services also have the following keys:
685 Upload bytes remaining
689 Download bytes remaining
693 Total bytes remaining
695 =item recharge_amount
699 =item recharge_seconds
701 Number of seconds gained by recharge
703 =item recharge_upbytes
705 Number of upload bytes gained by recharge
707 =item recharge_downbytes
709 Number of download bytes gained by recharge
711 =item recharge_totalbytes
713 Number of total bytes gained by recharge
721 Orders a package for this customer.
723 Takes a hash reference as parameter with the following keys:
733 pkgpart of package to order
737 optional svcpart, required only if the package definition does not contain
738 one svc_acct service definition with quantity 1 (it may contain others with
751 Optional security phrase
755 Optional Access number number
759 Returns a hash reference with a single key, B<error>, empty on success, or an
760 error message on errors. The special error '_decline' is returned for
761 declined transactions.
765 Cancels a package for this customer.
767 Takes a hash reference as parameter with the following keys:
777 pkgpart of package to cancel
781 Returns a hash reference with a single key, B<error>, empty on success, or an
782 error message on errors.
786 =head1 SIGNUP FUNCTIONS
790 =item signup_info HASHREF
792 Takes a hash reference as parameter with the following keys:
796 =item session_id - Optional agent/reseller interface session
800 Returns a hash reference containing information that may be useful in
801 displaying a signup page. The hash reference contains the following keys:
805 =item cust_main_county
807 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.
811 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
812 an agentnum specified explicitly via reseller interface session_id in the
817 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.
819 =item agentnum2part_pkg
821 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.
825 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.
827 =item security_phrase
829 True if the "security_phrase" feature is enabled
833 Array reference of acceptable payment types for signup
839 credit card - automatic
843 credit card - on-demand - version 1.5+ only
847 electronic check - automatic
851 electronic check - on-demand - version 1.5+ only
859 billing, not recommended for signups
863 free, definitely not recommended for signups
867 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
873 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
877 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".
889 =item new_customer HASHREF
891 Creates a new customer. Takes a hash reference as parameter with the
898 first name (required)
906 (not typically collected; mostly used for ACH transactions)
912 =item address1 (required)
920 =item city (required)
928 =item state (required)
950 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
954 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
958 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
962 Expiration date for CARD/DCRD
966 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
970 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),
972 =item referral_custnum
974 referring customer number
978 pkgpart of initial package
994 Access number (index, not the literal number)
1002 Returns a hash reference with the following keys:
1008 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)
1012 =item regionselector HASHREF | LIST
1014 Takes as input a hashref or list of key/value pairs with the following keys:
1018 =item selected_county
1020 Currently selected county
1022 =item selected_state
1024 Currently selected state
1026 =item selected_country
1028 Currently selected country
1032 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1036 Specify a javascript subroutine to call on changes
1042 =item default_country
1048 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>.
1052 Returns a list consisting of three HTML fragments for county selection,
1053 state selection and country selection, respectively.
1057 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1058 sub regionselector {
1065 $param->{'selected_country'} ||= $param->{'default_country'};
1066 $param->{'selected_state'} ||= $param->{'default_state'};
1068 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1072 my %cust_main_county;
1074 # unless ( @cust_main_county ) { #cache
1075 #@cust_main_county = qsearch('cust_main_county', {} );
1076 #foreach my $c ( @cust_main_county ) {
1077 foreach my $c ( @{ $param->{'locales'} } ) {
1078 #$countyflag=1 if $c->county;
1079 $countyflag=1 if $c->{county};
1080 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1081 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1082 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1085 $countyflag=1 if $param->{selected_county};
1087 my $script_html = <<END;
1089 function opt(what,value,text) {
1090 var optionName = new Option(text, value, false, false);
1091 var length = what.length;
1092 what.options[length] = optionName;
1094 function ${prefix}country_changed(what) {
1095 country = what.options[what.selectedIndex].text;
1096 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1097 what.form.${prefix}state.options[i] = null;
1099 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1101 foreach my $country ( sort keys %cust_main_county ) {
1102 $script_html .= "\nif ( country == \"$country\" ) {\n";
1103 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1104 my $text = $state || '(n/a)';
1105 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1107 $script_html .= "}\n";
1110 $script_html .= <<END;
1112 function ${prefix}state_changed(what) {
1115 if ( $countyflag ) {
1116 $script_html .= <<END;
1117 state = what.options[what.selectedIndex].text;
1118 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1119 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1120 what.form.${prefix}county.options[i] = null;
1123 foreach my $country ( sort keys %cust_main_county ) {
1124 $script_html .= "\nif ( country == \"$country\" ) {\n";
1125 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1126 $script_html .= "\nif ( state == \"$state\" ) {\n";
1127 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1128 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1129 my $text = $county || '(n/a)';
1131 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1133 $script_html .= "}\n";
1135 $script_html .= "}\n";
1139 $script_html .= <<END;
1144 my $county_html = $script_html;
1145 if ( $countyflag ) {
1146 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1147 $county_html .= '</SELECT>';
1150 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1153 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1154 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1155 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1156 my $text = $state || '(n/a)';
1157 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1158 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1160 $state_html .= '</SELECT>';
1162 $state_html .= '</SELECT>';
1164 my $country_html = qq!<SELECT NAME="${prefix}country" !.
1165 qq!onChange="${prefix}country_changed(this); $param->{'onchange'}">!;
1166 my $countrydefault = $param->{default_country} || 'US';
1167 foreach my $country (
1168 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1169 keys %cust_main_county
1171 my $selected = $country eq $param->{'selected_country'} ? ' SELECTED' : '';
1172 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1174 $country_html .= '</SELECT>';
1176 ($county_html, $state_html, $country_html);
1180 #=item expselect HASHREF | LIST
1182 #Takes as input a hashref or list of key/value pairs with the following keys:
1186 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1188 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1192 =item expselect PREFIX [ DATE ]
1194 Takes as input a unique prefix string and the current expiration date, in
1195 yyyy-mm-dd or m-d-yyyy format
1197 Returns an HTML fragments for expiration date selection.
1203 #if ( ref($_[0]) ) {
1207 #my $prefix = $param->{'prefix'};
1208 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1209 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1211 my $date = scalar(@_) ? shift : '';
1213 my( $m, $y ) = ( 0, 0 );
1214 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1215 ( $m, $y ) = ( $2, $1 );
1216 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1217 ( $m, $y ) = ( $1, $3 );
1219 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1221 $return .= qq!<OPTION VALUE="$_"!;
1222 $return .= " SELECTED" if $_ == $m;
1225 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1227 my $thisYear = $t[5] + 1900;
1228 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1229 $return .= qq!<OPTION VALUE="$_"!;
1230 $return .= " SELECTED" if $_ == $y;
1233 $return .= "</SELECT>";
1238 =item popselector HASHREF | LIST
1240 Takes as input a hashref or list of key/value pairs with the following keys:
1246 Access number number
1250 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>.
1254 Returns an HTML fragment for access number selection.
1258 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1266 my $popnum = $param->{'popnum'};
1267 my $pops = $param->{'pops'};
1269 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1270 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1271 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1272 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1273 if scalar(@$pops) == 1;
1276 my %popnum2pop = ();
1278 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1279 $popnum2pop{$_->{popnum}} = $_;
1284 function opt(what,href,text) {
1285 var optionName = new Option(text, href, false, false)
1286 var length = what.length;
1287 what.options[length] = optionName;
1291 my $init_popstate = $param->{'init_popstate'};
1292 if ( $init_popstate ) {
1293 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1294 $init_popstate. '">';
1297 function acstate_changed(what) {
1298 state = what.options[what.selectedIndex].text;
1299 what.form.popac.options.length = 0
1300 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1304 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1305 foreach my $state ( sort { $a cmp $b } @states ) {
1306 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1308 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1309 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1310 if ($ac eq $param->{'popac'}) {
1311 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1314 $text .= "}\n" unless $init_popstate;
1316 $text .= "popac_changed(what.form.popac)}\n";
1319 function popac_changed(what) {
1320 ac = what.options[what.selectedIndex].text;
1321 what.form.popnum.options.length = 0;
1322 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1326 foreach my $state ( @states ) {
1327 foreach my $popac ( keys %{ $pop{$state} } ) {
1328 $text .= "\nif ( ac == \"$popac\" ) {\n";
1330 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1331 my $o_popnum = $pop->{popnum};
1332 my $poptext = $pop->{city}. ', '. $pop->{state}.
1333 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1335 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1336 if ($popnum == $o_popnum) {
1337 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1345 $text .= "}\n</SCRIPT>\n";
1348 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1349 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1350 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1351 ">$_" foreach sort { $a cmp $b } @states;
1352 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1355 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1356 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1358 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1361 #comment this block to disable initial list polulation
1362 my @initial_select = ();
1363 if ( scalar( @$pops ) > 100 ) {
1364 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1366 @initial_select = @$pops;
1368 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1369 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1370 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1371 $pop->{city}. ', '. $pop->{state}.
1372 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1375 $text .= qq!</SELECT></TD></TR></TABLE>!;
1381 =item domainselector HASHREF | LIST
1383 Takes as input a hashref or list of key/value pairs with the following keys:
1393 Service number of the selected item.
1397 Returns an HTML fragment for domain selection.
1401 sub domainselector {
1408 my $domsvc= $param->{'domsvc'};
1410 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1411 my $domains = $rv->{'domains'};
1412 $domsvc = $rv->{'domsvc'} unless $domsvc;
1414 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1415 unless scalar(keys %$domains);
1417 if (scalar(keys %$domains) == 1) {
1419 foreach(keys %$domains) {
1422 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1423 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1426 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1429 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1430 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1431 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1432 $domains->{$domain};
1435 $text .= qq!</SELECT></TD></TR>!;
1441 =item didselector HASHREF | LIST
1443 Takes as input a hashref or list of key/value pairs with the following keys:
1453 Returns an HTML fragment for DID selection.
1465 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1466 'args'=>[ %$param ],
1470 $rv->{'error'} || $rv->{'output'};
1476 =head1 RESELLER FUNCTIONS
1478 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1479 with their active session, and the B<customer_info> and B<order_pkg> functions
1480 with their active session and an additional I<custnum> parameter.
1488 =item agent_list_customers
1496 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>