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 'create_ticket' => 'MyAccount/create_ticket',
90 'get_ticket' => 'MyAccount/get_ticket',
91 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
92 'did_report' => 'MyAccount/did_report',
93 'signup_info' => 'Signup/signup_info',
94 'skin_info' => 'MyAccount/skin_info',
95 'access_info' => 'MyAccount/access_info',
96 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
97 'new_customer' => 'Signup/new_customer',
98 'capture_payment' => 'Signup/capture_payment',
99 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
100 'new_agent' => 'Agent/new_agent',
101 'agent_login' => 'Agent/agent_login',
102 'agent_logout' => 'Agent/agent_logout',
103 'agent_info' => 'Agent/agent_info',
104 'agent_list_customers' => 'Agent/agent_list_customers',
105 'check_username' => 'Agent/check_username',
106 'suspend_username' => 'Agent/suspend_username',
107 'unsuspend_username' => 'Agent/unsuspend_username',
108 'mason_comp' => 'MasonComponent/mason_comp',
109 'call_time' => 'PrepaidPhone/call_time',
110 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
111 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
113 #'bulk_processrow' => 'Bulk/processrow',
114 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
116 'ping' => 'SGNG/ping',
117 'decompify_pkgs' => 'SGNG/decompify_pkgs',
118 'previous_payment_info' => 'SGNG/previous_payment_info',
119 'previous_payment_info_renew_info'
120 => 'SGNG/previous_payment_info_renew_info',
121 'previous_process_payment' => 'SGNG/previous_process_payment',
122 'previous_process_payment_order_pkg'
123 => 'SGNG/previous_process_payment_order_pkg',
124 'previous_process_payment_change_pkg'
125 => 'SGNG/previous_process_payment_change_pkg',
126 'previous_process_payment_order_renew'
127 => 'SGNG/previous_process_payment_order_renew',
131 qw( regionselector regionselector_hashref location_form
132 expselect popselector domainselector didselector
136 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
137 $ENV{'SHELL'} = '/bin/sh';
138 $ENV{'IFS'} = " \t\n";
141 $ENV{'BASH_ENV'} = '';
143 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
144 #if you grant appropriate permissions to whatever user
145 my $freeside_uid = scalar(getpwnam('freeside'));
146 die "not running as the freeside user\n"
147 if $> != $freeside_uid && ! $skip_uid_check;
149 -e $dir or die "FATAL: $dir doesn't exist!";
150 -d $dir or die "FATAL: $dir isn't a directory!";
151 -r $dir or die "FATAL: Can't read $dir as freeside user!";
152 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
154 foreach my $autoload ( keys %autoload ) {
157 "sub $autoload { ". '
162 #warn scalar(@_). ": ". join(" / ", @_);
166 $param->{_packet} = \''. $autoload{$autoload}. '\';
168 simple_packet($param);
178 warn "sending ". $packet->{_packet}. " to server"
180 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
181 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
182 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
185 #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
187 #block until there is a message on socket
188 # my $w = new IO::Select;
190 # my @wait = $w->can_read;
192 warn "reading message from server"
195 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
196 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
198 warn "returning message to client"
206 FS::SelfService - Freeside self-service API
210 # password and shell account changes
211 use FS::SelfService qw(passwd chfn chsh);
213 # "my account" functionality
214 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
216 my $rv = login( { 'username' => $username,
218 'password' => $password,
222 if ( $rv->{'error'} ) {
223 #handle login error...
226 my $session_id = $rv->{'session_id'};
229 my $customer_info = customer_info( { 'session_id' => $session_id } );
231 #payment_info and process_payment are available in 1.5+ only
232 my $payment_info = payment_info( { 'session_id' => $session_id } );
234 #!!! process_payment example
236 #!!! list_pkgs example
238 #!!! order_pkg example
240 #!!! cancel_pkg example
242 # signup functionality
243 use FS::SelfService qw( signup_info new_customer );
245 my $signup_info = signup_info;
247 $rv = new_customer( {
250 'company' => $company,
251 'address1' => $address1,
252 'address2' => $address2,
256 'country' => $country,
257 'daytime' => $daytime,
261 'payinfo' => $payinfo,
263 'paystart_month' => $paystart_month
264 'paystart_year' => $paystart_year,
265 'payissue' => $payissue,
267 'paydate' => $paydate,
268 'payname' => $payname,
269 'invoicing_list' => $invoicing_list,
270 'referral_custnum' => $referral_custnum,
271 'agentnum' => $agentnum,
272 'pkgpart' => $pkgpart,
274 'username' => $username,
275 '_password' => $password,
279 'phonenum' => $phonenum,
284 my $error = $rv->{'error'};
285 if ( $error eq '_decline' ) {
295 Use this API to implement your own client "self-service" module.
297 If you just want to customize the look of the existing "self-service" module,
300 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
312 =head1 "MY ACCOUNT" FUNCTIONS
318 Creates a user session. Takes a hash reference as parameter with the
337 Returns a hash reference with the following keys:
343 Empty on success, or an error message on errors.
347 Session identifier for successful logins
351 =item customer_info HASHREF
353 Returns general customer information.
355 Takes a hash reference as parameter with a single key: B<session_id>
357 Returns a hash reference with the following keys:
371 Array reference of hash references of open inoices. Each hash reference has
372 the following keys: invnum, date, owed
376 An HTML fragment containing shipping and billing addresses.
378 =item The following fields are also returned
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 payname month year invoicing_list postal_invoicing
384 =item edit_info HASHREF
386 Takes a hash reference as parameter with any of the following keys:
388 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
390 If a field exists, the customer record is updated with the new value of that
391 field. If a field does not exist, that field is not changed on the customer
394 Returns a hash reference with a single key, B<error>, empty on success, or an
395 error message on errors
397 =item invoice HASHREF
399 Returns an invoice. Takes a hash reference as parameter with two keys:
400 session_id and invnum
402 Returns a hash reference with the following keys:
408 Empty on success, or an error message on errors
420 =item list_invoices HASHREF
422 Returns a list of all customer invoices. Takes a hash references with a single
425 Returns a hash reference with the following keys:
431 Empty on success, or an error message on errors
435 Reference to array of hash references with the following keys:
445 Invoice date, in UNIX epoch time
453 Cancels this customer.
455 Takes a hash reference as parameter with a single key: B<session_id>
457 Returns a hash reference with a single key, B<error>, which is empty on
458 success or an error message on errors.
460 =item payment_info HASHREF
462 Returns information that may be useful in displaying a payment page.
464 Takes a hash reference as parameter with a single key: B<session_id>.
466 Returns a hash reference with the following keys:
472 Empty on success, or an error message on errors
480 Exact name on credit card (CARD/DCRD)
504 Customer's current default payment type.
508 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
512 For CARD/DCRD payment types, the card number
516 For CARD/DCRD payment types, expiration month
520 For CARD/DCRD payment types, expiration year
522 =item cust_main_county
524 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.
528 Array reference of all states in the current default country.
532 Hash reference of card types; keys are card types, values are the exact strings
533 passed to the process_payment function
537 #this doesn't actually work yet
541 #Unique transaction identifier (prevents multiple charges), passed to the
542 #process_payment function
546 =item process_payment HASHREF
548 Processes a payment and possible change of address or payment type. Takes a
549 hash reference as parameter with the following keys:
563 If true, address and card information entered will be saved for subsequent
568 If true, future credit card payments will be done automatically (sets payby to
569 CARD). If false, future credit card payments will be done on-demand (sets
570 payby to DCRD). This option only has meaning if B<save> is set true.
598 Two-letter country code
606 Card expiration month
614 #this doesn't actually work yet
618 #Unique transaction identifier, returned from the payment_info function.
619 #Prevents multiple charges.
623 Returns a hash reference with a single key, B<error>, empty on success, or an
624 error message on errors.
626 =item process_payment_order_pkg
628 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
629 payment processes sucessfully, the package is ordered. Takes a hash reference
630 as parameter with the keys of both methods.
632 Returns a hash reference with a single key, B<error>, empty on success, or an
633 error message on errors.
635 =item process_payment_change_pkg
637 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
638 payment processes sucessfully, the package is ordered. Takes a hash reference
639 as parameter with the keys of both methods.
641 Returns a hash reference with a single key, B<error>, empty on success, or an
642 error message on errors.
645 =item process_payment_order_renew
647 Combines the B<process_payment> and B<order_renew> functions in one step. If
648 the payment processes sucessfully, the renewal is processed. Takes a hash
649 reference as parameter with the keys of both methods.
651 Returns a hash reference with a single key, B<error>, empty on success, or an
652 error message on errors.
656 Returns package information for this customer. For more detail on services,
659 Takes a hash reference as parameter with a single key: B<session_id>
661 Returns a hash reference containing customer package information. The hash reference contains the following keys:
671 Empty on success, or an error message on errors.
673 =item cust_pkg HASHREF
675 Array reference of hash references, each of which has the fields of a cust_pkg
676 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
677 the internal FS:: objects, but hash references of columns and values.
681 =item part_pkg fields
683 All fields of part_pkg for this specific cust_pkg (be careful with this
684 information - it may reveal more about your available packages than you would
685 like users to know in aggregate)
689 #XXX pare part_pkg fields down to a more secure subset
693 An array of hash references indicating information on unprovisioned services
694 available for provisioning for this specific cust_pkg. Each has the following
699 =item part_svc fields
701 All fields of part_svc (be careful with this information - it may reveal more
702 about your available packages than you would like users to know in aggregate)
706 #XXX pare part_svc fields down to a more secure subset
712 An array of hash references indicating information on the customer services
713 already provisioned for this specific cust_pkg. Each has the following keys:
719 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.
725 Primary key for this service
729 Service definition (see L<FS::part_svc>)
733 Customer package (see L<FS::cust_pkg>)
737 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
745 Returns service information for this customer.
747 Takes a hash reference as parameter with a single key: B<session_id>
749 Returns a hash reference containing customer package information. The hash reference contains the following keys:
759 An array of hash references indicating information on all of this customer's
760 services. Each has the following keys:
766 Primary key for this service
774 Meaningful user-specific identifier for the service (i.e. username, domain, or
779 Account (svc_acct) services also have the following keys:
797 Upload bytes remaining
801 Download bytes remaining
805 Total bytes remaining
807 =item recharge_amount
811 =item recharge_seconds
813 Number of seconds gained by recharge
815 =item recharge_upbytes
817 Number of upload bytes gained by recharge
819 =item recharge_downbytes
821 Number of download bytes gained by recharge
823 =item recharge_totalbytes
825 Number of total bytes gained by recharge
833 Orders a package for this customer.
835 Takes a hash reference as parameter with the following keys:
845 Package to order (see L<FS::part_pkg>).
849 Service to order (see L<FS::part_svc>).
851 Normally optional; required only to provision a non-svc_acct service, or if the
852 package definition does not contain one svc_acct service definition with
853 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
854 also be specified to indicate that no initial service should be provisioned.
858 Fields used when provisioning an svc_acct service:
872 Optional security phrase
876 Optional Access number number
880 Fields used when provisioning an svc_domain service:
890 Fields used when provisioning an svc_phone service:
908 Fields used when provisioning an svc_external service:
922 Fields used when provisioning an svc_pbx service:
936 Returns a hash reference with a single key, B<error>, empty on success, or an
937 error message on errors. The special error '_decline' is returned for
938 declined transactions.
942 Changes a package for this customer.
944 Takes a hash reference as parameter with the following keys:
954 Existing customer package.
958 New package to order (see L<FS::part_pkg>).
962 Returns a hash reference with the following keys:
968 Empty on success, or an error message on errors.
972 On success, the new pkgnum
979 Provides useful info for early renewals.
981 Takes a hash reference as parameter with the following keys:
991 Returns a hash reference. On errors, it contains a single key, B<error>, with
992 the error message. Otherwise, contains a single key, B<dates>, pointing to
993 an array refernce of hash references. Each hash reference contains the
1000 (Future) Bill date. Indicates a future date for which billing could be run.
1001 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1004 =item bill_date_pretty
1006 (Future) Bill date as a human-readable string. (Convenience for display;
1007 subject to change, so best not to parse for the date.)
1011 Base amount which will be charged if renewed early as of this date.
1015 Renewal date; i.e. even-futher future date at which the customer will be paid
1016 through if the early renewal is completed with the given B<bill-date>.
1017 Specified as a integer UNIX timestamp.
1019 =item renew_date_pretty
1021 Renewal date as a human-readable string. (Convenience for display;
1022 subject to change, so best not to parse for the date.)
1026 Package that will be renewed.
1030 Expiration date of the package that will be renewed.
1032 =item expire_date_pretty
1034 Expiration date of the package that will be renewed, as a human-readable
1035 string. (Convenience for display; subject to change, so best not to parse for
1042 Renews this customer early; i.e. runs billing for this customer in advance.
1044 Takes a hash reference as parameter with the following keys:
1054 Integer date as returned by the B<renew_info> function, indicating the advance
1055 date for which to run billing.
1059 Returns a hash reference with a single key, B<error>, empty on success, or an
1060 error message on errors.
1064 Cancels a package for this customer.
1066 Takes a hash reference as parameter with the following keys:
1076 pkgpart of package to cancel
1080 Returns a hash reference with a single key, B<error>, empty on success, or an
1081 error message on errors.
1085 =head1 SIGNUP FUNCTIONS
1089 =item signup_info HASHREF
1091 Takes a hash reference as parameter with the following keys:
1095 =item session_id - Optional agent/reseller interface session
1099 Returns a hash reference containing information that may be useful in
1100 displaying a signup page. The hash reference contains the following keys:
1104 =item cust_main_county
1106 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.
1110 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
1111 an agentnum specified explicitly via reseller interface session_id in the
1116 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.
1118 =item agentnum2part_pkg
1120 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.
1124 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.
1126 =item security_phrase
1128 True if the "security_phrase" feature is enabled
1132 Array reference of acceptable payment types for signup
1138 credit card - automatic
1142 credit card - on-demand - version 1.5+ only
1146 electronic check - automatic
1150 electronic check - on-demand - version 1.5+ only
1158 billing, not recommended for signups
1162 free, definitely not recommended for signups
1166 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1172 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1176 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".
1182 =item countrydefault
1188 =item new_customer HASHREF
1190 Creates a new customer. Takes a hash reference as parameter with the
1197 first name (required)
1201 last name (required)
1205 (not typically collected; mostly used for ACH transactions)
1211 =item address1 (required)
1219 =item city (required)
1227 =item state (required)
1231 =item zip (required)
1237 Daytime phone number
1241 Evening phone number
1249 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1253 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1257 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1261 Expiration date for CARD/DCRD
1265 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1267 =item invoicing_list
1269 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),
1271 =item referral_custnum
1273 referring customer number
1281 pkgpart of initial package
1297 Access number (index, not the literal number)
1301 Country code (to be provisioned as a service)
1305 Phone number (to be provisioned as a service)
1313 Returns a hash reference with the following keys:
1319 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)
1323 =item regionselector HASHREF | LIST
1325 Takes as input a hashref or list of key/value pairs with the following keys:
1329 =item selected_county
1331 Currently selected county
1333 =item selected_state
1335 Currently selected state
1337 =item selected_country
1339 Currently selected country
1343 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1347 Specify a javascript subroutine to call on changes
1353 =item default_country
1359 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>.
1363 Returns a list consisting of three HTML fragments for county selection,
1364 state selection and country selection, respectively.
1368 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1369 sub regionselector {
1376 $param->{'selected_country'} ||= $param->{'default_country'};
1377 $param->{'selected_state'} ||= $param->{'default_state'};
1379 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1383 my %cust_main_county;
1385 # unless ( @cust_main_county ) { #cache
1386 #@cust_main_county = qsearch('cust_main_county', {} );
1387 #foreach my $c ( @cust_main_county ) {
1388 foreach my $c ( @{ $param->{'locales'} } ) {
1389 #$countyflag=1 if $c->county;
1390 $countyflag=1 if $c->{county};
1391 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1392 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1393 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1396 $countyflag=1 if $param->{selected_county};
1398 my $script_html = <<END;
1400 function opt(what,value,text) {
1401 var optionName = new Option(text, value, false, false);
1402 var length = what.length;
1403 what.options[length] = optionName;
1405 function ${prefix}country_changed(what) {
1406 country = what.options[what.selectedIndex].text;
1407 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1408 what.form.${prefix}state.options[i] = null;
1410 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1412 foreach my $country ( sort keys %cust_main_county ) {
1413 $script_html .= "\nif ( country == \"$country\" ) {\n";
1414 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1415 my $text = $state || '(n/a)';
1416 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1418 $script_html .= "}\n";
1421 $script_html .= <<END;
1423 function ${prefix}state_changed(what) {
1426 if ( $countyflag ) {
1427 $script_html .= <<END;
1428 state = what.options[what.selectedIndex].text;
1429 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1430 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1431 what.form.${prefix}county.options[i] = null;
1434 foreach my $country ( sort keys %cust_main_county ) {
1435 $script_html .= "\nif ( country == \"$country\" ) {\n";
1436 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1437 $script_html .= "\nif ( state == \"$state\" ) {\n";
1438 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1439 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1440 my $text = $county || '(n/a)';
1442 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1444 $script_html .= "}\n";
1446 $script_html .= "}\n";
1450 $script_html .= <<END;
1455 my $county_html = $script_html;
1456 if ( $countyflag ) {
1457 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1458 foreach my $county (
1459 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1461 my $text = $county || '(n/a)';
1462 $county_html .= qq!<OPTION VALUE="$county"!.
1463 ($county eq $param->{'selected_county'} ?
1470 $county_html .= '</SELECT>';
1473 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1476 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1477 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1478 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1479 my $text = $state || '(n/a)';
1480 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1481 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1483 $state_html .= '</SELECT>';
1485 my $country_html = '';
1486 if ( scalar( keys %cust_main_county ) > 1 ) {
1488 $country_html = qq(<SELECT NAME="${prefix}country" ).
1489 qq(onChange="${prefix}country_changed(this); ).
1490 $param->{'onchange'}.
1493 my $countrydefault = $param->{default_country} || 'US';
1494 foreach my $country (
1495 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1496 keys %cust_main_county
1498 my $selected = $country eq $param->{'selected_country'}
1501 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1503 $country_html .= '</SELECT>';
1506 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1507 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1511 ($county_html, $state_html, $country_html);
1515 sub regionselector_hashref {
1516 my ($county_html, $state_html, $country_html) = regionselector(@_);
1518 'county_html' => $county_html,
1519 'state_html' => $state_html,
1520 'country_html' => $country_html,
1524 =item location_form HASHREF | LIST
1526 Takes as input a hashref or list of key/value pairs with the following keys:
1532 Current customer session_id
1536 Omit red asterisks from required fields.
1538 =item address1_label
1540 Label for first address line.
1544 Returns an HTML fragment for a location form (address, city, state, zip,
1557 my $session_id = delete $param->{'session_id'};
1559 my $rv = mason_comp( 'session_id' => $session_id,
1560 'comp' => '/elements/location.html',
1561 'args' => [ %$param ],
1565 $rv->{'error'} || $rv->{'output'};
1570 #=item expselect HASHREF | LIST
1572 #Takes as input a hashref or list of key/value pairs with the following keys:
1576 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1578 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1582 =item expselect PREFIX [ DATE ]
1584 Takes as input a unique prefix string and the current expiration date, in
1585 yyyy-mm-dd or m-d-yyyy format
1587 Returns an HTML fragments for expiration date selection.
1593 #if ( ref($_[0]) ) {
1597 #my $prefix = $param->{'prefix'};
1598 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1599 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1601 my $date = scalar(@_) ? shift : '';
1603 my( $m, $y ) = ( 0, 0 );
1604 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1605 ( $m, $y ) = ( $2, $1 );
1606 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1607 ( $m, $y ) = ( $1, $3 );
1609 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1611 $return .= qq!<OPTION VALUE="$_"!;
1612 $return .= " SELECTED" if $_ == $m;
1615 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1617 my $thisYear = $t[5] + 1900;
1618 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1619 $return .= qq!<OPTION VALUE="$_"!;
1620 $return .= " SELECTED" if $_ == $y;
1623 $return .= "</SELECT>";
1628 =item popselector HASHREF | LIST
1630 Takes as input a hashref or list of key/value pairs with the following keys:
1636 Access number number
1640 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>.
1644 Returns an HTML fragment for access number selection.
1648 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1656 my $popnum = $param->{'popnum'};
1657 my $pops = $param->{'pops'};
1659 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1660 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1661 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1662 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1663 if scalar(@$pops) == 1;
1666 my %popnum2pop = ();
1668 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1669 $popnum2pop{$_->{popnum}} = $_;
1674 function opt(what,href,text) {
1675 var optionName = new Option(text, href, false, false)
1676 var length = what.length;
1677 what.options[length] = optionName;
1681 my $init_popstate = $param->{'init_popstate'};
1682 if ( $init_popstate ) {
1683 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1684 $init_popstate. '">';
1687 function acstate_changed(what) {
1688 state = what.options[what.selectedIndex].text;
1689 what.form.popac.options.length = 0
1690 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1694 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1695 foreach my $state ( sort { $a cmp $b } @states ) {
1696 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1698 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1699 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1700 if ($ac eq $param->{'popac'}) {
1701 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1704 $text .= "}\n" unless $init_popstate;
1706 $text .= "popac_changed(what.form.popac)}\n";
1709 function popac_changed(what) {
1710 ac = what.options[what.selectedIndex].text;
1711 what.form.popnum.options.length = 0;
1712 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1716 foreach my $state ( @states ) {
1717 foreach my $popac ( keys %{ $pop{$state} } ) {
1718 $text .= "\nif ( ac == \"$popac\" ) {\n";
1720 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1721 my $o_popnum = $pop->{popnum};
1722 my $poptext = $pop->{city}. ', '. $pop->{state}.
1723 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1725 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1726 if ($popnum == $o_popnum) {
1727 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1735 $text .= "}\n</SCRIPT>\n";
1737 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1740 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1741 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1742 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1743 ">$_" foreach sort { $a cmp $b } @states;
1744 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1747 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1748 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1750 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1753 #comment this block to disable initial list polulation
1754 my @initial_select = ();
1755 if ( scalar( @$pops ) > 100 ) {
1756 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1758 @initial_select = @$pops;
1760 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1761 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1762 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1763 $pop->{city}. ', '. $pop->{state}.
1764 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1767 $text .= qq!</SELECT></TD></TR></TABLE>!;
1773 =item domainselector HASHREF | LIST
1775 Takes as input a hashref or list of key/value pairs with the following keys:
1785 Service number of the selected item.
1789 Returns an HTML fragment for domain selection.
1793 sub domainselector {
1800 my $domsvc= $param->{'domsvc'};
1802 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1803 my $domains = $rv->{'domains'};
1804 $domsvc = $rv->{'domsvc'} unless $domsvc;
1806 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1807 unless scalar(keys %$domains);
1809 if (scalar(keys %$domains) == 1) {
1811 foreach(keys %$domains) {
1814 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1815 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1818 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1821 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1822 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1823 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1824 $domains->{$domain};
1827 $text .= qq!</SELECT></TD></TR>!;
1833 =item didselector HASHREF | LIST
1835 Takes as input a hashref or list of key/value pairs with the following keys:
1841 Field name for the returned HTML fragment.
1845 Service definition (see L<FS::part_svc>)
1849 Returns an HTML fragment for DID selection.
1861 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1862 'args'=>[ %$param ],
1866 $rv->{'error'} || $rv->{'output'};
1872 =head1 RESELLER FUNCTIONS
1874 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1875 with their active session, and the B<customer_info> and B<order_pkg> functions
1876 with their active session and an additional I<custnum> parameter.
1878 For the most part, development of the reseller web interface has been
1879 superceded by agent-virtualized access to the backend.
1891 =item agent_list_customers
1893 List agent's customers.
1901 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>