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:
604 =item Name of this service
606 =item Meaningful user-specific identifier for the service (i.e. username, domain or mail alias)
608 =item Table name of this service
614 Primary key for this service
618 Service definition (part_pkg)
622 Customer package (cust_pkg)
626 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
634 Empty on success, or an error message on errors.
640 Returns service information for this customer.
642 Takes a hash reference as parameter with a single key: B<session_id>
644 Returns a hash reference containing customer package information. The hash reference contains the following keys:
654 An array of hash references indicating information on all of this customer's
655 services. Each has the following keys:
661 Primary key for this service
669 Meaningful user-specific identifier for the service (i.e. username, domain, or
674 Account (svc_acct) services also have the following keys:
690 Upload bytes remaining
694 Download bytes remaining
698 Total bytes remaining
700 =item recharge_amount
704 =item recharge_seconds
706 Number of seconds gained by recharge
708 =item recharge_upbytes
710 Number of upload bytes gained by recharge
712 =item recharge_downbytes
714 Number of download bytes gained by recharge
716 =item recharge_totalbytes
718 Number of total bytes gained by recharge
726 Orders a package for this customer.
728 Takes a hash reference as parameter with the following keys:
738 pkgpart of package to order
742 optional svcpart, required only if the package definition does not contain
743 one svc_acct service definition with quantity 1 (it may contain others with
756 Optional security phrase
760 Optional Access number number
764 Returns a hash reference with a single key, B<error>, empty on success, or an
765 error message on errors. The special error '_decline' is returned for
766 declined transactions.
770 Cancels a package for this customer.
772 Takes a hash reference as parameter with the following keys:
782 pkgpart of package to cancel
786 Returns a hash reference with a single key, B<error>, empty on success, or an
787 error message on errors.
791 =head1 SIGNUP FUNCTIONS
795 =item signup_info HASHREF
797 Takes a hash reference as parameter with the following keys:
801 =item session_id - Optional agent/reseller interface session
805 Returns a hash reference containing information that may be useful in
806 displaying a signup page. The hash reference contains the following keys:
810 =item cust_main_county
812 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.
816 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
817 an agentnum specified explicitly via reseller interface session_id in the
822 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.
824 =item agentnum2part_pkg
826 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.
830 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.
832 =item security_phrase
834 True if the "security_phrase" feature is enabled
838 Array reference of acceptable payment types for signup
844 credit card - automatic
848 credit card - on-demand - version 1.5+ only
852 electronic check - automatic
856 electronic check - on-demand - version 1.5+ only
864 billing, not recommended for signups
868 free, definitely not recommended for signups
872 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
878 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
882 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".
894 =item new_customer HASHREF
896 Creates a new customer. Takes a hash reference as parameter with the
903 first name (required)
911 (not typically collected; mostly used for ACH transactions)
917 =item address1 (required)
925 =item city (required)
933 =item state (required)
955 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
959 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
963 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
967 Expiration date for CARD/DCRD
971 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
975 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),
977 =item referral_custnum
979 referring customer number
987 pkgpart of initial package
1003 Access number (index, not the literal number)
1007 Country code (to be provisioned as a service)
1011 Phone number (to be provisioned as a service)
1019 Returns a hash reference with the following keys:
1025 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)
1029 =item regionselector HASHREF | LIST
1031 Takes as input a hashref or list of key/value pairs with the following keys:
1035 =item selected_county
1037 Currently selected county
1039 =item selected_state
1041 Currently selected state
1043 =item selected_country
1045 Currently selected country
1049 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1053 Specify a javascript subroutine to call on changes
1059 =item default_country
1065 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>.
1069 Returns a list consisting of three HTML fragments for county selection,
1070 state selection and country selection, respectively.
1074 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1075 sub regionselector {
1082 $param->{'selected_country'} ||= $param->{'default_country'};
1083 $param->{'selected_state'} ||= $param->{'default_state'};
1085 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1089 my %cust_main_county;
1091 # unless ( @cust_main_county ) { #cache
1092 #@cust_main_county = qsearch('cust_main_county', {} );
1093 #foreach my $c ( @cust_main_county ) {
1094 foreach my $c ( @{ $param->{'locales'} } ) {
1095 #$countyflag=1 if $c->county;
1096 $countyflag=1 if $c->{county};
1097 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1098 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1099 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1102 $countyflag=1 if $param->{selected_county};
1104 my $script_html = <<END;
1106 function opt(what,value,text) {
1107 var optionName = new Option(text, value, false, false);
1108 var length = what.length;
1109 what.options[length] = optionName;
1111 function ${prefix}country_changed(what) {
1112 country = what.options[what.selectedIndex].text;
1113 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1114 what.form.${prefix}state.options[i] = null;
1116 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1118 foreach my $country ( sort keys %cust_main_county ) {
1119 $script_html .= "\nif ( country == \"$country\" ) {\n";
1120 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1121 my $text = $state || '(n/a)';
1122 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1124 $script_html .= "}\n";
1127 $script_html .= <<END;
1129 function ${prefix}state_changed(what) {
1132 if ( $countyflag ) {
1133 $script_html .= <<END;
1134 state = what.options[what.selectedIndex].text;
1135 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1136 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1137 what.form.${prefix}county.options[i] = null;
1140 foreach my $country ( sort keys %cust_main_county ) {
1141 $script_html .= "\nif ( country == \"$country\" ) {\n";
1142 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1143 $script_html .= "\nif ( state == \"$state\" ) {\n";
1144 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1145 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1146 my $text = $county || '(n/a)';
1148 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1150 $script_html .= "}\n";
1152 $script_html .= "}\n";
1156 $script_html .= <<END;
1161 my $county_html = $script_html;
1162 if ( $countyflag ) {
1163 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1164 $county_html .= '</SELECT>';
1167 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1170 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1171 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1172 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1173 my $text = $state || '(n/a)';
1174 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1175 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1177 $state_html .= '</SELECT>';
1179 $state_html .= '</SELECT>';
1181 my $country_html = qq!<SELECT NAME="${prefix}country" !.
1182 qq!onChange="${prefix}country_changed(this); $param->{'onchange'}">!;
1183 my $countrydefault = $param->{default_country} || 'US';
1184 foreach my $country (
1185 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1186 keys %cust_main_county
1188 my $selected = $country eq $param->{'selected_country'} ? ' SELECTED' : '';
1189 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1191 $country_html .= '</SELECT>';
1193 ($county_html, $state_html, $country_html);
1197 #=item expselect HASHREF | LIST
1199 #Takes as input a hashref or list of key/value pairs with the following keys:
1203 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1205 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1209 =item expselect PREFIX [ DATE ]
1211 Takes as input a unique prefix string and the current expiration date, in
1212 yyyy-mm-dd or m-d-yyyy format
1214 Returns an HTML fragments for expiration date selection.
1220 #if ( ref($_[0]) ) {
1224 #my $prefix = $param->{'prefix'};
1225 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1226 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1228 my $date = scalar(@_) ? shift : '';
1230 my( $m, $y ) = ( 0, 0 );
1231 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1232 ( $m, $y ) = ( $2, $1 );
1233 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1234 ( $m, $y ) = ( $1, $3 );
1236 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1238 $return .= qq!<OPTION VALUE="$_"!;
1239 $return .= " SELECTED" if $_ == $m;
1242 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1244 my $thisYear = $t[5] + 1900;
1245 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1246 $return .= qq!<OPTION VALUE="$_"!;
1247 $return .= " SELECTED" if $_ == $y;
1250 $return .= "</SELECT>";
1255 =item popselector HASHREF | LIST
1257 Takes as input a hashref or list of key/value pairs with the following keys:
1263 Access number number
1267 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>.
1271 Returns an HTML fragment for access number selection.
1275 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1283 my $popnum = $param->{'popnum'};
1284 my $pops = $param->{'pops'};
1286 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1287 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1288 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1289 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1290 if scalar(@$pops) == 1;
1293 my %popnum2pop = ();
1295 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1296 $popnum2pop{$_->{popnum}} = $_;
1301 function opt(what,href,text) {
1302 var optionName = new Option(text, href, false, false)
1303 var length = what.length;
1304 what.options[length] = optionName;
1308 my $init_popstate = $param->{'init_popstate'};
1309 if ( $init_popstate ) {
1310 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1311 $init_popstate. '">';
1314 function acstate_changed(what) {
1315 state = what.options[what.selectedIndex].text;
1316 what.form.popac.options.length = 0
1317 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1321 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1322 foreach my $state ( sort { $a cmp $b } @states ) {
1323 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1325 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1326 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1327 if ($ac eq $param->{'popac'}) {
1328 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1331 $text .= "}\n" unless $init_popstate;
1333 $text .= "popac_changed(what.form.popac)}\n";
1336 function popac_changed(what) {
1337 ac = what.options[what.selectedIndex].text;
1338 what.form.popnum.options.length = 0;
1339 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1343 foreach my $state ( @states ) {
1344 foreach my $popac ( keys %{ $pop{$state} } ) {
1345 $text .= "\nif ( ac == \"$popac\" ) {\n";
1347 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1348 my $o_popnum = $pop->{popnum};
1349 my $poptext = $pop->{city}. ', '. $pop->{state}.
1350 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1352 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1353 if ($popnum == $o_popnum) {
1354 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1362 $text .= "}\n</SCRIPT>\n";
1365 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1366 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1367 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1368 ">$_" foreach sort { $a cmp $b } @states;
1369 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1372 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1373 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1375 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1378 #comment this block to disable initial list polulation
1379 my @initial_select = ();
1380 if ( scalar( @$pops ) > 100 ) {
1381 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1383 @initial_select = @$pops;
1385 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1386 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1387 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1388 $pop->{city}. ', '. $pop->{state}.
1389 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1392 $text .= qq!</SELECT></TD></TR></TABLE>!;
1398 =item domainselector HASHREF | LIST
1400 Takes as input a hashref or list of key/value pairs with the following keys:
1410 Service number of the selected item.
1414 Returns an HTML fragment for domain selection.
1418 sub domainselector {
1425 my $domsvc= $param->{'domsvc'};
1427 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1428 my $domains = $rv->{'domains'};
1429 $domsvc = $rv->{'domsvc'} unless $domsvc;
1431 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1432 unless scalar(keys %$domains);
1434 if (scalar(keys %$domains) == 1) {
1436 foreach(keys %$domains) {
1439 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1440 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1443 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1446 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1447 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1448 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1449 $domains->{$domain};
1452 $text .= qq!</SELECT></TD></TR>!;
1458 =item didselector HASHREF | LIST
1460 Takes as input a hashref or list of key/value pairs with the following keys:
1470 Returns an HTML fragment for DID selection.
1482 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1483 'args'=>[ %$param ],
1487 $rv->{'error'} || $rv->{'output'};
1493 =head1 RESELLER FUNCTIONS
1495 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1496 with their active session, and the B<customer_info> and B<order_pkg> functions
1497 with their active session and an additional I<custnum> parameter.
1505 =item agent_list_customers
1513 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>