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 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
39 'process_payment' => 'MyAccount/process_payment',
40 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
41 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
42 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
43 'process_prepay' => 'MyAccount/process_prepay',
44 'realtime_collect' => 'MyAccount/realtime_collect',
45 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
46 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
47 'list_svc_usage' => 'MyAccount/list_svc_usage',
48 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
49 'list_support_usage' => 'MyAccount/list_support_usage',
50 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
51 'change_pkg' => 'MyAccount/change_pkg',
52 'order_recharge' => 'MyAccount/order_recharge',
53 'renew_info' => 'MyAccount/renew_info',
54 'order_renew' => 'MyAccount/order_renew',
55 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
56 'charge' => 'MyAccount/charge', #?
57 'part_svc_info' => 'MyAccount/part_svc_info',
58 'provision_acct' => 'MyAccount/provision_acct',
59 'provision_external' => 'MyAccount/provision_external',
60 'unprovision_svc' => 'MyAccount/unprovision_svc',
61 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
62 'signup_info' => 'Signup/signup_info',
63 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
64 'new_customer' => 'Signup/new_customer',
65 'capture_payment' => 'Signup/capture_payment',
66 'agent_login' => 'Agent/agent_login',
67 'agent_logout' => 'Agent/agent_logout',
68 'agent_info' => 'Agent/agent_info',
69 'agent_list_customers' => 'Agent/agent_list_customers',
70 'mason_comp' => 'MasonComponent/mason_comp',
71 'call_time' => 'PrepaidPhone/call_time',
72 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
73 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
74 'bulk_processrow' => 'Bulk/processrow',
75 'check_username' => 'Bulk/check_username',
77 'decompify_pkgs' => 'SGNG/decompify_pkgs',
78 'previous_payment_info' => 'SGNG/previous_payment_info',
79 'previous_payment_info_renew_info'
80 => 'SGNG/previous_payment_info_renew_info',
81 'previous_process_payment' => 'SGNG/previous_process_payment',
82 'previous_process_payment_order_pkg'
83 => 'SGNG/previous_process_payment_order_pkg',
84 'previous_process_payment_change_pkg'
85 => 'SGNG/previous_process_payment_change_pkg',
86 'previous_process_payment_order_renew'
87 => 'SGNG/previous_process_payment_order_renew',
91 qw( regionselector regionselector_hashref location_form
92 expselect popselector domainselector didselector
96 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
97 $ENV{'SHELL'} = '/bin/sh';
98 $ENV{'IFS'} = " \t\n";
101 $ENV{'BASH_ENV'} = '';
103 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
104 #if you grant appropriate permissions to whatever user
105 my $freeside_uid = scalar(getpwnam('freeside'));
106 die "not running as the freeside user\n"
107 if $> != $freeside_uid && ! $skip_uid_check;
109 -e $dir or die "FATAL: $dir doesn't exist!";
110 -d $dir or die "FATAL: $dir isn't a directory!";
111 -r $dir or die "FATAL: Can't read $dir as freeside user!";
112 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
114 foreach my $autoload ( keys %autoload ) {
117 "sub $autoload { ". '
122 #warn scalar(@_). ": ". join(" / ", @_);
126 $param->{_packet} = \''. $autoload{$autoload}. '\';
128 simple_packet($param);
138 warn "sending ". $packet->{_packet}. " to server"
140 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
141 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
142 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
145 #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
147 #block until there is a message on socket
148 # my $w = new IO::Select;
150 # my @wait = $w->can_read;
152 warn "reading message from server"
155 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
156 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
158 warn "returning message to client"
166 FS::SelfService - Freeside self-service API
170 # password and shell account changes
171 use FS::SelfService qw(passwd chfn chsh);
173 # "my account" functionality
174 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
176 my $rv = login( { 'username' => $username,
178 'password' => $password,
182 if ( $rv->{'error'} ) {
183 #handle login error...
186 my $session_id = $rv->{'session_id'};
189 my $customer_info = customer_info( { 'session_id' => $session_id } );
191 #payment_info and process_payment are available in 1.5+ only
192 my $payment_info = payment_info( { 'session_id' => $session_id } );
194 #!!! process_payment example
196 #!!! list_pkgs example
198 #!!! order_pkg example
200 #!!! cancel_pkg example
202 # signup functionality
203 use FS::SelfService qw( signup_info new_customer );
205 my $signup_info = signup_info;
207 $rv = new_customer( {
210 'company' => $company,
211 'address1' => $address1,
212 'address2' => $address2,
216 'country' => $country,
217 'daytime' => $daytime,
221 'payinfo' => $payinfo,
223 'paystart_month' => $paystart_month
224 'paystart_year' => $paystart_year,
225 'payissue' => $payissue,
227 'paydate' => $paydate,
228 'payname' => $payname,
229 'invoicing_list' => $invoicing_list,
230 'referral_custnum' => $referral_custnum,
231 'agentnum' => $agentnum,
232 'pkgpart' => $pkgpart,
234 'username' => $username,
235 '_password' => $password,
239 'phonenum' => $phonenum,
244 my $error = $rv->{'error'};
245 if ( $error eq '_decline' ) {
255 Use this API to implement your own client "self-service" module.
257 If you just want to customize the look of the existing "self-service" module,
260 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
272 =head1 "MY ACCOUNT" FUNCTIONS
278 Creates a user session. Takes a hash reference as parameter with the
297 Returns a hash reference with the following keys:
303 Empty on success, or an error message on errors.
307 Session identifier for successful logins
311 =item customer_info HASHREF
313 Returns general customer information.
315 Takes a hash reference as parameter with a single key: B<session_id>
317 Returns a hash reference with the following keys:
331 Array reference of hash references of open inoices. Each hash reference has
332 the following keys: invnum, date, owed
336 An HTML fragment containing shipping and billing addresses.
338 =item The following fields are also returned
340 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
344 =item edit_info HASHREF
346 Takes a hash reference as parameter with any of the following keys:
348 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
350 If a field exists, the customer record is updated with the new value of that
351 field. If a field does not exist, that field is not changed on the customer
354 Returns a hash reference with a single key, B<error>, empty on success, or an
355 error message on errors
357 =item invoice HASHREF
359 Returns an invoice. Takes a hash reference as parameter with two keys:
360 session_id and invnum
362 Returns a hash reference with the following keys:
368 Empty on success, or an error message on errors
380 =item list_invoices HASHREF
382 Returns a list of all customer invoices. Takes a hash references with a single
385 Returns a hash reference with the following keys:
391 Empty on success, or an error message on errors
395 Reference to array of hash references with the following keys:
405 Invoice date, in UNIX epoch time
413 Cancels this customer.
415 Takes a hash reference as parameter with a single key: B<session_id>
417 Returns a hash reference with a single key, B<error>, which is empty on
418 success or an error message on errors.
420 =item payment_info HASHREF
422 Returns information that may be useful in displaying a payment page.
424 Takes a hash reference as parameter with a single key: B<session_id>.
426 Returns a hash reference with the following keys:
432 Empty on success, or an error message on errors
440 Exact name on credit card (CARD/DCRD)
464 Customer's current default payment type.
468 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
472 For CARD/DCRD payment types, the card number
476 For CARD/DCRD payment types, expiration month
480 For CARD/DCRD payment types, expiration year
482 =item cust_main_county
484 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.
488 Array reference of all states in the current default country.
492 Hash reference of card types; keys are card types, values are the exact strings
493 passed to the process_payment function
497 #this doesn't actually work yet
501 #Unique transaction identifier (prevents multiple charges), passed to the
502 #process_payment function
506 =item process_payment HASHREF
508 Processes a payment and possible change of address or payment type. Takes a
509 hash reference as parameter with the following keys:
523 If true, address and card information entered will be saved for subsequent
528 If true, future credit card payments will be done automatically (sets payby to
529 CARD). If false, future credit card payments will be done on-demand (sets
530 payby to DCRD). This option only has meaning if B<save> is set true.
558 Two-letter country code
566 Card expiration month
574 #this doesn't actually work yet
578 #Unique transaction identifier, returned from the payment_info function.
579 #Prevents multiple charges.
583 Returns a hash reference with a single key, B<error>, empty on success, or an
584 error message on errors.
586 =item process_payment_order_pkg
588 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
589 payment processes sucessfully, the package is ordered. Takes a hash reference
590 as parameter with the keys of both methods.
592 Returns a hash reference with a single key, B<error>, empty on success, or an
593 error message on errors.
595 =item process_payment_change_pkg
597 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
598 payment processes sucessfully, the package is ordered. Takes a hash reference
599 as parameter with the keys of both methods.
601 Returns a hash reference with a single key, B<error>, empty on success, or an
602 error message on errors.
605 =item process_payment_order_renew
607 Combines the B<process_payment> and B<order_renew> functions in one step. If
608 the payment processes sucessfully, the renewal is processed. Takes a hash
609 reference as parameter with the keys of both methods.
611 Returns a hash reference with a single key, B<error>, empty on success, or an
612 error message on errors.
616 Returns package information for this customer. For more detail on services,
619 Takes a hash reference as parameter with a single key: B<session_id>
621 Returns a hash reference containing customer package information. The hash reference contains the following keys:
631 Empty on success, or an error message on errors.
633 =item cust_pkg HASHREF
635 Array reference of hash references, each of which has the fields of a cust_pkg
636 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
637 the internal FS:: objects, but hash references of columns and values.
641 =item part_pkg fields
643 All fields of part_pkg for this specific cust_pkg (be careful with this
644 information - it may reveal more about your available packages than you would
645 like users to know in aggregate)
649 #XXX pare part_pkg fields down to a more secure subset
653 An array of hash references indicating information on unprovisioned services
654 available for provisioning for this specific cust_pkg. Each has the following
659 =item part_svc fields
661 All fields of part_svc (be careful with this information - it may reveal more
662 about your available packages than you would like users to know in aggregate)
666 #XXX pare part_svc fields down to a more secure subset
672 An array of hash references indicating information on the customer services
673 already provisioned for this specific cust_pkg. Each has the following keys:
679 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.
685 Primary key for this service
689 Service definition (see L<FS::part_svc>)
693 Customer package (see L<FS::cust_pkg>)
697 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
705 Returns service information for this customer.
707 Takes a hash reference as parameter with a single key: B<session_id>
709 Returns a hash reference containing customer package information. The hash reference contains the following keys:
719 An array of hash references indicating information on all of this customer's
720 services. Each has the following keys:
726 Primary key for this service
734 Meaningful user-specific identifier for the service (i.e. username, domain, or
739 Account (svc_acct) services also have the following keys:
757 Upload bytes remaining
761 Download bytes remaining
765 Total bytes remaining
767 =item recharge_amount
771 =item recharge_seconds
773 Number of seconds gained by recharge
775 =item recharge_upbytes
777 Number of upload bytes gained by recharge
779 =item recharge_downbytes
781 Number of download bytes gained by recharge
783 =item recharge_totalbytes
785 Number of total bytes gained by recharge
793 Orders a package for this customer.
795 Takes a hash reference as parameter with the following keys:
805 Package to order (see L<FS::part_pkg>).
809 Service to order (see L<FS::part_svc>).
811 Normally optional; required only to provision a non-svc_acct service, or if the
812 package definition does not contain one svc_acct service definition with
813 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
814 also be specified to indicate that no initial service should be provisioned.
818 Fields used when provisioning an svc_acct service:
832 Optional security phrase
836 Optional Access number number
840 Fields used when provisioning an svc_domain service:
850 Fields used when provisioning an svc_phone service:
868 Fields used when provisioning an svc_external service:
882 Returns a hash reference with a single key, B<error>, empty on success, or an
883 error message on errors. The special error '_decline' is returned for
884 declined transactions.
888 Changes a package for this customer.
890 Takes a hash reference as parameter with the following keys:
900 Existing customer package.
904 New package to order (see L<FS::part_pkg>).
908 Returns a hash reference with a single key, B<error>, empty on success, or an
909 error message on errors.
913 Provides useful info for early renewals.
915 Takes a hash reference as parameter with the following keys:
925 Returns a hash reference. On errors, it contains a single key, B<error>, with
926 the error message. Otherwise, contains a single key, B<dates>, pointing to
927 an array refernce of hash references. Each hash reference contains the
934 (Future) Bill date. Indicates a future date for which billing could be run.
935 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
938 =item bill_date_pretty
940 (Future) Bill date as a human-readable string. (Convenience for display;
941 subject to change, so best not to parse for the date.)
945 Base amount which will be charged if renewed early as of this date.
949 Renewal date; i.e. even-futher future date at which the customer will be paid
950 through if the early renewal is completed with the given B<bill-date>.
951 Specified as a integer UNIX timestamp.
953 =item renew_date_pretty
955 Renewal date as a human-readable string. (Convenience for display;
956 subject to change, so best not to parse for the date.)
960 Package that will be renewed.
964 Expiration date of the package that will be renewed.
966 =item expire_date_pretty
968 Expiration date of the package that will be renewed, as a human-readable
969 string. (Convenience for display; subject to change, so best not to parse for
976 Renews this customer early; i.e. runs billing for this customer in advance.
978 Takes a hash reference as parameter with the following keys:
988 Integer date as returned by the B<renew_info> function, indicating the advance
989 date for which to run billing.
993 Returns a hash reference with a single key, B<error>, empty on success, or an
994 error message on errors.
998 Cancels a package for this customer.
1000 Takes a hash reference as parameter with the following keys:
1010 pkgpart of package to cancel
1014 Returns a hash reference with a single key, B<error>, empty on success, or an
1015 error message on errors.
1019 =head1 SIGNUP FUNCTIONS
1023 =item signup_info HASHREF
1025 Takes a hash reference as parameter with the following keys:
1029 =item session_id - Optional agent/reseller interface session
1033 Returns a hash reference containing information that may be useful in
1034 displaying a signup page. The hash reference contains the following keys:
1038 =item cust_main_county
1040 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.
1044 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
1045 an agentnum specified explicitly via reseller interface session_id in the
1050 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.
1052 =item agentnum2part_pkg
1054 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.
1058 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.
1060 =item security_phrase
1062 True if the "security_phrase" feature is enabled
1066 Array reference of acceptable payment types for signup
1072 credit card - automatic
1076 credit card - on-demand - version 1.5+ only
1080 electronic check - automatic
1084 electronic check - on-demand - version 1.5+ only
1092 billing, not recommended for signups
1096 free, definitely not recommended for signups
1100 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1106 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1110 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".
1116 =item countrydefault
1122 =item new_customer HASHREF
1124 Creates a new customer. Takes a hash reference as parameter with the
1131 first name (required)
1135 last name (required)
1139 (not typically collected; mostly used for ACH transactions)
1145 =item address1 (required)
1153 =item city (required)
1161 =item state (required)
1165 =item zip (required)
1171 Daytime phone number
1175 Evening phone number
1183 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1187 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1191 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1195 Expiration date for CARD/DCRD
1199 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1201 =item invoicing_list
1203 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),
1205 =item referral_custnum
1207 referring customer number
1215 pkgpart of initial package
1231 Access number (index, not the literal number)
1235 Country code (to be provisioned as a service)
1239 Phone number (to be provisioned as a service)
1247 Returns a hash reference with the following keys:
1253 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)
1257 =item regionselector HASHREF | LIST
1259 Takes as input a hashref or list of key/value pairs with the following keys:
1263 =item selected_county
1265 Currently selected county
1267 =item selected_state
1269 Currently selected state
1271 =item selected_country
1273 Currently selected country
1277 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1281 Specify a javascript subroutine to call on changes
1287 =item default_country
1293 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>.
1297 Returns a list consisting of three HTML fragments for county selection,
1298 state selection and country selection, respectively.
1302 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1303 sub regionselector {
1310 $param->{'selected_country'} ||= $param->{'default_country'};
1311 $param->{'selected_state'} ||= $param->{'default_state'};
1313 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1317 my %cust_main_county;
1319 # unless ( @cust_main_county ) { #cache
1320 #@cust_main_county = qsearch('cust_main_county', {} );
1321 #foreach my $c ( @cust_main_county ) {
1322 foreach my $c ( @{ $param->{'locales'} } ) {
1323 #$countyflag=1 if $c->county;
1324 $countyflag=1 if $c->{county};
1325 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1326 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1327 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1330 $countyflag=1 if $param->{selected_county};
1332 my $script_html = <<END;
1334 function opt(what,value,text) {
1335 var optionName = new Option(text, value, false, false);
1336 var length = what.length;
1337 what.options[length] = optionName;
1339 function ${prefix}country_changed(what) {
1340 country = what.options[what.selectedIndex].text;
1341 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1342 what.form.${prefix}state.options[i] = null;
1344 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1346 foreach my $country ( sort keys %cust_main_county ) {
1347 $script_html .= "\nif ( country == \"$country\" ) {\n";
1348 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1349 my $text = $state || '(n/a)';
1350 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1352 $script_html .= "}\n";
1355 $script_html .= <<END;
1357 function ${prefix}state_changed(what) {
1360 if ( $countyflag ) {
1361 $script_html .= <<END;
1362 state = what.options[what.selectedIndex].text;
1363 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1364 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1365 what.form.${prefix}county.options[i] = null;
1368 foreach my $country ( sort keys %cust_main_county ) {
1369 $script_html .= "\nif ( country == \"$country\" ) {\n";
1370 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1371 $script_html .= "\nif ( state == \"$state\" ) {\n";
1372 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1373 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1374 my $text = $county || '(n/a)';
1376 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1378 $script_html .= "}\n";
1380 $script_html .= "}\n";
1384 $script_html .= <<END;
1389 my $county_html = $script_html;
1390 if ( $countyflag ) {
1391 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1392 $county_html .= '</SELECT>';
1395 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1398 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1399 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1400 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1401 my $text = $state || '(n/a)';
1402 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1403 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1405 $state_html .= '</SELECT>';
1407 my $country_html = '';
1408 if ( scalar( keys %cust_main_county ) > 1 ) {
1410 $country_html = qq(<SELECT NAME="${prefix}country" ).
1411 qq(onChange="${prefix}country_changed(this); ).
1412 $param->{'onchange'}.
1415 my $countrydefault = $param->{default_country} || 'US';
1416 foreach my $country (
1417 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1418 keys %cust_main_county
1420 my $selected = $country eq $param->{'selected_country'}
1423 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1425 $country_html .= '</SELECT>';
1428 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1429 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1433 ($county_html, $state_html, $country_html);
1437 sub regionselector_hashref {
1438 my ($county_html, $state_html, $country_html) = regionselector(@_);
1440 'county_html' => $county_html,
1441 'state_html' => $state_html,
1442 'country_html' => $country_html,
1446 =item location_form HASHREF | LIST
1448 Takes as input a hashref or list of key/value pairs with the following keys:
1454 Current customer session_id
1458 Omit red asterisks from required fields.
1460 =item address1_label
1462 Label for first address line.
1466 Returns an HTML fragment for a location form (address, city, state, zip,
1479 my $session_id = delete $param->{'session_id'};
1481 my $rv = mason_comp( 'session_id' => $session_id,
1482 'comp' => '/elements/location.html',
1483 'args' => [ %$param ],
1487 $rv->{'error'} || $rv->{'output'};
1492 #=item expselect HASHREF | LIST
1494 #Takes as input a hashref or list of key/value pairs with the following keys:
1498 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1500 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1504 =item expselect PREFIX [ DATE ]
1506 Takes as input a unique prefix string and the current expiration date, in
1507 yyyy-mm-dd or m-d-yyyy format
1509 Returns an HTML fragments for expiration date selection.
1515 #if ( ref($_[0]) ) {
1519 #my $prefix = $param->{'prefix'};
1520 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1521 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1523 my $date = scalar(@_) ? shift : '';
1525 my( $m, $y ) = ( 0, 0 );
1526 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1527 ( $m, $y ) = ( $2, $1 );
1528 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1529 ( $m, $y ) = ( $1, $3 );
1531 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1533 $return .= qq!<OPTION VALUE="$_"!;
1534 $return .= " SELECTED" if $_ == $m;
1537 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1539 my $thisYear = $t[5] + 1900;
1540 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1541 $return .= qq!<OPTION VALUE="$_"!;
1542 $return .= " SELECTED" if $_ == $y;
1545 $return .= "</SELECT>";
1550 =item popselector HASHREF | LIST
1552 Takes as input a hashref or list of key/value pairs with the following keys:
1558 Access number number
1562 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>.
1566 Returns an HTML fragment for access number selection.
1570 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1578 my $popnum = $param->{'popnum'};
1579 my $pops = $param->{'pops'};
1581 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1582 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1583 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1584 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1585 if scalar(@$pops) == 1;
1588 my %popnum2pop = ();
1590 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1591 $popnum2pop{$_->{popnum}} = $_;
1596 function opt(what,href,text) {
1597 var optionName = new Option(text, href, false, false)
1598 var length = what.length;
1599 what.options[length] = optionName;
1603 my $init_popstate = $param->{'init_popstate'};
1604 if ( $init_popstate ) {
1605 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1606 $init_popstate. '">';
1609 function acstate_changed(what) {
1610 state = what.options[what.selectedIndex].text;
1611 what.form.popac.options.length = 0
1612 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1616 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1617 foreach my $state ( sort { $a cmp $b } @states ) {
1618 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1620 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1621 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1622 if ($ac eq $param->{'popac'}) {
1623 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1626 $text .= "}\n" unless $init_popstate;
1628 $text .= "popac_changed(what.form.popac)}\n";
1631 function popac_changed(what) {
1632 ac = what.options[what.selectedIndex].text;
1633 what.form.popnum.options.length = 0;
1634 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1638 foreach my $state ( @states ) {
1639 foreach my $popac ( keys %{ $pop{$state} } ) {
1640 $text .= "\nif ( ac == \"$popac\" ) {\n";
1642 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1643 my $o_popnum = $pop->{popnum};
1644 my $poptext = $pop->{city}. ', '. $pop->{state}.
1645 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1647 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1648 if ($popnum == $o_popnum) {
1649 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1657 $text .= "}\n</SCRIPT>\n";
1660 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1661 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1662 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1663 ">$_" foreach sort { $a cmp $b } @states;
1664 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1667 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1668 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1670 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1673 #comment this block to disable initial list polulation
1674 my @initial_select = ();
1675 if ( scalar( @$pops ) > 100 ) {
1676 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1678 @initial_select = @$pops;
1680 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1681 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1682 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1683 $pop->{city}. ', '. $pop->{state}.
1684 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1687 $text .= qq!</SELECT></TD></TR></TABLE>!;
1693 =item domainselector HASHREF | LIST
1695 Takes as input a hashref or list of key/value pairs with the following keys:
1705 Service number of the selected item.
1709 Returns an HTML fragment for domain selection.
1713 sub domainselector {
1720 my $domsvc= $param->{'domsvc'};
1722 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1723 my $domains = $rv->{'domains'};
1724 $domsvc = $rv->{'domsvc'} unless $domsvc;
1726 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1727 unless scalar(keys %$domains);
1729 if (scalar(keys %$domains) == 1) {
1731 foreach(keys %$domains) {
1734 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1735 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1738 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1741 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1742 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1743 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1744 $domains->{$domain};
1747 $text .= qq!</SELECT></TD></TR>!;
1753 =item didselector HASHREF | LIST
1755 Takes as input a hashref or list of key/value pairs with the following keys:
1761 Field name for the returned HTML fragment.
1765 Service definition (see L<FS::part_svc>)
1769 Returns an HTML fragment for DID selection.
1781 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1782 'args'=>[ %$param ],
1786 $rv->{'error'} || $rv->{'output'};
1792 =head1 RESELLER FUNCTIONS
1794 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1795 with their active session, and the B<customer_info> and B<order_pkg> functions
1796 with their active session and an additional I<custnum> parameter.
1798 For the most part, development of the reseller web interface has been
1799 superceded by agent-virtualized access to the backend.
1811 =item agent_list_customers
1813 List agent's customers.
1821 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>