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 #new-style login with an email address and password
207 # can also be used for svc_acct login, set $emailaddress to username@domain
208 my $rv = login ( { 'email' => $emailaddress,
209 'password' => $password,
212 if ( $rv->{'error'} ) {
213 #handle login error...
216 $session_id = $rv->{'session_id'};
219 #classic svc_acct-based login with separate username and password
220 my $rv = login( { 'username' => $username,
222 'password' => $password,
225 if ( $rv->{'error'} ) {
226 #handle login error...
229 $session_id = $rv->{'session_id'};
232 #svc_phone login with phone number and PIN
233 my $rv = login( { 'username' => $phone_number,
234 'domain' => 'svc_phone',
238 if ( $rv->{'error'} ) {
239 #handle login error...
242 $session_id = $rv->{'session_id'};
245 my $customer_info = customer_info( { 'session_id' => $session_id } );
247 #payment_info and process_payment are available in 1.5+ only
248 my $payment_info = payment_info( { 'session_id' => $session_id } );
250 #!!! process_payment example
252 #!!! list_pkgs example
254 #!!! order_pkg example
256 #!!! cancel_pkg example
258 # signup functionality
259 use FS::SelfService qw( signup_info new_customer );
261 my $signup_info = signup_info;
263 $rv = new_customer( {
266 'company' => $company,
267 'address1' => $address1,
268 'address2' => $address2,
272 'country' => $country,
273 'daytime' => $daytime,
277 'payinfo' => $payinfo,
279 'paystart_month' => $paystart_month
280 'paystart_year' => $paystart_year,
281 'payissue' => $payissue,
283 'paydate' => $paydate,
284 'payname' => $payname,
285 'invoicing_list' => $invoicing_list,
286 'referral_custnum' => $referral_custnum,
287 'agentnum' => $agentnum,
288 'pkgpart' => $pkgpart,
290 'username' => $username,
291 '_password' => $password,
295 'phonenum' => $phonenum,
300 my $error = $rv->{'error'};
301 if ( $error eq '_decline' ) {
311 Use this API to implement your own client "self-service" module.
313 If you just want to customize the look of the existing "self-service" module,
316 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
328 =head1 "MY ACCOUNT" FUNCTIONS
334 Creates a user session. Takes a hash reference as parameter with the
341 Email address (username@domain), instead of username and domain. Required for
342 contact-based self-service login, can also be used for svc_acct-based login.
358 Returns a hash reference with the following keys:
364 Empty on success, or an error message on errors.
368 Session identifier for successful logins
372 =item customer_info HASHREF
374 Returns general customer information.
376 Takes a hash reference as parameter with a single key: B<session_id>
378 Returns a hash reference with the following keys:
392 Array reference of hash references of open inoices. Each hash reference has
393 the following keys: invnum, date, owed
397 An HTML fragment containing shipping and billing addresses.
399 =item The following fields are also returned
401 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
405 =item edit_info HASHREF
407 Takes a hash reference as parameter with any of the following keys:
409 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
411 If a field exists, the customer record is updated with the new value of that
412 field. If a field does not exist, that field is not changed on the customer
415 Returns a hash reference with a single key, B<error>, empty on success, or an
416 error message on errors
418 =item invoice HASHREF
420 Returns an invoice. Takes a hash reference as parameter with two keys:
421 session_id and invnum
423 Returns a hash reference with the following keys:
429 Empty on success, or an error message on errors
441 =item list_invoices HASHREF
443 Returns a list of all customer invoices. Takes a hash references with a single
446 Returns a hash reference with the following keys:
452 Empty on success, or an error message on errors
456 Reference to array of hash references with the following keys:
466 Invoice date, in UNIX epoch time
474 Cancels this customer.
476 Takes a hash reference as parameter with a single key: B<session_id>
478 Returns a hash reference with a single key, B<error>, which is empty on
479 success or an error message on errors.
481 =item payment_info HASHREF
483 Returns information that may be useful in displaying a payment page.
485 Takes a hash reference as parameter with a single key: B<session_id>.
487 Returns a hash reference with the following keys:
493 Empty on success, or an error message on errors
501 Exact name on credit card (CARD/DCRD)
525 Customer's current default payment type.
529 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
533 For CARD/DCRD payment types, the card number
537 For CARD/DCRD payment types, expiration month
541 For CARD/DCRD payment types, expiration year
543 =item cust_main_county
545 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.
549 Array reference of all states in the current default country.
553 Hash reference of card types; keys are card types, values are the exact strings
554 passed to the process_payment function
558 #this doesn't actually work yet
562 #Unique transaction identifier (prevents multiple charges), passed to the
563 #process_payment function
567 =item process_payment HASHREF
569 Processes a payment and possible change of address or payment type. Takes a
570 hash reference as parameter with the following keys:
584 If true, address and card information entered will be saved for subsequent
589 If true, future credit card payments will be done automatically (sets payby to
590 CARD). If false, future credit card payments will be done on-demand (sets
591 payby to DCRD). This option only has meaning if B<save> is set true.
619 Two-letter country code
627 Card expiration month
635 #this doesn't actually work yet
639 #Unique transaction identifier, returned from the payment_info function.
640 #Prevents multiple charges.
644 Returns a hash reference with a single key, B<error>, empty on success, or an
645 error message on errors.
647 =item process_payment_order_pkg
649 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
650 payment processes sucessfully, the package is ordered. Takes a hash reference
651 as parameter with the keys of both methods.
653 Returns a hash reference with a single key, B<error>, empty on success, or an
654 error message on errors.
656 =item process_payment_change_pkg
658 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
659 payment processes sucessfully, the package is ordered. Takes a hash reference
660 as parameter with the keys of both methods.
662 Returns a hash reference with a single key, B<error>, empty on success, or an
663 error message on errors.
666 =item process_payment_order_renew
668 Combines the B<process_payment> and B<order_renew> functions in one step. If
669 the payment processes sucessfully, the renewal is processed. Takes a hash
670 reference as parameter with the keys of both methods.
672 Returns a hash reference with a single key, B<error>, empty on success, or an
673 error message on errors.
677 Returns package information for this customer. For more detail on services,
680 Takes a hash reference as parameter with a single key: B<session_id>
682 Returns a hash reference containing customer package information. The hash reference contains the following keys:
692 Empty on success, or an error message on errors.
694 =item cust_pkg HASHREF
696 Array reference of hash references, each of which has the fields of a cust_pkg
697 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
698 the internal FS:: objects, but hash references of columns and values.
702 =item part_pkg fields
704 All fields of part_pkg for this specific cust_pkg (be careful with this
705 information - it may reveal more about your available packages than you would
706 like users to know in aggregate)
710 #XXX pare part_pkg fields down to a more secure subset
714 An array of hash references indicating information on unprovisioned services
715 available for provisioning for this specific cust_pkg. Each has the following
720 =item part_svc fields
722 All fields of part_svc (be careful with this information - it may reveal more
723 about your available packages than you would like users to know in aggregate)
727 #XXX pare part_svc fields down to a more secure subset
733 An array of hash references indicating information on the customer services
734 already provisioned for this specific cust_pkg. Each has the following keys:
740 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.
746 Primary key for this service
750 Service definition (see L<FS::part_svc>)
754 Customer package (see L<FS::cust_pkg>)
758 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
766 Returns service information for this customer.
768 Takes a hash reference as parameter with a single key: B<session_id>
770 Returns a hash reference containing customer package information. The hash reference contains the following keys:
780 An array of hash references indicating information on all of this customer's
781 services. Each has the following keys:
787 Primary key for this service
795 Meaningful user-specific identifier for the service (i.e. username, domain, or
800 Account (svc_acct) services also have the following keys:
818 Upload bytes remaining
822 Download bytes remaining
826 Total bytes remaining
828 =item recharge_amount
832 =item recharge_seconds
834 Number of seconds gained by recharge
836 =item recharge_upbytes
838 Number of upload bytes gained by recharge
840 =item recharge_downbytes
842 Number of download bytes gained by recharge
844 =item recharge_totalbytes
846 Number of total bytes gained by recharge
854 Orders a package for this customer.
856 Takes a hash reference as parameter with the following keys:
866 Package to order (see L<FS::part_pkg>).
870 Quantity for this package order (default 1).
874 Optional locationnum for this package order, for existing locations.
876 Or, for new locations, pass the following fields: address1*, address2, city*,
877 county, state*, zip*, country. (* = required in this case)
889 Service to order (see L<FS::part_svc>).
891 Normally optional; required only to provision a non-svc_acct service, or if the
892 package definition does not contain one svc_acct service definition with
893 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
894 also be specified to indicate that no initial service should be provisioned.
898 Fields used when provisioning an svc_acct service:
912 Optional security phrase
916 Optional Access number number
920 Fields used when provisioning an svc_domain service:
930 Fields used when provisioning an svc_phone service:
948 Fields used when provisioning an svc_external service:
962 Fields used when provisioning an svc_pbx service:
976 Returns a hash reference with a single key, B<error>, empty on success, or an
977 error message on errors. The special error '_decline' is returned for
978 declined transactions.
982 Changes a package for this customer.
984 Takes a hash reference as parameter with the following keys:
994 Existing customer package.
998 New package to order (see L<FS::part_pkg>).
1002 Returns a hash reference with the following keys:
1008 Empty on success, or an error message on errors.
1012 On success, the new pkgnum
1019 Provides useful info for early renewals.
1021 Takes a hash reference as parameter with the following keys:
1031 Returns a hash reference. On errors, it contains a single key, B<error>, with
1032 the error message. Otherwise, contains a single key, B<dates>, pointing to
1033 an array refernce of hash references. Each hash reference contains the
1040 (Future) Bill date. Indicates a future date for which billing could be run.
1041 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1044 =item bill_date_pretty
1046 (Future) Bill date as a human-readable string. (Convenience for display;
1047 subject to change, so best not to parse for the date.)
1051 Base amount which will be charged if renewed early as of this date.
1055 Renewal date; i.e. even-futher future date at which the customer will be paid
1056 through if the early renewal is completed with the given B<bill-date>.
1057 Specified as a integer UNIX timestamp.
1059 =item renew_date_pretty
1061 Renewal date as a human-readable string. (Convenience for display;
1062 subject to change, so best not to parse for the date.)
1066 Package that will be renewed.
1070 Expiration date of the package that will be renewed.
1072 =item expire_date_pretty
1074 Expiration date of the package that will be renewed, as a human-readable
1075 string. (Convenience for display; subject to change, so best not to parse for
1082 Renews this customer early; i.e. runs billing for this customer in advance.
1084 Takes a hash reference as parameter with the following keys:
1094 Integer date as returned by the B<renew_info> function, indicating the advance
1095 date for which to run billing.
1099 Returns a hash reference with a single key, B<error>, empty on success, or an
1100 error message on errors.
1104 Cancels a package for this customer.
1106 Takes a hash reference as parameter with the following keys:
1116 pkgpart of package to cancel
1120 Returns a hash reference with a single key, B<error>, empty on success, or an
1121 error message on errors.
1125 =head1 SIGNUP FUNCTIONS
1129 =item signup_info HASHREF
1131 Takes a hash reference as parameter with the following keys:
1135 =item session_id - Optional agent/reseller interface session
1139 Returns a hash reference containing information that may be useful in
1140 displaying a signup page. The hash reference contains the following keys:
1144 =item cust_main_county
1146 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.
1150 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
1151 an agentnum specified explicitly via reseller interface session_id in the
1156 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.
1158 =item agentnum2part_pkg
1160 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.
1164 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.
1166 =item security_phrase
1168 True if the "security_phrase" feature is enabled
1172 Array reference of acceptable payment types for signup
1178 credit card - automatic
1182 credit card - on-demand - version 1.5+ only
1186 electronic check - automatic
1190 electronic check - on-demand - version 1.5+ only
1198 billing, not recommended for signups
1202 free, definitely not recommended for signups
1206 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1212 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1216 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".
1222 =item countrydefault
1228 =item new_customer HASHREF
1230 Creates a new customer. Takes a hash reference as parameter with the
1237 first name (required)
1241 last name (required)
1245 (not typically collected; mostly used for ACH transactions)
1251 =item address1 (required)
1259 =item city (required)
1267 =item state (required)
1271 =item zip (required)
1277 Daytime phone number
1281 Evening phone number
1289 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1293 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1297 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1301 Expiration date for CARD/DCRD
1305 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1307 =item invoicing_list
1309 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),
1311 =item referral_custnum
1313 referring customer number
1321 pkgpart of initial package
1337 Access number (index, not the literal number)
1341 Country code (to be provisioned as a service)
1345 Phone number (to be provisioned as a service)
1353 Returns a hash reference with the following keys:
1359 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)
1363 =item regionselector HASHREF | LIST
1365 Takes as input a hashref or list of key/value pairs with the following keys:
1369 =item selected_county
1371 Currently selected county
1373 =item selected_state
1375 Currently selected state
1377 =item selected_country
1379 Currently selected country
1383 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1387 Specify a javascript subroutine to call on changes
1393 =item default_country
1399 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>.
1403 Returns a list consisting of three HTML fragments for county selection,
1404 state selection and country selection, respectively.
1408 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1409 sub regionselector {
1416 $param->{'selected_country'} ||= $param->{'default_country'};
1417 $param->{'selected_state'} ||= $param->{'default_state'};
1419 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1423 my %cust_main_county;
1425 # unless ( @cust_main_county ) { #cache
1426 #@cust_main_county = qsearch('cust_main_county', {} );
1427 #foreach my $c ( @cust_main_county ) {
1428 foreach my $c ( @{ $param->{'locales'} } ) {
1429 #$countyflag=1 if $c->county;
1430 $countyflag=1 if $c->{county};
1431 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1432 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1433 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1436 $countyflag=1 if $param->{selected_county};
1438 my $script_html = <<END;
1440 function opt(what,value,text) {
1441 var optionName = new Option(text, value, false, false);
1442 var length = what.length;
1443 what.options[length] = optionName;
1445 function ${prefix}country_changed(what) {
1446 country = what.options[what.selectedIndex].text;
1447 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1448 what.form.${prefix}state.options[i] = null;
1450 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1452 foreach my $country ( sort keys %cust_main_county ) {
1453 $script_html .= "\nif ( country == \"$country\" ) {\n";
1454 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1455 my $text = $state || '(n/a)';
1456 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1458 $script_html .= "}\n";
1461 $script_html .= <<END;
1463 function ${prefix}state_changed(what) {
1466 if ( $countyflag ) {
1467 $script_html .= <<END;
1468 state = what.options[what.selectedIndex].text;
1469 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1470 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1471 what.form.${prefix}county.options[i] = null;
1474 foreach my $country ( sort keys %cust_main_county ) {
1475 $script_html .= "\nif ( country == \"$country\" ) {\n";
1476 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1477 $script_html .= "\nif ( state == \"$state\" ) {\n";
1478 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1479 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1480 my $text = $county || '(n/a)';
1482 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1484 $script_html .= "}\n";
1486 $script_html .= "}\n";
1490 $script_html .= <<END;
1495 my $county_html = $script_html;
1496 if ( $countyflag ) {
1497 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1498 foreach my $county (
1499 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1501 my $text = $county || '(n/a)';
1502 $county_html .= qq!<OPTION VALUE="$county"!.
1503 ($county eq $param->{'selected_county'} ?
1510 $county_html .= '</SELECT>';
1513 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1516 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1517 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1518 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1519 my $text = $state || '(n/a)';
1520 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1521 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
1523 $state_html .= '</SELECT>';
1525 my $country_html = '';
1526 if ( scalar( keys %cust_main_county ) > 1 ) {
1528 $country_html = qq(<SELECT NAME="${prefix}country" ).
1529 qq(onChange="${prefix}country_changed(this); ).
1530 $param->{'onchange'}.
1533 my $countrydefault = $param->{default_country} || 'US';
1534 foreach my $country (
1535 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1536 keys %cust_main_county
1538 my $selected = $country eq $param->{'selected_country'}
1541 $country_html .= "\n<OPTION $selected>$country</OPTION>"
1543 $country_html .= '</SELECT>';
1546 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1547 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1551 ($county_html, $state_html, $country_html);
1555 sub regionselector_hashref {
1556 my ($county_html, $state_html, $country_html) = regionselector(@_);
1558 'county_html' => $county_html,
1559 'state_html' => $state_html,
1560 'country_html' => $country_html,
1564 =item location_form HASHREF | LIST
1566 Takes as input a hashref or list of key/value pairs with the following keys:
1572 Current customer session_id
1576 Omit red asterisks from required fields.
1578 =item address1_label
1580 Label for first address line.
1584 Returns an HTML fragment for a location form (address, city, state, zip,
1597 my $session_id = delete $param->{'session_id'};
1599 my $rv = mason_comp( 'session_id' => $session_id,
1600 'comp' => '/elements/location.html',
1601 'args' => [ %$param ],
1605 $rv->{'error'} || $rv->{'output'};
1610 #=item expselect HASHREF | LIST
1612 #Takes as input a hashref or list of key/value pairs with the following keys:
1616 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1618 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1622 =item expselect PREFIX [ DATE ]
1624 Takes as input a unique prefix string and the current expiration date, in
1625 yyyy-mm-dd or m-d-yyyy format
1627 Returns an HTML fragments for expiration date selection.
1633 #if ( ref($_[0]) ) {
1637 #my $prefix = $param->{'prefix'};
1638 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1639 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1641 my $date = scalar(@_) ? shift : '';
1643 my( $m, $y ) = ( 0, 0 );
1644 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1645 ( $m, $y ) = ( $2, $1 );
1646 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1647 ( $m, $y ) = ( $1, $3 );
1649 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1651 $return .= qq!<OPTION VALUE="$_"!;
1652 $return .= " SELECTED" if $_ == $m;
1655 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1657 my $thisYear = $t[5] + 1900;
1658 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1659 $return .= qq!<OPTION VALUE="$_"!;
1660 $return .= " SELECTED" if $_ == $y;
1663 $return .= "</SELECT>";
1668 =item popselector HASHREF | LIST
1670 Takes as input a hashref or list of key/value pairs with the following keys:
1676 Access number number
1680 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>.
1684 Returns an HTML fragment for access number selection.
1688 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1696 my $popnum = $param->{'popnum'};
1697 my $pops = $param->{'pops'};
1699 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1700 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1701 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1702 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1703 if scalar(@$pops) == 1;
1706 my %popnum2pop = ();
1708 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1709 $popnum2pop{$_->{popnum}} = $_;
1714 function opt(what,href,text) {
1715 var optionName = new Option(text, href, false, false)
1716 var length = what.length;
1717 what.options[length] = optionName;
1721 my $init_popstate = $param->{'init_popstate'};
1722 if ( $init_popstate ) {
1723 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1724 $init_popstate. '">';
1727 function acstate_changed(what) {
1728 state = what.options[what.selectedIndex].text;
1729 what.form.popac.options.length = 0
1730 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1734 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1735 foreach my $state ( sort { $a cmp $b } @states ) {
1736 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1738 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1739 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1740 if ($ac eq $param->{'popac'}) {
1741 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1744 $text .= "}\n" unless $init_popstate;
1746 $text .= "popac_changed(what.form.popac)}\n";
1749 function popac_changed(what) {
1750 ac = what.options[what.selectedIndex].text;
1751 what.form.popnum.options.length = 0;
1752 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1756 foreach my $state ( @states ) {
1757 foreach my $popac ( keys %{ $pop{$state} } ) {
1758 $text .= "\nif ( ac == \"$popac\" ) {\n";
1760 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1761 my $o_popnum = $pop->{popnum};
1762 my $poptext = $pop->{city}. ', '. $pop->{state}.
1763 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1765 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1766 if ($popnum == $o_popnum) {
1767 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1775 $text .= "}\n</SCRIPT>\n";
1777 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1780 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1781 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1782 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1783 ">$_" foreach sort { $a cmp $b } @states;
1784 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1787 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1788 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1790 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1793 #comment this block to disable initial list polulation
1794 my @initial_select = ();
1795 if ( scalar( @$pops ) > 100 ) {
1796 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1798 @initial_select = @$pops;
1800 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1801 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1802 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1803 $pop->{city}. ', '. $pop->{state}.
1804 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1807 $text .= qq!</SELECT></TD></TR></TABLE>!;
1813 =item domainselector HASHREF | LIST
1815 Takes as input a hashref or list of key/value pairs with the following keys:
1825 Service number of the selected item.
1829 Returns an HTML fragment for domain selection.
1833 sub domainselector {
1840 my $domsvc= $param->{'domsvc'};
1842 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1843 my $domains = $rv->{'domains'};
1844 $domsvc = $rv->{'domsvc'} unless $domsvc;
1846 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1847 unless scalar(keys %$domains);
1849 if (scalar(keys %$domains) == 1) {
1851 foreach(keys %$domains) {
1854 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1855 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1858 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
1860 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
1862 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1863 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1864 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1865 $domains->{$domain};
1868 $text .= qq!</SELECT></TD></TR>!;
1874 =item didselector HASHREF | LIST
1876 Takes as input a hashref or list of key/value pairs with the following keys:
1882 Field name for the returned HTML fragment.
1886 Service definition (see L<FS::part_svc>)
1890 Returns an HTML fragment for DID selection.
1902 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1903 'args'=>[ %$param ],
1907 $rv->{'error'} || $rv->{'output'};
1913 =head1 RESELLER FUNCTIONS
1915 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1916 with their active session, and the B<customer_info> and B<order_pkg> functions
1917 with their active session and an additional I<custnum> parameter.
1919 For the most part, development of the reseller web interface has been
1920 superceded by agent-virtualized access to the backend.
1932 =item agent_list_customers
1934 List agent's customers.
1942 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>