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 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
57 'charge' => 'MyAccount/charge', #?
58 'part_svc_info' => 'MyAccount/part_svc_info',
59 'provision_acct' => 'MyAccount/provision_acct',
60 'provision_phone' => 'MyAccount/provision_phone',
61 'provision_external' => 'MyAccount/provision_external',
62 'unprovision_svc' => 'MyAccount/unprovision_svc',
63 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
64 'create_ticket' => 'MyAccount/create_ticket',
65 'get_ticket' => 'MyAccount/get_ticket',
66 'did_report' => 'MyAccount/did_report',
67 'signup_info' => 'Signup/signup_info',
68 'skin_info' => 'MyAccount/skin_info',
69 'access_info' => 'MyAccount/access_info',
70 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
71 'new_customer' => 'Signup/new_customer',
72 'capture_payment' => 'Signup/capture_payment',
73 'agent_login' => 'Agent/agent_login',
74 'agent_logout' => 'Agent/agent_logout',
75 'agent_info' => 'Agent/agent_info',
76 'agent_list_customers' => 'Agent/agent_list_customers',
77 'check_username' => 'Agent/check_username',
78 'suspend_username' => 'Agent/suspend_username',
79 'unsuspend_username' => 'Agent/unsuspend_username',
80 'mason_comp' => 'MasonComponent/mason_comp',
81 'call_time' => 'PrepaidPhone/call_time',
82 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
83 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
85 #'bulk_processrow' => 'Bulk/processrow',
86 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
88 'ping' => 'SGNG/ping',
89 'decompify_pkgs' => 'SGNG/decompify_pkgs',
90 'previous_payment_info' => 'SGNG/previous_payment_info',
91 'previous_payment_info_renew_info'
92 => 'SGNG/previous_payment_info_renew_info',
93 'previous_process_payment' => 'SGNG/previous_process_payment',
94 'previous_process_payment_order_pkg'
95 => 'SGNG/previous_process_payment_order_pkg',
96 'previous_process_payment_change_pkg'
97 => 'SGNG/previous_process_payment_change_pkg',
98 'previous_process_payment_order_renew'
99 => 'SGNG/previous_process_payment_order_renew',
103 qw( regionselector regionselector_hashref location_form
104 expselect popselector domainselector didselector
108 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
109 $ENV{'SHELL'} = '/bin/sh';
110 $ENV{'IFS'} = " \t\n";
113 $ENV{'BASH_ENV'} = '';
115 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
116 #if you grant appropriate permissions to whatever user
117 my $freeside_uid = scalar(getpwnam('freeside'));
118 die "not running as the freeside user\n"
119 if $> != $freeside_uid && ! $skip_uid_check;
121 -e $dir or die "FATAL: $dir doesn't exist!";
122 -d $dir or die "FATAL: $dir isn't a directory!";
123 -r $dir or die "FATAL: Can't read $dir as freeside user!";
124 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
126 foreach my $autoload ( keys %autoload ) {
129 "sub $autoload { ". '
134 #warn scalar(@_). ": ". join(" / ", @_);
138 $param->{_packet} = \''. $autoload{$autoload}. '\';
140 simple_packet($param);
150 warn "sending ". $packet->{_packet}. " to server"
152 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
153 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
154 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
157 #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
159 #block until there is a message on socket
160 # my $w = new IO::Select;
162 # my @wait = $w->can_read;
164 warn "reading message from server"
167 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
168 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
170 warn "returning message to client"
178 FS::SelfService - Freeside self-service API
182 # password and shell account changes
183 use FS::SelfService qw(passwd chfn chsh);
185 # "my account" functionality
186 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
188 my $rv = login( { 'username' => $username,
190 'password' => $password,
194 if ( $rv->{'error'} ) {
195 #handle login error...
198 my $session_id = $rv->{'session_id'};
201 my $customer_info = customer_info( { 'session_id' => $session_id } );
203 #payment_info and process_payment are available in 1.5+ only
204 my $payment_info = payment_info( { 'session_id' => $session_id } );
206 #!!! process_payment example
208 #!!! list_pkgs example
210 #!!! order_pkg example
212 #!!! cancel_pkg example
214 # signup functionality
215 use FS::SelfService qw( signup_info new_customer );
217 my $signup_info = signup_info;
219 $rv = new_customer( {
222 'company' => $company,
223 'address1' => $address1,
224 'address2' => $address2,
228 'country' => $country,
229 'daytime' => $daytime,
233 'payinfo' => $payinfo,
235 'paystart_month' => $paystart_month
236 'paystart_year' => $paystart_year,
237 'payissue' => $payissue,
239 'paydate' => $paydate,
240 'payname' => $payname,
241 'invoicing_list' => $invoicing_list,
242 'referral_custnum' => $referral_custnum,
243 'agentnum' => $agentnum,
244 'pkgpart' => $pkgpart,
246 'username' => $username,
247 '_password' => $password,
251 'phonenum' => $phonenum,
256 my $error = $rv->{'error'};
257 if ( $error eq '_decline' ) {
267 Use this API to implement your own client "self-service" module.
269 If you just want to customize the look of the existing "self-service" module,
272 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
284 =head1 "MY ACCOUNT" FUNCTIONS
290 Creates a user session. Takes a hash reference as parameter with the
309 Returns a hash reference with the following keys:
315 Empty on success, or an error message on errors.
319 Session identifier for successful logins
323 =item customer_info HASHREF
325 Returns general customer information.
327 Takes a hash reference as parameter with a single key: B<session_id>
329 Returns a hash reference with the following keys:
343 Array reference of hash references of open inoices. Each hash reference has
344 the following keys: invnum, date, owed
348 An HTML fragment containing shipping and billing addresses.
350 =item The following fields are also returned
352 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
356 =item edit_info HASHREF
358 Takes a hash reference as parameter with any of the following keys:
360 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
362 If a field exists, the customer record is updated with the new value of that
363 field. If a field does not exist, that field is not changed on the customer
366 Returns a hash reference with a single key, B<error>, empty on success, or an
367 error message on errors
369 =item invoice HASHREF
371 Returns an invoice. Takes a hash reference as parameter with two keys:
372 session_id and invnum
374 Returns a hash reference with the following keys:
380 Empty on success, or an error message on errors
392 =item list_invoices HASHREF
394 Returns a list of all customer invoices. Takes a hash references with a single
397 Returns a hash reference with the following keys:
403 Empty on success, or an error message on errors
407 Reference to array of hash references with the following keys:
417 Invoice date, in UNIX epoch time
425 Cancels this customer.
427 Takes a hash reference as parameter with a single key: B<session_id>
429 Returns a hash reference with a single key, B<error>, which is empty on
430 success or an error message on errors.
432 =item payment_info HASHREF
434 Returns information that may be useful in displaying a payment page.
436 Takes a hash reference as parameter with a single key: B<session_id>.
438 Returns a hash reference with the following keys:
444 Empty on success, or an error message on errors
452 Exact name on credit card (CARD/DCRD)
476 Customer's current default payment type.
480 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
484 For CARD/DCRD payment types, the card number
488 For CARD/DCRD payment types, expiration month
492 For CARD/DCRD payment types, expiration year
494 =item cust_main_county
496 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.
500 Array reference of all states in the current default country.
504 Hash reference of card types; keys are card types, values are the exact strings
505 passed to the process_payment function
509 #this doesn't actually work yet
513 #Unique transaction identifier (prevents multiple charges), passed to the
514 #process_payment function
518 =item process_payment HASHREF
520 Processes a payment and possible change of address or payment type. Takes a
521 hash reference as parameter with the following keys:
535 If true, address and card information entered will be saved for subsequent
540 If true, future credit card payments will be done automatically (sets payby to
541 CARD). If false, future credit card payments will be done on-demand (sets
542 payby to DCRD). This option only has meaning if B<save> is set true.
570 Two-letter country code
578 Card expiration month
586 #this doesn't actually work yet
590 #Unique transaction identifier, returned from the payment_info function.
591 #Prevents multiple charges.
595 Returns a hash reference with a single key, B<error>, empty on success, or an
596 error message on errors.
598 =item process_payment_order_pkg
600 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
601 payment processes sucessfully, the package is ordered. Takes a hash reference
602 as parameter with the keys of both methods.
604 Returns a hash reference with a single key, B<error>, empty on success, or an
605 error message on errors.
607 =item process_payment_change_pkg
609 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
610 payment processes sucessfully, the package is ordered. Takes a hash reference
611 as parameter with the keys of both methods.
613 Returns a hash reference with a single key, B<error>, empty on success, or an
614 error message on errors.
617 =item process_payment_order_renew
619 Combines the B<process_payment> and B<order_renew> functions in one step. If
620 the payment processes sucessfully, the renewal is processed. Takes a hash
621 reference as parameter with the keys of both methods.
623 Returns a hash reference with a single key, B<error>, empty on success, or an
624 error message on errors.
628 Returns package information for this customer. For more detail on services,
631 Takes a hash reference as parameter with a single key: B<session_id>
633 Returns a hash reference containing customer package information. The hash reference contains the following keys:
643 Empty on success, or an error message on errors.
645 =item cust_pkg HASHREF
647 Array reference of hash references, each of which has the fields of a cust_pkg
648 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
649 the internal FS:: objects, but hash references of columns and values.
653 =item part_pkg fields
655 All fields of part_pkg for this specific cust_pkg (be careful with this
656 information - it may reveal more about your available packages than you would
657 like users to know in aggregate)
661 #XXX pare part_pkg fields down to a more secure subset
665 An array of hash references indicating information on unprovisioned services
666 available for provisioning for this specific cust_pkg. Each has the following
671 =item part_svc fields
673 All fields of part_svc (be careful with this information - it may reveal more
674 about your available packages than you would like users to know in aggregate)
678 #XXX pare part_svc fields down to a more secure subset
684 An array of hash references indicating information on the customer services
685 already provisioned for this specific cust_pkg. Each has the following keys:
691 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.
697 Primary key for this service
701 Service definition (see L<FS::part_svc>)
705 Customer package (see L<FS::cust_pkg>)
709 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
717 Returns service information for this customer.
719 Takes a hash reference as parameter with a single key: B<session_id>
721 Returns a hash reference containing customer package information. The hash reference contains the following keys:
731 An array of hash references indicating information on all of this customer's
732 services. Each has the following keys:
738 Primary key for this service
746 Meaningful user-specific identifier for the service (i.e. username, domain, or
751 Account (svc_acct) services also have the following keys:
769 Upload bytes remaining
773 Download bytes remaining
777 Total bytes remaining
779 =item recharge_amount
783 =item recharge_seconds
785 Number of seconds gained by recharge
787 =item recharge_upbytes
789 Number of upload bytes gained by recharge
791 =item recharge_downbytes
793 Number of download bytes gained by recharge
795 =item recharge_totalbytes
797 Number of total bytes gained by recharge
805 Orders a package for this customer.
807 Takes a hash reference as parameter with the following keys:
817 Package to order (see L<FS::part_pkg>).
821 Service to order (see L<FS::part_svc>).
823 Normally optional; required only to provision a non-svc_acct service, or if the
824 package definition does not contain one svc_acct service definition with
825 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
826 also be specified to indicate that no initial service should be provisioned.
830 Fields used when provisioning an svc_acct service:
844 Optional security phrase
848 Optional Access number number
852 Fields used when provisioning an svc_domain service:
862 Fields used when provisioning an svc_phone service:
880 Fields used when provisioning an svc_external service:
894 Returns a hash reference with a single key, B<error>, empty on success, or an
895 error message on errors. The special error '_decline' is returned for
896 declined transactions.
900 Changes a package for this customer.
902 Takes a hash reference as parameter with the following keys:
912 Existing customer package.
916 New package to order (see L<FS::part_pkg>).
920 Returns a hash reference with a single key, B<error>, empty on success, or an
921 error message on errors.
925 Provides useful info for early renewals.
927 Takes a hash reference as parameter with the following keys:
937 Returns a hash reference. On errors, it contains a single key, B<error>, with
938 the error message. Otherwise, contains a single key, B<dates>, pointing to
939 an array refernce of hash references. Each hash reference contains the
946 (Future) Bill date. Indicates a future date for which billing could be run.
947 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
950 =item bill_date_pretty
952 (Future) Bill date as a human-readable string. (Convenience for display;
953 subject to change, so best not to parse for the date.)
957 Base amount which will be charged if renewed early as of this date.
961 Renewal date; i.e. even-futher future date at which the customer will be paid
962 through if the early renewal is completed with the given B<bill-date>.
963 Specified as a integer UNIX timestamp.
965 =item renew_date_pretty
967 Renewal date as a human-readable string. (Convenience for display;
968 subject to change, so best not to parse for the date.)
972 Package that will be renewed.
976 Expiration date of the package that will be renewed.
978 =item expire_date_pretty
980 Expiration date of the package that will be renewed, as a human-readable
981 string. (Convenience for display; subject to change, so best not to parse for
988 Renews this customer early; i.e. runs billing for this customer in advance.
990 Takes a hash reference as parameter with the following keys:
1000 Integer date as returned by the B<renew_info> function, indicating the advance
1001 date for which to run billing.
1005 Returns a hash reference with a single key, B<error>, empty on success, or an
1006 error message on errors.
1010 Cancels a package for this customer.
1012 Takes a hash reference as parameter with the following keys:
1022 pkgpart of package to cancel
1026 Returns a hash reference with a single key, B<error>, empty on success, or an
1027 error message on errors.
1031 =head1 SIGNUP FUNCTIONS
1035 =item signup_info HASHREF
1037 Takes a hash reference as parameter with the following keys:
1041 =item session_id - Optional agent/reseller interface session
1045 Returns a hash reference containing information that may be useful in
1046 displaying a signup page. The hash reference contains the following keys:
1050 =item cust_main_county
1052 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.
1056 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
1057 an agentnum specified explicitly via reseller interface session_id in the
1062 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.
1064 =item agentnum2part_pkg
1066 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.
1070 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.
1072 =item security_phrase
1074 True if the "security_phrase" feature is enabled
1078 Array reference of acceptable payment types for signup
1084 credit card - automatic
1088 credit card - on-demand - version 1.5+ only
1092 electronic check - automatic
1096 electronic check - on-demand - version 1.5+ only
1104 billing, not recommended for signups
1108 free, definitely not recommended for signups
1112 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1118 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1122 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".
1128 =item countrydefault
1134 =item new_customer HASHREF
1136 Creates a new customer. Takes a hash reference as parameter with the
1143 first name (required)
1147 last name (required)
1151 (not typically collected; mostly used for ACH transactions)
1157 =item address1 (required)
1165 =item city (required)
1173 =item state (required)
1177 =item zip (required)
1183 Daytime phone number
1187 Evening phone number
1195 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1199 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1203 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1207 Expiration date for CARD/DCRD
1211 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1213 =item invoicing_list
1215 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),
1217 =item referral_custnum
1219 referring customer number
1227 pkgpart of initial package
1243 Access number (index, not the literal number)
1247 Country code (to be provisioned as a service)
1251 Phone number (to be provisioned as a service)
1259 Returns a hash reference with the following keys:
1265 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)
1269 =item regionselector HASHREF | LIST
1271 Takes as input a hashref or list of key/value pairs with the following keys:
1275 =item selected_county
1277 Currently selected county
1279 =item selected_state
1281 Currently selected state
1283 =item selected_country
1285 Currently selected country
1289 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1293 Specify a javascript subroutine to call on changes
1299 =item default_country
1305 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>.
1309 Returns a list consisting of three HTML fragments for county selection,
1310 state selection and country selection, respectively.
1314 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1315 sub regionselector {
1322 $param->{'selected_country'} ||= $param->{'default_country'};
1323 $param->{'selected_state'} ||= $param->{'default_state'};
1325 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1329 my %cust_main_county;
1331 # unless ( @cust_main_county ) { #cache
1332 #@cust_main_county = qsearch('cust_main_county', {} );
1333 #foreach my $c ( @cust_main_county ) {
1334 foreach my $c ( @{ $param->{'locales'} } ) {
1335 #$countyflag=1 if $c->county;
1336 $countyflag=1 if $c->{county};
1337 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1338 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1339 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1342 $countyflag=1 if $param->{selected_county};
1344 my $script_html = <<END;
1346 function opt(what,value,text) {
1347 var optionName = new Option(text, value, false, false);
1348 var length = what.length;
1349 what.options[length] = optionName;
1351 function ${prefix}country_changed(what) {
1352 country = what.options[what.selectedIndex].text;
1353 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1354 what.form.${prefix}state.options[i] = null;
1356 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1358 foreach my $country ( sort keys %cust_main_county ) {
1359 $script_html .= "\nif ( country == \"$country\" ) {\n";
1360 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1361 my $text = $state || '(n/a)';
1362 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1364 $script_html .= "}\n";
1367 $script_html .= <<END;
1369 function ${prefix}state_changed(what) {
1372 if ( $countyflag ) {
1373 $script_html .= <<END;
1374 state = what.options[what.selectedIndex].text;
1375 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1376 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1377 what.form.${prefix}county.options[i] = null;
1380 foreach my $country ( sort keys %cust_main_county ) {
1381 $script_html .= "\nif ( country == \"$country\" ) {\n";
1382 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1383 $script_html .= "\nif ( state == \"$state\" ) {\n";
1384 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1385 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1386 my $text = $county || '(n/a)';
1388 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1390 $script_html .= "}\n";
1392 $script_html .= "}\n";
1396 $script_html .= <<END;
1401 my $county_html = $script_html;
1402 if ( $countyflag ) {
1403 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1404 foreach my $county (
1405 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1407 my $text = $county || '(n/a)';
1408 $county_html .= qq!<OPTION VALUE="$county"!.
1409 ($county eq $param->{'selected_county'} ?
1416 $county_html .= '</SELECT>';
1419 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1422 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1423 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1424 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1425 my $text = $state || '(n/a)';
1426 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1427 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1429 $state_html .= '</SELECT>';
1431 my $country_html = '';
1432 if ( scalar( keys %cust_main_county ) > 1 ) {
1434 $country_html = qq(<SELECT NAME="${prefix}country" ).
1435 qq(onChange="${prefix}country_changed(this); ).
1436 $param->{'onchange'}.
1439 my $countrydefault = $param->{default_country} || 'US';
1440 foreach my $country (
1441 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1442 keys %cust_main_county
1444 my $selected = $country eq $param->{'selected_country'}
1447 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1449 $country_html .= '</SELECT>';
1452 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1453 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1457 ($county_html, $state_html, $country_html);
1461 sub regionselector_hashref {
1462 my ($county_html, $state_html, $country_html) = regionselector(@_);
1464 'county_html' => $county_html,
1465 'state_html' => $state_html,
1466 'country_html' => $country_html,
1470 =item location_form HASHREF | LIST
1472 Takes as input a hashref or list of key/value pairs with the following keys:
1478 Current customer session_id
1482 Omit red asterisks from required fields.
1484 =item address1_label
1486 Label for first address line.
1490 Returns an HTML fragment for a location form (address, city, state, zip,
1503 my $session_id = delete $param->{'session_id'};
1505 my $rv = mason_comp( 'session_id' => $session_id,
1506 'comp' => '/elements/location.html',
1507 'args' => [ %$param ],
1511 $rv->{'error'} || $rv->{'output'};
1516 #=item expselect HASHREF | LIST
1518 #Takes as input a hashref or list of key/value pairs with the following keys:
1522 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1524 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1528 =item expselect PREFIX [ DATE ]
1530 Takes as input a unique prefix string and the current expiration date, in
1531 yyyy-mm-dd or m-d-yyyy format
1533 Returns an HTML fragments for expiration date selection.
1539 #if ( ref($_[0]) ) {
1543 #my $prefix = $param->{'prefix'};
1544 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1545 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1547 my $date = scalar(@_) ? shift : '';
1549 my( $m, $y ) = ( 0, 0 );
1550 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1551 ( $m, $y ) = ( $2, $1 );
1552 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1553 ( $m, $y ) = ( $1, $3 );
1555 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1557 $return .= qq!<OPTION VALUE="$_"!;
1558 $return .= " SELECTED" if $_ == $m;
1561 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1563 my $thisYear = $t[5] + 1900;
1564 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1565 $return .= qq!<OPTION VALUE="$_"!;
1566 $return .= " SELECTED" if $_ == $y;
1569 $return .= "</SELECT>";
1574 =item popselector HASHREF | LIST
1576 Takes as input a hashref or list of key/value pairs with the following keys:
1582 Access number number
1586 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>.
1590 Returns an HTML fragment for access number selection.
1594 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1602 my $popnum = $param->{'popnum'};
1603 my $pops = $param->{'pops'};
1605 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1606 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1607 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1608 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1609 if scalar(@$pops) == 1;
1612 my %popnum2pop = ();
1614 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1615 $popnum2pop{$_->{popnum}} = $_;
1620 function opt(what,href,text) {
1621 var optionName = new Option(text, href, false, false)
1622 var length = what.length;
1623 what.options[length] = optionName;
1627 my $init_popstate = $param->{'init_popstate'};
1628 if ( $init_popstate ) {
1629 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1630 $init_popstate. '">';
1633 function acstate_changed(what) {
1634 state = what.options[what.selectedIndex].text;
1635 what.form.popac.options.length = 0
1636 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1640 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1641 foreach my $state ( sort { $a cmp $b } @states ) {
1642 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1644 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1645 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1646 if ($ac eq $param->{'popac'}) {
1647 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1650 $text .= "}\n" unless $init_popstate;
1652 $text .= "popac_changed(what.form.popac)}\n";
1655 function popac_changed(what) {
1656 ac = what.options[what.selectedIndex].text;
1657 what.form.popnum.options.length = 0;
1658 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1662 foreach my $state ( @states ) {
1663 foreach my $popac ( keys %{ $pop{$state} } ) {
1664 $text .= "\nif ( ac == \"$popac\" ) {\n";
1666 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1667 my $o_popnum = $pop->{popnum};
1668 my $poptext = $pop->{city}. ', '. $pop->{state}.
1669 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1671 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1672 if ($popnum == $o_popnum) {
1673 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1681 $text .= "}\n</SCRIPT>\n";
1683 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1686 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1687 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1688 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1689 ">$_" foreach sort { $a cmp $b } @states;
1690 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1693 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1694 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1696 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1699 #comment this block to disable initial list polulation
1700 my @initial_select = ();
1701 if ( scalar( @$pops ) > 100 ) {
1702 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1704 @initial_select = @$pops;
1706 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1707 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1708 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1709 $pop->{city}. ', '. $pop->{state}.
1710 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1713 $text .= qq!</SELECT></TD></TR></TABLE>!;
1719 =item domainselector HASHREF | LIST
1721 Takes as input a hashref or list of key/value pairs with the following keys:
1731 Service number of the selected item.
1735 Returns an HTML fragment for domain selection.
1739 sub domainselector {
1746 my $domsvc= $param->{'domsvc'};
1748 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1749 my $domains = $rv->{'domains'};
1750 $domsvc = $rv->{'domsvc'} unless $domsvc;
1752 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1753 unless scalar(keys %$domains);
1755 if (scalar(keys %$domains) == 1) {
1757 foreach(keys %$domains) {
1760 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1761 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1764 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1767 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1768 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1769 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1770 $domains->{$domain};
1773 $text .= qq!</SELECT></TD></TR>!;
1779 =item didselector HASHREF | LIST
1781 Takes as input a hashref or list of key/value pairs with the following keys:
1787 Field name for the returned HTML fragment.
1791 Service definition (see L<FS::part_svc>)
1795 Returns an HTML fragment for DID selection.
1807 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1808 'args'=>[ %$param ],
1812 $rv->{'error'} || $rv->{'output'};
1818 =head1 RESELLER FUNCTIONS
1820 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1821 with their active session, and the B<customer_info> and B<order_pkg> functions
1822 with their active session and an additional I<custnum> parameter.
1824 For the most part, development of the reseller web interface has been
1825 superceded by agent-virtualized access to the backend.
1837 =item agent_list_customers
1839 List agent's customers.
1847 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>