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 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
35 'billing_history' => 'MyAccount/billing_history',
36 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
37 'invoice' => 'MyAccount/invoice',
38 'invoice_pdf' => 'MyAccount/invoice_pdf',
39 'legacy_invoice' => 'MyAccount/legacy_invoice',
40 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
41 'invoice_logo' => 'MyAccount/invoice_logo',
42 'list_invoices' => 'MyAccount/list_invoices', #?
43 'cancel' => 'MyAccount/cancel', #add to ss cgi!
44 'payment_info' => 'MyAccount/payment_info',
45 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
46 'process_payment' => 'MyAccount/process_payment',
47 'store_payment' => 'MyAccount/store_payment',
48 'process_stored_payment' => 'MyAccount/process_stored_payment',
49 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
50 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
51 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
52 'process_prepay' => 'MyAccount/process_prepay',
53 'realtime_collect' => 'MyAccount/realtime_collect',
54 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
55 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
56 'list_svc_usage' => 'MyAccount/list_svc_usage',
57 'svc_status_html' => 'MyAccount/svc_status_html',
58 'svc_status_hash' => 'MyAccount/svc_status_hash',
59 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
60 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
61 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
62 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
63 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
64 'acct_forward_info' => 'MyAccount/acct_forward_info',
65 'process_acct_forward' => 'MyAccount/process_acct_forward',
66 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
67 'add_dsl_device' => 'MyAccount/add_dsl_device',
68 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
69 'port_graph' => 'MyAccount/port_graph',
70 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
71 'list_support_usage' => 'MyAccount/list_support_usage',
72 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
73 'change_pkg' => 'MyAccount/change_pkg',
74 'order_recharge' => 'MyAccount/order_recharge',
75 'renew_info' => 'MyAccount/renew_info',
76 'order_renew' => 'MyAccount/order_renew',
77 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
78 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
79 'charge' => 'MyAccount/charge', #?
80 'part_svc_info' => 'MyAccount/part_svc_info',
81 'provision_acct' => 'MyAccount/provision_acct',
82 'provision_phone' => 'MyAccount/provision_phone',
83 'provision_external' => 'MyAccount/provision_external',
84 'unprovision_svc' => 'MyAccount/unprovision_svc',
85 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
86 'reset_passwd' => 'MyAccount/reset_passwd',
87 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
88 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
89 'list_tickets' => 'MyAccount/list_tickets',
90 'create_ticket' => 'MyAccount/create_ticket',
91 'get_ticket' => 'MyAccount/get_ticket',
92 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
93 'did_report' => 'MyAccount/did_report',
94 'signup_info' => 'Signup/signup_info',
95 'skin_info' => 'MyAccount/skin_info',
96 'access_info' => 'MyAccount/access_info',
97 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
98 'new_customer' => 'Signup/new_customer',
99 'new_customer_minimal' => 'Signup/new_customer_minimal',
100 'capture_payment' => 'Signup/capture_payment',
101 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
102 'new_agent' => 'Agent/new_agent',
103 'agent_login' => 'Agent/agent_login',
104 'agent_logout' => 'Agent/agent_logout',
105 'agent_info' => 'Agent/agent_info',
106 'agent_list_customers' => 'Agent/agent_list_customers',
107 'check_username' => 'Agent/check_username',
108 'suspend_username' => 'Agent/suspend_username',
109 'unsuspend_username' => 'Agent/unsuspend_username',
110 'mason_comp' => 'MasonComponent/mason_comp',
111 'call_time' => 'PrepaidPhone/call_time',
112 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
113 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
115 'start_thirdparty' => 'MyAccount/start_thirdparty',
116 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
120 qw( regionselector regionselector_hashref location_form
121 expselect popselector domainselector didselector
125 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
126 $ENV{'SHELL'} = '/bin/sh';
127 $ENV{'IFS'} = " \t\n";
130 $ENV{'BASH_ENV'} = '';
132 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
133 #if you grant appropriate permissions to whatever user
134 my $freeside_uid = scalar(getpwnam('freeside'));
135 die "not running as the freeside user\n"
136 if $> != $freeside_uid && ! $skip_uid_check;
138 -e $dir or die "FATAL: $dir doesn't exist!";
139 -d $dir or die "FATAL: $dir isn't a directory!";
140 -r $dir or die "FATAL: Can't read $dir as freeside user!";
141 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
143 foreach my $autoload ( keys %autoload ) {
146 "sub $autoload { ". '
151 #warn scalar(@_). ": ". join(" / ", @_);
155 $param->{_packet} = \''. $autoload{$autoload}. '\';
157 simple_packet($param);
167 warn "sending ". $packet->{_packet}. " to server"
169 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
170 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
171 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
174 #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
176 #block until there is a message on socket
177 # my $w = new IO::Select;
179 # my @wait = $w->can_read;
181 warn "reading message from server"
184 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
185 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
187 warn "returning message to client"
195 FS::SelfService - Freeside self-service API
199 # password and shell account changes
200 use FS::SelfService qw(passwd chfn chsh);
202 # "my account" functionality
203 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
205 my $rv = login( { 'username' => $username,
207 'password' => $password,
211 if ( $rv->{'error'} ) {
212 #handle login error...
215 my $session_id = $rv->{'session_id'};
218 my $customer_info = customer_info( { 'session_id' => $session_id } );
220 #payment_info and process_payment are available in 1.5+ only
221 my $payment_info = payment_info( { 'session_id' => $session_id } );
223 #!!! process_payment example
225 #!!! list_pkgs example
227 #!!! order_pkg example
229 #!!! cancel_pkg example
231 # signup functionality
232 use FS::SelfService qw( signup_info new_customer );
234 my $signup_info = signup_info;
236 $rv = new_customer( {
239 'company' => $company,
240 'address1' => $address1,
241 'address2' => $address2,
245 'country' => $country,
246 'daytime' => $daytime,
250 'payinfo' => $payinfo,
252 'paystart_month' => $paystart_month
253 'paystart_year' => $paystart_year,
254 'payissue' => $payissue,
256 'paydate' => $paydate,
257 'payname' => $payname,
258 'invoicing_list' => $invoicing_list,
259 'referral_custnum' => $referral_custnum,
260 'agentnum' => $agentnum,
261 'pkgpart' => $pkgpart,
263 'username' => $username,
264 '_password' => $password,
268 'phonenum' => $phonenum,
273 my $error = $rv->{'error'};
274 if ( $error eq '_decline' ) {
284 Use this API to implement your own client "self-service" module.
286 If you just want to customize the look of the existing "self-service" module,
289 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
301 =head1 "MY ACCOUNT" FUNCTIONS
307 Creates a user session. Takes a hash reference as parameter with the
326 Returns a hash reference with the following keys:
332 Empty on success, or an error message on errors.
336 Session identifier for successful logins
340 =item customer_info HASHREF
342 Returns general customer information.
344 Takes a hash reference as parameter with a single key: B<session_id>
346 Returns a hash reference with the following keys:
360 Array reference of hash references of open inoices. Each hash reference has
361 the following keys: invnum, date, owed
365 An HTML fragment containing shipping and billing addresses.
367 =item The following fields are also returned
369 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
373 =item edit_info HASHREF
375 Takes a hash reference as parameter with any of the following keys:
377 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
379 If a field exists, the customer record is updated with the new value of that
380 field. If a field does not exist, that field is not changed on the customer
383 Returns a hash reference with a single key, B<error>, empty on success, or an
384 error message on errors
386 =item invoice HASHREF
388 Returns an invoice. Takes a hash reference as parameter with two keys:
389 session_id and invnum
391 Returns a hash reference with the following keys:
397 Empty on success, or an error message on errors
409 =item list_invoices HASHREF
411 Returns a list of all customer invoices. Takes a hash references with a single
414 Returns a hash reference with the following keys:
420 Empty on success, or an error message on errors
424 Reference to array of hash references with the following keys:
434 Invoice date, in UNIX epoch time
442 Cancels this customer.
444 Takes a hash reference as parameter with a single key: B<session_id>
446 Returns a hash reference with a single key, B<error>, which is empty on
447 success or an error message on errors.
449 =item payment_info HASHREF
451 Returns information that may be useful in displaying a payment page.
453 Takes a hash reference as parameter with a single key: B<session_id>.
455 Returns a hash reference with the following keys:
461 Empty on success, or an error message on errors
469 Exact name on credit card (CARD/DCRD)
493 Customer's current default payment type.
497 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
501 For CARD/DCRD payment types, the card number
505 For CARD/DCRD payment types, expiration month
509 For CARD/DCRD payment types, expiration year
511 =item cust_main_county
513 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.
517 Array reference of all states in the current default country.
521 Hash reference of card types; keys are card types, values are the exact strings
522 passed to the process_payment function
526 #this doesn't actually work yet
530 #Unique transaction identifier (prevents multiple charges), passed to the
531 #process_payment function
535 =item process_payment HASHREF
537 Processes a payment and possible change of address or payment type. Takes a
538 hash reference as parameter with the following keys:
552 If true, address and card information entered will be saved for subsequent
557 If true, future credit card payments will be done automatically (sets payby to
558 CARD). If false, future credit card payments will be done on-demand (sets
559 payby to DCRD). This option only has meaning if B<save> is set true.
587 Two-letter country code
595 Card expiration month
603 #this doesn't actually work yet
607 #Unique transaction identifier, returned from the payment_info function.
608 #Prevents multiple charges.
612 Returns a hash reference with a single key, B<error>, empty on success, or an
613 error message on errors.
615 =item process_payment_order_pkg
617 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
618 payment processes sucessfully, the package is ordered. Takes a hash reference
619 as parameter with the keys of both methods.
621 Returns a hash reference with a single key, B<error>, empty on success, or an
622 error message on errors.
624 =item process_payment_change_pkg
626 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
627 payment processes sucessfully, the package is ordered. Takes a hash reference
628 as parameter with the keys of both methods.
630 Returns a hash reference with a single key, B<error>, empty on success, or an
631 error message on errors.
634 =item process_payment_order_renew
636 Combines the B<process_payment> and B<order_renew> functions in one step. If
637 the payment processes sucessfully, the renewal is processed. Takes a hash
638 reference as parameter with the keys of both methods.
640 Returns a hash reference with a single key, B<error>, empty on success, or an
641 error message on errors.
645 Returns package information for this customer. For more detail on services,
648 Takes a hash reference as parameter with a single key: B<session_id>
650 Returns a hash reference containing customer package information. The hash reference contains the following keys:
660 Empty on success, or an error message on errors.
662 =item cust_pkg HASHREF
664 Array reference of hash references, each of which has the fields of a cust_pkg
665 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
666 the internal FS:: objects, but hash references of columns and values.
670 =item part_pkg fields
672 All fields of part_pkg for this specific cust_pkg (be careful with this
673 information - it may reveal more about your available packages than you would
674 like users to know in aggregate)
678 #XXX pare part_pkg fields down to a more secure subset
682 An array of hash references indicating information on unprovisioned services
683 available for provisioning for this specific cust_pkg. Each has the following
688 =item part_svc fields
690 All fields of part_svc (be careful with this information - it may reveal more
691 about your available packages than you would like users to know in aggregate)
695 #XXX pare part_svc fields down to a more secure subset
701 An array of hash references indicating information on the customer services
702 already provisioned for this specific cust_pkg. Each has the following keys:
708 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.
714 Primary key for this service
718 Service definition (see L<FS::part_svc>)
722 Customer package (see L<FS::cust_pkg>)
726 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
734 Returns service information for this customer.
736 Takes a hash reference as parameter with a single key: B<session_id>
738 Returns a hash reference containing customer package information. The hash reference contains the following keys:
748 An array of hash references indicating information on all of this customer's
749 services. Each has the following keys:
755 Primary key for this service
763 Meaningful user-specific identifier for the service (i.e. username, domain, or
768 Account (svc_acct) services also have the following keys:
786 Upload bytes remaining
790 Download bytes remaining
794 Total bytes remaining
796 =item recharge_amount
800 =item recharge_seconds
802 Number of seconds gained by recharge
804 =item recharge_upbytes
806 Number of upload bytes gained by recharge
808 =item recharge_downbytes
810 Number of download bytes gained by recharge
812 =item recharge_totalbytes
814 Number of total bytes gained by recharge
822 Orders a package for this customer.
824 Takes a hash reference as parameter with the following keys:
834 Package to order (see L<FS::part_pkg>).
838 Service to order (see L<FS::part_svc>).
840 Normally optional; required only to provision a non-svc_acct service, or if the
841 package definition does not contain one svc_acct service definition with
842 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
843 also be specified to indicate that no initial service should be provisioned.
847 Fields used when provisioning an svc_acct service:
861 Optional security phrase
865 Optional Access number number
869 Fields used when provisioning an svc_domain service:
879 Fields used when provisioning an svc_phone service:
897 Fields used when provisioning an svc_external service:
911 Fields used when provisioning an svc_pbx service:
925 Returns a hash reference with a single key, B<error>, empty on success, or an
926 error message on errors. The special error '_decline' is returned for
927 declined transactions.
931 Changes a package for this customer.
933 Takes a hash reference as parameter with the following keys:
943 Existing customer package.
947 New package to order (see L<FS::part_pkg>).
951 Returns a hash reference with the following keys:
957 Empty on success, or an error message on errors.
961 On success, the new pkgnum
968 Provides useful info for early renewals.
970 Takes a hash reference as parameter with the following keys:
980 Returns a hash reference. On errors, it contains a single key, B<error>, with
981 the error message. Otherwise, contains a single key, B<dates>, pointing to
982 an array refernce of hash references. Each hash reference contains the
989 (Future) Bill date. Indicates a future date for which billing could be run.
990 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
993 =item bill_date_pretty
995 (Future) Bill date as a human-readable string. (Convenience for display;
996 subject to change, so best not to parse for the date.)
1000 Base amount which will be charged if renewed early as of this date.
1004 Renewal date; i.e. even-futher future date at which the customer will be paid
1005 through if the early renewal is completed with the given B<bill-date>.
1006 Specified as a integer UNIX timestamp.
1008 =item renew_date_pretty
1010 Renewal date as a human-readable string. (Convenience for display;
1011 subject to change, so best not to parse for the date.)
1015 Package that will be renewed.
1019 Expiration date of the package that will be renewed.
1021 =item expire_date_pretty
1023 Expiration date of the package that will be renewed, as a human-readable
1024 string. (Convenience for display; subject to change, so best not to parse for
1031 Renews this customer early; i.e. runs billing for this customer in advance.
1033 Takes a hash reference as parameter with the following keys:
1043 Integer date as returned by the B<renew_info> function, indicating the advance
1044 date for which to run billing.
1048 Returns a hash reference with a single key, B<error>, empty on success, or an
1049 error message on errors.
1053 Cancels a package for this customer.
1055 Takes a hash reference as parameter with the following keys:
1065 pkgpart of package to cancel
1069 Returns a hash reference with a single key, B<error>, empty on success, or an
1070 error message on errors.
1074 =head1 SIGNUP FUNCTIONS
1078 =item signup_info HASHREF
1080 Takes a hash reference as parameter with the following keys:
1084 =item session_id - Optional agent/reseller interface session
1088 Returns a hash reference containing information that may be useful in
1089 displaying a signup page. The hash reference contains the following keys:
1093 =item cust_main_county
1095 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.
1099 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
1100 an agentnum specified explicitly via reseller interface session_id in the
1105 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.
1107 =item agentnum2part_pkg
1109 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.
1113 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.
1115 =item security_phrase
1117 True if the "security_phrase" feature is enabled
1121 Array reference of acceptable payment types for signup
1127 credit card - automatic
1131 credit card - on-demand - version 1.5+ only
1135 electronic check - automatic
1139 electronic check - on-demand - version 1.5+ only
1147 billing, not recommended for signups
1151 free, definitely not recommended for signups
1155 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1161 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1165 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".
1171 =item countrydefault
1177 =item new_customer HASHREF
1179 Creates a new customer. Takes a hash reference as parameter with the
1186 first name (required)
1190 last name (required)
1194 (not typically collected; mostly used for ACH transactions)
1200 =item address1 (required)
1208 =item city (required)
1216 =item state (required)
1220 =item zip (required)
1226 Daytime phone number
1230 Evening phone number
1238 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1242 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1246 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1250 Expiration date for CARD/DCRD
1254 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1256 =item invoicing_list
1258 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),
1260 =item referral_custnum
1262 referring customer number
1270 pkgpart of initial package
1286 Access number (index, not the literal number)
1290 Country code (to be provisioned as a service)
1294 Phone number (to be provisioned as a service)
1302 Returns a hash reference with the following keys:
1308 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)
1312 =item regionselector HASHREF | LIST
1314 Takes as input a hashref or list of key/value pairs with the following keys:
1318 =item selected_county
1320 Currently selected county
1322 =item selected_state
1324 Currently selected state
1326 =item selected_country
1328 Currently selected country
1332 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1336 Specify a javascript subroutine to call on changes
1342 =item default_country
1348 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>.
1352 Returns a list consisting of three HTML fragments for county selection,
1353 state selection and country selection, respectively.
1357 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1358 sub regionselector {
1365 $param->{'selected_country'} ||= $param->{'default_country'};
1366 $param->{'selected_state'} ||= $param->{'default_state'};
1368 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1372 my %cust_main_county;
1374 # unless ( @cust_main_county ) { #cache
1375 #@cust_main_county = qsearch('cust_main_county', {} );
1376 #foreach my $c ( @cust_main_county ) {
1377 foreach my $c ( @{ $param->{'locales'} } ) {
1378 #$countyflag=1 if $c->county;
1379 $countyflag=1 if $c->{county};
1380 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1381 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1382 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1385 $countyflag=1 if $param->{selected_county};
1387 my $script_html = <<END;
1389 function opt(what,value,text) {
1390 var optionName = new Option(text, value, false, false);
1391 var length = what.length;
1392 what.options[length] = optionName;
1394 function ${prefix}country_changed(what) {
1395 country = what.options[what.selectedIndex].text;
1396 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1397 what.form.${prefix}state.options[i] = null;
1399 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1401 foreach my $country ( sort keys %cust_main_county ) {
1402 $script_html .= "\nif ( country == \"$country\" ) {\n";
1403 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1404 my $text = $state || '(n/a)';
1405 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1407 $script_html .= "}\n";
1410 $script_html .= <<END;
1412 function ${prefix}state_changed(what) {
1415 if ( $countyflag ) {
1416 $script_html .= <<END;
1417 state = what.options[what.selectedIndex].text;
1418 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1419 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1420 what.form.${prefix}county.options[i] = null;
1423 foreach my $country ( sort keys %cust_main_county ) {
1424 $script_html .= "\nif ( country == \"$country\" ) {\n";
1425 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1426 $script_html .= "\nif ( state == \"$state\" ) {\n";
1427 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1428 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1429 my $text = $county || '(n/a)';
1431 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1433 $script_html .= "}\n";
1435 $script_html .= "}\n";
1439 $script_html .= <<END;
1444 my $county_html = $script_html;
1445 if ( $countyflag ) {
1446 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1447 foreach my $county (
1448 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1450 my $text = $county || '(n/a)';
1451 $county_html .= qq!<OPTION VALUE="$county"!.
1452 ($county eq $param->{'selected_county'} ?
1459 $county_html .= '</SELECT>';
1462 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1465 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1466 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1467 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1468 my $text = $state || '(n/a)';
1469 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1470 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
1472 $state_html .= '</SELECT>';
1474 my $country_html = '';
1475 if ( scalar( keys %cust_main_county ) > 1 ) {
1477 $country_html = qq(<SELECT NAME="${prefix}country" ).
1478 qq(onChange="${prefix}country_changed(this); ).
1479 $param->{'onchange'}.
1482 my $countrydefault = $param->{default_country} || 'US';
1483 foreach my $country (
1484 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1485 keys %cust_main_county
1487 my $selected = $country eq $param->{'selected_country'}
1490 $country_html .= "\n<OPTION $selected>$country</OPTION>"
1492 $country_html .= '</SELECT>';
1495 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1496 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1500 ($county_html, $state_html, $country_html);
1504 sub regionselector_hashref {
1505 my ($county_html, $state_html, $country_html) = regionselector(@_);
1507 'county_html' => $county_html,
1508 'state_html' => $state_html,
1509 'country_html' => $country_html,
1513 =item location_form HASHREF | LIST
1515 Takes as input a hashref or list of key/value pairs with the following keys:
1521 Current customer session_id
1525 Omit red asterisks from required fields.
1527 =item address1_label
1529 Label for first address line.
1533 Returns an HTML fragment for a location form (address, city, state, zip,
1546 my $session_id = delete $param->{'session_id'};
1548 my $rv = mason_comp( 'session_id' => $session_id,
1549 'comp' => '/elements/location.html',
1550 'args' => [ %$param ],
1554 $rv->{'error'} || $rv->{'output'};
1559 #=item expselect HASHREF | LIST
1561 #Takes as input a hashref or list of key/value pairs with the following keys:
1565 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1567 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1571 =item expselect PREFIX [ DATE ]
1573 Takes as input a unique prefix string and the current expiration date, in
1574 yyyy-mm-dd or m-d-yyyy format
1576 Returns an HTML fragments for expiration date selection.
1582 #if ( ref($_[0]) ) {
1586 #my $prefix = $param->{'prefix'};
1587 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1588 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1590 my $date = scalar(@_) ? shift : '';
1592 my( $m, $y ) = ( 0, 0 );
1593 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1594 ( $m, $y ) = ( $2, $1 );
1595 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1596 ( $m, $y ) = ( $1, $3 );
1598 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1600 $return .= qq!<OPTION VALUE="$_"!;
1601 $return .= " SELECTED" if $_ == $m;
1604 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1606 my $thisYear = $t[5] + 1900;
1607 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1608 $return .= qq!<OPTION VALUE="$_"!;
1609 $return .= " SELECTED" if $_ == $y;
1612 $return .= "</SELECT>";
1617 =item popselector HASHREF | LIST
1619 Takes as input a hashref or list of key/value pairs with the following keys:
1625 Access number number
1629 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>.
1633 Returns an HTML fragment for access number selection.
1637 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1645 my $popnum = $param->{'popnum'};
1646 my $pops = $param->{'pops'};
1648 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1649 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1650 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1651 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1652 if scalar(@$pops) == 1;
1655 my %popnum2pop = ();
1657 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1658 $popnum2pop{$_->{popnum}} = $_;
1663 function opt(what,href,text) {
1664 var optionName = new Option(text, href, false, false)
1665 var length = what.length;
1666 what.options[length] = optionName;
1670 my $init_popstate = $param->{'init_popstate'};
1671 if ( $init_popstate ) {
1672 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1673 $init_popstate. '">';
1676 function acstate_changed(what) {
1677 state = what.options[what.selectedIndex].text;
1678 what.form.popac.options.length = 0
1679 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1683 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1684 foreach my $state ( sort { $a cmp $b } @states ) {
1685 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1687 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1688 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1689 if ($ac eq $param->{'popac'}) {
1690 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1693 $text .= "}\n" unless $init_popstate;
1695 $text .= "popac_changed(what.form.popac)}\n";
1698 function popac_changed(what) {
1699 ac = what.options[what.selectedIndex].text;
1700 what.form.popnum.options.length = 0;
1701 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1705 foreach my $state ( @states ) {
1706 foreach my $popac ( keys %{ $pop{$state} } ) {
1707 $text .= "\nif ( ac == \"$popac\" ) {\n";
1709 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1710 my $o_popnum = $pop->{popnum};
1711 my $poptext = $pop->{city}. ', '. $pop->{state}.
1712 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1714 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1715 if ($popnum == $o_popnum) {
1716 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1724 $text .= "}\n</SCRIPT>\n";
1726 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1729 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1730 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1731 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1732 ">$_" foreach sort { $a cmp $b } @states;
1733 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1736 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1737 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1739 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1742 #comment this block to disable initial list polulation
1743 my @initial_select = ();
1744 if ( scalar( @$pops ) > 100 ) {
1745 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1747 @initial_select = @$pops;
1749 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1750 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1751 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1752 $pop->{city}. ', '. $pop->{state}.
1753 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1756 $text .= qq!</SELECT></TD></TR></TABLE>!;
1762 =item domainselector HASHREF | LIST
1764 Takes as input a hashref or list of key/value pairs with the following keys:
1774 Service number of the selected item.
1778 Returns an HTML fragment for domain selection.
1782 sub domainselector {
1789 my $domsvc= $param->{'domsvc'};
1791 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1792 my $domains = $rv->{'domains'};
1793 $domsvc = $rv->{'domsvc'} unless $domsvc;
1795 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1796 unless scalar(keys %$domains);
1798 if (scalar(keys %$domains) == 1) {
1800 foreach(keys %$domains) {
1803 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1804 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1807 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
1809 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
1811 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1812 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1813 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1814 $domains->{$domain};
1817 $text .= qq!</SELECT></TD></TR>!;
1823 =item didselector HASHREF | LIST
1825 Takes as input a hashref or list of key/value pairs with the following keys:
1831 Field name for the returned HTML fragment.
1835 Service definition (see L<FS::part_svc>)
1839 Returns an HTML fragment for DID selection.
1851 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1852 'args'=>[ %$param ],
1856 $rv->{'error'} || $rv->{'output'};
1862 =head1 RESELLER FUNCTIONS
1864 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1865 with their active session, and the B<customer_info> and B<order_pkg> functions
1866 with their active session and an additional I<custnum> parameter.
1868 For the most part, development of the reseller web interface has been
1869 superceded by agent-virtualized access to the backend.
1881 =item agent_list_customers
1883 List agent's customers.
1891 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>