1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login' => 'MyAccount/login',
30 'logout' => 'MyAccount/logout',
31 'customer_info' => 'MyAccount/customer_info',
32 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
33 'invoice' => 'MyAccount/invoice',
34 'invoice_logo' => 'MyAccount/invoice_logo',
35 'list_invoices' => 'MyAccount/list_invoices', #?
36 'cancel' => 'MyAccount/cancel', #add to ss cgi!
37 'payment_info' => 'MyAccount/payment_info',
38 'process_payment' => 'MyAccount/process_payment',
39 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
40 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
41 'process_prepay' => 'MyAccount/process_prepay',
42 'realtime_collect' => 'MyAccount/realtime_collect',
43 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
44 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
45 'list_svc_usage' => 'MyAccount/list_svc_usage',
46 'list_support_usage' => 'MyAccount/list_support_usage',
47 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
48 'change_pkg' => 'MyAccount/change_pkg',
49 'order_recharge' => 'MyAccount/order_recharge',
50 'renew_info' => 'MyAccount/renew_info',
51 'order_renew' => 'MyAccount/order_renew',
52 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
53 'charge' => 'MyAccount/charge', #?
54 'part_svc_info' => 'MyAccount/part_svc_info',
55 'provision_acct' => 'MyAccount/provision_acct',
56 'provision_external' => 'MyAccount/provision_external',
57 'unprovision_svc' => 'MyAccount/unprovision_svc',
58 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
59 'signup_info' => 'Signup/signup_info',
60 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
61 'new_customer' => 'Signup/new_customer',
62 'capture_payment' => 'Signup/capture_payment',
63 'agent_login' => 'Agent/agent_login',
64 'agent_logout' => 'Agent/agent_logout',
65 'agent_info' => 'Agent/agent_info',
66 'agent_list_customers' => 'Agent/agent_list_customers',
67 'mason_comp' => 'MasonComponent/mason_comp',
68 'call_time' => 'PrepaidPhone/call_time',
69 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
70 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
74 qw( regionselector regionselector_hashref
75 expselect popselector domainselector didselector )
78 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
79 $ENV{'SHELL'} = '/bin/sh';
80 $ENV{'IFS'} = " \t\n";
83 $ENV{'BASH_ENV'} = '';
85 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
86 #if you grant appropriate permissions to whatever user
87 my $freeside_uid = scalar(getpwnam('freeside'));
88 die "not running as the freeside user\n"
89 if $> != $freeside_uid && ! $skip_uid_check;
91 -e $dir or die "FATAL: $dir doesn't exist!";
92 -d $dir or die "FATAL: $dir isn't a directory!";
93 -r $dir or die "FATAL: Can't read $dir as freeside user!";
94 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
96 foreach my $autoload ( keys %autoload ) {
104 #warn scalar(@_). ": ". join(" / ", @_);
108 $param->{_packet} = \''. $autoload{$autoload}. '\';
110 simple_packet($param);
120 warn "sending ". $packet->{_packet}. " to server"
122 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
123 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
124 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
127 #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
129 #block until there is a message on socket
130 # my $w = new IO::Select;
132 # my @wait = $w->can_read;
134 warn "reading message from server"
137 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
138 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
140 warn "returning message to client"
148 FS::SelfService - Freeside self-service API
152 # password and shell account changes
153 use FS::SelfService qw(passwd chfn chsh);
155 # "my account" functionality
156 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
158 my $rv = login( { 'username' => $username,
160 'password' => $password,
164 if ( $rv->{'error'} ) {
165 #handle login error...
168 my $session_id = $rv->{'session_id'};
171 my $customer_info = customer_info( { 'session_id' => $session_id } );
173 #payment_info and process_payment are available in 1.5+ only
174 my $payment_info = payment_info( { 'session_id' => $session_id } );
176 #!!! process_payment example
178 #!!! list_pkgs example
180 #!!! order_pkg example
182 #!!! cancel_pkg example
184 # signup functionality
185 use FS::SelfService qw( signup_info new_customer );
187 my $signup_info = signup_info;
189 $rv = new_customer( {
192 'company' => $company,
193 'address1' => $address1,
194 'address2' => $address2,
198 'country' => $country,
199 'daytime' => $daytime,
203 'payinfo' => $payinfo,
205 'paystart_month' => $paystart_month
206 'paystart_year' => $paystart_year,
207 'payissue' => $payissue,
209 'paydate' => $paydate,
210 'payname' => $payname,
211 'invoicing_list' => $invoicing_list,
212 'referral_custnum' => $referral_custnum,
213 'agentnum' => $agentnum,
214 'pkgpart' => $pkgpart,
216 'username' => $username,
217 '_password' => $password,
221 'phonenum' => $phonenum,
226 my $error = $rv->{'error'};
227 if ( $error eq '_decline' ) {
237 Use this API to implement your own client "self-service" module.
239 If you just want to customize the look of the existing "self-service" module,
242 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
254 =head1 "MY ACCOUNT" FUNCTIONS
260 Creates a user session. Takes a hash reference as parameter with the
279 Returns a hash reference with the following keys:
285 Empty on success, or an error message on errors.
289 Session identifier for successful logins
293 =item customer_info HASHREF
295 Returns general customer information.
297 Takes a hash reference as parameter with a single key: B<session_id>
299 Returns a hash reference with the following keys:
313 Array reference of hash references of open inoices. Each hash reference has
314 the following keys: invnum, date, owed
318 An HTML fragment containing shipping and billing addresses.
320 =item The following fields are also returned
322 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
326 =item edit_info HASHREF
328 Takes a hash reference as parameter with any of the following keys:
330 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
332 If a field exists, the customer record is updated with the new value of that
333 field. If a field does not exist, that field is not changed on the customer
336 Returns a hash reference with a single key, B<error>, empty on success, or an
337 error message on errors
339 =item invoice HASHREF
341 Returns an invoice. Takes a hash reference as parameter with two keys:
342 session_id and invnum
344 Returns a hash reference with the following keys:
350 Empty on success, or an error message on errors
362 =item list_invoices HASHREF
364 Returns a list of all customer invoices. Takes a hash references with a single
367 Returns a hash reference with the following keys:
373 Empty on success, or an error message on errors
377 Reference to array of hash references with the following keys:
387 Invoice date, in UNIX epoch time
395 Cancels this customer.
397 Takes a hash reference as parameter with a single key: B<session_id>
399 Returns a hash reference with a single key, B<error>, which is empty on
400 success or an error message on errors.
402 =item payment_info HASHREF
404 Returns information that may be useful in displaying a payment page.
406 Takes a hash reference as parameter with a single key: B<session_id>.
408 Returns a hash reference with the following keys:
414 Empty on success, or an error message on errors
422 Exact name on credit card (CARD/DCRD)
446 Customer's current default payment type.
450 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
454 For CARD/DCRD payment types, the card number
458 For CARD/DCRD payment types, expiration month
462 For CARD/DCRD payment types, expiration year
464 =item cust_main_county
466 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.
470 Array reference of all states in the current default country.
474 Hash reference of card types; keys are card types, values are the exact strings
475 passed to the process_payment function
479 #this doesn't actually work yet
483 #Unique transaction identifier (prevents multiple charges), passed to the
484 #process_payment function
488 =item process_payment HASHREF
490 Processes a payment and possible change of address or payment type. Takes a
491 hash reference as parameter with the following keys:
505 If true, address and card information entered will be saved for subsequent
510 If true, future credit card payments will be done automatically (sets payby to
511 CARD). If false, future credit card payments will be done on-demand (sets
512 payby to DCRD). This option only has meaning if B<save> is set true.
544 Card expiration month
552 #this doesn't actually work yet
556 #Unique transaction identifier, returned from the payment_info function.
557 #Prevents multiple charges.
561 Returns a hash reference with a single key, B<error>, empty on success, or an
562 error message on errors.
564 =item process_payment_order_pkg
566 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
567 payment processes sucessfully, the package is ordered. Takes a hash reference
568 as parameter with the keys of both methods.
570 Returns a hash reference with a single key, B<error>, empty on success, or an
571 error message on errors.
573 =item process_payment_order_renew
575 Combines the B<process_payment> and B<order_renew> functions in one step. If
576 the payment processes sucessfully, the renewal is processed. Takes a hash
577 reference as parameter with the keys of both methods.
579 Returns a hash reference with a single key, B<error>, empty on success, or an
580 error message on errors.
584 Returns package information for this customer. For more detail on services,
587 Takes a hash reference as parameter with a single key: B<session_id>
589 Returns a hash reference containing customer package information. The hash reference contains the following keys:
599 Empty on success, or an error message on errors.
601 =item cust_pkg HASHREF
603 Array reference of hash references, each of which has the fields of a cust_pkg
604 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
605 the internal FS:: objects, but hash references of columns and values.
609 =item part_pkg fields
611 All fields of part_pkg for this specific cust_pkg (be careful with this
612 information - it may reveal more about your available packages than you would
613 like users to know in aggregate)
617 #XXX pare part_pkg fields down to a more secure subset
621 An array of hash references indicating information on unprovisioned services
622 available for provisioning for this specific cust_pkg. Each has the following
627 =item part_svc fields
629 All fields of part_svc (be careful with this information - it may reveal more
630 about your available packages than you would like users to know in aggregate)
634 #XXX pare part_svc fields down to a more secure subset
640 An array of hash references indicating information on the customer services
641 already provisioned for this specific cust_pkg. Each has the following keys:
647 Array reference with three elements: The first element is the name of this service. The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias). The last element is the table name of this service.
653 Primary key for this service
657 Service definition (see L<FS::part_svc>)
661 Customer package (see L<FS::cust_pkg>)
665 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
673 Returns service information for this customer.
675 Takes a hash reference as parameter with a single key: B<session_id>
677 Returns a hash reference containing customer package information. The hash reference contains the following keys:
687 An array of hash references indicating information on all of this customer's
688 services. Each has the following keys:
694 Primary key for this service
702 Meaningful user-specific identifier for the service (i.e. username, domain, or
707 Account (svc_acct) services also have the following keys:
725 Upload bytes remaining
729 Download bytes remaining
733 Total bytes remaining
735 =item recharge_amount
739 =item recharge_seconds
741 Number of seconds gained by recharge
743 =item recharge_upbytes
745 Number of upload bytes gained by recharge
747 =item recharge_downbytes
749 Number of download bytes gained by recharge
751 =item recharge_totalbytes
753 Number of total bytes gained by recharge
761 Orders a package for this customer.
763 Takes a hash reference as parameter with the following keys:
773 Package to order (see L<FS::part_pkg>).
777 Service to order (see L<FS::part_svc>).
779 Normally optional; required only to provision a non-svc_acct service, or if the
780 package definition does not contain one svc_acct service definition with
781 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
782 also be specified to indicate that no initial service should be provisioned.
786 Fields used when provisioning an svc_acct service:
800 Optional security phrase
804 Optional Access number number
808 Fields used when provisioning an svc_domain service:
818 Fields used when provisioning an svc_phone service:
836 Fields used when provisioning an svc_external service:
850 Returns a hash reference with a single key, B<error>, empty on success, or an
851 error message on errors. The special error '_decline' is returned for
852 declined transactions.
856 Provides useful info for early renewals.
858 Takes a hash reference as parameter with the following keys:
868 Returns a hash reference. On errors, it contains a single key, B<error>, with
869 the error message. Otherwise, contains a single key, B<dates>, pointing to
870 an array refernce of hash references. Each hash reference contains the
877 (Future) Bill date. Indicates a future date for which billing could be run.
878 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
881 =item bill_date_pretty
883 (Future) Bill date as a human-readable string. (Convenience for display;
884 subject to change, so best not to parse for the date.)
888 Base amount which will be charged if renewed early as of this date.
892 Renewal date; i.e. even-futher future date at which the customer will be paid
893 through if the early renewal is completed with the given B<bill-date>.
894 Specified as a integer UNIX timestamp.
896 =item renew_date_pretty
898 Renewal date as a human-readable string. (Convenience for display;
899 subject to change, so best not to parse for the date.)
905 Renews this customer early; i.e. runs billing for this customer in advance.
907 Takes a hash reference as parameter with the following keys:
917 Integer date as returned by the B<renew_info> function, indicating the advance
918 date for which to run billing.
922 Returns a hash reference with a single key, B<error>, empty on success, or an
923 error message on errors.
927 Cancels a package for this customer.
929 Takes a hash reference as parameter with the following keys:
939 pkgpart of package to cancel
943 Returns a hash reference with a single key, B<error>, empty on success, or an
944 error message on errors.
948 =head1 SIGNUP FUNCTIONS
952 =item signup_info HASHREF
954 Takes a hash reference as parameter with the following keys:
958 =item session_id - Optional agent/reseller interface session
962 Returns a hash reference containing information that may be useful in
963 displaying a signup page. The hash reference contains the following keys:
967 =item cust_main_county
969 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.
973 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
974 an agentnum specified explicitly via reseller interface session_id in the
979 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.
981 =item agentnum2part_pkg
983 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.
987 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.
989 =item security_phrase
991 True if the "security_phrase" feature is enabled
995 Array reference of acceptable payment types for signup
1001 credit card - automatic
1005 credit card - on-demand - version 1.5+ only
1009 electronic check - automatic
1013 electronic check - on-demand - version 1.5+ only
1021 billing, not recommended for signups
1025 free, definitely not recommended for signups
1029 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1035 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1039 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".
1045 =item countrydefault
1051 =item new_customer HASHREF
1053 Creates a new customer. Takes a hash reference as parameter with the
1060 first name (required)
1064 last name (required)
1068 (not typically collected; mostly used for ACH transactions)
1074 =item address1 (required)
1082 =item city (required)
1090 =item state (required)
1094 =item zip (required)
1100 Daytime phone number
1104 Evening phone number
1112 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1116 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1120 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1124 Expiration date for CARD/DCRD
1128 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1130 =item invoicing_list
1132 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),
1134 =item referral_custnum
1136 referring customer number
1144 pkgpart of initial package
1160 Access number (index, not the literal number)
1164 Country code (to be provisioned as a service)
1168 Phone number (to be provisioned as a service)
1176 Returns a hash reference with the following keys:
1182 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)
1186 =item regionselector HASHREF | LIST
1188 Takes as input a hashref or list of key/value pairs with the following keys:
1192 =item selected_county
1194 Currently selected county
1196 =item selected_state
1198 Currently selected state
1200 =item selected_country
1202 Currently selected country
1206 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1210 Specify a javascript subroutine to call on changes
1216 =item default_country
1222 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>.
1226 Returns a list consisting of three HTML fragments for county selection,
1227 state selection and country selection, respectively.
1231 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1232 sub regionselector {
1239 $param->{'selected_country'} ||= $param->{'default_country'};
1240 $param->{'selected_state'} ||= $param->{'default_state'};
1242 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1246 my %cust_main_county;
1248 # unless ( @cust_main_county ) { #cache
1249 #@cust_main_county = qsearch('cust_main_county', {} );
1250 #foreach my $c ( @cust_main_county ) {
1251 foreach my $c ( @{ $param->{'locales'} } ) {
1252 #$countyflag=1 if $c->county;
1253 $countyflag=1 if $c->{county};
1254 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1255 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1256 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1259 $countyflag=1 if $param->{selected_county};
1261 my $script_html = <<END;
1263 function opt(what,value,text) {
1264 var optionName = new Option(text, value, false, false);
1265 var length = what.length;
1266 what.options[length] = optionName;
1268 function ${prefix}country_changed(what) {
1269 country = what.options[what.selectedIndex].text;
1270 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1271 what.form.${prefix}state.options[i] = null;
1273 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1275 foreach my $country ( sort keys %cust_main_county ) {
1276 $script_html .= "\nif ( country == \"$country\" ) {\n";
1277 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1278 my $text = $state || '(n/a)';
1279 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1281 $script_html .= "}\n";
1284 $script_html .= <<END;
1286 function ${prefix}state_changed(what) {
1289 if ( $countyflag ) {
1290 $script_html .= <<END;
1291 state = what.options[what.selectedIndex].text;
1292 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1293 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1294 what.form.${prefix}county.options[i] = null;
1297 foreach my $country ( sort keys %cust_main_county ) {
1298 $script_html .= "\nif ( country == \"$country\" ) {\n";
1299 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1300 $script_html .= "\nif ( state == \"$state\" ) {\n";
1301 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1302 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1303 my $text = $county || '(n/a)';
1305 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1307 $script_html .= "}\n";
1309 $script_html .= "}\n";
1313 $script_html .= <<END;
1318 my $county_html = $script_html;
1319 if ( $countyflag ) {
1320 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1321 $county_html .= '</SELECT>';
1324 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1327 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1328 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1329 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1330 my $text = $state || '(n/a)';
1331 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1332 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1334 $state_html .= '</SELECT>';
1336 my $country_html = '';
1337 if ( scalar( keys %cust_main_county ) > 1 ) {
1339 $country_html = qq(<SELECT NAME="${prefix}country" ).
1340 qq(onChange="${prefix}country_changed(this); ).
1341 $param->{'onchange'}.
1344 my $countrydefault = $param->{default_country} || 'US';
1345 foreach my $country (
1346 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1347 keys %cust_main_county
1349 my $selected = $country eq $param->{'selected_country'}
1352 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1354 $country_html .= '</SELECT>';
1357 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1358 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1362 ($county_html, $state_html, $country_html);
1366 sub regionselector_hashref {
1367 my ($county_html, $state_html, $country_html) = regionselector(@_);
1369 'county_html' => $county_html,
1370 'state_html' => $state_html,
1371 'country_html' => $country_html,
1375 #=item expselect HASHREF | LIST
1377 #Takes as input a hashref or list of key/value pairs with the following keys:
1381 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1383 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1387 =item expselect PREFIX [ DATE ]
1389 Takes as input a unique prefix string and the current expiration date, in
1390 yyyy-mm-dd or m-d-yyyy format
1392 Returns an HTML fragments for expiration date selection.
1398 #if ( ref($_[0]) ) {
1402 #my $prefix = $param->{'prefix'};
1403 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1404 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1406 my $date = scalar(@_) ? shift : '';
1408 my( $m, $y ) = ( 0, 0 );
1409 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1410 ( $m, $y ) = ( $2, $1 );
1411 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1412 ( $m, $y ) = ( $1, $3 );
1414 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1416 $return .= qq!<OPTION VALUE="$_"!;
1417 $return .= " SELECTED" if $_ == $m;
1420 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1422 my $thisYear = $t[5] + 1900;
1423 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1424 $return .= qq!<OPTION VALUE="$_"!;
1425 $return .= " SELECTED" if $_ == $y;
1428 $return .= "</SELECT>";
1433 =item popselector HASHREF | LIST
1435 Takes as input a hashref or list of key/value pairs with the following keys:
1441 Access number number
1445 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>.
1449 Returns an HTML fragment for access number selection.
1453 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1461 my $popnum = $param->{'popnum'};
1462 my $pops = $param->{'pops'};
1464 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1465 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1466 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1467 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1468 if scalar(@$pops) == 1;
1471 my %popnum2pop = ();
1473 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1474 $popnum2pop{$_->{popnum}} = $_;
1479 function opt(what,href,text) {
1480 var optionName = new Option(text, href, false, false)
1481 var length = what.length;
1482 what.options[length] = optionName;
1486 my $init_popstate = $param->{'init_popstate'};
1487 if ( $init_popstate ) {
1488 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1489 $init_popstate. '">';
1492 function acstate_changed(what) {
1493 state = what.options[what.selectedIndex].text;
1494 what.form.popac.options.length = 0
1495 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1499 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1500 foreach my $state ( sort { $a cmp $b } @states ) {
1501 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1503 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1504 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1505 if ($ac eq $param->{'popac'}) {
1506 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1509 $text .= "}\n" unless $init_popstate;
1511 $text .= "popac_changed(what.form.popac)}\n";
1514 function popac_changed(what) {
1515 ac = what.options[what.selectedIndex].text;
1516 what.form.popnum.options.length = 0;
1517 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1521 foreach my $state ( @states ) {
1522 foreach my $popac ( keys %{ $pop{$state} } ) {
1523 $text .= "\nif ( ac == \"$popac\" ) {\n";
1525 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1526 my $o_popnum = $pop->{popnum};
1527 my $poptext = $pop->{city}. ', '. $pop->{state}.
1528 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1530 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1531 if ($popnum == $o_popnum) {
1532 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1540 $text .= "}\n</SCRIPT>\n";
1543 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1544 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1545 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1546 ">$_" foreach sort { $a cmp $b } @states;
1547 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1550 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1551 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1553 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1556 #comment this block to disable initial list polulation
1557 my @initial_select = ();
1558 if ( scalar( @$pops ) > 100 ) {
1559 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1561 @initial_select = @$pops;
1563 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1564 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1565 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1566 $pop->{city}. ', '. $pop->{state}.
1567 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1570 $text .= qq!</SELECT></TD></TR></TABLE>!;
1576 =item domainselector HASHREF | LIST
1578 Takes as input a hashref or list of key/value pairs with the following keys:
1588 Service number of the selected item.
1592 Returns an HTML fragment for domain selection.
1596 sub domainselector {
1603 my $domsvc= $param->{'domsvc'};
1605 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1606 my $domains = $rv->{'domains'};
1607 $domsvc = $rv->{'domsvc'} unless $domsvc;
1609 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1610 unless scalar(keys %$domains);
1612 if (scalar(keys %$domains) == 1) {
1614 foreach(keys %$domains) {
1617 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1618 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1621 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1624 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1625 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1626 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1627 $domains->{$domain};
1630 $text .= qq!</SELECT></TD></TR>!;
1636 =item didselector HASHREF | LIST
1638 Takes as input a hashref or list of key/value pairs with the following keys:
1644 Field name for the returned HTML fragment.
1648 Service definition (see L<FS::part_svc>)
1652 Returns an HTML fragment for DID selection.
1664 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1665 'args'=>[ %$param ],
1669 $rv->{'error'} || $rv->{'output'};
1675 =head1 RESELLER FUNCTIONS
1677 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1678 with their active session, and the B<customer_info> and B<order_pkg> functions
1679 with their active session and an additional I<custnum> parameter.
1681 For the most part, development of the reseller web interface has been
1682 superceded by agent-virtualized access to the backend.
1694 =item agent_list_customers
1696 List agent's customers.
1704 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>