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_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'switch_cust' => 'MyAccount/switch_cust',
34 'customer_info' => 'MyAccount/customer_info',
35 'customer_info_short' => 'MyAccount/customer_info_short',
36 'billing_history' => 'MyAccount/billing_history',
37 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
38 'invoice' => 'MyAccount/invoice',
39 'invoice_pdf' => 'MyAccount/invoice_pdf',
40 'legacy_invoice' => 'MyAccount/legacy_invoice',
41 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
42 'invoice_logo' => 'MyAccount/invoice_logo',
43 'list_invoices' => 'MyAccount/list_invoices', #?
44 'cancel' => 'MyAccount/cancel', #add to ss cgi!
45 'payment_info' => 'MyAccount/payment_info',
46 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
47 'process_payment' => 'MyAccount/process_payment',
48 'store_payment' => 'MyAccount/store_payment',
49 'process_stored_payment' => 'MyAccount/process_stored_payment',
50 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
51 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
52 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
53 'process_prepay' => 'MyAccount/process_prepay',
54 'realtime_collect' => 'MyAccount/realtime_collect',
55 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
56 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
57 'list_svc_usage' => 'MyAccount/list_svc_usage',
58 'svc_status_html' => 'MyAccount/svc_status_html',
59 'svc_status_hash' => 'MyAccount/svc_status_hash',
60 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
61 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
62 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
63 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
64 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
65 'acct_forward_info' => 'MyAccount/acct_forward_info',
66 'process_acct_forward' => 'MyAccount/process_acct_forward',
67 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
68 'add_dsl_device' => 'MyAccount/add_dsl_device',
69 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
70 'port_graph' => 'MyAccount/port_graph',
71 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
72 'list_support_usage' => 'MyAccount/list_support_usage',
73 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
74 'change_pkg' => 'MyAccount/change_pkg',
75 'order_recharge' => 'MyAccount/order_recharge',
76 'renew_info' => 'MyAccount/renew_info',
77 'order_renew' => 'MyAccount/order_renew',
78 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
79 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
80 'charge' => 'MyAccount/charge', #?
81 'part_svc_info' => 'MyAccount/part_svc_info',
82 'provision_acct' => 'MyAccount/provision_acct',
83 'provision_phone' => 'MyAccount/provision_phone',
84 'provision_external' => 'MyAccount/provision_external',
85 'unprovision_svc' => 'MyAccount/unprovision_svc',
86 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
87 'reset_passwd' => 'MyAccount/reset_passwd',
88 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
89 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
90 'list_tickets' => 'MyAccount/list_tickets',
91 'create_ticket' => 'MyAccount/create_ticket',
92 'get_ticket' => 'MyAccount/get_ticket',
93 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
94 'did_report' => 'MyAccount/did_report',
95 'signup_info' => 'Signup/signup_info',
96 'skin_info' => 'MyAccount/skin_info',
97 'access_info' => 'MyAccount/access_info',
98 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
99 'new_customer' => 'Signup/new_customer',
100 'new_customer_minimal' => 'Signup/new_customer_minimal',
101 'capture_payment' => 'Signup/capture_payment',
102 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
103 'new_agent' => 'Agent/new_agent',
104 'agent_login' => 'Agent/agent_login',
105 'agent_logout' => 'Agent/agent_logout',
106 'agent_info' => 'Agent/agent_info',
107 'agent_list_customers' => 'Agent/agent_list_customers',
108 'check_username' => 'Agent/check_username',
109 'suspend_username' => 'Agent/suspend_username',
110 'unsuspend_username' => 'Agent/unsuspend_username',
111 'mason_comp' => 'MasonComponent/mason_comp',
112 'call_time' => 'PrepaidPhone/call_time',
113 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
114 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
116 'start_thirdparty' => 'MyAccount/start_thirdparty',
117 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
121 qw( regionselector regionselector_hashref location_form
122 expselect popselector domainselector didselector
126 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
127 $ENV{'SHELL'} = '/bin/sh';
128 $ENV{'IFS'} = " \t\n";
131 $ENV{'BASH_ENV'} = '';
133 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
134 #if you grant appropriate permissions to whatever user
135 my $freeside_uid = scalar(getpwnam('freeside'));
136 die "not running as the freeside user\n"
137 if $> != $freeside_uid && ! $skip_uid_check;
139 -e $dir or die "FATAL: $dir doesn't exist!";
140 -d $dir or die "FATAL: $dir isn't a directory!";
141 -r $dir or die "FATAL: Can't read $dir as freeside user!";
142 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
144 foreach my $autoload ( keys %autoload ) {
147 "sub $autoload { ". '
152 #warn scalar(@_). ": ". join(" / ", @_);
156 $param->{_packet} = \''. $autoload{$autoload}. '\';
158 simple_packet($param);
168 warn "sending ". $packet->{_packet}. " to server"
170 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
171 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
172 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
175 #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
177 #block until there is a message on socket
178 # my $w = new IO::Select;
180 # my @wait = $w->can_read;
182 warn "reading message from server"
185 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
186 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
188 warn "returning message to client"
196 FS::SelfService - Freeside self-service API
200 # password and shell account changes
201 use FS::SelfService qw(passwd chfn chsh);
203 # "my account" functionality
204 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
206 my $rv = login( { 'username' => $username,
208 'password' => $password,
212 if ( $rv->{'error'} ) {
213 #handle login error...
216 my $session_id = $rv->{'session_id'};
219 my $customer_info = customer_info( { 'session_id' => $session_id } );
221 #payment_info and process_payment are available in 1.5+ only
222 my $payment_info = payment_info( { 'session_id' => $session_id } );
224 #!!! process_payment example
226 #!!! list_pkgs example
228 #!!! order_pkg example
230 #!!! cancel_pkg example
232 # signup functionality
233 use FS::SelfService qw( signup_info new_customer );
235 my $signup_info = signup_info;
237 $rv = new_customer( {
240 'company' => $company,
241 'address1' => $address1,
242 'address2' => $address2,
246 'country' => $country,
247 'daytime' => $daytime,
251 'payinfo' => $payinfo,
253 'paystart_month' => $paystart_month
254 'paystart_year' => $paystart_year,
255 'payissue' => $payissue,
257 'paydate' => $paydate,
258 'payname' => $payname,
259 'invoicing_list' => $invoicing_list,
260 'referral_custnum' => $referral_custnum,
261 'agentnum' => $agentnum,
262 'pkgpart' => $pkgpart,
264 'username' => $username,
265 '_password' => $password,
269 'phonenum' => $phonenum,
274 my $error = $rv->{'error'};
275 if ( $error eq '_decline' ) {
285 Use this API to implement your own client "self-service" module.
287 If you just want to customize the look of the existing "self-service" module,
290 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
302 =head1 "MY ACCOUNT" FUNCTIONS
308 Creates a user session. Takes a hash reference as parameter with the
327 Returns a hash reference with the following keys:
333 Empty on success, or an error message on errors.
337 Session identifier for successful logins
341 =item customer_info HASHREF
343 Returns general customer information.
345 Takes a hash reference as parameter with a single key: B<session_id>
347 Returns a hash reference with the following keys:
361 Array reference of hash references of open inoices. Each hash reference has
362 the following keys: invnum, date, owed
366 An HTML fragment containing shipping and billing addresses.
368 =item The following fields are also returned
370 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
374 =item edit_info HASHREF
376 Takes a hash reference as parameter with any of the following keys:
378 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
380 If a field exists, the customer record is updated with the new value of that
381 field. If a field does not exist, that field is not changed on the customer
384 Returns a hash reference with a single key, B<error>, empty on success, or an
385 error message on errors
387 =item invoice HASHREF
389 Returns an invoice. Takes a hash reference as parameter with two keys:
390 session_id and invnum
392 Returns a hash reference with the following keys:
398 Empty on success, or an error message on errors
410 =item list_invoices HASHREF
412 Returns a list of all customer invoices. Takes a hash references with a single
415 Returns a hash reference with the following keys:
421 Empty on success, or an error message on errors
425 Reference to array of hash references with the following keys:
435 Invoice date, in UNIX epoch time
443 Cancels this customer.
445 Takes a hash reference as parameter with a single key: B<session_id>
447 Returns a hash reference with a single key, B<error>, which is empty on
448 success or an error message on errors.
450 =item payment_info HASHREF
452 Returns information that may be useful in displaying a payment page.
454 Takes a hash reference as parameter with a single key: B<session_id>.
456 Returns a hash reference with the following keys:
462 Empty on success, or an error message on errors
470 Exact name on credit card (CARD/DCRD)
494 Customer's current default payment type.
498 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
502 For CARD/DCRD payment types, the card number
506 For CARD/DCRD payment types, expiration month
510 For CARD/DCRD payment types, expiration year
512 =item cust_main_county
514 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.
518 Array reference of all states in the current default country.
522 Hash reference of card types; keys are card types, values are the exact strings
523 passed to the process_payment function
527 #this doesn't actually work yet
531 #Unique transaction identifier (prevents multiple charges), passed to the
532 #process_payment function
536 =item process_payment HASHREF
538 Processes a payment and possible change of address or payment type. Takes a
539 hash reference as parameter with the following keys:
553 If true, address and card information entered will be saved for subsequent
558 If true, future credit card payments will be done automatically (sets payby to
559 CARD). If false, future credit card payments will be done on-demand (sets
560 payby to DCRD). This option only has meaning if B<save> is set true.
588 Two-letter country code
596 Card expiration month
604 #this doesn't actually work yet
608 #Unique transaction identifier, returned from the payment_info function.
609 #Prevents multiple charges.
613 Returns a hash reference with a single key, B<error>, empty on success, or an
614 error message on errors.
616 =item process_payment_order_pkg
618 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
619 payment processes sucessfully, the package is ordered. Takes a hash reference
620 as parameter with the keys of both methods.
622 Returns a hash reference with a single key, B<error>, empty on success, or an
623 error message on errors.
625 =item process_payment_change_pkg
627 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
628 payment processes sucessfully, the package is ordered. Takes a hash reference
629 as parameter with the keys of both methods.
631 Returns a hash reference with a single key, B<error>, empty on success, or an
632 error message on errors.
635 =item process_payment_order_renew
637 Combines the B<process_payment> and B<order_renew> functions in one step. If
638 the payment processes sucessfully, the renewal is processed. Takes a hash
639 reference as parameter with the keys of both methods.
641 Returns a hash reference with a single key, B<error>, empty on success, or an
642 error message on errors.
646 Returns package information for this customer. For more detail on services,
649 Takes a hash reference as parameter with a single key: B<session_id>
651 Returns a hash reference containing customer package information. The hash reference contains the following keys:
661 Empty on success, or an error message on errors.
663 =item cust_pkg HASHREF
665 Array reference of hash references, each of which has the fields of a cust_pkg
666 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
667 the internal FS:: objects, but hash references of columns and values.
671 =item part_pkg fields
673 All fields of part_pkg for this specific cust_pkg (be careful with this
674 information - it may reveal more about your available packages than you would
675 like users to know in aggregate)
679 #XXX pare part_pkg fields down to a more secure subset
683 An array of hash references indicating information on unprovisioned services
684 available for provisioning for this specific cust_pkg. Each has the following
689 =item part_svc fields
691 All fields of part_svc (be careful with this information - it may reveal more
692 about your available packages than you would like users to know in aggregate)
696 #XXX pare part_svc fields down to a more secure subset
702 An array of hash references indicating information on the customer services
703 already provisioned for this specific cust_pkg. Each has the following keys:
709 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.
715 Primary key for this service
719 Service definition (see L<FS::part_svc>)
723 Customer package (see L<FS::cust_pkg>)
727 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
735 Returns service information for this customer.
737 Takes a hash reference as parameter with a single key: B<session_id>
739 Returns a hash reference containing customer package information. The hash reference contains the following keys:
749 An array of hash references indicating information on all of this customer's
750 services. Each has the following keys:
756 Primary key for this service
764 Meaningful user-specific identifier for the service (i.e. username, domain, or
769 Account (svc_acct) services also have the following keys:
787 Upload bytes remaining
791 Download bytes remaining
795 Total bytes remaining
797 =item recharge_amount
801 =item recharge_seconds
803 Number of seconds gained by recharge
805 =item recharge_upbytes
807 Number of upload bytes gained by recharge
809 =item recharge_downbytes
811 Number of download bytes gained by recharge
813 =item recharge_totalbytes
815 Number of total bytes gained by recharge
823 Orders a package for this customer.
825 Takes a hash reference as parameter with the following keys:
835 Package to order (see L<FS::part_pkg>).
839 Service to order (see L<FS::part_svc>).
841 Normally optional; required only to provision a non-svc_acct service, or if the
842 package definition does not contain one svc_acct service definition with
843 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
844 also be specified to indicate that no initial service should be provisioned.
848 Fields used when provisioning an svc_acct service:
862 Optional security phrase
866 Optional Access number number
870 Fields used when provisioning an svc_domain service:
880 Fields used when provisioning an svc_phone service:
898 Fields used when provisioning an svc_external service:
912 Fields used when provisioning an svc_pbx service:
926 Returns a hash reference with a single key, B<error>, empty on success, or an
927 error message on errors. The special error '_decline' is returned for
928 declined transactions.
932 Changes a package for this customer.
934 Takes a hash reference as parameter with the following keys:
944 Existing customer package.
948 New package to order (see L<FS::part_pkg>).
952 Returns a hash reference with the following keys:
958 Empty on success, or an error message on errors.
962 On success, the new pkgnum
969 Provides useful info for early renewals.
971 Takes a hash reference as parameter with the following keys:
981 Returns a hash reference. On errors, it contains a single key, B<error>, with
982 the error message. Otherwise, contains a single key, B<dates>, pointing to
983 an array refernce of hash references. Each hash reference contains the
990 (Future) Bill date. Indicates a future date for which billing could be run.
991 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
994 =item bill_date_pretty
996 (Future) Bill date as a human-readable string. (Convenience for display;
997 subject to change, so best not to parse for the date.)
1001 Base amount which will be charged if renewed early as of this date.
1005 Renewal date; i.e. even-futher future date at which the customer will be paid
1006 through if the early renewal is completed with the given B<bill-date>.
1007 Specified as a integer UNIX timestamp.
1009 =item renew_date_pretty
1011 Renewal date as a human-readable string. (Convenience for display;
1012 subject to change, so best not to parse for the date.)
1016 Package that will be renewed.
1020 Expiration date of the package that will be renewed.
1022 =item expire_date_pretty
1024 Expiration date of the package that will be renewed, as a human-readable
1025 string. (Convenience for display; subject to change, so best not to parse for
1032 Renews this customer early; i.e. runs billing for this customer in advance.
1034 Takes a hash reference as parameter with the following keys:
1044 Integer date as returned by the B<renew_info> function, indicating the advance
1045 date for which to run billing.
1049 Returns a hash reference with a single key, B<error>, empty on success, or an
1050 error message on errors.
1054 Cancels a package for this customer.
1056 Takes a hash reference as parameter with the following keys:
1066 pkgpart of package to cancel
1070 Returns a hash reference with a single key, B<error>, empty on success, or an
1071 error message on errors.
1075 =head1 SIGNUP FUNCTIONS
1079 =item signup_info HASHREF
1081 Takes a hash reference as parameter with the following keys:
1085 =item session_id - Optional agent/reseller interface session
1089 Returns a hash reference containing information that may be useful in
1090 displaying a signup page. The hash reference contains the following keys:
1094 =item cust_main_county
1096 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.
1100 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
1101 an agentnum specified explicitly via reseller interface session_id in the
1106 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.
1108 =item agentnum2part_pkg
1110 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.
1114 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.
1116 =item security_phrase
1118 True if the "security_phrase" feature is enabled
1122 Array reference of acceptable payment types for signup
1128 credit card - automatic
1132 credit card - on-demand - version 1.5+ only
1136 electronic check - automatic
1140 electronic check - on-demand - version 1.5+ only
1148 billing, not recommended for signups
1152 free, definitely not recommended for signups
1156 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1162 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1166 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".
1172 =item countrydefault
1178 =item new_customer HASHREF
1180 Creates a new customer. Takes a hash reference as parameter with the
1187 first name (required)
1191 last name (required)
1195 (not typically collected; mostly used for ACH transactions)
1201 =item address1 (required)
1209 =item city (required)
1217 =item state (required)
1221 =item zip (required)
1227 Daytime phone number
1231 Evening phone number
1239 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1243 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1247 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1251 Expiration date for CARD/DCRD
1255 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1257 =item invoicing_list
1259 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),
1261 =item referral_custnum
1263 referring customer number
1271 pkgpart of initial package
1287 Access number (index, not the literal number)
1291 Country code (to be provisioned as a service)
1295 Phone number (to be provisioned as a service)
1303 Returns a hash reference with the following keys:
1309 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)
1313 =item regionselector HASHREF | LIST
1315 Takes as input a hashref or list of key/value pairs with the following keys:
1319 =item selected_county
1321 Currently selected county
1323 =item selected_state
1325 Currently selected state
1327 =item selected_country
1329 Currently selected country
1333 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1337 Specify a javascript subroutine to call on changes
1343 =item default_country
1349 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>.
1353 Returns a list consisting of three HTML fragments for county selection,
1354 state selection and country selection, respectively.
1358 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1359 sub regionselector {
1366 $param->{'selected_country'} ||= $param->{'default_country'};
1367 $param->{'selected_state'} ||= $param->{'default_state'};
1369 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1373 my %cust_main_county;
1375 # unless ( @cust_main_county ) { #cache
1376 #@cust_main_county = qsearch('cust_main_county', {} );
1377 #foreach my $c ( @cust_main_county ) {
1378 foreach my $c ( @{ $param->{'locales'} } ) {
1379 #$countyflag=1 if $c->county;
1380 $countyflag=1 if $c->{county};
1381 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1382 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1383 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1386 $countyflag=1 if $param->{selected_county};
1388 my $script_html = <<END;
1390 function opt(what,value,text) {
1391 var optionName = new Option(text, value, false, false);
1392 var length = what.length;
1393 what.options[length] = optionName;
1395 function ${prefix}country_changed(what) {
1396 country = what.options[what.selectedIndex].text;
1397 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1398 what.form.${prefix}state.options[i] = null;
1400 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1402 foreach my $country ( sort keys %cust_main_county ) {
1403 $script_html .= "\nif ( country == \"$country\" ) {\n";
1404 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1405 my $text = $state || '(n/a)';
1406 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1408 $script_html .= "}\n";
1411 $script_html .= <<END;
1413 function ${prefix}state_changed(what) {
1416 if ( $countyflag ) {
1417 $script_html .= <<END;
1418 state = what.options[what.selectedIndex].text;
1419 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1420 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1421 what.form.${prefix}county.options[i] = null;
1424 foreach my $country ( sort keys %cust_main_county ) {
1425 $script_html .= "\nif ( country == \"$country\" ) {\n";
1426 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1427 $script_html .= "\nif ( state == \"$state\" ) {\n";
1428 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1429 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1430 my $text = $county || '(n/a)';
1432 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1434 $script_html .= "}\n";
1436 $script_html .= "}\n";
1440 $script_html .= <<END;
1445 my $county_html = $script_html;
1446 if ( $countyflag ) {
1447 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1448 foreach my $county (
1449 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1451 my $text = $county || '(n/a)';
1452 $county_html .= qq!<OPTION VALUE="$county"!.
1453 ($county eq $param->{'selected_county'} ?
1460 $county_html .= '</SELECT>';
1463 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1466 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1467 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1468 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1469 my $text = $state || '(n/a)';
1470 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1471 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
1473 $state_html .= '</SELECT>';
1475 my $country_html = '';
1476 if ( scalar( keys %cust_main_county ) > 1 ) {
1478 $country_html = qq(<SELECT NAME="${prefix}country" ).
1479 qq(onChange="${prefix}country_changed(this); ).
1480 $param->{'onchange'}.
1483 my $countrydefault = $param->{default_country} || 'US';
1484 foreach my $country (
1485 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1486 keys %cust_main_county
1488 my $selected = $country eq $param->{'selected_country'}
1491 $country_html .= "\n<OPTION $selected>$country</OPTION>"
1493 $country_html .= '</SELECT>';
1496 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1497 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1501 ($county_html, $state_html, $country_html);
1505 sub regionselector_hashref {
1506 my ($county_html, $state_html, $country_html) = regionselector(@_);
1508 'county_html' => $county_html,
1509 'state_html' => $state_html,
1510 'country_html' => $country_html,
1514 =item location_form HASHREF | LIST
1516 Takes as input a hashref or list of key/value pairs with the following keys:
1522 Current customer session_id
1526 Omit red asterisks from required fields.
1528 =item address1_label
1530 Label for first address line.
1534 Returns an HTML fragment for a location form (address, city, state, zip,
1547 my $session_id = delete $param->{'session_id'};
1549 my $rv = mason_comp( 'session_id' => $session_id,
1550 'comp' => '/elements/location.html',
1551 'args' => [ %$param ],
1555 $rv->{'error'} || $rv->{'output'};
1560 #=item expselect HASHREF | LIST
1562 #Takes as input a hashref or list of key/value pairs with the following keys:
1566 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1568 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1572 =item expselect PREFIX [ DATE ]
1574 Takes as input a unique prefix string and the current expiration date, in
1575 yyyy-mm-dd or m-d-yyyy format
1577 Returns an HTML fragments for expiration date selection.
1583 #if ( ref($_[0]) ) {
1587 #my $prefix = $param->{'prefix'};
1588 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1589 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1591 my $date = scalar(@_) ? shift : '';
1593 my( $m, $y ) = ( 0, 0 );
1594 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1595 ( $m, $y ) = ( $2, $1 );
1596 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1597 ( $m, $y ) = ( $1, $3 );
1599 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1601 $return .= qq!<OPTION VALUE="$_"!;
1602 $return .= " SELECTED" if $_ == $m;
1605 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1607 my $thisYear = $t[5] + 1900;
1608 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1609 $return .= qq!<OPTION VALUE="$_"!;
1610 $return .= " SELECTED" if $_ == $y;
1613 $return .= "</SELECT>";
1618 =item popselector HASHREF | LIST
1620 Takes as input a hashref or list of key/value pairs with the following keys:
1626 Access number number
1630 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>.
1634 Returns an HTML fragment for access number selection.
1638 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1646 my $popnum = $param->{'popnum'};
1647 my $pops = $param->{'pops'};
1649 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1650 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1651 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1652 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1653 if scalar(@$pops) == 1;
1656 my %popnum2pop = ();
1658 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1659 $popnum2pop{$_->{popnum}} = $_;
1664 function opt(what,href,text) {
1665 var optionName = new Option(text, href, false, false)
1666 var length = what.length;
1667 what.options[length] = optionName;
1671 my $init_popstate = $param->{'init_popstate'};
1672 if ( $init_popstate ) {
1673 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1674 $init_popstate. '">';
1677 function acstate_changed(what) {
1678 state = what.options[what.selectedIndex].text;
1679 what.form.popac.options.length = 0
1680 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1684 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1685 foreach my $state ( sort { $a cmp $b } @states ) {
1686 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1688 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1689 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1690 if ($ac eq $param->{'popac'}) {
1691 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1694 $text .= "}\n" unless $init_popstate;
1696 $text .= "popac_changed(what.form.popac)}\n";
1699 function popac_changed(what) {
1700 ac = what.options[what.selectedIndex].text;
1701 what.form.popnum.options.length = 0;
1702 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1706 foreach my $state ( @states ) {
1707 foreach my $popac ( keys %{ $pop{$state} } ) {
1708 $text .= "\nif ( ac == \"$popac\" ) {\n";
1710 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1711 my $o_popnum = $pop->{popnum};
1712 my $poptext = $pop->{city}. ', '. $pop->{state}.
1713 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1715 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1716 if ($popnum == $o_popnum) {
1717 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1725 $text .= "}\n</SCRIPT>\n";
1727 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1730 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1731 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1732 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1733 ">$_" foreach sort { $a cmp $b } @states;
1734 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1737 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1738 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1740 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1743 #comment this block to disable initial list polulation
1744 my @initial_select = ();
1745 if ( scalar( @$pops ) > 100 ) {
1746 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1748 @initial_select = @$pops;
1750 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1751 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1752 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1753 $pop->{city}. ', '. $pop->{state}.
1754 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1757 $text .= qq!</SELECT></TD></TR></TABLE>!;
1763 =item domainselector HASHREF | LIST
1765 Takes as input a hashref or list of key/value pairs with the following keys:
1775 Service number of the selected item.
1779 Returns an HTML fragment for domain selection.
1783 sub domainselector {
1790 my $domsvc= $param->{'domsvc'};
1792 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1793 my $domains = $rv->{'domains'};
1794 $domsvc = $rv->{'domsvc'} unless $domsvc;
1796 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1797 unless scalar(keys %$domains);
1799 if (scalar(keys %$domains) == 1) {
1801 foreach(keys %$domains) {
1804 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1805 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1808 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
1810 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
1812 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1813 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1814 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1815 $domains->{$domain};
1818 $text .= qq!</SELECT></TD></TR>!;
1824 =item didselector HASHREF | LIST
1826 Takes as input a hashref or list of key/value pairs with the following keys:
1832 Field name for the returned HTML fragment.
1836 Service definition (see L<FS::part_svc>)
1840 Returns an HTML fragment for DID selection.
1852 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1853 'args'=>[ %$param ],
1857 $rv->{'error'} || $rv->{'output'};
1863 =head1 RESELLER FUNCTIONS
1865 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1866 with their active session, and the B<customer_info> and B<order_pkg> functions
1867 with their active session and an additional I<custnum> parameter.
1869 For the most part, development of the reseller web interface has been
1870 superceded by agent-virtualized access to the backend.
1882 =item agent_list_customers
1884 List agent's customers.
1892 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>