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_prepay' => 'MyAccount/process_prepay',
41 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
42 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
43 'list_svc_usage' => 'MyAccount/list_svc_usage',
44 'list_support_usage' => 'MyAccount/list_support_usage',
45 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
46 'change_pkg' => 'MyAccount/change_pkg',
47 'order_recharge' => 'MyAccount/order_recharge',
48 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
49 'charge' => 'MyAccount/charge', #?
50 'part_svc_info' => 'MyAccount/part_svc_info',
51 'provision_acct' => 'MyAccount/provision_acct',
52 'provision_external' => 'MyAccount/provision_external',
53 'unprovision_svc' => 'MyAccount/unprovision_svc',
54 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
55 'signup_info' => 'Signup/signup_info',
56 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
57 'new_customer' => 'Signup/new_customer',
58 'agent_login' => 'Agent/agent_login',
59 'agent_logout' => 'Agent/agent_logout',
60 'agent_info' => 'Agent/agent_info',
61 'agent_list_customers' => 'Agent/agent_list_customers',
62 'mason_comp' => 'MasonComponent/mason_comp',
63 'call_time' => 'PrepaidPhone/call_time',
64 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
65 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
69 qw( regionselector regionselector_hashref
70 expselect popselector domainselector didselector )
73 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
74 $ENV{'SHELL'} = '/bin/sh';
75 $ENV{'IFS'} = " \t\n";
78 $ENV{'BASH_ENV'} = '';
80 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
81 #if you grant appropriate permissions to whatever user
82 my $freeside_uid = scalar(getpwnam('freeside'));
83 die "not running as the freeside user\n"
84 if $> != $freeside_uid && ! $skip_uid_check;
86 -e $dir or die "FATAL: $dir doesn't exist!";
87 -d $dir or die "FATAL: $dir isn't a directory!";
88 -r $dir or die "FATAL: Can't read $dir as freeside user!";
89 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
91 foreach my $autoload ( keys %autoload ) {
99 #warn scalar(@_). ": ". join(" / ", @_);
103 $param->{_packet} = \''. $autoload{$autoload}. '\';
105 simple_packet($param);
115 warn "sending ". $packet->{_packet}. " to server"
117 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
118 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
119 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
122 #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
124 #block until there is a message on socket
125 # my $w = new IO::Select;
127 # my @wait = $w->can_read;
129 warn "reading message from server"
132 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
133 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
135 warn "returning message to client"
143 FS::SelfService - Freeside self-service API
147 # password and shell account changes
148 use FS::SelfService qw(passwd chfn chsh);
150 # "my account" functionality
151 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
153 my $rv = login( { 'username' => $username,
155 'password' => $password,
159 if ( $rv->{'error'} ) {
160 #handle login error...
163 my $session_id = $rv->{'session_id'};
166 my $customer_info = customer_info( { 'session_id' => $session_id } );
168 #payment_info and process_payment are available in 1.5+ only
169 my $payment_info = payment_info( { 'session_id' => $session_id } );
171 #!!! process_payment example
173 #!!! list_pkgs example
175 #!!! order_pkg example
177 #!!! cancel_pkg example
179 # signup functionality
180 use FS::SelfService qw( signup_info new_customer );
182 my $signup_info = signup_info;
184 $rv = new_customer( {
187 'company' => $company,
188 'address1' => $address1,
189 'address2' => $address2,
193 'country' => $country,
194 'daytime' => $daytime,
198 'payinfo' => $payinfo,
200 'paystart_month' => $paystart_month
201 'paystart_year' => $paystart_year,
202 'payissue' => $payissue,
204 'paydate' => $paydate,
205 'payname' => $payname,
206 'invoicing_list' => $invoicing_list,
207 'referral_custnum' => $referral_custnum,
208 'agentnum' => $agentnum,
209 'pkgpart' => $pkgpart,
211 'username' => $username,
212 '_password' => $password,
216 'phonenum' => $phonenum,
221 my $error = $rv->{'error'};
222 if ( $error eq '_decline' ) {
232 Use this API to implement your own client "self-service" module.
234 If you just want to customize the look of the existing "self-service" module,
237 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
249 =head1 "MY ACCOUNT" FUNCTIONS
255 Creates a user session. Takes a hash reference as parameter with the
274 Returns a hash reference with the following keys:
280 Empty on success, or an error message on errors.
284 Session identifier for successful logins
288 =item customer_info HASHREF
290 Returns general customer information.
292 Takes a hash reference as parameter with a single key: B<session_id>
294 Returns a hash reference with the following keys:
308 Array reference of hash references of open inoices. Each hash reference has
309 the following keys: invnum, date, owed
313 An HTML fragment containing shipping and billing addresses.
315 =item The following fields are also returned
317 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
321 =item edit_info HASHREF
323 Takes a hash reference as parameter with any of the following keys:
325 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
327 If a field exists, the customer record is updated with the new value of that
328 field. If a field does not exist, that field is not changed on the customer
331 Returns a hash reference with a single key, B<error>, empty on success, or an
332 error message on errors
334 =item invoice HASHREF
336 Returns an invoice. Takes a hash reference as parameter with two keys:
337 session_id and invnum
339 Returns a hash reference with the following keys:
345 Empty on success, or an error message on errors
357 =item list_invoices HASHREF
359 Returns a list of all customer invoices. Takes a hash references with a single
362 Returns a hash reference with the following keys:
368 Empty on success, or an error message on errors
372 Reference to array of hash references with the following keys:
382 Invoice date, in UNIX epoch time
390 Cancels this customer.
392 Takes a hash reference as parameter with a single key: B<session_id>
394 Returns a hash reference with a single key, B<error>, which is empty on
395 success or an error message on errors.
397 =item payment_info HASHREF
399 Returns information that may be useful in displaying a payment page.
401 Takes a hash reference as parameter with a single key: B<session_id>.
403 Returns a hash reference with the following keys:
409 Empty on success, or an error message on errors
417 Exact name on credit card (CARD/DCRD)
441 Customer's current default payment type.
445 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
449 For CARD/DCRD payment types, the card number
453 For CARD/DCRD payment types, expiration month
457 For CARD/DCRD payment types, expiration year
459 =item cust_main_county
461 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.
465 Array reference of all states in the current default country.
469 Hash reference of card types; keys are card types, values are the exact strings
470 passed to the process_payment function
474 Unique transaction identifier (prevents multiple charges), passed to the
475 process_payment function
479 =item process_payment HASHREF
481 Processes a payment and possible change of address or payment type. Takes a
482 hash reference as parameter with the following keys:
496 If true, address and card information entered will be saved for subsequent
501 If true, future credit card payments will be done automatically (sets payby to
502 CARD). If false, future credit card payments will be done on-demand (sets
503 payby to DCRD). This option only has meaning if B<save> is set true.
535 Card expiration month
543 Unique transaction identifier, returned from the payment_info function.
544 Prevents multiple charges.
548 Returns a hash reference with a single key, B<error>, empty on success, or an
549 error message on errors
553 Returns package information for this customer. For more detail on services,
556 Takes a hash reference as parameter with a single key: B<session_id>
558 Returns a hash reference containing customer package information. The hash reference contains the following keys:
566 =item cust_pkg HASHREF
568 Array reference of hash references, each of which has the fields of a cust_pkg
569 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
570 the internal FS:: objects, but hash references of columns and values.
574 =item part_pkg fields
576 All fields of part_pkg for this specific cust_pkg (be careful with this
577 information - it may reveal more about your available packages than you would
578 like users to know in aggregate)
582 #XXX pare part_pkg fields down to a more secure subset
586 An array of hash references indicating information on unprovisioned services
587 available for provisioning for this specific cust_pkg. Each has the following
592 =item part_svc fields
594 All fields of part_svc (be careful with this information - it may reveal more
595 about your available packages than you would like users to know in aggregate)
599 #XXX pare part_svc fields down to a more secure subset
605 An array of hash references indicating information on the customer services
606 already provisioned for this specific cust_pkg. Each has the following keys:
612 Array reference with three elements:
622 Meaningful user-specific identifier for the service (i.e. username, domain or mail alias)
626 Table name of this service
632 Primary key for this service
636 Service definition (part_pkg)
640 Customer package (cust_pkg)
644 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
652 Empty on success, or an error message on errors.
658 Returns service information for this customer.
660 Takes a hash reference as parameter with a single key: B<session_id>
662 Returns a hash reference containing customer package information. The hash reference contains the following keys:
672 An array of hash references indicating information on all of this customer's
673 services. Each has the following keys:
679 Primary key for this service
687 Meaningful user-specific identifier for the service (i.e. username, domain, or
692 Account (svc_acct) services also have the following keys:
708 Upload bytes remaining
712 Download bytes remaining
716 Total bytes remaining
718 =item recharge_amount
722 =item recharge_seconds
724 Number of seconds gained by recharge
726 =item recharge_upbytes
728 Number of upload bytes gained by recharge
730 =item recharge_downbytes
732 Number of download bytes gained by recharge
734 =item recharge_totalbytes
736 Number of total bytes gained by recharge
744 Orders a package for this customer.
746 Takes a hash reference as parameter with the following keys:
756 pkgpart of package to order
760 optional svcpart, required only if the package definition does not contain
761 one svc_acct service definition with quantity 1 (it may contain others with
774 Optional security phrase
778 Optional Access number number
782 Returns a hash reference with a single key, B<error>, empty on success, or an
783 error message on errors. The special error '_decline' is returned for
784 declined transactions.
788 Cancels a package for this customer.
790 Takes a hash reference as parameter with the following keys:
800 pkgpart of package to cancel
804 Returns a hash reference with a single key, B<error>, empty on success, or an
805 error message on errors.
809 =head1 SIGNUP FUNCTIONS
813 =item signup_info HASHREF
815 Takes a hash reference as parameter with the following keys:
819 =item session_id - Optional agent/reseller interface session
823 Returns a hash reference containing information that may be useful in
824 displaying a signup page. The hash reference contains the following keys:
828 =item cust_main_county
830 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.
834 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
835 an agentnum specified explicitly via reseller interface session_id in the
840 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.
842 =item agentnum2part_pkg
844 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.
848 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.
850 =item security_phrase
852 True if the "security_phrase" feature is enabled
856 Array reference of acceptable payment types for signup
862 credit card - automatic
866 credit card - on-demand - version 1.5+ only
870 electronic check - automatic
874 electronic check - on-demand - version 1.5+ only
882 billing, not recommended for signups
886 free, definitely not recommended for signups
890 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
896 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
900 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".
912 =item new_customer HASHREF
914 Creates a new customer. Takes a hash reference as parameter with the
921 first name (required)
929 (not typically collected; mostly used for ACH transactions)
935 =item address1 (required)
943 =item city (required)
951 =item state (required)
973 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
977 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
981 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
985 Expiration date for CARD/DCRD
989 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
993 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),
995 =item referral_custnum
997 referring customer number
1005 pkgpart of initial package
1021 Access number (index, not the literal number)
1025 Country code (to be provisioned as a service)
1029 Phone number (to be provisioned as a service)
1037 Returns a hash reference with the following keys:
1043 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)
1047 =item regionselector HASHREF | LIST
1049 Takes as input a hashref or list of key/value pairs with the following keys:
1053 =item selected_county
1055 Currently selected county
1057 =item selected_state
1059 Currently selected state
1061 =item selected_country
1063 Currently selected country
1067 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1071 Specify a javascript subroutine to call on changes
1077 =item default_country
1083 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>.
1087 Returns a list consisting of three HTML fragments for county selection,
1088 state selection and country selection, respectively.
1092 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1093 sub regionselector {
1100 $param->{'selected_country'} ||= $param->{'default_country'};
1101 $param->{'selected_state'} ||= $param->{'default_state'};
1103 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1107 my %cust_main_county;
1109 # unless ( @cust_main_county ) { #cache
1110 #@cust_main_county = qsearch('cust_main_county', {} );
1111 #foreach my $c ( @cust_main_county ) {
1112 foreach my $c ( @{ $param->{'locales'} } ) {
1113 #$countyflag=1 if $c->county;
1114 $countyflag=1 if $c->{county};
1115 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1116 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1117 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1120 $countyflag=1 if $param->{selected_county};
1122 my $script_html = <<END;
1124 function opt(what,value,text) {
1125 var optionName = new Option(text, value, false, false);
1126 var length = what.length;
1127 what.options[length] = optionName;
1129 function ${prefix}country_changed(what) {
1130 country = what.options[what.selectedIndex].text;
1131 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1132 what.form.${prefix}state.options[i] = null;
1134 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1136 foreach my $country ( sort keys %cust_main_county ) {
1137 $script_html .= "\nif ( country == \"$country\" ) {\n";
1138 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1139 my $text = $state || '(n/a)';
1140 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1142 $script_html .= "}\n";
1145 $script_html .= <<END;
1147 function ${prefix}state_changed(what) {
1150 if ( $countyflag ) {
1151 $script_html .= <<END;
1152 state = what.options[what.selectedIndex].text;
1153 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1154 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1155 what.form.${prefix}county.options[i] = null;
1158 foreach my $country ( sort keys %cust_main_county ) {
1159 $script_html .= "\nif ( country == \"$country\" ) {\n";
1160 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1161 $script_html .= "\nif ( state == \"$state\" ) {\n";
1162 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1163 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1164 my $text = $county || '(n/a)';
1166 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1168 $script_html .= "}\n";
1170 $script_html .= "}\n";
1174 $script_html .= <<END;
1179 my $county_html = $script_html;
1180 if ( $countyflag ) {
1181 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1182 $county_html .= '</SELECT>';
1185 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1188 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1189 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1190 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1191 my $text = $state || '(n/a)';
1192 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1193 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1195 $state_html .= '</SELECT>';
1197 my $country_html = '';
1198 if ( scalar( keys %cust_main_county ) > 1 ) {
1200 $country_html = qq(<SELECT NAME="${prefix}country" ).
1201 qq(onChange="${prefix}country_changed(this); ).
1202 $param->{'onchange'}.
1205 my $countrydefault = $param->{default_country} || 'US';
1206 foreach my $country (
1207 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1208 keys %cust_main_county
1210 my $selected = $country eq $param->{'selected_country'}
1213 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1215 $country_html .= '</SELECT>';
1218 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1219 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1223 ($county_html, $state_html, $country_html);
1227 sub regionselector_hashref {
1228 my ($county_html, $state_html, $country_html) = regionselector(@_);
1230 'county_html' => $county_html,
1231 'state_html' => $state_html,
1232 'country_html' => $country_html,
1236 #=item expselect HASHREF | LIST
1238 #Takes as input a hashref or list of key/value pairs with the following keys:
1242 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1244 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1248 =item expselect PREFIX [ DATE ]
1250 Takes as input a unique prefix string and the current expiration date, in
1251 yyyy-mm-dd or m-d-yyyy format
1253 Returns an HTML fragments for expiration date selection.
1259 #if ( ref($_[0]) ) {
1263 #my $prefix = $param->{'prefix'};
1264 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1265 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1267 my $date = scalar(@_) ? shift : '';
1269 my( $m, $y ) = ( 0, 0 );
1270 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1271 ( $m, $y ) = ( $2, $1 );
1272 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1273 ( $m, $y ) = ( $1, $3 );
1275 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1277 $return .= qq!<OPTION VALUE="$_"!;
1278 $return .= " SELECTED" if $_ == $m;
1281 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1283 my $thisYear = $t[5] + 1900;
1284 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1285 $return .= qq!<OPTION VALUE="$_"!;
1286 $return .= " SELECTED" if $_ == $y;
1289 $return .= "</SELECT>";
1294 =item popselector HASHREF | LIST
1296 Takes as input a hashref or list of key/value pairs with the following keys:
1302 Access number number
1306 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>.
1310 Returns an HTML fragment for access number selection.
1314 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1322 my $popnum = $param->{'popnum'};
1323 my $pops = $param->{'pops'};
1325 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1326 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1327 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1328 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1329 if scalar(@$pops) == 1;
1332 my %popnum2pop = ();
1334 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1335 $popnum2pop{$_->{popnum}} = $_;
1340 function opt(what,href,text) {
1341 var optionName = new Option(text, href, false, false)
1342 var length = what.length;
1343 what.options[length] = optionName;
1347 my $init_popstate = $param->{'init_popstate'};
1348 if ( $init_popstate ) {
1349 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1350 $init_popstate. '">';
1353 function acstate_changed(what) {
1354 state = what.options[what.selectedIndex].text;
1355 what.form.popac.options.length = 0
1356 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1360 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1361 foreach my $state ( sort { $a cmp $b } @states ) {
1362 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1364 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1365 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1366 if ($ac eq $param->{'popac'}) {
1367 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1370 $text .= "}\n" unless $init_popstate;
1372 $text .= "popac_changed(what.form.popac)}\n";
1375 function popac_changed(what) {
1376 ac = what.options[what.selectedIndex].text;
1377 what.form.popnum.options.length = 0;
1378 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1382 foreach my $state ( @states ) {
1383 foreach my $popac ( keys %{ $pop{$state} } ) {
1384 $text .= "\nif ( ac == \"$popac\" ) {\n";
1386 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1387 my $o_popnum = $pop->{popnum};
1388 my $poptext = $pop->{city}. ', '. $pop->{state}.
1389 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1391 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1392 if ($popnum == $o_popnum) {
1393 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1401 $text .= "}\n</SCRIPT>\n";
1404 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1405 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1406 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1407 ">$_" foreach sort { $a cmp $b } @states;
1408 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1411 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1412 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1414 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1417 #comment this block to disable initial list polulation
1418 my @initial_select = ();
1419 if ( scalar( @$pops ) > 100 ) {
1420 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1422 @initial_select = @$pops;
1424 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1425 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1426 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1427 $pop->{city}. ', '. $pop->{state}.
1428 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1431 $text .= qq!</SELECT></TD></TR></TABLE>!;
1437 =item domainselector HASHREF | LIST
1439 Takes as input a hashref or list of key/value pairs with the following keys:
1449 Service number of the selected item.
1453 Returns an HTML fragment for domain selection.
1457 sub domainselector {
1464 my $domsvc= $param->{'domsvc'};
1466 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1467 my $domains = $rv->{'domains'};
1468 $domsvc = $rv->{'domsvc'} unless $domsvc;
1470 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1471 unless scalar(keys %$domains);
1473 if (scalar(keys %$domains) == 1) {
1475 foreach(keys %$domains) {
1478 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1479 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1482 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1485 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1486 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1487 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1488 $domains->{$domain};
1491 $text .= qq!</SELECT></TD></TR>!;
1497 =item didselector HASHREF | LIST
1499 Takes as input a hashref or list of key/value pairs with the following keys:
1509 Returns an HTML fragment for DID selection.
1521 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1522 'args'=>[ %$param ],
1526 $rv->{'error'} || $rv->{'output'};
1532 =head1 RESELLER FUNCTIONS
1534 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1535 with their active session, and the B<customer_info> and B<order_pkg> functions
1536 with their active session and an additional I<custnum> parameter.
1544 =item agent_list_customers
1552 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>