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 'switch_acct' => 'MyAccount/switch_acct',
32 'customer_info' => 'MyAccount/customer_info',
33 'customer_info_short' => 'MyAccount/customer_info_short',
34 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
35 'invoice' => 'MyAccount/invoice',
36 'invoice_pdf' => 'MyAccount/invoice_pdf',
37 'legacy_invoice' => 'MyAccount/legacy_invoice',
38 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
39 'invoice_logo' => 'MyAccount/invoice_logo',
40 'list_invoices' => 'MyAccount/list_invoices', #?
41 'cancel' => 'MyAccount/cancel', #add to ss cgi!
42 'payment_info' => 'MyAccount/payment_info',
43 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
44 'process_payment' => 'MyAccount/process_payment',
45 'store_payment' => 'MyAccount/store_payment',
46 'process_stored_payment' => 'MyAccount/process_stored_payment',
47 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
48 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
49 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
50 'process_prepay' => 'MyAccount/process_prepay',
51 'realtime_collect' => 'MyAccount/realtime_collect',
52 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
53 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
54 'list_svc_usage' => 'MyAccount/list_svc_usage',
55 'svc_status_html' => 'MyAccount/svc_status_html',
56 'acct_forward_info' => 'MyAccount/acct_forward_info',
57 'process_acct_forward' => 'MyAccount/process_acct_forward',
58 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
59 'add_dsl_device' => 'MyAccount/add_dsl_device',
60 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
61 'port_graph' => 'MyAccount/port_graph',
62 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
63 'list_support_usage' => 'MyAccount/list_support_usage',
64 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
65 'change_pkg' => 'MyAccount/change_pkg',
66 'order_recharge' => 'MyAccount/order_recharge',
67 'renew_info' => 'MyAccount/renew_info',
68 'order_renew' => 'MyAccount/order_renew',
69 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
70 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
71 'charge' => 'MyAccount/charge', #?
72 'part_svc_info' => 'MyAccount/part_svc_info',
73 'provision_acct' => 'MyAccount/provision_acct',
74 'provision_phone' => 'MyAccount/provision_phone',
75 'provision_external' => 'MyAccount/provision_external',
76 'unprovision_svc' => 'MyAccount/unprovision_svc',
77 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
78 'reset_passwd' => 'MyAccount/reset_passwd',
79 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
80 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
81 'create_ticket' => 'MyAccount/create_ticket',
82 'get_ticket' => 'MyAccount/get_ticket',
83 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
84 'did_report' => 'MyAccount/did_report',
85 'signup_info' => 'Signup/signup_info',
86 'skin_info' => 'MyAccount/skin_info',
87 'access_info' => 'MyAccount/access_info',
88 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
89 'new_customer' => 'Signup/new_customer',
90 'capture_payment' => 'Signup/capture_payment',
91 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
92 'new_agent' => 'Agent/new_agent',
93 'agent_login' => 'Agent/agent_login',
94 'agent_logout' => 'Agent/agent_logout',
95 'agent_info' => 'Agent/agent_info',
96 'agent_list_customers' => 'Agent/agent_list_customers',
97 'check_username' => 'Agent/check_username',
98 'suspend_username' => 'Agent/suspend_username',
99 'unsuspend_username' => 'Agent/unsuspend_username',
100 'mason_comp' => 'MasonComponent/mason_comp',
101 'call_time' => 'PrepaidPhone/call_time',
102 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
103 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
105 #'bulk_processrow' => 'Bulk/processrow',
106 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
108 'ping' => 'SGNG/ping',
109 'decompify_pkgs' => 'SGNG/decompify_pkgs',
110 'previous_payment_info' => 'SGNG/previous_payment_info',
111 'previous_payment_info_renew_info'
112 => 'SGNG/previous_payment_info_renew_info',
113 'previous_process_payment' => 'SGNG/previous_process_payment',
114 'previous_process_payment_order_pkg'
115 => 'SGNG/previous_process_payment_order_pkg',
116 'previous_process_payment_change_pkg'
117 => 'SGNG/previous_process_payment_change_pkg',
118 'previous_process_payment_order_renew'
119 => 'SGNG/previous_process_payment_order_renew',
123 qw( regionselector regionselector_hashref location_form
124 expselect popselector domainselector didselector
128 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
129 $ENV{'SHELL'} = '/bin/sh';
130 $ENV{'IFS'} = " \t\n";
133 $ENV{'BASH_ENV'} = '';
135 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
136 #if you grant appropriate permissions to whatever user
137 my $freeside_uid = scalar(getpwnam('freeside'));
138 die "not running as the freeside user\n"
139 if $> != $freeside_uid && ! $skip_uid_check;
141 -e $dir or die "FATAL: $dir doesn't exist!";
142 -d $dir or die "FATAL: $dir isn't a directory!";
143 -r $dir or die "FATAL: Can't read $dir as freeside user!";
144 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
146 foreach my $autoload ( keys %autoload ) {
149 "sub $autoload { ". '
154 #warn scalar(@_). ": ". join(" / ", @_);
158 $param->{_packet} = \''. $autoload{$autoload}. '\';
160 simple_packet($param);
170 warn "sending ". $packet->{_packet}. " to server"
172 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
173 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
174 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
177 #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
179 #block until there is a message on socket
180 # my $w = new IO::Select;
182 # my @wait = $w->can_read;
184 warn "reading message from server"
187 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
188 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
190 warn "returning message to client"
198 FS::SelfService - Freeside self-service API
202 # password and shell account changes
203 use FS::SelfService qw(passwd chfn chsh);
205 # "my account" functionality
206 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
208 my $rv = login( { 'username' => $username,
210 'password' => $password,
214 if ( $rv->{'error'} ) {
215 #handle login error...
218 my $session_id = $rv->{'session_id'};
221 my $customer_info = customer_info( { 'session_id' => $session_id } );
223 #payment_info and process_payment are available in 1.5+ only
224 my $payment_info = payment_info( { 'session_id' => $session_id } );
226 #!!! process_payment example
228 #!!! list_pkgs example
230 #!!! order_pkg example
232 #!!! cancel_pkg example
234 # signup functionality
235 use FS::SelfService qw( signup_info new_customer );
237 my $signup_info = signup_info;
239 $rv = new_customer( {
242 'company' => $company,
243 'address1' => $address1,
244 'address2' => $address2,
248 'country' => $country,
249 'daytime' => $daytime,
253 'payinfo' => $payinfo,
255 'paystart_month' => $paystart_month
256 'paystart_year' => $paystart_year,
257 'payissue' => $payissue,
259 'paydate' => $paydate,
260 'payname' => $payname,
261 'invoicing_list' => $invoicing_list,
262 'referral_custnum' => $referral_custnum,
263 'agentnum' => $agentnum,
264 'pkgpart' => $pkgpart,
266 'username' => $username,
267 '_password' => $password,
271 'phonenum' => $phonenum,
276 my $error = $rv->{'error'};
277 if ( $error eq '_decline' ) {
287 Use this API to implement your own client "self-service" module.
289 If you just want to customize the look of the existing "self-service" module,
292 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
304 =head1 "MY ACCOUNT" FUNCTIONS
310 Creates a user session. Takes a hash reference as parameter with the
329 Returns a hash reference with the following keys:
335 Empty on success, or an error message on errors.
339 Session identifier for successful logins
343 =item customer_info HASHREF
345 Returns general customer information.
347 Takes a hash reference as parameter with a single key: B<session_id>
349 Returns a hash reference with the following keys:
363 Array reference of hash references of open inoices. Each hash reference has
364 the following keys: invnum, date, owed
368 An HTML fragment containing shipping and billing addresses.
370 =item The following fields are also returned
372 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
376 =item edit_info HASHREF
378 Takes a hash reference as parameter with any of the following keys:
380 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
382 If a field exists, the customer record is updated with the new value of that
383 field. If a field does not exist, that field is not changed on the customer
386 Returns a hash reference with a single key, B<error>, empty on success, or an
387 error message on errors
389 =item invoice HASHREF
391 Returns an invoice. Takes a hash reference as parameter with two keys:
392 session_id and invnum
394 Returns a hash reference with the following keys:
400 Empty on success, or an error message on errors
412 =item list_invoices HASHREF
414 Returns a list of all customer invoices. Takes a hash references with a single
417 Returns a hash reference with the following keys:
423 Empty on success, or an error message on errors
427 Reference to array of hash references with the following keys:
437 Invoice date, in UNIX epoch time
445 Cancels this customer.
447 Takes a hash reference as parameter with a single key: B<session_id>
449 Returns a hash reference with a single key, B<error>, which is empty on
450 success or an error message on errors.
452 =item payment_info HASHREF
454 Returns information that may be useful in displaying a payment page.
456 Takes a hash reference as parameter with a single key: B<session_id>.
458 Returns a hash reference with the following keys:
464 Empty on success, or an error message on errors
472 Exact name on credit card (CARD/DCRD)
496 Customer's current default payment type.
500 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
504 For CARD/DCRD payment types, the card number
508 For CARD/DCRD payment types, expiration month
512 For CARD/DCRD payment types, expiration year
514 =item cust_main_county
516 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.
520 Array reference of all states in the current default country.
524 Hash reference of card types; keys are card types, values are the exact strings
525 passed to the process_payment function
529 #this doesn't actually work yet
533 #Unique transaction identifier (prevents multiple charges), passed to the
534 #process_payment function
538 =item process_payment HASHREF
540 Processes a payment and possible change of address or payment type. Takes a
541 hash reference as parameter with the following keys:
555 If true, address and card information entered will be saved for subsequent
560 If true, future credit card payments will be done automatically (sets payby to
561 CARD). If false, future credit card payments will be done on-demand (sets
562 payby to DCRD). This option only has meaning if B<save> is set true.
590 Two-letter country code
598 Card expiration month
606 #this doesn't actually work yet
610 #Unique transaction identifier, returned from the payment_info function.
611 #Prevents multiple charges.
615 Returns a hash reference with a single key, B<error>, empty on success, or an
616 error message on errors.
618 =item process_payment_order_pkg
620 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
621 payment processes sucessfully, the package is ordered. Takes a hash reference
622 as parameter with the keys of both methods.
624 Returns a hash reference with a single key, B<error>, empty on success, or an
625 error message on errors.
627 =item process_payment_change_pkg
629 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
630 payment processes sucessfully, the package is ordered. Takes a hash reference
631 as parameter with the keys of both methods.
633 Returns a hash reference with a single key, B<error>, empty on success, or an
634 error message on errors.
637 =item process_payment_order_renew
639 Combines the B<process_payment> and B<order_renew> functions in one step. If
640 the payment processes sucessfully, the renewal is processed. Takes a hash
641 reference as parameter with the keys of both methods.
643 Returns a hash reference with a single key, B<error>, empty on success, or an
644 error message on errors.
648 Returns package information for this customer. For more detail on services,
651 Takes a hash reference as parameter with a single key: B<session_id>
653 Returns a hash reference containing customer package information. The hash reference contains the following keys:
663 Empty on success, or an error message on errors.
665 =item cust_pkg HASHREF
667 Array reference of hash references, each of which has the fields of a cust_pkg
668 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
669 the internal FS:: objects, but hash references of columns and values.
673 =item part_pkg fields
675 All fields of part_pkg for this specific cust_pkg (be careful with this
676 information - it may reveal more about your available packages than you would
677 like users to know in aggregate)
681 #XXX pare part_pkg fields down to a more secure subset
685 An array of hash references indicating information on unprovisioned services
686 available for provisioning for this specific cust_pkg. Each has the following
691 =item part_svc fields
693 All fields of part_svc (be careful with this information - it may reveal more
694 about your available packages than you would like users to know in aggregate)
698 #XXX pare part_svc fields down to a more secure subset
704 An array of hash references indicating information on the customer services
705 already provisioned for this specific cust_pkg. Each has the following keys:
711 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.
717 Primary key for this service
721 Service definition (see L<FS::part_svc>)
725 Customer package (see L<FS::cust_pkg>)
729 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
737 Returns service information for this customer.
739 Takes a hash reference as parameter with a single key: B<session_id>
741 Returns a hash reference containing customer package information. The hash reference contains the following keys:
751 An array of hash references indicating information on all of this customer's
752 services. Each has the following keys:
758 Primary key for this service
766 Meaningful user-specific identifier for the service (i.e. username, domain, or
771 Account (svc_acct) services also have the following keys:
789 Upload bytes remaining
793 Download bytes remaining
797 Total bytes remaining
799 =item recharge_amount
803 =item recharge_seconds
805 Number of seconds gained by recharge
807 =item recharge_upbytes
809 Number of upload bytes gained by recharge
811 =item recharge_downbytes
813 Number of download bytes gained by recharge
815 =item recharge_totalbytes
817 Number of total bytes gained by recharge
825 Orders a package for this customer.
827 Takes a hash reference as parameter with the following keys:
837 Package to order (see L<FS::part_pkg>).
841 Service to order (see L<FS::part_svc>).
843 Normally optional; required only to provision a non-svc_acct service, or if the
844 package definition does not contain one svc_acct service definition with
845 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
846 also be specified to indicate that no initial service should be provisioned.
850 Fields used when provisioning an svc_acct service:
864 Optional security phrase
868 Optional Access number number
872 Fields used when provisioning an svc_domain service:
882 Fields used when provisioning an svc_phone service:
900 Fields used when provisioning an svc_external service:
914 Fields used when provisioning an svc_pbx service:
928 Returns a hash reference with a single key, B<error>, empty on success, or an
929 error message on errors. The special error '_decline' is returned for
930 declined transactions.
934 Changes a package for this customer.
936 Takes a hash reference as parameter with the following keys:
946 Existing customer package.
950 New package to order (see L<FS::part_pkg>).
954 Returns a hash reference with the following keys:
960 Empty on success, or an error message on errors.
964 On success, the new pkgnum
971 Provides useful info for early renewals.
973 Takes a hash reference as parameter with the following keys:
983 Returns a hash reference. On errors, it contains a single key, B<error>, with
984 the error message. Otherwise, contains a single key, B<dates>, pointing to
985 an array refernce of hash references. Each hash reference contains the
992 (Future) Bill date. Indicates a future date for which billing could be run.
993 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
996 =item bill_date_pretty
998 (Future) Bill date as a human-readable string. (Convenience for display;
999 subject to change, so best not to parse for the date.)
1003 Base amount which will be charged if renewed early as of this date.
1007 Renewal date; i.e. even-futher future date at which the customer will be paid
1008 through if the early renewal is completed with the given B<bill-date>.
1009 Specified as a integer UNIX timestamp.
1011 =item renew_date_pretty
1013 Renewal date as a human-readable string. (Convenience for display;
1014 subject to change, so best not to parse for the date.)
1018 Package that will be renewed.
1022 Expiration date of the package that will be renewed.
1024 =item expire_date_pretty
1026 Expiration date of the package that will be renewed, as a human-readable
1027 string. (Convenience for display; subject to change, so best not to parse for
1034 Renews this customer early; i.e. runs billing for this customer in advance.
1036 Takes a hash reference as parameter with the following keys:
1046 Integer date as returned by the B<renew_info> function, indicating the advance
1047 date for which to run billing.
1051 Returns a hash reference with a single key, B<error>, empty on success, or an
1052 error message on errors.
1056 Cancels a package for this customer.
1058 Takes a hash reference as parameter with the following keys:
1068 pkgpart of package to cancel
1072 Returns a hash reference with a single key, B<error>, empty on success, or an
1073 error message on errors.
1077 =head1 SIGNUP FUNCTIONS
1081 =item signup_info HASHREF
1083 Takes a hash reference as parameter with the following keys:
1087 =item session_id - Optional agent/reseller interface session
1091 Returns a hash reference containing information that may be useful in
1092 displaying a signup page. The hash reference contains the following keys:
1096 =item cust_main_county
1098 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.
1102 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
1103 an agentnum specified explicitly via reseller interface session_id in the
1108 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.
1110 =item agentnum2part_pkg
1112 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.
1116 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.
1118 =item security_phrase
1120 True if the "security_phrase" feature is enabled
1124 Array reference of acceptable payment types for signup
1130 credit card - automatic
1134 credit card - on-demand - version 1.5+ only
1138 electronic check - automatic
1142 electronic check - on-demand - version 1.5+ only
1150 billing, not recommended for signups
1154 free, definitely not recommended for signups
1158 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1164 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1168 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".
1174 =item countrydefault
1180 =item new_customer HASHREF
1182 Creates a new customer. Takes a hash reference as parameter with the
1189 first name (required)
1193 last name (required)
1197 (not typically collected; mostly used for ACH transactions)
1203 =item address1 (required)
1211 =item city (required)
1219 =item state (required)
1223 =item zip (required)
1229 Daytime phone number
1233 Evening phone number
1241 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1245 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1249 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1253 Expiration date for CARD/DCRD
1257 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1259 =item invoicing_list
1261 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),
1263 =item referral_custnum
1265 referring customer number
1273 pkgpart of initial package
1289 Access number (index, not the literal number)
1293 Country code (to be provisioned as a service)
1297 Phone number (to be provisioned as a service)
1305 Returns a hash reference with the following keys:
1311 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)
1315 =item regionselector HASHREF | LIST
1317 Takes as input a hashref or list of key/value pairs with the following keys:
1321 =item selected_county
1323 Currently selected county
1325 =item selected_state
1327 Currently selected state
1329 =item selected_country
1331 Currently selected country
1335 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1339 Specify a javascript subroutine to call on changes
1345 =item default_country
1351 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>.
1355 Returns a list consisting of three HTML fragments for county selection,
1356 state selection and country selection, respectively.
1360 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1361 sub regionselector {
1368 $param->{'selected_country'} ||= $param->{'default_country'};
1369 $param->{'selected_state'} ||= $param->{'default_state'};
1371 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1375 my %cust_main_county;
1377 # unless ( @cust_main_county ) { #cache
1378 #@cust_main_county = qsearch('cust_main_county', {} );
1379 #foreach my $c ( @cust_main_county ) {
1380 foreach my $c ( @{ $param->{'locales'} } ) {
1381 #$countyflag=1 if $c->county;
1382 $countyflag=1 if $c->{county};
1383 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1384 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1385 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1388 $countyflag=1 if $param->{selected_county};
1390 my $script_html = <<END;
1392 function opt(what,value,text) {
1393 var optionName = new Option(text, value, false, false);
1394 var length = what.length;
1395 what.options[length] = optionName;
1397 function ${prefix}country_changed(what) {
1398 country = what.options[what.selectedIndex].text;
1399 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1400 what.form.${prefix}state.options[i] = null;
1402 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1404 foreach my $country ( sort keys %cust_main_county ) {
1405 $script_html .= "\nif ( country == \"$country\" ) {\n";
1406 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1407 my $text = $state || '(n/a)';
1408 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1410 $script_html .= "}\n";
1413 $script_html .= <<END;
1415 function ${prefix}state_changed(what) {
1418 if ( $countyflag ) {
1419 $script_html .= <<END;
1420 state = what.options[what.selectedIndex].text;
1421 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1422 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1423 what.form.${prefix}county.options[i] = null;
1426 foreach my $country ( sort keys %cust_main_county ) {
1427 $script_html .= "\nif ( country == \"$country\" ) {\n";
1428 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1429 $script_html .= "\nif ( state == \"$state\" ) {\n";
1430 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1431 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1432 my $text = $county || '(n/a)';
1434 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1436 $script_html .= "}\n";
1438 $script_html .= "}\n";
1442 $script_html .= <<END;
1447 my $county_html = $script_html;
1448 if ( $countyflag ) {
1449 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1450 foreach my $county (
1451 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1453 my $text = $county || '(n/a)';
1454 $county_html .= qq!<OPTION VALUE="$county"!.
1455 ($county eq $param->{'selected_county'} ?
1462 $county_html .= '</SELECT>';
1465 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1468 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1469 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1470 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1471 my $text = $state || '(n/a)';
1472 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1473 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1475 $state_html .= '</SELECT>';
1477 my $country_html = '';
1478 if ( scalar( keys %cust_main_county ) > 1 ) {
1480 $country_html = qq(<SELECT NAME="${prefix}country" ).
1481 qq(onChange="${prefix}country_changed(this); ).
1482 $param->{'onchange'}.
1485 my $countrydefault = $param->{default_country} || 'US';
1486 foreach my $country (
1487 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1488 keys %cust_main_county
1490 my $selected = $country eq $param->{'selected_country'}
1493 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1495 $country_html .= '</SELECT>';
1498 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1499 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1503 ($county_html, $state_html, $country_html);
1507 sub regionselector_hashref {
1508 my ($county_html, $state_html, $country_html) = regionselector(@_);
1510 'county_html' => $county_html,
1511 'state_html' => $state_html,
1512 'country_html' => $country_html,
1516 =item location_form HASHREF | LIST
1518 Takes as input a hashref or list of key/value pairs with the following keys:
1524 Current customer session_id
1528 Omit red asterisks from required fields.
1530 =item address1_label
1532 Label for first address line.
1536 Returns an HTML fragment for a location form (address, city, state, zip,
1549 my $session_id = delete $param->{'session_id'};
1551 my $rv = mason_comp( 'session_id' => $session_id,
1552 'comp' => '/elements/location.html',
1553 'args' => [ %$param ],
1557 $rv->{'error'} || $rv->{'output'};
1562 #=item expselect HASHREF | LIST
1564 #Takes as input a hashref or list of key/value pairs with the following keys:
1568 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1570 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1574 =item expselect PREFIX [ DATE ]
1576 Takes as input a unique prefix string and the current expiration date, in
1577 yyyy-mm-dd or m-d-yyyy format
1579 Returns an HTML fragments for expiration date selection.
1585 #if ( ref($_[0]) ) {
1589 #my $prefix = $param->{'prefix'};
1590 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1591 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1593 my $date = scalar(@_) ? shift : '';
1595 my( $m, $y ) = ( 0, 0 );
1596 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1597 ( $m, $y ) = ( $2, $1 );
1598 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1599 ( $m, $y ) = ( $1, $3 );
1601 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1603 $return .= qq!<OPTION VALUE="$_"!;
1604 $return .= " SELECTED" if $_ == $m;
1607 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1609 my $thisYear = $t[5] + 1900;
1610 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1611 $return .= qq!<OPTION VALUE="$_"!;
1612 $return .= " SELECTED" if $_ == $y;
1615 $return .= "</SELECT>";
1620 =item popselector HASHREF | LIST
1622 Takes as input a hashref or list of key/value pairs with the following keys:
1628 Access number number
1632 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>.
1636 Returns an HTML fragment for access number selection.
1640 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1648 my $popnum = $param->{'popnum'};
1649 my $pops = $param->{'pops'};
1651 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1652 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1653 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1654 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1655 if scalar(@$pops) == 1;
1658 my %popnum2pop = ();
1660 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1661 $popnum2pop{$_->{popnum}} = $_;
1666 function opt(what,href,text) {
1667 var optionName = new Option(text, href, false, false)
1668 var length = what.length;
1669 what.options[length] = optionName;
1673 my $init_popstate = $param->{'init_popstate'};
1674 if ( $init_popstate ) {
1675 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1676 $init_popstate. '">';
1679 function acstate_changed(what) {
1680 state = what.options[what.selectedIndex].text;
1681 what.form.popac.options.length = 0
1682 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1686 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1687 foreach my $state ( sort { $a cmp $b } @states ) {
1688 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1690 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1691 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1692 if ($ac eq $param->{'popac'}) {
1693 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1696 $text .= "}\n" unless $init_popstate;
1698 $text .= "popac_changed(what.form.popac)}\n";
1701 function popac_changed(what) {
1702 ac = what.options[what.selectedIndex].text;
1703 what.form.popnum.options.length = 0;
1704 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1708 foreach my $state ( @states ) {
1709 foreach my $popac ( keys %{ $pop{$state} } ) {
1710 $text .= "\nif ( ac == \"$popac\" ) {\n";
1712 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1713 my $o_popnum = $pop->{popnum};
1714 my $poptext = $pop->{city}. ', '. $pop->{state}.
1715 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1717 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1718 if ($popnum == $o_popnum) {
1719 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1727 $text .= "}\n</SCRIPT>\n";
1729 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1732 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1733 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1734 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1735 ">$_" foreach sort { $a cmp $b } @states;
1736 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1739 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1740 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1742 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1745 #comment this block to disable initial list polulation
1746 my @initial_select = ();
1747 if ( scalar( @$pops ) > 100 ) {
1748 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1750 @initial_select = @$pops;
1752 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1753 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1754 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1755 $pop->{city}. ', '. $pop->{state}.
1756 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1759 $text .= qq!</SELECT></TD></TR></TABLE>!;
1765 =item domainselector HASHREF | LIST
1767 Takes as input a hashref or list of key/value pairs with the following keys:
1777 Service number of the selected item.
1781 Returns an HTML fragment for domain selection.
1785 sub domainselector {
1792 my $domsvc= $param->{'domsvc'};
1794 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1795 my $domains = $rv->{'domains'};
1796 $domsvc = $rv->{'domsvc'} unless $domsvc;
1798 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1799 unless scalar(keys %$domains);
1801 if (scalar(keys %$domains) == 1) {
1803 foreach(keys %$domains) {
1806 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1807 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1810 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1813 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1814 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1815 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1816 $domains->{$domain};
1819 $text .= qq!</SELECT></TD></TR>!;
1825 =item didselector HASHREF | LIST
1827 Takes as input a hashref or list of key/value pairs with the following keys:
1833 Field name for the returned HTML fragment.
1837 Service definition (see L<FS::part_svc>)
1841 Returns an HTML fragment for DID selection.
1853 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1854 'args'=>[ %$param ],
1858 $rv->{'error'} || $rv->{'output'};
1864 =head1 RESELLER FUNCTIONS
1866 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1867 with their active session, and the B<customer_info> and B<order_pkg> functions
1868 with their active session and an additional I<custnum> parameter.
1870 For the most part, development of the reseller web interface has been
1871 superceded by agent-virtualized access to the backend.
1883 =item agent_list_customers
1885 List agent's customers.
1893 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>