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 'agentnum' => $agentnum,
197 'pkgpart' => $pkgpart,
199 'username' => $username,
200 '_password' => $password,
204 'phonenum' => $phonenum,
209 my $error = $rv->{'error'};
210 if ( $error eq '_decline' ) {
220 Use this API to implement your own client "self-service" module.
222 If you just want to customize the look of the existing "self-service" module,
225 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
237 =head1 "MY ACCOUNT" FUNCTIONS
243 Creates a user session. Takes a hash reference as parameter with the
262 Returns a hash reference with the following keys:
268 Empty on success, or an error message on errors.
272 Session identifier for successful logins
276 =item customer_info HASHREF
278 Returns general customer information.
280 Takes a hash reference as parameter with a single key: B<session_id>
282 Returns a hash reference with the following keys:
296 Array reference of hash references of open inoices. Each hash reference has
297 the following keys: invnum, date, owed
301 An HTML fragment containing shipping and billing addresses.
303 =item The following fields are also returned
305 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
309 =item edit_info HASHREF
311 Takes a hash reference as parameter with any of the following keys:
313 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
315 If a field exists, the customer record is updated with the new value of that
316 field. If a field does not exist, that field is not changed on the customer
319 Returns a hash reference with a single key, B<error>, empty on success, or an
320 error message on errors
322 =item invoice HASHREF
324 Returns an invoice. Takes a hash reference as parameter with two keys:
325 session_id and invnum
327 Returns a hash reference with the following keys:
333 Empty on success, or an error message on errors
345 =item list_invoices HASHREF
347 Returns a list of all customer invoices. Takes a hash references with a single
350 Returns a hash reference with the following keys:
356 Empty on success, or an error message on errors
360 Reference to array of hash references with the following keys:
370 Invoice date, in UNIX epoch time
378 Cancels this customer.
380 Takes a hash reference as parameter with a single key: B<session_id>
382 Returns a hash reference with a single key, B<error>, which is empty on
383 success or an error message on errors.
385 =item payment_info HASHREF
387 Returns information that may be useful in displaying a payment page.
389 Takes a hash reference as parameter with a single key: B<session_id>.
391 Returns a hash reference with the following keys:
397 Empty on success, or an error message on errors
405 Exact name on credit card (CARD/DCRD)
429 Customer's current default payment type.
433 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
437 For CARD/DCRD payment types, the card number
441 For CARD/DCRD payment types, expiration month
445 For CARD/DCRD payment types, expiration year
447 =item cust_main_county
449 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.
453 Array reference of all states in the current default country.
457 Hash reference of card types; keys are card types, values are the exact strings
458 passed to the process_payment function
462 Unique transaction identifier (prevents multiple charges), passed to the
463 process_payment function
467 =item process_payment HASHREF
469 Processes a payment and possible change of address or payment type. Takes a
470 hash reference as parameter with the following keys:
484 If true, address and card information entered will be saved for subsequent
489 If true, future credit card payments will be done automatically (sets payby to
490 CARD). If false, future credit card payments will be done on-demand (sets
491 payby to DCRD). This option only has meaning if B<save> is set true.
523 Card expiration month
531 Unique transaction identifier, returned from the payment_info function.
532 Prevents multiple charges.
536 Returns a hash reference with a single key, B<error>, empty on success, or an
537 error message on errors
541 Returns package information for this customer. For more detail on services,
544 Takes a hash reference as parameter with a single key: B<session_id>
546 Returns a hash reference containing customer package information. The hash reference contains the following keys:
554 =item cust_pkg HASHREF
556 Array reference of hash references, each of which has the fields of a cust_pkg
557 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
558 the internal FS:: objects, but hash references of columns and values.
562 =item part_pkg fields
564 All fields of part_pkg for this specific cust_pkg (be careful with this
565 information - it may reveal more about your available packages than you would
566 like users to know in aggregate)
570 #XXX pare part_pkg fields down to a more secure subset
574 An array of hash references indicating information on unprovisioned services
575 available for provisioning for this specific cust_pkg. Each has the following
580 =item part_svc fields
582 All fields of part_svc (be careful with this information - it may reveal more
583 about your available packages than you would like users to know in aggregate)
587 #XXX pare part_svc fields down to a more secure subset
593 An array of hash references indicating information on the customer services
594 already provisioned for this specific cust_pkg. Each has the following keys:
600 Array reference with three elements:
610 Meaningful user-specific identifier for the service (i.e. username, domain or mail alias)
614 Table name of this service
620 Primary key for this service
624 Service definition (part_pkg)
628 Customer package (cust_pkg)
632 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
640 Empty on success, or an error message on errors.
646 Returns service information for this customer.
648 Takes a hash reference as parameter with a single key: B<session_id>
650 Returns a hash reference containing customer package information. The hash reference contains the following keys:
660 An array of hash references indicating information on all of this customer's
661 services. Each has the following keys:
667 Primary key for this service
675 Meaningful user-specific identifier for the service (i.e. username, domain, or
680 Account (svc_acct) services also have the following keys:
696 Upload bytes remaining
700 Download bytes remaining
704 Total bytes remaining
706 =item recharge_amount
710 =item recharge_seconds
712 Number of seconds gained by recharge
714 =item recharge_upbytes
716 Number of upload bytes gained by recharge
718 =item recharge_downbytes
720 Number of download bytes gained by recharge
722 =item recharge_totalbytes
724 Number of total bytes gained by recharge
732 Orders a package for this customer.
734 Takes a hash reference as parameter with the following keys:
744 pkgpart of package to order
748 optional svcpart, required only if the package definition does not contain
749 one svc_acct service definition with quantity 1 (it may contain others with
762 Optional security phrase
766 Optional Access number number
770 Returns a hash reference with a single key, B<error>, empty on success, or an
771 error message on errors. The special error '_decline' is returned for
772 declined transactions.
776 Cancels a package for this customer.
778 Takes a hash reference as parameter with the following keys:
788 pkgpart of package to cancel
792 Returns a hash reference with a single key, B<error>, empty on success, or an
793 error message on errors.
797 =head1 SIGNUP FUNCTIONS
801 =item signup_info HASHREF
803 Takes a hash reference as parameter with the following keys:
807 =item session_id - Optional agent/reseller interface session
811 Returns a hash reference containing information that may be useful in
812 displaying a signup page. The hash reference contains the following keys:
816 =item cust_main_county
818 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.
822 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
823 an agentnum specified explicitly via reseller interface session_id in the
828 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.
830 =item agentnum2part_pkg
832 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.
836 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.
838 =item security_phrase
840 True if the "security_phrase" feature is enabled
844 Array reference of acceptable payment types for signup
850 credit card - automatic
854 credit card - on-demand - version 1.5+ only
858 electronic check - automatic
862 electronic check - on-demand - version 1.5+ only
870 billing, not recommended for signups
874 free, definitely not recommended for signups
878 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
884 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
888 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".
900 =item new_customer HASHREF
902 Creates a new customer. Takes a hash reference as parameter with the
909 first name (required)
917 (not typically collected; mostly used for ACH transactions)
923 =item address1 (required)
931 =item city (required)
939 =item state (required)
961 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
965 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
969 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
973 Expiration date for CARD/DCRD
977 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
981 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),
983 =item referral_custnum
985 referring customer number
993 pkgpart of initial package
1009 Access number (index, not the literal number)
1013 Country code (to be provisioned as a service)
1017 Phone number (to be provisioned as a service)
1025 Returns a hash reference with the following keys:
1031 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)
1035 =item regionselector HASHREF | LIST
1037 Takes as input a hashref or list of key/value pairs with the following keys:
1041 =item selected_county
1043 Currently selected county
1045 =item selected_state
1047 Currently selected state
1049 =item selected_country
1051 Currently selected country
1055 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1059 Specify a javascript subroutine to call on changes
1065 =item default_country
1071 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>.
1075 Returns a list consisting of three HTML fragments for county selection,
1076 state selection and country selection, respectively.
1080 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1081 sub regionselector {
1088 $param->{'selected_country'} ||= $param->{'default_country'};
1089 $param->{'selected_state'} ||= $param->{'default_state'};
1091 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1095 my %cust_main_county;
1097 # unless ( @cust_main_county ) { #cache
1098 #@cust_main_county = qsearch('cust_main_county', {} );
1099 #foreach my $c ( @cust_main_county ) {
1100 foreach my $c ( @{ $param->{'locales'} } ) {
1101 #$countyflag=1 if $c->county;
1102 $countyflag=1 if $c->{county};
1103 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1104 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1105 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1108 $countyflag=1 if $param->{selected_county};
1110 my $script_html = <<END;
1112 function opt(what,value,text) {
1113 var optionName = new Option(text, value, false, false);
1114 var length = what.length;
1115 what.options[length] = optionName;
1117 function ${prefix}country_changed(what) {
1118 country = what.options[what.selectedIndex].text;
1119 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1120 what.form.${prefix}state.options[i] = null;
1122 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1124 foreach my $country ( sort keys %cust_main_county ) {
1125 $script_html .= "\nif ( country == \"$country\" ) {\n";
1126 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1127 my $text = $state || '(n/a)';
1128 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1130 $script_html .= "}\n";
1133 $script_html .= <<END;
1135 function ${prefix}state_changed(what) {
1138 if ( $countyflag ) {
1139 $script_html .= <<END;
1140 state = what.options[what.selectedIndex].text;
1141 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1142 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1143 what.form.${prefix}county.options[i] = null;
1146 foreach my $country ( sort keys %cust_main_county ) {
1147 $script_html .= "\nif ( country == \"$country\" ) {\n";
1148 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1149 $script_html .= "\nif ( state == \"$state\" ) {\n";
1150 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1151 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1152 my $text = $county || '(n/a)';
1154 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1156 $script_html .= "}\n";
1158 $script_html .= "}\n";
1162 $script_html .= <<END;
1167 my $county_html = $script_html;
1168 if ( $countyflag ) {
1169 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1170 $county_html .= '</SELECT>';
1173 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1176 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1177 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1178 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1179 my $text = $state || '(n/a)';
1180 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1181 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1183 $state_html .= '</SELECT>';
1185 $state_html .= '</SELECT>';
1187 my $country_html = qq!<SELECT NAME="${prefix}country" !.
1188 qq!onChange="${prefix}country_changed(this); $param->{'onchange'}">!;
1189 my $countrydefault = $param->{default_country} || 'US';
1190 foreach my $country (
1191 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1192 keys %cust_main_county
1194 my $selected = $country eq $param->{'selected_country'} ? ' SELECTED' : '';
1195 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1197 $country_html .= '</SELECT>';
1199 ($county_html, $state_html, $country_html);
1203 #=item expselect HASHREF | LIST
1205 #Takes as input a hashref or list of key/value pairs with the following keys:
1209 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1211 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1215 =item expselect PREFIX [ DATE ]
1217 Takes as input a unique prefix string and the current expiration date, in
1218 yyyy-mm-dd or m-d-yyyy format
1220 Returns an HTML fragments for expiration date selection.
1226 #if ( ref($_[0]) ) {
1230 #my $prefix = $param->{'prefix'};
1231 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1232 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1234 my $date = scalar(@_) ? shift : '';
1236 my( $m, $y ) = ( 0, 0 );
1237 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1238 ( $m, $y ) = ( $2, $1 );
1239 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1240 ( $m, $y ) = ( $1, $3 );
1242 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1244 $return .= qq!<OPTION VALUE="$_"!;
1245 $return .= " SELECTED" if $_ == $m;
1248 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1250 my $thisYear = $t[5] + 1900;
1251 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1252 $return .= qq!<OPTION VALUE="$_"!;
1253 $return .= " SELECTED" if $_ == $y;
1256 $return .= "</SELECT>";
1261 =item popselector HASHREF | LIST
1263 Takes as input a hashref or list of key/value pairs with the following keys:
1269 Access number number
1273 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>.
1277 Returns an HTML fragment for access number selection.
1281 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1289 my $popnum = $param->{'popnum'};
1290 my $pops = $param->{'pops'};
1292 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1293 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1294 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1295 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1296 if scalar(@$pops) == 1;
1299 my %popnum2pop = ();
1301 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1302 $popnum2pop{$_->{popnum}} = $_;
1307 function opt(what,href,text) {
1308 var optionName = new Option(text, href, false, false)
1309 var length = what.length;
1310 what.options[length] = optionName;
1314 my $init_popstate = $param->{'init_popstate'};
1315 if ( $init_popstate ) {
1316 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1317 $init_popstate. '">';
1320 function acstate_changed(what) {
1321 state = what.options[what.selectedIndex].text;
1322 what.form.popac.options.length = 0
1323 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1327 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1328 foreach my $state ( sort { $a cmp $b } @states ) {
1329 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1331 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1332 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1333 if ($ac eq $param->{'popac'}) {
1334 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1337 $text .= "}\n" unless $init_popstate;
1339 $text .= "popac_changed(what.form.popac)}\n";
1342 function popac_changed(what) {
1343 ac = what.options[what.selectedIndex].text;
1344 what.form.popnum.options.length = 0;
1345 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1349 foreach my $state ( @states ) {
1350 foreach my $popac ( keys %{ $pop{$state} } ) {
1351 $text .= "\nif ( ac == \"$popac\" ) {\n";
1353 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1354 my $o_popnum = $pop->{popnum};
1355 my $poptext = $pop->{city}. ', '. $pop->{state}.
1356 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1358 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1359 if ($popnum == $o_popnum) {
1360 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1368 $text .= "}\n</SCRIPT>\n";
1371 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1372 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1373 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1374 ">$_" foreach sort { $a cmp $b } @states;
1375 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1378 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1379 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1381 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1384 #comment this block to disable initial list polulation
1385 my @initial_select = ();
1386 if ( scalar( @$pops ) > 100 ) {
1387 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1389 @initial_select = @$pops;
1391 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1392 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1393 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1394 $pop->{city}. ', '. $pop->{state}.
1395 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1398 $text .= qq!</SELECT></TD></TR></TABLE>!;
1404 =item domainselector HASHREF | LIST
1406 Takes as input a hashref or list of key/value pairs with the following keys:
1416 Service number of the selected item.
1420 Returns an HTML fragment for domain selection.
1424 sub domainselector {
1431 my $domsvc= $param->{'domsvc'};
1433 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1434 my $domains = $rv->{'domains'};
1435 $domsvc = $rv->{'domsvc'} unless $domsvc;
1437 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1438 unless scalar(keys %$domains);
1440 if (scalar(keys %$domains) == 1) {
1442 foreach(keys %$domains) {
1445 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1446 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1449 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1452 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1453 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1454 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1455 $domains->{$domain};
1458 $text .= qq!</SELECT></TD></TR>!;
1464 =item didselector HASHREF | LIST
1466 Takes as input a hashref or list of key/value pairs with the following keys:
1476 Returns an HTML fragment for DID selection.
1488 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1489 'args'=>[ %$param ],
1493 $rv->{'error'} || $rv->{'output'};
1499 =head1 RESELLER FUNCTIONS
1501 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1502 with their active session, and the B<customer_info> and B<order_pkg> functions
1503 with their active session and an additional I<custnum> parameter.
1511 =item agent_list_customers
1519 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>