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 'capture_payment' => 'Signup/capture_payment',
100 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
101 'new_agent' => 'Agent/new_agent',
102 'agent_login' => 'Agent/agent_login',
103 'agent_logout' => 'Agent/agent_logout',
104 'agent_info' => 'Agent/agent_info',
105 'agent_list_customers' => 'Agent/agent_list_customers',
106 'check_username' => 'Agent/check_username',
107 'suspend_username' => 'Agent/suspend_username',
108 'unsuspend_username' => 'Agent/unsuspend_username',
109 'mason_comp' => 'MasonComponent/mason_comp',
110 'call_time' => 'PrepaidPhone/call_time',
111 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
112 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
114 'start_thirdparty' => 'MyAccount/start_thirdparty',
115 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
119 qw( regionselector regionselector_hashref location_form
120 expselect popselector domainselector didselector
124 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
125 $ENV{'SHELL'} = '/bin/sh';
126 $ENV{'IFS'} = " \t\n";
129 $ENV{'BASH_ENV'} = '';
131 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
132 #if you grant appropriate permissions to whatever user
133 my $freeside_uid = scalar(getpwnam('freeside'));
134 die "not running as the freeside user\n"
135 if $> != $freeside_uid && ! $skip_uid_check;
137 -e $dir or die "FATAL: $dir doesn't exist!";
138 -d $dir or die "FATAL: $dir isn't a directory!";
139 -r $dir or die "FATAL: Can't read $dir as freeside user!";
140 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
142 foreach my $autoload ( keys %autoload ) {
145 "sub $autoload { ". '
150 #warn scalar(@_). ": ". join(" / ", @_);
154 $param->{_packet} = \''. $autoload{$autoload}. '\';
156 simple_packet($param);
166 warn "sending ". $packet->{_packet}. " to server"
168 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
169 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
170 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
173 #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
175 #block until there is a message on socket
176 # my $w = new IO::Select;
178 # my @wait = $w->can_read;
180 warn "reading message from server"
183 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
184 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
186 warn "returning message to client"
194 FS::SelfService - Freeside self-service API
198 # password and shell account changes
199 use FS::SelfService qw(passwd chfn chsh);
201 # "my account" functionality
202 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
204 my $rv = login( { 'username' => $username,
206 'password' => $password,
210 if ( $rv->{'error'} ) {
211 #handle login error...
214 my $session_id = $rv->{'session_id'};
217 my $customer_info = customer_info( { 'session_id' => $session_id } );
219 #payment_info and process_payment are available in 1.5+ only
220 my $payment_info = payment_info( { 'session_id' => $session_id } );
222 #!!! process_payment example
224 #!!! list_pkgs example
226 #!!! order_pkg example
228 #!!! cancel_pkg example
230 # signup functionality
231 use FS::SelfService qw( signup_info new_customer );
233 my $signup_info = signup_info;
235 $rv = new_customer( {
238 'company' => $company,
239 'address1' => $address1,
240 'address2' => $address2,
244 'country' => $country,
245 'daytime' => $daytime,
249 'payinfo' => $payinfo,
251 'paystart_month' => $paystart_month
252 'paystart_year' => $paystart_year,
253 'payissue' => $payissue,
255 'paydate' => $paydate,
256 'payname' => $payname,
257 'invoicing_list' => $invoicing_list,
258 'referral_custnum' => $referral_custnum,
259 'agentnum' => $agentnum,
260 'pkgpart' => $pkgpart,
262 'username' => $username,
263 '_password' => $password,
267 'phonenum' => $phonenum,
272 my $error = $rv->{'error'};
273 if ( $error eq '_decline' ) {
283 Use this API to implement your own client "self-service" module.
285 If you just want to customize the look of the existing "self-service" module,
288 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
300 =head1 "MY ACCOUNT" FUNCTIONS
306 Creates a user session. Takes a hash reference as parameter with the
325 Returns a hash reference with the following keys:
331 Empty on success, or an error message on errors.
335 Session identifier for successful logins
339 =item customer_info HASHREF
341 Returns general customer information.
343 Takes a hash reference as parameter with a single key: B<session_id>
345 Returns a hash reference with the following keys:
359 Array reference of hash references of open inoices. Each hash reference has
360 the following keys: invnum, date, owed
364 An HTML fragment containing shipping and billing addresses.
366 =item The following fields are also returned
368 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
372 =item edit_info HASHREF
374 Takes a hash reference as parameter with any of the following keys:
376 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
378 If a field exists, the customer record is updated with the new value of that
379 field. If a field does not exist, that field is not changed on the customer
382 Returns a hash reference with a single key, B<error>, empty on success, or an
383 error message on errors
385 =item invoice HASHREF
387 Returns an invoice. Takes a hash reference as parameter with two keys:
388 session_id and invnum
390 Returns a hash reference with the following keys:
396 Empty on success, or an error message on errors
408 =item list_invoices HASHREF
410 Returns a list of all customer invoices. Takes a hash references with a single
413 Returns a hash reference with the following keys:
419 Empty on success, or an error message on errors
423 Reference to array of hash references with the following keys:
433 Invoice date, in UNIX epoch time
441 Cancels this customer.
443 Takes a hash reference as parameter with a single key: B<session_id>
445 Returns a hash reference with a single key, B<error>, which is empty on
446 success or an error message on errors.
448 =item payment_info HASHREF
450 Returns information that may be useful in displaying a payment page.
452 Takes a hash reference as parameter with a single key: B<session_id>.
454 Returns a hash reference with the following keys:
460 Empty on success, or an error message on errors
468 Exact name on credit card (CARD/DCRD)
492 Customer's current default payment type.
496 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
500 For CARD/DCRD payment types, the card number
504 For CARD/DCRD payment types, expiration month
508 For CARD/DCRD payment types, expiration year
510 =item cust_main_county
512 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.
516 Array reference of all states in the current default country.
520 Hash reference of card types; keys are card types, values are the exact strings
521 passed to the process_payment function
525 #this doesn't actually work yet
529 #Unique transaction identifier (prevents multiple charges), passed to the
530 #process_payment function
534 =item process_payment HASHREF
536 Processes a payment and possible change of address or payment type. Takes a
537 hash reference as parameter with the following keys:
551 If true, address and card information entered will be saved for subsequent
556 If true, future credit card payments will be done automatically (sets payby to
557 CARD). If false, future credit card payments will be done on-demand (sets
558 payby to DCRD). This option only has meaning if B<save> is set true.
586 Two-letter country code
594 Card expiration month
602 #this doesn't actually work yet
606 #Unique transaction identifier, returned from the payment_info function.
607 #Prevents multiple charges.
611 Returns a hash reference with a single key, B<error>, empty on success, or an
612 error message on errors.
614 =item process_payment_order_pkg
616 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
617 payment processes sucessfully, the package is ordered. Takes a hash reference
618 as parameter with the keys of both methods.
620 Returns a hash reference with a single key, B<error>, empty on success, or an
621 error message on errors.
623 =item process_payment_change_pkg
625 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
626 payment processes sucessfully, the package is ordered. Takes a hash reference
627 as parameter with the keys of both methods.
629 Returns a hash reference with a single key, B<error>, empty on success, or an
630 error message on errors.
633 =item process_payment_order_renew
635 Combines the B<process_payment> and B<order_renew> functions in one step. If
636 the payment processes sucessfully, the renewal is processed. Takes a hash
637 reference as parameter with the keys of both methods.
639 Returns a hash reference with a single key, B<error>, empty on success, or an
640 error message on errors.
644 Returns package information for this customer. For more detail on services,
647 Takes a hash reference as parameter with a single key: B<session_id>
649 Returns a hash reference containing customer package information. The hash reference contains the following keys:
659 Empty on success, or an error message on errors.
661 =item cust_pkg HASHREF
663 Array reference of hash references, each of which has the fields of a cust_pkg
664 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
665 the internal FS:: objects, but hash references of columns and values.
669 =item part_pkg fields
671 All fields of part_pkg for this specific cust_pkg (be careful with this
672 information - it may reveal more about your available packages than you would
673 like users to know in aggregate)
677 #XXX pare part_pkg fields down to a more secure subset
681 An array of hash references indicating information on unprovisioned services
682 available for provisioning for this specific cust_pkg. Each has the following
687 =item part_svc fields
689 All fields of part_svc (be careful with this information - it may reveal more
690 about your available packages than you would like users to know in aggregate)
694 #XXX pare part_svc fields down to a more secure subset
700 An array of hash references indicating information on the customer services
701 already provisioned for this specific cust_pkg. Each has the following keys:
707 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.
713 Primary key for this service
717 Service definition (see L<FS::part_svc>)
721 Customer package (see L<FS::cust_pkg>)
725 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
733 Returns service information for this customer.
735 Takes a hash reference as parameter with a single key: B<session_id>
737 Returns a hash reference containing customer package information. The hash reference contains the following keys:
747 An array of hash references indicating information on all of this customer's
748 services. Each has the following keys:
754 Primary key for this service
762 Meaningful user-specific identifier for the service (i.e. username, domain, or
767 Account (svc_acct) services also have the following keys:
785 Upload bytes remaining
789 Download bytes remaining
793 Total bytes remaining
795 =item recharge_amount
799 =item recharge_seconds
801 Number of seconds gained by recharge
803 =item recharge_upbytes
805 Number of upload bytes gained by recharge
807 =item recharge_downbytes
809 Number of download bytes gained by recharge
811 =item recharge_totalbytes
813 Number of total bytes gained by recharge
821 Orders a package for this customer.
823 Takes a hash reference as parameter with the following keys:
833 Package to order (see L<FS::part_pkg>).
837 Quantity for this package order (default 1).
841 Optional locationnum for this package order, for existing locations.
843 Or, for new locations, pass the following fields: address1*, address2, city*,
844 county, state*, zip*, country. (* = required in this case)
856 Service to order (see L<FS::part_svc>).
858 Normally optional; required only to provision a non-svc_acct service, or if the
859 package definition does not contain one svc_acct service definition with
860 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
861 also be specified to indicate that no initial service should be provisioned.
865 Fields used when provisioning an svc_acct service:
879 Optional security phrase
883 Optional Access number number
887 Fields used when provisioning an svc_domain service:
897 Fields used when provisioning an svc_phone service:
915 Fields used when provisioning an svc_external service:
929 Fields used when provisioning an svc_pbx service:
943 Returns a hash reference with a single key, B<error>, empty on success, or an
944 error message on errors. The special error '_decline' is returned for
945 declined transactions.
949 Changes a package for this customer.
951 Takes a hash reference as parameter with the following keys:
961 Existing customer package.
965 New package to order (see L<FS::part_pkg>).
969 Returns a hash reference with the following keys:
975 Empty on success, or an error message on errors.
979 On success, the new pkgnum
986 Provides useful info for early renewals.
988 Takes a hash reference as parameter with the following keys:
998 Returns a hash reference. On errors, it contains a single key, B<error>, with
999 the error message. Otherwise, contains a single key, B<dates>, pointing to
1000 an array refernce of hash references. Each hash reference contains the
1007 (Future) Bill date. Indicates a future date for which billing could be run.
1008 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1011 =item bill_date_pretty
1013 (Future) Bill date as a human-readable string. (Convenience for display;
1014 subject to change, so best not to parse for the date.)
1018 Base amount which will be charged if renewed early as of this date.
1022 Renewal date; i.e. even-futher future date at which the customer will be paid
1023 through if the early renewal is completed with the given B<bill-date>.
1024 Specified as a integer UNIX timestamp.
1026 =item renew_date_pretty
1028 Renewal date as a human-readable string. (Convenience for display;
1029 subject to change, so best not to parse for the date.)
1033 Package that will be renewed.
1037 Expiration date of the package that will be renewed.
1039 =item expire_date_pretty
1041 Expiration date of the package that will be renewed, as a human-readable
1042 string. (Convenience for display; subject to change, so best not to parse for
1049 Renews this customer early; i.e. runs billing for this customer in advance.
1051 Takes a hash reference as parameter with the following keys:
1061 Integer date as returned by the B<renew_info> function, indicating the advance
1062 date for which to run billing.
1066 Returns a hash reference with a single key, B<error>, empty on success, or an
1067 error message on errors.
1071 Cancels a package for this customer.
1073 Takes a hash reference as parameter with the following keys:
1083 pkgpart of package to cancel
1087 Returns a hash reference with a single key, B<error>, empty on success, or an
1088 error message on errors.
1092 =head1 SIGNUP FUNCTIONS
1096 =item signup_info HASHREF
1098 Takes a hash reference as parameter with the following keys:
1102 =item session_id - Optional agent/reseller interface session
1106 Returns a hash reference containing information that may be useful in
1107 displaying a signup page. The hash reference contains the following keys:
1111 =item cust_main_county
1113 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.
1117 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
1118 an agentnum specified explicitly via reseller interface session_id in the
1123 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.
1125 =item agentnum2part_pkg
1127 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.
1131 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.
1133 =item security_phrase
1135 True if the "security_phrase" feature is enabled
1139 Array reference of acceptable payment types for signup
1145 credit card - automatic
1149 credit card - on-demand - version 1.5+ only
1153 electronic check - automatic
1157 electronic check - on-demand - version 1.5+ only
1165 billing, not recommended for signups
1169 free, definitely not recommended for signups
1173 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1179 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1183 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".
1189 =item countrydefault
1195 =item new_customer HASHREF
1197 Creates a new customer. Takes a hash reference as parameter with the
1204 first name (required)
1208 last name (required)
1212 (not typically collected; mostly used for ACH transactions)
1218 =item address1 (required)
1226 =item city (required)
1234 =item state (required)
1238 =item zip (required)
1244 Daytime phone number
1248 Evening phone number
1256 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1260 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1264 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1268 Expiration date for CARD/DCRD
1272 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1274 =item invoicing_list
1276 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),
1278 =item referral_custnum
1280 referring customer number
1288 pkgpart of initial package
1304 Access number (index, not the literal number)
1308 Country code (to be provisioned as a service)
1312 Phone number (to be provisioned as a service)
1320 Returns a hash reference with the following keys:
1326 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)
1330 =item regionselector HASHREF | LIST
1332 Takes as input a hashref or list of key/value pairs with the following keys:
1336 =item selected_county
1338 Currently selected county
1340 =item selected_state
1342 Currently selected state
1344 =item selected_country
1346 Currently selected country
1350 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1354 Specify a javascript subroutine to call on changes
1360 =item default_country
1366 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>.
1370 Returns a list consisting of three HTML fragments for county selection,
1371 state selection and country selection, respectively.
1375 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1376 sub regionselector {
1383 $param->{'selected_country'} ||= $param->{'default_country'};
1384 $param->{'selected_state'} ||= $param->{'default_state'};
1386 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1390 my %cust_main_county;
1392 # unless ( @cust_main_county ) { #cache
1393 #@cust_main_county = qsearch('cust_main_county', {} );
1394 #foreach my $c ( @cust_main_county ) {
1395 foreach my $c ( @{ $param->{'locales'} } ) {
1396 #$countyflag=1 if $c->county;
1397 $countyflag=1 if $c->{county};
1398 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1399 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1400 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1403 $countyflag=1 if $param->{selected_county};
1405 my $script_html = <<END;
1407 function opt(what,value,text) {
1408 var optionName = new Option(text, value, false, false);
1409 var length = what.length;
1410 what.options[length] = optionName;
1412 function ${prefix}country_changed(what) {
1413 country = what.options[what.selectedIndex].text;
1414 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1415 what.form.${prefix}state.options[i] = null;
1417 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1419 foreach my $country ( sort keys %cust_main_county ) {
1420 $script_html .= "\nif ( country == \"$country\" ) {\n";
1421 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1422 my $text = $state || '(n/a)';
1423 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1425 $script_html .= "}\n";
1428 $script_html .= <<END;
1430 function ${prefix}state_changed(what) {
1433 if ( $countyflag ) {
1434 $script_html .= <<END;
1435 state = what.options[what.selectedIndex].text;
1436 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1437 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1438 what.form.${prefix}county.options[i] = null;
1441 foreach my $country ( sort keys %cust_main_county ) {
1442 $script_html .= "\nif ( country == \"$country\" ) {\n";
1443 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1444 $script_html .= "\nif ( state == \"$state\" ) {\n";
1445 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1446 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1447 my $text = $county || '(n/a)';
1449 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1451 $script_html .= "}\n";
1453 $script_html .= "}\n";
1457 $script_html .= <<END;
1462 my $county_html = $script_html;
1463 if ( $countyflag ) {
1464 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1465 foreach my $county (
1466 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1468 my $text = $county || '(n/a)';
1469 $county_html .= qq!<OPTION VALUE="$county"!.
1470 ($county eq $param->{'selected_county'} ?
1477 $county_html .= '</SELECT>';
1480 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1483 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1484 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1485 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1486 my $text = $state || '(n/a)';
1487 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1488 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1490 $state_html .= '</SELECT>';
1492 my $country_html = '';
1493 if ( scalar( keys %cust_main_county ) > 1 ) {
1495 $country_html = qq(<SELECT NAME="${prefix}country" ).
1496 qq(onChange="${prefix}country_changed(this); ).
1497 $param->{'onchange'}.
1500 my $countrydefault = $param->{default_country} || 'US';
1501 foreach my $country (
1502 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1503 keys %cust_main_county
1505 my $selected = $country eq $param->{'selected_country'}
1508 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1510 $country_html .= '</SELECT>';
1513 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1514 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1518 ($county_html, $state_html, $country_html);
1522 sub regionselector_hashref {
1523 my ($county_html, $state_html, $country_html) = regionselector(@_);
1525 'county_html' => $county_html,
1526 'state_html' => $state_html,
1527 'country_html' => $country_html,
1531 =item location_form HASHREF | LIST
1533 Takes as input a hashref or list of key/value pairs with the following keys:
1539 Current customer session_id
1543 Omit red asterisks from required fields.
1545 =item address1_label
1547 Label for first address line.
1551 Returns an HTML fragment for a location form (address, city, state, zip,
1564 my $session_id = delete $param->{'session_id'};
1566 my $rv = mason_comp( 'session_id' => $session_id,
1567 'comp' => '/elements/location.html',
1568 'args' => [ %$param ],
1572 $rv->{'error'} || $rv->{'output'};
1577 #=item expselect HASHREF | LIST
1579 #Takes as input a hashref or list of key/value pairs with the following keys:
1583 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1585 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1589 =item expselect PREFIX [ DATE ]
1591 Takes as input a unique prefix string and the current expiration date, in
1592 yyyy-mm-dd or m-d-yyyy format
1594 Returns an HTML fragments for expiration date selection.
1600 #if ( ref($_[0]) ) {
1604 #my $prefix = $param->{'prefix'};
1605 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1606 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1608 my $date = scalar(@_) ? shift : '';
1610 my( $m, $y ) = ( 0, 0 );
1611 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1612 ( $m, $y ) = ( $2, $1 );
1613 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1614 ( $m, $y ) = ( $1, $3 );
1616 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1618 $return .= qq!<OPTION VALUE="$_"!;
1619 $return .= " SELECTED" if $_ == $m;
1622 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1624 my $thisYear = $t[5] + 1900;
1625 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1626 $return .= qq!<OPTION VALUE="$_"!;
1627 $return .= " SELECTED" if $_ == $y;
1630 $return .= "</SELECT>";
1635 =item popselector HASHREF | LIST
1637 Takes as input a hashref or list of key/value pairs with the following keys:
1643 Access number number
1647 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>.
1651 Returns an HTML fragment for access number selection.
1655 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1663 my $popnum = $param->{'popnum'};
1664 my $pops = $param->{'pops'};
1666 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1667 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1668 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1669 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1670 if scalar(@$pops) == 1;
1673 my %popnum2pop = ();
1675 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1676 $popnum2pop{$_->{popnum}} = $_;
1681 function opt(what,href,text) {
1682 var optionName = new Option(text, href, false, false)
1683 var length = what.length;
1684 what.options[length] = optionName;
1688 my $init_popstate = $param->{'init_popstate'};
1689 if ( $init_popstate ) {
1690 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1691 $init_popstate. '">';
1694 function acstate_changed(what) {
1695 state = what.options[what.selectedIndex].text;
1696 what.form.popac.options.length = 0
1697 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1701 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1702 foreach my $state ( sort { $a cmp $b } @states ) {
1703 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1705 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1706 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1707 if ($ac eq $param->{'popac'}) {
1708 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1711 $text .= "}\n" unless $init_popstate;
1713 $text .= "popac_changed(what.form.popac)}\n";
1716 function popac_changed(what) {
1717 ac = what.options[what.selectedIndex].text;
1718 what.form.popnum.options.length = 0;
1719 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1723 foreach my $state ( @states ) {
1724 foreach my $popac ( keys %{ $pop{$state} } ) {
1725 $text .= "\nif ( ac == \"$popac\" ) {\n";
1727 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1728 my $o_popnum = $pop->{popnum};
1729 my $poptext = $pop->{city}. ', '. $pop->{state}.
1730 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1732 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1733 if ($popnum == $o_popnum) {
1734 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1742 $text .= "}\n</SCRIPT>\n";
1744 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1747 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1748 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1749 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1750 ">$_" foreach sort { $a cmp $b } @states;
1751 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1754 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1755 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1757 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1760 #comment this block to disable initial list polulation
1761 my @initial_select = ();
1762 if ( scalar( @$pops ) > 100 ) {
1763 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1765 @initial_select = @$pops;
1767 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1768 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1769 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1770 $pop->{city}. ', '. $pop->{state}.
1771 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1774 $text .= qq!</SELECT></TD></TR></TABLE>!;
1780 =item domainselector HASHREF | LIST
1782 Takes as input a hashref or list of key/value pairs with the following keys:
1792 Service number of the selected item.
1796 Returns an HTML fragment for domain selection.
1800 sub domainselector {
1807 my $domsvc= $param->{'domsvc'};
1809 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1810 my $domains = $rv->{'domains'};
1811 $domsvc = $rv->{'domsvc'} unless $domsvc;
1813 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1814 unless scalar(keys %$domains);
1816 if (scalar(keys %$domains) == 1) {
1818 foreach(keys %$domains) {
1821 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1822 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1825 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
1827 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
1829 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1830 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1831 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1832 $domains->{$domain};
1835 $text .= qq!</SELECT></TD></TR>!;
1841 =item didselector HASHREF | LIST
1843 Takes as input a hashref or list of key/value pairs with the following keys:
1849 Field name for the returned HTML fragment.
1853 Service definition (see L<FS::part_svc>)
1857 Returns an HTML fragment for DID selection.
1869 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1870 'args'=>[ %$param ],
1874 $rv->{'error'} || $rv->{'output'};
1880 =head1 RESELLER FUNCTIONS
1882 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1883 with their active session, and the B<customer_info> and B<order_pkg> functions
1884 with their active session and an additional I<custnum> parameter.
1886 For the most part, development of the reseller web interface has been
1887 superceded by agent-virtualized access to the backend.
1899 =item agent_list_customers
1901 List agent's customers.
1909 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>